texlive[45373] trunk: glossaries (21sep17)
commits+karl at tug.org
commits+karl at tug.org
Thu Sep 21 23:04:32 CEST 2017
Revision: 45373
http://tug.org/svn/texlive?view=revision&revision=45373
Author: karl
Date: 2017-09-21 23:04:31 +0200 (Thu, 21 Sep 2017)
Log Message:
-----------
glossaries (21sep17)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES
trunk/Master/texmf-dist/doc/latex/glossaries/README
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/glossary-lipsum-examples.tex
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/samplexdy.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.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
trunk/Master/tlpkg/libexec/ctan2tds
trunk/Master/tlpkg/tlpsrc/glossaries.tlpsrc
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex
trunk/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1
trunk/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf
trunk/Master/texmf-dist/doc/man/man1/makeglossaries.1
trunk/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf
trunk/Master/texmf-dist/source/latex/glossaries/makeglossaries-lite.pod
trunk/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbolnames.tex
Removed Paths:
-------------
trunk/Master/texmf-dist/scripts/glossaries/makeglossaries.bat
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2017-09-21 20:59:31 UTC (rev 45372)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2017-09-21 21:04:31 UTC (rev 45373)
@@ -2,7 +2,7 @@
# File : makeglossaries
# Author : Nicola Talbot
-# Version : 2.21
+# Version : 4.33
# Description: simple Perl script that calls makeindex or xindy.
# Intended for use with "glossaries.sty" (saves having to remember
# all the various switches)
@@ -27,9 +27,11 @@
# glossary-super.sty, glossaries.perl.
# Also makeglossaries and makeglossaries-lite.lua.
-my $version="2.21 (2017-05-11)";
+my $version="4.33 (2017-09-20)";
# History:
+# v4.33:
+# * Version number synchronized with glossaries.sty
# v2.21:
# * Fixed spelling of \GlsAddXdyLocation
# * Adjusted range encap clash
@@ -1497,15 +1499,15 @@
=head1 SYNOPSIS
-B<makeglossaries> [B<-o> I<file>] [B<-q>] [B<-Q>] [B<-s> I<file>]
-[B<-t> I<file>] [B<-L> I<language>] [B<-c>] [B<-g>] [B<-l>]
+B<makeglossaries> [B<-o> I<file>] [B<-q>] [B<-Q>] [B<-k>] [B<-n>]
+[B<-s> I<file>] [B<-t> I<file>] [B<-L> I<language>] [B<-c>] [B<-g>] [B<-l>]
[B<-p> I<num>] [B<-r>] [B<-d> I<aux dir>] [B<-m> I<file>] [B<-x> I<file>]
-[B<--version>] [B<--help>] I<filename>
+[B<--version>] [B<--help>] I<basename>
=head1 DESCRIPTION
B<makeglossaries> is designed for use with LaTeX documents that
-use the glossaries package. The mandatory argument I<filename> should
+use the glossaries package. The mandatory argument I<basename> should
be the name of the LaTeX document without the .tex extension.
B<makeglossaries> will read the auxiliary file to determine whether
B<makeindex> or B<xindy> should be called. All the information
@@ -1530,6 +1532,10 @@
Don't try forking with piped redirection. (Lessens the
effect of -q)
+=item B<-n>
+
+Print the commands that would normally be executed but don't run them.
+
=item B<-o> I<file>
Use I<file> as the output file. (Only suitable for documents
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2017-09-21 20:59:31 UTC (rev 45372)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2017-09-21 21:04:31 UTC (rev 45373)
@@ -26,6 +26,8 @@
This work has the LPPL maintenance status `maintained'.
History:
+ * 4.33:
+ - Version number synchronized with glossaries.sty
* 1.3
- added check for \glsxtr at makeglossaries
* 1.2 (2016-05-27)
@@ -35,7 +37,7 @@
- changed first line from lua to texlua
--]]
-thisversion = "1.3 2016-12-16"
+thisversion = "4.33 2017-09-20"
quiet = false
dryrun = false
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2017-09-21 20:59:31 UTC (rev 45372)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2017-09-21 21:04:31 UTC (rev 45373)
@@ -1,5 +1,34 @@
glossaries change log:
+v4.33 (2017-09-20):
+
+ * Removed makeglossaries.bat (TeX distributions on Windows
+ convert the Perl script to makeglossaries.exe, so the
+ .bat file isn't needed.)
+
+ * makeglossaries and makeglossaries-lite.lua now have their
+ version numbers synchronised with glossaries.sty
+
+ * Added makeglossaries-lite.pod (to provide the
+ makeglossaries-lite.1 man file)
+
+ * Updated POD at the end of makeglossaries
+
+ * Added example-glossaries-symbolnames.tex for use in any MWE
+ requiring symbols in the name fields.
+
+ * Tidied up the user manual and guide for beginners.
+
+ * glossaries.sty:
+
+ - added package option nolangwarn
+
+ - added package option esclocations
+
+ - added \GlsSetXdyNumberGroupOrder
+
+ - added starred form of \GlsSetXdyFirstLetterAfterDigits
+
v4.32 (2017-08-24):
* glossaries.sty:
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/README
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/README 2017-09-21 20:59:31 UTC (rev 45372)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/README 2017-09-21 21:04:31 UTC (rev 45373)
@@ -1,6 +1,6 @@
-LaTeX Package : glossaries v4.32
+LaTeX Package : glossaries v4.33
-Last Modified : 2017-08-24
+Last Modified : 2017-09-20
Author : Nicola Talbot
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 2017-09-21 20:59:31 UTC (rev 45372)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html 2017-09-21 21:04:31 UTC (rev 45373)
@@ -21,7 +21,6 @@
.cmr-17{font-size:170%;}
.cmr-12{font-size:120%;}
.cmr-8{font-size:80%;}
-.cmsy-8{font-size:80%;}
.cmtt-12{font-size:120%;font-family: monospace;}
.cmtt-12{font-family: monospace;}
.cmtt-12{font-family: monospace;}
@@ -33,6 +32,7 @@
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
+.cmss-10{ font-family: sans-serif;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
@@ -43,7 +43,9 @@
.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
+.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
.cmr-9{font-size:90%;}
+.tcrm-0800{font-size:80%;}
.cmtt-8{font-size:80%;font-family: monospace;}
.cmtt-8{font-family: monospace;}
.cmtt-8{font-family: monospace;}
@@ -53,20 +55,30 @@
.cmss-8{ font-family: sans-serif;}
.cmss-8{ font-family: sans-serif;}
.cmss-8{ font-family: sans-serif;}
+.cmss-8{ font-family: sans-serif;}
+.cmss-9{font-size:90%; font-family: sans-serif;}
+.cmss-9{ font-family: sans-serif;}
+.cmss-9{ font-family: sans-serif;}
+.cmss-9{ font-family: sans-serif;}
+.cmss-9{ font-family: sans-serif;}
+.tcrm-0900{font-size:90%;}
+.cmmi-9{font-size:90%;font-style: italic;}
+.msam-10x-x-90{font-size:90%;}
.cmtt-9{font-size:90%;font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmtt-9{font-family: monospace;}
-.cmsy-9{font-size:90%;}
-.cmitt-10{font-family: monospace; font-style: italic;}
+.pzdr-x-x-90{font-size:90%;}
.cmbx-12{font-size:120%; font-weight: bold;}
.cmbx-12{ font-weight: bold;}
+.cmitt-10{font-family: monospace; font-style: italic;}
.cmbxti-10{ font-weight: bold; font-style: italic;}
.cmssbx-10x-x-120{font-size:120%; font-family: sans-serif; font-weight: bold;}
.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;}
.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;}
.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;}
+.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;}
.small-caps{font-variant: small-caps; }
p.noindent { text-indent: 0em }
td p.noindent { text-indent: 0em; margin-top:0em; }
@@ -201,7 +213,7 @@
.equation-star td{text-align:center; }
table.equation-star { width:100%; }
table.equation { width:100%; }
-table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:100%; margin-left:5%; white-space: nowrap;}
+table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:95%; margin-left:5%; white-space: nowrap;}
table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;}
td.align-label { width:5%; text-align:center; }
td.align-odd { text-align:right; padding-right:0.3em;}
@@ -215,6 +227,68 @@
.supertabular {text-align:center}
div.important { border : solid red; }
div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;}
+span#textcolor1{color:#00FF00}
+span#textcolor2{color:#00FF00}
+span#textcolor3{color:#00FF00}
+span#textcolor4{color:#FF0000}
+span#textcolor5{color:#FF0000}
+span#textcolor6{color:#00FF00}
+span#textcolor7{color:#FF0000}
+span#textcolor8{color:#FF0000}
+span#textcolor9{color:#FF0000}
+span#textcolor10{color:#00FF00}
+span#textcolor11{color:#00FF00}
+span#textcolor12{color:#00FF00}
+span#textcolor13{color:#FF0000}
+span#textcolor14{color:#00FF00}
+span#textcolor15{color:#00FF00}
+span#textcolor16{color:#00FF00}
+span#textcolor17{color:#00FF00}
+span#textcolor18{color:#00FF00}
+span#textcolor19{color:#FF0000}
+span#textcolor20{color:#00FF00}
+span#textcolor21{color:#FF0000}
+span#textcolor22{color:#FF0000}
+span#textcolor23{color:#00FF00}
+span#textcolor24{color:#00FF00}
+span#textcolor25{color:#FF0000}
+span#textcolor26{color:#00FF00}
+span#textcolor27{color:#00FF00}
+span#textcolor28{color:#00FF00}
+span#textcolor29{color:#00FF00}
+span#textcolor30{color:#FF0000}
+span#textcolor31{color:#FF0000}
+span#textcolor32{color:#00FF00}
+span#textcolor33{color:#FF0000}
+span#textcolor34{color:#FF0000}
+span#textcolor35{color:#FF0000}
+span#textcolor36{color:#00FF00}
+span#textcolor37{color:#00FF00}
+span#textcolor38{color:#00FF00}
+span#textcolor39{color:#00FF00}
+span#textcolor40{color:#FF0000}
+span#textcolor41{color:#00FF00}
+span#textcolor42{color:#00FF00}
+span#textcolor43{color:#FF0000}
+span#textcolor44{color:#00FF00}
+span#textcolor45{color:#00FF00}
+span#textcolor46{color:#00FF00}
+span#textcolor47{color:#FF0000}
+span#textcolor48{color:#00FF00}
+span#textcolor49{color:#FF0000}
+span#textcolor50{color:#00FF00}
+span#textcolor51{color:#00FF00}
+span#textcolor52{color:#00FF00}
+span#textcolor53{color:#00FF00}
+span#textcolor54{color:#FF0000}
+span#textcolor55{color:#FF0000}
+span#textcolor56{color:#00FF00}
+span#textcolor57{color:#FF0000}
+span#textcolor58{color:#00FF00}
+span#textcolor59{color:#FF0000}
+span#textcolor60{color:#FF0000}
+span#textcolor61{color:#00FF00}
+span#textcolor62{color:#00FF00}
/* end css.sty */
@@ -222,20 +296,20 @@
</style>
</head><body
>
-<!--l. 406--><p class="noindent" ><a
+<!--l. 455--><p class="noindent" ><a
id="top"></a>
-</p><!--l. 406--><p class="indent" >
+</p><!--l. 455--><p class="indent" >
-</p><!--l. 406--><p class="indent" >
+</p><!--l. 455--><p class="indent" >
</p>
<div class="center"
>
-<!--l. 406--><p class="noindent" >
-</p><!--l. 406--><p class="noindent" ><span
-class="cmr-17">User Manual for glossaries.sty v4.32</span>
+<!--l. 455--><p class="noindent" >
+</p><!--l. 455--><p class="noindent" ><span
+class="cmr-17">User Manual for glossaries.sty v4.33</span>
</p>
<div class="tabular"> <table id="TBL-1" class="tabular"
cellspacing="0" cellpadding="0"
@@ -250,21 +324,21 @@
href="http://www.dickimaw-books.com/" class="url" ><span
class="cmtt-12">http://www.dickimaw-books.com/</span></a> </td></tr></table>
</div>
-<!--l. 406--><p class="noindent" ><span
-class="cmr-12">2017-08-24</span></p></div>
+<!--l. 455--><p class="noindent" ><span
+class="cmr-12">2017-09-20</span></p></div>
<div
class="abstract"
>
-<!--l. 408--><p class="indent" >
+<!--l. 457--><p class="indent" >
</p>
<div class="center"
>
-<!--l. 408--><p class="noindent" >
-</p><!--l. 408--><p class="noindent" ><span
+<!--l. 457--><p class="noindent" >
+</p><!--l. 457--><p class="noindent" ><span
class="cmbx-10">Abstract</span></p></div>
-<!--l. 409--><p class="noindent" >The <span
+<!--l. 458--><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
@@ -271,56 +345,71 @@
using <span class="TEX">T<span
class="E">E</span>X</span> or using a supplementary <a
href="#glo:indexingapp">indexing application</a>.
-</p><!--l. 414--><p class="indent" > Additional features not provided here may be available through the supplemental package
+</p><!--l. 463--><p class="indent" > Additional features not provided here may be available through the supplemental package
<a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a> which, if required, needs to be installed separately. New features will be added
to <span
class="cmss-10">glossaries-extra</span>. Versions of the <span
-class="cmss-10">glossaries </span>package after v4.21 will mostly be just bug
-fixes.
-</p><!--l. 419--><p class="indent" >
+class="cmss-10">glossaries </span>package after v4.21 will mostly be just bug fixes.
+Note that <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> provides an extra indexing option (<a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2"></a></a>) which isn’t available
+with just the base <span
+class="cmss-10">glossaries</span><a
+ id="dx1-3"></a> package.
+</p><!--l. 471--><p class="indent" >
</p>
</div>
-<!--l. 421--><p class="indent" > If you require multilingual support you must also separately install the relevant language
-module. Each language module is called <span
+<!--l. 473--><p class="indent" > If you require multilingual support you must also separately install the relevant language
+module. Each language module is distributed under the name <span
class="cmtt-10">glossaries-</span>⟨<span
-class="cmti-10">language</span>⟩, where ⟨<span
-class="cmti-10">language</span>⟩ is the root
-language name. For example, <span
-class="cmtt-10">glossaries-french </span>or <span
-class="cmtt-10">glossaries-german</span>. If a language
-module is required, the <span
-class="cmss-10">glossaries </span>package will automatically try to load it and will give
-a warning if the module isn’t found. See <a
+class="cmti-10">language</span>⟩,
+where ⟨<span
+class="cmti-10">language</span>⟩ is the root language name. For example, <span
+class="cmtt-10">glossaries-french </span>or
+<span
+class="cmtt-10">glossaries-german</span>. If a language module is required, the <span
+class="cmss-10">glossaries </span>package will
+automatically try to load it and will give a warning if the module isn’t found. See <a
href="#sec:languages"><span
-class="cmsy-10">§</span>1.3 </a><a
-href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> for further
-details.
-</p><!--l. 430--><p class="indent" > The <span
+class="tcrm-1000">§</span>1.4
+</a><a
+href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> for further details. If there isn’t any support available for your
+language, use the <span
+class="cmss-10">nolangwarn</span><a
+ id="dx1-4"></a> package option to suppress the warning and provide your own
+translations. (For example, use the <span
+class="cmss-10">title</span><a
+ id="dx1-5"></a> key in <span
+class="cmtt-10">\printglossary</span>.)
+</p><!--l. 486--><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-2"></a>, <span
+ id="dx1-6"></a>, <span
class="cmss-10">mfirstuc</span><a
- id="dx1-3"></a>, <span
+ id="dx1-7"></a>, <span
class="cmss-10">etoolbox</span><a
- id="dx1-4"></a>, <span
+ id="dx1-8"></a>, <span
class="cmss-10">xkeyval</span><a
- id="dx1-5"></a> (at least version dated 2006/11/18), <span
+ id="dx1-9"></a> (at least version dated 2006/11/18), <span
class="cmss-10">textcase</span><a
- id="dx1-6"></a>, <span
+ id="dx1-10"></a>, <span
class="cmss-10">xfor</span><a
- id="dx1-7"></a>,
+ id="dx1-11"></a>,
<span
class="cmss-10">datatool-base</span><a
- id="dx1-8"></a> (part of the <span
+ id="dx1-12"></a> (part of the <span
class="cmss-10">datatool</span><a
- id="dx1-9"></a> bundle) and <span
+ id="dx1-13"></a> bundle) and <span
class="cmss-10">amsgen</span><a
- id="dx1-10"></a>. These packages are all available
+ id="dx1-14"></a>. These packages are all available
in the latest <span class="TEX">T<span
class="E">E</span>X</span> Live and Mik<span class="TEX">T<span
class="E">E</span>X</span> distributions. If any of them are missing,
@@ -332,7 +421,7 @@
href="http://tex.stackexchange.com/questions/14925/updating-tex-on-linux" >Updating <span class="TEX">T<span
class="E">E</span>X</span> on
Linux</a>.)
-</p><!--l. 445--><p class="indent" > <div class="important" title="Important Note"> Documents have wide-ranging styles when it comes to presenting glossaries or lists of
+</p><!--l. 501--><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
@@ -340,7 +429,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. 455--><p class="indent" > 😱 If you’re freaking out at the size of this manual, start with <span
+</p><!--l. 511--><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
@@ -347,8 +436,8 @@
class="cmtt-10">texdoc glossariesbegin.pdf</span>. Once you’ve got to grips with
the basics, then come back to this manual to find out how to adjust the settings.
</div>
-</p><!--l. 461--><p class="noindent" >
-</p><!--l. 463--><p class="noindent" >The <span
+</p><!--l. 517--><p class="noindent" >
+</p><!--l. 519--><p class="noindent" >The <span
class="cmss-10">glossaries </span>bundle comes with the following documentation:
</p><dl class="description"><dt class="description">
<a
@@ -363,7 +452,7 @@
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-11"></a> package,
+ id="dx1-15"></a> package,
read <a
href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a>.
</dd><dt class="description">
@@ -378,13 +467,13 @@
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.32”.
+ Code for glossaries v4.33”.
+
+
</dd><dt class="description">
<span
class="cmbx-10">INSTALL</span> </dt><dd
class="description">Installation instructions.
-
-
</dd><dt class="description">
<span
class="cmbx-10">CHANGES</span> </dt><dd
@@ -394,7 +483,7 @@
class="cmbx-10">README</span> </dt><dd
class="description">Package summary.
</dd></dl>
-<!--l. 492--><p class="noindent" >Related resources: </p>
+<!--l. 548--><p class="noindent" >Related resources: </p>
<ul class="itemize1">
<li class="itemize"><a
href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" ><span
@@ -412,44 +501,48 @@
</li>
<li class="itemize">The <a
href="http://ctan.org/pkg/glossaries-extra" ><span
-class="cmss-10">glossaries-extra </span>package</a></li></ul>
-<!--l. 511--><p class="indent" > <div class="important" title="Important Note"> If you use <span
+class="cmss-10">glossaries-extra </span>package</a>
+ </li>
+ <li class="itemize"><a
+href="http://ctan.org/pkg/bib2gls" ><span
+class="cmtt-10">bib2gls</span></a></li></ul>
+<!--l. 569--><p class="indent" > <div class="important" title="Important Note"> If you use <span
class="cmss-10">hyperref</span><a
- id="dx1-12"></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-13"></a> <span
+ id="dx1-17"></a> <span
class="cmti-10">first</span>. Similarly the <span
class="cmss-10">doc</span><a
- id="dx1-14"></a> package
+ id="dx1-18"></a> package
must also be loaded before <span
class="cmss-10">glossaries</span>. (If <span
class="cmss-10">doc</span><a
- id="dx1-15"></a> is loaded, the file extensions for the default main
+ id="dx1-19"></a> is loaded, the file extensions for the default main
glossary are changed to <span
class="cmtt-10">gls2</span><a
- id="dx1-16"></a>, <span
+ id="dx1-20"></a>, <span
class="cmtt-10">glo2</span><a
- id="dx1-17"></a> and <span
+ id="dx1-21"></a> and <span
class="cmtt-10">.glg2</span><a
- id="dx1-18"></a> to avoid conflict with <span
+ id="dx1-22"></a> to avoid conflict with <span
class="cmss-10">doc</span><a
- id="dx1-19"></a>’s changes
+ id="dx1-23"></a>’s changes
glossary.)<a
id="pdflatexnote"></a>
-</p><!--l. 520--><p class="indent" > If you are using <span
+</p><!--l. 578--><p class="indent" > If you are using <span
class="cmss-10">hyperref</span><a
- id="dx1-20"></a>, it’s best to use <span
+ id="dx1-24"></a>, it’s best to use <span
class="cmtt-10">pdflatex</span><a
- id="dx1-21"></a> rather than <span
+ id="dx1-25"></a> rather than <span
class="cmtt-10">latex</span><a
- id="dx1-22"></a> (DVI format) as
+ id="dx1-26"></a> (DVI format) as
<span
class="cmtt-10">pdflatex </span>deals with hyperlinks much better. If you use the DVI format, you will encounter
problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is
an issue with the DVI format not with <span
class="cmss-10">glossaries</span>. </div>
-</p><!--l. 526--><p class="noindent" >
+</p><!--l. 584--><p class="noindent" >
@@ -463,172 +556,182 @@
<br /> <span class="chapterToc" >1 <a
href="#sec:intro" id="QQ2-1-5">Introduction</a></span>
<br />  <span class="sectionToc" >1.1 <a
-href="#sec:samples" id="QQ2-1-7">Sample Documents</a></span>
+href="#sec:indexingoptions" id="QQ2-1-6">Indexing Options</a></span>
<br />  <span class="sectionToc" >1.2 <a
-href="#sec:lipsum" id="QQ2-1-8">Dummy Entries for Testing</a></span>
+href="#sec:samples" id="QQ2-1-13">Sample Documents</a></span>
<br />  <span class="sectionToc" >1.3 <a
-href="#sec:languages" id="QQ2-1-9">Multi-Lingual Support</a></span>
-<br />   <span class="subsectionToc" >1.3.1 <a
-href="#sec:fixednames" id="QQ2-1-10">Changing the Fixed Names</a></span>
+href="#sec:lipsum" id="QQ2-1-14">Dummy Entries for Testing</a></span>
<br />  <span class="sectionToc" >1.4 <a
-href="#sec:makeglossaries" id="QQ2-1-13">Generating the Associated Glossary Files</a></span>
+href="#sec:languages" id="QQ2-1-15">Multi-Lingual Support</a></span>
<br />   <span class="subsectionToc" >1.4.1 <a
-href="#sec:makeglossariesapp" id="QQ2-1-15">Using the makeglossaries Perl Script</a></span>
-<br />   <span class="subsectionToc" >1.4.2 <a
-href="#sec:makeglossarieslua" id="QQ2-1-16">Using the makeglossaries-lite.lua Lua Script</a></span>
-<br />   <span class="subsectionToc" >1.4.3 <a
-href="#sec:xindyapp" id="QQ2-1-17">Using xindy explicitly (Option 3)</a></span>
-<br />   <span class="subsectionToc" >1.4.4 <a
-href="#sec:makeindexapp" id="QQ2-1-18">Using makeindex explicitly (Option 2)</a></span>
-<br />   <span class="subsectionToc" >1.4.5 <a
-href="#sec:notedev" id="QQ2-1-19">Note to Front-End and Script Developers</a></span>
+href="#sec:fixednames" id="QQ2-1-16">Changing the Fixed Names</a></span>
+<br />  <span class="sectionToc" >1.5 <a
+href="#sec:makeglossaries" id="QQ2-1-19">Generating the Associated Glossary Files</a></span>
+<br />   <span class="subsectionToc" >1.5.1 <a
+href="#sec:makeglossariesapp" id="QQ2-1-21">Using the makeglossaries Perl Script</a></span>
+<br />   <span class="subsectionToc" >1.5.2 <a
+href="#sec:makeglossarieslua" id="QQ2-1-22">Using the makeglossaries-lite Lua Script</a></span>
+<br />   <span class="subsectionToc" >1.5.3 <a
+href="#sec:xindyapp" id="QQ2-1-23">Using xindy explicitly (Option 3)</a></span>
+<br />   <span class="subsectionToc" >1.5.4 <a
+href="#sec:makeindexapp" id="QQ2-1-24">Using makeindex explicitly (Option 2)</a></span>
+<br />   <span class="subsectionToc" >1.5.5 <a
+href="#sec:notedev" id="QQ2-1-25">Note to Front-End and Script Developers</a></span>
<br /> <span class="chapterToc" >2 <a
-href="#sec:pkgopts" id="QQ2-1-20">Package Options</a></span>
+href="#sec:pkgopts" id="QQ2-1-26">Package Options</a></span>
<br />  <span class="sectionToc" >2.1 <a
-href="#sec:pkgopts-general" id="QQ2-1-21">General Options</a></span>
+href="#sec:pkgopts-general" id="QQ2-1-27">General Options</a></span>
<br />  <span class="sectionToc" >2.2 <a
-href="#sec:pkgopts-sec" id="QQ2-1-22">Sectioning, Headings and TOC Options</a></span>
+href="#sec:pkgopts-sec" id="QQ2-1-28">Sectioning, Headings and TOC Options</a></span>
<br />  <span class="sectionToc" >2.3 <a
-href="#sec:pkgopts-printglos" id="QQ2-1-23">Glossary Appearance Options</a></span>
+href="#sec:pkgopts-printglos" id="QQ2-1-29">Glossary Appearance Options</a></span>
<br />  <span class="sectionToc" >2.4 <a
-href="#sec:pkgopts-sort" id="QQ2-1-24">Sorting Options</a></span>
+href="#sec:pkgopts-sort" id="QQ2-1-30">Sorting Options</a></span>
<br />  <span class="sectionToc" >2.5 <a
-href="#sec:pkgopts-acronym" id="QQ2-1-25">Acronym Options</a></span>
+href="#sec:pkgopts-acronym" id="QQ2-1-31">Acronym Options</a></span>
<br />   <span class="subsectionToc" >2.5.1 <a
-href="#sec:pkgopts-old-acronym" id="QQ2-1-26">Deprecated Acronym Style Options</a></span>
+href="#sec:pkgopts-old-acronym" id="QQ2-1-32">Deprecated Acronym Style Options</a></span>
<br />  <span class="sectionToc" >2.6 <a
-href="#sec:pkgopts-other" id="QQ2-1-27">Other Options</a></span>
+href="#sec:pkgopts-other" id="QQ2-1-33">Other Options</a></span>
<br />  <span class="sectionToc" >2.7 <a
-href="#sec:setupglossaries" id="QQ2-1-28">Setting Options After the Package is Loaded</a></span>
+href="#sec:setupglossaries" id="QQ2-1-34">Setting Options After the Package is Loaded</a></span>
<br /> <span class="chapterToc" >3 <a
-href="#sec:setup" id="QQ2-1-29">Setting Up</a></span>
+href="#sec:setup" id="QQ2-1-35">Setting Up</a></span>
<br />  <span class="sectionToc" >3.1 <a
-href="#sec:setupopt1" id="QQ2-1-30">Option 1</a></span>
+href="#sec:setupopt1" id="QQ2-1-36">Option 1</a></span>
<br />  <span class="sectionToc" >3.2 <a
-href="#sec:setupopt23" id="QQ2-1-31">Options 2 and 3</a></span>
+href="#sec:setupopt23" id="QQ2-1-37">Options 2 and 3</a></span>
<br /> <span class="chapterToc" >4 <a
-href="#sec:newglosentry" id="QQ2-1-32">Defining Glossary Entries</a></span>
+href="#sec:newglosentry" id="QQ2-1-38">Defining Glossary Entries</a></span>
<br />  <span class="sectionToc" >4.1 <a
-href="#sec:plurals" id="QQ2-1-33">Plurals</a></span>
+href="#sec:plurals" id="QQ2-1-39">Plurals</a></span>
<br />  <span class="sectionToc" >4.2 <a
-href="#sec:grammar" id="QQ2-1-34">Other Grammatical Constructs</a></span>
+href="#sec:grammar" id="QQ2-1-40">Other Grammatical Constructs</a></span>
<br />  <span class="sectionToc" >4.3 <a
-href="#sec:addkey" id="QQ2-1-35">Additional Keys</a></span>
+href="#sec:addkey" id="QQ2-1-41">Additional Keys</a></span>
<br />   <span class="subsectionToc" >4.3.1 <a
-href="#sec:glsaddkey" id="QQ2-1-36">Document Keys</a></span>
+href="#sec:glsaddkey" id="QQ2-1-42">Document Keys</a></span>
<br />   <span class="subsectionToc" >4.3.2 <a
-href="#sec:glsaddstoragekey" id="QQ2-1-37">Storage Keys</a></span>
+href="#sec:glsaddstoragekey" id="QQ2-1-43">Storage Keys</a></span>
<br />  <span class="sectionToc" >4.4 <a
-href="#sec:expansion" id="QQ2-1-38">Expansion</a></span>
+href="#sec:expansion" id="QQ2-1-44">Expansion</a></span>
<br />  <span class="sectionToc" >4.5 <a
-href="#sec:subentries" id="QQ2-1-40">Sub-Entries</a></span>
+href="#sec:subentries" id="QQ2-1-46">Sub-Entries</a></span>
<br />   <span class="subsectionToc" >4.5.1 <a
-href="#sec:hierarchical" id="QQ2-1-41">Hierarchical Categories</a></span>
+href="#sec:hierarchical" id="QQ2-1-47">Hierarchical Categories</a></span>
<br />   <span class="subsectionToc" >4.5.2 <a
-href="#sec:homographs" id="QQ2-1-42">Homographs</a></span>
-<br />  <span class="sectionToc" >4.6 <a
-href="#sec:loadglsentries" id="QQ2-1-43">Loading Entries From a File</a></span>
+href="#sec:homographs" id="QQ2-1-48">Homographs</a></span>
+<br />  <span class="sectionToc" >4.6 <a
+href="#sec:loadglsentries" id="QQ2-1-49">Loading Entries From a File</a></span>
<br />  <span class="sectionToc" >4.7 <a
-href="#sec:moveentry" id="QQ2-1-44">Moving Entries to Another Glossary</a></span>
+href="#sec:moveentry" id="QQ2-1-50">Moving Entries to Another Glossary</a></span>
<br />  <span class="sectionToc" >4.8 <a
-href="#sec:docdefs" id="QQ2-1-45">Drawbacks With Defining Entries in the Document Environment</a></span>
+href="#sec:docdefs" id="QQ2-1-51">Drawbacks With Defining Entries in the Document Environment</a></span>
<br />   <span class="subsectionToc" >4.8.1 <a
-href="#sec:techissues" id="QQ2-1-46">Technical Issues</a></span>
+href="#sec:techissues" id="QQ2-1-52">Technical Issues</a></span>
<br />   <span class="subsectionToc" >4.8.2 <a
-href="#sec:goodpractice" id="QQ2-1-47">Good Practice Issues</a></span>
+href="#sec:goodpractice" id="QQ2-1-53">Good Practice Issues</a></span>
<br /> <span class="chapterToc" >5 <a
-href="#sec:numberlists" id="QQ2-1-48">Number lists</a></span>
+href="#sec:numberlists" id="QQ2-1-54">Number lists</a></span>
+<br />  <span class="sectionToc" >5.1 <a
+href="#sec:encap" id="QQ2-1-55">Encap Values</a></span>
+<br />  <span class="sectionToc" >5.2 <a
+href="#sec:locationsyntax" id="QQ2-1-56">Locations</a></span>
+<br />  <span class="sectionToc" >5.3 <a
+href="#sec:ranges" id="QQ2-1-57">Range Formations</a></span>
+<br />  <span class="sectionToc" >5.4 <a
+href="#sec:isthook" id="QQ2-1-58">Style Hook</a></span>
<br /> <span class="chapterToc" >6 <a
-href="#sec:glslink" id="QQ2-1-49">Links to Glossary Entries</a></span>
+href="#sec:glslink" id="QQ2-1-59">Links to Glossary Entries</a></span>
<br />  <span class="sectionToc" >6.1 <a
-href="#sec:gls-like" id="QQ2-1-51">The <span
+href="#sec:gls-like" id="QQ2-1-61">The <span
class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</a></span>
<br />  <span class="sectionToc" >6.2 <a
-href="#sec:glstext-like" id="QQ2-1-52">The <span
+href="#sec:glstext-like" id="QQ2-1-62">The <span
class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)</a></span>
<br />  <span class="sectionToc" >6.3 <a
-href="#sec:glsdisplay" id="QQ2-1-53">Changing the format of the link text</a></span>
+href="#sec:glsdisplay" id="QQ2-1-63">Changing the format of the link text</a></span>
<br />  <span class="sectionToc" >6.4 <a
-href="#sec:disablehyperlinks" id="QQ2-1-54">Enabling and disabling hyperlinks to glossary entries</a></span>
+href="#sec:disablehyperlinks" id="QQ2-1-64">Enabling and disabling hyperlinks to glossary entries</a></span>
<br /> <span class="chapterToc" >7 <a
-href="#sec:glsadd" id="QQ2-1-55">Adding an Entry to the Glossary Without Generating Text</a></span>
+href="#sec:glsadd" id="QQ2-1-65">Adding an Entry to the Glossary Without Generating Text</a></span>
<br /> <span class="chapterToc" >8 <a
-href="#sec:crossref" id="QQ2-1-56">Cross-Referencing Entries</a></span>
+href="#sec:crossref" id="QQ2-1-66">Cross-Referencing Entries</a></span>
<br />  <span class="sectionToc" >8.1 <a
-href="#sec:customxr" id="QQ2-1-57">Customising Cross-reference Text</a></span>
+href="#sec:customxr" id="QQ2-1-67">Customising Cross-reference Text</a></span>
<br /> <span class="chapterToc" >9 <a
-href="#sec:glsnolink" id="QQ2-1-58">Using Glossary Terms Without Links</a></span>
+href="#sec:glsnolink" id="QQ2-1-68">Using Glossary Terms Without Links</a></span>
<br /> <span class="chapterToc" >10 <a
-href="#sec:printglossary" id="QQ2-1-59">Displaying a glossary</a></span>
+href="#sec:printglossary" id="QQ2-1-69">Displaying a glossary</a></span>
<br /> <span class="chapterToc" >11 <a
-href="#sec:xindy" id="QQ2-1-60">Xindy (Option 3)</a></span>
+href="#sec:xindy" id="QQ2-1-70">Xindy (Option 3)</a></span>
<br />  <span class="sectionToc" >11.1 <a
-href="#sec:langenc" id="QQ2-1-61">Language and Encodings</a></span>
+href="#sec:langenc" id="QQ2-1-71">Language and Encodings</a></span>
<br />  <span class="sectionToc" >11.2 <a
-href="#sec:xindyloc" id="QQ2-1-62">Locations and Number lists</a></span>
+href="#sec:xindyloc" id="QQ2-1-72">Locations and Number lists</a></span>
<br />  <span class="sectionToc" >11.3 <a
-href="#sec:groups" id="QQ2-1-63">Glossary Groups</a></span>
+href="#sec:groups" id="QQ2-1-73">Glossary Groups</a></span>
<br /> <span class="chapterToc" >12 <a
-href="#sec:newglossary" id="QQ2-1-64">Defining New Glossaries</a></span>
+href="#sec:newglossary" id="QQ2-1-74">Defining New Glossaries</a></span>
<br /> <span class="chapterToc" >13 <a
-href="#sec:acronyms" id="QQ2-1-65">Acronyms and Other Abbreviations</a></span>
+href="#sec:acronyms" id="QQ2-1-75">Acronyms and Other Abbreviations</a></span>
<br />  <span class="sectionToc" >13.1 <a
-href="#sec:setacronymstyle" id="QQ2-1-67">Changing the Abbreviation Style</a></span>
+href="#sec:setacronymstyle" id="QQ2-1-77">Changing the Abbreviation Style</a></span>
<br />   <span class="subsectionToc" >13.1.1 <a
-href="#sec:predefinedacrstyles" id="QQ2-1-68">Predefined Acronym Styles</a></span>
+href="#sec:predefinedacrstyles" id="QQ2-1-78">Predefined Acronym Styles</a></span>
<br />   <span class="subsectionToc" >13.1.2 <a
-href="#sec:customacronym" id="QQ2-1-69">Defining A Custom Acronym Style</a></span>
+href="#sec:customacronym" id="QQ2-1-79">Defining A Custom Acronym Style</a></span>
<br />  <span class="sectionToc" >13.2 <a
-href="#sec:disploa" id="QQ2-1-70">Displaying the List of Acronyms</a></span>
+href="#sec:disploa" id="QQ2-1-80">Displaying the List of Acronyms</a></span>
<br />  <span class="sectionToc" >13.3 <a
-href="#sec:oldacronym" id="QQ2-1-71">Upgrading From the glossary Package</a></span>
+href="#sec:oldacronym" id="QQ2-1-81">Upgrading From the glossary Package</a></span>
<br /> <span class="chapterToc" >14 <a
-href="#sec:glsunset" id="QQ2-1-73">Unsetting and Resetting Entry Flags</a></span>
+href="#sec:glsunset" id="QQ2-1-83">Unsetting and Resetting Entry Flags</a></span>
<br />  <span class="sectionToc" >14.1 <a
-href="#sec:enableentrycount" id="QQ2-1-74">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span>
+href="#sec:enableentrycount" id="QQ2-1-84">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span>
<br /> <span class="chapterToc" >15 <a
-href="#sec:styles" id="QQ2-1-75">Glossary Styles</a></span>
+href="#sec:styles" id="QQ2-1-85">Glossary Styles</a></span>
<br />  <span class="sectionToc" >15.1 <a
-href="#sec:predefinedstyles" id="QQ2-1-76">Predefined Styles</a></span>
+href="#sec:predefinedstyles" id="QQ2-1-86">Predefined Styles</a></span>
<br />   <span class="subsectionToc" >15.1.1 <a
-href="#sec:liststyles" id="QQ2-1-78">List Styles</a></span>
+href="#sec:liststyles" id="QQ2-1-88">List Styles</a></span>
<br />   <span class="subsectionToc" >15.1.2 <a
-href="#sec:longstyles" id="QQ2-1-79">Longtable Styles</a></span>
+href="#sec:longstyles" id="QQ2-1-89">Longtable Styles</a></span>
<br />   <span class="subsectionToc" >15.1.3 <a
-href="#sec:longraggedstyles" id="QQ2-1-80">Longtable Styles (Ragged Right)</a></span>
+href="#sec:longraggedstyles" id="QQ2-1-90">Longtable Styles (Ragged Right)</a></span>
<br />   <span class="subsectionToc" >15.1.4 <a
-href="#sec:longbooktabsstyles" id="QQ2-1-81">Longtable Styles (<span
+href="#sec:longbooktabsstyles" id="QQ2-1-91">Longtable Styles (<span
class="cmss-10">booktabs</span>)</a></span>
<br />   <span class="subsectionToc" >15.1.5 <a
-href="#sec:superstyles" id="QQ2-1-82">Supertabular Styles</a></span>
+href="#sec:superstyles" id="QQ2-1-92">Supertabular Styles</a></span>
<br />   <span class="subsectionToc" >15.1.6 <a
-href="#sec:superraggedstyles" id="QQ2-1-83">Supertabular Styles (Ragged Right)</a></span>
+href="#sec:superraggedstyles" id="QQ2-1-93">Supertabular Styles (Ragged Right)</a></span>
<br />   <span class="subsectionToc" >15.1.7 <a
-href="#sec:treestyles" id="QQ2-1-84">Tree-Like Styles</a></span>
+href="#sec:treestyles" id="QQ2-1-94">Tree-Like Styles</a></span>
<br />   <span class="subsectionToc" >15.1.8 <a
-href="#sec:mcolstyles" id="QQ2-1-85">Multicols Style</a></span>
+href="#sec:mcolstyles" id="QQ2-1-95">Multicols Style</a></span>
<br />   <span class="subsectionToc" >15.1.9 <a
-href="#sec:inline" id="QQ2-1-87">In-Line Style</a></span>
+href="#sec:inline" id="QQ2-1-97">In-Line Style</a></span>
<br />  <span class="sectionToc" >15.2 <a
-href="#sec:newglossarystyle" id="QQ2-1-88">Defining your own glossary style</a></span>
+href="#sec:newglossarystyle" id="QQ2-1-98">Defining your own glossary style</a></span>
<br /> <span class="chapterToc" >16 <a
-href="#sec:utilities" id="QQ2-1-89">Utilities</a></span>
+href="#sec:utilities" id="QQ2-1-99">Utilities</a></span>
+
+
<br />  <span class="sectionToc" >16.1 <a
-href="#sec:loops" id="QQ2-1-90">Loops</a></span>
+href="#sec:loops" id="QQ2-1-100">Loops</a></span>
<br />  <span class="sectionToc" >16.2 <a
-href="#sec:conditionals" id="QQ2-1-91">Conditionals</a></span>
+href="#sec:conditionals" id="QQ2-1-101">Conditionals</a></span>
<br />  <span class="sectionToc" >16.3 <a
-href="#sec:fetchset" id="QQ2-1-92">Fetching and Updating the Value of a Field</a></span>
+href="#sec:fetchset" id="QQ2-1-102">Fetching and Updating the Value of a Field</a></span>
<br /> <span class="chapterToc" >17 <a
-href="#sec:prefix" id="QQ2-1-93">Prefixes or Determiners</a></span>
+href="#sec:prefix" id="QQ2-1-103">Prefixes or Determiners</a></span>
<br /> <span class="chapterToc" >18 <a
-href="#sec:accsupp" id="QQ2-1-94">Accessibility Support</a></span>
-
-
+href="#sec:accsupp" id="QQ2-1-104">Accessibility Support</a></span>
<br /> <span class="chapterToc" >19 <a
-href="#sec:trouble" id="QQ2-1-95">Troubleshooting</a></span>
+href="#sec:trouble" id="QQ2-1-105">Troubleshooting</a></span>
</div>
@@ -718,6 +821,26 @@
<!--l. 1--><p class="indent" >
</p><dl class="description"><dt class="description">
<a
+ id="glo:bib2gls"></a><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3001"></a> </dt><dd
+class="description"><br
+class="newline" />An <a
+href="#glo:indexingapp">indexing application</a> that combines two functions in one: (1) fetches entry
+ definition from a <span
+class="cmtt-10">.bib </span>file based on information provided in the <span
+class="cmtt-10">.aux </span>file (similar
+ to <span
+class="cmtt-10">bibtex</span>); (2) hierarchically sorts and collates location lists (similar to <span
+class="cmtt-10">makeindex</span>
+ and <span
+class="cmtt-10">xindy</span>). This application is designed for use with <span
+class="cmss-10">glossaries-extra </span>and can’t be
+ used with just the base <span
+class="cmss-10">glossaries </span>package. <br
+class="newline" />
+ </dd><dt class="description">
+<a
id="glo:cli"></a><span
class="cmbx-10">Command Line Interface (CLI)</span> </dt><dd
class="description"><br
@@ -730,7 +853,7 @@
<a
id="glo:entrylocation"></a><span
class="cmbx-10">Entry location</span><a
- id="dx1-3001"></a> </dt><dd
+ id="dx1-3002"></a> </dt><dd
class="description"><br
class="newline" />The location of the entry in the document. This defaults to the page number on
which the entry appears. An entry may have multiple locations. <br
@@ -739,54 +862,54 @@
<a
id="glo:exlatinalph"></a><span
class="cmbx-10">Extended Latin Alphabet</span><a
- id="dx1-3002"></a> </dt><dd
+ id="dx1-3003"></a> </dt><dd
class="description"><br
class="newline" />An alphabet consisting of <a
href="#glo:latinchar">Latin character<a
- id="dx1-3003"></a>s</a> and <a
+ id="dx1-3004"></a>s</a> and <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3004"></a>s</a>. <br
+ id="dx1-3005"></a>s</a>. <br
class="newline" />
+
+
</dd><dt class="description">
<a
id="glo:exlatinchar"></a><span
class="cmbx-10">Extended Latin Character</span><a
- id="dx1-3005"></a> </dt><dd
+ id="dx1-3006"></a> </dt><dd
class="description"><br
class="newline" />A character that’s created by combining <a
href="#glo:latinchar">Latin character<a
- id="dx1-3006"></a>s</a> to form ligatures (e.g. æ)
+ id="dx1-3007"></a>s</a> to form ligatures (e.g. æ)
or by applying diacritical marks to a Latin character<a
- id="dx1-3007"></a> or characters (e.g. á or ø).
+ id="dx1-3008"></a> or characters (e.g. á or ø).
See also <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-3008"></a></a>. <br
+ id="dx1-3009"></a></a>. <br
class="newline" />
</dd><dt class="description">
-
-
<a
id="glo:firstuse"></a><span
class="cmbx-10">First use</span><a
- id="dx1-3009"></a> </dt><dd
+ id="dx1-3010"></a> </dt><dd
class="description"><br
class="newline" />The first time a glossary entry is used (from the start of the document or after
a reset) with one of the following commands: <span
class="cmtt-10">\gls</span><a
- id="dx1-3010"></a>, <span
+ id="dx1-3011"></a>, <span
class="cmtt-10">\Gls</span><a
- id="dx1-3011"></a>, <span
+ id="dx1-3012"></a>, <span
class="cmtt-10">\GLS</span><a
- id="dx1-3012"></a>, <span
+ id="dx1-3013"></a>, <span
class="cmtt-10">\glspl</span><a
- id="dx1-3013"></a>, <span
+ id="dx1-3014"></a>, <span
class="cmtt-10">\Glspl</span><a
- id="dx1-3014"></a>,
+ id="dx1-3015"></a>,
<span
class="cmtt-10">\GLSpl</span><a
- id="dx1-3015"></a> or <span
+ id="dx1-3016"></a> or <span
class="cmtt-10">\glsdisp</span><a
- id="dx1-3016"></a>. (See <a
+ id="dx1-3017"></a>. (See <a
href="#glo:firstuseflag">first use flag</a> & <a
href="#glo:firstusetext">first use text</a>.) <br
class="newline" />
@@ -794,7 +917,7 @@
<a
id="glo:firstuseflag"></a><span
class="cmbx-10">First use flag</span><a
- id="dx1-3017"></a> </dt><dd
+ id="dx1-3018"></a> </dt><dd
class="description"><br
class="newline" />A conditional that determines whether or not the entry has been used according
to the rules of <a
@@ -801,7 +924,7 @@
href="#glo:firstuse">first use</a>. Commands to unset or reset this conditional are described
in <a
href="#sec:glsunset"><span
-class="cmsy-10">§</span>14 </a><a
+class="tcrm-1000">§</span>14 </a><a
href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br
class="newline" />
</dd><dt class="description">
@@ -808,22 +931,22 @@
<a
id="glo:firstusetext"></a><span
class="cmbx-10">First use text</span><a
- id="dx1-3018"></a> </dt><dd
+ id="dx1-3019"></a> </dt><dd
class="description"><br
class="newline" />The text that is displayed on <a
href="#glo:firstuse">first use</a>, which is governed by the <span
class="cmss-10">first</span><a
- id="dx1-3019"></a> and
+ id="dx1-3020"></a> and
<span
class="cmss-10">firstplural</span><a
- id="dx1-3020"></a> keys of <span
+ id="dx1-3021"></a> keys of <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-3021"></a>. (May be overridden by <span
+ id="dx1-3022"></a>. (May be overridden by <span
class="cmtt-10">\glsdisp</span><a
- id="dx1-3022"></a> or by
+ id="dx1-3023"></a> or by
<span
class="cmtt-10">\defglsentry</span><a
- id="dx1-3023"></a>.) <br
+ id="dx1-3024"></a>.) <br
class="newline" />
</dd><dt class="description">
<a
@@ -852,10 +975,10 @@
class="E">E</span>X</span>: <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-3024"></a></a> and <a
+ id="dx1-3025"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-3025"></a></a>.
+ id="dx1-3026"></a></a>.
These are both <a
href="#glo:cli">command line interface (CLI)</a> applications. <br
class="newline" />
@@ -863,18 +986,20 @@
<a
id="glo:latinalph"></a><span
class="cmbx-10">Latin Alphabet</span><a
- id="dx1-3026"></a> </dt><dd
+ id="dx1-3027"></a> </dt><dd
class="description"><br
class="newline" />The alphabet consisting of <a
href="#glo:latinchar">Latin character<a
- id="dx1-3027"></a>s</a>. See also <a
+ id="dx1-3028"></a>s</a>. See also <a
href="#glo:exlatinalph">extended Latin alphabet</a>. <br
class="newline" />
+
+
</dd><dt class="description">
<a
id="glo:latinchar"></a><span
class="cmbx-10">Latin Character</span><a
- id="dx1-3028"></a> </dt><dd
+ id="dx1-3029"></a> </dt><dd
class="description"><br
class="newline" />One of the letters <span
class="cmtt-10">a</span>, …, <span
@@ -882,19 +1007,17 @@
class="cmtt-10">A</span>, …, <span
class="cmtt-10">Z</span>. See also <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3029"></a></a>. <br
+ id="dx1-3030"></a></a>. <br
class="newline" />
</dd><dt class="description">
<a
id="glo:linktext"></a><span
class="cmbx-10">Link text</span><a
- id="dx1-3030"></a> </dt><dd
+ id="dx1-3031"></a> </dt><dd
class="description"><br
class="newline" />The text produced by commands such as <span
class="cmtt-10">\gls</span><a
- id="dx1-3031"></a>. It may or may not be a hyperlink
-
-
+ id="dx1-3032"></a>. It may or may not be a hyperlink
to the glossary. <br
class="newline" />
</dd><dt class="description">
@@ -901,28 +1024,33 @@
<a
id="glo:makeglossaries"></a><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-3032"></a> </dt><dd
+ id="dx1-3033"></a> </dt><dd
class="description"><br
-class="newline" />A custom designed Perl script interface to <a
+class="newline" />A custom designed Perl script interface to <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-3033"></a></a> and <a
+ id="dx1-3034"></a></a> and <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-3034"></a></a> provided with
- the <span
-class="cmss-10">glossaries </span>package. <br
+ id="dx1-3035"></a></a> provided
+ with the <span
+class="cmss-10">glossaries </span>package. <span class="TEX">T<span
+class="E">E</span>X</span> distributions on Windows convert the original
+ <span
+class="cmtt-10">makeglossaries </span>script into an executable <span
+class="cmtt-10">makeglossaries.exe </span>for convenience.
+ <br
class="newline" />
</dd><dt class="description">
<a
id="glo:makeglossariesgui"></a><span
class="cmtt-10">makeglossariesgui</span><a
- id="dx1-3035"></a> </dt><dd
+ id="dx1-3036"></a> </dt><dd
class="description"><br
class="newline" />A Java GUI alternative to <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-3036"></a></a> that also provides diagnostic tools.
+ id="dx1-3037"></a></a> that also provides diagnostic tools.
Available separately on <a
href="http://ctan.org/pkg/makeglossariesgui" >CTAN</a>. <br
class="newline" />
@@ -929,25 +1057,27 @@
</dd><dt class="description">
<a
id="glo:makeglossaries-lite.lua"></a><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-3037"></a> </dt><dd
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-3038"></a> </dt><dd
class="description"><br
class="newline" />A custom designed Lua script interface to <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-3038"></a></a> and <a
+ id="dx1-3039"></a></a> and <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-3039"></a></a> provided with
+ id="dx1-3040"></a></a> provided with
the <span
class="cmss-10">glossaries </span>package. This is a cut-down alternative to the Perl <span
class="cmtt-10">makeglossaries</span>
- script. If you have Perl installed, use the Perl script instead. Note that <span class="TEX">T<span
-class="E">E</span>X</span> Live
- creates a symbolic link called <span
-class="cmtt-10">makeglossaries-lite </span>(without the <span
-class="cmtt-10">.lua </span>extension)
- to the actual <span
+ script. If you have Perl installed, use the Perl script instead. This script is actually
+ distributed with the file name <span
+class="cmtt-10">makeglossaries-lite.lua</span>, but <span class="TEX">T<span
+class="E">E</span>X</span> Live (on
+ Unix-like systems) creates a symbolic link called <span
+class="cmtt-10">makeglossaries-lite </span>(without
+ the <span
+class="cmtt-10">.lua </span>extension) to the actual <span
class="cmtt-10">makeglossaries-lite.lua </span>script. <br
class="newline" />
</dd><dt class="description">
@@ -954,7 +1084,7 @@
<a
id="glo:makeindex"></a><span
class="cmtt-10">makeindex</span><a
- id="dx1-3040"></a> </dt><dd
+ id="dx1-3041"></a> </dt><dd
class="description"><br
class="newline" />An <a
href="#glo:indexingapp">indexing application</a>. <br
@@ -963,41 +1093,43 @@
<a
id="glo:nonlatinalph"></a><span
class="cmbx-10">Non-Latin Alphabet</span><a
- id="dx1-3041"></a> </dt><dd
+ id="dx1-3042"></a> </dt><dd
class="description"><br
class="newline" />An alphabet consisting of <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-3042"></a>s</a>. <br
+ id="dx1-3043"></a>s</a>. <br
class="newline" />
</dd><dt class="description">
<a
id="glo:nonlatinchar"></a><span
class="cmbx-10">Non-Latin Character</span><a
- id="dx1-3043"></a> </dt><dd
+ id="dx1-3044"></a> </dt><dd
class="description"><br
class="newline" />An <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3044"></a></a> or a character that isn’t a <a
+ id="dx1-3045"></a></a> or a character that isn’t a <a
href="#glo:latinchar">Latin character<a
- id="dx1-3045"></a></a>. <br
+ id="dx1-3046"></a></a>. <br
class="newline" />
+
+
</dd><dt class="description">
<a
id="glo:numberlist"></a><span
class="cmbx-10">Number list</span><a
- id="dx1-3046"></a> </dt><dd
+ id="dx1-3047"></a> </dt><dd
class="description"><br
class="newline" />A list of <a
href="#glo:entrylocation">entry locations</a> (also called a location list). The number list can be
suppressed using the <span
class="cmss-10">nonumberlist</span><a
- id="dx1-3047"></a> package option. <br
+ id="dx1-3048"></a> package option. <br
class="newline" />
</dd><dt class="description">
<a
id="glo:sanitize"></a><span
class="cmbx-10">Sanitize</span><a
- id="dx1-3048"></a> </dt><dd
+ id="dx1-3049"></a> </dt><dd
class="description"><br
class="newline" />Converts command names into character sequences. That is, a command called,
say, <span
@@ -1006,17 +1138,15 @@
class="cmtt-10">f</span>, <span
class="cmtt-10">o</span>, <span
class="cmtt-10">o</span>. Depending on
-
-
the font, the backslash character may appear as a dash when used in the main
document text, so <span
class="cmtt-10">\foo </span>will appear as: —foo.
- <!--l. 246--><p class="noindent" >Earlier versions of <span
+ <!--l. 298--><p class="noindent" >Earlier versions of <span
class="cmss-10">glossaries </span>used this technique to write information to the files
used by the indexing applications to prevent problems caused by fragile commands.
Now, this is only used for the <span
class="cmss-10">sort</span><a
- id="dx1-3049"></a> key. <br
+ id="dx1-3050"></a> key. <br
class="newline" />
</p></dd><dt class="description">
<a
@@ -1029,11 +1159,11 @@
class="cmbx-10">E</span></span><span
class="cmbx-10">X</span></span></span><span
class="cmbx-10"> Extended Latin Character</span><a
- id="dx1-3050"></a> </dt><dd
+ id="dx1-3051"></a> </dt><dd
class="description"><br
class="newline" />An <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3051"></a></a> that can be created by a core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-3052"></a></a> that can be created by a core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> command,
such as <span
class="cmtt-10">\o </span>(ø) or <span
@@ -1044,7 +1174,7 @@
<a
id="glo:xindy"></a><span
class="cmtt-10">xindy</span><a
- id="dx1-3052"></a> </dt><dd
+ id="dx1-3053"></a> </dt><dd
class="description"><br
class="newline" />A flexible <a
href="#glo:indexingapp">indexing application</a> with multilingual support written in Perl. <br
@@ -1051,19 +1181,19 @@
class="newline" /></dd></dl>
-<!--l. 543--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a
+<!--l. 601--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a
id="sec:intro"></a>Introduction</h2>
-</p><!--l. 546--><p class="indent" > The <span
+</p><!--l. 604--><p class="indent" > The <span
class="cmss-10">glossaries </span>package is provided to assist generating lists of terms, symbols or
abbreviations (glossaries). It has a certain amount of flexibility, allowing the user to customize
the format of the glossary and define multiple glossaries. It also supports glossary
styles that include symbols (in addition to a name and description) for glossary
entries. There is provision for loading a database of glossary terms. Only those terms
-used<span class="footnote-mark"><a
+indexed<span class="footnote-mark"><a
href="#fn1x1" id="fn1x1-bk"><sup class="textsuperscript">1.1</sup></a></span><a
id="x1-4001f1"></a> in
the document will be added to the glossary.
-</p><!--l. 559--><p class="indent" > <span
+</p><!--l. 617--><p class="indent" > <span
class="cmbx-10">This package replaces the </span><span
class="cmssbx-10">glossary</span><a
id="dx1-4005"></a> <span
@@ -1071,12 +1201,12 @@
document <a
href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> for assistance in
upgrading.
-</p><!--l. 563--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is the
+</p><!--l. 621--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is the
necessity of having a large manual that covers all the various settings. If you are
daunted by the size of the manual, try starting off with the much shorter <a
href="glossariesbegin.html" >guide for
beginners</a>.
-</p><!--l. 569--><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
+</p><!--l. 627--><p class="indent" > <div class="important" title="Important Note"> There’s a common misconception that you have to have Perl installed in order to use
the <span
class="cmss-10">glossaries </span>package. Perl is <span
class="cmti-10">not </span>a requirement but it does increase the available
@@ -1084,8 +1214,67 @@
href="#glo:exlatinalph">extended Latin alphabet</a> or a <a
href="#glo:nonlatinalph">non-Latin alphabet</a>.
</div>
-</p><!--l. 574--><p class="noindent" >
-</p><!--l. 576--><p class="indent" > The basic idea behind the <span
+</p><!--l. 632--><p class="noindent" >
+</p><!--l. 634--><p class="indent" > This document uses the <span
+class="cmss-10">glossaries </span>package. For example, when viewing the PDF version of
+this document in a hyperlinked-enabled PDF viewer (such as Adobe Reader or
+Okular) if you click on the word “<a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-4006"></a></a>” you’ll be taken to the entry in the glossary
+where there’s a brief description of the term “<span
+class="cmtt-10">xindy</span><a
+ id="dx1-4007"></a>”. This is the way the <span
+class="cmss-10">glossaries</span>
+mechanism works. An <a
+href="#glo:indexingapp">indexing application</a> is used to generated the sorted list of
+terms. The <a
+href="#glo:indexingapp">indexing applications</a> are <a
+href="#glo:cli">command line interface (CLI)</a> tools, which
+means they can be run directly from a command prompt or terminal, or can be
+integrated into some text editors, or you can use a build tool such as <span
+class="cmtt-10">arara</span><a
+ id="dx1-4008"></a> to run
+them.
+</p><!--l. 646--><p class="indent" > The remainder of this introductory section covers the following: </p>
+ <ul class="itemize1">
+ <li class="itemize"><a
+href="#sec:indexingoptions"><span
+class="tcrm-1000">§</span>1.1 </a><a
+href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> lists the available indexing options.
+ </li>
+ <li class="itemize"><a
+href="#sec:samples"><span
+class="tcrm-1000">§</span>1.2 </a><a
+href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this package.
+ </li>
+ <li class="itemize"><a
+href="#sec:lipsum"><span
+class="tcrm-1000">§</span>1.3 </a><a
+href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a> lists the dummy glossary files that may be used
+ for testing.
+ </li>
+ <li class="itemize"><a
+href="#sec:languages"><span
+class="tcrm-1000">§</span>1.4 </a><a
+href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a
+ language other than English.
+ </li>
+ <li class="itemize"><a
+href="#sec:makeglossaries"><span
+class="tcrm-1000">§</span>1.5 </a><a
+href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use an <a
+href="#glo:indexingapp">indexing
+ application</a> to create the sorted glossaries for your document (Options <a
+href="#option2">2</a> or <a
+href="#option3">3</a>).
+
+
+ </li></ul>
+<!--l. 666--><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. 669--><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
@@ -1092,684 +1281,1449 @@
<span
class="cmtt-10">\ref</span>). You can also, optionally, display a list of the entries you have referenced in your
document (the glossary). This last part, displaying the glossary, is the part that most new
-users find difficult. There are three options:
- </p><dl class="description"><dt class="description">
- </dt><dd
-class="description"><a
- id="option1"></a><span
+users find difficult. There are three options available with the base <span
+class="cmss-10">glossaries </span>package and two
+further options with the extension package <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a>. An overview of these options is
+given in <a
+href="#tab:options">table 1.1</a>.
+</p><!--l. 681--><p class="indent" > If you are developing a class or package that loads <span
+class="cmss-10">glossaries</span>, I recommend that you
+don’t force the user into a particular indexing method by adding an unconditional
+<span
+class="cmtt-10">\makeglossaries </span>into your class or package code. Aside from forcing the user into a
+particular indexing method, it means that they’re unable to use any commands that must
+come before <span
+class="cmtt-10">\makeglossaries </span>(such as <span
+class="cmtt-10">\newglossary</span>) and they can’t switch off the indexing
+whilst working on a draft document.
+</p>
+ <div class="table">
+
+
+<!--l. 690--><p class="indent" > <a
+ id="tab:options"></a></p><hr class="float" /><div class="float"
+>
+
+
+ <div class="caption"
+><span class="id">Table 1.1: </span><span
+class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50011 -->
+
+
+<div class="tabular"> <table id="TBL-2" class="tabular"
+cellspacing="0" cellpadding="0"
+><colgroup id="TBL-2-1g"><col
+id="TBL-2-1" /><col
+id="TBL-2-2" /><col
+id="TBL-2-3" /><col
+id="TBL-2-4" /><col
+id="TBL-2-5" /><col
+id="TBL-2-6" /></colgroup><tr
+ style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:wrap; text-align:left;" id="TBL-2-1-1"
+class="td01"><!--l. 698--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
+class="td11"> <a
+href="#option1"><span
class="cmbx-10">Option</span><span
-class="cmbx-10"> 1</span>:
- <!--l. 587--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted list, it doesn’t
- work well for <a
+class="cmbx-10"> 1</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-3"
+class="td11"> <a
+href="#option2"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10"> 2</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-4"
+class="td11"> <a
+href="#option3"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10"> 3</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-5"
+class="td11"> <a
+href="#option4"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10"> 4</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-6"
+class="td10"> <a
+href="#option5"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10"> 5</span></a></td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:wrap; text-align:left;" id="TBL-2-2-1"
+class="td01"><!--l. 700--><p class="noindent" ><span
+class="cmr-9">Requires</span>
+<a
+href="#glo:glossaries-extra"><span
+class="cmss-9">glossaries-extra</span></a><span
+class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
+class="td11"> <span id="textcolor1"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
+class="td11"> <span id="textcolor2"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4"
+class="td11"> <span id="textcolor3"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-5"
+class="td11"> <span id="textcolor4"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-6"
+class="td10"> <span id="textcolor5"><span
+class="pzdr-">✔</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:wrap; text-align:left;" id="TBL-2-3-1"
+class="td01"><!--l. 702--><p class="noindent" ><span
+class="cmr-9">Requires</span>
+<span
+class="cmr-9">an</span>
+<span
+class="cmr-9">external</span>
+<span
+class="cmr-9">application?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
+class="td11"> <span id="textcolor6"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
+class="td11"> <span id="textcolor7"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4"
+class="td11"> <span id="textcolor8"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-5"
+class="td11"> <span id="textcolor9"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-6"
+class="td10"> <span id="textcolor10"><span
+class="pzdr-">✘</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:wrap; text-align:left;" id="TBL-2-4-1"
+class="td01"><!--l. 704--><p class="noindent" ><span
+class="cmr-9">Requires</span>
+<span
+class="cmr-9">Perl?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
+class="td11"> <span id="textcolor11"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
+class="td11"> <span id="textcolor12"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4"
+class="td11"> <span id="textcolor13"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-5"
+class="td11"> <span id="textcolor14"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-6"
+class="td10"> <span id="textcolor15"><span
+class="pzdr-">✘</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:wrap; text-align:left;" id="TBL-2-5-1"
+class="td01"><!--l. 706--><p class="noindent" ><span
+class="cmr-9">Requires</span>
+<span
+class="cmr-9">Java?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
+class="td11"> <span id="textcolor16"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
+class="td11"> <span id="textcolor17"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4"
+class="td11"> <span id="textcolor18"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-5"
+class="td11"> <span id="textcolor19"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-6"
+class="td10"> <span id="textcolor20"><span
+class="pzdr-">✘</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:wrap; text-align:left;" id="TBL-2-6-1"
+class="td01"><!--l. 708--><p class="noindent" ><span
+class="cmr-9">Can</span>
+<span
+class="cmr-9">sort</span>
+<a
+href="#glo:exlatinalph"><span
+class="cmr-9">extended</span>
+<span
+class="cmr-9">Latin</span>
+<span
+class="cmr-9">alphabets</span></a>
+<span
+class="cmr-9">or</span>
+<a
+href="#glo:nonlatinalph"><span
+class="cmr-9">non-Latin</span>
+<span
+class="cmr-9">alphabets</span></a><span
+class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
+class="td11"> <span id="textcolor21"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">*</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
+class="td11"> <span id="textcolor22"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
+class="td11"> <span id="textcolor23"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-5"
+class="td11"> <span id="textcolor24"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-6"
+class="td10"> N/A </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:wrap; text-align:left;" id="TBL-2-7-1"
+class="td01"><!--l. 711--><p class="noindent" ><span
+class="cmr-9">Efficient</span>
+<span
+class="cmr-9">sort</span>
+<span
+class="cmr-9">algorithm?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
+class="td11"> <span id="textcolor25"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
+class="td11"> <span id="textcolor26"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4"
+class="td11"> <span id="textcolor27"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-5"
+class="td11"> <span id="textcolor28"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-6"
+class="td10"> N/A </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:wrap; text-align:left;" id="TBL-2-8-1"
+class="td01"><!--l. 713--><p class="noindent" ><span
+class="cmr-9">Can</span>
+<span
+class="cmr-9">use</span>
+<span
+class="cmr-9">a</span>
+<span
+class="cmr-9">different</span>
+<span
+class="cmr-9">sort</span>
+<span
+class="cmr-9">method</span>
+<span
+class="cmr-9">for</span>
+<span
+class="cmr-9">each</span>
+<span
+class="cmr-9">glossary?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2"
+class="td11"> <span id="textcolor29"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3"
+class="td11"> <span id="textcolor30"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-4"
+class="td11"> <span id="textcolor31"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-5"
+class="td11"> <span id="textcolor32"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-6"
+class="td10"> N/A </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:wrap; text-align:left;" id="TBL-2-9-1"
+class="td01"><!--l. 717--><p class="noindent" ><span
+class="cmr-9">Any</span>
+<span
+class="cmr-9">problematic</span>
+<span
+class="cmr-9">sort</span>
+<span
+class="cmr-9">values?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2"
+class="td11"> <span id="textcolor33"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-3"
+class="td11"> <span id="textcolor34"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-4"
+class="td11"> <span id="textcolor35"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-5"
+class="td11"> <span id="textcolor36"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-6"
+class="td10"> <span id="textcolor37"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">‡</span></sup> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:wrap; text-align:left;" id="TBL-2-10-1"
+class="td01"><!--l. 719--><p class="noindent" ><span
+class="cmr-9">Are</span>
+<span
+class="cmr-9">entries</span>
+<span
+class="cmr-9">with</span>
+<span
+class="cmr-9">identical</span>
+<span
+class="cmr-9">sort</span>
+<span
+class="cmr-9">values</span>
+<span
+class="cmr-9">treated</span>
+<span
+class="cmr-9">as</span>
+<span
+class="cmr-9">separate</span>
+<span
+class="cmr-9">unique</span>
+<span
+class="cmr-9">entries?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2"
+class="td11"> <span id="textcolor38"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-3"
+class="td11"> <span id="textcolor39"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-4"
+class="td11"> <span id="textcolor40"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">§</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-5"
+class="td11"> <span id="textcolor41"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-6"
+class="td10"> <span id="textcolor42"><span
+class="pzdr-">✔</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:wrap; text-align:left;" id="TBL-2-11-1"
+class="td01"><!--l. 722--><p class="noindent" ><span
+class="cmr-9">Can</span>
+<span
+class="cmr-9">automatically</span>
+<span
+class="cmr-9">form</span>
+<span
+class="cmr-9">ranges</span>
+<span
+class="cmr-9">in</span>
+<span
+class="cmr-9">the</span>
+<span
+class="cmr-9">location</span>
+<span
+class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2"
+class="td11"> <span id="textcolor43"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-3"
+class="td11"> <span id="textcolor44"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-4"
+class="td11"> <span id="textcolor45"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-5"
+class="td11"> <span id="textcolor46"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-6"
+class="td10"> <span id="textcolor47"><span
+class="pzdr-">✘</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:wrap; text-align:left;" id="TBL-2-12-1"
+class="td01"><!--l. 724--><p class="noindent" ><span
+class="cmr-9">Can</span>
+<span
+class="cmr-9">have</span>
+<span
+class="cmr-9">non-standard</span>
+<span
+class="cmr-9">locations</span>
+<span
+class="cmr-9">in</span>
+<span
+class="cmr-9">the</span>
+<span
+class="cmr-9">location</span>
+<span
+class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-2"
+class="td11"> <span id="textcolor48"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-3"
+class="td11"> <span id="textcolor49"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-4"
+class="td11"> <span id="textcolor50"><span
+class="pzdr-">✔</span></span><sup class="textsuperscript"><span
+class="msam-10x-x-90">♢</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-5"
+class="td11"> <span id="textcolor51"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-6"
+class="td10"> <span id="textcolor52"><span
+class="pzdr-">✔</span></span><sup class="textsuperscript"><span
+class="tcrm-0900">¶</span></sup> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:wrap; text-align:left;" id="TBL-2-13-1"
+class="td01"><!--l. 729--><p class="noindent" ><span
+class="cmr-9">Maximum</span>
+<span
+class="cmr-9">hierarchical</span>
+<span
+class="cmr-9">depth</span>
+<span
+class="cmr-9">(style-dependent)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-2"
+class="td11"> <span
+class="cmsy-10">∞</span><sup class="textsuperscript"><span
+class="cmr-9">#</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-3"
+class="td11"> 3 </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-4"
+class="td11"> <span
+class="cmsy-10">∞ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-5"
+class="td11"> <span
+class="cmsy-10">∞ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-6"
+class="td10"> <span
+class="cmsy-10">∞ </span></td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-14-"><td style="white-space:wrap; text-align:left;" id="TBL-2-14-1"
+class="td01"><!--l. 731--><p class="noindent" ><span
+class="cmtt-9">\glsdisplaynumberlist</span><a
+ id="dx1-5002"></a>
+<span
+class="cmr-9">reliable?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-2"
+class="td11"> <span id="textcolor53"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-3"
+class="td11"> <span id="textcolor54"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-4"
+class="td11"> <span id="textcolor55"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-5"
+class="td11"> <span id="textcolor56"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-6"
+class="td10"> <span id="textcolor57"><span
+class="pzdr-">✘</span></span> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-15-"><td style="white-space:wrap; text-align:left;" id="TBL-2-15-1"
+class="td01"><!--l. 733--><p class="noindent" ><span
+class="cmtt-9">\newglossaryentry</span><a
+ id="dx1-5003"></a>
+<span
+class="cmr-9">allowed</span>
+<span
+class="cmr-9">in</span>
+<span
+class="cmss-9">document</span><a
+ id="dx1-5004"></a><a
+ id="dx1-5005"></a>
+<span
+class="cmr-9">environment?</span>
+<span
+class="cmr-9">(Not</span>
+<span
+class="cmr-9">recommended.)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-2"
+class="td11"> <span
+class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-3"
+class="td11"> <span
+class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-4"
+class="td11"> <span
+class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-5"
+class="td11"> <span
+class="pzdr-">✘</span><sup class="textsuperscript"><span
+class="tcrm-0900">※</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-6"
+class="td10"> <span
+class="pzdr-">✔</span><sup class="textsuperscript"><!--l. 735--><p class="noindent" ><img
+src="glossaries-user0x.png" alt="*
+* " class="pic-halign" /></sup> </p></td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-16-"><td style="white-space:wrap; text-align:left;" id="TBL-2-16-1"
+class="td01"><!--l. 736--><p class="noindent" ><span
+class="cmr-9">Requires</span>
+<span
+class="cmr-9">additional</span>
+<span
+class="cmr-9">write</span>
+<span
+class="cmr-9">registers?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-2"
+class="td11"> <span id="textcolor58"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-3"
+class="td11"> <span id="textcolor59"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-4"
+class="td11"> <span id="textcolor60"><span
+class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-5"
+class="td11"> <span id="textcolor61"><span
+class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-6"
+class="td10"> <span id="textcolor62"><span
+class="pzdr-">✘</span></span><sup class="textsuperscript"><span
+class="cmmi-9">⋆</span></sup> </td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-2-17-"><td style="white-space:wrap; text-align:left;" id="TBL-2-17-1"
+class="td01"><!--l. 738--><p class="noindent" ><span
+class="cmr-9">Default</span>
+<span
+class="cmr-9">value</span>
+<span
+class="cmr-9">of</span>
+<span
+class="cmss-9">sanitizesort</span><a
+ id="dx1-5006"></a>
+<span
+class="cmr-9">package</span>
+<span
+class="cmr-9">option</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-2"
+class="td11"> <span
+class="cmtt-10">false </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-3"
+class="td11"> <span
+class="cmtt-10">true </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-4"
+class="td11"> <span
+class="cmtt-10">true </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-5"
+class="td11"> <span
+class="cmtt-10">true</span><sup class="textsuperscript"><span
+class="pzdr-x-x-90">✾</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-6"
+class="td10"> <span
+class="cmtt-10">true</span><sup class="textsuperscript"><span
+class="pzdr-x-x-90">✾</span></sup> </td>
+</tr></table>
+
+</div>
+<!--l. 746--><p class="noindent" >________________________________________________________________________
+</p><!--l. 748--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">*</span></sup> <span
+class="cmr-8">Strips standard </span><span class="LATEX"><span
+class="cmr-8">L</span><span class="A"><span
+class="cmr-8">A</span></span><span class="TEX"><span
+class="cmr-8">T</span><span
+class="E"><span
+class="cmr-8">E</span></span><span
+class="cmr-8">X</span></span></span><span
+class="cmr-8"> accents (that is, accents generated by core </span><span class="LATEX"><span
+class="cmr-8">L</span><span class="A"><span
+class="cmr-8">A</span></span><span class="TEX"><span
+class="cmr-8">T</span><span
+class="E"><span
+class="cmr-8">E</span></span><span
+class="cmr-8">X</span></span></span><span
+class="cmr-8"> commands) so, for</span>
+<span
+class="cmr-8">example, </span><span
+class="cmtt-8">\AA</span><a
+ id="dx1-5007"></a> <span
+class="cmr-8">is treated the same as A.</span>
+</p><!--l. 751--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">†</span></sup> <span
+class="cmr-8">Only with the hybrid method provided with </span><span
+class="cmss-8">glossaries-extra</span><a
+ id="dx1-5008"></a><span
+class="cmr-8">.</span>
+</p><!--l. 752--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">‡</span></sup> <span
+class="cmr-8">Provided </span><span
+class="cmss-8">sort=none</span><a
+ id="dx1-5009"></a> <span
+class="cmr-8">is used.</span>
+</p><!--l. 753--><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. 754--><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. 755--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">¶</span></sup> <span
+class="cmr-8">The locations must be set explicitly through the custom </span><span
+class="cmss-8">location</span><a
+ id="dx1-5010"></a> <span
+class="cmr-8">field provided by </span><span
+class="cmss-8">glossaries-extra</span><span
+class="cmr-8">.</span>
+</p><!--l. 758--><p class="noindent" ><sup class="textsuperscript"><span
+class="cmr-9">#</span></sup> <span
+class="cmr-8">Unlimited but unreliable.</span>
+</p><!--l. 759--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">※</span></sup> <span
+class="cmr-8">Entries are defined in </span><span
+class="cmtt-8">.bib </span><span
+class="cmr-8">format. </span><span
+class="cmtt-8">\newglossaryentry </span><span
+class="cmr-8">should not be used explicitly.</span>
+</p><!--l. 761--><p class="noindent" ><sup class="textsuperscript"></p><!--l. 761--><p class="noindent" ><img
+src="glossaries-user1x.png" alt="*
+* " class="pic-halign" /> </sup>
+<span
+class="cmr-8">Provided </span><span
+class="cmss-8">docdefs=true </span><span
+class="cmr-8">or </span><span
+class="cmss-8">docdefs=restricted </span><span
+class="cmr-8">but not recommended.</span>
+</p><!--l. 763--><p class="noindent" ><sup class="textsuperscript"><span
+class="cmmi-9">⋆</span> </sup> <span
+class="cmr-8">Provided </span><span
+class="cmss-8">docdefs=false </span><span
+class="cmr-8">or </span><span
+class="cmss-8">docdefs=restricted</span><span
+class="cmr-8">.</span>
+</p><!--l. 765--><p class="noindent" ><sup class="textsuperscript"><span
+class="pzdr-x-x-90">✾</span></sup> <span
+class="cmr-8">Irrelevant with </span><span
+class="cmss-8">sort=none</span><a
+ id="dx1-5011"></a><span
+class="cmr-8">. (The </span><span
+class="cmss-8">record=only </span><span
+class="cmr-8">option automatically switches this on.)</span>
+
+
+</p>
+ </div><hr class="endfloat" />
+ </div>
+<a
+ id="x1-5012r1"></a>
+ <h4 class="likesubsectionHead"><a
+ id="x1-60001"></a><a
+ id="option1"></a>Option 1 (<span class="TEX">T<span
+class="E">E</span>X</span>)</h4>
+<!--l. 773--><p class="noindent" >This option doesn’t require an external <a
+href="#glo:indexingapp">indexing application</a> but, with the default
+alphabetic sorting, it’s very slow with severe limitations. If you want a sorted list, it
+doesn’t work well for <a
href="#glo:exlatinalph">extended Latin alphabets</a> or <a
-href="#glo:nonlatinalph">non-Latin alphabets</a>. However, if you
- use the <span
+href="#glo:nonlatinalph">non-Latin alphabets</a>. However, if
+you use the <span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-4006"></a> package option (the default for Option 1) then the
- <a
+ id="dx1-6001"></a> package option (the default for Option 1) then the
+<a
href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> accent commands</a> will be ignored, so if an entry’s name is set
- to <span class="obeylines-h"><span class="verb"><span
+to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{\’e}lite</span></span></span> then the sort will default to <span
class="cmtt-10">elite </span>if <span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-4007"></a> is used and
- will default to <span class="obeylines-h"><span class="verb"><span
+ id="dx1-6002"></a> is used and
+will default to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\’elite</span></span></span> if <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-4008"></a> is used.
- </p><!--l. 598--><p class="noindent" >This option works best with the <span
+ id="dx1-6003"></a> is used. If you have any other kinds of
+commands that don’t expand to ASCII characters, such as <span
+class="cmtt-10">\alpha </span>or <span
+class="cmtt-10">\si</span>, then you
+must use <span
+class="cmss-10">sanitizesort=true</span><a
+ id="dx1-6004"></a> or change the sort method (<span
+class="cmss-10">sort=use</span><a
+ id="dx1-6005"></a> or <span
class="cmss-10">sort=def</span><a
- id="dx1-4009"></a> setting. For any other setting, be
- prepared for a long document build time, especially if you have a lot of entries
- defined. <span
-class="cmbx-10">This option is intended as a last resort for alphabetical sorting.</span>
- This option is not suitable for hierarchical glossaries.
- </p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-4011x1">Add <span
-class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start defining
- your entries, as described in <a
+ id="dx1-6006"></a>) in the
+package options or explicitly set the <span
+class="cmss-10">sort</span><a
+ id="dx1-6007"></a> key when you define the relevant entries. For
+example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-1">
+\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ <br /> sort={alpha},description={...}}
+</div>
+<!--l. 792--><p class="nopar" >
+</p><!--l. 794--><p class="indent" > This option works best with the <span
+class="cmss-10">sort=def</span><a
+ id="dx1-6008"></a> or <span
+class="cmss-10">sort=use</span><a
+ id="dx1-6009"></a> setting. For any other setting, be
+prepared for a long document build time, especially if you have a lot of entries defined. <span
+class="cmbx-10">This</span>
+<span
+class="cmbx-10">option is intended as a last resort for alphabetical sorting. </span>This option allows a
+mixture of sort methods. (For example, sorting by word order for one glossary and order of
+use for another.) This option is not suitable for hierarchical glossaries and does not form
+ranges in the <a
+href="#glo:numberlist">number list<a
+ id="dx1-6010"></a>s</a>. If you really can’t use an <a
+href="#glo:indexingapp">indexing application</a> consider using
+<a
+href="#option5">Option 5</a> instead.
+</p><!--l. 805--><p class="indent" >
+ </p><ol class="enumerate1" >
+ <li
+ class="enumerate" id="x1-6012x1">Add
+
+
+ <div class="verbatim" id="verbatim-2">
+ \makenoidxglossaries
+</div>
+ <!--l. 809--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
href="#sec:newglosentry"><span
-class="cmsy-10">§</span>4 </a><a
-href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </li>
- <li
- class="enumerate" id="x1-4013x2">Put
- <!--l. 611--><p class="noindent" ><hr><div title="Definition"><span
-class="cmtt-10">\printnoidxglossary </span></div><hr>
+class="tcrm-1000">§</span>4 </a><a
+href="#sec:newglosentry">Defining
+ Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
+ </p></li>
+ <li
+ class="enumerate" id="x1-6014x2">Put
- </p><!--l. 612--><p class="noindent" >
- where you want your list of entries to appear (described in <a
+ <div class="verbatim" id="verbatim-3">
+ \printnoidxglossary
+</div>
+ <!--l. 816--><p class="nopar" > where you want your list of entries to appear (described in <a
href="#sec:printglossary"><span
-class="cmsy-10">§</span>10 </a><a
-href="#sec:printglossary">Displaying a
- glossary<!--tex4ht:ref: sec:printglossary --></a>).
- </p></li>
- <li
- class="enumerate" id="x1-4015x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> twice on your document. (As you would do to make a table of
- contents appear.) For example, click twice on the “typeset” or “build” or
- “PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>” button in your editor.</li></ol>
- </dd><dt class="description">
- </dt><dd
-class="description"><a
- id="option2"></a><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 2</span>:
- <!--l. 623--><p class="noindent" >This option uses a <a
-href="#glo:cli">command line interface (CLI)</a> application called <a
+class="tcrm-1000">§</span>10 </a><a
+href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>).
+ Alternatively, to display all glossaries use the iterative command:
+
+
+</p>
+ <div class="verbatim" id="verbatim-4">
+ \printnoidxglossaries
+</div>
+ <!--l. 822--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-6016x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> twice on your document. (As you would do to make a table of contents
+ appear.) For example, click twice on the “typeset” or “build” or “PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>” button
+ in your editor.</li></ol>
+<!--l. 829--><p class="indent" > Complete example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-5">
+\documentclass{article}
+ <br />\usepackage{glossaries}
+ <br />\makenoidxglossaries % use TeX to sort
+ <br />\newglossaryentry{sample}{name={sample},
+ <br />  description={an example}}
+ <br />\begin{document}
+ <br />\gls{sample}.
+ <br />\printnoidxglossary
+ <br />\end{document}
+</div>
+<!--l. 840--><p class="nopar" >
+<a
+ id="x1-6017r2"></a>
+</p><!--l. 842--><p class="noindent" >
+</p>
+ <h4 class="likesubsectionHead"><a
+ id="x1-70002"></a><a
+ id="option2"></a>Option 2 (<span
+class="cmtt-10">makeindex</span>)</h4>
+<!--l. 844--><p class="noindent" >This option uses a <a
+href="#glo:cli">CLI</a> application called <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4016"></a></a> to sort
- the entries. This application comes with all modern <span class="TEX">T<span
-class="E">E</span>X</span> distributions, but it’s
- hard-coded for the non-extended <a
-href="#glo:latinalph">Latin alphabet<a
- id="dx1-4017"></a></a>, so it doesn’t work well for <a
-href="#glo:exlatinalph">extended
- Latin alphabets</a> or <a
-href="#glo:nonlatinalph">non-Latin alphabets</a>. This process involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-7001"></a></a> to sort the entries. This application
+comes with all modern <span class="TEX">T<span
+class="E">E</span>X</span> distributions, but it’s hard-coded for the non-extended <a
+href="#glo:latinalph">Latin
+alphabet<a
+ id="dx1-7002"></a></a>. It can’t correctly sort accent commands (such as <span
+class="cmtt-10">\’ </span>or <span
+class="cmtt-10">\c</span>) and fails with UTF-8
+characters, especially for any sort values that start with a UTF-8 character (as it separates
+the octets resulting in an invalid file encoding). This process involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> write
- the glossary information to a temporary file which <a
+the glossary information to a temporary file which <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4018"></a></a> reads. Then <a
+ id="dx1-7003"></a></a> reads. Then <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4019"></a></a>
- writes a new file containing the code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> then reads this
- file in on the next run.
- </p><!--l. 632--><p class="noindent" >This option works best if you want to sort entries according to the English alphabet and
- you don’t want to install Perl.
- </p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-4021x1">If you want to use <a
+ id="dx1-7004"></a></a> writes
+a new file containing the code to typeset the glossary. Then <span
+class="cmtt-10">\printglossary </span>reads this file in
+on the next run.
+</p><!--l. 856--><p class="indent" > This option works best if you want to sort entries according to the English alphabet and
+you don’t want to install Perl (or Java or you don’t want to use <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a>). This method
+can also work with the restricted shell escape since <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4022"></a>’s</a> <span
+ id="dx1-7005"></a></a> is considered a trusted
+application. (So you should be able to use the <span
+class="cmss-10">automake</span><a
+ id="dx1-7006"></a> package option provided the shell
+escape hasn’t been completely disabled.)
+</p><!--l. 864--><p class="indent" > This method can form ranges in the <a
+href="#glo:numberlist">number list<a
+ id="dx1-7007"></a></a> but only accepts limited number formats:
+<span
+class="cmtt-10">\arabic</span>, <span
+class="cmtt-10">\roman</span>, <span
+class="cmtt-10">\Roman</span>, <span
+class="cmtt-10">\alph </span>and <span
+class="cmtt-10">\Alph</span>.
+</p><!--l. 868--><p class="indent" > This option does not allow a mixture of sort methods. All glossaries must be sorted
+according to the same method: word/letter ordering or order of use or order of definition. If
+you need word ordering for one glossary and letter ordering for another you’ll have to
+explicitly call <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-7008"></a></a> for each glossary type. (The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7009"></a> package allows a hybrid
+mix of Options <a
+href="#option1">1</a> and <a
+href="#option2">2</a> to provide word/letter ordering with <a
+href="#option2">Option 2</a> and order of
+use/definition with <a
+href="#option1">Option 1</a>. See the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7010"></a> documentation for further
+details.)
+</p><!--l. 879--><p class="indent" >
+ </p><ol class="enumerate1" >
+ <li
+ class="enumerate" id="x1-7012x1">If you want to use <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-7013"></a>’s</a> <span
class="cmtt-10">-g</span><a
- id="dx1-4023"></a> option you must change the quote character
- using <span
+ id="dx1-7014"></a> option you must change the quote character using
+
+
+ <span
class="cmtt-10">\GlsSetQuote</span><a
- id="dx1-4024"></a>. For example:
+ id="dx1-7015"></a>. For example:
- <div class="verbatim" id="verbatim-1">
- \GlsSetQuote{+}
+ <div class="verbatim" id="verbatim-6">
+ \GlsSetQuote{+}
</div>
- <!--l. 641--><p class="nopar" > This must be used before <span
-class="cmtt-10">\makeglossaries</span>. Note that if you are using
- <span
+ <!--l. 884--><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-4025"></a>, the shorthands aren’t enabled until the start of the document,
- so you won’t be able to use the shorthands in definitions made in the
- preamble.
- </p></li>
- <li
- class="enumerate" id="x1-4027x2">Add <span
-class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your entries, as
- described in <a
+ id="dx1-7016"></a>, the
+ shorthands aren’t enabled until the start of the document, so you won’t be able to use
+ the shorthands in definitions made in the preamble.
+ </p></li>
+ <li
+ class="enumerate" id="x1-7018x2">Add
+
+
+ <div class="verbatim" id="verbatim-7">
+ \makeglossaries
+</div>
+ <!--l. 893--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
href="#sec:newglosentry"><span
-class="cmsy-10">§</span>4 </a><a
-href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </li>
- <li
- class="enumerate" id="x1-4029x3">Put
- <!--l. 653--><p class="noindent" ><hr><div title="Definition"><span
-class="cmtt-10">\printglossary </span></div><hr>
- </p><!--l. 654--><p class="noindent" >
- where you want your list of entries to appear (described in <a
+class="tcrm-1000">§</span>4 </a><a
+href="#sec:newglosentry">Defining
+ Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
+ </p></li>
+ <li
+ class="enumerate" id="x1-7020x3">Put
+
+
+ <div class="verbatim" id="verbatim-8">
+ \printglossary
+</div>
+ <!--l. 901--><p class="nopar" > where you want your list of entries to appear (described in <a
href="#sec:printglossary"><span
-class="cmsy-10">§</span>10 </a><a
-href="#sec:printglossary">Displaying a
- glossary<!--tex4ht:ref: sec:printglossary --></a>).
- </p></li>
- <li
- class="enumerate" id="x1-4031x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="tcrm-1000">§</span>10 </a><a
+href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>).
+ Alternatively, to display all glossaries use the iterative command:
+
+
+</p>
+ <div class="verbatim" id="verbatim-9">
+ \printglossaries
+</div>
+ <!--l. 907--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-7022x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document. This creates files with the extensions <span
-class="cmtt-10">.glo </span>and
- <span
-class="cmtt-10">.ist </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="cmtt-10">.glo </span>and <span
+class="cmtt-10">.ist</span>
+ (for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is called <span
-class="cmtt-10">myDoc.tex</span>, then you’ll have
- two extra files called <span
+class="cmtt-10">myDoc.tex</span>, then you’ll have two
+ extra files called <span
class="cmtt-10">myDoc.glo </span>and <span
-class="cmtt-10">myDoc.ist</span>). If you look at your
- document at this point, you won’t see the glossary as it hasn’t been created
- yet.
- </li>
- <li
- class="enumerate" id="x1-4033x5">Run <a
+class="cmtt-10">myDoc.ist</span>). If you look at your document
+ at this point, you won’t see the glossary as it hasn’t been created yet. (If
+ you use <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7023"></a> you’ll see the section heading and some boilerplate
+ text.)
+ </li>
+ <li
+ class="enumerate" id="x1-7025x5">Run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4034"></a></a> with the <span
+ id="dx1-7026"></a></a> with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.ist </span>file as the style so
- that it creates an output file with the extension <span
+ that it creates an output file with the extension <span
class="cmtt-10">.gls</span>. If you have access to a
- terminal or a command prompt (for example, the MSDOS command prompt for
- Windows users or the bash console for Unix-like users) then you need to run the
- command:
+ terminal or a command prompt (for example, the MSDOS command prompt for
+ Windows users or the bash console for Unix-like users) then you need to run the
+ command:
- <div class="verbatim" id="verbatim-2">
- makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
+ <div class="verbatim" id="verbatim-10">
+ makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
</div>
- <!--l. 673--><p class="nopar" > (Replace <span
+ <!--l. 926--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> document file. Avoid spaces
- in the file name.) If you don’t know how to use the command prompt, then you can
- probably access <a
+class="E">E</span>X</span></span> document file. Avoid spaces in the
+ file name if possible.) 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-4035"></a></a> via your text editor, but each editor has a different
- method of doing this, so I can’t give a general description. You will have to check
- your editor’s manual.
- </p><!--l. 681--><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
+ id="dx1-7027"></a></a> via your text editor, but each editor
+ has a different method of doing this, so I can’t give a general description.
+ You will have to check your editor’s manual. The simplest approach is to use
+ <span
+class="cmtt-10">arara</span><a
+ id="dx1-7028"></a> and add the following comment lines to the start of your document:
+ </p><div class="alltt">
+ <div class="obeylines-v">
+ <span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
+ <br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> makeglossaries</span>
+ <br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
+</div>
+ </div> (Replace <span
+class="cmtt-10">makeglossaries </span>with <span
+class="cmtt-10">makeglossaries-lite </span>if you don’t have Perl
+ installed.)
+ <!--l. 943--><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-4036"></a> switch:
+ id="dx1-7029"></a> switch:
</p>
- <div class="verbatim" id="verbatim-3">
- makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
+ <div class="verbatim" id="verbatim-11">
+ makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
</div>
- <!--l. 687--><p class="nopar" > (See <a
+ <!--l. 948--><p class="nopar" > (See <a
href="#sec:makeindexapp"><span
-class="cmsy-10">§</span>1.4.4 </a><a
+class="tcrm-1000">§</span>1.5.4 </a><a
href="#sec:makeindexapp">Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-4037"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using
- <span
+ id="dx1-7030"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using
+ <span
class="cmtt-10">makeindex</span><a
- id="dx1-4038"></a> explicitly.)
- </p></li>
- <li
- class="enumerate" id="x1-4040x6">Once you have successfully completed the previous step, you can now run
- <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> on your document again.</li></ol>
- <!--l. 695--><p class="noindent" >This is the default option (although you still need to use <span
-class="cmtt-10">\makeglossaries </span>to ensure
- the glossary files are created).
- </p></dd><dt class="description">
- </dt><dd
-class="description"><a
- id="option3"></a><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 3</span>:
- <!--l. 700--><p class="noindent" >This option uses a <a
+ id="dx1-7031"></a> explicitly.) If you use <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-7032"></a></a> or <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-7033"></a></a>
+ then use the <span
+class="cmss-10">order=letter</span><a
+ id="dx1-7034"></a> package option and the <span
+class="cmtt-10">-l</span><a
+ id="dx1-7035"></a> option will be added
+ automatically.
+ </p></li>
+ <li
+ class="enumerate" id="x1-7037x6">Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> on
+ your document again. You’ll need to repeat the process if you have used the <span
+class="cmss-10">toc</span><a
+ id="dx1-7038"></a> option
+ (unless you’re using <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7039"></a>) to ensure the section heading is added
+ to the table of contents. You’ll also need to repeat the process if you have
+ any cross-references which can’t be indexed until the glossary file has been
+ created.</li></ol>
+<!--l. 964--><p class="indent" > Complete example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-12">
+\documentclass{article}
+ <br />\usepackage{glossaries}
+ <br />\makeglossaries % open glossary files
+ <br />\newglossaryentry{sample}{name={sample},
+ <br /> description={an example}}
+ <br />\begin{document}
+ <br />\gls{sample}.
+ <br />\printglossary
+ <br />\end{document}
+</div>
+<!--l. 975--><p class="nopar" >
+<a
+ id="x1-7040r3"></a>
+</p><!--l. 977--><p class="noindent" >
+</p>
+ <h4 class="likesubsectionHead"><a
+ id="x1-80003"></a><a
+ id="option3"></a>Option 3 (<span
+class="cmtt-10">xindy</span>)</h4>
+<!--l. 979--><p class="noindent" >This option uses a <a
href="#glo:cli">CLI</a> application called <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4041"></a></a> to sort the entries. This application is
- more flexible than <span
+ id="dx1-8001"></a></a> to sort the entries. This application is more
+flexible than <span
class="cmtt-10">makeindex </span>and is able to sort <a
href="#glo:exlatinalph">extended Latin alphabets</a> or <a
-href="#glo:nonlatinalph">non-Latin
- alphabets</a>. The <a
+href="#glo:nonlatinalph">non-Latin alphabets</a>,
+however it does still have some limitations.
+</p><!--l. 984--><p class="indent" > The <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4042"></a></a> application comes with <span class="TEX">T<span
-class="E">E</span>X</span> Live and now also with MiK<span class="TEX">T<span
-class="E">E</span>X</span>.
- Since <a
+ id="dx1-8002"></a></a> application comes with both <span class="TEX">T<span
+class="E">E</span>X</span> Live and MiK<span class="TEX">T<span
+class="E">E</span>X</span>, but since <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4043"></a></a> is a Perl script, you will also need to install Perl, if you don’t already have
- it. In a similar way to <a
+ id="dx1-8003"></a></a> is a
+Perl script, you will also need to install Perl, if you don’t already have it. In a similar way to
+<a
href="#option2">Option 2</a>, this option involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> write the
- glossary information to a temporary file which <a
+class="E">E</span>X</span></span> write the glossary information to
+a temporary file which <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4044"></a></a> reads. Then <a
+ id="dx1-8004"></a></a> reads. Then <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4045"></a></a> writes a new
- file containing the code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> then reads this file in on the
- next run.
- </p><!--l. 712--><p class="noindent" >This is the best option if you want to sort according to a language other than English or
- if you want non-standard location lists.
- </p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-4047x1">Add the <span
+ id="dx1-8005"></a></a> writes a new file containing the
+code to typeset the glossary. Then <span
+class="cmtt-10">\printglossary </span>reads this file in on the next
+run.
+</p><!--l. 992--><p class="indent" > This is the best option with just the base <span
+class="cmss-10">glossaries </span>package if you want to sort according
+to a language other than English or if you want non-standard location lists, but it can require
+some setting up (see <a
+href="#sec:xindy"><span
+class="tcrm-1000">§</span>11 </a><a
+href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>). There are some problems with certain sort
+values: </p>
+ <ul class="itemize1">
+ <li class="itemize">entries with the same sort value are merged by <span
+class="cmtt-10">xindy</span><a
+ id="dx1-8006"></a> into a single glossary line
+ so you must make sure that each entry has a unique sort value;
+ </li>
+ <li class="itemize"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-8007"></a> forbids empty sort values;
+ </li>
+ <li class="itemize"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-8008"></a> automatically strips control sequences, the math-shift character <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">$</span></span></span> and
+ braces <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">{}</span></span></span> from the sort value, which is usually desired but this can cause the sort
+ value to collapse to an empty string which <span
+class="cmtt-10">xindy</span><a
+ id="dx1-8009"></a> forbids.</li></ul>
+<!--l. 1007--><p class="noindent" >In these problematic cases, you must set the <span
+class="cmss-10">sort</span><a
+ id="dx1-8010"></a> field explicitly. For example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-13">
+\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ <br /> sort={alpha},description={...}}
+</div>
+<!--l. 1012--><p class="nopar" >
+</p><!--l. 1014--><p class="indent" > All glossaries must be sorted according to the same method (word/letter ordering, order
+of use, or order of definition). (The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8011"></a> package allows a hybrid mix
+of Options <a
+href="#option1">1</a> and <a
+href="#option3">3</a> to provide word/letter ordering with <a
+href="#option3">Option 3</a> and order of
+use/definition with <a
+href="#option1">Option 1</a>. See the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8012"></a> documentation for further
+details.)
+</p><!--l. 1021--><p class="indent" >
+ </p><ol class="enumerate1" >
+ <li
+ class="enumerate" id="x1-8014x1">Add the <span
class="cmss-10">xindy</span><a
- id="dx1-4048"></a> option to the <span
+ id="dx1-8015"></a> option to the <span
class="cmss-10">glossaries </span>package option list:
- <div class="verbatim" id="verbatim-4">
- \usepackage[xindy]{glossaries}
+ <div class="verbatim" id="verbatim-14">
+ \usepackage[xindy]{glossaries}
</div>
- <!--l. 721--><p class="nopar" >
- </p></li>
- <li
- class="enumerate" id="x1-4050x2">Add <span
+ <!--l. 1026--><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-15">
+ \usepackage[xindy={glsnumbers=false}]{glossaries}
+</div>
+ <!--l. 1031--><p class="nopar" > or use either <span
+class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits{</span>⟨<span
+class="cmti-10">letter</span>⟩<span
+class="cmtt-10">} </span>or <span
+class="cmtt-10">\GlsSetXdyNumberGroupOrder</span>
+ <span
+class="cmtt-10">{</span>⟨<span
+class="cmti-10">spec</span>⟩<span
+class="cmtt-10">} </span>to indicate where the number group should be placed (see <a
+href="#sec:xindy"><span
+class="tcrm-1000">§</span>11 </a><a
+href="#sec:xindy">Xindy (Option
+ 3)<!--tex4ht:ref: sec:xindy --></a>).
+ </p></li>
+ <li
+ class="enumerate" id="x1-8017x2">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your entries, as
- described in <a
+ described in <a
href="#sec:newglosentry"><span
-class="cmsy-10">§</span>4 </a><a
+class="tcrm-1000">§</span>4 </a><a
href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </li>
- <li
- class="enumerate" id="x1-4052x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ </li>
+ <li
+ class="enumerate" id="x1-8019x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document. This creates files with the extensions <span
-class="cmtt-10">.glo </span>and
- <span
-class="cmtt-10">.xdy </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="cmtt-10">.glo </span>and <span
+class="cmtt-10">.xdy</span>
+ (for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is called <span
-class="cmtt-10">myDoc.tex</span>, then you’ll have
- two extra files called <span
+class="cmtt-10">myDoc.tex</span>, then you’ll have two extra
+ files called <span
class="cmtt-10">myDoc.glo </span>and <span
-class="cmtt-10">myDoc.xdy</span>). If you look at your
- document at this point, you won’t see the glossary as it hasn’t been created
- yet.
- </li>
- <li
- class="enumerate" id="x1-4054x4">Run <a
+class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, you
+ won’t see the glossary as it hasn’t been created yet. (If you’re using the extension
+ package <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8020"></a>, you’ll see the section header and some boilerplate
+ text.)
+ </li>
+ <li
+ class="enumerate" id="x1-8022x4">Run <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4055"></a></a> with the <span
+ id="dx1-8023"></a></a> with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
-class="cmtt-10">.xdy </span>file as a module so
- that it creates an output file with the extension <span
-class="cmtt-10">.gls</span>. You also need to set the
- language name and input encoding. If you have access to a terminal or a command
- prompt (for example, the MSDOS command prompt for Windows users or the
- bash console for Unix-like users) then you need to run the command (all on one
- line):
+class="cmtt-10">.xdy </span>file as a module so that it
+ creates an output file with the extension <span
+class="cmtt-10">.gls</span>. You also need to set the language name
+ and input encoding. If you have access to a terminal or a command prompt
+ (for example, the MSDOS command prompt for Windows users or the bash
+ console for Unix-like users) then you need to run the command (all on one
+ line):
- <div class="verbatim" id="verbatim-5">
- xindy -L english -C utf8 -I xindy -M myDoc
-  <br />-t myDoc.glg -o myDoc.gls myDoc.glo
+ <div class="verbatim" id="verbatim-16">
+ xindy -L english -C utf8 -I xindy -M myDoc
+  <br />-t myDoc.glg -o myDoc.gls myDoc.glo
</div>
- <!--l. 744--><p class="nopar" > (Replace <span
+ <!--l. 1059--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> document file. Avoid spaces
- in the file name. If necessary, also replace <span
-class="cmtt-10">english </span>with the name of your language
- and <span
-class="cmtt-10">utf8 </span>with your input encoding, for example, <span
+class="E">E</span>X</span></span> document file. Avoid spaces in the
+ file name. If necessary, also replace <span
+class="cmtt-10">english </span>with the name of your language and <span
+class="cmtt-10">utf8</span>
+ with your input encoding, for example, <span
class="cmtt-10">-L</span><a
- id="dx1-4056"></a> <span
+ id="dx1-8024"></a> <span
class="cmtt-10">german -C</span><a
- id="dx1-4057"></a> <span
-class="cmtt-10">din5007-utf8</span>.) 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-4058"></a></a> via your text editor, but each editor has a different method of doing this, so
- I can’t give a general description. You will have to check your editor’s
- manual.
- </p><!--l. 755--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter
- ordering you need to add the <span
-class="cmss-10">order=letter</span><a
- id="dx1-4059"></a> package option:
+ id="dx1-8025"></a> <span
+class="cmtt-10">din5007-utf8</span>.) Note that it’s
+ much simpler to use <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-8026"></a></a> instead:
</p>
- <div class="verbatim" id="verbatim-6">
- \usepackage[xindy,order=letter]{glossaries}
+ <div class="verbatim" id="verbatim-17">
+ makeglossaries myDoc
</div>
- <!--l. 761--><p class="nopar" > (and return to the previous step.) See <a
-href="#sec:xindyapp"><span
-class="cmsy-10">§</span>1.4.3 </a><a
-href="#sec:xindyapp">Using <a
+ <!--l. 1068--><p class="nopar" > (Remember that <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4060"></a></a> explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for
- further details on using <span
-class="cmtt-10">xindy</span><a
- id="dx1-4061"></a> explicitly.
- </p></li>
- <li
- class="enumerate" id="x1-4063x5">Once you have successfully completed the previous step, you can now run
- <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> on your document again.
- </li></ol>
- </dd></dl>
-<!--l. 773--><p class="indent" > There is a fourth option available if you use the extension package <span
-class="cmss-10">glossaries-extra</span><a
- id="dx1-4064"></a> (as from
-v1.08). See the <span
-class="cmss-10">record </span>package option in the <span
-class="cmss-10">glossaries-extra</span><a
- id="dx1-4065"></a> user manual for further
-details.
-</p><!--l. 778--><p class="indent" > For Options <a
-href="#option2">2</a> and <a
-href="#option3">3</a>, it can be difficult to remember all the parameters required for
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-4066"></a></a> or <a
+ id="dx1-8027"></a></a> is a Perl script so if you can use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4067"></a></a>, so the <span
-class="cmss-10">glossaries </span>package provides a Perl script called <a
+ id="dx1-8028"></a></a> then you can also use
+ <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-4068"></a></a>
-that reads the <span
-class="cmtt-10">.aux </span>file to determine what settings you have used and will then run
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-4069"></a></a> or <a
+ id="dx1-8029"></a></a>, and if you don’t want to use <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-8030"></a></a> because you don’t want
+ to install Perl, then you can’t use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4070"></a></a>. Again, this is a command line application and can be run in a terminal
-or command prompt. For example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> document is in the file <span
-class="cmtt-10">myDoc.tex</span>, then
-run:
-
-
-</p>
- <div class="verbatim" id="verbatim-7">
-makeglossaries myDoc
+ id="dx1-8031"></a></a> either.)
+ </p><!--l. 1074--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably
+ access <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-8032"></a></a> or <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-8033"></a></a> via your text editor, but each editor has a
+ different method of doing this, so I can’t give a general description. You
+ will have to check your editor’s manual. Again, a convenient method is to
+ use <span
+class="cmtt-10">arara </span>and add the follow comment lines to the start of your document:
+ </p><div class="alltt">
+ <div class="obeylines-v">
+ <span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
+ <br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> makeglossaries</span>
+ <br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
</div>
-<!--l. 789--><p class="nopar" > (Replace <span
-class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> document file. Avoid spaces in the file
-name.) This is described in more detail in <a
-href="#sec:makeglossaries"><span
-class="cmsy-10">§</span>1.4 </a><a
-href="#sec:makeglossaries">Generating the Associated Glossary
-Files<!--tex4ht:ref: sec:makeglossaries --></a>.
-</p><!--l. 794--><p class="indent" > If you don’t have Perl installed you can use the Lua script instead:
+ </div>
+ <!--l. 1086--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter
+ ordering you need to add the <span
+class="cmss-10">order=letter</span><a
+ id="dx1-8034"></a> package option:
</p>
- <div class="verbatim" id="verbatim-8">
-makeglossaries-lite.lua myDoc
+ <div class="verbatim" id="verbatim-18">
+ \usepackage[xindy,order=letter]{glossaries}
</div>
-<!--l. 797--><p class="nopar" > This script doesn’t have the full functionality of the Perl script, but since modern
-<span class="TEX">T<span
-class="E">E</span>X</span> distributions come with Lua, you shouldn’t need to install anything extra to make it
-run. Remember that since <a
+ <!--l. 1091--><p class="nopar" > (and return to the previous step). This option is picked up by <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-8035"></a></a>. If you
+ are explicitly using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4071"></a></a> is also a Perl script, if you want to use <a
+ id="dx1-8036"></a></a> then you’ll need to add <span
+class="cmtt-10">-M ord/letorder </span>to the options list.
+ See <a
+href="#sec:xindyapp"><span
+class="tcrm-1000">§</span>1.5.3 </a><a
+href="#sec:xindyapp">Using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4072"></a></a> you’ll need
-Perl installed anyway, so there’s no point using this Lua script if you’re using <a
-href="#glo:xindy"><span
+ id="dx1-8037"></a></a> explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span
class="cmtt-10">xindy</span><a
- id="dx1-4073"></a></a>. Note
-that <span class="TEX">T<span
-class="E">E</span>X</span> Live creates a symbolic link called <span
-class="cmtt-10">makeglossaries-lite </span>(without the <span
-class="cmtt-10">.lua</span>
-extension) to the actual <span
-class="cmtt-10">makeglossaries-lite.lua </span>script, so you may not need to supply
-the extension.
-</p><!--l. 809--><p class="indent" > <div class="important" title="Important Note"> The <span
-class="cmtt-10">.gls </span>and <span
-class="cmtt-10">.glo </span>are temporary files created to help build your document. You should
-not edit or explicitly input them. However, you may need to delete them if something goes
-wrong and you need to do a fresh build. </div>
-</p><!--l. 814--><p class="noindent" >
-</p><!--l. 816--><p class="indent" > An overview of these three options is given in <a
-href="#tab:options">table 1.1</a>.
+ id="dx1-8038"></a>
+ explicitly.
+ </p></li>
+ <li
+ class="enumerate" id="x1-8040x5">Once you have successfully completed the previous step, you can now run
+ <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> on your document again. As with the previous option, you may need to
+ repeat the process to ensure the table of contents and cross-references are
+ resolved.
+ </li></ol>
+<!--l. 1105--><p class="indent" > Complete example:
+
+
</p>
- <div class="table">
+ <div class="verbatim" id="verbatim-19">
+\documentclass{article}
+ <br />\usepackage[xindy]{glossaries}
+ <br />\makeglossaries % open glossary files
+ <br />\newglossaryentry{sample}{name={sample},
+ <br /> description={an example}}
+ <br />\begin{document}
+ <br />\gls{sample}.
+ <br />\printglossary
+ <br />\end{document}
+</div>
+<!--l. 1116--><p class="nopar" >
+<a
+ id="x1-8041r4"></a>
+</p><!--l. 1118--><p class="noindent" >
+</p>
+ <h4 class="likesubsectionHead"><a
+ id="x1-90004"></a><a
+ id="option4"></a>Option 4 (<span
+class="cmtt-10">bib2gls</span>)</h4>
+<!--l. 1120--><p class="noindent" >This option is only available with the extension package <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a>. This method uses
+<a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9001"></a></a> to both fetch entry definitions from <span
+class="cmtt-10">.bib </span>files and to hierarchically sort and
+collate.
+</p><!--l. 1125--><p class="indent" > All entries must be provided in one or more <span
+class="cmtt-10">.bib </span>files. (See the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9002"></a></a> user manual for
+the required format.) The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-9003"></a> package needs to be loaded with the <span
+class="cmss-10">record </span>package
+option
-<!--l. 819--><p class="indent" > <a
- id="tab:options"></a></p><hr class="float" /><div class="float"
->
+</p>
+ <div class="verbatim" id="verbatim-20">
+\usepackage[record]{glossaries-extra}
+</div>
+<!--l. 1131--><p class="nopar" > or (equivalently)
- <div class="caption"
-><span class="id">Table 1.1: </span><span
-class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-40741 -->
+</p>
+ <div class="verbatim" id="verbatim-21">
+\usepackage[record=only]{glossaries-extra}
+</div>
+<!--l. 1135--><p class="nopar" > (It’s possible to use a hybrid of this method and Options <a
+href="#option2">2</a> or <a
+href="#option3">3</a> with <span
+class="cmss-10">record=alsoindex </span>but in
+general there is little need for this and it complicates the build process.)
+</p><!--l. 1140--><p class="indent" > Each resource set is loaded with <span
+class="cmtt-10">\GlsXtrLoadResources[</span>⟨<span
+class="cmti-10">options</span>⟩<span
+class="cmtt-10">]</span>. For example:
-<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
-id="TBL-2-3" /><col
-id="TBL-2-4" /></colgroup><tr
- style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:wrap; text-align:left;" id="TBL-2-1-1"
-class="td11"> <!--l. 825--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
-class="td11"> <a
-href="#option1"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 1</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-3"
-class="td11"> <a
-href="#option2"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 2</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-4"
-class="td11"> <a
-href="#option3"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 3</span></a> </td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:wrap; text-align:left;" id="TBL-2-2-1"
-class="td11"> <!--l. 826--><p class="noindent" >Requires
- an
- external
- application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:wrap; text-align:left;" id="TBL-2-3-1"
-class="td11"> <!--l. 828--><p class="noindent" >Requires
- Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:wrap; text-align:left;" id="TBL-2-4-1"
-class="td11"> <!--l. 830--><p class="noindent" >Can
- sort
- <a
-href="#glo:exlatinalph">extended
- Latin
- alphabets</a>
- or
- <a
-href="#glo:nonlatinalph">non-Latin
- alphabets</a>? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
-class="td11"> <span
-class="pzdr-">✘</span><sup class="textsuperscript"><span
-class="cmsy-9">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:wrap; text-align:left;" id="TBL-2-5-1"
-class="td11"> <!--l. 833--><p class="noindent" >Efficient
- sort
- algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:wrap; text-align:left;" id="TBL-2-6-1"
-class="td11"> <!--l. 835--><p class="noindent" >Can
- use
- a
- different
- sort
- method
- for
- each
- glossary? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
-class="td11"> <span
-class="pzdr-">✘ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:wrap; text-align:left;" id="TBL-2-7-1"
-class="td11"> <!--l. 837--><p class="noindent" >Can
- form
- ranges
- in
- the
- location
- lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:wrap; text-align:left;" id="TBL-2-8-1"
-class="td11"> <!--l. 839--><p class="noindent" >Can
- have
- non-standard
- locations
- in
- the
- location
- lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:wrap; text-align:left;" id="TBL-2-9-1"
-class="td11"> <!--l. 841--><p class="noindent" >Maximum
- hierarchical
- depth </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2"
-class="td11"> Unlimited but unreliable </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-3"
-class="td11"> 3 </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-4"
-class="td11"> Unlimited </td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:wrap; text-align:left;" id="TBL-2-10-1"
-class="td11"> <!--l. 843--><p class="noindent" ><span
-class="cmtt-10">\glsdisplaynumberlist</span><a
- id="dx1-4075"></a>
- reliable? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-4"
-class="td11"> <span
-class="pzdr-">✘ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:wrap; text-align:left;" id="TBL-2-11-1"
-class="td11"> <!--l. 845--><p class="noindent" ><span
-class="cmtt-10">\newglossaryentry</span><a
- id="dx1-4076"></a>
- restricted
- to
- preamble? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-3"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-4"
-class="td11"> <span
-class="pzdr-">✘ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:wrap; text-align:left;" id="TBL-2-12-1"
-class="td11"> <!--l. 847--><p class="noindent" >Requires
- additional
- write
- registers? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-2"
-class="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-3"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td>
-</tr><tr
- style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:wrap; text-align:left;" id="TBL-2-13-1"
-class="td11"> <!--l. 849--><p class="noindent" >Default
- value
- of
- <span
-class="cmss-10">sanitizesort</span><a
- id="dx1-4077"></a>
- package
- option </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-2"
-class="td11"> <span
-class="cmtt-10">false </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-3"
-class="td11"> <span
-class="cmtt-10">true </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-4"
-class="td11"> <span
-class="cmtt-10">true </span></td>
-</tr></table>
+</p>
+ <div class="verbatim" id="verbatim-22">
+\GlsXtrLoadResources
+ <br />[% definitions in entries1.bib and entries2.bib:
+ <br /> src={entries1,entries2},
+ <br /> sort={de-CH-1996}% sort according to this locale
+ <br />]
+</div>
+<!--l. 1148--><p class="nopar" > You can have multiple resource commands.
+</p><!--l. 1151--><p class="indent" > The glossary is displayed using
+
+</p>
+ <div class="verbatim" id="verbatim-23">
+\printunsrtglossary
</div>
-<!--l. 853--><p class="noindent" ><sup class="textsuperscript"><span
-class="cmsy-9">†</span></sup> Strips standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> accents (that is, accents generated by core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> commands) so,
-for example, <span
-class="cmtt-10">\AA</span><a
- id="dx1-4078"></a> is treated the same as A.
+<!--l. 1154--><p class="nopar" > Alternatively all glossaries can be displayed using the iterative command:
</p>
- </div><hr class="endfloat" />
- </div>
-<!--l. 858--><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
+ <div class="verbatim" id="verbatim-24">
+\printunsrtglossaries
+</div>
+<!--l. 1159--><p class="nopar" > The document is build using:
+
+
+</p>
+ <div class="verbatim" id="verbatim-25">
+pdflatex myDoc
+ <br />bib2gls myDoc
+ <br />pdflatex myDoc
+</div>
+<!--l. 1165--><p class="nopar" > If letter groups are required, you need the <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">--group</span></span></span> switch:
+
+
+</p>
+ <div class="verbatim" id="verbatim-26">
+bib2gls --group myDoc
+</div>
+<!--l. 1169--><p class="nopar" > Unlike Options <a
+href="#option2">2</a> and <a
+href="#option3">3</a>, this method doesn’t create a file containing the typeset glossary but
+simply determines which entries are needed for the document, their associated locations and
+(if required) their associated letter group. This option allows a mixture of sort methods.
+(For example, sorting by word order for one glossary and order of use for another
+or even sorting one block of the glossary differently to another block in the same
+glossary.)
+</p><!--l. 1179--><p class="indent" > This method supports Unicode and (with at least Java 8) uses the Common
+Locale Data Repository, which provides more extensive language support than
+<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-4079"></a></a>” you’ll be taken to the entry in the glossary where there’s a brief
-description of the term “<span
-class="cmtt-10">xindy</span><a
- id="dx1-4080"></a>”.
-</p><!--l. 865--><p class="indent" > The remainder of this introductory section covers the following: </p>
- <ul class="itemize1">
- <li class="itemize"><a
-href="#sec:samples"><span
-class="cmsy-10">§</span>1.1 </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:languages"><span
-class="cmsy-10">§</span>1.3 </a><a
-href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a
- language other than English.
- </li>
- <li class="itemize"><a
-href="#sec:makeglossaries"><span
-class="cmsy-10">§</span>1.4 </a><a
-href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use an <a
+ id="dx1-9004"></a></a>.<span class="footnote-mark"><a
+href="#fn2x1" id="fn2x1-bk"><sup class="textsuperscript">1.2</sup></a></span><a
+ id="x1-9005f2"></a> The
+locations in the <a
+href="#glo:numberlist">number list<a
+ id="dx1-9007"></a></a> may be in any format. If <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9008"></a></a> can deduce a numerical value it
+will attempt to form ranges otherwise it will simply list the locations.
+</p><!--l. 1188--><p class="indent" > Complete example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-27">
+\documentclass{article}
+ <br />\usepackage[record]{glossaries-extra}
+ <br />\GlsXtrLoadResources[src={entries}]
+ <br />\begin{document}
+ <br />\gls{sample}.
+ <br />\printunsrtglossary
+ <br />\end{document}
+</div>
+<!--l. 1197--><p class="nopar" > where <span
+class="cmtt-10">entries.bib </span>contains
+
+
+</p>
+ <div class="verbatim" id="verbatim-28">
+ at entry{sample,
+ <br /> name={sample},
+ <br /> description={an example}
+ <br />}
+</div>
+<!--l. 1204--><p class="nopar" > See the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9009"></a></a> user manual for further details.
+<a
+ id="x1-9010r5"></a>
+</p><!--l. 1207--><p class="noindent" >
+</p>
+ <h4 class="likesubsectionHead"><a
+ id="x1-100005"></a><a
+ id="option5"></a>Option 5 (no sorting)</h4>
+<!--l. 1209--><p class="noindent" >This option is only available with the extension package <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a>. No <a
href="#glo:indexingapp">indexing
- application</a> to create the sorted glossaries for your document (Options <a
-href="#option2">2</a> or <a
+application</a> is required. This method is best used with the package option <span
+class="cmss-10">sort=none</span><a
+ id="dx1-10001"></a>.
+
+
+</p>
+ <div class="verbatim" id="verbatim-29">
+\usepackage[sort=none]{glossaries-extra}
+</div>
+<!--l. 1214--><p class="nopar" > There’s no “activation” command (such as <span
+class="cmtt-10">\makeglossaries </span>for Options <a
+href="#option2">2</a> and <a
href="#option3">3</a>).
- </li></ul>
-<!--l. 879--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.1 </span> <a
+</p><!--l. 1218--><p class="indent" > All entries must be defined before the glossary is displayed (preferably in the preamble) in
+the required order, and child entries must be defined immediately after their parent entry if
+they must be kept together in the glossary
+</p><!--l. 1223--><p class="indent" > The glossary is displayed using
+
+
+</p>
+ <div class="verbatim" id="verbatim-30">
+\printunsrtglossary
+</div>
+<!--l. 1226--><p class="nopar" > Alternatively all glossaries can be displayed using the iterative command:
+
+
+</p>
+ <div class="verbatim" id="verbatim-31">
+\printunsrtglossaries
+</div>
+<!--l. 1231--><p class="nopar" > This will display <span
+class="cmti-10">all </span>defined entries, regardless of whether or not they have been used in the
+document. The <a
+href="#glo:numberlist">number list<a
+ id="dx1-10002"></a>s</a> have to be set explicitly otherwise they won’t appear. Note
+that this uses the same command for displaying the glossary as <a
+href="#option4">Option 4</a>. This is
+because <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-10003"></a></a> takes advantage of this method by defining the wanted entries
+in the required order and setting the locations (and letter group information, if
+required).
+</p><!--l. 1240--><p class="indent" > This just requires a single <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> call
+
+
+</p>
+ <div class="verbatim" id="verbatim-32">
+pdflatex myDoc
+</div>
+<!--l. 1243--><p class="nopar" > unless the glossary needs to appear in the table of contents, in which case a second run is
+required.
+
+
+</p>
+ <div class="verbatim" id="verbatim-33">
+pdflatex myDoc
+ <br />pdflatex myDoc
+</div>
+<!--l. 1249--><p class="nopar" > (Naturally if the document also contains citations, and so on, then additional steps are
+required. Similarly for all the other options above.)
+</p><!--l. 1254--><p class="indent" > Complete example:
+
+
+</p>
+ <div class="verbatim" id="verbatim-34">
+\documentclass{article}
+ <br />\usepackage[sort=none]{glossaries-extra}
+ <br />\newglossaryentry{sample}{name={sample},
+ <br /> description={an example}}
+ <br />\begin{document}
+ <br />\gls{sample}.
+ <br />\printunsrtglossary
+ <br />\end{document}
+</div>
+<!--l. 1264--><p class="nopar" > See the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-10004"></a> documentation for further details.
+</p><!--l. 1268--><p class="noindent" >
+</p>
+<!--l. 1268--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a
id="sec:samples"></a>Sample Documents</h3>
-<!--l. 882--><p class="noindent" >The <span
+<!--l. 1271--><p class="noindent" >The <span
class="cmss-10">glossaries </span>package is provided with some sample documents that illustrate the
various functions. These should be located in the <span
class="cmtt-10">samples </span>subdirectory (folder)
@@ -1783,26 +2737,39 @@
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">texdoc -l glossaries</span></span>
-</p><!--l. 892--><p class="indent" > <spacer type=vertical size=10>
-This should display a list of all the files in the glossaries documentation directory with their
-full pathnames.
-</p><!--l. 896--><p class="indent" > If you can’t find the sample files on your computer, they are also available from your nearest
+</p><!--l. 1281--><p class="indent" > <spacer type=vertical size=10>
+This should display a list of all the files in the glossaries documentation directory with
+their full pathnames. (The GUI version of <span
+class="cmtt-10">texdoc </span>may also provide you with the
+information.)
+</p><!--l. 1286--><p class="indent" > If you can’t find the sample files on your computer, they are also available from your nearest
CTAN mirror at <a
href="http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/" class="url" ><span
class="cmtt-10">http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/</span></a>.
-</p><!--l. 900--><p class="indent" > The sample documents are as follows<span class="footnote-mark"><a
-href="#fn2x1" id="fn2x1-bk"><sup class="textsuperscript">1.2</sup></a></span><a
- id="x1-5001f2"></a>:
+</p><!--l. 1290--><p class="indent" > The sample documents are listed
+below<span class="footnote-mark"><a
+href="#fn3x1" id="fn3x1-bk"><sup class="textsuperscript">1.3</sup></a></span><a
+ id="x1-11001f3"></a> If
+you prefer to use UTF-8 aware engines (<span
+class="cmtt-10">xelatex </span>or <span
+class="cmtt-10">lualatex</span>) remember that you’ll need to
+switch from <span
+class="cmss-10">fontenc </span>& <span
+class="cmss-10">inputenc </span>to <span
+class="cmss-10">fontspec </span>where appropriate. The <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> package
+provides some additional sample files.
</p><dl class="description"><dt class="description">
<span
class="cmtt-10">minimalgls.tex</span> </dt><dd
class="description"><a
- id="x1-5002r1"></a> This document is a minimal working example. You can test your
+ id="x1-11002r1"></a> This document is a minimal working example. You can test your
installation using this file. To create the complete document you will need to do the
following steps:
<ol class="enumerate1" >
<li
- class="enumerate" id="x1-5004x1">Run <span
+ class="enumerate" id="x1-11004x1">Run <span
class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> either by typing <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -1809,7 +2776,7 @@
class="cmtt-10">latex minimalgls</span></span>
- <!--l. 913--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1309--><p class="noindent" ><spacer type=vertical size=10>
in a terminal or by using the relevant button or menu item in your text editor or
front-end. This will create the required associated files but you will not see the
glossary. If you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
@@ -1818,72 +2785,70 @@
</p>
- <div class="verbatim" id="verbatim-9">
+ <div class="verbatim" id="verbatim-35">
pdfTeX warning (dest): name{glo:aca} has been
 <br />referenced but does not exist,
 <br />replaced by a fixed one
</div>
- <!--l. 923--><p class="nopar" > These warnings may be ignored on the first run.
- </p><!--l. 926--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span
+ <!--l. 1319--><p class="nopar" > These warnings may be ignored on the first run.
+ </p><!--l. 1322--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">Missing</span><span
class="cmtt-10"> \begin{document}</span></span></span> error, then it’s most likely that
your version of <span
class="cmss-10">xkeyval</span><a
- id="dx1-5005"></a> is out of date. Check the log file for a warning
+ id="dx1-11005"></a> is out of date. Check the log file for a warning
of that nature. If this is the case, you will need to update the <span
class="cmss-10">xkeyval</span>
package.
</p></li>
<li
- class="enumerate" id="x1-5007x2">Run <a
+ class="enumerate" id="x1-11007x2">If you have Perl installed, run <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5008"></a></a> on the document (<a
+ id="dx1-11008"></a></a> on the document (<a
href="#sec:makeglossaries"><span
-class="cmsy-10">§</span>1.4 </a><a
-href="#sec:makeglossaries">Generating the Associated Glossary
- Files<!--tex4ht:ref: sec:makeglossaries --></a>). This can be done on a terminal either by typing <spacer type=vertical size=10><span class="obeylines-h">
+class="tcrm-1000">§</span>1.5 </a><a
+href="#sec:makeglossaries">Generating
+ the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>). This can be done on a terminal by typing
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries minimalgls</span></span>
- <!--l. 936--><p class="noindent" ><spacer type=vertical size=10>
- or by typing <spacer type=vertical size=10><span class="obeylines-h">
+ <!--l. 1332--><p class="noindent" ><spacer type=vertical size=10>
+ otherwise do <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">perl makeglossaries minimalgls</span></span>
- </p><!--l. 940--><p class="noindent" ><spacer type=vertical size=10>
- If your system doesn’t recognise the command <span
-class="cmtt-10">perl </span>then it’s likely you don’t have
- Perl installed. In which case you will need to use <a
+class="cmtt-10">makeglossaries-lite minimalgls</span></span>
+ </p><!--l. 1336--><p class="noindent" ><spacer type=vertical size=10>
+ If for some reason you want to call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5009"></a></a> directly. You can do
- this in a terminal by typing (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11009"></a></a> explicitly, you can do this in a
+ terminal by typing (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls</span>
<span
class="cmtt-10">minimalgls.glo</span></span>
- </p><!--l. 947--><p class="noindent" ><spacer type=vertical size=10>
+ </p><!--l. 1341--><p class="noindent" ><spacer type=vertical size=10>
(See <a
href="#sec:makeindexapp"><span
-class="cmsy-10">§</span>1.4.4 </a><a
+class="tcrm-1000">§</span>1.5.4 </a><a
href="#sec:makeindexapp">Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5010"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using
+ id="dx1-11010"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using
<span
class="cmtt-10">makeindex</span><a
- id="dx1-5011"></a> explicitly.)
- </p><!--l. 951--><p class="noindent" >Note that if you need to specify the full path and the path contains
- spaces, you will need to delimit the file names with the double-quote
- character.
+ id="dx1-11011"></a> explicitly.)
+ </p><!--l. 1345--><p class="noindent" >Note that if the file name contains spaces, you will need to use the double-quote
+ character to delimit the name.
</p></li>
<li
- class="enumerate" id="x1-5013x3">Run <span
+ class="enumerate" id="x1-11013x3">Run <span
class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> again (as step 1)</li></ol>
- <!--l. 957--><p class="noindent" >You should now have a complete document. The number following each entry in the
+ <!--l. 1350--><p class="noindent" >You should now have a complete document. The number following each entry in the
glossary is the location number. By default, this is the page number where the entry
was referenced.
- </p><!--l. 961--><p class="noindent" >There are three other files that can be used as a <a
+ </p><!--l. 1354--><p class="noindent" >There are three other files that can be used as a <a
href="http://www.dickimaw-books.com/latex/minexample/" >minimal working example</a>:
<span
class="cmtt-10">mwe-gls.tex</span>, <span
@@ -1893,37 +2858,37 @@
<span
class="cmtt-10">sample-noidxapp.tex</span> </dt><dd
class="description"><a
- id="x1-5014r2"></a> This document illustrates how to use the <span
+ id="x1-11014r2"></a> This document illustrates how to use the <span
class="cmss-10">glossaries </span>package without
an external <a
href="#glo:indexingapp">indexing application</a> (<a
href="#option1">Option 1</a>). To create the complete document, you
need to do: <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">latex sample-noidxapp</span>
<br /><span
-class="cmtt-10">latex sample-noidxapp</span>
- <br /><span
class="cmtt-10">latex sample-noidxapp</span></span>
- <!--l. 972--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1365--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-noidxapp-utf8.tex</span> </dt><dd
class="description"><a
- id="x1-5015r3"></a> As the previous example, except that it uses the <span
+ id="x1-11015r3"></a> As the previous example, except that it uses the <span
class="cmss-10">inputenc</span><a
- id="dx1-5016"></a>
+ id="dx1-11016"></a>
package. To create the complete document, you need to do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-noidxapp-utf8</span>
<br /><span
class="cmtt-10">latex sample-noidxapp-utf8</span></span>
- <!--l. 980--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1373--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample4col.tex</span> </dt><dd
class="description"><a
- id="x1-5017r4"></a> This document illustrates a four column glossary where the entries have a
+ id="x1-11017r4"></a> This document illustrates a four column glossary where the entries have a
symbol in addition to the name and description. To create the complete document, you
need to do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -1932,27 +2897,27 @@
class="cmtt-10">makeglossaries sample4col</span>
<br /><span
class="cmtt-10">latex sample4col</span></span>
- <!--l. 990--><p class="noindent" ><spacer type=vertical size=10>
- As before, if you don’t have Perl installed, you will need to use <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-5018"></a></a> directly
- instead of using <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-5019"></a></a>. The vertical gap between entries is the gap created at
- the start of each group. This can be suppressed using the <span
+ <!--l. 1383--><p class="noindent" ><spacer type=vertical size=10>
+ or <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">latex sample4col</span>
+ <br /><span
+class="cmtt-10">makeglossaries-lite sample4col</span>
+ <br /><span
+class="cmtt-10">latex sample4col</span></span>
+ </p><!--l. 1389--><p class="noindent" ><spacer type=vertical size=10>
+ The vertical gap between entries is the gap created at the start of each group. This can
+ be suppressed using the <span
class="cmss-10">nogroupskip</span><a
- id="dx1-5020"></a> package
- option.
+ id="dx1-11018"></a> package option.
</p></dd><dt class="description">
<span
class="cmtt-10">sampleAcr.tex</span> </dt><dd
class="description"><a
- id="x1-5021r5"></a> This document has some sample acronyms. It also adds the glossary to the
- table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> is required to ensure the document
- is up to date: <spacer type=vertical size=10><span class="obeylines-h">
+ id="x1-11019r5"></a> This document has some sample abbreviations. It also adds the glossary to
+ the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> is required to ensure the
+ document is up to date: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleAcr</span>
<br /><span
@@ -1961,20 +2926,24 @@
class="cmtt-10">latex sampleAcr</span>
<br /><span
class="cmtt-10">latex sampleAcr</span></span>
- <!--l. 1006--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1403--><p class="noindent" ><spacer type=vertical size=10>
+ (or use <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11020"></a></a>).
</p></dd><dt class="description">
<span
class="cmtt-10">sampleAcrDesc.tex</span> </dt><dd
class="description"><a
- id="x1-5022r6"></a> This is similar to the previous example, except that the acronyms
+ id="x1-11021r6"></a> This is similar to the previous example, except that the abbreviations
have an associated description. As with the previous example, the glossary is
+
+
added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> is required:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleAcrDesc</span>
-
-
<br /><span
class="cmtt-10">makeglossaries sampleAcrDesc</span>
<br /><span
@@ -1981,20 +2950,20 @@
class="cmtt-10">latex sampleAcrDesc</span>
<br /><span
class="cmtt-10">latex sampleAcrDesc</span></span>
- <!--l. 1017--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1415--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleDesc.tex</span> </dt><dd
class="description"><a
- id="x1-5023r7"></a> This is similar to the previous example, except that it defines the acronyms
- using <span
+ id="x1-11022r7"></a> This is similar to the previous example, except that it defines the
+ abbreviations using <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-5024"></a> instead of <span
+ id="dx1-11023"></a> instead of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-5025"></a>. As with the previous example, the
- glossary is added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> is required:
- <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11024"></a>. As with the previous
+ example, the glossary is added to the table of contents, so an extra run through
+ <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleDesc</span>
<br /><span
@@ -2003,13 +2972,13 @@
class="cmtt-10">latex sampleDesc</span>
<br /><span
class="cmtt-10">latex sampleDesc</span></span>
- <!--l. 1029--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1427--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleCustomAcr.tex</span> </dt><dd
class="description"><a
- id="x1-5026r8"></a> This document has some sample acronyms with a custom acronym
- style. It also adds the glossary to the table of contents, so an extra run through
+ id="x1-11025r8"></a> This document has some sample abbreviations with a custom
+ acronym style. It also adds the glossary to the table of contents, so an extra run through
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2020,17 +2989,17 @@
class="cmtt-10">latex sampleCustomAcr</span>
<br /><span
class="cmtt-10">latex sampleCustomAcr</span></span>
- <!--l. 1039--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1437--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleFnAcrDesc.tex</span> </dt><dd
class="description"><a
- id="x1-5027r9"></a> This is similar to <a
-href="#x1-5022r6"><span
+ id="x1-11026r9"></a> This is similar to <a
+href="#x1-11021r6"><span
class="cmtt-10">sampleAcrDesc.tex</span></a>, except that it uses the
<span
class="cmss-10">footnote-sc-desc</span><a
- id="dx1-5028"></a> style. As with the previous example, the glossary is added to the table
+ id="dx1-11027"></a> style. As with the previous example, the glossary is added to the table
of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2041,7 +3010,7 @@
class="cmtt-10">latex sampleFnAcrDesc</span>
<br /><span
class="cmtt-10">latex sampleFnAcrDesc</span></span>
- <!--l. 1050--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1448--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
@@ -2048,7 +3017,7 @@
<span
class="cmtt-10">sample-FnDesc.tex</span> </dt><dd
class="description"><a
- id="x1-5029r10"></a> This example defines a custom display format that puts the description
+ id="x1-11028r10"></a> This example defines a custom display format that puts the description
in a footnote on first use. <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-FnDesc</span>
@@ -2056,12 +3025,12 @@
class="cmtt-10">makeglossaries sample-FnDesc</span>
<br /><span
class="cmtt-10">latex sample-FnDesc</span></span>
- <!--l. 1059--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1457--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-custom-acronym.tex</span> </dt><dd
class="description"><a
- id="x1-5030r11"></a> This document illustrates how to define your own acronym
+ id="x1-11029r11"></a> This document illustrates how to define your own acronym
style if the predefined styles don’t suit your requirements. <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-custom-acronym</span>
@@ -2069,12 +3038,12 @@
class="cmtt-10">makeglossaries sample-custom-acronym</span>
<br /><span
class="cmtt-10">latex sample-custom-acronym</span></span>
- <!--l. 1068--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1466--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-crossref.tex</span> </dt><dd
class="description"><a
- id="x1-5031r12"></a> This document illustrates how to cross-reference entries in the
+ id="x1-11030r12"></a> This document illustrates how to cross-reference entries in the
glossary. <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-crossref</span>
@@ -2082,12 +3051,12 @@
class="cmtt-10">makeglossaries sample-crossref</span>
<br /><span
class="cmtt-10">latex sample-crossref</span></span>
- <!--l. 1077--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1475--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-dot-abbr.tex</span> </dt><dd
class="description"><a
- id="x1-5032r13"></a> This document illustrates how to use the post link hook to adjust the
+ id="x1-11031r13"></a> This document illustrates how to use the post link hook to adjust the
space factor after abbreviations. <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-dot-abbr</span>
@@ -2095,18 +3064,18 @@
class="cmtt-10">makeglossaries sampledot-abbrf</span>
<br /><span
class="cmtt-10">latex sample-dot-abbr</span></span>
- <!--l. 1085--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1483--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleDB.tex</span> </dt><dd
class="description"><a
- id="x1-5033r14"></a> This document illustrates how to load external files containing the glossary
+ id="x1-11032r14"></a> This document illustrates how to load external files containing the glossary
definitions. It also illustrates how to define a new glossary type. This document has the
<a
href="#glo:numberlist">number list<a
- id="dx1-5034"></a></a> suppressed and uses <span
+ id="dx1-11033"></a></a> suppressed and uses <span
class="cmtt-10">\glsaddall</span><a
- id="dx1-5035"></a> to add all the entries to the
+ id="dx1-11034"></a> to add all the entries to the
glossaries without referencing each one explicitly. To create the document do:
<spacer type=vertical size=10><span class="obeylines-h">
@@ -2117,46 +3086,107 @@
class="cmtt-10">makeglossaries sampleDB</span>
<br /><span
class="cmtt-10">latex sampleDB</span></span>
- <!--l. 1097--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1495--><p class="noindent" ><spacer type=vertical size=10>
+ or <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">latex sampleDB</span>
+ <br /><span
+class="cmtt-10">makeglossaries-lite sampleDB</span>
+ <br /><span
+class="cmtt-10">latex sampleDB</span></span>
+ </p><!--l. 1501--><p class="noindent" ><spacer type=vertical size=10>
The glossary definitions are stored in the accompanying files <span
class="cmtt-10">database1.tex </span>and
<span
-class="cmtt-10">database2.tex</span>. Note that if you don’t have Perl installed, you will need to use
- <a
+class="cmtt-10">database2.tex</span>. If for some reason you want to call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5036"></a></a> twice instead of a single call to <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-5037"></a></a>:
+ id="dx1-11035"></a></a> explicitly you must have
+ a separate call for each glossary:
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5039x1">Create the main glossary (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ class="enumerate" id="x1-11037x1">
+ Create
+ the
+ main
+ glossary
+ (all
+ on
+ one
+ line):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls</span>
+class="cmtt-10">makeindex</span>
<span
+class="cmtt-10">-s</span>
+ <span
+class="cmtt-10">sampleDB.ist</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleDB.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleDB.gls</span>
+ <span
class="cmtt-10">sampleDB.glo</span></span>
- <!--l. 1106--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1510--><p class="noindent" ><spacer type=vertical size=10>
</p></li>
<li
- class="enumerate" id="x1-5041x2">Create the secondary glossary (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ class="enumerate" id="x1-11039x2">
+ Create
+ the
+ secondary
+ glossary
+ (all
+ on
+
+
+ one
+ line):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not</span>
+class="cmtt-10">makeindex</span>
<span
+class="cmtt-10">-s</span>
+ <span
+class="cmtt-10">sampleDB.ist</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleDB.nlg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleDB.not</span>
+ <span
class="cmtt-10">sampleDB.ntn</span></span>
- <!--l. 1110--><p class="noindent" ><spacer type=vertical size=10>
- </p></li></ol>
+ <!--l. 1514--><p class="noindent" ><spacer type=vertical size=10>
+ Note that both <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-11040"></a></a> and <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11041"></a></a> do this all in one call,
+ so they not only make it easier because you don’t need to supply all the switches
+ and remember all the extensions but they also call <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-11042"></a></a> the appropriate
+ number of times.</p></li></ol>
</dd><dt class="description">
<span
class="cmtt-10">sampleEq.tex</span> </dt><dd
class="description"><a
- id="x1-5042r15"></a> This document illustrates how to change the location to something other
+ id="x1-11043r15"></a> This document illustrates how to change the location to something other
than the page number. In this case, the <span
class="cmtt-10">equation </span>counter is used since all glossary
entries appear inside an <span
class="cmss-10">equation</span><a
- id="dx1-5043"></a><a
- id="dx1-5044"></a> environment. To create the document do:
+ id="dx1-11044"></a><a
+ id="dx1-11045"></a> environment. To create the document do:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleEq</span>
@@ -2164,14 +3194,14 @@
class="cmtt-10">makeglossaries sampleEq</span>
<br /><span
class="cmtt-10">latex sampleEq</span></span>
- <!--l. 1122--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1530--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleEqPg.tex</span> </dt><dd
class="description"><a
- id="x1-5045r16"></a> This is similar to the previous example, but the <a
+ id="x1-11046r16"></a> This is similar to the previous example, but the <a
href="#glo:numberlist">number list<a
- id="dx1-5046"></a>s</a>
+ id="dx1-11047"></a>s</a>
are a mixture of page numbers and equation numbers. This example adds
the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run is required:
@@ -2184,19 +3214,19 @@
class="cmtt-10">latex sampleEqPg</span>
<br /><span
class="cmtt-10">latex sampleEqPg</span></span>
- <!--l. 1134--><p class="noindent" ><spacer type=vertical size=10>
-
-
+ <!--l. 1542--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleSec.tex</span> </dt><dd
class="description"><a
- id="x1-5047r17"></a> This document also illustrates how to change the location to something
+ id="x1-11048r17"></a> This document also illustrates how to change the location to something
other than the page number. In this case, the <span
class="cmtt-10">section </span>counter is used. This example
adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run is required:
<spacer type=vertical size=10><span class="obeylines-h">
+
+
<br /><span
class="cmtt-10">latex sampleSec</span>
<br /><span
@@ -2205,12 +3235,12 @@
class="cmtt-10">latex sampleSec</span>
<br /><span
class="cmtt-10">latex sampleSec</span></span>
- <!--l. 1146--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1554--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleNtn.tex</span> </dt><dd
class="description"><a
- id="x1-5048r18"></a> This document illustrates how to create an additional glossary type. This
+ id="x1-11049r18"></a> This document illustrates how to create an additional glossary type. This
example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run is required:
<spacer type=vertical size=10><span class="obeylines-h">
@@ -2222,47 +3252,95 @@
class="cmtt-10">latex sampleNtn</span>
<br /><span
class="cmtt-10">latex sampleNtn</span></span>
- <!--l. 1157--><p class="noindent" ><spacer type=vertical size=10>
- Note that if you don’t have Perl installed, you will need to use <a
+ <!--l. 1565--><p class="noindent" ><spacer type=vertical size=10>
+ Note that if you want to call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5049"></a></a> twice instead
- of a single call to <a
+ id="dx1-11050"></a></a> explicitly instead of using <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5050"></a></a>:
+ id="dx1-11051"></a></a> or
+ <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11052"></a></a> then you need to call <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-11053"></a></a> twice:
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5052x1">Create the main glossary (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ class="enumerate" id="x1-11055x1">
+ Create
+ the
+ main
+ glossary
+ (all
+ on
+ one
+ line):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls</span>
+class="cmtt-10">makeindex</span>
<span
+class="cmtt-10">-s</span>
+ <span
+class="cmtt-10">sampleNtn.ist</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleNtn.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleNtn.gls</span>
+ <span
class="cmtt-10">sampleNtn.glo</span></span>
- <!--l. 1165--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1573--><p class="noindent" ><spacer type=vertical size=10>
</p></li>
+
+
<li
- class="enumerate" id="x1-5054x2">Create the secondary glossary (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ class="enumerate" id="x1-11057x2">
+ Create
+ the
+ secondary
+ glossary
+ (all
+ on
+ one
+ line):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not</span>
+class="cmtt-10">makeindex</span>
<span
+class="cmtt-10">-s</span>
+ <span
+class="cmtt-10">sampleNtn.ist</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleNtn.nlg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleNtn.not</span>
+ <span
class="cmtt-10">sampleNtn.ntn</span></span>
- <!--l. 1169--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1577--><p class="noindent" ><spacer type=vertical size=10>
</p></li></ol>
</dd><dt class="description">
<span
class="cmtt-10">sample.tex</span> </dt><dd
class="description"><a
- id="x1-5055r19"></a> This document illustrates some of the basics, including how to create child
+ id="x1-11058r19"></a> This document illustrates some of the basics, including how to create child
entries that use the same name as the parent entry. This example adds the glossary to
the table of contents and it also uses <span
class="cmtt-10">\glsrefentry</span><a
- id="dx1-5056"></a>, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-11059"></a>, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run is
required: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample</span>
-
-
<br /><span
class="cmtt-10">makeglossaries sample</span>
<br /><span
@@ -2269,51 +3347,56 @@
class="cmtt-10">latex sample</span>
<br /><span
class="cmtt-10">latex sample</span></span>
- <!--l. 1182--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1590--><p class="noindent" ><spacer type=vertical size=10>
You can see the difference between word and letter ordering if you substitute
<span
class="cmss-10">order=word</span><a
- id="dx1-5057"></a> with <span
+ id="dx1-11060"></a> with <span
class="cmss-10">order=letter</span><a
- id="dx1-5058"></a>. (Note that this will only have an effect if you use
+ id="dx1-11061"></a>. (Note that this will only have an effect if you use
<a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5059"></a></a>. If you use <a
+ id="dx1-11062"></a></a> or <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11063"></a></a>. If you use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5060"></a></a> explicitly, you will need to use the <span
+ id="dx1-11064"></a></a> explicitly, you will
+ need to use the <span
class="cmtt-10">-l</span><a
- id="dx1-5061"></a> switch to
- indicate letter ordering.)
+ id="dx1-11065"></a> switch to indicate letter ordering.)
</p></dd><dt class="description">
<span
class="cmtt-10">sample-inline.tex</span> </dt><dd
class="description"><a
- id="x1-5062r20"></a> This document is like <span
+ id="x1-11066r20"></a> This document is like <span
class="cmtt-10">sample.tex</span>, above, but uses the <span
class="cmss-10">inline</span><a
- id="dx1-5063"></a> glossary
+ id="dx1-11067"></a> glossary
style to put the glossary in a footnote.
</dd><dt class="description">
<span
class="cmtt-10">sampletree.tex</span> </dt><dd
class="description"><a
- id="x1-5064r21"></a> This document illustrates a hierarchical glossary structure where child
+ id="x1-11068r21"></a> This document illustrates a hierarchical glossary structure where child
entries have different names to their corresponding parent entry. To create the
document do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampletree</span>
+
+
<br /><span
class="cmtt-10">makeglossaries sampletree</span>
<br /><span
class="cmtt-10">latex sampletree</span></span>
- <!--l. 1202--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1610--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-dual.tex</span> </dt><dd
class="description"><a
- id="x1-5065r22"></a> This document illustrates how to define an entry that both appears in
+ id="x1-11069r22"></a> This document illustrates how to define an entry that both appears in
the list of acronyms and in the main glossary. To create the document do:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2322,12 +3405,12 @@
class="cmtt-10">makeglossaries sample-dual</span>
<br /><span
class="cmtt-10">latex sample-dual</span></span>
- <!--l. 1211--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1619--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-langdict.tex</span> </dt><dd
class="description"><a
- id="x1-5066r23"></a> This document illustrates how to use the glossaries package to create
+ id="x1-11070r23"></a> This document illustrates how to use the glossaries package to create
English to French and French to English dictionaries. To create the document do:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2336,60 +3419,61 @@
class="cmtt-10">makeglossaries sample-langdict</span>
<br /><span
class="cmtt-10">latex sample-langdict</span></span>
- <!--l. 1221--><p class="noindent" ><spacer type=vertical size=10>
-
-
+ <!--l. 1629--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">samplexdy.tex</span> </dt><dd
class="description"><a
- id="x1-5067r24"></a> This document illustrates how to use the <span
+ id="x1-11071r24"></a> This document illustrates how to use the <span
class="cmss-10">glossaries </span>package with <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5068"></a></a>
+ id="dx1-11072"></a></a>
instead of <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5069"></a></a>. The document uses UTF8 encoding (with the <span
+ id="dx1-11073"></a></a>. The document uses UTF8 encoding (with the <span
class="cmss-10">inputenc</span><a
- id="dx1-5070"></a> package).
+ id="dx1-11074"></a> package).
The encoding is picked up by <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5071"></a></a>. By default, this document will
+ id="dx1-11075"></a></a>. By default, this document will
create a <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5072"></a></a> style file called <span
+ id="dx1-11076"></a></a> style file called <span
class="cmtt-10">samplexdy.xdy</span>, but if you uncomment the
lines
- <div class="verbatim" id="verbatim-10">
+ <div class="verbatim" id="verbatim-36">
\setStyleFile{samplexdy-mc}
 <br />\noist
 <br />\GlsSetXdyLanguage{}
</div>
- <!--l. 1234--><p class="nopar" > it will set the style file to <span
+ <!--l. 1642--><p class="nopar" > it will set the style file to <span
class="cmtt-10">samplexdy-mc.xdy </span>instead. This provides an additional letter
group for entries starting with “Mc” or “Mac”. If you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5073"></a></a>, you don’t
- need to supply any additional information. If you don’t use <span
+ id="dx1-11077"></a></a> or
+ <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11078"></a></a>, you don’t need to supply any additional information. If you
+ don’t use <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5074"></a>, you will
- need to specify the required information. Note that if you set the style file to
- <span
+ id="dx1-11079"></a>, you will need to specify the required information. Note that
+ if you set the style file to <span
class="cmtt-10">samplexdy-mc.xdy </span>you must also specify <span
class="cmtt-10">\noist</span><a
- id="dx1-5075"></a>, otherwise the <span
-class="cmss-10">glossaries</span>
- package will overwrite <span
-class="cmtt-10">samplexdy-mc.xdy </span>and you will lose the “Mc” letter
- group.
- </p><!--l. 1246--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11080"></a>, otherwise
+ the <span
+class="cmss-10">glossaries </span>package will overwrite <span
+class="cmtt-10">samplexdy-mc.xdy </span>and you will lose the “Mc”
+ letter group.
+ </p><!--l. 1655--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex samplexdy</span>
<br /><span
@@ -2396,79 +3480,203 @@
class="cmtt-10">makeglossaries samplexdy</span>
<br /><span
class="cmtt-10">latex samplexdy</span></span>
- </p><!--l. 1251--><p class="noindent" ><spacer type=vertical size=10>
- If you don’t have Perl installed, you will have to call <a
+ </p><!--l. 1660--><p class="noindent" ><spacer type=vertical size=10>
+ If you don’t have Perl installed then you can’t use <a
+href="#glo:makeglossaries"><span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-11081"></a></a>, but you also can’t
+ use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5076"></a></a> explicitly instead of using
+ id="dx1-11082"></a></a>! However, if for some reason you want to call <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-11083"></a></a> explicitly instead of using
<a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5077"></a></a>. If you are using the default style file <span
-class="cmtt-10">samplexdy.xdy</span>, then do (no line
- breaks): <spacer type=vertical size=10><span class="obeylines-h">
- <br /><span
-class="cmtt-10">xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o</span>
- <span
-class="cmtt-10">samplexdy.gls samplexdy.glo</span></span>
- </p><!--l. 1258--><p class="noindent" ><spacer type=vertical size=10>
- otherwise, if you are using <span
-class="cmtt-10">samplexdy-mc.xdy</span>, then do (no line breaks): <spacer type=vertical size=10><span class="obeylines-h">
- <br /><span
-class="cmtt-10">xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls</span>
- <span
+ id="dx1-11084"></a></a> (or <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11085"></a></a>): </p>
+ <ul class="itemize1">
+ <li class="itemize">
+ if
+ you
+ are
+ using
+ the
+ default
+ style
+ file
+ <span
+class="cmtt-10">samplexdy.xdy</span>,
+ then
+ do
+ (no
+ line
+ breaks):
+ <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-L</span>
+ <span
+class="cmtt-10">english</span>
+
+
+ <span
+class="cmtt-10">-C</span>
+ <span
+class="cmtt-10">utf8</span>
+ <span
+class="cmtt-10">-I</span>
+ <span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-M</span>
+ <span
+class="cmtt-10">samplexdy</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">samplexdy.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">samplexdy.gls</span>
+ <span
class="cmtt-10">samplexdy.glo</span></span>
- </p><!--l. 1263--><p class="noindent" ><spacer type=vertical size=10>
- </p></dd><dt class="description">
+ <!--l. 1671--><p class="noindent" ><spacer type=vertical size=10>
+ </p></li>
+ <li class="itemize">
+ if
+ you
+ are
+ using
+ <span
+class="cmtt-10">samplexdy-mc.xdy</span>,
+ then
+ do
+ (no
+ line
+ breaks):
+ <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-I</span>
+ <span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-M</span>
+ <span
+class="cmtt-10">samplexdy-mc</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">samplexdy.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">samplexdy.gls</span>
+ <span
+class="cmtt-10">samplexdy.glo</span></span>
+ <!--l. 1676--><p class="noindent" ><spacer type=vertical size=10>
+ </p></li></ul>
+ </dd><dt class="description">
<span
class="cmtt-10">samplexdy2.tex</span> </dt><dd
class="description"><a
- id="x1-5078r25"></a> This document illustrates how to use the <span
+ id="x1-11086r25"></a> This document illustrates how to use the <span
class="cmss-10">glossaries </span>package where the
location numbers don’t follow a standard format. This example will only work with
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5079"></a></a>. To create the document do: <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11087"></a></a>. To create the document do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">pdflatex samplexdy2</span>
+
+
<br /><span
class="cmtt-10">makeglossaries samplexdy2</span>
<br /><span
class="cmtt-10">pdflatex samplexdy2</span></span>
- <!--l. 1273--><p class="noindent" ><spacer type=vertical size=10>
- If you can’t use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-5080"></a></a> then you need to do (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ <!--l. 1687--><p class="noindent" ><spacer type=vertical size=10>
+ The
+ explicit
+ <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-11088"></a></a>
+ call
+ is:
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o</span>
+class="cmtt-10">xindy</span>
<span
-class="cmtt-10">samplexdy2.gls samplexdy2.glo</span></span>
-
-
- </p><!--l. 1278--><p class="noindent" ><spacer type=vertical size=10>
+class="cmtt-10">-L</span>
+ <span
+class="cmtt-10">english</span>
+ <span
+class="cmtt-10">-C</span>
+ <span
+class="cmtt-10">utf8</span>
+ <span
+class="cmtt-10">-I</span>
+ <span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-M</span>
+ <span
+class="cmtt-10">samplexdy2</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">samplexdy2.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">samplexdy2.gls</span>
+ <span
+class="cmtt-10">samplexdy2.glo</span></span>
+ </p><!--l. 1691--><p class="noindent" ><spacer type=vertical size=10>
See <a
href="#sec:xindyloc"><span
-class="cmsy-10">§</span>11.2 </a><a
+class="tcrm-1000">§</span>11.2 </a><a
href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details.
</p></dd><dt class="description">
<span
+class="cmtt-10">samplexdy3.tex</span> </dt><dd
+class="description"><a
+ id="x1-11089r26"></a> This document is like <a
+href="#x1-11071r24"><span
+class="cmtt-10">samplexdy.tex</span></a> but uses the command
+ <span
+class="cmtt-10">\Numberstring </span>from the <span
+class="cmss-10">fmtcount</span><a
+ id="dx1-11090"></a> package to format the page numbers. This requires at
+ least version 3.03 of <span
+class="cmss-10">fmtcount</span><a
+ id="dx1-11091"></a> to work correctly.
+ </dd><dt class="description">
+<span
class="cmtt-10">sampleutf8.tex</span> </dt><dd
class="description"><a
- id="x1-5081r26"></a> This is another example that uses <a
+ id="x1-11092r27"></a> This is another example that uses <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5082"></a></a>. Unlike <a
+ id="dx1-11093"></a></a>. Unlike <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5083"></a></a>, <a
+ id="dx1-11094"></a></a>, <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5084"></a></a> can
+ id="dx1-11095"></a></a> can
cope with <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-5085"></a>s</a>. This document uses UTF8 encoding. To create the
+ id="dx1-11096"></a>s</a>. This document uses UTF8 encoding. To create the
document do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleutf8</span>
@@ -2476,23 +3684,53 @@
class="cmtt-10">makeglossaries sampleutf8</span>
<br /><span
class="cmtt-10">latex sampleutf8</span></span>
- <!--l. 1289--><p class="noindent" ><spacer type=vertical size=10>
- If you don’t have Perl installed, you will have to call <a
+ <!--l. 1707--><p class="noindent" ><spacer type=vertical size=10>
+ The
+ explicit
+ <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-5086"></a></a> explicitly instead of using
- <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-5087"></a></a> (no line breaks): <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11097"></a></a>
+
+
+ call
+ is
+ (no
+ line
+ breaks):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o</span>
+class="cmtt-10">xindy</span>
<span
-class="cmtt-10">sampleutf8.gls sampleutf8.glo</span></span>
- </p><!--l. 1295--><p class="noindent" ><spacer type=vertical size=10>
- </p><!--l. 1297--><p class="noindent" >If you remove the <span
+class="cmtt-10">-L</span>
+ <span
+class="cmtt-10">english</span>
+ <span
+class="cmtt-10">-C</span>
+ <span
+class="cmtt-10">utf8</span>
+ <span
+class="cmtt-10">-I</span>
+ <span
+class="cmtt-10">xindy</span>
+ <span
+class="cmtt-10">-M</span>
+ <span
+class="cmtt-10">sampleutf8</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleutf8.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleutf8.gls</span>
+ <span
+class="cmtt-10">sampleutf8.glo</span></span>
+ </p><!--l. 1712--><p class="noindent" ><spacer type=vertical size=10>
+ </p><!--l. 1714--><p class="noindent" >If you remove the <span
class="cmss-10">xindy</span><a
- id="dx1-5088"></a> option from <span
+ id="dx1-11098"></a> option from <span
class="cmtt-10">sampleutf8.tex </span>and do: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sampleutf8</span>
@@ -2500,35 +3738,97 @@
class="cmtt-10">makeglossaries sampleutf8</span>
<br /><span
class="cmtt-10">latex sampleutf8</span></span>
- </p><!--l. 1303--><p class="noindent" ><spacer type=vertical size=10>
- you will see that the entries that start with an <a
-href="#glo:exlatinchar">extended Latin character<a
- id="dx1-5089"></a></a> now appear in
- the symbols group, and the word “manœuvre” is now after “manor” instead of before it.
- If you are unable to use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-5090"></a></a>, the call to <a
+ </p><!--l. 1720--><p class="noindent" ><spacer type=vertical size=10>
+ or <spacer type=vertical size=10><span class="obeylines-h">
+ <br /><span
+class="cmtt-10">latex sampleutf8</span>
+ <br /><span
+class="cmtt-10">makeglossaries-lite sampleutf8</span>
+ <br /><span
+class="cmtt-10">latex sampleutf8</span></span>
+ </p><!--l. 1726--><p class="noindent" ><spacer type=vertical size=10>
+ you
+ will
+ see
+ that
+ the
+ entries
+ that
+ start
+ with
+ an
+
+
+ <a
+href="#glo:exlatinchar">extended
+ Latin
+ character<a
+ id="dx1-11099"></a></a>
+ now
+ appear
+ in
+ the
+ symbols
+ group,
+ and
+ the
+ word
+ “manœuvre”
+ is
+ now
+ after
+ “manor”
+ instead
+ of
+ before
+ it.
+ If
+ you
+ want
+ to
+ explicitly
+ call
+ <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5091"></a></a> is as follows (no line
- breaks): <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11100"></a></a>
+ (no
+ line
+ breaks):
+ <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
-class="cmtt-10">makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls</span>
+class="cmtt-10">makeindex</span>
<span
+class="cmtt-10">-s</span>
+ <span
+class="cmtt-10">sampleutf8.ist</span>
+ <span
+class="cmtt-10">-t</span>
+ <span
+class="cmtt-10">sampleutf8.glg</span>
+ <span
+class="cmtt-10">-o</span>
+ <span
+class="cmtt-10">sampleutf8.gls</span>
+ <span
class="cmtt-10">sampleutf8.glo</span></span>
- </p><!--l. 1311--><p class="noindent" ><spacer type=vertical size=10>
+ </p><!--l. 1733--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-index.tex</span> </dt><dd
class="description"><a
- id="x1-5092r27"></a> This document uses the <span
+ id="x1-11101r28"></a> This document uses the <span
class="cmss-10">glossaries </span>package to create both a glossary and
an index. This requires two <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-5093"></a></a> calls to ensure the document is up to date:
- <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-11102"></a></a> (or <a
+href="#glo:makeglossaries-lite.lua"><span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-11103"></a></a>) calls to ensure
+
+
+ the document is up to date: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">latex sample-index</span>
<br /><span
@@ -2539,20 +3839,18 @@
class="cmtt-10">makeglossaries sample-index</span>
<br /><span
class="cmtt-10">latex sample-index</span></span>
- <!--l. 1323--><p class="noindent" ><spacer type=vertical size=10>
-
-
+ <!--l. 1746--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-newkeys.tex</span> </dt><dd
class="description"><a
- id="x1-5094r28"></a> This document illustrates how add custom keys (using <span
+ id="x1-11104r29"></a> This document illustrates how add custom keys (using <span
class="cmtt-10">\glsaddkey</span>).
</dd><dt class="description">
<span
class="cmtt-10">sample-storage-abbr.tex</span> </dt><dd
class="description"><a
- id="x1-5095r29"></a> This document illustrates how add custom storage keys (using
+ id="x1-11105r30"></a> This document illustrates how add custom storage keys (using
<span
class="cmtt-10">\glsaddstoragekey</span>).
</dd><dt class="description">
@@ -2559,13 +3857,13 @@
<span
class="cmtt-10">sample-storage-abbr-desc.tex</span> </dt><dd
class="description"><a
- id="x1-5096r30"></a> An extension of the previous example where the user
+ id="x1-11106r31"></a> An extension of the previous example where the user
needs to provide a description.
</dd><dt class="description">
<span
class="cmtt-10">sample-chap-hyperfirst.tex</span> </dt><dd
class="description"><a
- id="x1-5097r31"></a> This document illustrates how to add a custom key using
+ id="x1-11107r32"></a> This document illustrates how to add a custom key using
<span
class="cmtt-10">\glsaddstoragekey </span>and hook into the <a
href="#sec:gls-like"><span
@@ -2577,15 +3875,15 @@
<span
class="cmtt-10">sample-font-abbr.tex</span> </dt><dd
class="description"><a
- id="x1-5098r32"></a> This document illustrates how to different fonts for abbreviations
+ id="x1-11108r33"></a> This document illustrates how to different fonts for abbreviations
within the style.
</dd><dt class="description">
<span
class="cmtt-10">sample-numberlist.tex</span> </dt><dd
class="description"><a
- id="x1-5099r33"></a> This document illustrates how to reference the <a
+ id="x1-11109r34"></a> This document illustrates how to reference the <a
href="#glo:numberlist">number list<a
- id="dx1-5100"></a></a> in the
+ id="dx1-11110"></a></a> in the
document text. This requires an additional <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2596,12 +3894,12 @@
class="cmtt-10">latex sample-numberlist</span>
<br /><span
class="cmtt-10">latex sample-numberlist</span></span>
- <!--l. 1350--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1773--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">samplePeople.tex</span> </dt><dd
class="description"><a
- id="x1-5101r34"></a> This document illustrates how you can hook into the standard sort
+ id="x1-11111r35"></a> This document illustrates how you can hook into the standard sort
mechanism to adjust the way the sort key is set. This requires an additional run to
ensure the table of contents is up-to-date: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2608,20 +3906,20 @@
class="cmtt-10">latex samplePeople</span>
<br /><span
class="cmtt-10">makeglossaries samplePeople</span>
+
+
<br /><span
class="cmtt-10">latex samplePeople</span>
<br /><span
class="cmtt-10">latex samplePeople</span></span>
- <!--l. 1361--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1784--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleSort.tex</span> </dt><dd
class="description"><a
- id="x1-5102r35"></a> This is another document that illustrates how to hook into the standard
+ id="x1-11112r36"></a> This is another document that illustrates how to hook into the standard
sort mechanism. An additional run is required to ensure the table of contents is
up-to-date: <spacer type=vertical size=10><span class="obeylines-h">
-
-
<br /><span
class="cmtt-10">latex sampleSort</span>
<br /><span
@@ -2630,28 +3928,28 @@
class="cmtt-10">latex sampleSort</span>
<br /><span
class="cmtt-10">latex sampleSort</span></span>
- <!--l. 1371--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1794--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sample-nomathhyper.tex</span> </dt><dd
class="description"><a
- id="x1-5103r36"></a> This document illustrates how to selectively enable and disable
+ id="x1-11113r37"></a> This document illustrates how to selectively enable and disable
entry hyperlinks in <span
class="cmtt-10">\glsentryfmt</span><a
- id="dx1-5104"></a>.
+ id="dx1-11114"></a>.
</dd><dt class="description">
<span
class="cmtt-10">sample-entryfmt.tex</span> </dt><dd
class="description"><a
- id="x1-5105r37"></a> This document illustrates how to change the way an entry is
+ id="x1-11115r38"></a> This document illustrates how to change the way an entry is
displayed in the text.
</dd><dt class="description">
<span
class="cmtt-10">sample-prefix.tex</span> </dt><dd
class="description"><a
- id="x1-5106r38"></a> This document illustrates the use of the <span
+ id="x1-11116r39"></a> This document illustrates the use of the <span
class="cmss-10">glossaries-prefix</span><a
- id="dx1-5107"></a> package.
+ id="dx1-11117"></a> package.
An additional run is required to ensure the table of contents is up-to-date:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -2662,184 +3960,290 @@
class="cmtt-10">latex sample-prefix</span>
<br /><span
class="cmtt-10">latex sample-prefix</span></span>
- <!--l. 1387--><p class="noindent" ><spacer type=vertical size=10>
+ <!--l. 1810--><p class="noindent" ><spacer type=vertical size=10>
</p></dd><dt class="description">
<span
class="cmtt-10">sampleaccsupp.tex</span> </dt><dd
class="description"><a
- id="x1-5108r39"></a> This document uses the experimental <span
+ id="x1-11118r40"></a> This document uses the experimental <span
class="cmss-10">glossaries-accsupp</span><a
- id="dx1-5109"></a> package. The
+ id="dx1-11119"></a> package. The
symbol is set to the replacement text. Note that some PDF viewers don’t use the
accessibility support. Information about the <span
class="cmss-10">glossaries-accsupp </span>package can be found in
<a
href="#sec:accsupp"><span
-class="cmsy-10">§</span>18 </a><a
+class="tcrm-1000">§</span>18 </a><a
href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>.
</dd><dt class="description">
<span
class="cmtt-10">sample-ignored.tex</span> </dt><dd
class="description"><a
- id="x1-5110r40"></a> This document defines an ignored glossary for common terms that
+ id="x1-11120r41"></a> This document defines an ignored glossary for common terms that
don’t need a definition.
+
+
</dd><dt class="description">
<span
class="cmtt-10">sample-entrycount.tex</span> </dt><dd
class="description"><a
- id="x1-5111r41"></a> This document uses <span
+ id="x1-11121r42"></a> This document uses <span
class="cmtt-10">\glsenableentrycount</span><a
- id="dx1-5112"></a> and <span
+ id="dx1-11122"></a> and <span
class="cmtt-10">\cgls</span><a
- id="dx1-5113"></a> (described
+ id="dx1-11123"></a> (described
in <a
href="#sec:enableentrycount"><span
-class="cmsy-10">§</span>14.1 </a><a
+class="tcrm-1000">§</span>14.1 </a><a
href="#sec:enableentrycount">Counting the Number of Times an Entry has been Used (First Use
Flag Unset)<!--tex4ht:ref: sec:enableentrycount --></a>) so that acronyms only used once don’t appear in the list of
acronyms.</dd></dl>
-
-
-<!--l. 1405--><p class="noindent" >
+<!--l. 1828--><p class="noindent" >
</p>
-<!--l. 1405--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a
+<!--l. 1828--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a
id="sec:lipsum"></a>Dummy Entries for Testing</h3>
-<!--l. 1408--><p class="noindent" >In addition to the sample files described above, <span
+<!--l. 1831--><p class="noindent" >In addition to the sample files described above, <span
class="cmss-10">glossaries</span><a
- id="dx1-6001"></a> also provides some files containing
+ id="dx1-12001"></a> also provides some files containing
lorum ipsum dummy entries. These are provided for testing purposes and are on <span class="TEX">T<span
class="E">E</span>X</span>’s path
(in <span
class="cmtt-10">tex/latex/glossaries/test-entries</span>) so they can be included via <span
class="cmtt-10">\input</span><a
- id="dx1-6002"></a> or
+ id="dx1-12002"></a> or
<span
class="cmtt-10">\loadglsentries</span><a
- id="dx1-6003"></a>. The files are as follows:
+ id="dx1-12003"></a>. The files are as follows:
</p><dl class="description"><dt class="description">
<span
class="cmbx-10">example-glossaries-brief.tex</span> </dt><dd
-class="description">These entries all have brief descriptions.
- </dd><dt class="description">
+class="description">These entries all have brief descriptions. For example:
+
+
+ <div class="verbatim" id="verbatim-37">
+ \newglossaryentry{lorem}{name={lorem},description={ipsum}}
+</div>
+ <!--l. 1841--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-long.tex</span> </dt><dd
-class="description">These entries all have long descriptions.
- </dd><dt class="description">
+class="description">These entries all have long descriptions. For example:
+
+
+ <div class="verbatim" id="verbatim-38">
+ \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. 1851--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-multipar.tex</span> </dt><dd
-class="description">These entries all have multi-paragraph
- descriptions.
+class="description">These entries all have multi-paragraph descriptions.
</dd><dt class="description">
<span
class="cmbx-10">example-glossaries-symbols.tex</span> </dt><dd
class="description">These entries all use the <span
class="cmss-10">symbol</span><a
- id="dx1-6004"></a> key.
- </dd><dt class="description">
+ id="dx1-12004"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-39">
+ \newglossaryentry{alpha}{name={alpha},
+  <br />symbol={\ensuremath{\alpha}},
+  <br />description={Quisque ullamcorper placerat ipsum.}}
+</div>
+ <!--l. 1862--><p class="nopar" >
+ </p></dd><dt class="description">
<span
+class="cmbx-10">example-glossaries-symbolnames.tex</span> </dt><dd
+class="description">Similar to the previous file but the <span
+class="cmss-10">symbol</span><a
+ id="dx1-12005"></a> key isn’t
+ used. Instead the symbol is stored in the <span
+class="cmss-10">name</span><a
+ id="dx1-12006"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-40">
+ \newglossaryentry{sym.alpha}{sort={alpha},
+  <br />name={\ensuremath{\alpha}},
+  <br />description={Quisque ullamcorper placerat ipsum.}}
+</div>
+ <!--l. 1871--><p class="nopar" >
+ </p></dd><dt class="description">
+<span
class="cmbx-10">example-glossaries-images.tex</span> </dt><dd
class="description">These entries use the <span
class="cmss-10">user1</span><a
- id="dx1-6005"></a> key to store the name
- of an image file. (The images are provided by the <span
+ id="dx1-12007"></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-6006"></a> package and should be
- on <span class="TEX">T<span
-class="E">E</span>X</span>’s path.) One entry doesn’t have an associated image to help test for
- a missing key.
+ id="dx1-12008"></a> package and should be on <span class="TEX">T<span
+class="E">E</span>X</span>’s
+ path.) One entry doesn’t have an associated image to help test for a missing
+ key.
</dd><dt class="description">
<span
class="cmbx-10">example-glossaries-acronym.tex</span> </dt><dd
-class="description">These entries are all acronyms.
- </dd><dt class="description">
+class="description">These entries are all abbreviations. For example:
+
+
+ <div class="verbatim" id="verbatim-41">
+ \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum
+  <br />dolor}
+</div>
+ <!--l. 1883--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-acronym-desc.tex</span> </dt><dd
-class="description">These entries are all acronyms that use the
+class="description">These entries are all abbreviations that use the
<span
class="cmss-10">description</span><a
- id="dx1-6007"></a> key.
- </dd><dt class="description">
+ id="dx1-12009"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-42">
+ \newacronym[type=\glsdefaulttype,
+  <br />  description={fringilla a, euismod sodales,
+  <br />  sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula}
+</div>
+ <!--l. 1892--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-acronyms-lang.tex</span> </dt><dd
-class="description">These entries are all acronyms, where some
- of them have a translation supplied in the <span
+class="description">These entries are all abbreviations, where some of
+ them have a translation supplied in the <span
class="cmss-10">user1</span><a
- id="dx1-6008"></a> key.
- </dd><dt class="description">
+ id="dx1-12010"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-43">
+ \newacronym[type=\glsdefaulttype,user1={love itself}]
+  <br /> {li}{LI}{lorem ipsum}
+</div>
+ <!--l. 1901--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-parent.tex</span> </dt><dd
-class="description">These are hierarchical entries where the child entries
- use the <span
+class="description">These are hierarchical entries where the child entries use
+ the <span
class="cmss-10">name</span><a
- id="dx1-6009"></a> key.
- </dd><dt class="description">
+ id="dx1-12011"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-44">
+ \newglossaryentry{sedmattis}{name={sed mattis},
+  <br />description={erat sit amet}
+  <br />\newglossaryentry{gravida}{parent={sedmattis},
+  <br />  name={gravida},description={malesuada}}
+</div>
+ <!--l. 1912--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-childnoname.tex</span> </dt><dd
class="description">These are hierarchical entries where the child
entries don’t use the <span
class="cmss-10">name</span><a
- id="dx1-6010"></a> key.
- </dd><dt class="description">
+ id="dx1-12012"></a> key. For example:
+
+
+ <div class="verbatim" id="verbatim-45">
+ \newglossaryentry{scelerisque}{name={scelerisque},
+  <br />  description={at}}
+</div>
+ <!--l. 1920--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-cite.tex</span> </dt><dd
class="description">These entries use the <span
class="cmss-10">user1</span><a
- id="dx1-6011"></a> key to store a citation key
- (or comma-separated list of citation keys). The citations are defined in <span
-class="cmtt-10">xampl.bib</span>,
- which should be available on all modern <span class="TEX">T<span
-class="E">E</span>X</span> distributions. One entry doesn’t
- have an associated citation to help test for a missing key.
+ id="dx1-12013"></a> key to store a citation
+ key (or comma-separated list of citation keys). The citations are defined in
+ <span
+class="cmtt-10">xampl.bib</span>, which should be available on all modern <span class="TEX">T<span
+class="E">E</span>X</span> distributions. One
+ entry doesn’t have an associated citation to help test for a missing key. For
+ example:
- </dd><dt class="description">
+ <div class="verbatim" id="verbatim-46">
+ \newglossaryentry{fusce}{name={fusce},
+  <br />description={suscipit cursus sem},user1={article-minimal}}
+</div>
+ <!--l. 1932--><p class="nopar" >
+ </p></dd><dt class="description">
<span
class="cmbx-10">example-glossaries-url.tex</span> </dt><dd
-class="description">These entries use the <span
+class="description">These entries use the <span
class="cmss-10">user1</span><a
- id="dx1-6012"></a> key to store an URL
- associated with the entry.</dd></dl>
-<!--l. 1457--><p class="indent" > The sample file <span
+ id="dx1-12014"></a> key to store an URL associated
+ with the entry. For example:
+
+
+ <div class="verbatim" id="verbatim-47">
+ \newglossaryentry{aenean-url}{name={aenean},
+  <br /> description={adipiscing auctor est},
+  <br /> user1={http://uk.tug.org/}}
+</div>
+ <!--l. 1941--><p class="nopar" ></p></dd></dl>
+<!--l. 1944--><p class="indent" > The sample file <span
class="cmtt-10">glossary-lipsum-examples.tex </span>in the <span
class="cmtt-10">doc/latex/glossaries/samples</span>
directory uses all these files. See also <a
href="http://www.dickimaw-books.com/gallery/#glossaries" class="url" ><span
class="cmtt-10">http://www.dickimaw-books.com/gallery/#glossaries</span></a>.
-</p><!--l. 1462--><p class="noindent" >
+The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-12015"></a> package provides additional test files.
+</p><!--l. 1950--><p class="noindent" >
</p>
-<!--l. 1462--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a
+<!--l. 1950--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a
id="sec:languages"></a>Multi-Lingual Support</h3>
-<!--l. 1465--><p class="noindent" >As from version 1.17, the <span
-class="cmss-10">glossaries </span>package can now be used with <a
+<!--l. 1953--><p class="noindent" >As from version 1.17, the <span
+class="cmss-10">glossaries </span>package can be used with <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-7001"></a></a> as well as
-<a
+ id="dx1-13001"></a></a> as well as <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7002"></a></a>. If you are writing in a language that uses an <a
-href="#glo:exlatinalph">extended Latin alphabet</a> or
-<a
-href="#glo:nonlatinalph">non-Latin alphabet</a> it is recommended that you use <span
+ id="dx1-13002"></a></a>. If
+you are writing in a language that uses an <a
+href="#glo:exlatinalph">extended Latin alphabet</a> or <a
+href="#glo:nonlatinalph">non-Latin alphabet</a> it’s
+best to use <a
+href="#option3">Option 3</a> (<span
class="cmtt-10">xindy</span><a
- id="dx1-7003"></a> as <span
+ id="dx1-13003"></a>) or <a
+href="#option4">Option 4</a> (<a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-13004"></a></a>) as <span
class="cmtt-10">makeindex</span><a
- id="dx1-7004"></a> is hard-coded for the
-non-extended <a
+ id="dx1-13005"></a> (<a
+href="#option2">Option 2</a>) is hard-coded
+for the non-extended <a
href="#glo:latinalph">Latin alphabet<a
- id="dx1-7005"></a></a>. This means that you are not restricted to the A, …, Z letter
+ id="dx1-13006"></a></a> and <a
+href="#option1">Option 1</a> can performed limited ASCII
+comparisons.
+</p><!--l. 1961--><p class="indent" > This means that with Options <a
+href="#option3">3</a> or <a
+href="#option4">4</a> you are not restricted to the A, …, Z letter
groups. If you want to use <span
class="cmtt-10">xindy</span><a
- id="dx1-7006"></a>, remember to use the <span
+ id="dx1-13007"></a>, remember to use the <span
class="cmss-10">xindy</span><a
- id="dx1-7007"></a> package option. For
+ id="dx1-13008"></a> package option. For
example:
</p>
- <div class="verbatim" id="verbatim-11">
+ <div class="verbatim" id="verbatim-48">
\documentclass[frenchb]{article}
 <br />\usepackage[utf8]{inputenc}
 <br />\usepackage[T1]{fontenc}
@@ -2846,22 +4250,42 @@
 <br />\usepackage{babel}
 <br />\usepackage[xindy]{glossaries}
</div>
-<!--l. 1480--><p class="nopar" >
-</p><!--l. 1482--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a
+<!--l. 1970--><p class="nopar" > If you want to use <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-13009"></a>, you need to use the <span
+class="cmss-10">record</span><a
+ id="dx1-13010"></a> option with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-13011"></a>
+and supply the definitions in <span
+class="cmtt-10">.bib </span>files. (See the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-13012"></a></a> user manual for further
+details.)
+</p><!--l. 1976--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-7008"></a></a>, such as é, looks like a plain character in your
-tex file, with standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span> it’s actually a macro and can therefore cause expansion
-problems. You may need to switch off the field expansions with <span
-class="cmtt-10">\glsnoexpandfields</span>. This
-issue doesn’t occur with XeLaTeX.
-</p><!--l. 1489--><p class="indent" > If you use a <a
+ id="dx1-13013"></a></a>, such as é, looks like a plain character
+in your <span
+class="cmtt-10">.tex</span><a
+ id="dx1-13014"></a> file, with standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> it’s actually a macro and can therefore
+cause expansion problems. You may need to switch off the field expansions with
+<span
+class="cmtt-10">\glsnoexpandfields</span>. This issue doesn’t occur with XeLaTeX or Lua<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>.
+</div>
+</p><!--l. 1982--><p class="noindent" >
+</p><!--l. 1984--><p class="indent" > With <span
+class="cmss-10">inputenc</span><a
+ id="dx1-13015"></a>, if you use a <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-7009"></a></a> (or other expandable) character at the start of an entry
-name, you must place it in a group, or it will cause a problem for commands that convert the
-first letter to upper case (e.g. <span
+ id="dx1-13016"></a></a> (or other expandable) character at the
+start of an entry name, you must place it in a group, or it will cause a problem for
+commands that convert the first letter to upper case (e.g. <span
class="cmtt-10">\Gls</span><a
- id="dx1-7010"></a>). For example: </p><div class="alltt">
+ id="dx1-13017"></a>). For example:
+</p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry}{elite}{name={{</span></span><span
@@ -2874,54 +4298,72 @@
class="cmtt-10"> or</span><span
class="cmtt-10"> class}}</span></span>
</div>
-</div> </div>
-<!--l. 1497--><p class="noindent" >
-(For further details, see the section “UTF-8” section in the <span
+</div> (With newer versions of <span
class="cmss-10">mfirstuc</span><a
- id="dx1-7011"></a> user manual.)
-</p><!--l. 1501--><p class="indent" > If you use the <span
-class="cmss-10">inputenc</span><a
- id="dx1-7012"></a> package, <a
+ id="dx1-13018"></a> and <span
+class="cmss-10">datatool-base</span><a
+ id="dx1-13019"></a> you may be able to omit this grouping.)
+For further details, see the “UTF-8” section in the <span
+class="cmss-10">mfirstuc</span><a
+ id="dx1-13020"></a> user manual.
+<!--l. 1997--><p class="indent" > If you are using <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-13021"></a></a> or <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-13022"></a></a>, the application needs to know the encoding of the
+<span
+class="cmtt-10">.tex</span><a
+ id="dx1-13023"></a> file. This information is added to the <span
+class="cmtt-10">.aux</span><a
+ id="dx1-13024"></a> file and can be picked up by <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-7013"></a></a> will pick up the encoding from the
-auxiliary file. If you use <a
+ id="dx1-13025"></a></a>
+and <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-13026"></a></a>. If you use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-7014"></a></a> explicitly instead of via <span
+ id="dx1-13027"></a></a> explicitly instead of via <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-7015"></a>, you may need
-to specify the encoding using the <span
+ id="dx1-13028"></a>, you may need to
+specify the encoding using the <span
class="cmtt-10">-C</span><a
- id="dx1-7016"></a> option. Read the <span
+ id="dx1-13029"></a> option. Read the <span
class="cmtt-10">xindy</span><a
- id="dx1-7017"></a> manual for further
-details.
-</p><!--l. 1507--><p class="indent" > As from v4.24, if you are writing in German (for example, using the <span
+ id="dx1-13030"></a> manual for further details of this
+option.
+</p><!--l. 2006--><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-7018"></a> package or
-<span
+ id="dx1-13031"></a>
+package<span class="footnote-mark"><a
+href="#fn4x1" id="fn4x1-bk"><sup class="textsuperscript">1.4</sup></a></span><a
+ id="x1-13032f4"></a>
+or <span
class="cmss-10">babel</span><a
- id="dx1-7019"></a> with the <span
+ id="dx1-13033"></a> with the <span
class="cmss-10">ngerman</span><a
- id="dx1-7020"></a> package option), and you want to use <a
+ id="dx1-13034"></a> package option), and you want to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7021"></a>’s</a> <span
+ id="dx1-13035"></a>’s</a> <span
class="cmtt-10">-g</span><a
- id="dx1-7022"></a> option, you’ll
+ id="dx1-13036"></a> option, you’ll
need to change <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7023"></a>’s</a> quote character using:
-</p><!--l. 1511--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-13037"></a>’s</a> quote character using:
+</p><!--l. 2010--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\GlsSetQuote</span><span
class="cmtt-9"> </span></span><a
- id="dx1-7024"></a> <span
+ id="dx1-13038"></a> <span
class="cmtt-10">\GlsSetQuote{</span>⟨<span
class="cmitt-10">character</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 1513--><p class="noindent" >
+</p><!--l. 2012--><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
@@ -2931,48 +4373,48 @@
</p>
- <div class="verbatim" id="verbatim-12">
+ <div class="verbatim" id="verbatim-49">
\GlsSetQuote{+}
</div>
-<!--l. 1519--><p class="nopar" > This must be done before <span
+<!--l. 2018--><p class="nopar" > This must be done before <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-7025"></a> and any entry definitions. It’s only applicable
+ id="dx1-13039"></a> and any entry definitions. It’s only applicable
for <span
class="cmtt-10">makeindex</span><a
- id="dx1-7026"></a>. This option in conjunction with <span
+ id="dx1-13040"></a>. This option in conjunction with <span
class="cmss-10">ngerman</span><a
- id="dx1-7027"></a> will also cause <span
+ id="dx1-13041"></a> will also cause <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-7028"></a> to
+ id="dx1-13042"></a> to
use the <span
class="cmtt-10">-g</span><a
- id="dx1-7029"></a> switch when invoking <span
+ id="dx1-13043"></a> switch when invoking <span
class="cmtt-10">makeindex</span><a
- id="dx1-7030"></a>.
-</p><!--l. 1526--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span
+ id="dx1-13044"></a>.
+</p><!--l. 2025--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span
class="cmss-10">babel</span><a
- id="dx1-7031"></a>’s shorthands. These aren’t switched on until the start of the
+ id="dx1-13045"></a>’s shorthands. These aren’t switched on until the start of the
document, so any entries defined in the preamble won’t be able to use those shorthands.
However, if you define the entries in the document and any of those shorthands happen to be
special characters for <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7032"></a></a> or <a
+ id="dx1-13046"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-7033"></a></a> (such as the double-quote) then this will interfere
+ id="dx1-13047"></a></a> (such as the double-quote) then this will interfere
with code that tries to escape any of those characters that occur in the <span
class="cmss-10">sort</span><a
- id="dx1-7034"></a> key.
+ id="dx1-13048"></a> key.
</div>
-</p><!--l. 1535--><p class="noindent" >
-</p><!--l. 1537--><p class="indent" > In general, it’s best not to use <span
+</p><!--l. 2034--><p class="noindent" >
+</p><!--l. 2036--><p class="indent" > In general, it’s best not to use <span
class="cmss-10">babel</span><a
- id="dx1-7035"></a>’s shorthands in entry definitions. For example:
+ id="dx1-13049"></a>’s shorthands in entry definitions. For example:
</p>
- <div class="verbatim" id="verbatim-13">
+ <div class="verbatim" id="verbatim-50">
\documentclass{article}
 <br />\usepackage[ngerman]{babel}
 <br />\usepackage{glossaries}
@@ -2986,19 +4428,19 @@
 <br />\printglossaries
 <br />\end{document}
</div>
-<!--l. 1558--><p class="nopar" >
-</p><!--l. 1560--><p class="indent" > The <span
+<!--l. 2057--><p class="nopar" >
+</p><!--l. 2059--><p class="indent" > The <span
class="cmss-10">ngerman</span><a
- id="dx1-7036"></a> package has the shorthands on in the preamble, so they can be used if
+ id="dx1-13050"></a> package has the shorthands on in the preamble, so they can be used if
<span
class="cmtt-10">\GlsSetQuote </span>has changed the <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-7037"></a></a> quote character. Example:
+ id="dx1-13051"></a></a> quote character. Example:
</p>
- <div class="verbatim" id="verbatim-14">
+ <div class="verbatim" id="verbatim-51">
\documentclass{article}
 <br />\usepackage[ngerman]{babel}
 <br />\usepackage{glossaries}
@@ -3011,87 +4453,87 @@
 <br />\printglossaries
 <br />\end{document}
</div>
-<!--l. 1581--><p class="nopar" >
-</p><!--l. 1583--><p class="noindent" >
+<!--l. 2080--><p class="nopar" >
+</p><!--l. 2082--><p class="noindent" >
</p>
-<!--l. 1583--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.3.1 </span> <a
+<!--l. 2082--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.1 </span> <a
id="sec:fixednames"></a>Changing the Fixed Names</h4>
-<!--l. 1586--><p class="noindent" >The fixed names are produced using the commands listed in <a
+<!--l. 2085--><p class="noindent" >The fixed names are produced using the commands listed in <a
href="#tab:predefinednames">table 1.2</a>. If you aren’t using a
language package such as <span
class="cmss-10">babel</span><a
- id="dx1-8001"></a> or <span
+ id="dx1-14001"></a> or <span
class="cmss-10">polyglossia</span><a
- id="dx1-8002"></a> that uses caption hooks, you can just redefine
+ 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-8003"></a> or <span
+ id="dx1-14003"></a> or <span
class="cmss-10">polyglossia</span><a
- id="dx1-8004"></a>, you need to use their
+ id="dx1-14004"></a>, you need to use their
caption hooks to change the defaults. See <a
href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words babel uses</a> or read the <span
class="cmss-10">babel</span><a
- id="dx1-8005"></a> or
+ id="dx1-14005"></a> or
<span
class="cmss-10">polyglossia</span><a
- id="dx1-8006"></a> documentation. If you have loaded <span
+ id="dx1-14006"></a> documentation. If you have loaded <span
class="cmss-10">babel</span><a
- id="dx1-8007"></a>, then <span
+ id="dx1-14007"></a>, then <span
class="cmss-10">glossaries</span><a
- id="dx1-8008"></a> will attempt to load
+ id="dx1-14008"></a> will attempt to load
<span
class="cmss-10">translator</span><a
- id="dx1-8009"></a>, unless you have used the <span
+ id="dx1-14009"></a>, unless you have used the <span
class="cmss-10">notranslate</span><a
- id="dx1-8010"></a>, <span
+ id="dx1-14010"></a>, <span
class="cmss-10">translate=false</span><a
- id="dx1-8011"></a> or <span
+ id="dx1-14011"></a> or <span
class="cmss-10">translate=babel</span><a
- id="dx1-8012"></a> package
+ id="dx1-14012"></a> package
options. If the <span
class="cmss-10">translator</span><a
- id="dx1-8013"></a> package is loaded, the translations are provided by dictionary files
+ id="dx1-14013"></a> package is loaded, the translations are provided by dictionary files
(for example, <span
class="cmtt-10">glossaries-dictionary-English.dict</span>). See the <span
class="cmss-10">translator</span><a
- id="dx1-8014"></a> package for advice
+ id="dx1-14014"></a> package for advice
on changing translations provided by <span
class="cmss-10">translator</span><a
- id="dx1-8015"></a> dictionaries. If you can’t work out
+ id="dx1-14015"></a> dictionaries. If you can’t work out
how to modify these dictionary definitions, try switching to <span
class="cmss-10">babel</span><a
- id="dx1-8016"></a>’s interface using
+ id="dx1-14016"></a>’s interface using
<span
class="cmss-10">translate=babel</span><a
- id="dx1-8017"></a>:
+ id="dx1-14017"></a>:
</p>
- <div class="verbatim" id="verbatim-15">
+ <div class="verbatim" id="verbatim-52">
\documentclass[english,french]{article}
 <br />\usepackage{babel}
 <br />\usepackage[translate=babel]{glossaries}
</div>
-<!--l. 1607--><p class="nopar" > and then use <span
+<!--l. 2106--><p class="nopar" > and then use <span
class="cmss-10">babel</span><a
- id="dx1-8018"></a>’s caption hook mechanism. Note that if you pass the language options
+ id="dx1-14018"></a>’s caption hook mechanism. Note that if you pass the language options
directly to <span
class="cmss-10">babel</span><a
- id="dx1-8019"></a> rather that using the document class options or otherwise passing the same
+ id="dx1-14019"></a> rather that using the document class options or otherwise passing the same
options to <span
class="cmss-10">translator</span><a
- id="dx1-8020"></a>, then <span
+ id="dx1-14020"></a>, then <span
class="cmss-10">translator</span><a
- id="dx1-8021"></a> won’t pick up the language and no dictionaries will be
+ id="dx1-14021"></a> won’t pick up the language and no dictionaries will be
loaded and <span
class="cmss-10">babel</span><a
- id="dx1-8022"></a>’s caption hooks will be used instead.
+ id="dx1-14022"></a>’s caption hooks will be used instead.
</p>
<div class="table">
-<!--l. 1615--><p class="indent" > <a
+<!--l. 2114--><p class="indent" > <a
id="tab:predefinednames"></a></p><hr class="float" /><div class="float"
>
@@ -3098,7 +4540,7 @@
<div class="caption"
><span class="id">Table 1.2: </span><span
-class="content">Customised Text</span></div><!--tex4ht:label?: x1-80232 -->
+class="content">Customised Text</span></div><!--tex4ht:label?: x1-140232 -->
<div class="tabular"> <table id="TBL-3" class="tabular"
@@ -3110,22 +4552,22 @@
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:wrap; text-align:left;" id="TBL-3-1-2"
-class="td11"> <!--l. 1621--><p class="noindent" ><span
+class="td11"> <!--l. 2120--><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:wrap; text-align:left;" id="TBL-3-1-3"
-class="td10"> <!--l. 1622--><p class="noindent" ><span
+class="td10"> <!--l. 2121--><p class="noindent" ><span
class="cmbx-10">Purpose</span> </p></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-3-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-1"
class="td01"><span
class="cmtt-10">\glossaryname</span><a
- id="dx1-8024"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-2-2"
-class="td11"> <!--l. 1623--><p class="noindent" ><span
+ id="dx1-14024"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-2-2"
+class="td11"> <!--l. 2122--><p class="noindent" ><span
class="cmtt-10">Glossary</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-2-3"
-class="td10"> <!--l. 1623--><p class="noindent" >Title
+class="td10"> <!--l. 2122--><p class="noindent" >Title
of
the
main
@@ -3134,10 +4576,10 @@
style="vertical-align:baseline;" id="TBL-3-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-1"
class="td01"><span
class="cmtt-10">\acronymname</span><a
- id="dx1-8025"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-3-2"
-class="td11"> <!--l. 1624--><p class="noindent" ><span
+ id="dx1-14025"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-3-2"
+class="td11"> <!--l. 2123--><p class="noindent" ><span
class="cmtt-10">Acronyms</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-3-3"
-class="td10"> <!--l. 1624--><p class="noindent" >Title
+class="td10"> <!--l. 2123--><p class="noindent" >Title
of
the
list
@@ -3150,17 +4592,17 @@
option
<span
class="cmss-10">acronym</span><a
- id="dx1-8026"></a>). </p></td>
+ id="dx1-14026"></a>). </p></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-3-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-1"
class="td01"><span
class="cmtt-10">\entryname</span><a
- id="dx1-8027"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-4-2"
-class="td11"> <!--l. 1626--><p class="noindent" ><span
+ id="dx1-14027"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-4-2"
+class="td11"> <!--l. 2125--><p class="noindent" ><span
class="cmtt-10">Notation</span>
<span
class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-4-3"
-class="td10"> <!--l. 1627--><p class="noindent" >Header
+class="td10"> <!--l. 2126--><p class="noindent" >Header
for
first
column
@@ -3181,12 +4623,12 @@
style="vertical-align:baseline;" id="TBL-3-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-1"
class="td01"><span
class="cmtt-10">\descriptionname</span><a
- id="dx1-8028"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-5-2"
-class="td11"> <!--l. 1629--><p class="noindent" ><span
+ id="dx1-14028"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-5-2"
+class="td11"> <!--l. 2128--><p class="noindent" ><span
class="cmtt-10">Description</span>
<span
class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-5-3"
-class="td10"> <!--l. 1630--><p class="noindent" >Header
+class="td10"> <!--l. 2129--><p class="noindent" >Header
for
second
column
@@ -3207,12 +4649,12 @@
style="vertical-align:baseline;" id="TBL-3-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-1"
class="td01"><span
class="cmtt-10">\symbolname</span><a
- id="dx1-8029"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-6-2"
-class="td11"> <!--l. 1632--><p class="noindent" ><span
+ id="dx1-14029"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-6-2"
+class="td11"> <!--l. 2131--><p class="noindent" ><span
class="cmtt-10">Symbol</span>
<span
class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-6-3"
-class="td10"> <!--l. 1632--><p class="noindent" >Header
+class="td10"> <!--l. 2131--><p class="noindent" >Header
for
symbol
column
@@ -3230,14 +4672,14 @@
style="vertical-align:baseline;" id="TBL-3-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-1"
class="td01"><span
class="cmtt-10">\pagelistname</span><a
- id="dx1-8030"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-7-2"
-class="td11"> <!--l. 1634--><p class="noindent" ><span
+ id="dx1-14030"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-7-2"
+class="td11"> <!--l. 2133--><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:wrap; text-align:left;" id="TBL-3-7-3"
-class="td10"> <!--l. 1635--><p class="noindent" >Header
+class="td10"> <!--l. 2134--><p class="noindent" >Header
for
page
list
@@ -3255,12 +4697,12 @@
style="vertical-align:baseline;" id="TBL-3-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-1"
class="td01"><span
class="cmtt-10">\glssymbolsgroupname</span><a
- id="dx1-8031"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-8-2"
-class="td11"> <!--l. 1637--><p class="noindent" ><span
+ id="dx1-14031"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-8-2"
+class="td11"> <!--l. 2136--><p class="noindent" ><span
class="cmtt-10">Symbols</span>
<span
class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-8-3"
-class="td10"> <!--l. 1638--><p class="noindent" >Header
+class="td10"> <!--l. 2137--><p class="noindent" >Header
for
symbols
section
@@ -3278,12 +4720,12 @@
style="vertical-align:baseline;" id="TBL-3-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-1"
class="td01"><span
class="cmtt-10">\glsnumbersgroupname</span><a
- id="dx1-8032"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-9-2"
-class="td11"> <!--l. 1640--><p class="noindent" ><span
+ id="dx1-14032"></a> </td><td style="white-space:wrap; text-align:left;" id="TBL-3-9-2"
+class="td11"> <!--l. 2139--><p class="noindent" ><span
class="cmtt-10">Numbers</span>
<span
class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:wrap; text-align:left;" id="TBL-3-9-3"
-class="td10"> <!--l. 1640--><p class="noindent" >Header
+class="td10"> <!--l. 2139--><p class="noindent" >Header
for
numbers
section
@@ -3304,7 +4746,7 @@
</div><hr class="endfloat" />
</div>
-<!--l. 1646--><p class="indent" > As from version 4.12, multilingual support is provided by separate language modules that
+<!--l. 2145--><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
@@ -3313,98 +4755,92 @@
href="http://www.dickimaw-books.com/contact.html" class="url" ><span
class="cmtt-10">http://www.dickimaw-books.com/contact.html</span></a>. The <span
class="cmss-10">translator</span><a
- id="dx1-8033"></a> dictionary files for <span
+ id="dx1-14033"></a> dictionary files for <span
class="cmss-10">glossaries</span>
are now provided by the appropriate language module. For further details about
information specific to a given language, please see the documentation for that language
module.
-</p><!--l. 1658--><p class="indent" > Examples of use: </p>
+</p><!--l. 2157--><p class="indent" > Examples of use: </p>
<ul class="itemize1">
<li class="itemize">Using <span
class="cmss-10">babel</span><a
- id="dx1-8034"></a> and <span
+ id="dx1-14034"></a> and <span
class="cmss-10">translator</span><a
- id="dx1-8035"></a>:
+ id="dx1-14035"></a>:
- <div class="verbatim" id="verbatim-16">
+ <div class="verbatim" id="verbatim-53">
\documentclass[english,french]{article}
 <br />\usepackage{babel}
 <br />\usepackage{glossaries}
</div>
- <!--l. 1665--><p class="nopar" > (<span
+ <!--l. 2164--><p class="nopar" > (<span
class="cmss-10">translator</span><a
- id="dx1-8036"></a> is automatically loaded).
+ id="dx1-14036"></a> is automatically loaded).
</p></li>
<li class="itemize">Using <span
class="cmss-10">babel</span><a
- id="dx1-8037"></a>:
+ id="dx1-14037"></a>:
- <div class="verbatim" id="verbatim-17">
+ <div class="verbatim" id="verbatim-54">
\documentclass[english,french]{article}
 <br />\usepackage{babel}
 <br />\usepackage[translate=babel]{glossaries}
</div>
- <!--l. 1673--><p class="nopar" > (<span
+ <!--l. 2172--><p class="nopar" > (<span
class="cmss-10">translator</span><a
- id="dx1-8038"></a> isn’t loaded).
+ id="dx1-14038"></a> isn’t loaded).
</p></li>
<li class="itemize">Using <span
class="cmss-10">polyglossia</span><a
- id="dx1-8039"></a>:
+ id="dx1-14039"></a>:
- <div class="verbatim" id="verbatim-18">
+ <div class="verbatim" id="verbatim-55">
\documentclass{article}
 <br />\usepackage{polyglossia}
 <br />\setmainlanguage{english}
 <br />\usepackage{glossaries}
</div>
- <!--l. 1682--><p class="nopar" >
- </p></li>
- <li class="itemize">Using <span
-class="cmss-10">ngerman</span><a
- id="dx1-8040"></a>:
-
-
- <div class="verbatim" id="verbatim-19">
- \documentclass{article}
-  <br />\usepackage{ngerman}
-  <br />\usepackage{glossaries}
-</div>
- <!--l. 1689--><p class="nopar" >
+ <!--l. 2181--><p class="nopar" >
</p>
</li></ul>
-<!--l. 1693--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations may not
+<!--l. 2185--><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-8041"></a> package and the <span
+ id="dx1-14040"></a> package and the <span
class="cmss-10">glossaries </span>package option
<span
class="cmss-10">translate=babel</span><a
- id="dx1-8042"></a>, you need to be familiar with the advice given in <a
+ id="dx1-14041"></a>, you need to be familiar with the advice given in <a
href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words
babel uses</a>. If you are using the <span
class="cmss-10">translator</span><a
- id="dx1-8043"></a> package, then you can provide your own
+ id="dx1-14042"></a> package, then you can provide your own
dictionary with the necessary modifications (using <span
class="cmtt-10">\deftranslation</span>) and load it using
<span
-class="cmtt-10">\usedictionary</span>.
-</p><!--l. 1702--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
+class="cmtt-10">\usedictionary</span>. If you simply want to change the title of a glossary, you can use the
+<span
+class="cmss-10">title</span><a
+ id="dx1-14043"></a> key in commands like <span
+class="cmtt-10">\printglossary </span>(but not the iterative commands like
+<span
+class="cmtt-10">\printglossaries</span>).
+</p><!--l. 2197--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
class="cmss-10">translator</span><a
- id="dx1-8044"></a> dictionaries are loaded at the beginning of the document, so it
+ id="dx1-14044"></a> dictionaries are loaded at the beginning of the document, so it
won’t have any effect if you put <span
class="cmtt-10">\deftranslation </span>in the preamble. It should be put in your
personal dictionary instead (as in the example below). See the <span
class="cmss-10">translator</span><a
- id="dx1-8045"></a> documentation for
+ id="dx1-14045"></a> documentation for
further details. (Now with <span
class="cmss-10">beamer</span><a
- id="dx1-8046"></a> documentation.) </div>
-</p><!--l. 1709--><p class="noindent" >
-</p><!--l. 1711--><p class="indent" > Your custom dictionary doesn’t have to be just a translation from English to another
+ id="dx1-14046"></a> documentation.) </div>
+</p><!--l. 2204--><p class="noindent" >
+</p><!--l. 2206--><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
@@ -3412,43 +4848,43 @@
</p>
- <div class="verbatim" id="verbatim-20">
+ <div class="verbatim" id="verbatim-56">
myinstitute-glossaries-dictionary-English.dict
</div>
-<!--l. 1719--><p class="nopar" > that contains the following:
+<!--l. 2214--><p class="nopar" > that contains the following:
</p>
- <div class="verbatim" id="verbatim-21">
+ <div class="verbatim" id="verbatim-57">
\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
 <br />\deftranslation{Glossary}{Nomenclature}
 <br />\deftranslation{Page List (glossaries)}{Location}
</div>
-<!--l. 1725--><p class="nopar" > You can now load it using:
+<!--l. 2220--><p class="nopar" > You can now load it using:
</p>
- <div class="verbatim" id="verbatim-22">
+ <div class="verbatim" id="verbatim-58">
\usedictionary{myinstitute-glossaries-dictionary}
</div>
-<!--l. 1729--><p class="nopar" > (Make sure that <span
+<!--l. 2224--><p class="nopar" > (Make sure that <span
class="cmtt-10">myinstitute-glossaries-dictionary-English.dict </span>can be
found by <span class="TEX">T<span
class="E">E</span>X</span>.) If you want to share your custom dictionary, you can upload it to
<a
href="http://www.ctan.org/" >CTAN</a>.
-</p><!--l. 1734--><p class="indent" > If you are using <span
+</p><!--l. 2229--><p class="indent" > If you are using <span
class="cmss-10">babel</span><a
- id="dx1-8047"></a> and don’t want to use the <span
+ id="dx1-14047"></a> and don’t want to use the <span
class="cmss-10">translator</span><a
- id="dx1-8048"></a> interface, you can use the
+ id="dx1-14048"></a> interface, you can use the
package option <span
class="cmss-10">translate=babel</span><a
- id="dx1-8049"></a>. For example:
+ id="dx1-14049"></a>. For example:
</p>
- <div class="verbatim" id="verbatim-23">
+ <div class="verbatim" id="verbatim-59">
\documentclass[british]{article}
 <br />\usepackage{babel}
 <br />\usepackage[translate=babel]{glossaries}
@@ -3457,35 +4893,45 @@
 <br />    \renewcommand*{\acronymname}{List of Acronyms}%
 <br />}
</div>
-<!--l. 1747--><p class="nopar" >
-</p><!--l. 1749--><p class="indent" > Note that <a
+<!--l. 2242--><p class="nopar" >
+</p><!--l. 2244--><p class="indent" > Note that <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-8050"></a></a> provides much better multi-lingual support than <a
+ id="dx1-14050"></a></a> and <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-14051"></a></a> provide much better multi-lingual support than <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-8051"></a></a>, so
-I recommend that you use <span
+ id="dx1-14052"></a></a>,
+so I recommend that you use Options <a
+href="#option3">3</a> or <a
+href="#option4">4</a> if you have glossary entries that contain
+<a
+href="#glo:nonlatinchar">non-Latin character<a
+ id="dx1-14053"></a>s</a>. See <a
+href="#sec:xindy"><span
+class="tcrm-1000">§</span>11 </a><a
+href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on <a
+href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-8052"></a> if you have glossary entries that contain <a
-href="#glo:nonlatinchar">non-Latin
-character<a
- id="dx1-8053"></a>s</a>. See <a
-href="#sec:xindy"><span
-class="cmsy-10">§</span>11 </a><a
-href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details.
+ id="dx1-14054"></a></a>, and see the
+<a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-14055"></a></a> user manual for further details of that application.
</p>
<h5 class="subsubsectionHead"><a
id="sec:newlang"></a>Creating a New Language Module</h5>
-<!--l. 1758--><p class="noindent" >The <span
+<!--l. 2254--><p class="noindent" >The <span
class="cmss-10">glossaries </span>package now uses the <span
class="cmss-10">tracklang</span><a
- id="dx1-9001"></a> package to determine which language modules
+ id="dx1-15001"></a> package to determine which language modules
need to be loaded. If you want to create a new language module, you should first read the
<span
class="cmss-10">tracklang</span><a
- id="dx1-9002"></a> documentation.
-</p><!--l. 1763--><p class="indent" > To create a new language module, you need to at least create two files: <span
+ id="dx1-15002"></a> documentation.
+</p><!--l. 2259--><p class="indent" > To create a new language module, you need to at least create two files: <span
class="cmtt-10">glossaries-</span>⟨<span
class="cmti-10">lang</span>⟩<span
class="cmtt-10">.ldf</span>
@@ -3498,15 +4944,15 @@
class="cmtt-10">english</span>) and ⟨<span
class="cmti-10">Lang</span>⟩ is the language name used by <span
class="cmss-10">translator</span><a
- id="dx1-9003"></a> (for example,
+ id="dx1-15003"></a> (for example,
<span
class="cmtt-10">English</span>).
-</p><!--l. 1770--><p class="indent" > Here’s an example of <span
+</p><!--l. 2266--><p class="indent" > Here’s an example of <span
class="cmtt-10">glossaries-dictionary-English.dict</span>:
</p>
- <div class="verbatim" id="verbatim-24">
+ <div class="verbatim" id="verbatim-60">
\ProvidesDictionary{glossaries-dictionary}{English}
 <br />\providetranslation{Glossary}{Glossary}
 <br />\providetranslation{Acronyms}{Acronyms}
@@ -3517,10 +4963,10 @@
 <br />\providetranslation{Symbols (glossaries)}{Symbols}
 <br />\providetranslation{Numbers (glossaries)}{Numbers}
</div>
-<!--l. 1782--><p class="nopar" > You can use this as a template for your dictionary file. Change <span
+<!--l. 2278--><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-9004"></a> name
+ id="dx1-15004"></a> name
for your language (so that it matches the file name <span
class="cmtt-10">glossaries-dictionary-</span>⟨<span
class="cmti-10">Lang</span>⟩<span
@@ -3528,12 +4974,12 @@
and, for each <span
class="cmtt-10">\providetranslation</span>, change the second argument to the appropriate
translation.
-</p><!--l. 1790--><p class="indent" > Here’s an example of <span
+</p><!--l. 2286--><p class="indent" > Here’s an example of <span
class="cmtt-10">glossaries-english.ldf</span>:
</p>
- <div class="verbatim" id="verbatim-25">
+ <div class="verbatim" id="verbatim-61">
\ProvidesGlossariesLang{english}
 <br />\glsifusedtranslatordict{English}
 <br />{%
@@ -3592,11 +5038,11 @@
 <br />\renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}
 <br />\renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
</div>
-<!--l. 1848--><p class="nopar" > This is a somewhat longer file, but again you can use it as a template. Replace <span
+<!--l. 2344--><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-9005"></a> language label ⟨<span
+ id="dx1-15005"></a> language label ⟨<span
class="cmti-10">Lang</span>⟩ used for the dictionary file and replace <span
class="cmtt-10">english </span>with the
root language name ⟨<span
@@ -3604,7 +5050,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. 1857--><p class="indent" > <span
+</p><!--l. 2353--><p class="indent" > <span
class="cmbx-10">Note: </span>the suffixes used to generate the plural forms when the plural hasn’t been specified
are given by <span
class="cmtt-10">\glspluralsuffix </span>(for general entries) and <span
@@ -3617,7 +5063,7 @@
set before the entry is defined and so the definitions aren’t included in the caption mechanism
as that’s not switched on until the start of the document. This means that the suffix in effect
will be for the last loaded language.
-</p><!--l. 1868--><p class="indent" > If you want to add a regional variation, create a file called <span
+</p><!--l. 2364--><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
@@ -3633,7 +5079,7 @@
</p>
- <div class="verbatim" id="verbatim-26">
+ <div class="verbatim" id="verbatim-62">
 \ProvidesGlossariesLang{en-GB}
 <br /> \RequireGlossariesLang{english}
 <br /> \glsifusedtranslatordict{British}
@@ -3653,20 +5099,20 @@
 <br />   }%
 <br /> }
</div>
-<!--l. 1893--><p class="nopar" >
-</p><!--l. 1895--><p class="indent" > If the translations includes <a
+<!--l. 2389--><p class="nopar" >
+</p><!--l. 2391--><p class="indent" > If the translations includes <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-9006"></a>s</a>, it’s necessary to provide code that’s
+ id="dx1-15006"></a>s</a>, it’s necessary to provide code that’s
independent of the input encoding. Remember that while some users may use UTF-8, others
may use Latin-1 or any other supported encoding, but while users won’t appreciate
you enforcing your preference on them, it’s useful to provide a UTF-8 version for
XeLaTeX users.
-</p><!--l. 1902--><p class="indent" > The <span
+</p><!--l. 2398--><p class="indent" > The <span
class="cmtt-10">glossaries-irish.ldf </span>file provides this as follows:
</p>
- <div class="verbatim" id="verbatim-27">
+ <div class="verbatim" id="verbatim-63">
\ProvidesGlossariesLang{irish}
 <br />\glsifusedtranslatordict{Irish}
 <br />{%
@@ -3702,16 +5148,16 @@
 <br />  \glossariescaptionsirish
 <br />}
</div>
-<!--l. 1939--><p class="nopar" > (Again you can use this as a template. Replace <span
+<!--l. 2435--><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-9007"></a> dictionary label.)
-</p><!--l. 1944--><p class="indent" > There are now two extra files: <span
+ id="dx1-15007"></a> dictionary label.)
+</p><!--l. 2440--><p class="indent" > There are now two extra files: <span
class="cmtt-10">glossaries-irish-noenc.ldf </span>and <span
class="cmtt-10">glossaries-irish-utf8.ldf</span>.
-</p><!--l. 1947--><p class="indent" > These both define <span
+</p><!--l. 2443--><p class="indent" > These both define <span
class="cmtt-10">\glossariescaptionsirish </span>but the <span
class="cmtt-10">*-noenc.ldf </span>uses <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> accent
@@ -3719,7 +5165,7 @@
</p>
- <div class="verbatim" id="verbatim-28">
+ <div class="verbatim" id="verbatim-64">
\@ifpackageloaded{polyglossia}%
 <br />{%
 <br />  \newcommand*{\glossariescaptionsirish}{%
@@ -3746,211 +5192,248 @@
 <br />  }%
 <br />}
</div>
-<!--l. 1975--><p class="nopar" > whereas the <span
+<!--l. 2471--><p class="nopar" > whereas the <span
class="cmtt-10">*-utf8.ldf </span>replaces the accent commands with the appropriate UTF-8
characters.
-</p><!--l. 1980--><p class="noindent" >
+</p><!--l. 2476--><p class="noindent" >
</p>
-<!--l. 1980--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a
+<!--l. 2476--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.5 </span> <a
id="sec:makeglossaries"></a>Generating the Associated Glossary Files</h3>
-<!--l. 1983--><p class="noindent" ><div class="important" title="Important Note"> This section is only applicable if you have chosen Options <a
+<!--l. 2479--><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 <a
-href="#option1">Option 1</a>. If you want to alphabetically sort your entries
+href="#option3">3</a>. You can ignore this section
+if you have chosen any of the other options. If you want to alphabetically sort your entries
always remember to use the <span
class="cmss-10">sort</span><a
- id="dx1-10001"></a> key if the <span
+ id="dx1-16001"></a> key if the <span
class="cmss-10">name</span><a
- id="dx1-10002"></a> contains any <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-16002"></a> contains any <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> commands.
</div>
-</p><!--l. 1988--><p class="noindent" >
-</p><!--l. 1990--><p class="noindent" >If this section seriously confuses you, and you can’t work out how to run <a
+</p><!--l. 2484--><p class="noindent" >
+</p><!--l. 2486--><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-10003"></a></a> or
-<a
+ id="dx1-16003"></a></a> or <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10004"></a></a>, you can try using the <span
+ id="dx1-16004"></a></a>, you can try using the <span
class="cmss-10">automake</span><a
- id="dx1-10005"></a> package option, described in <a
+ id="dx1-16005"></a> package
+option, described in <a
href="#sec:pkgopts-sort"><span
-class="cmsy-10">§</span>2.4 </a><a
-href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>,
-but you will need <span class="TEX">T<span
-class="E">E</span>X</span>’s shell escape enabled.
-</p><!--l. 1996--><p class="indent" > In order to generate a sorted glossary with compact <a
-href="#glo:numberlist">number list<a
- id="dx1-10006"></a>s</a>, it is necessary to use an
+class="tcrm-1000">§</span>2.4 </a><a
+href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>, but you will need <span class="TEX">T<span
+class="E">E</span>X</span>’s shell escape
+enabled.
+</p><!--l. 2492--><p class="indent" > In order to generate a sorted glossary with compact <a
+href="#glo:numberlist">number list<a
+ id="dx1-16006"></a>s</a>, it is necessary to use an
external <a
href="#glo:indexingapp">indexing application</a> as an intermediate step (unless you have chosen <a
href="#option1">Option 1</a>,
which uses <span class="TEX">T<span
-class="E">E</span>X</span> to do the sorting). It is this application that creates the file containing the
-code that typesets the glossary. <span
-class="cmbx-10">If this step is omitted, the glossaries will not appear</span>
+class="E">E</span>X</span> to do the sorting or <a
+href="#option5">Option 5</a>, which doesn’t perform any sorting). It is this
+application that creates the file containing the code required to typeset the glossary. <span
+class="cmbx-10">If this</span>
<span
-class="cmbx-10">in your document. </span>The two indexing applications that are most commonly used with
-<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="cmbx-10">step is omitted, the glossaries will not appear in your document. </span>The two
+indexing applications that are most commonly used with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> are <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10007"></a></a> and <a
+ id="dx1-16007"></a></a> and
+<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10008"></a></a>. As from version 1.17, the <span
-class="cmss-10">glossaries </span>package can be
-used with either of these applications. Previous versions were designed to be used
-with <span
+ id="dx1-16008"></a></a>. As from version 1.17, the <span
+class="cmss-10">glossaries </span>package can be used with either of these
+applications. Previous versions were designed to be used with <span
class="cmtt-10">makeindex</span><a
- id="dx1-10009"></a> only. Note that <span
+ id="dx1-16009"></a> only. With
+the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-16010"></a> package, you can also use <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-16011"></a></a> as the indexing application.
+(See the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-16012"></a> and <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-16013"></a></a> user manuals for further details.) Note that
+<span
class="cmtt-10">xindy</span><a
- id="dx1-10010"></a> has much better multi-lingual support than
+ id="dx1-16014"></a> and <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-16015"></a> have much better multi-lingual support than <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-16016"></a>, so
<span
-class="cmtt-10">makeindex</span><a
- id="dx1-10011"></a>, so <span
class="cmtt-10">xindy</span><a
- id="dx1-10012"></a> is recommended if you’re not writing in English. Commands
+ id="dx1-16017"></a> or <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-16018"></a> are recommended if you’re not writing in English. Commands
that only have an effect when <span
class="cmtt-10">xindy</span><a
- id="dx1-10013"></a> is used are described in <a
+ id="dx1-16019"></a> is used are described in <a
href="#sec:xindy"><span
-class="cmsy-10">§</span>11 </a><a
+class="tcrm-1000">§</span>11 </a><a
href="#sec:xindy">Xindy (Option
3)<!--tex4ht:ref: sec:xindy --></a>.
-</p><!--l. 2012--><p class="indent" > <div class="important" title="Important Note"> This is a multi-stage process, but there are methods of automating
-document compilation using applications such as <span
+</p><!--l. 2512--><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-10014"></a> and <span
+ id="dx1-16020"></a> and <span
class="cmtt-10">arara</span><a
- id="dx1-10015"></a>. See
-<a
-href="http://www.dickimaw-books.com/latex/thesis/html/build.html" class="url" ><span
-class="cmtt-10">http://www.dickimaw-books.com/latex/thesis/html/build.html</span></a> for more information.
+ id="dx1-16021"></a>. With <span
+class="cmtt-10">arara</span><a
+ id="dx1-16022"></a> you can just add special
+comments to your document source: </p><div class="alltt">
+<div class="obeylines-v">
+<span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
+<br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> makeglossaries</span>
+<br /><span
+class="cmtt-10">%</span><span
+class="cmtt-10"> arara:</span><span
+class="cmtt-10"> pdflatex</span>
</div>
-</p><!--l. 2018--><p class="noindent" >
-</p><!--l. 2020--><p class="indent" > The <span
+</div> With <span
+class="cmtt-10">latexmk</span><a
+ id="dx1-16023"></a> you need to set up the required dependencies. </div>
+<!--l. 2523--><p class="noindent" >
+</p><!--l. 2525--><p class="indent" > The <span
class="cmss-10">glossaries </span>package comes with the Perl script <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10016"></a></a> which will run
+ id="dx1-16024"></a></a> which will run
<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10017"></a></a> or <a
+ id="dx1-16025"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10018"></a></a> on all the glossary files using a customized style file (which is created
-by <span
+ id="dx1-16026"></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-10019"></a>). See <a
+ id="dx1-16027"></a>). See <a
href="#sec:makeglossariesapp"><span
-class="cmsy-10">§</span>1.4.1 </a><a
-href="#sec:makeglossariesapp">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further
-details. Perl is stable, cross-platform, open source software that is used by a number
-of <span class="TEX">T<span
-class="E">E</span>X</span>-related applications. Most Unix-like operating systems come with a Perl
-interpreter. <span class="TEX">T<span
+class="tcrm-1000">§</span>1.5.1 </a><a
+href="#sec:makeglossariesapp">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further details. Perl is
+stable, cross-platform, open source software that is used by a number of <span class="TEX">T<span
+class="E">E</span>X</span>-related
+applications (including <span
+class="cmtt-10">xindy</span><a
+ id="dx1-16028"></a> and <span
+class="cmtt-10">latexmk</span><a
+ id="dx1-16029"></a>). Most Unix-like operating systems come with
+a Perl interpreter. <span class="TEX">T<span
class="E">E</span>X</span> Live also comes with a Perl interpreter. MiK<span class="TEX">T<span
class="E">E</span>X</span> doesn’t come
with a Perl interpreter so if you are a Windows MiK<span class="TEX">T<span
-class="E">E</span>X</span> user you will need to
-install Perl if you want to use <a
+class="E">E</span>X</span> user you will need to install Perl if
+you want to use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10020"></a></a>. Further information is available at
+ id="dx1-16030"></a></a> or <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-16031"></a></a>. Further information is available at
<a
href="http://www.perl.org/about.html" class="url" ><span
class="cmtt-10">http://www.perl.org/about.html</span></a> and <a
href="http://tex.stackexchange.com/questions/158796/miktex-and-perl-scripts-and-one-python-script" >MiKTeX and Perl scripts (and one Python
script)</a>.
-</p><!--l. 2035--><p class="indent" > The advantages of using <span
+</p><!--l. 2541--><p class="indent" > The advantages of using <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10021"></a>: </p>
+ id="dx1-16032"></a>: </p>
<ul class="itemize1">
<li class="itemize">It automatically detects whether to use <span
class="cmtt-10">makeindex</span><a
- id="dx1-10022"></a> or <span
+ id="dx1-16033"></a> or <span
class="cmtt-10">xindy</span><a
- id="dx1-10023"></a> and sets the relevant
+ id="dx1-16034"></a> and sets the relevant
application switches.
</li>
<li class="itemize">One call of <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10024"></a> will run <span
+ id="dx1-16035"></a> will run <span
class="cmtt-10">makeindex</span><a
- id="dx1-10025"></a>/<span
+ id="dx1-16036"></a>/<span
class="cmtt-10">xindy</span><a
- id="dx1-10026"></a> for each glossary type.
+ id="dx1-16037"></a> for each glossary type.
</li>
+
+
<li class="itemize">If things go wrong, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10027"></a></a> will scan the messages from <a
+ id="dx1-16038"></a></a> will scan the messages from <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10028"></a></a> or
+ id="dx1-16039"></a></a> or
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10029"></a></a> and attempt to diagnose the problem in relation to the <span
+ id="dx1-16040"></a></a> and attempt to diagnose the problem in relation to the <span
class="cmss-10">glossaries </span>package.
This will hopefully provide more helpful messages in some cases. If it can’t diagnose
the problem, you will have to read the relevant transcript file and see if you can
work it out from the <span
class="cmtt-10">makeindex</span><a
- id="dx1-10030"></a> or <span
+ id="dx1-16041"></a> or <span
class="cmtt-10">xindy</span><a
- id="dx1-10031"></a> messages.
+ id="dx1-16042"></a> messages.
</li>
<li class="itemize">If <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10032"></a></a> warns about multiple encap values, <a
+ id="dx1-16043"></a></a> warns about multiple encap values, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10033"></a></a> will detect this
+ id="dx1-16044"></a></a> will detect this
and attempt to correct the problem.<span class="footnote-mark"><a
-href="#fn3x1" id="fn3x1-bk"><sup class="textsuperscript">1.3</sup></a></span><a
- id="x1-10034f3"></a>
- Since <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-10036"></a></a> doesn’t warn about this, this correction is only provided by
- <a
+href="#fn5x1" id="fn5x1-bk"><sup class="textsuperscript">1.5</sup></a></span><a
+ id="x1-16045f5"></a>
+ This correction is only provided by <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10037"></a></a> when <a
+ id="dx1-16047"></a></a> when <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10038"></a></a> is used. (<a
+ id="dx1-16048"></a></a> is used since
+ <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10039"></a></a> uses the order of the attributes
- list to determine which format should take precedence. See <span
-class="cmtt-10">\GlsAddXdyAttribute</span>
-
-
- in <a
+ id="dx1-16049"></a></a> uses the order of the attributes list to determine which format should take
+ precedence. (See <span
+class="cmtt-10">\GlsAddXdyAttribute </span>in <a
href="#sec:xindyloc"><span
-class="cmsy-10">§</span>11.2 </a><a
+class="tcrm-1000">§</span>11.2 </a><a
href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.)
</li></ul>
-<!--l. 2062--><p class="indent" > As from version 4.16, the <span
+<!--l. 2567--><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.lua</span><a
- id="dx1-10040"></a></a>. This is a <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-16050"></a></a>. This is a <span
class="cmti-10">trimmed-down </span>alternative to the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10041"></a></a> Perl
+ id="dx1-16051"></a></a> Perl
script. It doesn’t have some of the options that the Perl version has and it doesn’t attempt to
diagnose any problems, but since modern <span class="TEX">T<span
class="E">E</span>X</span> distributions come with Lua<span class="TEX">T<span
@@ -3958,79 +5441,79 @@
therefore have a Lua interpreter) you don’t need to install anything else in order to use
<a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-10042"></a></a> so it’s an alternative to <a
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-16052"></a></a> so it’s an alternative to <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10043"></a></a> if you want to use
-<a
-href="#option2">Option 2</a> (<a
+ id="dx1-16053"></a></a> if you want to use <a
+href="#option2">Option 2</a>
+(<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10044"></a></a>).
-</p><!--l. 2072--><p class="indent" > If things go wrong and you can’t work out why your glossaries aren’t being generated
+ id="dx1-16054"></a></a>).
+</p><!--l. 2577--><p class="indent" > If things go wrong and you can’t work out why your glossaries aren’t being generated
correctly, you can use <a
href="#glo:makeglossariesgui"><span
class="cmtt-10">makeglossariesgui</span><a
- id="dx1-10045"></a></a> as a diagnostic tool. Once you’ve fixed the
+ id="dx1-16055"></a></a> as a diagnostic tool. Once you’ve fixed the
problem, you can then go back to using <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10046"></a></a> or <a
+ id="dx1-16056"></a></a> or <a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-10047"></a></a>.
-</p><!--l. 2078--><p class="indent" > Whilst I strongly recommended that you use the <a
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-16057"></a></a>.
+</p><!--l. 2583--><p class="indent" > Whilst I strongly recommended that you use the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10048"></a></a> Perl script or the
-<a
+ id="dx1-16058"></a></a> Perl script or
+the <a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-10049"></a></a> Lua script, it is possible to use the <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-16059"></a></a> Lua script, it is possible to use the <span
class="cmss-10">glossaries </span>package
without using those applications. However, note that some commands and package
options have no effect if you explicitly run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10050"></a></a>/<a
+ id="dx1-16060"></a></a>/<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10051"></a></a>. These are listed in
+ id="dx1-16061"></a></a>. These are listed in
<a
href="#tab:makeglossariesCmds">table 1.3</a>.
-</p><!--l. 2085--><p class="indent" > <div class="important" title="Important Note"> If you are choosing not to use <span
+</p><!--l. 2590--><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-10052"></a> because you don’t want to install Perl,
+ id="dx1-16062"></a> because you don’t want to install Perl,
you will only be able to use <span
class="cmtt-10">makeindex</span><a
- id="dx1-10053"></a> as <span
+ id="dx1-16063"></a> as <span
class="cmtt-10">xindy</span><a
- id="dx1-10054"></a> also requires Perl. (Other useful Perl
+ id="dx1-16064"></a> also requires Perl. (Other useful Perl
scripts include <span
class="cmtt-10">epstopdf </span>and <span
class="cmtt-10">latexmk</span>, so it’s well-worth the effort to install Perl.)
</div>
-</p><!--l. 2091--><p class="noindent" >
-</p><!--l. 2093--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside
+</p><!--l. 2596--><p class="noindent" >
+</p><!--l. 2598--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside
the glossary, you will need to do an additional <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10055"></a></a>, <a
+ id="dx1-16065"></a></a>, <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10056"></a></a> or
+ id="dx1-16066"></a></a> or
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10057"></a></a> run, as appropriate. For example, suppose you have defined the following
+ id="dx1-16067"></a></a> run, as appropriate. For example, suppose you have defined the following
entries:<span class="footnote-mark"><a
-href="#fn4x1" id="fn4x1-bk"><sup class="textsuperscript">1.4</sup></a></span><a
- id="x1-10058f4"></a>
+href="#fn6x1" id="fn6x1-bk"><sup class="textsuperscript">1.6</sup></a></span><a
+ id="x1-16068f6"></a>
</p>
- <div class="verbatim" id="verbatim-29">
+ <div class="verbatim" id="verbatim-65">
\newglossaryentry{citrusfruit}{name={citrus fruit},
 <br />description={fruit of any citrus tree. (See also
 <br />\gls{orange})}}
@@ -4037,7 +5520,7 @@
 <br />\newglossaryentry{orange}{name={orange},
 <br />description={an orange coloured fruit.}}
</div>
-<!--l. 2106--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span
+<!--l. 2611--><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
@@ -4045,14 +5528,14 @@
first create the glossary and then do another run of <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10060"></a></a>, <a
+ id="dx1-16070"></a></a>, <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10061"></a></a>
+ id="dx1-16071"></a></a>
or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10062"></a></a>. For example, if the document is called <span
+ id="dx1-16072"></a></a>. For example, if the document is called <span
class="cmtt-10">myDoc.tex</span>, then you must do:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -4065,7 +5548,7 @@
class="cmtt-10">makeglossaries myDoc</span>
<br /><span
class="cmtt-10">latex myDoc</span></span>
-</p><!--l. 2120--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2625--><p class="indent" > <spacer type=vertical size=10>
(Note that if you use <a
href="#glo:glossaries-extra"><span
class="cmss-10">glossaries-extra</span></a>, this will be done automatically for you if
@@ -4073,10 +5556,10 @@
class="cmss-10">indexcrossrefs </span>feature is enabled. See the <span
class="cmss-10">glossaries-extra </span>user guide for further
details.)
-</p><!--l. 2126--><p class="indent" > Likewise, an additional <a
+</p><!--l. 2631--><p class="indent" > Likewise, an additional <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-10063"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-16073"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run may be required if the
document pages shift with re-runs. For example, if the page numbering is not reset after the
table of contents, the insertion of the table of contents on the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
@@ -4083,19 +5566,19 @@
class="E">E</span>X</span></span> run may push
glossary entries across page boundaries, which means that the <a
href="#glo:numberlist">number list<a
- id="dx1-10064"></a>s</a> in the glossary
+ id="dx1-16074"></a>s</a> in the glossary
may need updating.
-</p><!--l. 2134--><p class="indent" > The examples in this document assume that you are accessing <a
+</p><!--l. 2639--><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-10065"></a></a>, <a
+ id="dx1-16075"></a></a>, <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10066"></a></a> or
+ id="dx1-16076"></a></a> or
<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10067"></a></a> via a terminal. Windows users can use the MSDOS Prompt which is usually
+ id="dx1-16077"></a></a> via a terminal. Windows users can use the MSDOS Prompt which is usually
accessed via the <span
class="cmss-10">Start-</span><span
class="cmmi-10">></span><span
@@ -4106,7 +5589,7 @@
class="cmmi-10">></span><span
class="cmss-10">Accessories</span>
menu.
-</p><!--l. 2140--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the
+</p><!--l. 2645--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the
required application. The article <a
href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >“Glossaries, Nomenclature, List of Symbols and
Acronyms”</a> in the <a
@@ -4122,17 +5605,17 @@
class="E">E</span>X</span></span> to Write a PhD Thesis”</a> describes how
to do it for TeXWorks. For other editors see the editor’s user manual for further
details.
-</p><!--l. 2156--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span
+</p><!--l. 2661--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span
class="cmtt-10">.glg</span><a
- id="dx1-10068"></a> or <span
+ id="dx1-16078"></a> or <span
class="cmtt-10">.alg</span><a
- id="dx1-10069"></a>) for
+ id="dx1-16079"></a>) for
messages.
</p>
<div class="table">
-<!--l. 2159--><p class="indent" > <a
+<!--l. 2664--><p class="indent" > <a
id="tab:makeglossariesCmds"></a></p><hr class="float" /><div class="float"
>
@@ -4142,11 +5625,11 @@
class="content">Commands and package options that have no effect when using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10071"></a></a> or
+ id="dx1-16081"></a></a> or
<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10072"></a></a> explicitly</span></div><!--tex4ht:label?: x1-100703 -->
+ id="dx1-16082"></a></a> explicitly</span></div><!--tex4ht:label?: x1-160803 -->
<div class="tabular"> <table id="TBL-4" class="tabular"
cellspacing="0" cellpadding="0"
><colgroup id="TBL-4-1g"><col
@@ -4159,28 +5642,28 @@
class="td11"> <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-10073"></a></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3"
+ id="dx1-16083"></a></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3"
class="td10"> <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-10074"></a></a> </td>
+ id="dx1-16084"></a></a> </td>
</tr><tr
style="vertical-align:baseline;" id="TBL-4-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-1"
class="td01"><span
class="cmss-10">order=letter</span><a
- id="dx1-10075"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2"
+ id="dx1-16085"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2"
class="td11"> use <span
class="cmtt-10">-l</span><a
- id="dx1-10076"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3"
+ id="dx1-16086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3"
class="td10"> use <span
class="cmtt-10">-M</span><a
- id="dx1-10077"></a> <span
+ id="dx1-16087"></a> <span
class="cmtt-10">ord/letorder</span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-4-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-1"
class="td01"><span
class="cmss-10">order=word</span><a
- id="dx1-10078"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2"
+ id="dx1-16088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2"
class="td11"> default </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-3"
class="td10"> default </td>
</tr><tr
@@ -4187,7 +5670,7 @@
style="vertical-align:baseline;" id="TBL-4-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-1"
class="td01"><span
class="cmss-10">xindy</span><a
- id="dx1-10079"></a>=<span
+ id="dx1-16089"></a>=<span
class="cmsy-10">{</span><span
class="cmss-10">language=</span>⟨<span
class="cmti-10">lang</span>⟩<span
@@ -4197,16 +5680,16 @@
class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-3"
class="td10"> use <span
class="cmtt-10">-L</span><a
- id="dx1-10080"></a> ⟨<span
+ id="dx1-16090"></a> ⟨<span
class="cmti-10">lang</span>⟩ <span
class="cmtt-10">-C</span><a
- id="dx1-10081"></a> ⟨<span
+ id="dx1-16091"></a> ⟨<span
class="cmti-10">code</span>⟩ </td>
</tr><tr
style="vertical-align:baseline;" id="TBL-4-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-1"
class="td01"><span
class="cmtt-10">\GlsSetXdyLanguage</span><a
- id="dx1-10082"></a><span
+ id="dx1-16092"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">lang</span>⟩<span
class="cmtt-10">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-2"
@@ -4213,13 +5696,13 @@
class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-3"
class="td10"> use <span
class="cmtt-10">-L</span><a
- id="dx1-10083"></a> ⟨<span
+ id="dx1-16093"></a> ⟨<span
class="cmti-10">lang</span>⟩ </td>
</tr><tr
style="vertical-align:baseline;" id="TBL-4-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-1"
class="td01"><span
class="cmtt-10">\GlsSetXdyCodePage</span><a
- id="dx1-10084"></a><span
+ id="dx1-16094"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">code</span>⟩<span
class="cmtt-10">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-2"
@@ -4226,7 +5709,7 @@
class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-3"
class="td10"> use <span
class="cmtt-10">-C</span><a
- id="dx1-10085"></a> ⟨<span
+ id="dx1-16095"></a> ⟨<span
class="cmti-10">code</span>⟩ </td></tr></table>
</div>
@@ -4233,25 +5716,25 @@
</div><hr class="endfloat" />
</div>
-<!--l. 2182--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.1 </span> <a
+<!--l. 2687--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.1 </span> <a
id="sec:makeglossariesapp"></a>Using the makeglossaries Perl Script</h4>
-<!--l. 2185--><p class="noindent" >The <a
+<!--l. 2690--><p class="noindent" >The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11001"></a></a> script picks up the relevant information from the auxiliary (<span
+ id="dx1-17001"></a></a> script picks up the relevant information from the auxiliary (<span
class="cmtt-10">.aux</span><a
- id="dx1-11002"></a>) file
+ id="dx1-17002"></a>) file
and will either call <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-11003"></a></a> or <a
+ id="dx1-17003"></a></a> or <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-11004"></a></a>, depending on the supplied information. Therefore,
+ id="dx1-17004"></a></a>, depending on the supplied information. Therefore,
you only need to pass the document’s name without the extension to <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11005"></a>. For
+ id="dx1-17005"></a>. For
example, if your document is called <span
class="cmtt-10">myDoc.tex</span>, type the following in your terminal:
<spacer type=vertical size=10><span class="obeylines-h">
@@ -4261,62 +5744,42 @@
class="cmtt-10">makeglossaries myDoc</span>
<br /><span
class="cmtt-10">latex myDoc</span></span>
-</p><!--l. 2196--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2701--><p class="indent" > <spacer type=vertical size=10>
You may need to explicitly load <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11006"></a></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-17006"></a></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">perl makeglossaries myDoc</span></span>
-</p><!--l. 2200--><p class="indent" > <spacer type=vertical size=10>
-</p><!--l. 2202--><p class="indent" > Windows users: <span class="TEX">T<span
+</p><!--l. 2705--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2707--><p class="indent" > Windows users: <span class="TEX">T<span
class="E">E</span>X</span> Live on Windows has its own internal Perl interpreter and provides
<span
class="cmtt-10">makeglossaries.exe </span>as a convenient wrapper for the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11007"></a></a> Perl script.
-MiKTeX also provides a wrapper <span
-class="cmtt-10">makeglossaries.exe </span>but doesn’t provide a Perl
-interpreter, which is still required even if you run MiKTeX’s <span
-class="cmtt-10">makeglossaries.exe</span>, so
-with MiKTeX you’ll need to install Perl. There’s more information about this at
-<a
+ id="dx1-17007"></a></a> Perl script. MiKTeX also
+provides a wrapper <span
+class="cmtt-10">makeglossaries.exe </span>but doesn’t provide a Perl interpreter, which is still
+required even if you run MiKTeX’s <span
+class="cmtt-10">makeglossaries.exe</span>, so with MiKTeX you’ll need to install
+Perl.<span class="footnote-mark"><a
+href="#fn7x1" id="fn7x1-bk"><sup class="textsuperscript">1.7</sup></a></span><a
+ id="x1-17008f7"></a>
+There’s more information about this at <a
href="http://tex.stackexchange.com/q/158796/19862" class="url" ><span
-class="cmtt-10">http://tex.stackexchange.com/q/158796/19862</span></a> on the TeX.SX site. Alternatively, there
-is a batch file called <span
-class="cmtt-10">makeglossaries.bat </span>that should be located in the same folder as the
-<a
+class="cmtt-10">http://tex.stackexchange.com/q/158796/19862</span></a>
+on the TeX.SX site.
+</p><!--l. 2719--><p class="indent" > The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11008"></a></a> Perl script. This just explicitly loads the script into Perl. If you’ve installed
-Perl but for some reason your operating system can’t find <span
-class="cmtt-10">perl.exe</span>, you can edit the
-<span
-class="cmtt-10">makeglossaries.bat </span>file to include the full path to <span
-class="cmtt-10">perl.exe </span>(but take care as this file will
-be overwritten next time you update the <span
-class="cmss-10">glossaries </span>package). If you move the <span
-class="cmtt-10">.bat </span>file to a
-new location, you will also need to supply the full path to the <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-11009"></a></a> Perl
-script. (Don’t also move the Perl script as well or you may miss out on updates to
-<a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-11010"></a></a>.)
-</p><!--l. 2223--><p class="indent" > The <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-11011"></a></a> script attempts to fork the <a
+ id="dx1-17009"></a></a> script attempts to fork the <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-11012"></a></a>/<a
+ id="dx1-17010"></a></a>/<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-11013"></a></a> process
+ id="dx1-17011"></a></a> process
using <span
class="cmtt-10">open() </span>on the piped redirection <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">2>&1</span><span
@@ -4324,30 +5787,30 @@
help diagnose problems. If this method fails <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11014"></a></a> will print an “Unable
+ id="dx1-17012"></a></a> will print an “Unable
to fork” warning and will retry without redirection. If you run <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11015"></a></a>
+ id="dx1-17013"></a></a>
on an operating system that doesn’t support this form of redirection, then you
can use the <span
class="cmtt-10">-Q</span><a
- id="dx1-11016"></a> switch to suppress this warning or you can use the <span
+ id="dx1-17014"></a> switch to suppress this warning or you can use the <span
class="cmtt-10">-k</span><a
- id="dx1-11017"></a> switch to
+ id="dx1-17015"></a> switch to
make <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11018"></a></a> automatically use the fallback method without attempting
+ id="dx1-17016"></a></a> automatically use the fallback method without attempting
the redirection. Without this redirection, the <span
class="cmtt-10">-q</span><a
- id="dx1-11019"></a> (quiet) switch doesn’t work as
+ id="dx1-17017"></a> (quiet) switch doesn’t work as
well.
-</p><!--l. 2235--><p class="indent" > You can specify in which directory the <span
+</p><!--l. 2731--><p class="indent" > You can specify in which directory the <span
class="cmtt-10">.aux</span><a
- id="dx1-11020"></a>, <span
+ id="dx1-17018"></a>, <span
class="cmtt-10">.glo</span><a
- id="dx1-11021"></a> etc files are located using the <span
+ id="dx1-17019"></a> etc files are located using the <span
class="cmtt-10">-d </span>switch.
For example: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -4354,43 +5817,41 @@
class="cmtt-10">pdflatex -output-directory myTmpDir myDoc</span>
<br /><span
class="cmtt-10">makeglossaries -d myTmpDir myDoc</span></span>
-
-
-</p><!--l. 2241--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2737--><p class="indent" > <spacer type=vertical size=10>
Note that <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11022"></a> assumes by default that <span
+ id="dx1-17020"></a> assumes by default that <span
class="cmtt-10">makeindex</span><a
- id="dx1-11023"></a>/<span
+ id="dx1-17021"></a>/<span
class="cmtt-10">xindy</span><a
- id="dx1-11024"></a> is on your operating
+ id="dx1-17022"></a> is on your operating
system’s path. If this isn’t the case, you can specify the full pathname using <span
class="cmtt-10">-m</span><a
- id="dx1-11025"></a>
+ id="dx1-17023"></a>
⟨<span
class="cmti-10">path/to/makeindex</span>⟩ for <span
class="cmtt-10">makeindex</span><a
- id="dx1-11026"></a> or <span
+ id="dx1-17024"></a> or <span
class="cmtt-10">-x</span><a
- id="dx1-11027"></a> ⟨<span
+ id="dx1-17025"></a> ⟨<span
class="cmti-10">path/to/xindy</span>⟩ for <span
class="cmtt-10">xindy</span><a
- id="dx1-11028"></a>.
-</p><!--l. 2248--><p class="indent" > As from <a
+ id="dx1-17026"></a>.
+</p><!--l. 2744--><p class="indent" > As from <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11029"></a></a> v2.18, if you are using <a
+ id="dx1-17027"></a></a> v2.18, if you are using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-11030"></a></a>, there’s a check for
+ id="dx1-17028"></a></a>, there’s a check for
<span
class="cmtt-10">makeindex</span><a
- id="dx1-11031"></a>’s multiple encap warning. This is where different encap values (location formats)
+ id="dx1-17029"></a>’s multiple encap warning. This is where different encap values (location formats)
are used on the same location for the same entry. For example:
</p>
- <div class="verbatim" id="verbatim-30">
+ <div class="verbatim" id="verbatim-66">
\documentclass{article}
 <br />\usepackage{glossaries}
 <br />\makeglossaries
@@ -4400,53 +5861,53 @@
 <br />\printglossaries
 <br />\end{document}
</div>
-<!--l. 2264--><p class="nopar" > If you explicitly use <a
+<!--l. 2760--><p class="nopar" > If you explicitly use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-11032"></a></a>, this will cause a warning and the location list
+ id="dx1-17030"></a></a>, this will cause a warning and the location list
will be “1, <span
class="cmbx-10">1</span>”. That is, the page number will be repeated with each format. As
from v2.18, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11033"></a></a> will check for this warning and, if found, will attempt
+ id="dx1-17031"></a></a> will check for this warning and, if found, will attempt
to correct the problem by removing duplicate locations and retrying. There’s no
similar check for <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-11034"></a></a> as <span
+ id="dx1-17032"></a></a> as <span
class="cmtt-10">xindy</span><a
- id="dx1-11035"></a> won’t produce any warning and will simply discard
+ id="dx1-17033"></a> won’t produce any warning and will simply discard
duplicates.
-</p><!--l. 2273--><p class="indent" > The <a
+</p><!--l. 2769--><p class="indent" > The <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11036"></a></a> script contains POD (Plain Old Documentation). If you want, you
+ id="dx1-17034"></a></a> script contains POD (Plain Old Documentation). If you want, you
can create a man page for <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-11037"></a> using <span
+ id="dx1-17035"></a> using <span
class="cmtt-10">pod2man</span><a
- id="dx1-11038"></a> and move the resulting file onto
+ id="dx1-17036"></a> and move the resulting file onto
the man path. Alternatively do <span
class="cmtt-10">makeglossaries --help </span>for a list of all options or
<span
class="cmtt-10">makeglossaries --version </span>for the version number.
-</p><!--l. 2280--><p class="indent" > <div class="important" title="Important Note"> When upgrading the <span
+</p><!--l. 2776--><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-11039"></a></a>. The current version is 2.21. </div>
-</p><!--l. 2284--><p class="noindent" >
-</p><!--l. 2286--><p class="noindent" >
+ id="dx1-17037"></a></a>. The current version is 4.33. </div>
+</p><!--l. 2780--><p class="noindent" >
+</p><!--l. 2782--><p class="noindent" >
</p>
-<!--l. 2286--><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 Lua Script</h4>
-<!--l. 2289--><p class="noindent" >The Lua alternative to the <a
+<!--l. 2782--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.2 </span> <a
+ id="sec:makeglossarieslua"></a>Using the makeglossaries-lite Lua Script</h4>
+<!--l. 2785--><p class="noindent" >The Lua alternative to the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-12001"></a></a> Perl script requires a Lua interpreter, which
+ id="dx1-18001"></a></a> Perl script requires a Lua interpreter, which
should already be available if you have a modern <span class="TEX">T<span
class="E">E</span>X</span> distribution that includes Lua<span class="TEX">T<span
class="E">E</span>X</span>.
@@ -4454,16 +5915,16 @@
doesn’t have the full-functionality of heavy-weight scripting languages, such as Perl. The
<a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-12002"></a></a> script is therefore limited by this and some of the options
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-18002"></a></a> script is therefore limited by this and some of the options
available to the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-12003"></a></a> Perl script aren’t available here. (In particular the <span
+ id="dx1-18003"></a></a> Perl script aren’t available here. (In particular the <span
class="cmtt-10">-d</span><a
- id="dx1-12004"></a>
+ id="dx1-18004"></a>
option.)
-</p><!--l. 2299--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="TEX">T<span
+</p><!--l. 2795--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="TEX">T<span
class="E">E</span>X</span> Live on Unix-like systems creates a symbolic link called
<span
class="cmtt-10">makeglossaries-lite </span>(without the <span
@@ -4470,48 +5931,48 @@
class="cmtt-10">.lua </span>extension) to the actual <span
class="cmtt-10">makeglossaries-lite.lua</span>
script, so you may not need to supply the extension. </div>
-</p><!--l. 2305--><p class="noindent" >
+</p><!--l. 2801--><p class="noindent" >
-</p><!--l. 2307--><p class="indent" > The <a
+</p><!--l. 2803--><p class="indent" > The <a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-12005"></a></a> script can be invoked in the same way as <a
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-18005"></a></a> script can be invoked in the same way as <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-12006"></a></a>.
+ id="dx1-18006"></a></a>.
For example, if your document is called <span
class="cmtt-10">myDoc.tex</span>, then do <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries-lite.lua myDoc</span></span>
-</p><!--l. 2312--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2808--><p class="indent" > <spacer type=vertical size=10>
or <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries-lite myDoc</span></span>
-</p><!--l. 2316--><p class="indent" > <spacer type=vertical size=10>
-</p><!--l. 2318--><p class="indent" > <span
+</p><!--l. 2812--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2814--><p class="indent" > <span
class="cmti-10">Some </span>of the options available with <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-12007"></a></a> are also available with
+ id="dx1-18007"></a></a> are also available with
<a
href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite.lua</span><a
- id="dx1-12008"></a></a>. For a complete list of available options, do <spacer type=vertical size=10><span class="obeylines-h">
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-18008"></a></a>. For a complete list of available options, do <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries-lite.lua --help</span></span>
-</p><!--l. 2323--><p class="indent" > <spacer type=vertical size=10>
-</p><!--l. 2327--><p class="noindent" >
+</p><!--l. 2819--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2823--><p class="noindent" >
</p>
-<!--l. 2327--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.3 </span> <a
+<!--l. 2823--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.3 </span> <a
id="sec:xindyapp"></a>Using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span></a> explicitly (Option 3)</h4>
-<!--l. 2330--><p class="noindent" ><a
+<!--l. 2826--><p class="noindent" ><a
href="#glo:xindy"><span
class="cmtt-10">Xindy</span><a
- id="dx1-13001"></a></a> comes with <span class="TEX">T<span
+ id="dx1-19001"></a></a> comes with <span class="TEX">T<span
class="E">E</span>X</span> Live. It has also been added to Mik<span class="TEX">T<span
class="E">E</span>X</span>, but if you don’t have it
installed, see <a
@@ -4518,45 +5979,42 @@
href="http://tex.stackexchange.com/questions/71167/how-to-use-xindy-with-miktex" >How to use Xindy with MikTeX</a> on <a
href="http://www.stackexchange.com/" ><span class="TEX">T<span
class="E">E</span>X</span> on StackExchange</a>.
-</p><!--l. 2336--><p class="indent" > If you want to use <a
+</p><!--l. 2832--><p class="indent" > If you want to use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13002"></a></a> to process the glossary files, you must make sure you have used
+ id="dx1-19002"></a></a> to process the glossary files, you must make sure you have used
the <span
class="cmss-10">xindy</span><a
- id="dx1-13003"></a> package option:
+ id="dx1-19003"></a> package option:
</p>
- <div class="verbatim" id="verbatim-31">
+ <div class="verbatim" id="verbatim-67">
\usepackage[xindy]{glossaries}
</div>
-<!--l. 2341--><p class="nopar" > This is required regardless of whether you use <a
+<!--l. 2837--><p class="nopar" > This is required regardless of whether you use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13004"></a></a> explicitly or whether it’s called
-implicitly via applications such as <a
+ id="dx1-19004"></a></a> explicitly or whether it’s
+called implicitly via applications such as <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-13005"></a></a> or <a
-href="#glo:makeglossariesgui"><span
-class="cmtt-10">makeglossariesgui</span><a
- id="dx1-13006"></a></a>. This causes the
-glossary entries to be written in raw <span
+ id="dx1-19005"></a></a>. This causes the glossary
+entries to be written in raw <span
class="cmtt-10">xindy</span><a
- id="dx1-13007"></a> format, so you need to use <span
+ id="dx1-19006"></a> format, so you need to use <span
class="cmtt-10">-I</span><a
- id="dx1-13008"></a> <span
+ id="dx1-19007"></a> <span
class="cmtt-10">xindy </span><span
class="cmti-10">not </span><span
class="cmtt-10">-I</span><a
- id="dx1-13009"></a>
+ id="dx1-19008"></a>
<span
class="cmtt-10">tex</span>.
-</p><!--l. 2348--><p class="indent" > To run <a
+</p><!--l. 2844--><p class="indent" > To run <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13010"></a></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-19009"></a></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">xindy -L </span>⟨<span
class="cmitt-10">language</span>⟩ <span
@@ -4572,7 +6030,7 @@
⟨<span
class="cmitt-10">base</span>⟩<span
class="cmtt-10">.glo</span></span>
-</p><!--l. 2352--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2848--><p class="indent" > <spacer type=vertical size=10>
where ⟨<span
class="cmti-10">language</span>⟩ is the required language name, ⟨<span
class="cmti-10">encoding</span>⟩ is the encoding, ⟨<span
@@ -4579,26 +6037,26 @@
class="cmti-10">base</span>⟩ is the name of
the document without the <span
class="cmtt-10">.tex</span><a
- id="dx1-13011"></a> extension and ⟨<span
+ id="dx1-19010"></a> extension and ⟨<span
class="cmti-10">style</span>⟩ is the name of the <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13012"></a></a> style file
+ id="dx1-19011"></a></a> style file
without the <span
class="cmtt-10">.xdy</span><a
- id="dx1-13013"></a> extension. The default name for this style file is ⟨<span
+ id="dx1-19012"></a> extension. The default name for this style file is ⟨<span
class="cmti-10">base</span>⟩<span
class="cmtt-10">.xdy</span><a
- id="dx1-13014"></a> but can be
+ id="dx1-19013"></a> but can be
changed via <span
class="cmtt-10">\setStyleFile</span><a
- id="dx1-13015"></a><span
+ id="dx1-19014"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">style</span>⟩<span
class="cmtt-10">}</span>. You may need to specify the full path name depending
on the current working directory. If any of the file names contain spaces, you must delimit
them using double-quotes.
-</p><!--l. 2363--><p class="indent" > For example, if your document is called <span
+</p><!--l. 2859--><p class="indent" > For example, if your document is called <span
class="cmtt-10">myDoc.tex </span>and you are using UTF8 encoding in
English, then type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
@@ -4605,70 +6063,70 @@
class="cmtt-10">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls</span>
<span
class="cmtt-10">myDoc.glo</span></span>
-</p><!--l. 2368--><p class="indent" > <spacer type=vertical size=10>
-</p><!--l. 2370--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of
+</p><!--l. 2864--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2866--><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-13016"></a>
+ id="dx1-19015"></a>
package option), substituting <span
class="cmtt-10">.glg</span><a
- id="dx1-13017"></a>, <span
+ id="dx1-19016"></a>, <span
class="cmtt-10">.gls</span><a
- id="dx1-13018"></a> and <span
+ id="dx1-19017"></a> and <span
class="cmtt-10">.glo</span><a
- id="dx1-13019"></a> with the relevant extensions. For
+ id="dx1-19018"></a> with the relevant extensions. For
example, if you have used the <span
class="cmss-10">acronym</span><a
- id="dx1-13020"></a> package option, then you would need to do:
+ id="dx1-19019"></a> package option, then you would need to do:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr</span>
<span
class="cmtt-10">myDoc.acn</span></span>
-</p><!--l. 2379--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2875--><p class="indent" > <spacer type=vertical size=10>
For additional glossaries, the extensions are those supplied when you created the glossary
with <span
class="cmtt-10">\newglossary</span><a
- id="dx1-13021"></a>.
-</p><!--l. 2383--><p class="indent" > Note that if you use <a
+ id="dx1-19020"></a>.
+</p><!--l. 2879--><p class="indent" > Note that if you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-13022"></a></a> instead, you can replace all those calls to <a
+ id="dx1-19021"></a></a> instead, you can replace all those calls to <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13023"></a></a>
+ id="dx1-19022"></a></a>
with just one call to <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-13024"></a>: <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-19023"></a>: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries myDoc</span></span>
-</p><!--l. 2388--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2884--><p class="indent" > <spacer type=vertical size=10>
Note also that some commands and package options have no effect if you use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-13025"></a></a> explicitly
+ id="dx1-19024"></a></a> explicitly
instead of using <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-13026"></a>. These are listed in <a
+ id="dx1-19025"></a>. These are listed in <a
href="#tab:makeglossariesCmds">table 1.3</a>.
-</p><!--l. 2396--><p class="noindent" >
+</p><!--l. 2892--><p class="noindent" >
</p>
-<!--l. 2396--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.4 </span> <a
+<!--l. 2892--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.4 </span> <a
id="sec:makeindexapp"></a>Using <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span></a> explicitly (Option 2)</h4>
-<!--l. 2399--><p class="noindent" >If you want to use <a
+<!--l. 2895--><p class="noindent" >If you want to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-14001"></a></a> explicitly, you must make sure that you haven’t used the <span
+ id="dx1-20001"></a></a> explicitly, you must make sure that you haven’t used the <span
class="cmss-10">xindy</span><a
- id="dx1-14002"></a>
+ id="dx1-20002"></a>
package option or the glossary entries will be written in the wrong format. To run <span
class="cmtt-10">makeindex</span><a
- id="dx1-14003"></a>,
+ id="dx1-20003"></a>,
type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeindex -s </span>⟨<span
@@ -4680,105 +6138,105 @@
class="cmtt-10">.gls </span>⟨<span
class="cmitt-10">base</span>⟩<span
class="cmtt-10">.glo</span></span>
-</p><!--l. 2406--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2902--><p class="indent" > <spacer type=vertical size=10>
where ⟨<span
class="cmti-10">base</span>⟩ is the name of your document without the <span
class="cmtt-10">.tex</span><a
- id="dx1-14004"></a> extension and ⟨<span
+ id="dx1-20004"></a> extension and ⟨<span
class="cmti-10">style</span>⟩<span
class="cmtt-10">.ist</span><a
- id="dx1-14005"></a> is the
+ id="dx1-20005"></a> is the
name of the <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-14006"></a></a> style file. By default, this is ⟨<span
+ id="dx1-20006"></a></a> style file. By default, this is ⟨<span
class="cmti-10">base</span>⟩<span
class="cmtt-10">.ist</span><a
- id="dx1-14007"></a>, but may be changed via
+ id="dx1-20007"></a>, but may be changed via
<span
class="cmtt-10">\setStyleFile</span><a
- id="dx1-14008"></a><span
+ id="dx1-20008"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">style</span>⟩<span
class="cmtt-10">}</span>. Note that there are other options, such as <span
class="cmtt-10">-l</span><a
- id="dx1-14009"></a> (letter ordering). See
+ id="dx1-20009"></a> (letter ordering). See
the <span
class="cmtt-10">makeindex</span><a
- id="dx1-14010"></a> manual for further details.
-</p><!--l. 2415--><p class="indent" > For example, if your document is called <span
+ id="dx1-20010"></a> manual for further details.
+</p><!--l. 2911--><p class="indent" > For example, if your document is called <span
class="cmtt-10">myDoc.tex</span>, then type the following at the
terminal: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo</span></span>
-</p><!--l. 2419--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2915--><p class="indent" > <spacer type=vertical size=10>
Note that this only creates the main glossary. If you have additional glossaries (for example, if
you have used the <span
class="cmss-10">acronym</span><a
- id="dx1-14011"></a> package option) then you must call <a
+ id="dx1-20011"></a> package option) then you must call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-14012"></a></a> for each glossary,
+ id="dx1-20012"></a></a> for each glossary,
substituting <span
class="cmtt-10">.glg</span><a
- id="dx1-14013"></a>, <span
+ id="dx1-20013"></a>, <span
class="cmtt-10">.gls</span><a
- id="dx1-14014"></a> and <span
+ id="dx1-20014"></a> and <span
class="cmtt-10">.glo</span><a
- id="dx1-14015"></a> with the relevant extensions. For example, if you have used
+ id="dx1-20015"></a> with the relevant extensions. For example, if you have used
the <span
class="cmss-10">acronym</span><a
- id="dx1-14016"></a> package option, then you need to type the following in your terminal:
+ id="dx1-20016"></a> package option, then you need to type the following in your terminal:
<spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn</span></span>
-</p><!--l. 2430--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2926--><p class="indent" > <spacer type=vertical size=10>
For additional glossaries, the extensions are those supplied when you created the glossary
with <span
class="cmtt-10">\newglossary</span><a
- id="dx1-14017"></a>.
-</p><!--l. 2434--><p class="indent" > Note that if you use <a
+ id="dx1-20017"></a>.
+</p><!--l. 2930--><p class="indent" > Note that if you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-14018"></a></a> instead, you can replace all those calls to <a
+ id="dx1-20018"></a></a> instead, you can replace all those calls to <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-14019"></a></a>
+ id="dx1-20019"></a></a>
with just one call to <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-14020"></a>: <spacer type=vertical size=10><span class="obeylines-h">
+ id="dx1-20020"></a>: <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">makeglossaries myDoc</span></span>
-</p><!--l. 2439--><p class="indent" > <spacer type=vertical size=10>
+</p><!--l. 2935--><p class="indent" > <spacer type=vertical size=10>
Note also that some commands and package options have no effect if you use <span
class="cmtt-10">makeindex</span><a
- id="dx1-14021"></a>
+ id="dx1-20021"></a>
explicitly instead of using <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-14022"></a></a>. These are listed in <a
+ id="dx1-20022"></a></a>. These are listed in <a
href="#tab:makeglossariesCmds">table 1.3</a>.
-</p><!--l. 2446--><p class="noindent" >
+</p><!--l. 2942--><p class="noindent" >
</p>
-<!--l. 2446--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.5 </span> <a
+<!--l. 2942--><p class="noindent" ><a
+href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.5 </span> <a
id="sec:notedev"></a>Note to Front-End and Script Developers</h4>
-<!--l. 2449--><p class="noindent" >The information needed to determine whether to use <a
+<!--l. 2945--><p class="noindent" >The information needed to determine whether to use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-15001"></a></a> or <a
+ id="dx1-21001"></a></a> or <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-15002"></a></a> and the
+ id="dx1-21002"></a></a> and the
information needed to call those applications is stored in the auxiliary file. This
information can be gathered by a front-end, editor or script to make the glossaries where
appropriate. This section describes how the information is stored in the auxiliary
file.
-</p><!--l. 2456--><p class="indent" > The file extensions used by each defined glossary are given by
-</p><!--l. 2457--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 2952--><p class="indent" > The file extensions used by each defined glossary are given by
+</p><!--l. 2953--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\@newglossary</span><span
class="cmtt-9"> </span></span><a
- id="dx1-15003"></a> <span
+ id="dx1-21003"></a> <span
class="cmtt-10">\@newglossary{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -4788,7 +6246,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">in-ext</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2459--><p class="noindent" >
+</p><!--l. 2955--><p class="noindent" >
where ⟨<span
class="cmti-10">in-ext</span>⟩ is the extension of the <a
href="#glo:indexingapp"><span
@@ -4809,59 +6267,59 @@
</p>
- <div class="verbatim" id="verbatim-32">
+ <div class="verbatim" id="verbatim-68">
\@newglossary{main}{glg}{gls}{glo}
</div>
-<!--l. 2472--><p class="nopar" >
-</p><!--l. 2474--><p class="indent" > The <a
+<!--l. 2968--><p class="nopar" >
+</p><!--l. 2970--><p class="indent" > The <a
href="#glo:indexingapp">indexing application’s</a> style file is specified by
-</p><!--l. 2475--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 2971--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\@istfilename</span><span
class="cmtt-9"> </span></span><a
- id="dx1-15004"></a> <span
+ id="dx1-21004"></a> <span
class="cmtt-10">\@istfilename{</span>⟨<span
class="cmitt-10">filename</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2477--><p class="noindent" >
+</p><!--l. 2973--><p class="noindent" >
The file extension indicates whether to use <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-15005"></a></a> (<span
+ id="dx1-21005"></a></a> (<span
class="cmtt-10">.ist</span><a
- id="dx1-15006"></a>) or <a
+ id="dx1-21006"></a>) or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-15007"></a></a> (<span
+ id="dx1-21007"></a></a> (<span
class="cmtt-10">.xdy</span><a
- id="dx1-15008"></a>).
+ id="dx1-21008"></a>).
Note that the glossary information is formatted differently depending on which
indexing application is supposed to be used, so it’s important to call the correct
one.
-</p><!--l. 2484--><p class="indent" > Word or letter ordering is specified by:
-</p><!--l. 2485--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 2980--><p class="indent" > Word or letter ordering is specified by:
+</p><!--l. 2981--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\@glsorder</span><span
class="cmtt-9"> </span></span><a
- id="dx1-15009"></a> <span
+ id="dx1-21009"></a> <span
class="cmtt-10">\@glsorder{</span>⟨<span
class="cmitt-10">order</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2487--><p class="noindent" >
+</p><!--l. 2983--><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. 2490--><p class="indent" > If <a
+</p><!--l. 2986--><p class="indent" > If <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-15010"></a></a> should be used, the language and code page for each glossary is specified
+ id="dx1-21010"></a></a> should be used, the language and code page for each glossary is specified
by
-</p><!--l. 2492--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 2988--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\@xdylanguage</span><span
class="cmtt-9"> </span></span><a
- id="dx1-15011"></a><span class="marginpar"><span
+ id="dx1-21011"></a><span class="marginpar"><span
class="cmtt-9">\@gls at codepage</span><span
class="cmtt-9"> </span></span><a
- id="dx1-15012"></a> <span
+ id="dx1-21012"></a> <span
class="cmtt-10">\@xdylanguage{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -4873,7 +6331,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">code</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2495--><p class="noindent" >
+</p><!--l. 2991--><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
@@ -4883,12 +6341,12 @@
class="cmtt-10">utf8</span>). These commands are omitted if <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-15013"></a></a> should be
+ id="dx1-21013"></a></a> should be
used.
-</p><!--l. 2501--><p class="indent" > If <a
+</p><!--l. 2997--><p class="indent" > If <a
href="#option1">Option 1</a> has been used, the <span
class="cmtt-10">.aux </span>file will contain
-</p><!--l. 2503--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 2999--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\@gls at reference{</span>⟨<span
class="cmitt-10">type</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -4896,30 +6354,45 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">location</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 2504--><p class="noindent" >
-for every time an entry has been referenced.
+</p><!--l. 3000--><p class="noindent" >
+for every time an entry has been referenced. If <a
+href="#option4">Option 4</a> has been used, the <span
+class="cmtt-10">.aux </span>file will
+contain one or more instances of
+</p><!--l. 3004--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\glsxtr at resource{</span>⟨<span
+class="cmitt-10">options</span>⟩<span
+class="cmtt-10">}{</span>⟨<span
+class="cmitt-10">basename</span>⟩<span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 3005--><p class="noindent" >
</p>
-<!--l. 2507--><p class="indent" > </div>
-</p><!--l. 2507--><p class="noindent" ><a
+<!--l. 3007--><p class="indent" > </div>
+</p><!--l. 3007--><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. 2510--><p class="indent" > This section describes the available <span
-class="cmss-10">glossaries </span>package options. You may omit the <span
-class="cmtt-10">=true </span>for
-boolean options. (For example, <span
+</p><!--l. 3010--><p class="indent" > This section describes the available <span
+class="cmss-10">glossaries </span>package options. You may omit the
+<span
+class="cmtt-10">=true </span>for boolean options. (For example, <span
class="cmss-10">acronym</span><a
- id="dx1-16001"></a> is equivalent to <span
+ id="dx1-22001"></a> is equivalent to <span
class="cmss-10">acronym=true</span><a
- id="dx1-16002"></a>).
-</p><!--l. 2514--><p class="indent" > <div class="important" title="Important Note"> Note that ⟨<span
+ id="dx1-22002"></a>).
+The <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> package has additional options described in the <span
+class="cmss-10">glossaries-extra</span>
+manual.
+</p><!--l. 3016--><p class="indent" > <div class="important" title="Important Note"> Note that ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ package options can’t be passed via the document class options.
(This includes options where the ⟨<span
class="cmti-10">value</span>⟩ part may be omitted, such as <span
class="cmss-10">acronym</span><a
- id="dx1-16003"></a>.)
+ id="dx1-22003"></a>.)
This is a general limitation not restricted to the <span
class="cmss-10">glossaries </span>package. Options that
aren’t ⟨<span
@@ -4926,17 +6399,17 @@
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ (such as <span
class="cmss-10">makeindex</span><a
- id="dx1-16004"></a>) may be passed via the document class options.
+ id="dx1-22004"></a>) may be passed via the document class options.
</div>
-</p><!--l. 2521--><p class="noindent" >
+</p><!--l. 3023--><p class="noindent" >
</p>
-<!--l. 2523--><p class="noindent" ><a
+<!--l. 3025--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.1 </span> <a
id="sec:pkgopts-general"></a>General Options</h3>
<dl class="description"><dt class="description">
<span
class="cmssbx-10">nowarn</span><a
- id="dx1-17001"></a> </dt><dd
+ id="dx1-23001"></a> </dt><dd
class="description">This suppresses all warnings generated by the <span
class="cmss-10">glossaries </span>package. Don’t use this
option if you’re new to using <span
@@ -4943,16 +6416,21 @@
class="cmss-10">glossaries </span>as the warnings are designed to help detect
common mistakes (such as forgetting to use <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-17002"></a>). Note that the
+ id="dx1-23002"></a>). Note that the
<span
class="cmss-10">debug=true</span><a
- id="dx1-17003"></a> and <span
+ id="dx1-23003"></a> and <span
class="cmss-10">debug=showtargets</span><a
- id="dx1-17004"></a> will override this option.
+ id="dx1-23004"></a> will override this option.
</dd><dt class="description">
<span
+class="cmssbx-10">nolangwarn</span><a
+ id="dx1-23005"></a> </dt><dd
+class="description">This suppresses the warning generated by a missing language module.
+ </dd><dt class="description">
+<span
class="cmssbx-10">noredefwarn</span><a
- id="dx1-17005"></a> </dt><dd
+ id="dx1-23006"></a> </dt><dd
class="description">If you load <span
class="cmss-10">glossaries </span>with a class or another package that already defines
glossary related commands, by default <span
@@ -4963,50 +6441,72 @@
suppress those warnings. Other warnings will still be issued unless you use the
<span
class="cmss-10">nowarn</span><a
- id="dx1-17006"></a> option described above.
+ id="dx1-23007"></a> option described above.
</dd><dt class="description">
<span
class="cmssbx-10">debug</span><a
- id="dx1-17007"></a> </dt><dd
-class="description">Introduced in version 4.24. This was a boolean option but as from v4.32 it’s now a
- choice option. If no value is given, <span
+ id="dx1-23008"></a> </dt><dd
+class="description">Introduced in version 4.24. The default setting is <span
+class="cmss-10">debug=false</span><a
+ id="dx1-23009"></a>. This was a
+ boolean option but as from v4.32 it now accepts the values: <span
+class="cmss-10">false</span>, <span
+class="cmss-10">true </span>and
+ <span
+class="cmss-10">showtargets</span>. If no value is given, <span
class="cmss-10">debug=true</span><a
- id="dx1-17008"></a> is assumed. Both <span
+ id="dx1-23010"></a> is assumed. Both <span
class="cmss-10">debug=true</span><a
- id="dx1-17009"></a>
+ id="dx1-23011"></a>
and <span
class="cmss-10">debug=showtargets</span><a
- id="dx1-17010"></a> switch on the debug mode (and will automatically
+ id="dx1-23012"></a> switch on the debug mode (and will automatically
cancel the <span
class="cmss-10">nowarn</span><a
- id="dx1-17011"></a> option). The <span
+ id="dx1-23013"></a> option). The <span
class="cmss-10">debug=showtargets</span><a
- id="dx1-17012"></a> option will additionally
+ id="dx1-23014"></a> option will additionally
use
- <!--l. 2549--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3056--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsshowtarget</span><span
class="cmtt-9"> </span></span><a
- id="dx1-17013"></a> <span
+ id="dx1-23015"></a> <span
class="cmtt-10">\glsshowtarget{</span>⟨<span
class="cmitt-10">target name</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 2551--><p class="noindent" >
- to show the hypertarget/hyperlink name in the margin when <span
+ </p><!--l. 3058--><p class="noindent" >
+ to show the hypertarget or hyperlink name in the margin when <span
class="cmtt-10">\glsdohypertarget </span>is
used by commands like <span
class="cmtt-10">\glstarget </span>and when <span
class="cmtt-10">\glsdohyperlink </span>is used by commands
+
+
like <span
-class="cmtt-10">\gls</span>.
- </p><!--l. 2556--><p class="noindent" >Consider the following example document:
+class="cmtt-10">\gls</span>. This puts the information in the margin using <span
+class="cmtt-10">\marginpar</span><a
+ id="dx1-23016"></a>. If this causes a
+ problem, you’ll need to redefine <span
+class="cmtt-10">\glsshowtarget</span>. For example:
</p>
- <div class="verbatim" id="verbatim-33">
+ <div class="verbatim" id="verbatim-69">
+ \renewcommand*{\glsshowtarget}[1]{\texttt{\small [#1]}}
+</div>
+ <!--l. 3067--><p class="nopar" >
+ </p><!--l. 3069--><p class="noindent" >The purpose of the debug mode can be demonstrated with the following example
+ document:
+
+
+</p>
+ <div class="verbatim" id="verbatim-70">
\documentclass{article}
 <br />\usepackage{glossaries}
-  <br />\newglossaryentry{sample1}{name={sample1},description={example}}
-  <br />\newglossaryentry{sample2}{name={sample2},description={example}}
+  <br />\newglossaryentry{sample1}{name={sample1},
+  <br />  description={example}}
+  <br />\newglossaryentry{sample2}{name={sample2},
+  <br />  description={example}}
 <br />\glsadd{sample2}
 <br />\makeglossaries
 <br />\begin{document}
@@ -5014,41 +6514,57 @@
 <br />\printglossaries
 <br />\end{document}
</div>
- <!--l. 2568--><p class="nopar" > Here, only the <span
+ <!--l. 3084--><p class="nopar" > In this case, only the <span
class="cmtt-10">sample1 </span>entry has been indexed, even though <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\glsadd{sample2}</span></span></span>
- appears in the source code. This is because the associated file is opened by
- <span
+ appears in the source code. This is because <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\glsadd{sample2}</span></span></span> has been used before the
+ associated file is opened by <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-17014"></a>, but <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\glsadd{sample2}</span></span></span> has been used before this command. Since
- the file isn’t open yet, the information can’t be written to it, which is why the <span
-class="cmtt-10">sample2</span>
- entry doesn’t appear in the glossary.
- </p><!--l. 2577--><p class="noindent" >This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user
+ id="dx1-23017"></a>. Since the file isn’t open yet, the
+ information can’t be written to it, which is why the <span
+class="cmtt-10">sample2 </span>entry doesn’t appear in
+ the glossary.
+ </p><!--l. 3092--><p class="noindent" >This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user
to want to use <span
class="cmss-10">glossaries </span>to format the entries (e.g. abbreviation expansion) but not
display any lists of terms, abbreviations, symbols etc. Without <span
-class="cmtt-10">\makeglossaries </span>(or
+class="cmtt-10">\makeglossaries </span>the
+ indexing is suppressed but, other than that, commands like <span
+class="cmtt-10">\gls </span>behave as
+ usual. It’s also possible that the user may want to temporarily comment out
<span
-class="cmtt-10">\makenoidxglossaries</span>) the indexing is suppressed but, other than that, commands
- like <span
-class="cmtt-10">\gls </span>behave as usual.
- </p><!--l. 2585--><p class="noindent" >The debug mode, enabled with the <span
+class="cmtt-10">\makeglossaries </span>in order to suppress the indexing while working on a draft
+ version to speed compilation. Therefore <span
+class="cmtt-10">\makeglossaries </span>can’t be used to
+ enable <span
+class="cmtt-10">\newglossaryentry </span>and <span
+class="cmtt-10">\glsadd</span>. They must be enabled by default. (It
+ does, however, enable the <span
+class="cmss-10">see</span><a
+ id="dx1-23018"></a> key as that’s a more common problem. See
+ below.)
+ </p><!--l. 3106--><p class="noindent" >The debug mode, enabled with the <span
class="cmss-10">debug</span><a
- id="dx1-17015"></a> option, 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
+ id="dx1-23019"></a> option,
+
+
+</p>
+ <div class="verbatim" id="verbatim-71">
+ \usepackage[debug]{glossaries}
+</div>
+ <!--l. 3109--><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. 2590--><p class="noindent" >Package glossaries Info: wrglossary(⟨<span
+ <!--l. 3114--><p class="noindent" >Package glossaries Info: wrglossary(⟨<span
class="cmti-10">type</span>⟩)(⟨<span
-class="cmti-10">line</span>⟩) on input line ⟨<span
+class="cmti-10">text</span>⟩) on input line ⟨<span
class="cmti-10">line</span>
<span
class="cmti-10">number</span>⟩.</p></div>
- <!--l. 2593--><p class="noindent" >where ⟨<span
+ <!--l. 3117--><p class="noindent" >where ⟨<span
class="cmti-10">type</span>⟩ is the glossary label and ⟨<span
-class="cmti-10">line</span>⟩ is the line of text that would’ve been written to
+class="cmti-10">text</span>⟩ is the line of text that would’ve been written to
the associated file if it had been open. So if any entries haven’t appeared in the glossary
but you’re sure you used commands like <span
class="cmtt-10">\glsadd </span>or <span
@@ -5055,12 +6571,12 @@
class="cmtt-10">\glsaddall</span>, try switching
on the <span
class="cmss-10">debug</span><a
- id="dx1-17016"></a> option and see if any information has been written to the log
+ id="dx1-23020"></a> option and see if any information has been written to the log
file.
</p></dd><dt class="description">
<span
class="cmssbx-10">seenoindex</span><a
- id="dx1-17017"></a> </dt><dd
+ id="dx1-23021"></a> </dt><dd
class="description">Introduced in version 4.24, this option may take one of three values: <span
class="cmss-10">error</span>, <span
class="cmss-10">warn </span>or
@@ -5067,61 +6583,66 @@
<span
class="cmss-10">ignore</span>. The <span
class="cmss-10">see</span><a
- id="dx1-17018"></a> key automatically indexes the cross-referenced entry using <span
+ id="dx1-23022"></a> key automatically indexes the cross-referenced entry using <span
class="cmtt-10">\glsadd</span>. This
means that it suffers from the same problem as the above. If used before
the relevant glossary file has been opened, the indexing can’t be performed.
Since this is easy to miss, the <span
class="cmss-10">glossaries </span>package by default issues an error
-
-
message if the <span
class="cmss-10">see</span><a
- id="dx1-17019"></a> key is used before <span
+ id="dx1-23023"></a> key is used before <span
class="cmtt-10">\makeglossaries</span>. This option allows
you to change the error into just a warning (<span
class="cmss-10">seenoindex=warn</span><a
- id="dx1-17020"></a>) or ignore it
+ id="dx1-23024"></a>) or ignore it
(<span
class="cmss-10">seenoindex=ignore</span><a
- id="dx1-17021"></a>).
+ id="dx1-23025"></a>) if, for example, you want to temporarily comment out
+ <span
+class="cmtt-10">\makeglossaries </span>to speed up the compilation of a draft document by omitting the
+ indexing.
</dd><dt class="description">
<span
class="cmssbx-10">nomain</span><a
- id="dx1-17022"></a> </dt><dd
+ id="dx1-23026"></a> </dt><dd
class="description">This suppresses the creation of the main glossary and associated <span
class="cmtt-10">.glo </span>file, if
unrequired. Note that if you use this option, you must create another glossary in which
to put all your entries (either via the <span
class="cmss-10">acronym</span><a
- id="dx1-17023"></a> (or <span
+ id="dx1-23027"></a> (or <span
class="cmss-10">acronyms</span><a
- id="dx1-17024"></a>) package option described in
+ id="dx1-23028"></a>) package option described in
<a
href="#sec:pkgopts-acronym"><span
-class="cmsy-10">§</span>2.5 </a><a
+class="tcrm-1000">§</span>2.5 </a><a
href="#sec:pkgopts-acronym">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a> or via the <span
class="cmss-10">symbols</span><a
- id="dx1-17025"></a>, <span
+ id="dx1-23029"></a>, <span
class="cmss-10">numbers</span><a
- id="dx1-17026"></a> or <span
+ id="dx1-23030"></a> or <span
class="cmss-10">index</span><a
- id="dx1-17027"></a> options described
+ id="dx1-23031"></a> options described
in <a
href="#sec:pkgopts-other"><span
-class="cmsy-10">§</span>2.6 </a><a
+class="tcrm-1000">§</span>2.6 </a><a
href="#sec:pkgopts-other">Other Options<!--tex4ht:ref: sec:pkgopts-other --></a> or via <span
class="cmtt-10">\newglossary</span><a
- id="dx1-17028"></a> described in <a
+ id="dx1-23032"></a> described in <a
href="#sec:newglossary"><span
-class="cmsy-10">§</span>12 </a><a
+class="tcrm-1000">§</span>12 </a><a
href="#sec:newglossary">Defining New
Glossaries<!--tex4ht:ref: sec:newglossary --></a>).
- <!--l. 2622--><p class="noindent" ><div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a
+ <!--l. 3148--><p class="noindent" ><div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-17029"></a></a> will
- produce the following warning: </p><div class="alltt">
+ id="dx1-23033"></a></a> will
+ produce a warning. </div>
+ </p><!--l. 3151--><p class="noindent" >
+ </p><div class="alltt">
+
+
<div class="obeylines-v">
<span
class="cmtt-10">Warning:</span><span
@@ -5160,28 +6681,27 @@
class="cmtt-10"> main</span><span
class="cmtt-10"> glossary.</span>
</div>
- </div> If you did actually want to use the main glossary and you see this warning, check that
- you have referenced the entries in that glossary via commands such as <span
+ </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-17030"></a>.
- </div>
- <!--l. 2635--><p class="noindent" >
- </p></dd><dt class="description">
+ id="dx1-23034"></a>.
+ </dd><dt class="description">
<span
class="cmssbx-10">sanitizesort</span><a
- id="dx1-17031"></a> </dt><dd
+ id="dx1-23035"></a> </dt><dd
class="description">This is a boolean option that determines whether or not to <a
href="#glo:sanitize">sanitize<a
- id="dx1-17032"></a></a> the sort
+ id="dx1-23036"></a></a> the sort
value when writing to the external glossary file. For example, suppose you define an
entry as follows:
- <div class="verbatim" id="verbatim-34">
+ <div class="verbatim" id="verbatim-72">
\newglossaryentry{hash}{name={\#},sort={#},
 <br /> description={hash symbol}}
</div>
- <!--l. 2644--><p class="nopar" > The sort value (<span class="obeylines-h"><span class="verb"><span
+ <!--l. 3170--><p class="nopar" > The sort value (<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">#</span></span></span>) must be sanitized before writing it to the glossary file, otherwise
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> will try to interpret it as a parameter reference. If, on the other hand, you
@@ -5190,7 +6710,7 @@
</p>
- <div class="verbatim" id="verbatim-35">
+ <div class="verbatim" id="verbatim-73">
\newcommand{\mysortvalue}{AAA}
 <br />\newglossaryentry{sample}{%
 <br />  name={sample},
@@ -5197,68 +6717,71 @@
 <br />  sort={\mysortvalue},
 <br />  description={an example}}
</div>
- <!--l. 2656--><p class="nopar" > and you actually want <span
+ <!--l. 3182--><p class="nopar" > and you actually want <span
class="cmtt-10">\mysortvalue </span>expanded, so that the entry is sorted according
to <span
class="cmtt-10">AAA</span>, then use the package option <span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-17033"></a>.
- </p><!--l. 2661--><p class="noindent" >The default for Options <a
+ id="dx1-23037"></a>.
+ </p><!--l. 3187--><p class="noindent" >The default for Options <a
href="#option2">2</a> and <a
href="#option3">3</a> is <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-17034"></a>, and the default for <a
+ id="dx1-23038"></a>, and the default for <a
href="#option1">Option 1</a> is
<span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-17035"></a>.
+ id="dx1-23039"></a>.
</p></dd><dt class="description">
<span
class="cmssbx-10">savewrites</span><a
- id="dx1-17036"></a> </dt><dd
+ id="dx1-23040"></a> </dt><dd
class="description">This is a boolean option to minimise the number of write registers used by the
<span
class="cmss-10">glossaries </span>package. (Default is <span
class="cmss-10">savewrites=false</span><a
- id="dx1-17037"></a>.) There are only a limited number of
+ id="dx1-23041"></a>.) There are only a limited number of
write registers, and if you have a large number of glossaries or if you are using a class or
other packages that create a lot of external files, you may exceed the maximum number
of available registers. If <span
class="cmss-10">savewrites</span><a
- id="dx1-17038"></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. If you run out of token registers, you can use
+ id="dx1-23042"></a> is set, the glossary information will be stored in token
+ registers until the end of the document when they will be written to the external
+ files.
+ <!--l. 3200--><p class="noindent" ><div class="important" title="Important Note"> This option can significantly slow document compilation and may cause the indexing to
+ fail. Page numbers in the <a
+href="#glo:numberlist">number list<a
+ id="dx1-23043"></a></a> will be incorrect on page boundaries due
+ to <span class="TEX">T<span
+class="E">E</span>X</span>’s asynchronous output routine. As an alternative, you can use the
<span
-class="cmss-10">etex</span><a
- id="dx1-17039"></a>.
- <!--l. 2675--><p class="noindent" ><div class="important" title="Important Note"> This option can significantly slow document compilation. As an alternative, you can
- use the <span
class="cmss-10">scrwfile</span><a
- id="dx1-17040"></a> package (part of the KOMA-Script bundle) and not use this option.
+ id="dx1-23044"></a> package (part of the KOMA-Script bundle) and not use this option.
</div>
- </p><!--l. 2679--><p class="noindent" >
- </p><!--l. 2681--><p class="noindent" >You can also reduce the number of write registers by using <a
-href="#option1">Option 1</a> or by ensuring you
- define all your glossary entries in the preamble.
- </p><!--l. 2685--><p class="noindent" ><div class="important" title="Important Note"> If you want to use <span class="TEX">T<span
+ </p><!--l. 3206--><p class="noindent" >
+ </p><!--l. 3208--><p class="noindent" >You can also reduce the number of write registers by using Options <a
+href="#option1">1</a> or <a
+href="#option4">4</a> or by
+ ensuring you define all your glossary entries in the preamble.
+ </p><!--l. 3212--><p class="noindent" ><div class="important" title="Important Note"> If you want to use <span class="TEX">T<span
class="E">E</span>X</span>’s <span
class="cmtt-10">\write18</span><a
- id="dx1-17041"></a> mechanism to call <a
+ id="dx1-23045"></a> mechanism to call <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-17042"></a></a> or <a
+ id="dx1-23046"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-17043"></a></a> from
+ id="dx1-23047"></a></a> from
your document and use <span
class="cmss-10">savewrites</span><a
- id="dx1-17044"></a>, you must create the external files with
+ id="dx1-23048"></a>, you must create the external files with
<span
class="cmtt-10">\glswritefiles </span>before you call <span
class="cmtt-10">makeindex</span><a
- id="dx1-17045"></a>/<span
+ id="dx1-23049"></a>/<span
class="cmtt-10">xindy</span><a
- id="dx1-17046"></a>. Also set <span
+ id="dx1-23050"></a>. Also set <span
class="cmtt-10">\glswritefiles </span>to
nothing or <span
class="cmtt-10">\relax </span>before the end of the document to avoid rewriting the files. For
@@ -5266,111 +6789,112 @@
</p>
- <div class="verbatim" id="verbatim-36">
+ <div class="verbatim" id="verbatim-74">
\glswritefiles
 <br />\write18{makeindex -s \istfilename\space
 <br />-t \jobname.glg -o \jobname.gls \jobname}
 <br />\let\glswritefiles\relax
</div>
- <!--l. 2697--><p class="nopar" > </div>
- </p><!--l. 2698--><p class="noindent" >
+ <!--l. 3224--><p class="nopar" > </div>
+ </p><!--l. 3225--><p class="noindent" >
+ In general, this package option is best avoided.
</p></dd><dt class="description">
<span
class="cmssbx-10">translate</span><a
- id="dx1-17047"></a> </dt><dd
+ id="dx1-23051"></a> </dt><dd
class="description">This can take the following values:
<dl class="description"><dt class="description">
<span
class="cmssbx-10">translate=true</span><a
- id="dx1-17048"></a> </dt><dd
+ id="dx1-23052"></a> </dt><dd
class="description">If <span
class="cmss-10">babel</span><a
- id="dx1-17049"></a> has been loaded and the <span
+ id="dx1-23053"></a> has been loaded and the <span
class="cmss-10">translator</span><a
- id="dx1-17050"></a> package is installed,
+ id="dx1-23054"></a> package is installed,
<span
class="cmss-10">translator</span><a
- id="dx1-17051"></a> will be loaded and the translations will be provided by the <span
+ id="dx1-23055"></a> will be loaded and the translations will be provided by the <span
class="cmss-10">translator</span><a
- id="dx1-17052"></a>
+ id="dx1-23056"></a>
package interface. You can modify the translations by providing your own
dictionary. If the <span
class="cmss-10">translator</span><a
- id="dx1-17053"></a> package isn’t installed and <span
+ id="dx1-23057"></a> package isn’t installed and <span
class="cmss-10">babel</span><a
- id="dx1-17054"></a> is loaded, the
+ id="dx1-23058"></a> is loaded, the
<span
class="cmss-10">glossaries-babel</span><a
- id="dx1-17055"></a> package will be loaded and the translations will be provided
+ id="dx1-23059"></a> package will be loaded and the translations will be provided
using <span
class="cmss-10">babel</span>’s <span
class="cmtt-10">\addto\caption</span>⟨<span
class="cmti-10">language</span>⟩ mechanism. If <span
class="cmss-10">polyglossia</span><a
- id="dx1-17056"></a> has been
+ id="dx1-23060"></a> has been
loaded, <span
class="cmss-10">glossaries-polyglossia</span><a
- id="dx1-17057"></a> will be loaded.
+ id="dx1-23061"></a> will be loaded.
</dd><dt class="description">
<span
class="cmssbx-10">translate=false</span><a
- id="dx1-17058"></a> </dt><dd
+ id="dx1-23062"></a> </dt><dd
class="description">Don’t provide translations, even if <span
class="cmss-10">babel</span><a
- id="dx1-17059"></a> or <span
+ id="dx1-23063"></a> or <span
class="cmss-10">polyglossia</span><a
- id="dx1-17060"></a> has been
+ id="dx1-23064"></a> has been
loaded. (Note that <span
class="cmss-10">babel</span><a
- id="dx1-17061"></a> provides the command <span
+ id="dx1-23065"></a> provides the command <span
class="cmtt-10">\glossaryname</span><a
- id="dx1-17062"></a> so that will
+ id="dx1-23066"></a> so that will
still be translated if you have loaded <span
class="cmss-10">babel</span><a
- id="dx1-17063"></a>.)
+ id="dx1-23067"></a>.)
</dd><dt class="description">
<span
class="cmssbx-10">translate=babel</span><a
- id="dx1-17064"></a> </dt><dd
+ id="dx1-23068"></a> </dt><dd
class="description">Don’t load the <span
class="cmss-10">translator</span><a
- id="dx1-17065"></a> package. Instead load <span
+ id="dx1-23069"></a> package. Instead load <span
class="cmss-10">glossaries-babel</span><a
- id="dx1-17066"></a>.
- <!--l. 2723--><p class="noindent" ><div class="important" title="Important Note"> I recommend you use <span
+ id="dx1-23070"></a>.
+ <!--l. 3251--><p class="noindent" ><div class="important" title="Important Note"> I recommend you use <span
class="cmss-10">translate=babel</span><a
- id="dx1-17067"></a> if you have any problems with the
+ id="dx1-23071"></a> if you have any problems with the
translations or with PDF bookmarks, but to maintain backward compatibility, if
<span
class="cmss-10">babel</span><a
- id="dx1-17068"></a> has been loaded the default is <span
+ id="dx1-23072"></a> has been loaded the default is <span
class="cmss-10">translate=true</span><a
- id="dx1-17069"></a>. </div>
- </p><!--l. 2728--><p class="noindent" >
+ id="dx1-23073"></a>. </div>
+ </p><!--l. 3256--><p class="noindent" >
</p>
</dd></dl>
- <!--l. 2732--><p class="noindent" >If <span
+ <!--l. 3260--><p class="noindent" >If <span
class="cmss-10">translate</span><a
- id="dx1-17070"></a> is specified without a value, <span
+ id="dx1-23074"></a> is specified without a value, <span
class="cmss-10">translate=true</span><a
- id="dx1-17071"></a> is assumed. If <span
+ id="dx1-23075"></a> is assumed. If <span
class="cmss-10">translate</span><a
- id="dx1-17072"></a> isn’t
+ id="dx1-23076"></a> isn’t
specified, <span
class="cmss-10">translate=true</span><a
- id="dx1-17073"></a> is assumed if <span
+ id="dx1-23077"></a> is assumed if <span
class="cmss-10">babel</span><a
- id="dx1-17074"></a>, <span
+ id="dx1-23078"></a>, <span
class="cmss-10">polyglossia</span><a
- id="dx1-17075"></a> or <span
+ id="dx1-23079"></a> or <span
class="cmss-10">translator</span><a
- id="dx1-17076"></a> have been loaded.
+ id="dx1-23080"></a> have been loaded.
Otherwise <span
class="cmss-10">translate=false</span><a
- id="dx1-17077"></a> is assumed.
- </p><!--l. 2738--><p class="noindent" >See <a
+ id="dx1-23081"></a> is assumed.
+ </p><!--l. 3266--><p class="noindent" >See <a
href="#sec:fixednames"><span
-class="cmsy-10">§</span>1.3.1 </a><a
+class="tcrm-1000">§</span>1.4.1 </a><a
href="#sec:fixednames">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details.
@@ -5377,99 +6901,99 @@
</p></dd><dt class="description">
<span
class="cmssbx-10">notranslate</span><a
- id="dx1-17078"></a> </dt><dd
+ id="dx1-23082"></a> </dt><dd
class="description">This is equivalent to <span
class="cmss-10">translate=false</span><a
- id="dx1-17079"></a> and may be passed via the document class
+ id="dx1-23083"></a> and may be passed via the document class
options.
</dd><dt class="description">
<span
class="cmssbx-10">nohypertypes</span><a
- id="dx1-17080"></a> </dt><dd
+ id="dx1-23084"></a> </dt><dd
class="description">Use this option if you have multiple glossaries and you want to suppress the
entry hyperlinks for a particular glossary or glossaries. The value of this option should
be a comma-separated list of glossary types where <span
class="cmtt-10">\gls</span><a
- id="dx1-17081"></a> etc shouldn’t have hyperlinks
+ id="dx1-23085"></a> etc shouldn’t have hyperlinks
by default. Make sure you enclose the value in braces if it contains any commas.
Example:
- <div class="verbatim" id="verbatim-37">
+ <div class="verbatim" id="verbatim-75">
\usepackage[acronym,nohypertypes={acronym,notation}]
 <br />  {glossaries}
 <br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
- <!--l. 2754--><p class="nopar" > The values must be fully expanded, so <span
+ <!--l. 3282--><p class="nopar" > The values must be fully expanded, so <span
class="cmbx-10">don’t </span>try <span
class="cmtt-10">nohypertypes=\acronymtype</span><a
- id="dx1-17082"></a>. You
+ id="dx1-23086"></a>. You
may also use
- </p><!--l. 2758--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 3286--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-17083"></a><span
+ id="dx1-23087"></a><span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 2759--><p class="noindent" >
+ </p><!--l. 3287--><p class="noindent" >
instead or additionally. See <a
href="#sec:glslink"><span
-class="cmsy-10">§</span>6 </a><a
+class="tcrm-1000">§</span>6 </a><a
href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details.
</p></dd><dt class="description">
<span
class="cmssbx-10">hyperfirst</span><a
- id="dx1-17084"></a> </dt><dd
+ id="dx1-23088"></a> </dt><dd
class="description">This is a boolean option that specifies whether each term has a hyperlink on <a
href="#glo:firstuse">first
use</a>. The default is <span
class="cmss-10">hyperfirst=true</span><a
- id="dx1-17085"></a> (terms on <a
+ id="dx1-23089"></a> (terms on <a
href="#glo:firstuse">first use</a> have a hyperlink, unless
explicitly suppressed using starred versions of commands such as <span
class="cmtt-10">\gls*</span><a
- id="dx1-17086"></a> or
+ id="dx1-23090"></a> or
by identifying the glossary with <span
class="cmss-10">nohypertypes</span><a
- id="dx1-17087"></a>, described above). Note that
+ id="dx1-23091"></a>, described above). Note that
<span
class="cmss-10">nohypertypes</span><a
- id="dx1-17088"></a> overrides <span
+ id="dx1-23092"></a> overrides <span
class="cmss-10">hyperfirst=true</span><a
- id="dx1-17089"></a>. This option only affects commands that
+ id="dx1-23093"></a>. This option only affects commands that
check the <a
href="#glo:firstuseflag">first use flag</a>, such as the <a
href="#sec:gls-like"><span
class="cmtt-10">\gls</span>-like</a> commands (for example, <span
class="cmtt-10">\gls</span><a
- id="dx1-17090"></a> or
+ id="dx1-23094"></a> or
<span
class="cmtt-10">\glsdisp</span><a
- id="dx1-17091"></a>), but not the <a
+ id="dx1-23095"></a>), but not the <a
href="#sec:glstext-like"><span
class="cmtt-10">\glstext</span>-like</a> commands (for example, <span
class="cmtt-10">\glslink</span><a
- id="dx1-17092"></a> or
+ id="dx1-23096"></a> or
<span
class="cmtt-10">\glstext</span><a
- id="dx1-17093"></a>).
- <!--l. 2775--><p class="noindent" >The <span
+ id="dx1-23097"></a>).
+ <!--l. 3303--><p class="noindent" >The <span
class="cmss-10">hyperfirst</span><a
- id="dx1-17094"></a> setting applies to all glossary types (unless identified by <span
+ id="dx1-23098"></a> setting applies to all glossary types (unless identified by <span
class="cmss-10">nohypertypes</span><a
- id="dx1-17095"></a> or
+ id="dx1-23099"></a> or
defined with <span
class="cmtt-10">\newignoredglossary</span><a
- id="dx1-17096"></a>). It can be overridden on an individual basis by
+ id="dx1-23100"></a>). It can be overridden on an individual basis by
explicitly setting the <span
class="cmss-10">hyper</span><a
- id="dx1-17097"></a> key when referencing an entry (or by using the plus or
+ id="dx1-23101"></a> key when referencing an entry (or by using the plus or
starred version of the referencing command).
- </p><!--l. 2782--><p class="noindent" >It may be that you only want to apply this to just the acronyms (where the first use
+ </p><!--l. 3310--><p class="noindent" >It may be that you only want to apply this to just the acronyms (where the first use
explains the meaning of the acronym) but not for ordinary glossary entries (where the
first use is identical to subsequent uses). In this case, you can use <span
class="cmss-10">hyperfirst=false</span><a
- id="dx1-17098"></a>
+ id="dx1-23102"></a>
and apply <span
class="cmtt-10">\glsunsetall </span>to all the regular (non-acronym) glossaries. For
example:
@@ -5476,43 +7000,43 @@
</p>
- <div class="verbatim" id="verbatim-38">
+ <div class="verbatim" id="verbatim-76">
 \usepackage[acronym,hyperfirst=false]{glossaries}
 <br /> % acronym and glossary entry definitions
 <br /> % at the end of the preamble
 <br /> \glsunsetall[main]
</div>
- <!--l. 2794--><p class="nopar" >
- </p><!--l. 2796--><p class="noindent" >Alternatively you can redefine the hook
- </p><!--l. 2797--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3322--><p class="nopar" >
+ </p><!--l. 3324--><p class="noindent" >Alternatively you can redefine the hook
+ </p><!--l. 3325--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glslinkcheckfirsthyperhook</span><span
class="cmtt-9"> </span></span><a
- id="dx1-17099"></a> <span
+ id="dx1-23103"></a> <span
class="cmtt-10">\glslinkcheckfirsthyperhook </span></div><hr>
- </p><!--l. 2799--><p class="noindent" >
+ </p><!--l. 3327--><p class="noindent" >
which is used by the commands that check the <a
href="#glo:firstuseflag">first use flag</a>, such as <span
class="cmtt-10">\gls</span><a
- id="dx1-17100"></a>. Within the
+ id="dx1-23104"></a>. Within the
definition of this command, you can use <span
class="cmtt-10">\glslabel</span><a
- id="dx1-17101"></a> to reference the entry label and
+ id="dx1-23105"></a> to reference the entry label and
<span
class="cmtt-10">\glstype</span><a
- id="dx1-17102"></a> to reference the glossary type. You can also use <span
+ id="dx1-23106"></a> to reference the glossary type. You can also use <span
class="cmtt-10">\ifglsused</span><a
- id="dx1-17103"></a> to determine if
+ id="dx1-23107"></a> to determine if
the entry has been used. You can test if an entry is an acronym by checking if it has the
<span
class="cmss-10">long</span><a
- id="dx1-17104"></a> key set using <span
+ id="dx1-23108"></a> key set using <span
class="cmtt-10">\ifglshaslong</span><a
- id="dx1-17105"></a>. For example, to switch off the hyperlink on first use
+ id="dx1-23109"></a>. For example, to switch off the hyperlink on first use
just for acronyms:
</p>
- <div class="verbatim" id="verbatim-39">
+ <div class="verbatim" id="verbatim-77">
\renewcommand*{\glslinkcheckfirsthyperhook}{%
 <br /> \ifglsused{\glslabel}{}%
 <br /> {%
@@ -5520,14 +7044,14 @@
 <br /> }%
 <br />}
</div>
- <!--l. 2815--><p class="nopar" >
- </p><!--l. 2817--><p class="noindent" >Note that this hook isn’t used by the commands that don’t check the <a
+ <!--l. 3343--><p class="nopar" >
+ </p><!--l. 3345--><p class="noindent" >Note that this hook isn’t used by the commands that don’t check the <a
href="#glo:firstuseflag">first use flag</a>, such
as <span
class="cmtt-10">\glstext</span><a
- id="dx1-17106"></a>. (You can, instead, redefine <span
+ id="dx1-23110"></a>. (You can, instead, redefine <span
class="cmtt-10">\glslinkpostsetkeys</span><a
- id="dx1-17107"></a>, which is used by both
+ id="dx1-23111"></a>, which is used by both
the <a
href="#sec:gls-like"><span
class="cmtt-10">\gls</span>-like</a> and <a
@@ -5536,12 +7060,12 @@
</p></dd><dt class="description">
<span
class="cmssbx-10">indexonlyfirst</span><a
- id="dx1-17108"></a> </dt><dd
+ id="dx1-23112"></a> </dt><dd
class="description">This is a boolean option that specifies whether to only add information to the
external glossary file on <a
href="#glo:firstuse">first use</a>. The default is <span
class="cmss-10">indexonlyfirst=false</span><a
- id="dx1-17109"></a>, which will add a
+ id="dx1-23113"></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
@@ -5549,22 +7073,22 @@
class="cmtt-10">\glstext</span>-like</a> commands are
used. Note that <span
class="cmtt-10">\glsadd</span><a
- id="dx1-17110"></a> will always add information to the external glossary
+ id="dx1-23114"></a> will always add information to the external glossary
file<span class="footnote-mark"><a
href="#fn1x2" id="fn1x2-bk"><sup class="textsuperscript">2.1</sup></a></span><a
- id="x1-17111f1"></a> (since
+ id="x1-23115f1"></a> (since
that’s the purpose of that command).
- <!--l. 2831--><p class="noindent" >You can customise this by redefining
- </p><!--l. 2832--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3359--><p class="noindent" >You can customise this by redefining
+ </p><!--l. 3360--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glswriteentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-17112"></a> <span
+ id="dx1-23116"></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. 2834--><p class="noindent" >
+ </p><!--l. 3362--><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
@@ -5574,7 +7098,7 @@
</p>
- <div class="verbatim" id="verbatim-40">
+ <div class="verbatim" id="verbatim-78">
\newcommand*{\glswriteentry}[2]{%
 <br />  \ifglsindexonlyfirst
 <br />    \ifglsused{#1}{}{#2}%
@@ -5583,9 +7107,9 @@
 <br />  \fi
 <br />}
</div>
- <!--l. 2846--><p class="nopar" > This checks the <span
+ <!--l. 3374--><p class="nopar" > This checks the <span
class="cmss-10">indexonlyfirst</span><a
- id="dx1-17113"></a> package option (using <span
+ id="dx1-23117"></a> package option (using <span
class="cmtt-10">\ifglsindexonlyfirst</span>) and does
⟨<span
class="cmti-10">wr-code</span>⟩ if this is <span
@@ -5592,7 +7116,7 @@
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. 2852--><p class="noindent" >For example, suppose you only want to index the first use for entries in the <span
+ </p><!--l. 3380--><p class="noindent" >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:
@@ -5599,7 +7123,7 @@
</p>
- <div class="verbatim" id="verbatim-41">
+ <div class="verbatim" id="verbatim-79">
\renewcommand*{\glswriteentry}[2]{%
 <br /> \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}
 <br /> {\ifglsused{#1}{}{#2}}%
@@ -5606,7 +7130,7 @@
 <br /> {#2}%
 <br />}
</div>
- <!--l. 2861--><p class="nopar" > Here I’ve used <span
+ <!--l. 3389--><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.
@@ -5613,71 +7137,71 @@
</p></dd><dt class="description">
<span
class="cmssbx-10">savenumberlist</span><a
- id="dx1-17114"></a> </dt><dd
+ id="dx1-23118"></a> </dt><dd
class="description">This is a boolean option that specifies whether or not to gather and
store the <a
href="#glo:numberlist">number list<a
- id="dx1-17115"></a></a> for each entry. The default is <span
+ id="dx1-23119"></a></a> for each entry. The default is <span
class="cmss-10">savenumberlist=false</span><a
- id="dx1-17116"></a>. (See
+ id="dx1-23120"></a>. (See
<span
class="cmtt-10">\glsentrynumberlist</span><a
- id="dx1-17117"></a> and <span
+ id="dx1-23121"></a> and <span
class="cmtt-10">\glsdisplaynumberlist</span><a
- id="dx1-17118"></a> in <a
+ id="dx1-23122"></a> in <a
href="#sec:glsnolink"><span
-class="cmsy-10">§</span>9 </a><a
+class="tcrm-1000">§</span>9 </a><a
href="#sec:glsnolink">Using Glossary Terms
Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) This is always true if you use <a
href="#option1">Option 1</a>.
</dd></dl>
-<!--l. 2874--><p class="noindent" >
+<!--l. 3402--><p class="noindent" >
</p>
-<!--l. 2874--><p class="noindent" ><a
+<!--l. 3402--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.2 </span> <a
id="sec:pkgopts-sec"></a>Sectioning, Headings and TOC Options</h3>
<dl class="description"><dt class="description">
<span
class="cmssbx-10">toc</span><a
- id="dx1-18001"></a> </dt><dd
+ id="dx1-24001"></a> </dt><dd
class="description">Add the glossaries to the table of contents. Note that an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run is
required with this option. Alternatively, you can switch this function on and off
using
- <!--l. 2881--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3409--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glstoctrue</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18002"></a> <span
+ id="dx1-24002"></a> <span
class="cmtt-10">\glstoctrue </span></div><hr>
- </p><!--l. 2883--><p class="noindent" >
+ </p><!--l. 3411--><p class="noindent" >
and
- </p><!--l. 2885--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3413--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glstocfalse</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18003"></a> <span
+ id="dx1-24003"></a> <span
class="cmtt-10">\glstocfalse </span></div><hr>
- </p><!--l. 2887--><p class="noindent" >
+ </p><!--l. 3415--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">numberline</span><a
- id="dx1-18004"></a> </dt><dd
+ id="dx1-24004"></a> </dt><dd
class="description">When used with <span
class="cmss-10">toc</span><a
- id="dx1-18005"></a>, this will add <span
+ id="dx1-24005"></a>, this will add <span
class="cmtt-10">\numberline</span><a
- id="dx1-18006"></a><span class="obeylines-h"><span class="verb"><span
+ id="dx1-24006"></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-18007"></a>. This will align the table of contents entry with the numbered
+ id="dx1-24007"></a>. This will align the table of contents entry with the numbered
section titles. Note that this option has no effect if the <span
class="cmss-10">toc</span><a
- id="dx1-18008"></a> option is omitted. If <span
+ id="dx1-24008"></a> option is omitted. If <span
class="cmss-10">toc</span><a
- id="dx1-18009"></a> is
+ id="dx1-24009"></a> is
used without <span
class="cmss-10">numberline</span><a
- id="dx1-18010"></a>, the title will be aligned with the section numbers rather than
+ id="dx1-24010"></a>, the title will be aligned with the section numbers rather than
the section titles.
@@ -5684,7 +7208,7 @@
</dd><dt class="description">
<span
class="cmssbx-10">section</span><a
- id="dx1-18011"></a> </dt><dd
+ id="dx1-24011"></a> </dt><dd
class="description">This is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ option. Its value should be the name of a sectional unit
@@ -5693,117 +7217,117 @@
Unnumbered sectional units will be used by default. Example:
- <div class="verbatim" id="verbatim-42">
+ <div class="verbatim" id="verbatim-80">
\usepackage[section=subsection]{glossaries}
</div>
- <!--l. 2905--><p class="nopar" > You can omit the value if you want to use sections, i.e. 
+ <!--l. 3433--><p class="nopar" > You can omit the value if you want to use sections, i.e. 
</p>
- <div class="verbatim" id="verbatim-43">
+ <div class="verbatim" id="verbatim-81">
\usepackage[section]{glossaries}
</div>
- <!--l. 2909--><p class="nopar" > is equivalent to
+ <!--l. 3437--><p class="nopar" > is equivalent to
</p>
- <div class="verbatim" id="verbatim-44">
+ <div class="verbatim" id="verbatim-82">
\usepackage[section=section]{glossaries}
</div>
- <!--l. 2913--><p class="nopar" > You can change this value later in the document using
- </p><!--l. 2915--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3441--><p class="nopar" > You can change this value later in the document using
+ </p><!--l. 3443--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\setglossarysection</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18012"></a> <span
+ id="dx1-24012"></a> <span
class="cmtt-10">\setglossarysection{</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 2917--><p class="noindent" >
+ </p><!--l. 3445--><p class="noindent" >
where ⟨<span
class="cmti-10">name</span>⟩ is the sectional unit.
- </p><!--l. 2920--><p class="noindent" >The start of each glossary adds information to the page header via
- </p><!--l. 2921--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3448--><p class="noindent" >The start of each glossary adds information to the page header via
+ </p><!--l. 3449--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsglossarymark</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18013"></a> <span
+ id="dx1-24013"></a> <span
class="cmtt-10">\glsglossarymark{</span>⟨<span
class="cmitt-10">glossary title</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 2923--><p class="noindent" >
+ </p><!--l. 3451--><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-18014f2"></a>
+ id="x1-24014f2"></a>
but you may need to redefine it. For example, to only change the right header:
</p>
- <div class="verbatim" id="verbatim-45">
+ <div class="verbatim" id="verbatim-83">
\renewcommand{\glsglossarymark}[1]{\markright{#1}}
</div>
- <!--l. 2930--><p class="nopar" > or to prevent it from changing the headers:
+ <!--l. 3458--><p class="nopar" > or to prevent it from changing the headers:
</p>
- <div class="verbatim" id="verbatim-46">
+ <div class="verbatim" id="verbatim-84">
\renewcommand{\glsglossarymark}[1]{}
</div>
- <!--l. 2934--><p class="nopar" > If you want <span
+ <!--l. 3462--><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-18017"></a>
+ id="dx1-24017"></a>
option described below.
- </p><!--l. 2938--><p class="noindent" >Occasionally you may find that another package defines <span
+ </p><!--l. 3466--><p class="noindent" >Occasionally you may find that another package defines <span
class="cmtt-10">\cleardoublepage </span>when it is
not required. This may cause an unwanted blank page to appear before each glossary.
This can be fixed by redefining <span class="marginpar"><span
class="cmtt-9">\glsclearpage</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18018"></a><span
+ id="dx1-24018"></a><span
class="cmtt-10">\glsclearpage</span>:
</p>
- <div class="verbatim" id="verbatim-47">
+ <div class="verbatim" id="verbatim-85">
\renewcommand*{\glsclearpage}{\clearpage}
</div>
- <!--l. 2944--><p class="nopar" >
+ <!--l. 3472--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">ucmark</span><a
- id="dx1-18019"></a> </dt><dd
+ id="dx1-24019"></a> </dt><dd
class="description">This is a boolean option (default: <span
class="cmss-10">ucmark=false</span><a
- id="dx1-18020"></a>, unless <span
+ id="dx1-24020"></a>, unless <span
class="cmss-10">memoir</span><a
- id="dx1-18021"></a> has been loaded,
+ id="dx1-24021"></a> has been loaded,
in which case it defaults to <span
class="cmss-10">ucmark=true</span><a
- id="dx1-18022"></a>). If set, <span
+ id="dx1-24022"></a>). If set, <span
class="cmtt-10">\glsglossarymark</span><a
- id="dx1-18023"></a> uses
+ id="dx1-24023"></a> uses
<span
class="cmtt-10">\MakeTextUppercase</span><a
- id="dx1-18024"></a><span class="footnote-mark"><a
+ id="dx1-24024"></a><span class="footnote-mark"><a
href="#fn3x2" id="fn3x2-bk"><sup class="textsuperscript">2.3</sup></a></span><a
- id="x1-18025f3"></a>.
+ id="x1-24025f3"></a>.
You can test whether this option has been set or not using
- <!--l. 2957--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 3485--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\ifglsucmark</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18030"></a> <span
+ id="dx1-24030"></a> <span
class="cmtt-10">\ifglsucmark </span>⟨<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. 2959--><p class="noindent" >
+ </p><!--l. 3487--><p class="noindent" >
For example:
</p>
- <div class="verbatim" id="verbatim-48">
+ <div class="verbatim" id="verbatim-86">
\renewcommand{\glsglossarymark}[1]{%
 <br />  \ifglsucmark
 <br />    \markright{\MakeTextUppercase{#1}}%
@@ -5811,29 +7335,29 @@
 <br />    \markright{#1}%
 <br />  \fi}
</div>
- <!--l. 2968--><p class="nopar" > If <span
+ <!--l. 3496--><p class="nopar" > If <span
class="cmss-10">memoir</span><a
- id="dx1-18031"></a> has been loaded and <span
+ id="dx1-24031"></a> has been loaded and <span
class="cmss-10">ucfirst</span><a
- id="dx1-18032"></a> is set, then <span
+ id="dx1-24032"></a> is set, then <span
class="cmss-10">memoir</span><a
- id="dx1-18033"></a>’s <span
+ id="dx1-24033"></a>’s <span
class="cmtt-10">\memUChead</span><a
- id="dx1-18034"></a> is
+ id="dx1-24034"></a> is
used.
</p></dd><dt class="description">
<span
class="cmssbx-10">numberedsection</span><a
- id="dx1-18035"></a> </dt><dd
+ id="dx1-24035"></a> </dt><dd
class="description">The glossaries are placed in unnumbered sectional units by default, but
this can be changed using <span
class="cmss-10">numberedsection</span><a
- id="dx1-18036"></a>. This option can take one of the following
+ id="dx1-24036"></a>. This option can take one of the following
values:
<ul class="itemize1">
<li class="itemize"><span
class="cmss-10">false</span><a
- id="dx1-18037"></a>:
+ id="dx1-24037"></a>:
no number, i.e. use starred form of sectioning command (e.g. <span
class="cmtt-10">\chapter* </span>or
<span
@@ -5841,7 +7365,7 @@
</li>
<li class="itemize"><span
class="cmss-10">nolabel</span><a
- id="dx1-18038"></a>: use a numbered section, i.e. the unstarred form of sectioning
+ id="dx1-24038"></a>: use a numbered section, i.e. the unstarred form of sectioning
command (e.g. <span
class="cmtt-10">\chapter </span>or <span
class="cmtt-10">\section</span>), but the section not labelled;
@@ -5848,20 +7372,20 @@
</li>
<li class="itemize"><span
class="cmss-10">autolabel</span><a
- id="dx1-18039"></a>: numbered with automatic labelling. Each glossary uses the unstarred
+ id="dx1-24039"></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-18040"></a>). The label is formed from
- <!--l. 2989--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-24040"></a>). The label is formed from
+ <!--l. 3517--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsautoprefix</span><span
class="cmtt-9"> </span></span><a
- id="dx1-18041"></a> <span
+ id="dx1-24041"></a> <span
class="cmtt-10">\glsautoprefix </span>⟨<span
class="cmitt-10">type</span>⟩ </div><hr>
- </p><!--l. 2991--><p class="noindent" >
+ </p><!--l. 3519--><p class="noindent" >
where ⟨<span
class="cmti-10">type</span>⟩ is the label identifying that glossary. The default value of
<span
@@ -5870,85 +7394,85 @@
</p>
- <div class="verbatim" id="verbatim-49">
+ <div class="verbatim" id="verbatim-87">
\usepackage[section,numberedsection=autolabel]
 <br />  {glossaries}
</div>
- <!--l. 2999--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using
+ <!--l. 3527--><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-50">
+ <div class="verbatim" id="verbatim-88">
The main glossary is in section~\ref{main} and
 <br />the list of acronyms is in section~\ref{acronym}.
</div>
- <!--l. 3005--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a
+ <!--l. 3533--><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-18042"></a> which is set to <span
+ id="dx1-24042"></a> which is set to <span
class="cmtt-10">main </span>if the
<span
class="cmss-10">acronym</span><a
- id="dx1-18043"></a> option is not used and is set to <span
+ id="dx1-24043"></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-18044"></a> option is used. For
+ id="dx1-24044"></a> option is used. For
example:
</p>
- <div class="verbatim" id="verbatim-51">
+ <div class="verbatim" id="verbatim-89">
The list of acronyms is in section~\ref{\acronymtype}.
</div>
- <!--l. 3013--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your
+ <!--l. 3541--><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-52">
+ <div class="verbatim" id="verbatim-90">
\renewcommand*{\glsautoprefix}{glo:}
</div>
- <!--l. 3019--><p class="nopar" > will add <span
+ <!--l. 3547--><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-53">
+ <div class="verbatim" id="verbatim-91">
The list of acronyms is in
 <br />section~\ref{glo:\acronymtype}.
</div>
- <!--l. 3025--><p class="nopar" > Or, if you are undecided on a prefix:
+ <!--l. 3553--><p class="nopar" > Or, if you are undecided on a prefix:
</p>
- <div class="verbatim" id="verbatim-54">
+ <div class="verbatim" id="verbatim-92">
The list of acronyms is in
 <br />section~\ref{\glsautoprefix\acronymtype}.
</div>
- <!--l. 3030--><p class="nopar" >
+ <!--l. 3558--><p class="nopar" >
</p></li>
<li class="itemize"><span
class="cmss-10">nameref</span><a
- id="dx1-18045"></a>: this is like <span
+ id="dx1-24045"></a>: this is like <span
class="cmss-10">autolabel</span><a
- id="dx1-18046"></a> but uses an unnumbered sectioning command
+ id="dx1-24046"></a> but uses an unnumbered sectioning command
(e.g. <span
class="cmtt-10">\chapter*</span><a
- id="dx1-18047"></a> or <span
+ id="dx1-24047"></a> or <span
class="cmtt-10">\section*</span><a
- id="dx1-18048"></a>). It’s designed for use with the <span
+ id="dx1-24048"></a>). It’s designed for use with the <span
class="cmss-10">nameref</span><a
- id="dx1-18049"></a> package.
+ id="dx1-24049"></a> package.
For example:
- <div class="verbatim" id="verbatim-55">
+ <div class="verbatim" id="verbatim-93">
\usepackage{nameref}
 <br />\usepackage[numberedsection=nameref]{glossaries}
</div>
- <!--l. 3039--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span
+ <!--l. 3567--><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
@@ -5955,56 +7479,56 @@
class="cmtt-10">\glsautoprefix </span>to provide a prefix for
the label.</p></li></ul>
</dd></dl>
-<!--l. 3047--><p class="noindent" >
+<!--l. 3575--><p class="noindent" >
</p>
-<!--l. 3047--><p class="noindent" ><a
+<!--l. 3575--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.3 </span> <a
id="sec:pkgopts-printglos"></a>Glossary Appearance Options</h3>
<dl class="description"><dt class="description">
<span
class="cmssbx-10">entrycounter</span><a
- id="dx1-19001"></a> </dt><dd
+ id="dx1-25001"></a> </dt><dd
class="description">This is a boolean option. (Default is <span
class="cmss-10">entrycounter=false</span><a
- id="dx1-19002"></a>.) If set, each main
+ id="dx1-25002"></a>.) If set, each main
(level 0) glossary entry will be numbered when using the standard glossary styles.
This option creates the counter <span class="marginpar"><span
class="cmtt-9">glossaryentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-19003"></a><a
- id="dx1-19004"></a><span
+ id="dx1-25003"></a><a
+ id="dx1-25004"></a><span
class="cmss-10">glossaryentry</span>.
- <!--l. 3057--><p class="noindent" >If you use this option, you can reference the entry number within the document
+ <!--l. 3585--><p class="noindent" >If you use this option, you can reference the entry number within the document
using
- </p><!--l. 3059--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3587--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsrefentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-19005"></a> <span
+ id="dx1-25005"></a> <span
class="cmtt-10">\glsrefentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 3061--><p class="noindent" >
+ </p><!--l. 3589--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is the label associated with that glossary entry.
- </p><!--l. 3064--><p class="noindent" ><div class="important" title="Important Note"> If you use <span
+ </p><!--l. 3592--><p class="noindent" ><div class="important" title="Important Note"> If you use <span
class="cmtt-10">\glsrefentry</span>, you must run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> twice after creating the glossary files
using <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-19006"></a></a>, <a
+ id="dx1-25006"></a></a>, <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-19007"></a></a> or <a
+ id="dx1-25007"></a></a> or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-19008"></a></a> to ensure the cross-references are
+ id="dx1-25008"></a></a> to ensure the cross-references are
up-to-date. </div>
- </p><!--l. 3069--><p class="noindent" >
+ </p><!--l. 3597--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">counterwithin</span><a
- id="dx1-19009"></a> </dt><dd
+ id="dx1-25009"></a> </dt><dd
class="description">This is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ option where ⟨<span
@@ -6011,50 +7535,50 @@
class="cmti-10">value</span>⟩ is the name of a counter. If used, this
option will automatically set <span
class="cmss-10">entrycounter=true</span><a
- id="dx1-19010"></a> and the <span
+ id="dx1-25010"></a> and the <span
class="cmss-10">glossaryentry</span><a
- id="dx1-19011"></a> counter will be
+ id="dx1-25011"></a> counter will be
reset every time ⟨<span
class="cmti-10">value</span>⟩ is incremented.
- <!--l. 3078--><p class="noindent" ><div class="important" title="Important Note"> The <span
+ <!--l. 3606--><p class="noindent" ><div class="important" title="Important Note"> The <span
class="cmss-10">glossaryentry</span><a
- id="dx1-19012"></a> counter isn’t automatically reset at the start of each glossary, except
+ id="dx1-25012"></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-19013"></a> is the
+ id="dx1-25013"></a> is the
same as the counter used in the glossary’s sectioning command. </div>
- </p><!--l. 3083--><p class="noindent" >
- </p><!--l. 3085--><p class="noindent" >If you want the counter reset at the start of each glossary, you can redefine
+ </p><!--l. 3611--><p class="noindent" >
+ </p><!--l. 3613--><p class="noindent" >If you want the counter reset at the start of each glossary, you can redefine
<span
class="cmtt-10">\glossarypreamble</span><a
- id="dx1-19014"></a> to use
+ id="dx1-25014"></a> to use
- </p><!--l. 3087--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3615--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsresetentrycounter</span><span
class="cmtt-9"> </span></span><a
- id="dx1-19015"></a> <span
+ id="dx1-25015"></a> <span
class="cmtt-10">\glsresetentrycounter </span></div><hr>
- </p><!--l. 3089--><p class="noindent" >
+ </p><!--l. 3617--><p class="noindent" >
which sets <span
class="cmss-10">glossaryentry</span><a
- id="dx1-19016"></a> to zero:
+ id="dx1-25016"></a> to zero:
</p>
- <div class="verbatim" id="verbatim-56">
+ <div class="verbatim" id="verbatim-94">
\renewcommand{\glossarypreamble}{%
 <br />  \glsresetentrycounter
 <br />}
</div>
- <!--l. 3095--><p class="nopar" > or if you are using <span
+ <!--l. 3623--><p class="nopar" > or if you are using <span
class="cmtt-10">\setglossarypreamble</span><a
- id="dx1-19017"></a>, add it to each glossary preamble, as
+ id="dx1-25017"></a>, add it to each glossary preamble, as
required. For example:
</p>
- <div class="verbatim" id="verbatim-57">
+ <div class="verbatim" id="verbatim-95">
\setglossarypreamble[acronym]{%
 <br />  \glsresetentrycounter
 <br />  The preamble text here for the list of acronyms.
@@ -6064,28 +7588,28 @@
 <br />  The preamble text here for the main glossary.
 <br />}
</div>
- <!--l. 3107--><p class="nopar" >
+ <!--l. 3635--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">subentrycounter</span><a
- id="dx1-19018"></a> </dt><dd
+ id="dx1-25018"></a> </dt><dd
class="description">This is a boolean option. (Default is <span
class="cmss-10">subentrycounter=false</span><a
- id="dx1-19019"></a>.) If set, each
+ id="dx1-25019"></a>.) If set, each
level 1 glossary entry will be numbered when using the standard glossary
styles. This option creates the counter <span class="marginpar"><span
class="cmtt-9">glossarysubentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-19020"></a><a
- id="dx1-19021"></a><span
+ id="dx1-25020"></a><a
+ id="dx1-25021"></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-19022"></a>. You can reference the number within the
+ id="dx1-25022"></a>. You can reference the number within the
document using <span
class="cmtt-10">\glsrefentry</span><a
- id="dx1-19023"></a><span
+ id="dx1-25023"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">label</span>⟩<span
class="cmtt-10">} </span>where ⟨<span
@@ -6094,208 +7618,266 @@
</dd><dt class="description">
<span
class="cmssbx-10">style</span><a
- id="dx1-19024"></a> </dt><dd
+ id="dx1-25024"></a> </dt><dd
class="description">This is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ option. (Default is <span
class="cmss-10">style=list</span><a
- id="dx1-19025"></a>, unless <span
+ id="dx1-25025"></a>, unless <span
class="cmss-10">classicthesis</span><a
- id="dx1-19026"></a> has been loaded, in
+ id="dx1-25026"></a> has been loaded, in
which case the default is <span
class="cmss-10">style=index</span><a
- id="dx1-19027"></a>.) Its value should be the name of the
+ id="dx1-25027"></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-19028"></a>,
+ id="dx1-25028"></a>,
<span
class="cmss-10">glossary-long</span><a
- id="dx1-19029"></a>, <span
+ id="dx1-25029"></a>, <span
class="cmss-10">glossary-super</span><a
- id="dx1-19030"></a> or <span
+ id="dx1-25030"></a> or <span
class="cmss-10">glossary-tree</span><a
- id="dx1-19031"></a>. Alternatively, you can set the style
+ id="dx1-25031"></a>. Alternatively, you can set the style
using
- <!--l. 3128--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 3656--><p class="noindent" ><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. 3129--><p class="noindent" >
+ </p><!--l. 3657--><p class="noindent" >
(See <a
href="#sec:styles"><span
-class="cmsy-10">§</span>15 </a><a
+class="tcrm-1000">§</span>15 </a><a
href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for further details.)
</p></dd><dt class="description">
<span
class="cmssbx-10">nolong</span><a
- id="dx1-19032"></a> </dt><dd
+ id="dx1-25032"></a> </dt><dd
class="description">This prevents the <span
class="cmss-10">glossaries </span>package from automatically loading <span
class="cmss-10">glossary-long</span><a
- id="dx1-19033"></a> (which
+ id="dx1-25033"></a> (which
means that the <span
class="cmss-10">longtable</span><a
- id="dx1-19034"></a> package also won’t be loaded). This reduces overhead by not
+ id="dx1-25034"></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-19035"></a>).
+ id="dx1-25035"></a>).
</dd><dt class="description">
<span
class="cmssbx-10">nosuper</span><a
- id="dx1-19036"></a> </dt><dd
+ id="dx1-25036"></a> </dt><dd
class="description">This prevents the <span
class="cmss-10">glossaries </span>package from automatically loading <span
class="cmss-10">glossary-super</span><a
- id="dx1-19037"></a> (which
+ id="dx1-25037"></a> (which
means that the <span
class="cmss-10">supertabular</span><a
- id="dx1-19038"></a> package also won’t be loaded). This reduces overhead by
+ id="dx1-25038"></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-19039"></a>).
+ id="dx1-25039"></a>).
</dd><dt class="description">
<span
class="cmssbx-10">nolist</span><a
- id="dx1-19040"></a> </dt><dd
+ id="dx1-25040"></a> </dt><dd
class="description">This prevents the <span
class="cmss-10">glossaries </span>package from automatically loading <span
class="cmss-10">glossary-list</span><a
- id="dx1-19041"></a>. This
+ id="dx1-25041"></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-19042"></a>). Note that since the default style is <span
+ id="dx1-25042"></a>). Note that since the default style is <span
class="cmss-10">list</span><a
- id="dx1-19043"></a> (unless
+ id="dx1-25043"></a> (unless
<span
class="cmss-10">classicthesis</span><a
- id="dx1-19044"></a> has been loaded), you will also need to use the <span
+ id="dx1-25044"></a> has been loaded), you will also need to use the <span
class="cmss-10">style</span><a
- id="dx1-19045"></a> option to set the style
+ id="dx1-25045"></a> option to set the style
to something else.
</dd><dt class="description">
<span
class="cmssbx-10">notree</span><a
- id="dx1-19046"></a> </dt><dd
+ id="dx1-25046"></a> </dt><dd
class="description">This prevents the <span
class="cmss-10">glossaries </span>package from automatically loading <span
class="cmss-10">glossary-tree</span><a
- id="dx1-19047"></a>. This
+ id="dx1-25047"></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-19048"></a>). Note that if
+ id="dx1-25048"></a>). Note that if
<span
class="cmss-10">classicthesis</span><a
- id="dx1-19049"></a> has been loaded, the default style is <span
+ id="dx1-25049"></a> has been loaded, the default style is <span
class="cmss-10">index</span><a
- id="dx1-19050"></a>, which is provided by
+ id="dx1-25050"></a>, which is provided by
<span
class="cmss-10">glossary-tree</span><a
- id="dx1-19051"></a>.
+ id="dx1-25051"></a>.
</dd><dt class="description">
<span
class="cmssbx-10">nostyles</span><a
- id="dx1-19052"></a> </dt><dd
+ id="dx1-25052"></a> </dt><dd
class="description">This prevents all the predefined styles from being loaded. If you use this option, you
need to load a glossary style package (such as <span
class="cmss-10">glossary-mcols</span><a
- id="dx1-19053"></a>). Also if you use
+ id="dx1-25053"></a>). Also if you use
this option, you can’t use the <span
class="cmss-10">style</span><a
- id="dx1-19054"></a> package option. Instead you must either
+ id="dx1-25054"></a> package option. Instead you must either
use <span
class="cmtt-10">\setglossarystyle</span><a
- id="dx1-19055"></a><span
+ id="dx1-25055"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">style</span>⟩<span
class="cmtt-10">} </span>or the <span
class="cmss-10">style</span><a
- id="dx1-19056"></a> key in the optional argument to
+ id="dx1-25056"></a> key in the optional argument to
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-19057"></a>. Example:
+ id="dx1-25057"></a>. Example:
- <div class="verbatim" id="verbatim-58">
+ <div class="verbatim" id="verbatim-96">
\usepackage[nostyles]{glossaries}
 <br />\usepackage{glossary-mcols}
 <br />\setglossarystyle{mcoltree}
</div>
- <!--l. 3179--><p class="nopar" >
+ <!--l. 3707--><p class="nopar" >
</p></dd><dt class="description">
<span
+class="cmssbx-10">esclocations</span><a
+ id="dx1-25058"></a> </dt><dd
+class="description">This is a boolean option. (The default is <span
+class="cmss-10">esclocations=true</span><a
+ id="dx1-25059"></a>.) Both <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-25060"></a></a>
+ and <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-25061"></a></a> are fussy about the location formats (<a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-25062"></a></a> more so than <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-25063"></a></a>) so the
+ <span
+class="cmss-10">glossaries </span>package tries to ensure that special characters are escaped and allows for the
+ location to be substituted for a format that’s more acceptable to the indexing
+ application. This requires a bit of trickery to circumvent the problem posed by <span class="TEX">T<span
+class="E">E</span>X</span>’s
+ asynchronous output routine, which can go wrong and also adds to the complexity of
+ the document build.
+ <!--l. 3719--><p class="noindent" >If you’re sure that your locations will always expand to an acceptable format (or you’re
+ prepared to post-process the glossary file before passing it to the relevant indexing
+ application) then use <span
+class="cmss-10">esclocations=false</span><a
+ id="dx1-25064"></a> to avoid the complex escaping of location
+ values.
+ </p></dd><dt class="description">
+<span
class="cmssbx-10">nonumberlist</span><a
- id="dx1-19058"></a> </dt><dd
+ id="dx1-25065"></a> </dt><dd
class="description">This option will suppress the associated <a
href="#glo:numberlist">number list<a
- id="dx1-19059"></a>s</a> in the glossaries (see also
+ id="dx1-25066"></a>s</a> in the glossaries (see also
<a
href="#sec:numberlists"><span
-class="cmsy-10">§</span>5 </a><a
-href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>).
+class="tcrm-1000">§</span>5 </a><a
+href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). Note that if you use Options <a
+href="#option2">2</a> or <a
+href="#option3">3</a> (<a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-25067"></a></a> or <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-25068"></a></a>) then the
+ locations must still be valid. This package option merely prevents the <a
+href="#glo:numberlist">number list<a
+ id="dx1-25069"></a></a> from
+ being displayed, but both <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-25070"></a></a> and <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-25071"></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-25072"></a></a> includes any
+ cross-references, so suppressing the <a
+href="#glo:numberlist">number list<a
+ id="dx1-25073"></a></a> will also hide the cross-references (see
+ below).
</dd><dt class="description">
<span
class="cmssbx-10">seeautonumberlist</span><a
- id="dx1-19060"></a> </dt><dd
+ id="dx1-25074"></a> </dt><dd
class="description">If you suppress the <a
href="#glo:numberlist">number list<a
- id="dx1-19061"></a>s</a> with <span
+ id="dx1-25075"></a>s</a> with <span
class="cmss-10">nonumberlist</span><a
- id="dx1-19062"></a>, described
+ id="dx1-25076"></a>, described
above, this will also suppress any cross-referencing information supplied by
the <span
class="cmss-10">see</span><a
- id="dx1-19063"></a> key in <span
+ id="dx1-25077"></a> key in <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-19064"></a> or <span
+ id="dx1-25078"></a> or <span
class="cmtt-10">\glssee</span><a
- id="dx1-19065"></a>. If you use <span
+ id="dx1-25079"></a>. If you use <span
class="cmss-10">seeautonumberlist</span><a
- id="dx1-19066"></a>,
+ id="dx1-25080"></a>,
the <span
class="cmss-10">see</span><a
- id="dx1-19067"></a> key will automatically implement <span
+ id="dx1-25081"></a> key will automatically implement <span
class="cmss-10">nonumberlist=false</span><a
- id="dx1-19068"></a> for that entry.
+ id="dx1-25082"></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="cmsy-10">§</span>8 </a><a
+class="tcrm-1000">§</span>8 </a><a
href="#sec:crossref">Cross-Referencing
Entries<!--tex4ht:ref: sec:crossref --></a>.
</dd><dt class="description">
<span
class="cmssbx-10">counter</span><a
- id="dx1-19069"></a> </dt><dd
+ id="dx1-25083"></a> </dt><dd
class="description">This is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ option. (Default is <span
class="cmss-10">counter=page</span><a
- id="dx1-19070"></a>.) The value should be
+ id="dx1-25084"></a>.) The value should be
the name of the default counter to use in the <a
href="#glo:numberlist">number list<a
- id="dx1-19071"></a>s</a> (see <a
+ id="dx1-25085"></a>s</a> (see <a
href="#sec:numberlists"><span
-class="cmsy-10">§</span>5 </a><a
+class="tcrm-1000">§</span>5 </a><a
href="#sec:numberlists">Number
lists<!--tex4ht:ref: sec:numberlists --></a>).
</dd><dt class="description">
<span
class="cmssbx-10">nopostdot</span><a
- id="dx1-19072"></a> </dt><dd
+ id="dx1-25086"></a> </dt><dd
class="description">This is a boolean option. If no value is specified, <span
class="cmtt-10">true </span>is assumed. When set to
<span
@@ -6302,11 +7884,13 @@
class="cmtt-10">true</span>, this option suppresses the default post description dot used by some of the
predefined styles. The default setting is <span
class="cmss-10">nopostdot=false</span><a
- id="dx1-19073"></a>.
+ id="dx1-25087"></a>.
+
+
</dd><dt class="description">
<span
class="cmssbx-10">nogroupskip</span><a
- id="dx1-19074"></a> </dt><dd
+ id="dx1-25088"></a> </dt><dd
class="description">This is a boolean option. If no value is specified, <span
class="cmtt-10">true </span>is assumed. When set to
<span
@@ -6313,19 +7897,17 @@
class="cmtt-10">true</span>, this option suppresses the default vertical gap between groups used by some of
the predefined styles. The default setting is <span
class="cmss-10">nogroupskip=false</span><a
- id="dx1-19075"></a>.
+ id="dx1-25089"></a>.
</dd></dl>
-<!--l. 3213--><p class="noindent" >
+<!--l. 3764--><p class="noindent" >
</p>
-<!--l. 3213--><p class="noindent" ><a
+<!--l. 3764--><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-sort"></a>Sorting Options</h3>
-
-
<dl class="description"><dt class="description">
<span
class="cmssbx-10">sort</span><a
- id="dx1-20001"></a> </dt><dd
+ id="dx1-26001"></a> </dt><dd
class="description">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
@@ -6333,19 +7915,19 @@
href="#option1">Option 1</a> allows you to specify sort methods for individual
glossaries via the <span
class="cmss-10">sort</span><a
- id="dx1-20002"></a> key in the optional argument of <span
+ id="dx1-26002"></a> key in the optional argument of <span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-20003"></a>. If
+ id="dx1-26003"></a>. If
you have multiple glossaries in your document and you are using <a
href="#option1">Option 1</a>, only
use the package options <span
class="cmss-10">sort=def</span><a
- id="dx1-20004"></a> or <span
+ id="dx1-26004"></a> or <span
class="cmss-10">sort=use</span><a
- id="dx1-20005"></a> if you want to set this sort method
+ id="dx1-26005"></a> if you want to set this sort method
for <span
class="cmti-10">all </span>your glossaries.
- <!--l. 3227--><p class="noindent" >This is a ⟨<span
+ <!--l. 3778--><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>⟩ may be one of the following: </p>
@@ -6352,60 +7934,65 @@
<ul class="itemize1">
<li class="itemize"><span
class="cmss-10">standard</span><a
- id="dx1-20006"></a> : entries are sorted according to the value of the <span
+ id="dx1-26006"></a> : entries are sorted according to the value of the <span
class="cmss-10">sort</span><a
- id="dx1-20007"></a> key used in
+ id="dx1-26007"></a> key used in
<span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-20008"></a> (if present) or the <span
+ id="dx1-26008"></a> (if present) or the <span
class="cmss-10">name</span><a
- id="dx1-20009"></a> key (if <span
+ id="dx1-26009"></a> key (if <span
class="cmss-10">sort</span><a
- id="dx1-20010"></a> key is missing);
+ id="dx1-26010"></a> key is missing);
</li>
<li class="itemize"><span
class="cmss-10">def</span><a
- id="dx1-20011"></a> : entries are sorted in the order in which they were defined (the <span
+ id="dx1-26011"></a> : entries are sorted in the order in which they were defined (the <span
class="cmss-10">sort</span><a
- id="dx1-20012"></a> key
+ id="dx1-26012"></a> key
in <span
class="cmtt-10">\newglossaryentry </span>is ignored);
</li>
<li class="itemize"><span
class="cmss-10">use</span><a
- id="dx1-20013"></a> : entries are sorted according to the order in which they are used in the
+ id="dx1-26013"></a> : entries are sorted according to the order in which they are used in the
document (the <span
class="cmss-10">sort</span><a
- id="dx1-20014"></a> key in <span
+ id="dx1-26014"></a> key in <span
class="cmtt-10">\newglossaryentry </span>is ignored).
- <!--l. 3243--><p class="noindent" >Both <span
+ <!--l. 3794--><p class="noindent" >Both <span
class="cmss-10">sort=def</span><a
- id="dx1-20015"></a> and <span
+ id="dx1-26015"></a> and <span
class="cmss-10">sort=use</span><a
- id="dx1-20016"></a> set the sort key to a six digit number via
- </p><!--l. 3245--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-26016"></a> set the sort key to a six digit number via
+ </p><!--l. 3796--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glssortnumberfmt</span><span
class="cmtt-9"> </span></span><a
- id="dx1-20017"></a> <span
+ id="dx1-26017"></a> <span
class="cmtt-10">\glssortnumberfmt{</span>⟨<span
class="cmitt-10">number</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 3247--><p class="noindent" >
+ </p><!--l. 3798--><p class="noindent" >
(padded with leading zeros, where necessary). This can be redefined, if required,
before the entries are defined (in the case of <span
class="cmss-10">sort=def</span><a
- id="dx1-20018"></a>) or before the entries are
+ id="dx1-26018"></a>) or before the entries are
used (in the case of <span
class="cmss-10">sort=use</span><a
- id="dx1-20019"></a>).
+ id="dx1-26019"></a>).
</p></li>
<li class="itemize"><span
class="cmss-10">none</span><a
- id="dx1-20020"></a> : this option is new to version 4.30 and is only for documents that don’t use
+ id="dx1-26020"></a> : this setting is new to version 4.30 and is only for documents that don’t use
<span
-class="cmtt-10">\makeglossaries </span>or <span
-class="cmtt-10">\makenoidxglossaries</span>. It omits the code used to sanitize or
- escape the sort value, since it’s not required. This option can’t be used with
+class="cmtt-10">\makeglossaries </span>(Options <a
+href="#option2">2</a> or <a
+href="#option3">3</a>) or <span
+class="cmtt-10">\makenoidxglossaries </span>(<a
+href="#option1">Option 1</a>). It
+ omits the code used to sanitize or escape the sort value, since it’s not
+ required. This can help to improve the document build speed, especially
+ if there are a large number of entries. This option can’t be used with
<span
class="cmtt-10">\printglossary </span>or <span
class="cmtt-10">\printnoidxglossary </span>(or the iterative versions
@@ -6414,24 +8001,27 @@
class="cmtt-10">\printnoidxglossaries</span>). It may be used with
<span
class="cmss-10">glossaries-extra</span><a
- id="dx1-20021"></a>’s <span
-class="cmtt-10">\printunsrtglossary</span>.</li></ul>
- <!--l. 3262--><p class="noindent" >Note that the group styles (such as <span
+ id="dx1-26021"></a>’s <span
+class="cmtt-10">\printunsrtglossary </span>(<a
+href="#option5">Option 5</a>).</li></ul>
+
+
+ <!--l. 3815--><p class="noindent" >Note that the group styles (such as <span
class="cmss-10">listgroup</span><a
- id="dx1-20022"></a>) are incompatible with the <span
+ id="dx1-26022"></a>) are incompatible with the <span
class="cmss-10">sort=use</span><a
- id="dx1-20023"></a> and
+ id="dx1-26023"></a> and
<span
class="cmss-10">sort=def</span><a
- id="dx1-20024"></a> options.
- </p><!--l. 3266--><p class="noindent" >The default is <span
+ id="dx1-26024"></a> options.
+ </p><!--l. 3819--><p class="noindent" >The default is <span
class="cmss-10">sort=standard</span><a
- id="dx1-20025"></a>. When the standard sort option is in use, you can hook into
+ id="dx1-26025"></a>. When the standard sort option is in use, you can hook into
the sort mechanism by redefining:
- </p><!--l. 3269--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3822--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsprestandardsort</span><span
class="cmtt-9"> </span></span><a
- id="dx1-20026"></a> <span
+ id="dx1-26026"></a> <span
class="cmtt-10">\glsprestandardsort{</span>⟨<span
class="cmitt-10">sort cs</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -6439,41 +8029,39 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 3271--><p class="noindent" >
+ </p><!--l. 3824--><p class="noindent" >
where ⟨<span
class="cmti-10">sort cs</span>⟩ is a temporary control sequence that stores the sort value (which was
either explicitly set via the <span
class="cmss-10">sort</span><a
- id="dx1-20027"></a> key or implicitly set via the <span
+ id="dx1-26027"></a> key or implicitly set via the <span
class="cmss-10">name</span><a
- id="dx1-20028"></a> key) before any
+ id="dx1-26028"></a> key) before any
escaping of the <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-20029"></a></a>/<a
+ id="dx1-26029"></a></a>/<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20030"></a></a> special characters is performed. By default
+ id="dx1-26030"></a></a> special characters is performed. By default
<span
class="cmtt-10">\glsprestandardsort </span>just does:
- </p><!--l. 3277--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 3830--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsdosanitizesort</span><span
class="cmtt-9"> </span></span><a
- id="dx1-20031"></a> <span
+ id="dx1-26031"></a> <span
class="cmtt-10">\glsdosanitizesort </span></div><hr>
-
-
- </p><!--l. 3279--><p class="noindent" >
+ </p><!--l. 3832--><p class="noindent" >
which <a
href="#glo:sanitize">sanitize<a
- id="dx1-20032"></a>s</a> ⟨<span
+ id="dx1-26032"></a>s</a> ⟨<span
class="cmti-10">sort cs</span>⟩ if the <span
class="cmss-10">sanitizesort</span><a
- id="dx1-20033"></a> package option is set (or does nothing if the
+ id="dx1-26033"></a> package option is set (or does nothing if the
package option <span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-20034"></a> is used).
- </p><!--l. 3284--><p class="noindent" >The other arguments, ⟨<span
+ id="dx1-26034"></a> is used).
+ </p><!--l. 3837--><p class="noindent" >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
@@ -6481,25 +8069,25 @@
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-20035"></a>.
- </p><!--l. 3289--><p class="noindent" ><div class="important" title="Important Note"> Redefining <span
+ id="dx1-26035"></a>.
+ </p><!--l. 3842--><p class="noindent" ><div class="important" title="Important Note"> Redefining <span
class="cmtt-10">\glsprestandardsort </span>won’t affect any entries that have already been
defined and will have no effect at all if you are using <span
class="cmss-10">sort=def</span><a
- id="dx1-20036"></a> or <span
+ id="dx1-26036"></a> or <span
class="cmss-10">sort=use</span><a
- id="dx1-20037"></a>.
+ id="dx1-26037"></a>.
</div>
- </p><!--l. 3293--><p class="noindent" >
+ </p><!--l. 3846--><p class="noindent" >
<a
- id="x1-20038r1"></a>
- </p><!--l. 3295--><p class="noindent" ><span
+ id="x1-26038r1"></a>
+ </p><!--l. 3848--><p class="noindent" ><span
class="cmbx-12">Example 1</span><span
class="cmbx-12"> (Mixing Alphabetical and Order of Definition</span>
<span
class="cmbx-12">Sorting)</span><a
- id="x1-20039"></a>
- </p><!--l. 3296--><p class="noindent" >Suppose I have three glossaries: <span
+ id="x1-26039"></a>
+ </p><!--l. 3849--><p class="noindent" >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
@@ -6508,29 +8096,29 @@
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. 3302--><p class="noindent" >For <a
+ </p><!--l. 3855--><p class="noindent" >For <a
href="#option1">Option 1</a>, I just need to set the <span
class="cmss-10">sort</span><a
- id="dx1-20040"></a> key in the optional argument of
+ id="dx1-26040"></a> key in the optional argument of
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-20041"></a>:
+ id="dx1-26041"></a>:
</p>
- <div class="verbatim" id="verbatim-59">
+ <div class="verbatim" id="verbatim-97">
\printnoidxglossary[sort=word]
 <br />\printnoidxglossary[type=acronym,sort=word]
 <br />\printnoidxglossary[type=notation,sort=def]
</div>
- <!--l. 3308--><p class="nopar" >
- </p><!--l. 3310--><p class="noindent" >For Options <a
+ <!--l. 3861--><p class="nopar" >
+ </p><!--l. 3863--><p class="noindent" >For Options <a
href="#option2">2</a> or <a
href="#option3">3</a>, I can set the sort to <span
class="cmtt-10">standard </span>(which is the default, but can be
explicitly set via the package option <span
class="cmss-10">sort=standard</span><a
- id="dx1-20042"></a>), and I can either define all my <span
+ id="dx1-26042"></a>), and I can either define all my <span
class="cmtt-10">main</span>
and <span
class="cmtt-10">acronym </span>entries, then redefine <span
@@ -6544,11 +8132,11 @@
⟨<span
class="cmti-10">type</span>⟩ is <span
class="cmtt-10">notation</span>.
- </p><!--l. 3320--><p class="noindent" >The first option can be achieved as follows:
+ </p><!--l. 3873--><p class="noindent" >The first option can be achieved as follows:
</p>
- <div class="verbatim" id="verbatim-60">
+ <div class="verbatim" id="verbatim-98">
\newcounter{sortcount}
 <br />\renewcommand{\glsprestandardsort}[3]{%
 <br />  \stepcounter{sortcount}%
@@ -6555,11 +8143,11 @@
 <br />  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
 <br />}
</div>
- <!--l. 3328--><p class="nopar" > The second option can be achieved as follows:
+ <!--l. 3881--><p class="nopar" > The second option can be achieved as follows:
</p>
- <div class="verbatim" id="verbatim-61">
+ <div class="verbatim" id="verbatim-99">
\newcounter{sortcount}
 <br />\renewcommand{\glsprestandardsort}[3]{%
 <br />  \ifdefstring{#2}{notation}%
@@ -6572,26 +8160,26 @@
 <br />  }%
 <br />}
</div>
- <!--l. 3343--><p class="nopar" > (<span
+ <!--l. 3896--><p class="nopar" > (<span
class="cmtt-10">\ifdefstring </span>is defined by the <span
class="cmss-10">etoolbox</span><a
- id="dx1-20043"></a> package.) For a complete document, see the
+ id="dx1-26043"></a> package.) For a complete document, see the
sample file <a
-href="#x1-5102r35"><span
+href="#x1-11112r36"><span
class="cmtt-10">sampleSort.tex</span></a>. </p>
<div class="center"
>
-<!--l. 3346--><p class="noindent" >
-</p><!--l. 3346--><p class="noindent" >____________________________</p></div>
+<!--l. 3899--><p class="noindent" >
+</p><!--l. 3899--><p class="noindent" >____________________________</p></div>
<a
- id="x1-20044r2"></a>
- <!--l. 3348--><p class="noindent" ><span
+ id="x1-26044r2"></a>
+ <!--l. 3901--><p class="noindent" ><span
class="cmbx-12">Example 2</span><span
class="cmbx-12"> (Customizing Standard Sort (Options 2 or</span>
<span
class="cmbx-12">3))</span><a
- id="x1-20045"></a>
- </p><!--l. 3349--><p class="noindent" >Suppose you want a glossary of people and you want the names listed as ⟨<span
+ id="x1-26045"></a>
+ </p><!--l. 3902--><p class="noindent" >Suppose you want a glossary of people and you want the names listed as ⟨<span
class="cmti-10">first-name</span>⟩
⟨<span
class="cmti-10">surname</span>⟩ in the glossary, but you want the names sorted by ⟨<span
@@ -6605,28 +8193,28 @@
class="cmtt-10">} </span>that you
can use in the <span
class="cmss-10">name</span><a
- id="dx1-20046"></a> key when you define the entry, but hook into the standard
+ id="dx1-26046"></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. 3358--><p class="noindent" >First, define two commands to set the person’s name:
+ </p><!--l. 3911--><p class="noindent" >First, define two commands to set the person’s name:
</p>
- <div class="verbatim" id="verbatim-62">
+ <div class="verbatim" id="verbatim-100">
\newcommand{\sortname}[2]{#2, #1}
 <br />\newcommand{\textname}[2]{#1 #2}
</div>
- <!--l. 3362--><p class="nopar" > and <span
+ <!--l. 3915--><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-63">
+ <div class="verbatim" id="verbatim-101">
\let\name\textname
</div>
- <!--l. 3366--><p class="nopar" > Now redefine <span
+ <!--l. 3919--><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>
@@ -6639,7 +8227,7 @@
</p>
- <div class="verbatim" id="verbatim-64">
+ <div class="verbatim" id="verbatim-102">
\renewcommand{\glsprestandardsort}[3]{%
 <br /> \let\name\sortname
 <br /> \edef#1{\expandafter\expandonce\expandafter{#1}}%
@@ -6647,127 +8235,127 @@
 <br /> \glsdosanitizesort
 <br />}
</div>
- <!--l. 3378--><p class="nopar" > (The somewhat complicate use of <span
+ <!--l. 3931--><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. 3382--><p class="noindent" >Now the entries can be defined:
+ </p><!--l. 3935--><p class="noindent" >Now the entries can be defined:
</p>
- <div class="verbatim" id="verbatim-65">
+ <div class="verbatim" id="verbatim-103">
\newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},
 <br />  description={some information about Joe Bloggs}}
 <br />\newglossaryentry{johnsmith}{name={\name{John}{Smith}},
 <br />  description={some information about John Smith}}
</div>
- <!--l. 3389--><p class="nopar" > For a complete document, see the sample file <a
-href="#x1-5101r34"><span
+ <!--l. 3942--><p class="nopar" > For a complete document, see the sample file <a
+href="#x1-11111r35"><span
class="cmtt-10">samplePeople.tex</span></a>. </p>
<div class="center"
>
-<!--l. 3391--><p class="noindent" >
-</p><!--l. 3391--><p class="noindent" >____________________________</p></div>
+<!--l. 3944--><p class="noindent" >
+</p><!--l. 3944--><p class="noindent" >____________________________</p></div>
</dd><dt class="description">
<span
class="cmssbx-10">order</span><a
- id="dx1-20047"></a> </dt><dd
+ id="dx1-26047"></a> </dt><dd
class="description">This may take two values: <span
class="cmss-10">word</span><a
- id="dx1-20048"></a> or <span
+ id="dx1-26048"></a> or <span
class="cmss-10">letter</span><a
- id="dx1-20049"></a>. The default is word ordering.
- <!--l. 3397--><p class="noindent" ><div class="important" title="Important Note"> Note that the <span
+ id="dx1-26049"></a>. The default is word ordering.
+ <!--l. 3950--><p class="noindent" ><div class="important" title="Important Note"> Note that the <span
class="cmss-10">order</span><a
- id="dx1-20050"></a> option has no effect if you don’t use <a
+ id="dx1-26050"></a> option has no effect if you don’t use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20051"></a></a>.
+ id="dx1-26051"></a></a>.
</div>
- </p><!--l. 3400--><p class="noindent" >
- </p><!--l. 3402--><p class="noindent" >If you use <a
+ </p><!--l. 3953--><p class="noindent" >
+ </p><!--l. 3955--><p class="noindent" >If you use <a
href="#option1">Option 1</a>, this setting will be used if you use <span
class="cmss-10">sort</span><a
- id="dx1-20052"></a><span
+ id="dx1-26052"></a><span
class="cmtt-10">=standard </span>in the optional
argument of <span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-20053"></a>:
+ id="dx1-26053"></a>:
</p>
- <div class="verbatim" id="verbatim-66">
+ <div class="verbatim" id="verbatim-104">
\printnoidxglossary[sort=standard]
</div>
- <!--l. 3407--><p class="nopar" > Alternatively, you can specify the order for individual glossaries:
+ <!--l. 3960--><p class="nopar" > Alternatively, you can specify the order for individual glossaries:
</p>
- <div class="verbatim" id="verbatim-67">
+ <div class="verbatim" id="verbatim-105">
\printnoidxglossary[sort=word]
 <br />\printnoidxglossary[type=acronym,sort=letter]
</div>
- <!--l. 3412--><p class="nopar" >
+ <!--l. 3965--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">makeindex</span><a
- id="dx1-20054"></a> </dt><dd
+ id="dx1-26054"></a> </dt><dd
class="description">(<a
href="#option2">Option 2</a>) The glossary information and indexing style file will be written in
<a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-20055"></a></a> format. If you use <a
+ id="dx1-26055"></a></a> format. If you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20056"></a></a>, it will automatically detect that it
+ id="dx1-26056"></a></a>, it will automatically detect that it
needs to call <span
class="cmtt-10">makeindex</span><a
- id="dx1-20057"></a>. If you don’t use <span
+ id="dx1-26057"></a>. If you don’t use <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20058"></a>, you need to remember
+ id="dx1-26058"></a>, you need to remember
to use <span
class="cmtt-10">makeindex</span><a
- id="dx1-20059"></a> not <a
+ id="dx1-26059"></a> not <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20060"></a></a>. The indexing style file will been given a <span
+ id="dx1-26060"></a></a>. The indexing style file will been given a <span
class="cmtt-10">.ist</span><a
- id="dx1-20061"></a>
+ id="dx1-26061"></a>
extension.
- <!--l. 3422--><p class="noindent" >You may omit this package option if you are using <a
+ <!--l. 3975--><p class="noindent" >You may omit this package option if you are using <a
href="#option2">Option 2</a> as this is the default. It’s
available in case you need to override the effect of an earlier occurrence of <span
class="cmss-10">xindy</span><a
- id="dx1-20062"></a> in the
+ id="dx1-26062"></a> in the
package option list.
</p></dd><dt class="description">
<span
class="cmssbx-10">xindy</span><a
- id="dx1-20063"></a> </dt><dd
+ id="dx1-26063"></a> </dt><dd
class="description">(<a
href="#option3">Option 3</a>) The glossary information and indexing style file will be written in
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20064"></a></a> format. If you use <a
+ id="dx1-26064"></a></a> format. If you use <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20065"></a></a>, it will automatically detect that it
+ id="dx1-26065"></a></a>, it will automatically detect that it
needs to call <span
class="cmtt-10">xindy</span><a
- id="dx1-20066"></a>. If you don’t use <span
+ id="dx1-26066"></a>. If you don’t use <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20067"></a>, you need to remember
+ id="dx1-26067"></a>, you need to remember
to use <span
class="cmtt-10">xindy</span><a
- id="dx1-20068"></a> not <a
+ id="dx1-26068"></a> not <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-20069"></a></a>. The indexing style file will been given a <span
+ id="dx1-26069"></a></a>. The indexing style file will been given a <span
class="cmtt-10">.xdy</span><a
- id="dx1-20070"></a>
+ id="dx1-26070"></a>
extension.
- <!--l. 3433--><p class="noindent" >This package option may additionally have a value that is a ⟨<span
+ <!--l. 3986--><p class="noindent" >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:
@@ -6774,54 +8362,54 @@
</p>
- <div class="verbatim" id="verbatim-68">
+ <div class="verbatim" id="verbatim-106">
\usepackage[xindy={language=english,codepage=utf8}]
 <br />  {glossaries}
</div>
- <!--l. 3439--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to
+ <!--l. 3992--><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-69">
+ <div class="verbatim" id="verbatim-107">
\usepackage[xindy={glsnumbers=false}]{glossaries}
</div>
- <!--l. 3444--><p class="nopar" > If no value is supplied to this package option (either simply writing <span
+ <!--l. 3997--><p class="nopar" > If no value is supplied to this package option (either simply writing <span
class="cmtt-10">xindy </span>or writing
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">xindy={}</span></span></span>) then the language, codepage and number group settings are unchanged. See
<a
href="#sec:xindy"><span
-class="cmsy-10">§</span>11 </a><a
+class="tcrm-1000">§</span>11 </a><a
href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20071"></a></a> with the <span
+ id="dx1-26071"></a></a> with the <span
class="cmss-10">glossaries</span>
package.
</p></dd><dt class="description">
<span
class="cmssbx-10">xindygloss</span><a
- id="dx1-20072"></a> </dt><dd
+ id="dx1-26072"></a> </dt><dd
class="description">(<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-20073"></a> option without any
+ id="dx1-26073"></a> option without any
value supplied) and may be used as a document class option. The language and code
page can be set via <span
class="cmtt-10">\GlsSetXdyLanguage</span><a
- id="dx1-20074"></a> and <span
+ id="dx1-26074"></a> and <span
class="cmtt-10">\GlsSetXdyCodePage</span><a
- id="dx1-20075"></a> (see <a
+ id="dx1-26075"></a> (see <a
href="#sec:langenc"><span
-class="cmsy-10">§</span>11.1
+class="tcrm-1000">§</span>11.1
</a><a
href="#sec:langenc">Language and Encodings<!--tex4ht:ref: sec:langenc --></a>.)
</dd><dt class="description">
<span
class="cmssbx-10">xindynoglsnumbers</span><a
- id="dx1-20076"></a> </dt><dd
+ id="dx1-26076"></a> </dt><dd
class="description">(<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
@@ -6829,57 +8417,57 @@
</dd><dt class="description">
<span
class="cmssbx-10">automake</span><a
- id="dx1-20077"></a> </dt><dd
+ id="dx1-26077"></a> </dt><dd
class="description">This is a boolean option (new to version 4.08) that will attempt to run <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-20078"></a></a>
+ id="dx1-26078"></a></a>
or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20079"></a></a> using <span class="TEX">T<span
+ id="dx1-26079"></a></a> using <span class="TEX">T<span
class="E">E</span>X</span>’s <span
class="cmtt-10">\write18</span><a
- id="dx1-20080"></a> mechanism at the end of the document. Since this
+ id="dx1-26080"></a> mechanism at the end of the document. Since this
mechanism can be a security risk, some <span class="TEX">T<span
class="E">E</span>X</span> distributions disable it completely, in
which case this option won’t have an effect. (If this option doesn’t appear to work,
search the log file for “runsystem” and see if it is followed by “enabled” or
“disabled”.)
- <!--l. 3470--><p class="noindent" >Some distributions allow <span
+ <!--l. 4023--><p class="noindent" >Some distributions allow <span
class="cmtt-10">\write18 </span>in a restricted mode. This mode has a limited
number of trusted applications, which usually includes <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-20081"></a></a> but may not include
+ id="dx1-26081"></a></a> but may not include
<a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20082"></a></a>. So if you have the restricted mode on, <span
+ id="dx1-26082"></a></a>. So if you have the restricted mode on, <span
class="cmss-10">automake</span><a
- id="dx1-20083"></a> should work with <span
+ id="dx1-26083"></a> should work with <span
class="cmtt-10">makeindex</span><a
- id="dx1-20084"></a>
+ id="dx1-26084"></a>
but may not work with <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-20085"></a></a>.
- </p><!--l. 3476--><p class="noindent" >However even in unrestricted mode this option may not work with <span
+ id="dx1-26085"></a></a>.
+ </p><!--l. 4029--><p class="noindent" >However even in unrestricted mode this option may not work with <span
class="cmtt-10">xindy</span><a
- id="dx1-20086"></a> as <span
+ id="dx1-26086"></a> as <span
class="cmtt-10">xindy</span><a
- id="dx1-20087"></a> uses
+ id="dx1-26087"></a> uses
language names that don’t always correspond with <span
class="cmtt-10">\babel</span><a
- id="dx1-20088"></a>’s language names. (The
+ id="dx1-26088"></a>’s language names. (The
<a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-20089"></a></a> script applies mappings to assist you.) Note that you still need
+ id="dx1-26089"></a></a> script applies mappings to assist you.) Note that you still need
at least two <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> runs to ensure the document is up-to-date with this
setting.
- </p><!--l. 3483--><p class="noindent" >Since this package option attempts to run the <a
+ </p><!--l. 4036--><p class="noindent" >Since this package option attempts to run the <a
href="#glo:indexingapp">indexing application</a> on every
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> run, its use should be considered a last resort for those who can’t work out
@@ -6886,42 +8474,42 @@
how to incorporate the indexing application into their document build. The default
value for this option is <span
class="cmss-10">automake=false</span><a
- id="dx1-20090"></a>.
+ id="dx1-26090"></a>.
</p>
</dd></dl>
-<!--l. 3491--><p class="noindent" >
+<!--l. 4044--><p class="noindent" >
</p>
-<!--l. 3491--><p class="noindent" ><a
+<!--l. 4044--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.5 </span> <a
id="sec:pkgopts-acronym"></a>Acronym Options</h3>
<dl class="description"><dt class="description">
<span
class="cmssbx-10">acronym</span><a
- id="dx1-21001"></a> </dt><dd
+ id="dx1-27001"></a> </dt><dd
class="description">This creates a new glossary with the label <span
class="cmtt-10">acronym</span>. This is equivalent
to:
- <div class="verbatim" id="verbatim-70">
+ <div class="verbatim" id="verbatim-108">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
- <!--l. 3499--><p class="nopar" > It will also define
- </p><!--l. 3501--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4052--><p class="nopar" > It will also define
+ </p><!--l. 4054--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\printacronyms</span><span
class="cmtt-9"> </span></span><a
- id="dx1-21002"></a> <span
+ id="dx1-27002"></a> <span
class="cmtt-10">\printacronyms[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 3503--><p class="noindent" >
+ </p><!--l. 4056--><p class="noindent" >
that’s equivalent to </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printglossary</span><a
- id="dx1-21003"></a><span
+ id="dx1-27003"></a><span
class="cmtt-10">[type=acronym,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
@@ -6929,110 +8517,110 @@
</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-21004"></a> is used).
- <!--l. 3511--><p class="noindent" >If you are using <a
+ id="dx1-27004"></a> is used).
+ <!--l. 4064--><p class="noindent" >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-21005"></a><span
+ id="dx1-27005"></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. 3517--><p class="noindent" >If the <span
+ <!--l. 4070--><p class="noindent" >If the <span
class="cmss-10">acronym</span><a
- id="dx1-21006"></a> package option is used, <span
+ id="dx1-27006"></a> package option is used, <span
class="cmtt-10">\acronymtype</span><a
- id="dx1-21007"></a> is set to <span
+ id="dx1-27007"></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="#fn4x2" id="fn4x2-bk"><sup class="textsuperscript">2.4</sup></a></span><a
- id="x1-21008f4"></a>
+ id="x1-27008f4"></a>
Entries that are defined using <span
class="cmtt-10">\newacronym</span><a
- id="dx1-21014"></a> are placed in the glossary whose label is
+ id="dx1-27014"></a> are placed in the glossary whose label is
given by <span
class="cmtt-10">\acronymtype</span><a
- id="dx1-21015"></a>, unless another glossary is explicitly specified.
- </p><!--l. 3527--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
+ id="dx1-27015"></a>, unless another glossary is explicitly specified.
+ </p><!--l. 4080--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-21016"></a> package option if you’re only interested in using
+ id="dx1-27016"></a> package option if you’re only interested in using
this <span
class="cmtt-10">acronym </span>glossary. (That is, you don’t intend to use the <span
class="cmtt-10">main </span>glossary.)
</div>
- </p><!--l. 3531--><p class="noindent" >
+ </p><!--l. 4084--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">acronyms</span><a
- id="dx1-21017"></a> </dt><dd
+ id="dx1-27017"></a> </dt><dd
class="description">This is equivalent to <span
class="cmss-10">acronym=true</span><a
- id="dx1-21018"></a> and may be used in the document class option
+ id="dx1-27018"></a> and may be used in the document class option
list.
</dd><dt class="description">
<span
class="cmssbx-10">acronymlists</span><a
- id="dx1-21019"></a> </dt><dd
+ id="dx1-27019"></a> </dt><dd
class="description">By default, only the <span
class="cmtt-10">\acronymtype </span>glossary is considered to be a list of
acronyms. If you have other lists of acronyms, you can specify them as a
comma-separated list in the value of <span
class="cmss-10">acronymlists</span><a
- id="dx1-21020"></a>. For example, if you use the <span
+ id="dx1-27020"></a>. For example, if you use the <span
class="cmss-10">acronym</span><a
- id="dx1-21021"></a>
+ id="dx1-27021"></a>
package option but you also want the <span
class="cmtt-10">main </span>glossary to also contain a list of acronyms,
you can do:
- <div class="verbatim" id="verbatim-71">
+ <div class="verbatim" id="verbatim-109">
\usepackage[acronym,acronymlists={main}]{glossaries}
</div>
- <!--l. 3545--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add
+ <!--l. 4098--><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-72">
+ <div class="verbatim" id="verbatim-110">
\usepackage[acronym,acronymlists={main,acronym2}]
 <br />  {glossaries}
 <br />\newglossary[alg2]{acronym2}{acr2}{acn2}%
 <br />  {Statistical Acronyms}
</div>
- <!--l. 3553--><p class="nopar" > You can use
- </p><!--l. 3555--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4106--><p class="nopar" > You can use
+ </p><!--l. 4108--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\DeclareAcronymList</span><span
class="cmtt-9"> </span></span><a
- id="dx1-21022"></a> <span
+ id="dx1-27022"></a> <span
class="cmtt-10">\DeclareAcronymList{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 3557--><p class="noindent" >
+ </p><!--l. 4110--><p class="noindent" >
instead of or in addition to the <span
class="cmss-10">acronymlists</span><a
- id="dx1-21023"></a> option. This will add the glossaries given in
+ id="dx1-27023"></a> option. This will add the glossaries given in
⟨<span
class="cmti-10">list</span>⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of
acronym lists with a new list use:
- </p><!--l. 3562--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 4115--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\SetAcronymLists</span><span
class="cmtt-9"> </span></span><a
- id="dx1-21024"></a> <span
+ id="dx1-27024"></a> <span
class="cmtt-10">\SetAcronymLists{</span>⟨<span
class="cmitt-10">list</span>⟩<span
class="cmtt-10">} </span></div><hr>
- </p><!--l. 3564--><p class="noindent" >
- </p><!--l. 3566--><p class="noindent" >You can determine if a glossary has been identified as being a list of acronyms
+ </p><!--l. 4117--><p class="noindent" >
+ </p><!--l. 4119--><p class="noindent" >You can determine if a glossary has been identified as being a list of acronyms
using:
- </p><!--l. 3568--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 4121--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsIfListOfAcronyms</span><span
class="cmtt-9"> </span></span><a
- id="dx1-21025"></a> <span
+ id="dx1-27025"></a> <span
class="cmtt-10">\glsIfListOfAcronyms{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -7041,404 +8629,404 @@
class="cmitt-10">false part</span>⟩<span
class="cmtt-10">}</span>
</div><hr>
- </p><!--l. 3570--><p class="noindent" >
+ </p><!--l. 4123--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">shortcuts</span><a
- id="dx1-21026"></a> </dt><dd
+ id="dx1-27026"></a> </dt><dd
class="description">This option provides shortcut commands for acronyms. See <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
+class="tcrm-1000">§</span>13 </a><a
href="#sec:acronyms">Acronyms and
Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details. Alternatively you can use:
- <!--l. 3575--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4128--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\DefineAcronymSynonyms</span><span
class="cmtt-9"> </span></span><a
- id="dx1-21027"></a> <span
+ id="dx1-27027"></a> <span
class="cmtt-10">\DefineAcronymSynonyms </span></div><hr>
- </p><!--l. 3577--><p class="noindent" >
+ </p><!--l. 4130--><p class="noindent" >
</p></dd></dl>
-<!--l. 3580--><p class="noindent" >
+<!--l. 4133--><p class="noindent" >
</p>
-<!--l. 3580--><p class="noindent" ><a
+<!--l. 4133--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">2.5.1 </span> <a
id="sec:pkgopts-old-acronym"></a>Deprecated Acronym Style Options</h4>
-<!--l. 3583--><p class="noindent" >The package options listed in this section are now deprecated but are kept for
+<!--l. 4136--><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-22001"></a> instead. See <a
+ id="dx1-28001"></a> instead. See <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
+class="tcrm-1000">§</span>13 </a><a
href="#sec:acronyms">Acronyms and Other
Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details.
</p><dl class="description"><dt class="description">
<span
class="cmssbx-10">description</span><a
- id="dx1-22002"></a> </dt><dd
+ id="dx1-28002"></a> </dt><dd
class="description">This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-22003"></a> to allow a description. This
+ id="dx1-28003"></a> to allow a description. This
option may be replaced by
- <div class="verbatim" id="verbatim-73">
+ <div class="verbatim" id="verbatim-111">
\setacronymstyle{long-short-desc}
</div>
- <!--l. 3593--><p class="nopar" > or (with <span
+ <!--l. 4146--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-22004"></a>)
+ id="dx1-28004"></a>)
</p>
- <div class="verbatim" id="verbatim-74">
+ <div class="verbatim" id="verbatim-112">
\setacronymstyle{long-sc-short-desc}
</div>
- <!--l. 3597--><p class="nopar" > or (with <span
+ <!--l. 4150--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-22005"></a>)
+ id="dx1-28005"></a>)
</p>
- <div class="verbatim" id="verbatim-75">
+ <div class="verbatim" id="verbatim-113">
\setacronymstyle{long-sm-short-desc}
</div>
- <!--l. 3601--><p class="nopar" > or (with <span
+ <!--l. 4154--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-22006"></a>)
+ id="dx1-28006"></a>)
</p>
- <div class="verbatim" id="verbatim-76">
+ <div class="verbatim" id="verbatim-114">
\setacronymstyle{footnote-desc}
</div>
- <!--l. 3605--><p class="nopar" > or (with <span
+ <!--l. 4158--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-22007"></a> and <span
+ id="dx1-28007"></a> and <span
class="cmss-10">smallcaps</span><a
- id="dx1-22008"></a>)
+ id="dx1-28008"></a>)
</p>
- <div class="verbatim" id="verbatim-77">
+ <div class="verbatim" id="verbatim-115">
\setacronymstyle{footnote-sc-desc}
</div>
- <!--l. 3609--><p class="nopar" > or (with <span
+ <!--l. 4162--><p class="nopar" > or (with <span
class="cmss-10">footnote</span><a
- id="dx1-22009"></a> and <span
+ id="dx1-28009"></a> and <span
class="cmss-10">smaller</span><a
- id="dx1-22010"></a>)
+ id="dx1-28010"></a>)
</p>
- <div class="verbatim" id="verbatim-78">
+ <div class="verbatim" id="verbatim-116">
\setacronymstyle{footnote-sm-desc}
</div>
- <!--l. 3613--><p class="nopar" > or (with <span
+ <!--l. 4166--><p class="nopar" > or (with <span
class="cmss-10">dua</span><a
- id="dx1-22011"></a>)
+ id="dx1-28011"></a>)
</p>
- <div class="verbatim" id="verbatim-79">
+ <div class="verbatim" id="verbatim-117">
\setacronymstyle{dua-desc}
</div>
- <!--l. 3617--><p class="nopar" >
+ <!--l. 4170--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">smallcaps</span><a
- id="dx1-22012"></a> </dt><dd
+ id="dx1-28012"></a> </dt><dd
class="description">This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-22013"></a> and the way that acronyms are
+ id="dx1-28013"></a> and the way that acronyms are
displayed. This option may be replaced by:
- <div class="verbatim" id="verbatim-80">
+ <div class="verbatim" id="verbatim-118">
\setacronymstyle{long-sc-short}
</div>
- <!--l. 3624--><p class="nopar" > or (with <span
+ <!--l. 4177--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22014"></a>)
+ id="dx1-28014"></a>)
</p>
- <div class="verbatim" id="verbatim-81">
+ <div class="verbatim" id="verbatim-119">
\setacronymstyle{long-sc-short-desc}
</div>
- <!--l. 3628--><p class="nopar" > or (with <span
+ <!--l. 4181--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22015"></a> and <span
+ id="dx1-28015"></a> and <span
class="cmss-10">footnote</span><a
- id="dx1-22016"></a>)
+ id="dx1-28016"></a>)
</p>
- <div class="verbatim" id="verbatim-82">
+ <div class="verbatim" id="verbatim-120">
\setacronymstyle{footnote-sc-desc}
</div>
- <!--l. 3632--><p class="nopar" >
+ <!--l. 4185--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">smaller</span><a
- id="dx1-22017"></a> </dt><dd
+ id="dx1-28017"></a> </dt><dd
class="description">This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-22018"></a> and the way that acronyms are
+ id="dx1-28018"></a> and the way that acronyms are
displayed.
- <!--l. 3636--><p class="noindent" ><div class="important" title="Important Note"> If you use this option, you will need to include the <span
+ <!--l. 4189--><p class="noindent" ><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-22019"></a> package or otherwise define
+ id="dx1-28019"></a> package or otherwise define
<span
class="cmtt-10">\textsmaller</span><a
- id="dx1-22020"></a> or redefine <span
+ id="dx1-28020"></a> or redefine <span
class="cmtt-10">\acronymfont</span><a
- id="dx1-22021"></a>. </div>
- </p><!--l. 3640--><p class="noindent" >
+ id="dx1-28021"></a>. </div>
+ </p><!--l. 4193--><p class="noindent" >
This option may be replaced by:
</p>
- <div class="verbatim" id="verbatim-83">
+ <div class="verbatim" id="verbatim-121">
\setacronymstyle{long-sm-short}
</div>
- <!--l. 3644--><p class="nopar" > or (with <span
+ <!--l. 4197--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22022"></a>)
+ id="dx1-28022"></a>)
</p>
- <div class="verbatim" id="verbatim-84">
+ <div class="verbatim" id="verbatim-122">
\setacronymstyle{long-sm-short-desc}
</div>
- <!--l. 3648--><p class="nopar" > or (with <span
+ <!--l. 4201--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22023"></a> and <span
+ id="dx1-28023"></a> and <span
class="cmss-10">footnote</span><a
- id="dx1-22024"></a>)
+ id="dx1-28024"></a>)
</p>
- <div class="verbatim" id="verbatim-85">
+ <div class="verbatim" id="verbatim-123">
\setacronymstyle{footnote-sm-desc}
</div>
- <!--l. 3652--><p class="nopar" >
+ <!--l. 4205--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">footnote</span><a
- id="dx1-22025"></a> </dt><dd
+ id="dx1-28025"></a> </dt><dd
class="description">This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-22026"></a> and the way that acronyms are
+ id="dx1-28026"></a> and the way that acronyms are
displayed. This option may be replaced by:
- <div class="verbatim" id="verbatim-86">
+ <div class="verbatim" id="verbatim-124">
\setacronymstyle{footnote}
</div>
- <!--l. 3659--><p class="nopar" > or (with <span
+ <!--l. 4212--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-22027"></a>)
+ id="dx1-28027"></a>)
</p>
- <div class="verbatim" id="verbatim-87">
+ <div class="verbatim" id="verbatim-125">
\setacronymstyle{footnote-sc}
</div>
- <!--l. 3663--><p class="nopar" > or (with <span
+ <!--l. 4216--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-22028"></a>)
+ id="dx1-28028"></a>)
</p>
- <div class="verbatim" id="verbatim-88">
+ <div class="verbatim" id="verbatim-126">
\setacronymstyle{footnote-sm}
</div>
- <!--l. 3667--><p class="nopar" > or (with <span
+ <!--l. 4220--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22029"></a>)
+ id="dx1-28029"></a>)
</p>
- <div class="verbatim" id="verbatim-89">
+ <div class="verbatim" id="verbatim-127">
\setacronymstyle{footnote-desc}
</div>
- <!--l. 3671--><p class="nopar" > or (with <span
+ <!--l. 4224--><p class="nopar" > or (with <span
class="cmss-10">smallcaps</span><a
- id="dx1-22030"></a> and <span
+ id="dx1-28030"></a> and <span
class="cmss-10">description</span><a
- id="dx1-22031"></a>)
+ id="dx1-28031"></a>)
</p>
- <div class="verbatim" id="verbatim-90">
+ <div class="verbatim" id="verbatim-128">
\setacronymstyle{footnote-sc-desc}
</div>
- <!--l. 3675--><p class="nopar" > or (with <span
+ <!--l. 4228--><p class="nopar" > or (with <span
class="cmss-10">smaller</span><a
- id="dx1-22032"></a> and <span
+ id="dx1-28032"></a> and <span
class="cmss-10">description</span><a
- id="dx1-22033"></a>)
+ id="dx1-28033"></a>)
</p>
- <div class="verbatim" id="verbatim-91">
+ <div class="verbatim" id="verbatim-129">
\setacronymstyle{footnote-sm-desc}
</div>
- <!--l. 3679--><p class="nopar" >
+ <!--l. 4232--><p class="nopar" >
</p></dd><dt class="description">
<span
class="cmssbx-10">dua</span><a
- id="dx1-22034"></a> </dt><dd
+ id="dx1-28034"></a> </dt><dd
class="description">This option changes the definition of <span
class="cmtt-10">\newacronym</span><a
- id="dx1-22035"></a> so that acronyms are always
+ id="dx1-28035"></a> so that acronyms are always
expanded. This option may be replaced by:
- <div class="verbatim" id="verbatim-92">
+ <div class="verbatim" id="verbatim-130">
\setacronymstyle{dua}
</div>
- <!--l. 3687--><p class="nopar" > or (with <span
+ <!--l. 4240--><p class="nopar" > or (with <span
class="cmss-10">description</span><a
- id="dx1-22036"></a>)
+ id="dx1-28036"></a>)
</p>
- <div class="verbatim" id="verbatim-93">
+ <div class="verbatim" id="verbatim-131">
\setacronymstyle{dua-desc}
</div>
- <!--l. 3691--><p class="nopar" >
+ <!--l. 4244--><p class="nopar" >
</p>
</dd></dl>
-<!--l. 3695--><p class="noindent" >
+<!--l. 4248--><p class="noindent" >
</p>
-<!--l. 3695--><p class="noindent" ><a
+<!--l. 4248--><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-other"></a>Other Options</h3>
-<!--l. 3698--><p class="noindent" >Other available options that don’t fit any of the above categories are:
+<!--l. 4251--><p class="noindent" >Other available options that don’t fit any of the above categories are:
</p><dl class="description"><dt class="description">
<span
class="cmssbx-10">symbols</span><a
- id="dx1-23001"></a> </dt><dd
+ id="dx1-29001"></a> </dt><dd
class="description">This option defines a new glossary type with the label <span
class="cmtt-10">symbols </span>via
- <div class="verbatim" id="verbatim-94">
+ <div class="verbatim" id="verbatim-132">
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
</div>
- <!--l. 3705--><p class="nopar" > It also defines
- </p><!--l. 3707--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4258--><p class="nopar" > It also defines
+ </p><!--l. 4260--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\printsymbols</span><span
class="cmtt-9"> </span></span><a
- id="dx1-23002"></a> <span
+ id="dx1-29002"></a> <span
class="cmtt-10">\printsymbols[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 3709--><p class="noindent" >
+ </p><!--l. 4262--><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-23003"></a><span
+ id="dx1-29003"></a><span
class="cmtt-10">[type=symbols,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
- <!--l. 3715--><p class="noindent" >If you use <a
+ <!--l. 4268--><p class="noindent" >If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-23004"></a><span
+ id="dx1-29004"></a><span
class="cmtt-10">[type=symbols,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> to display the list of symbols.
- <!--l. 3721--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
+ <!--l. 4274--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-23005"></a> package option if you’re only interested in using this
+ id="dx1-29005"></a> package option if you’re only interested in using this
<span
class="cmtt-10">symbols </span>glossary and don’t intend to use the <span
class="cmtt-10">main </span>glossary. </div>
- </p><!--l. 3725--><p class="noindent" >
+ </p><!--l. 4278--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">numbers</span><a
- id="dx1-23006"></a> </dt><dd
+ id="dx1-29006"></a> </dt><dd
class="description">This option defines a new glossary type with the label <span
class="cmtt-10">numbers </span>via
- <div class="verbatim" id="verbatim-95">
+ <div class="verbatim" id="verbatim-133">
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
</div>
- <!--l. 3731--><p class="nopar" > It also defines
- </p><!--l. 3733--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4284--><p class="nopar" > It also defines
+ </p><!--l. 4286--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\printnumbers</span><span
class="cmtt-9"> </span></span><a
- id="dx1-23007"></a> <span
+ id="dx1-29007"></a> <span
class="cmtt-10">\printnumbers[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 3735--><p class="noindent" >
+ </p><!--l. 4288--><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-23008"></a><span
+ id="dx1-29008"></a><span
class="cmtt-10">[type=numbers,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
- <!--l. 3741--><p class="noindent" >If you use <a
+ <!--l. 4294--><p class="noindent" >If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-23009"></a><span
+ id="dx1-29009"></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. 3747--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
+ <!--l. 4300--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-23010"></a> package option if you’re only interested in using this
+ id="dx1-29010"></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. 3751--><p class="noindent" >
+ </p><!--l. 4304--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">index</span><a
- id="dx1-23011"></a> </dt><dd
+ id="dx1-29011"></a> </dt><dd
class="description">This option defines a new glossary type with the label <span
class="cmtt-10">index </span>via
- <div class="verbatim" id="verbatim-96">
+ <div class="verbatim" id="verbatim-134">
\newglossary[ilg]{index}{ind}{idx}{\indexname}%
</div>
- <!--l. 3757--><p class="nopar" > It also defines
- </p><!--l. 3759--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4310--><p class="nopar" > It also defines
+ </p><!--l. 4312--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\newterm</span><span
class="cmtt-9"> </span></span><a
- id="dx1-23012"></a> <span
+ id="dx1-29012"></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. 3761--><p class="noindent" >
+ </p><!--l. 4314--><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-23013"></a><span
+ id="dx1-29013"></a><span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">term</span>⟩<span
class="cmtt-10">}[type=index,name={</span>⟨<span
@@ -7446,186 +9034,196 @@
class="cmtt-10">},%</span>
<br /><span
class="cmtt-10">description=\nopostdesc</span><a
- id="dx1-23014"></a><span
+ id="dx1-29014"></a><span
class="cmtt-10">,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div> and
- <!--l. 3768--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4321--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\printindex</span><span
class="cmtt-9"> </span></span><a
- id="dx1-23015"></a> <span
+ id="dx1-29015"></a> <span
class="cmtt-10">\printindex[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 3770--><p class="noindent" >
+ </p><!--l. 4323--><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-23016"></a><span
+ id="dx1-29016"></a><span
class="cmtt-10">[type=index,</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">]</span>
</div>
</div>
- <!--l. 3776--><p class="noindent" >If you use <a
+ <!--l. 4329--><p class="noindent" >If you use <a
href="#option1">Option 1</a>, you need to use: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-23017"></a><span
+ id="dx1-29017"></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. 3782--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
+ <!--l. 4335--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span
class="cmss-10">nomain</span><a
- id="dx1-23018"></a> package option if you’re only interested in using this
+ id="dx1-29018"></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-23019"></a>. Either use <span
+ id="dx1-29019"></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-23020"></a>, <span
+ id="dx1-29020"></a>, <span
class="cmss-10">index</span><a
- id="dx1-23021"></a> or <span
+ id="dx1-29021"></a> or <span
class="cmss-10">imakeidx</span><a
- id="dx1-23022"></a>. (You can, of course, load
+ id="dx1-29022"></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-23023"></a> package option.)
+ id="dx1-29023"></a> package option.)
</div>
- </p><!--l. 3791--><p class="noindent" >
+ </p><!--l. 4344--><p class="noindent" >
- </p><!--l. 3793--><p class="noindent" >Since the index isn’t designed for terms with descriptions, you might also want to
+ </p><!--l. 4346--><p class="noindent" >Since the index isn’t designed for terms with descriptions, you might also want to
disable the hyperlinks for this glossary using the package option <span
class="cmss-10">nohypertypes=index</span><a
- id="dx1-23024"></a> or
+ id="dx1-29024"></a> or
the command <spacer type=vertical size=10><span class="obeylines-h">
<br /><span
class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-23025"></a><span class="verb"><span
+ id="dx1-29025"></a><span class="verb"><span
class="cmtt-10">{index}</span></span>
<br /><spacer type=vertical size=10></span>
- </p><!--l. 3800--><p class="noindent" >The example file <a
-href="#x1-5092r27"><span
+ </p><!--l. 4353--><p class="noindent" >The example file <a
+href="#x1-11101r28"><span
class="cmtt-10">sample-index.tex</span></a> illustrates the use of the <span
class="cmss-10">index</span><a
- id="dx1-23026"></a> package
+ id="dx1-29026"></a> package
option.
</p></dd><dt class="description">
<span
class="cmssbx-10">compatible-2.07</span><a
- id="dx1-23027"></a> </dt><dd
+ id="dx1-29027"></a> </dt><dd
class="description">Compatibility mode for old documents created using version 2.07 or
below.
</dd><dt class="description">
<span
class="cmssbx-10">compatible-3.07</span><a
- id="dx1-23028"></a> </dt><dd
+ id="dx1-29028"></a> </dt><dd
class="description">Compatibility mode for old documents created using version 3.07 or
below.
</dd></dl>
-<!--l. 3811--><p class="noindent" >
+<!--l. 4364--><p class="noindent" >
</p>
-<!--l. 3811--><p class="noindent" ><a
+<!--l. 4364--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.7 </span> <a
id="sec:setupglossaries"></a>Setting Options After the Package is Loaded</h3>
-<!--l. 3814--><p class="noindent" >Some of the options described above may also be set after the <span
+<!--l. 4367--><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. 3816--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4369--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\setupglossaries</span><span
class="cmtt-9"> </span></span><a
- id="dx1-24001"></a> <span
+ id="dx1-30001"></a> <span
class="cmtt-10">\setupglossaries{</span>⟨<span
class="cmitt-10">key-val list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3818--><p class="noindent" >
+</p><!--l. 4371--><p class="noindent" >
The following package options <span
class="cmbx-10">can’t </span>be used in <span
class="cmtt-10">\setupglossaries</span>: <span
class="cmss-10">xindy</span><a
- id="dx1-24002"></a>, <span
+ id="dx1-30002"></a>, <span
class="cmss-10">xindygloss</span><a
- id="dx1-24003"></a>,
+ id="dx1-30003"></a>,
<span
class="cmss-10">xindynoglsnumbers</span><a
- id="dx1-24004"></a>, <span
+ id="dx1-30004"></a>, <span
class="cmss-10">makeindex</span><a
- id="dx1-24005"></a>, <span
+ id="dx1-30005"></a>, <span
class="cmss-10">nolong</span><a
- id="dx1-24006"></a>, <span
+ id="dx1-30006"></a>, <span
class="cmss-10">nosuper</span><a
- id="dx1-24007"></a>, <span
+ id="dx1-30007"></a>, <span
class="cmss-10">nolist</span><a
- id="dx1-24008"></a>, <span
+ id="dx1-30008"></a>, <span
class="cmss-10">notree</span><a
- id="dx1-24009"></a>, <span
+ id="dx1-30009"></a>, <span
class="cmss-10">nostyles</span><a
- id="dx1-24010"></a>, <span
+ id="dx1-30010"></a>, <span
class="cmss-10">nomain</span><a
- id="dx1-24011"></a>, <span
+ id="dx1-30011"></a>, <span
class="cmss-10">compatible-2.07</span><a
- id="dx1-24012"></a>,
+ id="dx1-30012"></a>,
<span
class="cmss-10">translate</span><a
- id="dx1-24013"></a>, <span
+ id="dx1-30013"></a>, <span
class="cmss-10">notranslate</span><a
- id="dx1-24014"></a>, <span
+ id="dx1-30014"></a>, <span
class="cmss-10">acronym</span><a
- id="dx1-24015"></a>. These options have to be set while the package is loading,
+ id="dx1-30015"></a>. These options have to be set while the package is loading,
except for the <span
class="cmss-10">xindy</span><a
- id="dx1-24016"></a> sub-options which can be set using commands like <span
+ id="dx1-30016"></a> sub-options which can be set using commands like <span
class="cmtt-10">\GlsSetXdyLanguage</span><a
- id="dx1-24017"></a>
+ id="dx1-30017"></a>
(see <a
href="#sec:xindy"><span
-class="cmsy-10">§</span>11 </a><a
+class="tcrm-1000">§</span>11 </a><a
href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details).
-</p><!--l. 3830--><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. 4383--><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-24018"></a>) after you have started defining your
+ id="dx1-30018"></a>) after you have started defining your
acronyms, you are likely to get unexpected results. If you try changing the sort
option after you have started to define entries, you may get unexpected results.
</div>
-</p><!--l. 3838--><p class="noindent" >
+</p><!--l. 4391--><p class="noindent" >
</p>
-<!--l. 3840--><p class="indent" > </div>
-</p><!--l. 3840--><p class="noindent" ><a
+<!--l. 4393--><p class="indent" > </div>
+</p><!--l. 4393--><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. 3843--><p class="indent" > In the preamble you need to indicate whether you want to use <a
+</p><!--l. 4396--><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.
+href="#option3">Option 3</a>. It’s not possible to mix these options within a document, although some
+combinations are possible with <span
+class="cmss-10">glossaries-extra</span>. (For Options <a
+href="#option4">4</a> and <a
+href="#option5">5</a> see the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-31001"></a></a> and
+<a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> manuals.)
</p>
-<!--l. 3847--><p class="noindent" ><a
+<!--l. 4402--><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. 3850--><p class="noindent" >The command
-</p><!--l. 3851--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 4405--><p class="noindent" >The command
+</p><!--l. 4406--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\makenoidxglossaries</span><span
class="cmtt-9"> </span></span><a
- id="dx1-26001"></a> <span
+ id="dx1-32001"></a> <span
class="cmtt-10">\makenoidxglossaries </span></div><hr>
-</p><!--l. 3853--><p class="noindent" >
+</p><!--l. 4408--><p class="noindent" >
must be placed in the preamble. This sets up the internal commands required to make
<a
href="#option1">Option 1</a> work. <span
@@ -7634,30 +9232,30 @@
class="cmbx-10">none of the glossaries will be</span>
<span
class="cmbx-10">displayed.</span>
-</p><!--l. 3859--><p class="noindent" >
+</p><!--l. 4414--><p class="noindent" >
</p>
-<!--l. 3859--><p class="noindent" ><a
+<!--l. 4414--><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. 3862--><p class="noindent" >The command
-</p><!--l. 3863--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 4417--><p class="noindent" >The command
+</p><!--l. 4418--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\makeglossaries</span><span
class="cmtt-9"> </span></span><a
- id="dx1-27001"></a> <span
+ id="dx1-33001"></a> <span
class="cmtt-10">\makeglossaries </span></div><hr>
-</p><!--l. 3865--><p class="noindent" >
+</p><!--l. 4420--><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-27002"></a></a> (<span
+ id="dx1-33002"></a></a> (<span
class="cmtt-10">.ist</span><a
- id="dx1-27003"></a>) or <a
+ id="dx1-33003"></a>) or <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-27004"></a></a>
+ id="dx1-33004"></a></a>
(<span
class="cmtt-10">.xdy</span><a
- id="dx1-27005"></a>) style file (for Options <a
+ id="dx1-33005"></a>) style file (for Options <a
href="#option2">2</a> or <a
href="#option3">3</a>, respectively) and to ensure that glossary entries are
written to the appropriate output files. <span
@@ -7666,7 +9264,7 @@
class="cmbx-10">none of the</span>
<span
class="cmbx-10">glossary files will be created.</span>
-</p><!--l. 3873--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span
+</p><!--l. 4428--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span
class="cmss-10">glossaries </span>package must not be used
after <span
class="cmtt-10">\makeglossaries </span>as they are required when creating the customised style file. If
@@ -7673,169 +9271,186 @@
you attempt to use those commands after <span
class="cmtt-10">\makeglossaries </span>you will generate an
error.
-</p><!--l. 3880--><p class="indent" > Similarly, there are some commands that must not be used before <span
+</p><!--l. 4435--><p class="indent" > Similarly, there are some commands that must not be used before <span
class="cmtt-10">\makeglossaries</span>.
</div>
-</p><!--l. 3882--><p class="noindent" >
-</p><!--l. 3884--><p class="indent" > You can suppress the creation of the customised <a
+</p><!--l. 4437--><p class="noindent" >
+</p><!--l. 4439--><p class="indent" > You can suppress the creation of the customised <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-27006"></a></a> or <a
+ id="dx1-33006"></a></a> or <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-27007"></a></a> style file
+ id="dx1-33007"></a></a> style file
using
-</p><!--l. 3886--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4441--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\noist</span><span
class="cmtt-9"> </span></span><a
- id="dx1-27008"></a> <span
+ id="dx1-33008"></a> <span
class="cmtt-10">\noist </span></div><hr>
-</p><!--l. 3888--><p class="noindent" >
+</p><!--l. 4443--><p class="noindent" >
That this command must not be used after <span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 3890--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span
+</p><!--l. 4445--><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-27009"></a> file created when using <span
+ id="dx1-33009"></a> file created when using <span
class="cmss-10">glossaries </span>version 2.07 or
below, you will need to use the <span
class="cmss-10">compatible-2.07</span><a
- id="dx1-27010"></a> package option with it. </div>
-</p><!--l. 3894--><p class="noindent" >
-</p><!--l. 3896--><p class="indent" > The default name for the customised style file is given by <span
+ id="dx1-33010"></a> package option with it. </div>
+</p><!--l. 4449--><p class="noindent" >
+
+
+</p><!--l. 4451--><p class="indent" > The default name for the customised style file is given by <span
class="cmtt-10">\jobname</span><a
- id="dx1-27011"></a><span
+ id="dx1-33011"></a><span
class="cmtt-10">.ist</span><a
- id="dx1-27012"></a> (<a
+ id="dx1-33012"></a> (<a
href="#option2">Option 2</a>) or
<span
class="cmtt-10">\jobname</span><a
- id="dx1-27013"></a><span
+ id="dx1-33013"></a><span
class="cmtt-10">.xdy</span><a
- id="dx1-27014"></a> (<a
+ id="dx1-33014"></a> (<a
href="#option3">Option 3</a>). This name may be changed using:
-
-
-</p><!--l. 3900--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4455--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\setStyleFile</span><span
class="cmtt-9"> </span></span><a
- id="dx1-27015"></a> <span
+ id="dx1-33015"></a> <span
class="cmtt-10">\setStyleFile{</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3902--><p class="noindent" >
+</p><!--l. 4457--><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. 3907--><p class="indent" > Each glossary entry is assigned a <a
+</p><!--l. 4462--><p class="indent" > Each glossary entry is assigned a <a
href="#glo:numberlist">number list<a
- id="dx1-27016"></a></a> that lists all the locations in the document
+ id="dx1-33016"></a></a> that lists all the locations in the document
where that entry was used. By default, the location refers to the page number but this may
be overridden using the <span
class="cmss-10">counter</span><a
- id="dx1-27017"></a> package option. The default form of the location number
+ id="dx1-33017"></a> package option. The default form of the location number
assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different
compositor (e.g. 1-2) you need to set this using
-</p><!--l. 3914--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4469--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsSetCompositor</span><span
class="cmtt-9"> </span></span><a
- id="dx1-27018"></a> <span
+ id="dx1-33018"></a> <span
class="cmtt-10">\glsSetCompositor{</span>⟨<span
class="cmitt-10">symbol</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3916--><p class="noindent" >
+</p><!--l. 4471--><p class="noindent" >
For example:
</p>
- <div class="verbatim" id="verbatim-97">
+ <div class="verbatim" id="verbatim-135">
\glsSetCompositor{-}
</div>
-<!--l. 3920--><p class="nopar" > This command must not be used after <span
+<!--l. 4475--><p class="nopar" > This command must not be used after <span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 3923--><p class="indent" > If you use <a
+</p><!--l. 4478--><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. 3925--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4480--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsSetAlphaCompositor</span><span
class="cmtt-9"> </span></span><a
- id="dx1-27019"></a> <span
+ id="dx1-33019"></a> <span
class="cmtt-10">\glsSetAlphaCompositor{</span>⟨<span
class="cmitt-10">symbol</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3927--><p class="noindent" >
+</p><!--l. 4482--><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-27020"></a>s</a>
+ id="dx1-33020"></a>s</a>
containing a mixture of A-1 and 2.3 style formats, then do:
</p>
- <div class="verbatim" id="verbatim-98">
+ <div class="verbatim" id="verbatim-136">
\glsSetCompositor{.}\glsSetAlphaCompositor{-}
</div>
-<!--l. 3933--><p class="nopar" > See <a
+<!--l. 4488--><p class="nopar" > See <a
href="#sec:numberlists"><span
-class="cmsy-10">§</span>5 </a><a
+class="tcrm-1000">§</span>5 </a><a
href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about <a
href="#glo:numberlist">number list<a
- id="dx1-27021"></a>s</a>.
+ id="dx1-33021"></a>s</a>.
</p>
-<!--l. 3937--><p class="indent" > </div>
-</p><!--l. 3937--><p class="noindent" ><a
+<!--l. 4492--><p class="indent" > </div>
+</p><!--l. 4492--><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. 3940--><p class="indent" > All glossary entries must be defined before they are used, so it is better to define them in
+</p><!--l. 4495--><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
+class="cmtt-10">\longnewglossaryentry</span>
+may only be used in the preamble. See <a
href="#sec:docdefs"><span
-class="cmsy-10">§</span>4.8 </a><a
+class="tcrm-1000">§</span>4.8 </a><a
+href="#sec:docdefs">Drawbacks With Defining Entries in
+the Document Environment<!--tex4ht:ref: sec:docdefs --></a> for a discussion of the problems with defining entries
+within the document instead of in the preamble. (The <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> package has an
+option that provides a restricted form of document definitions that avoids some of
+the issues discussed in <a
+href="#sec:docdefs"><span
+class="tcrm-1000">§</span>4.8 </a><a
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.
-</p><!--l. 3946--><p class="indent" > <div class="important" title="Important Note"> <a
+Environment<!--tex4ht:ref: sec:docdefs --></a>.)
+</p><!--l. 4504--><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-28001"></a>. </div>
-</p><!--l. 3949--><p class="noindent" >
-</p><!--l. 3951--><p class="indent" > Only those entries that are referenced in the document (using any of the commands
+ id="dx1-34001"></a>. <a
+href="#option4">Option 4</a>
+requires that definitions are provided in <span
+class="cmtt-10">.bib </span>format. <a
+href="#option5">Option 5</a> requires either
+preamble-only definitions or the use of the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-34002"></a> package option <span
+class="cmss-10">docdef=restricted</span>.
+</div>
+</p><!--l. 4510--><p class="noindent" >
+</p><!--l. 4512--><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="cmsy-10">§</span>6 </a><a
+class="tcrm-1000">§</span>6 </a><a
href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a
href="#sec:glsadd"><span
-class="cmsy-10">§</span>7 </a><a
+class="tcrm-1000">§</span>7 </a><a
href="#sec:glsadd">Adding an Entry to the Glossary Without
Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a
href="#sec:crossref"><span
-class="cmsy-10">§</span>8 </a><a
+class="tcrm-1000">§</span>8 </a><a
href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. See <a
href="#sec:printglossary"><span
-class="cmsy-10">§</span>10
+class="tcrm-1000">§</span>10
</a><a
href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the glossary.
-</p><!--l. 3959--><p class="indent" > New glossary entries are defined using the command:
-</p><!--l. 3960--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4520--><p class="indent" > New glossary entries are defined using the command:
+</p><!--l. 4521--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\newglossaryentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28002"></a> <span
+ id="dx1-34003"></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. 3962--><p class="noindent" >
+</p><!--l. 4523--><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. If you
have a long description that needs to span multiple paragraphs, use
-</p><!--l. 3966--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4527--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\longnewglossaryentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28003"></a> <span
+ id="dx1-34004"></a> <span
class="cmtt-10">\longnewglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -7845,7 +9460,7 @@
<span
class="cmitt-10">description</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 3969--><p class="noindent" >
+</p><!--l. 4530--><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
@@ -7853,12 +9468,12 @@
but won’t remove leading spaces (otherwise it would interfere with commands like
<span
class="cmtt-10">\Glsentrydesc</span>).
-</p><!--l. 3976--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been
+</p><!--l. 4537--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been
defined:
-</p><!--l. 3978--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4539--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\provideglossaryentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28004"></a> <span
+ id="dx1-34005"></a> <span
class="cmtt-10">\provideglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -7865,246 +9480,264 @@
class="cmitt-10">key=value list</span>⟩<span
class="cmtt-10">}</span>
</div><hr>
-</p><!--l. 3980--><p class="noindent" >
+</p><!--l. 4541--><p class="noindent" >
and
-</p><!--l. 3982--><p class="indent" > <span class="marginpar"><span
+</p><!--l. 4543--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\longprovideglossaryentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28005"></a>
-</p><!--l. 3984--><p class="indent" > <hr><div title="Definition"><span
+ id="dx1-34006"></a> <span
class="cmtt-10">\longprovideglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">key=value list</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
+class="cmtt-10">}</span>
+<span
+class="cmtt-10">{</span>⟨<span
class="cmitt-10">long description</span>⟩<span
-class="cmtt-10">}</span>
-</div><hr>
-</p><!--l. 3986--><p class="noindent" >
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 4546--><p class="noindent" >
(These are both preamble-only commands.)
-</p><!--l. 3989--><p class="indent" > For all the above commands, the first argument, ⟨<span
+</p><!--l. 4549--><p class="indent" > For all the above commands, the first argument, ⟨<span
class="cmti-10">label</span>⟩, must be a unique label with which
to identify this entry. <span
class="cmbx-10">This can’t contain any non-expandable commands</span>
<span
class="cmbx-10">or active characters. </span>The reason for this restriction is that the label is used to
+
+
construct internal commands that store the associated information (similarly to
commands like <span
class="cmtt-10">\label</span>) and therefore must be able to expand to a valid control sequence
name.
-</p><!--l. 3997--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a
+</p><!--l. 4557--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a
href="#glo:exlatinchar">extended Latin character<a
- id="dx1-28006"></a></a> or other <a
+ id="dx1-34007"></a></a> or other <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-28007"></a></a>, such as é
+ id="dx1-34008"></a></a>, such as é
or ß, looks like a plain character in your <span
class="cmtt-10">.tex </span>file, it’s actually a macro (an active character)
-
-
and therefore can’t be used in the label. (This applies to <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> rather than XeLaTeX.)
Also be careful of <span
class="cmss-10">babel</span><a
- id="dx1-28008"></a>’s options that change certain punctuation characters (such as <span
+ id="dx1-34009"></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. 4005--><p class="noindent" >
-</p><!--l. 4007--><p class="indent" > The second argument, ⟨<span
+</p><!--l. 4565--><p class="noindent" >
+</p><!--l. 4567--><p class="indent" > The second argument, ⟨<span
class="cmti-10">key=value list</span>⟩, is a ⟨<span
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ list that supplies the relevant
information about this entry. There are two required fields: <span
class="cmss-10">description</span><a
- id="dx1-28009"></a> and either <span
+ id="dx1-34010"></a> and either <span
class="cmss-10">name</span><a
- id="dx1-28010"></a> or
+ id="dx1-34011"></a> or
<span
class="cmss-10">parent</span><a
- id="dx1-28011"></a>. The description is set in the third argument of <span
+ id="dx1-34012"></a>. The description is set in the third argument of <span
class="cmtt-10">\longnewglossaryentry </span>and
<span
class="cmtt-10">\longprovideglossaryentry</span>. With the other commands it’s set via the <span
class="cmss-10">description</span><a
- id="dx1-28012"></a> key. As is
+ id="dx1-34013"></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:
+braces. Available fields are listed below. Additional fields are provided by the supplementary
+packages <span
+class="cmss-10">glossaries-prefix</span><a
+ id="dx1-34014"></a> (<a
+href="#sec:prefix"><span
+class="tcrm-1000">§</span>17 </a><a
+href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span
+class="cmss-10">glossaries-accsupp</span><a
+ id="dx1-34015"></a> (<a
+href="#sec:accsupp"><span
+class="tcrm-1000">§</span>18
+</a><a
+href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>) and also by <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a>. You can also define your own custom keys
+(see <a
+href="#sec:addkey"><span
+class="tcrm-1000">§</span>4.3 </a><a
+href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>).
</p><dl class="description"><dt class="description">
<span
class="cmssbx-10">name</span><a
- id="dx1-28013"></a> </dt><dd
+ id="dx1-34016"></a> </dt><dd
class="description">The name of the entry (as it will appear in the glossary). If this key is omitted
and the <span
class="cmss-10">parent</span><a
- id="dx1-28014"></a> key is supplied, this value will be the same as the parent’s name.
- <!--l. 4023--><p class="noindent" ><div class="important" title="Important Note"> If the <span
+ id="dx1-34017"></a> key is supplied, this value will be the same as the parent’s name.
+ <!--l. 4588--><p class="noindent" ><div class="important" title="Important Note"> If the <span
class="cmss-10">name</span><a
- id="dx1-28015"></a> key contains any commands, you must also use the <span
+ id="dx1-34018"></a> key contains any commands, you must also use the <span
class="cmss-10">sort</span><a
- id="dx1-28016"></a> key (described
+ id="dx1-34019"></a> key (described
below) if you intend sorting the entries alphabetically, otherwise the entries can’t be
sorted correctly. </div>
- </p><!--l. 4027--><p class="noindent" >
+ </p><!--l. 4592--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">description</span><a
- id="dx1-28017"></a> </dt><dd
+ id="dx1-34020"></a> </dt><dd
class="description">A brief description of this term (to appear in the glossary). Within this value,
you can use
- <!--l. 4031--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ <!--l. 4596--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\nopostdesc</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28018"></a> <span
+ id="dx1-34021"></a> <span
class="cmtt-10">\nopostdesc </span></div><hr>
- </p><!--l. 4033--><p class="noindent" >
+ </p><!--l. 4598--><p class="noindent" >
to suppress the description terminator for this entry. For example, if this
entry is a parent entry that doesn’t require a description, you can do
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">description={\nopostdesc}</span></span></span>. If you want a paragraph break in the description
use
- </p><!--l. 4039--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
+ </p><!--l. 4604--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glspar</span><span
class="cmtt-9"> </span></span><a
- id="dx1-28019"></a> <span
+ id="dx1-34022"></a> <span
class="cmtt-10">\glspar </span></div><hr>
- </p><!--l. 4041--><p class="noindent" >
+ </p><!--l. 4606--><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-28020"></a> not <span class="obeylines-h"><span class="verb"><span
+ id="dx1-34023"></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></dd><dt class="description">
+
+
<span
class="cmssbx-10">parent</span><a
- id="dx1-28021"></a> </dt><dd
+ id="dx1-34024"></a> </dt><dd
class="description">The label of the parent entry. Note that the parent entry must be defined before its
sub-entries. See <a
href="#sec:subentries"><span
-class="cmsy-10">§</span>4.5 </a><a
+class="tcrm-1000">§</span>4.5 </a><a
href="#sec:subentries">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details.
</dd><dt class="description">
<span
class="cmssbx-10">descriptionplural</span><a
- id="dx1-28022"></a> </dt><dd
+ id="dx1-34025"></a> </dt><dd
class="description">The plural form of the description, if required. If omitted, the value is set to
the same as the <span
class="cmss-10">description</span><a
- id="dx1-28023"></a> key.
+ id="dx1-34026"></a> key.
</dd><dt class="description">
<span
class="cmssbx-10">text</span><a
- id="dx1-28024"></a> </dt><dd
+ id="dx1-34027"></a> </dt><dd
class="description">How this entry will appear in the document text when using <span
class="cmtt-10">\gls</span><a
- id="dx1-28025"></a> (or one of its
-
-
+ id="dx1-34028"></a> (or one of its
upper case variants). If this field is omitted, the value of the <span
class="cmss-10">name</span><a
- id="dx1-28026"></a> key is
+ id="dx1-34029"></a> key is
used.
</dd><dt class="description">
<span
class="cmssbx-10">first</span><a
- id="dx1-28027"></a> </dt><dd
+ id="dx1-34030"></a> </dt><dd
class="description">How the entry will appear in the document text on <a
href="#glo:firstuse">first use</a> with <span
class="cmtt-10">\gls</span><a
- id="dx1-28028"></a> (or one of its
+ id="dx1-34031"></a> (or one of its
upper case variants). If this field is omitted, the value of the <span
class="cmss-10">text</span><a
- id="dx1-28029"></a> key is used. Note that
+ id="dx1-34032"></a> key is used. Note that
if you use <span
class="cmtt-10">\glspl</span><a
- id="dx1-28030"></a>, <span
+ id="dx1-34033"></a>, <span
class="cmtt-10">\Glspl</span><a
- id="dx1-28031"></a>, <span
+ id="dx1-34034"></a>, <span
class="cmtt-10">\GLSpl</span><a
- id="dx1-28032"></a>, <span
+ id="dx1-34035"></a>, <span
class="cmtt-10">\glsdisp</span><a
- id="dx1-28033"></a> before using <span
+ id="dx1-34036"></a> before using <span
class="cmtt-10">\gls</span><a
- id="dx1-28034"></a>, the <span
+ id="dx1-34037"></a>, the <span
class="cmss-10">firstplural</span><a
- id="dx1-28035"></a> value
+ id="dx1-34038"></a> value
won’t be used with <span
class="cmtt-10">\gls</span><a
- id="dx1-28036"></a>.
+ id="dx1-34039"></a>.
</dd><dt class="description">
<span
class="cmssbx-10">plural</span><a
- id="dx1-28037"></a> </dt><dd
+ id="dx1-34040"></a> </dt><dd
class="description">How the entry will appear in the document text when using <span
class="cmtt-10">\glspl</span><a
- id="dx1-28038"></a> (or one
+ id="dx1-34041"></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-28039"></a> to the value of the <span
+ id="dx1-34042"></a> to the value of the <span
class="cmss-10">text</span><a
- id="dx1-28040"></a> field. The default value of
+ id="dx1-34043"></a> field. The default value of
<span
class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-28041"></a> is the letter “s”.
+ id="dx1-34044"></a> is the letter “s”.
</dd><dt class="description">
<span
class="cmssbx-10">firstplural</span><a
- id="dx1-28042"></a> </dt><dd
+ id="dx1-34045"></a> </dt><dd
class="description">How the entry will appear in the document text on <a
href="#glo:firstuse">first use</a> with <span
class="cmtt-10">\glspl</span><a
- id="dx1-28043"></a> (or one
+ id="dx1-34046"></a> (or one
of its upper case variants). If this field is omitted, the value is obtained from the <span
class="cmss-10">plural</span><a
- id="dx1-28044"></a>
+ id="dx1-34047"></a>
key, if the <span
class="cmss-10">first</span><a
- id="dx1-28045"></a> key is omitted, or by appending <span
+ id="dx1-34048"></a> key is omitted, or by appending <span
class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-28046"></a> to the value of
+ id="dx1-34049"></a> to the value of
the <span
class="cmss-10">first</span><a
- id="dx1-28047"></a> field, if the <span
+ id="dx1-34050"></a> field, if the <span
class="cmss-10">first</span><a
- id="dx1-28048"></a> field is present. Note that if you use <span
+ id="dx1-34051"></a> field is present. Note that if you use <span
class="cmtt-10">\gls</span><a
- id="dx1-28049"></a>, <span
+ id="dx1-34052"></a>, <span
class="cmtt-10">\Gls</span><a
- id="dx1-28050"></a>,
+ id="dx1-34053"></a>,
<span
class="cmtt-10">\GLS</span><a
- id="dx1-28051"></a>, <span
+ id="dx1-34054"></a>, <span
class="cmtt-10">\glsdisp </span>before using <span
class="cmtt-10">\glspl</span><a
- id="dx1-28052"></a>, the <span
+ id="dx1-34055"></a>, the <span
class="cmss-10">firstplural</span><a
- id="dx1-28053"></a> value won’t be used with
+ id="dx1-34056"></a> value won’t be used with
<span
class="cmtt-10">\glspl</span><a
- id="dx1-28054"></a>.
- <!--l. 4083--><p class="noindent" ><span
+ id="dx1-34057"></a>.
+ <!--l. 4648--><p class="noindent" ><span
class="cmbx-10">Note: </span>prior to version 1.13, the default value of <span
class="cmss-10">firstplural</span><a
- id="dx1-28055"></a> was always taken by
+ id="dx1-34058"></a> was always taken by
appending “s” to the <span
class="cmss-10">first</span><a
- id="dx1-28056"></a> key, which meant that you had to specify both <span
+ id="dx1-34059"></a> key, which meant that you had to specify both <span
class="cmss-10">plural</span><a
- id="dx1-28057"></a> and
+ id="dx1-34060"></a> and
<span
class="cmss-10">firstplural</span><a
- id="dx1-28058"></a>, even if you hadn’t used the <span
+ id="dx1-34061"></a>, even if you hadn’t used the <span
class="cmss-10">first</span><a
- id="dx1-28059"></a> key.
+ id="dx1-34062"></a> key.
</p></dd><dt class="description">
<span
class="cmssbx-10">symbol</span><a
- id="dx1-28060"></a> </dt><dd
+ id="dx1-34063"></a> </dt><dd
class="description">This field is provided to allow the user to specify an associated symbol. If
omitted, the value is set to <span
class="cmtt-10">\relax</span>. Note that not all glossary styles display the
@@ -8112,50 +9745,52 @@
</dd><dt class="description">
<span
class="cmssbx-10">symbolplural</span><a
- id="dx1-28061"></a> </dt><dd
+ id="dx1-34064"></a> </dt><dd
class="description">This is the plural form of the symbol (as passed to <span
class="cmtt-10">\glsdisplay</span><a
- id="dx1-28062"></a> and
+ id="dx1-34065"></a> and
<span
class="cmtt-10">\glsdisplayfirst</span><a
- id="dx1-28063"></a> by <span
+ id="dx1-34066"></a> by <span
class="cmtt-10">\glspl</span><a
- id="dx1-28064"></a>, <span
+ id="dx1-34067"></a>, <span
class="cmtt-10">\Glspl</span><a
- id="dx1-28065"></a> and <span
+ id="dx1-34068"></a> and <span
class="cmtt-10">\GLSpl</span><a
- id="dx1-28066"></a>). If omitted, the value is set to the
+ id="dx1-34069"></a>). If omitted, the value is set to the
same as the <span
class="cmss-10">symbol</span><a
- id="dx1-28067"></a> key.
+ id="dx1-34070"></a> key.
</dd><dt class="description">
<span
class="cmssbx-10">sort</span><a
- id="dx1-28068"></a> </dt><dd
+ id="dx1-34071"></a> </dt><dd
class="description">This value indicates how this entry should be sorted. If omitted, the value is given by the
<span
class="cmss-10">name</span><a
- id="dx1-28069"></a> field unless one of the package options <span
+ id="dx1-34072"></a> field unless one of the package options <span
class="cmss-10">sort=def</span><a
- id="dx1-28070"></a> and <span
+ id="dx1-34073"></a> and <span
class="cmss-10">sort=use</span><a
- id="dx1-28071"></a> have been
+ id="dx1-34074"></a> have been
used. In general, it’s best to use the <span
class="cmss-10">sort</span><a
- id="dx1-28072"></a> key if the <span
+ id="dx1-34075"></a> key if the <span
class="cmss-10">name</span><a
- id="dx1-28073"></a> contains commands
+ id="dx1-34076"></a> contains commands
+
+
(e.g. <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\ensuremath{\alpha}</span></span></span>). You can also override the <span
class="cmss-10">sort</span><a
- id="dx1-28074"></a> key by redefining
+ id="dx1-34077"></a> key by redefining
<span
class="cmtt-10">\glsprestandardsort</span><a
- id="dx1-28075"></a> (see <a
+ id="dx1-34078"></a> (see <a
href="#sec:pkgopts-sort"><span
-class="cmsy-10">§</span>2.4 </a><a
+class="tcrm-1000">§</span>2.4 </a><a
href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>).
- <!--l. 4107--><p class="noindent" ><a
+ <!--l. 4672--><p class="noindent" ><a
href="#option1">Option 1</a> by default strips the <a
href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> accents</a> (that is, accents generated by
@@ -8162,25 +9797,25 @@
core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> commands) from the <span
class="cmss-10">name</span><a
- id="dx1-28076"></a> key when it sets the <span
+ id="dx1-34079"></a> key when it sets the <span
class="cmss-10">sort</span><a
- id="dx1-28077"></a> key. So with
+ id="dx1-34080"></a> key. So with
<a
href="#option1">Option 1</a>:
</p>
- <div class="verbatim" id="verbatim-99">
+ <div class="verbatim" id="verbatim-137">
\newglossaryentry{elite}{%
 <br />  name={{\'e}lite},
 <br />  description={select group of people}
 <br />}
</div>
- <!--l. 4116--><p class="nopar" > This is equivalent to:
+ <!--l. 4681--><p class="nopar" > This is equivalent to:
</p>
- <div class="verbatim" id="verbatim-100">
+ <div class="verbatim" id="verbatim-138">
\newglossaryentry{elite}{%
 <br />  name={{\'e}lite},
 <br />  description={select group of people},
@@ -8187,14 +9822,14 @@
 <br />  sort={elite}
 <br />}
</div>
- <!--l. 4124--><p class="nopar" > Unless you use the package option <span
+ <!--l. 4689--><p class="nopar" > Unless you use the package option <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-28078"></a>, in which case it’s equivalent
+ id="dx1-34081"></a>, in which case it’s equivalent
to:
</p>
- <div class="verbatim" id="verbatim-101">
+ <div class="verbatim" id="verbatim-139">
\newglossaryentry{elite}{%
 <br />  name={{\'e}lite},
 <br />  description={select group of people},
@@ -8201,11 +9836,11 @@
 <br />  sort={\'elite}
 <br />}
</div>
- <!--l. 4133--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a
+ <!--l. 4698--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a
symbol.
- </p><!--l. 4137--><p class="noindent" >Similarly if you use the <span
+ </p><!--l. 4702--><p class="noindent" >Similarly if you use the <span
class="cmss-10">inputenc</span><a
- id="dx1-28079"></a> package: </p><div class="alltt">
+ id="dx1-34082"></a> package: </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}{%</span></span>
@@ -8257,7 +9892,7 @@
</div>
</div> Unless you use the package option <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-28080"></a>, in which case it’s equivalent to:
+ id="dx1-34083"></a>, in which case it’s equivalent to:
<div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
@@ -8290,130 +9925,120 @@
</div> Again, this will place the entry before the “A” group.
- <!--l. 4163--><p class="noindent" >With Options <a
+ <!--l. 4728--><p class="noindent" >With Options <a
href="#option2">2</a> and <a
href="#option3">3</a>, the default value of <span
class="cmss-10">sort</span><a
- id="dx1-28081"></a> will either be set to the <span
+ id="dx1-34084"></a> will either be set to the <span
class="cmss-10">name</span><a
- id="dx1-28082"></a>
+ id="dx1-34085"></a>
key (if <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-28083"></a>) or it will set it to the expansion of the <span
+ id="dx1-34086"></a>) or it will set it to the expansion of the <span
class="cmss-10">name</span><a
- id="dx1-28084"></a> key (if
+ id="dx1-34087"></a> key (if
<span
class="cmss-10">sanitizesort=false</span><a
- id="dx1-28085"></a>).
- </p><!--l. 4168--><p class="noindent" ><div class="important" title="Important Note"> Take care with <a
+ id="dx1-34088"></a>).
+ </p><!--l. 4733--><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-28086"></a></a> (<a
+ id="dx1-34089"></a></a> (<a
href="#option3">Option 3</a>): if you have entries with the same <span
class="cmss-10">sort</span><a
- id="dx1-28087"></a> value they will
+ id="dx1-34090"></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-28088"></a></a> and aren’t using the <span
+ id="dx1-34091"></a></a> and aren’t using the <span
class="cmtt-10">def </span>or <span
class="cmtt-10">use </span>sort
methods, <span
class="cmbx-10">always </span>use the <span
class="cmss-10">sort</span><a
- id="dx1-28089"></a> key for entries where the name just consists of a control
+ id="dx1-34092"></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. 4176--><p class="noindent" >Take care if you use <a
+ </p><!--l. 4741--><p class="noindent" >Take care if you use <a
href="#option1">Option 1</a> and the <span
class="cmss-10">name</span><a
- id="dx1-28090"></a> contains fragile commands. You will either
+ id="dx1-34093"></a> contains fragile commands. You will either
need to explicitly set the <span
class="cmss-10">sort</span><a
- id="dx1-28091"></a> key or use the <span
+ id="dx1-34094"></a> key or use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-28092"></a> package option (unless you
+ id="dx1-34095"></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. 4180--><p class="noindent" >
+ </p><!--l. 4745--><p class="noindent" >
</p></dd><dt class="description">
<span
class="cmssbx-10">type</span><a
- id="dx1-28093"></a> </dt><dd
+ id="dx1-34096"></a> </dt><dd
class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the
default glossary is assumed unless <span
class="cmtt-10">\newacronym</span><a
- id="dx1-28094"></a> is used (see <a
+ id="dx1-34097"></a> is used (see <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
+class="tcrm-1000">§</span>13 </a><a
href="#sec:acronyms">Acronyms and Other
Abbreviations<!--tex4ht:ref: sec:acronyms --></a>).
</dd><dt class="description">
<span
class="cmssbx-10">user1</span><a
- id="dx1-28095"></a><span
+ id="dx1-34098"></a><span
class="cmbx-10">, </span><span
class="cmbx-10">…, </span><span
class="cmssbx-10">user6</span><a
- id="dx1-28096"></a><a
- id="dx1-28097"></a><a
- id="dx1-28098"></a><a
- id="dx1-28099"></a><a
- id="dx1-28100"></a> </dt><dd
+ id="dx1-34099"></a><a
+ id="dx1-34100"></a><a
+ id="dx1-34101"></a><a
+ id="dx1-34102"></a><a
+ id="dx1-34103"></a> </dt><dd
class="description">Six keys provided for any additional information the user may want to
specify. (For example, an associated dimension or an alternative plural or some other
grammatical construct.) Alternatively, you can add new keys using <span
class="cmtt-10">\glsaddkey</span><a
- id="dx1-28101"></a> or
+ id="dx1-34104"></a> or
<span
class="cmtt-10">\glsaddstoragekey</span><a
- id="dx1-28102"></a> (see <a
+ id="dx1-34105"></a> (see <a
href="#sec:addkey"><span
-class="cmsy-10">§</span>4.3 </a><a
-href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>). Other keys are also provided by the
- <span
-class="cmss-10">glossaries-prefix</span><a
- id="dx1-28103"></a> (<a
-href="#sec:prefix"><span
-class="cmsy-10">§</span>17 </a><a
-href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span
-class="cmss-10">glossaries-accsupp</span><a
- id="dx1-28104"></a> (<a
-href="#sec:accsupp"><span
-class="cmsy-10">§</span>18 </a><a
-href="#sec:accsupp">Accessibility
- Support<!--tex4ht:ref: sec:accsupp --></a>) packages.
+class="tcrm-1000">§</span>4.3 </a><a
+href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>).
</dd><dt class="description">
<span
class="cmssbx-10">nonumberlist</span><a
- id="dx1-28105"></a> </dt><dd
+ id="dx1-34106"></a> </dt><dd
class="description">A boolean key. If the value is missing or is <span
class="cmtt-10">true</span>, this will suppress the <a
href="#glo:numberlist">number
list<a
- id="dx1-28106"></a></a> just for this entry. Conversely, if you have used the package option <span
+ id="dx1-34107"></a></a> just for this entry. Conversely, if you have used the package option <span
class="cmss-10">nonumberlist</span><a
- id="dx1-28107"></a>, you
+ id="dx1-34108"></a>, you
can activate the number list<a
- id="dx1-28108"></a> just for this entry with <span
+ id="dx1-34109"></a> just for this entry with <span
class="cmss-10">nonumberlist=false</span><a
- id="dx1-28109"></a>. (See <a
+ id="dx1-34110"></a>. (See <a
href="#sec:numberlists"><span
-class="cmsy-10">§</span>5 </a><a
+class="tcrm-1000">§</span>5 </a><a
href="#sec:numberlists">Number
lists<!--tex4ht:ref: sec:numberlists --></a>.)
</dd><dt class="description">
<span
class="cmssbx-10">see</span><a
- id="dx1-28110"></a> </dt><dd
+ id="dx1-34111"></a> </dt><dd
class="description">Cross-reference another entry. Using the <span
class="cmss-10">see</span><a
- id="dx1-28111"></a> key will automatically add this entry to the
- glossary, but will not automatically add the cross-referenced entry. The referenced entry
+ id="dx1-34112"></a> key will <span
+class="cmti-10">automatically add this entry to the</span>
+ <span
+class="cmti-10">glossary</span>, but will not automatically add the cross-referenced entry. The referenced entry
should be supplied as the value to this key. If you want to override the “see” tag,
you can supply the new tag in square brackets before the label. For example
<span class="obeylines-h"><span class="verb"><span
@@ -8424,25 +10049,23 @@
class="cmbx-10">number</span>
<span
class="cmbx-10">list</span><a
- id="dx1-28112"></a></a><span
+ id="dx1-34113"></a></a><span
class="cmbx-10">, the cross-referencing information won’t appear in the glossary, as it</span>
<span
class="cmbx-10">forms part of the number list</span><a
- id="dx1-28113"></a><span
+ id="dx1-34114"></a><span
class="cmbx-10">. </span>You can override this for individual glossary
entries using <span
class="cmss-10">nonumberlist=false</span><a
- id="dx1-28114"></a> (see above). Alternatively, you can use the
+ id="dx1-34115"></a> (see above). Alternatively, you can use the
<span
class="cmss-10">seeautonumberlist</span><a
- id="dx1-28115"></a> package option. For further details, see <a
+ id="dx1-34116"></a> package option. For further details, see <a
href="#sec:crossref"><span
-class="cmsy-10">§</span>8 </a><a
+class="tcrm-1000">§</span>8 </a><a
href="#sec:crossref">Cross-Referencing
Entries<!--tex4ht:ref: sec:crossref --></a>.
- <!--l. 4218--><p class="noindent" >This key essentially provides a convenient shortcut that performs </p><div class="alltt">
-
-
+ <!--l. 4780--><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
@@ -8454,108 +10077,108 @@
class="cmitt-10"> list</span>⟩<span
class="cmtt-10">}</span>
</div>
+
+
</div> after the entry has been defined.
- <!--l. 4224--><p class="noindent" ><div class="important" title="Important Note"> For Options <a
+ <!--l. 4786--><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-28116"></a> must be used before any occurrence of
+ id="dx1-34117"></a> must be used before any occurrence of
<span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-28117"></a> that contains the <span
+ id="dx1-34118"></a> that contains the <span
class="cmss-10">see</span><a
- id="dx1-28118"></a> key. This key has no effect for entries defined
- in the <span
+ id="dx1-34119"></a> key. This key should not be used with entries
+ defined in the <span
class="cmss-10">document</span><a
- id="dx1-28119"></a><a
- id="dx1-28120"></a> environment. </div>
- </p><!--l. 4228--><p class="noindent" >
- </p><!--l. 4230--><p class="noindent" >If you use the <span
+ id="dx1-34120"></a><a
+ id="dx1-34121"></a> environment. </div>
+ </p><!--l. 4790--><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-34122"></a> package option to warn or ignore the <span
class="cmss-10">see</span><a
- id="dx1-28121"></a> key, you may want to consider using the supplementary <a
+ id="dx1-34123"></a> key while
+ <span
+class="cmtt-10">\makeglossaries </span>is commented out.
+ </p><!--l. 4796--><p class="noindent" >If you use the <span
+class="cmss-10">see</span><a
+ id="dx1-34124"></a> key, you may want to consider using the <a
href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>
- package.
+class="cmss-10">glossaries-extra</span></a> package which
+ additionally provides a <span
+class="cmtt-10">seealso </span>and <span
+class="cmtt-10">alias </span>key. If you want to avoid the automatic
+ indexing triggered by the <span
+class="cmss-10">see</span><a
+ id="dx1-34125"></a> key, consider using <a
+href="#option4">Option 4</a>.
</p>
</dd></dl>
-<!--l. 4235--><p class="indent" > The following keys are reserved for <span
+<!--l. 4804--><p class="indent" > The following keys are reserved for <span
class="cmtt-10">\newacronym</span><a
- id="dx1-28122"></a> (see <a
+ id="dx1-34126"></a> (see <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
+class="tcrm-1000">§</span>13 </a><a
href="#sec:acronyms">Acronyms and Other
Abbreviations<!--tex4ht:ref: sec:acronyms --></a>): <span
class="cmss-10">long</span><a
- id="dx1-28123"></a>, <span
+ id="dx1-34127"></a>, <span
class="cmss-10">longplural</span><a
- id="dx1-28124"></a>, <span
+ id="dx1-34128"></a>, <span
class="cmss-10">short</span><a
- id="dx1-28125"></a> and <span
+ id="dx1-34129"></a> and <span
class="cmss-10">shortplural</span><a
- id="dx1-28126"></a>. Additional keys are provided by the
-<span
-class="cmss-10">glossaries-prefix</span><a
- id="dx1-28127"></a> (<a
-href="#sec:prefix"><span
-class="cmsy-10">§</span>17 </a><a
-href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and the <span
-class="cmss-10">glossaries-accsupp</span><a
- id="dx1-28128"></a> (<a
-href="#sec:accsupp"><span
-class="cmsy-10">§</span>18 </a><a
-href="#sec:accsupp">Accessibility
-Support<!--tex4ht:ref: sec:accsupp --></a>) packages. You can also define your own custom keys (see <a
-href="#sec:addkey"><span
-class="cmsy-10">§</span>4.3 </a><a
-href="#sec:addkey">Additional
-Keys<!--tex4ht:ref: sec:addkey --></a>).
-</p><!--l. 4243--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a
+ id="dx1-34130"></a>.
+</p><!--l. 4808--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a
href="#sec:gls-like"><span
class="cmtt-10">\gls</span>-like</a> or <a
href="#sec:glstext-like"><span
class="cmtt-10">\glstext</span>-like</a> commands within the <span
class="cmss-10">text</span><a
- id="dx1-28129"></a>, <span
+ id="dx1-34131"></a>, <span
class="cmss-10">first</span><a
- id="dx1-28130"></a>, <span
+ id="dx1-34132"></a>, <span
class="cmss-10">short</span><a
- id="dx1-28131"></a>
+ id="dx1-34133"></a>
or <span
class="cmss-10">long</span><a
- id="dx1-28132"></a> keys (or their plural equivalent) or any other key that you plan to access through
+ id="dx1-34134"></a> keys (or their plural equivalent) or any other key that you plan to access through
those commands. (For example, the <span
class="cmss-10">symbol</span><a
- id="dx1-28133"></a> key if you intend to use <span
+ id="dx1-34135"></a> key if you intend to use <span
class="cmtt-10">\glssymbol</span>.) Otherwise
you end up with nested links, which can cause complications and they won’t work with the
case-changing commands. You can use them within the value of keys that won’t be accessed
through those commands. For example, the <span
class="cmss-10">description</span><a
- id="dx1-28134"></a> key if you don’t use <span
+ id="dx1-34136"></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. 4256--><p class="noindent" >
-</p><!--l. 4258--><p class="indent" > Note that if the name starts with <a
+</p><!--l. 4821--><p class="noindent" >
+</p><!--l. 4823--><p class="indent" > Note that if the name starts with <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-28135"></a></a>, you must group the
+ id="dx1-34137"></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-28136"></a> and <span
+ id="dx1-34138"></a> and <span
class="cmtt-10">\Glspl</span><a
- id="dx1-28137"></a>. For
+ id="dx1-34139"></a>. For
example:
</p>
- <div class="verbatim" id="verbatim-102">
+ <div class="verbatim" id="verbatim-140">
\newglossaryentry{elite}{name={{\'e}lite},
 <br />description={select group or class}}
</div>
-<!--l. 4265--><p class="nopar" > Note that the same applies if you are using the <span
+<!--l. 4830--><p class="nopar" > Note that the same applies if you are using the <span
class="cmss-10">inputenc</span><a
- id="dx1-28138"></a> package: </p><div class="alltt">
+ id="dx1-34140"></a> package: </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}{name={{</span></span><span
@@ -8570,69 +10193,69 @@
</div>
</div> (This doesn’t apply for XeLaTeX documents using the <span
class="cmss-10">fontspec</span><a
- id="dx1-28139"></a> package. For further details,
+ id="dx1-34141"></a> package. For further details,
see the “UTF-8” section in the <span
class="cmss-10">mfirstuc</span><a
- id="dx1-28140"></a> user manual.)
-<!--l. 4276--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span
+ id="dx1-34142"></a> user manual.)
+<!--l. 4841--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span
class="cmss-10">sort</span><a
- id="dx1-28141"></a> key if you
+ id="dx1-34143"></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-28142"></a></a> (<a
+ id="dx1-34144"></a></a> (<a
href="#option3">Option 3</a>) is usually able to sort <a
href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-28143"></a>s</a>
+ id="dx1-34145"></a>s</a>
correctly. <a
href="#option1">Option 1</a> discards accents from <a
href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> extended Latin character<a
- id="dx1-28144"></a>s</a> unless
+ id="dx1-34146"></a>s</a> unless
you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-28145"></a>.
+ id="dx1-34147"></a>.
</p>
-<!--l. 4284--><p class="noindent" ><a
+<!--l. 4849--><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. 4287--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define a
+<!--l. 4852--><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. 4290--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 4855--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glspluralsuffix</span><span
class="cmtt-9"> </span></span><a
- id="dx1-29001"></a> <span
+ id="dx1-35001"></a> <span
class="cmtt-10">\glspluralsuffix </span></div><hr>
-</p><!--l. 4292--><p class="noindent" >
+</p><!--l. 4857--><p class="noindent" >
to the singular form. This command defaults to the letter “s”. For example:
</p>
- <div class="verbatim" id="verbatim-103">
+ <div class="verbatim" id="verbatim-141">
\newglossaryentry{cow}{name=cow,description={a fully grown
 <br />female of any bovine animal}}
</div>
-<!--l. 4298--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you
+<!--l. 4863--><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-104">
+ <div class="verbatim" id="verbatim-142">
\newglossaryentry{cow}{name=cow,plural=kine,
 <br />description={a fully grown female of any bovine animal}}
</div>
-<!--l. 4306--><p class="nopar" >
-</p><!--l. 4308--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use
+<!--l. 4871--><p class="nopar" >
+</p><!--l. 4873--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use
the <span
class="cmss-10">plural</span><a
- id="dx1-29002"></a> key for one of them and one of the user keys to specify the other plural form. For
+ id="dx1-35002"></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-105">
+ <div class="verbatim" id="verbatim-143">
\newglossaryentry{cow}{%
 <br />  name=cow,%
 <br />  description={a fully grown female of any bovine animal
@@ -8639,7 +10262,7 @@
 <br />               (plural cows, archaic plural kine)},%
 <br />  user1={kine}}
</div>
-<!--l. 4318--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span
+<!--l. 4883--><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:
@@ -8646,18 +10269,18 @@
</p>
- <div class="verbatim" id="verbatim-106">
+ <div class="verbatim" id="verbatim-144">
\let\glsaltpl\glsuseri
</div>
-<!--l. 4324--><p class="nopar" > Then you don’t have to remember which key you used to store the second plural.
+<!--l. 4889--><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-29003"></a>, described in <a
+ id="dx1-35003"></a>, described in <a
href="#sec:addkey"><span
-class="cmsy-10">§</span>4.3 </a><a
+class="tcrm-1000">§</span>4.3 </a><a
href="#sec:addkey">Additional
Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 4329--><p class="indent" > If you are using a language that usually forms plurals by appending a different letter, or
+</p><!--l. 4894--><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
@@ -8664,20 +10287,20 @@
class="cmti-10">before </span>the entries are defined. For languages that don’t form plurals by simply
appending a suffix, all the plural forms must be specified using the <span
class="cmss-10">plural</span><a
- id="dx1-29004"></a> key (and the
+ id="dx1-35004"></a> key (and the
<span
class="cmss-10">firstplural</span><a
- id="dx1-29005"></a> key where necessary).
-</p><!--l. 4337--><p class="noindent" >
+ id="dx1-35005"></a> key where necessary).
+</p><!--l. 4902--><p class="noindent" >
</p>
-<!--l. 4337--><p class="noindent" ><a
+<!--l. 4902--><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. 4340--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example:
+<!--l. 4905--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example:
</p>
- <div class="verbatim" id="verbatim-107">
+ <div class="verbatim" id="verbatim-145">
\let\glsing\glsuseri
 <br />\let\glsd\glsuserii
 <br />\newcommand*{\ingkey}{user1}
@@ -8691,55 +10314,55 @@
 <br />  }%
 <br />}
</div>
-<!--l. 4357--><p class="nopar" > With the above definitions, I can now define terms like this:
+<!--l. 4922--><p class="nopar" > With the above definitions, I can now define terms like this:
</p>
- <div class="verbatim" id="verbatim-108">
+ <div class="verbatim" id="verbatim-146">
\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. 4363--><p class="nopar" > and use them in the text:
+<!--l. 4928--><p class="nopar" > and use them in the text:
</p>
- <div class="verbatim" id="verbatim-109">
+ <div class="verbatim" id="verbatim-147">
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. 4371--><p class="nopar" >
-</p><!--l. 4373--><p class="indent" > Alternatively, you can define your own keys using <span
+<!--l. 4936--><p class="nopar" >
+</p><!--l. 4938--><p class="indent" > Alternatively, you can define your own keys using <span
class="cmtt-10">\glsaddkey</span><a
- id="dx1-30001"></a>, described below in <a
+ id="dx1-36001"></a>, described below in <a
href="#sec:addkey"><span
-class="cmsy-10">§</span>4.3
+class="tcrm-1000">§</span>4.3
</a><a
href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 4376--><p class="noindent" >
+</p><!--l. 4941--><p class="noindent" >
</p>
-<!--l. 4376--><p class="noindent" ><a
+<!--l. 4941--><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. 4379--><p class="noindent" >You can now also define your own custom keys using the commands described in this section.
+<!--l. 4944--><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. 4384--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you
+</p><!--l. 4949--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you
might want to reference this unit in your document. In this case use <span
class="cmtt-10">\glsaddkey </span>described in
<a
href="#sec:glsaddkey"><span
-class="cmsy-10">§</span>4.3.1 </a><a
+class="tcrm-1000">§</span>4.3.1 </a><a
href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>. If, on the other hand, you want to add a key to indicate to a
glossary style or acronym style that this entry should be formatted differently to
other entries, then you can use <span
class="cmtt-10">\glsaddstoragekey </span>described in <a
href="#sec:glsaddstoragekey"><span
-class="cmsy-10">§</span>4.3.2 </a><a
+class="tcrm-1000">§</span>4.3.2 </a><a
href="#sec:glsaddstoragekey">Storage
Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>.
-</p><!--l. 4392--><p class="indent" > In both cases, a new command ⟨<span
+</p><!--l. 4957--><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
@@ -8748,16 +10371,16 @@
class="cmtt-10">\glsaddkey </span>or <span
class="cmtt-10">\glsaddstoragekey </span>before glossary
entries are defined.
-</p><!--l. 4399--><p class="noindent" >
+</p><!--l. 4964--><p class="noindent" >
</p>
-<!--l. 4399--><p class="noindent" ><a
+<!--l. 4964--><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. 4402--><p class="noindent" >A custom key that can be used in the document is defined using:
-</p><!--l. 4403--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 4967--><p class="noindent" >A custom key that can be used in the document is defined using:
+</p><!--l. 4968--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsaddkey</span><span
class="cmtt-9"> </span></span><a
- id="dx1-32001"></a> <span
+ id="dx1-38001"></a> <span
class="cmtt-10">\glsaddkey{</span>⟨<span
class="cmitt-10">key</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -8775,7 +10398,7 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">link allcaps cs</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4411--><p class="noindent" >
+</p><!--l. 4976--><p class="noindent" >
where:
</p><dl class="description"><dt class="description">
⟨<span
@@ -8782,10 +10405,10 @@
class="cmbxti-10">key</span>⟩ </dt><dd
class="description">is the new key to use in <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-32002"></a> (or similar commands such as
+ id="dx1-38002"></a> (or similar commands such as
<span
class="cmtt-10">\longnewglossaryentry</span><a
- id="dx1-32003"></a>);
+ id="dx1-38003"></a>);
</dd><dt class="description">
@@ -8802,7 +10425,7 @@
class="cmbxti-10">no link cs</span>⟩ </dt><dd
class="description">is the control sequence to use analogous to commands like <span
class="cmtt-10">\glsentrytext</span><a
- id="dx1-32004"></a>;
+ id="dx1-38004"></a>;
</dd><dt class="description">
⟨<span
class="cmbxti-10">no link ucfirst cs</span>⟩ </dt><dd
@@ -8809,35 +10432,35 @@
class="description">is the control sequence to use analogous to commands like
<span
class="cmtt-10">\Glsentrytext</span><a
- id="dx1-32005"></a>;
+ id="dx1-38005"></a>;
</dd><dt class="description">
⟨<span
class="cmbxti-10">link cs</span>⟩ </dt><dd
class="description">is the control sequence to use analogous to commands like <span
class="cmtt-10">\glstext</span><a
- id="dx1-32006"></a>;
+ id="dx1-38006"></a>;
</dd><dt class="description">
⟨<span
class="cmbxti-10">link ucfirst cs</span>⟩ </dt><dd
class="description">is the control sequence to use analogous to commands like <span
class="cmtt-10">\Glstext</span><a
- id="dx1-32007"></a>;
+ id="dx1-38007"></a>;
</dd><dt class="description">
⟨<span
class="cmbxti-10">link allcaps cs</span>⟩ </dt><dd
class="description">is the control sequence to use analogous to commands like <span
class="cmtt-10">\GLStext</span><a
- id="dx1-32008"></a>.</dd></dl>
-<!--l. 4432--><p class="noindent" >The starred version of <span
+ id="dx1-38008"></a>.</dd></dl>
+<!--l. 4997--><p class="noindent" >The starred version of <span
class="cmtt-10">\glsaddkey </span>switches on expansion for this key. The unstarred version
doesn’t override the current expansion setting.
<a
- id="x1-32009r3"></a>
-</p><!--l. 4436--><p class="noindent" ><span
+ id="x1-38009r3"></a>
+</p><!--l. 5001--><p class="noindent" ><span
class="cmbx-12">Example 3</span><span
class="cmbx-12"> (Defining Custom Keys)</span><a
- id="x1-32010"></a>
-</p><!--l. 4437--><p class="indent" > Suppose I want to define two new keys, <span
+ id="x1-38010"></a>
+</p><!--l. 5002--><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
@@ -8845,7 +10468,7 @@
</p>
- <div class="verbatim" id="verbatim-110">
+ <div class="verbatim" id="verbatim-148">
 % Define "ed" key:
 <br /> \glsaddkey*
 <br />  {ed}% key
@@ -8865,11 +10488,11 @@
 <br />  {\Glsing}% command analogous to \Glstext
 <br />  {\GLSing}% command analogous to \GLStext
</div>
-<!--l. 4461--><p class="nopar" > Now I can define some entries:
+<!--l. 5026--><p class="nopar" > Now I can define some entries:
</p>
- <div class="verbatim" id="verbatim-111">
+ <div class="verbatim" id="verbatim-149">
 % No need to override defaults for this entry:
 <br /> \newglossaryentry{jump}{name={jump},description={}}
 <br /> % Need to override defaults on these entries:
@@ -8882,33 +10505,33 @@
 <br />   ing={waddling},%
 <br />   description={}}
</div>
-<!--l. 4479--><p class="nopar" >
-</p><!--l. 4481--><p class="indent" > These entries can later be used in the document:
+<!--l. 5044--><p class="nopar" >
+</p><!--l. 5046--><p class="indent" > These entries can later be used in the document:
</p>
- <div class="verbatim" id="verbatim-112">
+ <div class="verbatim" id="verbatim-150">
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. 4488--><p class="nopar" > For a complete document, see the sample file <a
-href="#x1-5094r28"><span
+<!--l. 5053--><p class="nopar" > For a complete document, see the sample file <a
+href="#x1-11104r29"><span
class="cmtt-10">sample-newkeys.tex</span></a>. </p>
<div class="center"
>
-<!--l. 4490--><p class="noindent" >
-</p><!--l. 4490--><p class="noindent" >____________________________</p></div>
-<!--l. 4492--><p class="noindent" >
+<!--l. 5055--><p class="noindent" >
+</p><!--l. 5055--><p class="noindent" >____________________________</p></div>
+<!--l. 5057--><p class="noindent" >
</p>
-<!--l. 4492--><p class="noindent" ><a
+<!--l. 5057--><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. 4495--><p class="noindent" >A custom key that can be used for simply storing information is defined using:
-</p><!--l. 4497--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 5060--><p class="noindent" >A custom key that can be used for simply storing information is defined using:
+</p><!--l. 5062--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsaddstoragekey</span><span
class="cmtt-9"> </span></span><a
- id="dx1-33001"></a> <span
+ id="dx1-39001"></a> <span
class="cmtt-10">\glsaddstoragekey{</span>⟨<span
class="cmitt-10">key</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -8917,35 +10540,36 @@
class="cmitt-10">no link cs</span>⟩<span
class="cmtt-10">}</span>
</div><hr>
-</p><!--l. 4499--><p class="noindent" >
+</p><!--l. 5064--><p class="noindent" >
where the arguments are as the first three arguments of <span
class="cmtt-10">\glsaddkey</span>, described above in
<a
href="#sec:glsaddkey"><span
-class="cmsy-10">§</span>4.3.1 </a><a
+class="tcrm-1000">§</span>4.3.1 </a><a
href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>.
-</p><!--l. 4503--><p class="indent" > This is essentially the same as <span
+</p><!--l. 5068--><p class="indent" > This is essentially the same as <span
class="cmtt-10">\glsaddkey </span>except that it doesn’t define the additional
commands. You can access or update the value of your new field using the commands
described in <a
href="#sec:fetchset"><span
-class="cmsy-10">§</span>16.3 </a><a
+class="tcrm-1000">§</span>16.3 </a><a
href="#sec:fetchset">Fetching and Updating the Value of a Field<!--tex4ht:ref: sec:fetchset --></a>.
<a
- id="x1-33002r4"></a>
-</p><!--l. 4508--><p class="noindent" ><span
+ id="x1-39002r4"></a>
+</p><!--l. 5073--><p class="noindent" ><span
class="cmbx-12">Example 4</span><span
class="cmbx-12"> (Defining Custom Storage Key (Acronyms and</span>
<span
class="cmbx-12">Initialisms))</span><a
- id="x1-33003"></a>
-</p><!--l. 4509--><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.<span class="footnote-mark"><a
-href="#fn1x4" id="fn1x4-bk"><sup class="textsuperscript">4.1</sup></a></span><a
- id="x1-33004f1"></a>
-</p><!--l. 4516--><p class="indent" > Here I can define a new key that determines whether the term is actually an acronym
+ id="x1-39003"></a>
+</p><!--l. 5074--><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. 5081--><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>
@@ -8953,19 +10577,19 @@
</p>
- <div class="verbatim" id="verbatim-113">
+ <div class="verbatim" id="verbatim-151">
\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. 4525--><p class="nopar" >
-</p><!--l. 4527--><p class="indent" > Now I can define a style that looks up the value of this new key to determine how to
+<!--l. 5090--><p class="nopar" >
+</p><!--l. 5092--><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-114">
+ <div class="verbatim" id="verbatim-152">
\newacronymstyle
 <br /> {mystyle}% style name
 <br /> {% Use the generic display
@@ -8972,7 +10596,8 @@
 <br />   \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
 <br /> }
 <br /> {% Put the long form in the description
- <br />   \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}%
+ <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.
@@ -9011,9 +10636,9 @@
 <br />      (\protect\firstacronymfont{\glsentryshortpl{##1}})%
 <br />    }%
 <br />  }%
- <br />  % plural and first letter upper case
+ <br />  % plural and first letter upper case
 <br />  \renewcommand*{\Genplacrfullformat}[2]{%
 <br />    \ifglsfieldeq{##1}{abbrtype}{word}
 <br />    {% is a proper acronym
@@ -9026,7 +10651,8 @@
 <br />    }%
 <br />  }%
 <br />  % Just use the short form as the name part in the glossary:
- <br />  \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}}%
+ <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:
@@ -9037,31 +10663,31 @@
 <br />  \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%
 <br /> }
</div>
-<!--l. 4598--><p class="nopar" > Remember that the new style needs to be set before defining any terms:
+<!--l. 5165--><p class="nopar" > Remember that the new style needs to be set before defining any terms:
</p>
- <div class="verbatim" id="verbatim-115">
+ <div class="verbatim" id="verbatim-153">
\setacronymstyle{mystyle}
</div>
-<!--l. 4603--><p class="nopar" >
-</p><!--l. 4605--><p class="indent" > Since it’s a bit confusing to use <span
+<!--l. 5170--><p class="nopar" >
+</p><!--l. 5172--><p class="indent" > Since it’s a bit confusing to use <span
class="cmtt-10">\newacronym</span><a
- id="dx1-33005"></a> for something that’s not technically an
+ id="dx1-39004"></a> for something that’s not technically an
acronym, let’s define a new command for initialisms:
</p>
- <div class="verbatim" id="verbatim-116">
+ <div class="verbatim" id="verbatim-154">
\newcommand*{\newinitialism}[4][]{%
 <br />  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%
 <br />}
</div>
-<!--l. 4612--><p class="nopar" > Now the entries can all be defined:
+<!--l. 5179--><p class="nopar" > Now the entries can all be defined:
</p>
- <div class="verbatim" id="verbatim-117">
+ <div class="verbatim" id="verbatim-155">
\newacronym{radar}{radar}{radio detecting and ranging}
 <br />\newacronym{laser}{laser}{light amplification by stimulated
 <br />emission of radiation}
@@ -9070,19 +10696,19 @@
 <br />\newinitialism{dsp}{DSP}{digital signal processing}
 <br />\newinitialism{atm}{ATM}{automated teller machine}
</div>
-<!--l. 4622--><p class="nopar" > On <a
+<!--l. 5189--><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. 4627--><p class="indent" > For a complete document, see the sample file <a
-href="#x1-5095r29"><span
+</p><!--l. 5194--><p class="indent" > For a complete document, see the sample file <a
+href="#x1-11105r30"><span
class="cmtt-10">sample-storage-abbr.tex</span></a>. </p>
<div class="center"
>
-<!--l. 4629--><p class="noindent" >
-</p><!--l. 4629--><p class="noindent" >____________________________</p></div>
-<!--l. 4631--><p class="indent" > In the above example, if <span
+<!--l. 5196--><p class="noindent" >
+</p><!--l. 5196--><p class="noindent" >____________________________</p></div>
+<!--l. 5198--><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
@@ -9090,131 +10716,132 @@
<span
class="cmtt-10">\ifglshaslong </span>test in the custom acronym style will be false (since the <span
class="cmss-10">long</span><a
- id="dx1-33006"></a> key hasn’t been
+ id="dx1-39005"></a> key hasn’t been
set) so the display style will switch to that given by <span
class="cmtt-10">\glsgenentryfmt </span>and they’ll be no test
performed on the <span
class="cmtt-10">abbrtype </span>field.
<a
- id="x1-33007r5"></a>
-</p><!--l. 4640--><p class="noindent" ><span
+ id="x1-39006r5"></a>
+</p><!--l. 5207--><p class="noindent" ><span
class="cmbx-12">Example 5</span><span
class="cmbx-12"> (Defining Custom Storage Key (Acronyms and</span>
<span
class="cmbx-12">Non-Acronyms with Descriptions))</span><a
- id="x1-33008"></a>
-</p><!--l. 4641--><p class="indent" > The previous example can be modified if the <span
+ id="x1-39007"></a>
+</p><!--l. 5208--><p class="indent" > The previous example can be modified if the <span
class="cmss-10">description</span><a
- id="dx1-33009"></a> also needs to be provided. Here
+ id="dx1-39008"></a> also needs to be provided. Here
I’ve changed “word” to “acronym”:
</p>
- <div class="verbatim" id="verbatim-118">
+ <div class="verbatim" id="verbatim-156">
\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. 4649--><p class="nopar" > This may seem a little odd for non-abbreviated entries defined using <span
+<!--l. 5216--><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-33010"></a> can be used to determine whether or not to reference the value
+ id="dx1-39009"></a> can be used to determine whether or not to reference the value
of this new <span
class="cmtt-10">abbrtype </span>field.
-</p><!--l. 4655--><p class="indent" > The new acronym style has a minor modification that forces the user to specify a
+</p><!--l. 5222--><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-119">
-   \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}%
+ <div class="verbatim" id="verbatim-157">
+   \renewcommand*{\GenericAcronymFields}{%
+ <br />     description={\the\glslongtok}}%
</div>
-<!--l. 4659--><p class="nopar" > needs to be changed to:
+<!--l. 5227--><p class="nopar" > needs to be changed to:
</p>
- <div class="verbatim" id="verbatim-120">
+ <div class="verbatim" id="verbatim-158">
   \renewcommand*{\GenericAcronymFields}{}%
</div>
-<!--l. 4663--><p class="nopar" > Additionally, to accommodate the change in the default value of the <span
+<!--l. 5231--><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-121">
+ <div class="verbatim" id="verbatim-159">
    \ifglsfieldeq{##1}{abbrtype}{word}
</div>
-<!--l. 4668--><p class="nopar" > need to be changed to:
+<!--l. 5236--><p class="nopar" > need to be changed to:
</p>
- <div class="verbatim" id="verbatim-122">
+ <div class="verbatim" id="verbatim-160">
    \ifglsfieldeq{##1}{abbrtype}{acronym}
</div>
-<!--l. 4672--><p class="nopar" >
-</p><!--l. 4674--><p class="indent" > Once this new style has been set, the new acronyms can be defined using the optional
+<!--l. 5240--><p class="nopar" >
+</p><!--l. 5242--><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-123">
+ <div class="verbatim" id="verbatim-161">
\newacronym[description={system for detecting the position and
 <br />speed of aircraft, ships, etc}]{radar}{radar}{radio detecting
 <br />and ranging}
</div>
-<!--l. 4680--><p class="nopar" >
-</p><!--l. 4682--><p class="indent" > No change is required for the definition of <span
+<!--l. 5248--><p class="nopar" >
+</p><!--l. 5250--><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-124">
+ <div class="verbatim" id="verbatim-162">
\newinitialism[description={mathematical manipulation of an
 <br />information signal}]{dsp}{DSP}{digital signal processing}
</div>
-<!--l. 4687--><p class="nopar" >
-</p><!--l. 4689--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms:
+<!--l. 5255--><p class="nopar" >
+</p><!--l. 5257--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms:
</p>
- <div class="verbatim" id="verbatim-125">
+ <div class="verbatim" id="verbatim-163">
\newcommand*{\newcontraction}[4][]{%
 <br />  \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%
 <br />}
</div>
-<!--l. 4695--><p class="nopar" > The contractions can similarly been defined using this new command:
+<!--l. 5263--><p class="nopar" > The contractions can similarly been defined using this new command:
</p>
- <div class="verbatim" id="verbatim-126">
+ <div class="verbatim" id="verbatim-164">
\newcontraction[description={front part of a ship below the
 <br />deck}]{focsle}{fo'c's'le}{forecastle}
</div>
-<!--l. 4700--><p class="nopar" >
-</p><!--l. 4702--><p class="indent" > Since the custom acronym style just checks if <span
+<!--l. 5268--><p class="nopar" >
+</p><!--l. 5270--><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. 4707--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word:
+</p><!--l. 5275--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word:
</p>
- <div class="verbatim" id="verbatim-127">
+ <div class="verbatim" id="verbatim-165">
\newglossaryentry{apple}{name={apple},description={a fruit}}
</div>
-<!--l. 4711--><p class="nopar" >
-</p><!--l. 4713--><p class="indent" > Now for a new glossary style that provides information about the abbreviation (in
+<!--l. 5279--><p class="nopar" >
+</p><!--l. 5281--><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-128">
+ <div class="verbatim" id="verbatim-166">
\newglossarystyle
 <br /> {mystyle}% style name
 <br /> {% base it on the "list" style
@@ -9227,86 +10854,85 @@
 <br />       \glossentrydesc{##1}\glspostdescription\space ##2}%
 <br /> }
</div>
-<!--l. 4727--><p class="nopar" > This uses <span
+<!--l. 5295--><p class="nopar" > This uses <span
class="cmtt-10">\ifglshaslong</span><a
- id="dx1-33011"></a> to determine whether or not the term is an abbreviation. If it has
+ id="dx1-39010"></a> to determine whether or not the term is an abbreviation. If it has
an abbreviation, the full form is supplied in parentheses and <span
class="cmtt-10">\abbrtype </span>(defined by
<span
class="cmtt-10">\glsaddstoragekey </span>earlier) is used to indicate the type of abbreviation.
-</p><!--l. 4734--><p class="indent" > With this style set, the <span
+</p><!--l. 5302--><p class="indent" > With this style set, the <span
class="cmtt-10">apple </span>entry is simply displayed in the glossary as
</p><dl class="description"><dt class="description">
<span
class="cmbx-10">apple</span> </dt><dd
class="description">a fruit.</dd></dl>
-<!--l. 4739--><p class="noindent" >but the abbreviations are displayed in the form
+<!--l. 5307--><p class="noindent" >but the abbreviations are displayed in the form
</p><dl class="description"><dt class="description">
<span
class="cmbx-10">laser</span> </dt><dd
class="description">(acronym: light amplification by stimulated emission of radiation) device that
creates a narrow beam of intense light.</dd></dl>
-<!--l. 4745--><p class="noindent" >(for acronyms) or
+<!--l. 5313--><p class="noindent" >(for acronyms) or
</p><dl class="description"><dt class="description">
<span
class="cmbx-10">DSP</span> </dt><dd
class="description">(initialism: digital signal processing) mathematical manipulation of an
information signal.</dd></dl>
-<!--l. 4750--><p class="noindent" >(for initalisms) or
+<!--l. 5318--><p class="noindent" >(for initalisms) or
</p><dl class="description"><dt class="description">
<span
class="cmbx-10">fo’c’s’le</span> </dt><dd
class="description">(contraction: forecastle) front part of a ship below the deck.</dd></dl>
-<!--l. 4755--><p class="noindent" >(for contractions).
-</p><!--l. 4757--><p class="indent" > For a complete document, see the sample file <a
-href="#x1-5096r30"><span
-class="cmtt-10">sample-storage-abbr-desc.tex</span></a>.
-</p>
+<!--l. 5323--><p class="noindent" >(for contractions).
+</p><!--l. 5325--><p class="indent" > For a complete document, see <a
+href="#x1-11106r31"><span
+class="cmtt-10">sample-storage-abbr-desc.tex</span></a>. </p>
<div class="center"
>
-<!--l. 4759--><p class="noindent" >
-</p><!--l. 4759--><p class="noindent" >____________________________</p></div>
+<!--l. 5326--><p class="noindent" >
+</p><!--l. 5326--><p class="noindent" >____________________________</p></div>
-<!--l. 4761--><p class="noindent" >
+<!--l. 5328--><p class="noindent" >
</p>
-<!--l. 4761--><p class="noindent" ><a
+<!--l. 5328--><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. 4764--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span
+<!--l. 5331--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span
class="cmss-10">name</span><a
- id="dx1-34001"></a>,
+ id="dx1-40001"></a>,
<span
class="cmss-10">description</span><a
- id="dx1-34002"></a>, <span
+ id="dx1-40002"></a>, <span
class="cmss-10">descriptionplural</span><a
- id="dx1-34003"></a>, <span
+ id="dx1-40003"></a>, <span
class="cmss-10">symbol</span><a
- id="dx1-34004"></a>, <span
+ id="dx1-40004"></a>, <span
class="cmss-10">symbolplural</span><a
- id="dx1-34005"></a> and <span
+ id="dx1-40005"></a> and <span
class="cmss-10">sort</span><a
- id="dx1-34006"></a> keys (these keys all have expansion
+ id="dx1-40006"></a> keys (these keys all have expansion
suppressed via <span
class="cmtt-10">\glssetnoexpandfield</span>).
-</p><!--l. 4770--><p class="indent" > You can switch expansion on or off for individual keys using
-</p><!--l. 4771--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 5337--><p class="indent" > You can switch expansion on or off for individual keys using
+</p><!--l. 5338--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glssetexpandfield</span><span
class="cmtt-9"> </span></span><a
- id="dx1-34007"></a> <span
+ id="dx1-40007"></a> <span
class="cmtt-10">\glssetexpandfield{</span>⟨<span
class="cmitt-10">field</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4773--><p class="noindent" >
+</p><!--l. 5340--><p class="noindent" >
or
-</p><!--l. 4775--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 5342--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glssetnoexpandfield</span><span
class="cmtt-9"> </span></span><a
- id="dx1-34008"></a> <span
+ id="dx1-40008"></a> <span
class="cmtt-10">\glssetnoexpandfield{</span>⟨<span
class="cmitt-10">field</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4777--><p class="noindent" >
+</p><!--l. 5344--><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
@@ -9315,7 +10941,7 @@
<div class="table">
-<!--l. 4782--><p class="indent" > <a
+<!--l. 5349--><p class="indent" > <a
id="tab:fieldmap"></a></p><hr class="float" /><div class="float"
>
@@ -9322,7 +10948,7 @@
<div class="caption"
><span class="id">Table 4.1: </span><span
-class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-340091 -->
+class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-400091 -->
<div class="tabular"> <table id="TBL-5" class="tabular"
cellspacing="0" cellpadding="0"
><colgroup id="TBL-5-1g"><col
@@ -9337,13 +10963,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="cmss-10">sort</span><a
- id="dx1-34010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2"
+ id="dx1-40010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2"
class="td11"> <span
class="cmtt-10">sortvalue </span></td></tr><tr
style="vertical-align:baseline;" id="TBL-5-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-1"
class="td11"> <span
class="cmss-10">firstplural</span><a
- id="dx1-34011"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2"
+ id="dx1-40011"></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
@@ -9350,7 +10976,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="cmss-10">description</span><a
- id="dx1-34012"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2"
+ id="dx1-40012"></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
@@ -9357,7 +10983,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="cmss-10">descriptionplural</span><a
- id="dx1-34013"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2"
+ id="dx1-40013"></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
@@ -9364,7 +10990,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="cmss-10">user1</span><a
- id="dx1-34014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2"
+ id="dx1-40014"></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
@@ -9371,7 +10997,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="cmss-10">user2</span><a
- id="dx1-34015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2"
+ id="dx1-40015"></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
@@ -9378,7 +11004,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="cmss-10">user3</span><a
- id="dx1-34016"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2"
+ id="dx1-40016"></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
@@ -9385,7 +11011,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="cmss-10">user4</span><a
- id="dx1-34017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2"
+ id="dx1-40017"></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
@@ -9392,7 +11018,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="cmss-10">user5</span><a
- id="dx1-34018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2"
+ id="dx1-40018"></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
@@ -9399,7 +11025,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="cmss-10">user6</span><a
- id="dx1-34019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-2"
+ id="dx1-40019"></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
@@ -9406,7 +11032,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="cmss-10">longplural</span><a
- id="dx1-34020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-2"
+ id="dx1-40020"></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
@@ -9413,7 +11039,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="cmss-10">shortplural</span><a
- id="dx1-34021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-2"
+ id="dx1-40021"></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>
@@ -9421,31 +11047,31 @@
</div><hr class="endfloat" />
</div>
-<!--l. 4803--><p class="indent" > Any keys that haven’t had the expansion explicitly set using <span
+<!--l. 5370--><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. 4805--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 5372--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsexpandfields</span><span
class="cmtt-9"> </span></span><a
- id="dx1-34022"></a> <span
+ id="dx1-40022"></a> <span
class="cmtt-10">\glsexpandfields </span></div><hr>
-</p><!--l. 4807--><p class="noindent" >
+</p><!--l. 5374--><p class="noindent" >
and
-</p><!--l. 4809--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 5376--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsnoexpandfields</span><span
class="cmtt-9"> </span></span><a
- id="dx1-34023"></a> <span
+ id="dx1-40023"></a> <span
class="cmtt-10">\glsnoexpandfields </span></div><hr>
-</p><!--l. 4811--><p class="noindent" >
-</p><!--l. 4813--><p class="indent" > If your entries contain any fragile commands, I recommend you switch off expansion via
+</p><!--l. 5378--><p class="noindent" >
+</p><!--l. 5380--><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. 4817--><p class="noindent" ><a
+<!--l. 5384--><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. 4820--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the
+<!--l. 5387--><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
@@ -9454,44 +11080,44 @@
name whilst others don’t. Therefore you need to ensure that you use a suitable
style. (See <a
href="#sec:styles"><span
-class="cmsy-10">§</span>15 </a><a
+class="tcrm-1000">§</span>15 </a><a
href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined styles.) As from version 3.0,
level 1 sub-entries are automatically numbered in the predefined styles if you use the
<span
class="cmss-10">subentrycounter</span><a
- id="dx1-35001"></a> package option (see <a
+ id="dx1-41001"></a> package option (see <a
href="#sec:pkgopts-printglos"><span
-class="cmsy-10">§</span>2.3 </a><a
+class="tcrm-1000">§</span>2.3 </a><a
href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further
details).
-</p><!--l. 4835--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child
+</p><!--l. 5402--><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-35002"></a></a>. Note also that <a
+ id="dx1-41002"></a></a>. Note also that <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-35003"></a></a> has a restriction on the maximum
+ id="dx1-41003"></a></a> has a restriction on the maximum
sub-entry depth.
-</p><!--l. 4841--><p class="noindent" >
+</p><!--l. 5408--><p class="noindent" >
</p>
-<!--l. 4841--><p class="noindent" ><a
+<!--l. 5408--><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. 4844--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and
+<!--l. 5411--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and
then define the sub-entries using the relevant category entry as the value of the <span
class="cmss-10">parent</span><a
- id="dx1-36001"></a>
+ id="dx1-42001"></a>
key.
<a
- id="x1-36002r6"></a>
-</p><!--l. 4849--><p class="noindent" ><span
+ id="x1-42002r6"></a>
+</p><!--l. 5416--><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-36003"></a>
-</p><!--l. 4851--><p class="indent" > Suppose I want a glossary of mathematical symbols that are divided into Greek letters
+ id="x1-42003"></a>
+</p><!--l. 5418--><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:
@@ -9498,23 +11124,23 @@
</p>
- <div class="verbatim" id="verbatim-129">
+ <div class="verbatim" id="verbatim-167">
\newglossaryentry{greekletter}{name={Greek letters},
 <br />description={\nopostdesc}}
 <br />\newglossaryentry{romanletter}{name={Roman letters},
 <br />description={\nopostdesc}}
</div>
-<!--l. 4860--><p class="nopar" >
-</p><!--l. 4862--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the
+<!--l. 5427--><p class="nopar" >
+</p><!--l. 5429--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the
descriptions to <span
class="cmtt-10">\nopostdesc</span><a
- id="dx1-36004"></a>. This gives a blank description and suppresses the description
+ id="dx1-42004"></a>. This gives a blank description and suppresses the description
terminator.
-</p><!--l. 4867--><p class="indent" > I can now define my sub-entries as follows:
+</p><!--l. 5434--><p class="indent" > I can now define my sub-entries as follows:
</p>
- <div class="verbatim" id="verbatim-130">
+ <div class="verbatim" id="verbatim-168">
\newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},
 <br />description={ratio of the circumference of a circle to
 <br />the diameter},
@@ -9523,41 +11149,41 @@
 <br />description={Euler's constant},
 <br />parent=romanletter}
</div>
-<!--l. 4877--><p class="nopar" > For a complete document, see the sample file <a
-href="#x1-5064r21"><span
+<!--l. 5444--><p class="nopar" > For a complete document, see the sample file <a
+href="#x1-11068r21"><span
class="cmtt-10">sampletree.tex</span></a>. </p>
<div class="center"
>
-<!--l. 4879--><p class="noindent" >
-</p><!--l. 4879--><p class="noindent" >____________________________</p></div>
-<!--l. 4881--><p class="noindent" >
+<!--l. 5446--><p class="noindent" >
+</p><!--l. 5446--><p class="noindent" >____________________________</p></div>
+<!--l. 5448--><p class="noindent" >
</p>
-<!--l. 4881--><p class="noindent" ><a
+<!--l. 5448--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.5.2 </span> <a
id="sec:homographs"></a>Homographs</h4>
-<!--l. 4884--><p class="noindent" >Sub-entries that have the same name as the parent entry, don’t need to have the
+<!--l. 5451--><p class="noindent" >Sub-entries that have the same name as the parent entry, don’t need to have the
<span
class="cmss-10">name</span><a
- id="dx1-37001"></a> key. For example, the word “glossary” can mean a list of technical words or a
+ id="dx1-43001"></a> key. For example, the word “glossary” can mean a list of technical words or a
collection of glosses. In both cases the plural is “glossaries”. So first define the parent
entry:
</p>
- <div class="verbatim" id="verbatim-131">
+ <div class="verbatim" id="verbatim-169">
\newglossaryentry{glossary}{name=glossary,
 <br />description={\nopostdesc},
 <br />plural={glossaries}}
</div>
-<!--l. 4893--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be
+<!--l. 5460--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be
suppressed using <span
class="cmtt-10">\nopostdesc</span><a
- id="dx1-37002"></a>.
-</p><!--l. 4897--><p class="indent" > Now define the two different meanings of the word:
+ id="dx1-43002"></a>.
+</p><!--l. 5464--><p class="indent" > Now define the two different meanings of the word:
</p>
- <div class="verbatim" id="verbatim-132">
+ <div class="verbatim" id="verbatim-170">
\newglossaryentry{glossarylist}{
 <br />description={list of technical words},
 <br />sort={1},
@@ -9567,38 +11193,38 @@
 <br />sort={2},
 <br />parent={glossary}}
</div>
-<!--l. 4908--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s <a
+<!--l. 5475--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s <a
href="#glo:numberlist">number
list<a
- id="dx1-37003"></a></a>, whereas if I reference any of the child entries, the location will be added to the child
+ id="dx1-43003"></a></a>, whereas if I reference any of the child entries, the location will be added to the child
entry’s number list. Note also that since the sub-entries have the same name, the <span
class="cmss-10">sort</span><a
- id="dx1-37004"></a> key is
+ id="dx1-43004"></a> key is
required unless you are using the <span
class="cmss-10">sort=use</span><a
- id="dx1-37005"></a> or <span
+ id="dx1-43005"></a> or <span
class="cmss-10">sort=def</span><a
- id="dx1-37006"></a> package options (see <a
+ id="dx1-43006"></a> package options (see <a
href="#sec:pkgopts-sort"><span
-class="cmsy-10">§</span>2.4
+class="tcrm-1000">§</span>2.4
</a><a
href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>). You can use the <span
class="cmss-10">subentrycounter</span><a
- id="dx1-37007"></a> package option to automatically
+ id="dx1-43007"></a> package option to automatically
number the first-level child entries. See <a
href="#sec:pkgopts-printglos"><span
-class="cmsy-10">§</span>2.3 </a><a
+class="tcrm-1000">§</span>2.3 </a><a
href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further
details.
-</p><!--l. 4920--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the
+</p><!--l. 5487--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the
parent entry, so the <span
class="cmss-10">plural</span><a
- id="dx1-37008"></a> key was not required for the child entries. However, if the
+ id="dx1-43008"></a> key was not required for the child entries. However, if the
sub-entries have different plurals, they will need to be specified. For example:
</p>
- <div class="verbatim" id="verbatim-133">
+ <div class="verbatim" id="verbatim-171">
\newglossaryentry{bravo}{name={bravo},
 <br />description={\nopostdesc}}
 <br />\newglossaryentry{bravocry}{description={cry of approval
@@ -9612,83 +11238,88 @@
 <br />plural={bravoes},
 <br />parent=bravo}
</div>
-<!--l. 4939--><p class="nopar" >
-</p><!--l. 4942--><p class="noindent" >
+<!--l. 5506--><p class="nopar" >
+</p><!--l. 5509--><p class="noindent" >
</p>
-<!--l. 4942--><p class="noindent" ><a
+<!--l. 5509--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.6 </span> <a
id="sec:loadglsentries"></a>Loading Entries From a File</h3>
-<!--l. 4945--><p class="noindent" >You can store all your glossary entry definitions in another file and use:
-</p><!--l. 4947--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 5512--><p class="noindent" >You can store all your glossary entry definitions in another file and use:
+</p><!--l. 5514--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\loadglsentries</span><span
class="cmtt-9"> </span></span><a
- id="dx1-38001"></a> <span
+ id="dx1-44001"></a> <span
class="cmtt-10">\loadglsentries[</span>⟨<span
class="cmitt-10">type</span>⟩<span
class="cmtt-10">]{</span>⟨<span
class="cmitt-10">filename</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 4949--><p class="noindent" >
+</p><!--l. 5516--><p class="noindent" >
where ⟨<span
class="cmti-10">filename</span>⟩ is the name of the file containing all the <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-38002"></a> or
+ id="dx1-44002"></a> or
<span
class="cmtt-10">\longnewglossaryentry</span><a
- id="dx1-38003"></a> commands. The optional argument ⟨<span
+ id="dx1-44003"></a> commands. The optional argument ⟨<span
class="cmti-10">type</span>⟩ is the name of the glossary
to which those entries should belong, for those entries where the <span
class="cmss-10">type</span><a
- id="dx1-38004"></a> key has been omitted
+ id="dx1-44004"></a> key has been omitted
(or, more specifically, for those entries whose type has been specified by <span
class="cmtt-10">\glsdefaulttype</span><a
- id="dx1-38005"></a>,
+ id="dx1-44005"></a>,
which is what <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-38006"></a> uses by default).
-</p><!--l. 4959--><p class="indent" > This is a preamble-only command. You may also use <span
+ id="dx1-44006"></a> uses by default).
+</p><!--l. 5526--><p class="indent" > This is a preamble-only command. You may also use <span
class="cmtt-10">\input</span><a
- id="dx1-38007"></a> to load the file but don’t use
+ id="dx1-44007"></a> to load the file but don’t use
<span
class="cmtt-10">\include</span><a
- id="dx1-38008"></a>.
-</p><!--l. 4962--><p class="indent" > <div class="important" title="Important Note"> If you want to use <span
+ id="dx1-44008"></a>. If you find that your file is becoming unmanageably large, you may want to
+consider switching to <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-44009"></a></a> and use an application such as JabRef to manage the entry
+definitions.
+</p><!--l. 5532--><p class="indent" > <div class="important" title="Important Note"> If you want to use <span
class="cmtt-10">\AtBeginDocument</span><a
- id="dx1-38009"></a> to <span
+ id="dx1-44010"></a> to <span
class="cmtt-10">\input </span>all your entries automatically at the
start of the document, add the <span
class="cmtt-10">\AtBeginDocument </span>command <span
class="cmti-10">before </span>you load the <span
class="cmss-10">glossaries</span><a
- id="dx1-38010"></a>
+ id="dx1-44011"></a>
package (and <span
class="cmss-10">babel</span><a
- id="dx1-38011"></a>, if you are also loading that) to avoid the creation of the <span
+ id="dx1-44012"></a>, if you are also loading that) to avoid the creation of the <span
class="cmtt-10">.glsdefs </span>file and
any associated problems that are caused by defining commands in the <span
class="cmss-10">document</span><a
- id="dx1-38012"></a><a
- id="dx1-38013"></a>
+ id="dx1-44013"></a><a
+ id="dx1-44014"></a>
environment. (See <a
href="#sec:docdefs"><span
-class="cmsy-10">§</span>4.8 </a><a
+class="tcrm-1000">§</span>4.8 </a><a
href="#sec:docdefs">Drawbacks With Defining Entries in the Document Environment<!--tex4ht:ref: sec:docdefs --></a>.)
</div>
-</p><!--l. 4971--><p class="noindent" >
+</p><!--l. 5541--><p class="noindent" >
<a
- id="x1-38014r7"></a>
+ id="x1-44015r7"></a>
-</p><!--l. 4973--><p class="noindent" ><span
+</p><!--l. 5543--><p class="noindent" ><span
class="cmbx-12">Example 7</span><span
class="cmbx-12"> (Loading Entries from Another File)</span><a
- id="x1-38015"></a>
-</p><!--l. 4974--><p class="indent" > Suppose I have a file called <span
+ id="x1-44016"></a>
+</p><!--l. 5544--><p class="indent" > Suppose I have a file called <span
class="cmtt-10">myentries.tex </span>which contains:
</p>
- <div class="verbatim" id="verbatim-134">
+ <div class="verbatim" id="verbatim-172">
\newglossaryentry{perl}{type=main,
 <br />name={Perl},
 <br />description={A scripting language}}
@@ -9698,14 +11329,14 @@
 <br />name={html},
 <br />description={A mark up language}}
</div>
-<!--l. 4986--><p class="nopar" > and suppose in my document preamble I use the command:
+<!--l. 5556--><p class="nopar" > and suppose in my document preamble I use the command:
</p>
- <div class="verbatim" id="verbatim-135">
+ <div class="verbatim" id="verbatim-173">
\loadglsentries[languages]{myentries}
</div>
-<!--l. 4990--><p class="nopar" > then this will add the entries <span
+<!--l. 5560--><p class="nopar" > then this will add the entries <span
class="cmtt-10">tex </span>and <span
class="cmtt-10">html </span>to the glossary whose type is given by
<span
@@ -9715,14 +11346,14 @@
class="cmtt-10">main</span>. </p>
<div class="center"
>
-<!--l. 4995--><p class="noindent" >
-</p><!--l. 4995--><p class="noindent" >____________________________</p></div>
-<!--l. 4997--><p class="indent" > <span
+<!--l. 5565--><p class="noindent" >
+</p><!--l. 5565--><p class="noindent" >____________________________</p></div>
+<!--l. 5567--><p class="indent" > <span
class="cmbx-10">Note: </span>if you use <span
class="cmtt-10">\newacronym</span><a
- id="dx1-38016"></a> (see <a
+ id="dx1-44017"></a> (see <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
+class="tcrm-1000">§</span>13 </a><a
href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>) the type is
set as <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">type=\acronymtype</span></span></span> unless you explicitly override it. For example, if my file
@@ -9731,73 +11362,73 @@
</p>
- <div class="verbatim" id="verbatim-136">
+ <div class="verbatim" id="verbatim-174">
\newacronym{aca}{aca}{a contrived acronym}
</div>
-<!--l. 5003--><p class="nopar" > then (supposing I have defined a new glossary type called <span
+<!--l. 5573--><p class="nopar" > then (supposing I have defined a new glossary type called <span
class="cmtt-10">altacronym</span>)
</p>
- <div class="verbatim" id="verbatim-137">
+ <div class="verbatim" id="verbatim-175">
\loadglsentries[altacronym]{myacronyms}
</div>
-<!--l. 5008--><p class="nopar" > will add <span
+<!--l. 5578--><p class="nopar" > will add <span
class="cmtt-10">aca </span>to the glossary type <span
class="cmtt-10">acronym</span>, if the package option <span
class="cmss-10">acronym</span><a
- id="dx1-38017"></a> has been specified,
+ id="dx1-44018"></a> has been specified,
or will add <span
class="cmtt-10">aca </span>to the glossary type <span
class="cmtt-10">altacronym</span>, if the package option <span
class="cmss-10">acronym</span><a
- id="dx1-38018"></a> is not
+ id="dx1-44019"></a> is not
specified.<span class="footnote-mark"><a
-href="#fn2x4" id="fn2x4-bk"><sup class="textsuperscript">4.2</sup></a></span><a
- id="x1-38019f2"></a>
-</p><!--l. 5016--><p class="indent" > If you have used the <span
+href="#fn1x4" id="fn1x4-bk"><sup class="textsuperscript">4.1</sup></a></span><a
+ id="x1-44020f1"></a>
+</p><!--l. 5586--><p class="indent" > If you have used the <span
class="cmss-10">acronym</span><a
- id="dx1-38023"></a> package option, there are two possible solutions to this
+ id="dx1-44024"></a> package option, there are two possible solutions to this
problem:
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-38025x1">Change <span
+ class="enumerate" id="x1-44026x1">Change <span
class="cmtt-10">myacronyms.tex </span>so that entries are defined in the form:
- <div class="verbatim" id="verbatim-138">
+ <div class="verbatim" id="verbatim-176">
\newacronym[type=\glsdefaulttype]{aca}{aca}{a
 <br />contrived acronym}
</div>
- <!--l. 5024--><p class="nopar" > and do:
+ <!--l. 5594--><p class="nopar" > and do:
</p>
- <div class="verbatim" id="verbatim-139">
+ <div class="verbatim" id="verbatim-177">
\loadglsentries[altacronym]{myacronyms}
</div>
- <!--l. 5028--><p class="nopar" >
+ <!--l. 5598--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-38027x2">Temporarily change <span
+ class="enumerate" id="x1-44028x2">Temporarily change <span
class="cmtt-10">\acronymtype </span>to the target glossary:
- <div class="verbatim" id="verbatim-140">
+ <div class="verbatim" id="verbatim-178">
\let\orgacronymtype\acronymtype
 <br />\renewcommand{\acronymtype}{altacronym}
 <br />\loadglsentries{myacronyms}
 <br />\let\acronymtype\orgacronymtype
</div>
- <!--l. 5036--><p class="nopar" ></p></li></ol>
-<!--l. 5039--><p class="indent" > Note that only those entries that have been used in the text will appear in the relevant
+ <!--l. 5606--><p class="nopar" ></p></li></ol>
+<!--l. 5609--><p class="indent" > Note that only those entries that have been used in the text will appear in the relevant
glossaries. Note also that <span
class="cmtt-10">\loadglsentries </span>may only be used in the preamble.
-</p><!--l. 5044--><p class="indent" > Remember that you can use <span
+</p><!--l. 5614--><p class="indent" > Remember that you can use <span
class="cmtt-10">\provideglossaryentry</span><a
- id="dx1-38028"></a> rather than <span
+ id="dx1-44029"></a> rather than <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-38029"></a>.
+ id="dx1-44030"></a>.
Suppose you want to maintain a large database of acronyms or terms that you’re likely to use
in your documents, but you may want to use a modified version of some of those entries.
(Suppose, for example, one document may require a more detailed description.) Then if you
@@ -9810,15 +11441,15 @@
</p>
- <div class="verbatim" id="verbatim-141">
+ <div class="verbatim" id="verbatim-179">
\provideglossaryentry{mallard}{name=mallard,
 <br /> description={a type of duck}}
</div>
-<!--l. 5057--><p class="nopar" > but suppose your document requires a more detailed description, you can do:
+<!--l. 5627--><p class="nopar" > but suppose your document requires a more detailed description, you can do:
</p>
- <div class="verbatim" id="verbatim-142">
+ <div class="verbatim" id="verbatim-180">
\usepackage{glossaries}
 <br />\makeglossaries
 <br />\newglossaryentry{mallard}{name=mallard,
@@ -9825,58 +11456,58 @@
 <br /> description={a dabbling duck where the male has a green head}}
 <br />\loadglsentries{terms}
</div>
-<!--l. 5068--><p class="nopar" > Now the <span
+<!--l. 5638--><p class="nopar" > Now the <span
class="cmtt-10">mallard </span>definition in the <span
class="cmtt-10">terms.tex </span>file will be ignored.
-</p><!--l. 5072--><p class="noindent" >
+</p><!--l. 5642--><p class="noindent" >
</p>
-<!--l. 5072--><p class="noindent" ><a
+<!--l. 5642--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.7 </span> <a
id="sec:moveentry"></a>Moving Entries to Another Glossary</h3>
-<!--l. 5075--><p class="noindent" >As from version 3.02, you can move an entry from one glossary to another using:
-</p><!--l. 5077--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 5645--><p class="noindent" >As from version 3.02, you can move an entry from one glossary to another using:
+</p><!--l. 5647--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsmoveentry</span><span
class="cmtt-9"> </span></span><a
- id="dx1-39001"></a> <span
+ id="dx1-45001"></a> <span
class="cmtt-10">\glsmoveentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">target glossary label</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5079--><p class="noindent" >
+</p><!--l. 5649--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is the unique label identifying the required entry and ⟨<span
class="cmti-10">target glossary label</span>⟩ is the
unique label identifying the glossary in which to put the entry.
-</p><!--l. 5084--><p class="indent" > Note that no check is performed to determine the existence of the target glossary. If
+</p><!--l. 5654--><p class="indent" > Note that no check is performed to determine the existence of the target glossary. If
you want to move an entry to a glossary that’s skipped by <span
class="cmtt-10">\printglossaries</span><a
- id="dx1-39002"></a>,
+ id="dx1-45002"></a>,
then define an ignored glossary with <span
class="cmtt-10">\newignoredglossary</span><a
- id="dx1-39003"></a>. (See <a
+ id="dx1-45003"></a>. (See <a
href="#sec:newglossary"><span
-class="cmsy-10">§</span>12 </a><a
+class="tcrm-1000">§</span>12 </a><a
href="#sec:newglossary">Defining New
Glossaries<!--tex4ht:ref: sec:newglossary --></a>.)
-</p><!--l. 5090--><p class="indent" > <div class="important" title="Important Note"> Unpredictable results may occur if you move an entry to a different glossary from its
+</p><!--l. 5660--><p class="indent" > <div class="important" title="Important Note"> Unpredictable results may occur if you move an entry to a different glossary from its
parent or children. </div>
-</p><!--l. 5093--><p class="noindent" >
-</p><!--l. 5095--><p class="noindent" >
+</p><!--l. 5663--><p class="noindent" >
+</p><!--l. 5665--><p class="noindent" >
</p>
-<!--l. 5095--><p class="noindent" ><a
+<!--l. 5665--><p class="noindent" ><a
href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.8 </span> <a
id="sec:docdefs"></a>Drawbacks With Defining Entries in the Document Environment</h3>
-<!--l. 5098--><p class="noindent" >Originally, <span
+<!--l. 5668--><p class="noindent" >Originally, <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-40001"></a> (and <span
+ id="dx1-46001"></a> (and <span
class="cmtt-10">\newacronym</span><a
- id="dx1-40002"></a>) could only be used in the preamble. I
+ id="dx1-46002"></a>) could only be used in the preamble. I
reluctantly removed this restriction in version 1.13, but there are issues with defining
commands in the <span
class="cmss-10">document</span><a
- id="dx1-40003"></a><a
- id="dx1-40004"></a> environment instead of the preamble, which is why the restriction
+ id="dx1-46003"></a><a
+ id="dx1-46004"></a> environment instead of the preamble, which is why the restriction
is maintained for newer commands. This restriction is also reimposed for <span
class="cmtt-10">\newglossaryentry</span>
by the new <a
@@ -9889,30 +11520,30 @@
definitions.)
-</p><!--l. 5108--><p class="noindent" >
+</p><!--l. 5678--><p class="noindent" >
</p>
-<!--l. 5108--><p class="noindent" ><a
+<!--l. 5678--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.8.1 </span> <a
id="sec:techissues"></a>Technical Issues</h4>
-<!--l. 5111--><p class="noindent" >
+<!--l. 5681--><p class="noindent" >
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-41002x1">If you define an entry mid-way through your document, but subsequently shuffle
+ class="enumerate" id="x1-47002x1">If you define an entry mid-way through your document, but subsequently shuffle
sections around, you could end up using an entry before it has been defined.
</li>
<li
- class="enumerate" id="x1-41004x2">Entry information is required when displaying the glossary. If this occurs at the
+ class="enumerate" id="x1-47004x2">Entry information is required when displaying the glossary. If this occurs at the
start of the document, but the entries aren’t defined until later, then the entry
details are being looked up before the entry has been defined.
</li>
<li
- class="enumerate" id="x1-41006x3">If you use a package, such as <span
+ class="enumerate" id="x1-47006x3">If you use a package, such as <span
class="cmss-10">babel</span><a
- id="dx1-41007"></a>, that makes certain characters active at the start
+ id="dx1-47007"></a>, that makes certain characters active at the start
of the <span
class="cmss-10">document</span><a
- id="dx1-41008"></a><a
- id="dx1-41009"></a> environment, there will be a problem if those characters have
+ id="dx1-47008"></a><a
+ id="dx1-47009"></a> environment, there will be a problem if those characters have
a special significance when defining glossary entries. These characters include the
double-quote <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">"</span></span></span> character, the exclamation mark <span
@@ -9922,7 +11553,7 @@
class="cmtt-10">|</span></span></span> character. They must not be active when defining
a glossary entry where they occur in the <span
class="cmss-10">sort</span><a
- id="dx1-41010"></a> key (and they should be avoided in
+ id="dx1-47010"></a> key (and they should be avoided in
the label if they may be active at any point in the document). Additionally, the
comma <span
class="cmtt-10">, </span>character and the equals <span
@@ -9931,24 +11562,24 @@
class="cmti-10">key</span>⟩=⟨<span
class="cmti-10">value</span>⟩ arguments.
</li></ol>
-<!--l. 5137--><p class="noindent" >To overcome the first two problems, as from version 4.0 the <span
+<!--l. 5707--><p class="noindent" >To overcome the first two problems, as from version 4.0 the <span
class="cmss-10">glossaries </span>package modifies the
definition of <span
class="cmtt-10">\newglossaryentry </span>at the beginning of the <span
class="cmss-10">document</span><a
- id="dx1-41011"></a><a
- id="dx1-41012"></a> environment so that the
+ id="dx1-47011"></a><a
+ id="dx1-47012"></a> environment so that the
definitions are written to an external file (<span
class="cmtt-10">\jobname.glsdefs</span><a
- id="dx1-41013"></a>) which is then read in at the
+ id="dx1-47013"></a>) which is then read in at the
start of the document on the next run. The entry will then only be defined in the
<span
class="cmss-10">document</span><a
- id="dx1-41014"></a><a
- id="dx1-41015"></a> environment if it doesn’t already exist. This means that the entry can now
+ id="dx1-47014"></a><a
+ id="dx1-47015"></a> environment if it doesn’t already exist. This means that the entry can now
be looked up in the glossary, even if the glossary occurs at the beginning of the
document.
-</p><!--l. 5147--><p class="indent" > There are drawbacks to this mechanism: if you modify an entry definition, you need a
+</p><!--l. 5717--><p class="indent" > There are drawbacks to this mechanism: if you modify an entry definition, you need a
second run to see the effect of your modification; this method requires an extra <span
class="cmtt-10">\newwrite</span>,
which may exceed <span class="TEX">T<span
@@ -9955,29 +11586,42 @@
class="E">E</span>X</span>’s maximum allocation; unexpected expansion issues could occur; the
<span
class="cmss-10">see</span><a
- id="dx1-41016"></a> key isn’t stored, which means it can’t be added to the <span
+ id="dx1-47016"></a> key isn’t stored, which means it can’t be added to the <span
class="cmtt-10">.glsdefs</span><a
- id="dx1-41017"></a> file when it’s
+ id="dx1-47017"></a> file when it’s
created at the end of the document (and therefore won’t be present on subsequent
runs).
-</p><!--l. 5155--><p class="noindent" >
+</p><!--l. 5725--><p class="indent" > The <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> package provides a setting (but only for Options <a
+href="#option2">2</a> and <a
+href="#option3">3</a>) that allows
+<span
+class="cmtt-10">\newglossaryentry </span>to occur in the document environment but doesn’t create the
+<span
+class="cmtt-10">.glsdefs</span><a
+ id="dx1-47018"></a> file. This circumvents some problems but it means that you can’t display
+any of the glossaries before all the entries have been defined (so it’s all right if all
+the glossaries are at the end of the document but not if any occur in the front
+matter).
+
+
+</p><!--l. 5733--><p class="noindent" >
</p>
-<!--l. 5155--><p class="noindent" ><a
+<!--l. 5733--><p class="noindent" ><a
href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.8.2 </span> <a
id="sec:goodpractice"></a>Good Practice Issues</h4>
-<!--l. 5158--><p class="noindent" >The above section covers technical issues that can cause your document to have compilation
+<!--l. 5736--><p class="noindent" >The above section covers technical issues that can cause your document to have compilation
errors or produce incorrect output. This section focuses on good writing practice. The main
reason cited by users wanting to define entries within the <span
class="cmss-10">document</span><a
- id="dx1-42001"></a><a
- id="dx1-42002"></a> environment
-
-
+ id="dx1-48001"></a><a
+ id="dx1-48002"></a> environment
rather than in the preamble is that they want to write the definition as they type in
their document text. This suggests a “stream of consciousness” style of writing
that may be acceptable in certain literary genres but is inappropriate for factual
documents.
-</p><!--l. 5167--><p class="indent" > When you write technical documents, regardless of whether it’s a PhD thesis or an article
+</p><!--l. 5745--><p class="indent" > When you write technical documents, regardless of whether it’s a PhD thesis or an article
for a journal or proceedings, you must plan what you write in advance. If you plan in
advance, you should have a fairly good idea of the type of terminology that your
document will contain, so while you are planning, create a new file with all your
@@ -9990,185 +11634,468 @@
</p>
-<!--l. 5180--><p class="indent" > </div>
-</p><!--l. 5180--><p class="noindent" ><a
+<!--l. 5758--><p class="indent" > </div>
+</p><!--l. 5758--><p class="noindent" ><a
href="#top">Top</a><div class="chapter"><h2 class="chapterHead">5. <a
id="sec:numberlists"></a>Number lists</h2>
-</p><!--l. 5183--><p class="indent" > Each entry in the glossary has an associated <a
+</p><!--l. 5761--><p class="indent" > Each entry in the glossary has an associated <a
href="#glo:numberlist">number list<a
- id="dx1-43001"></a></a>. By default, these numbers refer
-to the pages on which that entry has been used (using any of the commands described in <a
+ id="dx1-49001"></a></a>. By default, these numbers refer
+to the pages on which that entry has been indexed (using any of the commands described in
+<a
href="#sec:glslink"><span
-class="cmsy-10">§</span>6
-</a><a
+class="tcrm-1000">§</span>6 </a><a
href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a
href="#sec:glsadd"><span
-class="cmsy-10">§</span>7 </a><a
-href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>).
-The number list can be suppressed using the <span
+class="tcrm-1000">§</span>7 </a><a
+href="#sec:glsadd">Adding an Entry to the Glossary Without Generating
+Text<!--tex4ht:ref: sec:glsadd --></a>). The number list can be suppressed using the <span
class="cmss-10">nonumberlist</span><a
- id="dx1-43002"></a> package option, or an alternative
-counter can be set as the default using the <span
+ id="dx1-49002"></a> package option, or an
+alternative counter can be set as the default using the <span
class="cmss-10">counter</span><a
- id="dx1-43003"></a> package option. The number list is also
-referred to as the location list<a
- id="dx1-43004"></a>.
-</p><!--l. 5192--><p class="indent" > Each location in the <a
+ id="dx1-49003"></a> package option. The number
+list is also referred to as the location list<a
+ id="dx1-49004"></a>.
+</p><!--l. 5770--><p class="indent" > <a
+href="#glo:numberlist">Number list<a
+ id="dx1-49005"></a>s</a> are more common with indexes rather than glossaries (although you can use
+the <span
+class="cmss-10">glossaries </span>package for indexes as well). However, the <span
+class="cmss-10">glossaries </span>package makes use of
+<a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-49006"></a></a> or <a
+href="#glo:xindy"><span
+class="cmtt-10">xindy</span><a
+ id="dx1-49007"></a></a> to hierarchically sort and collate the entries since they are readily
+available with most modern <span class="TEX">T<span
+class="E">E</span>X</span> distributions. Since these are both designed as <a
+href="#glo:indexingapp">indexing
+applications</a> they both require that terms either have a valid location or a cross-reference.
+Even if you use <span
+class="cmss-10">nonumberlist</span><a
+ id="dx1-49008"></a>, the locations must still be provided and acceptable
+to the <a
+href="#glo:indexingapp">indexing application</a> or they will cause an error during the indexing stage,
+which will interrupt the document build. However, if you’re not interested in the
+locations, each entry only needs to be indexed once, so consider using <span
+class="cmss-10">indexonlyfirst</span><a
+ id="dx1-49009"></a>,
+which can improve the document build time by only indexing the <a
+href="#glo:firstuse">first use</a> of each
+term.
+</p><!--l. 5785--><p class="indent" > The <span
+class="cmtt-10">\glsaddall</span><a
+ id="dx1-49010"></a> command (see <a
+href="#sec:glsadd"><span
+class="tcrm-1000">§</span>7 </a><a
+href="#sec:glsadd">Adding an Entry to the Glossary Without Generating
+Text<!--tex4ht:ref: sec:glsadd --></a>), which is used to automatically index all entries, iterates over all defined entries and
+does <span
+class="cmtt-10">\glsadd{</span>⟨<span
+class="cmti-10">label</span>⟩<span
+class="cmtt-10">} </span>for each entry (where ⟨<span
+class="cmti-10">label</span>⟩ is that entry’s label). This means that
+<span
+class="cmtt-10">\glsaddall </span>automatically adds the same location to every entry’s <a
href="#glo:numberlist">number list<a
- id="dx1-43005"></a></a> is encapsulated with a command. (The <span
+ id="dx1-49011"></a></a>, which looks
+weird if the number list<a
+ id="dx1-49012"></a> hasn’t been suppressed.
+</p><!--l. 5792--><p class="indent" > With <a
+href="#option4">Option 4</a>, the indexing is performed by <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-49013"></a></a>, which was specifically designed for
+the <a
+href="#glo:glossaries-extra"><span
+class="cmss-10">glossaries-extra</span></a> package. So it will allow any location format, and its <span
+class="cmtt-10">selection=all</span>
+option will select all entries without adding an unwanted location to the <a
+href="#glo:numberlist">number list<a
+ id="dx1-49014"></a></a>. If
+<a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-49015"></a></a> can deduce a numerical value for a location, it will attempt to form a range over
+consecutive locations, otherwise it won’t try to form a range and the location will just form
+an individual item in the list. <a
+href="#option1">Option 1</a> also allows any location but it doesn’t form
+ranges.
+</p>
+<!--l. 5802--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.1 </span> <a
+ id="sec:encap"></a>Encap Values</h3>
+<!--l. 5805--><p class="noindent" >Each location in the <a
+href="#glo:numberlist">number list<a
+ id="dx1-50001"></a></a> is encapsulated with a command formed from the <span
class="cmti-10">encap</span><a
- id="dx1-43006"></a> value.) By
-default this is the <span
+ id="dx1-50002"></a>
+value. By default this is the <span
class="cmtt-10">\glsnumberformat</span><a
- id="dx1-43007"></a> command, but may be overridden using the <span
+ id="dx1-50003"></a> command, which corresponds to the encap
+<span
+class="cmtt-10">glsnumberformat</span>, but this may be overridden using the <span
class="cmss-10">format</span><a
- id="dx1-43008"></a> key
-in the optional argument to commands like <span
+ id="dx1-50004"></a> key in the optional argument
+to commands like <span
class="cmtt-10">\gls</span>. (See <a
href="#sec:glslink"><span
-class="cmsy-10">§</span>6 </a><a
-href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>.) For
-example, you may want the location to appear in bold to indicate the principle use of a term
-or symbol. Complications can arise if you use different encap values for the same location.
-For example, suppose on page 10 you have both the default <span
-class="cmtt-10">\glsnumberformat</span>
-and <span
-class="cmtt-10">\textbf </span>encaps. While it may seem apparent that <span
-class="cmtt-10">\textbf </span>should override
+class="tcrm-1000">§</span>6 </a><a
+href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>.) For example, you may want the
+location to appear in bold to indicate the principle use of a term or symbol. If the encap
+starts with an open parenthesis <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">(</span></span></span> this signifies the start of a range and if the encap starts
+with close parenthesis <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">)</span></span></span> this signifies the end of a range. These must always occur in
+matching pairs.
+</p><!--l. 5817--><p class="indent" > The <span
+class="cmss-10">glossaries </span>package provides the command <span
+class="cmtt-10">\glsignore</span><a
+ id="dx1-50005"></a> which ignores its argument.
+This is the format used by <span
+class="cmtt-10">\glsaddallunused </span>to suppress the location, which works fine as
+long as no other locations are added to the <a
+href="#glo:numberlist">number list<a
+ id="dx1-50006"></a></a>. For example, if you use
+
+
+<span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{sample}</span></span></span> on page 2 then reset the <a
+href="#glo:firstuseflag">first use flag</a> and then use <span
+class="cmtt-10">\glsaddallunused </span>on
+page 10, the <a
+href="#glo:numberlist">number list<a
+ id="dx1-50007"></a></a> for <span
+class="cmtt-10">sample </span>will be <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">2,</span><span
+class="cmtt-10"> \glsignore{10}</span></span></span> which will result in “2, ”
+which has a spurious comma.
+</p><!--l. 5826--><p class="indent" > This isn’t a problem with <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-50008"></a></a> because you’d use <span
+class="cmtt-10">selection=all </span>instead of
<span
-class="cmtt-10">\glsnumberformat </span>in this situation, neither <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-43009"></a></a> nor <a
+class="cmtt-10">\glsaddallunused</span>, but even if you explicitly had, for example, <span
+class="cmtt-10">\gls[format=glsignore]</span>
+<span
+class="cmtt-10">{</span>⟨<span
+class="cmti-10">label</span>⟩<span
+class="cmtt-10">} </span>for some reason, <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-50009"></a></a> will recognise <span
+class="cmtt-10">glsignore </span>as a special encap indicating an
+ignored location, so it will select the entry but not add that location to the <a
+href="#glo:numberlist">number list<a
+ id="dx1-50010"></a></a>. It’s a
+problem for all the other options (except <a
+href="#option5">Option 5</a>, which doesn’t perform any
+indexing).
+</p><!--l. 5836--><p class="indent" > Complications can arise if you use different encap values for the same location. For
+example, suppose on page 10 you have both the default <span
+class="cmtt-10">glsnumberformat </span>and <span
+class="cmtt-10">textbf</span>
+encaps. While it may seem apparent that <span
+class="cmtt-10">textbf </span>should override <span
+class="cmtt-10">glsnumberformat </span>in this
+situation, the <a
+href="#glo:indexingapp">indexing application</a> may not know it. This is therefore something you need to
+be careful about if you use the <span
+class="cmss-10">format</span><a
+ id="dx1-50011"></a> key or if you use a command that implicitly sets
+it.
+</p><!--l. 5845--><p class="indent" > In the case of <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43010"></a></a> know this. In
-the case of <a
+ id="dx1-50012"></a></a>, it only accepts one encap (according to the order of precedence given
+in the <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43011"></a></a>, it only accepts one encap and discards the other for identical
-locations. The encap it chooses to keep may not necessarily be the one you want. In the
-case of <a
+ id="dx1-50013"></a></a> module) and discards the others for identical locations (for the same
+entry). This can cause a problem if a discarded location forms the start or end of a
+range.
+</p><!--l. 5850--><p class="indent" > In the case of <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43012"></a></a>, it accepts different encaps for the same location, but warns
+ id="dx1-50014"></a></a>, it accepts different encaps for the same location, but warns
about it. This leads to a <a
href="#glo:numberlist">number list<a
- id="dx1-43013"></a></a> with the same location repeated in different
-fonts.
-</p><!--l. 5210--><p class="indent" > This is something you need to be careful about, but if you use the
-<a
+ id="dx1-50015"></a></a> with the same location repeated in different formats. If
+you use the <a
href="#glo:makeglossaries"><span
class="cmtt-10">makeglossaries</span><a
- id="dx1-43014"></a></a> Perl script it will detect <a
+ id="dx1-50016"></a></a> Perl script with <a
+href="#option2">Option 2</a> it will detect <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43015"></a></a>’s warning and attempt to fix the
-problem.<span class="footnote-mark"><a
-href="#fn1x5" id="fn1x5-bk"><sup class="textsuperscript">5.1</sup></a></span><a
- id="x1-43016f1"></a>
-Since <a
+ id="dx1-50017"></a></a>’s warning
+and attempt to fix the problem, ensuring that the <span
+class="cmtt-10">glsnumberformat </span>encap always has the
+least precedence unless it includes a range identifier. Other conflicting encaps will have the
+last one override earlier ones for the same location with range identifiers taking
+priority.
+</p><!--l. 5860--><p class="indent" > No discard occurs with <a
+href="#option1">Option 1</a> so again you get the same location repeated in different
+formats. With <a
+href="#option4">Option 4</a>, <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-50018"></a></a> will discard according to order of precedence,
+giving priority to start and end range encaps. (See the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-50019"></a></a> manual for further
+details.)
+</p><!--l. 5865--><p class="noindent" >
+</p>
+<!--l. 5865--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.2 </span> <a
+ id="sec:locationsyntax"></a>Locations</h3>
+<!--l. 5868--><p class="noindent" >Neither <a
+href="#option1">Option 1</a> nor <a
+href="#option4">Option 4</a> care about the location syntax as long as it’s valid
+<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span> code (and doesn’t contain fragile commands). In both cases, the indexing is
+performed by writing a line to the <span
+class="cmtt-10">.aux </span>file. The write operation is deferred to avoid the
+problems associated with <span class="TEX">T<span
+class="E">E</span>X</span>’s asynchronous output routine. (See, for example, <a
+href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage" >Finding if
+you’re on an odd or an even page</a> for more details on this issue.) Unfortunately Options <a
+href="#option2">2</a>
+and <a
+href="#option3">3</a> are far more problematic and need some complex code to deal with awkward
+locations.
+</p><!--l. 5879--><p class="indent" > If you know that your locations will always expand to a format acceptable to your chosen
+<a
+href="#glo:indexingapp">indexing application</a> then use the package option <span
+class="cmss-10">esclocations=false</span><a
+ id="dx1-51001"></a> to bypass this operation.
+This setting only affects Options <a
+href="#option2">2</a> and <a
+href="#option3">3</a> as the problem doesn’t arise with the other
+
+
+indexing options.
+</p><!--l. 5885--><p class="indent" > Both <a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-51002"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43018"></a></a> doesn’t generate a warning, <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-43019"></a></a> won’t do anything about it if you
-are using <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-43020"></a></a>. With <a
+ id="dx1-51003"></a></a> are fussy about the syntax of the locations. In the
+case of <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43021"></a></a>, <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-43022"></a></a> will let the encaps override each other,
-similar to <a
+ id="dx1-51004"></a></a>, only the numbering system obtained with <span
+class="cmtt-10">\arabic</span>, <span
+class="cmtt-10">\roman</span>,
+<span
+class="cmtt-10">\Roman</span>, <span
+class="cmtt-10">\alph </span>and <span
+class="cmtt-10">\Alph </span>or composites formed from them with the same separator
+(set with <span
+class="cmtt-10">\glsSetCompositor{</span>⟨<span
+class="cmti-10">char</span>⟩<span
+class="cmtt-10">}</span>) are accepted. (<a
+href="#glo:makeindex"><span
+class="cmtt-10">makeindex</span><a
+ id="dx1-51005"></a></a> won’t accept an
+empty location.) In the case of <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43023"></a></a>, except that the <span
-class="cmtt-10">\glsnumberformat </span>encap will always have the least
-precedence. Other conflicting encaps will have the last one override earlier ones for the same
-location.
-</p><!--l. 5221--><p class="indent" > Due to the asynchronous nature of <span class="TEX">T<span
-class="E">E</span>X</span>’s output routine (see, for example, <a
-href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage" >Finding if
-you’re on an odd or an even page</a>) the <span
-class="cmtt-10">page </span>counter (represented internally as <span
-class="cmtt-10">\c at page</span>) can
-be unreliable. This can cause problems when glossary entries are referenced in a paragraph
-that spans a page break. The standard <span
-class="cmtt-10">\label </span>mechanism deals with this by deferring the
-write until the end of the paragraph, but the <span
-class="cmss-10">glossaries </span>indexing mechanism needs to take
-into account the possibility that the location might contain any of <a
+ id="dx1-51006"></a></a>, you can define your own location classes,
+but if the location contains a robust command then the leading backslash must be
+escaped. The <span
+class="cmss-10">glossaries</span><a
+ id="dx1-51007"></a> package tries to do this, but it’s caught between two conflicting
+requirements:
+ </p><ol class="enumerate1" >
+ <li
+ class="enumerate" id="x1-51009x1">The location must be fully expanded before <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\</span></span></span> can be converted to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\</span></span></span> (there’s no
+ point converting <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\thepage</span></span></span> to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\thepage</span></span></span>);
+ </li>
+ <li
+ class="enumerate" id="x1-51011x2">The page number can’t be expanded until the deferred write operation (so <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\c at page</span></span></span>
+ mustn’t expand in the previous step but <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\the\c at page</span></span></span> mustn’t be converted to
+ <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\the\\c at page</span></span></span> and <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\number\c at page</span></span></span> mustn’t be converted to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\number\\c at page</span></span></span>
+ etc).</li></ol>
+<!--l. 5905--><p class="noindent" >There’s a certain amount of trickery needed to deal with this conflict and the code requires
+the location to be in a form that doesn’t embed the counter’s internal register in
+commands like <span
+class="cmtt-10">\value</span>. For example, suppose you have a robust command called
+<span
+class="cmtt-10">\tallynum </span>that takes a number as the argument and an expandable command called
+<span
+class="cmtt-10">\tally </span>that converts a counter name into the associated register or number to
+pass to <span
+class="cmtt-10">\tallynum</span>. Let’s suppose that this command is used to represent the page
+number:
+
+
+</p>
+ <div class="verbatim" id="verbatim-181">
+\renewcommand{\thepage}{\tally{page}}
+</div>
+<!--l. 5915--><p class="nopar" > Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a
+paragraph that started on page 1. With <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43024"></a>’s</a> special
-characters which will need to be escaped before the write can be performed. (This
-isn’t a problem with <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-43025"></a></a> as that places restrictions on the location format
-which prevent this from happening, but these very restrictions can make <span
+ id="dx1-51012"></a></a>, the location <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\tally{page}</span></span></span> needs to be
+written to the file as <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\tallynum{2}</span></span></span>. If it’s written as <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\tallynum{2}</span></span></span> then <a
+href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43026"></a>
-preferable.)
-</p><!--l. 5237--><p class="indent" > To compensate, the <span
-class="cmss-10">glossaries </span>package has to make some adjustments to ensure the
-location number is correct for this situation. By default, the adjustments only affect the
-counter styles: <span
-class="cmtt-10">roman</span>, <span
-class="cmtt-10">Roman</span>, <span
-class="cmtt-10">alph</span>, <span
-class="cmtt-10">Alph </span>and <span
-class="cmtt-10">arabic</span>. If you have a different numbering
-system where <span class="obeylines-h"><span class="verb"><span
+ id="dx1-51013"></a></a> will
+interpret <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\t</span></span></span> as the character “t” (which means the location would appear as “tallynum2”). So
+<span
+class="cmss-10">glossaries</span><a
+ id="dx1-51014"></a> tries to expand <span
+class="cmtt-10">\thepage </span>without expanding <span
+class="cmtt-10">\c at page </span>and then escapes all the
+backslashes, except for the page counter’s internal command. The following definitions of
+<span
+class="cmtt-10">\tally </span>will work: </p>
+ <ul class="itemize1">
+ <li class="itemize">In the following, <span
+class="cmtt-10">\arabic </span>works as its internal command <span
+class="cmtt-10">\c at arabic </span>is temporarily
+ redefined to check for <span
+class="cmtt-10">\c at page</span>:
+
+
+ <div class="verbatim" id="verbatim-182">
+ \newcommand{\tally}[1]{\tallynum{\arabic{#1}}}
+</div>
+ <!--l. 5931--><p class="nopar" >
+ </p></li>
+ <li class="itemize">The form <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\expandafter\the\csname</span><span
+class="cmtt-10"> c@</span></span></span>⟨<span
+class="cmti-10">counter</span>⟩<span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\endcsname</span></span></span> also works (provided <span
+class="cmtt-10">\the</span>
+ is allowed to be temporarily redefined, see below):
+
+
+ <div class="verbatim" id="verbatim-183">
+ \newcommand{\tally}[1]{%
+  <br /> \tallynum{\expandafter\the\csname c@#1\endcsname}}
+</div>
+ <!--l. 5939--><p class="nopar" >
+ </p></li>
+ <li class="itemize"><span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\expandafter\the\value</span></span></span><span
+class="cmtt-10">{</span>⟨<span
+class="cmti-10">counter</span>⟩<span
+class="cmtt-10">} </span>now also works (with the same condition as
+ above):
+
+
+ <div class="verbatim" id="verbatim-184">
+ \newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}}
+</div>
+ <!--l. 5945--><p class="nopar" >
+ </p></li>
+ <li class="itemize">Another variation that will work:
+
+
+ <div class="verbatim" id="verbatim-185">
+ \newcommand{\tally}[1]{%
+  <br />  \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}}
+</div>
+ <!--l. 5951--><p class="nopar" >
+ </p></li>
+ <li class="itemize">and also:
+
+
+ <div class="verbatim" id="verbatim-186">
+ \newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}}
+</div>
+ <!--l. 5956--><p class="nopar" ></p></li></ul>
+<!--l. 5958--><p class="noindent" >The following <span
+class="cmti-10">don’t work</span>: </p>
+ <ul class="itemize1">
+ <li class="itemize">This definition leads to the premature expansion of <span
+class="cmtt-10">\c at page </span>to “1” when, in this case,
+ it should be “2”:
+
+
+ <div class="verbatim" id="verbatim-187">
+ \newcommand{\tally}[1]{\tallynum{\the\value{#1}}}
+</div>
+ <!--l. 5964--><p class="nopar" >
+ </p></li>
+ <li class="itemize">This definition leads to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\c at page</span></span></span> in the glossary file:
+
+
+ <div class="verbatim" id="verbatim-188">
+ \newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}}
+</div>
+ <!--l. 5968--><p class="nopar" ></p></li></ul>
+<!--l. 5970--><p class="noindent" >If you have a numbering system where <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span>⟨<span
class="cmti-10">cs name</span>⟩<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{page}</span></span></span> expands to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span>⟨<span
class="cmti-10">internal cs name</span>⟩<span
-class="cmtt-10">\c at page </span>you need to
+class="cmtt-10">\c at page</span>
+(for example, if <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\tally{page}</span></span></span> expands to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\tallynum\c at page</span></span></span>) then you need to
use:
-</p><!--l. 5245--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 5975--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsaddprotectedpagefmt</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43027"></a> <span
+ id="dx1-51015"></a> <span
class="cmtt-10">\glsaddprotectedpagefmt{</span>⟨<span
class="cmitt-10">internal cs name</span>⟩<span
class="cmtt-10">}</span>
-
-
</div><hr>
-</p><!--l. 5247--><p class="noindent" >
+</p><!--l. 5977--><p class="noindent" >
Note that the backslash must be omitted from ⟨<span
class="cmti-10">internal cs name</span>⟩ and the corresponding
command must be able to process a count register as the (sole) argument.
-</p><!--l. 5252--><p class="indent" > For example, suppose you have a style <span
+</p><!--l. 5982--><p class="indent" > For example, suppose you have a style <span
class="cmtt-10">samplenum </span>that is implemented as follows:
</p>
- <div class="verbatim" id="verbatim-143">
+ <div class="verbatim" id="verbatim-189">
 \newcommand*{\samplenum}[1]{%
 <br />   \expandafter\@samplenum\csname c@#1\endcsname}
 <br /> \newcommand*{\@samplenum}[1]{\two at digits{#1}}
</div>
-<!--l. 5259--><p class="nopar" > (That is, it displays the value of the counter as a two-digit number.) Then to ensure the
+<!--l. 5989--><p class="nopar" > (That is, it displays the value of the counter as a two-digit number.) Then to ensure the
location is correct for entries in page-spanning paragraphs, you need to do:
</p>
- <div class="verbatim" id="verbatim-144">
+ <div class="verbatim" id="verbatim-190">
\glsaddprotectedpagefmt{@samplenum}
</div>
-<!--l. 5265--><p class="nopar" > (If you are using a different counter for the location, such as <span
+<!--l. 5995--><p class="nopar" > (If you are using a different counter for the location, such as <span
class="cmtt-10">section </span>or <span
class="cmtt-10">equation</span>, you don’t
-need to worry about this.)
-</p><!--l. 5270--><p class="indent" > If the inner macro (as given by <span class="obeylines-h"><span class="verb"><span
+need to worry about this provided the inner command is expandable.)
+</p><!--l. 6000--><p class="indent" > If the inner macro (as given by <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span>⟨<span
class="cmti-10">internal cs name</span>⟩) contains non-expandable
commands then you may need to redefine <span
@@ -10179,25 +12106,27 @@
class="cmtt-10">\glsaddprotectedpagefmt{</span>⟨<span
class="cmti-10">internal cs name</span>⟩<span
class="cmtt-10">}</span>. This command doesn’t take any arguments as
-the location is assumed to be given by <span
-class="cmtt-10">\c at page</span>. For example, suppose now my page counter
-format uses small caps Roman numerals:
+<span
+class="cmti-10">the location is assumed to be given by </span><span
+class="cmitt-10">\c at page </span>because that’s the only occasion this
+command should be used. For example, suppose now my page counter format uses small caps
+Roman numerals:
</p>
- <div class="verbatim" id="verbatim-145">
+ <div class="verbatim" id="verbatim-191">
 \newcommand*{\samplenum}[1]{%
 <br />  \expandafter\@samplenum\csname c@#1\endcsname}
 <br /> \newcommand*{\@samplenum}[1]{\textsc{\romannumeral#1}}
</div>
-<!--l. 5280--><p class="nopar" > Again, the inner macro needs to be identified using:
+<!--l. 6011--><p class="nopar" > Again, the inner macro needs to be identified using:
</p>
- <div class="verbatim" id="verbatim-146">
+ <div class="verbatim" id="verbatim-192">
\glsaddprotectedpagefmt{@samplenum}
</div>
-<!--l. 5284--><p class="nopar" > However, since <span
+<!--l. 6015--><p class="nopar" > However, since <span
class="cmtt-10">\textsc </span>isn’t fully expandable, the location is written to the file as
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\textsc</span><span
@@ -10210,7 +12139,7 @@
href="#glo:indexingapp">indexing application</a> (particularly for <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43028"></a></a>). To compensate for this,
+ id="dx1-51016"></a></a>). To compensate for this,
the <span
class="cmtt-10">\gls</span>⟨<span
class="cmti-10">internal cs name</span>⟩<span
@@ -10219,64 +12148,76 @@
</p>
- <div class="verbatim" id="verbatim-147">
+ <div class="verbatim" id="verbatim-193">
\renewcommand*{\gls at samplenumpage}{\romannumeral\c at page}
</div>
-<!--l. 5294--><p class="nopar" > While this modification means that the location list in the glossary won’t exactly match the
+<!--l. 6025--><p class="nopar" > While this modification means that the <a
+href="#glo:numberlist">number list<a
+ id="dx1-51017"></a></a> in the glossary won’t exactly match the
format of the page numbers (displaying lower case Roman numbers instead of small cap
Roman numerals) this method will at least work correctly for both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43029"></a></a> and <a
+ id="dx1-51018"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43030"></a></a>. If
+ id="dx1-51019"></a></a>. If
you are using <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43031"></a></a>, the following definition:
+ id="dx1-51020"></a></a>, the following definition:
</p>
- <div class="verbatim" id="verbatim-148">
+ <div class="verbatim" id="verbatim-194">
 \renewcommand*{\gls at samplenumpage}{%
 <br />   \glsbackslash\string\textsc{\romannumeral\c at page}}
</div>
-<!--l. 5304--><p class="nopar" > combined with
+<!--l. 6035--><p class="nopar" > combined with
</p>
- <div class="verbatim" id="verbatim-149">
+ <div class="verbatim" id="verbatim-195">
\GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace"
 <br /> "roman-numbers-lowercase" :sep "\glsclosebrace"}
</div>
-<!--l. 5309--><p class="nopar" > will now have lowercase Roman numerals in the location list. (This option may cause
-problems if your locations should be hyperlinks.)
-</p><!--l. 5314--><p class="indent" > Another possibility that will work with both <a
+<!--l. 6040--><p class="nopar" > will now have lowercase Roman numerals in the location list (see <a
+href="#sec:xindyloc"><span
+class="tcrm-1000">§</span>11.2 </a><a
+href="#sec:xindyloc">Locations and
+Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details on that command). Take care of the backslashes. The location
+(which ends up in the <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">:locref</span></span></span> attribute) needs <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\\</span></span></span> but the location class (identified with
+<span
+class="cmtt-10">\GlsAddXdyLocation</span>) just has a single backslash. Note that this example will cause problems
+if your locations should be hyperlinks.
+</p><!--l. 6049--><p class="indent" > Another possibility that may work with both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43032"></a></a> and <a
+ id="dx1-51021"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43033"></a></a> is to redefine
+ id="dx1-51022"></a></a> is to redefine
<span
class="cmtt-10">\gls</span>⟨<span
class="cmti-10">internal cs name</span>⟩<span
class="cmtt-10">page </span>(<span
-class="cmtt-10">\gls at samplenumpage </span>in this example) to just expand to
-the decimal page number and redefine <span
+class="cmtt-10">\gls at samplenumpage </span>in this example) to just expand to the
+decimal page number (<span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\number\c at page</span></span></span>) and redefine <span
class="cmtt-10">\glsnumberformat</span><a
- id="dx1-43034"></a> to change the displayed
-format:
+ id="dx1-51023"></a> to change the
+displayed format:
</p>
- <div class="verbatim" id="verbatim-150">
-  \renewcommand*{\gls at samplenumpage}{\number\c at page}
- <br />  \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}}
+ <div class="verbatim" id="verbatim-196">
+\renewcommand*{\gls at samplenumpage}{\number\c at page}
+ <br />\renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}}
</div>
-<!--l. 5322--><p class="nopar" >
-</p><!--l. 5324--><p class="indent" > <div class="important" title="Important Note"> If you redefine <span
+<!--l. 6057--><p class="nopar" >
+</p><!--l. 6059--><p class="indent" > <div class="important" title="Important Note"> If you redefine <span
class="cmtt-10">\gls</span>⟨<span
class="cmti-10">internal cs name</span>⟩<span
class="cmtt-10">page</span>, you must make sure that <span
@@ -10284,128 +12225,151 @@
when it’s written to the file. (So don’t, for example, hide <span
class="cmtt-10">\c at page </span>inside a robust command.)
</div>
-</p><!--l. 5329--><p class="noindent" >
-</p><!--l. 5331--><p class="indent" > The mechanism that allows this to work temporarily redefines <span
+</p><!--l. 6064--><p class="noindent" >
+</p><!--l. 6066--><p class="indent" > The mechanism that allows this to work temporarily redefines <span
class="cmtt-10">\the</span><a
- id="dx1-43035"></a> and <span
+ id="dx1-51024"></a> and <span
class="cmtt-10">\number</span><a
- id="dx1-43036"></a> while it
+ id="dx1-51025"></a> while it
processes the location. If this causes a problem you can disallow it using
-</p><!--l. 5334--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 6069--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glswrallowprimitivemodsfalse</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43037"></a> <span
+ id="dx1-51026"></a> <span
class="cmtt-10">\glswrallowprimitivemodsfalse </span></div><hr>
-</p><!--l. 5336--><p class="noindent" >
-</p><!--l. 5338--><p class="indent" > Both <a
+</p><!--l. 6071--><p class="noindent" >
+but you will need to find some other way to ensure the location expands correctly.
+</p><!--l. 6075--><p class="noindent" >
+</p>
+<!--l. 6075--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.3 </span> <a
+ id="sec:ranges"></a>Range Formations</h3>
+<!--l. 6078--><p class="noindent" >Both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43038"></a></a> and <a
+ id="dx1-52001"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43039"></a></a> (Options <a
+ id="dx1-52002"></a></a> (Options <a
href="#option2">2</a> and <a
href="#option3">3</a>) concatenate a sequence of 3 or more
consecutive pages into a range. With <span
class="cmtt-10">xindy</span><a
- id="dx1-43040"></a> (<a
+ id="dx1-52003"></a> (<a
href="#option3">Option 3</a>) you can vary the minimum sequence
length using <span
class="cmtt-10">\GlsSetXdyMinRangeLength</span><a
- id="dx1-43041"></a><span
+ id="dx1-52004"></a><span
class="cmtt-10">{</span>⟨<span
class="cmti-10">n</span>⟩<span
class="cmtt-10">} </span>where ⟨<span
class="cmti-10">n</span>⟩ is either an integer or the keyword
<span
-class="cmtt-10">none </span>which indicates that there should be no range formation.
-</p><!--l. 5345--><p class="indent" > <div class="important" title="Important Note"> Note that <span
+class="cmtt-10">none </span>which indicates that there should be no range formation (see <a
+href="#sec:xindyloc"><span
+class="tcrm-1000">§</span>11.2 </a><a
+href="#sec:xindyloc">Locations and
+Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details).
+</p><!--l. 6086--><p class="indent" > <div class="important" title="Important Note"> Note that <span
class="cmtt-10">\GlsSetXdyMinRangeLength </span>must be used before <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-43042"></a> and has
+ id="dx1-52005"></a> and has
no effect if <span
class="cmtt-10">\noist</span><a
- id="dx1-43043"></a> is used. </div>
-</p><!--l. 5348--><p class="noindent" >
-</p><!--l. 5350--><p class="indent" > With both <a
+ id="dx1-52006"></a> is used. </div>
+</p><!--l. 6089--><p class="noindent" >
+</p><!--l. 6091--><p class="indent" > With both <a
href="#glo:makeindex"><span
class="cmtt-10">makeindex</span><a
- id="dx1-43044"></a></a> and <a
+ id="dx1-52007"></a></a> and <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43045"></a></a> (Options <a
+ id="dx1-52008"></a></a> (Options <a
href="#option2">2</a> and <a
href="#option3">3</a>), you can replace the separator and
the closing number in the range using:
-</p><!--l. 5352--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 6093--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsSetSuffixF</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43046"></a> <span
+ id="dx1-52009"></a> <span
class="cmtt-10">\glsSetSuffixF{</span>⟨<span
class="cmitt-10">suffix</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5354--><p class="noindent" >
-</p><!--l. 5355--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 6095--><p class="noindent" >
+</p><!--l. 6096--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsSetSuffixFF</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43047"></a> <span
+ id="dx1-52010"></a> <span
class="cmtt-10">\glsSetSuffixFF{</span>⟨<span
class="cmitt-10">suffix</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5357--><p class="noindent" >
+</p><!--l. 6098--><p class="noindent" >
where the former command specifies the suffix to use for a 2 page list and the latter specifies
the suffix to use for longer lists. For example:
</p>
- <div class="verbatim" id="verbatim-151">
+ <div class="verbatim" id="verbatim-197">
\glsSetSuffixF{f.}
 <br />\glsSetSuffixFF{ff.}
</div>
-<!--l. 5364--><p class="nopar" > Note that if you use <a
+<!--l. 6105--><p class="nopar" > Note that if you use <a
href="#glo:xindy"><span
class="cmtt-10">xindy</span><a
- id="dx1-43048"></a></a> (<a
+ id="dx1-52011"></a></a> (<a
href="#option3">Option 3</a>), you will also need to set the minimum range length
to 1 if you want to change these suffixes:
</p>
- <div class="verbatim" id="verbatim-152">
+ <div class="verbatim" id="verbatim-198">
\GlsSetXdyMinRangeLength{1}
</div>
-<!--l. 5370--><p class="nopar" > Note that if you use the <span
+<!--l. 6111--><p class="nopar" > Note that if you use the <span
class="cmss-10">hyperref</span><a
- id="dx1-43049"></a> package, you will need to use <span
+ id="dx1-52012"></a> package, you will need to use <span
class="cmtt-10">\nohyperpage</span><a
- id="dx1-43050"></a> in the suffix to
+ id="dx1-52013"></a> in the suffix to
ensure that the hyperlinks work correctly. For example:
</p>
- <div class="verbatim" id="verbatim-153">
+ <div class="verbatim" id="verbatim-199">
\glsSetSuffixF{\nohyperpage{f.}}
 <br />\glsSetSuffixFF{\nohyperpage{ff.}}
</div>
-<!--l. 5377--><p class="nopar" >
-</p><!--l. 5379--><p class="indent" > <div class="important" title="Important Note"> Note that <span
+<!--l. 6118--><p class="nopar" >
+</p><!--l. 6120--><p class="indent" > <div class="important" title="Important Note"> Note that <span
class="cmtt-10">\glsSetSuffixF </span>and <span
class="cmtt-10">\glsSetSuffixFF </span>must be used before <span
class="cmtt-10">\makeglossaries</span><a
- id="dx1-43051"></a>
+ id="dx1-52014"></a>
and have no effect if <span
class="cmtt-10">\noist</span><a
- id="dx1-43052"></a> is used. </div>
-</p><!--l. 5383--><p class="noindent" >
-</p><!--l. 5385--><p class="indent" > <a
+ id="dx1-52015"></a> is used. </div>
+</p><!--l. 6124--><p class="noindent" >
+</p><!--l. 6126--><p class="indent" > It’s also possible to concatenate a sequence of consecutive locations into a range or have
+suffixes with <a
+href="#option4">Option 4</a>, but with <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-52016"></a></a> these implicit ranges can’t be merged with
+explicit ranges (created with the <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">(</span></span></span> and <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">)</span></span></span> encaps). See the <a
+href="#glo:bib2gls"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-52017"></a></a> manual for further
+details.
+</p><!--l. 6132--><p class="indent" > <a
href="#option1">Option 1</a> doesn’t form ranges. However, with this option you can iterate over an entry’s
<a
href="#glo:numberlist">number list<a
- id="dx1-43053"></a></a> using:
-</p><!--l. 5387--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-52018"></a></a> using:
+</p><!--l. 6134--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsnumberlistloop</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43054"></a> <span
+ id="dx1-52019"></a> <span
class="cmtt-10">\glsnumberlistloop{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -10414,12 +12378,12 @@
class="cmitt-10">xr handler cs</span>⟩<span
class="cmtt-10">}</span>
</div><hr>
-</p><!--l. 5390--><p class="noindent" >
+</p><!--l. 6137--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span
class="cmti-10">handler cs</span>⟩ is a handler control sequence of the
form:
-</p><!--l. 5394--><p class="indent" > <hr><div title="Definition">⟨<span
+</p><!--l. 6141--><p class="indent" > <hr><div title="Definition">⟨<span
class="cmitt-10">handler cs</span>⟩<span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">prefix</span>⟩<span
@@ -10430,11 +12394,11 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">location</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5395--><p class="noindent" >
+</p><!--l. 6142--><p class="noindent" >
where ⟨<span
class="cmti-10">prefix</span>⟩ is the <span
class="cmss-10">hyperref</span><a
- id="dx1-43055"></a> prefix, ⟨<span
+ id="dx1-52020"></a> prefix, ⟨<span
class="cmti-10">counter</span>⟩ is the name of the counter used for the location,
⟨<span
class="cmti-10">format</span>⟩ is the format used to display the location (e.g. <span
@@ -10442,7 +12406,7 @@
class="cmti-10">location</span>⟩ is the location.
The third argument is the control sequence to use for any cross-references in the list. This
handler should have the syntax:
-</p><!--l. 5403--><p class="indent" > <hr><div title="Definition">⟨<span
+</p><!--l. 6150--><p class="indent" > <hr><div title="Definition">⟨<span
class="cmitt-10">xr handler cs</span>⟩<span
class="cmtt-10">[</span>⟨<span
class="cmitt-10">tag</span>⟩<span
@@ -10449,7 +12413,7 @@
class="cmtt-10">]{</span>⟨<span
class="cmitt-10">xr list</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5404--><p class="noindent" >
+</p><!--l. 6151--><p class="noindent" >
where ⟨<span
class="cmti-10">tag</span>⟩ is the cross-referenced text (e.g. “see”) and ⟨<span
class="cmti-10">xr list</span>⟩ is a comma-separated list of
@@ -10456,42 +12420,42 @@
labels. (This actually has a third argument but it’s always empty when used with
<a
href="#option1">Option 1</a>.)
-</p><!--l. 5409--><p class="indent" > For example, if on page 12 I have used
+</p><!--l. 6156--><p class="indent" > For example, if on page 12 I have used
</p>
- <div class="verbatim" id="verbatim-154">
+ <div class="verbatim" id="verbatim-200">
\gls[format=textbf]{apple}
</div>
-<!--l. 5413--><p class="nopar" > and on page 18 I have used
+<!--l. 6160--><p class="nopar" > and on page 18 I have used
</p>
- <div class="verbatim" id="verbatim-155">
+ <div class="verbatim" id="verbatim-201">
\gls[format=emph]{apple}
</div>
-<!--l. 5417--><p class="nopar" > then
+<!--l. 6164--><p class="nopar" > then
</p>
- <div class="verbatim" id="verbatim-156">
+ <div class="verbatim" id="verbatim-202">
\glsnumberlistloop{apple}{\myhandler}
</div>
-<!--l. 5421--><p class="nopar" > will be equivalent to:
+<!--l. 6168--><p class="nopar" > will be equivalent to:
</p>
- <div class="verbatim" id="verbatim-157">
+ <div class="verbatim" id="verbatim-203">
\myhandler{}{page}{textbf}{12}%
 <br />\myhandler{}{page}{emph}{18}%
</div>
-<!--l. 5426--><p class="nopar" > There is a predefined handler that’s used to display the <a
+<!--l. 6173--><p class="nopar" > There is a predefined handler that’s used to display the <a
href="#glo:numberlist">number list<a
- id="dx1-43056"></a></a> in the glossary:
-</p><!--l. 5429--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-52021"></a></a> in the glossary:
+</p><!--l. 6176--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsnoidxdisplayloc</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43057"></a> <span
+ id="dx1-52022"></a> <span
class="cmtt-10">\glsnoidxdisplayloc{</span>⟨<span
class="cmitt-10">prefix</span>⟩<span
class="cmtt-10">}{</span>⟨<span
@@ -10502,9 +12466,9 @@
class="cmitt-10">location</span>⟩<span
class="cmtt-10">}</span>
</div><hr>
-</p><!--l. 5431--><p class="noindent" >
+</p><!--l. 6178--><p class="noindent" >
The predefined handler used for the cross-references in the glossary is:
-</p><!--l. 5434--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 6181--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsseeformat[</span>⟨<span
class="cmitt-10">tag</span>⟩<span
class="cmtt-10">]{</span>⟨<span
@@ -10512,117 +12476,132 @@
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">location</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5435--><p class="noindent" >
+</p><!--l. 6182--><p class="noindent" >
which is described in <a
href="#sec:customxr"><span
-class="cmsy-10">§</span>8.1 </a><a
+class="tcrm-1000">§</span>8.1 </a><a
href="#sec:customxr">Customising Cross-reference Text<!--tex4ht:ref: sec:customxr --></a>.
-</p><!--l. 5438--><p class="indent" > <div class="important" title="Important Note"> <span
+</p><!--l. 6185--><p class="indent" > <div class="important" title="Important Note"> <span
class="cmtt-10">\glsnumberlistloop </span>is not available for Options <a
href="#option2">2</a> and <a
href="#option3">3</a>. </div>
-</p><!--l. 5440--><p class="noindent" >
-</p><!--l. 5442--><p class="indent" > As from version 4.24, there’s a hook that’s used near the end of <span
+</p><!--l. 6187--><p class="noindent" >
+</p><!--l. 6189--><p class="noindent" >
+</p>
+<!--l. 6189--><p class="noindent" ><a
+href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.4 </span> <a
+ id="sec:isthook"></a>Style Hook</h3>
+<!--l. 6192--><p class="noindent" >As from version 4.24, there’s a hook that’s used near the end of <span
class="cmtt-10">\writeist</span><a
- id="dx1-43058"></a> before the file
-is closed. You can set the code to be performed then using:
-</p><!--l. 5445--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+ id="dx1-53001"></a> before the file is
+closed. You can set the code to be performed then using:
+</p><!--l. 6195--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\GlsSetWriteIstHook</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43059"></a> <span
+ id="dx1-53002"></a> <span
class="cmtt-10">\GlsSetWriteIstHook{</span>⟨<span
class="cmitt-10">code</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5447--><p class="noindent" >
+</p><!--l. 6197--><p class="noindent" >
If you want the ⟨<span
class="cmti-10">code</span>⟩ to write any information to the file, you need to use
-</p><!--l. 5450--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 6200--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glswrite</span><span
class="cmtt-9"> </span></span><a
- id="dx1-43060"></a> <span
+ id="dx1-53003"></a> <span
class="cmtt-10">\write\glswrite{</span>⟨<span
class="cmitt-10">style information</span>⟩<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 5452--><p class="noindent" >
+</p><!--l. 6202--><p class="noindent" >
Make sure you use the correct format within ⟨<span
class="cmti-10">style information</span>⟩. For example, if you are using
<span
class="cmtt-10">makeindex</span><a
- id="dx1-43061"></a>:
+ id="dx1-53004"></a>:
</p>
- <div class="verbatim" id="verbatim-158">
+ <div class="verbatim" id="verbatim-204">
\GlsSetWriteIstHook{%
 <br /> \write\glswrite{page_precedence "arnAR"}%
 <br /> \write\glswrite{line_max 80}%
 <br />}
</div>
-<!--l. 5460--><p class="nopar" > This changes the page type precedence<a
- id="dx1-43062"></a> and the maximum line length used by
+<!--l. 6210--><p class="nopar" > This changes the page type precedence<a
+ id="dx1-53005"></a> and the maximum line length used by
<span
class="cmtt-10">makeindex</span><a
- id="dx1-43063"></a>.
-</p><!--l. 5464--><p class="indent" > Remember that if you switch to <span
+ id="dx1-53006"></a>.
+</p><!--l. 6214--><p class="indent" > Remember that if you switch to <span
class="cmtt-10">xindy</span><a
- id="dx1-43064"></a>, this will no longer be valid code.
+ id="dx1-53007"></a>, this will no longer be valid code.
</p>
-<!--l. 5467--><p class="indent" > </div>
-</p><!--l. 5467--><p class="noindent" ><a
+<!--l. 6217--><p class="indent" > </div>
+</p><!--l. 6217--><p class="noindent" ><a
href="#top">Top</a><div class="chapter"><h2 class="chapterHead">6. <a
id="sec:glslink"></a>Links to Glossary Entries</h2>
-</p><!--l. 5470--><p class="indent" > Once you have defined a glossary entry using <span
+</p><!--l. 6220--><p class="indent" > Once you have defined a glossary entry using <span
class="cmtt-10">\newglossaryentry</span><a
- id="dx1-44001"></a> or <span
+ id="dx1-54001"></a> (<a
+href="#sec:newglosentry"><span
+class="tcrm-1000">§</span>4 </a><a
+href="#sec:newglosentry">Defining
+Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>) or <span
class="cmtt-10">\newacronym</span><a
- id="dx1-44002"></a> (see
-<a
+ id="dx1-54002"></a> (see <a
href="#sec:acronyms"><span
-class="cmsy-10">§</span>13 </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>), you can refer to that entry in the document using
-one of the commands listed in <a
+class="tcrm-1000">§</span>13 </a><a
+href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>), you
+can refer to that entry in the document using one of the commands listed in <a
href="#sec:gls-like"><span
-class="cmsy-10">§</span>6.1 </a><a
+class="tcrm-1000">§</span>6.1
+</a><a
href="#sec:gls-like">The <span
-class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a> or
-<a
+class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a> or <a
href="#sec:glstext-like"><span
-class="cmsy-10">§</span>6.2 </a><a
+class="tcrm-1000">§</span>6.2 </a><a
href="#sec:glstext-like">The <span
-class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)<!--tex4ht:ref: sec:glstext-like --></a>. The text which appears at
-that point in the document when using one of these commands is referred to as the <a
+class="cmtt-10">\glstext</span>-Like
+Commands (First Use Flag Not Querie