summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html3422
1 files changed, 2539 insertions, 883 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
index 66d476fd9d1..ea4a11c301a 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
+++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
@@ -17,6 +17,7 @@
/* start css.sty */
.cmr-17{font-size:170%;}
.cmr-12{font-size:120%;}
+.cmr-8{font-size:80%;}
.cmtt-12{font-size:120%;font-family: monospace;}
.cmtt-12{font-family: monospace;}
.cmtt-12{font-family: monospace;}
@@ -26,12 +27,14 @@
.cmbx-9{ font-weight: bold;}
.cmss-9{font-size:90%; font-family: sans-serif;}
.cmss-9{ font-family: sans-serif;}
+.cmss-9{ font-family: sans-serif;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
+.cmss-10{ font-family: sans-serif;}
.cmti-10{ font-style: italic;}
.cmtt-9{font-size:90%;font-family: monospace;}
.cmtt-9{font-family: monospace;}
@@ -41,6 +44,10 @@
.cmbx-10{ font-weight: bold;}
.cmbx-10{ font-weight: bold;}
.cmsy-9{font-size:90%;}
+.cmss-8{font-size:80%; font-family: sans-serif;}
+.cmss-8{ font-family: sans-serif;}
+.cmss-8{ font-family: sans-serif;}
+.small-caps{font-variant: small-caps; }
p.noindent { text-indent: 0em }
td p.noindent { text-indent: 0em; margin-top:0em; }
p.nopar { text-indent: 0em; }
@@ -172,7 +179,7 @@ div.array {text-align:center;}
.equation-star td{text-align:center; }
table.equation-star { width:100%; }
table.equation { width:100%; }
-table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width: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;}
@@ -186,6 +193,46 @@ div.longtable{text-align:center;}
.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:#00FF00}
+span#textcolor6{color:#FF0000}
+span#textcolor7{color:#FF0000}
+span#textcolor8{color:#FF0000}
+span#textcolor9{color:#00FF00}
+span#textcolor10{color:#00FF00}
+span#textcolor11{color:#FF0000}
+span#textcolor12{color:#00FF00}
+span#textcolor13{color:#00FF00}
+span#textcolor14{color:#00FF00}
+span#textcolor15{color:#00FF00}
+span#textcolor16{color:#FF0000}
+span#textcolor17{color:#FF0000}
+span#textcolor18{color:#FF0000}
+span#textcolor19{color:#00FF00}
+span#textcolor20{color:#00FF00}
+span#textcolor21{color:#FF0000}
+span#textcolor22{color:#00FF00}
+span#textcolor23{color:#00FF00}
+span#textcolor24{color:#00FF00}
+span#textcolor25{color:#00FF00}
+span#textcolor26{color:#FF0000}
+span#textcolor27{color:#FF0000}
+span#textcolor28{color:#00FF00}
+span#textcolor29{color:#FF0000}
+span#textcolor30{color:#FF0000}
+span#textcolor31{color:#FF0000}
+span#textcolor32{color:#00FF00}
+span#textcolor33{color:#FF0000}
+span#textcolor34{color:#00FF00}
+span#textcolor35{color:#00FF00}
+span#textcolor36{color:#00FF00}
+span#textcolor37{color:#00FF00}
+span#textcolor38{color:#FF0000}
+span#textcolor39{color:#00FF00}
+span#textcolor40{color:#00FF00}
/* end css.sty */
@@ -193,22 +240,22 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle
</style>
</head><body
>
-<!--l. 44--><p class="noindent" ><a
+<!--l. 55--><p class="noindent" ><a
id="top"></a>
-</p><!--l. 44--><p class="indent" >
+</p><!--l. 55--><p class="indent" >
-</p><!--l. 44--><p class="indent" >
+</p><!--l. 55--><p class="indent" >
</p>
<div class="center"
>
-<!--l. 44--><p class="noindent" >
-</p><!--l. 44--><p class="noindent" ><span
-class="cmr-17">The glossaries package v4.32: a guide for</span>
+<!--l. 55--><p class="noindent" >
+</p><!--l. 55--><p class="noindent" ><span
+class="cmr-17">The glossaries package v4.33: a guide for</span>
<span
class="cmr-17">beginners</span>
</p>
@@ -220,36 +267,36 @@ id="TBL-1-1" /></colgroup><tr
class="td11"> <span
class="cmr-12">Nicola L.C. Talbot </span></td></tr></table>
</div>
-<!--l. 44--><p class="noindent" ><span
-class="cmr-12">2017-08-24</span></p></div>
+<!--l. 55--><p class="noindent" ><span
+class="cmr-12">2017-09-20</span></p></div>
<div
class="abstract"
>
<div class="center"
>
-<!--l. 46--><p class="noindent" >
-</p><!--l. 46--><p class="noindent" ><span
+<!--l. 57--><p class="noindent" >
+</p><!--l. 57--><p class="noindent" ><span
class="cmbx-9">Abstract</span></p></div>
- <!--l. 47--><p class="indent" > <span
+ <!--l. 58--><p class="indent" > <span
class="cmr-9">The </span><span
class="cmss-9">glossaries </span><span
class="cmr-9">package is very flexible, but this means that it has a</span><span
class="cmr-9">&#x00A0;lot</span>
<span
-class="cmr-9">options, and since a user guide is supposed to provide a complete list of all</span>
+class="cmr-9">of options, and since a user guide is supposed to provide a complete list</span>
<span
-class="cmr-9">the high-level user commands, the main user manual is quite big. This can</span>
+class="cmr-9">of all the high-level user commands, the main user manual is quite big.</span>
<span
-class="cmr-9">be rather daunting for beginners, so this document is a brief introduction</span>
+class="cmr-9">This can be rather daunting for beginners, so this document is a brief</span>
<span
-class="cmr-9">just to help get you started. If you find yourself saying, &#8220;Yeah, but how</span>
+class="cmr-9">introduction just to help get you started. If you find yourself saying, &#8220;Yeah,</span>
<span
-class="cmr-9">can I do</span><span
+class="cmr-9">but how can I do</span><span
class="cmr-9">&#x2026;?&#8221; then it&#8217;s time to move on to the </span><a
href="glossaries-user.html" ><span
class="cmr-9">main user manual</span></a><span
class="cmr-9">.</span>
- </p><!--l. 56--><p class="indent" > <span
+ </p><!--l. 67--><p class="indent" > <span
class="cmr-9">I&#8217;ve made some statements in this document that don&#8217;t actually tell</span>
<span
class="cmr-9">you the full truth, but it would clutter the document and cause confusion</span>
@@ -287,12 +334,12 @@ href="#sec:xr" id="QQ2-1-10">Cross-References</a></span>
<br /> <span class="sectionToc" >9 <a
href="#sec:moreinfo" id="QQ2-1-11">Further Information</a></span>
</div>
-<!--l. 66--><p class="noindent" >
+<!--l. 77--><p class="noindent" >
</p>
-<!--l. 66--><p class="noindent" ><a
+<!--l. 77--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1 </span> <a
id="sec:start"></a>Getting Started</h3>
-<!--l. 69--><p class="noindent" >As with all packages, you need to load <span
+<!--l. 80--><p class="noindent" >As with all packages, you need to load <span
class="cmss-10">glossaries </span>with <span
class="cmtt-10">\usepackage</span>, but
there are certain packages that must be loaded before <span
@@ -312,7 +359,7 @@ class="cmss-10">fontenc</span><a
to load these packages, but if you want them, you must load them before
<span
class="cmss-10">glossaries</span>.)
-</p><!--l. 76--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant
+</p><!--l. 87--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant
language module. Each language module is called <span
class="cmtt-10">glossaries-</span>&#x27E8;<span
class="cmti-10">language</span>&#x27E9;, where
@@ -324,8 +371,8 @@ class="cmtt-10">glossaries-german</span>. If a language module is required, the
class="cmss-10">glossaries </span>package will
automatically try to load it and will give a warning if the module isn&#8217;t found.
</div>
-</p><!--l. 84--><p class="noindent" >
-</p><!--l. 86--><p class="indent" > Once you have loaded <span
+</p><!--l. 95--><p class="noindent" >
+</p><!--l. 97--><p class="indent" > Once you have loaded <span
class="cmss-10">glossaries</span>, you need to define your terms in the
preamble and then you can use them throughout the document. Here&#8217;s a simple
example:
@@ -334,34 +381,34 @@ example:
</p>
<div class="verbatim" id="verbatim-1">
-\documentclass{article}
-&#x00A0;<br />\usepackage{glossaries}
-&#x00A0;<br />\newglossaryentry{ex}{name={sample},description={an&#x00A0;example}}
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />Here's&#x00A0;my&#x00A0;\gls{ex}&#x00A0;term.
-&#x00A0;<br />\end{document}
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries}
+&#x00A0;<br />&#x00A0;\newglossaryentry{ex}{name={sample},description={an&#x00A0;example}}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;Here's&#x00A0;my&#x00A0;\gls{ex}&#x00A0;term.
+&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 99--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h">
- <br />Here&#8217;s my sample term.
- <br /><spacer type=vertical size=10></span>
-Here&#8217;s another example:
+<!--l. 110--><p class="nopar" > This produces:
+ </p><div class="quote">
+ <!--l. 113--><p class="noindent" >Here&#8217;s my sample term.</p></div>
+<!--l. 115--><p class="noindent" >Here&#8217;s another example:
</p>
<div class="verbatim" id="verbatim-2">
-\documentclass{article}
-&#x00A0;<br />\usepackage{glossaries}
-&#x00A0;<br />\setacronymstyle{long-short}
-&#x00A0;<br />\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />\end{document}
-</div>
-<!--l. 117--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h">
- <br />First use: support vector machine (SVM). Second use: SVM.
- <br /><spacer type=vertical size=10></span>
-In this case, the text produced by <span class="obeylines-h"><span class="verb"><span
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries}
+&#x00A0;<br />&#x00A0;\setacronymstyle{long-short}
+&#x00A0;<br />&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 128--><p class="nopar" > This produces:
+ </p><div class="quote">
+ <!--l. 131--><p class="noindent" >First use: support vector machine (SVM). Second use: SVM.</p></div>
+<!--l. 133--><p class="noindent" >In this case, the text produced by <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{svm}</span></span></span> changed after the first use. The first use
produced the long form followed by the short form in parentheses because I set the
acronym style to <span
@@ -375,7 +422,48 @@ class="cmtt-10">.log </span>file and search
for the line that starts with <span
class="cmtt-10">Package: glossaries </span>followed by a date and
version.)
-</p><!--l. 133--><p class="indent" > If you like, you can put all your definitions in another file (for example,
+</p><!--l. 144--><p class="indent" > Abbreviations are slightly different if you use the extension package <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2006"></a>
+(which needs to be installed separately):
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-3">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;<br />&#x00A0;\setabbreviationstyle{long-short}%&#x00A0;glossaries-extra.sty
+&#x00A0;<br />&#x00A0;\newabbreviation{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 158--><p class="nopar" > If you still want to use <span
+class="cmtt-10">\newacronym </span>(rather than <span
+class="cmtt-10">\newabbreviation</span>) then you need
+the optional argument of <span
+class="cmtt-10">\setabbreviationstyle</span>:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-4">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;<br />&#x00A0;\setabbreviationstyle[acronym]{long-short}%&#x00A0;glossaries-extra.sty&#x00A0;only
+&#x00A0;<br />&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 174--><p class="nopar" >
+</p><!--l. 175--><p class="indent" > <div class="important" title="Important Note"> You can&#8217;t use <span
+class="cmtt-10">\setacronymstyle </span>with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2007"></a>. </div>
+</p><!--l. 177--><p class="noindent" >
+</p><!--l. 179--><p class="indent" > If you like, you can put all your definitions in another file (for example,
<span
class="cmtt-10">defns.tex</span>) and load that file in the preamble using <span
class="cmtt-10">\loadglsentries </span>with the
@@ -384,177 +472,394 @@ filename as the argument. For example:
</p>
- <div class="verbatim" id="verbatim-3">
+ <div class="verbatim" id="verbatim-5">
\loadglsentries{defns}
</div>
-<!--l. 138--><p class="nopar" >
-</p><!--l. 140--><p class="indent" > Don&#8217;t try inserting formatting commands into the definitions as they can
-interfere with the underlying mechanism. Instead, the formatting should
-be done by the style. For example, suppose I&#x00A0;want to replace <span
-class="cmtt-10">SVM </span>in the
-above to <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\textsc{svm}</span></span></span>, then I&#x00A0;need to select a style that uses <span
-class="cmtt-10">\textsc</span>, like
-this:
+<!--l. 184--><p class="nopar" > If you find you have a really large number of definitions that are hard to manage in a
+<span
+class="cmtt-10">.tex </span>file, you might want to have a look at <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2008"></a> (installed separately) which
+requires a <span
+class="cmtt-10">.bib </span>format instead that can be managed by an application such as
+JabRef.
+</p><!--l. 191--><p class="indent" > Don&#8217;t try inserting formatting commands into the definitions as they can interfere
+with the underlying mechanism. Instead, the formatting should be done by the
+style. For example, suppose I&#x00A0;want to replace <span
+class="cmtt-10">SVM </span>with <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\textsc{svm}</span></span></span>, then
+I&#x00A0;need to select a style that uses <span
+class="cmtt-10">\textsc</span>, like this (for the base <span
+class="cmss-10">glossaries</span>
+style):
</p>
- <div class="verbatim" id="verbatim-4">
-\documentclass{article}
-&#x00A0;<br />\usepackage{glossaries}
-&#x00A0;<br />\setacronymstyle{long-sc-short}
-&#x00A0;<br />\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />\end{document}
+ <div class="verbatim" id="verbatim-6">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries}
+&#x00A0;<br />&#x00A0;\setacronymstyle{long-sc-short}
+&#x00A0;<br />&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 209--><p class="nopar" > The abbreviation styles have a different naming scheme with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2009"></a>:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-7">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;<br />&#x00A0;\setabbreviationstyle{long-short-sc}%&#x00A0;glossaries-extra.sty
+&#x00A0;<br />&#x00A0;\newabbreviation{svm}{svm}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 157--><p class="nopar" >
-</p><!--l. 159--><p class="indent" > As you can hopefully see from the above examples, there are two main ways of
-defining a term. In both cases, the term is given a label. In the first case the label
-was <span
-class="cmtt-10">ex </span>and in the second case the label was <span
-class="cmtt-10">svm</span>. The label is just a way of
-identifying the term (like the standard <span
+<!--l. 224--><p class="nopar" > With <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2010"></a> you can have multiple abbreviation styles for different
+categories. Many of these styles have their own associated formatting commands that
+can be redefined for minor adjustments. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-8">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;<br />&#x00A0;\setabbreviationstyle[statistical]{long-short-sc}
+&#x00A0;<br />&#x00A0;\setabbreviationstyle[bacteria]{long-only-short-only}
+&#x00A0;<br />&#x00A0;%&#x00A0;Formatting&#x00A0;commands&#x00A0;used&#x00A0;by&#x00A0;'long-only-short-only'&#x00A0;style:
+&#x00A0;<br />&#x00A0;\renewcommand*{\glsabbrvonlyfont}[1]{\emph{#1}}
+&#x00A0;<br />&#x00A0;\renewcommand*{\glslongonlyfont}[1]{\emph{#1}}
+&#x00A0;<br />&#x00A0;%&#x00A0;Formatting&#x00A0;command&#x00A0;used&#x00A0;by&#x00A0;'long-short-sc'&#x00A0;style:
+&#x00A0;<br />&#x00A0;%&#x00A0;(make&#x00A0;sure&#x00A0;abbreviation&#x00A0;is&#x00A0;converted&#x00A0;to&#x00A0;lower&#x00A0;case)
+&#x00A0;<br />&#x00A0;\renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}}
+&#x00A0;<br />&#x00A0;\newabbreviation
+&#x00A0;<br />&#x00A0;&#x00A0;[
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={statistical}%&#x00A0;glossaries-extra.sty&#x00A0;key
+&#x00A0;<br />&#x00A0;&#x00A0;]
+&#x00A0;<br />&#x00A0;&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;\newabbreviation
+&#x00A0;<br />&#x00A0;&#x00A0;[
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={bacteria}%&#x00A0;glossaries-extra.sty&#x00A0;key
+&#x00A0;<br />&#x00A0;&#x00A0;]
+&#x00A0;<br />&#x00A0;&#x00A0;{cbot}{C.~botulinum}{Clostridium&#x00A0;botulinum}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
+&#x00A0;<br />&#x00A0;Next&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 262--><p class="nopar" > This produces:
+ </p><div class="quote">
+ <!--l. 265--><p class="noindent" >First use: support vector machine (<span
+class="cmcsc-10"><span
+class="small-caps">s</span><span
+class="small-caps">v</span><span
+class="small-caps">m</span></span>), <span
+class="cmti-10">Clostridium botulinum</span>.
+ </p><!--l. 268--><p class="noindent" >Next use: <span
+class="cmcsc-10"><span
+class="small-caps">s</span><span
+class="small-caps">v</span><span
+class="small-caps">m</span></span>, <span
+class="cmti-10">C.</span><span
+class="cmti-10">&#x00A0;botulinum</span>.</p></div>
+<!--l. 271--><p class="indent" > As you can hopefully see from the above examples, there are two main ways of
+defining a term: as a general entry (<span
+class="cmtt-10">\newglossaryentry</span>) or as an abbreviation
+(<span
+class="cmtt-10">\newacronym </span>or, with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2011"></a>, <span
+class="cmtt-10">\newabbreviation</span>).
+</p><!--l. 276--><p class="indent" > Regardless of the method of defining a term, the term is always given a label. In
+
+
+
+the first example, the label was <span
+class="cmtt-10">ex </span>and in the other examples the label was <span
+class="cmtt-10">svm </span>(and
+<span
+class="cmtt-10">cbot </span>in the last example). The label is used to uniquely identify the term (like the
+standard <span
class="cmtt-10">\label</span>/<span
-class="cmtt-10">\ref </span>mechanism). It&#8217;s best to just use
-the following alphanumerics in the labels: <span
+class="cmtt-10">\ref </span>or <span
+class="cmtt-10">\cite </span>mechanism). It&#8217;s best to just use the following
+alphanumerics in the labels: <span
class="cmtt-10">a</span>, &#x2026;, <span
class="cmtt-10">z</span>, <span
class="cmtt-10">A</span>, &#x2026;, <span
class="cmtt-10">Z</span>, <span
class="cmtt-10">0</span>, &#x2026;, <span
-class="cmtt-10">9</span>. Sometimes you can
-also use punctuation characters but not if another package (such as <span
+class="cmtt-10">9</span>. Sometimes you can also use
+punctuation characters but not if another package (such as <span
class="cmss-10">babel</span><a
- id="dx1-2006"></a>)
-meddles with them. Don&#8217;t try using any characters outside of the basic Latin
-set (for example, &eacute; or &szlig;) or things will go horribly wrong. This warning
+ id="dx1-2012"></a>) meddles with
+them. Don&#8217;t try using any characters outside of the basic Latin set with
+<span
+class="cmss-10">inputenc</span><a
+ id="dx1-2013"></a> (for example, &eacute; or &szlig;) or things will go horribly wrong. This warning
only applies to the label. It doesn&#8217;t apply to the text that appears in the
document.
-</p><!--l. 173--><p class="indent" > <div class="important" title="Important Note"> Don&#8217;t use <span
-class="cmtt-10">\gls </span>in chapter or section headings as it can have some
-unpleasant side-effects. Instead use <span
-class="cmtt-10">\glsentrytext </span>for regular entries and
-one of <span
-class="cmtt-10">\glsentryshort</span>, <span
+</p><!--l. 291--><p class="indent" > <div class="important" title="Important Note"> Don&#8217;t use <span
+class="cmtt-10">\gls </span>in chapter or section headings as it can have some unpleasant
+side-effects. Instead use <span
+class="cmtt-10">\glsentrytext </span>for regular entries and one of <span
+class="cmtt-10">\glsentryshort</span>,
+<span
class="cmtt-10">\glsentrylong </span>or <span
-class="cmtt-10">\glsentryfull </span>for acronyms.
-</div>
-</p><!--l. 178--><p class="noindent" >
-</p><!--l. 180--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes
-if you want to display a sorted list of all the entries you have used in the
-document. The <span
-class="cmss-10">glossaries </span>package provides three options: use <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;to perform the
-sorting; use <span
-class="cmtt-10">makeindex </span>to perform the sorting; use <span
-class="cmtt-10">xindy </span>to perform the
-sorting.
-</p><!--l. 187--><p class="indent" > The first option (using <span class="TEX">T<span
-class="E">E</span>X</span>) is the simplest and easiest method, but
-it&#8217;s inefficient and the sorting is done according to the English alphabet.
-To use this method, add <span
+class="cmtt-10">\glsentryfull </span>for acronyms. Alternatively use <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2014"></a>
+which provides special commands for use in section headings, such as <span
+class="cmtt-10">\glsfmtshort</span>
+<span
+class="cmtt-10">{</span>&#x27E8;<span
+class="cmti-10">label</span>&#x27E9;<span
+class="cmtt-10">}</span>. </div>
+</p><!--l. 298--><p class="noindent" >
+</p><!--l. 300--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes if you
+want to display a <span
+class="cmti-10">sorted </span>list of all the entries you have used in the document. The
+<span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2015"></a> package provides a really easy way of listing all the defined
+entries:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-9">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage[sort=none]{glossaries-extra}
+&#x00A0;<br />&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
+&#x00A0;<br />&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
+&#x00A0;<br />&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{turnip}{name={turnip},
+&#x00A0;<br />&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{carrot}{name={carrot},
+&#x00A0;<br />&#x00A0;&#x00A0;description={orange&#x00A0;root}}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
+&#x00A0;<br />&#x00A0;\printunsrtglossaries&#x00A0;%&#x00A0;list&#x00A0;all&#x00A0;entries
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 326--><p class="nopar" > However this method doesn&#8217;t sort the entries (they&#8217;re listed in order of definition)
+and it will display all the defined entries, regardless of whether or not you&#8217;ve used
+them all in the document, so &#8220;turnip&#8221; appears in the glossary even though there&#8217;s no
+<span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{turnip}</span></span></span> (or similar) in the document.
+</p><!--l. 333--><p class="indent" > The <span
+class="cmss-10">sort=none</span><a
+ id="dx1-2016"></a> option isn&#8217;t essential in this case (there&#8217;s no other sort option
+available for this document), but it prevents the automatic construction of the sort
+value and so slightly improves the document build time.
+</p><!--l. 338--><p class="indent" > Note that this example document uses the same command (<span
+class="cmtt-10">\printunsrtglossaries</span>)
+that&#8217;s used with <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2017"></a> (<a
+href="#option4">Option&#x00A0;4</a>) but with <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2018"></a> you instead need to use the
+<span
+class="cmss-10">record</span><a
+ id="dx1-2019"></a> package option and one or more instances of <span
+class="cmtt-10">\GlsXtrLoadResources </span>in the
+preamble (see below).
+</p><!--l. 344--><p class="indent" > Most users prefer to have an automatically sorted list that only contains entries
+that have been used in the document. The <span
+class="cmss-10">glossaries </span>package provides three options:
+use <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;to perform the sorting (<a
+href="#option1">Option&#x00A0;1</a>); use <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-2020"></a> to perform
+the sorting (<a
+href="#option2">Option&#x00A0;2</a>); use <span
+class="cmtt-10">xindy</span><a
+ id="dx1-2021"></a> to perform the sorting (<a
+href="#option3">Option&#x00A0;3</a>). The
+extension package <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2022"></a> provides a fourth method: use <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2023"></a>
+(<a
+href="#option4">Option&#x00A0;4</a>).
+</p><!--l. 352--><p class="indent" > The first option (using <span class="TEX">T<span
+class="E">E</span>X</span>) is the simplest method, as it doesn&#8217;t require an
+external tool, but it&#8217;s very inefficient and the sorting is done according to the English
+alphabet. To use this method, add <span
class="cmtt-10">\makenoidxglossaries </span>to the preamble and put
<span
class="cmtt-10">\printnoidxglossaries </span>at the place where you want your glossary. For
+
+
+
example:
</p>
- <div class="verbatim" id="verbatim-5">
-\documentclass{article}
-&#x00A0;<br />\usepackage{glossaries}
-&#x00A0;<br />\makenoidxglossaries
-&#x00A0;<br />\newglossaryentry{potato}{name={potato},plural={potatoes},
-&#x00A0;<br />&#x00A0;description={starchy&#x00A0;tuber}}
-&#x00A0;<br />\newglossaryentry{cabbage}{name={cabbage},
-&#x00A0;<br />&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
-&#x00A0;<br />\newglossaryentry{carrot}{name={carrot},
-&#x00A0;<br />&#x00A0;description={orange&#x00A0;root}}
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
-&#x00A0;<br />\printnoidxglossaries
-&#x00A0;<br />\end{document}
-</div>
-<!--l. 213--><p class="nopar" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ <div class="verbatim" id="verbatim-10">
+&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries}
+&#x00A0;<br />&#x00A0;\makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
+&#x00A0;<br />&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
+&#x00A0;<br />&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
+&#x00A0;<br />&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{turnip}{name={turnip},
+&#x00A0;<br />&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
+&#x00A0;<br />&#x00A0;\newglossaryentry{carrot}{name={carrot},
+&#x00A0;<br />&#x00A0;&#x00A0;description={orange&#x00A0;root}}
+&#x00A0;<br />&#x00A0;\begin{document}
+&#x00A0;<br />&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
+&#x00A0;<br />&#x00A0;\printnoidxglossaries
+&#x00A0;<br />&#x00A0;\end{document}
+</div>
+<!--l. 382--><p class="nopar" >
+</p><!--l. 384--><p class="indent" > <div class="important" title="Important Note"> The <span
+class="cmtt-10">\makenoidxglossaries </span>method is very slow, uses an ASCII comparator and
+often breaks if there are commands in the <span
+class="cmtt-10">name </span>key. </div>
+</p><!--l. 388--><p class="noindent" >
+</p><!--l. 390--><p class="indent" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;(or pdf<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>) <span
-class="cmti-10">twice</span>. The first run won&#8217;t
-show the glossary. It will only appear on the second run. The glossary has
-a vertical gap between the &#8220;carrot&#8221; term and the &#8220;potato&#8221; term. This is
-because the entries in the glossaries are grouped according to their first
-letter. If you don&#8217;t want this gap, just add <span
-class="cmtt-10">nogroupskip </span>to the package
+class="cmti-10">twice</span>. The first run won&#8217;t show the
+glossary. It will only appear on the second run. This doesn&#8217;t include &#8220;turnip&#8221; in the
+glossary because that term hasn&#8217;t been used (with commands like <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{turnip}</span></span></span>) in
+the document.
+</p><!--l. 395--><p class="indent" > The glossary has a vertical gap between the &#8220;carrot&#8221; term and the &#8220;potato&#8221; term.
+This is because the entries in the glossaries are grouped according to their
+first letter. If you don&#8217;t want this gap, just add <span
+class="cmss-10">nogroupskip</span><a
+ id="dx1-2024"></a> to the package
options:
</p>
- <div class="verbatim" id="verbatim-6">
+ <div class="verbatim" id="verbatim-11">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 222--><p class="nopar" > If you try out this example you may also notice that the description is followed
-by a full stop (period) and a number. The number is the location in the
-document where the entry was used, so you can lookup the term in the glossary
+<!--l. 401--><p class="nopar" > or you may want to try out a style that shows the group headings:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-12">
+\usepackage[style=indexgroup]{glossaries}
+</div>
+<!--l. 405--><p class="nopar" > If you try out this example you may also notice that the description is followed by a
+full stop (period) and a number. The number is the location in the document where
+the entry was used (page&#x00A0;1 in this case), so you can lookup the term in the glossary
and be directed to the relevant pages. It may be that you don&#8217;t want this
back-reference, in which case you can suppress it using the <span
-class="cmtt-10">nonumberlist </span>package
+class="cmss-10">nonumberlist</span><a
+ id="dx1-2025"></a> package
option:
</p>
- <div class="verbatim" id="verbatim-7">
+ <div class="verbatim" id="verbatim-13">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--l. 231--><p class="nopar" > If you don&#8217;t like the terminating full stop, you can suppress that with the <span
-class="cmtt-10">nopostdot</span>
+<!--l. 415--><p class="nopar" > If you don&#8217;t like the terminating full stop, you can suppress that with the <span
+class="cmss-10">nopostdot</span><a
+ id="dx1-2026"></a>
package option:
</p>
- <div class="verbatim" id="verbatim-8">
+ <div class="verbatim" id="verbatim-14">
\usepackage[nopostdot]{glossaries}
</div>
-<!--l. 236--><p class="nopar" >
-</p><!--l. 238--><p class="indent" > You may have noticed that I&#8217;ve used another command in the above example:
+<!--l. 420--><p class="nopar" >
+</p><!--l. 422--><p class="indent" > If you tried out the previous example with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2027"></a> and <span
+class="cmtt-10">\printunsrtglossaries</span>
+the terminating full stop is missing and there are no number lists. You can add the
+full stop back with
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-15">
+\usepackage[nopostdot=false]{glossaries-extra}
+</div>
+<!--l. 427--><p class="nopar" > or
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-16">
+\usepackage[postdot]{glossaries-extra}
+</div>
+<!--l. 431--><p class="nopar" > If you want the number lists then you need to use an indexing option.
+</p><!--l. 435--><p class="indent" > You may have noticed that I&#8217;ve used another command in the above example:
<span
class="cmtt-10">\glspl</span>. This displays the plural form. By default, this is just the singular form with
the letter &#8220;s&#8221; appended, but in the case of &#8220;potato&#8221; I had to specify the correct
plural using the <span
class="cmtt-10">plural </span>key.
-</p><!--l. 244--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span
+</p><!--l. 441--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span
class="E">E</span>X</span>&#x00A0;to sort the entries is the simplest but least
efficient method. If you have a large glossary or if your terms contain non-Latin or
extended Latin characters, then you will have a much faster build time if you use
<span
-class="cmtt-10">makeindex </span>or <span
-class="cmtt-10">xindy</span>. If you are using extended Latin or non-Latin characters, then
-<span
-class="cmtt-10">xindy </span>is the recommended method. These two methods are described in more detail
-in <a
+class="cmtt-10">makeindex</span><a
+ id="dx1-2028"></a> (<a
+href="#option2">Option&#x00A0;2</a>) or <span
+class="cmtt-10">xindy</span><a
+ id="dx1-2029"></a> (<a
+href="#option3">Option&#x00A0;3</a>) or <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2030"></a> (<a
+href="#option4">Option&#x00A0;4</a>). If you are using
+extended Latin or non-Latin characters, then <span
+class="cmtt-10">xindy</span><a
+ id="dx1-2031"></a> or <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-2032"></a> are the
+recommended methods. These methods are described in more detail in <a
href="#sec:printglossaries"><span
class="cmsy-10">&sect;</span>4 </a><a
-href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
-</p><!--l. 253--><p class="indent" > The rest of this document briefly describes the main commands provided by the
+href="#sec:printglossaries">Displaying
+a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
+</p><!--l. 451--><p class="indent" > The rest of this document briefly describes the main commands provided by the
<span
-class="cmss-10">glossaries </span>package.
-</p><!--l. 256--><p class="noindent" >
+class="cmss-10">glossaries </span>package. (Most of these are also available with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-2033"></a> but may
+behave slightly differently.)
+</p><!--l. 456--><p class="noindent" >
</p>
-<!--l. 256--><p class="noindent" ><a
+<!--l. 456--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a
id="sec:defterm"></a>Defining Terms</h3>
-<!--l. 259--><p class="noindent" >When you use the <span
+<!--l. 459--><p class="noindent" >When you use the <span
class="cmss-10">glossaries</span><a
id="dx1-3001"></a> package, you need to define glossary entries in the
-document preamble. These entries could be a&#x00A0;word, phrase, acronym or symbol.
+document preamble. These entries could be a&#x00A0;word, phrase, abbreviation or symbol.
They&#8217;re usually accompanied by a&#x00A0;description, which could be a short sentence or an
in-depth explanation that spans multiple paragraphs. The simplest method of
defining an entry is to use:
-</p><!--l. 266--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
+</p><!--l. 466--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{</span>&#x27E8;<span
@@ -581,23 +886,23 @@ class="cmitt-10">&#x00A0;options</span>&#x27E9;
class="cmtt-10">}</span></span>
</div>
</div> </div><hr>
-<!--l. 274--><p class="noindent" >
+
+
+
+<!--l. 474--><p class="noindent" >
where &#x27E8;<span
class="cmti-10">label</span>&#x27E9; is a unique label that identifies this entry. (Don&#8217;t include the angle
brackets &#x27E8; &#x27E9;. They just indicate the parts of the code you need to change when you use
this command in your document.) The &#x27E8;<span
class="cmti-10">name</span>&#x27E9; is the word, phrase or symbol
-
-
-
you are defining, and &#x27E8;<span
class="cmti-10">description</span>&#x27E9; is the description to be displayed in the
glossary.
-</p><!--l. 282--><p class="indent" > This command is a &#8220;short&#8221; command, which means that &#x27E8;<span
+</p><!--l. 482--><p class="indent" > This command is a &#8220;short&#8221; command, which means that &#x27E8;<span
class="cmti-10">description</span>&#x27E9; can&#8217;t
contain a&#x00A0;paragraph break. If you have a&#x00A0;long description, you can instead
use:
-</p><!--l. 286--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
+</p><!--l. 486--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\longnewglossaryentry{</span>&#x27E8;<span
@@ -623,8 +928,8 @@ class="cmitt-10">description</span>&#x27E9;<span
class="cmtt-10">}</span>
</div>
</div> </div><hr>
-<!--l. 294--><p class="noindent" >
-</p><!--l. 296--><p class="indent" > Examples:
+<!--l. 494--><p class="noindent" >
+</p><!--l. 496--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-3003x1">Define the term &#8220;set&#8221; with the label <span
@@ -632,14 +937,14 @@ class="cmtt-10">set</span>:
- <div class="verbatim" id="verbatim-9">
+ <div class="verbatim" id="verbatim-17">
\newglossaryentry{set}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={set},
&#x00A0;<br />&#x00A0;&#x00A0;description={a&#x00A0;collection&#x00A0;of&#x00A0;objects}
&#x00A0;<br />}
</div>
- <!--l. 305--><p class="nopar" >
+ <!--l. 505--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-3005x2">Define the symbol <span
@@ -648,14 +953,17 @@ class="cmtt-10">emptyset</span>:
- <div class="verbatim" id="verbatim-10">
+ <div class="verbatim" id="verbatim-18">
\newglossaryentry{emptyset}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;empty&#x00A0;set}
&#x00A0;<br />}
</div>
- <!--l. 315--><p class="nopar" >
+ <!--l. 515--><p class="nopar" > (This will also need a <span
+class="cmtt-10">sort </span>key if you use Options&#x00A0;<a
+href="#option1">1</a> or&#x00A0;<a
+href="#option3">3</a>, see below.)
</p></li>
<li
class="enumerate" id="x1-3007x3">Define the phrase &#8220;Fish Age&#8221; with the label <span
@@ -663,7 +971,7 @@ class="cmtt-10">fishage</span>:
- <div class="verbatim" id="verbatim-11">
+ <div class="verbatim" id="verbatim-19">
\longnewglossaryentry{fishage}
&#x00A0;<br />{name={Fish&#x00A0;Age}}
&#x00A0;<br />{%
@@ -674,7 +982,7 @@ class="cmtt-10">fishage</span>:
&#x00A0;<br />&#x00A0;&#x00A0;fish&#x00A0;species.
&#x00A0;<br />}
</div>
- <!--l. 330--><p class="nopar" > (The percent character discards the end of line character that would otherwise
+ <!--l. 532--><p class="nopar" > (The percent character discards the end of line character that would otherwise
cause an unwanted space to appear at the start of the description.)
</p></li>
<li
@@ -688,14 +996,14 @@ class="cmtt-10">&eacute;</span>). This first letter must be placed in a&#x00A0;g
- <div class="verbatim" id="verbatim-12">
+ <div class="verbatim" id="verbatim-20">
\newglossaryentry{elite}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={{\'e}lite},
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
- <!--l. 346--><p class="nopar" > or </p><div class="alltt">
+ <!--l. 548--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
@@ -719,62 +1027,307 @@ class="cmtt-10">&#x00A0;class}</span></span>
class="cmtt-10">}</span></span>
</div>
</div></li></ol>
-<!--l. 356--><p class="noindent" >(For further details, see the section <a
-href="mfirstuc-manual.html" >&#8220;UTF-8&#8221;</a> in the <span
-class="cmss-10">mfirstuc</span><a
- id="dx1-3011"></a> user manual.)
-</p><!--l. 360--><p class="indent" > Acronyms (or other abbreviations) can be defined using
-</p><!--l. 362--><p class="indent" > <hr><div title="Definition"><span
-class="cmtt-10">\newacronym{</span>&#x27E8;<span
+<!--l. 558--><p class="noindent" >(For further details, see the section &#8220;UTF-8&#8221; of the <a
+href="https://ctan.org/pkg/mfirstuc" ><span
+class="cmss-10">mfirstuc</span></a> user manual.)
+</p><!--l. 561--><p class="indent" > If you use <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3011"></a> with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3012"></a> then the terms must be defined in a <span
+class="cmtt-10">.bib</span>
+file. For example: </p><div class="alltt">
+<div class="obeylines-v">
+<span
+class="cmtt-10">%</span><span
+class="cmtt-10">&#x00A0;Encoding:</span><span
+class="cmtt-10">&#x00A0;UTF-8</span>
+<br />
+<br /><span
+class="cmtt-10">@entry</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">set,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;name=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">set</span><span
+class="cmsy-10">}</span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;description=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">a</span><span
+class="cmtt-10">&#x00A0;collection</span><span
+class="cmtt-10">&#x00A0;of</span><span
+class="cmtt-10">&#x00A0;objects</span><span
+class="cmsy-10">}</span>
+<br /><span
+class="cmsy-10">}</span>
+<br />
+<br /><span
+class="cmtt-10">@entry</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">emptyset,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;name=</span><span class="verb"><span
+class="cmtt-10">{\ensuremath{\emptyset}}</span></span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;description=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">the</span><span
+class="cmtt-10">&#x00A0;empty</span><span
+class="cmtt-10">&#x00A0;set</span><span
+class="cmsy-10">}</span>
+<br /><span
+class="cmsy-10">}</span>
+<br />
+<br /><span
+class="cmtt-10">@entry</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">fishage,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;name=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">Fish</span><span
+class="cmtt-10">&#x00A0;Age</span><span
+class="cmsy-10">}</span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;description=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">A</span><span
+class="cmtt-10">&#x00A0;common</span><span
+class="cmtt-10">&#x00A0;name</span><span
+class="cmtt-10">&#x00A0;for</span><span
+class="cmtt-10">&#x00A0;the</span><span
+class="cmtt-10">&#x00A0;Devonian</span><span
+class="cmtt-10">&#x00A0;geologic</span><span
+class="cmtt-10">&#x00A0;period</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;spanning</span><span
+class="cmtt-10">&#x00A0;from</span><span
+class="cmtt-10">&#x00A0;the</span><span
+class="cmtt-10">&#x00A0;end</span><span
+class="cmtt-10">&#x00A0;of</span><span
+class="cmtt-10">&#x00A0;the</span><span
+class="cmtt-10">&#x00A0;Silurian</span><span
+class="cmtt-10">&#x00A0;Period</span><span
+class="cmtt-10">&#x00A0;to</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;the</span><span
+class="cmtt-10">&#x00A0;beginning</span><span
+class="cmtt-10">&#x00A0;of</span><span
+class="cmtt-10">&#x00A0;the</span><span
+class="cmtt-10">&#x00A0;Carboniferous</span><span
+class="cmtt-10">&#x00A0;Period.</span>
+
+
+
+<br />
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;This</span><span
+class="cmtt-10">&#x00A0;age</span><span
+class="cmtt-10">&#x00A0;was</span><span
+class="cmtt-10">&#x00A0;known</span><span
+class="cmtt-10">&#x00A0;for</span><span
+class="cmtt-10">&#x00A0;its</span><span
+class="cmtt-10">&#x00A0;remarkable</span><span
+class="cmtt-10">&#x00A0;variety</span><span
+class="cmtt-10">&#x00A0;of</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;fish</span><span
+class="cmtt-10">&#x00A0;species.</span><span
+class="cmsy-10">}</span>
+<br /><span
+class="cmsy-10">}</span>
+<br />
+<br /><span
+class="cmtt-10">@entry</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">elite,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;name=</span><span class="verb"><span
+class="cmtt-10">{{</span></span><span
+class="cmtt-10">&eacute;</span><span class="verb"><span
+class="cmtt-10">}lite}</span></span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;description=</span><span class="verb"><span
+class="cmtt-10">{select</span><span
+class="cmtt-10">&#x00A0;group</span><span
+class="cmtt-10">&#x00A0;or</span><span
+class="cmtt-10">&#x00A0;class}</span></span>
+<br /><span
+class="cmsy-10">}</span>
+</div>
+</div> (The <span
+class="cmtt-10">.bib </span>format doesn&#8217;t allow spaces in labels so you can&#8217;t have <span
+class="cmtt-10">fish age </span>as the
+label, but you can have <span
+class="cmtt-10">fish-age</span>.) This method requires the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3013"></a>&#8217;s <span
+class="cmss-10">record</span><a
+ id="dx1-3014"></a>
+package option:
+
+
+
+ <div class="verbatim" id="verbatim-21">
+\usepackage[record]{glossaries-extra}
+</div>
+<!--l. 598--><p class="nopar" > and the <span
+class="cmtt-10">.bib </span>file is specified in the resource command. For example, if the
+<span
+class="cmtt-10">.bib </span>file is called <span
+class="cmtt-10">entries.bib </span>then put the following line in the document
+preamble:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-22">
+\GlsXtrLoadResources[src={entries}]
+</div>
+<!--l. 604--><p class="nopar" > You can have a comma-separated list. For example, if you also have entries defined
+in the file <span
+class="cmtt-10">entries2.bib</span>:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-23">
+\GlsXtrLoadResources[src={entries,entries2.bib}]
+</div>
+<!--l. 609--><p class="nopar" >
+</p><!--l. 611--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span
+class="cmtt-10">name</span>
+key indicates how the term should appear in the list of entries (glossary), but if the
+term should appear differently when you reference it with <span
+class="cmtt-10">\gls{</span>&#x27E8;<span
+class="cmti-10">label</span>&#x27E9;<span
+class="cmtt-10">} </span>in the
+document, you need to use the <span
+class="cmtt-10">text </span>key as well.
+</p><!--l. 617--><p class="indent" > For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-24">
+\newglossaryentry{latinalph}
+&#x00A0;<br />{
+&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
+&#x00A0;<br />&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
+&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
+&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
+&#x00A0;<br />}
+</div>
+<!--l. 626--><p class="nopar" > This will appear in the text as &#8220;Latin alphabet&#8221; but will be listed in the glossary
+as &#8220;Latin Alphabet&#8221;. With <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3015"></a> this entry is defined in the <span
+class="cmtt-10">.bib </span>file
+as:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-25">
+@entry{latinalph,
+&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
+&#x00A0;<br />&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
+&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
+&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
+&#x00A0;<br />}
+</div>
+<!--l. 638--><p class="nopar" >
+</p><!--l. 640--><p class="indent" > Another commonly used key is <span
+class="cmtt-10">plural </span>for specifying the plural of the term. This
+defaults to the value of the <span
+class="cmtt-10">text </span>key with an &#8220;s&#8221; appended, but if this is incorrect,
+just use the <span
+class="cmtt-10">plural </span>key to override it:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-26">
+\newglossaryentry{oesophagus}
+&#x00A0;<br />{
+&#x00A0;<br />&#x00A0;&#x00A0;name={{\oe}sophagus},
+&#x00A0;<br />&#x00A0;&#x00A0;plural={{\oe}sophagi},
+&#x00A0;<br />&#x00A0;&#x00A0;description={canal&#x00A0;from&#x00A0;mouth&#x00A0;to&#x00A0;stomach}
+&#x00A0;<br />}
+</div>
+<!--l. 651--><p class="nopar" > (Remember from earlier that the initial ligature <span
+class="cmtt-10">\oe </span>needs to be grouped.)
+</p><!--l. 655--><p class="indent" > Abbreviations can be defined using
+</p><!--l. 657--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\newacronym[</span>&#x27E8;<span
+class="cmitt-10">options</span>&#x27E9;<span
+class="cmtt-10">]{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">short</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">long</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 363--><p class="noindent" >
+</p><!--l. 658--><p class="noindent" >
where &#x27E8;<span
-class="cmti-10">label</span>&#x27E9; is the label (as with the <span
-class="cmtt-10">\newglossaryentry </span>and the <span
-class="cmtt-10">\longnewglossaryentry</span>
-commands), &#x27E8;<span
-class="cmti-10">short</span>&#x27E9; is the short form and &#x27E8;<span
-class="cmti-10">long</span>&#x27E9; is the long form. For example, the
-following defines an abbreviation:
+class="cmti-10">label</span>&#x27E9; is the label (as per <span
+class="cmtt-10">\newglossaryentry</span>), &#x27E8;<span
+class="cmti-10">short</span>&#x27E9; is the short form and
+&#x27E8;<span
+class="cmti-10">long</span>&#x27E9; is the long form. For example, the following defines an abbreviation:
</p>
- <div class="verbatim" id="verbatim-13">
-\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-</div>
-<!--l. 370--><p class="nopar" > This defines a glossary entry with the label <span
-class="cmtt-10">svm</span>. By default, the &#x27E8;<span
-class="cmti-10">name</span>&#x27E9; is set
-to &#x27E8;<span
-class="cmti-10">short</span>&#x27E9; (&#8220;svm&#8221; in the above example) and the &#x27E8;<span
-class="cmti-10">description</span>&#x27E9; is set to &#x27E8;<span
-class="cmti-10">long</span>&#x27E9;
-(&#8220;support vector machine&#8221; in the above example). If, instead, you want to
-be able to specify your own description you can do this using the optional
-argument:
+ <div class="verbatim" id="verbatim-27">
+\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+</div>
+<!--l. 665--><p class="nopar" > This internally uses <span
+class="cmtt-10">\newglossaryentry </span>to define an entry with the label <span
+class="cmtt-10">svm</span>. By
+default, the <span
+class="cmtt-10">name </span>key is set to &#x27E8;<span
+class="cmti-10">short</span>&#x27E9; (&#8220;SVM&#8221; in the above example) and the
+<span
+class="cmtt-10">description </span>key is set to &#x27E8;<span
+class="cmti-10">long</span>&#x27E9; (&#8220;support vector machine&#8221; in the above example). If,
+instead, you want to be able to specify your own description you can do this using
+the optional argument:
</p>
- <div class="verbatim" id="verbatim-14">
+ <div class="verbatim" id="verbatim-28">
\newacronym
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
-&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 381--><p class="nopar" >
-</p><!--l. 383--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to
+<!--l. 677--><p class="nopar" >
+</p><!--l. 679--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to
specify which style to use with
-</p><!--l. 386--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 682--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\setacronymstyle{</span>&#x27E8;<span
class="cmitt-10">style name</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 387--><p class="noindent" >
+</p><!--l. 683--><p class="noindent" >
where &#x27E8;<span
class="cmti-10">style name</span>&#x27E9; is the name of the style. There are a number of predefined styles,
such as: <span
@@ -791,49 +1344,81 @@ description). There are some other styles as well that use <span
class="cmtt-10">\textsc </span>to typeset the
acronym or that use a footnote on first use. See the main user guide for further
details.
-</p><!--l. 399--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span
-class="cmtt-10">name</span>
-key used above indicates how the term should appear in the list of entries (glossary).
-If the term should appear differently when you reference it in the document, you need
-to use the <span
-class="cmtt-10">text </span>key as well.
-</p><!--l. 405--><p class="indent" > For example:
-
-
-
-</p>
- <div class="verbatim" id="verbatim-15">
-\newglossaryentry{latinalph}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
-&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
-&#x00A0;<br />}
+</p><!--l. 695--><p class="indent" > The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3016"></a> package provides improved abbreviation handling with <a
+href="http://www.dickimaw-books.com/gallery/sample-abbr-styles.shtml" >a lot
+more predefined styles</a>. With this extension package, abbreviations are defined
+using:
+</p><!--l. 699--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\newabbreviation[</span>&#x27E8;<span
+class="cmitt-10">options</span>&#x27E9;<span
+class="cmtt-10">]{</span>&#x27E8;<span
+class="cmitt-10">label</span>&#x27E9;<span
+class="cmtt-10">}{</span>&#x27E8;<span
+class="cmitt-10">short</span>&#x27E9;<span
+class="cmtt-10">}{</span>&#x27E8;<span
+class="cmitt-10">long</span>&#x27E9;<span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 700--><p class="noindent" >
+You can still use <span
+class="cmtt-10">\newacronym </span>but it&#8217;s redefined to use the new abbreviation
+interface. The style must now be set using:
+</p><!--l. 704--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\setabbreviationstyle[</span>&#x27E8;<span
+class="cmitt-10">category</span>&#x27E9;<span
+class="cmtt-10">]{</span>&#x27E8;<span
+class="cmitt-10">style name</span>&#x27E9;<span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 705--><p class="noindent" >
+The default &#x27E8;<span
+class="cmti-10">category</span>&#x27E9; is <span
+class="cmtt-10">abbreviation</span>. If you use <span
+class="cmtt-10">\newacronym </span>the category is
+<span
+class="cmtt-10">acronym</span>, which is why you need to use the optional argument if you define
+abbreviations with <span
+class="cmtt-10">\newacronym </span>when <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3017"></a> has been loaded: </p><div class="alltt">
+<div class="obeylines-v">
+<span
+class="cmtt-10">\setabbreviationstyle[acronym]{</span>&#x27E8;<span
+class="cmitt-10">style</span><span
+class="cmitt-10">&#x00A0;name</span>&#x27E9;<span
+class="cmtt-10">}</span>
</div>
-<!--l. 414--><p class="nopar" > This will appear in the text as &#8220;Latin alphabet&#8221; but will be listed in the glossary as
-&#8220;Latin Alphabet&#8221;.
-</p><!--l. 418--><p class="indent" > Another commonly used key is <span
-class="cmtt-10">plural </span>for specifying the plural of the term. This
-defaults to the value of the <span
-class="cmtt-10">text </span>key with an &#8220;s&#8221; appended, but if this is incorrect,
-just use the <span
-class="cmtt-10">plural </span>key to override it:
+</div> If you use <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3018"></a> then abbreviations are defined in the <span
+class="cmtt-10">.bib </span>file in the format:
+<div class="alltt">
+<div class="obeylines-v">
+<span
+class="cmtt-10">@abbreviation</span><span
+class="cmsy-10">{</span>&#x27E8;<span
+class="cmitt-10">label</span>&#x27E9;<span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;long={</span>&#x27E8;<span
+class="cmitt-10">long</span><span
+class="cmitt-10">&#x00A0;form</span>&#x27E9;<span
+class="cmtt-10">},</span>
-</p>
- <div class="verbatim" id="verbatim-16">
-\newglossaryentry{oesophagus}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={{\oe}sophagus},
-&#x00A0;<br />&#x00A0;&#x00A0;plural={{\oe}sophagi},
-&#x00A0;<br />&#x00A0;&#x00A0;description={canal&#x00A0;from&#x00A0;mouth&#x00A0;to&#x00A0;stomach}
-&#x00A0;<br />}
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;short={</span>&#x27E8;<span
+class="cmitt-10">short</span><span
+class="cmitt-10">&#x00A0;form</span>&#x27E9;<span
+class="cmtt-10">}</span>
+<br /><span
+class="cmsy-10">}</span>
</div>
-<!--l. 429--><p class="nopar" > (Remember from earlier that the initial ligature <span
-class="cmtt-10">\oe </span>needs to be grouped.)
-</p><!--l. 433--><p class="indent" > The plural forms for acronyms can be specified using the <span
+</div>
+<!--l. 722--><p class="indent" > The plural forms for abbreviations can be specified using the <span
class="cmtt-10">longplural </span>and
<span
class="cmtt-10">shortplural </span>keys. For example:
@@ -841,14 +1426,41 @@ class="cmtt-10">shortplural </span>keys. For example:
</p>
- <div class="verbatim" id="verbatim-17">
+ <div class="verbatim" id="verbatim-29">
\newacronym
&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
</div>
-<!--l. 439--><p class="nopar" > If omitted, the defaults are again obtained by appending an &#8220;s&#8221; to the singular
-versions.
-</p><!--l. 443--><p class="indent" > It&#8217;s also possible to have both a&#x00A0;name and a&#x00A0;corresponding symbol.
+<!--l. 728--><p class="nopar" > or (with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3019"></a>):
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-30">
+\newabbreviation&#x00A0;%&#x00A0;glossaries-extra.sty
+&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
+&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
+</div>
+<!--l. 734--><p class="nopar" > If omitted, the defaults are again obtained by appending an &#8220;s&#8221; to the singular
+versions. With <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3020"></a>, the definition in the <span
+class="cmtt-10">.bib </span>file is:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-31">
+@abbreviation{dm,
+&#x00A0;<br />&#x00A0;&#x00A0;short={DM},
+&#x00A0;<br />&#x00A0;&#x00A0;long={diagonal&#x00A0;matrix},
+&#x00A0;<br />&#x00A0;&#x00A0;longplural={diagonal&#x00A0;matrices}
+&#x00A0;<br />}
+</div>
+<!--l. 744--><p class="nopar" >
+</p><!--l. 746--><p class="indent" > It&#8217;s also possible to have both a&#x00A0;name and a&#x00A0;corresponding symbol.
Just use the <span
class="cmtt-10">name </span>key for the name and the <span
class="cmtt-10">symbol </span>key for the symbol. For
@@ -857,7 +1469,7 @@ example:
</p>
- <div class="verbatim" id="verbatim-18">
+ <div class="verbatim" id="verbatim-32">
\newglossaryentry{emptyset}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={empty&#x00A0;set},
@@ -865,28 +1477,169 @@ example:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 453--><p class="nopar" >
-</p><!--l. 455--><p class="noindent" >
+<!--l. 756--><p class="nopar" > or with <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3021"></a> the definition in the <span
+class="cmtt-10">.bib </span>file is:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-33">
+@entry{emptyset,
+&#x00A0;<br />&#x00A0;&#x00A0;name={empty&#x00A0;set},
+&#x00A0;<br />&#x00A0;&#x00A0;symbol={\ensuremath{\emptyset}},
+&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+&#x00A0;<br />}
+</div>
+<!--l. 764--><p class="nopar" >
+</p><!--l. 766--><p class="indent" > If you want the symbol in the <span
+class="cmtt-10">name </span>field then you must supply a <span
+class="cmtt-10">sort </span>value with
+Options&#x00A0;<a
+href="#option1">1</a> and&#x00A0;<a
+href="#option3">3</a> otherwise you&#8217;ll end up with errors from <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;or <span
+class="cmtt-10">xindy</span><a
+ id="dx1-3022"></a>. With
+<a
+href="#option2">Option&#x00A0;2</a> (<span
+class="cmtt-10">makeindex</span><a
+ id="dx1-3023"></a>) it&#8217;s not quite so important but you may find the resulting
+order is a little odd. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-34">
+\newglossaryentry{emptyset}
+&#x00A0;<br />{
+&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;<br />&#x00A0;&#x00A0;sort={empty&#x00A0;set},
+&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+&#x00A0;<br />}
+</div>
+<!--l. 778--><p class="nopar" > This displays the symbol as <span
+class="cmsy-10">&#x2205; </span>but sorts according to &#8220;empty set&#8221;. You
+may want to consider using <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-3024"></a>&#8217;s <span
+class="cmss-10">symbols</span><a
+ id="dx1-3025"></a> package option which
+provides
+</p><!--l. 784--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\glsxtrnewsymbol[</span>&#x27E8;<span
+class="cmitt-10">options</span>&#x27E9;<span
+class="cmtt-10">]{</span>&#x27E8;<span
+class="cmitt-10">label</span>&#x27E9;<span
+class="cmtt-10">}{</span>&#x27E8;<span
+class="cmitt-10">symbol</span>&#x27E9;<span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 785--><p class="noindent" >
+This internally uses <span
+class="cmtt-10">\newglossaryentry </span>but automatically sets the <span
+class="cmtt-10">sort </span>key to the
+&#x27E8;<span
+class="cmti-10">label</span>&#x27E9;. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-35">
+\documentclass{article}
+&#x00A0;<br />\usepackage[symbols]{glossaries-extra}
+&#x00A0;<br />\makeglossaries
+&#x00A0;<br />\glsxtrnewsymbol&#x00A0;%&#x00A0;requires&#x00A0;glossaries-extra.sty&#x00A0;'symbols'&#x00A0;option
+&#x00A0;<br />&#x00A0;[description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}]
+&#x00A0;<br />&#x00A0;{emptyset}%&#x00A0;label&#x00A0;(and&#x00A0;sort&#x00A0;value)
+&#x00A0;<br />&#x00A0;{\ensuremath{\emptyset}}%&#x00A0;symbol
+&#x00A0;<br />\begin{document}
+&#x00A0;<br />\gls{emptyset}
+&#x00A0;<br />\printglossaries
+&#x00A0;<br />\end{document}
+</div>
+<!--l. 805--><p class="nopar" > Now the sort value is &#8220;emptyset&#8221; rather than the previous &#8220;empty set&#8221;.
+</p><!--l. 809--><p class="indent" > With <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3026"></a> you can define this in the <span
+class="cmtt-10">.bib </span>file as
+
+
+
</p>
-<!--l. 455--><p class="noindent" ><a
+ <div class="verbatim" id="verbatim-36">
+@entry{emptyset,
+&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+&#x00A0;<br />}
+</div>
+<!--l. 816--><p class="nopar" > in which case <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3027"></a> will try to interpret the <span
+class="cmtt-10">name </span>field to determine the sort
+value. Alternatively you can use:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-37">
+@symbol{emptyset,
+&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+&#x00A0;<br />}
+</div>
+<!--l. 824--><p class="nopar" > which will use the label (<span
+class="cmtt-10">emptyset</span>) as the sort value. (You don&#8217;t need the <span
+class="cmss-10">symbols</span><a
+ id="dx1-3028"></a>
+package option in this case, unless you want a separate symbols list.) The
+corresponding document (where the definition is in the file <span
+class="cmtt-10">entries.bib</span>) is
+now:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-38">
+\documentclass{article}
+&#x00A0;<br />\usepackage[record]{glossaries-extra}
+&#x00A0;<br />\GlsXtrLoadResources[src=entries]
+&#x00A0;<br />\begin{document}
+&#x00A0;<br />\gls{emptyset}
+&#x00A0;<br />\printunsrtglossaries
+&#x00A0;<br />\end{document}
+</div>
+<!--l. 841--><p class="nopar" >
+</p><!--l. 843--><p class="noindent" >
+</p>
+<!--l. 843--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a
id="sec:useterm"></a>Using Entries</h3>
-<!--l. 458--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in
+<!--l. 846--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in
your document. There are a&#x00A0;number of commands to do this, but the most common
one is:
-</p><!--l. 462--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 850--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\gls{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 463--><p class="noindent" >
+</p><!--l. 851--><p class="noindent" >
where &#x27E8;<span
class="cmti-10">label</span>&#x27E9; is the label you assigned to the entry when you defined it. For example,
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{fishage}</span></span></span> will display &#8220;Fish Age&#8221; in the text (given the definition from the
-previous section).
-</p><!--l. 468--><p class="indent" > If you are using the <span
+previous section). If you are using <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-4001"></a> then this will display ?? (like
+<span
+class="cmtt-10">\ref </span>and <span
+class="cmtt-10">\cite</span>) until <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-4002"></a> has created the relevant files and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;is
+rerun.
+</p><!--l. 859--><p class="indent" > If you are using the <span
class="cmss-10">hyperref</span><a
- id="dx1-4001"></a> package (remember to load it before <span
+ id="dx1-4003"></a> package (remember to load it before <span
class="cmss-10">glossaries</span>) <span
class="cmtt-10">\gls</span>
will create a hyperlink to the corresponding entry in the glossary. If you want to
@@ -895,84 +1648,306 @@ class="cmtt-10">\gls* </span>for
example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls*{fishage}</span></span></span>. The other commands described in this section all have a
similar starred form.
-</p><!--l. 475--><p class="indent" > If the entry was defined as an acronym (using <span
-class="cmtt-10">\newacronym </span>described above),
+</p><!--l. 866--><p class="indent" > If the entry was defined as an acronym (using <span
+class="cmtt-10">\newacronym </span>with <span
+class="cmss-10">glossaries</span>
+described above) or an abbreviation (using <span
+class="cmtt-10">\newabbreviation </span>with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-4004"></a>),
then <span
class="cmtt-10">\gls </span>will display the full form the first time it&#8217;s used and just the
-short form on subsequent use. For example, if the acronym style is set to
-<span
-class="cmtt-10">long-short</span>, then <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\gls{svm}</span></span></span> will display &#8220;support vector machine (svm)&#8221; the
-first time it&#8217;s used, but the next occurrence of <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\gls{svm}</span></span></span> will just display
-&#8220;svm&#8221;.
-</p><!--l. 483--><p class="indent" > If you want the plural form, you can use:
-</p><!--l. 485--><p class="indent" > <hr><div title="Definition"><span
+short form on subsequent use. For example, if the style is set to <span
+class="cmtt-10">long-short</span>,
+then <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{svm}</span></span></span> will display &#8220;support vector machine (SVM)&#8221; the first time
+it&#8217;s used, but the next occurrence of <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{svm}</span></span></span> will just display &#8220;SVM&#8221;.
+(If you use <span
+class="cmtt-10">\newacronym </span>with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-4005"></a> the default doesn&#8217;t show the
+long form on first use. You&#8217;ll need to change the style first, as described
+earlier.)
+
+
+
+</p><!--l. 878--><p class="indent" > If you want the plural form, you can use:
+</p><!--l. 880--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glspl{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 486--><p class="noindent" >
+</p><!--l. 881--><p class="noindent" >
instead of <span
class="cmtt-10">\gls{</span>&#x27E8;<span
class="cmti-10">label</span>&#x27E9;<span
class="cmtt-10">}</span>. For example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\glspl{set}</span></span></span> displays &#8220;sets&#8221;.
-</p><!--l. 490--><p class="indent" > If the term appears at the start of a&#x00A0;sentence, you can convert the first letter to
+</p><!--l. 885--><p class="indent" > If the term appears at the start of a&#x00A0;sentence, you can convert the first letter to
upper case using:
-</p><!--l. 493--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 888--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Gls{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 494--><p class="noindent" >
+</p><!--l. 889--><p class="noindent" >
for the singular form or
-
-
-
-</p><!--l. 497--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 892--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Glspl{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 498--><p class="noindent" >
+</p><!--l. 893--><p class="noindent" >
for the plural form. For example:
</p>
- <div class="verbatim" id="verbatim-19">
+ <div class="verbatim" id="verbatim-39">
\Glspl{set}&#x00A0;are&#x00A0;collections.
</div>
-<!--l. 502--><p class="nopar" > produces &#8220;Sets are collections&#8221;.
-</p><!--l. 505--><p class="indent" > If you&#8217;ve specified a symbol using the <span
+<!--l. 897--><p class="nopar" > produces &#8220;Sets are collections&#8221;.
+</p><!--l. 900--><p class="indent" > If you&#8217;ve specified a symbol using the <span
class="cmtt-10">symbol </span>key, you can display it
using:
-</p><!--l. 508--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 903--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glssymbol{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 509--><p class="noindent" >
-</p><!--l. 511--><p class="noindent" >
+</p><!--l. 904--><p class="noindent" >
+</p><!--l. 906--><p class="noindent" >
</p>
-<!--l. 511--><p class="noindent" ><a
+<!--l. 906--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a
id="sec:printglossaries"></a>Displaying a List of Entries</h3>
-<!--l. 514--><p class="noindent" >In <a
+<!--l. 909--><p class="noindent" >In <a
href="#sec:start"><span
class="cmsy-10">&sect;</span>1 </a><a
-href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a> I mentioned that there are three options you can choose from
-to create your glossary. Here they are again in a little more detail:
-</p><!--l. 518--><p class="indent" >
- </p><dl class="description"><dt class="description">
+href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a>, I mentioned that there are three options you can choose from
+to create an automatically sorted glossary with the base <span
+class="cmss-10">glossaries </span>package. These are
+also available with the extension package <span
+class="cmss-10">glossaries-extra </span>along with a fourth option.
+These four options are listed below in a little more detail. <a
+href="#x1-50011">Table&#x00A0;1</a> summarises the
+main advantages and disadvantages. (There&#8217;s a more detailed summary in the main
+<span
+class="cmss-10">glossaries </span>user manual.)
+</p>
+ <div class="table">
+
+
+
+<!--l. 918--><p class="indent" > <a
+ id="x1-50011"></a></p><hr class="float" /><div class="float"
+>
+
+
+
+ <div class="caption"
+><span class="id">Table&#x00A0;1: </span><span
+class="content">Comparison of Glossary Options</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" /></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. 924--><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">&#x00A0;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">&#x00A0;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">&#x00A0;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">&#x00A0;4</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. 926--><p class="noindent" >Requires
+ <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-5002"></a>? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
+class="td11"> <span id="textcolor1"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
+class="td11"> <span id="textcolor2"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4"
+class="td11"> <span id="textcolor3"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-5"
+class="td11"> <span id="textcolor4"><span
+class="pzdr-">&#x2714;</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="td11"> <!--l. 928--><p class="noindent" >Requires
+ an
+ external
+ application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
+class="td11"> <span id="textcolor5"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
+class="td11"> <span id="textcolor6"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4"
+class="td11"> <span id="textcolor7"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-5"
+class="td11"> <span id="textcolor8"><span
+class="pzdr-">&#x2714;</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="td11"> <!--l. 930--><p class="noindent" >Requires
+ Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
+class="td11"> <span id="textcolor9"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
+class="td11"> <span id="textcolor10"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4"
+class="td11"> <span id="textcolor11"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-5"
+class="td11"> <span id="textcolor12"><span
+class="pzdr-">&#x2718;</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="td11"> <!--l. 932--><p class="noindent" >Requires
+ Java? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
+class="td11"> <span id="textcolor13"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
+class="td11"> <span id="textcolor14"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4"
+class="td11"> <span id="textcolor15"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-5"
+class="td11"> <span id="textcolor16"><span
+class="pzdr-">&#x2714;</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="td11"> <!--l. 934--><p class="noindent" >Can
+ sort
+ extended
+ Latin
+ or
+ non-Latin
+ alphabets? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
+class="td11"> <span id="textcolor17"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
+class="td11"> <span id="textcolor18"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
+class="td11"> <span id="textcolor19"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-5"
+class="td11"> <span id="textcolor20"><span
+class="pzdr-">&#x2714;</span></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. 937--><p class="noindent" >Efficient
+ sort
+ algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
+class="td11"> <span id="textcolor21"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
+class="td11"> <span id="textcolor22"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4"
+class="td11"> <span id="textcolor23"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-5"
+class="td11"> <span id="textcolor24"><span
+class="pzdr-">&#x2714;</span></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. 939--><p class="noindent" >Can
+ use
+ different
+ sort
+ methods
+ for
+ each
+ glossary? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2"
+class="td11"> <span id="textcolor25"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3"
+class="td11"> <span id="textcolor26"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-4"
+class="td11"> <span id="textcolor27"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-5"
+class="td11"> <span id="textcolor28"><span
+class="pzdr-">&#x2714;</span></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. 941--><p class="noindent" >Any
+ problematic
+ sort
+ values? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2"
+class="td11"> <span id="textcolor29"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-3"
+class="td11"> <span id="textcolor30"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-4"
+class="td11"> <span id="textcolor31"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-5"
+class="td11"> <span id="textcolor32"><span
+class="pzdr-">&#x2718;</span></span> </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. 943--><p class="noindent" >Can
+ form
+ ranges
+ in
+ the
+ location
+ lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2"
+class="td11"> <span id="textcolor33"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-3"
+class="td11"> <span id="textcolor34"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-4"
+class="td11"> <span id="textcolor35"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-5"
+class="td11"> <span id="textcolor36"><span
+class="pzdr-">&#x2714;</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="td11"> <!--l. 945--><p class="noindent" >Can
+ have
+ non-standard
+ locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2"
+class="td11"> <span id="textcolor37"><span
+class="pzdr-">&#x2714;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-3"
+class="td11"> <span id="textcolor38"><span
+class="pzdr-">&#x2718;</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-4"
+class="td11"> <span id="textcolor39"><span
+class="pzdr-">&#x2714;</span></span><sup class="textsuperscript"><span
+class="cmsy-9">&#8224;</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-5"
+class="td11"> <span id="textcolor40"><span
+class="pzdr-">&#x2714;</span></span> </td>
+</tr></table></div>
+<!--l. 948--><p class="noindent" ><sup class="textsuperscript"><span
+class="cmsy-9">&#8224;</span></sup> <span
+class="cmr-8">Requires some setting up.</span>
+
+
+
+</p>
+ </div><hr class="endfloat" />
+ </div>
+ <dl class="description"><dt class="description">
</dt><dd
class="description"><a
id="option1"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;1</span>:
- <!--l. 521--><p class="noindent" >This is the simplest option but it&#8217;s slow and if you want a sorted list, it
- doesn&#8217;t work for non-Latin alphabets.
- </p><!--l. 524--><p class="noindent" >
+ <!--l. 955--><p class="noindent" >This is the simplest option but it&#8217;s slow and if you want a sorted
+ list, it doesn&#8217;t work for non-Latin alphabets. The <span
+class="cmtt-10">name </span>mustn&#8217;t contain
+ commands (or, if it does, the <span
+class="cmtt-10">sort </span>value must be supplied) unless you
+ have the package option <span
+class="cmss-10">sanitizesort</span><a
+ id="dx1-5003"></a> or <span
+class="cmss-10">sort=def</span><a
+ id="dx1-5004"></a> or <span
+class="cmss-10">sort=use</span><a
+ id="dx1-5005"></a>.
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5002x1">Add <span
+ class="enumerate" id="x1-5007x1">Add <span
class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start
defining your entries, as described in <a
href="#sec:defterm"><span
@@ -980,14 +1955,14 @@ class="cmsy-10">&sect;</span>2 </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>).
</li>
<li
- class="enumerate" id="x1-5004x2">Put
- <!--l. 531--><p class="noindent" ><hr><div title="Definition"><span
+ class="enumerate" id="x1-5009x2">Put
+ <!--l. 969--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[sort=</span>&#x27E8;<span
class="cmitt-10">order</span>&#x27E9;<span
class="cmtt-10">,</span>&#x27E8;<span
class="cmitt-10">other options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 532--><p class="noindent" >
+ </p><!--l. 970--><p class="noindent" >
where you want your list of entries to appear. The sort &#x27E8;<span
class="cmti-10">order</span>&#x27E9; may be one
of: <span
@@ -998,84 +1973,140 @@ class="cmtt-10">case </span>(case-sensitive
class="cmtt-10">def </span>(in order of definition) or <span
class="cmtt-10">use </span>(in order of use).
Alternatively, use
- </p><!--l. 539--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 977--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
- </p><!--l. 540--><p class="noindent" >
+ </p><!--l. 978--><p class="noindent" >
to display all your glossaries (if you have more than one). This command
doesn&#8217;t have any arguments.
+ </p><!--l. 982--><p class="noindent" >This option allows you to have different sort methods. For example:
+</p>
+ <div class="verbatim" id="verbatim-40">
+ \printnoidxglossary[sort=word]%&#x00A0;main&#x00A0;glossary
+ &#x00A0;<br />\printnoidxglossary[type=symbols,sort=use]%&#x00A0;symbols&#x00A0;glossary
+</div>
+ <!--l. 987--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5006x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ class="enumerate" id="x1-5011x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;twice on your document. (As you would do to make a&#x00A0;table
of contents appear.) For example, click twice on the &#8220;typeset&#8221; or &#8220;build&#8221;
or &#8220;PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#8221; button in your editor.</li></ol>
- </dd><dt class="description">
+ <!--l. 993--><p class="noindent" >Here&#8217;s a complete document (<span
+class="cmtt-10">myDoc.tex</span>):
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-41">
+ \documentclass{article}
+ &#x00A0;<br />\usepackage{glossaries}
+ &#x00A0;<br />\makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
+ &#x00A0;<br />\newglossaryentry{sample}{name={sample},
+ &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
+ &#x00A0;<br />\begin{document}
+ &#x00A0;<br />A&#x00A0;\gls{sample}.
+ &#x00A0;<br />\printnoidxglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;indexed&#x00A0;entries
+ &#x00A0;<br />\end{document}
+</div>
+ <!--l. 1009--><p class="nopar" > Document build:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-42">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1014--><p class="nopar" >
+ </p></dd><dt class="description">
</dt><dd
class="description"><a
id="option2"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span>:
- <!--l. 551--><p class="noindent" >This option uses an application called <span
-class="cmtt-10">makeindex </span>to sort the entries.
- This application comes with all modern <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;distributions, but it&#8217;s
- hard-coded for the non-extended Latin alphabet. 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>&#x00A0;write the glossary information to a temporary file which
- <span
-class="cmtt-10">makeindex </span>reads. Then <span
-class="cmtt-10">makeindex </span>writes a&#x00A0;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>&#x00A0;then reads this file on the next
- run.
- </p><!--l. 559--><p class="noindent" >
+ <!--l. 1018--><p class="noindent" >This option uses an application called <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-5012"></a> to sort the entries. This
+ application comes with all modern <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;distributions, but it&#8217;s hard-coded for
+ the non-extended Latin alphabet. 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>&#x00A0;write
+ the glossary information to a temporary file which <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-5013"></a> reads.
+ Then <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-5014"></a> writes a&#x00A0;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>&#x00A0;then reads this file on the next run. The <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-5015"></a>
+ application is automatically invoked by the helper <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5016"></a>
+ script, which works out all the appropriate settings from the <span
+class="cmtt-10">.aux</span>
+ file.
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5008x1">If you are using <span
+ class="enumerate" id="x1-5018x1">If you are using <span
class="cmss-10">ngerman</span><a
- id="dx1-5009"></a> or some other package that makes the
- double-quote character <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">"</span></span></span> a shorthand, then use <span
-class="cmtt-10">\GlsSetQuote </span>to change
- this to some other character. For example:
+ id="dx1-5019"></a><span class="footnote-mark"><a
+href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a
+ id="x1-5020f1"></a>
+ or some other package that makes the double-quote character <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">"</span></span></span> a
+ shorthand, then use <span
+class="cmtt-10">\GlsSetQuote </span>to change this to some other character.
+ For example:
- <div class="verbatim" id="verbatim-20">
+ <div class="verbatim" id="verbatim-43">
\GlsSetQuote{+}
</div>
- <!--l. 566--><p class="nopar" > Use this as soon as possible after you&#8217;ve loaded the <span
+ <!--l. 1037--><p class="nopar" > Use this as soon as possible after you&#8217;ve loaded the <span
class="cmss-10">glossaries</span>
package.
</p></li>
<li
- class="enumerate" id="x1-5011x2">Add <span
+ class="enumerate" id="x1-5023x2">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
</li>
<li
- class="enumerate" id="x1-5013x3">Put
- <!--l. 575--><p class="noindent" ><hr><div title="Definition"><span
+ class="enumerate" id="x1-5025x3">Put
+ <!--l. 1046--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>&#x27E8;<span
class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 576--><p class="noindent" >
+ </p><!--l. 1047--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key
isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
- </p><!--l. 581--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1052--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 582--><p class="noindent" >
+ </p><!--l. 1053--><p class="noindent" >
which will display all glossaries (if you have more than one). This
command doesn&#8217;t have any arguments.
+ </p><!--l. 1057--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified
+ with one of the package options: <span
+class="cmss-10">sort=standard</span><a
+ id="dx1-5026"></a> (default), <span
+class="cmss-10">sort=use</span><a
+ id="dx1-5027"></a> or
+ <span
+class="cmss-10">sort=def</span><a
+ id="dx1-5028"></a>. </div>
+ </p><!--l. 1062--><p class="noindent" >
</p></li>
<li
- class="enumerate" id="x1-5015x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ class="enumerate" id="x1-5030x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions
<span
class="cmtt-10">.glo </span>and <span
@@ -1089,111 +2120,206 @@ class="cmtt-10">myDoc.ist</span>). If you look at your document at this point, y
glossary as it hasn&#8217;t been created yet.
</li>
<li
- class="enumerate" id="x1-5017x5">Run <span
-class="cmtt-10">makeindex </span>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
+ class="enumerate" id="x1-5032x5">Run <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5033"></a> with the base name of your document (without the
<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
+class="cmtt-10">.tex</span>) extension. If you have access to a terminal or a command prompt
+ (for example, the MSDOS command prompt for Windows users or
the bash console for Unix-like users) then you need to run the
command:
- <div class="verbatim" id="verbatim-21">
- makeindex&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
+ <div class="verbatim" id="verbatim-44">
+ makeglossaries&#x00A0;myDoc
</div>
- <!--l. 601--><p class="nopar" > (Replace <span
+ <!--l. 1078--><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>&#x00A0;document file. Avoid
- spaces in the file name.) If you don&#8217;t know how to use the command
- prompt, then you can probably access <span
-class="cmtt-10">makeindex </span>via your text editor,
- but each editor has a different method of doing this, so I&#x00A0;can&#8217;t
- give a&#x00A0;general description. You will have to check your editor&#8217;s
- manual.
- </p><!--l. 609--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
+class="E">E</span>X</span></span>&#x00A0;document file
+ without the <span
+class="cmtt-10">.tex </span>extension. Avoid spaces in the file name.) If you don&#8217;t
+ have Perl installed use <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-5034"></a> instead:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-45">
+ makeglossaries-lite&#x00A0;myDoc
+</div>
+ <!--l. 1085--><p class="nopar" >
+ </p><!--l. 1087--><p class="noindent" ><div class="important" title="Important Note"> Some beginners get confused by <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5035"></a> the application (run as
+ a system command) and <span
+class="cmtt-10">\makeglossaries </span>the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;command
+ which should be typed in the document preamble. These are two
+ different concepts that happen to have similar looking names.
+ </div>
+ </p><!--l. 1093--><p class="noindent" >
+ </p><!--l. 1095--><p class="noindent" >If you don&#8217;t know how to use the command prompt, then you can
+ probably configure your text editor to add <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5036"></a> (or
+ <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-5037"></a>) as a build tool, but each editor has a different
+ method of doing this, so I&#x00A0;can&#8217;t give a&#x00A0;general description. You will have
+ to check your editor&#8217;s manual. If you still have problems, try adding the
+ <span
+class="cmss-10">automake</span><a
+ id="dx1-5038"></a> package option:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-46">
+ \usepackage[automake]{glossaries}
+</div>
+ <!--l. 1105--><p class="nopar" >
+ </p><!--l. 1107--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
want letter ordering you need to add the <span
-class="cmtt-10">-l </span>switch:
+class="cmss-10">order=letter</span><a
+ id="dx1-5039"></a> package
+ option
</p>
- <div class="verbatim" id="verbatim-22">
- makeindex&#x00A0;-l&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
+ <div class="verbatim" id="verbatim-47">
+ \usepackage[order=letter]{glossaries}
</div>
- <!--l. 615--><p class="nopar" >
+ <!--l. 1112--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5019x6">Once you have successfully completed the previous step, you can now run
+ class="enumerate" id="x1-5041x6">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>&#x00A0;on your document again.</li></ol>
- </dd><dt class="description">
+ <!--l. 1117--><p class="noindent" >Here&#8217;s a complete document (<span
+class="cmtt-10">myDoc.tex</span>):
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-48">
+ \documentclass{article}
+ &#x00A0;<br />\usepackage{glossaries}
+ &#x00A0;<br />\makeglossaries&#x00A0;%&#x00A0;create&#x00A0;makeindex&#x00A0;files
+ &#x00A0;<br />\newglossaryentry{sample}{name={sample},
+ &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
+ &#x00A0;<br />\begin{document}
+ &#x00A0;<br />A&#x00A0;\gls{sample}.
+ &#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;makeindex
+ &#x00A0;<br />\end{document}
+</div>
+ <!--l. 1133--><p class="nopar" > Document build:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-49">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />makeglossaries&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1139--><p class="nopar" > or
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-50">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />makeglossaries-lite&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1145--><p class="nopar" >
+ </p></dd><dt class="description">
</dt><dd
class="description"><a
id="option3"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span>:
- <!--l. 623--><p class="noindent" >This option uses an application called <span
-class="cmtt-10">xindy </span>to sort the entries. This
+ <!--l. 1150--><p class="noindent" >This option uses an application called <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5042"></a> to sort the entries. This
application is more flexible than <span
-class="cmtt-10">makeindex </span>and is able to sort extended Latin
- or non-Latin alphabets. It comes with <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;Live but not with MiK<span class="TEX">T<span
-class="E">E</span>X</span>. Since
- <span
-class="cmtt-10">xindy </span>is a Perl script, if you are using MiK<span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;you will not only need to
- install <span
-class="cmtt-10">xindy</span>, you will also need to install Perl. In a&#x00A0;similar way to <a
-href="#option2">Option&#x00A0;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>&#x00A0;write the glossary information to
- a&#x00A0;temporary file which <span
-class="cmtt-10">xindy </span>reads. Then <span
-class="cmtt-10">xindy </span>writes a&#x00A0;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>&#x00A0;then reads this file on the next
- run.
- </p><!--l. 635--><p class="noindent" >
+class="cmtt-10">makeindex</span><a
+ id="dx1-5043"></a> and is able to sort extended Latin
+ or non-Latin alphabets. It comes with both <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;Live and MiK<span class="TEX">T<span
+class="E">E</span>X</span>.
+ Since <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5044"></a> is a Perl script, you will also need to ensure that Perl is
+ installed. In a&#x00A0;similar way to <a
+href="#option2">Option&#x00A0;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>&#x00A0;write the glossary information to a&#x00A0;temporary file which <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5045"></a>
+ reads. Then <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5046"></a> writes a&#x00A0;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>&#x00A0;then reads this file on the next run. The <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5047"></a>
+ application is automatically invoked by the helper <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5048"></a>
+ script, which works out all the appropriate settings from the <span
+class="cmtt-10">.aux</span>
+ file.
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5021x1">Add the <span
-class="cmtt-10">xindy </span>option to the <span
+ class="enumerate" id="x1-5050x1">Add the <span
+class="cmss-10">xindy</span><a
+ id="dx1-5051"></a> option to the <span
class="cmss-10">glossaries</span><a
- id="dx1-5022"></a> package option list:
+ id="dx1-5052"></a> package option list:
- <div class="verbatim" id="verbatim-23">
+ <div class="verbatim" id="verbatim-51">
\usepackage[xindy]{glossaries}
</div>
- <!--l. 640--><p class="nopar" >
+ <!--l. 1169--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5024x2">Add <span
+ class="enumerate" id="x1-5054x2">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
</li>
<li
- class="enumerate" id="x1-5026x3">Put
- <!--l. 647--><p class="noindent" ><hr><div title="Definition"><span
+ class="enumerate" id="x1-5056x3">Put
+ <!--l. 1176--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>&#x27E8;<span
class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 648--><p class="noindent" >
+ </p><!--l. 1177--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key
isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
- </p><!--l. 653--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1182--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 654--><p class="noindent" >
+ </p><!--l. 1183--><p class="noindent" >
+ </p><!--l. 1185--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified
+ with one of the package options: <span
+class="cmss-10">sort=standard</span><a
+ id="dx1-5057"></a> (default), <span
+class="cmss-10">sort=use</span><a
+ id="dx1-5058"></a> or
+ <span
+class="cmss-10">sort=def</span><a
+ id="dx1-5059"></a>. </div>
+ </p><!--l. 1190--><p class="noindent" >
</p></li>
<li
- class="enumerate" id="x1-5028x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ class="enumerate" id="x1-5061x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions
<span
class="cmtt-10">.glo </span>and <span
@@ -1207,37 +2333,31 @@ class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, y
glossary as it hasn&#8217;t been created yet.
</li>
<li
- class="enumerate" id="x1-5030x5">Run <span
-class="cmtt-10">xindy </span>with the <span
-class="cmtt-10">.glo </span>file as the input file and the <span
-class="cmtt-10">.xdy </span>file as
- a&#x00A0;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="enumerate" id="x1-5063x5">Run <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5064"></a> with the base name of the document (omitting the
+ <span
+class="cmtt-10">.tex </span>extension). If you have access to a terminal or a command prompt
+ (for example, the MSDOS command prompt for Windows users or
+ the bash console for Unix-like users) then you need to run the
+ command:
- <div class="verbatim" id="verbatim-24">
- xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc
- &#x00A0;<br />-t&#x00A0;myDoc.glg&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
+ <div class="verbatim" id="verbatim-52">
+ makeglossaries&#x00A0;myDoc
</div>
- <!--l. 674--><p class="nopar" > (Replace <span
+ <!--l. 1206--><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>&#x00A0;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.) If you don&#8217;t know
- how to use the command prompt, then you can probably access <span
-class="cmtt-10">xindy </span>via
- your text editor, but each editor has a different method of doing this, so
- I&#x00A0;can&#8217;t give a&#x00A0;general description. You will have to check your editor&#8217;s
- manual.
- </p><!--l. 684--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
+class="E">E</span>X</span></span>&#x00A0;document file
+ without the <span
+class="cmtt-10">.tex </span>extension. Avoid spaces in the file name. If you don&#8217;t
+ know how to use the command prompt, then as mentioned above, you may
+ be able to configure your text editor to add <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5065"></a> as a build
+ tool.
+ </p><!--l. 1214--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
want letter ordering you need to add the <span
class="cmtt-10">order=letter </span>package
option:
@@ -1245,114 +2365,304 @@ class="cmtt-10">order=letter </span>package
</p>
- <div class="verbatim" id="verbatim-25">
+ <div class="verbatim" id="verbatim-53">
\usepackage[xindy,order=letter]{glossaries}
</div>
- <!--l. 690--><p class="nopar" >
+ <!--l. 1220--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5032x6">Once you have successfully completed the previous step, you can now run
+ class="enumerate" id="x1-5067x6">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>&#x00A0;on your document again.
</li></ol>
- </dd></dl>
-<!--l. 699--><p class="indent" > For Options&#x00A0;<a
+ <!--l. 1226--><p class="noindent" >Here&#8217;s a complete document (<span
+class="cmtt-10">myDoc.tex</span>):
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-54">
+ \documentclass{article}
+ &#x00A0;<br />\usepackage[xindy]{glossaries}
+ &#x00A0;<br />\makeglossaries&#x00A0;%&#x00A0;create&#x00A0;xindy&#x00A0;files
+ &#x00A0;<br />\newglossaryentry{sample}{name={sample},
+ &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
+ &#x00A0;<br />\begin{document}
+ &#x00A0;<br />A&#x00A0;\gls{sample}.
+ &#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;xindy
+ &#x00A0;<br />\end{document}
+</div>
+ <!--l. 1242--><p class="nopar" > Document build:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-55">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />makeglossaries&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1248--><p class="nopar" >
+ </p></dd><dt class="description">
+ </dt><dd
+class="description"><a
+ id="option4"></a><span
+class="cmbx-10">Option</span><span
+class="cmbx-10">&#x00A0;4</span>:
+ <!--l. 1252--><p class="noindent" >This requires the extension package <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-5068"></a> and an application called
+ <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5069"></a>. This application is able to sort extended Latin or non-Latin
+ alphabets. It comes with both <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;Live and MiK<span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;but requires at least
+ Java&#x00A0;7. This method works differently to Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
-href="#option3">3</a>, it can be difficult to remember all the parameters required
-for <span
-class="cmtt-10">makeindex </span>or <span
-class="cmtt-10">xindy</span>, so the <span
-class="cmss-10">glossaries</span><a
- id="dx1-5033"></a> package provides a&#x00A0;script called
-<span
-class="cmtt-10">makeglossaries </span>that reads the <span
-class="cmtt-10">.aux </span>file to determine what settings you have used
-and will then run <span
-class="cmtt-10">makeindex </span>or <span
-class="cmtt-10">xindy</span>. Again, this is a&#x00A0;command line application
-and can be run in a&#x00A0;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>&#x00A0;document is in the file <span
-class="cmtt-10">myDoc.tex</span>, then run:
+href="#option3">3</a>. Instead of
+ creating a file containing the code to typeset the glossary it creates a
+ <span
+class="cmtt-10">.glstex </span>file containing the entry definitions fetched from the <span
+class="cmtt-10">.bib </span>file (or
+ files), but only those entries that are required in the document are
+ defined and they are defined in the order obtained from the chosen sort
+ method. This means that you can just use <span
+class="cmtt-10">\printunsrtglossary </span>to
+ display each glossary (or <span
+class="cmtt-10">\printunsrtglossaries </span>to display them
+ all).
+ </p><ol class="enumerate1" >
+ <li
+ class="enumerate" id="x1-5071x1">Add the <span
+class="cmss-10">record</span><a
+ id="dx1-5072"></a> option to the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-5073"></a> package option list:
+
+
+
+ <div class="verbatim" id="verbatim-56">
+ \usepackage[record]{glossaries-extra}
+</div>
+ <!--l. 1271--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-5075x2">Add one or more
+ <!--l. 1275--><p class="noindent" ><hr><div title="Definition"><span
+class="cmtt-10">\GlsXtrLoadResources[src={</span>&#x27E8;<span
+class="cmitt-10">bib list</span>&#x27E9;<span
+class="cmtt-10">},</span>&#x27E8;<span
+class="cmitt-10">options</span>&#x27E9;<span
+class="cmtt-10">] </span></div><hr>
+ </p><!--l. 1276--><p class="noindent" >
+ to your preamble where &#x27E8;<span
+class="cmti-10">bib list</span>&#x27E9; is the list of <span
+class="cmtt-10">.bib </span>files containing the
+ entries. You may use different sort methods for each resource set. For
+ example:
</p>
- <div class="verbatim" id="verbatim-26">
-makeglossaries&#x00A0;myDoc
+ <div class="verbatim" id="verbatim-57">
+ \usepackage[record,%&#x00A0;using&#x00A0;bib2gls
+ &#x00A0;<br />&#x00A0;abbreviations,
+ &#x00A0;<br />&#x00A0;symbols,
+ &#x00A0;<br />&#x00A0;numbers
+ &#x00A0;<br />]{glossaries-extra}
+ &#x00A0;<br />\GlsXtrLoadResources[
+ &#x00A0;<br />&#x00A0;&#x00A0;src={terms},%&#x00A0;entries&#x00A0;in&#x00A0;terms.bib
+ &#x00A0;<br />&#x00A0;&#x00A0;type=main,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'main'&#x00A0;(default)&#x00A0;list
+ &#x00A0;<br />&#x00A0;&#x00A0;sort={de-CH-1996}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
+ &#x00A0;<br />]
+ &#x00A0;<br />\GlsXtrLoadResources[
+ &#x00A0;<br />&#x00A0;&#x00A0;src={abbrvs},%&#x00A0;entries&#x00A0;in&#x00A0;abbrvs.bib
+ &#x00A0;<br />&#x00A0;&#x00A0;type=abbreviations,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'abbreviations'&#x00A0;list
+ &#x00A0;<br />&#x00A0;&#x00A0;sort={letter-case}%&#x00A0;case-sensitive&#x00A0;letter&#x00A0;(non-locale)&#x00A0;sort
+ &#x00A0;<br />]
+ &#x00A0;<br />\GlsXtrLoadResources[
+ &#x00A0;<br />&#x00A0;&#x00A0;src={syms},%&#x00A0;entries&#x00A0;in&#x00A0;syms.bib
+ &#x00A0;<br />&#x00A0;&#x00A0;type=symbols,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'symbols'&#x00A0;list
+ &#x00A0;<br />&#x00A0;&#x00A0;sort={use}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;first&#x00A0;use&#x00A0;in&#x00A0;the&#x00A0;document
+ &#x00A0;<br />]
+ &#x00A0;<br />\GlsXtrLoadResources[
+ &#x00A0;<br />&#x00A0;&#x00A0;src={constants},%&#x00A0;entries&#x00A0;in&#x00A0;constants.bib
+ &#x00A0;<br />&#x00A0;&#x00A0;type=numbers,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'numbers'&#x00A0;list
+ &#x00A0;<br />&#x00A0;&#x00A0;sort-field={user1},%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;field
+ &#x00A0;<br />&#x00A0;&#x00A0;sort={double}%&#x00A0;double-precision&#x00A0;sort
+ &#x00A0;<br />]
+</div>
+ <!--l. 1308--><p class="nopar" > The last resource set assumes that the entries defined in the file
+ <span
+class="cmtt-10">constants.bib </span>have a number stored in the <span
+class="cmtt-10">user1 </span>field. For
+ example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-58">
+ @number{pi,
+ &#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\pi}},
+ &#x00A0;<br />&#x00A0;&#x00A0;description={pi},
+ &#x00A0;<br />&#x00A0;&#x00A0;user1={3.141592654}
+ &#x00A0;<br />}
+</div>
+ <!--l. 1318--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-5077x3">Put
+ <!--l. 1322--><p class="noindent" ><hr><div title="Definition"><span
+class="cmtt-10">\printunsrtglossary[type={</span>&#x27E8;<span
+class="cmitt-10">type</span>&#x27E9;<span
+class="cmtt-10">},</span>&#x27E8;<span
+class="cmitt-10">options</span>&#x27E9;<span
+class="cmtt-10">] </span></div><hr>
+ </p><!--l. 1323--><p class="noindent" >
+ where you want your list of entries (glossary) to appear. (The <span
+class="cmtt-10">sort </span>key
+ isn&#8217;t available in &#x27E8;<span
+class="cmti-10">options</span>&#x27E9;. It needs to be used in <span
+class="cmtt-10">\GlsXtrLoadResources</span>
+ instead.) Alternatively, use
+ </p><!--l. 1329--><p class="noindent" ><hr><div title="Definition"><span
+class="cmtt-10">\printunsrtglossaries </span></div><hr>
+ </p><!--l. 1330--><p class="noindent" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-5079x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;on your document. The <span
+class="cmss-10">record</span><a
+ id="dx1-5080"></a> option adds information to
+ the <span
+class="cmtt-10">.aux </span>file that provides <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5081"></a> with all required details for each
+ resource set. For example, if the file is called <span
+class="cmtt-10">myDoc.tex</span>:
+
+
+
+ <div class="verbatim" id="verbatim-59">
+ pdflatex&#x00A0;myDoc
</div>
-<!--l. 710--><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>&#x00A0;document file. Avoid
-spaces in the file name.) If you don&#8217;t know how to use the command prompt,
-you can probably access <span
-class="cmtt-10">makeglossaries </span>via your text editor. Check your
-editor&#8217;s manual for advice. If you are using <span
-class="cmtt-10">arara </span>then you can just use the
-directives:
+ <!--l. 1338--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-5083x5">Run <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5084"></a>
+
+
+
+ <div class="verbatim" id="verbatim-60">
+ bib2gls&#x00A0;myDoc
+</div>
+ <!--l. 1343--><p class="nopar" > or (if you need letter groups)
</p>
- <div class="verbatim" id="verbatim-27">
-&#x00A0;arara:&#x00A0;pdflatex
-&#x00A0;<br />&#x00A0;arara:&#x00A0;makeglossaries
-&#x00A0;<br />&#x00A0;arara:&#x00A0;pdflatex
-</div>
-<!--l. 720--><p class="nopar" >
-</p><!--l. 722--><p class="indent" > The <span
-class="cmtt-10">makeglossaries </span>script is written in Perl, so you need a&#x00A0;Perl interpreter
-installed. If you are using a&#x00A0;Unix-like operating system then you most likely have one
-installed. If you are using Windows with the <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;Live distribution, then you can
-use the Perl interpreter that comes with <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;Live. If you are using Windows and
-MiK<span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;then you need to install a&#x00A0;Perl distribution for Windows. If you are using
-<a
-href="#option3">Option&#x00A0;3</a>, then you need to do this anyway as <span
-class="cmtt-10">xindy </span>is also written in Perl.
-If you are using <a
-href="#option2">Option&#x00A0;2</a> and can&#8217;t work out how to install Perl (or for
-some reason don&#8217;t want to install it) then just use <span
-class="cmtt-10">makeindex </span>directly, as
-described above, or you can use a&#x00A0;Lua alternative to <span
-class="cmtt-10">makeglossaries </span>called
-<span
-class="cmtt-10">makeglossaries-lite.lua</span>:
+ <div class="verbatim" id="verbatim-61">
+ bib2gls&#x00A0;--group&#x00A0;myDoc
+</div>
+ <!--l. 1347--><p class="nopar" >
+ </p></li>
+ <li
+ class="enumerate" id="x1-5086x6">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;again.</li></ol>
+ <!--l. 1351--><p class="noindent" >Here&#8217;s a complete document (<span
+class="cmtt-10">myDoc.tex</span>):
</p>
- <div class="verbatim" id="verbatim-28">
-makeglossaries-lite.lua&#x00A0;myDoc
+ <div class="verbatim" id="verbatim-62">
+ \documentclass{article}
+ &#x00A0;<br />\usepackage[record]{glossaries-extra}
+ &#x00A0;<br />\GlsXtrLoadResources&#x00A0;%&#x00A0;input&#x00A0;file&#x00A0;created&#x00A0;by&#x00A0;bib2gls
+ &#x00A0;<br />&#x00A0;[%&#x00A0;instructions&#x00A0;to&#x00A0;bib2gls:
+ &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;src={entries},&#x00A0;%&#x00A0;terms&#x00A0;defined&#x00A0;in&#x00A0;entries.bib
+ &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={en-GB}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
+ &#x00A0;<br />&#x00A0;]
+ &#x00A0;<br />\newglossaryentry{sample}{name={sample},
+ &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
+ &#x00A0;<br />\begin{document}
+ &#x00A0;<br />A&#x00A0;\gls{sample}.
+ &#x00A0;<br />\printunsrtglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;defined&#x00A0;entries
+ &#x00A0;<br />\end{document}
+</div>
+ <!--l. 1371--><p class="nopar" > The accompanying <span
+class="cmtt-10">entries.bib </span>file:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-63">
+ @entry{sample,
+ &#x00A0;<br />&#x00A0;&#x00A0;name&#x00A0;=&#x00A0;{sample},
+ &#x00A0;<br />&#x00A0;&#x00A0;description&#x00A0;=&#x00A0;{an&#x00A0;example}
+ &#x00A0;<br />}
</div>
-<!--l. 736--><p class="nopar" >
-</p><!--l. 738--><p class="indent" > As a last resort you can try the package option <span
-class="cmtt-10">automake</span>:
+ <!--l. 1378--><p class="nopar" > Document build:
</p>
- <div class="verbatim" id="verbatim-29">
-\usepackage[automake]{glossaries}
-</div>
-<!--l. 741--><p class="nopar" > This will attempt to use <span class="TEX">T<span
-class="E">E</span>X</span>&#8217;s <span
-class="cmtt-10">\write18 </span>mechanism to run <span
-class="cmtt-10">makeindex </span>or <span
-class="cmtt-10">xindy</span>. It
-probably won&#8217;t work for <span
-class="cmtt-10">xindy </span>and won&#8217;t work at all if the shell escape has been
-disabled in your <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;distribution. Most <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;distributions will allow a restricted
-shell escape, which will only allow trusted applications to be run. If the <span
-class="cmtt-10">automake</span>
-option is successful, you will still need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;twice for the glossaries to be
-displayed.
-</p><!--l. 751--><p class="indent" > When sorting the entries, the string comparisons are made according to each
+ <div class="verbatim" id="verbatim-64">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />bib2gls&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1384--><p class="nopar" >
+</p>
+ </dd></dl>
+<!--l. 1388--><p class="indent" > If you are having difficulty integrating <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5087"></a> into your document build
+process, you may want to consider using <span
+class="cmtt-10">arara</span><a
+ id="dx1-5088"></a>, which is a Java application that
+searches the document for special comment lines that tell <span
+class="cmtt-10">arara</span><a
+ id="dx1-5089"></a> which applications
+to run. For example, the file <span
+class="cmtt-10">myDoc.tex </span>might start with:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-65">
+&#x00A0;%&#x00A0;arara:&#x00A0;pdflatex
+&#x00A0;<br />&#x00A0;%&#x00A0;arara:&#x00A0;makeglossaries
+&#x00A0;<br />&#x00A0;%&#x00A0;arara:&#x00A0;pdflatex
+&#x00A0;<br />&#x00A0;\documentclass{article}
+&#x00A0;<br />&#x00A0;\usepackage{glossaries}
+&#x00A0;<br />&#x00A0;\makeglossaries
+</div>
+<!--l. 1401--><p class="nopar" > then to build the document you just need the single system call:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-66">
+&#x00A0;arara&#x00A0;myDoc
+</div>
+<!--l. 1405--><p class="nopar" > (The currently pending version 4.0 of <span
+class="cmtt-10">arara</span><a
+ id="dx1-5090"></a> has directives for <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-5091"></a>
+and <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5092"></a>. These aren&#8217;t available in earlier versions, but you could try copying
+and adapting the <span
+class="cmtt-10">makeglossaries.yaml </span>file and replace <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-5093"></a> as
+appropriate.)
+</p><!--l. 1412--><p class="indent" > When sorting the entries, the string comparisons are made according to each
entry&#8217;s <span
class="cmtt-10">sort </span>key. If this is omitted, the <span
class="cmtt-10">name </span>key is used. For example, recall the
@@ -1361,14 +2671,14 @@ earlier definition:
</p>
- <div class="verbatim" id="verbatim-30">
-\newglossaryentry{elite}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={{\'e}lite},
-&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
-&#x00A0;<br />}
-</div>
-<!--l. 761--><p class="nopar" > No <span
+ <div class="verbatim" id="verbatim-67">
+&#x00A0;\newglossaryentry{elite}
+&#x00A0;<br />&#x00A0;{
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={{\'e}lite},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
+&#x00A0;<br />&#x00A0;}
+</div>
+<!--l. 1422--><p class="nopar" > No <span
class="cmtt-10">sort </span>key was used, so it&#8217;s set to the same as the <span
class="cmtt-10">name </span>key: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{\&#8217;e}lite</span></span></span>. How this
@@ -1384,12 +2694,15 @@ class="description">By default, the accent command will be stripped so the sort
class="cmtt-10">elite</span>. This will put the entry in the &#8220;E&#8221; letter group. However
if you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-5034"></a> package option, the sort value will be
+ id="dx1-5094"></a> package option, the sort value will be
interpreted as the sequence of characters: <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">{</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span> <span
-class="cmtt-10">&#8217; e l i t </span>and <span
-class="cmtt-10">e</span>. This will place
- this entry before the &#8220;A&#8221; letter group since it starts with a symbol.
+class="cmtt-10">&#8217; e </span><span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">}</span></span></span> <span
+class="cmtt-10">l i t </span>and <span
+class="cmtt-10">e</span>. This will
+ place this entry in the &#8220;symbols&#8221; group since it starts with a symbol.
</dd><dt class="description">
<a
href="#option2"><span
@@ -1406,7 +2719,8 @@ class="cmtt-10">}</span></span></span><span
class="cmtt-10">lit </span>and <span
class="cmtt-10">e</span>. The first character is an opening curly brace <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> so <span
-class="cmtt-10">makeindex</span>
+class="cmtt-10">makeindex</span><a
+ id="dx1-5095"></a>
will put this entry in the &#8220;symbols&#8221; group.
</dd><dt class="description">
<a
@@ -1415,32 +2729,100 @@ class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
-class="cmtt-10">xindy </span>disregards <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="cmtt-10">xindy</span><a
+ id="dx1-5096"></a> disregards <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;commands so it sorts on <span
-class="cmtt-10">elite</span>, which
- puts this entry in the &#8220;E&#8221; group.</dd></dl>
-<!--l. 786--><p class="indent" > If the <span
+class="cmtt-10">elite</span>, which puts
+ this entry in the &#8220;E&#8221; group. If stripping all commands leads to an empty string
+ (such as <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\ensuremath{\emptyset}</span></span></span>) then <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5097"></a> will fail, so in these
+ situations you need to provide an appropriate <span
+class="cmtt-10">sort </span>value that <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5098"></a> will
+ accept.
+ <!--l. 1448--><p class="noindent" ><div class="important" title="Important Note"> <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5099"></a> merges entries with duplicate sort values. <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5100"></a> forbids empty sort
+ values. A sort value may degrade into an empty or duplicate value once <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5101"></a>
+ has stripped all commands and braces. </div>
+ </p><!--l. 1453--><p class="noindent" >
+ </p></dd><dt class="description">
+<a
+href="#option4"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10">&#x00A0;4</span></a><span
+class="cmbx-10">:</span> </dt><dd
+class="description"><span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5102"></a> has a primitive <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;parser that recognises a limited set of
+ commands, which includes the standard accent commands and some maths
+ commands, so it can convert <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">{\&#8217;e}lite</span></span></span> to <span
+class="cmtt-10">&eacute;</span><span
+class="cmtt-10">lite</span>. It disregards unknown
+ commands. This may lead to an empty sort value, but <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5103"></a> doesn&#8217;t mind
+ that.
+ <!--l. 1462--><p class="noindent" >Note that even if the name is given as <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">{\&#8217;e}lite</span></span></span>, the letter group heading
+ (if the <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">--group</span></span></span> switch is used) may end up with the character É
+ depending on the locale used by the sort comparator. In this case you
+
+
+
+ will need to ensure the document can support this character either
+ with <span
+class="cmss-10">inputenc</span><a
+ id="dx1-5104"></a> or by switching to a <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;engine with native UTF-8
+ support.
+</p>
+ </dd></dl>
+<!--l. 1472--><p class="indent" > If the <span
class="cmss-10">inputenc</span><a
- id="dx1-5035"></a> package is used and the entry is defined as: </p><div class="alltt">
+ id="dx1-5105"></a> package is used:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-68">
+&#x00A0;\usepackage[utf8]{inputenc}
+</div>
+<!--l. 1475--><p class="nopar" > and the entry is defined as: </p><div class="alltt">
<div class="obeylines-v">
-<span class="verb"><span
+<span
+class="cmtt-10">&#x00A0;</span><span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
-<br /><span class="verb"><span
+<br /><span
+class="cmtt-10">&#x00A0;</span><span class="verb"><span
class="cmtt-10">{</span></span>
<br /><span
class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;</span><span
class="cmtt-10">&#x00A0;name=</span><span class="verb"><span
class="cmtt-10">{{</span></span><span
class="cmtt-10">&eacute;</span><span class="verb"><span
class="cmtt-10">}lite},</span></span>
<br /><span
class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;</span><span
class="cmtt-10">&#x00A0;description=</span><span class="verb"><span
class="cmtt-10">{select</span><span
class="cmtt-10">&#x00A0;group</span><span
class="cmtt-10">&#x00A0;or</span><span
class="cmtt-10">&#x00A0;class}</span></span>
-<br /><span class="verb"><span
+<br /><span
+class="cmtt-10">&#x00A0;</span><span class="verb"><span
class="cmtt-10">}</span></span>
</div>
</div> then:
@@ -1454,15 +2836,13 @@ class="description">By default the sort value will be interpreted as <span
class="cmtt-10">elite </span>so the entry
will be put in the &#8220;E&#8221; letter group. If you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-5036"></a> package
+ id="dx1-5106"></a> package
option, the sort value will be interpreted as <span
class="cmtt-10">&eacute;</span><span
class="cmtt-10">lite </span>where &eacute; has been
- sanitized (so it&#8217;s no longer an active character) which will put this entry
- before the &#8220;A&#8221; letter group.
-
-
-
+ sanitized (so it&#8217;s no longer an active character and is in fact seen as two
+ octets 0xC3 0xA9) which will put this entry before the &#8220;A&#8221; letter group.
+ (The group is determined by the first octet 0xC3.)
</dd><dt class="description">
<a
href="#option2"><span
@@ -1470,9 +2850,13 @@ class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
-class="cmtt-10">makeindex </span>doesn&#8217;t recognise <span
-class="cmtt-10">&eacute;</span> as a&#x00A0;letter so it will be put in the
- symbols group.
+class="cmtt-10">makeindex</span><a
+ id="dx1-5107"></a> sees <span
+class="cmtt-10">&eacute;</span> as two octets (0xC3 0xA9) rather than a single
+ character so it tries to put <span
+class="cmtt-10">&eacute;</span><span
+class="cmtt-10">lite </span>in the 0xC3 (&#8220;&Atilde;&#8221;) letter group (which,
+ in this case, comes after &#8220;Z&#8221;).
</dd><dt class="description">
<a
href="#option3"><span
@@ -1480,26 +2864,79 @@ class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
-class="cmtt-10">xindy </span>will correctly recognise the sort value <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5108"></a> will correctly recognise the sort value <span
class="cmtt-10">&eacute;</span><span
class="cmtt-10">lite </span>and will place
it in whatever letter group is appropriate for the given language setting.
- (In English, this would just be the &#8220;E&#8221; letter group.)</dd></dl>
-<!--l. 812--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is
-to use <span
-class="cmtt-10">xindy </span>(<a
-href="#option3">Option&#x00A0;3</a>) with the <span
+ (In English, this would just be the &#8220;E&#8221; letter group, but another language
+ might put it in the &#8220;É&#8221; letter group.)
+ </dd><dt class="description">
+<a
+href="#option4"><span
+class="cmbx-10">Option</span><span
+class="cmbx-10">&#x00A0;4</span></a><span
+class="cmbx-10">:</span> </dt><dd
+class="description">The <span
class="cmss-10">inputenc</span><a
- id="dx1-5037"></a> package. If you use <span
-class="cmtt-10">makeindex </span>(<a
-href="#option2">Option&#x00A0;2</a>)
-you need to specify the <span
-class="cmtt-10">sort </span>key like this:
+ id="dx1-5109"></a> package doesn&#8217;t affect the encoding used with <span
+class="cmtt-10">.bib </span>entry
+ definitions, since these are dependent on the encoding used to save the <span
+class="cmtt-10">.bib </span>file
+ (although the labels must still be ASCII). You can help <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5110"></a> (and
+ JabRef) by putting an encoding comment at the start of the <span
+class="cmtt-10">.bib </span>file:
+ <div class="alltt">
+ <div class="obeylines-v">
+ <span
+class="cmtt-10">%</span><span
+class="cmtt-10">&#x00A0;Encoding:</span><span
+class="cmtt-10">&#x00A0;UTF-8</span>
+</div>
+ </div>
+ <!--l. 1515--><p class="noindent" >With the correct encoding set up, <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5111"></a> will determine that the sort value is
+ <span
+class="cmtt-10">&eacute;</span><span
+class="cmtt-10">lite </span>and will place it in whatever letter group is appropriate for the given
+ sort rule. For example, <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">sort=en-GB</span></span></span> (or just <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">sort=en</span></span></span>) will put <span
+class="cmtt-10">&eacute;</span><span
+class="cmtt-10">lite </span>in the
+ &#8220;E&#8221; letter group, but another language might put it in the &#8220;É&#8221; letter
+ group.
</p>
- <div class="verbatim" id="verbatim-31">
+ </dd></dl>
+<!--l. 1524--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is
+to use either <span
+class="cmtt-10">xindy</span><a
+ id="dx1-5112"></a> (<a
+href="#option3">Option&#x00A0;3</a>) or <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5113"></a> (<a
+href="#option4">Option&#x00A0;4</a>) with the <span
+class="cmss-10">inputenc</span><a
+ id="dx1-5114"></a> or <span
+class="cmss-10">fontspec</span><a
+ id="dx1-5115"></a>
+package. If you use <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-5116"></a> (<a
+href="#option2">Option&#x00A0;2</a>) you need to specify the <span
+class="cmtt-10">sort </span>key like
+this:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-69">
\newglossaryentry{elite}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={{\'e}lite},
@@ -1507,160 +2944,75 @@ class="cmtt-10">sort </span>key like this:
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
-<!--l. 823--><p class="nopar" > If you use <a
+<!--l. 1536--><p class="nopar" > or </p><div class="alltt">
+<div class="obeylines-v">
+<span
+class="cmtt-10">\newglossaryentry</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">elite</span><span
+class="cmsy-10">}</span>
+<br /><span
+class="cmsy-10">{</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;name=</span><span
+class="cmsy-10">{{</span><span
+class="cmtt-10">&eacute;</span><span
+class="cmsy-10">}</span><span
+class="cmtt-10">lite</span><span
+class="cmsy-10">}</span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;sort=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">elite</span><span
+class="cmsy-10">}</span><span
+class="cmtt-10">,</span>
+<br /><span
+class="cmtt-10">&#x00A0;</span><span
+class="cmtt-10">&#x00A0;description=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">select</span><span
+class="cmtt-10">&#x00A0;group</span><span
+class="cmtt-10">&#x00A0;or</span><span
+class="cmtt-10">&#x00A0;class</span><span
+class="cmsy-10">}</span>
+<br /><span
+class="cmsy-10">}</span>
+</div>
+</div> If you use <a
href="#option1">Option&#x00A0;1</a>, you may or may not need to use the <span
class="cmtt-10">sort </span>key, but you will
need to be careful about fragile commands in the <span
class="cmtt-10">name </span>key if you don&#8217;t set the <span
class="cmtt-10">sort</span>
key.
-</p><!--l. 828--><p class="indent" > If you use <a
+<!--l. 1550--><p class="indent" > If you use <a
href="#option3">Option&#x00A0;3</a> and the <span
-class="cmtt-10">name </span>only contains a command (such as <span
-class="cmtt-10">\P</span>) you
-must add the <span
-class="cmtt-10">sort </span>key. This is also advisable for the other options, but is essential
-for <a
-href="#option3">Option&#x00A0;3</a>. For example:
+class="cmtt-10">name </span>only contains a command or commands (such
+as <span
+class="cmtt-10">\P </span>or <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\ensuremath{\pi}</span></span></span>) you must add the <span
+class="cmtt-10">sort </span>key. This is also advisable
+for the other options (except <a
+href="#option4">Option&#x00A0;4</a>), but is essential for <a
+href="#option3">Option&#x00A0;3</a>. For
+example:
</p>
- <div class="verbatim" id="verbatim-32">
-\newglossaryentry{P}{name={\P},sort={P},
-&#x00A0;<br />&#x00A0;description={paragraph&#x00A0;symbol}}
+ <div class="verbatim" id="verbatim-70">
+&#x00A0;\newglossaryentry{P}{name={\P},sort={P},
+&#x00A0;<br />&#x00A0;&#x00A0;description={paragraph&#x00A0;symbol}}
</div>
-<!--l. 835--><p class="nopar" >
-</p><!--l. 837--><p class="indent" > <a
-href="#x1-50381">Table&#x00A0;1</a> summarises the main pros and cons of three options described
-above.
-</p>
- <div class="table">
-
-
-
-<!--l. 840--><p class="indent" > <a
- id="x1-50381"></a></p><hr class="float" /><div class="float"
->
-
-
-
- <div class="caption"
-><span class="id">Table&#x00A0;1: </span><span
-class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50381 -->
-<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. 846--><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">&#x00A0;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">&#x00A0;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">&#x00A0;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. 847--><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-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
-class="td11"> <span
-class="pzdr-">&#x2714; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </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. 849--><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-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
-class="td11"> <span
-class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </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. 851--><p class="noindent" >Can
- sort
- extended
- Latin
- or
- non-Latin
- alphabets? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
-class="td11"> <span
-class="pzdr-">&#x2718;</span><sup class="textsuperscript"><span
-class="cmsy-9">&#8224;</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
-class="td11"> <span
-class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </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. 854--><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-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
-class="td11"> <span
-class="pzdr-">&#x2714; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </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. 856--><p class="noindent" >Can
- form
- ranges
- in
- the
- location
- lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
-class="td11"> <span
-class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
-class="td11"> <span
-class="pzdr-">&#x2714; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </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. 858--><p class="noindent" >Can
- have
- non-standard
- locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
-class="td11"> <span
-class="pzdr-">&#x2714; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
-class="td11"> <span
-class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4"
-class="td11"> <span
-class="pzdr-">&#x2714; </span></td>
-</tr></table></div>
-<!--l. 862--><p class="noindent" ><sup class="textsuperscript"><span
-class="cmsy-9">&#8224;</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>&#x00A0;accents so, for example, <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\AA</span></span></span> is treated the same as
-A.
-
-
-
+<!--l. 1557--><p class="nopar" >
</p>
- </div><hr class="endfloat" />
- </div>
-<!--l. 866--><p class="noindent" ><a
+<!--l. 1559--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a
id="sec:glosstyle"></a>Customising the Glossary</h3>
-<!--l. 869--><p class="noindent" >The default glossary style uses the <span
+<!--l. 1562--><p class="noindent" >The default glossary style uses the <span
class="cmss-10">description</span><a
id="dx1-6001"></a><a
id="dx1-6002"></a> environment to display the entry list.
@@ -1673,159 +3025,245 @@ class="cmtt-10">\glsnamefont</span>:
</p>
- <div class="verbatim" id="verbatim-33">
+ <div class="verbatim" id="verbatim-71">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
</div>
-<!--l. 876--><p class="nopar" >
-</p><!--l. 878--><p class="indent" > By default, a&#x00A0;full stop is appended to the description. To prevent this from
-happening use the <span
-class="cmtt-10">nopostdot </span>package option:
+<!--l. 1569--><p class="nopar" > Some classes and packages redefine the <span
+class="cmss-10">description</span><a
+ id="dx1-6003"></a><a
+ id="dx1-6004"></a> environment in such as way that&#8217;s
+incompatible with the <span
+class="cmss-10">glossaries </span>package. In which case you&#8217;ll need to select a
+different glossary style (see below).
+</p><!--l. 1575--><p class="indent" > By default, a&#x00A0;full stop is appended to the description (unless you use
+<span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-6005"></a>). To prevent this from happening use the <span
+class="cmss-10">nopostdot</span><a
+ id="dx1-6006"></a> package
+option:
</p>
- <div class="verbatim" id="verbatim-34">
+ <div class="verbatim" id="verbatim-72">
\usepackage[nopostdot]{glossaries}
</div>
-<!--l. 882--><p class="nopar" >
-</p><!--l. 884--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry. This refers to the
-document locations (for example, the page number) where the entry has been
-referenced. If you use Options&#x00A0;<a
+<!--l. 1580--><p class="nopar" > or to add it with <span
+class="cmss-10">glossaries-extra</span>:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-73">
+\usepackage[postdot]{glossaries-extra}
+</div>
+<!--l. 1584--><p class="nopar" >
+</p><!--l. 1586--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry (unless you use
+<span
+class="cmtt-10">\printunsrtglossary </span>without <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-6007"></a>). This refers to the document locations (for
+example, the page number) where the entry has been referenced. If you use
+Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a> described in <a
href="#sec:printglossaries"><span
class="cmsy-10">&sect;</span>4 </a><a
-href="#sec:printglossaries">Displaying a List of
-Entries<!--tex4ht:ref: sec:printglossaries --></a> location ranges will be compressed. For example, if an entry was
-used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
+href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a> or <a
+href="#option4">Option&#x00A0;4</a> (with
+<span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-6008"></a> and <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-6009"></a>) then location ranges will be compressed. For example, if
+an entry was used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
-href="#option3">3</a> the location list will appear
-as 1&#8211;3, but with <a
-href="#option1">Option&#x00A0;1</a> it will appear as 1, 2, 3. If you don&#8217;t want the
-locations displayed you can hide them using the <span
-class="cmtt-10">nonumberlist </span>package
+href="#option3">3</a> or <a
+href="#option4">Option&#x00A0;4</a> the
+location list will appear as 1&#8211;3, but with <a
+href="#option1">Option&#x00A0;1</a> it will appear as 1, 2, 3. If you
+don&#8217;t want the locations displayed you can hide them using the <span
+class="cmss-10">nonumberlist</span><a
+ id="dx1-6010"></a> package
option:
</p>
- <div class="verbatim" id="verbatim-35">
+ <div class="verbatim" id="verbatim-74">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--l. 894--><p class="nopar" >
-</p><!--l. 896--><p class="indent" > Entries are grouped according to the first letter of each entry&#8217;s <span
+<!--l. 1598--><p class="nopar" > or with <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-6011"></a> use <span
+class="cmtt-10">save-locations=false </span>in the optional argument of the
+appropriate <span
+class="cmtt-10">\GlsXtrLoadResources </span>(it&#8217;s possible to have some resource sets with
+locations and some without).
+</p><!--l. 1604--><p class="indent" > Entries are grouped according to the first letter of each entry&#8217;s <span
class="cmtt-10">sort </span>key. By
default a&#x00A0;vertical gap is placed between letter groups. You can suppress this with the
<span
-class="cmtt-10">nogroupskip </span>package option:
+class="cmss-10">nogroupskip</span><a
+ id="dx1-6012"></a> package option:
</p>
- <div class="verbatim" id="verbatim-36">
+ <div class="verbatim" id="verbatim-75">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 902--><p class="nopar" >
-</p><!--l. 904--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
+<!--l. 1610--><p class="nopar" >
+</p><!--l. 1612--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
using:
-</p><!--l. 907--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1615--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\setglossarystyle{</span>&#x27E8;<span
class="cmitt-10">style name</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 908--><p class="noindent" >
-There are a&#x00A0;number of predefined styles. Glossaries can vary from a&#x00A0;list of symbols
+</p><!--l. 1616--><p class="noindent" >
+<a
+href="http://www.dickimaw-books.com/gallery/glossaries-styles/" >There are a&#x00A0;number of predefined styles.</a> Glossaries can vary from a&#x00A0;list of symbols
with a&#x00A0;terse description to a&#x00A0;list of words or phrases with descriptions that span
multiple paragraphs, so there&#8217;s no &#8220;one style fits all&#8221; solution. You need to choose
-a&#x00A0;style that suits your document.
-</p><!--l. 915--><p class="indent" > Examples:
+a&#x00A0;style that suits your document. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-76">
+\setglossarystyle{index}
+</div>
+<!--l. 1624--><p class="nopar" > You can also use the <span
+class="cmss-10">style</span><a
+ id="dx1-6013"></a> package option for the preloaded styles. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-77">
+\usepackage[style=index]{glossaries}
+</div>
+<!--l. 1629--><p class="nopar" >
+</p><!--l. 1631--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-6004x1">You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief
+ class="enumerate" id="x1-6015x1">You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief
phrase or short sentence. Try one of the &#8220;mcol&#8221; styles defined in the
<span
class="cmss-10">glossary-mcols</span><a
- id="dx1-6005"></a> package. For example:
+ id="dx1-6016"></a> package. For example:
- <div class="verbatim" id="verbatim-37">
- \usepackage[nogroupskip,nopostdot]{glossaries}
+ <div class="verbatim" id="verbatim-78">
+ \usepackage[nopostdot]{glossaries}
&#x00A0;<br />\usepackage{glossary-mcols}
&#x00A0;<br />\setglossarystyle{mcolindex}
</div>
- <!--l. 924--><p class="nopar" >
+ <!--l. 1640--><p class="nopar" > or
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-79">
+ \usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra}
+</div>
+ <!--l. 1644--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-6007x2">You have entries where the name is a&#x00A0;word or phrase and the description spans
+ class="enumerate" id="x1-6018x2">You have entries where the name is a&#x00A0;word or phrase and the description spans
multiple paragraphs. Try one of the &#8220;altlist&#8221; styles. For example:
- <div class="verbatim" id="verbatim-38">
+ <div class="verbatim" id="verbatim-80">
\usepackage[nopostdot]{glossaries}
&#x00A0;<br />\setglossarystyle{altlist}
</div>
- <!--l. 932--><p class="nopar" >
+ <!--l. 1652--><p class="nopar" > or
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-81">
+ \usepackage[stylemods,style=altlist]{glossaries-extra}
+</div>
+ <!--l. 1656--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-6009x3">You have entries where the name is a&#x00A0;single word, the description is
+ class="enumerate" id="x1-6020x3">You have entries where the name is a&#x00A0;single word, the description is
brief, and an associated symbol has been set. Use one of the styles that
display the symbol (not all of them do). For example, one of the tabular
styles:
- <div class="verbatim" id="verbatim-39">
+ <div class="verbatim" id="verbatim-82">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{long4col}
</div>
- <!--l. 941--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
+ <!--l. 1665--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
</p>
- <div class="verbatim" id="verbatim-40">
+ <div class="verbatim" id="verbatim-83">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{tree}
</div>
- <!--l. 946--><p class="nopar" ></p></li></ol>
-<!--l. 949--><p class="indent" > If your glossary consists of a&#x00A0;list of acronyms and you also want to specify
-a&#x00A0;description as well as the long form, then you need to use an acronym style that
-will suit the glossary style. For example, use the <span
+ <!--l. 1670--><p class="nopar" ></p></li></ol>
+<!--l. 1673--><p class="indent" > If your glossary consists of a&#x00A0;list of abbreviations and you also want to specify
+a&#x00A0;description as well as the long form, then you need to use an abbreviation style
+that will suit the glossary style. For example, use the <span
class="cmtt-10">long-short-desc </span>acronym
style:
</p>
- <div class="verbatim" id="verbatim-41">
+ <div class="verbatim" id="verbatim-84">
\setacronymstyle{long-short-desc}
</div>
-<!--l. 955--><p class="nopar" > Define the acronyms with a&#x00A0;description:
+<!--l. 1679--><p class="nopar" > Define the acronyms with a&#x00A0;description:
</p>
- <div class="verbatim" id="verbatim-42">
+ <div class="verbatim" id="verbatim-85">
\newacronym
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
-&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 961--><p class="nopar" > Choose a&#x00A0;glossary style that suits wide entry names:
+<!--l. 1685--><p class="nopar" > Alternatively with <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-6021"></a>:
</p>
- <div class="verbatim" id="verbatim-43">
+ <div class="verbatim" id="verbatim-86">
+\setabbreviationstyle{long-short-desc}
+&#x00A0;<br />\newabbreviation
+&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
+&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+</div>
+<!--l. 1693--><p class="nopar" >
+</p><!--l. 1695--><p class="indent" > Choose a&#x00A0;glossary style that suits wide entry names. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-87">
\setglossarystyle{altlist}
</div>
-<!--l. 965--><p class="nopar" >
-</p><!--l. 967--><p class="noindent" >
+<!--l. 1698--><p class="nopar" >
+</p><!--l. 1700--><p class="noindent" >
</p>
-<!--l. 967--><p class="noindent" ><a
+<!--l. 1700--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a
id="sec:multigloss"></a>Multiple Glossaries</h3>
-<!--l. 970--><p class="noindent" >The <span
+<!--l. 1703--><p class="noindent" >The <span
class="cmss-10">glossaries</span><a
id="dx1-7001"></a> package predefines a&#x00A0;default <span
class="cmtt-10">main </span>glossary. When you define an entry
@@ -1837,7 +3275,7 @@ automatically assigned to the default glossary, unless you indicate otherwise us
<span
class="cmtt-10">type </span>key. However you first need to make sure the desired glossary has been defined.
This is done using:
-</p><!--l. 977--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1710--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary[</span>&#x27E8;<span
class="cmitt-10">glg</span>&#x27E9;<span
class="cmtt-10">]{</span>&#x27E8;<span
@@ -1849,7 +3287,7 @@ class="cmitt-10">glo</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">title</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 978--><p class="noindent" >
+</p><!--l. 1711--><p class="noindent" >
The &#x27E8;<span
class="cmti-10">label</span>&#x27E9; is a&#x00A0;label that uniquely identifies this new glossary. As with other types of
identifying labels, be careful not to use active characters in &#x27E8;<span
@@ -1860,58 +3298,93 @@ class="cmtt-10">\printglossary </span>or
<span
class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions used by
<span
-class="cmtt-10">makeindex</span>/<span
-class="cmtt-10">xindy </span>(described in <a
+class="cmtt-10">makeindex</span><a
+ id="dx1-7002"></a>/<span
+class="cmtt-10">xindy</span><a
+ id="dx1-7003"></a> (described in <a
href="#sec:printglossaries"><span
class="cmsy-10">&sect;</span>4 </a><a
-href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>). If you use
-<a
-href="#option1">Option&#x00A0;1</a> described above, the &#x27E8;<span
+href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>). If you use <a
+href="#option1">Option&#x00A0;1</a>
+described above (or <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-7004"></a> and <span
+class="cmtt-10">\printunsrtglossaries</span>), then the &#x27E8;<span
class="cmti-10">glg</span>&#x27E9;, &#x27E8;<span
class="cmti-10">gls</span>&#x27E9; and &#x27E8;<span
-class="cmti-10">glo</span>&#x27E9; arguments are ignored, in which
-case you may prefer to use the starred version where you don&#8217;t specify the
-extensions:
-</p><!--l. 991--><p class="indent" > <hr><div title="Definition"><span
+class="cmti-10">glo</span>&#x27E9;
+arguments are ignored, in which case you may prefer to use the starred version where
+you don&#8217;t specify the extensions:
+</p><!--l. 1725--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary*{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">title</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 992--><p class="noindent" >
-</p><!--l. 994--><p class="indent" > In the case of Options&#x00A0;<a
+</p><!--l. 1726--><p class="noindent" >
+</p><!--l. 1728--><p class="indent" > In the case of Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a>, all glossary definitions must come before
<span
-class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 997--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
-acronyms, the <span
+class="cmtt-10">\makeglossaries</span>. (Entries definitions should come after <span
+class="cmtt-10">\makeglossaries</span>.) In the case
+of <a
+href="#option4">Option&#x00A0;4</a>, all glossary definitions must come before any <span
+class="cmtt-10">\GlsXtrLoadResources</span>
+that requires them.
+</p><!--l. 1733--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
+abbreviations, the <span
class="cmss-10">glossaries</span><a
- id="dx1-7002"></a> package provides the package option <span
-class="cmtt-10">acronym </span>(or <span
-class="cmtt-10">acronyms</span>),
-which is a&#x00A0;convenient shortcut for
+ id="dx1-7005"></a> package provides the package option <span
+class="cmss-10">acronym</span><a
+ id="dx1-7006"></a> (or
+<span
+class="cmss-10">acronyms</span><a
+ id="dx1-7007"></a>), which is a&#x00A0;convenient shortcut for
</p>
- <div class="verbatim" id="verbatim-44">
+ <div class="verbatim" id="verbatim-88">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
-<!--l. 1003--><p class="nopar" > The option also changes the behaviour of <span
+<!--l. 1739--><p class="nopar" > The option also changes the behaviour of <span
class="cmtt-10">\newacronym </span>so that acronyms are
-automatically put in the list of acronyms instead of the main glossary.
-</p><!--l. 1008--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
+automatically put in the list of acronyms instead of the main glossary. The
+<span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7008"></a> package also provides this option for abbreviations defined using
+<span
+class="cmtt-10">\newacronym </span>but additionally has the package option <span
+class="cmss-10">abbreviations</span><a
+ id="dx1-7009"></a> to create a list of
+abbreviations for <span
+class="cmtt-10">\newabbreviation</span>.
+</p><!--l. 1747--><p class="indent" > There are some other package options for creating commonly used lists: <span
+class="cmss-10">symbols</span><a
+ id="dx1-7010"></a>
+(lists of symbols), <span
+class="cmss-10">numbers</span><a
+ id="dx1-7011"></a> (lists of numbers), <span
+class="cmss-10">index</span><a
+ id="dx1-7012"></a> (index of terms without
+descriptions defined with <span
+class="cmtt-10">\newterm[</span>&#x27E8;<span
+class="cmti-10">options</span>&#x27E9;<span
+class="cmtt-10">]{</span>&#x27E8;<span
+class="cmti-10">label</span>&#x27E9;<span
+class="cmtt-10">}</span>).
+</p><!--l. 1752--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
a&#x00A0;list of notation:
</p>
- <div class="verbatim" id="verbatim-45">
-\usepackage[acronyms]{glossaries}
-&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
+ <div class="verbatim" id="verbatim-89">
+&#x00A0;\usepackage[acronyms]{glossaries}
+&#x00A0;<br />&#x00A0;\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1013--><p class="nopar" > After <span
+<!--l. 1757--><p class="nopar" > After <span
class="cmtt-10">\makeglossaries </span>(or <span
class="cmtt-10">\makenoidxglossaries</span>) you can define the entries in
the preamble. For example:
@@ -1919,95 +3392,152 @@ the preamble. For example:
</p>
- <div class="verbatim" id="verbatim-46">
-\newglossaryentry{gls:set}
-&#x00A0;<br />{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`main'&#x00A0;glossary
-&#x00A0;<br />&#x00A0;&#x00A0;name=set,
-&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;collection&#x00A0;of&#x00A0;distinct&#x00A0;objects}
-&#x00A0;<br />}
-&#x00A0;<br />&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`acronym'&#x00A0;glossary:
-&#x00A0;<br />\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />\newglossaryentry{not:set}
-&#x00A0;<br />{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
-&#x00A0;<br />&#x00A0;&#x00A0;type=notation,
-&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\mathcal{S}}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
-</div>
-<!--l. 1032--><p class="nopar" > or if you don&#8217;t like using <span
+ <div class="verbatim" id="verbatim-90">
+&#x00A0;\newglossaryentry{gls:set}
+&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`main'&#x00A0;glossary
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name=set,
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;collection&#x00A0;of&#x00A0;distinct&#x00A0;objects}
+&#x00A0;<br />&#x00A0;}
+&#x00A0;<br />&#x00A0;%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`acronym'&#x00A0;glossary:
+&#x00A0;<br />&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />&#x00A0;\newglossaryentry{not:set}
+&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;type=notation,
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={\ensuremath{\mathcal{S}}},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
+</div>
+<!--l. 1776--><p class="nopar" > or if you don&#8217;t like using <span
class="cmtt-10">\ensuremath</span>:
</p>
- <div class="verbatim" id="verbatim-47">
-\newglossaryentry{not:set}
-&#x00A0;<br />{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
-&#x00A0;<br />&#x00A0;&#x00A0;type=notation,
-&#x00A0;<br />&#x00A0;&#x00A0;name={$\mathcal{S}$},
-&#x00A0;<br />&#x00A0;&#x00A0;text={\mathcal{S}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
-</div>
-<!--l. 1042--><p class="nopar" >
-</p><!--l. 1044--><p class="indent" > Each glossary is displayed using:
-</p><!--l. 1046--><p class="indent" > <hr><div title="Definition"><span
+ <div class="verbatim" id="verbatim-91">
+&#x00A0;\newglossaryentry{not:set}
+&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;type=notation,
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={$\mathcal{S}$},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;text={\mathcal{S}},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
+&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
+</div>
+<!--l. 1786--><p class="nopar" >
+</p><!--l. 1788--><p class="indent" > Each glossary is displayed using:
+</p><!--l. 1790--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[type=</span>&#x27E8;<span
class="cmitt-10">type</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 1047--><p class="noindent" >
+</p><!--l. 1791--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1050--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1794--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossary[type=</span>&#x27E8;<span
class="cmitt-10">type</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 1051--><p class="noindent" >
+</p><!--l. 1795--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>). Where &#x27E8;<span
class="cmti-10">type</span>&#x27E9; is the glossary label. If the type is omitted the
default <span
class="cmtt-10">main </span>glossary is assumed.
-</p><!--l. 1055--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries:
-</p><!--l. 1058--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1799--><p class="indent" > If you&#8217;re using <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-7013"></a> then each glossary is displayed using:
+</p><!--l. 1802--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\printunsrtglossary[type=</span>&#x27E8;<span
+class="cmitt-10">type</span>&#x27E9;<span
+class="cmtt-10">] </span></div><hr>
+</p><!--l. 1803--><p class="noindent" >
+With this method you don&#8217;t use <span
+class="cmtt-10">\makeglossaries </span>or <span
+class="cmtt-10">\makenoidxglossaries</span>.
+Instead you can assign the entry type with the resource command. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-92">
+&#x00A0;\usepackage[record,abbreviations,symbols]{glossaries-extra}
+&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
+&#x00A0;<br />&#x00A0;&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
+&#x00A0;<br />&#x00A0;]
+&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
+&#x00A0;<br />&#x00A0;&#x00A0;type={abbreviations}%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
+&#x00A0;<br />&#x00A0;]
+&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
+&#x00A0;<br />&#x00A0;&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
+&#x00A0;<br />&#x00A0;]
+</div>
+<!--l. 1822--><p class="nopar" > Later in the document:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-93">
+&#x00A0;\printunsrtglossary&#x00A0;%&#x00A0;main
+&#x00A0;<br />&#x00A0;\printunsrtglossary[type=abbreviations]
+&#x00A0;<br />&#x00A0;\printunsrtglossary[type=symbols]
+</div>
+<!--l. 1828--><p class="nopar" >
+</p><!--l. 1830--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries
+depending on the indexing method:
+</p><!--l. 1833--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
-</p><!--l. 1059--><p class="noindent" >
+</p><!--l. 1834--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1062--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1837--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
-</p><!--l. 1063--><p class="noindent" >
+</p><!--l. 1838--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
-href="#option3">3</a>).
-</p><!--l. 1066--><p class="indent" > If you use <a
+href="#option3">3</a>) or (<span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-7014"></a> only)
+</p><!--l. 1841--><p class="indent" > <hr><div title="Definition"><span
+class="cmtt-10">\printunsrtglossaries </span></div><hr>
+</p><!--l. 1842--><p class="noindent" >
+</p><!--l. 1844--><p class="indent" > If you use <a
href="#option1">Option&#x00A0;1</a>, you don&#8217;t need to do anything else. If you use Options&#x00A0;<a
href="#option2">2</a>
or&#x00A0;<a
href="#option3">3</a> with the <span
-class="cmtt-10">makeglossaries </span>Perl script, you similarly don&#8217;t need to do anything
-else. If you use Options&#x00A0;<a
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-7015"></a> Perl script or the <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-7016"></a> Lua script,
+you similarly don&#8217;t need to do anything else. If you use Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
-href="#option3">3</a> without the <span
-class="cmtt-10">makeglossaries </span>Perl script then you
-need to make sure you run <span
-class="cmtt-10">makeindex</span>/<span
-class="cmtt-10">xindy </span><span
+href="#option3">3</a> without the
+<span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-7017"></a> Perl script then you need to make sure you run <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-7018"></a>/<span
+class="cmtt-10">xindy</span><a
+ id="dx1-7019"></a>
+<span
class="cmti-10">for each defined glossary</span>. The &#x27E8;<span
-class="cmti-10">gls</span>&#x27E9; and
-&#x27E8;<span
+class="cmti-10">gls</span>&#x27E9; and &#x27E8;<span
class="cmti-10">glo</span>&#x27E9; arguments of <span
-class="cmtt-10">\newglossary </span>specify the file extensions to use instead of <span
-class="cmtt-10">.gls </span>and
-<span
+class="cmtt-10">\newglossary </span>specify the file
+extensions to use instead of <span
+class="cmtt-10">.gls </span>and <span
class="cmtt-10">.glo</span>. The optional argument &#x27E8;<span
-class="cmti-10">glg</span>&#x27E9; is the file extension for the transcript file. This
-should be different for each glossary in case you need to check for <span
-class="cmtt-10">makeindex</span>/<span
-class="cmtt-10">xindy</span>
-errors or warnings if things go wrong.
-</p><!--l. 1079--><p class="indent" > For example, suppose you have three glossaries in your document (<span
+class="cmti-10">glg</span>&#x27E9; is the file
+extension for the transcript file. This should be different for each glossary in
+case you need to check for <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-7020"></a>/<span
+class="cmtt-10">xindy</span><a
+ id="dx1-7021"></a> errors or warnings if things go
+wrong.
+</p><!--l. 1858--><p class="indent" > For example, suppose you have three glossaries in your document (<span
class="cmtt-10">main</span>, <span
class="cmtt-10">acronym</span>
and <span
@@ -2016,42 +3546,70 @@ class="cmtt-10">notation</span>), specified using:
</p>
- <div class="verbatim" id="verbatim-48">
+ <div class="verbatim" id="verbatim-94">
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1085--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+<!--l. 1864--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document is in a&#x00A0;file called <span
class="cmtt-10">myDoc.tex</span>):
-</p><!--l. 1089--><p class="indent" >
+</p><!--l. 1868--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
-href="#option2">Option&#x00A0;2</a>:
- <!--l. 1092--><p class="noindent" >You need to run <span
-class="cmtt-10">makeindex </span>three times:
+href="#option2">Option&#x00A0;2</a> Either use one <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-7022"></a> or <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-7023"></a> call:
+
+
+
+ <div class="verbatim" id="verbatim-95">
+ makeglossaries&#x00A0;myDoc
+</div>
+ <!--l. 1874--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-49">
+ <div class="verbatim" id="verbatim-96">
+ makeglossaries-lite&#x00A0;myDoc
+</div>
+ <!--l. 1878--><p class="nopar" > Or you need to run <span
+class="cmtt-10">makeindex</span><a
+ id="dx1-7024"></a> three times:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-97">
makeindex&#x00A0;-t&#x00A0;myDoc.glg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
&#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.alg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
&#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.nlg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
</div>
- <!--l. 1097--><p class="nopar" >
+ <!--l. 1884--><p class="nopar" >
</p></dd><dt class="description">
</dt><dd
class="description"><a
-href="#option3">Option&#x00A0;3</a>:
- <!--l. 1101--><p class="noindent" >You need to run <span
-class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where
- the line has wrapped.)
+href="#option3">Option&#x00A0;3</a> Either use one <span
+class="cmtt-10">makeglossaries</span><a
+ id="dx1-7025"></a> call:
+
+
+
+ <div class="verbatim" id="verbatim-98">
+ makeglossaries&#x00A0;myDoc
+</div>
+ <!--l. 1890--><p class="nopar" > Or you need to run <span
+class="cmtt-10">xindy</span><a
+ id="dx1-7026"></a> three times (be careful not to insert line breaks
+ where the line has wrapped.)
</p>
- <div class="verbatim" id="verbatim-50">
+ <div class="verbatim" id="verbatim-99">
xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.glg
&#x00A0;<br />-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
&#x00A0;<br />xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.alg
@@ -2059,59 +3617,78 @@ class="cmtt-10">xindy </span>three times (be careful not to insert line breaks w
&#x00A0;<br />xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.nlg
&#x00A0;<br />-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
</div>
- <!--l. 1110--><p class="nopar" ></p></dd></dl>
-<!--l. 1113--><p class="noindent" >
+ <!--l. 1900--><p class="nopar" >
+ </p></dd><dt class="description">
+ </dt><dd
+class="description"><a
+href="#option4">Option&#x00A0;4</a> With <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-7027"></a> only one call is required:
+
+
+
+ <div class="verbatim" id="verbatim-100">
+ pdflatex&#x00A0;myDoc
+ &#x00A0;<br />bib2gls&#x00A0;--group&#x00A0;myDoc
+ &#x00A0;<br />pdflatex&#x00A0;myDoc
+</div>
+ <!--l. 1908--><p class="nopar" > (Omit <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">--group</span></span></span> if you don&#8217;t need letter groups.)</p></dd></dl>
+<!--l. 1913--><p class="noindent" >
</p>
-<!--l. 1113--><p class="noindent" ><a
+<!--l. 1913--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a
id="sec:hyperref"></a><span
class="cmss-10">glossaries </span>and <span
class="cmss-10">hyperref</span></h3>
-<!--l. 1116--><p class="noindent" >Take care if you use the <span
+<!--l. 1916--><p class="noindent" >Take care if you use the <span
class="cmss-10">glossaries</span><a
id="dx1-8001"></a> package with <span
class="cmss-10">hyperref</span><a
- id="dx1-8002"></a>. Contrary to the usual
-advice that <span
+ id="dx1-8002"></a>. Contrary to the usual advice
+that <span
class="cmss-10">hyperref</span><a
id="dx1-8003"></a> should be loaded last, <span
class="cmss-10">glossaries</span><a
- id="dx1-8004"></a> must be loaded <span
-class="cmti-10">after</span>
+ id="dx1-8004"></a> (and <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8005"></a>) must be loaded
<span
+class="cmti-10">after </span><span
class="cmss-10">hyperref</span><a
- id="dx1-8005"></a>:
+ id="dx1-8006"></a>:
</p>
- <div class="verbatim" id="verbatim-51">
+ <div class="verbatim" id="verbatim-101">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage{glossaries}
</div>
-<!--l. 1123--><p class="nopar" > If you use <span
+<!--l. 1923--><p class="nopar" > If you use <span
class="cmss-10">hyperref</span><a
- id="dx1-8006"></a> make sure you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ id="dx1-8007"></a> make sure you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;rather than the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;to DVI
engine. The DVI format can&#8217;t break hyperlinks across a&#x00A0;line so long glossary entries
(such as the full form of acronyms) won&#8217;t line wrap with the DVI engine.
Also, hyperlinks in sub- or superscripts aren&#8217;t correctly sized with the DVI
format.
-</p><!--l. 1130--><p class="indent" > By default, if the <span
+</p><!--l. 1930--><p class="indent" > By default, if the <span
class="cmss-10">hyperref</span><a
- id="dx1-8007"></a> package has been loaded, commands like <span
+ id="dx1-8008"></a> package has been loaded, commands like <span
class="cmtt-10">\gls </span>will form
a&#x00A0;hyperlink to the relevant entry in the glossary. If you to disable this for <span
class="cmti-10">all </span>your
glossaries, then use
-</p><!--l. 1135--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1935--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsdisablehyper </span></div><hr>
-</p><!--l. 1136--><p class="noindent" >
+</p><!--l. 1936--><p class="noindent" >
If you want hyperlinks suppressed for entries in specific glossaries, then use the
<span
-class="cmtt-10">nohypertypes </span>package option. For example, if you don&#8217;t want hyperlinks for entries
-in the <span
+class="cmss-10">nohypertypes</span><a
+ id="dx1-8009"></a> package option. For example, if you don&#8217;t want hyperlinks for entries in
+the <span
class="cmtt-10">acronym </span>and <span
class="cmtt-10">notation </span>glossaries but you do want them for entries in the <span
class="cmtt-10">main</span>
@@ -2120,29 +3697,30 @@ glossary, then do:
</p>
- <div class="verbatim" id="verbatim-52">
+ <div class="verbatim" id="verbatim-102">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1146--><p class="nopar" >
-</p><!--l. 1148--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
+<!--l. 1946--><p class="nopar" >
+</p><!--l. 1948--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
want hyperlinks for subsequence references then use the <span
-class="cmtt-10">hyperfirst=false </span>package
+class="cmss-10">hyperfirst=false</span><a
+ id="dx1-8010"></a> package
option:
</p>
- <div class="verbatim" id="verbatim-53">
+ <div class="verbatim" id="verbatim-103">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[hyperfirst=false]{glossaries}
</div>
-<!--l. 1154--><p class="nopar" >
-</p><!--l. 1156--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn&#8217;t
+<!--l. 1954--><p class="nopar" >
+</p><!--l. 1956--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn&#8217;t
specific to the <span
class="cmss-10">glossaries</span><a
- id="dx1-8008"></a> package but is a&#x00A0;limitation of PDF bookmarks.
+ id="dx1-8011"></a> package but is a&#x00A0;limitation of PDF bookmarks.
Non-expandable commands include commands like <span
class="cmtt-10">\gls</span>, <span
class="cmtt-10">\glspl</span>, <span
@@ -2150,25 +3728,25 @@ class="cmtt-10">\Gls </span>and <span
class="cmtt-10">\Glspl</span>.
The <span
class="cmss-10">hyperref</span><a
- id="dx1-8009"></a> package provides a&#x00A0;way of specifying alternative text for the PDF
+ id="dx1-8012"></a> package provides a&#x00A0;way of specifying alternative text for the PDF
bookmarks via <span
class="cmtt-10">\texorpdfstring</span>. For example:
</p>
- <div class="verbatim" id="verbatim-54">
+ <div class="verbatim" id="verbatim-104">
\section{The&#x00A0;\texorpdfstring{\gls{fishage}}{Fish&#x00A0;Age}}
</div>
-<!--l. 1164--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
+<!--l. 1964--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
class="cmtt-10">\gls </span>in a&#x00A0;section heading as
you&#8217;ll end up with the table of contents in your location list. Instead you can
use
-</p><!--l. 1169--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1969--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsentrytext{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 1170--><p class="noindent" >
+</p><!--l. 1970--><p class="noindent" >
This is expandable provided that the <span
class="cmtt-10">text </span>key doesn&#8217;t contain non-expandable code.
For example, the following works:
@@ -2176,28 +3754,39 @@ For example, the following works:
</p>
- <div class="verbatim" id="verbatim-55">
+ <div class="verbatim" id="verbatim-105">
\section{The&#x00A0;\glsentrytext{fishage}}
</div>
-<!--l. 1175--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
-</p><!--l. 1178--><p class="noindent" >
+<!--l. 1975--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
+</p><!--l. 1978--><p class="indent" > If you use <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8013"></a> then use the commands that are provided specifically for
+use in section headers. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-106">
+\section{The&#x00A0;\glsfmttext{fishage}}
+</div>
+<!--l. 1982--><p class="nopar" >
+</p><!--l. 1984--><p class="noindent" >
</p>
-<!--l. 1178--><p class="noindent" ><a
+<!--l. 1984--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a
id="sec:xr"></a>Cross-References</h3>
-<!--l. 1181--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
-class="cmtt-10">see=</span>
-<span
-class="cmtt-10">{</span>&#x27E8;<span
-class="cmti-10">label</span>&#x27E9;<span
-class="cmtt-10">} </span>key when you define an entry. The referenced entry must also be
+<!--l. 1987--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
+class="cmtt-10">see={</span>&#x27E8;<span
+class="cmti-10">label list</span>&#x27E9;<span
+class="cmtt-10">}</span>
+key when you define an entry. The referenced entry (or entries) must also be
defined.
-</p><!--l. 1185--><p class="indent" > For example:
+</p><!--l. 1991--><p class="indent" > For example:
</p>
- <div class="verbatim" id="verbatim-56">
+ <div class="verbatim" id="verbatim-107">
\longnewglossaryentry{devonian}{name={Devonian}}%
&#x00A0;<br />{%
&#x00A0;<br />&#x00A0;&#x00A0;The&#x00A0;geologic&#x00A0;period&#x00A0;spanning&#x00A0;from&#x00A0;the&#x00A0;end&#x00A0;of&#x00A0;the
@@ -2212,7 +3801,7 @@ defined.
&#x00A0;<br />&#x00A0;&#x00A0;see={devonian}
&#x00A0;<br />}
</div>
-<!--l. 1202--><p class="nopar" > The cross-reference will appear as &#8220;<span
+<!--l. 2008--><p class="nopar" > The cross-reference will appear as &#8220;<span
class="cmti-10">see </span>Devonian&#8221;. You can change the &#8220;see&#8221; tag
using the format <span
class="cmtt-10">see=[</span>&#x27E8;<span
@@ -2223,7 +3812,7 @@ class="cmti-10">label</span>&#x27E9;. For example:
</p>
- <div class="verbatim" id="verbatim-57">
+ <div class="verbatim" id="verbatim-108">
\newglossaryentry{latinalph}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;alphabet},
@@ -2238,7 +3827,7 @@ class="cmti-10">label</span>&#x27E9;. For example:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;other&#x00A0;letters&#x00A0;such&#x00A0;as&#x00A0;ligatures&#x00A0;or&#x00A0;diacritics.}
&#x00A0;<br />}
</div>
-<!--l. 1220--><p class="nopar" > If you use the <span
+<!--l. 2026--><p class="nopar" > If you use the <span
class="cmtt-10">see </span>key in the optional argument of <span
class="cmtt-10">\newacronym</span>, make sure you
enclose the value in braces. For example:
@@ -2246,37 +3835,104 @@ enclose the value in braces. For example:
</p>
- <div class="verbatim" id="verbatim-58">
+ <div class="verbatim" id="verbatim-109">
\newacronym{ksvm}{ksvm}{kernel&#x00A0;support&#x00A0;vector&#x00A0;machine}
&#x00A0;<br />\newacronym
&#x00A0;<br />&#x00A0;[see={[see&#x00A0;also]{ksvm}}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 1229--><p class="nopar" >
-</p><!--l. 1231--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location
-list using the <span
-class="cmtt-10">nonumberlist </span>package option, then the cross-reference will also be
-suppressed.
-</p><!--l. 1235--><p class="noindent" >
+<!--l. 2035--><p class="nopar" > The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-9001"></a> package provides a <span
+class="cmtt-10">seealso </span>key. This doesn&#8217;t allow a tag but
+behaves much like <span
+class="cmtt-10">see=</span><span
+class="cmsy-10">{</span><span
+class="cmtt-10">[\seealsoname]{</span>&#x27E8;<span
+class="cmitt-10">label</span>&#x27E9;<span
+class="cmtt-10">}</span><span
+class="cmsy-10">}</span>. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-110">
+\newabbreviation{ksvm}{ksvm}{kernel&#x00A0;support&#x00A0;vector&#x00A0;machine}
+&#x00A0;<br />\newabbreviation
+&#x00A0;<br />&#x00A0;[seealso={ksvm}]
+&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+</div>
+<!--l. 2044--><p class="nopar" >
+</p><!--l. 2046--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the
+location list using the <span
+class="cmss-10">nonumberlist</span><a
+ id="dx1-9002"></a> package option, then the cross-reference
+will also be suppressed. With <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-9003"></a>, don&#8217;t use the <span
+class="cmss-10">nonumberlist</span><a
+ id="dx1-9004"></a> package
+option. Instead use the <span
+class="cmtt-10">save-locations=false </span>in the resource options. For
+example:
+
+
+
</p>
-<!--l. 1235--><p class="noindent" ><a
+ <div class="verbatim" id="verbatim-111">
+\usepackage[record,abbreviations,symbols]{glossaries-extra}
+&#x00A0;<br />\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
+&#x00A0;<br />&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
+&#x00A0;<br />]
+&#x00A0;<br />\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
+&#x00A0;<br />&#x00A0;type={abbreviations},%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
+&#x00A0;<br />&#x00A0;save-locations=false%&#x00A0;no&#x00A0;number&#x00A0;list&#x00A0;for&#x00A0;these&#x00A0;entries
+&#x00A0;<br />]
+&#x00A0;<br />\GlsXtrLoadResources[
+&#x00A0;<br />&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
+&#x00A0;<br />&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
+&#x00A0;<br />]
+</div>
+<!--l. 2068--><p class="nopar" >
+</p><!--l. 2070--><p class="noindent" >
+</p>
+<!--l. 2070--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a
id="sec:moreinfo"></a>Further Information</h3>
-<!--l. 1238--><p class="noindent" >Further information can be found in the main <span
+<!--l. 2073--><p class="noindent" >Further information can be found in the main <span
class="cmss-10">glossaries</span><a
id="dx1-10001"></a> <a
href="glossaries-user.html" >user manual</a> or in the
<a
-href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries FAQ</a>. There is also an <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" >article on the glossaries and glossaries-extra packages</a>
-on the <a
+href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries FAQ</a>. See also the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-10002"></a> package and the <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-10003"></a> document, both
+of which can be found on CTAN (<a
+href="http://ctan.org/pkg/glossaries-extra" class="url" ><span
+class="cmtt-10">http://ctan.org/pkg/glossaries-extra</span></a> and
+<a
+href="http://ctan.org/pkg/bib2gls" class="url" ><span
+class="cmtt-10">http://ctan.org/pkg/bib2gls</span></a>). There is also an <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" >article on the glossaries and
+glossaries-extra packages</a> on the <a
href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;Community&#8217;s</a> Know How section and a&#x00A0;chapter on the <span
+class="E">E</span>X</span></span>&#x00A0;Community&#8217;s</a> Know How section and
+a&#x00A0;chapter on the <span
class="cmss-10">glossaries</span><a
- id="dx1-10002"></a>
-package in <a
+ id="dx1-10004"></a> package in <a
href="http://www.dickimaw-books.com/latex/thesis/" >Using <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;to Write a PhD Thesis</a>. </p>
+class="E">E</span>X</span></span>&#x00A0;to Write a PhD Thesis</a>.
+</p><div class="footnotes"><!--l. 1031--><p class="noindent" ><span class="footnote-mark"><a
+href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span
+class="cmr-8">deprecated, use </span><span
+class="cmss-8">babel</span><a
+ id="dx1-5021"></a> <span
+class="cmr-8">instead</span></p> </div>
+
</body></html>