texlive[60591] trunk: glossaries (23sep21)
commits+karl at tug.org
commits+karl at tug.org
Thu Sep 23 22:14:28 CEST 2021
Revision: 60591
http://tug.org/svn/texlive?view=revision&revision=60591
Author: karl
Date: 2021-09-23 22:14:27 +0200 (Thu, 23 Sep 2021)
Log Message:
-----------
glossaries (23sep21)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
trunk/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl
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-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.pdf
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/samplexdy2.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf
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/tex/latex/glossaries/base/glossaries-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-childmultipar.tex
trunk/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-longchild.tex
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2021-09-23 20:14:27 UTC (rev 60591)
@@ -2,7 +2,7 @@
# File : makeglossaries
# Author : Nicola Talbot
-# Version : 4.45
+# Version : 4.47
# Description: simple Perl script that calls makeindex or xindy.
# Intended for use with "glossaries.sty" (saves having to remember
# all the various switches)
@@ -31,25 +31,15 @@
# glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl.
# Also makeglossaries and makeglossaries-lite.lua.
-my $version="4.45 (2020-01-18)";
+my $version="4.47 (2021-09-20)";
# History:
-# v4.43:
-# * No change.
-# v4.41:
-# * No change.
-# v4.40:
-# * No change.
-# v4.39:
-# * No change.
-# v4.38:
-# * No change.
-# v4.37:
-# * No change.
-# v4.36:
-# * No change.
-# v4.35:
-# * No change.
+# v4.47:
+# * Added hybrid instructions if record option detected but not
+# \makeglossaries
+# * Added quote_if_spaced subroutine
+# v4.35 - v4.46:
+# * No change. (Version number updated in line with glossaries.sty)
# v4.34:
# * Added check for \glsxtr at resource
# v4.33:
@@ -350,9 +340,12 @@
{
if ($foundbib2glsresource)
{
+# v4.47 added extra hybrid instructions
die "Found \\glsxtr\@resource in '$name.aux',\n",
"but not found \\\@istfilename.\n",
- "You need to run bib2gls not makeglossaries.\n";
+ "You need to run bib2gls not makeglossaries.\n",
+ "If you have used record=alsoindex or record=hybrid\n",
+ "then add \\makeglossaries to your preamble.\n";
}
else
{
@@ -818,6 +811,21 @@
}
}
+# v4.47 new
+# Issue #129 was specifically about the Lua script but it's
+# likely the same problem would occur with this Perl script given
+# the same version of cmd.exe
+sub quote_if_spaced{
+ my ($str) = @_;
+
+ if ($str=~/ /)
+ {
+ $str = "\"$str\"";
+ }
+
+ $str;
+}
+
# v2.01 new subroutine run_app added
sub run_app{
my($appname, $appargs, $trans, $quiet, $dontexec) = @_;
@@ -833,9 +841,12 @@
return if ($dontexec);
+ # v4.47
+ my $cmdstr = "e_if_spaced($appname) . " $appargs";
+
# v2.11 added double-quotes around $appname
# v2.14 added -k switch
- if (not $opt_k and open (STATUS, "\"$appname\" $appargs 2>&1 |"))
+ if (not $opt_k and open (STATUS, "$cmdstr 2>&1 |"))
{
while (<STATUS>)
{
@@ -861,7 +872,7 @@
"Retrying without redirection.\n" unless ($quiet or $opt_Q);
}
- $status = `\"$appname\" $appargs`;
+ $status = `$cmdstr`;
$log = $status;
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2021-09-23 20:14:27 UTC (rev 60591)
@@ -36,14 +36,14 @@
Also makeglossaries and makeglossaries-lite.lua.
History:
- * 4.45:
+ * 4.47:
+ - Added hybrid instructions if record option detected but not \makeglossaries
+ - Added extra info to error message on -d
+ - Fixed bug #183 that occurs when \@istfilename is missing
+ - Only add double-quotes if text contains any spaces which
+ may help address issue #129
+ * 4.40 - 4.46:
- no change.
- * 4.44:
- - no change.
- * 4.41:
- - no change.
- * 4.40:
- - no change.
* 4.39:
- corrected script name in version and help messages
* 4.38:
@@ -68,7 +68,7 @@
- changed first line from lua to texlua
--]]
-thisversion = "4.45 (2020-01-18)"
+thisversion = "4.47 (2021-09-20)"
quiet = false
dryrun = false
@@ -163,6 +163,17 @@
end
+-- v4.47 only add double-quotes if text contains any spaces
+function quote_if_spaced(str)
+
+ if string.find(str, " ") then
+ str = '"' .. str .. '"'
+ end
+
+ return str;
+
+end
+
function doxindy(name, glg, gls, glo, language, codepage)
if codepage == nil
@@ -170,14 +181,14 @@
codepage = "utf8"
end
- cmd = string.format('"%s" -I xindy -L %s -C %s -M "%s" -t "%s" -o "%s"',
- xindyexec, language, codepage, styfile, glg, gls)
+ cmd = string.format('%s -I xindy -L %s -C %s -M %s -t %s -o %s',
+ quote_if_spaced(xindyexec), language, codepage, quote_if_spaced(styfile), quote_if_spaced(glg), quote_if_spaced(gls))
if letterorder then cmd = string.format('%s -M ord/letorder', cmd) end
if quiet then cmd = string.format('%s -q', cmd) end
- cmd = string.format('%s "%s"', cmd, glo)
+ cmd = string.format('%s %s', cmd, quote_if_spaced(glo))
if dryrun then
@@ -194,7 +205,7 @@
function domakeindex(name, glg, gls, glo)
- cmd = string.format('"%s"', makeindex_m)
+ cmd = quote_if_spaced(makeindex_m)
if makeindex_c then cmd = cmd .. " -c" end
@@ -206,9 +217,9 @@
if quiet then cmd = cmd .. " -q" end
- if glg ~= nil then cmd = string.format('%s -t "%s"', cmd, glg) end
+ if glg ~= nil then cmd = string.format('%s -t %s', cmd, quote_if_spaced(glg)) end
- if gls ~= nil then cmd = string.format('%s -o "%s"', cmd, gls) end
+ if gls ~= nil then cmd = string.format('%s -o %s', cmd, quote_if_spaced(gls)) end
if makeindex_p ~= nil then
cmd = string.format("%s -p %s", cmd, makeindex_p)
@@ -215,10 +226,10 @@
end
if styfile ~= nil then
- cmd = string.format('%s -s "%s"', cmd, styfile)
+ cmd = string.format('%s -s %s', cmd, quote_if_spaced(styfile))
end
- cmd = string.format('%s "%s"', cmd, glo)
+ cmd = string.format('%s %s', cmd, quote_if_spaced(glo))
if dryrun then
print(cmd)
@@ -275,7 +286,7 @@
elseif arg[i] == "-d"
then
error(string.format(
- "The '%s' option isn't available for this light-weight version.\nYou will need to use the Perl version instead.",
+ "The '%s' option isn't available for this light-weight version. \n(Lua doesn't natively provide a function to change directory.) \nYou will need to use the Perl version instead \nor just change directory before running this script.",
arg[i]))
-- Xindy Options
@@ -382,15 +393,23 @@
-- v4.36: corrected check for double-quotes
styfile = string.match(aux, "\\@istfilename{([^}]*)}")
- styfile = string.gsub(styfile, "\"", "");
+-- v4.47: added check for null styfile (missing \@istfilename)
+ if styfile ~= nil
+ then
+ styfile = string.gsub(styfile, "\"", "");
+ end
+
if styfile == nil
then
if isbib2gls
then
+-- v4.47 added extra hybrid instructions
error([[
No \@istfilename found but found \glsxtr at resource.
You need to run bib2gls not makeglossaries-lite.
+If you have used record=alsoindex or record=hybrid
+then add \makeglossaries to your preamble.
]])
else
error([[
Modified: trunk/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl 2021-09-23 20:14:27 UTC (rev 60591)
@@ -1,12 +1,12 @@
#!/usr/bin/env perl
-# $Id: tlmgr.pl 60157 2021-08-04 01:42:52Z preining $
+# $Id: tlmgr.pl 60557 2021-09-20 10:46:43Z preining $
#
# Copyright 2008-2021 Norbert Preining
# This file is licensed under the GNU General Public License version 2
# or any later version.
-my $svnrev = '$Revision: 60157 $';
-my $datrev = '$Date: 2021-08-04 03:42:52 +0200 (Wed, 04 Aug 2021) $';
+my $svnrev = '$Revision: 60557 $';
+my $datrev = '$Date: 2021-09-20 12:46:43 +0200 (Mon, 20 Sep 2021) $';
my $tlmgrrevision;
my $tlmgrversion;
my $prg;
@@ -1658,7 +1658,15 @@
} elsif ($opts{'data'}) {
# output format is changed to csv with " as quotes
# we need to determine the fields
- @datafields = split(',', $opts{'data'});
+ #
+ # Try to work around stupidiy in Windows where "," is interpreted in
+ # powershell (and cmd?)
+ # We optionally split at ":"
+ if ($opts{'data'} =~ m/:/) {
+ @datafields = split(':', $opts{'data'});
+ } else {
+ @datafields = split(',', $opts{'data'});
+ }
# check for correctness of data fields and whether remote is necessary
my $load_remote = 0;
for my $d (@datafields) {
@@ -8480,8 +8488,8 @@
=item B<--data C<item1,item2,...>>
-If the option C<--data> is given, its argument must be a comma separated
-list of field names from: C<name>, C<category>, C<localrev>,
+If the option C<--data> is given, its argument must be a comma or colon
+separated list of field names from: C<name>, C<category>, C<localrev>,
C<remoterev>, C<shortdesc>, C<longdesc>, C<installed>, C<size>,
C<relocatable>, C<depends>, C<cat-version>, C<cat-date>, C<cat-license>,
plus various C<cat-contact-*> fields (see below).
@@ -10231,7 +10239,7 @@
distribution (L<https://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.
-$Id: tlmgr.pl 60157 2021-08-04 01:42:52Z preining $
+$Id: tlmgr.pl 60557 2021-09-20 10:46:43Z preining $
=cut
# test HTML version: pod2html --cachedir=/tmp tlmgr.pl >/tmp/tlmgr.html
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2021-09-23 20:14:27 UTC (rev 60591)
@@ -1,5 +1,111 @@
glossaries change log:
+v4.47 (2021-09-20):
+
+ * added new files containing dummy entries for testing:
+
+ - example-glossaries-longchild.tex
+ - example-glossaries-childmultipar.tex
+
+ * glossaries.sty:
+
+ - Rollback to v4.46 is available, if necessary:
+
+ \usepackage{glossaries}[=v4.46]
+
+ - bug fix #173 https://www.dickimaw-books.com/bugtracker.php?key=173
+ (.glsdefs not updated if entry definition modified)
+
+ This bug fix has also led to support for the use of the 'see' key
+ within the document environment.
+
+ ** Delete your .glsdefs files on upgrading **
+
+ Note that this update slightly changes the format of the .glsdefs file.
+ If you have a system that parses this file (for example, to pick
+ up labels for autocompletion) it will need to be modified.
+
+ Old format:
+
+\ifglsentryexists{<label>}{}%
+{%
+\gls at defglossaryentry{<label>}%
+{%
+<key value list>
+}%
+}%
+
+ New format:
+
+\glsdefs at newdocentry{<label>}%
+{%
+<key value list>
+}%
+
+ - bug fix #162 https://www.dickimaw-books.com/bugtracker.php?key=162
+ (\newacronym without \setacronymstyle but with
+ \glsnoexpandfields has incorrect plurals)
+
+ - bug fix #166 https://www.dickimaw-books.com/bugtracker.php?key=166
+ (\ also needs escaping with makeindex's quote character in the
+ event that the sort value contains commands like \| or \! with
+ sanitizesort=true)
+
+ - bug file #177 https://www.dickimaw-books.com/bugtracker.php?key=177
+ (spurious \glolist@ at the end of glslabels file with writeglslabels option)
+
+ - new package option 'writeglslabelnames'
+ (as writeglslabels but also writes the name)
+
+ - added warnings to deprecated acronym style package options
+ 'description', 'footnote', 'smaller', 'smallcaps', 'dua'
+ and corresponding commands, such as \SetDescriptionFootnoteAcronymStyle.
+
+ (These package options and commands were deprecated in v4.02 2013-12-05
+ and have been labelled as deprecated in the manual since then.)
+ The warnings can be suppressed with the 'nowarn' package option
+ but it's better to use \setacronymstyle instead (or switch to
+ glossaries-extra's abbreviations).
+
+ - replaced some instances of \edef with \protected at edef when
+ defining control sequences that store labels or lists of
+ labels. Similarly for \xdef and \eappto. (Aiming towards
+ support for UTF-8 characters in labels with PDFLaTeX, but may
+ not be fully implemented so not yet documented.)
+
+ Note that letter group formations using TeX
+ (\printnoidxglossary or \printunsrtglossary without bib2gls) still
+ don't work if the sort value starts with a UTF-8 character with
+ PDFLaTeX. (This is also a limitation of makeindex regardless of
+ the TeX engine.)
+
+ - added internal command \@makeglossaries at warn@noprintglossary
+
+ * makeglossaries-lite:
+
+ - added hybrid instructions if glossaries-extra record option detected but not
+ \makeglossaries
+
+ - bug fix #183 https://www.dickimaw-books.com/bugtracker.php?key=183
+ ("bad argument #1 to 'gsub'" when \makeglossaries missing)
+
+ - Only add double-quotes if filename contains any spaces
+ (should address issue #129)
+
+ * makeglossaries:
+
+ - added hybrid instructions if glossaries-extra record option detected but not
+ \makeglossaries
+
+ - only add double-quotes to makeindex/xindy if space occurs in
+ the pathname. (Issue #129 for makeglossaries-lite will probably
+ also cause the same problem for makeglossaries since it relates
+ to the behaviour of certain versions of cmd.exe in Windows.)
+
+ * user manual:
+
+ - some sections have been rearranged.
+
v4.46 (2020-03-19):
* glossaries.sty:
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/README.md 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/README.md 2021-09-23 20:14:27 UTC (rev 60591)
@@ -1,4 +1,4 @@
-# glossaries v4.46 (2020-03-19)
+# glossaries v4.47 (2021-09-20)
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-2020 Nicola Talbot
+Copyright 2007-2021 Nicola Talbot
## DESCRIPTION
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html 2021-09-23 20:13:37 UTC (rev 60590)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html 2021-09-23 20:14:27 UTC (rev 60591)
@@ -6,8 +6,8 @@
>
<head><title></title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
-<meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
+<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" />
@@ -28,6 +28,7 @@
.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;}
@@ -45,6 +46,9 @@
.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;}
@@ -71,6 +75,7 @@
.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;}
@@ -86,6 +91,7 @@
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; }
@media print {div.crosslinks {visibility:hidden;}}
a img { border-top: 0; border-left: 0; border-right: 0; }
center { margin-top:1em; margin-bottom:1em; }
@@ -92,9 +98,12 @@
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:first-child{ margin-bottom; }
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;}
@@ -108,7 +117,7 @@
td.displaylines {text-align:center; white-space:nowrap;}
.centerline {text-align:center;}
.rightline {text-align:right;}
-div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; }
+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; }
@@ -179,7 +188,6 @@
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;}
-.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;}
.verse{white-space:nowrap; margin-left:2em}
div.maketitle {text-align:center;}
h2.titleHead{text-align:center;}
@@ -186,10 +194,10 @@
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; }
-.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; }
h1.partHead{text-align: center}
-.abstract p {margin-left:5%; margin-right:5%;}
+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;}
@@ -210,7 +218,7 @@
.hline hr, .cline hr{border:none;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; }
+.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%; }
@@ -1284,6 +1292,32 @@
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 */
@@ -1292,23 +1326,23 @@
</style>
</head><body
>
-<!--l. 679--><p class="noindent" ><a
+<!--l. 690--><p class="noindent" ><a
id="top"></a>
-</p><!--l. 679--><p class="indent" >
+</p><!--l. 690--><p class="indent" >
-</p><!--l. 679--><p class="indent" >
+</p><!--l. 690--><p class="indent" >
</p>
<div class="center"
>
-<!--l. 679--><p class="noindent" >
-</p><!--l. 679--><p class="noindent" ><span
-class="cmr-17">User Manual for glossaries.sty v4.46</span>
+<!--l. 690--><p class="noindent" >
+</p><!--l. 690--><p class="noindent" ><span
+class="cmr-17">User Manual for glossaries.sty v4.47</span>
</p>
<div class="tabular"> <table id="TBL-1" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-1-1g"><col
id="TBL-1-1" /></colgroup><tr
style="vertical-align:baseline;" id="TBL-1-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-1"
@@ -1320,36 +1354,35 @@
href="http://www.dickimaw-books.com/contact" ><span
class="cmtt-12">dickimaw-books.com/contact</span></a> </td></tr></table>
</div>
-<!--l. 679--><p class="noindent" ><span
-class="cmr-12">2020-03-19</span></p></div>
+<!--l. 690--><p class="noindent" ><span
+class="cmr-12">2021-09-20</span></p></div>
<div
class="abstract"
>
-<!--l. 681--><p class="indent" >
+<!--l. 692--><p class="indent" >
</p>
-<div class="center"
->
-<!--l. 681--><p class="noindent" >
-</p><!--l. 681--><p class="noindent" ><span
-class="cmbx-10">Abstract</span></p></div>
-<!--l. 682--><p class="noindent" >The <span
-class="cmss-10">glossaries </span>package provides a means to define terms or abbreviations or symbols that can be referenced within
-your document. Sorted lists with collated <a
-href="#glo:entrylocation">locations</a> can be generated either using TeX or using a supplementary
-<a
+ <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">§19 </a><a
-href="#sec:samples">Sample
-Documents<!--tex4ht:ref: sec:samples --></a>.
-</p><!--l. 688--><p class="indent" >
+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. 690--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> Additional features not provided here may be available through the extension package <a
+<!--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
@@ -1364,8 +1397,8 @@
id="dx1-2"></a></a>) which isn’t available with just the base <span
class="cmss-10">glossaries </span>package.
</div>
-</p><!--l. 698--><p class="noindent" >
-</p><!--l. 700--><p class="indent" > If you require multilingual support you must also separately install the relevant language module. Each
+</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
@@ -1385,7 +1418,7 @@
id="dx1-4"></a> key in
<span
class="cmtt-10">\printglossary</span>.)
-</p><!--l. 713--><p class="indent" > The <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
@@ -1412,7 +1445,7 @@
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. 728--><p class="indent" > Note that occasionally you may find that certain packages need to be loaded <span
+</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
@@ -1424,7 +1457,7 @@
id="dx1-15"></a>), then ⟨<span
class="cmti-10">X</span>⟩, and finally load <span
class="cmss-10">glossaries</span>.
-</p><!--l. 734--><p class="indent" > <div class="important" title="Important Note"> Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or
+</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
@@ -1431,7 +1464,7 @@
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. 744--><p class="indent" > 😱 If you’re freaking out at the size of this manual, start with <span
+</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>
@@ -1438,74 +1471,75 @@
<span
class="cmtt-10">glossariesbegin.pdf</span>. Once you’ve got to grips with the basics, then come back to this manual to find out how
to adjust the settings. </div>
-</p><!--l. 750--><p class="noindent" >
-</p><!--l. 752--><p class="noindent" >The <span
-class="cmss-10">glossaries </span>bundle comes with the following documentation:
+</p><!--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> </dt><dd
-class="description">If you are a complete beginner, start with <a
-href="glossariesbegin.html" >“The glossaries package: a guide for
- beginners”</a>.
- </dd><dt class="description">
-<a
-href="glossary2glossaries.pdf" class="url" ><span
-class="cmtt-10">glossary2glossaries.pdf</span></a> </dt><dd
-class="description">If you are moving over from the obsolete <span
-class="cmss-10">glossary</span><a
- id="dx1-16"></a> package, read <a
-href="glossary2glossaries.html" >“Upgrading
- from the glossary package to the glossaries package”</a>.
+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" >
- </dd><dt class="description">
<span
-class="cmbx-10">glossaries-user.pdf</span> </dt><dd
-class="description">This document is the main user guide for the <span
+class="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.
- </dd><dt class="description">
+ </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> </dt><dd
-class="description">Advanced users wishing to know more about the inner workings of all the
- packages provided in the <span
-class="cmss-10">glossaries </span>bundle should read “Documented Code for glossaries v4.46”.
- </dd><dt class="description">
+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.47”.
+ </p></dd><dt class="description">
+ <!--l. 780--><p class="noindent" >
<span
-class="cmbx-10">INSTALL</span> </dt><dd
-class="description">Installation instructions.
- </dd><dt class="description">
+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">CHANGES</span> </dt><dd
-class="description">Change log.
- </dd><dt class="description">
-<span
-class="cmbx-10">README.md</span> </dt><dd
-class="description">Package summary.
+class="cmbx-10">README.md</span> </p></dt><dd
+class="description">
+ <!--l. 782--><p class="noindent" >Package summary.
+</p>
</dd></dl>
-<!--l. 781--><p class="noindent" >Related resources: </p>
+<!--l. 785--><p class="noindent" >Related resources: </p>
<ul class="itemize1">
- <li class="itemize"><a
+ <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>.
- </li>
- <li class="itemize"><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>
- </li>
- <li class="itemize"><a
+ </p></li>
+ <li class="itemize">
+ <!--l. 792--><p class="noindent" ><a
href="https://www.dickimaw-books.com/gallery/#glossaries" ><span
-class="cmtt-10">https://www.dickimaw-books.com/gallery/#glossaries</span></a><span
-class="cmss-10">glossaries </span>gallery
- </li>
- <li class="itemize"><a
+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>
- </li>
- <li class="itemize"><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
@@ -1512,55 +1546,59 @@
class="cmss-10">glossaries </span>and <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>).
- </li>
- <li class="itemize"><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).
- </li>
- <li class="itemize"><a
+ </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>
- </li>
- <li class="itemize">The <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>
- </li>
- <li class="itemize"><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></li></ul>
-<!--l. 811--><p class="indent" > <div class="important" title="Important Note"><span class="warningsymbol">⚠</span> If you use <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-17"></a> and <span
+ id="dx1-16"></a> and <span
class="cmss-10">glossaries</span>, you must load <span
class="cmss-10">hyperref</span><a
- id="dx1-18"></a> <span
+ id="dx1-17"></a> <span
class="cmti-10">first </span>(although <span
class="cmss-10">hyperref</span><a
- id="dx1-19"></a> should be loaded after
+ id="dx1-18"></a> should be loaded after
most other packages). Similarly the <span
class="cmss-10">doc</span><a
- id="dx1-20"></a> package must also be loaded before <span
+ 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-21"></a> is loaded, the file
+ 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-22"></a>, <span
+ id="dx1-21"></a>, <span
class="cmtt-10">glo2</span><a
- id="dx1-23"></a> and <span
+ id="dx1-22"></a> and <span
class="cmtt-10">glg2</span><a
- id="dx1-24"></a> to avoid conflict with <span
+ id="dx1-23"></a> to avoid conflict with <span
class="cmss-10">doc</span><a
- id="dx1-25"></a>’s changes
+ id="dx1-24"></a>’s changes
glossary.)<a
id="pdflatexnote"></a>
-
-
-</p><!--l. 821--><p class="indent" > If you are using <span
+</p><!--l. 825--><p class="indent" > If you are using <span
class="cmss-10">hyperref</span><a
- id="dx1-26"></a>, it’s best to use <span
+ id="dx1-25"></a>, it’s best to use <span
class="cmtt-10">pdflatex</span><a
- id="dx1-27"></a> rather than <span
+ id="dx1-26"></a> rather than <span
class="cmtt-10">latex</span><a
- id="dx1-28"></a> (DVI format) as <span
+ 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
@@ -1570,12 +1608,12 @@
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-29"></a> and <span id="textcolor2"><span
+ id="dx1-28"></a> and <span id="textcolor2"><span
class="cmss-10">textformat</span></span><a
- id="dx1-30"></a> attributes set to appropriate values for problematic entries.
+ id="dx1-29"></a> attributes set to appropriate values for problematic entries.
</div>
-</p><!--l. 831--><p class="noindent" >
-</p><!--l. 834--><p class="indent" > <strong>The <span
+</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
@@ -1600,6 +1638,8 @@
href="#sec:languages" id="QQ2-1-15">Multi-Lingual Support</a></span>
<br />   <span class="subsectionToc" >1.3.1 <a
href="#sec:fixednames" id="QQ2-1-16">Changing the Fixed Names</a></span>
+<br />   <span class="subsectionToc" >1.3.2 <a
+href="#pluralsuffix" id="QQ2-1-18">Creating a New Language Module</a></span>
<br />  <span class="sectionToc" >1.4 <a
href="#sec:makeglossaries" id="QQ2-1-19">Generating the Associated Glossary Files</a></span>
<br />   <span class="subsectionToc" >1.4.1 <a
@@ -1607,9 +1647,9 @@
<br />   <span class="subsectionToc" >1.4.2 <a
href="#sec:makeglossarieslua" id="QQ2-1-22">Using the makeglossaries-lite Lua Script</a></span>
<br />   <span class="subsectionToc" >1.4.3 <a
-href="#sec:xindyapp" id="QQ2-1-23">Using xindy explicitly (Option 3)</a></span>
+href="#sec:xindyapp" id="QQ2-1-23">Using xindy explicitly (Option3)</a></span>
<br />   <span class="subsectionToc" >1.4.4 <a
-href="#sec:makeindexapp" id="QQ2-1-24">Using makeindex explicitly (Option 2)</a></span>
+href="#sec:makeindexapp" id="QQ2-1-24">Using makeindex explicitly (Option2)</a></span>
<br />  <span class="sectionToc" >1.5 <a
href="#sec:notedev" id="QQ2-1-25">Note to Front-End and Script Developers</a></span>
<br />   <span class="subsectionToc" >1.5.1 <a
@@ -1623,184 +1663,188 @@
<br />  <span class="sectionToc" >2.1 <a
href="#sec:pkgopts-general" id="QQ2-1-30">General Options</a></span>
<br />  <span class="sectionToc" >2.2 <a
-href="#sec:pkgopts-sec" id="QQ2-1-42">Sectioning, Headings and TOC Options</a></span>
+href="#sec:pkgopts-sec" id="QQ2-1-43">Sectioning, Headings and TOC Options</a></span>
<br />  <span class="sectionToc" >2.3 <a
-href="#sec:pkgopts-printglos" id="QQ2-1-48">Glossary Appearance Options</a></span>
+href="#sec:pkgopts-printglos" id="QQ2-1-49">Glossary Appearance Options</a></span>
<br />  <span class="sectionToc" >2.4 <a
-href="#sec:pkgopts-indexing" id="QQ2-1-65">Indexing Options</a></span>
+href="#sec:pkgopts-indexing" id="QQ2-1-66">Indexing Options</a></span>
<br />  <span class="sectionToc" >2.5 <a
-href="#sec:pkgopts-sort" id="QQ2-1-75">Sorting Options</a></span>
+href="#sec:pkgopts-sort" id="QQ2-1-76">Sorting Options</a></span>
<br />  <span class="sectionToc" >2.6 <a
-href="#sec:pkgopts-type" id="QQ2-1-86">Glossary Type Options</a></span>
+href="#sec:pkgopts-type" id="QQ2-1-87">Glossary Type Options</a></span>
<br />  <span class="sectionToc" >2.7 <a
-href="#sec:pkgopts-acronym" id="QQ2-1-93">Acronym and Abbreviation Options</a></span>
-<br />   <span class="subsectionToc" >2.7.1 <a
-href="#sec:pkgopts-old-acronym" id="QQ2-1-99">Deprecated Acronym Style Options</a></span>
+href="#sec:pkgopts-acronym" id="QQ2-1-94">Acronym and Abbreviation Options</a></span>
<br />  <span class="sectionToc" >2.8 <a
-href="#sec:pkgopts-other" id="QQ2-1-105">Other Options</a></span>
+href="#sec:pkgopts-old-acronym" id="QQ2-1-100">Deprecated Acronym Style Options</a></span>
<br />  <span class="sectionToc" >2.9 <a
-href="#sec:setupglossaries" id="QQ2-1-112">Setting Options After the Package is Loaded</a></span>
+href="#sec:pkgopts-other" id="QQ2-1-106">Other Options</a></span>
+<br />  <span class="sectionToc" >2.10 <a
+href="#sec:setupglossaries" id="QQ2-1-113">Setting Options After the Package is Loaded</a></span>
<br /> <span class="chapterToc" >3 <a
-href="#sec:setup" id="QQ2-1-113">Setting Up</a></span>
+href="#sec:setup" id="QQ2-1-114">Setting Up</a></span>
<br />  <span class="sectionToc" >3.1 <a
-href="#sec:setupopt1" id="QQ2-1-114">Option 1</a></span>
+href="#sec:setupopt1" id="QQ2-1-115">Option 1</a></span>
<br />  <span class="sectionToc" >3.2 <a
-href="#sec:setupopt23" id="QQ2-1-115">Options 2 and 3</a></span>
+href="#sec:setupopt23" id="QQ2-1-116">Options 2 and 3</a></span>
<br /> <span class="chapterToc" >4 <a
-href="#sec:newglosentry" id="QQ2-1-116">Defining Glossary Entries</a></span>
+href="#sec:newglosentry" id="QQ2-1-117">Defining Glossary Entries</a></span>
<br />  <span class="sectionToc" >4.1 <a
-href="#sec:plurals" id="QQ2-1-117">Plurals</a></span>
+href="#sec:plurals" id="QQ2-1-118">Plurals</a></span>
<br />  <span class="sectionToc" >4.2 <a
-href="#sec:grammar" id="QQ2-1-118">Other Grammatical Constructs</a></span>
+href="#sec:grammar" id="QQ2-1-119">Other Grammatical Constructs</a></span>
<br />  <span class="sectionToc" >4.3 <a
-href="#sec:addkey" id="QQ2-1-119">Additional Keys</a></span>
+href="#sec:addkey" id="QQ2-1-120">Additional Keys</a></span>
<br />   <span class="subsectionToc" >4.3.1 <a
-href="#sec:glsaddkey" id="QQ2-1-120">Document Keys</a></span>
-<br />   <span class="subsectionToc" >4.3.2 <a
-href="#sec:glsaddstoragekey" id="QQ2-1-121">Storage Keys</a></span>
+href="#sec:glsaddkey" id="QQ2-1-121">Document Keys</a></span>
+<br />   <span class="subsectionToc" >4.3.2 <a
+href="#sec:glsaddstoragekey" id="QQ2-1-122">Storage Keys</a></span>
<br />  <span class="sectionToc" >4.4 <a
-href="#sec:expansion" id="QQ2-1-122">Expansion</a></span>
+href="#sec:expansion" id="QQ2-1-123">Expansion</a></span>
<br />  <span class="sectionToc" >4.5 <a
-href="#sec:subentries" id="QQ2-1-124">Sub-Entries</a></span>
+href="#sec:subentries" id="QQ2-1-125">Sub-Entries</a></span>
<br />   <span class="subsectionToc" >4.5.1 <a
-href="#sec:hierarchical" id="QQ2-1-125">Hierarchical Categories</a></span>
+href="#sec:hierarchical" id="QQ2-1-126">Hierarchical Categories</a></span>
<br />   <span class="subsectionToc" >4.5.2 <a
-href="#sec:homographs" id="QQ2-1-126">Homographs</a></span>
+href="#sec:homographs" id="QQ2-1-127">Homographs</a></span>
<br />  <span class="sectionToc" >4.6 <a
-href="#sec:loadglsentries" id="QQ2-1-127">Loading Entries From a File</a></span>
+href="#sec:loadglsentries" id="QQ2-1-128">Loading Entries From a File</a></span>
<br />  <span class="sectionToc" >4.7 <a
-href="#sec:moveentry" id="QQ2-1-128">Moving Entries to Another Glossary</a></span>
+href="#sec:moveentry" id="QQ2-1-129">Moving Entries to Another Glossary</a></span>
<br />  <span class="sectionToc" >4.8 <a
-href="#sec:docdefs" id="QQ2-1-129">Drawbacks With Defining Entries in the Document Environment</a></span>
+href="#sec:docdefs" id="QQ2-1-130">Drawbacks With Defining Entries in the Document Environment</a></span>
<br />   <span class="subsectionToc" >4.8.1 <a
-href="#sec:techissues" id="QQ2-1-130">Technical Issues</a></span>
+href="#sec:techissues" id="QQ2-1-131">Technical Issues</a></span>
<br />   <span class="subsectionToc" >4.8.2 <a
-href="#sec:goodpractice" id="QQ2-1-131">Good Practice Issues</a></span>
+href="#sec:goodpractice" id="QQ2-1-132">Good Practice Issues</a></span>
<br /> <span class="chapterToc" >5 <a
-href="#sec:numberlists" id="QQ2-1-132">Number lists</a></span>
+href="#sec:usingentries" id="QQ2-1-133">Referencing Entries in the Document</a></span>
<br />  <span class="sectionToc" >5.1 <a
-href="#sec:encap" id="QQ2-1-133">Encap Values</a></span>
+href="#sec:glslink" id="QQ2-1-134">Links to Glossary Entries</a></span>
+<br />   <span class="subsectionToc" >5.1.1 <a
+href="#sec:gls-like" id="QQ2-1-136">The <span
+class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</a></span>
+<br />   <span class="subsectionToc" >5.1.2 <a
+href="#sec:glstext-like" id="QQ2-1-137">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-138">Changing the format of the link text</a></span>
+<br />   <span class="subsectionToc" >5.1.4 <a
+href="#sec:disablehyperlinks" id="QQ2-1-139">Enabling and disabling hyperlinks to glossary entries</a></span>
<br />  <span class="sectionToc" >5.2 <a
-href="#sec:locationsyntax" id="QQ2-1-134">Locations</a></span>
-<br />  <span class="sectionToc" >5.3 <a
-href="#sec:ranges" id="QQ2-1-135">Range Formations</a></span>
-<br />  <span class="sectionToc" >5.4 <a
-href="#sec:isthook" id="QQ2-1-136">Style Hook</a></span>
+href="#sec:glsnolink" id="QQ2-1-140">Using Glossary Terms Without Links</a></span>
<br /> <span class="chapterToc" >6 <a
-href="#sec:glslink" id="QQ2-1-137">Links to Glossary Entries</a></span>
+href="#sec:acronyms" id="QQ2-1-141">Acronyms and Other Abbreviations</a></span>
<br />  <span class="sectionToc" >6.1 <a
-href="#sec:gls-like" id="QQ2-1-139">The <span
-class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</a></span>
+href="#sec:longshortfull" id="QQ2-1-142">Displaying the Long, Short and Full Forms (Independent of First Use)</a></span>
<br />  <span class="sectionToc" >6.2 <a
-href="#sec:glstext-like" id="QQ2-1-140">The <span
-class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)</a></span>
+href="#sec:setacronymstyle" id="QQ2-1-144">Changing the Acronym Style</a></span>
+<br />   <span class="subsectionToc" >6.2.1 <a
+href="#sec:predefinedacrstyles" id="QQ2-1-145">Predefined Acronym Styles</a></span>
+<br />   <span class="subsectionToc" >6.2.2 <a
+href="#sec:customacronym" id="QQ2-1-146">Defining A Custom Acronym Style</a></span>
<br />  <span class="sectionToc" >6.3 <a
-href="#sec:glsdisplay" id="QQ2-1-141">Changing the format of the link text</a></span>
+href="#sec:disploa" id="QQ2-1-147">Displaying the List of Acronyms</a></span>
<br />  <span class="sectionToc" >6.4 <a
-href="#sec:disablehyperlinks" id="QQ2-1-142">Enabling and disabling hyperlinks to glossary entries</a></span>
+href="#sec:oldacronym" id="QQ2-1-148">Upgrading From the glossary Package</a></span>
<br /> <span class="chapterToc" >7 <a
-href="#sec:glsadd" id="QQ2-1-143">Adding an Entry to the Glossary Without Generating Text</a></span>
+href="#sec:glsunset" id="QQ2-1-150">Unsetting and Resetting Entry Flags</a></span>
+<br />  <span class="sectionToc" >7.1 <a
+href="#sec:enableentrycount" id="QQ2-1-151">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span>
<br /> <span class="chapterToc" >8 <a
-href="#sec:crossref" id="QQ2-1-144">Cross-Referencing Entries</a></span>
-<br />  <span class="sectionToc" >8.1 <a
-href="#sec:customxr" id="QQ2-1-145">Customising Cross-reference Text</a></span>
+href="#sec:printglossary" id="QQ2-1-152">Displaying a Glossary</a></span>
<br /> <span class="chapterToc" >9 <a
-href="#sec:glsnolink" id="QQ2-1-146">Using Glossary Terms Without Links</a></span>
+href="#sec:newglossary" id="QQ2-1-153">Defining New Glossaries</a></span>
<br /> <span class="chapterToc" >10 <a
-href="#sec:printglossary" id="QQ2-1-147">Displaying a glossary</a></span>
+href="#sec:glsadd" id="QQ2-1-154">Adding an Entry to the Glossary Without Generating Text</a></span>
<br /> <span class="chapterToc" >11 <a
-href="#sec:xindy" id="QQ2-1-148">Xindy (Option 3)</a></span>
+href="#sec:crossref" id="QQ2-1-155">Cross-Referencing Entries</a></span>
<br />  <span class="sectionToc" >11.1 <a
-href="#sec:langenc" id="QQ2-1-149">Language and Encodings</a></span>
-<br />  <span class="sectionToc" >11.2 <a
-href="#sec:xindyloc" id="QQ2-1-150">Locations and Number lists</a></span>
-<br />  <span class="sectionToc" >11.3 <a
-href="#sec:groups" id="QQ2-1-151">Glossary Groups</a></span>
+href="#sec:customxr" id="QQ2-1-156">Customising Cross-reference Text</a></span>
<br /> <span class="chapterToc" >12 <a
-href="#sec:newglossary" id="QQ2-1-152">Defining New Glossaries</a></span>
+href="#sec:numberlists" id="QQ2-1-157">Number Lists</a></span>
+<br />  <span class="sectionToc" >12.1 <a
+href="#sec:encap" id="QQ2-1-158">Encap Values (Location Formats)</a></span>
+<br />  <span class="sectionToc" >12.2 <a
+href="#sec:locationsyntax" id="QQ2-1-159">Locations</a></span>
+<br />  <span class="sectionToc" >12.3 <a
+href="#sec:ranges" id="QQ2-1-160">Range Formations</a></span>
+<br />  <span class="sectionToc" >12.4 <a
+href="#sec:isthook" id="QQ2-1-161">Style Hook</a></span>
<br /> <span class="chapterToc" >13 <a
-href="#sec:acronyms" id="QQ2-1-153">Acronyms and Other Abbreviations</a></span>
+href="#sec:styles" id="QQ2-1-162">Glossary Styles</a></span>
<br />  <span class="sectionToc" >13.1 <a
-href="#sec:setacronymstyle" id="QQ2-1-155">Changing the Abbreviation Style</a></span>
+href="#sec:predefinedstyles" id="QQ2-1-163">Predefined Styles</a></span>
<br />   <span class="subsectionToc" >13.1.1 <a
-href="#sec:predefinedacrstyles" id="QQ2-1-156">Predefined Acronym Styles</a></span>
+href="#sec:liststyles" id="QQ2-1-165">List Styles</a></span>
<br />   <span class="subsectionToc" >13.1.2 <a
-href="#sec:customacronym" id="QQ2-1-157">Defining A Custom Acronym Style</a></span>
+href="#sec:longstyles" id="QQ2-1-166">Longtable Styles</a></span>
+<br />   <span class="subsectionToc" >13.1.3 <a
+href="#sec:longraggedstyles" id="QQ2-1-167">Longtable Styles (Ragged Right)</a></span>
+<br />   <span class="subsectionToc" >13.1.4 <a
+href="#sec:longbooktabsstyles" id="QQ2-1-168">Longtable Styles (<span
+class="cmss-10">booktabs</span>)</a></span>
+<br />   <span class="subsectionToc" >13.1.5 <a
+href="#sec:superstyles" id="QQ2-1-169">Supertabular Styles</a></span>
+<br />   <span class="subsectionToc" >13.1.6 <a
+href="#sec:superraggedstyles" id="QQ2-1-170">Supertabular Styles (Ragged Right)</a></span>
+<br />   <span class="subsectionToc" >13.1.7 <a
+href="#sec:treestyles" id="QQ2-1-171">Tree-Like Styles</a></span>
+<br />   <span class="subsectionToc" >13.1.8 <a
+href="#sec:mcolstyles" id="QQ2-1-172">Multicols Style</a></span>
+
+
+<br />   <span class="subsectionToc" >13.1.9 <a
+href="#sec:inline" id="QQ2-1-174">In-Line Style</a></span>
<br />  <span class="sectionToc" >13.2 <a
-href="#sec:disploa" id="QQ2-1-158">Displaying the List of Acronyms</a></span>
-<br />  <span class="sectionToc" >13.3 <a
-href="#sec:oldacronym" id="QQ2-1-159">Upgrading From the glossary Package</a></span>
+href="#sec:newglossarystyle" id="QQ2-1-175">Defining your own glossary style</a></span>
<br /> <span class="chapterToc" >14 <a
-href="#sec:glsunset" id="QQ2-1-161">Unsetting and Resetting Entry Flags</a></span>
+href="#sec:xindy" id="QQ2-1-176">Xindy (Option 3)</a></span>
<br />  <span class="sectionToc" >14.1 <a
-href="#sec:enableentrycount" id="QQ2-1-162">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span>
+href="#sec:langenc" id="QQ2-1-177">Language and Encodings</a></span>
+<br />  <span class="sectionToc" >14.2 <a
+href="#sec:xindyloc" id="QQ2-1-178">Locations and Number lists</a></span>
+<br />  <span class="sectionToc" >14.3 <a
+href="#sec:groups" id="QQ2-1-179">Glossary Groups</a></span>
<br /> <span class="chapterToc" >15 <a
-href="#sec:styles" id="QQ2-1-163">Glossary Styles</a></span>
+href="#sec:utilities" id="QQ2-1-180">Utilities</a></span>
<br />  <span class="sectionToc" >15.1 <a
-href="#sec:predefinedstyles" id="QQ2-1-164">Predefined Styles</a></span>
-<br />   <span class="subsectionToc" >15.1.1 <a
-href="#sec:liststyles" id="QQ2-1-166">List Styles</a></span>
-<br />   <span class="subsectionToc" >15.1.2 <a
-href="#sec:longstyles" id="QQ2-1-167">Longtable Styles</a></span>
-<br />   <span class="subsectionToc" >15.1.3 <a
-href="#sec:longraggedstyles" id="QQ2-1-168">Longtable Styles (Ragged Right)</a></span>
-<br />   <span class="subsectionToc" >15.1.4 <a
-href="#sec:longbooktabsstyles" id="QQ2-1-169">Longtable Styles (<span
-class="cmss-10">booktabs</span>)</a></span>
-<br />   <span class="subsectionToc" >15.1.5 <a
-href="#sec:superstyles" id="QQ2-1-170">Supertabular Styles</a></span>
-<br />   <span class="subsectionToc" >15.1.6 <a
-href="#sec:superraggedstyles" id="QQ2-1-171">Supertabular Styles (Ragged Right)</a></span>
-<br />   <span class="subsectionToc" >15.1.7 <a
-href="#sec:treestyles" id="QQ2-1-172">Tree-Like Styles</a></span>
-
-
-<br />   <span class="subsectionToc" >15.1.8 <a
-href="#sec:mcolstyles" id="QQ2-1-173">Multicols Style</a></span>
-<br />   <span class="subsectionToc" >15.1.9 <a
-href="#sec:inline" id="QQ2-1-175">In-Line Style</a></span>
+href="#sec:loops" id="QQ2-1-181">Loops</a></span>
<br />  <span class="sectionToc" >15.2 <a
-href="#sec:newglossarystyle" id="QQ2-1-176">Defining your own glossary style</a></span>
+href="#sec:conditionals" id="QQ2-1-182">Conditionals</a></span>
+<br />  <span class="sectionToc" >15.3 <a
+href="#sec:fetchset" id="QQ2-1-183">Fetching and Updating the Value of a Field</a></span>
<br /> <span class="chapterToc" >16 <a
-href="#sec:utilities" id="QQ2-1-177">Utilities</a></span>
-<br />  <span class="sectionToc" >16.1 <a
-href="#sec:loops" id="QQ2-1-178">Loops</a></span>
-<br />  <span class="sectionToc" >16.2 <a
-href="#sec:conditionals" id="QQ2-1-179">Conditionals</a></span>
-<br />  <span class="sectionToc" >16.3 <a
-href="#sec:fetchset" id="QQ2-1-180">Fetching and Updating the Value of a Field</a></span>
+href="#sec:prefix" id="QQ2-1-184">Prefixes or Determiners</a></span>
<br /> <span class="chapterToc" >17 <a
-href="#sec:prefix" id="QQ2-1-181">Prefixes or Determiners</a></span>
+href="#sec:accsupp" id="QQ2-1-185">Accessibility Support</a></span>
<br /> <span class="chapterToc" >18 <a
-href="#sec:accsupp" id="QQ2-1-182">Accessibility Support</a></span>
+href="#sec:samples" id="QQ2-1-186">Sample Documents</a></span>
+<br />  <span class="sectionToc" >18.1 <a
+href="#sec:samplesbasic" id="QQ2-1-187">Basic</a></span>
+<br />  <span class="sectionToc" >18.2 <a
+href="#sec:sampleacronyms" id="QQ2-1-190">Acronyms and First Use</a></span>
+<br />  <span class="sectionToc" >18.3 <a
+href="#sec:samplecounter" id="QQ2-1-200">Non-Page Locations</a></span>
+<br />  <span class="sectionToc" >18.4 <a
+href="#sec:samplestype" id="QQ2-1-204">Multiple Glossaries</a></span>
+<br />  <span class="sectionToc" >18.5 <a
+href="#sec:samplessort" id="QQ2-1-209">Sorting</a></span>
+<br />  <span class="sectionToc" >18.6 <a
+href="#sec:samplesparent" id="QQ2-1-212">Child Entries</a></span>
+<br />  <span class="sectionToc" >18.7 <a
+href="#sec:samplescrossref" id="QQ2-1-216">Cross-Referencing</a></span>
+<br />  <span class="sectionToc" >18.8 <a
+href="#sec:samplescustomkeys" id="QQ2-1-218">Custom Keys</a></span>
+<br />  <span class="sectionToc" >18.9 <a
+href="#sec:samplesxindy" id="QQ2-1-223">Xindy (Option 3)</a></span>
+<br />  <span class="sectionToc" >18.10 <a
+href="#sec:samplesnoidx" id="QQ2-1-228">No Indexing Application (Option 1)</a></span>
+<br />  <span class="sectionToc" >18.11 <a
+href="#sec:samplesother" id="QQ2-1-231">Other</a></span>
<br /> <span class="chapterToc" >19 <a
-href="#sec:samples" id="QQ2-1-183">Sample Documents</a></span>
-<br />  <span class="sectionToc" >19.1 <a
-href="#sec:samplesbasic" id="QQ2-1-184">Basic</a></span>
-<br />  <span class="sectionToc" >19.2 <a
-href="#sec:sampleacronyms" id="QQ2-1-187">Acronyms and First Use</a></span>
-<br />  <span class="sectionToc" >19.3 <a
-href="#sec:samplecounter" id="QQ2-1-197">Non-Page Locations</a></span>
-<br />  <span class="sectionToc" >19.4 <a
-href="#sec:samplestype" id="QQ2-1-201">Multiple Glossaries</a></span>
-<br />  <span class="sectionToc" >19.5 <a
-href="#sec:samplessort" id="QQ2-1-206">Sorting</a></span>
-<br />  <span class="sectionToc" >19.6 <a
-href="#sec:samplesparent" id="QQ2-1-209">Child Entries</a></span>
-<br />  <span class="sectionToc" >19.7 <a
-href="#sec:samplescrossref" id="QQ2-1-213">Cross-Referencing</a></span>
-<br />  <span class="sectionToc" >19.8 <a
-href="#sec:samplescustomkeys" id="QQ2-1-215">Custom Keys</a></span>
-<br />  <span class="sectionToc" >19.9 <a
-href="#sec:samplesxindy" id="QQ2-1-220">Xindy (Option 3)</a></span>
-<br />  <span class="sectionToc" >19.10 <a
-href="#sec:samplesnoidx" id="QQ2-1-225">No Indexing Application (Option 1)</a></span>
-<br />  <span class="sectionToc" >19.11 <a
-href="#sec:samplesother" id="QQ2-1-228">Other</a></span>
-<br /> <span class="chapterToc" >20 <a
-href="#sec:trouble" id="QQ2-1-237">Troubleshooting</a></span>
+href="#sec:trouble" id="QQ2-1-240">Troubleshooting</a></span>
</div>
@@ -1816,14 +1860,14 @@
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" >6.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" >13.1 <a
+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" >13.2 <a
-href="#tab:xspace">The
-effect of using xspace</a></span><br /><span class="lotToc" >15.1 <a
-href="#tab:styles">Glossary Styles</a></span><br /><span class="lotToc" >15.2 <a
+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>
@@ -1832,16 +1876,17 @@
<!--l. 1--><p class="indent" > <a
id="likesection.1"></a><a
+ id="x1-2001x1"></a><a
id="Q1-1-3"></a>
</p>
<h2 class="likechapterHead"><a
- id="x1-3000"></a>Glossary</h2>
+ 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" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"><span
@@ -1850,7 +1895,7 @@
class="cmtt-10">xindy,</span>
</td></tr></table>
<!--l. 1--><p class="indent" > </p><table
-cellpadding="0" border="0" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"> </td><td
@@ -1857,7 +1902,7 @@
class="tabbing"><span
class="cmtt-10">nonumberlist,</span></td></tr></table>
<!--l. 1--><p class="indent" > </p><table
-cellpadding="0" border="0" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"></td><td
@@ -1864,7 +1909,7 @@
class="tabbing"><span
class="cmtt-10">toc,</span></td></tr></table>
<!--l. 1--><p class="indent" > </p><table
-cellpadding="0" border="0" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"></td><td
@@ -1871,7 +1916,7 @@
class="tabbing"><span
class="cmtt-10">nopostdot,</span></td></tr></table>
<!--l. 1--><p class="indent" > </p><table
-cellpadding="0" border="0" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"></td><td
@@ -1878,7 +1923,7 @@
class="tabbing"><span
class="cmtt-10">style=altlist,</span></td></tr></table>
<!--l. 1--><p class="indent" > </p><table
-cellpadding="0" border="0" cellspacing="0"
+cellpadding="0" border="0"
class="tabbing"><tr
style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
class="tabbing"></td><td
@@ -1889,11 +1934,13 @@
class="cmsy-10">}</span></td></tr></table>
<!--l. 1--><p class="indent" >
</p><dl class="description"><dt class="description">
+ <!--l. 90--><p class="noindent" >
<a
id="glo:bib2gls"></a><span
class="cmtt-10">bib2gls</span><a
- id="dx1-3001"></a> </dt><dd
-class="description"><br
+ id="dx1-3001"></a> </p></dt><dd
+class="description">
+ <!--l. 90--><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
@@ -1915,21 +1962,25 @@
class="cmss-10">glossaries </span>package. See <a
href="#option4">Option 4</a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 96--><p class="noindent" >
<a
id="glo:cli"></a><span
-class="cmbx-10">Command Line Interface (CLI)</span> </dt><dd
-class="description"><br
+class="cmbx-10">Command Line Interface (CLI)</span> </p></dt><dd
+class="description">
+ <!--l. 96--><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" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 109--><p class="noindent" >
<a
id="glo:convertgls2bib"></a><span
class="cmtt-10">convertgls2bib</span><a
- id="dx1-3006"></a> </dt><dd
-class="description"><br
+ id="dx1-3006"></a> </p></dt><dd
+class="description">
+ <!--l. 109--><p class="noindent" ><br
class="newline" />An application provided with <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
@@ -1942,6 +1993,8 @@
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
@@ -1954,21 +2007,25 @@
id="dx1-3012"></a></a>
v2.0). <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 113--><p class="noindent" >
<a
id="glo:entrylocation"></a><span
class="cmbx-10">Entry location</span><a
- id="dx1-3013"></a> </dt><dd
-class="description"><br
+ id="dx1-3013"></a> </p></dt><dd
+class="description">
+ <!--l. 113--><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" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 121--><p class="noindent" >
<a
id="glo:exlatinalph"></a><span
class="cmbx-10">Extended Latin Alphabet</span><a
- id="dx1-3014"></a> </dt><dd
-class="description"><br
+ id="dx1-3014"></a> </p></dt><dd
+class="description">
+ <!--l. 121--><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
@@ -1975,12 +2032,14 @@
href="#glo:exlatinchar">extended Latin character<a
id="dx1-3016"></a>s</a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 126--><p class="noindent" >
<a
id="glo:exlatinchar"></a><span
class="cmbx-10">Extended Latin Character</span><a
- id="dx1-3017"></a> </dt><dd
-class="description"><br
+ id="dx1-3017"></a> </p></dt><dd
+class="description">
+ <!--l. 126--><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
@@ -1989,12 +2048,14 @@
href="#glo:nonlatinchar">non-Latin character<a
id="dx1-3020"></a></a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 161--><p class="noindent" >
<a
id="glo:firstuse"></a><span
class="cmbx-10">First use</span><a
- id="dx1-3021"></a> </dt><dd
-class="description"><br
+ id="dx1-3021"></a> </p></dt><dd
+class="description">
+ <!--l. 161--><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
@@ -2015,25 +2076,32 @@
flag</a> & <a
href="#glo:firstusetext">first use text</a>.) <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 180--><p class="noindent" >
<a
id="glo:firstuseflag"></a><span
class="cmbx-10">First use flag</span><a
- id="dx1-3029"></a> </dt><dd
-class="description"><br
+ id="dx1-3029"></a> </p></dt><dd
+class="description">
+ <!--l. 180--><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">§14 </a><a
-href="#sec:glsunset">Unsetting and Resetting
- Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br
+href="#sec:glsunset">§<span
+class="cmbx-10">??</span>sec:glsunset </a><a
+href="#sec:glsunset">Unsetting
+ and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br
class="newline" />
- </dd><dt class="description">
+
+
+ </p></dd><dt class="description">
+ <!--l. 182--><p class="noindent" >
<a
id="glo:firstusetext"></a><span
class="cmbx-10">First use text</span><a
- id="dx1-3030"></a> </dt><dd
-class="description"><br
+ id="dx1-3030"></a> </p></dt><dd
+class="description">
+ <!--l. 182--><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
@@ -2048,11 +2116,13 @@
class="cmtt-10">\defglsentry</span><a
id="dx1-3035"></a>.) <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 278--><p class="noindent" >
<a
id="glo:glossaries-extra"></a><span
-class="cmssbx-10">glossaries-extra</span> </dt><dd
-class="description"><br
+class="cmssbx-10">glossaries-extra</span> </p></dt><dd
+class="description">
+ <!--l. 278--><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
@@ -2061,11 +2131,13 @@
<span
class="cmss-10">glossaries-extra </span>package installed. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 298--><p class="noindent" >
<a
id="glo:indexingapp"></a><span
-class="cmbx-10">Indexing application</span> </dt><dd
-class="description"><br
+class="cmbx-10">Indexing application</span> </p></dt><dd
+class="description">
+ <!--l. 298--><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
@@ -2078,25 +2150,27 @@
id="dx1-3037"></a></a>. These are both <a
href="#glo:cli">command line interface (CLI)</a> applications. <br
class="newline" />
-
-
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 302--><p class="noindent" >
<a
id="glo:latinalph"></a><span
class="cmbx-10">Latin Alphabet</span><a
- id="dx1-3038"></a> </dt><dd
-class="description"><br
+ id="dx1-3038"></a> </p></dt><dd
+class="description">
+ <!--l. 302--><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" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 306--><p class="noindent" >
<a
id="glo:latinchar"></a><span
class="cmbx-10">Latin Character</span><a
- id="dx1-3040"></a> </dt><dd
-class="description"><br
+ id="dx1-3040"></a> </p></dt><dd
+class="description">
+ <!--l. 306--><p class="noindent" ><br
class="newline" />One of the letters <span
class="cmtt-10">a</span>, …, <span
class="cmtt-10">z</span>, <span
@@ -2105,23 +2179,29 @@
href="#glo:exlatinchar">extended Latin character<a
id="dx1-3041"></a></a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 326--><p class="noindent" >
<a
id="glo:linktext"></a><span
class="cmbx-10">Link text</span><a
- id="dx1-3042"></a> </dt><dd
-class="description"><br
+ id="dx1-3042"></a> </p></dt><dd
+class="description">
+
+
+ <!--l. 326--><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" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 362--><p class="noindent" >
<a
id="glo:makeglossaries"></a><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-3044"></a> </dt><dd
-class="description"><br
+ id="dx1-3044"></a> </p></dt><dd
+class="description">
+ <!--l. 362--><p class="noindent" ><br
class="newline" />A custom designed Perl script interface to <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
@@ -2135,12 +2215,14 @@
executable <span
class="cmtt-10">makeglossaries.exe </span>for convenience (but Perl is still required). <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 365--><p class="noindent" >
<a
id="glo:makeglossariesgui"></a><span
class="cmtt-10">makeglossariesgui</span><a
- id="dx1-3047"></a> </dt><dd
-class="description"><br
+ id="dx1-3047"></a> </p></dt><dd
+class="description">
+ <!--l. 365--><p class="noindent" ><br
class="newline" />A Java GUI alternative to <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
@@ -2148,12 +2230,14 @@
on <a
href="http://ctan.org/pkg/makeglossariesgui" >CTAN</a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 385--><p class="noindent" >
<a
id="glo:makeglossaries-lite.lua"></a><span
class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-3049"></a> </dt><dd
-class="description"><br
+ id="dx1-3049"></a> </p></dt><dd
+class="description">
+ <!--l. 385--><p class="noindent" ><br
class="newline" />A custom designed Lua script interface to <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
@@ -2175,34 +2259,40 @@
class="cmtt-10">makeglossaries-lite.lua</span>
script. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 440--><p class="noindent" >
<a
id="glo:makeindex"></a><span
class="cmtt-10">makeindex</span><a
- id="dx1-3053"></a> </dt><dd
-class="description"><br
+ id="dx1-3053"></a> </p></dt><dd
+class="description">
+ <!--l. 440--><p class="noindent" ><br
class="newline" />An <a
href="#glo:indexingapp">indexing application</a>. See <a
href="#option2">Option 2</a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 448--><p class="noindent" >
<a
id="glo:nonlatinalph"></a><span
class="cmbx-10">Non-Latin Alphabet</span><a
- id="dx1-3054"></a> </dt><dd
-class="description"><br
+ id="dx1-3054"></a> </p></dt><dd
+class="description">
+
+
+ <!--l. 448--><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" />
-
-
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 458--><p class="noindent" >
<a
id="glo:nonlatinchar"></a><span
class="cmbx-10">Non-Latin Character</span><a
- id="dx1-3056"></a> </dt><dd
-class="description"><br
+ id="dx1-3056"></a> </p></dt><dd
+class="description">
+ <!--l. 458--><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
@@ -2209,12 +2299,14 @@
href="#glo:latinchar">Latin character<a
id="dx1-3058"></a></a>. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 506--><p class="noindent" >
<a
id="glo:numberlist"></a><span
class="cmbx-10">Number list</span><a
- id="dx1-3059"></a> </dt><dd
-class="description"><br
+ id="dx1-3059"></a> </p></dt><dd
+class="description">
+ <!--l. 506--><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
@@ -2221,12 +2313,14 @@
class="cmss-10">nonumberlist</span><a
id="dx1-3060"></a> package option. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 512--><p class="noindent" >
<a
id="glo:sanitize"></a><span
class="cmbx-10">Sanitize</span><a
- id="dx1-3061"></a> </dt><dd
-class="description"><br
+ id="dx1-3061"></a> </p></dt><dd
+class="description">
+ <!--l. 512--><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
@@ -2236,7 +2330,7 @@
class="cmtt-10">o</span>. Depending on the font, the backslash character
may appear as a dash when used in the main document text, so <span
class="cmtt-10">\foo </span>will appear as: —foo.
- <!--l. 496--><p class="noindent" >Earlier versions of <span
+ </p><!--l. 512--><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
@@ -2244,11 +2338,13 @@
key. <br
class="newline" />
</p></dd><dt class="description">
+ <!--l. 521--><p class="noindent" >
<a
id="glo:smallcaps"></a><span
class="cmbx-10">Small caps</span><a
- id="dx1-3063"></a> </dt><dd
-class="description"><br
+ id="dx1-3063"></a> </p></dt><dd
+class="description">
+ <!--l. 521--><p class="noindent" ><br
class="newline" />Small capitals. The LaTeX kernel provides <span
class="cmtt-10">\textsc</span><a
id="dx1-3064"></a><span
@@ -2272,13 +2368,17 @@
slanted properties. In this case, there will be a font substitution warning and one of the properties
(such as small caps or slanted) will be dropped. <br
class="newline" />
- </dd><dt class="description">
+
+
+ </p></dd><dt class="description">
+ <!--l. 525--><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> </dt><dd
-class="description"><br
+ id="dx1-3067"></a> </p></dt><dd
+class="description">
+ <!--l. 525--><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
@@ -2286,21 +2386,37 @@
<span
class="cmtt-10">\’e </span>(é). That is, the character can be produced without the need to load a particular package. <br
class="newline" />
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 535--><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. 535--><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. 590--><p class="noindent" >
+<a
id="glo:xindy"></a><span
class="cmtt-10">xindy</span><a
- id="dx1-3069"></a> </dt><dd
-class="description"><br
+ id="dx1-3070"></a> </p></dt><dd
+class="description">
+ <!--l. 590--><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" /></dd></dl>
+class="newline" /></p></dd></dl>
-<!--l. 853--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a
+<!--l. 857--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a
id="sec:intro"></a>Introduction</h2>
-</p><!--l. 856--><p class="indent" > The <span
+</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
@@ -2307,7 +2423,7 @@
to customize the format of the glossary and define multiple glossaries. It also supports glossary
styles that include an associated symbol (in addition to a name and description) for each glossary
entry.
-</p><!--l. 866--><p class="indent" > There is provision for loading a database of glossary entries. Only those entries
+</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
@@ -2314,56 +2430,56 @@
the document will be displayed in the glossary. (Unless you use <a
href="#option5">Option 5</a>, which doesn’t use any indexing but
will instead list all defined entries in order of definition.)
-</p><!--l. 875--><p class="indent" > It’s not necessary to actually have a glossary in the document. You may be interested in using this package
+</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. 881--><p class="indent" > The simplest document is one without a glossary:
+</p><!--l. 885--><p class="indent" > The simplest document is one without a glossary:
</p>
- <div class="verbatim" id="verbatim-1">
+ <pre class="verbatim" id="verbatim-1">
\documentclass{article}
- <br />\usepackage[
- <br />  sort=none % no sorting or indexing required
- <br />]
- <br />{glossaries}
- <br />\newglossaryentry
- <br /> {cafe}% label
- <br /> {% definition:
- <br />   name={caf\'e},
- <br />   description={small restaurant selling refreshments}
- <br /> }
- <br />\setacronymstyle{long-short}
- <br />\newacronym
- <br /> {html}% label
- <br /> {HTML}% short form
- <br /> {hypertext markup language}% long form
- <br />\newglossaryentry
- <br /> {pi}% label
- <br /> {% definition:
- <br />   name={\ensuremath{\pi}},
- <br />   description={Archimedes' Constant}
- <br /> }
- <br />\newglossaryentry
- <br /> {distance}% label
- <br /> {% definition:
- <br />   name={distance},
- <br />   description={the length between two points},
- <br />   symbol={m}
- <br /> }
- <br />\begin{document}
- <br />First use: \gls{cafe}, \gls{html}, \gls{pi}.
- <br />Next use: \gls{cafe}, \gls{html}, \gls{pi}.
- <br />\Gls{distance} (\glsentrydesc{distance}) is measured in
- <br />\glssymbol{distance}.
- <br />\end{document}
-</div>
-<!--l. 925--><p class="nopar" > (This is a trivial example. For a real document I recommend you use <span
+\usepackage[
+  sort=none % no sorting or indexing required
+]
+{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. 929--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a
+</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
@@ -2379,10 +2495,10 @@
</p>
- <div class="verbatim" id="verbatim-2">
+ <pre class="verbatim" id="verbatim-2">
\documentclass{article}
-</div>
-<!--l. 937--><p class="nopar" > </p><div class="alltt">
+</pre>
+<!--l. 941--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\usepackage[</span>
@@ -2435,15 +2551,15 @@
</div>
- <div class="verbatim" id="verbatim-3">
+ <pre class="verbatim" id="verbatim-3">
\newglossaryentry % provided by glossaries.sty
- <br /> {cafe}% label
- <br /> {% definition:
- <br />   name={caf\'e},
- <br />   description={small restaurant selling refreshments}
- <br /> }
-</div>
-<!--l. 954--><p class="nopar" > </p><div class="alltt">
+ {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
@@ -2500,20 +2616,20 @@
</div>
- <div class="verbatim" id="verbatim-4">
+ <pre class="verbatim" id="verbatim-4">
\newglossaryentry % provided by glossaries.sty
- <br /> {distance}% label
- <br /> {% definition:
- <br />   name={distance},
- <br />   description={the length between two points},
- <br />   symbol={m}
- <br /> }
- <br />\begin{document}
- <br />First use: \gls{cafe}, \gls{html}, \gls{pi}.
- <br />Next use: \gls{cafe}, \gls{html}, \gls{pi}.
- <br />\Gls{distance} is measured in \glssymbol{distance}.
-</div>
-<!--l. 984--><p class="nopar" > </p><div class="alltt">
+ {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
@@ -2539,7 +2655,7 @@
class="cmss-10">glossaries-extra</span></a>. Other options are
passed to the base <span
class="cmss-10">glossaries </span>package.
-<!--l. 995--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> In this document, commands and options displayed in teal, such as <span id="textcolor14"><span
+<!--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
@@ -2557,13 +2673,13 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> user manual for further details of those commands.
</div>
-</p><!--l. 1003--><p class="noindent" >
-</p><!--l. 1005--><p class="indent" > One of the strengths of the <span
+</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. 1011--><p class="indent" > <div class="important" title="Important Note"> There’s a common misconception that you have to have Perl installed in order to use the <span
+</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
@@ -2571,8 +2687,8 @@
href="#glo:exlatinalph">extended Latin alphabet</a> or a <a
href="#glo:nonlatinalph">non-Latin alphabet</a>.
</div>
-</p><!--l. 1017--><p class="noindent" >
-</p><!--l. 1019--><p class="indent" > This document uses the <span
+</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
@@ -2583,7 +2699,7 @@
id="dx1-4017"></a>”. This is the way the
<span
class="cmss-10">glossaries </span>mechanism works. An <a
-href="#glo:indexingapp">indexing application</a> is used to generated the sorted list of terms. The <a
+href="#glo:indexingapp">indexing 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
@@ -2593,43 +2709,54 @@
class="cmtt-10">arara</span><a
id="dx1-4018"></a> to
run them.
-</p><!--l. 1031--><p class="indent" > Neither of the above two examples require an <a
+</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. 1036--><p class="indent" > The remainder of this introductory section covers the following: </p>
+</p><!--l. 1040--><p class="indent" > The remainder of this introductory section covers the following: </p>
<ul class="itemize1">
- <li class="itemize"><a
-href="#sec:indexingoptions">§1.1 </a><a
+ <li class="itemize">
+ <!--l. 1042--><p class="noindent" ><a
+href="#sec:indexingoptions">§<span
+class="cmbx-10">??</span>sec:indexingoptions </a><a
href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> lists the available indexing options.
- </li>
- <li class="itemize"><a
-href="#sec:samples">§19 </a><a
-href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this package.
- </li>
- <li class="itemize"><a
-href="#sec:lipsum">§1.2 </a><a
+ </p></li>
+ <li class="itemize">
+ <!--l. 1045--><p class="noindent" ><a
+href="#sec:lipsum">§<span
+class="cmbx-10">??</span>sec:lipsum </a><a
href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a> lists the dummy glossary files that may be used for testing.
- </li>
- <li class="itemize"><a
-href="#sec:languages">§1.3 </a><a
-href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a language other
- than English.
- </li>
- <li class="itemize"><a
-href="#sec:makeglossaries">§1.4 </a><a
+ </p></li>
+ <li class="itemize">
+ <!--l. 1048--><p class="noindent" ><a
+href="#sec:languages">§<span
+class="cmbx-10">??</span>sec:languages </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">??</span>sec:makeglossaries </a><a
href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use an <a
-href="#glo:indexingapp">indexing application</a> to create
- the sorted glossaries for your document (Options <a
+href="#glo:indexingapp">indexing
+ application</a> to create the sorted glossaries for your document (Options <a
href="#option2">2</a> or <a
href="#option3">3</a>).
+</p>
</li></ul>
-<!--l. 1056--><p class="noindent" ><a
+<!--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">??</span>sec:samples </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:indexingoptions"></a>Indexing Options</h3>
-<!--l. 1059--><p class="noindent" >The basic idea behind the <span
+<!--l. 1063--><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
@@ -2647,16 +2774,17 @@
href="#option5">5</a>) as well as an option for standalone descriptions within the document body
(<a
href="#option6">Option 6</a>).
-</p><!--l. 1070--><p class="indent" > An overview of Options <a
+</p><!--l. 1074--><p class="indent" > An overview of Options <a
href="#option1">1</a>–<a
href="#option5">5</a> is given in <a
-href="#tab:options">table 1.1</a>. <a
+href="#tab:options">table <span
+class="cmbx-10">??</span>tab:options</a>. <a
href="#option6">Option 6</a> is omitted from the table as it doesn’t
produce a list. For a more detailed comparison of the various methods, see the <a
href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml" ><span
class="cmss-10">glossaries </span>performance
page</a>.
-</p><!--l. 1076--><p class="indent" > <div class="important" title="Important Note"> If you are developing a class or package that loads <span
+</p><!--l. 1080--><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>
@@ -2665,9 +2793,11 @@
class="cmtt-10">\makeglossaries </span>(such
as <span
class="cmtt-10">\newglossary</span>) and they can’t switch off the indexing whilst working on a draft document.
+
+
</div>
-</p><!--l. 1085--><p class="noindent" >
-</p><!--l. 1087--><p class="indent" > Strictly speaking, Options <a
+</p><!--l. 1089--><p class="noindent" >
+</p><!--l. 1091--><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
@@ -2674,8 +2804,6 @@
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>
@@ -2682,7 +2810,7 @@
<div class="table">
-<!--l. 1094--><p class="indent" > <a
+<!--l. 1098--><p class="indent" > <a
id="tab:options"></a></p><hr class="float" /><div class="float"
>
@@ -2693,7 +2821,7 @@
<div class="tabular"> <table id="TBL-2" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-2-1g"><col
id="TBL-2-1" /><col
id="TBL-2-2" /><col
@@ -2702,7 +2830,7 @@
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. 1102--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
+class="td01"><!--l. 1106--><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
@@ -2725,7 +2853,7 @@
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. 1104--><p class="noindent" ><span
+class="td01"><!--l. 1108--><p class="noindent" ><span
class="cmr-9">Requires</span>
<a
href="#glo:glossaries-extra"><span
@@ -2743,7 +2871,7 @@
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. 1106--><p class="noindent" ><span
+class="td01"><!--l. 1110--><p class="noindent" ><span
class="cmr-9">Requires</span>
<span
class="cmr-9">an</span>
@@ -2763,7 +2891,7 @@
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. 1108--><p class="noindent" ><span
+class="td01"><!--l. 1112--><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"
@@ -2779,7 +2907,7 @@
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. 1110--><p class="noindent" ><span
+class="td01"><!--l. 1114--><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"
@@ -2795,7 +2923,7 @@
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. 1112--><p class="noindent" ><span
+class="td01"><!--l. 1116--><p class="noindent" ><span
class="cmr-9">Can</span>
<span
class="cmr-9">sort</span>
@@ -2826,7 +2954,7 @@
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. 1115--><p class="noindent" ><span
+class="td01"><!--l. 1119--><p class="noindent" ><span
class="cmr-9">Efficient</span>
<span
class="cmr-9">sort</span>
@@ -2843,7 +2971,7 @@
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. 1117--><p class="noindent" ><span
+class="td01"><!--l. 1121--><p class="noindent" ><span
class="cmr-9">Can</span>
<span
class="cmr-9">use</span>
@@ -2874,7 +3002,7 @@
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. 1121--><p class="noindent" ><span
+class="td01"><!--l. 1125--><p class="noindent" ><span
class="cmr-9">Any</span>
<span
class="cmr-9">problematic</span>
@@ -2895,7 +3023,7 @@
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. 1123--><p class="noindent" ><span
+class="td01"><!--l. 1127--><p class="noindent" ><span
class="cmr-9">Are</span>
<span
class="cmr-9">entries</span>
@@ -2930,7 +3058,7 @@
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. 1126--><p class="noindent" ><span
+class="td01"><!--l. 1130--><p class="noindent" ><span
class="cmr-9">Can</span>
<span
class="cmr-9">automatically</span>
@@ -2958,7 +3086,7 @@
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. 1128--><p class="noindent" ><span
+class="td01"><!--l. 1132--><p class="noindent" ><span
class="cmr-9">Can</span>
<span
class="cmr-9">have</span>
@@ -2988,7 +3116,7 @@
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. 1133--><p class="noindent" ><span
+class="td01"><!--l. 1137--><p class="noindent" ><span
class="cmr-9">Maximum</span>
<span
class="cmr-9">hierarchical</span>
@@ -3008,7 +3136,7 @@
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. 1135--><p class="noindent" ><span
+class="td01"><!--l. 1139--><p class="noindent" ><span
class="cmtt-9">\glsdisplaynumberlist</span><a
id="dx1-5002"></a>
<span
@@ -3025,7 +3153,7 @@
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. 1137--><p class="noindent" ><span
+class="td01"><!--l. 1141--><p class="noindent" ><span
class="cmtt-9">\newglossaryentry</span><a
id="dx1-5003"></a>
<span
@@ -3055,7 +3183,7 @@
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. 1140--><p class="noindent" ><span
+class="td01"><!--l. 1144--><p class="noindent" ><span
class="cmr-9">Requires</span>
<span
class="cmr-9">additional</span>
@@ -3076,7 +3204,7 @@
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. 1142--><p class="noindent" ><span
+class="td01"><!--l. 1146--><p class="noindent" ><span
class="cmr-9">Default</span>
<span
class="cmr-9">value</span>
@@ -3104,8 +3232,8 @@
</tr></table>
</div>
-<!--l. 1150--><p class="noindent" >______________________________________________________________________________________
-</p><!--l. 1152--><p class="noindent" ><sup class="textsuperscript"><span
+<!--l. 1154--><p class="noindent" >______________________________________________________________________________________
+</p><!--l. 1156--><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
@@ -3115,13 +3243,13 @@
class="cmr-8">is treated the</span>
<span
class="cmr-8">same as A.</span>
-</p><!--l. 1155--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1159--><p class="noindent" ><sup class="textsuperscript"><span
class="tcrm-0900">†</span></sup> <span
class="cmr-8">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. 1156--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1160--><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
@@ -3129,13 +3257,13 @@
class="cmss-8">none</span><a
id="dx1-5008"></a> <span
class="cmr-8">is used.</span>
-</p><!--l. 1157--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1161--><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. 1158--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1162--><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. 1159--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1163--><p class="noindent" ><sup class="textsuperscript"><span
class="tcrm-0900">¶</span></sup> <span
class="cmr-8">The locations must be set explicitly through the custom </span><span id="textcolor78"><span
class="cmtt-8">location</span></span><a
@@ -3143,10 +3271,10 @@
class="cmr-8">field provided by </span><span
class="cmss-8">glossaries-extra</span><span
class="cmr-8">.</span>
-</p><!--l. 1162--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1166--><p class="noindent" ><sup class="textsuperscript"><span
class="cmr-9">#</span></sup> <span
class="cmr-8">Unlimited but unreliable.</span>
-</p><!--l. 1163--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1167--><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
@@ -3154,7 +3282,7 @@
class="cmr-8">format. </span><span
class="cmtt-8">\newglossaryentry </span><span
class="cmr-8">should not be used explicitly.</span>
-</p><!--l. 1165--><p class="noindent" ><sup class="textsuperscript">⁑</sup> <span
+</p><!--l. 1169--><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
@@ -3166,7 +3294,7 @@
class="cmss-8">restricted</span></span><a
id="dx1-5012"></a> <span
class="cmr-8">but not recommended.</span>
-</p><!--l. 1167--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1171--><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
@@ -3179,7 +3307,7 @@
class="cmss-8">restricted</span></span><a
id="dx1-5014"></a><span
class="cmr-8">.</span>
-</p><!--l. 1169--><p class="noindent" ><sup class="textsuperscript"><span
+</p><!--l. 1173--><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
@@ -3202,15 +3330,15 @@
<h4 class="likesubsectionHead"><a
id="x1-60001"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option1">🔗</a><a
id="option1"></a>Option 1 (TeX)</h4>
-<!--l. 1176--><p class="noindent" >Example Document:
+<!--l. 1180--><p class="noindent" >This option isn’t generally recommended for reasons given below. Example Document:
</p>
- <div class="verbatim" id="verbatim-5">
+ <pre class="verbatim" id="verbatim-5">
\documentclass{article}
- <br />\usepackage{glossaries}
-</div>
-<!--l. 1180--><p class="nopar" > </p><div class="alltt">
+\usepackage{glossaries}
+</pre>
+<!--l. 1185--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<strong><span
class="cmtt-10">\makenoidxglossaries</span><a
@@ -3224,13 +3352,13 @@
</div>
- <div class="verbatim" id="verbatim-6">
+ <pre class="verbatim" id="verbatim-6">
\newglossaryentry{sample}{name={sample},
- <br />  description={an example}}
- <br />\begin{document}
- <br />\gls{sample}.
-</div>
-<!--l. 1189--><p class="nopar" > </p><div class="alltt">
+  description={an example}}
+\begin{document}
+\gls{sample}.
+</pre>
+<!--l. 1194--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<strong><span
class="cmtt-10">\printnoidxglossary</span><a
@@ -3245,20 +3373,22 @@
class="cmti-10">after </span><span
class="cmtt-10">\makenoidxglossaries</span><a
id="dx1-6004"></a>).
-<!--l. 1198--><p class="indent" > This option doesn’t require an external <a
+<!--l. 1203--><p class="indent" > This option doesn’t require an external <a
href="#glo:indexingapp">indexing application</a> but, with the default alphabetic sorting, it’s
very slow with severe limitations. If you want a sorted list, it doesn’t work well for <a
href="#glo:exlatinalph">extended Latin alphabets</a> or
<a
-href="#glo:nonlatinalph">non-Latin alphabets</a>. However, if you use the <span
+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-6005"></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
+ id="dx1-6005"></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
@@ -3268,8 +3398,8 @@
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-6007"></a> is used. If
-you have any other kinds of commands that don’t expand to ASCII characters, such as <span
+ id="dx1-6007"></a> is used. If you
+have any other kinds of commands that don’t expand to ASCII characters, such as <span
class="cmtt-10">\alpha </span>or
<span
class="cmtt-10">\si</span>, then you must use <span
@@ -3300,7 +3430,7 @@
class="cmtt-10">,description={...}}</span>
</div>
</div>
-<!--l. 1218--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+<!--l. 1224--><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
@@ -3312,8 +3442,8 @@
id="dx1-6015"></a> key to the entry label (instead of the <span
class="cmtt-10">name</span><a
id="dx1-6016"></a>). </div>
-</p><!--l. 1222--><p class="noindent" >
-</p><!--l. 1224--><p class="indent" > This option works best with the <span
+</p><!--l. 1228--><p class="noindent" >
+</p><!--l. 1230--><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
@@ -3331,59 +3461,68 @@
href="#glo:indexingapp">indexing application</a> consider using <a
href="#option5">Option 5</a>
instead.
-</p><!--l. 1235--><p class="indent" >
+</p><!--l. 1241--><p class="indent" > Summary:
+
+
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-6021x1">Add
+<li
+ class="enumerate" id="x1-6021x1">
+ <!--l. 1243--><p class="noindent" >Add
- <div class="verbatim" id="verbatim-7">
+</p>
+ <pre class="verbatim" id="verbatim-7">
\makenoidxglossaries
-</div>
- <!--l. 1239--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
-href="#sec:newglosentry">§4 </a><a
-href="#sec:newglosentry">Defining Glossary
- Entries<!--tex4ht:ref: sec:newglosentry --></a>).
+</pre>
+ <!--l. 1246--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
+href="#sec:newglosentry">§<span
+class="cmbx-10">??</span>sec:newglosentry </a><a
+href="#sec:newglosentry">Defining
+ Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
</p></li>
- <li
- class="enumerate" id="x1-6023x2">Put
+<li
+ class="enumerate" id="x1-6023x2">
+ <!--l. 1250--><p class="noindent" >Put
- <div class="verbatim" id="verbatim-8">
+</p>
+ <pre class="verbatim" id="verbatim-8">
\printnoidxglossary
-</div>
- <!--l. 1246--><p class="nopar" > where you want your list of entries to appear (described in <a
-href="#sec:printglossary">§10 </a><a
-href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). Alternatively, to
- display all glossaries use the iterative command:
+</pre>
+ <!--l. 1253--><p class="nopar" > where you want your list of entries to appear (described in <a
+href="#sec:printglossary">§<span
+class="cmbx-10">??</span>sec:printglossary </a><a
+href="#sec:printglossary">Displaying a Glossary<!--tex4ht:ref: sec:printglossary --></a>).
+ Alternatively, to display all glossaries use the iterative command:
</p>
- <div class="verbatim" id="verbatim-9">
+ <pre class="verbatim" id="verbatim-9">
\printnoidxglossaries
-</div>
- <!--l. 1252--><p class="nopar" >
+</pre>
+ <!--l. 1259--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-6025x3">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.</li></ol>
+<li
+ class="enumerate" id="x1-6025x3">
+ <!--l. 1261--><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-6026r2"></a>
-<!--l. 1259--><p class="noindent" >
+<!--l. 1266--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-70002"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option2">🔗</a><a
id="option2"></a>Option 2 (<span
class="cmtt-10">makeindex</span>)</h4>
-<!--l. 1261--><p class="noindent" >Example document:
+<!--l. 1268--><p class="noindent" >Example document:
</p>
- <div class="verbatim" id="verbatim-10">
+ <pre class="verbatim" id="verbatim-10">
\documentclass{article}
- <br />\usepackage{glossaries}
-</div>
-<!--l. 1265--><p class="nopar" > </p><div class="alltt">
+\usepackage{glossaries}
+</pre>
+<!--l. 1272--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<strong><span
class="cmtt-10">\makeglossaries</span><a
@@ -3396,13 +3535,13 @@
</div>
- <div class="verbatim" id="verbatim-11">
+ <pre class="verbatim" id="verbatim-11">
\newglossaryentry{sample}{name={sample},
- <br /> description={an example}}
- <br />\begin{document}
- <br />\gls{sample}.
-</div>
-<!--l. 1274--><p class="nopar" > </p><div class="alltt">
+ description={an example}}
+\begin{document}
+\gls{sample}.
+</pre>
+<!--l. 1281--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<strong><span
class="cmtt-10">\printglossary</span><a
@@ -3417,7 +3556,7 @@
class="cmti-10">after </span><span
class="cmtt-10">\makeglossaries</span><a
id="dx1-7004"></a>).
-<!--l. 1283--><p class="indent" > This option uses a <a
+<!--l. 1290--><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
@@ -3427,8 +3566,10 @@
id="dx1-7006"></a></a>. It can’t correctly sort
accent commands (such as <span
class="cmtt-10">\’ </span>or <span
-class="cmtt-10">\c</span>) and fails with UTF-8 characters, especially for any sort values that start
-with a UTF-8 character (as it separates the octets resulting in an invalid file encoding). This process involves
+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
@@ -3439,7 +3580,7 @@
writes a new file containing the code to typeset the glossary. Then <span
class="cmtt-10">\printglossary </span>reads this file in on the
next run.
-</p><!--l. 1295--><p class="indent" > This option works best if you want to sort entries according to the English alphabet and you don’t want to
+</p><!--l. 1302--><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
@@ -3448,7 +3589,7 @@
class="cmss-10">automake</span><a
id="dx1-7010"></a> package option provided the shell escape hasn’t
been completely disabled.)
-</p><!--l. 1302--><p class="indent" > This method can form ranges in the <a
+</p><!--l. 1309--><p class="indent" > This method can form ranges in the <a
href="#glo:numberlist">number list<a
id="dx1-7011"></a></a> but only accepts limited number formats: <span
class="cmtt-10">\arabic</span>, <span
@@ -3457,7 +3598,7 @@
class="cmtt-10">\Roman</span>, <span
class="cmtt-10">\alph </span>and <span
class="cmtt-10">\Alph</span>.
-</p><!--l. 1306--><p class="indent" > This option does not allow a mixture of sort methods. All glossaries must be sorted according to the same
+</p><!--l. 1313--><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
@@ -3464,29 +3605,31 @@
class="cmtt-10">makeindex</span><a
id="dx1-7012"></a></a> for each glossary
type.
-</p><!--l. 1313--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 1320--><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">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
+class="cmss-10">glossaries-extra</span></a> documentation for further
+details. See also the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> alternative to <a
href="#ex:sampleSort"><span
class="cmtt-10">sampleSort.tex</span></a> in <a
-href="#sec:samplessort">§19.5 </a><a
+href="#sec:samplessort">§<span
+class="cmbx-10">??</span>sec:samplessort </a><a
href="#sec:samplessort">Sorting<!--tex4ht:ref: sec:samplessort --></a>.
</div>
-</p><!--l. 1320--><p class="noindent" >
-</p><!--l. 1322--><p class="indent" >
+</p><!--l. 1327--><p class="noindent" >
+</p><!--l. 1329--><p class="indent" > Summary:
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-7014x1">If you want to use <a
+<li
+ class="enumerate" id="x1-7014x1">
+ <!--l. 1331--><p class="noindent" >If you want to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-7015"></a>’s</a> <span
@@ -3497,10 +3640,11 @@
example:
- <div class="verbatim" id="verbatim-12">
+</p>
+ <pre class="verbatim" id="verbatim-12">
\GlsSetQuote{+}
-</div>
- <!--l. 1327--><p class="nopar" > This must be used before <span
+</pre>
+ <!--l. 1335--><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-7018"></a>, the shorthands aren’t
@@ -3507,39 +3651,46 @@
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-7020x2">Add
+<li
+ class="enumerate" id="x1-7020x2">
+ <!--l. 1341--><p class="noindent" >Add
- <div class="verbatim" id="verbatim-13">
+</p>
+ <pre class="verbatim" id="verbatim-13">
\makeglossaries
-</div>
- <!--l. 1336--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
-href="#sec:newglosentry">§4 </a><a
-href="#sec:newglosentry">Defining Glossary
- Entries<!--tex4ht:ref: sec:newglosentry --></a>).
+</pre>
+ <!--l. 1344--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
+href="#sec:newglosentry">§<span
+class="cmbx-10">??</span>sec:newglosentry </a><a
+href="#sec:newglosentry">Defining
+ Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
</p></li>
- <li
- class="enumerate" id="x1-7022x3">Put
+<li
+ class="enumerate" id="x1-7022x3">
+ <!--l. 1349--><p class="noindent" >Put
- <div class="verbatim" id="verbatim-14">
+</p>
+ <pre class="verbatim" id="verbatim-14">
\printglossary
-</div>
- <!--l. 1344--><p class="nopar" > where you want your list of entries to appear (described in <a
-href="#sec:printglossary">§10 </a><a
-href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). Alternatively, to
- display all glossaries use the iterative command:
+</pre>
+ <!--l. 1352--><p class="nopar" > where you want your list of entries to appear (described in <a
+href="#sec:printglossary">§<span
+class="cmbx-10">??</span>sec:printglossary </a><a
+href="#sec:printglossary">Displaying a Glossary<!--tex4ht:ref: sec:printglossary --></a>).
+ Alternatively, to display all glossaries use the iterative command:
</p>
- <div class="verbatim" id="verbatim-15">
+ <pre class="verbatim" id="verbatim-15">
\printglossaries
-</div>
- <!--l. 1350--><p class="nopar" >
+</pre>
+ <!--l. 1358--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-7024x4">Run LaTeX on your document. This creates files with the extensions <span
+<li
+ class="enumerate" id="x1-7024x4">
+ <!--l. 1360--><p class="noindent" >Run LaTeX on your document. This creates files with the extensions <span
class="cmtt-10">glo</span><a
id="dx1-7025"></a> and <span
class="cmtt-10">ist</span><a
@@ -3553,13 +3704,14 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> you’ll see the section heading and some boilerplate
text.)
- <!--l. 1361--><p class="noindent" >If you have used package options such as <span
+ </p><!--l. 1369--><p class="noindent" >If you have used package options such as <span
class="cmss-10">symbols</span><a
id="dx1-7027"></a> there will also be other sets of files corresponding to the
extra glossaries that were created by those options.
</p></li>
- <li
- class="enumerate" id="x1-7029x5"><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.run">🔗</a><a
+<li
+ class="enumerate" id="x1-7029x5">
+ <!--l. 1373--><p class="noindent" ><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.run">🔗</a><a
id="makeindex.run"></a> Run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
@@ -3570,7 +3722,7 @@
class="cmtt-10">.gls</span>. If you have access to a terminal or a command prompt (for example,
the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to
run the command:
- <!--l. 1371--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+ </p><!--l. 1379--><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>
@@ -3578,20 +3730,21 @@
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. 1378--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span
+ </p><!--l. 1386--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span
class="cmtt-10">type</span><a
id="dx1-7031"></a>. See <a
-href="#sec:makeindexapp">§1.4.4 </a><a
+href="#sec:makeindexapp">§<span
+class="cmbx-10">??</span>sec:makeindexapp </a><a
href="#sec:makeindexapp">Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7032"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a>
- for further details. <a
+ id="dx1-7032"></a></a>
+ explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details. <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-7033"></a></a> must be called for each set of files. </div>
- </p><!--l. 1382--><p class="noindent" >
- </p><!--l. 1384--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably access <a
+ </p><!--l. 1390--><p class="noindent" >
+ </p><!--l. 1392--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably access <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-7034"></a></a> via your
@@ -3598,7 +3751,7 @@
text editor, but each editor has a different method of doing this. See <a
href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or
makeglossaries-lite or bib2gls into the document build</a> for some examples.
- </p><!--l. 1390--><p class="noindent" >Alternatively, run <a
+ </p><!--l. 1398--><p class="noindent" >Alternatively, run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-7035"></a></a> indirectly via the <a
@@ -3605,11 +3758,11 @@
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-7036"></a></a> script:
- </p><!--l. 1392--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+ </p><!--l. 1400--><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
@@ -3626,7 +3779,7 @@
class="cmtt-10">makeindex</span><a
id="dx1-7040"></a></a> the appropriate number of times with all the necessary
switches.
- </p><!--l. 1402--><p class="noindent" >The simplest approach is to use <span
+ </p><!--l. 1410--><p class="noindent" >The simplest approach is to use <span
class="cmtt-10">arara</span><a
id="dx1-7041"></a> and add the following comment lines to the start of your document:
</p><div class="alltt">
@@ -3648,23 +3801,24 @@
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. 1413--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to
+ <!--l. 1421--><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-7042"></a> switch:
- </p><!--l. 1416--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+ </p><!--l. 1424--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
<br /></pre><spacer type=vertical size=10>
<br /></span>
(See <a
-href="#sec:makeindexapp">§1.4.4 </a><a
+href="#sec:makeindexapp">§<span
+class="cmbx-10">??</span>sec:makeindexapp </a><a
href="#sec:makeindexapp">Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-7043"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span
class="cmtt-10">makeindex</span><a
- id="dx1-7044"></a> explicitly.) If you
- use <a
+ id="dx1-7044"></a>
+ explicitly.) If you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-7045"></a></a> or <a
@@ -3674,16 +3828,17 @@
class="cmss-10">order</span><span
class="cmtt-10">=</span><span
class="cmss-10">letter</span><a
- id="dx1-7047"></a> package option and the <span
+ id="dx1-7047"></a> package option
+ and the <span
class="cmtt-10">-l</span><a
- id="dx1-7048"></a> option
- will be added automatically.
+ id="dx1-7048"></a> option will be added automatically.
</p></li>
- <li
- class="enumerate" id="x1-7050x6"><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.relatex">🔗</a><a
+<li
+ class="enumerate" id="x1-7050x6">
+ <!--l. 1433--><p class="noindent" ><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.relatex">🔗</a><a
id="makeindex.relatex"></a> Once you have successfully completed the previous step, you can now run LaTeX on your document
- again.</li></ol>
-<!--l. 1428--><p class="noindent" >You’ll need to repeat the last step if you have used the <span
+ again.</p></li></ol>
+<!--l. 1436--><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-7051"></a> option (unless you’re using <a
href="#glo:glossaries-extra"><span
@@ -3694,15 +3849,15 @@
cross-references which can’t be indexed until the glossary file has been created.
<a
id="x1-7052r3"></a>
-</p><!--l. 1435--><p class="noindent" >
+
+
+</p><!--l. 1443--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-80003"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option3">🔗</a><a
id="option3"></a>Option 3 (<span
class="cmtt-10">xindy</span>)</h4>
-<!--l. 1437--><p class="noindent" >Example document: </p><div class="alltt">
-
-
+<!--l. 1445--><p class="noindent" >Example document: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\documentclass{article}</span>
@@ -3721,13 +3876,13 @@
</div>
- <div class="verbatim" id="verbatim-16">
+ <pre class="verbatim" id="verbatim-16">
\newglossaryentry{sample}{name={sample},
- <br /> description={an example}}
- <br />\begin{document}
- <br />\gls{sample}.
-</div>
-<!--l. 1448--><p class="nopar" > </p><div class="alltt">
+ description={an example}}
+\begin{document}
+\gls{sample}.
+</pre>
+<!--l. 1456--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<strong><span
class="cmtt-10">\printglossary</span><a
@@ -3742,7 +3897,7 @@
class="cmti-10">after </span><span
class="cmtt-10">\makeglossaries</span><a
id="dx1-8004"></a>).
-<!--l. 1457--><p class="indent" > This option uses a <a
+<!--l. 1465--><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
@@ -3752,7 +3907,7 @@
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. 1462--><p class="indent" > The <a
+</p><!--l. 1470--><p class="indent" > The <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-8006"></a></a> application comes with both TeX Live and MiKTeX, but since <a
@@ -3771,23 +3926,28 @@
containing the code to typeset the glossary. Then <span
class="cmtt-10">\printglossary </span>reads this file in on the next
run.
-</p><!--l. 1470--><p class="indent" > This is the best option with just the base <span
-class="cmss-10">glossaries </span>package if you want to sort according to a language
-other than English or if you want non-standard location lists, but it can require some setting up (see <a
-href="#sec:xindy">§11 </a><a
-href="#sec:xindy">Xindy
-(Option 3)<!--tex4ht:ref: sec:xindy --></a>). There are some problems with certain sort values: </p>
+</p><!--l. 1478--><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">??</span>sec:xindy </a><a
+href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>). There are some problems with certain sort values:
+</p>
<ul class="itemize1">
- <li class="itemize">entries with the same sort value are merged by <span
+ <li class="itemize">
+ <!--l. 1484--><p class="noindent" >entries with the same sort value are merged by <span
class="cmtt-10">xindy</span><a
id="dx1-8010"></a> into a single glossary line so you must make
sure that each entry has a unique sort value;
- </li>
- <li class="itemize"><span
+ </p></li>
+ <li class="itemize">
+ <!--l. 1487--><p class="noindent" ><span
class="cmtt-10">xindy</span><a
id="dx1-8011"></a> forbids empty sort values;
- </li>
- <li class="itemize"><span
+ </p></li>
+ <li class="itemize">
+ <!--l. 1488--><p class="noindent" ><span
class="cmtt-10">xindy</span><a
id="dx1-8012"></a> automatically strips control sequences, the math-shift character <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">$</span></span></span> and braces <span class="obeylines-h"><span class="verb"><span
@@ -3795,10 +3955,12 @@
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-8013"></a> forbids.</li></ul>
-<!--l. 1485--><p class="noindent" >In these problematic cases, you must set the <span
+ id="dx1-8013"></a> forbids.</p></li></ul>
+<!--l. 1493--><p class="noindent" >In these problematic cases, you must set the <span
class="cmtt-10">sort</span><a
id="dx1-8014"></a> field explicitly. For example: </p><div class="alltt">
+
+
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{alpha}{name={\ensuremath{\alpha}},</span>
@@ -3806,11 +3968,9 @@
class="cmtt-10"> </span><strong><span
class="cmtt-10">sort={alpha},</span></strong><span
class="cmtt-10">description={...}}</span>
-
-
</div>
</div>
-<!--l. 1491--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+<!--l. 1499--><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
@@ -3822,10 +3982,10 @@
id="dx1-8017"></a> key to the entry label (instead of the <span
class="cmtt-10">name</span><a
id="dx1-8018"></a>). </div>
-</p><!--l. 1495--><p class="noindent" >
-</p><!--l. 1497--><p class="indent" > All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of
+</p><!--l. 1503--><p class="noindent" >
+</p><!--l. 1505--><p class="indent" > All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of
definition).
-</p><!--l. 1500--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 1508--><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
@@ -3836,28 +3996,30 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> documentation for further details.
</div>
-</p><!--l. 1505--><p class="noindent" >
-</p><!--l. 1507--><p class="indent" >
+</p><!--l. 1513--><p class="noindent" >
+</p><!--l. 1515--><p class="indent" > Summary:
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-8020x1">Add the <span
+<li
+ class="enumerate" id="x1-8020x1">
+ <!--l. 1517--><p class="noindent" >Add the <span
class="cmss-10">xindy</span><a
id="dx1-8021"></a> option to the <span
class="cmss-10">glossaries </span>package option list:
- <div class="verbatim" id="verbatim-17">
+</p>
+ <pre class="verbatim" id="verbatim-17">
\usepackage[xindy]{glossaries}
-</div>
- <!--l. 1512--><p class="nopar" > If you are using a non-Latin script you’ll also need to either switch off the creation of the number
+</pre>
+ <!--l. 1521--><p class="nopar" > If you are using a non-Latin script you’ll also need to either switch off the creation of the number
group:
</p>
- <div class="verbatim" id="verbatim-18">
+ <pre class="verbatim" id="verbatim-18">
\usepackage[xindy={glsnumbers=false}]{glossaries}
-</div>
- <!--l. 1517--><p class="nopar" > or use either <span
+</pre>
+ <!--l. 1526--><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
@@ -3866,18 +4028,22 @@
class="cmti-10">spec</span>⟩<span
class="cmtt-10">} </span>to indicate where the number group should be placed (see
<a
-href="#sec:xindy">§11 </a><a
+href="#sec:xindy">§<span
+class="cmbx-10">??</span>sec:xindy </a><a
href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>).
</p></li>
- <li
- class="enumerate" id="x1-8023x2">Add <span
-class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your entries, as described in <a
-href="#sec:newglosentry">§4 </a><a
-href="#sec:newglosentry">Defining
- Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </li>
- <li
- class="enumerate" id="x1-8025x3">Run LaTeX on your document. This creates files with the extensions <span
+<li
+ class="enumerate" id="x1-8023x2">
+ <!--l. 1532--><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">??</span>sec:newglosentry </a><a
+href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
+ </p></li>
+<li
+ class="enumerate" id="x1-8025x3">
+ <!--l. 1535--><p class="noindent" >Run LaTeX on your document. This creates files with the extensions <span
class="cmtt-10">glo</span><a
id="dx1-8026"></a> and <span
class="cmtt-10">xdy</span><a
@@ -3891,13 +4057,14 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> extension package, you’ll see the section header and some boilerplate
text.)
- <!--l. 1535--><p class="noindent" >If you have used package options such as <span
+ </p><!--l. 1544--><p class="noindent" >If you have used package options such as <span
class="cmss-10">symbols</span><a
id="dx1-8028"></a> there will also be other sets of files corresponding to the
extra glossaries that were created by those options.
</p></li>
- <li
- class="enumerate" id="x1-8030x4">Run <a
+<li
+ class="enumerate" id="x1-8030x4">
+ <!--l. 1548--><p class="noindent" >Run <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-8031"></a></a> with the <span
@@ -3908,7 +4075,7 @@
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):
- <!--l. 1547--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+ </p><!--l. 1556--><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>
@@ -3923,27 +4090,28 @@
class="cmtt-10">german -C</span><a
id="dx1-8033"></a> <span
class="cmtt-10">din5007-utf8</span>.)
- </p><!--l. 1556--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span
+
+
+ </p><!--l. 1565--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span
class="cmtt-10">type</span><a
id="dx1-8034"></a>. See <a
-href="#sec:xindyapp">§1.4.3 </a><a
+href="#sec:xindyapp">§<span
+class="cmbx-10">??</span>sec:xindyapp </a><a
href="#sec:xindyapp">Using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-8035"></a></a> explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for
- further details. <a
+ id="dx1-8035"></a></a> explicitly
+ (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details. <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-8036"></a></a> must be called for each set of files. </div>
- </p><!--l. 1560--><p class="noindent" >
- </p><!--l. 1562--><p class="noindent" >It’s much simpler to use <a
+ </p><!--l. 1569--><p class="noindent" >
+ </p><!--l. 1571--><p class="noindent" >It’s much simpler to use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-8037"></a></a> instead:
- </p><!--l. 1563--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+ </p><!--l. 1572--><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
@@ -3953,7 +4121,7 @@
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-8039"></a></a> the appropriate number of times with all the necessary switches.
- </p><!--l. 1571--><p class="noindent" >There’s no benefit in using <a
+ </p><!--l. 1580--><p class="noindent" >There’s no benefit in using <a
href="#glo:makeglossaries-lite.lua"><span
class="cmtt-10">makeglossaries-lite</span><a
id="dx1-8040"></a></a> with <a
@@ -3978,7 +4146,7 @@
class="cmtt-10">xindy</span><a
id="dx1-8046"></a></a>
either.)
- </p><!--l. 1577--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably access <a
+ </p><!--l. 1586--><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-8047"></a></a> or
@@ -3989,7 +4157,7 @@
<a
href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build</a> for some
examples.
- </p><!--l. 1583--><p class="noindent" >Again, a convenient method is to use <span
+ </p><!--l. 1592--><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">
@@ -4007,7 +4175,7 @@
class="cmtt-10"> pdflatex</span>
</div>
</div>
- <!--l. 1591--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to
+ <!--l. 1600--><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
@@ -4016,10 +4184,10 @@
</p>
- <div class="verbatim" id="verbatim-19">
+ <pre class="verbatim" id="verbatim-19">
\usepackage[xindy,order=letter]{glossaries}
-</div>
- <!--l. 1596--><p class="nopar" > (and return to the previous step). This option is picked up by <a
+</pre>
+ <!--l. 1605--><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-8050"></a></a>. If you are explicitly using
@@ -4028,17 +4196,19 @@
class="cmtt-10">xindy</span><a
id="dx1-8051"></a></a> then you’ll need to add <span
class="cmtt-10">-M ord/letorder </span>to the options list. See <a
-href="#sec:xindyapp">§1.4.3 </a><a
+href="#sec:xindyapp">§<span
+class="cmbx-10">??</span>sec:xindyapp </a><a
href="#sec:xindyapp">Using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-8052"></a></a> explicitly
- (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span
+ id="dx1-8052"></a></a>
+ explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span
class="cmtt-10">xindy</span><a
id="dx1-8053"></a> explicitly.
</p></li>
- <li
- class="enumerate" id="x1-8055x5">Once you have successfully completed the previous step, you can now run LaTeX on your document
+<li
+ class="enumerate" id="x1-8055x5">
+ <!--l. 1612--><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
@@ -4045,16 +4215,17 @@
id="dx1-8056"></a></a> (<a
href="#option2">Option 2</a>), you may need to repeat the previous step and this step to ensure
the table of contents and cross-references are resolved.
+</p>
</li></ol>
<a
id="x1-8057r4"></a>
-<!--l. 1610--><p class="noindent" >
+<!--l. 1619--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-90004"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option4">🔗</a><a
id="option4"></a>Option 4 (<span
class="cmtt-10">bib2gls</span>)</h4>
-<!--l. 1612--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a
+<!--l. 1621--><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
@@ -4065,7 +4236,7 @@
id="dx1-9001"></a></a> to both fetch entry definitions from <span
class="cmtt-10">bib</span><a
id="dx1-9002"></a> files and to hierarchically sort and collate.
-</p><!--l. 1617--><p class="indent" > Example document: </p><div class="alltt">
+</p><!--l. 1626--><p class="indent" > Example document: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\documentclass{article}</span>
@@ -4094,6 +4265,8 @@
</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
@@ -4108,8 +4281,6 @@
class="cmtt-10"> example}</span>
<br /><span
class="cmtt-10">}</span>
-
-
<br /><span id="textcolor91"><span
class="cmtt-10">@symbol</span></span><a
id="dx1-9007"></a><span
@@ -4138,7 +4309,7 @@
class="cmtt-10">}</span>
</div>
</div>
-<!--l. 1643--><p class="indent" > All entries must be provided in one or more <span
+<!--l. 1652--><p class="indent" > All entries must be provided in one or more <span
class="cmtt-10">bib</span><a
id="dx1-9009"></a> files. See the <a
href="#glo:bib2gls"><span
@@ -4145,7 +4316,7 @@
class="cmtt-10">bib2gls</span><a
id="dx1-9010"></a></a> user manual for the required
format.
-</p><!--l. 1646--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
+</p><!--l. 1655--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
class="cmtt-10">sort</span><a
id="dx1-9011"></a> key should not be used. Each entry type (<span id="textcolor93"><span
class="cmtt-10">@entry</span></span><a
@@ -4165,8 +4336,8 @@
href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span
class="cmtt-10">bib2gls </span>gallery: sorting</a> for examples.
</div>
-</p><!--l. 1653--><p class="noindent" >
-</p><!--l. 1655--><p class="indent" > The <a
+</p><!--l. 1662--><p class="noindent" >
+</p><!--l. 1664--><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
@@ -4201,20 +4372,22 @@
class="cmtt-10">=</span><span
class="cmss-10">nameref</span></span><a
id="dx1-9020"></a> option is the best method.
-<!--l. 1670--><p class="indent" > (It’s possible to use a hybrid of this method and Options <a
+<!--l. 1679--><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">alsoindex</span></span><a
+class="cmss-10">hybrid</span></span><a
id="dx1-9021"></a> but in general there is
little need for this and it complicates the build process.)
-</p><!--l. 1674--><p class="indent" > Each resource set is loaded with <span id="textcolor102"><span
+</p><!--l. 1683--><p class="indent" > Each resource set is loaded with <span id="textcolor102"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
id="dx1-9022"></a><span
class="cmtt-10">[</span>⟨<span
class="cmti-10">options</span>⟩<span
class="cmtt-10">]</span>. For example: </p><div class="alltt">
+
+
<div class="obeylines-v">
<span id="textcolor103"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
@@ -4226,8 +4399,6 @@
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
@@ -4256,7 +4427,7 @@
sorting method. This may be a locale identifier for alphabetic sorting, but there are other sort methods
available, such as character code or numeric. One resource set may cover multiple glossaries or one glossary may
be split across multiple resource sets, forming logical sub-blocks.
-<!--l. 1691--><p class="indent" > If you want to ensure that all entries are selected, even if they haven’t been referenced in the document, then
+<!--l. 1700--><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
@@ -4266,7 +4437,7 @@
class="cmtt-10">bib2gls</span><a
id="dx1-9030"></a></a> user manual for further
details.)
-</p><!--l. 1697--><p class="indent" > The glossary is displayed using: </p><div class="alltt">
+</p><!--l. 1706--><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
@@ -4279,7 +4450,7 @@
id="dx1-9032"></a>
</div>
</div> The document is built using:
-<!--l. 1707--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+<!--l. 1716--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />pdflatex myDoc
<br />bib2gls myDoc
<br />pdflatex myDoc
@@ -4288,7 +4459,7 @@
If letter groups are required, you need the <span id="textcolor111"><span
class="cmtt-10">--group</span></span><a
id="dx1-9033"></a> switch:
-</p><!--l. 1713--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 1722--><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>
@@ -4304,20 +4475,20 @@
class="cmtt-10"> group:</span><span
class="cmtt-10"> on</span><span
class="cmtt-10"> }</span>
+
+
</div>
</div> (You will also need an appropriate glossary style.)
-<!--l. 1722--><p class="indent" > Unlike Options <a
+<!--l. 1731--><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. 1731--><p class="indent" > This method supports Unicode and uses the Common Locale Data Repository, which provides more extensive language support
+</p><!--l. 1740--><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
@@ -4331,24 +4502,93 @@
class="cmtt-10">bib2gls</span><a
id="dx1-9039"></a></a> can deduce a numerical value it will attempt to
form ranges otherwise it will simply list the locations.
-</p><!--l. 1739--><p class="indent" > See <a
+</p><!--l. 1748--><p class="indent" > Summary:
+ </p><ol class="enumerate1" >
+<li
+ class="enumerate" id="x1-9041x1">
+ <!--l. 1750--><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-9042"></a>ackage option:
+
+
+</p>
+ <pre class="verbatim" id="verbatim-20">
+ \usepackage[record]{glossaries-extra}
+</pre>
+ <!--l. 1754--><p class="nopar" >
+ </p></li>
+<li
+ class="enumerate" id="x1-9044x2">
+ <!--l. 1756--><p class="noindent" >Use <span
+class="cmtt-10">\*</span>GlsXtrLoadResources to identify the <span
+class="cmtt-10">bib</span><a
+ id="dx1-9045"></a> file(s) and <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9046"></a></a> options:
+
+
+</p>
+ <pre class="verbatim" id="verbatim-21">
+ \GlsXtrLoadResources[src={terms.bib,abbreviations.bib},sort=en]
+</pre>
+ <!--l. 1760--><p class="nopar" >
+ </p></li>
+<li
+ class="enumerate" id="x1-9048x3">
+ <!--l. 1762--><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-9050x4">
+ <!--l. 1772--><p class="noindent" >Run LaTeX on your document.
+ </p></li>
+<li
+ class="enumerate" id="x1-9052x5">
+ <!--l. 1774--><p class="noindent" >Run <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9053"></a></a> with just the document base name.
+ </p></li>
+<li
+ class="enumerate" id="x1-9055x6">
+ <!--l. 1776--><p class="noindent" >Run LaTeX on your document.
+</p>
+ </li></ol>
+
+
+<!--l. 1780--><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-9040"></a></a> user manual for further details of
+ id="dx1-9056"></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-9041r5"></a>
-</p><!--l. 1745--><p class="noindent" >
+ id="x1-9057r5"></a>
+</p><!--l. 1786--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-100005"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option5">🔗</a><a
id="option5"></a>Option 5 (no sorting)</h4>
-<!--l. 1747--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a
+<!--l. 1788--><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
@@ -4355,23 +4595,23 @@
class="cmss-10">glossaries-extra</span></a>. No <a
href="#glo:indexingapp">indexing application</a>
is required.
-</p><!--l. 1751--><p class="indent" > Example document:
+</p><!--l. 1792--><p class="indent" > Example document:
</p>
- <div class="verbatim" id="verbatim-20">
+ <pre class="verbatim" id="verbatim-22">
\documentclass{article}
- <br />\usepackage[sort=none]{glossaries-extra}
- <br />\newglossaryentry{sample}{name={sample},
- <br /> description={an example}}
- <br />\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
- <br /> description={...}}
- <br />\begin{document}
- <br />\gls{sample}.
-</div>
-<!--l. 1761--><p class="nopar" > </p><div class="alltt">
+\usepackage[sort=none]{glossaries-extra}
+\newglossaryentry{sample}{name={sample},
+ description={an example}}
+\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ description={...}}
+\begin{document}
+\gls{sample}.
+</pre>
+<!--l. 1802--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor112"><span
+<span id="textcolor113"><span
class="cmtt-10">\printunsrtglossary</span></span><a
id="dx1-10001"></a>
<br /><span
@@ -4378,7 +4618,7 @@
class="cmtt-10">\end{document}</span>
</div>
</div>
-<!--l. 1767--><p class="indent" > This method is best used with the package option <span
+<!--l. 1808--><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
@@ -4386,8 +4626,12 @@
command (such as <span
class="cmtt-10">\makeglossaries </span>for Options <a
href="#option2">2</a> and <a
-href="#option3">3</a>).
-</p><!--l. 1771--><p class="indent" > All entries must be defined before the glossary is displayed (preferably in the preamble) in the
+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. 1816--><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
@@ -4397,17 +4641,19 @@
<span
class="cmtt-10">\loadglsentries</span><a
id="dx1-10003"></a>.
-</p><!--l. 1782--><p class="indent" > The glossary is displayed using: </p><div class="alltt">
+</p><!--l. 1827--><p class="indent" > The glossary is displayed using: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor113"><span
+<span id="textcolor114"><span
class="cmtt-10">\printunsrtglossary</span></span><a
id="dx1-10004"></a>
</div>
</div> Alternatively all glossaries can be displayed using the iterative command: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor114"><span
+<span id="textcolor115"><span
class="cmtt-10">\printunsrtglossaries</span></span><a
id="dx1-10005"></a>
+
+
</div>
</div> This will display <span
class="cmti-10">all </span>defined entries, regardless of whether or not they have been used in the document. The
@@ -4421,20 +4667,18 @@
id="dx1-10007"></a></a> takes advantage of this method by defining the
wanted entries in the required order and setting the locations (and letter group information, if
required).
-
-
-<!--l. 1799--><p class="indent" > Therefore, the above example document has a glossary containing the entries: sample and <span
+<!--l. 1844--><p class="indent" > Therefore, the above example document has a glossary containing the entries: sample and <span
class="cmmi-10">α </span>(in
that order). Note that the <span
class="cmtt-10">alpha </span>entry has been included even though it wasn’t referenced in the
document.
-</p><!--l. 1804--><p class="indent" > This just requires a single LaTeX call:
-</p><!--l. 1805--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 1849--><p class="indent" > This just requires a single LaTeX call:
+</p><!--l. 1850--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />pdflatex myDoc
<br /></pre><spacer type=vertical size=10>
<br /></span>
unless the glossary needs to appear in the table of contents, in which case a second run is required:
-</p><!--l. 1810--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 1855--><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>
@@ -4441,17 +4685,17 @@
<br /></span>
(Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all
the other options above.)
-</p><!--l. 1818--><p class="indent" > See the <a
+</p><!--l. 1863--><p class="indent" > See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> documentation for further details of this method.
<a
id="x1-10008r6"></a>
-</p><!--l. 1820--><p class="noindent" >
+</p><!--l. 1865--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-110006"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option6">🔗</a><a
id="option6"></a>Option 6 (standalone)</h4>
-<!--l. 1822--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a
+<!--l. 1867--><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
@@ -4461,7 +4705,7 @@
id="x1-11001f3"></a>
Instead of creating a list, this has standalone definitions throughout the document. The entry name may or may
not be in a section heading.
-</p><!--l. 1832--><p class="indent" > You can either define entries in the document preamble (or in an external file loaded with <span
+</p><!--l. 1877--><p class="indent" > You can either define entries in the document preamble (or in an external file loaded with <span
class="cmtt-10">\loadglsentries</span><a
id="dx1-11004"></a>), as
with <a
@@ -4469,29 +4713,29 @@
</p>
- <div class="verbatim" id="verbatim-21">
+ <pre class="verbatim" id="verbatim-23">
\documentclass{article}
- <br />\usepackage[colorlinks]{hyperref}
- <br />\usepackage[sort=none,
- <br />   nostyles% <- no glossary styles are required
- <br /> ]{glossaries-extra}
- <br />\newglossaryentry{set}{name={set},
- <br />  description={a collection of any kind of objects},
- <br />  symbol={\ensuremath{\mathcal{S}}}
- <br />}
- <br />\newglossaryentry{function}{name={function},
- <br />  description={a rule that assigns every element in the
- <br />  domain \gls{set} to an element in the range \gls{set}},
- <br />  symbol={\ensuremath{f(x)}}
- <br />}
-</div>
-<!--l. 1852--><p class="nopar" > </p><div class="alltt">
+\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)}}
+}
+</pre>
+<!--l. 1897--><p class="nopar" > </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newcommand*{\termdef}[1]{%</span>
<br /><span
class="cmtt-10"> </span><span
-class="cmtt-10"> \section{</span><span id="textcolor115"><span
+class="cmtt-10"> \section{</span><span id="textcolor116"><span
class="cmtt-10">\glsxtrglossentry</span></span><a
id="dx1-11005"></a><span
class="cmtt-10">{#1}</span><span
@@ -4509,18 +4753,18 @@
</div>
- <div class="verbatim" id="verbatim-22">
+ <pre class="verbatim" id="verbatim-24">
\begin{document}
- <br />\tableofcontents
- <br />\section{Introduction}
- <br />Sample document about \glspl{function} and \glspl{set}.
- <br />\termdef{set}
- <br />More detailed information about \glspl{set} with examples.
- <br />\termdef{function}
- <br />More detailed information about \glspl{function} with examples.
- <br />\end{document}
-</div>
-<!--l. 1875--><p class="nopar" > Or you can use <a
+\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. 1920--><p class="nopar" > Or you can use <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-11008"></a></a> if you want to manage a large database of terms. For example (requires <a
@@ -4534,7 +4778,7 @@
<br /><span
class="cmtt-10">\usepackage[colorlinks]{hyperref}</span>
<br /><span
-class="cmtt-10">\usepackage[</span><span id="textcolor116"><span
+class="cmtt-10">\usepackage[</span><span id="textcolor117"><span
class="cmtt-10">record</span></span><span
class="cmtt-10">,</span>
<br /><span
@@ -4551,16 +4795,16 @@
class="cmtt-10"> </span><span
class="cmtt-10"> ]{glossaries-extra}</span>
<br />
-<br /><span id="textcolor117"><span
+<br /><span id="textcolor118"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
id="dx1-11009"></a><span
-class="cmtt-10">[</span><span id="textcolor118"><span
+class="cmtt-10">[</span><span id="textcolor119"><span
class="cmtt-10">src</span></span><a
id="dx1-11010"></a><span
-class="cmtt-10">=terms,</span><span id="textcolor119"><span
+class="cmtt-10">=terms,</span><span id="textcolor120"><span
class="cmtt-10">sort</span></span><a
id="dx1-11011"></a><span
-class="cmtt-10">=none,</span><span id="textcolor120"><span
+class="cmtt-10">=none,</span><span id="textcolor121"><span
class="cmtt-10">save-locations</span></span><a
id="dx1-11012"></a><span
class="cmtt-10">=false]</span>
@@ -4569,7 +4813,7 @@
class="cmtt-10">\newcommand*{\termdef}[1]{%</span>
<br /><span
class="cmtt-10"> </span><span
-class="cmtt-10"> \section{</span><span id="textcolor121"><span
+class="cmtt-10"> \section{</span><span id="textcolor122"><span
class="cmtt-10">\glsxtrglossentry</span></span><a
id="dx1-11013"></a><span
class="cmtt-10">{#1}</span><span
@@ -4597,21 +4841,21 @@
</div>
- <div class="verbatim" id="verbatim-23">
+ <pre class="verbatim" id="verbatim-25">
\begin{document}
- <br />\tableofcontents
- <br />\section{Introduction}
- <br />Sample document about \glspl{function} and \glspl{set}.
- <br />\termdef{set}
- <br />More detailed information about \glspl{set} with examples.
- <br />\termdef{function}
- <br />More detailed information about \glspl{function} with examples.
- <br />\end{document}
-</div>
-<!--l. 1910--><p class="nopar" > Where the file <span
+\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. 1955--><p class="nopar" > Where the file <span
class="cmtt-10">terms.bib </span>contains: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor122"><span
+<span id="textcolor123"><span
class="cmtt-10">@entry</span></span><a
id="dx1-11017"></a><span
class="cmtt-10">{set,</span>
@@ -4632,7 +4876,7 @@
class="cmtt-10"> symbol={\ensuremath{\mathcal{S}}}</span>
<br /><span
class="cmtt-10">}</span>
-<br /><span id="textcolor123"><span
+<br /><span id="textcolor124"><span
class="cmtt-10">@entry</span></span><a
id="dx1-11018"></a><span
class="cmtt-10">{function,</span>
@@ -4673,11 +4917,11 @@
class="cmtt-10">bib2gls</span><a
id="dx1-11020"></a></a>) is that you can use an existing database
of entries shared across multiple documents, ensuring consistent notation for all of them.
-<!--l. 1930--><p class="indent" > In both cases, there’s no need to load all the glossary styles packages, as they’re not required, so I’ve used
+<!--l. 1975--><p class="indent" > In both cases, there’s no need to load all the glossary styles packages, as they’re not required, so I’ve used
the <span
class="cmss-10">nostyles</span><a
id="dx1-11021"></a> package option to prevent them from being loaded.
-</p><!--l. 1934--><p class="indent" > In the first case, you need the <span
+</p><!--l. 1979--><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
@@ -4685,7 +4929,7 @@
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. 1938--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 1983--><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>
@@ -4692,7 +4936,7 @@
<br /></span>
-</p><!--l. 1943--><p class="indent" > In the second case, you need the <span id="textcolor124"><span
+</p><!--l. 1988--><p class="indent" > In the second case, you need the <span id="textcolor125"><span
class="cmss-10">record</span></span><a
id="dx1-11023"></a> package option (as in <a
href="#option4">Option 4</a>) since <a
@@ -4701,13 +4945,13 @@
id="dx1-11024"></a></a> is needed to select the
required entries, but you don’t need a sorted list: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor125"><span
+<span id="textcolor126"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
id="dx1-11025"></a><span
-class="cmtt-10">[</span><span id="textcolor126"><span
+class="cmtt-10">[</span><span id="textcolor127"><span
class="cmtt-10">src</span></span><a
id="dx1-11026"></a><span
-class="cmtt-10">={terms},</span><strong><span id="textcolor127"><span
+class="cmtt-10">={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>
@@ -4721,16 +4965,16 @@
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-11029"></a></a>, but it will skip the sorting step. (The chances are you probably also won’t need location
-lists either. If so, you can add the option <span id="textcolor128"><span
+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-11030"></a>.)
-<!--l. 1955--><p class="indent" > Remember that for this second case you need to run <a
+<!--l. 2000--><p class="indent" > Remember that for this second case you need to run <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-11031"></a></a> as per <a
href="#option4">Option 4</a>:
-</p><!--l. 1956--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 2001--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />pdflatex myDoc
<br />bib2gls myDoc
<br />pdflatex myDoc
@@ -4737,12 +4981,12 @@
<br />pdflatex myDoc
<br /></pre><spacer type=vertical size=10>
<br /></span>
-</p><!--l. 1963--><p class="indent" > For both cases (with or without <a
+</p><!--l. 2008--><p class="indent" > For both cases (with or without <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-11032"></a></a>), instead of listing all the entries using <span id="textcolor129"><span
+ id="dx1-11032"></a></a>), instead of listing all the entries using <span id="textcolor130"><span
class="cmtt-10">\printunsrtglossary</span></span>, you
-use <span id="textcolor130"><span
+use <span id="textcolor131"><span
class="cmtt-10">\glsxtrglossentry</span></span><a
id="dx1-11033"></a><span
class="cmtt-10">{</span>⟨<span
@@ -4769,7 +5013,7 @@
class="cmtt-10">\termdef </span>to simplify the code and ensure
consistency. Extra styling, such as placing the description in a coloured frame, can be added to this custom
definition as required.
-</p><!--l. 1976--><p class="indent" > (Instead of using <span
+</p><!--l. 2021--><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
@@ -4777,15 +5021,15 @@
class="cmtt-10">{</span>⟨<span
class="cmti-10">label</span>⟩<span
class="cmtt-10">}</span>, which
-will obey attributes such as <span id="textcolor131"><span
+will obey attributes such as <span id="textcolor132"><span
class="cmss-10">glossdesc</span></span><a
- id="dx1-11039"></a> and <span id="textcolor132"><span
+ id="dx1-11039"></a> and <span id="textcolor133"><span
class="cmss-10">glossdescfont</span></span><a
id="dx1-11040"></a>. See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further
details.)
-</p><!--l. 1981--><p class="indent" > The symbol (if required) can be displayed with either <span
+</p><!--l. 2026--><p class="indent" > The symbol (if required) can be displayed with either <span
class="cmtt-10">\glsentrysymbol</span><a
id="dx1-11041"></a><span
class="cmtt-10">{</span>⟨<span
@@ -4805,13 +5049,13 @@
class="cmtt-10">bib2gls</span><a
id="dx1-11044"></a></a> if the symbol needs to go in a section title as the entries aren’t defined on the
first LaTeX run.
-</p><!--l. 1988--><p class="indent" > In normal document text, <span
+</p><!--l. 2033--><p class="indent" > In normal document text, <span
class="cmtt-10">\glsentrysymbol </span>will silently do nothing if the entry hasn’t been defined, but
when used in a section heading it will expand to an undefined internal command when written to the <span
class="cmtt-10">aux</span><a
id="dx1-11045"></a> file,
which triggers an error.
-</p><!--l. 1993--><p class="indent" > The <span
+</p><!--l. 2038--><p class="indent" > The <span
class="cmtt-10">\glossentrysymbol</span><a
id="dx1-11046"></a> command performs an existence check, which triggers a warning if the entry is undefined.
(All entries will be undefined before the first <a
@@ -4831,7 +5075,7 @@
(see the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> user manual for further details).
-</p><!--l. 2004--><p class="indent" > If you want to test if the <span
+</p><!--l. 2049--><p class="indent" > If you want to test if the <span
class="cmtt-10">symbol</span><a
id="dx1-11051"></a> field has been set, you need to use <span
class="cmtt-10">\ifglshassymbol</span><a
@@ -4843,25 +5087,25 @@
<span
class="cmtt-10">\ifglshassymbol{#1}%</span>
<br /><span
-class="cmtt-10">{\section{</span><span id="textcolor133"><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="textcolor134"><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. 2013--><p class="indent" > In both of the above examples, the section titles start with a lowercase character (because the <span
+<!--l. 2058--><p class="indent" > In both of the above examples, the section titles start with a lowercase character (because the <span
class="cmtt-10">name</span><a
id="dx1-11053"></a> value is
-all lowercase in entry definitions). You can apply automatic case-change with the <span id="textcolor135"><span
+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-11054"></a> attribute. For
example: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor136"><span
+<span id="textcolor137"><span
class="cmtt-10">\glssetcategoryattribute</span></span><a
id="dx1-11055"></a><span
class="cmtt-10">{general}{glossname}{firstuc}</span>
@@ -4868,44 +5112,44 @@
</div>
</div> or (for title-case) <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor137"><span
+<span id="textcolor138"><span
class="cmtt-10">\glssetcategoryattribute</span></span><a
id="dx1-11056"></a><span
class="cmtt-10">{general}{glossname}{title}</span>
</div>
</div> However, this won’t apply the case-change in the table of contents or bookmarks.
-<!--l. 2027--><p class="indent" > In the second example, you can instead use <a
+<!--l. 2072--><p class="indent" > In the second example, you can instead use <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-11057"></a></a> to apply a case-change: </p><div class="alltt">
<div class="obeylines-v">
<span
-class="cmtt-10">\GlsXtrLoadResources[</span><span id="textcolor138"><span
+class="cmtt-10">\GlsXtrLoadResources[</span><span id="textcolor139"><span
class="cmtt-10">src</span></span><a
id="dx1-11058"></a><span
class="cmtt-10">=terms,</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor139"><span
+class="cmtt-10"> </span><span id="textcolor140"><span
class="cmtt-10">sort</span></span><a
id="dx1-11059"></a><span
-class="cmtt-10">=none,</span><span id="textcolor140"><span
+class="cmtt-10">=none,</span><span id="textcolor141"><span
class="cmtt-10">save-locations</span></span><a
id="dx1-11060"></a><span
class="cmtt-10">=false</span><strong><span
class="cmtt-10">,</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor141"><span
+class="cmtt-10"> </span><span id="textcolor142"><span
class="cmtt-10">replicate-fields</span></span><a
id="dx1-11061"></a><span
class="cmtt-10">={name=text},</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor142"><span
+class="cmtt-10"> </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="textcolor143"><span
+</div> (Or <span id="textcolor144"><span
class="cmtt-10">name-case-change</span></span><span
class="cmtt-10">=title</span><a
id="dx1-11062"></a> for title-case.) This copies the <span
@@ -4924,7 +5168,7 @@
class="cmtt-10">\gls</span><a
id="dx1-11068"></a> is still
lowercase.
-<!--l. 2043--><p class="indent" > In the first example (without <a
+<!--l. 2088--><p class="indent" > In the first example (without <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-11069"></a></a>) you need to do this manually. For example: </p><div class="alltt">
@@ -4953,7 +5197,7 @@
</div>
</div>
-<!--l. 2052--><p class="indent" > Note that if you use the default <span id="textcolor144"><span
+<!--l. 2097--><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-11070"></a> with <a
@@ -4963,7 +5207,7 @@
href="#option4">4</a>
and <a
href="#option6">6</a> to have both standalone definitions and an index. Now I do need a glossary style. In this case I’m going
-to use <span id="textcolor145"><span
+to use <span id="textcolor146"><span
class="cmss-10">bookindex</span></span><a
id="dx1-11072"></a>, which is provided in the <span
class="cmss-10">glossary-bookindex</span><a
@@ -4978,7 +5222,7 @@
</p><div class="alltt">
<div class="obeylines-v">
<span
-class="cmtt-10">\usepackage[</span><span id="textcolor146"><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
@@ -4993,7 +5237,7 @@
class="cmtt-10"> style</span><span
class="cmtt-10"> packages</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor147"><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
@@ -5000,7 +5244,7 @@
class="cmtt-10"> load</span><span
class="cmtt-10"> glossary-bookindex.sty</span>
<br /><span
-class="cmtt-10"> style=</span><span id="textcolor148"><span
+class="cmtt-10"> style=</span><span id="textcolor149"><span
class="cmtt-10">bookindex</span></span><span
class="cmtt-10">%</span><span
class="cmtt-10"> <-</span><span
@@ -5015,10 +5259,10 @@
</div>
</div> I also need to sort the entries, so the resource command is now: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor149"><span
+<span id="textcolor150"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
id="dx1-11076"></a><span
-class="cmtt-10">[</span><span id="textcolor150"><span
+class="cmtt-10">[</span><span id="textcolor151"><span
class="cmtt-10">src</span></span><a
id="dx1-11077"></a><span
class="cmtt-10">=terms,%</span><span
@@ -5026,7 +5270,7 @@
class="cmtt-10"> in</span><span
class="cmtt-10"> terms.bib</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor151"><span
+class="cmtt-10"> </span><span id="textcolor152"><span
class="cmtt-10">sort</span></span><a
id="dx1-11078"></a><span
class="cmtt-10">=en-GB,%</span><span
@@ -5035,12 +5279,12 @@
class="cmtt-10"> this</span><span
class="cmtt-10"> locale</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor152"><span
+class="cmtt-10"> </span><span id="textcolor153"><span
class="cmtt-10">replicate-fields</span></span><a
id="dx1-11079"></a><span
class="cmtt-10">={name=text},</span>
<br /><span
-class="cmtt-10"> </span><span id="textcolor153"><span
+class="cmtt-10"> </span><span id="textcolor154"><span
class="cmtt-10">name-case-change</span></span><span
class="cmtt-10">={firstuc}</span>
<br /><span
@@ -5048,18 +5292,18 @@
</div>
</div> At the end of the document, I can add the glossary: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor154"><span
+<span id="textcolor155"><span
class="cmtt-10">\printunsrtglossary</span></span><a
id="dx1-11080"></a><span
class="cmtt-10">[title=Index,target=false]</span>
</div>
</div> Note that I’ve had to switch off the hypertargets with <a
- id="dx1-11081"></a><span id="textcolor155"><span
+ id="dx1-11081"></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="textcolor156"><span
+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-11082"></a> switch:
-<!--l. 2083--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+<!--l. 2128--><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>
@@ -5079,11 +5323,11 @@
</div>
-<!--l. 2091--><p class="indent" > The <span id="textcolor157"><span
+<!--l. 2136--><p class="indent" > The <span id="textcolor158"><span
class="cmss-10">bookindex</span></span><a
id="dx1-11084"></a> style doesn’t show the description, so only the name and location is displayed. Remember
that the name has had a case-conversion so it now starts with an initial capital. If you feel this is inappropriate
-for the index, you can adjust the <span id="textcolor158"><span
+for the index, you can adjust the <span id="textcolor159"><span
class="cmss-10">bookindex</span></span><a
id="dx1-11085"></a> style so that it uses the <span
class="cmtt-10">text</span><a
@@ -5091,13 +5335,13 @@
</p><div class="alltt">
<div class="obeylines-v">
<span
-class="cmtt-10">\renewcommand*{</span><span id="textcolor159"><span
+class="cmtt-10">\renewcommand*{</span><span id="textcolor160"><span
class="cmtt-10">\glsxtrbookindexname</span></span><a
id="dx1-11087"></a><span
class="cmtt-10">}[1]{%</span>
<br /><span
class="cmtt-10"> </span><span
-class="cmtt-10"> </span><span id="textcolor160"><span
+class="cmtt-10"> </span><span id="textcolor161"><span
class="cmtt-10">\glossentrynameother</span></span><a
id="dx1-11088"></a><span
class="cmtt-10">{#1}{text}}</span>
@@ -5105,24 +5349,24 @@
</div> See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> user manual for further details about this style.
-<!--l. 2104--><p class="indent" > Note that on the first LaTeX run none of the entries will be defined. Once they are defined, the page
+<!--l. 2149--><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. 2109--><p class="indent" > If there are extra terms that need to be included in the index that don’t have a description, you can define
-them with <span id="textcolor161"><span
+</p><!--l. 2154--><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-11089"></a> in the <span
class="cmtt-10">bib</span><a
id="dx1-11090"></a> file. For example: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor162"><span
+<span id="textcolor163"><span
class="cmtt-10">@index</span></span><a
id="dx1-11091"></a><span
class="cmtt-10">{element}</span>
-<br /><span id="textcolor163"><span
+<br /><span id="textcolor164"><span
class="cmtt-10">@index</span></span><a
id="dx1-11092"></a><span
-class="cmtt-10">{member,</span><span id="textcolor164"><span id="textcolor165"><span
+class="cmtt-10">{member,</span><span id="textcolor165"><span id="textcolor166"><span
class="cmtt-10">alias</span></span><a
id="dx1-11093"></a></span><span
class="cmtt-10">={element}}</span>
@@ -5130,11 +5374,11 @@
</div> They can be used in the document as usual:
- <div class="verbatim" id="verbatim-24">
+ <pre class="verbatim" id="verbatim-26">
The objects that make up a set are the \glspl{element}
- <br />or \glspl{member}.
-</div>
-<!--l. 2120--><p class="nopar" > See <a
+or \glspl{member}.
+</pre>
+<!--l. 2165--><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
@@ -5142,17 +5386,18 @@
class="cmtt-10">bib2gls</span><a
id="dx1-11094"></a></a> user manual for further
details.
-</p><!--l. 2124--><p class="indent" > The <span
+</p><!--l. 2169--><p class="indent" > The <span
class="cmss-10">glossaries </span>package comes with a number of sample documents that illustrate the various functions. These
are listed in <a
-href="#sec:samples">§19 </a><a
+href="#sec:samples">§<span
+class="cmbx-10">??</span>sec:samples </a><a
href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>.
-</p><!--l. 2128--><p class="noindent" >
+</p><!--l. 2173--><p class="noindent" >
</p>
-<!--l. 2128--><p class="noindent" ><a
+<!--l. 2173--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a
id="sec:lipsum"></a>Dummy Entries for Testing</h3>
-<!--l. 2131--><p class="noindent" >In addition to the sample files described above, <span
+<!--l. 2176--><p class="noindent" >In addition to the sample files described above, <span
class="cmss-10">glossaries</span><a
id="dx1-12001"></a> also provides some files containing lorum
ipsum dummy entries. These are provided for testing purposes and are on TeX’s path (in
@@ -5172,115 +5417,136 @@
id="dx1-12005"></a></a>. The files are as
follows:
</p><dl class="description"><dt class="description">
+ <!--l. 2186--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-brief.tex</span> </dt><dd
-class="description">These entries all have brief descriptions. For example:
+class="cmbx-10">example-glossaries-brief.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2186--><p class="noindent" >These entries all have brief descriptions. For example:
- <div class="verbatim" id="verbatim-25">
+</p>
+ <pre class="verbatim" id="verbatim-27">
\newglossaryentry{lorem}{name={lorem},description={ipsum}}
-</div>
- <!--l. 2145--><p class="nopar" >
+</pre>
+ <!--l. 2190--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2192--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-long.tex</span> </dt><dd
-class="description">These entries all have long descriptions. For example:
+class="cmbx-10">example-glossaries-long.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2192--><p class="noindent" >These entries all have long descriptions. For example:
- <div class="verbatim" id="verbatim-26">
+</p>
+ <pre class="verbatim" id="verbatim-28">
\newglossaryentry{loremipsum}{name={lorem ipsum},
-  <br />description={dolor sit amet, consectetuer adipiscing
-  <br />elit. Ut purus elit, vestibulum ut, placerat ac,
-  <br />adipiscing vitae, felis. Curabitur dictum gravida
-  <br />mauris.}}
-</div>
- <!--l. 2155--><p class="nopar" >
+ description={dolor sit amet, consectetuer adipiscing
+ elit. Ut purus elit, vestibulum ut, placerat ac,
+ adipiscing vitae, felis. Curabitur dictum gravida
+ mauris.}}
+</pre>
+ <!--l. 2200--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2202--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-multipar.tex</span> </dt><dd
-class="description">These entries all have multi-paragraph descriptions. For example:
+class="cmbx-10">example-glossaries-multipar.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2202--><p class="noindent" >These entries all have multi-paragraph descriptions. For example:
- <div class="verbatim" id="verbatim-27">
+</p>
+ <pre class="verbatim" id="verbatim-29">
\longnewglossaryentry{loremi-ii}{name={lorem 1--2}}%
-  <br />{%
-  <br />Lorem ipsum ...
-  <br />Nam dui ligula...
-  <br />}
-</div>
- <!--l. 2166--><p class="nopar" >
+ {%
+ Lorem ipsum ...
+ Nam dui ligula...
+ }
+</pre>
+ <!--l. 2211--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2213--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-symbols.tex</span> </dt><dd
-class="description">These entries all use the <span
+class="cmbx-10">example-glossaries-symbols.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2213--><p class="noindent" >These entries all use the <span
class="cmtt-10">symbol</span><a
id="dx1-12006"></a> key. For example:
- <div class="verbatim" id="verbatim-28">
+</p>
+ <pre class="verbatim" id="verbatim-30">
\newglossaryentry{alpha}{name={alpha},
-  <br />symbol={\ensuremath{\alpha}},
-  <br />description={Quisque ullamcorper placerat ipsum.}}
-</div>
- <!--l. 2174--><p class="nopar" >
+ symbol={\ensuremath{\alpha}},
+ description={Quisque ullamcorper placerat ipsum.}}
+</pre>
+ <!--l. 2219--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2221--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-symbolnames.tex</span> </dt><dd
-class="description">Similar to the previous file but the <span
+class="cmbx-10">example-glossaries-symbolnames.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2221--><p class="noindent" >Similar to the previous file but the <span
class="cmtt-10">symbol</span><a
- id="dx1-12007"></a> key isn’t used. Instead the
- symbol is stored in the <span
+ id="dx1-12007"></a> key isn’t used. Instead the symbol is stored in the <span
class="cmtt-10">name</span><a
- id="dx1-12008"></a> key. For example:
+ id="dx1-12008"></a> key.
+ For example:
- <div class="verbatim" id="verbatim-29">
+</p>
+ <pre class="verbatim" id="verbatim-31">
\newglossaryentry{sym.alpha}{sort={alpha},
-  <br />name={\ensuremath{\alpha}},
-  <br />description={Quisque ullamcorper placerat ipsum.}}
-</div>
- <!--l. 2183--><p class="nopar" >
+ name={\ensuremath{\alpha}},
+ description={Quisque ullamcorper placerat ipsum.}}
+</pre>
+ <!--l. 2228--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2230--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-images.tex</span> </dt><dd
-class="description">These entries use the <span
+class="cmbx-10">example-glossaries-images.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2230--><p class="noindent" >These entries use the <span
class="cmtt-10">user1</span><a
- id="dx1-12009"></a> key to store the name of an image file. (The
- images are provided by the <span
+ id="dx1-12009"></a> key to store the name of an image file. (The images are provided by the <span
class="cmss-10">mwe</span><a
- id="dx1-12010"></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:
+ id="dx1-12010"></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:
- <div class="verbatim" id="verbatim-30">
+</p>
+ <pre class="verbatim" id="verbatim-32">
\longnewglossaryentry{sedfeugiat}{name={sed feugiat},
-  <br />user1={example-image}}%
-  <br />{%
-  <br />Cum sociis natoque...
-  <br />Etiam...
-  <br />}
-</div>
- <!--l. 2199--><p class="nopar" >
+ user1={example-image}}%
+ {%
+ Cum sociis natoque...
+ Etiam...
+ }
+</pre>
+ <!--l. 2244--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2246--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-acronym.tex</span> </dt><dd
-class="description">These entries are all abbreviations. For example:
+class="cmbx-10">example-glossaries-acronym.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2246--><p class="noindent" >These entries are all abbreviations. For example:
- <div class="verbatim" id="verbatim-31">
+</p>
+ <pre class="verbatim" id="verbatim-33">
\newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum
-  <br />dolor}
-</div>
- <!--l. 2206--><p class="nopar" >
- </p><!--l. 2207--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
+ dolor}
+</pre>
+ <!--l. 2251--><p class="nopar" >
+ </p><!--l. 2252--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> extension package, then <span
class="cmtt-10">\newacronym</span><a
- id="dx1-12011"></a> is redefined to use <span id="textcolor166"><span
+ id="dx1-12011"></a> is redefined to use <span id="textcolor167"><span
class="cmtt-10">\newabbreviation</span></span><a
id="dx1-12012"></a>
- with the <span id="textcolor167"><span id="textcolor168"><span
+ with the <span id="textcolor168"><span id="textcolor169"><span
class="cmtt-10">category</span></span><a
id="dx1-12013"></a></span> key set to <span
class="cmtt-10">acronym </span>(rather than the default <span
@@ -5290,34 +5556,36 @@
</p>
- <div class="verbatim" id="verbatim-32">
+ <pre class="verbatim" id="verbatim-34">
\setabbreviationstyle[acronym]{long-short}
-</div>
- <!--l. 2216--><p class="nopar" > </div>
- </p><!--l. 2217--><p class="noindent" >
+</pre>
+ <!--l. 2261--><p class="nopar" > </div>
+ </p><!--l. 2262--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 2264--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-acronym-desc.tex</span> </dt><dd
-class="description">This file contains entries that are all abbreviations that use the
- <span
+class="cmbx-10">example-glossaries-acronym-desc.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2264--><p class="noindent" >This file contains entries that are all abbreviations that use the <span
class="cmtt-10">description</span><a
id="dx1-12014"></a> key. For example:
- <div class="verbatim" id="verbatim-33">
+</p>
+ <pre class="verbatim" id="verbatim-35">
\newacronym[type=\glsdefaulttype,
-  <br />  description={fringilla a, euismod sodales,
-  <br />  sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula}
-</div>
- <!--l. 2227--><p class="nopar" >
- </p><!--l. 2228--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
+   description={fringilla a, euismod sodales,
+   sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula}
+</pre>
+ <!--l. 2272--><p class="nopar" >
+ </p><!--l. 2273--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> extension package, then <span
class="cmtt-10">\newacronym</span><a
- id="dx1-12015"></a> is redefined to use <span id="textcolor169"><span
+ id="dx1-12015"></a> is redefined to use <span id="textcolor170"><span
class="cmtt-10">\newabbreviation</span></span><a
id="dx1-12016"></a>
- with the <span id="textcolor170"><span id="textcolor171"><span
+ with the <span id="textcolor171"><span id="textcolor172"><span
class="cmtt-10">category</span></span><a
id="dx1-12017"></a></span> key set to <span
class="cmtt-10">acronym </span>(rather than the default <span
@@ -5327,33 +5595,36 @@
</p>
- <div class="verbatim" id="verbatim-34">
+ <pre class="verbatim" id="verbatim-36">
\setabbreviationstyle[acronym]{long-short-desc}
-</div>
- <!--l. 2237--><p class="nopar" > </div>
- </p><!--l. 2238--><p class="noindent" >
+</pre>
+ <!--l. 2282--><p class="nopar" > </div>
+ </p><!--l. 2283--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 2285--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-acronyms-lang.tex</span> </dt><dd
-class="description">These entries are all abbreviations, where some of them have
- a translation supplied in the <span
+class="cmbx-10">example-glossaries-acronyms-lang.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2285--><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-12018"></a> key. For example:
+ id="dx1-12018"></a> key. For
+ example:
- <div class="verbatim" id="verbatim-35">
+</p>
+ <pre class="verbatim" id="verbatim-37">
\newacronym[type=\glsdefaulttype,user1={love itself}]
-  <br /> {li}{LI}{lorem ipsum}
-</div>
- <!--l. 2247--><p class="nopar" >
- </p><!--l. 2248--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
+  {li}{LI}{lorem ipsum}
+</pre>
+ <!--l. 2292--><p class="nopar" >
+ </p><!--l. 2293--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> extension package, then <span
class="cmtt-10">\newacronym</span><a
- id="dx1-12019"></a> is redefined to use <span id="textcolor172"><span
+ id="dx1-12019"></a> is redefined to use <span id="textcolor173"><span
class="cmtt-10">\newabbreviation</span></span><a
id="dx1-12020"></a>
- with the <span id="textcolor173"><span id="textcolor174"><span
+ with the <span id="textcolor174"><span id="textcolor175"><span
class="cmtt-10">category</span></span><a
id="dx1-12021"></a></span> key set to <span
class="cmtt-10">acronym </span>(rather than the default <span
@@ -5363,118 +5634,182 @@
</p>
- <div class="verbatim" id="verbatim-36">
+ <pre class="verbatim" id="verbatim-38">
\setabbreviationstyle[acronym]{long-short-user}
-</div>
- <!--l. 2257--><p class="nopar" > </div>
- </p><!--l. 2258--><p class="noindent" >
+</pre>
+ <!--l. 2302--><p class="nopar" > </div>
+ </p><!--l. 2303--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 2305--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-parent.tex</span> </dt><dd
-class="description">These are hierarchical entries where the child entries use the <span
+class="cmbx-10">example-glossaries-parent.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2305--><p class="noindent" >These are hierarchical entries where the child entries use the <span
class="cmtt-10">name</span><a
- id="dx1-12022"></a> key. For
- example:
+ id="dx1-12022"></a> key. For example:
- <div class="verbatim" id="verbatim-37">
+</p>
+ <pre class="verbatim" id="verbatim-39">
\newglossaryentry{sedmattis}{name={sed mattis},
-  <br />description={erat sit amet}
-  <br />\newglossaryentry{gravida}{parent={sedmattis},
-  <br />  name={gravida},description={malesuada}}
-</div>
- <!--l. 2269--><p class="nopar" >
+ description={erat sit amet}
+ \newglossaryentry{gravida}{parent={sedmattis},
+   name={gravida},description={malesuada}}
+</pre>
+ <!--l. 2314--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2316--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-childnoname.tex</span> </dt><dd
-class="description">These are hierarchical entries where the child entries don’t use the
- <span
+class="cmbx-10">example-glossaries-childnoname.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2316--><p class="noindent" >These are hierarchical entries where the child entries don’t use the <span
class="cmtt-10">name</span><a
id="dx1-12023"></a> key. For example:
- <div class="verbatim" id="verbatim-38">
+</p>
+ <pre class="verbatim" id="verbatim-40">
\newglossaryentry{scelerisque}{name={scelerisque},
-  <br />  description={at}}
-  <br />\newglossaryentry{vestibulum}{parent={scelerisque},
-  <br />  description={eu, nulla}}
-</div>
- <!--l. 2280--><p class="nopar" >
+   description={at}}
+ \newglossaryentry{vestibulum}{parent={scelerisque},
+   description={eu, nulla}}
+</pre>
+ <!--l. 2325--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2327--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-cite.tex</span> </dt><dd
-class="description">These entries use the <span
-class="cmtt-10">user1</span><a
- id="dx1-12024"></a> key to store a citation key (or comma-separated list
- of citation keys). The citations are defined in <span
-class="cmtt-10">xampl.bib</span>, which should be available on all modern
- TeX distributions. One entry doesn’t have an associated citation to help test for a missing key. For
+class="cmbx-10">example-glossaries-longchild.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2327--><p class="noindent" >(New to v4.47.) These entries all have long descriptions and there are some child entries. For
example:
- <div class="verbatim" id="verbatim-39">
+</p>
+ <pre class="verbatim" id="verbatim-41">
+ \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. 2340--><p class="nopar" >
+ </p></dd><dt class="description">
+ <!--l. 2342--><p class="noindent" >
+<span
+class="cmbx-10">example-glossaries-childmultipar.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2342--><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-12024"></a> key set to the name of an image file provided
+ by the <span
+class="cmss-10">mwe</span><a
+ id="dx1-12025"></a> package. For example:
+
+
+</p>
+ <pre class="verbatim" id="verbatim-42">
+ \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. 2363--><p class="nopar" >
+ </p></dd><dt class="description">
+ <!--l. 2365--><p class="noindent" >
+<span
+class="cmbx-10">example-glossaries-cite.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2365--><p class="noindent" >These entries use the <span
+class="cmtt-10">user1</span><a
+ id="dx1-12026"></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-43">
\newglossaryentry{fusce}{name={fusce},
-  <br />description={suscipit cursus sem},user1={article-minimal}}
-</div>
- <!--l. 2292--><p class="nopar" >
+ description={suscipit cursus sem},user1={article-minimal}}
+</pre>
+ <!--l. 2375--><p class="nopar" >
</p></dd><dt class="description">
+ <!--l. 2377--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-url.tex</span> </dt><dd
-class="description">These entries use the <span
+class="cmbx-10">example-glossaries-url.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2377--><p class="noindent" >These entries use the <span
class="cmtt-10">user1</span><a
- id="dx1-12025"></a> key to store an URL associated with the entry. For
- example:
+ id="dx1-12027"></a> key to store an URL associated with the entry. For example:
- <div class="verbatim" id="verbatim-40">
+</p>
+ <pre class="verbatim" id="verbatim-44">
\newglossaryentry{aenean-url}{name={aenean},
-  <br /> description={adipiscing auctor est},
-  <br /> user1={http://uk.tug.org/}}
-</div>
- <!--l. 2301--><p class="nopar" ></p></dd></dl>
-<!--l. 2304--><p class="indent" > The sample file <a
+  description={adipiscing auctor est},
+  user1={http://uk.tug.org/}}
+</pre>
+ <!--l. 2384--><p class="nopar" ></p></dd></dl>
+<!--l. 2387--><p class="indent" > The sample file <a
href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.tex" ><span
class="cmtt-10">glossary-lipsum-examples.tex</span></a> in the <span
class="cmtt-10">doc/latex/glossaries/samples </span>directory uses all
these files. See also <a
href="https://www.dickimaw-books.com/gallery/#glossaries" ><span
-class="cmtt-10">https://www.dickimaw-books.com/gallery/#glossaries</span></a>.
-</p><!--l. 2308--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a
+class="cmss-10">glossaries </span>gallery</a>.
+</p><!--l. 2391--><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. 2395--><p class="noindent" >
<span
-class="cmbx-10">example-glossaries-xr.tex</span> </dt><dd
-class="description">These entries use the <span
+class="cmbx-10">example-glossaries-xr.tex</span> </p></dt><dd
+class="description">
+ <!--l. 2395--><p class="noindent" >These entries use the <span
class="cmtt-10">see</span><a
- id="dx1-12026"></a> key provided by the base <span
-class="cmss-10">glossaries </span>package and also the
- <span id="textcolor175"><span id="textcolor176"><span
+ id="dx1-12028"></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-12027"></a></span> and <span id="textcolor177"><span id="textcolor178"><span
+ id="dx1-12029"></a></span> and <span id="textcolor178"><span id="textcolor179"><span
class="cmtt-10">seealso</span></span><a
- id="dx1-12028"></a></span> keys that require <a
+ id="dx1-12030"></a></span>
+ keys that require <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>. For example:
- <div class="verbatim" id="verbatim-41">
+</p>
+ <pre class="verbatim" id="verbatim-45">
\newglossaryentry{alias-lorem}{name={alias-lorem},
-  <br /> description={ipsum},alias={lorem}}
-  <br />\newglossaryentry{amet}{name={amet},description={consectetuer},
-  <br /> see={dolor}}
-  <br />\newglossaryentry{arcu}{name={arcu},description={libero},
-  <br /> seealso={placerat,vitae,curabitur}}
-</div>
- <!--l. 2325--><p class="nopar" ></p></dd></dl>
-<!--l. 2328--><p class="noindent" >
+  description={ipsum},alias={lorem}}
+ \newglossaryentry{amet}{name={amet},description={consectetuer},
+  see={dolor}}
+ \newglossaryentry{arcu}{name={arcu},description={libero},
+  seealso={placerat,vitae,curabitur}}
+</pre>
+ <!--l. 2408--><p class="nopar" ></p></dd></dl>
+<!--l. 2411--><p class="noindent" >
</p>
-<!--l. 2328--><p class="noindent" ><a
+<!--l. 2411--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a
id="sec:languages"></a>Multi-Lingual Support</h3>
-<!--l. 2331--><p class="noindent" ><div class="important" title="Important Note"> The <span
+<!--l. 2414--><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
@@ -5484,8 +5819,8 @@
href="https://www.dickimaw-books.com/latex/tracklang/" >Localisation with <span
class="cmtt-10">tracklang.tex</span></a> for further details.
</div>
-</p><!--l. 2341--><p class="noindent" >
-</p><!--l. 2343--><p class="noindent" >As from version 1.17, the <span
+</p><!--l. 2424--><p class="noindent" >
+</p><!--l. 2426--><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
@@ -5511,7 +5846,7 @@
id="dx1-13006"></a></a> and <a
href="#option1">Option 1</a>
can only perform limited ASCII comparisons.
-</p><!--l. 2351--><p class="indent" > This means that with Options <a
+</p><!--l. 2434--><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
@@ -5522,16 +5857,16 @@
</p>
- <div class="verbatim" id="verbatim-42">
-\documentclass[frenchb]{article}
- <br />\usepackage[utf8]{inputenc}
- <br />\usepackage[T1]{fontenc}
- <br />\usepackage{babel}
- <br />\usepackage[xindy]{glossaries}
-</div>
-<!--l. 2360--><p class="nopar" > If you want to use <span
+ <pre class="verbatim" id="verbatim-46">
+\documentclass[french]{article}
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage{babel}
+\usepackage[xindy]{glossaries}
+</pre>
+<!--l. 2443--><p class="nopar" > If you want to use <span
class="cmtt-10">bib2gls</span><a
- id="dx1-13009"></a>, you need to use the <span id="textcolor179"><span
+ id="dx1-13009"></a>, you need to use the <span id="textcolor180"><span
class="cmss-10">record</span></span><a
id="dx1-13010"></a> option with <a
href="#glo:glossaries-extra"><span
@@ -5542,7 +5877,7 @@
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-13012"></a></a> user manual for further details.)
-</p><!--l. 2366--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a
+</p><!--l. 2449--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a
href="#glo:nonlatinchar">non-Latin character<a
id="dx1-13013"></a></a>, such as é, looks like a plain character in your <span
class="cmtt-10">tex</span><a
@@ -5551,8 +5886,8 @@
the field expansions with <span
class="cmtt-10">\glsnoexpandfields</span>. This issue doesn’t occur with XeLaTeX or LuaLaTeX.
</div>
-</p><!--l. 2372--><p class="noindent" >
-</p><!--l. 2374--><p class="indent" > With <span
+</p><!--l. 2455--><p class="noindent" >
+</p><!--l. 2457--><p class="indent" > With <span
class="cmss-10">inputenc</span><a
id="dx1-13015"></a>, if you use a <a
href="#glo:nonlatinchar">non-Latin character<a
@@ -5575,7 +5910,7 @@
</div> For further details, see the “UTF-8” section in the <span
class="cmss-10">mfirstuc</span><a
id="dx1-13018"></a> user manual.
-<!--l. 2385--><p class="indent" > If you are using <a
+<!--l. 2468--><p class="indent" > If you are using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-13019"></a></a> or <a
@@ -5604,7 +5939,7 @@
<span
class="cmtt-10">xindy</span><a
id="dx1-13028"></a> manual for further details of this option.
-</p><!--l. 2394--><p class="indent" > As from v4.24, if you are writing in German (for example, using the <span
+</p><!--l. 2477--><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-13029"></a>
package<span class="footnote-mark"><a
@@ -5623,12 +5958,12 @@
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-13034"></a>’s</a> quote character using:
-</p><!--l. 2399--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 2482--><p class="indent" > <hr><div title="Definition"><a
id="dx1-13035"></a> <span
class="cmtt-10">\GlsSetQuote{</span>⟨<span
class="cmitt-10">character</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2401--><p class="noindent" >
+</p><!--l. 2484--><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
@@ -5638,10 +5973,10 @@
</p>
- <div class="verbatim" id="verbatim-43">
+ <pre class="verbatim" id="verbatim-47">
\GlsSetQuote{+}
-</div>
-<!--l. 2407--><p class="nopar" > This must be done before <span
+</pre>
+<!--l. 2490--><p class="nopar" > This must be done before <span
class="cmtt-10">\makeglossaries</span><a
id="dx1-13036"></a> and any entry definitions. It’s only applicable for <span
class="cmtt-10">makeindex</span><a
@@ -5656,7 +5991,7 @@
<span
class="cmtt-10">makeindex</span><a
id="dx1-13041"></a>.
-</p><!--l. 2414--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span
+</p><!--l. 2497--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span
class="cmss-10">babel</span><a
id="dx1-13042"></a>’s shorthands. These aren’t switched on until the start of the document, so any entries
defined in the preamble won’t be able to use those shorthands. However, if you define the entries in the
@@ -5671,29 +6006,29 @@
<span
class="cmtt-10">sort</span><a
id="dx1-13045"></a> key. </div>
-</p><!--l. 2423--><p class="noindent" >
-</p><!--l. 2425--><p class="indent" > In general, it’s best not to use <span
+</p><!--l. 2506--><p class="noindent" >
+</p><!--l. 2508--><p class="indent" > In general, it’s best not to use <span
class="cmss-10">babel</span><a
id="dx1-13046"></a>’s shorthands in entry definitions. For example:
</p>
- <div class="verbatim" id="verbatim-44">
+ <pre class="verbatim" id="verbatim-48">
\documentclass{article}
- <br />\usepackage[ngerman]{babel}
- <br />\usepackage{glossaries}
- <br />\GlsSetQuote{+}
- <br />\makeglossaries
- <br />\newglossaryentry{rna}{name={ribonukleins\"aure},
- <br />  sort={ribonukleins"aure},
- <br />  description={eine Nukleins\"aure}}
- <br />\begin{document}
- <br />\gls{rna}
- <br />\printglossaries
- <br />\end{document}
-</div>
-<!--l. 2446--><p class="nopar" >
-</p><!--l. 2448--><p class="indent" > The <span
+\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. 2529--><p class="nopar" >
+</p><!--l. 2531--><p class="indent" > The <span
class="cmss-10">ngerman</span><a
id="dx1-13047"></a> package has the shorthands on in the preamble, so they can be used in definitions if
<span
@@ -5704,33 +6039,34 @@
</p>
- <div class="verbatim" id="verbatim-45">
+ <pre class="verbatim" id="verbatim-49">
\documentclass{article}
- <br />\usepackage[ngerman]{babel}
- <br />\usepackage{glossaries}
- <br />\GlsSetQuote{+}
- <br />\makeglossaries
- <br />\newglossaryentry{rna}{name={ribonukleins"aure},
- <br />  description={eine Nukleins"aure}}
- <br />\begin{document}
- <br />\gls{rna}
- <br />\printglossaries
- <br />\end{document}
-</div>
-<!--l. 2469--><p class="nopar" >
-</p><!--l. 2471--><p class="noindent" >
+\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. 2552--><p class="nopar" >
+</p><!--l. 2554--><p class="noindent" >
</p>
-<!--l. 2471--><p class="noindent" ><a
+<!--l. 2554--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.3.1 </span> <a
id="sec:fixednames"></a>Changing the Fixed Names</h4>
-<!--l. 2474--><p class="noindent" >The fixed names are produced using the commands listed in <a
-href="#tab:predefinednames">table 1.2</a>. If you aren’t using a language package
-such as <span
+<!--l. 2557--><p class="noindent" >The fixed names are produced using the commands listed in <a
+href="#tab:predefinednames">table <span
+class="cmbx-10">??</span>tab:predefinednames</a>. If you aren’t using a
+language package such as <span
class="cmss-10">babel</span><a
id="dx1-14001"></a> or <span
class="cmss-10">polyglossia</span><a
- id="dx1-14002"></a> that uses caption hooks, you can just redefine these commands as appropriate. If
-you are using <span
+ id="dx1-14002"></a> that uses caption hooks, you can just redefine these commands as
+appropriate. If you are using <span
class="cmss-10">babel</span><a
id="dx1-14003"></a> or <span
class="cmss-10">polyglossia</span><a
@@ -5779,12 +6115,12 @@
</p>
- <div class="verbatim" id="verbatim-46">
+ <pre class="verbatim" id="verbatim-50">
\documentclass[english,french]{article}
- <br />\usepackage{babel}
- <br />\usepackage[translate=babel]{glossaries}
-</div>
-<!--l. 2495--><p class="nopar" > and then use <span
+\usepackage{babel}
+\usepackage[translate=babel]{glossaries}
+</pre>
+<!--l. 2578--><p class="nopar" > and then use <span
class="cmss-10">babel</span><a
id="dx1-14018"></a>’s caption hook mechanism. Note that if you pass the language options directly to <span
class="cmss-10">babel</span><a
@@ -5802,7 +6138,7 @@
<div class="table">
-<!--l. 2503--><p class="indent" > <a
+<!--l. 2586--><p class="indent" > <a
id="tab:predefinednames"></a></p><hr class="float" /><div class="float"
>
@@ -5813,7 +6149,7 @@
<div class="tabular"> <table id="TBL-3" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-3-1g"><col
id="TBL-3-1" /><col
id="TBL-3-2" /><col
@@ -5821,13 +6157,13 @@
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. 2509--><p class="noindent" ><span
+class="td11"> <!--l. 2592--><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. 2510--><p class="noindent" ><span
+class="td10"> <!--l. 2593--><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"
@@ -5834,9 +6170,9 @@
class="td01"><span
class="cmtt-10">\glossaryname</span><a
id="dx1-14024"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-2-2"
-class="td11"> <!--l. 2511--><p class="noindent" ><span
+class="td11"> <!--l. 2594--><p class="noindent" ><span
class="cmtt-10">Glossary</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-2-3"
-class="td10"> <!--l. 2511--><p class="noindent" >Title
+class="td10"> <!--l. 2594--><p class="noindent" >Title
of
the
main
@@ -5846,9 +6182,9 @@
class="td01"><span
class="cmtt-10">\acronymname</span><a
id="dx1-14025"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-3-2"
-class="td11"> <!--l. 2512--><p class="noindent" ><span
+class="td11"> <!--l. 2595--><p class="noindent" ><span
class="cmtt-10">Acronyms</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-3-3"
-class="td10"> <!--l. 2512--><p class="noindent" >Title
+class="td10"> <!--l. 2595--><p class="noindent" >Title
of
the
list
@@ -5867,11 +6203,11 @@
class="td01"><span
class="cmtt-10">\entryname</span><a
id="dx1-14027"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-4-2"
-class="td11"> <!--l. 2514--><p class="noindent" ><span
+class="td11"> <!--l. 2597--><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. 2515--><p class="noindent" >Header
+class="td10"> <!--l. 2598--><p class="noindent" >Header
for
first
column
@@ -5893,11 +6229,11 @@
class="td01"><span
class="cmtt-10">\descriptionname</span><a
id="dx1-14028"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-5-2"
-class="td11"> <!--l. 2517--><p class="noindent" ><span
+class="td11"> <!--l. 2600--><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. 2518--><p class="noindent" >Header
+class="td10"> <!--l. 2601--><p class="noindent" >Header
for
second
column
@@ -5919,11 +6255,11 @@
class="td01"><span
class="cmtt-10">\symbolname</span><a
id="dx1-14029"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-6-2"
-class="td11"> <!--l. 2520--><p class="noindent" ><span
+class="td11"> <!--l. 2603--><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. 2520--><p class="noindent" >Header
+class="td10"> <!--l. 2603--><p class="noindent" >Header
for
symbol
column
@@ -5942,13 +6278,13 @@
class="td01"><span
class="cmtt-10">\pagelistname</span><a
id="dx1-14030"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-7-2"
-class="td11"> <!--l. 2522--><p class="noindent" ><span
+class="td11"> <!--l. 2605--><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. 2523--><p class="noindent" >Header
+class="td10"> <!--l. 2606--><p class="noindent" >Header
for
page
list
@@ -5967,11 +6303,11 @@
class="td01"><span
class="cmtt-10">\glssymbolsgroupname</span><a
id="dx1-14031"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-8-2"
-class="td11"> <!--l. 2525--><p class="noindent" ><span
+class="td11"> <!--l. 2608--><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. 2526--><p class="noindent" >Header
+class="td10"> <!--l. 2609--><p class="noindent" >Header
for
symbols
section
@@ -5990,11 +6326,11 @@
class="td01"><span
class="cmtt-10">\glsnumbersgroupname</span><a
id="dx1-14032"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-9-2"
-class="td11"> <!--l. 2528--><p class="noindent" ><span
+class="td11"> <!--l. 2611--><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. 2528--><p class="noindent" >Header
+class="td10"> <!--l. 2611--><p class="noindent" >Header
for
numbers
section
@@ -6015,7 +6351,7 @@
</div><hr class="endfloat" />
</div>
-<!--l. 2534--><p class="indent" > As from version 4.12, multilingual support is provided by separate language modules that need to be
+<!--l. 2617--><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
@@ -6028,9 +6364,10 @@
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. 2546--><p class="indent" > Examples of use: </p>
+</p><!--l. 2629--><p class="indent" > Examples of use: </p>
<ul class="itemize1">
- <li class="itemize">Using <span
+ <li class="itemize">
+ <!--l. 2631--><p class="noindent" >Using <span
class="cmss-10">babel</span><a
id="dx1-14034"></a> and <span
class="cmss-10">translator</span><a
@@ -6037,26 +6374,29 @@
id="dx1-14035"></a>:
- <div class="verbatim" id="verbatim-47">
+</p>
+ <pre class="verbatim" id="verbatim-51">
\documentclass[english,french]{article}
-  <br />\usepackage{babel}
-  <br />\usepackage{glossaries}
-</div>
- <!--l. 2553--><p class="nopar" > (<span
+ \usepackage{babel}
+ \usepackage{glossaries}
+</pre>
+ <!--l. 2636--><p class="nopar" > (<span
class="cmss-10">translator</span><a
id="dx1-14036"></a> is automatically loaded).
</p></li>
- <li class="itemize">Using <span
+ <li class="itemize">
+ <!--l. 2639--><p class="noindent" >Using <span
class="cmss-10">babel</span><a
id="dx1-14037"></a>:
- <div class="verbatim" id="verbatim-48">
+</p>
+ <pre class="verbatim" id="verbatim-52">
\documentclass[english,french]{article}
-  <br />\usepackage{babel}
-  <br />\usepackage[translate=babel]{glossaries}
-</div>
- <!--l. 2561--><p class="nopar" > (<span
+ \usepackage{babel}
+ \usepackage[translate=babel]{glossaries}
+</pre>
+ <!--l. 2644--><p class="nopar" > (<span
class="cmss-10">translator</span><a
id="dx1-14038"></a> isn’t loaded). The <a
href="#glo:glossaries-extra"><span
@@ -6069,21 +6409,23 @@
id="dx1-14040"></a> has been
loaded.
</p></li>
- <li class="itemize">Using <span
+ <li class="itemize">
+ <!--l. 2649--><p class="noindent" >Using <span
class="cmss-10">polyglossia</span><a
id="dx1-14041"></a>:
- <div class="verbatim" id="verbatim-49">
+</p>
+ <pre class="verbatim" id="verbatim-53">
\documentclass{article}
-  <br />\usepackage{polyglossia}
-  <br />\setmainlanguage{english}
-  <br />\usepackage{glossaries}
-</div>
- <!--l. 2572--><p class="nopar" >
+ \usepackage{polyglossia}
+ \setmainlanguage{english}
+ \usepackage{glossaries}
+</pre>
+ <!--l. 2655--><p class="nopar" >
</p>
</li></ul>
-<!--l. 2576--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations may not be
+<!--l. 2659--><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-14042"></a> package and the <span
@@ -6106,7 +6448,7 @@
class="cmtt-10">\printglossary </span>(but not the iterative commands like
<span
class="cmtt-10">\printglossaries</span>).
-</p><!--l. 2588--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
+</p><!--l. 2671--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
class="cmss-10">translator</span><a
id="dx1-14046"></a> dictionaries are loaded at the beginning of the document, so it won’t have any effect
if you put <span
@@ -6117,8 +6459,8 @@
class="cmss-10">beamer</span><a
id="dx1-14048"></a> documentation.)
</div>
-</p><!--l. 2595--><p class="noindent" >
-</p><!--l. 2597--><p class="indent" > Your custom dictionary doesn’t have to be just a translation from English to another language. You may
+</p><!--l. 2678--><p class="noindent" >
+</p><!--l. 2680--><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,
@@ -6125,30 +6467,30 @@
</p>
- <div class="verbatim" id="verbatim-50">
+ <pre class="verbatim" id="verbatim-54">
myinstitute-glossaries-dictionary-English.dict
-</div>
-<!--l. 2605--><p class="nopar" > that contains the following:
+</pre>
+<!--l. 2688--><p class="nopar" > that contains the following:
</p>
- <div class="verbatim" id="verbatim-51">
+ <pre class="verbatim" id="verbatim-55">
\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
- <br />\deftranslation{Glossary}{Nomenclature}
- <br />\deftranslation{Page List (glossaries)}{Location}
-</div>
-<!--l. 2611--><p class="nopar" > You can now load it using:
+\deftranslation{Glossary}{Nomenclature}
+\deftranslation{Page List (glossaries)}{Location}
+</pre>
+<!--l. 2694--><p class="nopar" > You can now load it using:
</p>
- <div class="verbatim" id="verbatim-52">
+ <pre class="verbatim" id="verbatim-56">
\usedictionary{myinstitute-glossaries-dictionary}
-</div>
-<!--l. 2615--><p class="nopar" > (Make sure that <span
+</pre>
+<!--l. 2698--><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. 2620--><p class="indent" > If you are using <span
+</p><!--l. 2703--><p class="indent" > If you are using <span
class="cmss-10">babel</span><a
id="dx1-14049"></a> and don’t want to use the <span
class="cmss-10">translator</span><a
@@ -6161,17 +6503,17 @@
</p>
- <div class="verbatim" id="verbatim-53">
+ <pre class="verbatim" id="verbatim-57">
\documentclass[british]{article}
- <br />\usepackage{babel}
- <br />\usepackage[translate=babel]{glossaries}
- <br />\addto\captionsbritish{%
- <br />    \renewcommand*{\glossaryname}{List of Terms}%
- <br />    \renewcommand*{\acronymname}{List of Acronyms}%
- <br />}
-</div>
-<!--l. 2633--><p class="nopar" >
-</p><!--l. 2635--><p class="indent" > Note that <a
+\usepackage{babel}
+\usepackage[translate=babel]{glossaries}
+\addto\captionsbritish{%
+    \renewcommand*{\glossaryname}{List of Terms}%
+    \renewcommand*{\acronymname}{List of Acronyms}%
+}
+</pre>
+<!--l. 2716--><p class="nopar" >
+</p><!--l. 2718--><p class="indent" > Note that <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-14052"></a></a> and <a
@@ -6186,9 +6528,10 @@
href="#option4">4</a> if you have glossary entries that contain <a
href="#glo:nonlatinchar">non-Latin character<a
id="dx1-14055"></a>s</a>. See <a
-href="#sec:xindy">§11 </a><a
-href="#sec:xindy">Xindy
-(Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on <a
+href="#sec:xindy">§<span
+class="cmbx-10">??</span>sec:xindy
+</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-14056"></a></a>, and see the <a
@@ -6197,9 +6540,10 @@
id="dx1-14057"></a></a> user manual for further details of that
application.
</p>
- <h5 class="subsubsectionHead"><a
- id="pluralsuffix"></a>Creating a New Language Module</h5>
-<!--l. 2645--><p class="noindent" >The <span
+<!--l. 2725--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.3.2 </span> <a
+ id="pluralsuffix"></a>Creating a New Language Module</h4>
+<!--l. 2728--><p class="noindent" >The <span
class="cmss-10">glossaries </span>package now uses the <span
class="cmss-10">tracklang</span><a
id="dx1-15001"></a> package to determine which language modules need
@@ -6207,7 +6551,7 @@
class="cmss-10">tracklang</span><a
id="dx1-15002"></a>
documentation.
-</p><!--l. 2650--><p class="indent" > To create a new language module, you need to at least create two files called: <span
+</p><!--l. 2733--><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
@@ -6224,23 +6568,23 @@
class="cmss-10">translator</span><a
id="dx1-15005"></a> (for example, <span
class="cmtt-10">English</span>).
-</p><!--l. 2657--><p class="indent" > Here’s an example of <span
+</p><!--l. 2740--><p class="indent" > Here’s an example of <span
class="cmtt-10">glossaries-dictionary-English.dict</span>:
</p>
- <div class="verbatim" id="verbatim-54">
+ <pre class="verbatim" id="verbatim-58">
\ProvidesDictionary{glossaries-dictionary}{English}
- <br />\providetranslation{Glossary}{Glossary}
- <br />\providetranslation{Acronyms}{Acronyms}
- <br />\providetranslation{Notation (glossaries)}{Notation}
- <br />\providetranslation{Description (glossaries)}{Description}
- <br />\providetranslation{Symbol (glossaries)}{Symbol}
- <br />\providetranslation{Page List (glossaries)}{Page List}
- <br />\providetranslation{Symbols (glossaries)}{Symbols}
- <br />\providetranslation{Numbers (glossaries)}{Numbers}
-</div>
-<!--l. 2669--><p class="nopar" > You can use this as a template for your dictionary file. Change <span
+\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. 2752--><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-15006"></a> name for your
@@ -6250,71 +6594,71 @@
class="cmtt-10">.dict</span>) and, for each
<span
class="cmtt-10">\providetranslation</span>, change the second argument to the appropriate translation.
-</p><!--l. 2677--><p class="indent" > Here’s an example of <span
+</p><!--l. 2760--><p class="indent" > Here’s an example of <span
class="cmtt-10">glossaries-english.ldf</span>:
</p>
- <div class="verbatim" id="verbatim-55">
+ <pre class="verbatim" id="verbatim-59">
\ProvidesGlossariesLang{english}
- <br />\glsifusedtranslatordict{English}
- <br />{%
- <br />  \addglossarytocaptions{\CurrentTrackedLanguage}%
- <br />  \addglossarytocaptions{\CurrentTrackedDialect}%
- <br />}
- <br />{%
- <br />  \@ifpackageloaded{polyglossia}%
- <br />  {%
- <br />    \newcommand*{\glossariescaptionsenglish}{%
- <br />      \renewcommand*{\glossaryname}{\textenglish{Glossary}}%
- <br />      \renewcommand*{\acronymname}{\textenglish{Acronyms}}%
- <br />      \renewcommand*{\entryname}{\textenglish{Notation}}%
- <br />      \renewcommand*{\descriptionname}{\textenglish{Description}}%
- <br />      \renewcommand*{\symbolname}{\textenglish{Symbol}}%
- <br />      \renewcommand*{\pagelistname}{\textenglish{Page List}}%
- <br />      \renewcommand*{\glssymbolsgroupname}{\textenglish{Symbols}}%
- <br />      \renewcommand*{\glsnumbersgroupname}{\textenglish{Numbers}}%
- <br />    }%
- <br />  }%
- <br />  {%
- <br />    \newcommand*{\glossariescaptionsenglish}{%
- <br />      \renewcommand*{\glossaryname}{Glossary}%
- <br />      \renewcommand*{\acronymname}{Acronyms}%
- <br />      \renewcommand*{\entryname}{Notation}%
- <br />      \renewcommand*{\descriptionname}{Description}%
- <br />      \renewcommand*{\symbolname}{Symbol}%
- <br />      \renewcommand*{\pagelistname}{Page List}%
- <br />      \renewcommand*{\glssymbolsgroupname}{Symbols}%
- <br />      \renewcommand*{\glsnumbersgroupname}{Numbers}%
- <br />    }%
- <br />  }%
- <br />  \ifcsdef{captions\CurrentTrackedDialect}
- <br />  {%
- <br />    \csappto{captions\CurrentTrackedDialect}%
- <br />    {%
- <br />      \glossariescaptionsenglish
- <br />    }%
- <br />  }%
- <br />  {%
- <br />    \ifcsdef{captions\CurrentTrackedLanguage}
- <br />    {
- <br />      \csappto{captions\CurrentTrackedLanguage}%
- <br />      {%
- <br />        \glossariescaptionsenglish
+\glsifusedtranslatordict{English}
+{%
+  \addglossarytocaptions{\CurrentTrackedLanguage}%
+  \addglossarytocaptions{\CurrentTrackedDialect}%
+}
+{%
+  \@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
- <br />      }%
- <br />    }%
- <br />    {%
- <br />    }%
- <br />  }%
- <br />  \glossariescaptionsenglish
- <br />}
- <br />\renewcommand*{\glspluralsuffix}{s}
- <br />\renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}
- <br />\renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
-</div>
-<!--l. 2735--><p class="nopar" > This is a somewhat longer file, but again you can use it as a template. Replace <span
+      }%
+    }%
+    {%
+    }%
+  }%
+  \glossariescaptionsenglish
+}
+\renewcommand*{\glspluralsuffix}{s}
+\renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}
+\renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
+</pre>
+<!--l. 2818--><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-15007"></a>
@@ -6326,7 +6670,7 @@
class="cmtt-10">\glossariescaptions</span>⟨<span
class="cmti-10">lang</span>⟩, replace the English text (such as “Glossaries”) with the
appropriate translation.
-</p><!--l. 2745--><p class="indent" > <span class="warningsymbol">⚠</span> The suffixes used to generate the plural forms when the plural hasn’t been specified are given by
+</p><!--l. 2828--><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
@@ -6339,7 +6683,7 @@
They may be expanded on definition or they may be expanded on use, depending on the <span
class="cmss-10">glossaries</span>
configuration.
-</p><!--l. 2756--><p class="indent" > <div class="important" title="Important Note"> Therefore these plural suffix command definitions aren’t included in the caption mechanism as that’s
+</p><!--l. 2839--><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
@@ -6350,8 +6694,8 @@
class="cmtt-10">shortplural</span><a
id="dx1-15010"></a> etc keys to override exceptions.
</div>
-</p><!--l. 2765--><p class="noindent" >
-</p><!--l. 2767--><p class="indent" > If you want to add a regional variation, create a file called <span
+</p><!--l. 2848--><p class="noindent" >
+</p><!--l. 2850--><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
@@ -6366,125 +6710,129 @@
</p>
- <div class="verbatim" id="verbatim-56">
+ <pre class="verbatim" id="verbatim-60">
 \ProvidesGlossariesLang{en-GB}
- <br /> \RequireGlossariesLang{english}
- <br /> \glsifusedtranslatordict{British}
- <br /> {%
- <br />   \addglossarytocaptions{\CurrentTrackedLanguage}%
- <br />   \addglossarytocaptions{\CurrentTrackedDialect}%
- <br /> }
- <br /> {%
- <br />   \@ifpackageloaded{polyglossia}%
- <br />   {%
- <br />     % Modify \glossariescaptionsenglish as appropriate for
- <br />     % polyglossia
- <br />   }%
- <br />   {%
- <br />     % Modify \glossariescaptionsenglish as appropriate for
- <br />     % non-polyglossia
- <br />   }%
- <br /> }
-</div>
-<!--l. 2792--><p class="nopar" >
-</p><!--l. 2794--><p class="indent" > If the translations includes <a
+ \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. 2875--><p class="nopar" >
+</p><!--l. 2877--><p class="indent" > If the translations includes <a
href="#glo:nonlatinchar">non-Latin character<a
id="dx1-15011"></a>s</a>, it’s necessary to provide code that’s independent of the
-input encoding. Remember that while some users may use UTF-8, others may use Latin-1 or any other
+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 UTF-8 version for XeLaTeX users.
-</p><!--l. 2801--><p class="indent" > The <span
+provide a <a
+href="#glo:UTF-8">UTF-8</a> version for XeLaTeX and LuaLaTeX users.
+</p><!--l. 2884--><p class="indent" > The <span
class="cmtt-10">glossaries-irish.ldf </span>file provides this as follows:
</p>
- <div class="verbatim" id="verbatim-57">
+ <pre class="verbatim" id="verbatim-61">
\ProvidesGlossariesLang{irish}
- <br />\glsifusedtranslatordict{Irish}
- <br />{%
- <br />  \addglossarytocaptions{\CurrentTrackedLanguage}%
- <br />  \addglossarytocaptions{\CurrentTrackedDialect}%
- <br />}
- <br />{%
- <br />  \ifdefstring{\inputencodingname}{utf8}
- <br />  {\input{glossaries-irish-utf8.ldf}}%
- <br />  {%
- <br />    \ifdef{\XeTeXinputencoding}% XeTeX defaults to UTF-8
- <br />    {\input{glossaries-irish-utf8.ldf}}%
- <br />    {\input{glossaries-irish-noenc.ldf}}
- <br />  }
- <br />  \ifcsdef{captions\CurrentTrackedDialect}
- <br />  {%
- <br />    \csappto{captions\CurrentTrackedDialect}%
- <br />    {%
- <br />      \glossariescaptionsirish
- <br />    }%
- <br />  }%
- <br />  {%
- <br />    \ifcsdef{captions\CurrentTrackedLanguage}
- <br />    {
- <br />      \csappto{captions\CurrentTrackedLanguage}%
- <br />      {%
- <br />        \glossariescaptionsirish
- <br />      }%
- <br />    }%
- <br />    {%
- <br />    }%
- <br />  }%
- <br />  \glossariescaptionsirish
- <br />}
-</div>
-<!--l. 2838--><p class="nopar" > (Again you can use this as a template. Replace <span
+\glsifusedtranslatordict{Irish}
+{%
+  \addglossarytocaptions{\CurrentTrackedLanguage}%
+  \addglossarytocaptions{\CurrentTrackedDialect}%
+}
+{%
+  \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
+}
+</pre>
+<!--l. 2921--><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-15012"></a> dictionary label.)
-</p><!--l. 2843--><p class="indent" > There are now two extra files: <span
+</p><!--l. 2926--><p class="indent" > There are now two extra files: <span
class="cmtt-10">glossaries-irish-noenc.ldf </span>(no encoding information) and
<span
-class="cmtt-10">glossaries-irish-utf8.ldf </span>(UTF-8).
-</p><!--l. 2847--><p class="indent" > These both define <span
+class="cmtt-10">glossaries-irish-utf8.ldf </span>(<a
+href="#glo:UTF-8">UTF-8</a>).
+</p><!--l. 2930--><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>
- <div class="verbatim" id="verbatim-58">
+ <pre class="verbatim" id="verbatim-62">
\@ifpackageloaded{polyglossia}%
- <br />{%
- <br />  \newcommand*{\glossariescaptionsirish}{%
- <br />    \renewcommand*{\glossaryname}{\textirish{Gluais}}%
- <br />    \renewcommand*{\acronymname}{\textirish{Acrainmneacha}}%
- <br />    \renewcommand*{\entryname}{\textirish{Ciall}}%
- <br />    \renewcommand*{\descriptionname}{\textirish{Tuairisc}}%
- <br />    \renewcommand*{\symbolname}{\textirish{Comhartha}}%
- <br />    \renewcommand*{\glssymbolsgroupname}{\textirish{Comhartha\'{\i}}}%
- <br />    \renewcommand*{\pagelistname}{\textirish{Leathanaigh}}%
- <br />    \renewcommand*{\glsnumbersgroupname}{\textirish{Uimhreacha}}%
- <br />  }%
- <br />}%
- <br />{%
- <br />  \newcommand*{\glossariescaptionsirish}{%
- <br />    \renewcommand*{\glossaryname}{Gluais}%
- <br />    \renewcommand*{\acronymname}{Acrainmneacha}%
- <br />    \renewcommand*{\entryname}{Ciall}%
- <br />    \renewcommand*{\descriptionname}{Tuairisc}%
- <br />    \renewcommand*{\symbolname}{Comhartha}%
- <br />    \renewcommand*{\glssymbolsgroupname}{Comhartha\'{\i}}%
- <br />    \renewcommand*{\pagelistname}{Leathanaigh}%
- <br />    \renewcommand*{\glsnumbersgroupname}{Uimhreacha}%
- <br />  }%
- <br />}
-</div>
-<!--l. 2875--><p class="nopar" > whereas the <span
-class="cmtt-10">*-utf8.ldf </span>replaces the accent commands with the appropriate UTF-8 characters.
-</p><!--l. 2880--><p class="noindent" >
+{%
+  \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}%
+  }%
+}
+</pre>
+<!--l. 2958--><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. 2963--><p class="noindent" >
</p>
-<!--l. 2880--><p class="noindent" ><a
+<!--l. 2963--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a
id="sec:makeglossaries"></a>Generating the Associated Glossary Files</h3>
-<!--l. 2883--><p class="noindent" ><div class="important" title="Important Note"> This section is only applicable if you have chosen Options <a
+<!--l. 2966--><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
@@ -6497,8 +6845,8 @@
class="cmtt-10">bib2gls</span><a
id="dx1-16003"></a></a>).
</div>
-</p><!--l. 2889--><p class="noindent" >
-</p><!--l. 2891--><p class="noindent" >If this section seriously confuses you, and you can’t work out how to run external tools like <a
+</p><!--l. 2972--><p class="noindent" >
+</p><!--l. 2974--><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-16004"></a></a> or
@@ -6508,12 +6856,13 @@
id="dx1-16005"></a></a>, you can try using the <span
class="cmss-10">automake</span><a
id="dx1-16006"></a> package option, described in <a
-href="#sec:pkgopts-sort">§2.5 </a><a
-href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>, but you will need
-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. 2900--><p class="indent" > In order to generate a sorted glossary with compact <a
+href="#sec:pkgopts-sort">§<span
+class="cmbx-10">??</span>sec:pkgopts-sort </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. 2983--><p class="indent" > In order to generate a sorted glossary with compact <a
href="#glo:numberlist">number list<a
id="dx1-16007"></a>s</a>, it is necessary to use an external <a
href="#glo:indexingapp">indexing
@@ -6520,12 +6869,12 @@
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="#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-16008"></a></a> and <a
@@ -6532,40 +6881,41 @@
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-16009"></a></a>. As from version 1.17, the <span
-class="cmss-10">glossaries </span>package can be used with either of
-these applications. Previous versions were designed to be used with <span
+class="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-16010"></a> only. With the
-<a
+ id="dx1-16010"></a> only. With the <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> package, you can also use <a
+class="cmss-10">glossaries-extra</span></a>
+package, you can also use <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-16011"></a></a> as the indexing application. (See the <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>
-and <a
+class="cmss-10">glossaries-extra</span></a> and <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-16012"></a></a> user manuals for further details.) Note that <span
+ id="dx1-16012"></a></a>
+user manuals for further details.) Note that <span
class="cmtt-10">xindy</span><a
id="dx1-16013"></a> and <span
class="cmtt-10">bib2gls</span><a
- id="dx1-16014"></a> have much better
-multi-lingual support than <span
+ id="dx1-16014"></a> have much better multi-lingual
+support than <span
class="cmtt-10">makeindex</span><a
id="dx1-16015"></a>, so <span
class="cmtt-10">xindy</span><a
id="dx1-16016"></a> or <span
class="cmtt-10">bib2gls</span><a
- id="dx1-16017"></a> are recommended if you’re not writing in
-English. Commands that only have an effect when <span
+ id="dx1-16017"></a> are recommended if you’re not writing in English.
+Commands that only have an effect when <span
class="cmtt-10">xindy</span><a
id="dx1-16018"></a> is used are described in <a
-href="#sec:xindy">§11 </a><a
+href="#sec:xindy">§<span
+class="cmbx-10">??</span>sec:xindy </a><a
href="#sec:xindy">Xindy (Option
3)<!--tex4ht:ref: sec:xindy --></a>.
-</p><!--l. 2920--><p class="indent" > <div class="important" title="Important Note"> This is a multi-stage process, but there are methods of automating document compilation using applications
+</p><!--l. 3003--><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-16019"></a> and <span
@@ -6591,8 +6941,8 @@
</div> With <span
class="cmtt-10">latexmk</span><a
id="dx1-16022"></a> you need to set up the required dependencies. </div>
-<!--l. 2931--><p class="noindent" >
-</p><!--l. 2933--><p class="indent" > The <span
+<!--l. 3014--><p class="noindent" >
+</p><!--l. 3016--><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
@@ -6602,14 +6952,15 @@
id="dx1-16024"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-16025"></a></a> on all
-the glossary files using a customized style file (which is created by <span
+ id="dx1-16025"></a></a>
+on all the glossary files using a customized style file (which is created by <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-16026"></a>). See <a
-href="#sec:makeglossariesapp">§1.4.1
-</a><a
-href="#sec:makeglossariesapp">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further details. Perl is stable, cross-platform, open source
-software that is used by a number of TeX-related applications (including <span
+ id="dx1-16026"></a>). See
+<a
+href="#sec:makeglossariesapp">§<span
+class="cmbx-10">??</span>sec:makeglossariesapp </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-16027"></a> and <span
class="cmtt-10">latexmk</span><a
@@ -6628,18 +6979,20 @@
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. 2949--><p class="indent" > The advantages of using <span
+</p><!--l. 3032--><p class="indent" > The advantages of using <span
class="cmtt-10">makeglossaries</span><a
id="dx1-16031"></a>: </p>
<ul class="itemize1">
- <li class="itemize">It automatically detects whether to use <span
+ <li class="itemize">
+ <!--l. 3034--><p class="noindent" >It automatically detects whether to use <span
class="cmtt-10">makeindex</span><a
id="dx1-16032"></a> or <span
class="cmtt-10">xindy</span><a
id="dx1-16033"></a> and sets the relevant application
switches.
- </li>
- <li class="itemize">One call of <span
+ </p></li>
+ <li class="itemize">
+ <!--l. 3037--><p class="noindent" >One call of <span
class="cmtt-10">makeglossaries</span><a
id="dx1-16034"></a> will run <span
class="cmtt-10">makeindex</span><a
@@ -6646,8 +6999,11 @@
id="dx1-16035"></a>/<span
class="cmtt-10">xindy</span><a
id="dx1-16036"></a> for each glossary type.
- </li>
- <li class="itemize">If things go wrong, <a
+ </p></li>
+ <li class="itemize">
+
+
+ <!--l. 3040--><p class="noindent" >If things go wrong, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-16037"></a></a> will scan the messages from <a
@@ -6665,10 +7021,9 @@
id="dx1-16040"></a> or <span
class="cmtt-10">xindy</span><a
id="dx1-16041"></a> messages.
-
-
- </li>
- <li class="itemize">If <a
+ </p></li>
+ <li class="itemize">
+ <!--l. 3048--><p class="noindent" >If <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-16042"></a></a> warns about multiple encap values, <a
@@ -6690,11 +7045,13 @@
id="dx1-16048"></a></a> uses the
order of the <a
id="dx1-16049"></a>attributes list to determine which format should take precedence. (see <a
-href="#sec:xindyloc">§11.2 </a><a
-href="#sec:xindyloc">Locations
- and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.)
+href="#sec:xindyloc">§<span
+class="cmbx-10">??</span>sec:xindyloc
+ </a><a
+href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.)
+</p>
</li></ul>
-<!--l. 2975--><p class="indent" > As from version 4.16, the <span
+<!--l. 3058--><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
@@ -6718,7 +7075,7 @@
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-16054"></a></a>).
-</p><!--l. 2985--><p class="indent" > If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use
+</p><!--l. 3068--><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
@@ -6730,7 +7087,7 @@
href="#glo:makeglossaries-lite.lua"><span
class="cmtt-10">makeglossaries-lite</span><a
id="dx1-16057"></a></a>.
-</p><!--l. 2991--><p class="indent" > Whilst I strongly recommended that you use the <a
+</p><!--l. 3074--><p class="indent" > Whilst I strongly recommended that you use the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-16058"></a></a> Perl script or the <a
@@ -6747,8 +7104,9 @@
class="cmtt-10">xindy</span><a
id="dx1-16061"></a></a>. These are listed in
<a
-href="#tab:makeglossariesCmds">table 1.3</a>.
-</p><!--l. 2998--><p class="indent" > <div class="important" title="Important Note"> If you are choosing not to use <span
+href="#tab:makeglossariesCmds">table <span
+class="cmbx-10">??</span>tab:makeglossariesCmds</a>.
+</p><!--l. 3081--><p class="indent" > <div class="important" title="Important Note"> If you are choosing not to use <span
class="cmtt-10">makeglossaries</span><a
id="dx1-16062"></a> because you don’t want to install Perl, you will only be able
to use <span
@@ -6759,8 +7117,8 @@
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. 3004--><p class="noindent" >
-</p><!--l. 3006--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an
+</p><!--l. 3087--><p class="noindent" >
+</p><!--l. 3089--><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
@@ -6777,14 +7135,14 @@
</p>
- <div class="verbatim" id="verbatim-59">
+ <pre class="verbatim" id="verbatim-63">
\newglossaryentry{citrusfruit}{name={citrus fruit},
- <br />description={fruit of any citrus tree. (See also
- <br />\gls{orange})}}
- <br />\newglossaryentry{orange}{name={orange},
- <br />description={an orange coloured fruit.}}
-</div>
-<!--l. 3019--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span
+description={fruit of any citrus tree. (See also
+\gls{orange})}}
+\newglossaryentry{orange}{name={orange},
+description={an orange coloured fruit.}}
+</pre>
+<!--l. 3102--><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
@@ -6801,7 +7159,7 @@
id="dx1-16072"></a></a>. For example, if the document is called <span
class="cmtt-10">myDoc.tex</span>, then you must
do:
-</p><!--l. 3027--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3110--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />pdflatex myDoc
<br />makeglossaries myDoc
<br />pdflatex myDoc
@@ -6823,7 +7181,7 @@
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-16075"></a></a> manual for further details.)
-</p><!--l. 3040--><p class="indent" > Likewise, an additional <a
+</p><!--l. 3123--><p class="indent" > Likewise, an additional <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-16076"></a></a> and LaTeX run may be required if the document pages shift with
@@ -6832,7 +7190,7 @@
<a
href="#glo:numberlist">number list<a
id="dx1-16077"></a>s</a> in the glossary may need updating.
-</p><!--l. 3048--><p class="indent" > The examples in this document assume that you are accessing <a
+</p><!--l. 3131--><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-16078"></a></a>, <a
@@ -6852,11 +7210,11 @@
class="cmss-10">All Programs-</span><span
class="cmmi-10">></span><span
class="cmss-10">Accessories </span>menu.
-</p><!--l. 3054--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the required
+</p><!--l. 3137--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the required
application. See <a
href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document
build</a>.
-</p><!--l. 3060--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span
+</p><!--l. 3143--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span
class="cmtt-10">glg</span><a
id="dx1-16081"></a> or <span
class="cmtt-10">alg</span><a
@@ -6865,7 +7223,7 @@
<div class="table">
-<!--l. 3063--><p class="indent" > <a
+<!--l. 3146--><p class="indent" > <a
id="tab:makeglossariesCmds"></a></p><hr class="float" /><div class="float"
>
@@ -6880,7 +7238,7 @@
class="cmtt-10">makeindex</span><a
id="dx1-16085"></a></a> explicitly</span></div><!--tex4ht:label?: x1-160833 -->
<div class="tabular"> <table id="TBL-4" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-4-1g"><col
id="TBL-4-1" /><col
id="TBL-4-2" /><col
@@ -6969,10 +7327,10 @@
</div><hr class="endfloat" />
</div>
-<!--l. 3086--><p class="noindent" ><a
+<!--l. 3169--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.1 </span> <a
id="sec:makeglossariesapp"></a>Using the makeglossaries Perl Script</h4>
-<!--l. 3089--><p class="noindent" >The <a
+<!--l. 3172--><p class="noindent" >The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-17001"></a></a> script picks up the relevant information from the auxiliary (<span
@@ -6990,7 +7348,7 @@
id="dx1-17005"></a>. For example, if your document is called <span
class="cmtt-10">myDoc.tex</span>, type the
following in your terminal:
-</p><!--l. 3096--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3179--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />pdflatex myDoc
<br />makeglossaries myDoc
<br />pdflatex myDoc
@@ -7000,11 +7358,11 @@
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-17006"></a></a> into Perl:
-</p><!--l. 3102--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3185--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />perl makeglossaries myDoc
<br /></pre><spacer type=vertical size=10>
<br /></span>
-</p><!--l. 3106--><p class="indent" > Windows users: TeX Live on Windows has its own internal Perl interpreter and provides
+</p><!--l. 3189--><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
@@ -7021,7 +7379,7 @@
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. 3118--><p class="indent" > The <a
+</p><!--l. 3201--><p class="indent" > The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-17009"></a></a> script attempts to fork the <a
@@ -7055,7 +7413,7 @@
class="cmtt-10">-q</span><a
id="dx1-17017"></a> (quiet) switch doesn’t
work as well.
-</p><!--l. 3130--><p class="indent" > You can specify in which directory the <span
+</p><!--l. 3213--><p class="indent" > You can specify in which directory the <span
class="cmtt-10">aux</span><a
id="dx1-17018"></a>, <span
class="cmtt-10">glo</span><a
@@ -7062,7 +7420,7 @@
id="dx1-17019"></a> etc files are located using the <span
class="cmtt-10">-d </span>switch. For
example:
-</p><!--l. 3133--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3216--><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>
@@ -7088,7 +7446,7 @@
id="dx1-17026"></a>.
-</p><!--l. 3143--><p class="indent" > As from <a
+</p><!--l. 3226--><p class="indent" > As from <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-17027"></a></a> v2.18, if you are using <a
@@ -7102,17 +7460,17 @@
</p>
- <div class="verbatim" id="verbatim-60">
+ <pre class="verbatim" id="verbatim-64">
\documentclass{article}
- <br />\usepackage{glossaries}
- <br />\makeglossaries
- <br />\newglossaryentry{sample}{name={sample},description={an example}}
- <br />\begin{document}
- <br />\gls{sample}, \gls[format=textbf]{sample}.
- <br />\printglossaries
- <br />\end{document}
-</div>
-<!--l. 3159--><p class="nopar" > If you explicitly use <a
+\usepackage{glossaries}
+\makeglossaries
+\newglossaryentry{sample}{name={sample},description={an example}}
+\begin{document}
+\gls{sample}, \gls[format=textbf]{sample}.
+\printglossaries
+\end{document}
+</pre>
+<!--l. 3242--><p class="nopar" > If you explicitly use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-17030"></a></a>, this will cause a warning and the location list will be “1, <span
@@ -7129,21 +7487,21 @@
class="cmtt-10">xindy</span><a
id="dx1-17033"></a> won’t produce any warning and will simply discard
duplicates.
-</p><!--l. 3168--><p class="indent" > For a complete list of options do <span
+</p><!--l. 3251--><p class="indent" > For a complete list of options do <span
class="cmtt-10">makeglossaries --help</span>.
-</p><!--l. 3170--><p class="indent" > <div class="important" title="Important Note"> When upgrading the <span
+</p><!--l. 3253--><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-17034"></a></a>. The
-current version is 4.45. </div>
-</p><!--l. 3174--><p class="noindent" >
-</p><!--l. 3176--><p class="noindent" >
+current version is 4.47. </div>
+</p><!--l. 3257--><p class="noindent" >
+</p><!--l. 3259--><p class="noindent" >
</p>
-<!--l. 3176--><p class="noindent" ><a
+<!--l. 3259--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.2 </span> <a
id="sec:makeglossarieslua"></a>Using the makeglossaries-lite Lua Script</h4>
-<!--l. 3179--><p class="noindent" >The Lua alternative to the <a
+<!--l. 3262--><p class="noindent" >The Lua alternative to the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-18001"></a></a> Perl script requires a Lua interpreter, which should already be
@@ -7160,7 +7518,7 @@
class="cmtt-10">-d</span><a
id="dx1-18004"></a>
option.)
-</p><!--l. 3189--><p class="indent" > <div class="important" title="Important Note"> Note that TeX Live on Unix-like systems creates a symbolic link called <span
+</p><!--l. 3272--><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
@@ -7167,8 +7525,8 @@
id="dx1-18005"></a> extension) to the actual <span
class="cmtt-10">makeglossaries-lite.lua </span>script, so you may not need to supply the extension.
</div>
-</p><!--l. 3195--><p class="noindent" >
-</p><!--l. 3197--><p class="indent" > The <a
+</p><!--l. 3278--><p class="noindent" >
+</p><!--l. 3280--><p class="indent" > The <a
href="#glo:makeglossaries-lite.lua"><span
class="cmtt-10">makeglossaries-lite</span><a
id="dx1-18006"></a></a> script can be invoked in the same way as <a
@@ -7177,7 +7535,7 @@
id="dx1-18007"></a></a>. For example, if your
document is called <span
class="cmtt-10">myDoc.tex</span>, then do
-</p><!--l. 3200--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3283--><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>
@@ -7184,11 +7542,11 @@
<br /></span>
or
-</p><!--l. 3204--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3287--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />makeglossaries-lite myDoc
<br /></pre><spacer type=vertical size=10>
<br /></span>
-</p><!--l. 3208--><p class="indent" > <span
+</p><!--l. 3291--><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
@@ -7197,18 +7555,18 @@
href="#glo:makeglossaries-lite.lua"><span
class="cmtt-10">makeglossaries-lite</span><a
id="dx1-18009"></a></a> script. For a complete list of available options, do
-</p><!--l. 3211--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3294--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />makeglossaries-lite.lua --help
<br /></pre><spacer type=vertical size=10>
<br /></span>
-</p><!--l. 3217--><p class="noindent" >
+</p><!--l. 3300--><p class="noindent" >
</p>
-<!--l. 3217--><p class="noindent" ><a
+<!--l. 3300--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.3 </span> <a
id="sec:xindyapp"></a>Using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span></a> explicitly (Option 3)</h4>
-<!--l. 3220--><p class="noindent" ><a
+<!--l. 3303--><p class="noindent" ><a
href="#glo:xindy"><span
class="cmtt-10">Xindy</span><a
id="dx1-19001"></a></a> comes with TeX Live. It has also been added to MikTeX, but if you don’t have it installed, see <a
@@ -7215,7 +7573,7 @@
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. 3226--><p class="indent" > If you want to use <a
+</p><!--l. 3309--><p class="indent" > If you want to use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-19002"></a></a> to process the glossary files, you must make sure you have used the <span
@@ -7225,10 +7583,10 @@
</p>
- <div class="verbatim" id="verbatim-61">
+ <pre class="verbatim" id="verbatim-65">
\usepackage[xindy]{glossaries}
-</div>
-<!--l. 3231--><p class="nopar" > This is required regardless of whether you use <a
+</pre>
+<!--l. 3314--><p class="nopar" > This is required regardless of whether you use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-19004"></a></a> explicitly or whether it’s called implicitly via applications
@@ -7246,11 +7604,11 @@
class="cmtt-10">-I</span><a
id="dx1-19008"></a> <span
class="cmtt-10">tex</span>.
-</p><!--l. 3238--><p class="indent" > To run <a
+</p><!--l. 3321--><p class="indent" > To run <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-19009"></a></a> type the following in your terminal (all on one line):
-</p><!--l. 3240--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3323--><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
@@ -7284,14 +7642,14 @@
class="cmtt-10">}</span>. You may need to specify the
full path name depending on the current working directory. If any of the file names contain spaces, you must
delimit them using double-quotes.
-</p><!--l. 3253--><p class="indent" > For example, if your document is called <span
+</p><!--l. 3336--><p class="indent" > For example, if your document is called <span
class="cmtt-10">myDoc.tex </span>and you are using UTF8 encoding in English, then type
the following in your terminal:
-</p><!--l. 3256--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3339--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
<br />xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo
<br /></pre><spacer type=vertical size=10>
<br /></span>
-</p><!--l. 3260--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of the other glossaries
+</p><!--l. 3343--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of the other glossaries
(including the list of acronyms if you have used the <span
class="cmss-10">acronym</span><a
id="dx1-19015"></a> package option), substituting <span
@@ -7305,7 +7663,7 @@
class="cmss-10">acronym</span><a
id="dx1-19019"></a> package option, then you would need to
do:
-</p><!--l. 3267--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3350--><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>
@@ -7313,7 +7671,7 @@
<span
class="cmtt-10">\newglossary</span><a
id="dx1-19020"></a>.
-</p><!--l. 3273--><p class="indent" > Note that if you use <a
+</p><!--l. 3356--><p class="indent" > Note that if you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-19021"></a></a> instead, you can replace all those calls to <a
@@ -7323,7 +7681,7 @@
<span
class="cmtt-10">makeglossaries</span><a
id="dx1-19023"></a>:
-</p><!--l. 3276--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3359--><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>
@@ -7334,17 +7692,18 @@
<span
class="cmtt-10">makeglossaries</span><a
id="dx1-19025"></a>. These are listed in <a
-href="#tab:makeglossariesCmds">table 1.3</a>.
+href="#tab:makeglossariesCmds">table <span
+class="cmbx-10">??</span>tab:makeglossariesCmds</a>.
-</p><!--l. 3286--><p class="noindent" >
+</p><!--l. 3369--><p class="noindent" >
</p>
-<!--l. 3286--><p class="noindent" ><a
+<!--l. 3369--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.4 </span> <a
id="sec:makeindexapp"></a>Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span></a> explicitly (Option 2)</h4>
-<!--l. 3289--><p class="noindent" >If you want to use <a
+<!--l. 3372--><p class="noindent" >If you want to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-20001"></a></a> explicitly, you must make sure that you haven’t used the <span
@@ -7354,7 +7713,7 @@
class="cmtt-10">makeindex</span><a
id="dx1-20003"></a>, type the following in your
terminal:
-</p><!--l. 3294--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3377--><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
@@ -7387,9 +7746,9 @@
class="cmtt-10">makeindex</span><a
id="dx1-20010"></a> manual for further
details.
-</p><!--l. 3305--><p class="indent" > For example, if your document is called <span
+</p><!--l. 3388--><p class="indent" > For example, if your document is called <span
class="cmtt-10">myDoc.tex</span>, then type the following at the terminal:
-</p><!--l. 3307--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3390--><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>
@@ -7410,7 +7769,7 @@
class="cmss-10">acronym</span><a
id="dx1-20016"></a> package option, then you need to type the
following in your terminal:
-</p><!--l. 3318--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3401--><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>
@@ -7418,7 +7777,7 @@
<span
class="cmtt-10">\newglossary</span><a
id="dx1-20017"></a>.
-</p><!--l. 3324--><p class="indent" > Note that if you use <a
+</p><!--l. 3407--><p class="indent" > Note that if you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-20018"></a></a> instead, you can replace all those calls to <a
@@ -7428,7 +7787,7 @@
to <span
class="cmtt-10">makeglossaries</span><a
id="dx1-20020"></a>:
-</p><!--l. 3327--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h">
+</p><!--l. 3410--><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>
@@ -7439,13 +7798,14 @@
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-20022"></a></a>. These are listed in <a
-href="#tab:makeglossariesCmds">table 1.3</a>.
-</p><!--l. 3335--><p class="noindent" >
+href="#tab:makeglossariesCmds">table <span
+class="cmbx-10">??</span>tab:makeglossariesCmds</a>.
+</p><!--l. 3418--><p class="noindent" >
</p>
-<!--l. 3335--><p class="noindent" ><a
+<!--l. 3418--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.5 </span> <a
id="sec:notedev"></a>Note to Front-End and Script Developers</h3>
-<!--l. 3338--><p class="noindent" >The information needed to determine whether to use <a
+<!--l. 3421--><p class="noindent" >The information needed to determine whether to use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-21001"></a></a>, <a
@@ -7461,13 +7821,13 @@
section describes how the information is stored in the auxiliary file.
-</p><!--l. 3344--><p class="noindent" >
+</p><!--l. 3427--><p class="noindent" >
</p>
-<!--l. 3344--><p class="noindent" ><a
+<!--l. 3427--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.1 </span> <a
id="sec:notedev.makeindex.xindy"></a>MakeIndex and Xindy</h4>
-<!--l. 3347--><p class="noindent" >The file extensions used by each defined (but not ignored) glossary are given by
-</p><!--l. 3348--><p class="indent" > <hr><div title="Definition"><a
+<!--l. 3430--><p class="noindent" >The file extensions used by each defined (but not ignored) glossary are given by
+</p><!--l. 3431--><p class="indent" > <hr><div title="Definition"><a
id="dx1-22001"></a> <span
class="cmtt-10">\@newglossary{</span>⟨<span
class="cmitt-10">label</span>⟩<span
@@ -7478,7 +7838,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">in-ext</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3350--><p class="noindent" >
+</p><!--l. 3433--><p class="noindent" >
where ⟨<span
class="cmti-10">in-ext</span>⟩ is the extension of the <a
href="#glo:indexingapp"><span
@@ -7502,10 +7862,10 @@
</p>
- <div class="verbatim" id="verbatim-62">
+ <pre class="verbatim" id="verbatim-66">
\@newglossary{main}{glg}{gls}{glo}
-</div>
-<!--l. 3364--><p class="nopar" > If <a
+</pre>
+<!--l. 3447--><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
@@ -7513,7 +7873,7 @@
class="cmtt-10">]</span>), then the sub-list of
glossaries that need to be processed will be identified with: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor180"><span
+<span id="textcolor181"><span
class="cmtt-10">\glsxtr at makeglossaries</span></span><a
id="dx1-22004"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7521,14 +7881,14 @@
class="cmtt-10">}</span>
</div>
</div>
-<!--l. 3372--><p class="indent" > The <a
+<!--l. 3455--><p class="indent" > The <a
href="#glo:indexingapp">indexing application’s</a> style file is specified by
-</p><!--l. 3373--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3456--><p class="indent" > <hr><div title="Definition"><a
id="dx1-22005"></a> <span
class="cmtt-10">\@istfilename{</span>⟨<span
class="cmitt-10">filename</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3375--><p class="noindent" >
+</p><!--l. 3458--><p class="noindent" >
The file extension indicates whether to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
@@ -7542,7 +7902,7 @@
id="dx1-22009"></a>). Note that the glossary information
is formatted differently depending on which indexing application is supposed to be used, so it’s important to call
the correct one.
-</p><!--l. 3382--><p class="indent" > For example, with <span
+</p><!--l. 3465--><p class="indent" > For example, with <span
class="cmtt-10">arara</span><a
id="dx1-22010"></a> you can easily determine whether to run <a
href="#glo:makeglossaries"><span
@@ -7564,7 +7924,7 @@
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-22013"></a></a>
-<!--l. 3389--><p class="indent" > <div class="important" title="Important Note"> Note that if you choose to explicitly call <a
+<!--l. 3472--><p class="indent" > <div class="important" title="Important Note"> Note that if you choose to explicitly call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-22014"></a></a> or <a
@@ -7575,23 +7935,23 @@
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
id="dx1-22016"></a></a> also provides. </div>
-</p><!--l. 3394--><p class="noindent" >
-</p><!--l. 3396--><p class="indent" > Word or letter ordering is specified by:
-</p><!--l. 3397--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3477--><p class="noindent" >
+</p><!--l. 3479--><p class="indent" > Word or letter ordering is specified by:
+</p><!--l. 3480--><p class="indent" > <hr><div title="Definition"><a
id="dx1-22017"></a> <span
class="cmtt-10">\@glsorder{</span>⟨<span
class="cmitt-10">order</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3399--><p class="noindent" >
+</p><!--l. 3482--><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. 3402--><p class="indent" > If <a
+</p><!--l. 3485--><p class="indent" > If <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
id="dx1-22018"></a></a> should be used, the language and code page for each glossary is specified by
-</p><!--l. 3404--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3487--><p class="indent" > <hr><div title="Definition"><a
id="dx1-22019"></a><a
id="dx1-22020"></a> <span
class="cmtt-10">\@xdylanguage{</span>⟨<span
@@ -7605,7 +7965,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">code</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3407--><p class="noindent" >
+</p><!--l. 3490--><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
@@ -7616,11 +7976,11 @@
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
id="dx1-22021"></a></a> should be used.
-</p><!--l. 3413--><p class="indent" > If <a
+</p><!--l. 3496--><p class="indent" > If <a
href="#option1">Option 1</a> has been used, the <span
class="cmtt-10">aux</span><a
id="dx1-22022"></a> file will contain
-</p><!--l. 3414--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3497--><p class="indent" > <hr><div title="Definition"><a
id="dx1-22023"></a> <span
class="cmtt-10">\@gls at reference{</span>⟨<span
class="cmitt-10">type</span>⟩<span
@@ -7629,39 +7989,44 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">location</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3416--><p class="noindent" >
+</p><!--l. 3499--><p class="noindent" >
for every time an entry has been referenced.
-</p><!--l. 3419--><p class="noindent" >
+</p><!--l. 3502--><p class="noindent" >
</p>
-<!--l. 3419--><p class="noindent" ><a
+<!--l. 3502--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.2 </span> <a
id="sec:notedev.labels"></a>Entry Labels</h4>
-<!--l. 3422--><p class="noindent" >If you need to gather labels for auto-completion, the <span
+<!--l. 3505--><p class="noindent" >If you need to gather labels for auto-completion, the <span
class="cmss-10">writeglslabels</span><a
id="dx1-23001"></a> package option will create a file containing the
-labels of all defined entries (regardless of whether or not the entry has been used in the document). The
-<a
+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-23002"></a> that writes both the label and name (separated by a
+tab).
+</p><!--l. 3512--><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="textcolor181"><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-23002"></a>, which will create the <span
+ id="dx1-23003"></a>, which will create the <span
class="cmtt-10">glsdefs</span><a
- id="dx1-23003"></a> file but will act like
-<span id="textcolor182"><span
+ id="dx1-23004"></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-23004"></a>.
-</p><!--l. 3429--><p class="noindent" >
+ id="dx1-23005"></a>. </div>
+</p><!--l. 3516--><p class="noindent" >
+</p><!--l. 3518--><p class="noindent" >
</p>
-<!--l. 3429--><p class="noindent" ><a
+<!--l. 3518--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.3 </span> <a
id="sec:notedev.bib2gls"></a>Bib2Gls</h4>
-<!--l. 3432--><p class="noindent" ><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a
+<!--l. 3521--><p class="noindent" ><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-24001"></a></a></span>If <a
@@ -7669,7 +8034,7 @@
class="cmtt-10">aux</span><a
id="dx1-24002"></a> file will contain one or more instances of </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor183"><span
+<span id="textcolor184"><span
class="cmtt-10">\glsxtr at resource</span></span><a
id="dx1-24003"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7695,7 +8060,7 @@
class="cmtt-10">bib</span><a
id="dx1-24006"></a>
file.
-<!--l. 3442--><p class="indent" > For example, with <span
+<!--l. 3531--><p class="indent" > For example, with <span
class="cmtt-10">arara</span><a
id="dx1-24007"></a> you can easily determine whether or not to run <a
href="#glo:bib2gls"><span
@@ -7710,16 +8075,16 @@
class="cmtt-10"> found("aux",</span><span
class="cmtt-10"> "glsxtr at resource")</span>
</div>
-</div> (It gets more complicated if both <span id="textcolor184"><span
+</div> (It gets more complicated if both <span id="textcolor185"><span
class="cmtt-10">\glsxtr at resource</span></span><a
id="dx1-24009"></a> and <span
class="cmtt-10">\@istfilename </span>are present as that indicates the
-hybrid <span id="textcolor185"><span
+hybrid <span id="textcolor186"><span
class="cmss-10">record</span><span
class="cmtt-10">=</span><span
-class="cmss-10">alsoindex</span></span><a
+class="cmss-10">hybrid</span></span><a
id="dx1-24010"></a> option.)
-<!--l. 3451--><p class="indent" > Remember that with <a
+<!--l. 3540--><p class="indent" > Remember that with <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
id="dx1-24011"></a></a>, the entries will never be defined on the first LaTeX call (because their
@@ -7733,7 +8098,7 @@
class="cmtt-10">aux</span><a
id="dx1-24014"></a> file, which will be in the form: </p><div class="alltt">
<div class="obeylines-v">
-<span id="textcolor186"><span
+<span id="textcolor187"><span
class="cmtt-10">\glsxtr at record</span></span><a
id="dx1-24015"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7748,13 +8113,15 @@
class="cmitt-10">loc</span>⟩<span
class="cmtt-10">}</span>
</div>
-</div> or (with <span id="textcolor187"><span
+</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-24016"></a>) <div class="alltt">
+
+
<div class="obeylines-v">
-<span id="textcolor188"><span
+<span id="textcolor189"><span
class="cmtt-10">\glsxtr at record@nameref</span></span><a
id="dx1-24017"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7782,10 +8149,8 @@
</div>
</div> or (with <span
class="cmtt-10">\glssee</span>) <div class="alltt">
-
-
<div class="obeylines-v">
-<span id="textcolor189"><span
+<span id="textcolor190"><span
class="cmtt-10">\glsxtr at recordsee</span></span><a
id="dx1-24018"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7795,7 +8160,7 @@
class="cmitt-10"> list</span>⟩<span
class="cmtt-10">}</span>
</div>
-</div> You can also pick up the commands defined with <span id="textcolor190"><span
+</div> You can also pick up the commands defined with <span id="textcolor191"><span
class="cmtt-10">\glsxtrnewglslike</span></span><a
id="dx1-24019"></a>, which are added to the <span
class="cmtt-10">aux</span><a
@@ -7805,7 +8170,7 @@
class="cmtt-10">bib2gls</span><a
id="dx1-24021"></a>’s</a> benefit: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor191"><span
+<span id="textcolor192"><span
class="cmtt-10">\@glsxtr at newglslike</span></span><a
id="dx1-24022"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7814,11 +8179,11 @@
class="cmitt-10">cs</span>⟩<span
class="cmtt-10">}</span>
</div>
-</div> If <span id="textcolor192"><span
+</div> If <span id="textcolor193"><span
class="cmtt-10">\GlsXtrSetAltModifier</span></span><a
id="dx1-24023"></a> is used, then the modifier is identified with: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor193"><span
+<span id="textcolor194"><span
class="cmtt-10">\@glsxtr at altmodifier</span></span><a
id="dx1-24024"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7825,11 +8190,11 @@
class="cmitt-10">character</span>⟩<span
class="cmtt-10">}</span>
</div>
-</div> Label prefixes (for the <span id="textcolor194"><span
+</div> Label prefixes (for the <span id="textcolor195"><span
class="cmtt-10">\dgls</span></span><a
id="dx1-24025"></a> set of commands) are identified with: <div class="alltt">
<div class="obeylines-v">
-<span id="textcolor195"><span
+<span id="textcolor196"><span
class="cmtt-10">\@glsxtr at prefixlabellist</span></span><a
id="dx1-24026"></a><span
class="cmtt-10">{</span>⟨<span
@@ -7839,11 +8204,11 @@
</div>
-<!--l. 3484--><p class="indent" > </div>
-</p><!--l. 3484--><p class="noindent" ><a
+<!--l. 3573--><p class="indent" > </div>
+</p><!--l. 3573--><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. 3487--><p class="indent" > This section describes the available <span
+</p><!--l. 3576--><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
@@ -7853,7 +8218,7 @@
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
id="dx1-25002"></a>).
-</p><!--l. 3491--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 3580--><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
@@ -7862,8 +8227,8 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> may have additional package options or new values
for existing settings that aren’t listed here. </div>
-</p><!--l. 3498--><p class="noindent" >
-</p><!--l. 3500--><p class="indent" > <div class="important" title="Important Note"> Note that ⟨<span
+</p><!--l. 3587--><p class="noindent" >
+</p><!--l. 3589--><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
@@ -7877,18 +8242,18 @@
class="cmss-10">makeindex</span><a
id="dx1-25004"></a>) may be passed via the document class
options. </div>
-</p><!--l. 3507--><p class="noindent" >
+</p><!--l. 3596--><p class="noindent" >
</p>
-<!--l. 3509--><p class="noindent" ><a
+<!--l. 3598--><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. 3512--><p class="noindent" >
+<!--l. 3601--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-270002.1"></a><a
id="pkgopt:nowarn"></a><span
class="cmss-10">nowarn</span></h4>
-<!--l. 3512--><p class="noindent" >This suppresses all warnings generated by the <span
+<!--l. 3601--><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
@@ -7899,20 +8264,20 @@
id="dx1-27002"></a> with any value other than <span
class="cmss-10">false </span>it will override this
option.
-</p><!--l. 3519--><p class="noindent" >
+</p><!--l. 3608--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-280002.1"></a><a
id="pkgopt:nolangwarn"></a><span
class="cmss-10">nolangwarn</span></h4>
-<!--l. 3519--><p class="noindent" >This suppresses the warning generated by a missing language module.
-</p><!--l. 3522--><p class="noindent" >
+<!--l. 3608--><p class="noindent" >This suppresses the warning generated by a missing language module.
+</p><!--l. 3611--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-290002.1"></a><a
id="pkgopt:noredefwarn"></a><span
class="cmss-10">noredefwarn</span></h4>
-<!--l. 3522--><p class="noindent" >If you load <span
+<!--l. 3611--><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
@@ -7926,7 +8291,7 @@
class="cmss-10">glossaries-extra</span></a>.)
-</p><!--l. 3532--><p class="noindent" >
+</p><!--l. 3621--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-300002.1"></a><a
@@ -7935,7 +8300,7 @@
class="cmtt-10">{</span>⟨<span
class="cmssi-10">value</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 3532--><p class="noindent" >Introduced in version 4.24. The default setting is <span
+<!--l. 3621--><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
@@ -7949,19 +8314,19 @@
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
id="dx1-30002"></a> is assumed.
-</p><!--l. 3538--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 3627--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> package provides extra values <span id="textcolor196"><span
+class="cmss-10">glossaries-extra</span></a> package provides extra values <span id="textcolor197"><span
class="cmss-10">showwrgloss</span></span><a
id="dx1-30003"></a>, that may be used to show where the indexing
-is occurring, and <span id="textcolor197"><span
+is occurring, and <span id="textcolor198"><span
class="cmss-10">all</span></span><a
id="dx1-30004"></a>, which switches on all debugging options. See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further details.
</div>
-</p><!--l. 3544--><p class="noindent" >
-</p><!--l. 3546--><p class="indent" > All values other than <span
+</p><!--l. 3633--><p class="noindent" >
+</p><!--l. 3635--><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
@@ -7973,12 +8338,12 @@
class="cmtt-10">=</span><span
class="cmss-10">showtargets</span><a
id="dx1-30007"></a> option will additionally use:
-</p><!--l. 3549--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3638--><p class="indent" > <hr><div title="Definition"><a
id="dx1-30008"></a> <span
class="cmtt-10">\glsshowtarget{</span>⟨<span
class="cmitt-10">target name</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3551--><p class="noindent" >
+</p><!--l. 3640--><p class="noindent" >
to show the hypertarget or hyperlink name when <span
class="cmtt-10">\glsdohypertarget </span>is used by commands like
<span
@@ -7987,17 +8352,17 @@
class="cmtt-10">\gls</span>. In math mode or inner
mode, this puts the target name in square brackets just before the link or anchor. In outer mode it
uses:
-</p><!--l. 3557--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3646--><p class="indent" > <hr><div title="Definition"><a
id="dx1-30009"></a> <span
class="cmtt-10">\glsshowtargetouter{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3559--><p class="noindent" >
+</p><!--l. 3648--><p class="noindent" >
which by default places the target name in the margin. The font is given by:
-</p><!--l. 3562--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3651--><p class="indent" > <hr><div title="Definition"><a
id="dx1-30010"></a> <span
class="cmtt-10">\glsshowtargetfont </span></div><hr>
-</p><!--l. 3564--><p class="noindent" >
+</p><!--l. 3653--><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
@@ -8006,17 +8371,17 @@
</p>
- <div class="verbatim" id="verbatim-63">
+ <pre class="verbatim" id="verbatim-67">
\renewcommand*{\glsshowtargetouter}[1]{%
- <br /> {\glsshowtargetfont [#1]}}
-</div>
-<!--l. 3572--><p class="nopar" >
-</p><!--l. 3574--><p class="indent" > Similarly, the <span
+ {\glsshowtargetfont [#1]}}
+</pre>
+<!--l. 3661--><p class="nopar" >
+</p><!--l. 3663--><p class="indent" > Similarly, the <span
class="cmss-10">debug</span><span
class="cmtt-10">=</span><span
class="cmss-10">showaccsupp</span><a
id="dx1-30011"></a> will add the accessibility support information using:
-</p><!--l. 3576--><p class="indent" > <hr><div title="Definition"><a
+</p><!--l. 3665--><p class="indent" > <hr><div title="Definition"><a
id="dx1-30012"></a> <span
class="cmtt-10">\glsshowaccsupp{</span>⟨<span
class="cmitt-10">options</span>⟩<span
@@ -8025,13 +8390,13 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">replacement text</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3578--><p class="noindent" >
+</p><!--l. 3667--><p class="noindent" >
This internally uses <span
class="cmtt-10">\glsshowtarget</span><a
id="dx1-30013"></a>. This option is provided for use with <span
class="cmss-10">glossaries-accsupp</span><a
id="dx1-30014"></a>.
-</p><!--l. 3582--><p class="indent" > The purpose of the debug mode can be demonstrated with the following example document:
+</p><!--l. 3671--><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
@@ -8072,13 +8437,13 @@
id="dx1-30017"></a>. Since the file isn’t open yet, the information can’t be written to it, which is why the <span
class="cmtt-10">sample2</span>
entry doesn’t appear in the glossary.
-<!--l. 3603--><p class="indent" > Without <span
+<!--l. 3692--><p class="indent" > Without <span
class="cmtt-10">\makeglossaries </span>the indexing is suppressed with Options <a
href="#option2">2</a> and <a
href="#option3">3</a> but, other than that,
commands like <span
class="cmtt-10">\gls </span>behave as usual.
-</p><!--l. 3606--><p class="indent" > This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use
+</p><!--l. 3695--><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
@@ -8091,7 +8456,7 @@
href="#option4">4</a> for indexing, which don’t use
<span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 3616--><p class="indent" > Therefore <span
+</p><!--l. 3705--><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
@@ -8100,23 +8465,23 @@
class="cmtt-10">see</span><a
id="dx1-30018"></a> key as that’s a more
common problem. See below.)
-</p><!--l. 3621--><p class="indent" > The debug mode, enabled with the <span
+</p><!--l. 3710--><p class="indent" > The debug mode, enabled with the <span
class="cmss-10">debug</span><a
id="dx1-30019"></a> option,
</p>
- <div class="verbatim" id="verbatim-64">
+ <pre class="verbatim" id="verbatim-68">
\usepackage[debug]{glossaries}
-</div>
-<!--l. 3624--><p class="nopar" > will write information to the log file when the indexing can’t occur because the associated file isn’t open. The
+</pre>
+<!--l. 3713--><p class="nopar" > will write information to the log file when the indexing can’t occur because the associated file isn’t open. The
message is written in the form
- </p><div class="quote">
- <!--l. 3629--><p class="noindent" >Package glossaries Info: wrglossary(⟨<span
+ </p><blockquote class="quote">
+ <!--l. 3718--><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></div>
-<!--l. 3632--><p class="noindent" >where ⟨<span
+class="cmti-10">line number</span>⟩.</p></blockquote>
+<!--l. 3721--><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
@@ -8126,7 +8491,7 @@
class="cmss-10">debug</span><a
id="dx1-30020"></a> option and see if any information has been written to the log
file.
-</p><!--l. 3639--><p class="noindent" >
+</p><!--l. 3728--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-310002.1"></a><a
@@ -8135,7 +8500,7 @@
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 3639--><p class="noindent" >This is a boolean option to minimise the number of write registers used by the <span
+<!--l. 3728--><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
@@ -8145,7 +8510,7 @@
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. 3645--><p class="indent" > With all options except Options <a
+</p><!--l. 3734--><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
@@ -8156,7 +8521,7 @@
aren’t permitted and indexing information is written to the <span
class="cmtt-10">aux</span><a
id="dx1-31003"></a> file). If you really need document definitions
-but you want to minimise the number of write registers then consider using <span id="textcolor198"><span
+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
@@ -8164,7 +8529,7 @@
<a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>.
-</p><!--l. 3654--><p class="indent" > There are only a limited number of write registers, and if you have a large number of glossaries
+</p><!--l. 3743--><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
@@ -8171,7 +8536,7 @@
id="dx1-31005"></a> is set, the glossary information will be
stored in token registers until the end of the document when they will be written to the external
files.
-</p><!--l. 3662--><p class="indent" > <div class="important" title="Important Note"> This option can significantly slow document compilation and may cause the indexing to fail. Page numbers
+</p><!--l. 3751--><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-31006"></a></a> will be incorrect on page boundaries due to TeX’s asynchronous output routine. As an
@@ -8179,8 +8544,8 @@
class="cmss-10">scrwfile</span><a
id="dx1-31007"></a> package (part of the KOMA-Script bundle) and not use this option.
</div>
-</p><!--l. 3668--><p class="noindent" >
-</p><!--l. 3670--><p class="indent" > By way of comparison, <span
+</p><!--l. 3757--><p class="noindent" >
+</p><!--l. 3759--><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
@@ -8198,7 +8563,7 @@
(9 resource files and 1 transcript file).
-</p><!--l. 3680--><p class="indent" > <span class="warningsymbol">⚠</span> If you want to use TeX’s <span
+</p><!--l. 3769--><p class="indent" > <span class="warningsymbol">⚠</span> If you want to use TeX’s <span
class="cmtt-10">\write18</span><a
id="dx1-31012"></a> mechanism to call <a
href="#glo:makeindex"><span
@@ -8222,15 +8587,15 @@
</p>
- <div class="verbatim" id="verbatim-65">
+ <pre class="verbatim" id="verbatim-69">
\glswritefiles
- <br />\write18{makeindex -s \istfilename\space
- <br />-t \jobname.glg -o \jobname.gls \jobname}
- <br />\let\glswritefiles\relax
-</div>
-<!--l. 3692--><p class="nopar" >
-</p><!--l. 3694--><p class="noindent" >In general, this package option is best avoided.
-</p><!--l. 3697--><p class="noindent" >
+\write18{makeindex -s \istfilename\space
+-t \jobname.glg -o \jobname.gls \jobname}
+\let\glswritefiles\relax
+</pre>
+<!--l. 3781--><p class="nopar" >
+</p><!--l. 3783--><p class="noindent" >In general, this package option is best avoided.
+</p><!--l. 3786--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-320002.1"></a><a
@@ -8239,12 +8604,14 @@
class="cmtt-10">{</span>⟨<span
class="cmssi-10">value</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 3697--><p class="noindent" >This can take the following values:
+<!--l. 3786--><p class="noindent" >This can take the following values:
</p><dl class="description"><dt class="description">
+ <!--l. 3789--><p class="noindent" >
<span
class="cmssbx-10">true</span><a
- id="dx1-32001"></a> </dt><dd
-class="description">If <span
+ id="dx1-32001"></a> </p></dt><dd
+class="description">
+ <!--l. 3789--><p class="noindent" >If <span
class="cmss-10">babel</span><a
id="dx1-32002"></a> has been loaded and the <span
class="cmss-10">translator</span><a
@@ -8271,11 +8638,13 @@
class="cmss-10">glossaries-polyglossia</span><a
id="dx1-32010"></a> will be
loaded.
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 3801--><p class="noindent" >
<span
class="cmssbx-10">false</span><a
- id="dx1-32011"></a> </dt><dd
-class="description">Don’t provide translations, even if <span
+ id="dx1-32011"></a> </p></dt><dd
+class="description">
+ <!--l. 3801--><p class="noindent" >Don’t provide translations, even if <span
class="cmss-10">babel</span><a
id="dx1-32012"></a> or <span
class="cmss-10">polyglossia</span><a
@@ -8287,16 +8656,18 @@
id="dx1-32015"></a> so that will still be translated if you have loaded <span
class="cmss-10">babel</span><a
id="dx1-32016"></a>.)
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 3806--><p class="noindent" >
<span
class="cmssbx-10">babel</span><a
- id="dx1-32017"></a> </dt><dd
-class="description">Don’t load the <span
+ id="dx1-32017"></a> </p></dt><dd
+class="description">
+ <!--l. 3806--><p class="noindent" >Don’t load the <span
class="cmss-10">translator</span><a
id="dx1-32018"></a> package. Instead load <span
class="cmss-10">glossaries-babel</span><a
id="dx1-32019"></a>.
- <!--l. 3720--><p class="noindent" ><div class="important" title="Important Note"> I recommend you use <span
+ </p><!--l. 3809--><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
@@ -8309,10 +8680,12 @@
class="cmss-10">true</span><a
id="dx1-32022"></a>.
</div>
- </p><!--l. 3725--><p class="noindent" >
+ </p><!--l. 3814--><p class="noindent" >
+
+
</p>
</dd></dl>
-<!--l. 3729--><p class="indent" > If <span
+<!--l. 3818--><p class="indent" > If <span
class="cmss-10">translate</span><a
id="dx1-32023"></a> is specified without a value, <span
class="cmss-10">translate</span><span
@@ -8337,7 +8710,7 @@
class="cmss-10">false</span><a
id="dx1-32030"></a> is
assumed.
-</p><!--l. 3735--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> With <a
+</p><!--l. 3824--><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
@@ -8349,24 +8722,23 @@
class="cmss-10">glossaries</span><a
id="dx1-32033"></a>
package. </div>
-
-
-</p><!--l. 3739--><p class="noindent" >
-</p><!--l. 3741--><p class="indent" > See <a
-href="#sec:fixednames">§1.3.1 </a><a
+</p><!--l. 3828--><p class="noindent" >
+</p><!--l. 3830--><p class="indent" > See <a
+href="#sec:fixednames">§<span
+class="cmbx-10">??</span>sec:fixednames </a><a
href="#sec:fixednames">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details.
-</p><!--l. 3743--><p class="noindent" >
+</p><!--l. 3832--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-330002.1"></a><a
id="pkgopt:notranslate"></a><span
class="cmss-10">notranslate</span></h4>
-<!--l. 3743--><p class="noindent" >This is equivalent to <span
+<!--l. 3832--><p class="noindent" >This is equivalent to <span
class="cmss-10">translate</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
id="dx1-33001"></a> and may be passed via the document class options.
-</p><!--l. 3747--><p class="noindent" >
+</p><!--l. 3836--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-340002.1"></a><a
@@ -8375,7 +8747,7 @@
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 3747--><p class="noindent" >This is a boolean option that specifies whether each term has a hyperlink on <a
+<!--l. 3836--><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
@@ -8410,7 +8782,7 @@
id="dx1-34008"></a> or <span
class="cmtt-10">\glstext</span><a
id="dx1-34009"></a>).
-</p><!--l. 3759--><p class="indent" > The <span
+</p><!--l. 3848--><p class="indent" > The <span
class="cmss-10">hyperfirst</span><a
id="dx1-34010"></a> setting applies to all glossary types (unless identified by <span
class="cmss-10">nohypertypes</span><a
@@ -8422,7 +8794,7 @@
class="cmtt-10">hyper</span><a
id="dx1-34013"></a> key when referencing an entry (or by using the plus or starred version of the referencing
command).
-</p><!--l. 3766--><p class="indent" > It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of
+</p><!--l. 3855--><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
@@ -8434,18 +8806,18 @@
</p>
- <div class="verbatim" id="verbatim-66">
+ <pre class="verbatim" id="verbatim-70">
 \usepackage[acronym,hyperfirst=false]{glossaries}
- <br /> % acronym and glossary entry definitions
- <br /> % at the end of the preamble
- <br /> \glsunsetall[main]
-</div>
-<!--l. 3778--><p class="nopar" >
-</p><!--l. 3780--><p class="indent" > Alternatively you can redefine the hook
-</p><!--l. 3781--><p class="indent" > <hr><div title="Definition"><a
+ % acronym and glossary entry definitions
+ % at the end of the preamble
+ \glsunsetall[main]
+</pre>
+<!--l. 3867--><p class="nopar" >
+</p><!--l. 3869--><p class="indent" > Alternatively you can redefine the hook
+</p><!--l. 3870--><p class="indent" > <hr><div title="Definition"><a
id="dx1-34015"></a> <span
class="cmtt-10">\glslinkcheckfirsthyperhook </span></div><hr>
-</p><!--l. 3783--><p class="noindent" >
+</p><!--l. 3872--><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
@@ -8467,16 +8839,16 @@
</p>
- <div class="verbatim" id="verbatim-67">
+ <pre class="verbatim" id="verbatim-71">
\renewcommand*{\glslinkcheckfirsthyperhook}{%
- <br /> \ifglsused{\glslabel}{}%
- <br /> {%
- <br />   \ifglshaslong{\glslabel}{\setkeys{glslink}{hyper=false}}{}%
- <br /> }%
- <br />}
-</div>
-<!--l. 3799--><p class="nopar" >
-</p><!--l. 3801--><p class="indent" > Note that this hook isn’t used by the commands that don’t check the <a
+ \ifglsused{\glslabel}{}%
+ {%
+   \ifglshaslong{\glslabel}{\setkeys{glslink}{hyper=false}}{}%
+ }%
+}
+</pre>
+<!--l. 3888--><p class="nopar" >
+</p><!--l. 3890--><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
@@ -8488,13 +8860,13 @@
<a
href="#sec:glstext-like"><span
class="cmtt-10">\glstext</span>-like</a> commands.)
-</p><!--l. 3806--><p class="indent" > The <a
+</p><!--l. 3895--><p class="indent" > The <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> package provides a method of disabling the <a
href="#glo:firstuse">first use</a> hyperlink according to the entry’s
associated category. For example, if you only to switch off the <a
href="#glo:firstuse">first use</a> hyperlink for abbreviations and
-acronyms then you simply need to set the <span id="textcolor199"><span
+acronyms then you simply need to set the <span id="textcolor200"><span
class="cmss-10">nohyperfirst</span></span><a
id="dx1-34024"></a> attribute for the <span
class="cmtt-10">abbreviation </span>and <span
@@ -8505,202 +8877,223 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further
details.
-</p><!--l. 3815--><p class="noindent" >
+</p><!--l. 3904--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
id="x1-350002.1"></a><a
id="pkgopt:writeglslabels"></a><span
class="cmss-10">writeglslabels</span></h4>
-<!--l. 3815--><p class="noindent" >This is a valueless option that will create a file called <span
+<!--l. 3904--><p class="noindent" >This is a valueless option that will create a file called <span
class="cmtt-10">\jobname.glslabels</span><a
id="dx1-35001"></a> at the end of the document. This file
simply contains a list of all defined entry labels (including those in any ignored glossaries). It’s provided for the
benefit of text editors that need to know labels for auto-completion<a
- id="dx1-35002"></a>. (See also <a
+ id="dx1-35002"></a>. If you also want the name, use
+<span
+class="cmss-10">writeglslabelnames</span><a
+ id="dx1-35003"></a>. (See also <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span>’s</a> <span id="textcolor200"><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-35003"></a>
-package option.)
-</p><!--l. 3823--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> Note that with <a
+ id="dx1-35004"></a> package option.)
+</p><!--l. 3913--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> Note that with <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-35004"></a></a> the file will only contain the entries that <a
+ id="dx1-35005"></a></a> the file will only contain the entries that <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-35005"></a></a> has selected from the <span
+ id="dx1-35006"></a></a> has selected from the <span
class="cmtt-10">bib</span><a
- id="dx1-35006"></a> files.
+ id="dx1-35007"></a> files.
</div>
-</p><!--l. 3826--><p class="noindent" >
-</p><!--l. 3828--><p class="noindent" >
+</p><!--l. 3916--><p class="noindent" >
+</p><!--l. 3918--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-360002.1"></a><span id="textcolor201"><a
- id="pkgopt:undefaction"></a><span id="textcolor202"><span
+ id="x1-360002.1"></a><a
+ id="pkgopt:writeglslabelnames"></a><span
+class="cmss-10">writeglslabelnames</span></h4>
+<!--l. 3918--><p class="noindent" >Similar to the above but writes both the label and name (separated by a tab).
+</p><!--l. 3921--><p class="noindent" >
+</p>
+ <h4 class="likesubsectionHead"><a
+ id="x1-370002.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. 3830--><p class="noindent" >The value may be one of:
+<!--l. 3923--><p class="noindent" >The value may be one of:
+
+
</p><dl class="description"><dt class="description">
+ <!--l. 3925--><p class="noindent" >
<span
-class="cmssbx-10">error</span> </dt><dd
-class="description">generate an error if a referenced entry is undefined (default, and only available setting with just
- <span
+class="cmssbx-10">error</span> </p></dt><dd
+class="description">
+ <!--l. 3925--><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>);
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 3928--><p class="noindent" >
<span
-class="cmssbx-10">warn</span> </dt><dd
-class="description">only warn if a referenced entry is undefined (automatically activated with <a
-href="#option4">Option 4</a>).</dd></dl>
-
-
-<!--l. 3839--><p class="noindent" >
+class="cmssbx-10">warn</span> </p></dt><dd
+class="description">
+ <!--l. 3928--><p class="noindent" >only warn if a referenced entry is undefined (automatically activated with <a
+href="#option4">Option 4</a>).</p></dd></dl>
+<!--l. 3932--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-370002.1"></a><span id="textcolor203"><a
- id="pkgopt:docdef"></a><span id="textcolor204"><span
+ id="x1-380002.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. 3841--><p class="noindent" >This option governs the use of <span
+<!--l. 3934--><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. 3937--><p class="noindent" >
<span
-class="cmssbx-10">false</span> </dt><dd
-class="description"><span
+class="cmssbx-10">false</span> </p></dt><dd
+class="description">
+ <!--l. 3937--><p class="noindent" ><span
class="cmtt-10">\newglossaryentry </span>is not permitted in the <span
class="cmss-10">document</span><a
- id="dx1-37001"></a><a
- id="dx1-37002"></a> environment (default with <a
+ id="dx1-38001"></a><a
+ id="dx1-38002"></a> environment (default with <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>
and for <a
href="#option1">Option 1</a> with just the base <span
class="cmss-10">glossaries </span>package);
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 3941--><p class="noindent" >
<span
-class="cmssbx-10">restricted</span> </dt><dd
-class="description"><span
+class="cmssbx-10">restricted</span> </p></dt><dd
+class="description">
+ <!--l. 3941--><p class="noindent" ><span
class="cmtt-10">\newglossaryentry </span>is only permitted in the <span
class="cmss-10">document</span><a
- id="dx1-37003"></a><a
- id="dx1-37004"></a> environment if it occurs before
+ id="dx1-38003"></a><a
+ id="dx1-38004"></a> environment if it occurs before
<span
class="cmtt-10">\printglossary </span>(not available for some indexing options);
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 3945--><p class="noindent" >
<span
-class="cmssbx-10">atom</span> </dt><dd
-class="description">as <span
+class="cmssbx-10">atom</span> </p></dt><dd
+class="description">
+ <!--l. 3945--><p class="noindent" >as <span
class="cmss-10">restricted </span>but creates the <span
class="cmtt-10">docdefs</span><a
- id="dx1-37005"></a> file for use by <span
+ id="dx1-38005"></a> file for use by <span
class="cmtt-10">atom</span><a
- id="dx1-37006"></a> (without the limitations of <span id="textcolor205"><span
+ id="dx1-38006"></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-37007"></a>);
- </dd><dt class="description">
+ id="dx1-38007"></a>);
+ </p></dd><dt class="description">
+ <!--l. 3949--><p class="noindent" >
<span
-class="cmssbx-10">true</span> </dt><dd
-class="description"><span
+class="cmssbx-10">true</span> </p></dt><dd
+class="description">
+ <!--l. 3949--><p class="noindent" ><span
class="cmtt-10">\newglossaryentry </span>is permitted in the <span
class="cmss-10">document</span><a
- id="dx1-37008"></a><a
- id="dx1-37009"></a> environment where it would normally be
+ id="dx1-38008"></a><a
+ id="dx1-38009"></a> environment where it would normally be
permitted by the base <span
class="cmss-10">glossaries </span>package. This will create the <span
class="cmtt-10">docdefs</span><a
- id="dx1-37010"></a> file if <span
+ id="dx1-38010"></a> file if <span
class="cmtt-10">\newglossaryentry</span>
is found in the <span
class="cmss-10">document</span><a
- id="dx1-37011"></a><a
- id="dx1-37012"></a> environment.</dd></dl>
-<!--l. 3863--><p class="noindent" >
+ id="dx1-38011"></a><a
+ id="dx1-38012"></a> environment.</p></dd></dl>
+
+
+<!--l. 3956--><p class="noindent" >
</p>
-<!--l. 3863--><p class="noindent" ><a
+<!--l. 3956--><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. 3866--><p class="noindent" >
+<!--l. 3959--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-390002.2"></a><a
+ id="x1-400002.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. 3866--><p class="noindent" >Add the glossaries to the table of contents. Note that an extra LaTeX run is required with this option.
+<!--l. 3959--><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. 3869--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-39001"></a> <span
+</p><!--l. 3962--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-40001"></a> <span
class="cmtt-10">\glstoctrue </span></div><hr>
-</p><!--l. 3871--><p class="noindent" >
+</p><!--l. 3964--><p class="noindent" >
and
-</p><!--l. 3873--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-39002"></a> <span
+</p><!--l. 3966--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-40002"></a> <span
class="cmtt-10">\glstocfalse </span></div><hr>
-</p><!--l. 3875--><p class="noindent" >
+</p><!--l. 3968--><p class="noindent" >
The default value is <span
class="cmss-10">toc</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-39003"></a> for the base <span
+ id="dx1-40003"></a> for the base <span
class="cmss-10">glossaries </span>package and <span
class="cmss-10">toc</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-39004"></a> for <a
+ id="dx1-40004"></a> for <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>.
-</p><!--l. 3880--><p class="noindent" >
+</p><!--l. 3973--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-400002.2"></a><a
+ id="x1-410002.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. 3880--><p class="noindent" >When used with the above <span
+<!--l. 3973--><p class="noindent" >When used with the above <span
class="cmss-10">toc</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-40001"></a> option, this will add <span
+ id="dx1-41001"></a> option, this will add <span
class="cmtt-10">\numberline</span><a
- id="dx1-40002"></a><span class="obeylines-h"><span class="verb"><span
+ id="dx1-41002"></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-40003"></a>. This will align the table of contents entry with the numbered section titles. Note that this
+ id="dx1-41003"></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-40004"></a> option is omitted. If <span
+ id="dx1-41004"></a> option is omitted. If <span
class="cmss-10">toc</span><a
- id="dx1-40005"></a> is used without <span
+ id="dx1-41005"></a> is used without <span
class="cmss-10">numberline</span><a
- id="dx1-40006"></a>, the title will be aligned with
+ id="dx1-41006"></a>, the title will be aligned with
the section numbers rather than the section titles.
-</p><!--l. 3889--><p class="noindent" >
+</p><!--l. 3982--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-410002.2"></a><a
+ id="x1-420002.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. 3891--><p class="noindent" >This option indicates the sectional unit to use for the glossary. The value should be the control
+<!--l. 3984--><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
@@ -8707,187 +9100,190 @@
class="cmtt-10">\chapter </span>or
<span
class="cmtt-10">chapter*</span>).
-</p><!--l. 3896--><p class="indent" > The default behaviour is for the glossary heading to use <span
+</p><!--l. 3989--><p class="indent" > The default behaviour is for the glossary heading to use <span
class="cmtt-10">\chapter</span>, if that command exists, or <span
class="cmtt-10">\section</span>
otherwise. The starred or unstarred form is determined by the <span
class="cmss-10">numberedsection</span><a
- id="dx1-41001"></a> option.
-</p><!--l. 3900--><p class="indent" > Example:
+ id="dx1-42001"></a> option.
+</p><!--l. 3993--><p class="indent" > Example:
</p>
- <div class="verbatim" id="verbatim-68">
+ <pre class="verbatim" id="verbatim-72">
\usepackage[section=subsection]{glossaries}
-</div>
-<!--l. 3903--><p class="nopar" > You can omit the value if you want to use <span
+</pre>
+<!--l. 3996--><p class="nopar" > You can omit the value if you want to use <span
class="cmtt-10">\section</span>, i.e. 
</p>
- <div class="verbatim" id="verbatim-69">
+ <pre class="verbatim" id="verbatim-73">
\usepackage[section]{glossaries}
-</div>
-<!--l. 3907--><p class="nopar" > is equivalent to
+</pre>
+<!--l. 4000--><p class="nopar" > is equivalent to
</p>
- <div class="verbatim" id="verbatim-70">
+ <pre class="verbatim" id="verbatim-74">
\usepackage[section=section]{glossaries}
-</div>
-<!--l. 3911--><p class="nopar" > You can change this value later in the document using
-</p><!--l. 3913--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-41002"></a> <span
+</pre>
+<!--l. 4004--><p class="nopar" > You can change this value later in the document using
+</p><!--l. 4006--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-42002"></a> <span
class="cmtt-10">\setglossarysection{</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3915--><p class="noindent" >
+</p><!--l. 4008--><p class="noindent" >
where ⟨<span
class="cmti-10">name</span>⟩ is the sectional unit.
-</p><!--l. 3918--><p class="indent" > The start of each glossary adds information to the page header via
-</p><!--l. 3919--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-41003"></a> <span
+</p><!--l. 4011--><p class="indent" > The start of each glossary adds information to the page header via
+</p><!--l. 4012--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-42003"></a> <span
class="cmtt-10">\glsglossarymark{</span>⟨<span
class="cmitt-10">glossary title</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3921--><p class="noindent" >
+</p><!--l. 4014--><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-41004f2"></a>
+ id="x1-42004f2"></a>
but you may need to redefine it. For example, to only change the right header:
</p>
- <div class="verbatim" id="verbatim-71">
+ <pre class="verbatim" id="verbatim-75">
\renewcommand{\glsglossarymark}[1]{\markright{#1}}
-</div>
-<!--l. 3928--><p class="nopar" > or to prevent it from changing the headers:
+</pre>
+<!--l. 4021--><p class="nopar" > or to prevent it from changing the headers:
</p>
- <div class="verbatim" id="verbatim-72">
+ <pre class="verbatim" id="verbatim-76">
\renewcommand{\glsglossarymark}[1]{}
-</div>
-<!--l. 3932--><p class="nopar" > If you want <span
+</pre>
+<!--l. 4025--><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-41007"></a> option described
+ id="dx1-42007"></a> option described
below.
-</p><!--l. 3936--><p class="indent" > Occasionally you may find that another package defines <span
+</p><!--l. 4029--><p class="indent" > Occasionally you may find that another package defines <span
class="cmtt-10">\cleardoublepage </span>when it is not required. This
may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining
<a
- id="dx1-41008"></a><span
+ id="dx1-42008"></a><span
class="cmtt-10">\glsclearpage</span>:
</p>
- <div class="verbatim" id="verbatim-73">
+ <pre class="verbatim" id="verbatim-77">
\renewcommand*{\glsclearpage}{\clearpage}
-</div>
-<!--l. 3942--><p class="nopar" >
-</p><!--l. 3944--><p class="noindent" >
+</pre>
+<!--l. 4035--><p class="nopar" >
+</p><!--l. 4037--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-420002.2"></a><a
+ id="x1-430002.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. 3944--><p class="noindent" >This is a boolean option. The default is <span
+<!--l. 4037--><p class="noindent" >This is a boolean option. The default is <span
class="cmss-10">ucmark</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-42001"></a>, unless <span
+ id="dx1-43001"></a>, unless <span
class="cmss-10">memoir</span><a
- id="dx1-42002"></a> has been loaded, in which case the default
+ id="dx1-43002"></a> has been loaded, in which case the default
is <span
class="cmss-10">ucmark</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-42003"></a>.
-</p><!--l. 3948--><p class="indent" > If set, <span
+ id="dx1-43003"></a>.
+</p><!--l. 4041--><p class="indent" > If set, <span
class="cmtt-10">\glsglossarymark</span><a
- id="dx1-42004"></a> uses
+ id="dx1-43004"></a> uses
<span
class="cmtt-10">\MakeTextUppercase</span><a
- id="dx1-42005"></a><span class="footnote-mark"><a
+ id="dx1-43005"></a><span class="footnote-mark"><a
href="#fn3x2" id="fn3x2-bk"><sup class="textsuperscript">2.3</sup></a></span><a
- id="x1-42006f3"></a>.
+ id="x1-43006f3"></a>.
You can test whether this option has been set or not using
-</p><!--l. 3957--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 4050--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\ifglsucmark</span><a
- id="dx1-42011"></a> ⟨<span
+ id="dx1-43011"></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. 3958--><p class="noindent" >
+</p><!--l. 4051--><p class="noindent" >
For example:
</p>
- <div class="verbatim" id="verbatim-74">
+ <pre class="verbatim" id="verbatim-78">
\renewcommand{\glsglossarymark}[1]{%
- <br />  \ifglsucmark
- <br />    \markright{\MakeTextUppercase{#1}}%
- <br />  \else
- <br />    \markright{#1}%
- <br />  \fi}
-</div>
-<!--l. 3967--><p class="nopar" > If <span
+  \ifglsucmark
+    \markright{\MakeTextUppercase{#1}}%
+  \else
+    \markright{#1}%
+  \fi}
+</pre>
+<!--l. 4060--><p class="nopar" > If <span
class="cmss-10">memoir</span><a
- id="dx1-42012"></a> has been loaded and <span
+ id="dx1-43012"></a> has been loaded and <span
class="cmss-10">ucmark</span><a
- id="dx1-42013"></a> is set, then <span
+ id="dx1-43013"></a> is set, then <span
class="cmss-10">memoir</span><a
- id="dx1-42014"></a>’s <span
+ id="dx1-43014"></a>’s <span
class="cmtt-10">\memUChead</span><a
- id="dx1-42015"></a> is used.
-</p><!--l. 3971--><p class="noindent" >
+ id="dx1-43015"></a> is used.
+</p><!--l. 4064--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-430002.2"></a><a
+ id="x1-440002.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. 3972--><p class="noindent" >The glossaries are placed in unnumbered sectional units by default, but this can be changed using
+<!--l. 4065--><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-43001"></a>. This option can take one of the following values: </p>
+ id="dx1-44001"></a>. This option can take one of the following values: </p>
<ul class="itemize1">
- <li class="itemize"><span
+ <li class="itemize">
+ <!--l. 4069--><p class="noindent" ><span
class="cmss-10">false</span><a
- id="dx1-43002"></a>: no number, i.e. use starred form of sectioning command (e.g. <span
+ id="dx1-44002"></a>: no number, i.e. use starred form of sectioning command (e.g. <span
class="cmtt-10">\chapter* </span>or <span
class="cmtt-10">\section*</span>);
- </li>
- <li class="itemize"><span
+ </p></li>
+ <li class="itemize">
+ <!--l. 4072--><p class="noindent" ><span
class="cmss-10">nolabel</span><a
- id="dx1-43003"></a>: use a numbered section, i.e. the unstarred form of sectioning command (e.g. <span
+ id="dx1-44003"></a>: use a numbered section, i.e. the unstarred form of sectioning command (e.g. <span
class="cmtt-10">\chapter </span>or
<span
class="cmtt-10">\section</span>), but the section not labelled;
- </li>
- <li class="itemize"><span
+ </p></li>
+ <li class="itemize">
+ <!--l. 4077--><p class="noindent" ><span
class="cmss-10">autolabel</span><a
- id="dx1-43004"></a>: numbered with automatic labelling. Each glossary uses the unstarred form of a sectioning
+ id="dx1-44004"></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-43005"></a>). The label is formed
+ id="dx1-44005"></a>). The label is formed
from
- <!--l. 3988--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-43006"></a> <span
+ </p><!--l. 4081--><p class="noindent" ><hr><div title="Definition"><a
+ id="dx1-44006"></a> <span
class="cmtt-10">\glsautoprefix </span>⟨<span
class="cmitt-10">type</span>⟩ </div><hr>
- </p><!--l. 3990--><p class="noindent" >
+ </p><!--l. 4083--><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
@@ -8896,167 +9292,170 @@
</p>
- <div class="verbatim" id="verbatim-75">
+ <pre class="verbatim" id="verbatim-79">
\usepackage[section,numberedsection=autolabel]
-  <br />  {glossaries}
-</div>
- <!--l. 3998--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using something
+   {glossaries}
+</pre>
+ <!--l. 4091--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using something
like:
</p>
- <div class="verbatim" id="verbatim-76">
+ <pre class="verbatim" id="verbatim-80">
The main glossary is in section~\ref{main} and
-  <br />the list of acronyms is in section~\ref{acronym}.
-</div>
- <!--l. 4004--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you
+ the list of acronyms is in section~\ref{acronym}.
+</pre>
+ <!--l. 4097--><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-43007"></a> which is set to <span
+ id="dx1-44007"></a> which is set to <span
class="cmtt-10">main </span>if the <span
class="cmss-10">acronym</span><a
- id="dx1-43008"></a> option is not used and is set to <span
+ id="dx1-44008"></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-43009"></a> option is used. For example:
+ id="dx1-44009"></a> option is used. For example:
</p>
- <div class="verbatim" id="verbatim-77">
+ <pre class="verbatim" id="verbatim-81">
The list of acronyms is in section~\ref{\acronymtype}.
-</div>
- <!--l. 4012--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your document. For
+</pre>
+ <!--l. 4105--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your document. For
example:
</p>
- <div class="verbatim" id="verbatim-78">
+ <pre class="verbatim" id="verbatim-82">
\renewcommand*{\glsautoprefix}{glo:}
-</div>
- <!--l. 4018--><p class="nopar" > will add <span
+</pre>
+ <!--l. 4111--><p class="nopar" > will add <span
class="cmtt-10">glo: </span>to the automatically generated label, so you can then, for example, refer to the list of
acronyms as follows:
</p>
- <div class="verbatim" id="verbatim-79">
+ <pre class="verbatim" id="verbatim-83">
The list of acronyms is in
-  <br />section~\ref{glo:\acronymtype}.
-</div>
- <!--l. 4024--><p class="nopar" > Or, if you are undecided on a prefix:
+ section~\ref{glo:\acronymtype}.
+</pre>
+ <!--l. 4117--><p class="nopar" > Or, if you are undecided on a prefix:
</p>
- <div class="verbatim" id="verbatim-80">
+ <pre class="verbatim" id="verbatim-84">
The list of acronyms is in
-  <br />section~\ref{\glsautoprefix\acronymtype}.
-</div>
- <!--l. 4029--><p class="nopar" >
+ section~\ref{\glsautoprefix\acronymtype}.
+</pre>
+ <!--l. 4122--><p class="nopar" >
</p></li>
- <li class="itemize"><span
+ <li class="itemize">
+ <!--l. 4124--><p class="noindent" ><span
class="cmss-10">nameref</span><a
- id="dx1-43010"></a>: this is like <span
+ id="dx1-44010"></a>: this is like <span
class="cmss-10">autolabel</span><a
- id="dx1-43011"></a> but uses an unnumbered sectioning command (e.g. <span
+ id="dx1-44011"></a> but uses an unnumbered sectioning command (e.g. <span
class="cmtt-10">\chapter*</span><a
- id="dx1-43012"></a> or
+ id="dx1-44012"></a> or
<span
class="cmtt-10">\section*</span><a
- id="dx1-43013"></a>). It’s designed for use with the <span
+ id="dx1-44013"></a>). It’s designed for use with the <span
class="cmss-10">nameref</span><a
- id="dx1-43014"></a> package. For example:
+ id="dx1-44014"></a> package. For example:
- <div class="verbatim" id="verbatim-81">
+</p>
+ <pre class="verbatim" id="verbatim-85">
\usepackage{nameref}
-  <br />\usepackage[numberedsection=nameref]{glossaries}
-</div>
- <!--l. 4038--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span
+ \usepackage[numberedsection=nameref]{glossaries}
+</pre>
+ <!--l. 4131--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\nameref{main}</span></span></span> will display the (TOC) section title associated with the <span
class="cmtt-10">main </span>glossary. As above,
you can redefine <span
class="cmtt-10">\glsautoprefix </span>to provide a prefix for the label.</p></li></ul>
-<!--l. 4044--><p class="noindent" >
+<!--l. 4137--><p class="noindent" >
</p>
-<!--l. 4044--><p class="noindent" ><a
+<!--l. 4137--><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. 4047--><p class="noindent" >
+<!--l. 4140--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-450002.3"></a><a
+ id="x1-460002.3"></a><a
id="pkgopt:savenumberlist"></a><span
class="cmss-10">savenumberlist=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4047--><p class="noindent" >This is a boolean option that specifies whether or not to gather and store the <a
+<!--l. 4140--><p class="noindent" >This is a boolean option that specifies whether or not to gather and store the <a
href="#glo:numberlist">number list<a
- id="dx1-45001"></a></a> for each entry. The
+ id="dx1-46001"></a></a> for each entry. The
default is <span
class="cmss-10">savenumberlist</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-45002"></a>. (See <span
+ id="dx1-46002"></a>. (See <span
class="cmtt-10">\glsentrynumberlist</span><a
- id="dx1-45003"></a> and <span
+ id="dx1-46003"></a> and <span
class="cmtt-10">\glsdisplaynumberlist</span><a
- id="dx1-45004"></a> in <a
-href="#sec:glsnolink">§9 </a><a
-href="#sec:glsnolink">Using Glossary
-Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) This is always true if you use <a
+ id="dx1-46004"></a> in <a
+href="#sec:glsnolink">§<span
+class="cmbx-10">??</span>sec:glsnolink
+</a><a
+href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) This is always true if you use <a
href="#option1">Option 1</a>.
-</p><!--l. 4054--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you use the <span id="textcolor206"><span
+</p><!--l. 4147--><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-45005"></a> option (with either no value or <span id="textcolor207"><span
+ id="dx1-46005"></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-45006"></a> or <span id="textcolor208"><span
+ id="dx1-46006"></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-45007"></a>) then this package option
+ id="dx1-46007"></a>) then this package option
has no effect. With <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-45008"></a></a>, the <a
+ id="dx1-46008"></a></a>, the <a
href="#glo:numberlist">number list<a
- id="dx1-45009"></a>s</a> are automatically saved with the default <span id="textcolor209"><span
+ id="dx1-46009"></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-45010"></a>
-and <span id="textcolor210"><span
+ id="dx1-46010"></a>
+and <span id="textcolor211"><span
class="cmtt-10">save-loclist</span></span><span
class="cmtt-10">=true</span><a
- id="dx1-45011"></a> resource settings. </div>
-</p><!--l. 4061--><p class="noindent" >
-</p><!--l. 4063--><p class="noindent" >
+ id="dx1-46011"></a> resource settings. </div>
+</p><!--l. 4154--><p class="noindent" >
+</p><!--l. 4156--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-460002.3"></a><a
+ id="x1-470002.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. 4063--><p class="noindent" >This is a boolean option. (Default is <span
+<!--l. 4156--><p class="noindent" >This is a boolean option. (Default is <span
class="cmss-10">entrycounter</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-46001"></a>.) If set, each main (level 0) glossary entry will be
+ id="dx1-47001"></a>.) If set, each main (level 0) glossary entry will be
numbered when using the standard glossary styles. This option creates the counter <a
- id="dx1-46002"></a><a
- id="dx1-46003"></a><span
+ id="dx1-47002"></a><a
+ id="dx1-47003"></a><span
class="cmss-10">glossaryentry</span>.
-</p><!--l. 4069--><p class="indent" > If you use this option, you can reference the entry number within the document using
-</p><!--l. 4071--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-46004"></a> <span
+</p><!--l. 4162--><p class="indent" > If you use this option, you can reference the entry number within the document using
+</p><!--l. 4164--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-47004"></a> <span
class="cmtt-10">\glsrefentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4073--><p class="noindent" >
+</p><!--l. 4166--><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
@@ -9064,37 +9463,37 @@
class="cmti-10">label</span>⟩ is
the entry’s label and ⟨<span
class="cmti-10">prefix</span>⟩ is given by
-</p><!--l. 4077--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-46005"></a> <span
+</p><!--l. 4170--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-47005"></a> <span
class="cmtt-10">\GlsEntryCounterLabelPrefix </span></div><hr>
-</p><!--l. 4079--><p class="noindent" >
+</p><!--l. 4172--><p class="noindent" >
(which defaults to <span
class="cmtt-10">glsentry-</span>).
-</p><!--l. 4082--><p class="indent" > <div class="important" title="Important Note"> If you use <span
+
+
+</p><!--l. 4175--><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-46006"></a></a>, <a
+ id="dx1-47006"></a></a>, <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-46007"></a></a> or <a
+ id="dx1-47007"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-46008"></a></a> to ensure the cross-references are up-to-date. </div>
-
-
-</p><!--l. 4087--><p class="noindent" >
-</p><!--l. 4089--><p class="noindent" >
+ id="dx1-47008"></a></a> to ensure the cross-references are up-to-date. </div>
+</p><!--l. 4180--><p class="noindent" >
+</p><!--l. 4182--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-470002.3"></a><a
+ id="x1-480002.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. 4089--><p class="noindent" >This is a ⟨<span
+<!--l. 4182--><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
@@ -9102,379 +9501,384 @@
class="cmss-10">entrycounter</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-47001"></a> and the <span
+ id="dx1-48001"></a> and the <span
class="cmss-10">glossaryentry</span><a
- id="dx1-47002"></a> counter will be reset every time ⟨<span
+ id="dx1-48002"></a> counter will be reset every time ⟨<span
class="cmti-10">value</span>⟩ is incremented.
-</p><!--l. 4096--><p class="indent" > <div class="important" title="Important Note"> The <span
+</p><!--l. 4189--><p class="indent" > <div class="important" title="Important Note"> The <span
class="cmss-10">glossaryentry</span><a
- id="dx1-47003"></a> counter isn’t automatically reset at the start of each glossary, except when glossary section
+ id="dx1-48003"></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-47004"></a> is the same as the counter used in the glossary’s
+ id="dx1-48004"></a> is the same as the counter used in the glossary’s
sectioning command. </div>
-</p><!--l. 4101--><p class="noindent" >
-</p><!--l. 4103--><p class="indent" > If you want the counter reset at the start of each glossary, you can modify the glossary preamble
+</p><!--l. 4194--><p class="noindent" >
+</p><!--l. 4196--><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-47005"></a>) to use
-</p><!--l. 4105--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-47006"></a> <span
+ id="dx1-48005"></a>) to use
+</p><!--l. 4198--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-48006"></a> <span
class="cmtt-10">\glsresetentrycounter </span></div><hr>
-</p><!--l. 4107--><p class="noindent" >
+</p><!--l. 4200--><p class="noindent" >
which sets <span
class="cmss-10">glossaryentry</span><a
- id="dx1-47007"></a> to zero:
+ id="dx1-48007"></a> to zero:
</p>
- <div class="verbatim" id="verbatim-82">
+ <pre class="verbatim" id="verbatim-86">
\renewcommand{\glossarypreamble}{%
- <br />  \glsresetentrycounter
- <br />}
-</div>
-<!--l. 4113--><p class="nopar" > or if you are using <span
+  \glsresetentrycounter
+}
+</pre>
+<!--l. 4206--><p class="nopar" > or if you are using <span
class="cmtt-10">\setglossarypreamble</span><a
- id="dx1-47008"></a>, add it to each glossary preamble, as required. For
+ id="dx1-48008"></a>, add it to each glossary preamble, as required. For
example:
</p>
- <div class="verbatim" id="verbatim-83">
+ <pre class="verbatim" id="verbatim-87">
\setglossarypreamble[acronym]{%
- <br />  \glsresetentrycounter
- <br />  The preamble text here for the list of acronyms.
- <br />}
- <br />\setglossarypreamble{%
- <br />  \glsresetentrycounter
- <br />  The preamble text here for the main glossary.
- <br />}
-</div>
-<!--l. 4125--><p class="nopar" >
-</p><!--l. 4127--><p class="noindent" >
+  \glsresetentrycounter
+  The preamble text here for the list of acronyms.
+}
+\setglossarypreamble{%
+  \glsresetentrycounter
+  The preamble text here for the main glossary.
+}
+</pre>
+<!--l. 4218--><p class="nopar" >
+</p><!--l. 4220--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-480002.3"></a><a
+ id="x1-490002.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. 4127--><p class="noindent" >This is a boolean option. (Default is <span
+<!--l. 4220--><p class="noindent" >This is a boolean option. (Default is <span
class="cmss-10">subentrycounter</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-48001"></a>.) If set, each level 1 glossary entry will be numbered
+ id="dx1-49001"></a>.) If set, each level 1 glossary entry will be numbered
when using the standard glossary styles. This option creates the counter <a
- id="dx1-48002"></a><a
- id="dx1-48003"></a><span
+ id="dx1-49002"></a><a
+ id="dx1-49003"></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-48004"></a>. You can reference
+ id="dx1-49004"></a>. You can reference
the number within the document using <span
class="cmtt-10">\glsrefentry</span><a
- id="dx1-48005"></a><span
+ id="dx1-49005"></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. 4138--><p class="noindent" >
+</p><!--l. 4231--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-490002.3"></a><a
+ id="x1-500002.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. 4138--><p class="noindent" >This is a ⟨<span
+<!--l. 4231--><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-49001"></a>, unless <span
+ id="dx1-50001"></a>, unless <span
class="cmss-10">classicthesis</span><a
- id="dx1-49002"></a> has been loaded, in which case the default is
+ id="dx1-50002"></a> has been loaded, in which case the default is
<span
class="cmss-10">style</span><span
class="cmtt-10">=</span><span
class="cmss-10">index</span><a
- id="dx1-49003"></a>.) Its value should be the name of the glossary style to use. This key may only be used for styles
+ id="dx1-50003"></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-49004"></a>, <span
+ id="dx1-50004"></a>, <span
class="cmss-10">glossary-long</span><a
- id="dx1-49005"></a>, <span
+ id="dx1-50005"></a>, <span
class="cmss-10">glossary-super</span><a
- id="dx1-49006"></a> or <span
+ id="dx1-50006"></a> or <span
class="cmss-10">glossary-tree</span><a
- id="dx1-49007"></a>. Alternatively, you can set the style
+ id="dx1-50007"></a>. Alternatively, you can set the style
using
-</p><!--l. 4146--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 4239--><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. 4147--><p class="noindent" >
+</p><!--l. 4240--><p class="noindent" >
(See <a
-href="#sec:styles">§15 </a><a
+href="#sec:styles">§<span
+class="cmbx-10">??</span>sec:styles </a><a
href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for further details.)
-</p><!--l. 4150--><p class="noindent" >
+</p><!--l. 4243--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-500002.3"></a><a
+ id="x1-510002.3"></a><a
id="pkgopt:nolong"></a><span
class="cmss-10">nolong</span></h4>
-<!--l. 4150--><p class="noindent" >This prevents the <span
+<!--l. 4243--><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-50001"></a> (which means that the <span
+ id="dx1-51001"></a> (which means that the <span
class="cmss-10">longtable</span><a
- id="dx1-50002"></a>
+ id="dx1-51002"></a>
package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that
if you use this option, you won’t be able to use any of the glossary styles defined in the <span
class="cmss-10">glossary-long </span>package
(unless you explicitly load <span
class="cmss-10">glossary-long</span><a
- id="dx1-50003"></a>).
+ id="dx1-51003"></a>).
-</p><!--l. 4158--><p class="noindent" >
+</p><!--l. 4251--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-510002.3"></a><a
+ id="x1-520002.3"></a><a
id="pkgopt:nosuper"></a><span
class="cmss-10">nosuper</span></h4>
-<!--l. 4158--><p class="noindent" >This prevents the <span
+<!--l. 4251--><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-51001"></a> (which means that the
+ id="dx1-52001"></a> (which means that the
<span
class="cmss-10">supertabular</span><a
- id="dx1-51002"></a> package also won’t be loaded). This reduces overhead by not defining unwanted styles and
+ 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-super </span>package (unless you explicitly load <span
class="cmss-10">glossary-super</span><a
- id="dx1-51003"></a>).
-</p><!--l. 4166--><p class="noindent" >
+ id="dx1-52003"></a>).
+</p><!--l. 4259--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-520002.3"></a><a
+ id="x1-530002.3"></a><a
id="pkgopt:nolist"></a><span
class="cmss-10">nolist</span></h4>
-<!--l. 4166--><p class="noindent" >This prevents the <span
+<!--l. 4259--><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-52001"></a>. This reduces overhead by not
+ id="dx1-53001"></a>. This reduces overhead by not
defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles
defined in the <span
class="cmss-10">glossary-list </span>package (unless you explicitly load <span
class="cmss-10">glossary-list</span><a
- id="dx1-52002"></a>). Note that since the default style is <span
+ id="dx1-53002"></a>). Note that since the default style is <span
class="cmss-10">list</span><a
- id="dx1-52003"></a>
+ id="dx1-53003"></a>
(unless <span
class="cmss-10">classicthesis</span><a
- id="dx1-52004"></a> has been loaded), you will also need to use the <span
+ id="dx1-53004"></a> has been loaded), you will also need to use the <span
class="cmss-10">style</span><a
- id="dx1-52005"></a> option to set the style to something
+ id="dx1-53005"></a> option to set the style to something
else.
-</p><!--l. 4177--><p class="noindent" >
+</p><!--l. 4270--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-530002.3"></a><a
+ id="x1-540002.3"></a><a
id="pkgopt:notree"></a><span
class="cmss-10">notree</span></h4>
-<!--l. 4177--><p class="noindent" >This prevents the <span
+<!--l. 4270--><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-53001"></a>. This reduces overhead by not
+ 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-tree </span>package (unless you explicitly load <span
class="cmss-10">glossary-tree</span><a
- id="dx1-53002"></a>). Note that if <span
+ id="dx1-54002"></a>). Note that if <span
class="cmss-10">classicthesis</span><a
- id="dx1-53003"></a> has been
+ id="dx1-54003"></a> has been
loaded, the default style is <span
class="cmss-10">index</span><a
- id="dx1-53004"></a>, which is provided by <span
+ id="dx1-54004"></a>, which is provided by <span
class="cmss-10">glossary-tree</span><a
- id="dx1-53005"></a>.
-</p><!--l. 4186--><p class="noindent" >
+ id="dx1-54005"></a>.
+</p><!--l. 4279--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-540002.3"></a><a
+ id="x1-550002.3"></a><a
id="pkgopt:nostyles"></a><span
class="cmss-10">nostyles</span></h4>
-<!--l. 4186--><p class="noindent" >This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary
+<!--l. 4279--><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-54001"></a>). Also if you use this option, you can’t use the <span
+ id="dx1-55001"></a>). Also if you use this option, you can’t use the <span
class="cmss-10">style</span><a
- id="dx1-54002"></a> package option. Instead
+ id="dx1-55002"></a> package option. Instead
you must either use <span
class="cmtt-10">\setglossarystyle</span><a
- id="dx1-54003"></a><span
+ id="dx1-55003"></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-54004"></a> key in the optional argument to <span
+ id="dx1-55004"></a> key in the optional argument to <span
class="cmtt-10">\printglossary</span><a
- id="dx1-54005"></a>.
+ id="dx1-55005"></a>.
Example:
</p>
- <div class="verbatim" id="verbatim-84">
+ <pre class="verbatim" id="verbatim-88">
\usepackage[nostyles]{glossaries}
- <br />\usepackage{glossary-mcols}
- <br />\setglossarystyle{mcoltree}
-</div>
-<!--l. 4197--><p class="nopar" >
-</p><!--l. 4199--><p class="noindent" >
+\usepackage{glossary-mcols}
+\setglossarystyle{mcoltree}
+</pre>
+<!--l. 4290--><p class="nopar" >
+</p><!--l. 4292--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-550002.3"></a><a
+ id="x1-560002.3"></a><a
id="pkgopt:nonumberlist"></a><span
class="cmss-10">nonumberlist</span></h4>
-<!--l. 4199--><p class="noindent" >This option will suppress the associated <a
+<!--l. 4292--><p class="noindent" >This option will suppress the associated <a
href="#glo:numberlist">number list<a
- id="dx1-55001"></a>s</a> in the glossaries (see also <a
-href="#sec:numberlists">§5 </a><a
-href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). Note
-that if you use Options <a
+ id="dx1-56001"></a>s</a> in the glossaries (see also <a
+href="#sec:numberlists">§<span
+class="cmbx-10">??</span>sec:numberlists </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-55002"></a></a> or <a
+ id="dx1-56002"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-55003"></a></a>) then the locations must still be valid. This
+ id="dx1-56003"></a></a>) then the locations must still be valid. This
package option merely prevents the <a
href="#glo:numberlist">number list<a
- id="dx1-55004"></a></a> from being displayed, but both <a
+ id="dx1-56004"></a></a> from being displayed, but both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-55005"></a></a> and <a
+ id="dx1-56005"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-55006"></a></a>
+ id="dx1-56006"></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-55007"></a></a>
+ id="dx1-56007"></a></a>
includes any cross-references, so suppressing the <a
href="#glo:numberlist">number list<a
- id="dx1-55008"></a></a> will also hide the cross-references (see
+ id="dx1-56008"></a></a> will also hide the cross-references (see
below).
-</p><!--l. 4210--><p class="noindent" >
+</p><!--l. 4303--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-560002.3"></a><a
+ id="x1-570002.3"></a><a
id="pkgopt:seeautonumberlist"></a><span
class="cmss-10">seeautonumberlist</span></h4>
-<!--l. 4210--><p class="noindent" >If you suppress the <a
+<!--l. 4303--><p class="noindent" >If you suppress the <a
href="#glo:numberlist">number list<a
- id="dx1-56001"></a>s</a> with <span
+ id="dx1-57001"></a>s</a> with <span
class="cmss-10">nonumberlist</span><a
- id="dx1-56002"></a>, described above, this will also suppress any cross-referencing
-information supplied by the <span
+ id="dx1-57002"></a>, described above, this will also suppress any
+cross-referencing information supplied by the <span
class="cmtt-10">see</span><a
- id="dx1-56003"></a> key in <span
+ id="dx1-57003"></a> key in <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-56004"></a> or <span
+ id="dx1-57004"></a> or <span
class="cmtt-10">\glssee</span><a
- id="dx1-56005"></a>. If you use <span
+ id="dx1-57005"></a>. If you
+use <span
class="cmss-10">seeautonumberlist</span><a
- id="dx1-56006"></a>, the <span
+ id="dx1-57006"></a>, the <span
class="cmtt-10">see</span><a
- id="dx1-56007"></a>
-key will automatically implement <span
+ id="dx1-57007"></a> key will automatically implement <span
class="cmtt-10">nonumberlist=false</span><a
- id="dx1-56008"></a> for that entry. (Note this doesn’t affect <span
-class="cmtt-10">\glssee</span>.) For
-further details see <a
-href="#sec:crossref">§8 </a><a
-href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>.
-</p><!--l. 4219--><p class="noindent" >
+ id="dx1-57008"></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">??</span>sec:crossref </a><a
+href="#sec:crossref">Cross-Referencing
+Entries<!--tex4ht:ref: sec:crossref --></a>.
+</p><!--l. 4312--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-570002.3"></a><a
+ id="x1-580002.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. 4219--><p class="noindent" >This is a ⟨<span
+<!--l. 4312--><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-57001"></a>.) The value should be the name of the default counter to
+ id="dx1-58001"></a>.) The value should be the name of the default counter to
use in the <a
href="#glo:numberlist">number list<a
- id="dx1-57002"></a>s</a> (see <a
-href="#sec:numberlists">§5 </a><a
-href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>).
-</p><!--l. 4224--><p class="noindent" >
+ id="dx1-58002"></a>s</a> (see <a
+href="#sec:numberlists">§<span
+class="cmbx-10">??</span>sec:numberlists </a><a
+href="#sec:numberlists">Number Lists<!--tex4ht:ref: sec:numberlists --></a>).
+</p><!--l. 4317--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-580002.3"></a><a
+ id="x1-590002.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. 4224--><p class="noindent" >This is a boolean option. If no value is specified, <span
+<!--l. 4317--><p class="noindent" >This is a boolean option. If no value is specified, <span
class="cmss-10">true</span><a
- id="dx1-58001"></a> is assumed. When set to <span
+ id="dx1-59001"></a> is assumed. When set to <span
class="cmss-10">true</span><a
- id="dx1-58002"></a>, this option suppresses the
+ id="dx1-59002"></a>, this option suppresses the
default post description dot used by some of the predefined styles.
-</p><!--l. 4229--><p class="indent" > The default setting is <span
+
+
+</p><!--l. 4322--><p class="indent" > The default setting is <span
class="cmss-10">nopostdot</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-58003"></a> for the base <span
+ id="dx1-59003"></a> for the base <span
class="cmss-10">glossaries </span>package and <span
class="cmss-10">nopostdot</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-58004"></a> for
+ id="dx1-59004"></a> for
<a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>.
-
-
-</p><!--l. 4233--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 4326--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor211"><span
+class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor212"><span
class="cmss-10">postdot</span></span><a
- id="dx1-58005"></a>, which is equivalent to <span
+ id="dx1-59005"></a>, which is equivalent to <span
class="cmss-10">nopostdot</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-58006"></a>, and also <span id="textcolor212"><span
+ id="dx1-59006"></a>, and also <span id="textcolor213"><span
class="cmss-10">postpunc</span></span><a
- id="dx1-58007"></a>,
+ id="dx1-59007"></a>,
which allows you to choose a different punctuation character. </div>
-</p><!--l. 4238--><p class="noindent" >
-</p><!--l. 4240--><p class="noindent" >
+</p><!--l. 4331--><p class="noindent" >
+</p><!--l. 4333--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-590002.3"></a><a
+ id="x1-600002.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. 4240--><p class="noindent" >This is a boolean option. If no value is specified, <span
+<!--l. 4333--><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
@@ -9482,11 +9886,11 @@
class="cmss-10">nogroupskip</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-59001"></a>.
-</p><!--l. 4246--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you are using <a
+ id="dx1-60001"></a>.
+</p><!--l. 4339--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you are using <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-59002"></a></a> without the <span
+ id="dx1-60002"></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
@@ -9493,20 +9897,20 @@
class="cmtt-10">=</span><span
class="cmss-10">true </span>as
there won’t be any letter groups. </div>
-</p><!--l. 4251--><p class="noindent" >
-</p><!--l. 4253--><p class="noindent" >
+</p><!--l. 4344--><p class="noindent" >
+</p><!--l. 4346--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-600002.3"></a><span id="textcolor213"><a
- id="pkgopt:stylemods"></a><span id="textcolor214"><span
+ id="x1-610002.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. 4255--><p class="noindent" >Load the <span
+<!--l. 4348--><p class="noindent" >Load the <span
class="cmss-10">glossaries-extra-stylemods</span><a
- id="dx1-60001"></a> package and patch the predefined styles. The ⟨<span
+ id="dx1-61001"></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
@@ -9515,127 +9919,128 @@
class="cmti-10">element</span>⟩ in the comma-separated
⟨<span
class="cmti-10">list</span>⟩.
-</p><!--l. 4260--><p class="noindent" >
+</p><!--l. 4353--><p class="noindent" >
</p>
-<!--l. 4260--><p class="noindent" ><a
+<!--l. 4353--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.4 </span> <a
id="sec:pkgopts-indexing"></a>Indexing Options</h3>
-<!--l. 4263--><p class="noindent" >
+<!--l. 4356--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-620002.4"></a><a
+ id="x1-630002.4"></a><a
id="pkgopt:seenoindex"></a><span
class="cmss-10">seenoindex=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">value</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4263--><p class="noindent" >Introduced in version 4.24, this option may take one of three values: <span
+<!--l. 4356--><p class="noindent" >Introduced in version 4.24, this option may take one of three values: <span
class="cmss-10">error</span>, <span
class="cmss-10">warn </span>or <span
class="cmss-10">ignore</span>. The <span
class="cmtt-10">see</span><a
- id="dx1-62001"></a> key
+ id="dx1-63001"></a> key
automatically indexes the cross-referenced entry using <span
-class="cmtt-10">\glsadd</span>. This means that if this key is
+class="cmtt-10">\glssee</span><a
+ id="dx1-63002"></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-62002"></a> key is used before <span
+ id="dx1-63003"></a> key is used before <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-62003"></a>. This option allows you to change the error into just a
+ id="dx1-63004"></a>. This option allows you to change the error into just a
warning (<span
class="cmss-10">seenoindex</span><span
class="cmtt-10">=</span><span
class="cmss-10">warn</span><a
- id="dx1-62004"></a>) or ignore it (<span
+ id="dx1-63005"></a>) or ignore it (<span
class="cmss-10">seenoindex</span><span
class="cmtt-10">=</span><span
class="cmss-10">ignore</span><a
- id="dx1-62005"></a>) if, for example, you want to temporarily
+ id="dx1-63006"></a>) if, for example, you want to temporarily
comment out <span
class="cmtt-10">\makeglossaries </span>to speed up the compilation of a draft document by omitting the
indexing.
-</p><!--l. 4277--><p class="noindent" >
+</p><!--l. 4370--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-630002.4"></a><a
+ id="x1-640002.4"></a><a
id="pkgopt:esclocations"></a><span
class="cmss-10">esclocations=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4277--><p class="noindent" >This is a boolean option. The default is <span
+<!--l. 4370--><p class="noindent" >This is a boolean option. The default is <span
class="cmss-10">esclocations</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-63001"></a>, which is needed for Options <a
+ id="dx1-64001"></a>, which is needed for Options <a
href="#option2">2</a> and <a
href="#option3">3</a>. With <a
href="#option1">Option 1</a>
<span
class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-63002"></a> changes it to <span
+ id="dx1-64002"></a> changes it to <span
class="cmss-10">esclocations</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-63003"></a>. With <a
+ id="dx1-64003"></a>. With <a
href="#option4">Option 4</a> (<a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-63004"></a></a>), this setting is
+ id="dx1-64004"></a></a>), this setting is
ignored.
-</p><!--l. 4283--><p class="indent" > Both <a
+</p><!--l. 4376--><p class="indent" > Both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-63005"></a></a> and <a
+ id="dx1-64005"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-63006"></a></a> are fussy about the location formats (<a
+ id="dx1-64006"></a></a> are fussy about the location formats (<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-63007"></a></a> more so than <a
+ id="dx1-64007"></a></a> more so than <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-63008"></a></a>) so the
+ id="dx1-64008"></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. 4292--><p class="indent" > If you’re sure that your locations will always expand to an acceptable format (or you’re prepared to
+</p><!--l. 4385--><p class="indent" > If you’re sure that your locations will always expand to an acceptable format (or you’re prepared to
post-process the glossary file before passing it to the relevant indexing application) then use <span
class="cmss-10">esclocations</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-63009"></a> to
+ id="dx1-64009"></a> to
avoid the complex escaping of location values. (See “Writing information to associated files” in the documented
code for further details.)
-</p><!--l. 4300--><p class="indent" > This isn’t an issue for Options <a
+</p><!--l. 4393--><p class="indent" > This isn’t an issue for Options <a
href="#option1">1</a> or <a
href="#option4">4</a> as the locations are written to the <span
class="cmtt-10">aux</span><a
- id="dx1-63010"></a> file so no syntax conversion is
+ id="dx1-64010"></a> file so no syntax conversion is
required.
-</p><!--l. 4303--><p class="noindent" >
+</p><!--l. 4396--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-640002.4"></a><a
+ id="x1-650002.4"></a><a
id="pkgopt:indexonlyfirst"></a><span
class="cmss-10">indexonlyfirst=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4303--><p class="noindent" >This is a boolean option that specifies whether to only add information to the external glossary file on <a
+<!--l. 4396--><p class="noindent" >This is a boolean option that specifies whether to only add information to the external glossary file on <a
href="#glo:firstuse">first use</a>.
The default is <span
class="cmss-10">indexonlyfirst</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-64001"></a>, which will add a line to the file every time one of the <a
+ id="dx1-65001"></a>, which will add a line to the file every time one of the <a
href="#sec:gls-like"><span
class="cmtt-10">\gls</span>-like</a> or
<a
@@ -9642,30 +10047,30 @@
href="#sec:glstext-like"><span
class="cmtt-10">\glstext</span>-like</a> commands are used. Note that <span
class="cmtt-10">\glsadd</span><a
- id="dx1-64002"></a> will always add information to the external glossary
+ id="dx1-65002"></a> will always add information to the external glossary
file<span class="footnote-mark"><a
href="#fn4x2" id="fn4x2-bk"><sup class="textsuperscript">2.4</sup></a></span><a
- id="x1-64003f4"></a> (since
+ id="x1-65003f4"></a> (since
that’s the purpose of that command).
-</p><!--l. 4312--><p class="indent" > <div class="important" title="Important Note"> Resetting the <a
+</p><!--l. 4405--><p class="indent" > <div class="important" title="Important Note"> Resetting the <a
href="#glo:firstuseflag">first use flag</a> with commands like <span
class="cmtt-10">\glsreset</span><a
- id="dx1-64004"></a> after an entry has been indexed will cause that
+ id="dx1-65004"></a> after an entry has been indexed will cause that
entry to be indexed multiple times if it’s used again after the reset. Likewise unsetting the <a
href="#glo:firstuseflag">first use flag</a> before
an entry has been indexed will prevent it from being indexed (unless specifically indexed with <span
class="cmtt-10">\glsadd</span>).
</div>
-</p><!--l. 4319--><p class="noindent" >
-</p><!--l. 4321--><p class="indent" > You can customise this by redefining
-</p><!--l. 4322--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-64005"></a> <span
+</p><!--l. 4412--><p class="noindent" >
+</p><!--l. 4414--><p class="indent" > You can customise this by redefining
+</p><!--l. 4415--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-65005"></a> <span
class="cmtt-10">\glswriteentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">wr-code</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4324--><p class="noindent" >
+</p><!--l. 4417--><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.
@@ -9674,24 +10079,24 @@
</p>
- <div class="verbatim" id="verbatim-85">
+ <pre class="verbatim" id="verbatim-89">
\newcommand*{\glswriteentry}[2]{%
- <br />  \ifglsindexonlyfirst
- <br />    \ifglsused{#1}{}{#2}%
- <br />  \else
- <br />    #2%
- <br />  \fi
- <br />}
-</div>
-<!--l. 4336--><p class="nopar" > This checks the <span
+  \ifglsindexonlyfirst
+    \ifglsused{#1}{}{#2}%
+  \else
+    #2%
+  \fi
+}
+</pre>
+<!--l. 4429--><p class="nopar" > This checks the <span
class="cmss-10">indexonlyfirst</span><a
- id="dx1-64006"></a> package option (using <span
+ id="dx1-65006"></a> package option (using <span
class="cmtt-10">\ifglsindexonlyfirst</span>) and does ⟨<span
class="cmti-10">wr-code</span>⟩ if this is <span
class="cmss-10">false</span>
otherwise it only does ⟨<span
class="cmti-10">wr-code</span>⟩ of the entry hasn’t been used.
-</p><!--l. 4342--><p class="indent" > For example, suppose you only want to index the first use for entries in the <span
+</p><!--l. 4435--><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:
@@ -9698,241 +10103,271 @@
</p>
- <div class="verbatim" id="verbatim-86">
+ <pre class="verbatim" id="verbatim-90">
\renewcommand*{\glswriteentry}[2]{%
- <br /> \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}
- <br /> {\ifglsused{#1}{}{#2}}%
- <br /> {#2}%
- <br />}
-</div>
-<!--l. 4351--><p class="nopar" > Here I’ve used <span
+ \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}
+ {\ifglsused{#1}{}{#2}}%
+ {#2}%
+}
+</pre>
+<!--l. 4444--><p class="nopar" > Here I’ve used <span
class="cmtt-10">\ifthenelse </span>to ensure the arguments of <span
class="cmtt-10">\equal </span>are fully expanded before the comparison is
made.
-</p><!--l. 4355--><p class="indent" > With the <a
+</p><!--l. 4448--><p class="indent" > With the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> package it’s possible to only index <a
href="#glo:firstuse">first use</a> for particular categories. For example, if
-you only want this enabled for abbreviations and acronyms then you can set the <span id="textcolor215"><span
+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-64007"></a> attribute for the
+ id="dx1-65007"></a> attribute for the
<span
class="cmtt-10">abbreviation </span>and <span
class="cmtt-10">acronym </span>categories. (Instead of using the <span
class="cmss-10">indexonlyfirst</span><a
- id="dx1-64008"></a> package option.) See the
+ id="dx1-65008"></a> package option.) See the
<a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further details.
-</p><!--l. 4363--><p class="noindent" >
+</p><!--l. 4456--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-650002.4"></a><span id="textcolor216"><a
- id="pkgopt:indexcrossrefs"></a><span id="textcolor217"><span
+ id="x1-660002.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. 4365--><p class="noindent" >If <span
-class="cmss-10">true</span>, this will automatically index any cross-referenced entries that haven’t been marked as used at
+<!--l. 4458--><p class="noindent" >If <span
+class="cmss-10">true</span>, this will automatically index (<span
+class="cmtt-10">\glsadd</span><a
+ id="dx1-66001"></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. 4370--><p class="noindent" >
+</p><!--l. 4463--><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-66002"></a></a> can automatically find dependent entries when it parses the <span
+class="cmtt-10">bib</span><a
+ id="dx1-66003"></a> file. Use the <span id="textcolor219">selection</span>
+option to <span id="textcolor220"><span
+class="cmtt-10">\GlsXtrLoadResources</span></span><a
+ id="dx1-66004"></a> to determine the selection of dependencies. </div>
+</p><!--l. 4468--><p class="noindent" >
+</p><!--l. 4470--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-660002.4"></a><span id="textcolor218"><a
- id="pkgopt:autoseeindex"></a><span id="textcolor219"><span
+ id="x1-670002.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. 4372--><p class="noindent" >If <span
+<!--l. 4472--><p class="noindent" >If <span
class="cmss-10">true</span>, makes the <span
class="cmtt-10">see</span><a
- id="dx1-66001"></a> and <span id="textcolor220"><span id="textcolor221"><span
+ id="dx1-67001"></a> and <span id="textcolor223"><span id="textcolor224"><span
class="cmtt-10">seealso</span></span><a
- id="dx1-66002"></a></span> keys automatically index the cross-reference when the entry is defined
-(default, and the only option with just the base <span
+ id="dx1-67002"></a></span> keys automatically index the cross-reference (with <span
+class="cmtt-10">\glssee</span><a
+ id="dx1-67003"></a>) when the entry
+is defined (default, and the only option with just the base <span
class="cmss-10">glossaries </span>package).
-</p><!--l. 4377--><p class="noindent" >
+</p><!--l. 4477--><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-67004"></a></a>, use the <span id="textcolor225">selection</span> option to <span id="textcolor226"><span
+class="cmtt-10">\GlsXtrLoadResources</span></span><a
+ id="dx1-67005"></a> to determine the selection of
+dependencies. </div>
+</p><!--l. 4481--><p class="noindent" >
+</p><!--l. 4483--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-670002.4"></a><span id="textcolor222"><a
- id="pkgopt:record"></a><span id="textcolor223"><span
+ id="x1-680002.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. 4379--><p class="noindent" >If not <span
+<!--l. 4485--><p class="noindent" >If not <span
class="cmss-10">off</span>, this option indicates that <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-67001"></a></a> is required. If the value is omitted, <span
+ id="dx1-68001"></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. 4488--><p class="noindent" >
<span
-class="cmssbx-10">off</span> </dt><dd
-class="description"><a
+class="cmssbx-10">off</span> </p></dt><dd
+class="description">
+ <!--l. 4488--><p class="noindent" ><a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-67002"></a></a> isn’t being used;
- </dd><dt class="description">
+ id="dx1-68002"></a></a> isn’t being used;
+ </p></dd><dt class="description">
+ <!--l. 4490--><p class="noindent" >
<span
-class="cmssbx-10">only</span> </dt><dd
-class="description"><a
+class="cmssbx-10">only</span> </p></dt><dd
+class="description">
+ <!--l. 4490--><p class="noindent" ><a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-67003"></a></a> is being used to fetch entries from a <span
+ id="dx1-68003"></a></a> is being used to fetch entries from a <span
class="cmtt-10">bib</span><a
- id="dx1-67004"></a> file, to sort the entries and collate the <a
+ id="dx1-68004"></a> file, to sort the entries and collate the <a
href="#glo:numberlist">number
list<a
- id="dx1-67005"></a>s</a>, where the location information is the same as for Options <a
+ id="dx1-68005"></a>s</a>, where the location information is the same as for Options <a
href="#option1">1</a>–<a
href="#option3">3</a>;
-
-
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 4495--><p class="noindent" >
<span
-class="cmssbx-10">nameref</span> </dt><dd
-class="description">like <span
-class="cmss-10">only </span>but provides extra information that allows the associated title to be used instead of
- the location number;
- </dd><dt class="description">
+class="cmssbx-10">nameref</span> </p></dt><dd
+class="description">
+ <!--l. 4495--><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. 4500--><p class="noindent" >
<span
-class="cmssbx-10">alsoindex</span> </dt><dd
-class="description">a hybrid approach where <a
+class="cmssbx-10">hybrid</span> </p></dt><dd
+class="description">
+ <!--l. 4500--><p class="noindent" >a hybrid approach where <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-67006"></a></a> is begin used to fetch entries from a <span
+ id="dx1-68006"></a></a> is used to fetch entries from a <span
class="cmtt-10">bib</span><a
- id="dx1-67007"></a> file but <a
+ id="dx1-68007"></a> file but <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-67008"></a></a>
- or <a
+ id="dx1-68008"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-67009"></a></a> are used for the indexing. This requires a more complicated document build and isn’t
- recommended.</dd></dl>
-<!--l. 4398--><p class="noindent" >See <a
+ id="dx1-68009"></a></a>
+ are used for the indexing. This requires a more complicated document build and isn’t recommended.</p></dd></dl>
+<!--l. 4505--><p class="noindent" >See <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further details.
-</p><!--l. 4400--><p class="noindent" >
+</p><!--l. 4507--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-680002.4"></a><span id="textcolor224"><a
- id="pkgopt:equations"></a><span id="textcolor225"><span
+ id="x1-690002.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. 4402--><p class="noindent" >If <span
+<!--l. 4509--><p class="noindent" >If <span
class="cmss-10">true</span>, this option will cause the default location counter to automatically switch to <span
class="cmtt-10">equation </span>when inside a
numbered equation environment.
-</p><!--l. 4406--><p class="noindent" >
+</p><!--l. 4513--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-690002.4"></a><span id="textcolor226"><a
- id="pkgopt:floats"></a><span id="textcolor227"><span
+ id="x1-700002.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. 4408--><p class="noindent" >If <span
+<!--l. 4515--><p class="noindent" >If <span
class="cmss-10">true</span>, this option will cause the default location counter to automatically switch to the corresponding counter
when inside a float. (Remember that with floats it’s the <span
class="cmtt-10">\caption </span>command that increments the counter so the
location will be incorrect if an entry is indexed within the float before the caption.)
-</p><!--l. 4414--><p class="noindent" >
+
+
+</p><!--l. 4521--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-700002.4"></a><span id="textcolor228"><a
- id="pkgopt:indexcounter"></a><span id="textcolor229"><span
+ id="x1-710002.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. 4416--><p class="noindent" >This valueless option is primarily intended for use with <a
+<!--l. 4523--><p class="noindent" >This valueless option is primarily intended for use with <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-70001"></a></a> and <span
+ id="dx1-71001"></a></a> and <span
class="cmss-10">hyperref</span><a
- id="dx1-70002"></a> allowing the page location
-hyperlink to the relevant point in the page (rather than the top of the page). Unexpected results will occur with
-other indexing methods. See <a
+ id="dx1-71002"></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. 4422--><p class="noindent" >
+class="cmss-10">glossaries-extra</span></a> manual for further
+details.
+</p><!--l. 4530--><p class="noindent" >
</p>
-<!--l. 4422--><p class="noindent" ><a
+<!--l. 4530--><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. 4425--><p class="noindent" >This section is mostly for Options <a
+<!--l. 4533--><p class="noindent" >This section is mostly for Options <a
href="#option2">2</a> and <a
href="#option3">3</a>. Only the <span
class="cmss-10">sort</span><a
- id="dx1-71001"></a> and <span
+ id="dx1-72001"></a> and <span
class="cmss-10">order</span><a
- id="dx1-71002"></a> options are applicable for
+ id="dx1-72002"></a> options are applicable for
<a
href="#option1">Option 1</a>.
-</p><!--l. 4428--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> With Options <a
+</p><!--l. 4536--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> With Options <a
href="#option4">4</a>–<a
href="#option6">6</a>, only <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">none</span><a
- id="dx1-71003"></a> is applicable (and this is automatically implemented by
-<span id="textcolor230"><span
+ id="dx1-72003"></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-71004"></a> and <span id="textcolor231"><span
+ id="dx1-72004"></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-71005"></a>). With <a
+ id="dx1-72005"></a>). With <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-71006"></a></a>, the sort method is provided in the optional argument of
-<span id="textcolor232"><span
+ id="dx1-72006"></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-71007"></a> not with the <span
+ id="dx1-72007"></a> not with the <span
class="cmss-10">sort </span>package option. There’s no sorting with Options <a
href="#option5">5</a> and <a
href="#option6">6</a>.
</div>
-
-
-</p><!--l. 4435--><p class="noindent" >
-</p><!--l. 4437--><p class="noindent" >
+</p><!--l. 4543--><p class="noindent" >
+</p><!--l. 4545--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-720002.5"></a><a
+ id="x1-730002.5"></a><a
id="pkgopt:sanitizesort"></a><span
class="cmss-10">sanitizesort=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">boolean</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4437--><p class="noindent" >This is a boolean option that determines whether or not to <a
+<!--l. 4545--><p class="noindent" >This is a boolean option that determines whether or not to <a
href="#glo:sanitize">sanitize<a
- id="dx1-72001"></a></a> the sort value when writing to the external
+ id="dx1-73001"></a></a> the sort value when writing to the external
glossary file. For example, suppose you define an entry as follows:
</p>
- <div class="verbatim" id="verbatim-87">
+ <pre class="verbatim" id="verbatim-91">
\newglossaryentry{hash}{name={\#},sort={#},
- <br /> description={hash symbol}}
-</div>
-<!--l. 4444--><p class="nopar" > The sort value (<span class="obeylines-h"><span class="verb"><span
+ description={hash symbol}}
+</pre>
+<!--l. 4552--><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:
@@ -9939,14 +10374,14 @@
</p>
- <div class="verbatim" id="verbatim-88">
+ <pre class="verbatim" id="verbatim-92">
\newcommand{\mysortvalue}{AAA}
- <br />\newglossaryentry{sample}{%
- <br />  name={sample},
- <br />  sort={\mysortvalue},
- <br />  description={an example}}
-</div>
-<!--l. 4456--><p class="nopar" > and you actually want <span
+\newglossaryentry{sample}{%
+  name={sample},
+  sort={\mysortvalue},
+  description={an example}}
+</pre>
+<!--l. 4564--><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
@@ -9953,112 +10388,118 @@
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-72002"></a>.
-</p><!--l. 4461--><p class="indent" > The default for Options <a
+ id="dx1-73002"></a>.
+</p><!--l. 4569--><p class="indent" > The default for Options <a
href="#option2">2</a> and <a
href="#option3">3</a> is <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-72003"></a>, and the default for <a
+ id="dx1-73003"></a>, and the default for <a
href="#option1">Option 1</a> is <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-72004"></a>.
-</p><!--l. 4464--><p class="noindent" >
+ id="dx1-73004"></a>.
+</p><!--l. 4572--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-730002.5"></a><a
+ id="x1-740002.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. 4464--><p class="noindent" >If you use Options <a
+<!--l. 4572--><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-73001"></a> key in the optional argument
+ id="dx1-74001"></a> key in the optional argument
of <span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-73002"></a>. If you have multiple glossaries in your document and you are using <a
+ id="dx1-74002"></a>. If you have multiple glossaries in your document and you are using <a
href="#option1">Option 1</a>,
only use the package options <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-73003"></a> or <span
+ id="dx1-74003"></a> or <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-73004"></a> if you want to set this sort method for <span
+ id="dx1-74004"></a> if you want to set this sort method for <span
class="cmti-10">all </span>your
glossaries.
-</p><!--l. 4474--><p class="indent" > This is a ⟨<span
+</p><!--l. 4582--><p class="indent" > This is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ option where ⟨<span
class="cmti-10">value</span>⟩ may be one of the following: </p>
<ul class="itemize1">
- <li class="itemize"><span
+ <li class="itemize">
+ <!--l. 4585--><p class="noindent" ><span
class="cmss-10">standard</span><a
- id="dx1-73005"></a> : entries are sorted according to the value of the <span
+ id="dx1-74005"></a> : entries are sorted according to the value of the <span
class="cmtt-10">sort</span><a
- id="dx1-73006"></a> key used in <span
+ id="dx1-74006"></a> key used in <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-73007"></a> (if
+ id="dx1-74007"></a> (if
present) or the <span
class="cmtt-10">name</span><a
- id="dx1-73008"></a> key (if <span
+ id="dx1-74008"></a> key (if <span
class="cmtt-10">sort</span><a
- id="dx1-73009"></a> key is missing);
- </li>
- <li class="itemize"><span
+ id="dx1-74009"></a> key is missing);
+ </p></li>
+ <li class="itemize">
+ <!--l. 4590--><p class="noindent" ><span
class="cmss-10">def</span><a
- id="dx1-73010"></a> : entries are sorted in the order in which they were defined (the <span
+ id="dx1-74010"></a> : entries are sorted in the order in which they were defined (the <span
class="cmtt-10">sort</span><a
- id="dx1-73011"></a> key in <span
+ id="dx1-74011"></a> key in <span
class="cmtt-10">\newglossaryentry</span>
is ignored);
- </li>
- <li class="itemize"><span
+ </p></li>
+ <li class="itemize">
+ <!--l. 4594--><p class="noindent" ><span
class="cmss-10">use</span><a
- id="dx1-73012"></a> : entries are sorted according to the order in which they are used in the document (the <span
+ id="dx1-74012"></a> : entries are sorted according to the order in which they are used in the document (the <span
class="cmtt-10">sort</span><a
- id="dx1-73013"></a>
+ id="dx1-74013"></a>
key in <span
class="cmtt-10">\newglossaryentry </span>is ignored).
- <!--l. 4490--><p class="noindent" >Both <span
+ </p><!--l. 4598--><p class="noindent" >Both <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-73014"></a> and <span
+ id="dx1-74014"></a> and <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-73015"></a> set the sort key to a six digit number via
- </p><!--l. 4492--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-73016"></a> <span
+ id="dx1-74015"></a> set the sort key to a six digit number via
+ </p><!--l. 4600--><p class="noindent" ><hr><div title="Definition"><a
+ id="dx1-74016"></a> <span
class="cmtt-10">\glssortnumberfmt{</span>⟨<span
class="cmitt-10">number</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 4494--><p class="noindent" >
+ </p><!--l. 4602--><p class="noindent" >
(padded with leading zeros, where necessary). This can be redefined, if required, before the entries are
defined (in the case of <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-73017"></a>) or before the entries are used (in the case of <span
+ id="dx1-74017"></a>) or before the entries are used (in the case of <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-73018"></a>).
+ id="dx1-74018"></a>).
+
+
</p></li>
- <li class="itemize"><span
+ <li class="itemize">
+ <!--l. 4608--><p class="noindent" ><span
class="cmss-10">none</span><a
- id="dx1-73019"></a> : this setting is new to version 4.30 and is only for documents that don’t use <span
+ id="dx1-74019"></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
@@ -10067,9 +10508,7 @@
href="#option1">Option 1</a>). It omits the code used to sanitize or escape the
sort value, since it’s not required. This can help to improve the document build speed, especially if there
are a large number of entries.
-
-
- <!--l. 4507--><p class="noindent" >This option can’t be used with <span
+ </p><!--l. 4615--><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
@@ -10080,25 +10519,25 @@
<span
class="cmtt-10">\printunsrtglossary </span>(<a
href="#option5">Option 5</a>).</p></li></ul>
-<!--l. 4513--><p class="noindent" >Note that the group styles (such as <span
+<!--l. 4621--><p class="noindent" >Note that the group styles (such as <span
class="cmss-10">listgroup</span><a
- id="dx1-73020"></a>) are incompatible with the <span
+ id="dx1-74020"></a>) are incompatible with the <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-73021"></a> and <span
+ id="dx1-74021"></a> and <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-73022"></a> options.
-</p><!--l. 4517--><p class="indent" > The default is <span
+ id="dx1-74022"></a> options.
+</p><!--l. 4625--><p class="indent" > The default is <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">standard</span><a
- id="dx1-73023"></a>. When the standard sort option is in use, you can hook into the sort mechanism
+ id="dx1-74023"></a>. When the standard sort option is in use, you can hook into the sort mechanism
by redefining:
-</p><!--l. 4520--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-73024"></a> <span
+</p><!--l. 4628--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-74024"></a> <span
class="cmtt-10">\glsprestandardsort{</span>⟨<span
class="cmitt-10">sort cs</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -10106,38 +10545,38 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4522--><p class="noindent" >
+</p><!--l. 4630--><p class="noindent" >
where ⟨<span
class="cmti-10">sort cs</span>⟩ is a temporary control sequence that stores the sort value (which was either explicitly set via the
<span
class="cmtt-10">sort</span><a
- id="dx1-73025"></a> key or implicitly set via the <span
+ id="dx1-74025"></a> key or implicitly set via the <span
class="cmtt-10">name</span><a
- id="dx1-73026"></a> key) before any escaping of the <a
+ id="dx1-74026"></a> key) before any escaping of the <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-73027"></a></a>/<a
+ id="dx1-74027"></a></a>/<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-73028"></a></a> special characters is
+ id="dx1-74028"></a></a> special characters is
performed. By default <span
class="cmtt-10">\glsprestandardsort </span>just does:
-</p><!--l. 4528--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-73029"></a> <span
+</p><!--l. 4636--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-74029"></a> <span
class="cmtt-10">\glsdosanitizesort </span></div><hr>
-</p><!--l. 4530--><p class="noindent" >
+</p><!--l. 4638--><p class="noindent" >
which <a
href="#glo:sanitize">sanitize<a
- id="dx1-73030"></a>s</a> ⟨<span
+ id="dx1-74030"></a>s</a> ⟨<span
class="cmti-10">sort cs</span>⟩ if the <span
class="cmss-10">sanitizesort</span><a
- id="dx1-73031"></a> package option is set (or does nothing if the package option
+ id="dx1-74031"></a> package option is set (or does nothing if the package option
<span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-73032"></a> is used).
-</p><!--l. 4535--><p class="indent" > The other arguments, ⟨<span
+ id="dx1-74032"></a> is used).
+</p><!--l. 4643--><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
@@ -10145,26 +10584,26 @@
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-73033"></a>.
-</p><!--l. 4540--><p class="indent" > <div class="important" title="Important Note"> Redefining <span
+ id="dx1-74033"></a>.
+</p><!--l. 4648--><p class="indent" > <div class="important" title="Important Note"> Redefining <span
class="cmtt-10">\glsprestandardsort </span>won’t affect any entries that have already been defined and will have no
effect at all if you are using <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-73034"></a> or <span
+ id="dx1-74034"></a> or <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-73035"></a>. </div>
-</p><!--l. 4544--><p class="noindent" >
+ id="dx1-74035"></a>. </div>
+</p><!--l. 4652--><p class="noindent" >
<a
id="ex:diffsorts"></a>
-</p><!--l. 4546--><p class="noindent" ><span
+</p><!--l. 4654--><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-73037"></a>
-</p><!--l. 4547--><p class="indent" > Suppose I have three glossaries: <span
+ id="x1-74037"></a>
+</p><!--l. 4655--><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
@@ -10173,22 +10612,22 @@
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. 4553--><p class="indent" > For <a
+</p><!--l. 4661--><p class="indent" > For <a
href="#option1">Option 1</a>, the <span
class="cmtt-10">sort</span><a
- id="dx1-73038"></a> option can be used in <span
+ id="dx1-74038"></a> option can be used in <span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-73039"></a>:
+ id="dx1-74039"></a>:
</p>
- <div class="verbatim" id="verbatim-89">
+ <pre class="verbatim" id="verbatim-93">
\printnoidxglossary[sort=word]
- <br />\printnoidxglossary[type=acronym,sort=word]
- <br />\printnoidxglossary[type=notation,sort=def]
-</div>
-<!--l. 4559--><p class="nopar" >
-</p><!--l. 4561--><p class="indent" > For Options <a
+\printnoidxglossary[type=acronym,sort=word]
+\printnoidxglossary[type=notation,sort=def]
+</pre>
+<!--l. 4667--><p class="nopar" >
+</p><!--l. 4669--><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
@@ -10196,7 +10635,7 @@
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">standard</span><a
- id="dx1-73040"></a>), and I can either define all my <span
+ id="dx1-74040"></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
@@ -10209,52 +10648,52 @@
⟨<span
class="cmti-10">type</span>⟩ is <span
class="cmtt-10">notation</span>.
-</p><!--l. 4571--><p class="indent" > The first option can be achieved as follows:
+</p><!--l. 4679--><p class="indent" > The first option can be achieved as follows:
</p>
- <div class="verbatim" id="verbatim-90">
+ <pre class="verbatim" id="verbatim-94">
\newcounter{sortcount}
- <br />\renewcommand{\glsprestandardsort}[3]{%
- <br />  \stepcounter{sortcount}%
- <br />  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
- <br />}
-</div>
-<!--l. 4579--><p class="nopar" > The second option can be achieved as follows:
+\renewcommand{\glsprestandardsort}[3]{%
+  \stepcounter{sortcount}%
+  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
+}
+</pre>
+<!--l. 4687--><p class="nopar" > The second option can be achieved as follows:
</p>
- <div class="verbatim" id="verbatim-91">
+ <pre class="verbatim" id="verbatim-95">
\newcounter{sortcount}
- <br />\renewcommand{\glsprestandardsort}[3]{%
- <br />  \ifdefstring{#2}{notation}%
- <br />  {%
- <br />     \stepcounter{sortcount}%
- <br />     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
- <br />  }%
- <br />  {%
- <br />     \glsdosanitizesort
- <br />  }%
- <br />}
-</div>
-<!--l. 4594--><p class="nopar" > (<span
+\renewcommand{\glsprestandardsort}[3]{%
+  \ifdefstring{#2}{notation}%
+  {%
+     \stepcounter{sortcount}%
+     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
+  }%
+  {%
+     \glsdosanitizesort
+  }%
+}
+</pre>
+<!--l. 4702--><p class="nopar" > (<span
class="cmtt-10">\ifdefstring </span>is defined by the <span
class="cmss-10">etoolbox</span><a
- id="dx1-73041"></a> package.) For a complete document, see the sample file
+ id="dx1-74041"></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. 4597--><p class="noindent" >
-</p><!--l. 4597--><p class="noindent" >____________________________</p></div>
+<!--l. 4705--><p class="noindent" >
+</p><!--l. 4705--><p class="noindent" >____________________________</p></div>
<a
id="ex:customsort"></a>
-<!--l. 4599--><p class="noindent" ><span
+<!--l. 4707--><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-73043"></a>
-</p><!--l. 4600--><p class="indent" > Suppose you want a glossary of people and you want the names listed as ⟨<span
+ id="x1-74043"></a>
+</p><!--l. 4708--><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
@@ -10267,28 +10706,28 @@
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-73044"></a> key when you define the entry, but
+ id="dx1-74044"></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. 4609--><p class="indent" > First, define two commands to set the person’s name:
+</p><!--l. 4717--><p class="indent" > First, define two commands to set the person’s name:
</p>
- <div class="verbatim" id="verbatim-92">
+ <pre class="verbatim" id="verbatim-96">
\newcommand{\sortname}[2]{#2, #1}
- <br />\newcommand{\textname}[2]{#1 #2}
-</div>
-<!--l. 4613--><p class="nopar" > and <span
+\newcommand{\textname}[2]{#1 #2}
+</pre>
+<!--l. 4721--><p class="nopar" > and <span
class="cmtt-10">\name </span>needs to be initialised to <span
class="cmtt-10">\textname</span>:
</p>
- <div class="verbatim" id="verbatim-93">
+ <pre class="verbatim" id="verbatim-97">
\let\name\textname
-</div>
-<!--l. 4617--><p class="nopar" > Now redefine <span
+</pre>
+<!--l. 4725--><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
@@ -10301,153 +10740,153 @@
</p>
- <div class="verbatim" id="verbatim-94">
+ <pre class="verbatim" id="verbatim-98">
\renewcommand{\glsprestandardsort}[3]{%
- <br /> \let\name\sortname
- <br /> \edef#1{\expandafter\expandonce\expandafter{#1}}%
- <br /> \let\name\textname
- <br /> \glsdosanitizesort
- <br />}
-</div>
-<!--l. 4629--><p class="nopar" > (The somewhat complicate use of <span
+ \let\name\sortname
+ \edef#1{\expandafter\expandonce\expandafter{#1}}%
+ \let\name\textname
+ \glsdosanitizesort
+}
+</pre>
+<!--l. 4737--><p class="nopar" > (The somewhat complicate use of <span
class="cmtt-10">\expandafter </span>etc helps to protect fragile commands, but care is still
needed.)
-</p><!--l. 4633--><p class="indent" > Now the entries can be defined:
+</p><!--l. 4741--><p class="indent" > Now the entries can be defined:
</p>
- <div class="verbatim" id="verbatim-95">
+ <pre class="verbatim" id="verbatim-99">
\newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},
- <br />  description={some information about Joe Bloggs}}
- <br />\newglossaryentry{johnsmith}{name={\name{John}{Smith}},
- <br />  description={some information about John Smith}}
-</div>
-<!--l. 4640--><p class="nopar" > For a complete document, see the sample file <a
+  description={some information about Joe Bloggs}}
+\newglossaryentry{johnsmith}{name={\name{John}{Smith}},
+  description={some information about John Smith}}
+</pre>
+<!--l. 4748--><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. 4642--><p class="noindent" >
-</p><!--l. 4642--><p class="noindent" >____________________________</p></div>
-<!--l. 4644--><p class="noindent" >
+<!--l. 4750--><p class="noindent" >
+</p><!--l. 4750--><p class="noindent" >____________________________</p></div>
+<!--l. 4752--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-740002.5"></a><a
+ id="x1-750002.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. 4644--><p class="noindent" >This may take two values: <span
+<!--l. 4752--><p class="noindent" >This may take two values: <span
class="cmss-10">word</span><a
- id="dx1-74001"></a> or <span
+ id="dx1-75001"></a> or <span
class="cmss-10">letter</span><a
- id="dx1-74002"></a>. The default is word ordering.
-</p><!--l. 4648--><p class="indent" > <div class="important" title="Important Note"> Note that with Options <a
+ id="dx1-75002"></a>. The default is word ordering.
+</p><!--l. 4756--><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-74003"></a> option has no effect if you don’t use <a
+ id="dx1-75003"></a> option has no effect if you don’t use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-74004"></a></a>.
+ id="dx1-75004"></a></a>.
</div>
-</p><!--l. 4651--><p class="noindent" >
-</p><!--l. 4653--><p class="indent" > If you use <a
+</p><!--l. 4759--><p class="noindent" >
+</p><!--l. 4761--><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-74005"></a><span
+ id="dx1-75005"></a><span
class="cmtt-10">=standard </span>in the optional argument of
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-74006"></a>:
+ id="dx1-75006"></a>:
</p>
- <div class="verbatim" id="verbatim-96">
+ <pre class="verbatim" id="verbatim-100">
\printnoidxglossary[sort=standard]
-</div>
-<!--l. 4658--><p class="nopar" > Alternatively, you can specify the order for individual glossaries:
+</pre>
+<!--l. 4766--><p class="nopar" > Alternatively, you can specify the order for individual glossaries:
</p>
- <div class="verbatim" id="verbatim-97">
+ <pre class="verbatim" id="verbatim-101">
\printnoidxglossary[sort=word]
- <br />\printnoidxglossary[type=acronym,sort=letter]
-</div>
-<!--l. 4663--><p class="nopar" >
-</p><!--l. 4665--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> With <a
+\printnoidxglossary[type=acronym,sort=letter]
+</pre>
+<!--l. 4771--><p class="nopar" >
+</p><!--l. 4773--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> With <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-74007"></a></a>, use the <span id="textcolor233"><span
+ id="dx1-75007"></a></a>, use the <span id="textcolor238"><span
class="cmtt-10">break-at</span></span><a
- id="dx1-74008"></a> option in <span id="textcolor234"><span
+ id="dx1-75008"></a> option in <span id="textcolor239"><span
class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-74009"></a> instead of <span
+ id="dx1-75009"></a> instead of <span
class="cmss-10">order</span>. </div>
-</p><!--l. 4668--><p class="noindent" >
-</p><!--l. 4670--><p class="noindent" >
+</p><!--l. 4776--><p class="noindent" >
+</p><!--l. 4778--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-750002.5"></a><a
+ id="x1-760002.5"></a><a
id="pkgopt:makeindex"></a><span
class="cmss-10">makeindex</span></h4>
-<!--l. 4670--><p class="noindent" >(<a
+<!--l. 4778--><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-75001"></a></a> format. If you use
+ id="dx1-76001"></a></a> format. If you use
<a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-75002"></a></a>, it will automatically detect that it needs to call <span
+ id="dx1-76002"></a></a>, it will automatically detect that it needs to call <span
class="cmtt-10">makeindex</span><a
- id="dx1-75003"></a>. If you don’t use <span
+ id="dx1-76003"></a>. If you don’t use <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-75004"></a>,
+ id="dx1-76004"></a>,
you need to remember to use <span
class="cmtt-10">makeindex</span><a
- id="dx1-75005"></a> not <a
+ id="dx1-76005"></a> not <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-75006"></a></a>. The indexing style file will been given a <span
+ id="dx1-76006"></a></a>. The indexing style file will been given a <span
class="cmtt-10">ist</span><a
- id="dx1-75007"></a>
+ id="dx1-76007"></a>
extension.
-</p><!--l. 4678--><p class="indent" > You may omit this package option if you are using <a
+</p><!--l. 4786--><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-75008"></a> in the package option list.
-</p><!--l. 4682--><p class="noindent" >
+ id="dx1-76008"></a> in the package option list.
+</p><!--l. 4790--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-760002.5"></a><a
+ id="x1-770002.5"></a><a
id="pkgopt:xindy"></a><span
class="cmss-10">xindy</span></h4>
-<!--l. 4682--><p class="noindent" >(<a
+<!--l. 4790--><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-76001"></a></a> format. If you use
+ id="dx1-77001"></a></a> format. If you use
<a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-76002"></a></a>, it will automatically detect that it needs to call <span
+ id="dx1-77002"></a></a>, it will automatically detect that it needs to call <span
class="cmtt-10">xindy</span><a
- id="dx1-76003"></a>. If you don’t use <span
+ id="dx1-77003"></a>. If you don’t use <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-76004"></a>,
+ id="dx1-77004"></a>,
you need to remember to use <span
class="cmtt-10">xindy</span><a
- id="dx1-76005"></a> not <a
+ id="dx1-77005"></a> not <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-76006"></a></a>. The indexing style file will been given a <span
+ id="dx1-77006"></a></a>. The indexing style file will been given a <span
class="cmtt-10">xdy</span><a
- id="dx1-76007"></a>
+ id="dx1-77007"></a>
extension.
-</p><!--l. 4689--><p class="indent" > This package option may additionally have a value that is a ⟨<span
+</p><!--l. 4797--><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:
@@ -10454,68 +10893,70 @@
</p>
- <div class="verbatim" id="verbatim-98">
+ <pre class="verbatim" id="verbatim-102">
\usepackage[xindy={language=english,codepage=utf8}]
- <br />  {glossaries}
-</div>
-<!--l. 4695--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to true, but can be
+  {glossaries}
+</pre>
+<!--l. 4803--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to true, but can be
suppressed. For example:
</p>
- <div class="verbatim" id="verbatim-99">
+ <pre class="verbatim" id="verbatim-103">
\usepackage[xindy={glsnumbers=false}]{glossaries}
-</div>
-<!--l. 4700--><p class="nopar" > If no value is supplied to this package option (either simply writing <span
+</pre>
+<!--l. 4808--><p class="nopar" > If no value is supplied to this package option (either simply writing <span
class="cmtt-10">xindy </span>or writing <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">xindy={}</span></span></span>) then the
language, codepage and number group settings are unchanged. See <a
-href="#sec:xindy">§11 </a><a
-href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on
-using <a
+href="#sec:xindy">§<span
+class="cmbx-10">??</span>sec:xindy </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-76008"></a></a> with the <span
+ id="dx1-77008"></a></a> with the <span
class="cmss-10">glossaries </span>package.
-</p><!--l. 4707--><p class="noindent" >
+</p><!--l. 4815--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-770002.5"></a><a
+ id="x1-780002.5"></a><a
id="pkgopt:xindygloss"></a><span
class="cmss-10">xindygloss</span></h4>
-<!--l. 4707--><p class="noindent" >(<a
+<!--l. 4815--><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-77001"></a> option without any value supplied) and may be
+ id="dx1-78001"></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-77002"></a> and
+ id="dx1-78002"></a> and
<span
class="cmtt-10">\GlsSetXdyCodePage</span><a
- id="dx1-77003"></a> (see <a
-href="#sec:langenc">§11.1 </a><a
+ id="dx1-78003"></a> (see <a
+href="#sec:langenc">§<span
+class="cmbx-10">??</span>sec:langenc </a><a
href="#sec:langenc">Language and Encodings<!--tex4ht:ref: sec:langenc --></a>.)
-</p><!--l. 4713--><p class="noindent" >
+</p><!--l. 4821--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-780002.5"></a><a
+ id="x1-790002.5"></a><a
id="pkgopt:xindynoglsnumbers"></a><span
class="cmss-10">xindynoglsnumbers</span></h4>
-<!--l. 4713--><p class="noindent" >(<a
+<!--l. 4821--><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. 4717--><p class="noindent" >
+</p><!--l. 4825--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-790002.5"></a><a
+ id="x1-800002.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. 4717--><p class="noindent" >This is option was introduced to version 4.08 as a boolean option. As from version 4.42 it may now take three
+<!--l. 4825--><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
@@ -10525,36 +10966,36 @@
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-79001"></a> will attempt to run <a
+ id="dx1-80001"></a> will attempt to run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-79002"></a></a> or <a
+ id="dx1-80002"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-79003"></a></a> using TeX’s <span
+ id="dx1-80003"></a></a> using TeX’s <span
class="cmtt-10">\write18</span><a
- id="dx1-79004"></a> mechanism
+ id="dx1-80004"></a> mechanism
at the end of the document. The option <span
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">immediate</span><a
- id="dx1-79005"></a> will attempt to run <a
+ id="dx1-80005"></a> will attempt to run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-79006"></a></a> or
+ id="dx1-80006"></a></a> or
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-79007"></a></a> at the start of <span
+ id="dx1-80007"></a></a> at the start of <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-79008"></a> using <span
+ id="dx1-80008"></a> using <span
class="cmtt-10">\immediate </span>(before the glossary files have been
opened).
-</p><!--l. 4728--><p class="indent" > In the case of <span
+</p><!--l. 4836--><p class="indent" > In the case of <span
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-79009"></a>, the associated files are created at the end of the document ready
+ id="dx1-80009"></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
@@ -10566,50 +11007,50 @@
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">immediate</span><a
- id="dx1-79010"></a>
+ id="dx1-80010"></a>
instead.
-</p><!--l. 4738--><p class="indent" > With <span
+</p><!--l. 4846--><p class="indent" > With <span
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">immediate</span><a
- id="dx1-79011"></a>, you will get a warning on the first LaTeX run as the associated glossary files
+ id="dx1-80011"></a>, you will get a warning on the first LaTeX run as the associated glossary files
don’t exist yet.
-</p><!--l. 4742--><p class="indent" > Since this mechanism can be a security risk, some TeX distributions disable it completely, in which case this
+</p><!--l. 4850--><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. 4748--><p class="indent" > Some distributions allow <span
+</p><!--l. 4856--><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-79012"></a></a> but may not include <a
+ id="dx1-80012"></a></a> but may not include <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-79013"></a></a>. So if you have the restricted mode
+ id="dx1-80013"></a></a>. So if you have the restricted mode
on, <span
class="cmss-10">automake</span><a
- id="dx1-79014"></a> should work with <span
+ id="dx1-80014"></a> should work with <span
class="cmtt-10">makeindex</span><a
- id="dx1-79015"></a> but may not work with <a
+ id="dx1-80015"></a> but may not work with <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-79016"></a></a>.
-</p><!--l. 4754--><p class="indent" > However even in unrestricted mode this option may not work with <span
+ id="dx1-80016"></a></a>.
+</p><!--l. 4862--><p class="indent" > However even in unrestricted mode this option may not work with <span
class="cmtt-10">xindy</span><a
- id="dx1-79017"></a> as <span
+ id="dx1-80017"></a> as <span
class="cmtt-10">xindy</span><a
- id="dx1-79018"></a> uses language names that
+ id="dx1-80018"></a> uses language names that
don’t always correspond with <span
-class="cmtt-10">\babel</span><a
- id="dx1-79019"></a>’s language names. (The <a
+class="cmss-10">babel</span><a
+ id="dx1-80019"></a>’s language names. (The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-79020"></a></a> script applies mappings to assist
+ id="dx1-80020"></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. 4761--><p class="indent" > Since this package option attempts to run the <a
+</p><!--l. 4869--><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
@@ -10616,53 +11057,54 @@
class="cmss-10">automake</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-79021"></a>.
-</p><!--l. 4767--><p class="noindent" >
+ id="dx1-80021"></a>.
+</p><!--l. 4875--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-800002.5"></a><a
+ id="x1-810002.5"></a><a
id="pkgopt:disablemakegloss"></a><span
class="cmss-10">disablemakegloss</span></h4>
-<!--l. 4767--><p class="noindent" >This valueless option indicates that <span
+<!--l. 4875--><p class="noindent" >This valueless option indicates that <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-80001"></a> and <span
+ id="dx1-81001"></a> and <span
class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-80002"></a> should be disabled. This
-option is provided in the event that you have to use a class or package that disregards the advice in <a
-href="#sec:indexingoptions">§1.1 </a><a
-href="#sec:indexingoptions">Indexing
-Options<!--tex4ht:ref: sec:indexingoptions --></a> and automatically performs <span
+ id="dx1-81002"></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">??</span>sec:indexingoptions </a><a
+href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> and automatically performs <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-80003"></a> or <span
+ id="dx1-81003"></a> or
+<span
class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-80004"></a> but you don’t want this. (For
-example, you want to use a different indexing method or you want to disable indexing while working on a draft
-document.)
-</p><!--l. 4777--><p class="indent" > This option may be passed in the standard document class option list or passed using <span
+ id="dx1-81004"></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. 4885--><p class="indent" > This option may be passed in the standard document class option list or passed using <span
class="cmtt-10">\PassOptionsToPackage</span>
before <span
class="cmss-10">glossaries</span><a
- id="dx1-80005"></a> is loaded. Note that this does nothing if <span
+ id="dx1-81005"></a> is loaded. Note that this does nothing if <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-80006"></a> or <span
+ id="dx1-81006"></a> or <span
class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-80007"></a> has
+ id="dx1-81007"></a> has
already been used whilst enabled.
-</p><!--l. 4783--><p class="noindent" >
+</p><!--l. 4891--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-810002.5"></a><a
+ id="x1-820002.5"></a><a
id="pkgopt:restoremakegloss"></a><span
class="cmss-10">restoremakegloss</span></h4>
-<!--l. 4783--><p class="noindent" >Cancels the effect of <span
+<!--l. 4891--><p class="noindent" >Cancels the effect of <span
class="cmss-10">disablemakegloss</span><a
- id="dx1-81001"></a>. This option may be used in <span
+ id="dx1-82001"></a>. This option may be used in <span
class="cmtt-10">\setupglossaries</span>. It issues a
warning if <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-81002"></a> or <span
+ id="dx1-82002"></a> or <span
class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-81003"></a> has already been used whilst enabled. For
+ id="dx1-82003"></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
@@ -10673,34 +11115,34 @@
</p>
- <div class="verbatim" id="verbatim-100">
+ <pre class="verbatim" id="verbatim-104">
\documentclass[disablemakegloss]{customclass}
- <br />\newglossary*{functions}{Functions}
- <br />\setupglossaries{restoremakegloss}
- <br />\makeglossaries
-</div>
-<!--l. 4796--><p class="nopar" > or
+\newglossary*{functions}{Functions}
+\setupglossaries{restoremakegloss}
+\makeglossaries
+</pre>
+<!--l. 4904--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-101">
+ <pre class="verbatim" id="verbatim-105">
\PassOptionsToPackage{disablemakegloss}{glossaries}
- <br />\documentclass{customclass}
- <br />\newglossary*{functions}{Functions}
- <br />\setupglossaries{restoremakegloss}
- <br />\makeglossaries
-</div>
-<!--l. 4804--><p class="nopar" >
-</p><!--l. 4806--><p class="indent" > Note that restoring these commands doesn’t necessarily mean that they can be used. It just means that their
-normal behaviour given the current settings will apply. For example, if you use the <span id="textcolor235"><span
+\documentclass{customclass}
+\newglossary*{functions}{Functions}
+\setupglossaries{restoremakegloss}
+\makeglossaries
+</pre>
+<!--l. 4912--><p class="nopar" >
+</p><!--l. 4914--><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-81004"></a> or <span id="textcolor236"><span
+ id="dx1-82004"></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-81005"></a>
+ id="dx1-82005"></a>
options with <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> then you can’t use <span
@@ -10708,86 +11150,90 @@
class="cmtt-10">\makenoidxglossaries </span>regardless of
<span
class="cmss-10">restoremakegloss</span><a
- id="dx1-81006"></a>.
-</p><!--l. 4813--><p class="noindent" >
+ id="dx1-82006"></a>.
+</p><!--l. 4921--><p class="noindent" >
</p>
-<!--l. 4813--><p class="noindent" ><a
+<!--l. 4921--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.6 </span> <a
id="sec:pkgopts-type"></a>Glossary Type Options</h3>
-<!--l. 4816--><p class="noindent" >
+<!--l. 4924--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-830002.6"></a><a
+ id="x1-840002.6"></a><a
id="pkgopt:nohypertypes"></a><span
class="cmss-10">nohypertypes=</span><span
class="cmtt-10">{</span>⟨<span
class="cmssi-10">list</span>⟩<span
class="cmtt-10">}</span></h4>
-<!--l. 4816--><p class="noindent" >Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular
+<!--l. 4924--><p class="noindent" >Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular
glossary or glossaries. The value of this option should be a comma-separated list of glossary types where <span
class="cmtt-10">\gls</span><a
- id="dx1-83001"></a>
+ id="dx1-84001"></a>
etc shouldn’t have hyperlinks by default. Make sure you enclose the value in braces if it contains any commas.
Example:
</p>
- <div class="verbatim" id="verbatim-102">
+ <pre class="verbatim" id="verbatim-106">
\usepackage[acronym,nohypertypes={acronym,notation}]
- <br />  {glossaries}
- <br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
-</div>
-<!--l. 4826--><p class="nopar" > The values must be fully expanded, so <strong>don’t</strong> try <span
+  {glossaries}
+\newglossary[nlg]{notation}{not}{ntn}{Notation}
+</pre>
+<!--l. 4934--><p class="nopar" > The values must be fully expanded, so <strong>don’t</strong> try <span
class="cmtt-10">nohypertypes=\acronymtype</span><a
- id="dx1-83002"></a>. You may also
+ id="dx1-84002"></a>. You may also
use
-</p><!--l. 4830--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 4938--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-83003"></a><span
+ id="dx1-84003"></a><span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4831--><p class="noindent" >
+</p><!--l. 4939--><p class="noindent" >
instead or additionally. See <a
-href="#sec:glslink">§6 </a><a
+href="#sec:glslink">§<span
+class="cmbx-10">??</span>sec:glslink </a><a
href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details.
-</p><!--l. 4835--><p class="noindent" >
+</p><!--l. 4943--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-840002.6"></a><a
+ id="x1-850002.6"></a><a
id="pkgopt:nomain"></a><span
class="cmss-10">nomain</span></h4>
-<!--l. 4835--><p class="noindent" >This suppresses the creation of the main glossary and associated <span
+<!--l. 4943--><p class="noindent" >This suppresses the creation of the main glossary and associated <span
class="cmtt-10">glo</span><a
- id="dx1-84001"></a> file, if unrequired. Note that if you use this
+ id="dx1-85001"></a> file, if unrequired. Note that if you use this
option, you must create another glossary in which to put all your entries (either via the <span
class="cmss-10">acronym</span><a
- id="dx1-84002"></a> (or <span
+ id="dx1-85002"></a> (or <span
class="cmss-10">acronyms</span><a
- id="dx1-84003"></a>)
+ id="dx1-85003"></a>)
package option described in <a
-href="#sec:pkgopts-acronym">§2.7 </a><a
+href="#sec:pkgopts-acronym">§<span
+class="cmbx-10">??</span>sec:pkgopts-acronym </a><a
href="#sec:pkgopts-acronym">Acronym and Abbreviation Options<!--tex4ht:ref: sec:pkgopts-acronym --></a> or via the <span
class="cmss-10">symbols</span><a
- id="dx1-84004"></a>, <span
+ id="dx1-85004"></a>,
+<span
class="cmss-10">numbers</span><a
- id="dx1-84005"></a> or
-<span
+ id="dx1-85005"></a> or <span
class="cmss-10">index</span><a
- id="dx1-84006"></a> options described in <a
-href="#sec:pkgopts-other">§2.8 </a><a
+ id="dx1-85006"></a> options described in <a
+href="#sec:pkgopts-other">§<span
+class="cmbx-10">??</span>sec:pkgopts-other </a><a
href="#sec:pkgopts-other">Other Options<!--tex4ht:ref: sec:pkgopts-other --></a> or via <span
class="cmtt-10">\newglossary</span><a
- id="dx1-84007"></a> described in <a
-href="#sec:newglossary">§12 </a><a
-href="#sec:newglossary">Defining New
-Glossaries<!--tex4ht:ref: sec:newglossary --></a>).
-</p><!--l. 4845--><p class="indent" > <div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a
+ id="dx1-85007"></a> described in
+<a
+href="#sec:newglossary">§<span
+class="cmbx-10">??</span>sec:newglossary </a><a
+href="#sec:newglossary">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>).
+</p><!--l. 4953--><p class="indent" > <div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-84008"></a></a> will produce a warning.
+ id="dx1-85008"></a></a> will produce a warning.
</div>
-</p><!--l. 4848--><p class="noindent" >
+</p><!--l. 4956--><p class="noindent" >
</p><div class="alltt">
<div class="obeylines-v">
<span
@@ -10830,153 +11276,153 @@
</div> If you did actually want to use the main glossary and you see this warning, check that you have referenced the
entries in that glossary via commands such as <span
class="cmtt-10">\gls</span><a
- id="dx1-84009"></a>.
-<!--l. 4860--><p class="noindent" >
+ id="dx1-85009"></a>.
+<!--l. 4968--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-850002.6"></a><a
+ id="x1-860002.6"></a><a
id="pkgopt:symbols"></a><span
class="cmss-10">symbols</span></h4>
-<!--l. 4860--><p class="noindent" >This valueless option defines a new glossary type with the label <span
+<!--l. 4968--><p class="noindent" >This valueless option defines a new glossary type with the label <span
class="cmtt-10">symbols </span>via
</p>
- <div class="verbatim" id="verbatim-103">
+ <pre class="verbatim" id="verbatim-107">
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-</div>
-<!--l. 4864--><p class="nopar" > It also defines
-</p><!--l. 4866--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-85001"></a> <span
+</pre>
+<!--l. 4972--><p class="nopar" > It also defines
+</p><!--l. 4974--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-86001"></a> <span
class="cmtt-10">\printsymbols[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 4868--><p class="noindent" >
+</p><!--l. 4976--><p class="noindent" >
which is a synonym for </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-85002"></a><span
+ id="dx1-86002"></a><span
class="cmtt-10">[type=symbols,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
-<!--l. 4874--><p class="indent" > If you use <a
+<!--l. 4982--><p class="indent" > If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-85003"></a><span
+ id="dx1-86003"></a><span
class="cmtt-10">[type=symbols,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> to display the list of symbols.
-<!--l. 4880--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
+<!--l. 4988--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-85004"></a> package option if you’re only interested in using this <span
+ id="dx1-86004"></a> package option if you’re only interested in using this <span
class="cmtt-10">symbols </span>glossary and
don’t intend to use the <span
class="cmtt-10">main </span>glossary. </div>
-</p><!--l. 4884--><p class="noindent" >
-</p><!--l. 4886--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 4992--><p class="noindent" >
+</p><!--l. 4994--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> package has a slightly modified version of this option which additionally provides
-<span id="textcolor237"><span
+<span id="textcolor242"><span
class="cmtt-10">\glsxtrnewsymbol</span></span><a
- id="dx1-85005"></a> as a convenient shortcut method for defining symbols. See the <a
+ id="dx1-86005"></a> as a convenient shortcut method for defining symbols. See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for
further details. </div>
-</p><!--l. 4891--><p class="noindent" >
-</p><!--l. 4893--><p class="noindent" >
+</p><!--l. 4999--><p class="noindent" >
+</p><!--l. 5001--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-860002.6"></a><a
+ id="x1-870002.6"></a><a
id="pkgopt:numbers"></a><span
class="cmss-10">numbers</span></h4>
-<!--l. 4893--><p class="noindent" >This valueless option defines a new glossary type with the label <span
+<!--l. 5001--><p class="noindent" >This valueless option defines a new glossary type with the label <span
class="cmtt-10">numbers </span>via
</p>
- <div class="verbatim" id="verbatim-104">
+ <pre class="verbatim" id="verbatim-108">
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
-</div>
-<!--l. 4897--><p class="nopar" > It also defines
-</p><!--l. 4899--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-86001"></a> <span
+</pre>
+<!--l. 5005--><p class="nopar" > It also defines
+</p><!--l. 5007--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-87001"></a> <span
class="cmtt-10">\printnumbers[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 4901--><p class="noindent" >
+</p><!--l. 5009--><p class="noindent" >
which is a synonym for </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-86002"></a><span
+ id="dx1-87002"></a><span
class="cmtt-10">[type=numbers,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
-<!--l. 4907--><p class="indent" > If you use <a
+<!--l. 5015--><p class="indent" > If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-86003"></a><span
+ id="dx1-87003"></a><span
class="cmtt-10">[type=numbers,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> to display the list of numbers.
-<!--l. 4913--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
+<!--l. 5021--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-86004"></a> package option if you’re only interested in using this <span
+ id="dx1-87004"></a> package option if you’re only interested in using this <span
class="cmtt-10">numbers </span>glossary and
don’t intend to use the <span
class="cmtt-10">main </span>glossary. </div>
-</p><!--l. 4917--><p class="noindent" >
-</p><!--l. 4919--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 5025--><p class="noindent" >
+</p><!--l. 5027--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> package has a slightly modified version of this option which additionally provides
-<span id="textcolor238"><span
+<span id="textcolor243"><span
class="cmtt-10">\glsxtrnewnumber</span></span><a
- id="dx1-86005"></a> as a convenient shortcut method for defining numbers. See the <a
+ id="dx1-87005"></a> as a convenient shortcut method for defining numbers. See the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for
further details. </div>
-</p><!--l. 4924--><p class="noindent" >
-</p><!--l. 4926--><p class="noindent" >
+</p><!--l. 5032--><p class="noindent" >
+</p><!--l. 5034--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-870002.6"></a><a
+ id="x1-880002.6"></a><a
id="pkgopt:index"></a><span
class="cmss-10">index</span></h4>
-<!--l. 4926--><p class="noindent" >This valueless option defines a new glossary type with the label <span
+<!--l. 5034--><p class="noindent" >This valueless option defines a new glossary type with the label <span
class="cmtt-10">index </span>via
</p>
- <div class="verbatim" id="verbatim-105">
+ <pre class="verbatim" id="verbatim-109">
\newglossary[ilg]{index}{ind}{idx}{\indexname}%
-</div>
-<!--l. 4930--><p class="nopar" > It also defines
-</p><!--l. 4932--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-87001"></a> <span
+</pre>
+<!--l. 5038--><p class="nopar" > It also defines
+</p><!--l. 5040--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-88001"></a> <span
class="cmtt-10">\newterm[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]{</span>⟨<span
class="cmitt-10">term</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4934--><p class="noindent" >
+</p><!--l. 5042--><p class="noindent" >
which is a synonym for </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-87002"></a><span
+ id="dx1-88002"></a><span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">term</span>⟩<span
class="cmtt-10">}[type=index,name={</span>⟨<span
@@ -10984,126 +11430,126 @@
class="cmtt-10">},%</span>
<br /><span
class="cmtt-10">description=\nopostdesc</span><a
- id="dx1-87003"></a><span
+ id="dx1-88003"></a><span
class="cmtt-10">,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> and
-<!--l. 4941--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-87004"></a> <span
+<!--l. 5049--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-88004"></a> <span
class="cmtt-10">\printindex[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 4943--><p class="noindent" >
+</p><!--l. 5051--><p class="noindent" >
which is a synonym for </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-87005"></a><span
+ id="dx1-88005"></a><span
class="cmtt-10">[type=index,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
-<!--l. 4949--><p class="indent" > If you use <a
+<!--l. 5057--><p class="indent" > If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-87006"></a><span
+ id="dx1-88006"></a><span
class="cmtt-10">[type=index,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> to display this glossary.
-<!--l. 4955--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
+<!--l. 5063--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-87007"></a> package option if you’re only interested in using this <span
+ id="dx1-88007"></a> package option if you’re only interested in using this <span
class="cmtt-10">index </span>glossary and
don’t intend to use the <span
class="cmtt-10">main </span>glossary. Note that you can’t mix this option with <span
class="cmtt-10">\index</span><a
- id="dx1-87008"></a>. Either use
+ id="dx1-88008"></a>. Either use
<span
class="cmss-10">glossaries </span>for the indexing or use a custom indexing package, such as <span
class="cmss-10">makeidx</span><a
- id="dx1-87009"></a>, <span
+ id="dx1-88009"></a>, <span
class="cmss-10">index</span><a
- id="dx1-87010"></a> or <span
+ id="dx1-88010"></a> or <span
class="cmss-10">imakeidx</span><a
- id="dx1-87011"></a>. (You
+ id="dx1-88011"></a>. (You
can, of course, load one of those packages and load <span
class="cmss-10">glossaries </span>without the <span
class="cmss-10">index</span><a
- id="dx1-87012"></a> package option.)
+ id="dx1-88012"></a> package option.)
</div>
-</p><!--l. 4964--><p class="noindent" >
-</p><!--l. 4966--><p class="indent" > Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for
+</p><!--l. 5072--><p class="noindent" >
+</p><!--l. 5074--><p class="indent" > Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for
this glossary using the package option <span
class="cmss-10">nohypertypes</span><span
class="cmtt-10">=</span><span
class="cmss-10">index</span><a
- id="dx1-87013"></a> or the command <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-88013"></a> or the command <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-87014"></a><span class="verb"><span
+ id="dx1-88014"></a><span class="verb"><span
class="cmtt-10">{index}</span></span>
<br /><spacer type=vertical size=10></span>
-</p><!--l. 4973--><p class="indent" > The example file <a
+</p><!--l. 5081--><p class="indent" > The example file <a
href="#ex:sample-index"><span
class="cmtt-10">sample-index.tex</span></a> illustrates the use of the <span
class="cmss-10">index</span><a
- id="dx1-87015"></a> package option.
+ id="dx1-88015"></a> package option.
-</p><!--l. 4976--><p class="noindent" >
+</p><!--l. 5084--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-880002.6"></a><a
+ id="x1-890002.6"></a><a
id="pkgopt:noglossaryindex"></a><span
class="cmss-10">noglossaryindex</span></h4>
-<!--l. 4976--><p class="noindent" >This valueless option switches off <span
+<!--l. 5084--><p class="noindent" >This valueless option switches off <span
class="cmss-10">index</span><a
- id="dx1-88001"></a> if <span
+ id="dx1-89001"></a> if <span
class="cmss-10">index</span><a
- id="dx1-88002"></a> has been passed implicitly (for example, through global
+ id="dx1-89002"></a> has been passed implicitly (for example, through global
document options). This option can’t be used in <span
class="cmtt-10">\setupglossaries</span>.
-</p><!--l. 4982--><p class="noindent" >
+</p><!--l. 5090--><p class="noindent" >
</p>
-<!--l. 4982--><p class="noindent" ><a
+<!--l. 5090--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.7 </span> <a
id="sec:pkgopts-acronym"></a>Acronym and Abbreviation Options</h3>
-<!--l. 4985--><p class="noindent" >
+<!--l. 5093--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-900002.7"></a><a
+ id="x1-910002.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. 4985--><p class="noindent" >If true, this creates a new glossary with the label <span
+<!--l. 5093--><p class="noindent" >If true, this creates a new glossary with the label <span
class="cmtt-10">acronym</span>. This is equivalent to:
</p>
- <div class="verbatim" id="verbatim-106">
+ <pre class="verbatim" id="verbatim-110">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-</div>
-<!--l. 4989--><p class="nopar" > It will also define
-</p><!--l. 4991--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-90001"></a> <span
+</pre>
+<!--l. 5097--><p class="nopar" > It will also define
+</p><!--l. 5099--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-91001"></a> <span
class="cmtt-10">\printacronyms[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 4993--><p class="noindent" >
+</p><!--l. 5101--><p class="noindent" >
that’s equivalent to </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-90002"></a><span
+ id="dx1-91002"></a><span
class="cmtt-10">[type=acronym,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
@@ -11111,162 +11557,162 @@
</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-90003"></a> is used).
-<!--l. 5001--><p class="indent" > If you are using <a
+ id="dx1-91003"></a> is used).
+<!--l. 5109--><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-90004"></a><span
+ id="dx1-91004"></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. 5007--><p class="indent" > If the <span
+<!--l. 5115--><p class="indent" > If the <span
class="cmss-10">acronym</span><a
- id="dx1-90005"></a> package option is used, <span
+ id="dx1-91005"></a> package option is used, <span
class="cmtt-10">\acronymtype</span><a
- id="dx1-90006"></a> is set to <span
+ id="dx1-91006"></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-90007f5"></a>
+ id="x1-91007f5"></a>
Entries that are defined using <span
class="cmtt-10">\newacronym</span><a
- id="dx1-90013"></a> are placed in the glossary whose label is given by <span
+ id="dx1-91013"></a> are placed in the glossary whose label is given by <span
class="cmtt-10">\acronymtype</span><a
- id="dx1-90014"></a>,
+ id="dx1-91014"></a>,
unless another glossary is explicitly specified.
-</p><!--l. 5017--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
+</p><!--l. 5125--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-90015"></a> package option if you’re only interested in using this <span
+ id="dx1-91015"></a> package option if you’re only interested in using this <span
class="cmtt-10">acronym </span>glossary. (That
is, you don’t intend to use the <span
class="cmtt-10">main </span>glossary.) </div>
-</p><!--l. 5021--><p class="noindent" >
-</p><!--l. 5023--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 5129--><p class="noindent" >
+</p><!--l. 5131--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> extension package comes with an analogous <span id="textcolor239"><span
+class="cmss-10">glossaries-extra</span></a> extension package comes with an analogous <span id="textcolor244"><span
class="cmss-10">abbreviations</span></span><a
- id="dx1-90016"></a> option, which creates a new
+ id="dx1-91016"></a> option, which creates a new
glossary with the label <span
-class="cmtt-10">abbreviations </span>and sets the command <span id="textcolor240"><span
+class="cmtt-10">abbreviations </span>and sets the command <span id="textcolor245"><span
class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-90017"></a> to this. If the <span
+ id="dx1-91017"></a> to this. If the <span
class="cmss-10">acronym</span><a
- id="dx1-90018"></a> option
+ id="dx1-91018"></a> option
hasn’t also been used, then <span
class="cmtt-10">\acronymtype</span><a
- id="dx1-90019"></a> will be set to <span id="textcolor241"><span
+ id="dx1-91019"></a> will be set to <span id="textcolor246"><span
class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-90020"></a>. This enables both <span
+ id="dx1-91020"></a>. This enables both <span
class="cmtt-10">\newacronym</span><a
- id="dx1-90021"></a>
-and <span id="textcolor242"><span
+ id="dx1-91021"></a>
+and <span id="textcolor247"><span
class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-90022"></a> to use the same glossary.
-</p><!--l. 5032--><p class="indent" > Make sure you have at least v1.42 of <a
+ id="dx1-91022"></a> to use the same glossary.
+</p><!--l. 5140--><p class="indent" > Make sure you have at least v1.42 of <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> if you use the <span
class="cmss-10">acronym</span><a
- id="dx1-90023"></a> (or <span
+ id="dx1-91023"></a> (or <span
class="cmss-10">acronyms</span><a
- id="dx1-90024"></a>) package option
+ id="dx1-91024"></a>) package option
with the extension package to avoid a bug that interferes with the abbreviation style. </div>
-</p><!--l. 5036--><p class="noindent" >
-</p><!--l. 5038--><p class="noindent" >
+</p><!--l. 5144--><p class="noindent" >
+</p><!--l. 5146--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-910002.7"></a><a
+ id="x1-920002.7"></a><a
id="pkgopt:acronyms"></a><span
class="cmss-10">acronyms</span></h4>
-<!--l. 5038--><p class="noindent" >This is equivalent to <span
+<!--l. 5146--><p class="noindent" >This is equivalent to <span
class="cmss-10">acronym</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-91001"></a> and may be used in the document class option list.
+ id="dx1-92001"></a> and may be used in the document class option list.
-</p><!--l. 5042--><p class="noindent" >
+</p><!--l. 5150--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-920002.7"></a><span id="textcolor243"><a
- id="pkgopt:abbreviations"></a><span id="textcolor244"><span
+ id="x1-930002.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. 5044--><p class="noindent" >This valueless option creates a new glossary type using:
+<!--l. 5152--><p class="noindent" >This valueless option creates a new glossary type using:
</p>
- <div class="verbatim" id="verbatim-107">
+ <pre class="verbatim" id="verbatim-111">
\newglossary[glg-abr]{abbreviations}{gls-abr}{glo-abr}{\abbreviationsname}
-</div>
-<!--l. 5047--><p class="nopar" > The label can be accessed with <span id="textcolor245"><span
+</pre>
+<!--l. 5155--><p class="nopar" > The label can be accessed with <span id="textcolor250"><span
class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-92001"></a>, which is analogous to <span
+ id="dx1-93001"></a>, which is analogous to <span
class="cmtt-10">\acronymtype</span>. See <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>
manual for further details.
-</p><!--l. 5052--><p class="noindent" >
+</p><!--l. 5160--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-930002.7"></a><a
+ id="x1-940002.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. 5052--><p class="noindent" >By default, only the <span
+<!--l. 5160--><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-93001"></a>. For example, if you use
+ id="dx1-94001"></a>. For example, if you use
the <span
class="cmss-10">acronym</span><a
- id="dx1-93002"></a> package option but you also want the <span
+ id="dx1-94002"></a> package option but you also want the <span
class="cmtt-10">main </span>glossary to also contain a list of acronyms, you can
do:
</p>
- <div class="verbatim" id="verbatim-108">
+ <pre class="verbatim" id="verbatim-112">
\usepackage[acronym,acronymlists={main}]{glossaries}
-</div>
-<!--l. 5060--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined
+</pre>
+<!--l. 5168--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined
yet. For example:
</p>
- <div class="verbatim" id="verbatim-109">
+ <pre class="verbatim" id="verbatim-113">
\usepackage[acronym,acronymlists={main,acronym2}]
- <br />  {glossaries}
- <br />\newglossary[alg2]{acronym2}{acr2}{acn2}%
- <br />  {Statistical Acronyms}
-</div>
-<!--l. 5068--><p class="nopar" > You can use
-</p><!--l. 5070--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-93003"></a> <span
+  {glossaries}
+\newglossary[alg2]{acronym2}{acr2}{acn2}%
+  {Statistical Acronyms}
+</pre>
+<!--l. 5176--><p class="nopar" > You can use
+</p><!--l. 5178--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-94003"></a> <span
class="cmtt-10">\DeclareAcronymList{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5072--><p class="noindent" >
+</p><!--l. 5180--><p class="noindent" >
instead of or in addition to the <span
class="cmss-10">acronymlists</span><a
- id="dx1-93004"></a> option. This will add the glossaries given in ⟨<span
+ id="dx1-94004"></a> option. This will add the glossaries given in ⟨<span
class="cmti-10">list</span>⟩ to the list of
glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list
use:
-</p><!--l. 5077--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-93005"></a> <span
+</p><!--l. 5185--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-94005"></a> <span
class="cmtt-10">\SetAcronymLists{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5079--><p class="noindent" >
-</p><!--l. 5081--><p class="indent" > You can determine if a glossary has been identified as being a list of acronyms using:
-</p><!--l. 5083--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-93006"></a> <span
+</p><!--l. 5187--><p class="noindent" >
+</p><!--l. 5189--><p class="indent" > You can determine if a glossary has been identified as being a list of acronyms using:
+</p><!--l. 5191--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-94006"></a> <span
class="cmtt-10">\glsIfListOfAcronyms{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -11274,363 +11720,367 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">false part</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5085--><p class="noindent" >
-</p><!--l. 5087--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> This option is incompatible with <a
+</p><!--l. 5193--><p class="noindent" >
+</p><!--l. 5195--><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. 5090--><p class="noindent" >
-</p><!--l. 5092--><p class="noindent" >
+class="cmss-10">glossaries-extra</span>’s</a> abbreviation mechanism.
+</div>
+</p><!--l. 5198--><p class="noindent" >
+</p><!--l. 5200--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-940002.7"></a><a
+ id="x1-950002.7"></a><a
id="pkgopt:shortcuts"></a><span
class="cmss-10">shortcuts</span></h4>
-<!--l. 5092--><p class="noindent" >This option provides shortcut commands for acronyms. See <a
-href="#sec:acronyms">§13 </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further
-details. Alternatively you can use:
-</p><!--l. 5095--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-94001"></a> <span
+<!--l. 5200--><p class="noindent" >This option provides shortcut commands for acronyms. See <a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </a><a
+href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>
+for further details. Alternatively you can use:
+</p><!--l. 5203--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-95001"></a> <span
class="cmtt-10">\DefineAcronymSynonyms </span></div><hr>
-</p><!--l. 5097--><p class="noindent" >
-</p><!--l. 5099--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
+</p><!--l. 5205--><p class="noindent" >
+</p><!--l. 5207--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> package provides additional shortcuts. </div>
-</p><!--l. 5101--><p class="noindent" >
-</p><!--l. 5103--><p class="noindent" >
+</p><!--l. 5209--><p class="noindent" >
+</p><!--l. 5211--><p class="noindent" >
</p>
-<!--l. 5103--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">2.7.1 </span> <a
- id="sec:pkgopts-old-acronym"></a>Deprecated Acronym Style Options</h4>
-<!--l. 5106--><p class="noindent" >The package options listed in this section are now deprecated but are kept for backward-compatibility. Use
+<!--l. 5211--><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. 5214--><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-95001"></a> instead. See <a
-href="#sec:acronyms">§13 </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details.
-
-
-</p><!--l. 5110--><p class="noindent" >
+ id="dx1-96001"></a> instead. See <a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </a><a
+href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further
+details.
+</p><!--l. 5218--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-960002.7.1"></a><a
+ id="x1-970002.8"></a><a
id="pkgopt:description"></a><span
class="cmss-10">description</span></h4>
-<!--l. 5110--><p class="noindent" >This option changes the definition of <span
+<!--l. 5218--><p class="noindent" >This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-96001"></a> to allow a description. This option may be replaced
+ id="dx1-97001"></a> to allow a description. This option may be replaced
by
</p>
- <div class="verbatim" id="verbatim-110">
+ <pre class="verbatim" id="verbatim-114">
\setacronymstyle{long-short-desc}
-</div>
-<!--l. 5115--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5223--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-96002"></a>)
+ id="dx1-97002"></a>)
</p>
- <div class="verbatim" id="verbatim-111">
+ <pre class="verbatim" id="verbatim-115">
\setacronymstyle{long-sc-short-desc}
-</div>
-<!--l. 5119--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5227--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-96003"></a>)
+ id="dx1-97003"></a>)
</p>
- <div class="verbatim" id="verbatim-112">
+ <pre class="verbatim" id="verbatim-116">
\setacronymstyle{long-sm-short-desc}
-</div>
-<!--l. 5123--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5231--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-96004"></a>)
+ id="dx1-97004"></a>)
</p>
- <div class="verbatim" id="verbatim-113">
+ <pre class="verbatim" id="verbatim-117">
\setacronymstyle{footnote-desc}
-</div>
-<!--l. 5127--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5235--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-96005"></a> and <span
+ id="dx1-97005"></a> and <span
class="cmss-10">smallcaps</span><a
- id="dx1-96006"></a>)
+ id="dx1-97006"></a>)
</p>
- <div class="verbatim" id="verbatim-114">
+ <pre class="verbatim" id="verbatim-118">
\setacronymstyle{footnote-sc-desc}
-</div>
-<!--l. 5131--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5239--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-96007"></a> and <span
+ id="dx1-97007"></a> and <span
class="cmss-10">smaller</span><a
- id="dx1-96008"></a>)
+ id="dx1-97008"></a>)
</p>
- <div class="verbatim" id="verbatim-115">
+ <pre class="verbatim" id="verbatim-119">
\setacronymstyle{footnote-sm-desc}
-</div>
-<!--l. 5135--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5243--><p class="nopar" > or (with <span
class="cmss-10">dua</span><a
- id="dx1-96009"></a>)
+ id="dx1-97009"></a>)
</p>
- <div class="verbatim" id="verbatim-116">
+ <pre class="verbatim" id="verbatim-120">
\setacronymstyle{dua-desc}
-</div>
-<!--l. 5139--><p class="nopar" >
-</p><!--l. 5141--><p class="noindent" >
+</pre>
+<!--l. 5247--><p class="nopar" >
+</p><!--l. 5249--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-970002.7.1"></a><a
+ id="x1-980002.8"></a><a
id="pkgopt:smallcaps"></a><span
class="cmss-10">smallcaps</span></h4>
-<!--l. 5141--><p class="noindent" >This option changes the definition of <span
+<!--l. 5249--><p class="noindent" >This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-97001"></a> and the way that acronyms are displayed. This option may
+ id="dx1-98001"></a> and the way that acronyms are displayed. This option may
be replaced by:
</p>
- <div class="verbatim" id="verbatim-117">
+ <pre class="verbatim" id="verbatim-121">
\setacronymstyle{long-sc-short}
-</div>
-<!--l. 5146--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5254--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-97002"></a>)
+ id="dx1-98002"></a>)
</p>
- <div class="verbatim" id="verbatim-118">
+ <pre class="verbatim" id="verbatim-122">
\setacronymstyle{long-sc-short-desc}
-</div>
-<!--l. 5150--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5258--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-97003"></a> and <span
+ id="dx1-98003"></a> and <span
class="cmss-10">footnote</span><a
- id="dx1-97004"></a>)
+ id="dx1-98004"></a>)
</p>
- <div class="verbatim" id="verbatim-119">
+ <pre class="verbatim" id="verbatim-123">
\setacronymstyle{footnote-sc-desc}
-</div>
-<!--l. 5154--><p class="nopar" >
-</p><!--l. 5156--><p class="noindent" >
+</pre>
+<!--l. 5262--><p class="nopar" >
+</p><!--l. 5264--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-980002.7.1"></a><a
+ id="x1-990002.8"></a><a
id="pkgopt:smaller"></a><span
class="cmss-10">smaller</span></h4>
-<!--l. 5156--><p class="noindent" >This option changes the definition of <span
+<!--l. 5264--><p class="noindent" >This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-98001"></a> and the way that acronyms are displayed.
-</p><!--l. 5158--><p class="indent" > <div class="important" title="Important Note"> If you use this option, you will need to include the <span
+ id="dx1-99001"></a> and the way that acronyms are displayed.
+</p><!--l. 5266--><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-98002"></a> package or otherwise define <span
+ id="dx1-99002"></a> package or otherwise define <span
class="cmtt-10">\textsmaller</span><a
- id="dx1-98003"></a> or
+ id="dx1-99003"></a> or
redefine <span
class="cmtt-10">\acronymfont</span><a
- id="dx1-98004"></a>. </div>
-</p><!--l. 5162--><p class="noindent" >
+ id="dx1-99004"></a>. </div>
+</p><!--l. 5270--><p class="noindent" >
This option may be replaced by:
</p>
- <div class="verbatim" id="verbatim-120">
+ <pre class="verbatim" id="verbatim-124">
\setacronymstyle{long-sm-short}
-</div>
-<!--l. 5166--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5274--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-98005"></a>)
+ id="dx1-99005"></a>)
</p>
- <div class="verbatim" id="verbatim-121">
+ <pre class="verbatim" id="verbatim-125">
\setacronymstyle{long-sm-short-desc}
-</div>
-<!--l. 5170--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5278--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-98006"></a> and <span
+ id="dx1-99006"></a> and <span
class="cmss-10">footnote</span><a
- id="dx1-98007"></a>)
+ id="dx1-99007"></a>)
</p>
- <div class="verbatim" id="verbatim-122">
+ <pre class="verbatim" id="verbatim-126">
\setacronymstyle{footnote-sm-desc}
-</div>
-<!--l. 5174--><p class="nopar" >
-</p><!--l. 5176--><p class="noindent" >
+</pre>
+<!--l. 5282--><p class="nopar" >
+</p><!--l. 5284--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-990002.7.1"></a><a
+ id="x1-1000002.8"></a><a
id="pkgopt:footnote"></a><span
class="cmss-10">footnote</span></h4>
-<!--l. 5176--><p class="noindent" >This option changes the definition of <span
+<!--l. 5284--><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
+ id="dx1-100001"></a> and the way that acronyms are displayed. This option may
be replaced by:
</p>
- <div class="verbatim" id="verbatim-123">
+ <pre class="verbatim" id="verbatim-127">
\setacronymstyle{footnote}
-</div>
-<!--l. 5181--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5289--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-99002"></a>)
+ id="dx1-100002"></a>)
</p>
- <div class="verbatim" id="verbatim-124">
+ <pre class="verbatim" id="verbatim-128">
\setacronymstyle{footnote-sc}
-</div>
-<!--l. 5185--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5293--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-99003"></a>)
+ id="dx1-100003"></a>)
</p>
- <div class="verbatim" id="verbatim-125">
+ <pre class="verbatim" id="verbatim-129">
\setacronymstyle{footnote-sm}
-</div>
-<!--l. 5189--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5297--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-99004"></a>)
+ id="dx1-100004"></a>)
</p>
- <div class="verbatim" id="verbatim-126">
+ <pre class="verbatim" id="verbatim-130">
\setacronymstyle{footnote-desc}
-</div>
-<!--l. 5193--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5301--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-99005"></a> and <span
+ id="dx1-100005"></a> and <span
class="cmss-10">description</span><a
- id="dx1-99006"></a>)
+ id="dx1-100006"></a>)
</p>
- <div class="verbatim" id="verbatim-127">
+ <pre class="verbatim" id="verbatim-131">
\setacronymstyle{footnote-sc-desc}
-</div>
-<!--l. 5197--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5305--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-99007"></a> and <span
+ id="dx1-100007"></a> and <span
class="cmss-10">description</span><a
- id="dx1-99008"></a>)
+ id="dx1-100008"></a>)
</p>
- <div class="verbatim" id="verbatim-128">
+ <pre class="verbatim" id="verbatim-132">
\setacronymstyle{footnote-sm-desc}
-</div>
-<!--l. 5201--><p class="nopar" >
-</p><!--l. 5203--><p class="noindent" >
+</pre>
+<!--l. 5309--><p class="nopar" >
+</p><!--l. 5311--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1000002.7.1"></a><a
+ id="x1-1010002.8"></a><a
id="pkgopt:dua"></a><span
class="cmss-10">dua</span></h4>
-<!--l. 5203--><p class="noindent" >This option changes the definition of <span
+<!--l. 5311--><p class="noindent" >This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-100001"></a> so that acronyms are always expanded. This option may be
+ id="dx1-101001"></a> so that acronyms are always expanded. This option may be
replaced by:
</p>
- <div class="verbatim" id="verbatim-129">
+ <pre class="verbatim" id="verbatim-133">
\setacronymstyle{dua}
-</div>
-<!--l. 5208--><p class="nopar" > or (with <span
+</pre>
+<!--l. 5316--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-100002"></a>)
+ id="dx1-101002"></a>)
</p>
- <div class="verbatim" id="verbatim-130">
+ <pre class="verbatim" id="verbatim-134">
\setacronymstyle{dua-desc}
-</div>
-<!--l. 5212--><p class="nopar" >
-</p><!--l. 5214--><p class="noindent" >
+</pre>
+<!--l. 5320--><p class="nopar" >
+</p><!--l. 5322--><p class="noindent" >
</p>
-<!--l. 5214--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.8 </span> <a
+<!--l. 5322--><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. 5217--><p class="noindent" >Other available options that don’t fit any of the above categories are described below.
-</p><!--l. 5220--><p class="noindent" >
+<!--l. 5325--><p class="noindent" >Other available options that don’t fit any of the above categories are described below.
+</p><!--l. 5328--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1020002.8"></a><span id="textcolor246"><a
- id="pkgopt:accsupp"></a><span id="textcolor247"><span
+ id="x1-1030002.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. 5222--><p class="noindent" >Load the <span
+<!--l. 5330--><p class="noindent" >Load the <span
class="cmss-10">glossaries-accsupp</span><a
- id="dx1-102001"></a> package.
-</p><!--l. 5224--><p class="noindent" >
+ id="dx1-103001"></a> package.
+</p><!--l. 5332--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1030002.8"></a><span id="textcolor248"><a
- id="pkgopt:prefix"></a><span id="textcolor249"><span
+ id="x1-1040002.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. 5226--><p class="noindent" >Load the <span
+<!--l. 5334--><p class="noindent" >Load the <span
class="cmss-10">glossaries-prefix</span><a
- id="dx1-103001"></a> package.
-</p><!--l. 5228--><p class="noindent" >
+ id="dx1-104001"></a> package.
+</p><!--l. 5336--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1040002.8"></a><span id="textcolor250"><a
- id="pkgopt:nomissingglstext"></a><span id="textcolor251"><span
+ id="x1-1050002.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. 5230--><p class="noindent" >This option may be used to suppress the boilerplate text generated by <span
+<!--l. 5338--><p class="noindent" >This option may be used to suppress the boilerplate text generated by <span
class="cmtt-10">\printglossary </span>if the glossary file is
missing.
-</p><!--l. 5233--><p class="noindent" >
+</p><!--l. 5341--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1050002.8"></a><a
+ id="x1-1060002.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. 5233--><p class="noindent" >Compatibility mode for old documents created using version 2.07 or below.
+<!--l. 5341--><p class="noindent" >Compatibility mode for old documents created using version 2.07 or below.
-</p><!--l. 5236--><p class="noindent" >
+</p><!--l. 5344--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1060002.8"></a><a
+ id="x1-1070002.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. 5236--><p class="noindent" >Compatibility mode for old documents created using version 3.07 or below.
-</p><!--l. 5239--><p class="noindent" >
+<!--l. 5344--><p class="noindent" >Compatibility mode for old documents created using version 3.07 or below.
+</p><!--l. 5347--><p class="noindent" >
</p>
<h4 class="likesubsectionHead"><a
- id="x1-1070002.8"></a><a
+ id="x1-1080002.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. 5239--><p class="noindent" >As a legacy from the precursor <span
+<!--l. 5347--><p class="noindent" >As a legacy from the precursor <span
class="cmss-10">glossary</span><a
- id="dx1-107001"></a> package, the standard glossary commands provided by the LaTeX kernel
+ id="dx1-108001"></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
@@ -11638,9 +12088,9 @@
were never documented in this user manual, and the conversion guide (<a
href="glossary2glossaries.html" >“Upgrading from the glossary package to
the glossaries package”</a>) explicitly discourages their use.
-</p><!--l. 5248--><p class="indent" > The use of those kernel commands (instead of the appropriate commands documented in this user guide) are
+</p><!--l. 5356--><p class="indent" > The use of those kernel commands (instead of the appropriate commands documented in this user guide) are
deprecated, and you will now get a warning if you try using them.
-</p><!--l. 5252--><p class="indent" > In the event that you require the original form of these kernel commands, for example, if you need to use the
+</p><!--l. 5360--><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
@@ -11649,19 +12099,19 @@
class="cmss-10">kernelglossredefs</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-107002"></a>. You may also need to use the <span
+ id="dx1-108002"></a>. You may also need to use the <span
class="cmss-10">nomain</span><a
- id="dx1-107003"></a> option in the event of file
+ id="dx1-108003"></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-107004"></a>
+ id="dx1-108004"></a>
package.)
-</p><!--l. 5263--><p class="indent" > This option may take one of three values: <span
+</p><!--l. 5371--><p class="indent" > This option may take one of three values: <span
class="cmss-10">true </span>(redefine with warnings, default), <span
class="cmss-10">false </span>(restore previous
definitions) or <span
class="cmss-10">nowarn </span>(redefine without warnings, not recommended).
-</p><!--l. 5268--><p class="indent" > The only glossary-related commands provided by the LaTeX kernel are <span
+</p><!--l. 5376--><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
@@ -11669,149 +12119,166 @@
class="cmss-10">glossaries </span>(such as <span
class="cmtt-10">\printglossary </span>and <span
class="cmss-10">theglossary</span><a
- id="dx1-107005"></a><a
- id="dx1-107006"></a>). These non-kernel commands aren’t affected by this
+ id="dx1-108005"></a><a
+ id="dx1-108006"></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-107007"></a> package will override the existing definitions of <span
+ id="dx1-108007"></a> package will override the existing definitions of <span
class="cmtt-10">\printglossary </span>and
<span
class="cmss-10">theglossary</span><a
- id="dx1-107008"></a><a
- id="dx1-107009"></a>.)
-</p><!--l. 5278--><p class="indent" > In general, if possible, it’s best to stick with just one package that provides a glossary mechanism. (The
+ id="dx1-108008"></a><a
+ id="dx1-108009"></a>.)
+</p><!--l. 5386--><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-107010"></a> package and patches <span
+ id="dx1-108010"></a> package and patches <span
class="cmtt-10">\PrintChanges</span>.)
-</p><!--l. 5282--><p class="noindent" >
+</p><!--l. 5390--><p class="noindent" >
</p>
-<!--l. 5282--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.9 </span> <a
+<!--l. 5390--><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. 5285--><p class="noindent" >Some of the options described above may also be set after the <span
+<!--l. 5393--><p class="noindent" >Some of the options described above may also be set after the <span
class="cmss-10">glossaries </span>package has been loaded
using
-</p><!--l. 5287--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-108001"></a> <span
+</p><!--l. 5395--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-109001"></a> <span
class="cmtt-10">\setupglossaries{</span>⟨<span
class="cmitt-10">key-val list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5289--><p class="noindent" >
+</p><!--l. 5397--><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-108002"></a>, <span
+ id="dx1-109002"></a>, <span
class="cmss-10">xindygloss</span><a
- id="dx1-108003"></a>, <span
+ id="dx1-109003"></a>, <span
class="cmss-10">xindynoglsnumbers</span><a
- id="dx1-108004"></a>,
+ id="dx1-109004"></a>,
<span
class="cmss-10">makeindex</span><a
- id="dx1-108005"></a>, <span
+ id="dx1-109005"></a>, <span
class="cmss-10">nolong</span><a
- id="dx1-108006"></a>, <span
+ id="dx1-109006"></a>, <span
class="cmss-10">nosuper</span><a
- id="dx1-108007"></a>, <span
+ id="dx1-109007"></a>, <span
class="cmss-10">nolist</span><a
- id="dx1-108008"></a>, <span
+ id="dx1-109008"></a>, <span
class="cmss-10">notree</span><a
- id="dx1-108009"></a>, <span
+ id="dx1-109009"></a>, <span
class="cmss-10">nostyles</span><a
- id="dx1-108010"></a>, <span
+ id="dx1-109010"></a>, <span
class="cmss-10">nomain</span><a
- id="dx1-108011"></a>, <span
+ id="dx1-109011"></a>, <span
class="cmss-10">compatible-2.07</span><a
- id="dx1-108012"></a>, <span
+ id="dx1-109012"></a>, <span
class="cmss-10">translate</span><a
- id="dx1-108013"></a>, <span
+ id="dx1-109013"></a>, <span
class="cmss-10">notranslate</span><a
- id="dx1-108014"></a>,
-<span
+ id="dx1-109014"></a>, <span
class="cmss-10">acronym</span><a
- id="dx1-108015"></a>. These options have to be set while the package is loading, except for the <span
+ id="dx1-109015"></a>. These
+options have to be set while the package is loading, except for the <span
class="cmss-10">xindy</span><a
- id="dx1-108016"></a> sub-options
-which can be set using commands like <span
+ id="dx1-109016"></a> sub-options which can
+be set using commands like <span
class="cmtt-10">\GlsSetXdyLanguage</span><a
- id="dx1-108017"></a> (see <a
-href="#sec:xindy">§11 </a><a
+ id="dx1-109017"></a> (see <a
+href="#sec:xindy">§<span
+class="cmbx-10">??</span>sec:xindy </a><a
href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further
details).
-</p><!--l. 5301--><p class="indent" > <div class="important" title="Important Note"> If you need to use this command, use it as soon as possible after loading <span
+</p><!--l. 5409--><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-108018"></a>) after you have started defining your acronyms, you are likely to get unexpected results. If you try
+ id="dx1-109018"></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. 5309--><p class="noindent" >
+</p><!--l. 5417--><p class="noindent" >
+</p><!--l. 5419--><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-109019"></a> instead. </div>
+</p><!--l. 5422--><p class="noindent" >
</p>
-<!--l. 5311--><p class="indent" > </div>
-</p><!--l. 5311--><p class="noindent" ><a
+<!--l. 5424--><p class="indent" > </div>
+</p><!--l. 5424--><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. 5314--><p class="indent" > In the preamble you need to indicate whether you want to use <a
-href="#option1">Option 1</a>, <a
-href="#option2">Option 2</a> or <a
-href="#option3">Option 3</a>. It’s not
-possible to mix these options within a document, although some combinations are possible with <span
-class="cmss-10">glossaries-extra</span>.
-(For Options <a
-href="#option4">4</a> and <a
-href="#option5">5</a> see the <a
+</p><!--l. 5427--><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">??</span>sec:indexingoptions </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-109001"></a></a> and <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> manuals.)
+ id="dx1-110001"></a></a> manuals for the full documentation of the other
+options.
+</p><!--l. 5435--><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">??</span>sec:newglosentry </a><a
+href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>.
</p>
-<!--l. 5320--><p class="noindent" ><a
+<!--l. 5439--><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. 5323--><p class="noindent" >The command
-</p><!--l. 5324--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-110001"></a> <span
+<!--l. 5442--><p class="noindent" >The command
+</p><!--l. 5443--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-111001"></a> <span
class="cmtt-10">\makenoidxglossaries </span></div><hr>
-</p><!--l. 5326--><p class="noindent" >
+</p><!--l. 5445--><p class="noindent" >
must be placed in the preamble. This sets up the internal commands required to make <a
href="#option1">Option 1</a> work. <strong>If you
omit <span
class="cmtt-10">\makenoidxglossaries </span>none of the glossaries will be displayed.</strong>
-</p><!--l. 5332--><p class="noindent" >
+</p><!--l. 5451--><p class="noindent" >
</p>
-<!--l. 5332--><p class="noindent" ><a
+<!--l. 5451--><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. 5335--><p class="noindent" >The command
-</p><!--l. 5336--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-111001"></a> <span
+<!--l. 5454--><p class="noindent" >The command
+</p><!--l. 5455--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-112001"></a> <span
class="cmtt-10">\makeglossaries </span></div><hr>
-</p><!--l. 5338--><p class="noindent" >
+</p><!--l. 5457--><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-111002"></a></a> (<span
+ id="dx1-112002"></a></a> (<span
class="cmtt-10">ist</span><a
- id="dx1-111003"></a>) or <a
+ id="dx1-112003"></a>) or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-111004"></a></a> (<span
+ id="dx1-112004"></a></a> (<span
class="cmtt-10">xdy</span><a
- id="dx1-111005"></a>) style file (for
+ id="dx1-112005"></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. 5346--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you are using <a
+</p><!--l. 5465--><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
@@ -11823,8 +12290,8 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further details.
</div>
-</p><!--l. 5350--><p class="noindent" >
-</p><!--l. 5353--><p class="indent" > <span class="warningsymbol">⚠</span> Note that some of the commands provided by the <span
+</p><!--l. 5469--><p class="noindent" >
+</p><!--l. 5472--><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
@@ -11832,156 +12299,187 @@
class="cmtt-10">\makeglossaries </span>you will generate an error. Similarly, there are some commands that must
not be used before <span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5361--><p class="indent" > You can suppress the creation of the customised <a
+</p><!--l. 5480--><p class="indent" > You can suppress the creation of the customised <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-111006"></a></a> or <a
+ id="dx1-112006"></a></a> or <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-111007"></a></a> style file using
-</p><!--l. 5363--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-111008"></a> <span
+ id="dx1-112007"></a></a> style file using
+</p><!--l. 5482--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-112008"></a> <span
class="cmtt-10">\noist </span></div><hr>
-</p><!--l. 5365--><p class="noindent" >
+</p><!--l. 5484--><p class="noindent" >
That this command must not be used after <span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5367--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span
+</p><!--l. 5486--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span
class="cmtt-10">xdy</span><a
- id="dx1-111009"></a> file created when using <span
+ id="dx1-112009"></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-111010"></a> package option with it. </div>
-</p><!--l. 5371--><p class="noindent" >
-</p><!--l. 5373--><p class="indent" > The default name for the customised style file is given by <span
+ id="dx1-112010"></a> package option with it. </div>
+
+
+</p><!--l. 5490--><p class="noindent" >
+</p><!--l. 5492--><p class="indent" > The default name for the customised style file is given by <span
class="cmtt-10">\jobname</span><a
- id="dx1-111011"></a><span
-class="cmtt-10">ist</span><a
- id="dx1-111012"></a> (<a
+ id="dx1-112011"></a><span
+class="cmtt-10">.ist</span><a
+ id="dx1-112012"></a> (<a
href="#option2">Option 2</a>) or <span
class="cmtt-10">\jobname</span><a
- id="dx1-111013"></a><span
-class="cmtt-10">xdy</span><a
- id="dx1-111014"></a>
+ id="dx1-112013"></a><span
+class="cmtt-10">.xdy</span><a
+ id="dx1-112014"></a>
(<a
href="#option3">Option 3</a>). This name may be changed using:
-</p><!--l. 5377--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-111015"></a> <span
+</p><!--l. 5496--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-112015"></a> <span
class="cmtt-10">\setStyleFile{</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">} </span></div><hr>
-
-
-</p><!--l. 5379--><p class="noindent" >
+</p><!--l. 5498--><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. 5384--><p class="indent" > Each glossary entry is assigned a <a
+</p><!--l. 5503--><p class="indent" > Each glossary entry is assigned a <a
href="#glo:numberlist">number list<a
- id="dx1-111016"></a></a> that lists all the locations in the document where that entry
+ id="dx1-112016"></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-111017"></a> package option. The default form of the location number assumes a full stop compositor
+ id="dx1-112017"></a> package option. The default form of the location number assumes a full stop compositor
(e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this
using
-</p><!--l. 5391--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-111018"></a> <span
+</p><!--l. 5510--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-112018"></a> <span
class="cmtt-10">\glsSetCompositor{</span>⟨<span
class="cmitt-10">symbol</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5393--><p class="noindent" >
+</p><!--l. 5512--><p class="noindent" >
For example:
</p>
- <div class="verbatim" id="verbatim-131">
+ <pre class="verbatim" id="verbatim-135">
\glsSetCompositor{-}
-</div>
-<!--l. 5397--><p class="nopar" > This command must not be used after <span
+</pre>
+<!--l. 5516--><p class="nopar" > This command must not be used after <span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5400--><p class="indent" > If you use <a
+</p><!--l. 5519--><p class="indent" > If you use <a
href="#option3">Option 3</a>, you can have a different compositor for page numbers starting with an upper case
alphabetical character using:
-</p><!--l. 5402--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-111019"></a> <span
+</p><!--l. 5521--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-112019"></a> <span
class="cmtt-10">\glsSetAlphaCompositor{</span>⟨<span
class="cmitt-10">symbol</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5404--><p class="noindent" >
+</p><!--l. 5523--><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-111020"></a>s</a> containing a mixture of
+ id="dx1-112020"></a>s</a> containing a mixture of
A-1 and 2.3 style formats, then do:
</p>
- <div class="verbatim" id="verbatim-132">
+ <pre class="verbatim" id="verbatim-136">
\glsSetCompositor{.}\glsSetAlphaCompositor{-}
-</div>
-<!--l. 5410--><p class="nopar" > See <a
-href="#sec:numberlists">§5 </a><a
-href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about <a
+</pre>
+<!--l. 5529--><p class="nopar" > See <a
+href="#sec:numberlists">§<span
+class="cmbx-10">??</span>sec:numberlists </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-111021"></a>s</a>.
+ id="dx1-112021"></a>s</a>.
</p>
-<!--l. 5414--><p class="indent" > </div>
-</p><!--l. 5414--><p class="noindent" ><a
+<!--l. 5533--><p class="indent" > </div>
+</p><!--l. 5533--><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. 5417--><p class="indent" > All glossary entries must be defined before they are used, so it is better to define them in the
-preamble to ensure this. In fact, some commands such as <span
-class="cmtt-10">\longnewglossaryentry </span>may only be used
-in the preamble. See <a
-href="#sec:docdefs">§4.8 </a><a
+</p><!--l. 5536--><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-113001"></a></a>, entries must be defined in <span
+class="cmtt-10">bib</span><a
+ id="dx1-113002"></a> files using the syntax described in the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-113003"></a></a>
+user manual. </div>
+</p><!--l. 5540--><p class="noindent" >
+</p><!--l. 5542--><p class="indent" > Acronyms are covered in <a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </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-113004"></a> and <span
+class="cmtt-10">plural</span><a
+ id="dx1-113005"></a>, interfere with the acronym styles.
+</p><!--l. 5549--><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">??</span>sec:docdefs </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
+discussion of the problems with defining entries within the document instead of in the preamble. (The
+<a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> package has an option that provides a restricted form of document definitions
-that avoids some of the issues discussed in <a
-href="#sec:docdefs">§4.8 </a><a
+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">??</span>sec:docdefs </a><a
href="#sec:docdefs">Drawbacks With Defining Entries in the Document
Environment<!--tex4ht:ref: sec:docdefs --></a>.)
-</p><!--l. 5426--><p class="indent" > <div class="important" title="Important Note"> <a
+</p><!--l. 5558--><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-112001"></a>. <a
+ id="dx1-113006"></a>. <a
href="#option4">Option 4</a> requires that definitions
are provided in <span
class="cmtt-10">bib</span><a
- id="dx1-112002"></a> format. <a
+ id="dx1-113007"></a> format. <a
href="#option5">Option 5</a> requires either preamble-only definitions or the use of the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>
package option <span
class="cmss-10">docdef=restricted</span>. </div>
-</p><!--l. 5432--><p class="noindent" >
-</p><!--l. 5434--><p class="indent" > Only those entries that are indexed in the document (using any of the commands described in <a
-href="#sec:glslink">§6 </a><a
-href="#sec:glslink">Links to
-Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a
-href="#sec:glsadd">§7 </a><a
-href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a
-href="#sec:crossref">§8 </a><a
-href="#sec:crossref">Cross-Referencing
-Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. See <a
-href="#sec:printglossary">§10 </a><a
-href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the
-glossary.
-</p><!--l. 5442--><p class="indent" > New glossary entries are defined using the command:
-</p><!--l. 5443--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-112003"></a> <span
+</p><!--l. 5564--><p class="noindent" >
+</p><!--l. 5566--><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">??</span>sec:glslink
+</a><a
+href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a
+href="#sec:glsadd">§<span
+class="cmbx-10">??</span>sec:glsadd </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">??</span>sec:crossref </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">??</span>sec:printglossary </a><a
+href="#sec:printglossary">Displaying a
+Glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the glossary.
+</p><!--l. 5574--><p class="indent" > New glossary entries are defined using the command:
+</p><!--l. 5575--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-113008"></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. 5445--><p class="noindent" >
+</p><!--l. 5577--><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
@@ -11988,9 +12486,9 @@
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. 5451--><p class="indent" > If you have a long description that needs to span multiple paragraphs, use
-</p><!--l. 5453--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-112004"></a> <span
+</p><!--l. 5583--><p class="indent" > If you have a long description that needs to span multiple paragraphs, use
+</p><!--l. 5585--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-113009"></a> <span
class="cmtt-10">\longnewglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -11998,7 +12496,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">long description</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5456--><p class="noindent" >
+</p><!--l. 5588--><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
@@ -12012,18 +12510,18 @@
doesn’t append either <span
class="cmtt-10">\unskip </span>or <span
class="cmtt-10">\nopostdesc</span>.
-</p><!--l. 5466--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been defined:
-</p><!--l. 5468--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-112005"></a> <span
+</p><!--l. 5598--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been defined:
+</p><!--l. 5600--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-113010"></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. 5470--><p class="noindent" >
+</p><!--l. 5602--><p class="noindent" >
and
-</p><!--l. 5472--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-112006"></a> <span
+</p><!--l. 5604--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-113011"></a> <span
class="cmtt-10">\longprovideglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -12031,9 +12529,11 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">long description</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5475--><p class="noindent" >
+
+
+</p><!--l. 5607--><p class="noindent" >
(These are both preamble-only commands.)
-</p><!--l. 5478--><p class="indent" > For all the above commands, the first argument, ⟨<span
+</p><!--l. 5610--><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
@@ -12040,344 +12540,419 @@
(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. 5486--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a
+</p><!--l. 5618--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-112007"></a></a> or other <a
+ id="dx1-113012"></a></a> or other <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-112008"></a></a>, such as é or
-
-
+ id="dx1-113013"></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-112009"></a>’s options that change certain punctuation characters (such as <span
+ id="dx1-113014"></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. 5494--><p class="noindent" >
-</p><!--l. 5496--><p class="indent" > The second argument, ⟨<span
+</p><!--l. 5626--><p class="noindent" >
+</p><!--l. 5628--><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-112010"></a> and either <span
+ id="dx1-113015"></a> and either <span
class="cmtt-10">name</span><a
- id="dx1-112011"></a> or <span
+ id="dx1-113016"></a> or <span
class="cmtt-10">parent</span><a
- id="dx1-112012"></a>. The description is set in the third
+ id="dx1-113017"></a>. The description is set in the third
argument of <span
class="cmtt-10">\longnewglossaryentry </span>and <span
class="cmtt-10">\longprovideglossaryentry</span>. With the other commands it’s set via
the <span
class="cmtt-10">description</span><a
- id="dx1-112013"></a> key. As is typical with ⟨<span
+ id="dx1-113018"></a> key. As is typical with ⟨<span
class="cmti-10">key</span>⟩=⟨<span
-class="cmti-10">value</span>⟩ lists, values that contain a comma or equal sign
-must be enclosed in braces. Available fields are listed below. Additional fields are provided by the
-supplementary packages <span
+class="cmti-10">value</span>⟩ lists, values that contain a comma or equal sign must be
+enclosed in braces. Available fields are listed below. Additional fields are provided by the supplementary
+packages <span
class="cmss-10">glossaries-prefix</span><a
- id="dx1-112014"></a> (<a
-href="#sec:prefix">§17 </a><a
+ id="dx1-113019"></a> (<a
+href="#sec:prefix">§<span
+class="cmbx-10">??</span>sec:prefix </a><a
href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span
class="cmss-10">glossaries-accsupp</span><a
- id="dx1-112015"></a> (<a
-href="#sec:accsupp">§18 </a><a
-href="#sec:accsupp">Accessibility
-Support<!--tex4ht:ref: sec:accsupp --></a>) and also by <a
+ id="dx1-113020"></a> (<a
+href="#sec:accsupp">§<span
+class="cmbx-10">??</span>sec:accsupp
+</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">§4.3 </a><a
-href="#sec:addkey">Additional
-Keys<!--tex4ht:ref: sec:addkey --></a>).
+href="#sec:addkey">§<span
+class="cmbx-10">??</span>sec:addkey
+</a><a
+href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>).
</p><dl class="description"><dt class="description">
+ <!--l. 5645--><p class="noindent" >
<span
class="cmtt-10">name</span><a
- id="dx1-112016"></a> </dt><dd
-class="description">The name of the entry (as it will appear in the glossary). If this key is omitted and the <span
+ id="dx1-113021"></a> </p></dt><dd
+class="description">
+ <!--l. 5645--><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-112017"></a>
- key is supplied, this value will be the same as the parent’s name.
- <!--l. 5517--><p class="noindent" ><div class="important" title="Important Note"> If the <span
+ id="dx1-113022"></a> key
+ is supplied, this value will be the same as the parent’s name.
+ </p><!--l. 5649--><p class="noindent" ><div class="important" title="Important Note"> If the <span
class="cmtt-10">name</span><a
- id="dx1-112018"></a> key contains any commands, you must also use the <span
+ id="dx1-113023"></a> key contains any commands, you must also use the <span
class="cmtt-10">sort</span><a
- id="dx1-112019"></a> key (described below) if
+ id="dx1-113024"></a> key (described below) if
you intend sorting the entries alphabetically, otherwise the entries can’t be sorted correctly.
</div>
- </p><!--l. 5521--><p class="noindent" >
+ </p><!--l. 5653--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 5655--><p class="noindent" >
<span
class="cmtt-10">description</span><a
- id="dx1-112020"></a> </dt><dd
-class="description">A brief description of this term (to appear in the glossary). Within this value, you can
- use:
- <!--l. 5525--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-112021"></a> <span
+ id="dx1-113025"></a> </p></dt><dd
+class="description">
+ <!--l. 5655--><p class="noindent" >A brief description of this term (to appear in the glossary). Within this value, you can use:
+ </p><!--l. 5657--><p class="noindent" ><hr><div title="Definition"><a
+ id="dx1-113026"></a> <span
class="cmtt-10">\nopostdesc </span></div><hr>
- </p><!--l. 5527--><p class="noindent" >
+ </p><!--l. 5659--><p class="noindent" >
to suppress the description terminator for this entry. For example, if this entry is a parent entry that
doesn’t require a description, you can do <span
class="cmtt-10">description={\nopostdesc}</span>. If you want a paragraph break in
the description use:
- </p><!--l. 5533--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-112022"></a> <span
+ </p><!--l. 5665--><p class="noindent" ><hr><div title="Definition"><a
+ id="dx1-113027"></a> <span
class="cmtt-10">\glspar </span></div><hr>
- </p><!--l. 5535--><p class="noindent" >
+
+
+ </p><!--l. 5667--><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-112023"></a> not <span class="obeylines-h"><span class="verb"><span
+ id="dx1-113028"></a> not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\\</span></span></span> if you want to force a line break.
- </p><!--l. 5542--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> With <a
+ </p><!--l. 5674--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> With <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>, use <span id="textcolor252"><span
+class="cmss-10">glossaries-extra</span></a>, use <span id="textcolor258"><span
class="cmtt-10">\glsxtrnopostpunc</span></span><a
- id="dx1-112024"></a> instead of <span
+ id="dx1-113029"></a> instead of <span
class="cmtt-10">\nopostdesc </span>to suppress the post-description
punctuation. </div>
- </p><!--l. 5545--><p class="noindent" >
+ </p><!--l. 5677--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 5679--><p class="noindent" >
<span
class="cmtt-10">parent</span><a
- id="dx1-112025"></a> </dt><dd
-class="description">The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See <a
-href="#sec:subentries">§4.5
- </a><a
+ id="dx1-113030"></a> </p></dt><dd
+class="description">
+ <!--l. 5679--><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">??</span>sec:subentries </a><a
href="#sec:subentries">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details.
-
-
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 5683--><p class="noindent" >
<span
class="cmtt-10">descriptionplural</span><a
- id="dx1-112026"></a> </dt><dd
-class="description">The plural form of the description, if required. If omitted, the value is set to the same as
- the <span
+ id="dx1-113031"></a> </p></dt><dd
+class="description">
+ <!--l. 5683--><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-112027"></a> key.
- </dd><dt class="description">
+ id="dx1-113032"></a>
+ key.
+ </p></dd><dt class="description">
+ <!--l. 5687--><p class="noindent" >
<span
class="cmtt-10">text</span><a
- id="dx1-112028"></a> </dt><dd
-class="description">How this entry will appear in the document text when using <span
+ id="dx1-113033"></a> </p></dt><dd
+class="description">
+ <!--l. 5687--><p class="noindent" >How this entry will appear in the document text when using <span
class="cmtt-10">\gls</span><a
- id="dx1-112029"></a> (or one of its upper case variants). If
+ id="dx1-113034"></a> (or one of its upper case variants). If
this field is omitted, the value of the <span
class="cmtt-10">name</span><a
- id="dx1-112030"></a> key is used.
- </dd><dt class="description">
+ id="dx1-113035"></a> key is used.
+ </p><!--l. 5691--><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-113036"></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. 5696--><p class="noindent" >
<span
class="cmtt-10">first</span><a
- id="dx1-112031"></a> </dt><dd
-class="description">How the entry will appear in the document text on <a
+ id="dx1-113037"></a> </p></dt><dd
+class="description">
+ <!--l. 5696--><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-112032"></a> (or one of its upper case
- variants). If this field is omitted, the value of the <span
+ id="dx1-113038"></a> (or one of its upper
+ case variants). If this field is omitted, the value of the <span
class="cmtt-10">text</span><a
- id="dx1-112033"></a> key is used. Note that if you use <span
+ id="dx1-113039"></a> key is used. Note that if you use
+ <span
class="cmtt-10">\glspl</span><a
- id="dx1-112034"></a>,
- <span
+ id="dx1-113040"></a>, <span
class="cmtt-10">\Glspl</span><a
- id="dx1-112035"></a>, <span
+ id="dx1-113041"></a>, <span
class="cmtt-10">\GLSpl</span><a
- id="dx1-112036"></a>, <span
+ id="dx1-113042"></a>, <span
class="cmtt-10">\glsdisp</span><a
- id="dx1-112037"></a> before using <span
+ id="dx1-113043"></a> before using <span
class="cmtt-10">\gls</span><a
- id="dx1-112038"></a>, the <span
-class="cmtt-10">firstplural</span><a
- id="dx1-112039"></a> value won’t be used with
+ id="dx1-113044"></a>, the <span
+class="cmtt-10">first</span><a
+ id="dx1-113045"></a> value won’t be used with
<span
class="cmtt-10">\gls</span><a
- id="dx1-112040"></a>.
- </dd><dt class="description">
+ id="dx1-113046"></a>.
+ </p><!--l. 5703--><p class="noindent" >You may prefer to use abbreviations (<a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </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-113047"></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. 5710--><p class="noindent" >Although it is possible to use <span
+class="cmtt-10">first</span><a
+ id="dx1-113048"></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. 5714--><p class="noindent" >
<span
class="cmtt-10">plural</span><a
- id="dx1-112041"></a> </dt><dd
-class="description">How the entry will appear in the document text when using <span
+ id="dx1-113049"></a> </p></dt><dd
+class="description">
+ <!--l. 5714--><p class="noindent" >How the entry will appear in the document text when using <span
class="cmtt-10">\glspl</span><a
- id="dx1-112042"></a> (or one of its upper case variants).
- If this field is omitted, the value is obtained by appending <span
+ id="dx1-113050"></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-112043"></a> to the value of the <span
+ id="dx1-113051"></a> to the value of the <span
class="cmtt-10">text</span><a
- id="dx1-112044"></a>
- field. The default value of <span
+ id="dx1-113052"></a> field.
+ The default value of <span
class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-112045"></a> is the letter “s”.
- </dd><dt class="description">
+ id="dx1-113053"></a> is the letter “s”.
+ </p><!--l. 5720--><p class="noindent" >Although it is possible to use <span
+class="cmtt-10">plural</span><a
+ id="dx1-113054"></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-113055"></a> instead, if the default value is
+ inappropriate.
+ </p></dd><dt class="description">
+ <!--l. 5725--><p class="noindent" >
<span
class="cmtt-10">firstplural</span><a
- id="dx1-112046"></a> </dt><dd
-class="description">How the entry will appear in the document text on <a
+ id="dx1-113056"></a> </p></dt><dd
+class="description">
+ <!--l. 5725--><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-112047"></a> (or one of its upper case
+ id="dx1-113057"></a> (or one of its upper case
variants). If this field is omitted, the value is obtained from the <span
class="cmtt-10">plural</span><a
- id="dx1-112048"></a> key, if the <span
+ id="dx1-113058"></a> key, if the <span
class="cmtt-10">first</span><a
- id="dx1-112049"></a> key is omitted, or
+ id="dx1-113059"></a> key is omitted, or
by appending <span
class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-112050"></a> to the value of the <span
+ id="dx1-113060"></a> to the value of the <span
class="cmtt-10">first</span><a
- id="dx1-112051"></a> field, if the <span
+ id="dx1-113061"></a> field, if the <span
class="cmtt-10">first</span><a
- id="dx1-112052"></a> field is present. Note that if
+ id="dx1-113062"></a> field is present. Note that if
you use <span
class="cmtt-10">\gls</span><a
- id="dx1-112053"></a>, <span
+ id="dx1-113063"></a>, <span
class="cmtt-10">\Gls</span><a
- id="dx1-112054"></a>, <span
+ id="dx1-113064"></a>, <span
class="cmtt-10">\GLS</span><a
- id="dx1-112055"></a>, <span
+ id="dx1-113065"></a>, <span
class="cmtt-10">\glsdisp </span>before using <span
class="cmtt-10">\glspl</span><a
- id="dx1-112056"></a>, the <span
+ id="dx1-113066"></a>, the <span
class="cmtt-10">firstplural</span><a
- id="dx1-112057"></a> value won’t be used with
+ id="dx1-113067"></a> value won’t be used with
<span
class="cmtt-10">\glspl</span><a
- id="dx1-112058"></a>.
- <!--l. 5583--><p class="noindent" ><span class="warningsymbol">⚠</span> Note: prior to version 1.13, the default value of <span
+ id="dx1-113068"></a>.
+ </p><!--l. 5735--><p class="noindent" >Although it is possible to use <span
class="cmtt-10">firstplural</span><a
- id="dx1-112059"></a> was always taken by appending “s” to the
+ id="dx1-113069"></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-113070"></a> and <span
+class="cmtt-10">longplural</span><a
+ id="dx1-113071"></a> instead, if the default
+ value is inappropriate.
+ </p><!--l. 5741--><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-113072"></a> was always taken by appending “s” to the
<span
class="cmtt-10">first</span><a
- id="dx1-112060"></a> key, which meant that you had to specify both <span
+ id="dx1-113073"></a> key, which meant that you had to specify both <span
class="cmtt-10">plural</span><a
- id="dx1-112061"></a> and <span
+ id="dx1-113074"></a> and <span
class="cmtt-10">firstplural</span><a
- id="dx1-112062"></a>, even if you hadn’t used
+ id="dx1-113075"></a>, even if you hadn’t used
the <span
class="cmtt-10">first</span><a
- id="dx1-112063"></a> key.
+ id="dx1-113076"></a> key.
</p></dd><dt class="description">
+ <!--l. 5747--><p class="noindent" >
<span
class="cmtt-10">symbol</span><a
- id="dx1-112064"></a> </dt><dd
-class="description">This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to
+ id="dx1-113077"></a> </p></dt><dd
+class="description">
+ <!--l. 5747--><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.
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 5751--><p class="noindent" >
<span
class="cmtt-10">symbolplural</span><a
- id="dx1-112065"></a> </dt><dd
-class="description">This is the plural form of the symbol (as passed to <span
+ id="dx1-113078"></a> </p></dt><dd
+class="description">
+ <!--l. 5751--><p class="noindent" >This is the plural form of the symbol (as passed to <span
class="cmtt-10">\glsdisplay</span><a
- id="dx1-112066"></a> and <span
+ id="dx1-113079"></a> and <span
class="cmtt-10">\glsdisplayfirst</span><a
- id="dx1-112067"></a> by
+ id="dx1-113080"></a> by <span
+class="cmtt-10">\glspl</span><a
+ id="dx1-113081"></a>,
<span
-class="cmtt-10">\glspl</span><a
- id="dx1-112068"></a>, <span
class="cmtt-10">\Glspl</span><a
- id="dx1-112069"></a> and <span
+ id="dx1-113082"></a> and <span
class="cmtt-10">\GLSpl</span><a
- id="dx1-112070"></a>). If omitted, the value is set to the same as the <span
+ id="dx1-113083"></a>). If omitted, the value is set to the same as the <span
class="cmtt-10">symbol</span><a
- id="dx1-112071"></a> key.
- </dd><dt class="description">
+ id="dx1-113084"></a> key.
+ </p></dd><dt class="description">
+ <!--l. 5756--><p class="noindent" >
<span
class="cmtt-10">sort</span><a
- id="dx1-112072"></a> </dt><dd
-class="description">This value indicates how this entry should be sorted. If omitted, the value is given by the
- <span
+ id="dx1-113085"></a> </p></dt><dd
+class="description">
+ <!--l. 5756--><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-112073"></a> field unless one of the package options <span
+ id="dx1-113086"></a> field unless one of the package options <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
- id="dx1-112074"></a> and <span
+ id="dx1-113087"></a> and <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">use</span><a
- id="dx1-112075"></a> have been used. In general,
- it’s best to use the <span
+ id="dx1-113088"></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-112076"></a> key if the <span
+ id="dx1-113089"></a> key if the <span
class="cmtt-10">name</span><a
- id="dx1-112077"></a> contains commands (e.g. <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\ensuremath{\alpha}</span></span></span>).
- You can also override the <span
+ id="dx1-113090"></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. 5765--><p class="noindent" >You can also override the <span
class="cmtt-10">sort</span><a
- id="dx1-112078"></a> key by redefining <span
+ id="dx1-113091"></a> key by redefining <span
class="cmtt-10">\glsprestandardsort</span><a
- id="dx1-112079"></a> (see <a
-href="#sec:pkgopts-sort">§2.5 </a><a
+ id="dx1-113092"></a> (see <a
+href="#sec:pkgopts-sort">§<span
+class="cmbx-10">??</span>sec:pkgopts-sort </a><a
href="#sec:pkgopts-sort">Sorting
Options<!--tex4ht:ref: sec:pkgopts-sort --></a>).
- <!--l. 5607--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> The <span
+ </p><!--l. 5768--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> The <span
class="cmtt-10">sort</span><a
- id="dx1-112080"></a> key shouldn’t be used with <a
+ id="dx1-113093"></a> key shouldn’t be used with <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-112081"></a></a>. It has a system of fallbacks that allow different types of
+ id="dx1-113094"></a></a>. It has a system of fallbacks that allow different types of
entries to obtain the sort value from the most relevant field. See the <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-112082"></a></a> manual for further details
+ id="dx1-113095"></a></a> manual for further details
and see also <a
href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span
class="cmtt-10">bib2gls </span>gallery: sorting</a>. </div>
- </p><!--l. 5613--><p class="noindent" >
-
-
- </p><!--l. 5615--><p class="noindent" ><a
+ </p><!--l. 5774--><p class="noindent" >
+ </p><!--l. 5776--><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-112083"></a> key when it sets the <span
+ id="dx1-113096"></a> key when it sets the <span
class="cmtt-10">sort</span><a
- id="dx1-112084"></a> key. So with <a
+ id="dx1-113097"></a> key. So with <a
href="#option1">Option 1</a>:
</p>
- <div class="verbatim" id="verbatim-133">
+ <pre class="verbatim" id="verbatim-137">
\newglossaryentry{elite}{%
-  <br />  name={{\'e}lite},
-  <br />  description={select group of people}
-  <br />}
-</div>
- <!--l. 5624--><p class="nopar" > This is equivalent to:
+   name={{\'e}lite},
+   description={select group of people}
+ }
+</pre>
+ <!--l. 5785--><p class="nopar" > This is equivalent to:
</p>
- <div class="verbatim" id="verbatim-134">
+ <pre class="verbatim" id="verbatim-138">
\newglossaryentry{elite}{%
-  <br />  name={{\'e}lite},
-  <br />  description={select group of people},
-  <br />  sort={elite}
-  <br />}
-</div>
- <!--l. 5632--><p class="nopar" > Unless you use the package option <span
+   name={{\'e}lite},
+   description={select group of people},
+   sort={elite}
+ }
+</pre>
+ <!--l. 5793--><p class="nopar" > Unless you use the package option <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-112085"></a>, in which case it’s equivalent to:
+ id="dx1-113098"></a>, in which case it’s equivalent to:
</p>
- <div class="verbatim" id="verbatim-135">
+ <pre class="verbatim" id="verbatim-139">
\newglossaryentry{elite}{%
-  <br />  name={{\'e}lite},
-  <br />  description={select group of people},
-  <br />  sort={\'elite}
-  <br />}
-</div>
- <!--l. 5641--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a symbol.
- </p><!--l. 5645--><p class="noindent" >Similarly if you use the <span
+   name={{\'e}lite},
+   description={select group of people},
+   sort={\'elite}
+ }
+</pre>
+ <!--l. 5802--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a symbol.
+ </p><!--l. 5806--><p class="noindent" >Similarly if you use the <span
class="cmss-10">inputenc</span><a
- id="dx1-112086"></a> package: </p><div class="alltt">
+ id="dx1-113099"></a> package: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{elite}{%</span>
@@ -12401,7 +12976,7 @@
class="cmtt-10">\newglossaryentry{elite}{%</span>
<br /><span
class="cmtt-10"> </span><span
-class="cmtt-10"> name=i{{</span><span
+class="cmtt-10"> name={{</span><span
class="cmtt-10">é</span><span
class="cmtt-10">}lite},</span>
<br /><span
@@ -12420,7 +12995,7 @@
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-112087"></a>, in which case it’s equivalent to: <div class="alltt">
+ id="dx1-113100"></a>, in which case it’s equivalent to: <div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{elite}{%</span>
@@ -12444,139 +13019,129 @@
class="cmtt-10">}</span>
</div>
</div> Again, this will place the entry before the “A” group.
- <!--l. 5671--><p class="noindent" >With Options <a
+ <!--l. 5832--><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-112088"></a> will either be set to the <span
+ id="dx1-113101"></a> will either be set to the <span
class="cmtt-10">name</span><a
- id="dx1-112089"></a> key (if <span
+ id="dx1-113102"></a> key (if <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-112090"></a>) or
+ id="dx1-113103"></a>) or
it will set it to the expansion of the <span
class="cmtt-10">name</span><a
- id="dx1-112091"></a> key (if <span
+ id="dx1-113104"></a> key (if <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">false</span><a
- id="dx1-112092"></a>).
+ id="dx1-113105"></a>).
- </p><!--l. 5676--><p class="noindent" ><div class="important" title="Important Note"> Take care with <a
+ </p><!--l. 5837--><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-112093"></a></a> (<a
+ id="dx1-113106"></a></a> (<a
href="#option3">Option 3</a>): if you have entries with the same <span
class="cmtt-10">sort</span><a
- id="dx1-112094"></a> value they will be treated as
+ id="dx1-113107"></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-112095"></a></a> and aren’t using the <span
+ id="dx1-113108"></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-112096"></a> key for entries where the name just consists of a control sequence (for example
+ id="dx1-113109"></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. 5684--><p class="noindent" >Take care if you use <a
+ </p><!--l. 5845--><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-112097"></a> contains fragile commands. You will either need to explicitly
+ id="dx1-113110"></a> contains fragile commands. You will either need to explicitly
set the <span
class="cmtt-10">sort</span><a
- id="dx1-112098"></a> key or use the <span
+ id="dx1-113111"></a> key or use the <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-112099"></a> package option (unless you use the <span
+ id="dx1-113112"></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. 5688--><p class="noindent" >
+ </p><!--l. 5849--><p class="noindent" >
</p></dd><dt class="description">
+ <!--l. 5851--><p class="noindent" >
<span
class="cmtt-10">type</span><a
- id="dx1-112100"></a> </dt><dd
-class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is
- assumed unless <span
+ id="dx1-113113"></a> </p></dt><dd
+class="description">
+ <!--l. 5851--><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-112101"></a> is used (see <a
-href="#sec:acronyms">§13 </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>).
- </dd><dt class="description">
+ id="dx1-113114"></a> is used (see <a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </a><a
+href="#sec:acronyms">Acronyms and Other
+ Abbreviations<!--tex4ht:ref: sec:acronyms --></a>).
+ </p></dd><dt class="description">
+ <!--l. 5857--><p class="noindent" >
<span
class="cmtt-10">user1</span><a
- id="dx1-112102"></a><span
+ id="dx1-113115"></a><span
class="cmbx-10">, </span><span
class="cmbx-10">…, </span><span
class="cmtt-10">user6</span><a
- id="dx1-112103"></a><a
- id="dx1-112104"></a><a
- id="dx1-112105"></a><a
- id="dx1-112106"></a><a
- id="dx1-112107"></a> </dt><dd
-class="description">Six keys provided for any additional information the user may want to specify. (For
- example, an associated dimension or an alternative plural or some other grammatical construct.)
- Alternatively, you can add new keys using <span
+ id="dx1-113116"></a><a
+ id="dx1-113117"></a><a
+ id="dx1-113118"></a><a
+ id="dx1-113119"></a><a
+ id="dx1-113120"></a> </p></dt><dd
+class="description">
+ <!--l. 5857--><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-112108"></a> or <span
+ id="dx1-113121"></a> or <span
class="cmtt-10">\glsaddstoragekey</span><a
- id="dx1-112109"></a> (see <a
-href="#sec:addkey">§4.3 </a><a
+ id="dx1-113122"></a> (see <a
+href="#sec:addkey">§<span
+class="cmbx-10">??</span>sec:addkey </a><a
href="#sec:addkey">Additional
Keys<!--tex4ht:ref: sec:addkey --></a>).
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 5863--><p class="noindent" >
<span
class="cmtt-10">nonumberlist</span><a
- id="dx1-112110"></a> </dt><dd
-class="description">A boolean key. If the value is missing or is <span
+ id="dx1-113123"></a> </p></dt><dd
+class="description">
+ <!--l. 5863--><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-112111"></a></a> just for this entry. Conversely, if you have used the package option <span
+href="#glo:numberlist">number list<a
+ id="dx1-113124"></a></a> just for this
+ entry. Conversely, if you have used the package option <span
class="cmss-10">nonumberlist</span><a
- id="dx1-112112"></a>, you
- can activate the number list<a
- id="dx1-112113"></a> just for this entry with <span
+ id="dx1-113125"></a>, you can activate the
+ number list<a
+ id="dx1-113126"></a> just for this entry with <span
class="cmtt-10">nonumberlist=false</span><a
- id="dx1-112114"></a>. (See <a
-href="#sec:numberlists">§5 </a><a
+ id="dx1-113127"></a>. (See <a
+href="#sec:numberlists">§<span
+class="cmbx-10">??</span>sec:numberlists </a><a
href="#sec:numberlists">Number
- lists<!--tex4ht:ref: sec:numberlists --></a>.)
- </dd><dt class="description">
+ Lists<!--tex4ht:ref: sec:numberlists --></a>.)
+ </p></dd><dt class="description">
+ <!--l. 5870--><p class="noindent" >
<span
class="cmtt-10">see</span><a
- id="dx1-112115"></a> </dt><dd
-class="description">Cross-reference another entry. Using the <span
-class="cmtt-10">see</span><a
- id="dx1-112116"></a> key will <span
-class="cmti-10">automatically add this entry to the glossary</span>, but will
- not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to
- this key. If you want to override the “see” tag, you can supply the new tag in square brackets before the
- label. For example <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">see=[see</span><span
-class="cmtt-10"> also]{anotherlabel}</span></span></span>. <strong>Note that if you have suppressed the <a
-href="#glo:numberlist">number list<a
- id="dx1-112117"></a></a>,
- the cross-referencing information won’t appear in the glossary, as it forms part of the number list<a
- id="dx1-112118"></a>.</strong> You can
- override this for individual glossary entries using <span
-class="cmtt-10">nonumberlist=false</span><a
- id="dx1-112119"></a> (see above). Alternatively, you
- can use the <span
-class="cmss-10">seeautonumberlist</span><a
- id="dx1-112120"></a> package option. For further details, see <a
-href="#sec:crossref">§8 </a><a
-href="#sec:crossref">Cross-Referencing
- Entries<!--tex4ht:ref: sec:crossref --></a>.
- <!--l. 5723--><p class="noindent" >This key essentially provides a convenient shortcut that performs </p><div class="alltt">
+ id="dx1-113128"></a> </p></dt><dd
+class="description">
+ <!--l. 5870--><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
@@ -12588,35 +13153,100 @@
class="cmitt-10"> list</span>⟩<span
class="cmtt-10">}</span>
</div>
- </div> after the entry has been defined.
- <!--l. 5729--><p class="noindent" ><div class="important" title="Important Note"> For Options <a
+
+
+ </div> after the entry has been defined. (See <a
+href="#sec:crossref">§<span
+class="cmbx-10">??</span>sec:crossref </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-113129"></a>s</a>.
+ <!--l. 5881--><p class="noindent" ><div class="important" title="Important Note"> Using the <span
+class="cmtt-10">see</span><a
+ id="dx1-113130"></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. 5885--><p class="noindent" >
+ </p><!--l. 5887--><p class="noindent" >For example:
+
+
+</p>
+ <pre class="verbatim" id="verbatim-140">
+ \newglossaryentry{courgette}{name={courgette},
+   description={variety of small marrow}}
+ \newglossaryentry{zucchini}{name={zucchini},
+   description={(North American)},
+   see={courgette}}
+</pre>
+ <!--l. 5894--><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-113131"></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-113132"></a></a>. (Page 1, if the
+ definitions occur in the preamble.)
+ </p><!--l. 5902--><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-141">
+ \newglossaryentry{zucchini}{name={zucchini},
+   description={(North American) see \gls{courgette}}}
+</pre>
+ <!--l. 5907--><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. 5912--><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-113133"></a></a>, the cross-referencing
+ information won’t appear in the glossary, as it forms part of the number list<a
+ id="dx1-113134"></a>.</strong> You can override this for
+ individual glossary entries using <span
+class="cmtt-10">nonumberlist=false</span><a
+ id="dx1-113135"></a> (see above). Alternatively, you can use the
+ <span
+class="cmss-10">seeautonumberlist</span><a
+ id="dx1-113136"></a> package option. For further details, see <a
+href="#sec:crossref">§<span
+class="cmbx-10">??</span>sec:crossref </a><a
+href="#sec:crossref">Cross-Referencing
+ Entries<!--tex4ht:ref: sec:crossref --></a>.
+ </p><!--l. 5923--><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-112121"></a> must be used before any occurrence of <span
+ id="dx1-113137"></a> must be used before any occurrence of <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-112122"></a> that
+ id="dx1-113138"></a> that
contains the <span
class="cmtt-10">see</span><a
- id="dx1-112123"></a> key. This key should not be used with entries defined in the <span
+ id="dx1-113139"></a> key. This key should not be used with entries defined in the <span
class="cmss-10">document</span><a
- id="dx1-112124"></a><a
- id="dx1-112125"></a> environment.
+ id="dx1-113140"></a><a
+ id="dx1-113141"></a> environment.
</div>
-
-
- </p><!--l. 5733--><p class="noindent" >
+ </p><!--l. 5927--><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-112126"></a> package option to warn or ignore the <span
+ id="dx1-113142"></a> package option to warn or ignore the <span
class="cmtt-10">see</span><a
- id="dx1-112127"></a> key while <span
+ id="dx1-113143"></a> key while <span
class="cmtt-10">\makeglossaries </span>is commented
out.
- </p><!--l. 5739--><p class="noindent" >If you use the <span
+ </p><!--l. 5933--><p class="noindent" >If you use the <span
class="cmtt-10">see</span><a
- id="dx1-112128"></a> key, you may want to consider using the <a
+ id="dx1-113144"></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
@@ -12623,39 +13253,59 @@
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-112129"></a> key,
+ id="dx1-113145"></a> key,
consider using <a
-href="#option4">Option 4</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. 5940--><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-113146"></a></a> <span
+class="cmtt-10">see</span><a
+ id="dx1-113147"></a> field (and <span id="textcolor260"><span id="textcolor261"><span
+class="cmtt-10">seealso</span></span><a
+ id="dx1-113148"></a></span>) have a slightly different meaning. The <span id="textcolor262"><span
+class="cmtt-10">selection</span></span><a
+ id="dx1-113149"></a>
+ resource option determines the behaviour. </div>
+ </p><!--l. 5944--><p class="noindent" >
</p></dd><dt class="description">
-<span id="textcolor253"><span id="textcolor254"><span
+ <!--l. 5946--><p class="noindent" >
+<span id="textcolor263"><span id="textcolor264"><span
class="cmtt-10">seealso</span></span><a
- id="dx1-112130"></a></span> </dt><dd
-class="description">This key is only available with <a
+ id="dx1-113150"></a></span> </p></dt><dd
+class="description">
+ <!--l. 5946--><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-112131"></a> but it doesn’t allow for the
- optional tag. The <a
+ id="dx1-113151"></a> but it doesn’t allow for the optional
+ tag. The <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor255"><span
+class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor265"><span
class="cmtt-10">\seealsoname</span></span><a
- id="dx1-112132"></a> and <span
+ id="dx1-113152"></a> and <span
class="cmtt-10">seealso={</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span>is essentially like
<span
-class="cmtt-10">see=[</span><span id="textcolor256"><span
+class="cmtt-10">see=[</span><span id="textcolor266"><span
class="cmtt-10">\seealsoname</span></span><a
- id="dx1-112133"></a><span
+ id="dx1-113153"></a><span
class="cmtt-10">]</span>⟨<span
class="cmitt-10">list</span>⟩ (Options <a
href="#option3">3</a> and <a
href="#option4">4</a> may treat these differently).
- </dd><dt class="description">
-<span id="textcolor257"><span id="textcolor258"><span
+ </p></dd><dt class="description">
+ <!--l. 5954--><p class="noindent" >
+<span id="textcolor267"><span id="textcolor268"><span
class="cmtt-10">alias</span></span><a
- id="dx1-112134"></a></span> </dt><dd
-class="description">This key is only available with <a
+ id="dx1-113154"></a></span> </p></dt><dd
+class="description">
+
+
+ <!--l. 5954--><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
@@ -12668,15 +13318,20 @@
behaviour of commands like <span
class="cmtt-10">\gls </span>so that they index the entry given by ⟨<span
class="cmti-10">label</span>⟩ instead of the original entry.
- More variations with the key are available with <a
+ (See, for example, <a
+href="https://www.dickimaw-books.com/gallery/index.php?label=aliases" >Gallery: Aliases</a>.)
+ </p><!--l. 5963--><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-112135"></a></a>.
- </dd><dt class="description">
-<span id="textcolor259"><span id="textcolor260"><span
+ id="dx1-113155"></a></a>. </div>
+ </p><!--l. 5965--><p class="noindent" >
+ </p></dd><dt class="description">
+ <!--l. 5967--><p class="noindent" >
+<span id="textcolor269"><span id="textcolor270"><span
class="cmtt-10">category</span></span><a
- id="dx1-112136"></a></span> </dt><dd
-class="description">This key is only available with <a
+ id="dx1-113156"></a></span> </p></dt><dd
+class="description">
+ <!--l. 5967--><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
@@ -12683,88 +13338,92 @@
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual for further
details.
+</p>
</dd></dl>
-<!--l. 5770--><p class="indent" > The following keys are reserved for <span
+<!--l. 5975--><p class="indent" > The following keys are reserved for <span
class="cmtt-10">\newacronym</span><a
- id="dx1-112137"></a> (see <a
-href="#sec:acronyms">§13 </a><a
+ id="dx1-113157"></a> (see <a
+href="#sec:acronyms">§<span
+class="cmbx-10">??</span>sec:acronyms </a><a
href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>)
-and also for <span id="textcolor261"><span
+and also for <span id="textcolor271"><span
class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-112138"></a> (see the <a
+ id="dx1-113158"></a> (see the <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> manual): <span
class="cmtt-10">long</span><a
- id="dx1-112139"></a>, <span
+ id="dx1-113159"></a>, <span
class="cmtt-10">longplural</span><a
- id="dx1-112140"></a>, <span
+ id="dx1-113160"></a>, <span
class="cmtt-10">short</span><a
- id="dx1-112141"></a> and
+ id="dx1-113161"></a> and
<span
class="cmtt-10">shortplural</span><a
- id="dx1-112142"></a>.
-</p><!--l. 5775--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> There are also special internal field names used by <a
+ id="dx1-113162"></a>.
+</p><!--l. 5980--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> There are also special internal field names used by <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-112143"></a></a>. See the <a
+ id="dx1-113163"></a></a>. See the <a
href="#glo:bib2gls"><span
class="cmtt-10">bib2gls</span><a
- id="dx1-112144"></a></a> manual for further details.
+ id="dx1-113164"></a></a> manual for further details.
</div>
-</p><!--l. 5778--><p class="noindent" >
-</p><!--l. 5780--><p class="indent" > The supplementary packages <span
+</p><!--l. 5983--><p class="noindent" >
+</p><!--l. 5985--><p class="indent" > The supplementary packages <span
class="cmss-10">glossaries-prefix </span>(<a
-href="#sec:prefix">§17 </a><a
+href="#sec:prefix">§<span
+class="cmbx-10">??</span>sec:prefix </a><a
href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span
-class="cmss-10">glossaries-accsupp </span>(<a
-href="#sec:accsupp">§18
-</a><a
+class="cmss-10">glossaries-accsupp</span>
+(<a
+href="#sec:accsupp">§<span
+class="cmbx-10">??</span>sec:accsupp </a><a
href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>) provide additional keys.
-</p><!--l. 5783--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a
+</p><!--l. 5988--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a
href="#sec:gls-like"><span
class="cmtt-10">\gls</span>-like</a> or <a
href="#sec:glstext-like"><span
class="cmtt-10">\glstext</span>-like</a> commands within the <span
class="cmtt-10">text</span><a
- id="dx1-112145"></a>, <span
+ id="dx1-113165"></a>, <span
class="cmtt-10">first</span><a
- id="dx1-112146"></a>, <span
+ id="dx1-113166"></a>, <span
class="cmtt-10">short</span><a
- id="dx1-112147"></a> or <span
+ id="dx1-113167"></a> or <span
class="cmtt-10">long</span><a
- id="dx1-112148"></a> keys
+ id="dx1-113168"></a> keys
(or their plural equivalent) or any other key that you plan to access through those commands. (For example, the
<span
class="cmtt-10">symbol</span><a
- id="dx1-112149"></a> key if you intend to use <span
+ id="dx1-113169"></a> key if you intend to use <span
class="cmtt-10">\glssymbol</span>.) Otherwise you end up with nested links, which can cause
complications and they won’t work with the case-changing commands. You can use them within the value of
keys that won’t be accessed through those commands. For example, the <span
class="cmtt-10">description</span><a
- id="dx1-112150"></a> key if you don’t
+ id="dx1-113170"></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. 5796--><p class="noindent" >
-</p><!--l. 5798--><p class="indent" > Note that if the name starts with <a
+</p><!--l. 6001--><p class="noindent" >
+</p><!--l. 6003--><p class="indent" > Note that if the name starts with <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-112151"></a></a>, you must group the character, otherwise it will cause
+ id="dx1-113171"></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-112152"></a> and <span
+ id="dx1-113172"></a> and <span
class="cmtt-10">\Glspl</span><a
- id="dx1-112153"></a>. For example:
+ id="dx1-113173"></a>. For example:
</p>
- <div class="verbatim" id="verbatim-136">
+ <pre class="verbatim" id="verbatim-142">
\newglossaryentry{elite}{name={{\'e}lite},
- <br />description={select group or class}}
-</div>
-<!--l. 5805--><p class="nopar" > Note that the same applies if you are using the <span
+description={select group or class}}
+</pre>
+<!--l. 6010--><p class="nopar" > Note that the same applies if you are using the <span
class="cmss-10">inputenc</span><a
- id="dx1-112154"></a> package: </p><div class="alltt">
+ id="dx1-113174"></a> package: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{elite}{name={{</span><span
@@ -12776,76 +13435,74 @@
class="cmtt-10"> or</span><span
class="cmtt-10"> class}}</span>
</div>
-</div> (This doesn’t apply for XeLaTeX documents using the <span
-class="cmss-10">fontspec</span><a
- id="dx1-112155"></a> package. For further details, see the “UTF-8”
-section in the <span
+</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-112156"></a> user manual.)
-<!--l. 5816--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span
+ id="dx1-113175"></a> user manual.)
+<!--l. 6021--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span
class="cmtt-10">sort</span><a
- id="dx1-112157"></a> key if you are
+ id="dx1-113176"></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-112158"></a></a> (<a
+ id="dx1-113177"></a></a> (<a
href="#option3">Option 3</a>) is usually able to sort <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-112159"></a>s</a> correctly.
+ id="dx1-113178"></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-112160"></a>s</a> unless you use the
+ id="dx1-113179"></a>s</a> unless you use the
<span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-112161"></a>.
+ id="dx1-113180"></a>.
</p>
-<!--l. 5824--><p class="noindent" ><a
+<!--l. 6029--><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. 5827--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define a term. If you omit this,
+<!--l. 6032--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define a term. If you omit this,
the plural will be obtained by appending
-</p><!--l. 5830--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113001"></a> <span
+</p><!--l. 6035--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-114001"></a> <span
class="cmtt-10">\glspluralsuffix </span></div><hr>
-</p><!--l. 5832--><p class="noindent" >
+</p><!--l. 6037--><p class="noindent" >
to the singular form. This command defaults to the letter “s”. For example:
</p>
- <div class="verbatim" id="verbatim-137">
+ <pre class="verbatim" id="verbatim-143">
\newglossaryentry{cow}{name=cow,description={a fully grown
- <br />female of any bovine animal}}
-</div>
-<!--l. 5838--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in
+female of any bovine animal}}
+</pre>
+<!--l. 6043--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in
archaic English, you may want to use “kine” as the plural form, in which case you would have to
do:
</p>
- <div class="verbatim" id="verbatim-138">
+ <pre class="verbatim" id="verbatim-144">
\newglossaryentry{cow}{name=cow,plural=kine,
- <br />description={a fully grown female of any bovine animal}}
-</div>
-<!--l. 5846--><p class="nopar" >
-</p><!--l. 5848--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use the <span
+description={a fully grown female of any bovine animal}}
+</pre>
+<!--l. 6051--><p class="nopar" >
+</p><!--l. 6053--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use the <span
class="cmtt-10">plural</span><a
- id="dx1-113002"></a> key for
+ id="dx1-114002"></a> key for
one of them and one of the user keys to specify the other plural form. For example:
</p>
- <div class="verbatim" id="verbatim-139">
+ <pre class="verbatim" id="verbatim-145">
\newglossaryentry{cow}{%
- <br />  name=cow,%
- <br />  description={a fully grown female of any bovine animal
- <br />               (plural cows, archaic plural kine)},%
- <br />  user1={kine}}
-</div>
-<!--l. 5858--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span
+  name=cow,%
+  description={a fully grown female of any bovine animal
+               (plural cows, archaic plural kine)},%
+  user1={kine}}
+</pre>
+<!--l. 6063--><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:
@@ -12852,16 +13509,17 @@
</p>
- <div class="verbatim" id="verbatim-140">
+ <pre class="verbatim" id="verbatim-146">
\let\glsaltpl\glsuseri
-</div>
-<!--l. 5864--><p class="nopar" > Then you don’t have to remember which key you used to store the second plural. Alternatively, you can define
+</pre>
+<!--l. 6069--><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-113003"></a>, described in <a
-href="#sec:addkey">§4.3 </a><a
+ id="dx1-114003"></a>, described in <a
+href="#sec:addkey">§<span
+class="cmbx-10">??</span>sec:addkey </a><a
href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 5869--><p class="indent" > If you are using a language that usually forms plurals by appending a different letter, or sequence of letters,
+</p><!--l. 6074--><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
@@ -12868,77 +13526,80 @@
languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the
<span
class="cmtt-10">plural</span><a
- id="dx1-113004"></a> key (and the <span
+ id="dx1-114004"></a> key (and the <span
class="cmtt-10">firstplural</span><a
- id="dx1-113005"></a> key where necessary).
-</p><!--l. 5877--><p class="noindent" >
+ id="dx1-114005"></a> key where necessary).
+</p><!--l. 6082--><p class="noindent" >
</p>
-<!--l. 5877--><p class="noindent" ><a
+<!--l. 6082--><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. 5880--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example:
+<!--l. 6085--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example:
</p>
- <div class="verbatim" id="verbatim-141">
+ <pre class="verbatim" id="verbatim-147">
\let\glsing\glsuseri
- <br />\let\glsd\glsuserii
- <br />\newcommand*{\ingkey}{user1}
- <br />\newcommand*{\edkey}{user2}
- <br />\newcommand*{\newword}[3][]{%
- <br />  \newglossaryentry{#2}{%
- <br />   name={#2},%
- <br />   description={#3},%
- <br />   \edkey={#2ed},%
- <br />   \ingkey={#2ing},#1%
- <br />  }%
- <br />}
-</div>
-<!--l. 5897--><p class="nopar" > With the above definitions, I can now define terms like this:
+\let\glsd\glsuserii
+\newcommand*{\ingkey}{user1}
+\newcommand*{\edkey}{user2}
+\newcommand*{\newword}[3][]{%
+  \newglossaryentry{#2}{%
+   name={#2},%
+   description={#3},%
+   \edkey={#2ed},%
+   \ingkey={#2ing},#1%
+  }%
+}
+</pre>
+<!--l. 6102--><p class="nopar" > With the above definitions, I can now define terms like this:
</p>
- <div class="verbatim" id="verbatim-142">
+ <pre class="verbatim" id="verbatim-148">
\newword{play}{to take part in activities for enjoyment}
- <br />\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using
- <br />the legs}
-</div>
-<!--l. 5903--><p class="nopar" > and use them in the text:
+\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using
+the legs}
+</pre>
+<!--l. 6108--><p class="nopar" > and use them in the text:
</p>
- <div class="verbatim" id="verbatim-143">
+ <pre class="verbatim" id="verbatim-149">
Peter is \glsing{play} in the park today.
- <br />Jane \glsd{play} in the park yesterday.
- <br />Peter and Jane \glsd{run} in the park last week.
-</div>
-<!--l. 5911--><p class="nopar" >
-</p><!--l. 5913--><p class="indent" > Alternatively, you can define your own keys using <span
+Jane \glsd{play} in the park yesterday.
+Peter and Jane \glsd{run} in the park last week.
+</pre>
+<!--l. 6116--><p class="nopar" >
+</p><!--l. 6118--><p class="indent" > Alternatively, you can define your own keys using <span
class="cmtt-10">\glsaddkey</span><a
- id="dx1-114001"></a>, described below in <a
-href="#sec:addkey">§4.3 </a><a
+ id="dx1-115001"></a>, described below in <a
+href="#sec:addkey">§<span
+class="cmbx-10">??</span>sec:addkey </a><a
href="#sec:addkey">Additional
Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 5916--><p class="noindent" >
+</p><!--l. 6121--><p class="noindent" >
</p>
-<!--l. 5916--><p class="noindent" ><a
+<!--l. 6121--><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. 5919--><p class="noindent" >You can now also define your own custom keys using the commands described in this section. There are two
+<!--l. 6124--><p class="noindent" >You can now also define your own custom keys using the commands described in this section. There are two
types of keys: those for use within the document and those to store information used behind the scenes by other
commands.
-</p><!--l. 5924--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you might want to
+</p><!--l. 6129--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you might want to
reference this unit in your document. In this case use <span
class="cmtt-10">\glsaddkey </span>described in <a
-href="#sec:glsaddkey">§4.3.1 </a><a
-href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>. If, on the
-other hand, you want to add a key to indicate to a glossary style or acronym style that this entry should be
-formatted differently to other entries, then you can use <span
-class="cmtt-10">\glsaddstoragekey </span>described in <a
-href="#sec:glsaddstoragekey">§4.3.2 </a><a
-href="#sec:glsaddstoragekey">Storage
-Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>.
-</p><!--l. 5932--><p class="indent" > In both cases, a new command ⟨<span
+href="#sec:glsaddkey">§<span
+class="cmbx-10">??</span>sec:glsaddkey </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">??</span>sec:glsaddstoragekey </a><a
+href="#sec:glsaddstoragekey">Storage Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>.
+</p><!--l. 6137--><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
@@ -12946,14 +13607,14 @@
class="cmtt-10">\glsaddkey </span>or
<span
class="cmtt-10">\glsaddstoragekey </span>before glossary entries are defined.
-</p><!--l. 5939--><p class="noindent" >
+</p><!--l. 6144--><p class="noindent" >
</p>
-<!--l. 5939--><p class="noindent" ><a
+<!--l. 6144--><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. 5942--><p class="noindent" >A custom key that can be used in the document is defined using:
-</p><!--l. 5943--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-116001"></a> <span
+<!--l. 6147--><p class="noindent" >A custom key that can be used in the document is defined using:
+</p><!--l. 6148--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-117001"></a> <span
class="cmtt-10">\glsaddkey{</span>⟨<span
class="cmitt-10">key</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -12971,67 +13632,81 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">link allcaps cs</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5951--><p class="noindent" >
+</p><!--l. 6156--><p class="noindent" >
where:
</p><dl class="description"><dt class="description">
+ <!--l. 6159--><p class="noindent" >
⟨<span
-class="cmbxti-10">key</span>⟩ </dt><dd
-class="description">is the new key to use in <span
+class="cmbxti-10">key</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6159--><p class="noindent" >is the new key to use in <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-116002"></a> (or similar commands such as
+ id="dx1-117002"></a> (or similar commands such as
<span
class="cmtt-10">\longnewglossaryentry</span><a
- id="dx1-116003"></a>);
+ id="dx1-117003"></a>);
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 6161--><p class="noindent" >
⟨<span
-class="cmbxti-10">default value</span>⟩ </dt><dd
-class="description">is the default value to use if this key isn’t used in an entry definition (this may reference
- the current entry label via <span
-class="cmtt-10">\glslabel</span>, but you will have to switch on expansion via the starred
- version of <span
+class="cmbxti-10">default value</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6161--><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);
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 6166--><p class="noindent" >
⟨<span
-class="cmbxti-10">no link cs</span>⟩ </dt><dd
-class="description">is the control sequence to use analogous to commands like <span
+class="cmbxti-10">no link cs</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6166--><p class="noindent" >is the control sequence to use analogous to commands like <span
class="cmtt-10">\glsentrytext</span><a
- id="dx1-116004"></a>;
- </dd><dt class="description">
+ id="dx1-117004"></a>;
+ </p></dd><dt class="description">
+ <!--l. 6168--><p class="noindent" >
⟨<span
-class="cmbxti-10">no link ucfirst cs</span>⟩ </dt><dd
-class="description">is the control sequence to use analogous to commands like <span
+class="cmbxti-10">no link ucfirst cs</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6168--><p class="noindent" >is the control sequence to use analogous to commands like <span
class="cmtt-10">\Glsentrytext</span><a
- id="dx1-116005"></a>;
- </dd><dt class="description">
+ id="dx1-117005"></a>;
+ </p></dd><dt class="description">
+ <!--l. 6170--><p class="noindent" >
⟨<span
-class="cmbxti-10">link cs</span>⟩ </dt><dd
-class="description">is the control sequence to use analogous to commands like <span
+class="cmbxti-10">link cs</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6170--><p class="noindent" >is the control sequence to use analogous to commands like <span
class="cmtt-10">\glstext</span><a
- id="dx1-116006"></a>;
- </dd><dt class="description">
+ id="dx1-117006"></a>;
+ </p></dd><dt class="description">
+ <!--l. 6172--><p class="noindent" >
⟨<span
-class="cmbxti-10">link ucfirst cs</span>⟩ </dt><dd
-class="description">is the control sequence to use analogous to commands like <span
+class="cmbxti-10">link ucfirst cs</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6172--><p class="noindent" >is the control sequence to use analogous to commands like <span
class="cmtt-10">\Glstext</span><a
- id="dx1-116007"></a>;
- </dd><dt class="description">
+ id="dx1-117007"></a>;
+ </p></dd><dt class="description">
+ <!--l. 6174--><p class="noindent" >
⟨<span
-class="cmbxti-10">link allcaps cs</span>⟩ </dt><dd
-class="description">is the control sequence to use analogous to commands like <span
+class="cmbxti-10">link allcaps cs</span>⟩ </p></dt><dd
+class="description">
+ <!--l. 6174--><p class="noindent" >is the control sequence to use analogous to commands like <span
class="cmtt-10">\GLStext</span><a
- id="dx1-116008"></a>.</dd></dl>
-<!--l. 5972--><p class="noindent" >The starred version of <span
+ id="dx1-117008"></a>.</p></dd></dl>
+<!--l. 6177--><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="ex:addkey"></a>
-</p><!--l. 5976--><p class="noindent" ><span
+</p><!--l. 6181--><p class="noindent" ><span
class="cmbx-12">Example 3</span><span
class="cmbx-12"> (Defining Custom Keys)</span><a
- id="x1-116010"></a>
-</p><!--l. 5977--><p class="indent" > Suppose I want to define two new keys, <span
+ id="x1-117010"></a>
+</p><!--l. 6182--><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
@@ -13039,68 +13714,68 @@
</p>
- <div class="verbatim" id="verbatim-144">
+ <pre class="verbatim" id="verbatim-150">
 % Define "ed" key:
- <br /> \glsaddkey*
- <br />  {ed}% key
- <br />  {\glsentrytext{\glslabel}ed}% default value
- <br />  {\glsentryed}% command analogous to \glsentrytext
- <br />  {\Glsentryed}% command analogous to \Glsentrytext
- <br />  {\glsed}% command analogous to \glstext
- <br />  {\Glsed}% command analogous to \Glstext
- <br />  {\GLSed}% command analogous to \GLStext
- <br /> % Define "ing" key:
- <br /> \glsaddkey*
- <br />  {ing}% key
- <br />  {\glsentrytext{\glslabel}ing}% default value
- <br />  {\glsentrying}% command analogous to \glsentrytext
- <br />  {\Glsentrying}% command analogous to \Glsentrytext
- <br />  {\glsing}% command analogous to \glstext
- <br />  {\Glsing}% command analogous to \Glstext
- <br />  {\GLSing}% command analogous to \GLStext
-</div>
-<!--l. 6001--><p class="nopar" > Now I can define some entries:
+ \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. 6206--><p class="nopar" > Now I can define some entries:
</p>
- <div class="verbatim" id="verbatim-145">
+ <pre class="verbatim" id="verbatim-151">
 % No need to override defaults for this entry:
- <br /> \newglossaryentry{jump}{name={jump},description={}}
- <br /> % Need to override defaults on these entries:
- <br /> \newglossaryentry{run}{name={run},%
- <br />   ed={ran},%
- <br />   ing={running},%
- <br />   description={}}
- <br /> \newglossaryentry{waddle}{name={waddle},%
- <br />   ed={waddled},%
- <br />   ing={waddling},%
- <br />   description={}}
-</div>
-<!--l. 6019--><p class="nopar" >
-</p><!--l. 6021--><p class="indent" > These entries can later be used in the document:
+ \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. 6224--><p class="nopar" >
+</p><!--l. 6226--><p class="indent" > These entries can later be used in the document:
</p>
- <div class="verbatim" id="verbatim-146">
+ <pre class="verbatim" id="verbatim-152">
The dog \glsed{jump} over the duck.
- <br />The duck was \glsing{waddle} round the dog.
- <br />The dog \glsed{run} away from the duck.
-</div>
-<!--l. 6028--><p class="nopar" > For a complete document, see the sample file <a
+The duck was \glsing{waddle} round the dog.
+The dog \glsed{run} away from the duck.
+</pre>
+<!--l. 6233--><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. 6030--><p class="noindent" >
-</p><!--l. 6030--><p class="noindent" >____________________________</p></div>
-<!--l. 6032--><p class="noindent" >
+<!--l. 6235--><p class="noindent" >
+</p><!--l. 6235--><p class="noindent" >____________________________</p></div>
+<!--l. 6237--><p class="noindent" >
</p>
-<!--l. 6032--><p class="noindent" ><a
+<!--l. 6237--><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. 6035--><p class="noindent" >A custom key that can be used for simply storing information is defined using:
-</p><!--l. 6037--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-117001"></a> <span
+<!--l. 6240--><p class="noindent" >A custom key that can be used for simply storing information is defined using:
+</p><!--l. 6242--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-118001"></a> <span
class="cmtt-10">\glsaddstoragekey{</span>⟨<span
class="cmitt-10">key</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -13108,31 +13783,33 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">no link cs</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 6039--><p class="noindent" >
+</p><!--l. 6244--><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">§4.3.1 </a><a
-href="#sec:glsaddkey">Document
-Keys<!--tex4ht:ref: sec:glsaddkey --></a>.
-</p><!--l. 6043--><p class="indent" > This is essentially the same as <span
+href="#sec:glsaddkey">§<span
+class="cmbx-10">??</span>sec:glsaddkey
+</a><a
+href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>.
+</p><!--l. 6248--><p class="indent" > This is essentially the same as <span
class="cmtt-10">\glsaddkey </span>except that it doesn’t define the additional commands. You can
access or update the value of your new field using the commands described in <a
-href="#sec:fetchset">§16.3 </a><a
-href="#sec:fetchset">Fetching and Updating the
-Value of a Field<!--tex4ht:ref: sec:fetchset --></a>.
+href="#sec:fetchset">§<span
+class="cmbx-10">??</span>sec:fetchset </a><a
+href="#sec:fetchset">Fetching and
+Updating the Value of a Field<!--tex4ht:ref: sec:fetchset --></a>.
<a
id="ex:addstoragekey"></a>
-</p><!--l. 6048--><p class="noindent" ><span
+</p><!--l. 6253--><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-117003"></a>
-</p><!--l. 6049--><p class="indent" > Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all
+ id="x1-118003"></a>
+</p><!--l. 6254--><p class="indent" > Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all
in the same glossary and I want the acronyms on first use to be displayed with the short form followed by the
long form in parentheses, but the opposite way round for other forms of abbreviations. (The <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>
package provides a simpler way of achieving this.)
-</p><!--l. 6056--><p class="indent" > Here I can define a new key that determines whether the term is actually an acronym rather
+</p><!--l. 6261--><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
@@ -13140,138 +13817,138 @@
</p>
- <div class="verbatim" id="verbatim-147">
+ <pre class="verbatim" id="verbatim-153">
\glsaddstoragekey
- <br /> {abbrtype}% key/field name
- <br /> {word}% default value if not explicitly set
- <br /> {\abbrtype}% custom command to access the value if required
-</div>
-<!--l. 6065--><p class="nopar" >
-</p><!--l. 6067--><p class="indent" > Now I can define a style that looks up the value of this new key to determine how to display the full
+ {abbrtype}% key/field name
+ {word}% default value if not explicitly set
+ {\abbrtype}% custom command to access the value if required
+</pre>
+<!--l. 6270--><p class="nopar" >
+</p><!--l. 6272--><p class="indent" > Now I can define a style that looks up the value of this new key to determine how to display the full
form:
</p>
- <div class="verbatim" id="verbatim-148">
+ <pre class="verbatim" id="verbatim-154">
\newacronymstyle
- <br /> {mystyle}% style name
- <br /> {% Use the generic display
- <br />   \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
- <br /> }
- <br /> {% Put the long form in the description
- <br />   \renewcommand*{\GenericAcronymFields}{%
- <br />       description={\the\glslongtok}}%
- <br />   % For the full format, test the value of the "abbrtype" key.
- <br />   % If it's set to "word" put the short form first with
- <br />   % the long form in brackets.
- <br />   \renewcommand*{\genacrfullformat}[2]{%
- <br />    \ifglsfieldeq{##1}{abbrtype}{word}
- <br />    {% is a proper acronym
- <br />      \protect\firstacronymfont{\glsentryshort{##1}}##2\space
- <br />       (\glsentrylong{##1})%
- <br />    }
- <br />    {% is another form of abbreviation
- <br />     \glsentrylong{##1}##2\space
- <br />      (\protect\firstacronymfont{\glsentryshort{##1}})%
- <br />    }%
- <br />  }%
- <br />  % first letter upper case version:
- <br />   \renewcommand*{\Genacrfullformat}[2]{%
- <br />    \ifglsfieldeq{##1}{abbrtype}{word}
- <br />    {% is a proper acronym
- <br />      \protect\firstacronymfont{\Glsentryshort{##1}}##2\space
- <br />       (\glsentrylong{##1})%
- <br />    }
- <br />    {% is another form of abbreviation
- <br />     \Glsentrylong{##1}##2\space
- <br />      (\protect\firstacronymfont{\glsentryshort{##1}})%
- <br />    }%
- <br />  }%
- <br />  % plural
- <br />   \renewcommand*{\genplacrfullformat}[2]{%
- <br />    \ifglsfieldeq{##1}{abbrtype}{word}
- <br />    {% is a proper acronym
- <br />      \protect\firstacronymfont{\glsentryshortpl{##1}}##2\space
- <br />       (\glsentrylong{##1})%
- <br />    }
- <br />    {% is another form of abbreviation
- <br />     \glsentrylongpl{##1}##2\space
- <br />      (\protect\firstacronymfont{\glsentryshortpl{##1}})%
- <br />    }%
- <br />  }%
+ {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}})%
+    }%
+  }%
- <br />  % plural and first letter upper case
- <br />  \renewcommand*{\Genplacrfullformat}[2]{%
- <br />    \ifglsfieldeq{##1}{abbrtype}{word}
- <br />    {% is a proper acronym
- <br />      \protect\firstacronymfont{\Glsentryshortpl{##1}}##2\space
- <br />       (\glsentrylong{##1})%
- <br />    }
- <br />    {% is another form of abbreviation
- <br />     \Glsentrylongpl{##1}##2\space
- <br />      (\protect\firstacronymfont{\glsentryshortpl{##1}})%
- <br />    }%
- <br />  }%
- <br />  % Just use the short form as the name part in the glossary:
- <br />  \renewcommand*{\acronymentry}[1]{%
- <br />     \acronymfont{\glsentryshort{##1}}}%
- <br />  % Sort by the short form:
- <br />  \renewcommand*{\acronymsort}[2]{##1}%
- <br />  % Just use the surrounding font for the short form:
- <br />  \renewcommand*{\acronymfont}[1]{##1}%
- <br />  % Same for first use:
- <br />  \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}%
- <br />  % Default plural suffix if the plural isn't explicitly set
- <br />  \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%
- <br /> }
-</div>
-<!--l. 6140--><p class="nopar" > Remember that the new style needs to be set before defining any terms:
+  % 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. 6345--><p class="nopar" > Remember that the new style needs to be set before defining any terms:
</p>
- <div class="verbatim" id="verbatim-149">
+ <pre class="verbatim" id="verbatim-155">
\setacronymstyle{mystyle}
-</div>
-<!--l. 6145--><p class="nopar" >
-</p><!--l. 6147--><p class="indent" > Since it’s a bit confusing to use <span
+</pre>
+<!--l. 6350--><p class="nopar" >
+</p><!--l. 6352--><p class="indent" > Since it’s a bit confusing to use <span
class="cmtt-10">\newacronym</span><a
- id="dx1-117004"></a> for something that’s not technically an acronym, let’s define a
+ id="dx1-118004"></a> for something that’s not technically an acronym, let’s define a
new command for initialisms:
</p>
- <div class="verbatim" id="verbatim-150">
+ <pre class="verbatim" id="verbatim-156">
\newcommand*{\newinitialism}[4][]{%
- <br />  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%
- <br />}
-</div>
-<!--l. 6154--><p class="nopar" > Now the entries can all be defined:
+  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%
+}
+</pre>
+<!--l. 6359--><p class="nopar" > Now the entries can all be defined:
</p>
- <div class="verbatim" id="verbatim-151">
+ <pre class="verbatim" id="verbatim-157">
\newacronym{radar}{radar}{radio detecting and ranging}
- <br />\newacronym{laser}{laser}{light amplification by stimulated
- <br />emission of radiation}
- <br />\newacronym{scuba}{scuba}{self-contained underwater breathing
- <br />apparatus}
- <br />\newinitialism{dsp}{DSP}{digital signal processing}
- <br />\newinitialism{atm}{ATM}{automated teller machine}
-</div>
-<!--l. 6164--><p class="nopar" > On <a
+\newacronym{laser}{laser}{light amplification by stimulated
+emission of radiation}
+\newacronym{scuba}{scuba}{self-contained underwater breathing
+apparatus}
+\newinitialism{dsp}{DSP}{digital signal processing}
+\newinitialism{atm}{ATM}{automated teller machine}
+</pre>
+<!--l. 6369--><p class="nopar" > On <a
href="#glo:firstuse">first use</a>, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{radar}</span></span></span> will produce “radar (radio detecting and ranging)” but <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{dsp}</span></span></span> will produce
“DSP (digital signal processing)”.
-</p><!--l. 6169--><p class="indent" > For a complete document, see the sample file <a
+</p><!--l. 6374--><p class="indent" > For a complete document, see the sample file <a
href="#ex:sample-storage-abbr"><span
class="cmtt-10">sample-storage-abbr.tex</span></a>. </p>
<div class="center"
>
-<!--l. 6171--><p class="noindent" >
-</p><!--l. 6171--><p class="noindent" >____________________________</p></div>
-<!--l. 6173--><p class="indent" > In the above example, if <span
+<!--l. 6376--><p class="noindent" >
+</p><!--l. 6376--><p class="noindent" >____________________________</p></div>
+<!--l. 6378--><p class="indent" > In the above example, if <span
class="cmtt-10">\newglossaryentry </span>is explicitly used (instead of through <span
class="cmtt-10">\newacronym</span>) the
<span
@@ -13279,226 +13956,235 @@
class="cmtt-10">\ifglshaslong </span>test in the custom acronym style
will be false (since the <span
class="cmtt-10">long</span><a
- id="dx1-117005"></a> key hasn’t been set) so the display style will switch to that given by
+ id="dx1-118005"></a> key hasn’t been set) so the display style will switch to that given by
<span
class="cmtt-10">\glsgenentryfmt </span>and they’ll be no test performed on the <span
class="cmtt-10">abbrtype </span>field.
<a
id="ex:addstoragekey2"></a>
-</p><!--l. 6182--><p class="noindent" ><span
+</p><!--l. 6387--><p class="noindent" ><span
class="cmbx-12">Example 5</span><span
class="cmbx-12"> (Defining Custom Storage Key (Acronyms and Non-Acronyms with</span>
<span
class="cmbx-12">Descriptions))</span><a
- id="x1-117007"></a>
-</p><!--l. 6183--><p class="indent" > The previous example can be modified if the <span
+ id="x1-118007"></a>
+</p><!--l. 6388--><p class="indent" > The previous example can be modified if the <span
class="cmtt-10">description</span><a
- id="dx1-117008"></a> also needs to be provided. Here I’ve changed
+ id="dx1-118008"></a> also needs to be provided. Here I’ve changed
“word” to “acronym”:
</p>
- <div class="verbatim" id="verbatim-152">
+ <pre class="verbatim" id="verbatim-158">
\glsaddstoragekey
- <br /> {abbrtype}% key/field name
- <br /> {acronym}% default value if not explicitly set
- <br /> {\abbrtype}% custom command to access the value if required
-</div>
-<!--l. 6191--><p class="nopar" > This may seem a little odd for non-abbreviated entries defined using <span
+ {abbrtype}% key/field name
+ {acronym}% default value if not explicitly set
+ {\abbrtype}% custom command to access the value if required
+</pre>
+<!--l. 6396--><p class="nopar" > This may seem a little odd for non-abbreviated entries defined using <span
class="cmtt-10">\newglossaryentry </span>directly, but
<span
class="cmtt-10">\ifglshaslong</span><a
- id="dx1-117009"></a> can be used to determine whether or not to reference the value of this new <span
+ id="dx1-118009"></a> can be used to determine whether or not to reference the value of this new <span
class="cmtt-10">abbrtype</span>
field.
-</p><!--l. 6197--><p class="indent" > The new acronym style has a minor modification that forces the user to specify a description. In the
+</p><!--l. 6402--><p class="indent" > The new acronym style has a minor modification that forces the user to specify a description. In the
previous example, the line:
</p>
- <div class="verbatim" id="verbatim-153">
+ <pre class="verbatim" id="verbatim-159">
   \renewcommand*{\GenericAcronymFields}{%
- <br />     description={\the\glslongtok}}%
-</div>
-<!--l. 6202--><p class="nopar" > needs to be changed to:
+     description={\the\glslongtok}}%
+</pre>
+<!--l. 6407--><p class="nopar" > needs to be changed to:
</p>
- <div class="verbatim" id="verbatim-154">
+ <pre class="verbatim" id="verbatim-160">
   \renewcommand*{\GenericAcronymFields}{}%
-</div>
-<!--l. 6206--><p class="nopar" > Additionally, to accommodate the change in the default value of the <span
+</pre>
+<!--l. 6411--><p class="nopar" > Additionally, to accommodate the change in the default value of the <span
class="cmtt-10">abbrtype </span>key, all instances
of
</p>
- <div class="verbatim" id="verbatim-155">
+ <pre class="verbatim" id="verbatim-161">
    \ifglsfieldeq{##1}{abbrtype}{word}
-</div>
-<!--l. 6211--><p class="nopar" > need to be changed to:
+</pre>
+<!--l. 6416--><p class="nopar" > need to be changed to:
</p>
- <div class="verbatim" id="verbatim-156">
+ <pre class="verbatim" id="verbatim-162">
    \ifglsfieldeq{##1}{abbrtype}{acronym}
-</div>
-<!--l. 6215--><p class="nopar" >
-</p><!--l. 6217--><p class="indent" > Once this new style has been set, the new acronyms can be defined using the optional argument to set the
+</pre>
+<!--l. 6420--><p class="nopar" >
+</p><!--l. 6422--><p class="indent" > Once this new style has been set, the new acronyms can be defined using the optional argument to set the
description:
</p>
- <div class="verbatim" id="verbatim-157">
+ <pre class="verbatim" id="verbatim-163">
\newacronym[description={system for detecting the position and
- <br />speed of aircraft, ships, etc}]{radar}{radar}{radio detecting
- <br />and ranging}
-</div>
-<!--l. 6223--><p class="nopar" >
-</p><!--l. 6225--><p class="indent" > No change is required for the definition of <span
+speed of aircraft, ships, etc}]{radar}{radar}{radio detecting
+and ranging}
+</pre>
+<!--l. 6428--><p class="nopar" >
+</p><!--l. 6430--><p class="indent" > No change is required for the definition of <span
class="cmtt-10">\newinitialism </span>but again the optional argument is required to
set the description:
</p>
- <div class="verbatim" id="verbatim-158">
+ <pre class="verbatim" id="verbatim-164">
\newinitialism[description={mathematical manipulation of an
- <br />information signal}]{dsp}{DSP}{digital signal processing}
-</div>
-<!--l. 6230--><p class="nopar" >
-</p><!--l. 6232--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms:
+information signal}]{dsp}{DSP}{digital signal processing}
+</pre>
+<!--l. 6435--><p class="nopar" >
+</p><!--l. 6437--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms:
</p>
- <div class="verbatim" id="verbatim-159">
+ <pre class="verbatim" id="verbatim-165">
\newcommand*{\newcontraction}[4][]{%
- <br />  \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%
- <br />}
-</div>
-<!--l. 6238--><p class="nopar" > The contractions can similarly been defined using this new command:
+  \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%
+}
+</pre>
+<!--l. 6443--><p class="nopar" > The contractions can similarly been defined using this new command:
</p>
- <div class="verbatim" id="verbatim-160">
+ <pre class="verbatim" id="verbatim-166">
\newcontraction[description={front part of a ship below the
- <br />deck}]{focsle}{fo'c's'le}{forecastle}
-</div>
-<!--l. 6243--><p class="nopar" >
-</p><!--l. 6245--><p class="indent" > Since the custom acronym style just checks if <span
+deck}]{focsle}{fo'c's'le}{forecastle}
+</pre>
+<!--l. 6448--><p class="nopar" >
+</p><!--l. 6450--><p class="indent" > Since the custom acronym style just checks if <span
class="cmtt-10">abbrtype </span>is <span
class="cmtt-10">acronym</span>, the contractions will be treated the
same as the initialisms, but the style could be modified by a further test of the <span
class="cmtt-10">abbrtype </span>value if
required.
-</p><!--l. 6250--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word:
+</p><!--l. 6455--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word:
</p>
- <div class="verbatim" id="verbatim-161">
+ <pre class="verbatim" id="verbatim-167">
\newglossaryentry{apple}{name={apple},description={a fruit}}
-</div>
-<!--l. 6254--><p class="nopar" >
-</p><!--l. 6256--><p class="indent" > Now for a new glossary style that provides information about the abbreviation (in addition to the
+</pre>
+<!--l. 6459--><p class="nopar" >
+</p><!--l. 6461--><p class="indent" > Now for a new glossary style that provides information about the abbreviation (in addition to the
description):
</p>
- <div class="verbatim" id="verbatim-162">
+ <pre class="verbatim" id="verbatim-168">
\newglossarystyle
- <br /> {mystyle}% style name
- <br /> {% base it on the "list" style
- <br />   \setglossarystyle{list}%
- <br />   \renewcommand*{\glossentry}[2]{%
- <br />     \item[\glsentryitem{##1}%
- <br />          \glstarget{##1}{\glossentryname{##1}}]
- <br />       \ifglshaslong{##1}%
- <br />       { (\abbrtype{##1}: \glsentrylong{##1})\space}{}%
- <br />       \glossentrydesc{##1}\glspostdescription\space ##2}%
- <br /> }
-</div>
-<!--l. 6270--><p class="nopar" > This uses <span
+ {mystyle}% style name
+ {% base it on the "list" style
+   \setglossarystyle{list}%
+   \renewcommand*{\glossentry}[2]{%
+     \item[\glsentryitem{##1}%
+          \glstarget{##1}{\glossentryname{##1}}]
+       \ifglshaslong{##1}%
+       { (\abbrtype{##1}: \glsentrylong{##1})\space}{}%
+       \glossentrydesc{##1}\glspostdescription\space ##2}%
+ }
+</pre>
+<!--l. 6475--><p class="nopar" > This uses <span
class="cmtt-10">\ifglshaslong</span><a
- id="dx1-117010"></a> to determine whether or not the term is an abbreviation. If it has an abbreviation,
+ id="dx1-118010"></a> to determine whether or not the term is an abbreviation. If it has an abbreviation,
the full form is supplied in parentheses and <span
class="cmtt-10">\abbrtype </span>(defined by <span
class="cmtt-10">\glsaddstoragekey </span>earlier) is used to
indicate the type of abbreviation.
-</p><!--l. 6277--><p class="indent" > With this style set, the <span
+</p><!--l. 6482--><p class="indent" > With this style set, the <span
class="cmtt-10">apple </span>entry is simply displayed in the glossary as
</p><dl class="description"><dt class="description">
+ <!--l. 6485--><p class="noindent" >
<span
-class="cmbx-10">apple</span> </dt><dd
-class="description">a fruit.</dd></dl>
-<!--l. 6282--><p class="noindent" >but the abbreviations are displayed in the form
+class="cmbx-10">apple</span> </p></dt><dd
+class="description">
+ <!--l. 6485--><p class="noindent" >a fruit.</p></dd></dl>
+<!--l. 6487--><p class="noindent" >but the abbreviations are displayed in the form
</p><dl class="description"><dt class="description">
+ <!--l. 6489--><p class="noindent" >
<span
-class="cmbx-10">laser</span> </dt><dd
-class="description">(acronym: light amplification by stimulated emission of radiation) device that creates a narrow
- beam of intense light.</dd></dl>
-<!--l. 6288--><p class="noindent" >(for acronyms) or
+class="cmbx-10">laser</span> </p></dt><dd
+class="description">
+ <!--l. 6489--><p class="noindent" >(acronym: light amplification by stimulated emission of radiation) device that creates a narrow
+ beam of intense light.</p></dd></dl>
+<!--l. 6493--><p class="noindent" >(for acronyms) or
</p><dl class="description"><dt class="description">
+ <!--l. 6495--><p class="noindent" >
<span
-class="cmbx-10">DSP</span> </dt><dd
-class="description">(initialism: digital signal processing) mathematical manipulation of an information signal.</dd></dl>
-<!--l. 6293--><p class="noindent" >(for initalisms) or
+class="cmbx-10">DSP</span> </p></dt><dd
+class="description">
+ <!--l. 6495--><p class="noindent" >(initialism: digital signal processing) mathematical manipulation of an information signal.</p></dd></dl>
+<!--l. 6498--><p class="noindent" >(for initalisms) or
</p><dl class="description"><dt class="description">
+ <!--l. 6500--><p class="noindent" >
<span
-class="cmbx-10">fo’c’s’le</span> </dt><dd
-class="description">(contraction: forecastle) front part of a ship below the deck.</dd></dl>
-<!--l. 6298--><p class="noindent" >(for contractions).
-</p><!--l. 6300--><p class="indent" > For a complete document, see <a
+class="cmbx-10">fo’c’s’le</span> </p></dt><dd
+class="description">
+ <!--l. 6500--><p class="noindent" >(contraction: forecastle) front part of a ship below the deck.</p></dd></dl>
+
+
+<!--l. 6503--><p class="noindent" >(for contractions).
+</p><!--l. 6505--><p class="indent" > For a complete document, see <a
href="#ex:sample-storage-abbr-desc"><span
class="cmtt-10">sample-storage-abbr-desc.tex</span></a>. </p>
<div class="center"
>
-<!--l. 6301--><p class="noindent" >
-</p><!--l. 6301--><p class="noindent" >____________________________</p></div>
-
-
-<!--l. 6303--><p class="noindent" >
+<!--l. 6506--><p class="noindent" >
+</p><!--l. 6506--><p class="noindent" >____________________________</p></div>
+<!--l. 6508--><p class="noindent" >
</p>
-<!--l. 6303--><p class="noindent" ><a
+<!--l. 6508--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.4 </span> <a
id="sec:expansion"></a>Expansion</h3>
-<!--l. 6306--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span
+<!--l. 6511--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span
class="cmtt-10">name</span><a
- id="dx1-118001"></a>, <span
+ id="dx1-119001"></a>, <span
class="cmtt-10">description</span><a
- id="dx1-118002"></a>,
+ id="dx1-119002"></a>,
<span
class="cmtt-10">descriptionplural</span><a
- id="dx1-118003"></a>, <span
+ id="dx1-119003"></a>, <span
class="cmtt-10">symbol</span><a
- id="dx1-118004"></a>, <span
+ id="dx1-119004"></a>, <span
class="cmtt-10">symbolplural</span><a
- id="dx1-118005"></a> and <span
+ id="dx1-119005"></a> and <span
class="cmtt-10">sort</span><a
- id="dx1-118006"></a> keys (these keys all have expansion suppressed via
+ id="dx1-119006"></a> keys (these keys all have expansion suppressed via
<span
class="cmtt-10">\glssetnoexpandfield</span>).
-</p><!--l. 6312--><p class="indent" > You can switch expansion on or off for individual keys using
-</p><!--l. 6313--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-118007"></a> <span
+</p><!--l. 6517--><p class="indent" > You can switch expansion on or off for individual keys using
+</p><!--l. 6518--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-119007"></a> <span
class="cmtt-10">\glssetexpandfield{</span>⟨<span
class="cmitt-10">field</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 6315--><p class="noindent" >
+</p><!--l. 6520--><p class="noindent" >
or
-</p><!--l. 6317--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-118008"></a> <span
+</p><!--l. 6522--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-119008"></a> <span
class="cmtt-10">\glssetnoexpandfield{</span>⟨<span
class="cmitt-10">field</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 6319--><p class="noindent" >
+</p><!--l. 6524--><p class="noindent" >
respectively, where ⟨<span
class="cmti-10">field</span>⟩ is the field tag corresponding to the key. In most cases, this is the same as the name of
the key except for those listed in <a
-href="#tab:fieldmap">table 4.1</a>.
+href="#tab:fieldmap">table <span
+class="cmbx-10">??</span>tab:fieldmap</a>.
</p>
<div class="table">
-<!--l. 6324--><p class="indent" > <a
+<!--l. 6529--><p class="indent" > <a
id="tab:fieldmap"></a></p><hr class="float" /><div class="float"
>
@@ -13505,9 +14191,9 @@
<div class="caption"
><span class="id">Table 4.1: </span><span
-class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-1180091 -->
+class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-1190091 -->
<div class="tabular"> <table id="TBL-5" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-5-1g"><col
id="TBL-5-1" /><col
id="TBL-5-2" /></colgroup><tr
@@ -13520,13 +14206,13 @@
style="vertical-align:baseline;" id="TBL-5-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-1"
class="td11"> <span
class="cmtt-10">sort</span><a
- id="dx1-118010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2"
+ id="dx1-119010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2"
class="td11"> <span
class="cmtt-10">sortvalue </span></td></tr><tr
style="vertical-align:baseline;" id="TBL-5-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-1"
class="td11"> <span
class="cmtt-10">firstplural</span><a
- id="dx1-118011"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2"
+ id="dx1-119011"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2"
class="td11"> <span
class="cmtt-10">firstpl</span></td>
</tr><tr
@@ -13533,7 +14219,7 @@
style="vertical-align:baseline;" id="TBL-5-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-1"
class="td11"> <span
class="cmtt-10">description</span><a
- id="dx1-118012"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2"
+ id="dx1-119012"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2"
class="td11"> <span
class="cmtt-10">desc </span></td>
</tr><tr
@@ -13540,7 +14226,7 @@
style="vertical-align:baseline;" id="TBL-5-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-1"
class="td11"> <span
class="cmtt-10">descriptionplural</span><a
- id="dx1-118013"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2"
+ id="dx1-119013"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2"
class="td11"> <span
class="cmtt-10">descplural </span></td>
</tr><tr
@@ -13547,7 +14233,7 @@
style="vertical-align:baseline;" id="TBL-5-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-1"
class="td11"> <span
class="cmtt-10">user1</span><a
- id="dx1-118014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2"
+ id="dx1-119014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2"
class="td11"> <span
class="cmtt-10">useri </span></td>
</tr><tr
@@ -13554,7 +14240,7 @@
style="vertical-align:baseline;" id="TBL-5-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-1"
class="td11"> <span
class="cmtt-10">user2</span><a
- id="dx1-118015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2"
+ id="dx1-119015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2"
class="td11"> <span
class="cmtt-10">userii </span></td>
</tr><tr
@@ -13561,7 +14247,7 @@
style="vertical-align:baseline;" id="TBL-5-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-1"
class="td11"> <span
class="cmtt-10">user3</span><a
- id="dx1-118016"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2"
+ id="dx1-119016"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2"
class="td11"> <span
class="cmtt-10">useriii </span></td>
</tr><tr
@@ -13568,7 +14254,7 @@
style="vertical-align:baseline;" id="TBL-5-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-1"
class="td11"> <span
class="cmtt-10">user4</span><a
- id="dx1-118017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2"
+ id="dx1-119017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2"
class="td11"> <span
class="cmtt-10">useriv </span></td>
</tr><tr
@@ -13575,7 +14261,7 @@
style="vertical-align:baseline;" id="TBL-5-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-1"
class="td11"> <span
class="cmtt-10">user5</span><a
- id="dx1-118018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2"
+ id="dx1-119018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2"
class="td11"> <span
class="cmtt-10">userv </span></td>
</tr><tr
@@ -13582,7 +14268,7 @@
style="vertical-align:baseline;" id="TBL-5-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-1"
class="td11"> <span
class="cmtt-10">user6</span><a
- id="dx1-118019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-2"
+ id="dx1-119019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-2"
class="td11"> <span
class="cmtt-10">uservi </span></td>
</tr><tr
@@ -13589,7 +14275,7 @@
style="vertical-align:baseline;" id="TBL-5-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-1"
class="td11"> <span
class="cmtt-10">longplural</span><a
- id="dx1-118020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-2"
+ id="dx1-119020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-2"
class="td11"> <span
class="cmtt-10">longpl </span></td>
</tr><tr
@@ -13596,7 +14282,7 @@
style="vertical-align:baseline;" id="TBL-5-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-1"
class="td11"> <span
class="cmtt-10">shortplural</span><a
- id="dx1-118021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-2"
+ id="dx1-119021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-2"
class="td11"> <span
class="cmtt-10">shortpl </span></td></tr></table>
</div>
@@ -13604,279 +14290,284 @@
</div><hr class="endfloat" />
</div>
-<!--l. 6345--><p class="indent" > Any keys that haven’t had the expansion explicitly set using <span
+<!--l. 6550--><p class="indent" > Any keys that haven’t had the expansion explicitly set using <span
class="cmtt-10">\glssetexpandfield </span>or <span
class="cmtt-10">\glssetnoexpandfield</span>
are governed by
-</p><!--l. 6347--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-118022"></a> <span
+</p><!--l. 6552--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-119022"></a> <span
class="cmtt-10">\glsexpandfields </span></div><hr>
-</p><!--l. 6349--><p class="noindent" >
+</p><!--l. 6554--><p class="noindent" >
and
-</p><!--l. 6351--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-118023"></a> <span
+</p><!--l. 6556--><p class="indent" > <hr><div title="Definition"><a
+ id="dx1-119023"></a> <span
class="cmtt-10">\glsnoexpandfields </span></div><hr>
-</p><!--l. 6353--><p class="noindent" >
-</p><!--l. 6355--><p class="indent" > If your entries contain any fragile commands, I recommend you switch off expansion via <span
+</p><!--l. 6558--><p class="noindent" >
+</p><!--l. 6560--><p class="indent" > If your entries contain any fragile commands, I recommend you switch off expansion via <span
class="cmtt-10">\glsnoexpandfields</span>.
(This should be used before you define the entries.)
</p>
-<!--l. 6359--><p class="noindent" ><a
+<!--l. 6564--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.5 </span> <a
id="sec:subentries"></a>Sub-Entries</h3>
-<!--l. 6362--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into
+<!--l. 6567--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into
categories, in which case the sub-entry will have a different name to its parent entry, or it may be used to
distinguish different definitions for the same word, in which case the sub-entries will have the same name as the
parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a
flat format. Of the styles that support sub-entries, some display the sub-entry’s name whilst others don’t.
Therefore you need to ensure that you use a suitable style. (See <a
-href="#sec:styles">§15 </a><a
-href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined
-styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles
-if you use the <span
+href="#sec:styles">§<span
+class="cmbx-10">??</span>sec:styles </a><a
+href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of
+predefined styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles if
+you use the <span
class="cmss-10">subentrycounter</span><a
- id="dx1-119001"></a> package option (see <a
-href="#sec:pkgopts-printglos">§2.3 </a><a
-href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further
-details).
-</p><!--l. 6377--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child entries are used in
+ id="dx1-120001"></a> package option (see <a
+href="#sec:pkgopts-printglos">§<span
+class="cmbx-10">??</span>sec:pkgopts-printglos </a><a
+href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for
+further details).
+</p><!--l. 6582--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child entries are used in
the document. If the parent entry is not referenced in the document, it will not have a <a
href="#glo:numberlist">number list<a
- id="dx1-119002"></a></a>. Note also
+ id="dx1-120002"></a></a>. Note also
that <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-119003"></a></a> has a restriction on the maximum sub-entry depth.
-</p><!--l. 6383--><p class="noindent" >
+ id="dx1-120003"></a></a> has a restriction on the maximum sub-entry depth.
+</p><!--l. 6588--><p class="noindent" >
</p>
-<!--l. 6383--><p class="noindent" ><a
+<!--l. 6588--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.5.1 </span> <a
id="sec:hierarchical"></a>Hierarchical Categories</h4>
-<!--l. 6386--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and then define the
+<!--l. 6591--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and then define the
sub-entries using the relevant category entry as the value of the <span
class="cmtt-10">parent</span><a
- id="dx1-120001"></a> key.
+ id="dx1-121001"></a> key.
<a
id="ex:hierarchical"></a>
-</p><!--l. 6391--><p class="noindent" ><span
+</p><!--l. 6596--><p class="noindent" ><span
class="cmbx-12">Example 6</span><span
class="cmbx-12"> (Hierarchical Categories—Greek and Roman Mathematical</span>
<span
class="cmbx-12">Symbols)</span><a
- id="x1-120003"></a>
-</p><!--l. 6393--><p class="indent" > Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters.
+ id="x1-121003"></a>
+</p><!--l. 6598--><p class="indent" > Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters.
Then I can define the categories as follows:
</p>
- <div class="verbatim" id="verbatim-163">
+ <pre class="verbatim" id="verbatim-169">
\newglossaryentry{greekletter}{name={Greek letters},
- <br />description={\nopostdesc}}
- <br />\newglossaryentry{romanletter}{name={Roman letters},
- <br />description={\nopostdesc}}
-</div>
-<!--l. 6402--><p class="nopar" >
-</p><!--l. 6404--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the descriptions to
+description={\nopostdesc}}
+\newglossaryentry{romanlett