summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/glossaries/glossariesbegin.html
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-03-20 03:01:17 +0000
committerNorbert Preining <norbert@preining.info>2020-03-20 03:01:17 +0000
commitc720a4409b388fa706f3eb1ce275f76f7d49d996 (patch)
treed9e0864c856e4b7abba585785d57bbf02aa1f9ad /macros/latex/contrib/glossaries/glossariesbegin.html
parentc8b8ea37fe9cd71b53223dff23f291b2f158fc0f (diff)
CTAN sync 202003200301
Diffstat (limited to 'macros/latex/contrib/glossaries/glossariesbegin.html')
-rw-r--r--macros/latex/contrib/glossaries/glossariesbegin.html1131
1 files changed, 573 insertions, 558 deletions
diff --git a/macros/latex/contrib/glossaries/glossariesbegin.html b/macros/latex/contrib/glossaries/glossariesbegin.html
index d9d639897e..91e6cd7014 100644
--- a/macros/latex/contrib/glossaries/glossariesbegin.html
+++ b/macros/latex/contrib/glossaries/glossariesbegin.html
@@ -18,32 +18,32 @@
.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;}
-.cmtt-12{font-family: monospace;}
+.cmtt-12{font-size:120%;font-family: monospace,monospace;}
+.cmtt-12{font-family: monospace,monospace;}
+.cmtt-12{font-family: monospace,monospace;}
+.cmtt-12{font-family: monospace,monospace;}
.cmr-9{font-size:90%;}
.cmbx-9{font-size:90%; font-weight: bold;}
.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;}
+.cmtt-10{font-family: monospace,monospace;}
+.cmtt-10{font-family: monospace,monospace;}
+.cmtt-10{font-family: monospace,monospace;}
+.cmtt-10{font-family: monospace,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;}
-.cmtt-9{font-family: monospace;}
-.cmtt-9{font-family: monospace;}
-.cmitt-10{font-family: monospace; font-style: italic;}
+.cmtt-9{font-size:90%;font-family: monospace,monospace;}
+.cmtt-9{font-family: monospace,monospace;}
+.cmtt-9{font-family: monospace,monospace;}
+.cmtt-9{font-family: monospace,monospace;}
+.cmitt-10{font-family: monospace,monospace; font-style: italic;}
.cmbx-10{ font-weight: bold;}
.cmbx-10{ font-weight: bold;}
-.cmsy-9{font-size:90%;}
+.tcrm-0900{font-size:90%;}
.cmss-8{font-size:80%; font-family: sans-serif;}
.cmss-8{ font-family: sans-serif;}
.cmss-8{ font-family: sans-serif;}
@@ -114,11 +114,6 @@ table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
.hline td, .cline td{ padding: 0; }
.hline hr, .cline hr{border:none;border-top:1px solid black;}
.tabbing-right {text-align:right;}
-span.TEX {letter-spacing: -0.125em; }
-span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;}
-a span.TEX span.E {text-decoration: none; }
-span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;}
-span.LATEX span.TEX{ position:relative; left: -0.4em; }
div.float, div.figure {margin-left: auto; margin-right: auto;}
div.float img {text-align:center;}
div.figure img {text-align:center;}
@@ -248,22 +243,22 @@ span#textcolor40{color:#00FF00}
</style>
</head><body
>
-<!--l. 55--><p class="noindent" ><a
+<!--l. 59--><p class="noindent" ><a
id="top"></a>
-</p><!--l. 55--><p class="indent" >
+</p><!--l. 59--><p class="indent" >
-</p><!--l. 55--><p class="indent" >
+</p><!--l. 59--><p class="indent" >
</p>
<div class="center"
>
-<!--l. 55--><p class="noindent" >
-</p><!--l. 55--><p class="noindent" ><span
-class="cmr-17">The glossaries package v4.45: a guide for</span>
+<!--l. 59--><p class="noindent" >
+</p><!--l. 59--><p class="noindent" ><span
+class="cmr-17">The glossaries package v4.46: a guide for</span>
<span
class="cmr-17">beginners</span>
</p>
@@ -272,20 +267,25 @@ cellspacing="0" cellpadding="0"
><colgroup id="TBL-1-1g"><col
id="TBL-1-1" /></colgroup><tr
style="vertical-align:baseline;" id="TBL-1-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-1"
-class="td11"> <span
-class="cmr-12">Nicola L.C. Talbot </span></td></tr></table>
+class="td11"> <span
+class="cmr-12">Nicola L.C. Talbot </span></td>
+</tr><tr
+ style="vertical-align:baseline;" id="TBL-1-2-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-2-1"
+class="td11"> <a
+href="https://www.dickimaw-books.com/" ><span
+class="cmtt-12">dickimaw-books.com</span></a> </td></tr></table>
</div>
-<!--l. 55--><p class="noindent" ><span
-class="cmr-12">2020-02-13</span></p></div>
+<!--l. 59--><p class="noindent" ><span
+class="cmr-12">2020-03-19</span></p></div>
<div
class="abstract"
>
<div class="center"
>
-<!--l. 57--><p class="noindent" >
-</p><!--l. 57--><p class="noindent" ><span
+<!--l. 61--><p class="noindent" >
+</p><!--l. 61--><p class="noindent" ><span
class="cmbx-9">Abstract</span></p></div>
- <!--l. 58--><p class="indent" > <span
+ <!--l. 62--><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
@@ -304,7 +304,7 @@ 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. 67--><p class="indent" > <span
+ </p><!--l. 71--><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>
@@ -342,12 +342,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. 77--><p class="noindent" >
+<!--l. 81--><p class="noindent" >
</p>
-<!--l. 77--><p class="noindent" ><a
+<!--l. 81--><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. 80--><p class="noindent" >As with all packages, you need to load <span
+<!--l. 84--><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
@@ -367,7 +367,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. 87--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant
+</p><!--l. 91--><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
@@ -379,8 +379,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. 95--><p class="noindent" >
-</p><!--l. 97--><p class="indent" > Once you have loaded <span
+</p><!--l. 99--><p class="noindent" >
+</p><!--l. 101--><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:
@@ -396,10 +396,10 @@ example:
&#x00A0;<br />&#x00A0;Here's&#x00A0;my&#x00A0;\gls{ex}&#x00A0;term.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 110--><p class="nopar" > This produces:
+<!--l. 114--><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:
+ <!--l. 117--><p class="noindent" >Here&#8217;s my sample term.</p></div>
+<!--l. 119--><p class="noindent" >Here&#8217;s another example:
@@ -413,10 +413,10 @@ example:
&#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:
+<!--l. 132--><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
+ <!--l. 135--><p class="noindent" >First use: support vector machine (SVM). Second use: SVM.</p></div>
+<!--l. 137--><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
@@ -430,13 +430,13 @@ 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. 144--><p class="indent" > <div class="important" title="Important Note"> Be careful of fragile commands. If a command causes a problem when used in one
+</p><!--l. 148--><p class="indent" > <div class="important" title="Important Note"> Be careful of fragile commands. If a command causes a problem when used in one
of the <span
class="cmtt-10">\newglossaryentry </span>fields, consider adding <span
class="cmtt-10">\glsnoexpandfields </span>before you
start defining your entries. </div>
-</p><!--l. 148--><p class="noindent" >
-</p><!--l. 150--><p class="indent" > Abbreviations are slightly different if you use the extension package <span
+</p><!--l. 152--><p class="noindent" >
+</p><!--l. 154--><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):
@@ -453,10 +453,17 @@ class="cmss-10">glossaries-extra</span><a
&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 164--><p class="nopar" > If you still want to use <span
+<!--l. 168--><p class="nopar" > Since <span
+class="cmtt-10">long-short </span>happens to be the default for <span
+class="cmtt-10">\newabbreviation </span>(if you haven&#8217;t
+set the <span
+class="cmtt-10">category </span>key) you may omit the <span
+class="cmtt-10">\setabbreviationstyle </span>line in this
+example.
+</p><!--l. 173--><p class="indent" > 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">\newabbreviation</span>) then you
+need the optional argument of <span
class="cmtt-10">\setabbreviationstyle</span>:
@@ -471,13 +478,21 @@ class="cmtt-10">\setabbreviationstyle</span>:
&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 180--><p class="nopar" >
-</p><!--l. 181--><p class="indent" > <div class="important" title="Important Note"> You can&#8217;t use <span
+<!--l. 188--><p class="nopar" > In this example, if you omit the <span
+class="cmtt-10">\setabbreviationstyle </span>line you will notice a
+difference because the <span
+class="cmtt-10">short-nolong </span>style (not the <span
+class="cmtt-10">long-short </span>style) is the default
+with <span
+class="cmtt-10">\newacronym</span>. With the <span
+class="cmtt-10">short-nolong </span>style the first use simply shows just the
+short form.
+</p><!--l. 195--><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. 183--><p class="noindent" >
-</p><!--l. 185--><p class="indent" > If you like, you can put all your definitions in another file (for example,
+</p><!--l. 197--><p class="noindent" >
+</p><!--l. 199--><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
@@ -489,7 +504,7 @@ filename as the argument. For example:
<div class="verbatim" id="verbatim-5">
\loadglsentries{defns}
</div>
-<!--l. 190--><p class="nopar" > If you find you have a really large number of definitions that are hard to manage in a
+<!--l. 204--><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
@@ -497,7 +512,7 @@ class="cmtt-10">bib2gls</span><a
requires a <span
class="cmtt-10">.bib </span>format instead that can be managed by an application such as
JabRef.
-</p><!--l. 197--><p class="indent" > Don&#8217;t try inserting formatting commands into the definitions as they can interfere
+</p><!--l. 211--><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
@@ -519,7 +534,7 @@ style):
&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 215--><p class="nopar" > The abbreviation styles have a different naming scheme with <span
+<!--l. 229--><p class="nopar" > The abbreviation styles have a different naming scheme with <span
class="cmss-10">glossaries-extra</span><a
id="dx1-2009"></a>:
@@ -535,7 +550,7 @@ class="cmss-10">glossaries-extra</span><a
&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 230--><p class="nopar" > With <span
+<!--l. 244--><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
@@ -570,22 +585,22 @@ can be redefined for minor adjustments. For example:
&#x00A0;<br />&#x00A0;Next&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 268--><p class="nopar" > This produces:
+<!--l. 282--><p class="nopar" > This produces:
</p><div class="quote">
- <!--l. 271--><p class="noindent" >First use: support vector machine (<span
+ <!--l. 285--><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. 274--><p class="noindent" >Next use: <span
+ </p><!--l. 288--><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. 277--><p class="indent" > As you can hopefully see from the above examples, there are two main ways of
+<!--l. 291--><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
@@ -593,36 +608,38 @@ 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. 282--><p class="indent" > Regardless of the method of defining a term, the term is always given a label. In
+</p><!--l. 296--><p class="indent" > Regardless of the method of defining a term, the term is always given a
-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
+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>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">\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">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-2012"></a>) meddles with
-them. Don&#8217;t try using any characters outside of the basic Latin set with
-<span
+ id="dx1-2012"></a>) makes them active. 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. 297--><p class="indent" > <div class="important" title="Important Note"> Don&#8217;t use <span
+ 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. If you really
+need UTF-8 characters in your labels then you&#8217;ll need to use XeLaTeX&#x00A0;or
+LuaLaTeX.
+</p><!--l. 313--><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
@@ -632,14 +649,13 @@ class="cmtt-10">\glsentrylong </span>or <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>
+which provides special commands for use in section headings and captions, such as
<span
-class="cmtt-10">{</span>&#x27E8;<span
+class="cmtt-10">\glsfmtshort{</span>&#x27E8;<span
class="cmti-10">label</span>&#x27E9;<span
class="cmtt-10">}</span>. </div>
-</p><!--l. 304--><p class="noindent" >
-</p><!--l. 306--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes if you
+</p><!--l. 320--><p class="noindent" >
+</p><!--l. 322--><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
@@ -666,19 +682,19 @@ entries:
&#x00A0;<br />&#x00A0;\printunsrtglossaries&#x00A0;%&#x00A0;list&#x00A0;all&#x00A0;entries
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 332--><p class="nopar" > However this method doesn&#8217;t sort the entries (they&#8217;re listed in order of definition)
+<!--l. 348--><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. 339--><p class="indent" > The <span
+</p><!--l. 355--><p class="indent" > The <span
class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">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. 344--><p class="indent" > Note that this example document uses the same command (<span
+</p><!--l. 360--><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
@@ -691,11 +707,10 @@ 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. 350--><p class="indent" > Most users prefer to have an automatically sorted list that only contains entries
+</p><!--l. 366--><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
+class="cmss-10">glossaries </span>package provides three
+options: use TeX&#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
@@ -711,17 +726,17 @@ class="cmtt-10">bib2gls</span><a
id="dx1-2023"></a>
(<a
href="#option4">Option&#x00A0;4</a>).
-</p><!--l. 358--><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
+</p><!--l. 374--><p class="indent" > The first option (using TeX) 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 lower case
+character code (which matches basic Latin alphabets, such as English, but
+not extended Latin alphabets, such as Icelandic). To use this method, add
-example:
+<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:
@@ -743,21 +758,21 @@ example:
&#x00A0;<br />&#x00A0;\printnoidxglossaries
&#x00A0;<br />&#x00A0;\end{document}
</div>
-<!--l. 388--><p class="nopar" >
-</p><!--l. 390--><p class="indent" > <div class="important" title="Important Note"> The <span
+<!--l. 406--><p class="nopar" >
+</p><!--l. 408--><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. 394--><p class="noindent" >
-</p><!--l. 396--><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="cmtt-10">name </span>key. See <a
+href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml" >Glossaries Performance</a> for a
+comparison. </div>
+</p><!--l. 414--><p class="noindent" >
+</p><!--l. 416--><p class="indent" > Try this out and run LaTeX&#x00A0;(or pdfLaTeX) <span
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. 401--><p class="indent" > The glossary has a vertical gap between the &#8220;carrot&#8221; term and the &#8220;potato&#8221; term.
+</p><!--l. 421--><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
@@ -770,7 +785,7 @@ options:
<div class="verbatim" id="verbatim-11">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 407--><p class="nopar" > or you may want to try out a style that shows the group headings:
+<!--l. 427--><p class="nopar" > or you may want to try out a style that shows the group headings:
@@ -778,7 +793,7 @@ options:
<div class="verbatim" id="verbatim-12">
\usepackage[style=indexgroup]{glossaries}
</div>
-<!--l. 411--><p class="nopar" > If you try out this example you may also notice that the description is followed by a
+<!--l. 431--><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
@@ -793,7 +808,7 @@ option:
<div class="verbatim" id="verbatim-13">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--l. 421--><p class="nopar" > If you don&#8217;t like the terminating full stop, you can suppress that with the <span
+<!--l. 441--><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:
@@ -804,13 +819,13 @@ package option:
<div class="verbatim" id="verbatim-14">
\usepackage[nopostdot]{glossaries}
</div>
-<!--l. 426--><p class="nopar" >
-</p><!--l. 428--><p class="indent" > If you tried out the previous example with <span
+<!--l. 446--><p class="nopar" >
+</p><!--l. 448--><p class="indent" > If you try out the earlier 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
+you may notice that the terminating full stop is missing and there are no number
+lists. You can add the full stop back with
@@ -818,7 +833,7 @@ full stop back with
<div class="verbatim" id="verbatim-15">
\usepackage[nopostdot=false]{glossaries-extra}
</div>
-<!--l. 433--><p class="nopar" > or
+<!--l. 453--><p class="nopar" > or
@@ -826,15 +841,14 @@ full stop back with
<div class="verbatim" id="verbatim-16">
\usepackage[postdot]{glossaries-extra}
</div>
-<!--l. 437--><p class="nopar" > If you want the number lists then you need to use an indexing option.
-</p><!--l. 441--><p class="indent" > You may have noticed that I&#8217;ve used another command in the above example:
+<!--l. 457--><p class="nopar" > If you want the number lists then you need to use an indexing option.
+</p><!--l. 460--><p class="indent" > You may have noticed that I&#8217;ve used another command in the above examples:
<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. 447--><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
+</p><!--l. 466--><p class="indent" > As I mentioned earlier, using TeX&#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
@@ -854,28 +868,28 @@ 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
+class="tcrm-1000">&sect;</span>4 </a><a
href="#sec:printglossaries">Displaying
a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
-</p><!--l. 457--><p class="indent" > The rest of this document briefly describes the main commands provided by the
+</p><!--l. 476--><p class="indent" > The rest of this document briefly describes the main commands provided by the
<span
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. 462--><p class="noindent" >
+</p><!--l. 481--><p class="noindent" >
</p>
-<!--l. 462--><p class="noindent" ><a
+<!--l. 481--><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. 465--><p class="noindent" >When you use the <span
+<!--l. 484--><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, 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. 472--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
+</p><!--l. 491--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{</span>&#x27E8;<span
@@ -905,7 +919,7 @@ class="cmtt-10">}</span></span>
-<!--l. 480--><p class="noindent" >
+<!--l. 499--><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
@@ -914,11 +928,11 @@ 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. 488--><p class="indent" > This command is a &#8220;short&#8221; command, which means that &#x27E8;<span
+</p><!--l. 507--><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. 492--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
+</p><!--l. 511--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\longnewglossaryentry{</span>&#x27E8;<span
@@ -944,8 +958,8 @@ class="cmitt-10">description</span>&#x27E9;<span
class="cmtt-10">}</span>
</div>
</div> </div><hr>
-<!--l. 500--><p class="noindent" >
-</p><!--l. 502--><p class="indent" > Examples:
+<!--l. 519--><p class="noindent" >
+</p><!--l. 521--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-3003x1">Define the term &#8220;set&#8221; with the label <span
@@ -960,7 +974,7 @@ class="cmtt-10">set</span>:
&#x00A0;<br />&#x00A0;&#x00A0;description={a&#x00A0;collection&#x00A0;of&#x00A0;objects}
&#x00A0;<br />}
</div>
- <!--l. 511--><p class="nopar" >
+ <!--l. 530--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-3005x2">Define the symbol <span
@@ -976,7 +990,7 @@ class="cmtt-10">emptyset</span>:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;empty&#x00A0;set}
&#x00A0;<br />}
</div>
- <!--l. 521--><p class="nopar" > (This will also need a <span
+ <!--l. 540--><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.)
@@ -998,7 +1012,7 @@ class="cmtt-10">fishage</span>:
&#x00A0;<br />&#x00A0;&#x00A0;fish&#x00A0;species.
&#x00A0;<br />}
</div>
- <!--l. 538--><p class="nopar" > (The percent character discards the end of line character that would otherwise
+ <!--l. 557--><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
@@ -1019,7 +1033,7 @@ class="cmtt-10">&eacute;</span>). This first letter must be placed in a&#x00A0;g
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
- <!--l. 554--><p class="nopar" > or </p><div class="alltt">
+ <!--l. 573--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
@@ -1043,10 +1057,11 @@ class="cmtt-10">&#x00A0;class}</span></span>
class="cmtt-10">}</span></span>
</div>
</div></li></ol>
-<!--l. 564--><p class="noindent" >(For further details, see the section &#8220;UTF-8&#8221; of the <a
+<!--l. 583--><p class="noindent" >(This isn&#8217;t necessary for UTF-8 characters with XeLaTeX&#x00A0;or LuaLaTeX. 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. 567--><p class="indent" > If you use <span
+</p><!--l. 587--><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
@@ -1137,6 +1152,9 @@ 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
@@ -1145,9 +1163,6 @@ 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
@@ -1205,7 +1220,7 @@ package option:
<div class="verbatim" id="verbatim-21">
\usepackage[record]{glossaries-extra}
</div>
-<!--l. 604--><p class="nopar" > and the <span
+<!--l. 624--><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
@@ -1218,7 +1233,7 @@ preamble:
<div class="verbatim" id="verbatim-22">
\GlsXtrLoadResources[src={entries}]
</div>
-<!--l. 610--><p class="nopar" > You can have a comma-separated list. For example, if you also have entries defined
+<!--l. 630--><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>:
@@ -1226,10 +1241,10 @@ class="cmtt-10">entries2.bib</span>:
</p>
<div class="verbatim" id="verbatim-23">
-\GlsXtrLoadResources[src={entries,entries2.bib}]
+\GlsXtrLoadResources[src={entries,entries2}]
</div>
-<!--l. 615--><p class="nopar" >
-</p><!--l. 617--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span
+<!--l. 635--><p class="nopar" >
+</p><!--l. 637--><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
@@ -1238,7 +1253,7 @@ 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. 623--><p class="indent" > For example:
+</p><!--l. 643--><p class="indent" > For example:
@@ -1252,7 +1267,7 @@ class="cmtt-10">text </span>key as well.
&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
&#x00A0;<br />}
</div>
-<!--l. 632--><p class="nopar" > This will appear in the text as &#8220;Latin alphabet&#8221; but will be listed in the glossary
+<!--l. 652--><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
@@ -1270,8 +1285,8 @@ as:
&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
&#x00A0;<br />}
</div>
-<!--l. 644--><p class="nopar" >
-</p><!--l. 646--><p class="indent" > Another commonly used key is <span
+<!--l. 664--><p class="nopar" >
+</p><!--l. 666--><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,
@@ -1289,10 +1304,10 @@ class="cmtt-10">plural </span>key to override it:
&#x00A0;<br />&#x00A0;&#x00A0;description={canal&#x00A0;from&#x00A0;mouth&#x00A0;to&#x00A0;stomach}
&#x00A0;<br />}
</div>
-<!--l. 657--><p class="nopar" > (Remember from earlier that the initial ligature <span
+<!--l. 677--><p class="nopar" > (Remember from earlier that the initial ligature <span
class="cmtt-10">\oe </span>needs to be grouped.)
-</p><!--l. 661--><p class="indent" > Abbreviations can be defined using
-</p><!--l. 663--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 681--><p class="indent" > Abbreviations can be defined using:
+</p><!--l. 683--><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
@@ -1302,7 +1317,7 @@ 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. 664--><p class="noindent" >
+</p><!--l. 684--><p class="noindent" >
where &#x27E8;<span
class="cmti-10">label</span>&#x27E9; is the label (as per <span
class="cmtt-10">\newglossaryentry</span>), &#x27E8;<span
@@ -1316,7 +1331,7 @@ class="cmti-10">long</span>&#x27E9; is the long form. For example, the following
<div class="verbatim" id="verbatim-27">
\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 671--><p class="nopar" > This internally uses <span
+<!--l. 691--><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
@@ -1336,14 +1351,14 @@ the optional argument:
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 683--><p class="nopar" >
-</p><!--l. 685--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to
-specify which style to use with
-</p><!--l. 688--><p class="indent" > <hr><div title="Definition"><span
+<!--l. 703--><p class="nopar" >
+</p><!--l. 705--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to
+specify which style to use with:
+</p><!--l. 708--><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. 689--><p class="noindent" >
+</p><!--l. 709--><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
@@ -1360,13 +1375,13 @@ 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. 701--><p class="indent" > The <span
+</p><!--l. 721--><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. 705--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 725--><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
@@ -1376,17 +1391,17 @@ 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. 706--><p class="noindent" >
+</p><!--l. 726--><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. 710--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 730--><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. 711--><p class="noindent" >
+</p><!--l. 731--><p class="noindent" >
The default &#x27E8;<span
class="cmti-10">category</span>&#x27E9; is <span
class="cmtt-10">abbreviation</span>. If you use <span
@@ -1434,7 +1449,7 @@ class="cmtt-10">}</span>
class="cmsy-10">}</span>
</div>
</div>
-<!--l. 728--><p class="indent" > The plural forms for abbreviations can be specified using the <span
+<!--l. 748--><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:
@@ -1447,7 +1462,7 @@ class="cmtt-10">shortplural </span>keys. For example:
&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
</div>
-<!--l. 734--><p class="nopar" > or (with <span
+<!--l. 754--><p class="nopar" > or (with <span
class="cmss-10">glossaries-extra</span><a
id="dx1-3019"></a>):
@@ -1459,7 +1474,7 @@ class="cmss-10">glossaries-extra</span><a
&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
</div>
-<!--l. 740--><p class="nopar" > If omitted, the defaults are again obtained by appending an &#8220;s&#8221; to the singular
+<!--l. 760--><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
@@ -1475,8 +1490,8 @@ class="cmtt-10">.bib </span>file is:
&#x00A0;<br />&#x00A0;&#x00A0;longplural={diagonal&#x00A0;matrices}
&#x00A0;<br />}
</div>
-<!--l. 750--><p class="nopar" >
-</p><!--l. 752--><p class="indent" > It&#8217;s also possible to have both a&#x00A0;name and a&#x00A0;corresponding symbol.
+<!--l. 770--><p class="nopar" >
+</p><!--l. 772--><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
@@ -1493,7 +1508,7 @@ example:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 762--><p class="nopar" > or with <span
+<!--l. 782--><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:
@@ -1508,14 +1523,13 @@ class="cmtt-10">.bib </span>file is:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 770--><p class="nopar" >
-</p><!--l. 772--><p class="indent" > If you want the symbol in the <span
+<!--l. 790--><p class="nopar" >
+</p><!--l. 792--><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
+href="#option3">3</a> otherwise you&#8217;ll end up with errors from TeX&#x00A0;or <span
class="cmtt-10">xindy</span><a
id="dx1-3022"></a>. With
<a
@@ -1535,7 +1549,7 @@ order is a little odd. For example:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 784--><p class="nopar" > This displays the symbol as <span
+<!--l. 804--><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
@@ -1543,7 +1557,7 @@ class="cmss-10">glossaries-extra</span><a
class="cmss-10">symbols</span><a
id="dx1-3025"></a> package option which
provides
-</p><!--l. 790--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 810--><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
@@ -1551,7 +1565,7 @@ 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. 791--><p class="noindent" >
+</p><!--l. 811--><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
@@ -1574,8 +1588,8 @@ class="cmti-10">label</span>&#x27E9;. For example:
&#x00A0;<br />\printglossaries
&#x00A0;<br />\end{document}
</div>
-<!--l. 811--><p class="nopar" > Now the sort value is &#8220;emptyset&#8221; rather than the previous &#8220;empty set&#8221;.
-</p><!--l. 815--><p class="indent" > With <span
+<!--l. 831--><p class="nopar" > Now the sort value is &#8220;emptyset&#8221; rather than the previous &#8220;empty set&#8221;.
+</p><!--l. 835--><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
@@ -1589,7 +1603,7 @@ class="cmtt-10">.bib </span>file as
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 822--><p class="nopar" > in which case <span
+<!--l. 842--><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
@@ -1604,7 +1618,7 @@ value. Alternatively you can use:
&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
&#x00A0;<br />}
</div>
-<!--l. 830--><p class="nopar" > which will use the label (<span
+<!--l. 850--><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>
@@ -1625,20 +1639,34 @@ now:
&#x00A0;<br />\printunsrtglossaries
&#x00A0;<br />\end{document}
</div>
-<!--l. 847--><p class="nopar" >
-</p><!--l. 849--><p class="noindent" >
+<!--l. 867--><p class="nopar" >
+</p><!--l. 869--><p class="indent" > Note that while the <span
+class="cmtt-10">sort </span>key is advised for symbols when using <span
+class="cmtt-10">\makeglossaries </span>or
+<span
+class="cmtt-10">\makenoidxglossaries </span>it shouldn&#8217;t be used with <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3029"></a>. Instead, <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-3030"></a> has its
+own algorithm for determining the sort value based on the entry type (<span
+class="cmtt-10">@entry</span>,
+<span
+class="cmtt-10">@symbol </span>etc). See <a
+href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" >bib2gls gallery: sorting</a> for further details.
+</p><!--l. 877--><p class="noindent" >
</p>
-<!--l. 849--><p class="noindent" ><a
+<!--l. 877--><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. 852--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in
+<!--l. 880--><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. 856--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 884--><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. 857--><p class="noindent" >
+</p><!--l. 885--><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
@@ -1650,10 +1678,9 @@ class="cmtt-10">bib2gls</span><a
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
+ id="dx1-4002"></a> has created the relevant files and LaTeX&#x00A0;is
rerun.
-</p><!--l. 865--><p class="indent" > If you are using the <span
+</p><!--l. 893--><p class="indent" > If you are using the <span
class="cmss-10">hyperref</span><a
id="dx1-4003"></a> package (remember to load it before <span
class="cmss-10">glossaries</span>) <span
@@ -1664,7 +1691,7 @@ 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. 872--><p class="indent" > If the entry was defined as an acronym (using <span
+</p><!--l. 900--><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
@@ -1677,6 +1704,9 @@ 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
@@ -1685,33 +1715,30 @@ 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. 884--><p class="indent" > If you want the plural form, you can use:
-</p><!--l. 886--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 912--><p class="indent" > If you want the plural form, you can use:
+</p><!--l. 914--><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. 887--><p class="noindent" >
+</p><!--l. 915--><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. 891--><p class="indent" > If the term appears at the start of a&#x00A0;sentence, you can convert the first letter to
+</p><!--l. 919--><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. 894--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 922--><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. 895--><p class="noindent" >
+</p><!--l. 923--><p class="noindent" >
for the singular form or
-</p><!--l. 898--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 926--><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. 899--><p class="noindent" >
+</p><!--l. 927--><p class="noindent" >
for the plural form. For example:
@@ -1720,23 +1747,23 @@ for the plural form. For example:
<div class="verbatim" id="verbatim-39">
\Glspl{set}&#x00A0;are&#x00A0;collections.
</div>
-<!--l. 903--><p class="nopar" > produces &#8220;Sets are collections&#8221;.
-</p><!--l. 906--><p class="indent" > If you&#8217;ve specified a symbol using the <span
+<!--l. 931--><p class="nopar" > produces &#8220;Sets are collections&#8221;.
+</p><!--l. 934--><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. 909--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 937--><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. 910--><p class="noindent" >
-</p><!--l. 912--><p class="noindent" >
+</p><!--l. 938--><p class="noindent" >
+</p><!--l. 940--><p class="noindent" >
</p>
-<!--l. 912--><p class="noindent" ><a
+<!--l. 940--><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. 915--><p class="noindent" >In <a
+<!--l. 943--><p class="noindent" >In <a
href="#sec:start"><span
-class="cmsy-10">&sect;</span>1 </a><a
+class="tcrm-1000">&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 an automatically sorted glossary with the base <span
class="cmss-10">glossaries</span>
@@ -1755,7 +1782,7 @@ build</a>.
-<!--l. 925--><p class="indent" > <a
+<!--l. 953--><p class="indent" > <a
id="tab:optionsp+c"></a></p><hr class="float" /><div class="float"
>
@@ -1773,7 +1800,7 @@ 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:normal; text-align:left;" id="TBL-2-1-1"
-class="td11"> <!--l. 931--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
+class="td11"> <!--l. 959--><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
@@ -1792,7 +1819,7 @@ 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:normal; text-align:left;" id="TBL-2-2-1"
-class="td11"> <!--l. 933--><p class="noindent" >Requires
+class="td11"> <!--l. 961--><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"
@@ -1806,7 +1833,7 @@ 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:normal; text-align:left;" id="TBL-2-3-1"
-class="td11"> <!--l. 935--><p class="noindent" >Requires
+class="td11"> <!--l. 963--><p class="noindent" >Requires
an
external
application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
@@ -1820,7 +1847,7 @@ 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:normal; text-align:left;" id="TBL-2-4-1"
-class="td11"> <!--l. 937--><p class="noindent" >Requires
+class="td11"> <!--l. 965--><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"
@@ -1832,7 +1859,7 @@ 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:normal; text-align:left;" id="TBL-2-5-1"
-class="td11"> <!--l. 939--><p class="noindent" >Requires
+class="td11"> <!--l. 967--><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"
@@ -1844,7 +1871,7 @@ 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:normal; text-align:left;" id="TBL-2-6-1"
-class="td11"> <!--l. 941--><p class="noindent" >Can
+class="td11"> <!--l. 969--><p class="noindent" >Can
sort
extended
Latin
@@ -1861,7 +1888,7 @@ 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:normal; text-align:left;" id="TBL-2-7-1"
-class="td11"> <!--l. 944--><p class="noindent" >Efficient
+class="td11"> <!--l. 972--><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
@@ -1874,7 +1901,7 @@ 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:normal; text-align:left;" id="TBL-2-8-1"
-class="td11"> <!--l. 946--><p class="noindent" >Can
+class="td11"> <!--l. 974--><p class="noindent" >Can
use
different
sort
@@ -1892,7 +1919,7 @@ 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:normal; text-align:left;" id="TBL-2-9-1"
-class="td11"> <!--l. 948--><p class="noindent" >Any
+class="td11"> <!--l. 976--><p class="noindent" >Any
problematic
sort
values? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2"
@@ -1906,7 +1933,7 @@ 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:normal; text-align:left;" id="TBL-2-10-1"
-class="td11"> <!--l. 950--><p class="noindent" >Can
+class="td11"> <!--l. 978--><p class="noindent" >Can
form
ranges
in
@@ -1923,7 +1950,7 @@ 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:normal; text-align:left;" id="TBL-2-11-1"
-class="td11"> <!--l. 952--><p class="noindent" >Can
+class="td11"> <!--l. 980--><p class="noindent" >Can
have
non-standard
locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2"
@@ -1933,12 +1960,12 @@ 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="tcrm-0900">&#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. 955--><p class="noindent" ><sup class="textsuperscript"><span
-class="cmsy-9">&#8224;</span></sup> <span
+<!--l. 983--><p class="noindent" ><sup class="textsuperscript"><span
+class="tcrm-0900">&#8224;</span></sup> <span
class="cmr-8">Requires some setting up.</span>
@@ -1952,12 +1979,12 @@ class="description"><a
id="option1"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;1</span>:
- <!--l. 962--><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
+ <!--l. 990--><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 extended or 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</span><span
@@ -1974,18 +2001,18 @@ class="cmss-10">use</span><a
class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start
defining your entries, as described in <a
href="#sec:defterm"><span
-class="cmsy-10">&sect;</span>2 </a><a
+class="tcrm-1000">&sect;</span>2 </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>).
</li>
<li
class="enumerate" id="x1-5009x2">Put
- <!--l. 976--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 1004--><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. 977--><p class="noindent" >
+ </p><!--l. 1005--><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
@@ -1996,12 +2023,12 @@ 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. 984--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1012--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
- </p><!--l. 985--><p class="noindent" >
+ </p><!--l. 1013--><p class="noindent" >
to display all your glossaries (if you have more than one). This command
doesn&#8217;t have any arguments.
- </p><!--l. 989--><p class="noindent" >This option allows you to have different sort methods. For example:
+ </p><!--l. 1017--><p class="noindent" >This option allows you to have different sort methods. For example:
@@ -2010,15 +2037,13 @@ class="cmtt-10">\printnoidxglossaries </span></div><hr>
\printnoidxglossary[sort=word]%&#x00A0;main&#x00A0;glossary
&#x00A0;<br />\printnoidxglossary[type=symbols,sort=use]%&#x00A0;symbols&#x00A0;glossary
</div>
- <!--l. 994--><p class="nopar" >
+ <!--l. 1022--><p class="nopar" >
</p></li>
<li
- 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
+ class="enumerate" id="x1-5011x3">Run LaTeX&#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>
- <!--l. 1000--><p class="noindent" >Here&#8217;s a complete document (<span
+ or &#8220;PDFLaTeX&#8221; button in your editor.</li></ol>
+ <!--l. 1028--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
@@ -2035,7 +2060,7 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />\printnoidxglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;indexed&#x00A0;entries
&#x00A0;<br />\end{document}
</div>
- <!--l. 1016--><p class="nopar" > Document build:
+ <!--l. 1044--><p class="nopar" > Document build:
@@ -2044,28 +2069,25 @@ class="cmtt-10">myDoc.tex</span>):
pdflatex&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1021--><p class="nopar" >
+ <!--l. 1049--><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. 1025--><p class="noindent" >This option uses an application called <span
+ <!--l. 1053--><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
+ application comes with all modern TeX&#x00A0;distributions, but it&#8217;s hard-coded for
+ the non-extended Latin alphabet. This process involves making LaTeX&#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
+ glossary. LaTeX&#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
@@ -2092,7 +2114,7 @@ class="cmtt-10">\GlsSetQuote </span>to change this to some other character.
<div class="verbatim" id="verbatim-43">
\GlsSetQuote{+}
</div>
- <!--l. 1044--><p class="nopar" > Use this as soon as possible after you&#8217;ve loaded the <span
+ <!--l. 1072--><p class="nopar" > Use this as soon as possible after you&#8217;ve loaded the <span
class="cmss-10">glossaries</span>
package.
</p></li>
@@ -2103,21 +2125,21 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini
</li>
<li
class="enumerate" id="x1-5025x3">Put
- <!--l. 1053--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 1081--><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. 1054--><p class="noindent" >
+ </p><!--l. 1082--><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. 1059--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1087--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 1060--><p class="noindent" >
+ </p><!--l. 1088--><p class="noindent" >
which will display all glossaries (if you have more than one). This
command doesn&#8217;t have any arguments.
- </p><!--l. 1064--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified
+ </p><!--l. 1092--><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</span><span
class="cmtt-10">=</span><span
@@ -2132,21 +2154,19 @@ class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
id="dx1-5028"></a>. </div>
- </p><!--l. 1069--><p class="noindent" >
+ </p><!--l. 1097--><p class="noindent" >
</p></li>
<li
- 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
-class="cmtt-10">.ist </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;document is called
- <span
-class="cmtt-10">myDoc.tex</span>, then you&#8217;ll have two extra files called <span
-class="cmtt-10">myDoc.glo </span>and
- <span
-class="cmtt-10">myDoc.ist</span>). If you look at your document at this point, you won&#8217;t see the
- glossary as it hasn&#8217;t been created yet.
+ class="enumerate" id="x1-5030x4">Run LaTeX&#x00A0;on your document. This creates files with the extensions <span
+class="cmtt-10">.glo</span>
+ and <span
+class="cmtt-10">.ist </span>(for example, if your LaTeX&#x00A0;document is called <span
+class="cmtt-10">myDoc.tex</span>, then
+ you&#8217;ll have two extra files called <span
+class="cmtt-10">myDoc.glo </span>and <span
+class="cmtt-10">myDoc.ist</span>). If you look
+ at your document at this point, you won&#8217;t see the glossary as it hasn&#8217;t
+ been created yet.
</li>
<li
class="enumerate" id="x1-5032x5">Run <span
@@ -2163,12 +2183,11 @@ class="cmtt-10">.tex</span>) extension. If you have access to a terminal or a co
<div class="verbatim" id="verbatim-44">
makeglossaries&#x00A0;myDoc
</div>
- <!--l. 1085--><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
- 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
+ <!--l. 1113--><p class="nopar" > (Replace <span
+class="cmtt-10">myDoc </span>with the base name of your LaTeX&#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:
@@ -2178,18 +2197,17 @@ class="cmtt-10">makeglossaries-lite</span><a
<div class="verbatim" id="verbatim-45">
makeglossaries-lite&#x00A0;myDoc
</div>
- <!--l. 1092--><p class="nopar" >
- </p><!--l. 1094--><p class="noindent" ><div class="important" title="Important Note"> Some beginners get confused by <span
+ <!--l. 1120--><p class="nopar" >
+ </p><!--l. 1122--><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
+class="cmtt-10">\makeglossaries </span>the LaTeX&#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. 1100--><p class="noindent" >
- </p><!--l. 1102--><p class="noindent" >If you don&#8217;t know how to use the command prompt, then you can
+ </p><!--l. 1128--><p class="noindent" >
+ </p><!--l. 1130--><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
@@ -2197,10 +2215,13 @@ class="cmtt-10">makeglossaries</span><a
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
+ to check your editor&#8217;s manual. (There are some guidelines in <a
+href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating
+ makeglossaries or makeglossaries-lite or bib2gls into the document
+ build</a>.) If you still have problems, try adding the <span
class="cmss-10">automake</span><a
- id="dx1-5038"></a> package option:
+ id="dx1-5038"></a> package
+ option:
@@ -2208,8 +2229,8 @@ class="cmss-10">automake</span><a
<div class="verbatim" id="verbatim-46">
\usepackage[automake]{glossaries}
</div>
- <!--l. 1112--><p class="nopar" >
- </p><!--l. 1114--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
+ <!--l. 1144--><p class="nopar" >
+ </p><!--l. 1146--><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="cmss-10">order</span><span
class="cmtt-10">=</span><span
@@ -2223,13 +2244,12 @@ class="cmss-10">letter</span><a
<div class="verbatim" id="verbatim-47">
\usepackage[order=letter]{glossaries}
</div>
- <!--l. 1119--><p class="nopar" >
+ <!--l. 1151--><p class="nopar" >
</p></li>
<li
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>
- <!--l. 1124--><p class="noindent" >Here&#8217;s a complete document (<span
+ LaTeX&#x00A0;on your document again.</li></ol>
+ <!--l. 1156--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
@@ -2246,7 +2266,7 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;makeindex
&#x00A0;<br />\end{document}
</div>
- <!--l. 1140--><p class="nopar" > Document build:
+ <!--l. 1172--><p class="nopar" > Document build:
@@ -2256,7 +2276,7 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />makeglossaries&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1146--><p class="nopar" > or
+ <!--l. 1178--><p class="nopar" > or
@@ -2266,36 +2286,32 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />makeglossaries-lite&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1152--><p class="nopar" >
+ <!--l. 1184--><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. 1157--><p class="noindent" >This option uses an application called <span
+ <!--l. 1189--><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><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>.
+ or non-Latin alphabets. It comes with both TeX&#x00A0;Live and MiKTeX.
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
+ LaTeX&#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
+ the glossary. LaTeX&#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
@@ -2317,7 +2333,7 @@ class="cmss-10">glossaries</span><a
<div class="verbatim" id="verbatim-51">
\usepackage[xindy]{glossaries}
</div>
- <!--l. 1176--><p class="nopar" >
+ <!--l. 1208--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5054x2">Add <span
@@ -2326,19 +2342,19 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini
</li>
<li
class="enumerate" id="x1-5056x3">Put
- <!--l. 1183--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 1215--><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. 1184--><p class="noindent" >
+ </p><!--l. 1216--><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. 1189--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1221--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 1190--><p class="noindent" >
- </p><!--l. 1192--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified
+ </p><!--l. 1222--><p class="noindent" >
+ </p><!--l. 1224--><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</span><span
class="cmtt-10">=</span><span
@@ -2353,21 +2369,19 @@ class="cmss-10">sort</span><span
class="cmtt-10">=</span><span
class="cmss-10">def</span><a
id="dx1-5059"></a>. </div>
- </p><!--l. 1197--><p class="noindent" >
+ </p><!--l. 1229--><p class="noindent" >
</p></li>
<li
- 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
-class="cmtt-10">.xdy </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;document is called
- <span
-class="cmtt-10">myDoc.tex</span>, then you&#8217;ll have two extra files called <span
-class="cmtt-10">myDoc.glo </span>and
- <span
-class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, you won&#8217;t see the
- glossary as it hasn&#8217;t been created yet.
+ class="enumerate" id="x1-5061x4">Run LaTeX&#x00A0;on your document. This creates files with the extensions <span
+class="cmtt-10">.glo</span>
+ and <span
+class="cmtt-10">.xdy </span>(for example, if your LaTeX&#x00A0;document is called <span
+class="cmtt-10">myDoc.tex</span>, then
+ you&#8217;ll have two extra files called <span
+class="cmtt-10">myDoc.glo </span>and <span
+class="cmtt-10">myDoc.xdy</span>). If you look
+ at your document at this point, you won&#8217;t see the glossary as it hasn&#8217;t
+ been created yet.
</li>
<li
class="enumerate" id="x1-5063x5">Run <span
@@ -2384,17 +2398,16 @@ class="cmtt-10">.tex </span>extension). If you have access to a terminal or a co
<div class="verbatim" id="verbatim-52">
makeglossaries&#x00A0;myDoc
</div>
- <!--l. 1213--><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
- 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
+ <!--l. 1245--><p class="nopar" > (Replace <span
+class="cmtt-10">myDoc </span>with the base name of your LaTeX&#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. 1221--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
+ </p><!--l. 1253--><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:
@@ -2405,14 +2418,13 @@ class="cmtt-10">order=letter </span>package
<div class="verbatim" id="verbatim-53">
\usepackage[xindy,order=letter]{glossaries}
</div>
- <!--l. 1227--><p class="nopar" >
+ <!--l. 1259--><p class="nopar" >
</p></li>
<li
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.
+ LaTeX&#x00A0;on your document again.
</li></ol>
- <!--l. 1233--><p class="noindent" >Here&#8217;s a complete document (<span
+ <!--l. 1265--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
@@ -2429,7 +2441,7 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;xindy
&#x00A0;<br />\end{document}
</div>
- <!--l. 1249--><p class="nopar" > Document build:
+ <!--l. 1281--><p class="nopar" > Document build:
@@ -2439,23 +2451,21 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />makeglossaries&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1255--><p class="nopar" >
+ <!--l. 1287--><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. 1259--><p class="noindent" >This requires the extension package <span
+ <!--l. 1291--><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
+ alphabets. It comes with both TeX&#x00A0;Live and MiKTeX&#x00A0;but requires at least
+ Java&#x00A0;8. This method works differently to Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>. Instead of
creating a file containing the code to typeset the glossary it creates a
@@ -2482,17 +2492,17 @@ class="cmss-10">glossaries-extra</span><a
<div class="verbatim" id="verbatim-56">
\usepackage[record]{glossaries-extra}
</div>
- <!--l. 1278--><p class="nopar" >
+ <!--l. 1310--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5075x2">Add one or more
- <!--l. 1282--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 1314--><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. 1283--><p class="noindent" >
+ </p><!--l. 1315--><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
@@ -2530,7 +2540,7 @@ class="cmtt-10">.bib </span>files containing the
&#x00A0;<br />&#x00A0;&#x00A0;sort={double}%&#x00A0;double-precision&#x00A0;sort
&#x00A0;<br />]
</div>
- <!--l. 1315--><p class="nopar" > The last resource set assumes that the entries defined in the file
+ <!--l. 1347--><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
@@ -2546,37 +2556,36 @@ class="cmtt-10">user1 </span>field. For
&#x00A0;<br />&#x00A0;&#x00A0;user1={3.141592654}
&#x00A0;<br />}
</div>
- <!--l. 1325--><p class="nopar" >
+ <!--l. 1357--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5077x3">Put
- <!--l. 1329--><p class="noindent" ><hr><div title="Definition"><span
+ <!--l. 1361--><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. 1330--><p class="noindent" >
+ </p><!--l. 1362--><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. 1336--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 1368--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printunsrtglossaries </span></div><hr>
- </p><!--l. 1337--><p class="noindent" >
+ </p><!--l. 1369--><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="enumerate" id="x1-5079x4">Run LaTeX&#x00A0;on your document. The <span
class="cmss-10">record</span><a
- id="dx1-5080"></a> option adds information to
- the <span
+ 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
+ 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>:
@@ -2584,7 +2593,7 @@ class="cmtt-10">myDoc.tex</span>:
<div class="verbatim" id="verbatim-59">
pdflatex&#x00A0;myDoc
</div>
- <!--l. 1345--><p class="nopar" >
+ <!--l. 1377--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5083x5">Run <span
@@ -2596,7 +2605,7 @@ class="cmtt-10">bib2gls</span><a
<div class="verbatim" id="verbatim-60">
bib2gls&#x00A0;myDoc
</div>
- <!--l. 1350--><p class="nopar" > or (if you need letter groups)
+ <!--l. 1382--><p class="nopar" > or (if you need letter groups)
@@ -2604,12 +2613,11 @@ class="cmtt-10">bib2gls</span><a
<div class="verbatim" id="verbatim-61">
bib2gls&#x00A0;--group&#x00A0;myDoc
</div>
- <!--l. 1354--><p class="nopar" >
+ <!--l. 1386--><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. 1358--><p class="noindent" >Here&#8217;s a complete document (<span
+ class="enumerate" id="x1-5086x6">Run LaTeX&#x00A0;again.</li></ol>
+ <!--l. 1390--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
@@ -2630,7 +2638,7 @@ class="cmtt-10">myDoc.tex</span>):
&#x00A0;<br />\printunsrtglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;defined&#x00A0;entries
&#x00A0;<br />\end{document}
</div>
- <!--l. 1378--><p class="nopar" > The accompanying <span
+ <!--l. 1410--><p class="nopar" > The accompanying <span
class="cmtt-10">entries.bib </span>file:
@@ -2642,7 +2650,7 @@ class="cmtt-10">entries.bib </span>file:
&#x00A0;<br />&#x00A0;&#x00A0;description&#x00A0;=&#x00A0;{an&#x00A0;example}
&#x00A0;<br />}
</div>
- <!--l. 1385--><p class="nopar" > Document build:
+ <!--l. 1417--><p class="nopar" > Document build:
@@ -2652,10 +2660,10 @@ class="cmtt-10">entries.bib </span>file:
&#x00A0;<br />bib2gls&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1391--><p class="nopar" >
+ <!--l. 1423--><p class="nopar" >
</p>
</dd></dl>
-<!--l. 1395--><p class="indent" > If you are having difficulty integrating <span
+<!--l. 1427--><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
@@ -2678,7 +2686,7 @@ class="cmtt-10">myDoc.tex </span>might start with:
&#x00A0;<br />&#x00A0;\usepackage{glossaries}
&#x00A0;<br />&#x00A0;\makeglossaries
</div>
-<!--l. 1408--><p class="nopar" > then to build the document you just need the single system call:
+<!--l. 1440--><p class="nopar" > then to build the document you just need the single system call:
@@ -2686,20 +2694,17 @@ class="cmtt-10">myDoc.tex </span>might start with:
<div class="verbatim" id="verbatim-66">
&#x00A0;arara&#x00A0;myDoc
</div>
-<!--l. 1412--><p class="nopar" > (The currently pending version 4.0 of <span
+<!--l. 1444--><p class="nopar" > (As from version 4.0, <span
class="cmtt-10">arara</span><a
- id="dx1-5090"></a> has directives for <span
+ id="dx1-5090"></a> also has directives for <span
class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-5091"></a>
-and <span
+ 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. 1419--><p class="indent" > When sorting the entries, the string comparisons are made according to each
+ id="dx1-5092"></a>. See the <span
+class="cmtt-10">arara</span><a
+ id="dx1-5093"></a> manual for further details.)
+</p><!--l. 1449--><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
@@ -2715,7 +2720,7 @@ earlier definition:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />&#x00A0;}
</div>
-<!--l. 1429--><p class="nopar" > No <span
+<!--l. 1459--><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
@@ -2769,10 +2774,9 @@ class="cmbx-10">&#x00A0;3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><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. If stripping all commands leads to an empty string
+ id="dx1-5096"></a> disregards LaTeX&#x00A0;commands so it sorts on <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
@@ -2782,7 +2786,7 @@ class="cmtt-10">sort </span>value that <span
class="cmtt-10">xindy</span><a
id="dx1-5098"></a> will
accept.
- <!--l. 1455--><p class="noindent" ><div class="important" title="Important Note"> <span
+ <!--l. 1485--><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
@@ -2791,7 +2795,7 @@ class="cmtt-10">xindy</span><a
class="cmtt-10">xindy</span><a
id="dx1-5101"></a>
has stripped all commands and braces. </div>
- </p><!--l. 1460--><p class="noindent" >
+ </p><!--l. 1490--><p class="noindent" >
</p></dd><dt class="description">
<a
href="#option4"><span
@@ -2800,8 +2804,7 @@ 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
+ id="dx1-5102"></a> has a primitive LaTeX&#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
@@ -2811,7 +2814,7 @@ class="cmtt-10">lite</span>. It disregards unknown
class="cmtt-10">bib2gls</span><a
id="dx1-5103"></a> doesn&#8217;t mind
that.
- <!--l. 1469--><p class="noindent" >Note that even if the name is given as <span class="obeylines-h"><span class="verb"><span
+ <!--l. 1499--><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 É
@@ -2822,14 +2825,18 @@ class="cmtt-10">--group</span></span></span> switch is used) may end up with the
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
+ id="dx1-5104"></a> or by switching to a LaTeX&#x00A0;engine with native UTF-8
support.
+ </p><!--l. 1506--><p class="noindent" >There&#8217;s more information on how <span
+class="cmtt-10">bib2gls</span><a
+ id="dx1-5105"></a> obtains the sort value in <a
+href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" >bib2gls
+ gallery: sorting</a>.
</p>
</dd></dl>
-<!--l. 1479--><p class="indent" > If the <span
+<!--l. 1513--><p class="indent" > If the <span
class="cmss-10">inputenc</span><a
- id="dx1-5105"></a> package is used:
+ id="dx1-5106"></a> package is used:
@@ -2837,7 +2844,7 @@ class="cmss-10">inputenc</span><a
<div class="verbatim" id="verbatim-68">
&#x00A0;\usepackage[utf8]{inputenc}
</div>
-<!--l. 1482--><p class="nopar" > and the entry is defined as: </p><div class="alltt">
+<!--l. 1516--><p class="nopar" > and the entry is defined as: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">&#x00A0;</span><span class="verb"><span
@@ -2877,7 +2884,7 @@ class="cmtt-10">elite </span>so the entry
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-5106"></a> package
+ id="dx1-5107"></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
@@ -2892,7 +2899,7 @@ class="cmbx-10">&#x00A0;2</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">makeindex</span><a
- id="dx1-5107"></a> sees <span
+ id="dx1-5108"></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
@@ -2906,7 +2913,7 @@ class="cmbx-10">&#x00A0;3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">xindy</span><a
- id="dx1-5108"></a> will correctly recognise the sort value <span
+ id="dx1-5109"></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.
@@ -2920,16 +2927,16 @@ 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-5109"></a> package doesn&#8217;t affect the encoding used with <span
+ id="dx1-5110"></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
+ (although the labels must still be ASCII unless you use XeLaTeX/LuaLaTeX).
+ 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">
+ id="dx1-5111"></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
@@ -2940,9 +2947,9 @@ class="cmtt-10">&#x00A0;UTF-8</span>
</div>
</div>
- <!--l. 1522--><p class="noindent" >With the correct encoding set up, <span
+ <!--l. 1556--><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
+ id="dx1-5112"></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
@@ -2955,21 +2962,21 @@ class="cmtt-10">lite </span>in the
group.
</p>
</dd></dl>
-<!--l. 1531--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is
+<!--l. 1565--><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
+ id="dx1-5113"></a> (<a
href="#option3">Option&#x00A0;3</a>) or <span
class="cmtt-10">bib2gls</span><a
- id="dx1-5113"></a> (<a
+ id="dx1-5114"></a> (<a
href="#option4">Option&#x00A0;4</a>) with the <span
class="cmss-10">inputenc</span><a
- id="dx1-5114"></a> or <span
+ id="dx1-5115"></a> or <span
class="cmss-10">fontspec</span><a
- id="dx1-5115"></a>
+ id="dx1-5116"></a>
package. If you use <span
class="cmtt-10">makeindex</span><a
- id="dx1-5116"></a> (<a
+ id="dx1-5117"></a> (<a
href="#option2">Option&#x00A0;2</a>) you need to specify the <span
class="cmtt-10">sort </span>key like
this:
@@ -2985,7 +2992,7 @@ this:
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
-<!--l. 1543--><p class="nopar" > or </p><div class="alltt">
+<!--l. 1577--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry</span><span
@@ -3029,7 +3036,7 @@ 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.
-<!--l. 1557--><p class="indent" > If you use <a
+<!--l. 1591--><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 or commands (such
as <span
@@ -3048,12 +3055,12 @@ example:
&#x00A0;\newglossaryentry{P}{name={\P},sort={P},
&#x00A0;<br />&#x00A0;&#x00A0;description={paragraph&#x00A0;symbol}}
</div>
-<!--l. 1564--><p class="nopar" >
+<!--l. 1598--><p class="nopar" >
</p>
-<!--l. 1566--><p class="noindent" ><a
+<!--l. 1600--><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. 1569--><p class="noindent" >The default glossary style uses the <span
+<!--l. 1603--><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.
@@ -3069,14 +3076,14 @@ class="cmtt-10">\glsnamefont</span>:
<div class="verbatim" id="verbatim-71">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
</div>
-<!--l. 1576--><p class="nopar" > Some classes and packages redefine the <span
+<!--l. 1610--><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. 1582--><p class="indent" > By default, a&#x00A0;full stop is appended to the description (unless you use
+</p><!--l. 1616--><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
@@ -3090,7 +3097,7 @@ option:
<div class="verbatim" id="verbatim-72">
\usepackage[nopostdot]{glossaries}
</div>
-<!--l. 1587--><p class="nopar" > or to add it with <span
+<!--l. 1621--><p class="nopar" > or to add it with <span
class="cmss-10">glossaries-extra</span>:
@@ -3099,8 +3106,8 @@ class="cmss-10">glossaries-extra</span>:
<div class="verbatim" id="verbatim-73">
\usepackage[postdot]{glossaries-extra}
</div>
-<!--l. 1591--><p class="nopar" >
-</p><!--l. 1593--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry (unless you use
+<!--l. 1625--><p class="nopar" >
+</p><!--l. 1627--><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
@@ -3110,7 +3117,7 @@ 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
+class="tcrm-1000">&sect;</span>4 </a><a
href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a> or <a
href="#option4">Option&#x00A0;4</a> (with
<span
@@ -3135,19 +3142,20 @@ option:
<div class="verbatim" id="verbatim-74">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--l. 1605--><p class="nopar" > or with <span
+<!--l. 1639--><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. 1611--><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
+</p><!--l. 1645--><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 for most of
+the predefined styles. You can suppress this with the <span
class="cmss-10">nogroupskip</span><a
- id="dx1-6012"></a> package option:
+ id="dx1-6012"></a> package
+option:
@@ -3155,14 +3163,14 @@ class="cmss-10">nogroupskip</span><a
<div class="verbatim" id="verbatim-75">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 1617--><p class="nopar" >
-</p><!--l. 1619--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
+<!--l. 1651--><p class="nopar" >
+</p><!--l. 1653--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
using:
-</p><!--l. 1622--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1656--><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. 1623--><p class="noindent" >
+</p><!--l. 1657--><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
@@ -3175,7 +3183,7 @@ a&#x00A0;style that suits your document. For example:
<div class="verbatim" id="verbatim-76">
\setglossarystyle{index}
</div>
-<!--l. 1631--><p class="nopar" > You can also use the <span
+<!--l. 1665--><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:
@@ -3185,8 +3193,8 @@ class="cmss-10">style</span><a
<div class="verbatim" id="verbatim-77">
\usepackage[style=index]{glossaries}
</div>
-<!--l. 1636--><p class="nopar" >
-</p><!--l. 1638--><p class="indent" > Examples:
+<!--l. 1670--><p class="nopar" >
+</p><!--l. 1672--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-6015x1">You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief
@@ -3202,7 +3210,7 @@ class="cmss-10">glossary-mcols</span><a
&#x00A0;<br />\usepackage{glossary-mcols}
&#x00A0;<br />\setglossarystyle{mcolindex}
</div>
- <!--l. 1647--><p class="nopar" > or
+ <!--l. 1681--><p class="nopar" > or
@@ -3210,7 +3218,7 @@ class="cmss-10">glossary-mcols</span><a
<div class="verbatim" id="verbatim-79">
\usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra}
</div>
- <!--l. 1651--><p class="nopar" >
+ <!--l. 1685--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6018x2">You have entries where the name is a&#x00A0;word or phrase and the description spans
@@ -3222,7 +3230,7 @@ class="cmss-10">glossary-mcols</span><a
\usepackage[nopostdot]{glossaries}
&#x00A0;<br />\setglossarystyle{altlist}
</div>
- <!--l. 1659--><p class="nopar" > or
+ <!--l. 1693--><p class="nopar" > or
@@ -3230,7 +3238,7 @@ class="cmss-10">glossary-mcols</span><a
<div class="verbatim" id="verbatim-81">
\usepackage[stylemods,style=altlist]{glossaries-extra}
</div>
- <!--l. 1663--><p class="nopar" >
+ <!--l. 1697--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6020x3">You have entries where the name is a&#x00A0;single word, the description is
@@ -3241,20 +3249,18 @@ class="cmss-10">glossary-mcols</span><a
<div class="verbatim" id="verbatim-82">
- \usepackage[nopostdot,nonumberlist]{glossaries}
- &#x00A0;<br />\setglossarystyle{long4col}
+ \usepackage[nopostdot,nonumberlist,style=long4col]{glossaries}
</div>
- <!--l. 1672--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
+ <!--l. 1705--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
</p>
<div class="verbatim" id="verbatim-83">
- \usepackage[nopostdot,nonumberlist]{glossaries}
- &#x00A0;<br />\setglossarystyle{tree}
+ \usepackage[nopostdot,nonumberlist,style=tree]{glossaries}
</div>
- <!--l. 1677--><p class="nopar" ></p></li></ol>
-<!--l. 1680--><p class="indent" > If your glossary consists of a&#x00A0;list of abbreviations and you also want to specify
+ <!--l. 1709--><p class="nopar" ></p></li></ol>
+<!--l. 1712--><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
@@ -3266,7 +3272,7 @@ style:
<div class="verbatim" id="verbatim-84">
\setacronymstyle{long-short-desc}
</div>
-<!--l. 1686--><p class="nopar" > Define the acronyms with a&#x00A0;description:
+<!--l. 1718--><p class="nopar" > Define the acronyms with a&#x00A0;description:
@@ -3276,7 +3282,7 @@ style:
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 1692--><p class="nopar" > Alternatively with <span
+<!--l. 1724--><p class="nopar" > Alternatively with <span
class="cmss-10">glossaries-extra</span><a
id="dx1-6021"></a>:
@@ -3289,8 +3295,8 @@ class="cmss-10">glossaries-extra</span><a
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 1700--><p class="nopar" >
-</p><!--l. 1702--><p class="indent" > Choose a&#x00A0;glossary style that suits wide entry names. For example:
+<!--l. 1732--><p class="nopar" >
+</p><!--l. 1734--><p class="indent" > Choose a&#x00A0;glossary style that suits wide entry names. For example:
@@ -3298,25 +3304,25 @@ class="cmss-10">glossaries-extra</span><a
<div class="verbatim" id="verbatim-87">
\setglossarystyle{altlist}
</div>
-<!--l. 1705--><p class="nopar" >
-</p><!--l. 1707--><p class="noindent" >
+<!--l. 1737--><p class="nopar" >
+</p><!--l. 1739--><p class="noindent" >
</p>
-<!--l. 1707--><p class="noindent" ><a
+<!--l. 1739--><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. 1710--><p class="noindent" >The <span
+<!--l. 1742--><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
(using one of the commands described in <a
href="#sec:defterm"><span
-class="cmsy-10">&sect;</span>2 </a><a
+class="tcrm-1000">&sect;</span>2 </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>), that entry is
automatically assigned to the default glossary, unless you indicate otherwise using the
<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. 1717--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1749--><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
@@ -3328,7 +3334,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. 1718--><p class="noindent" >
+</p><!--l. 1750--><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
@@ -3344,7 +3350,7 @@ class="cmtt-10">makeindex</span><a
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
+class="tcrm-1000">&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 (or <span
@@ -3354,26 +3360,27 @@ 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. 1732--><p class="indent" > <hr><div title="Definition"><span
+arguments aren&#8217;t relevant, in which case you may prefer to use the starred version
+where you don&#8217;t specify the extensions:
+</p><!--l. 1764--><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. 1733--><p class="noindent" >
-</p><!--l. 1735--><p class="indent" > In the case of Options&#x00A0;<a
+</p><!--l. 1765--><p class="noindent" >
+</p><!--l. 1767--><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>. (Entries definitions should come after <span
+class="cmtt-10">\makeglossaries</span>. (<span
+class="cmti-10">Entry </span>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. 1740--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
+</p><!--l. 1772--><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-7005"></a> package provides the package option <span
@@ -3389,7 +3396,7 @@ class="cmss-10">acronyms</span><a
<div class="verbatim" id="verbatim-88">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
-<!--l. 1746--><p class="nopar" > The option also changes the behaviour of <span
+<!--l. 1778--><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. The
<span
@@ -3401,7 +3408,7 @@ 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. 1754--><p class="indent" > There are some other package options for creating commonly used lists: <span
+</p><!--l. 1786--><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
@@ -3415,7 +3422,7 @@ 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. 1759--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
+</p><!--l. 1791--><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:
@@ -3425,7 +3432,7 @@ a&#x00A0;list of notation:
&#x00A0;\usepackage[acronyms]{glossaries}
&#x00A0;<br />&#x00A0;\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1764--><p class="nopar" > After <span
+<!--l. 1796--><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:
@@ -3448,7 +3455,7 @@ the preamble. For example:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
</div>
-<!--l. 1783--><p class="nopar" > or if you don&#8217;t like using <span
+<!--l. 1815--><p class="nopar" > or if you don&#8217;t like using <span
class="cmtt-10">\ensuremath</span>:
@@ -3463,34 +3470,34 @@ class="cmtt-10">\ensuremath</span>:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
</div>
-<!--l. 1793--><p class="nopar" >
-</p><!--l. 1795--><p class="indent" > Each glossary is displayed using:
-</p><!--l. 1797--><p class="indent" > <hr><div title="Definition"><span
+<!--l. 1825--><p class="nopar" >
+</p><!--l. 1827--><p class="indent" > Each glossary is displayed using:
+</p><!--l. 1829--><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. 1798--><p class="noindent" >
+</p><!--l. 1830--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1801--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1833--><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. 1802--><p class="noindent" >
+</p><!--l. 1834--><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. 1806--><p class="indent" > If you&#8217;re using <span
+</p><!--l. 1838--><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. 1809--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1841--><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. 1810--><p class="noindent" >
+</p><!--l. 1842--><p class="noindent" >
With this method you don&#8217;t use <span
class="cmtt-10">\makeglossaries </span>or <span
class="cmtt-10">\makenoidxglossaries</span>.
@@ -3514,7 +3521,7 @@ Instead you can assign the entry type with the resource command. For example:
&#x00A0;<br />&#x00A0;&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
&#x00A0;<br />&#x00A0;]
</div>
-<!--l. 1829--><p class="nopar" > Later in the document:
+<!--l. 1861--><p class="nopar" > Later in the document:
@@ -3524,26 +3531,26 @@ Instead you can assign the entry type with the resource command. For example:
&#x00A0;<br />&#x00A0;\printunsrtglossary[type=abbreviations]
&#x00A0;<br />&#x00A0;\printunsrtglossary[type=symbols]
</div>
-<!--l. 1835--><p class="nopar" >
-</p><!--l. 1837--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries
+<!--l. 1867--><p class="nopar" >
+</p><!--l. 1869--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries
depending on the indexing method:
-</p><!--l. 1840--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1872--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
-</p><!--l. 1841--><p class="noindent" >
+</p><!--l. 1873--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1844--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1876--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
-</p><!--l. 1845--><p class="noindent" >
+</p><!--l. 1877--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>) or (<span
class="cmss-10">glossaries-extra</span><a
id="dx1-7014"></a> only)
-</p><!--l. 1848--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1880--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printunsrtglossaries </span></div><hr>
-</p><!--l. 1849--><p class="noindent" >
-</p><!--l. 1851--><p class="indent" > If you use <a
+</p><!--l. 1881--><p class="noindent" >
+</p><!--l. 1883--><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
@@ -3551,19 +3558,23 @@ href="#option3">3</a> with the <span
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
+ 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><a
- id="dx1-7017"></a> Perl script then you need to make sure you run <span
+ id="dx1-7017"></a> Perl script or <span
+class="cmtt-10">makeglossaries-lite</span><a
+ id="dx1-7018"></a>
+Lua script then you need to make sure you run <span
class="cmtt-10">makeindex</span><a
- id="dx1-7018"></a>/<span
+ id="dx1-7019"></a>/<span
class="cmtt-10">xindy</span><a
- id="dx1-7019"></a>
+ id="dx1-7020"></a> <span
+class="cmti-10">for each</span>
<span
-class="cmti-10">for each defined glossary</span>. The &#x27E8;<span
+class="cmti-10">defined glossary</span>. The &#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
@@ -3574,11 +3585,11 @@ 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
+ id="dx1-7021"></a>/<span
class="cmtt-10">xindy</span><a
- id="dx1-7021"></a> errors or warnings if things go
+ id="dx1-7022"></a> errors or warnings if things go
wrong.
-</p><!--l. 1865--><p class="indent" > For example, suppose you have three glossaries in your document (<span
+</p><!--l. 1898--><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
@@ -3591,25 +3602,24 @@ class="cmtt-10">notation</span>), specified using:
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1871--><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
+<!--l. 1904--><p class="nopar" > Then (assuming your LaTeX&#x00A0;document is in a&#x00A0;file called <span
class="cmtt-10">myDoc.tex</span>):
-</p><!--l. 1875--><p class="indent" >
+</p><!--l. 1908--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
href="#option2">Option&#x00A0;2</a> Either use one <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-7022"></a> or <span
+ id="dx1-7023"></a> or <span
class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-7023"></a> call:
+ id="dx1-7024"></a> call:
<div class="verbatim" id="verbatim-95">
makeglossaries&#x00A0;myDoc
</div>
- <!--l. 1881--><p class="nopar" > or
+ <!--l. 1914--><p class="nopar" > or
@@ -3617,9 +3627,9 @@ class="cmtt-10">makeglossaries-lite</span><a
<div class="verbatim" id="verbatim-96">
makeglossaries-lite&#x00A0;myDoc
</div>
- <!--l. 1885--><p class="nopar" > Or you need to run <span
+ <!--l. 1918--><p class="nopar" > Or you need to run <span
class="cmtt-10">makeindex</span><a
- id="dx1-7024"></a> three times:
+ id="dx1-7025"></a> three times:
@@ -3629,22 +3639,22 @@ class="cmtt-10">makeindex</span><a
&#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. 1891--><p class="nopar" >
+ <!--l. 1924--><p class="nopar" >
</p></dd><dt class="description">
</dt><dd
class="description"><a
href="#option3">Option&#x00A0;3</a> Either use one <span
class="cmtt-10">makeglossaries</span><a
- id="dx1-7025"></a> call:
+ id="dx1-7026"></a> call:
<div class="verbatim" id="verbatim-98">
makeglossaries&#x00A0;myDoc
</div>
- <!--l. 1897--><p class="nopar" > Or you need to run <span
+ <!--l. 1930--><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
+ id="dx1-7027"></a> three times (be careful not to insert line breaks
where the line has wrapped.)
@@ -3658,13 +3668,13 @@ class="cmtt-10">xindy</span><a
&#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. 1907--><p class="nopar" >
+ <!--l. 1940--><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:
+ id="dx1-7028"></a> only one call is required:
@@ -3673,16 +3683,16 @@ class="cmtt-10">bib2gls</span><a
&#x00A0;<br />bib2gls&#x00A0;--group&#x00A0;myDoc
&#x00A0;<br />pdflatex&#x00A0;myDoc
</div>
- <!--l. 1915--><p class="nopar" > (Omit <span class="obeylines-h"><span class="verb"><span
+ <!--l. 1948--><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. 1920--><p class="noindent" >
+<!--l. 1953--><p class="noindent" >
</p>
-<!--l. 1920--><p class="noindent" ><a
+<!--l. 1953--><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. 1923--><p class="noindent" >Take care if you use the <span
+<!--l. 1956--><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
@@ -3706,25 +3716,23 @@ class="cmss-10">hyperref</span><a
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage{glossaries}
</div>
-<!--l. 1930--><p class="nopar" > If you use <span
+<!--l. 1963--><p class="nopar" > If you use <span
class="cmss-10">hyperref</span><a
- 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
+ id="dx1-8007"></a> make sure you use PDFLaTeX&#x00A0;rather than the LaTeX&#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. 1937--><p class="indent" > By default, if the <span
+</p><!--l. 1970--><p class="indent" > By default, if the <span
class="cmss-10">hyperref</span><a
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. 1942--><p class="indent" > <hr><div title="Definition"><span
+a&#x00A0;hyperlink to the relevant entry in the glossary. If you want to disable this for <span
+class="cmti-10">all</span>
+your glossaries, then use:
+</p><!--l. 1975--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsdisablehyper </span></div><hr>
-</p><!--l. 1943--><p class="noindent" >
+</p><!--l. 1976--><p class="noindent" >
If you want hyperlinks suppressed for entries in specific glossaries, then use the
<span
class="cmss-10">nohypertypes</span><a
@@ -3743,8 +3751,8 @@ glossary, then do:
&#x00A0;<br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1953--><p class="nopar" >
-</p><!--l. 1955--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
+<!--l. 1986--><p class="nopar" >
+</p><!--l. 1988--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
want hyperlinks for subsequence references then use the <span
class="cmss-10">hyperfirst</span><span
class="cmtt-10">=</span><span
@@ -3759,11 +3767,16 @@ option:
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[hyperfirst=false]{glossaries}
</div>
-<!--l. 1961--><p class="nopar" >
-</p><!--l. 1963--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn&#8217;t
+<!--l. 1994--><p class="nopar" > The <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8011"></a> extension package provides another method using category
+attributes. See the <span
+class="cmss-10">glossaries-extra</span><a
+ id="dx1-8012"></a> user manual for further details.
+</p><!--l. 1999--><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-8011"></a> package but is a&#x00A0;limitation of PDF bookmarks.
+ id="dx1-8013"></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
@@ -3771,7 +3784,7 @@ class="cmtt-10">\Gls </span>and <span
class="cmtt-10">\Glspl</span>.
The <span
class="cmss-10">hyperref</span><a
- id="dx1-8012"></a> package provides a&#x00A0;way of specifying alternative text for the PDF
+ id="dx1-8014"></a> package provides a&#x00A0;way of specifying alternative text for the PDF
bookmarks via <span
class="cmtt-10">\texorpdfstring</span>. For example:
@@ -3781,15 +3794,15 @@ class="cmtt-10">\texorpdfstring</span>. For example:
<div class="verbatim" id="verbatim-104">
\section{The&#x00A0;\texorpdfstring{\gls{fishage}}{Fish&#x00A0;Age}}
</div>
-<!--l. 1971--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
+<!--l. 2007--><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
+you&#8217;ll end up with the table of contents page in your location list. Instead you can
use
-</p><!--l. 1976--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 2012--><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. 1977--><p class="noindent" >
+</p><!--l. 2013--><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:
@@ -3800,10 +3813,10 @@ For example, the following works:
<div class="verbatim" id="verbatim-105">
\section{The&#x00A0;\glsentrytext{fishage}}
</div>
-<!--l. 1982--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
-</p><!--l. 1985--><p class="indent" > If you use <span
+<!--l. 2018--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
+</p><!--l. 2021--><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
+ id="dx1-8015"></a> then use the commands that are provided specifically for
use in section headers. For example:
@@ -3812,19 +3825,19 @@ use in section headers. For example:
<div class="verbatim" id="verbatim-106">
\section{The&#x00A0;\glsfmttext{fishage}}
</div>
-<!--l. 1989--><p class="nopar" >
-</p><!--l. 1991--><p class="noindent" >
+<!--l. 2025--><p class="nopar" >
+</p><!--l. 2027--><p class="noindent" >
</p>
-<!--l. 1991--><p class="noindent" ><a
+<!--l. 2027--><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. 1994--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
+<!--l. 2030--><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. 1998--><p class="indent" > For example:
+</p><!--l. 2034--><p class="indent" > For example:
@@ -3844,7 +3857,7 @@ defined.
&#x00A0;<br />&#x00A0;&#x00A0;see={devonian}
&#x00A0;<br />}
</div>
-<!--l. 2015--><p class="nopar" > The cross-reference will appear as &#8220;<span
+<!--l. 2051--><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
@@ -3870,7 +3883,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. 2033--><p class="nopar" > If you use the <span
+<!--l. 2069--><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:
@@ -3884,7 +3897,7 @@ enclose the value in braces. For example:
&#x00A0;<br />&#x00A0;[see={[see&#x00A0;also]{ksvm}}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 2042--><p class="nopar" > The <span
+<!--l. 2078--><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
@@ -3905,8 +3918,8 @@ class="cmsy-10">}</span>. For example:
&#x00A0;<br />&#x00A0;[seealso={ksvm}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 2051--><p class="nopar" >
-</p><!--l. 2053--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the
+<!--l. 2087--><p class="nopar" >
+</p><!--l. 2089--><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
@@ -3938,10 +3951,10 @@ example:
&#x00A0;<br />&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
&#x00A0;<br />]
</div>
-<!--l. 2075--><p class="nopar" >
-</p><!--l. 2077--><p class="noindent" >
+<!--l. 2111--><p class="nopar" >
+</p><!--l. 2113--><p class="noindent" >
</p>
-<!--l. 2077--><p class="noindent" ><a
+<!--l. 2113--><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>
<ul class="itemize1">
@@ -3969,12 +3982,14 @@ class="cmss-10">glossaries-extra</span></a> package.
<li class="itemize">The <a
href="https://ctan.org/pkg/bib2gls" ><span
class="cmtt-10">bib2gls</span></a> application.</li></ul>
- <div class="footnotes"><!--l. 1038--><p class="noindent" ><span class="footnote-mark"><a
+<!--l. 2128--><p class="noindent" >The <a
+href="https://www.dickimaw-books.com/gallery" >Dickimaw Books Gallery</a> provides additional example documents.
+</p><div class="footnotes"><!--l. 1066--><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>
+class="cmr-8">instead</span></p> </div>
</body></html>