summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/glossaries/glossariesbegin.html
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-09-24 03:01:47 +0000
committerNorbert Preining <norbert@preining.info>2021-09-24 03:01:47 +0000
commit5d714d9476cbb90b125ff14a9d764ad90bb7c2ed (patch)
treeb426e6a4c96fc80fefa171542b39fd4725b7aea2 /macros/latex/contrib/glossaries/glossariesbegin.html
parenta26e6aee249adb0efff5d0eecaa2dfb8794585a5 (diff)
CTAN sync 202109240301
Diffstat (limited to 'macros/latex/contrib/glossaries/glossariesbegin.html')
-rw-r--r--macros/latex/contrib/glossaries/glossariesbegin.html1750
1 files changed, 926 insertions, 824 deletions
diff --git a/macros/latex/contrib/glossaries/glossariesbegin.html b/macros/latex/contrib/glossaries/glossariesbegin.html
index 91e6cd7014..85fd72607d 100644
--- a/macros/latex/contrib/glossaries/glossariesbegin.html
+++ b/macros/latex/contrib/glossaries/glossariesbegin.html
@@ -6,8 +6,8 @@
>
<head><title></title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
-<meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
+<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)" />
+<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)" />
<!-- xhtml,fn-in,css-in,uni-html4,utf8 -->
<meta name="src" content="glossariesbegin.tex" />
@@ -40,9 +40,9 @@
.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;}
+.cmitt-10{font-family: monospace,monospace; font-style: italic;}
.tcrm-0900{font-size:90%;}
.cmss-8{font-size:80%; font-family: sans-serif;}
.cmss-8{ font-family: sans-serif;}
@@ -53,15 +53,19 @@ p.indent{text-indent:0;}
p + p{margin-top:1em;}
p + div, p + pre {margin-top:1em;}
div + p, pre + p {margin-top:1em;}
+a { overflow-wrap: break-word; word-wrap: break-word; word-break: break-word; hyphens: auto; }
@media print {div.crosslinks {visibility:hidden;}}
a img { border-top: 0; border-left: 0; border-right: 0; }
center { margin-top:1em; margin-bottom:1em; }
td center { margin-top:0em; margin-bottom:0em; }
.Canvas { position:relative; }
img.math{vertical-align:middle;}
+div.par-math-display, div.math-display{text-align:center;}
li p.indent { text-indent: 0em }
li p:first-child{ margin-top:0em; }
+li p:first-child{ margin-bottom; }
li p:last-child, li div:last-child { margin-bottom:0.5em; }
+li p:first-child{ margin-bottom:0; }
li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; }
.enumerate1 {list-style-type:decimal;}
.enumerate2 {list-style-type:lower-alpha;}
@@ -75,7 +79,7 @@ div.obeylines-v p { margin-top:0; margin-bottom:0; }
td.displaylines {text-align:center; white-space:nowrap;}
.centerline {text-align:center;}
.rightline {text-align:right;}
-div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; }
+pre.verbatim {font-family: monospace,monospace; text-align:left; clear:both; }
.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
div.fbox {display:table}
div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
@@ -137,6 +141,7 @@ table.pmatrix {width:100%;}
span.bar-css {text-decoration:overline;}
img.cdots{vertical-align:middle;}
.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;}
+.chapterToc a, .chapterToc, .likechapterToc a, .likechapterToc, .appendixToc a, .appendixToc {line-height: 200%; font-weight:bold;}
.index-item, .index-subitem, .index-subsubitem {display:block}
div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;}
div.caption span.id{font-weight: bold; white-space: nowrap; }
@@ -145,18 +150,17 @@ p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom
p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; }
.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;}
.subparagraphHead, .likesubparagraphHead { font-weight: bold;}
-.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;}
.verse{white-space:nowrap; margin-left:2em}
div.maketitle {text-align:center;}
h2.titleHead{text-align:center;}
div.maketitle{ margin-bottom: 2em; }
div.author, div.date {text-align:center;}
div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; }
-.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; }
-.abstract p {margin-left:5%; margin-right:5%;}
+div.abstract p {margin-left:5%; margin-right:5%;}
div.abstract {width:100%;}
+.abstracttitle{text-align:center;margin-bottom:1em;}
.alltt P { margin-bottom : 0em; margin-top : 0em; }
-.alltt { margin-bottom : 1em; margin-top : 1em; }
+.alltt { margin-bottom : 1em; margin-top : 1em; font-family:monospace,monospace; }
div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; }
table.tabular td p{margin-top:0em;}
table.tabular {margin-left: auto; margin-right: auto;}
@@ -258,12 +262,12 @@ span#textcolor40{color:#00FF00}
>
<!--l. 59--><p class="noindent" >
</p><!--l. 59--><p class="noindent" ><span
-class="cmr-17">The glossaries package v4.46: a guide for</span>
+class="cmr-17">The glossaries package v4.47: a guide for</span>
<span
class="cmr-17">beginners</span>
</p>
<div class="tabular"> <table id="TBL-1" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-1-1g"><col
id="TBL-1-1" /></colgroup><tr
style="vertical-align:baseline;" id="TBL-1-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-1"
@@ -276,30 +280,29 @@ href="https://www.dickimaw-books.com/" ><span
class="cmtt-12">dickimaw-books.com</span></a> </td></tr></table>
</div>
<!--l. 59--><p class="noindent" ><span
-class="cmr-12">2020-03-19</span></p></div>
+class="cmr-12">2021-09-20</span></p></div>
<div
class="abstract"
>
-<div class="center"
->
-<!--l. 61--><p class="noindent" >
-</p><!--l. 61--><p class="noindent" ><span
-class="cmbx-9">Abstract</span></p></div>
- <!--l. 62--><p class="indent" > <span
+ <h3 class="abstracttitle">
+<span
+class="cmbx-9">Abstract</span>
+</h3>
+ <!--l. 62--><p class="noindent" ><span
class="cmr-9">The </span><span
class="cmss-9">glossaries </span><span
class="cmr-9">package is very flexible, but this means that it has a</span><span
-class="cmr-9">&#x00A0;lot</span>
+class="cmr-9">&#x00A0;lot of</span>
<span
-class="cmr-9">of options, and since a user guide is supposed to provide a complete list</span>
+class="cmr-9">options, and since a user guide is supposed to provide a complete list of all</span>
<span
-class="cmr-9">of all the high-level user commands, the main user manual is quite big.</span>
+class="cmr-9">the high-level user commands, the main user manual is quite big. This can</span>
<span
-class="cmr-9">This can be rather daunting for beginners, so this document is a brief</span>
+class="cmr-9">be rather daunting for beginners, so this document is a brief introduction</span>
<span
-class="cmr-9">introduction just to help get you started. If you find yourself saying, &#8220;Yeah,</span>
+class="cmr-9">just to help get you started. If you find yourself saying, &#8220;Yeah, but how</span>
<span
-class="cmr-9">but how can I do</span><span
+class="cmr-9">can I do</span><span
class="cmr-9">&#x2026;?&#8221; then it&#8217;s time to move on to the </span><a
href="glossaries-user.html" ><span
class="cmr-9">main user manual</span></a><span
@@ -320,26 +323,26 @@ class="cmr-9">that way may cause complications under certain circumstances&#8221
<h3 class="likesectionHead"><a
id="x1-1000"></a>Contents</h3>
<div class="tableofcontents">
- <span class="sectionToc" >1 <a
-href="#sec:start" id="QQ2-1-2">Getting Started</a></span>
-<br /> <span class="sectionToc" >2 <a
+ &#x00A0;<span class="sectionToc" >1 <a
+href="#sec:start" id="QQ2-1-2">Getting Started</a></span>
+<br /> &#x00A0;<span class="sectionToc" >2 <a
href="#sec:defterm" id="QQ2-1-3">Defining Terms</a></span>
-<br /> <span class="sectionToc" >3 <a
+<br /> &#x00A0;<span class="sectionToc" >3 <a
href="#sec:useterm" id="QQ2-1-4">Using Entries</a></span>
-<br /> <span class="sectionToc" >4 <a
+<br /> &#x00A0;<span class="sectionToc" >4 <a
href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries</a></span>
-<br /> <span class="sectionToc" >5 <a
+<br /> &#x00A0;<span class="sectionToc" >5 <a
href="#sec:glosstyle" id="QQ2-1-7">Customising the Glossary</a></span>
-<br /> <span class="sectionToc" >6 <a
+<br /> &#x00A0;<span class="sectionToc" >6 <a
href="#sec:multigloss" id="QQ2-1-8">Multiple Glossaries</a></span>
-<br /> <span class="sectionToc" >7 <a
+<br /> &#x00A0;<span class="sectionToc" >7 <a
href="#sec:hyperref" id="QQ2-1-9">glossaries and hyperref</a></span>
-<br /> <span class="sectionToc" >8 <a
+<br /> &#x00A0;<span class="sectionToc" >8 <a
href="#sec:xr" id="QQ2-1-10">Cross-References</a></span>
-<br /> <span class="sectionToc" >9 <a
+<br /> &#x00A0;<span class="sectionToc" >9 <a
href="#sec:moreinfo" id="QQ2-1-11">Further Information</a></span>
</div>
<!--l. 81--><p class="noindent" >
@@ -388,34 +391,34 @@ example:
</p>
- <div class="verbatim" id="verbatim-1">
+ <pre class="verbatim" id="verbatim-1">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries}
-&#x00A0;<br />&#x00A0;\newglossaryentry{ex}{name={sample},description={an&#x00A0;example}}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;Here's&#x00A0;my&#x00A0;\gls{ex}&#x00A0;term.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries}
+&#x00A0;\newglossaryentry{ex}{name={sample},description={an&#x00A0;example}}
+&#x00A0;\begin{document}
+&#x00A0;Here's&#x00A0;my&#x00A0;\gls{ex}&#x00A0;term.
+&#x00A0;\end{document}
+</pre>
<!--l. 114--><p class="nopar" > This produces:
- </p><div class="quote">
- <!--l. 117--><p class="noindent" >Here&#8217;s my sample term.</p></div>
+ </p><blockquote class="quote">
+ <!--l. 117--><p class="noindent" >Here&#8217;s my sample term.</p></blockquote>
<!--l. 119--><p class="noindent" >Here&#8217;s another example:
</p>
- <div class="verbatim" id="verbatim-2">
+ <pre class="verbatim" id="verbatim-2">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries}
-&#x00A0;<br />&#x00A0;\setacronymstyle{long-short}
-&#x00A0;<br />&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries}
+&#x00A0;\setacronymstyle{long-short}
+&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;\end{document}
+</pre>
<!--l. 132--><p class="nopar" > This produces:
- </p><div class="quote">
- <!--l. 135--><p class="noindent" >First use: support vector machine (SVM). Second use: SVM.</p></div>
+ </p><blockquote class="quote">
+ <!--l. 135--><p class="noindent" >First use: support vector machine (SVM). Second use: SVM.</p></blockquote>
<!--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
@@ -444,15 +447,15 @@ class="cmss-10">glossaries-extra</span><a
</p>
- <div class="verbatim" id="verbatim-3">
+ <pre class="verbatim" id="verbatim-3">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
-&#x00A0;<br />&#x00A0;\setabbreviationstyle{long-short}%&#x00A0;glossaries-extra.sty
-&#x00A0;<br />&#x00A0;\newabbreviation{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;\setabbreviationstyle{long-short}%&#x00A0;glossaries-extra.sty
+&#x00A0;\newabbreviation{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;\end{document}
+</pre>
<!--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
@@ -469,15 +472,15 @@ class="cmtt-10">\setabbreviationstyle</span>:
</p>
- <div class="verbatim" id="verbatim-4">
+ <pre class="verbatim" id="verbatim-4">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
-&#x00A0;<br />&#x00A0;\setabbreviationstyle[acronym]{long-short}%&#x00A0;glossaries-extra.sty&#x00A0;only
-&#x00A0;<br />&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;\setabbreviationstyle[acronym]{long-short}%&#x00A0;glossaries-extra.sty&#x00A0;only
+&#x00A0;\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;\end{document}
+</pre>
<!--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
@@ -501,9 +504,9 @@ filename as the argument. For example:
</p>
- <div class="verbatim" id="verbatim-5">
+ <pre class="verbatim" id="verbatim-5">
\loadglsentries{defns}
-</div>
+</pre>
<!--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
@@ -525,15 +528,15 @@ style):
</p>
- <div class="verbatim" id="verbatim-6">
+ <pre class="verbatim" id="verbatim-6">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries}
-&#x00A0;<br />&#x00A0;\setacronymstyle{long-sc-short}
-&#x00A0;<br />&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries}
+&#x00A0;\setacronymstyle{long-sc-short}
+&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;\end{document}
+</pre>
<!--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>:
@@ -541,15 +544,15 @@ class="cmss-10">glossaries-extra</span><a
</p>
- <div class="verbatim" id="verbatim-7">
+ <pre class="verbatim" id="verbatim-7">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
-&#x00A0;<br />&#x00A0;\setabbreviationstyle{long-short-sc}%&#x00A0;glossaries-extra.sty
-&#x00A0;<br />&#x00A0;\newabbreviation{svm}{svm}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;\setabbreviationstyle{long-short-sc}%&#x00A0;glossaries-extra.sty
+&#x00A0;\newabbreviation{svm}{svm}{support&#x00A0;vector&#x00A0;machine}%&#x00A0;glossaries-extra.sty
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm}.&#x00A0;Second&#x00A0;use:&#x00A0;\gls{svm}.
+&#x00A0;\end{document}
+</pre>
<!--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
@@ -559,34 +562,34 @@ can be redefined for minor adjustments. For example:
</p>
- <div class="verbatim" id="verbatim-8">
+ <pre class="verbatim" id="verbatim-8">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries-extra}
-&#x00A0;<br />&#x00A0;\setabbreviationstyle[statistical]{long-short-sc}
-&#x00A0;<br />&#x00A0;\setabbreviationstyle[bacteria]{long-only-short-only}
-&#x00A0;<br />&#x00A0;%&#x00A0;Formatting&#x00A0;commands&#x00A0;used&#x00A0;by&#x00A0;'long-only-short-only'&#x00A0;style:
-&#x00A0;<br />&#x00A0;\renewcommand*{\glsabbrvonlyfont}[1]{\emph{#1}}
-&#x00A0;<br />&#x00A0;\renewcommand*{\glslongonlyfont}[1]{\emph{#1}}
-&#x00A0;<br />&#x00A0;%&#x00A0;Formatting&#x00A0;command&#x00A0;used&#x00A0;by&#x00A0;'long-short-sc'&#x00A0;style:
-&#x00A0;<br />&#x00A0;%&#x00A0;(make&#x00A0;sure&#x00A0;abbreviation&#x00A0;is&#x00A0;converted&#x00A0;to&#x00A0;lower&#x00A0;case)
-&#x00A0;<br />&#x00A0;\renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}}
-&#x00A0;<br />&#x00A0;\newabbreviation
-&#x00A0;<br />&#x00A0;&#x00A0;[
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={statistical}%&#x00A0;glossaries-extra.sty&#x00A0;key
-&#x00A0;<br />&#x00A0;&#x00A0;]
-&#x00A0;<br />&#x00A0;&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />&#x00A0;\newabbreviation
-&#x00A0;<br />&#x00A0;&#x00A0;[
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={bacteria}%&#x00A0;glossaries-extra.sty&#x00A0;key
-&#x00A0;<br />&#x00A0;&#x00A0;]
-&#x00A0;<br />&#x00A0;&#x00A0;{cbot}{C.~botulinum}{Clostridium&#x00A0;botulinum}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
-&#x00A0;<br />&#x00A0;Next&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries-extra}
+&#x00A0;\setabbreviationstyle[statistical]{long-short-sc}
+&#x00A0;\setabbreviationstyle[bacteria]{long-only-short-only}
+&#x00A0;%&#x00A0;Formatting&#x00A0;commands&#x00A0;used&#x00A0;by&#x00A0;'long-only-short-only'&#x00A0;style:
+&#x00A0;\renewcommand*{\glsabbrvonlyfont}[1]{\emph{#1}}
+&#x00A0;\renewcommand*{\glslongonlyfont}[1]{\emph{#1}}
+&#x00A0;%&#x00A0;Formatting&#x00A0;command&#x00A0;used&#x00A0;by&#x00A0;'long-short-sc'&#x00A0;style:
+&#x00A0;%&#x00A0;(make&#x00A0;sure&#x00A0;abbreviation&#x00A0;is&#x00A0;converted&#x00A0;to&#x00A0;lower&#x00A0;case)
+&#x00A0;\renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}}
+&#x00A0;\newabbreviation
+&#x00A0;&#x00A0;[
+&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={statistical}%&#x00A0;glossaries-extra.sty&#x00A0;key
+&#x00A0;&#x00A0;]
+&#x00A0;&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;\newabbreviation
+&#x00A0;&#x00A0;[
+&#x00A0;&#x00A0;&#x00A0;&#x00A0;category={bacteria}%&#x00A0;glossaries-extra.sty&#x00A0;key
+&#x00A0;&#x00A0;]
+&#x00A0;&#x00A0;{cbot}{C.~botulinum}{Clostridium&#x00A0;botulinum}
+&#x00A0;\begin{document}
+&#x00A0;First&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
+&#x00A0;Next&#x00A0;use:&#x00A0;\gls{svm},&#x00A0;\gls{cbot}.
+&#x00A0;\end{document}
+</pre>
<!--l. 282--><p class="nopar" > This produces:
- </p><div class="quote">
+ </p><blockquote class="quote">
<!--l. 285--><p class="noindent" >First use: support vector machine (<span
class="cmcsc-10"><span
class="small-caps">s</span><span
@@ -599,7 +602,7 @@ 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>
+class="cmti-10">&#x00A0;botulinum</span>.</p></blockquote>
<!--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
@@ -666,22 +669,22 @@ entries:
</p>
- <div class="verbatim" id="verbatim-9">
+ <pre class="verbatim" id="verbatim-9">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage[sort=none]{glossaries-extra}
-&#x00A0;<br />&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
-&#x00A0;<br />&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
-&#x00A0;<br />&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{turnip}{name={turnip},
-&#x00A0;<br />&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{carrot}{name={carrot},
-&#x00A0;<br />&#x00A0;&#x00A0;description={orange&#x00A0;root}}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
-&#x00A0;<br />&#x00A0;\printunsrtglossaries&#x00A0;%&#x00A0;list&#x00A0;all&#x00A0;entries
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage[sort=none]{glossaries-extra}
+&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
+&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
+&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
+&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
+&#x00A0;\newglossaryentry{turnip}{name={turnip},
+&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
+&#x00A0;\newglossaryentry{carrot}{name={carrot},
+&#x00A0;&#x00A0;description={orange&#x00A0;root}}
+&#x00A0;\begin{document}
+&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
+&#x00A0;\printunsrtglossaries&#x00A0;%&#x00A0;list&#x00A0;all&#x00A0;entries
+&#x00A0;\end{document}
+</pre>
<!--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
@@ -741,23 +744,23 @@ place where you want your glossary. For example:
</p>
- <div class="verbatim" id="verbatim-10">
+ <pre class="verbatim" id="verbatim-10">
&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries}
-&#x00A0;<br />&#x00A0;\makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
-&#x00A0;<br />&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
-&#x00A0;<br />&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
-&#x00A0;<br />&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{turnip}{name={turnip},
-&#x00A0;<br />&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
-&#x00A0;<br />&#x00A0;\newglossaryentry{carrot}{name={carrot},
-&#x00A0;<br />&#x00A0;&#x00A0;description={orange&#x00A0;root}}
-&#x00A0;<br />&#x00A0;\begin{document}
-&#x00A0;<br />&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
-&#x00A0;<br />&#x00A0;\printnoidxglossaries
-&#x00A0;<br />&#x00A0;\end{document}
-</div>
+&#x00A0;\usepackage{glossaries}
+&#x00A0;\makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
+&#x00A0;\newglossaryentry{potato}{name={potato},plural={potatoes},
+&#x00A0;&#x00A0;description={starchy&#x00A0;tuber}}
+&#x00A0;\newglossaryentry{cabbage}{name={cabbage},
+&#x00A0;&#x00A0;description={vegetable&#x00A0;with&#x00A0;thick&#x00A0;green&#x00A0;or&#x00A0;purple&#x00A0;leaves}}
+&#x00A0;\newglossaryentry{turnip}{name={turnip},
+&#x00A0;&#x00A0;description={round&#x00A0;pale&#x00A0;root&#x00A0;vegetable}}
+&#x00A0;\newglossaryentry{carrot}{name={carrot},
+&#x00A0;&#x00A0;description={orange&#x00A0;root}}
+&#x00A0;\begin{document}
+&#x00A0;Chop&#x00A0;the&#x00A0;\gls{cabbage},&#x00A0;\glspl{potato}&#x00A0;and&#x00A0;\glspl{carrot}.
+&#x00A0;\printnoidxglossaries
+&#x00A0;\end{document}
+</pre>
<!--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
@@ -782,17 +785,17 @@ options:
</p>
- <div class="verbatim" id="verbatim-11">
+ <pre class="verbatim" id="verbatim-11">
\usepackage[nogroupskip]{glossaries}
-</div>
+</pre>
<!--l. 427--><p class="nopar" > or you may want to try out a style that shows the group headings:
</p>
- <div class="verbatim" id="verbatim-12">
+ <pre class="verbatim" id="verbatim-12">
\usepackage[style=indexgroup]{glossaries}
-</div>
+</pre>
<!--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
@@ -805,9 +808,9 @@ option:
</p>
- <div class="verbatim" id="verbatim-13">
+ <pre class="verbatim" id="verbatim-13">
\usepackage[nonumberlist]{glossaries}
-</div>
+</pre>
<!--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>
@@ -816,9 +819,9 @@ package option:
</p>
- <div class="verbatim" id="verbatim-14">
+ <pre class="verbatim" id="verbatim-14">
\usepackage[nopostdot]{glossaries}
-</div>
+</pre>
<!--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
@@ -830,17 +833,17 @@ lists. You can add the full stop back with
</p>
- <div class="verbatim" id="verbatim-15">
+ <pre class="verbatim" id="verbatim-15">
\usepackage[nopostdot=false]{glossaries-extra}
-</div>
+</pre>
<!--l. 453--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-16">
+ <pre class="verbatim" id="verbatim-16">
\usepackage[postdot]{glossaries-extra}
-</div>
+</pre>
<!--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
@@ -860,17 +863,18 @@ class="cmtt-10">xindy</span><a
href="#option3">Option&#x00A0;3</a>) or <span
class="cmtt-10">bib2gls</span><a
id="dx1-2030"></a> (<a
-href="#option4">Option&#x00A0;4</a>). If you are using
-extended Latin or non-Latin characters, then <span
+href="#option4">Option&#x00A0;4</a>). If you are
+using extended Latin or non-Latin characters, then <span
class="cmtt-10">xindy</span><a
id="dx1-2031"></a> or <span
class="cmtt-10">bib2gls</span><a
- id="dx1-2032"></a> are the
-recommended methods. These methods are described in more detail in <a
+ id="dx1-2032"></a> are
+the recommended methods. These methods are described in more detail in
+<a
href="#sec:printglossaries"><span
-class="tcrm-1000">&sect;</span>4 </a><a
-href="#sec:printglossaries">Displaying
-a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:printglossaries </a><a
+href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
</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
@@ -961,62 +965,69 @@ class="cmtt-10">}</span>
<!--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
+<li
+ class="enumerate" id="x1-3003x1">
+ <!--l. 523--><p class="noindent" >Define the term &#8220;set&#8221; with the label <span
class="cmtt-10">set</span>:
- <div class="verbatim" id="verbatim-17">
+</p>
+ <pre class="verbatim" id="verbatim-17">
\newglossaryentry{set}
- &#x00A0;<br />{
- &#x00A0;<br />&#x00A0;&#x00A0;name={set},
- &#x00A0;<br />&#x00A0;&#x00A0;description={a&#x00A0;collection&#x00A0;of&#x00A0;objects}
- &#x00A0;<br />}
-</div>
+ {
+ &#x00A0;&#x00A0;name={set},
+ &#x00A0;&#x00A0;description={a&#x00A0;collection&#x00A0;of&#x00A0;objects}
+ }
+</pre>
<!--l. 530--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-3005x2">Define the symbol <span
+<li
+ class="enumerate" id="x1-3005x2">
+ <!--l. 532--><p class="noindent" >Define the symbol <span
class="cmsy-10">&#x2205; </span>with the label <span
class="cmtt-10">emptyset</span>:
- <div class="verbatim" id="verbatim-18">
+</p>
+ <pre class="verbatim" id="verbatim-18">
\newglossaryentry{emptyset}
- &#x00A0;<br />{
- &#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
- &#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;empty&#x00A0;set}
- &#x00A0;<br />}
-</div>
+ {
+ &#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+ &#x00A0;&#x00A0;description={the&#x00A0;empty&#x00A0;set}
+ }
+</pre>
<!--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.)
</p></li>
- <li
- class="enumerate" id="x1-3007x3">Define the phrase &#8220;Fish Age&#8221; with the label <span
+<li
+ class="enumerate" id="x1-3007x3">
+ <!--l. 544--><p class="noindent" >Define the phrase &#8220;Fish Age&#8221; with the label <span
class="cmtt-10">fishage</span>:
- <div class="verbatim" id="verbatim-19">
+</p>
+ <pre class="verbatim" id="verbatim-19">
\longnewglossaryentry{fishage}
- &#x00A0;<br />{name={Fish&#x00A0;Age}}
- &#x00A0;<br />{%
- &#x00A0;<br />&#x00A0;&#x00A0;A&#x00A0;common&#x00A0;name&#x00A0;for&#x00A0;the&#x00A0;Devonian&#x00A0;geologic&#x00A0;period
- &#x00A0;<br />&#x00A0;&#x00A0;spanning&#x00A0;from&#x00A0;the&#x00A0;end&#x00A0;of&#x00A0;the&#x00A0;Silurian&#x00A0;Period&#x00A0;to
- &#x00A0;<br />&#x00A0;&#x00A0;the&#x00A0;beginning&#x00A0;of&#x00A0;the&#x00A0;Carboniferous&#x00A0;Period.
- &#x00A0;<br />&#x00A0;&#x00A0;This&#x00A0;age&#x00A0;was&#x00A0;known&#x00A0;for&#x00A0;its&#x00A0;remarkable&#x00A0;variety&#x00A0;of
- &#x00A0;<br />&#x00A0;&#x00A0;fish&#x00A0;species.
- &#x00A0;<br />}
-</div>
+ {name={Fish&#x00A0;Age}}
+ {%
+ &#x00A0;&#x00A0;A&#x00A0;common&#x00A0;name&#x00A0;for&#x00A0;the&#x00A0;Devonian&#x00A0;geologic&#x00A0;period
+ &#x00A0;&#x00A0;spanning&#x00A0;from&#x00A0;the&#x00A0;end&#x00A0;of&#x00A0;the&#x00A0;Silurian&#x00A0;Period&#x00A0;to
+ &#x00A0;&#x00A0;the&#x00A0;beginning&#x00A0;of&#x00A0;the&#x00A0;Carboniferous&#x00A0;Period.
+ &#x00A0;&#x00A0;This&#x00A0;age&#x00A0;was&#x00A0;known&#x00A0;for&#x00A0;its&#x00A0;remarkable&#x00A0;variety&#x00A0;of
+ &#x00A0;&#x00A0;fish&#x00A0;species.
+ }
+</pre>
<!--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
- class="enumerate" id="x1-3009x4">Take care if the first letter is an extended Latin or non-Latin character (either
+<li
+ class="enumerate" id="x1-3009x4">
+ <!--l. 562--><p class="noindent" >Take care if the first letter is an extended Latin or non-Latin character (either
specified via a&#x00A0;command such as <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\&#8217;e</span></span></span> or explicitly via the <span
class="cmss-10">inputenc</span><a
@@ -1026,13 +1037,14 @@ class="cmtt-10">&eacute;</span>). This first letter must be placed in a&#x00A0;g
- <div class="verbatim" id="verbatim-20">
+</p>
+ <pre class="verbatim" id="verbatim-20">
\newglossaryentry{elite}
- &#x00A0;<br />{
- &#x00A0;<br />&#x00A0;&#x00A0;name={{\'e}lite},
- &#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
- &#x00A0;<br />}
-</div>
+ {
+ &#x00A0;&#x00A0;name={{\'e}lite},
+ &#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
+ }
+</pre>
<!--l. 573--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
@@ -1129,6 +1141,9 @@ class="cmtt-10">Fish</span><span
class="cmtt-10">&#x00A0;Age</span><span
class="cmsy-10">}</span><span
class="cmtt-10">,</span>
+
+
+
<br /><span
class="cmtt-10">&#x00A0;</span><span
class="cmtt-10">&#x00A0;description=</span><span
@@ -1152,9 +1167,6 @@ 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
@@ -1217,9 +1229,9 @@ package option:
- <div class="verbatim" id="verbatim-21">
+ <pre class="verbatim" id="verbatim-21">
\usepackage[record]{glossaries-extra}
-</div>
+</pre>
<!--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
@@ -1230,9 +1242,9 @@ preamble:
</p>
- <div class="verbatim" id="verbatim-22">
+ <pre class="verbatim" id="verbatim-22">
\GlsXtrLoadResources[src={entries}]
-</div>
+</pre>
<!--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>:
@@ -1240,9 +1252,9 @@ class="cmtt-10">entries2.bib</span>:
</p>
- <div class="verbatim" id="verbatim-23">
+ <pre class="verbatim" id="verbatim-23">
\GlsXtrLoadResources[src={entries,entries2}]
-</div>
+</pre>
<!--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>
@@ -1258,15 +1270,15 @@ class="cmtt-10">text </span>key as well.
</p>
- <div class="verbatim" id="verbatim-24">
+ <pre class="verbatim" id="verbatim-24">
\newglossaryentry{latinalph}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
-&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
+&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
+&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
+&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
+}
+</pre>
<!--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
@@ -1277,14 +1289,14 @@ as:
</p>
- <div class="verbatim" id="verbatim-25">
+ <pre class="verbatim" id="verbatim-25">
@entry{latinalph,
-&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
-&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
-&#x00A0;<br />}
-</div>
+&#x00A0;&#x00A0;name={Latin&#x00A0;Alphabet},
+&#x00A0;&#x00A0;text={Latin&#x00A0;alphabet},
+&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
+&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z}
+}
+</pre>
<!--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
@@ -1296,14 +1308,14 @@ class="cmtt-10">plural </span>key to override it:
</p>
- <div class="verbatim" id="verbatim-26">
+ <pre class="verbatim" id="verbatim-26">
\newglossaryentry{oesophagus}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={{\oe}sophagus},
-&#x00A0;<br />&#x00A0;&#x00A0;plural={{\oe}sophagi},
-&#x00A0;<br />&#x00A0;&#x00A0;description={canal&#x00A0;from&#x00A0;mouth&#x00A0;to&#x00A0;stomach}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={{\oe}sophagus},
+&#x00A0;&#x00A0;plural={{\oe}sophagi},
+&#x00A0;&#x00A0;description={canal&#x00A0;from&#x00A0;mouth&#x00A0;to&#x00A0;stomach}
+}
+</pre>
<!--l. 677--><p class="nopar" > (Remember from earlier that the initial ligature <span
class="cmtt-10">\oe </span>needs to be grouped.)
</p><!--l. 681--><p class="indent" > Abbreviations can be defined using:
@@ -1328,9 +1340,9 @@ class="cmti-10">long</span>&#x27E9; is the long form. For example, the following
</p>
- <div class="verbatim" id="verbatim-27">
+ <pre class="verbatim" id="verbatim-27">
\newacronym{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-</div>
+</pre>
<!--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
@@ -1346,11 +1358,11 @@ the optional argument:
</p>
- <div class="verbatim" id="verbatim-28">
+ <pre class="verbatim" id="verbatim-28">
\newacronym
-&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
-&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-</div>
+&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
+&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+</pre>
<!--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:
@@ -1457,11 +1469,11 @@ class="cmtt-10">shortplural </span>keys. For example:
</p>
- <div class="verbatim" id="verbatim-29">
+ <pre class="verbatim" id="verbatim-29">
\newacronym
-&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
-&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
-</div>
+&#x00A0;[longplural={diagonal&#x00A0;matrices}]
+&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
+</pre>
<!--l. 754--><p class="nopar" > or (with <span
class="cmss-10">glossaries-extra</span><a
id="dx1-3019"></a>):
@@ -1469,11 +1481,11 @@ class="cmss-10">glossaries-extra</span><a
</p>
- <div class="verbatim" id="verbatim-30">
+ <pre class="verbatim" id="verbatim-30">
\newabbreviation&#x00A0;%&#x00A0;glossaries-extra.sty
-&#x00A0;<br />&#x00A0;[longplural={diagonal&#x00A0;matrices}]
-&#x00A0;<br />&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
-</div>
+&#x00A0;[longplural={diagonal&#x00A0;matrices}]
+&#x00A0;{dm}{DM}{diagonal&#x00A0;matrix}
+</pre>
<!--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
@@ -1483,13 +1495,13 @@ class="cmtt-10">.bib </span>file is:
</p>
- <div class="verbatim" id="verbatim-31">
+ <pre class="verbatim" id="verbatim-31">
@abbreviation{dm,
-&#x00A0;<br />&#x00A0;&#x00A0;short={DM},
-&#x00A0;<br />&#x00A0;&#x00A0;long={diagonal&#x00A0;matrix},
-&#x00A0;<br />&#x00A0;&#x00A0;longplural={diagonal&#x00A0;matrices}
-&#x00A0;<br />}
-</div>
+&#x00A0;&#x00A0;short={DM},
+&#x00A0;&#x00A0;long={diagonal&#x00A0;matrix},
+&#x00A0;&#x00A0;longplural={diagonal&#x00A0;matrices}
+}
+</pre>
<!--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
@@ -1500,14 +1512,14 @@ example:
</p>
- <div class="verbatim" id="verbatim-32">
+ <pre class="verbatim" id="verbatim-32">
\newglossaryentry{emptyset}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={empty&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;symbol={\ensuremath{\emptyset}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={empty&#x00A0;set},
+&#x00A0;&#x00A0;symbol={\ensuremath{\emptyset}},
+&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+}
+</pre>
<!--l. 782--><p class="nopar" > or with <span
class="cmtt-10">bib2gls</span><a
id="dx1-3021"></a> the definition in the <span
@@ -1516,13 +1528,13 @@ class="cmtt-10">.bib </span>file is:
</p>
- <div class="verbatim" id="verbatim-33">
+ <pre class="verbatim" id="verbatim-33">
@entry{emptyset,
-&#x00A0;<br />&#x00A0;&#x00A0;name={empty&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;symbol={\ensuremath{\emptyset}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
-&#x00A0;<br />}
-</div>
+&#x00A0;&#x00A0;name={empty&#x00A0;set},
+&#x00A0;&#x00A0;symbol={\ensuremath{\emptyset}},
+&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+}
+</pre>
<!--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
@@ -1541,14 +1553,14 @@ order is a little odd. For example:
</p>
- <div class="verbatim" id="verbatim-34">
+ <pre class="verbatim" id="verbatim-34">
\newglossaryentry{emptyset}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
-&#x00A0;<br />&#x00A0;&#x00A0;sort={empty&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;&#x00A0;sort={empty&#x00A0;set},
+&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+}
+</pre>
<!--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
@@ -1575,19 +1587,19 @@ class="cmti-10">label</span>&#x27E9;. For example:
</p>
- <div class="verbatim" id="verbatim-35">
+ <pre class="verbatim" id="verbatim-35">
\documentclass{article}
-&#x00A0;<br />\usepackage[symbols]{glossaries-extra}
-&#x00A0;<br />\makeglossaries
-&#x00A0;<br />\glsxtrnewsymbol&#x00A0;%&#x00A0;requires&#x00A0;glossaries-extra.sty&#x00A0;'symbols'&#x00A0;option
-&#x00A0;<br />&#x00A0;[description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}]
-&#x00A0;<br />&#x00A0;{emptyset}%&#x00A0;label&#x00A0;(and&#x00A0;sort&#x00A0;value)
-&#x00A0;<br />&#x00A0;{\ensuremath{\emptyset}}%&#x00A0;symbol
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />\gls{emptyset}
-&#x00A0;<br />\printglossaries
-&#x00A0;<br />\end{document}
-</div>
+\usepackage[symbols]{glossaries-extra}
+\makeglossaries
+\glsxtrnewsymbol&#x00A0;%&#x00A0;requires&#x00A0;glossaries-extra.sty&#x00A0;'symbols'&#x00A0;option
+&#x00A0;[description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}]
+&#x00A0;{emptyset}%&#x00A0;label&#x00A0;(and&#x00A0;sort&#x00A0;value)
+&#x00A0;{\ensuremath{\emptyset}}%&#x00A0;symbol
+\begin{document}
+\gls{emptyset}
+\printglossaries
+\end{document}
+</pre>
<!--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
@@ -1597,12 +1609,12 @@ class="cmtt-10">.bib </span>file as
</p>
- <div class="verbatim" id="verbatim-36">
+ <pre class="verbatim" id="verbatim-36">
@entry{emptyset,
-&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
-&#x00A0;<br />}
-</div>
+&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+}
+</pre>
<!--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
@@ -1612,12 +1624,12 @@ value. Alternatively you can use:
</p>
- <div class="verbatim" id="verbatim-37">
+ <pre class="verbatim" id="verbatim-37">
@symbol{emptyset,
-&#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
-&#x00A0;<br />&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
-&#x00A0;<br />}
-</div>
+&#x00A0;&#x00A0;name={\ensuremath{\emptyset}},
+&#x00A0;&#x00A0;description={the&#x00A0;set&#x00A0;containing&#x00A0;no&#x00A0;elements}
+}
+</pre>
<!--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
@@ -1630,15 +1642,15 @@ now:
</p>
- <div class="verbatim" id="verbatim-38">
+ <pre class="verbatim" id="verbatim-38">
\documentclass{article}
-&#x00A0;<br />\usepackage[record]{glossaries-extra}
-&#x00A0;<br />\GlsXtrLoadResources[src=entries]
-&#x00A0;<br />\begin{document}
-&#x00A0;<br />\gls{emptyset}
-&#x00A0;<br />\printunsrtglossaries
-&#x00A0;<br />\end{document}
-</div>
+\usepackage[record]{glossaries-extra}
+\GlsXtrLoadResources[src=entries]
+\begin{document}
+\gls{emptyset}
+\printunsrtglossaries
+\end{document}
+</pre>
<!--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
@@ -1744,9 +1756,9 @@ for the plural form. For example:
</p>
- <div class="verbatim" id="verbatim-39">
+ <pre class="verbatim" id="verbatim-39">
\Glspl{set}&#x00A0;are&#x00A0;collections.
-</div>
+</pre>
<!--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
@@ -1763,15 +1775,17 @@ href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span cla
id="sec:printglossaries"></a>Displaying a List of Entries</h3>
<!--l. 943--><p class="noindent" >In <a
href="#sec:start"><span
-class="tcrm-1000">&sect;</span>1 </a><a
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:start </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>
package. These are also available with the extension package <span
-class="cmss-10">glossaries-extra</span>
-along with a fourth option. These four options are listed below in a little
-more detail. <a
-href="#tab:optionsp+c">Table&#x00A0;1</a> summarises the main advantages and disadvantages.
+class="cmss-10">glossaries-extra </span>along
+with a fourth option. These four options are listed below in a little more detail.
+<a
+href="#tab:optionsp+c">Table&#x00A0;<span
+class="cmbx-10">??</span>tab:optionsp+c</a> summarises the main advantages and disadvantages.
(There&#8217;s a more detailed summary in the main <span
class="cmss-10">glossaries </span>user manual.) See also
<a
@@ -1792,7 +1806,7 @@ build</a>.
><span class="id">Table&#x00A0;1: </span><span
class="content">Comparison of Glossary Options</span></div><!--tex4ht:label?: x1-50011 -->
<div class="tabular"> <table id="TBL-2" class="tabular"
-cellspacing="0" cellpadding="0"
+
><colgroup id="TBL-2-1g"><col
id="TBL-2-1" /><col
id="TBL-2-2" /><col
@@ -1974,12 +1988,14 @@ class="cmr-8">Requires some setting up.</span>
</div><hr class="endfloat" />
</div>
<dl class="description"><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 988--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 988--><p class="noindent" ><a
id="option1"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;1</span>:
- <!--l. 990--><p class="noindent" >This is the simplest option but it&#8217;s slow and if you want a sorted list,
+ </p><!--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
@@ -1996,17 +2012,20 @@ class="cmtt-10">=</span><span
class="cmss-10">use</span><a
id="dx1-5005"></a>.
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-5007x1">Add <span
+<li
+ class="enumerate" id="x1-5007x1">
+ <!--l. 998--><p class="noindent" >Add <span
class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start
defining your entries, as described in <a
href="#sec:defterm"><span
-class="tcrm-1000">&sect;</span>2 </a><a
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:defterm </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>).
- </li>
- <li
- class="enumerate" id="x1-5009x2">Put
- <!--l. 1004--><p class="noindent" ><hr><div title="Definition"><span
+ </p></li>
+<li
+ class="enumerate" id="x1-5009x2">
+ <!--l. 1002--><p class="noindent" >Put
+ </p><!--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
@@ -2033,50 +2052,53 @@ class="cmtt-10">\printnoidxglossaries </span></div><hr>
</p>
- <div class="verbatim" id="verbatim-40">
+ <pre class="verbatim" id="verbatim-40">
\printnoidxglossary[sort=word]%&#x00A0;main&#x00A0;glossary
- &#x00A0;<br />\printnoidxglossary[type=symbols,sort=use]%&#x00A0;symbols&#x00A0;glossary
-</div>
+ \printnoidxglossary[type=symbols,sort=use]%&#x00A0;symbols&#x00A0;glossary
+</pre>
<!--l. 1022--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5011x3">Run LaTeX&#x00A0;twice on your document. (As you would do to make a&#x00A0;table
+<li
+ class="enumerate" id="x1-5011x3">
+ <!--l. 1024--><p class="noindent" >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;PDFLaTeX&#8221; button in your editor.</li></ol>
+ or &#8220;PDFLaTeX&#8221; button in your editor.</p></li></ol>
<!--l. 1028--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
</p>
- <div class="verbatim" id="verbatim-41">
+ <pre class="verbatim" id="verbatim-41">
\documentclass{article}
- &#x00A0;<br />\usepackage{glossaries}
- &#x00A0;<br />\makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
- &#x00A0;<br />\newglossaryentry{sample}{name={sample},
- &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
- &#x00A0;<br />\begin{document}
- &#x00A0;<br />A&#x00A0;\gls{sample}.
- &#x00A0;<br />\printnoidxglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;indexed&#x00A0;entries
- &#x00A0;<br />\end{document}
-</div>
+ \usepackage{glossaries}
+ \makenoidxglossaries&#x00A0;%&#x00A0;use&#x00A0;TeX&#x00A0;to&#x00A0;sort
+ \newglossaryentry{sample}{name={sample},
+ &#x00A0;&#x00A0;description={an&#x00A0;example}}
+ \begin{document}
+ A&#x00A0;\gls{sample}.
+ \printnoidxglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;indexed&#x00A0;entries
+ \end{document}
+</pre>
<!--l. 1044--><p class="nopar" > Document build:
</p>
- <div class="verbatim" id="verbatim-42">
+ <pre class="verbatim" id="verbatim-42">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ pdflatex&#x00A0;myDoc
+</pre>
<!--l. 1049--><p class="nopar" >
</p></dd><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1051--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1051--><p class="noindent" ><a
id="option2"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span>:
- <!--l. 1053--><p class="noindent" >This option uses an application called <span
+ </p><!--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 TeX&#x00A0;distributions, but it&#8217;s hard-coded for
@@ -2097,8 +2119,9 @@ class="cmtt-10">makeglossaries</span><a
class="cmtt-10">.aux</span>
file.
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-5018x1">If you are using <span
+<li
+ class="enumerate" id="x1-5018x1">
+ <!--l. 1065--><p class="noindent" >If you are using <span
class="cmss-10">ngerman</span><a
id="dx1-5019"></a><span class="footnote-mark"><a
href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a
@@ -2111,21 +2134,24 @@ class="cmtt-10">\GlsSetQuote </span>to change this to some other character.
- <div class="verbatim" id="verbatim-43">
+</p>
+ <pre class="verbatim" id="verbatim-43">
\GlsSetQuote{+}
-</div>
+</pre>
<!--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>
- <li
- class="enumerate" id="x1-5023x2">Add <span
+<li
+ class="enumerate" id="x1-5023x2">
+ <!--l. 1076--><p class="noindent" >Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
- </li>
- <li
- class="enumerate" id="x1-5025x3">Put
- <!--l. 1081--><p class="noindent" ><hr><div title="Definition"><span
+ </p></li>
+<li
+ class="enumerate" id="x1-5025x3">
+ <!--l. 1079--><p class="noindent" >Put
+ </p><!--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>
@@ -2156,8 +2182,9 @@ class="cmss-10">def</span><a
id="dx1-5028"></a>. </div>
</p><!--l. 1097--><p class="noindent" >
</p></li>
- <li
- class="enumerate" id="x1-5030x4">Run LaTeX&#x00A0;on your document. This creates files with the extensions <span
+<li
+ class="enumerate" id="x1-5030x4">
+ <!--l. 1099--><p class="noindent" >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
@@ -2167,22 +2194,27 @@ 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
+ </p></li>
+<li
+ class="enumerate" id="x1-5032x5">
+ <!--l. 1106--><p class="noindent" >Run <span
class="cmtt-10">makeglossaries</span><a
id="dx1-5033"></a> with the base name of your document (without the
<span
class="cmtt-10">.tex</span>) extension. If you have access to a terminal or a command prompt
+
+
+
(for example, the MSDOS command prompt for Windows users or
the bash console for Unix-like users) then you need to run the
command:
- <div class="verbatim" id="verbatim-44">
+</p>
+ <pre class="verbatim" id="verbatim-44">
makeglossaries&#x00A0;myDoc
-</div>
+</pre>
<!--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
@@ -2194,9 +2226,9 @@ class="cmtt-10">makeglossaries-lite</span><a
</p>
- <div class="verbatim" id="verbatim-45">
+ <pre class="verbatim" id="verbatim-45">
makeglossaries-lite&#x00A0;myDoc
-</div>
+</pre>
<!--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
@@ -2226,9 +2258,9 @@ class="cmss-10">automake</span><a
</p>
- <div class="verbatim" id="verbatim-46">
+ <pre class="verbatim" id="verbatim-46">
\usepackage[automake]{glossaries}
-</div>
+</pre>
<!--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
@@ -2241,59 +2273,62 @@ class="cmss-10">letter</span><a
</p>
- <div class="verbatim" id="verbatim-47">
+ <pre class="verbatim" id="verbatim-47">
\usepackage[order=letter]{glossaries}
-</div>
+</pre>
<!--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
- LaTeX&#x00A0;on your document again.</li></ol>
+<li
+ class="enumerate" id="x1-5041x6">
+ <!--l. 1153--><p class="noindent" >Once you have successfully completed the previous step, you can now run
+ LaTeX&#x00A0;on your document again.</p></li></ol>
<!--l. 1156--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
</p>
- <div class="verbatim" id="verbatim-48">
+ <pre class="verbatim" id="verbatim-48">
\documentclass{article}
- &#x00A0;<br />\usepackage{glossaries}
- &#x00A0;<br />\makeglossaries&#x00A0;%&#x00A0;create&#x00A0;makeindex&#x00A0;files
- &#x00A0;<br />\newglossaryentry{sample}{name={sample},
- &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
- &#x00A0;<br />\begin{document}
- &#x00A0;<br />A&#x00A0;\gls{sample}.
- &#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;makeindex
- &#x00A0;<br />\end{document}
-</div>
+ \usepackage{glossaries}
+ \makeglossaries&#x00A0;%&#x00A0;create&#x00A0;makeindex&#x00A0;files
+ \newglossaryentry{sample}{name={sample},
+ &#x00A0;&#x00A0;description={an&#x00A0;example}}
+ \begin{document}
+ A&#x00A0;\gls{sample}.
+ \printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;makeindex
+ \end{document}
+</pre>
<!--l. 1172--><p class="nopar" > Document build:
</p>
- <div class="verbatim" id="verbatim-49">
+ <pre class="verbatim" id="verbatim-49">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />makeglossaries&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ makeglossaries&#x00A0;myDoc
+ pdflatex&#x00A0;myDoc
+</pre>
<!--l. 1178--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-50">
+ <pre class="verbatim" id="verbatim-50">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />makeglossaries-lite&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ makeglossaries-lite&#x00A0;myDoc
+ pdflatex&#x00A0;myDoc
+</pre>
<!--l. 1184--><p class="nopar" >
</p></dd><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1187--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1187--><p class="noindent" ><a
id="option3"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span>:
- <!--l. 1189--><p class="noindent" >This option uses an application called <span
+ </p><!--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
@@ -2321,8 +2356,9 @@ class="cmtt-10">makeglossaries</span><a
class="cmtt-10">.aux</span>
file.
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-5050x1">Add the <span
+<li
+ class="enumerate" id="x1-5050x1">
+ <!--l. 1204--><p class="noindent" >Add the <span
class="cmss-10">xindy</span><a
id="dx1-5051"></a> option to the <span
class="cmss-10">glossaries</span><a
@@ -2330,19 +2366,22 @@ class="cmss-10">glossaries</span><a
- <div class="verbatim" id="verbatim-51">
+</p>
+ <pre class="verbatim" id="verbatim-51">
\usepackage[xindy]{glossaries}
-</div>
+</pre>
<!--l. 1208--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5054x2">Add <span
+<li
+ class="enumerate" id="x1-5054x2">
+ <!--l. 1210--><p class="noindent" >Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
- </li>
- <li
- class="enumerate" id="x1-5056x3">Put
- <!--l. 1215--><p class="noindent" ><hr><div title="Definition"><span
+ </p></li>
+<li
+ class="enumerate" id="x1-5056x3">
+ <!--l. 1213--><p class="noindent" >Put
+ </p><!--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>
@@ -2371,8 +2410,9 @@ class="cmss-10">def</span><a
id="dx1-5059"></a>. </div>
</p><!--l. 1229--><p class="noindent" >
</p></li>
- <li
- class="enumerate" id="x1-5061x4">Run LaTeX&#x00A0;on your document. This creates files with the extensions <span
+<li
+ class="enumerate" id="x1-5061x4">
+ <!--l. 1231--><p class="noindent" >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
@@ -2382,9 +2422,10 @@ 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
+ </p></li>
+<li
+ class="enumerate" id="x1-5063x5">
+ <!--l. 1238--><p class="noindent" >Run <span
class="cmtt-10">makeglossaries</span><a
id="dx1-5064"></a> with the base name of the document (omitting the
<span
@@ -2395,9 +2436,10 @@ class="cmtt-10">.tex </span>extension). If you have access to a terminal or a co
- <div class="verbatim" id="verbatim-52">
+</p>
+ <pre class="verbatim" id="verbatim-52">
makeglossaries&#x00A0;myDoc
-</div>
+</pre>
<!--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
@@ -2415,14 +2457,16 @@ class="cmtt-10">order=letter </span>package
</p>
- <div class="verbatim" id="verbatim-53">
+ <pre class="verbatim" id="verbatim-53">
\usepackage[xindy,order=letter]{glossaries}
-</div>
+</pre>
<!--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
+<li
+ class="enumerate" id="x1-5067x6">
+ <!--l. 1261--><p class="noindent" >Once you have successfully completed the previous step, you can now run
LaTeX&#x00A0;on your document again.
+</p>
</li></ol>
<!--l. 1265--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
@@ -2430,35 +2474,37 @@ class="cmtt-10">myDoc.tex</span>):
</p>
- <div class="verbatim" id="verbatim-54">
+ <pre class="verbatim" id="verbatim-54">
\documentclass{article}
- &#x00A0;<br />\usepackage[xindy]{glossaries}
- &#x00A0;<br />\makeglossaries&#x00A0;%&#x00A0;create&#x00A0;xindy&#x00A0;files
- &#x00A0;<br />\newglossaryentry{sample}{name={sample},
- &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
- &#x00A0;<br />\begin{document}
- &#x00A0;<br />A&#x00A0;\gls{sample}.
- &#x00A0;<br />\printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;xindy
- &#x00A0;<br />\end{document}
-</div>
+ \usepackage[xindy]{glossaries}
+ \makeglossaries&#x00A0;%&#x00A0;create&#x00A0;xindy&#x00A0;files
+ \newglossaryentry{sample}{name={sample},
+ &#x00A0;&#x00A0;description={an&#x00A0;example}}
+ \begin{document}
+ A&#x00A0;\gls{sample}.
+ \printglossaries&#x00A0;%&#x00A0;input&#x00A0;files&#x00A0;created&#x00A0;by&#x00A0;xindy
+ \end{document}
+</pre>
<!--l. 1281--><p class="nopar" > Document build:
</p>
- <div class="verbatim" id="verbatim-55">
+ <pre class="verbatim" id="verbatim-55">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />makeglossaries&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ makeglossaries&#x00A0;myDoc
+ pdflatex&#x00A0;myDoc
+</pre>
<!--l. 1287--><p class="nopar" >
</p></dd><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1289--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1289--><p class="noindent" ><a
id="option4"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;4</span>:
- <!--l. 1291--><p class="noindent" >This requires the extension package <span
+ </p><!--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
@@ -2480,8 +2526,9 @@ class="cmtt-10">\printunsrtglossary </span>to
class="cmtt-10">\printunsrtglossaries </span>to display them
all).
</p><ol class="enumerate1" >
- <li
- class="enumerate" id="x1-5071x1">Add the <span
+<li
+ class="enumerate" id="x1-5071x1">
+ <!--l. 1306--><p class="noindent" >Add the <span
class="cmss-10">record</span><a
id="dx1-5072"></a> option to the <span
class="cmss-10">glossaries-extra</span><a
@@ -2489,14 +2536,16 @@ class="cmss-10">glossaries-extra</span><a
- <div class="verbatim" id="verbatim-56">
+</p>
+ <pre class="verbatim" id="verbatim-56">
\usepackage[record]{glossaries-extra}
-</div>
+</pre>
<!--l. 1310--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5075x2">Add one or more
- <!--l. 1314--><p class="noindent" ><hr><div title="Definition"><span
+<li
+ class="enumerate" id="x1-5075x2">
+ <!--l. 1312--><p class="noindent" >Add one or more
+ </p><!--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
@@ -2512,34 +2561,34 @@ class="cmtt-10">.bib </span>files containing the
</p>
- <div class="verbatim" id="verbatim-57">
+ <pre class="verbatim" id="verbatim-57">
\usepackage[record,%&#x00A0;using&#x00A0;bib2gls
- &#x00A0;<br />&#x00A0;abbreviations,
- &#x00A0;<br />&#x00A0;symbols,
- &#x00A0;<br />&#x00A0;numbers
- &#x00A0;<br />]{glossaries-extra}
- &#x00A0;<br />\GlsXtrLoadResources[
- &#x00A0;<br />&#x00A0;&#x00A0;src={terms},%&#x00A0;entries&#x00A0;in&#x00A0;terms.bib
- &#x00A0;<br />&#x00A0;&#x00A0;type=main,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'main'&#x00A0;(default)&#x00A0;list
- &#x00A0;<br />&#x00A0;&#x00A0;sort={de-CH-1996}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
- &#x00A0;<br />]
- &#x00A0;<br />\GlsXtrLoadResources[
- &#x00A0;<br />&#x00A0;&#x00A0;src={abbrvs},%&#x00A0;entries&#x00A0;in&#x00A0;abbrvs.bib
- &#x00A0;<br />&#x00A0;&#x00A0;type=abbreviations,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'abbreviations'&#x00A0;list
- &#x00A0;<br />&#x00A0;&#x00A0;sort={letter-case}%&#x00A0;case-sensitive&#x00A0;letter&#x00A0;(non-locale)&#x00A0;sort
- &#x00A0;<br />]
- &#x00A0;<br />\GlsXtrLoadResources[
- &#x00A0;<br />&#x00A0;&#x00A0;src={syms},%&#x00A0;entries&#x00A0;in&#x00A0;syms.bib
- &#x00A0;<br />&#x00A0;&#x00A0;type=symbols,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'symbols'&#x00A0;list
- &#x00A0;<br />&#x00A0;&#x00A0;sort={use}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;first&#x00A0;use&#x00A0;in&#x00A0;the&#x00A0;document
- &#x00A0;<br />]
- &#x00A0;<br />\GlsXtrLoadResources[
- &#x00A0;<br />&#x00A0;&#x00A0;src={constants},%&#x00A0;entries&#x00A0;in&#x00A0;constants.bib
- &#x00A0;<br />&#x00A0;&#x00A0;type=numbers,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'numbers'&#x00A0;list
- &#x00A0;<br />&#x00A0;&#x00A0;sort-field={user1},%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;field
- &#x00A0;<br />&#x00A0;&#x00A0;sort={double}%&#x00A0;double-precision&#x00A0;sort
- &#x00A0;<br />]
-</div>
+ &#x00A0;abbreviations,
+ &#x00A0;symbols,
+ &#x00A0;numbers
+ ]{glossaries-extra}
+ \GlsXtrLoadResources[
+ &#x00A0;&#x00A0;src={terms},%&#x00A0;entries&#x00A0;in&#x00A0;terms.bib
+ &#x00A0;&#x00A0;type=main,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'main'&#x00A0;(default)&#x00A0;list
+ &#x00A0;&#x00A0;sort={de-CH-1996}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
+ ]
+ \GlsXtrLoadResources[
+ &#x00A0;&#x00A0;src={abbrvs},%&#x00A0;entries&#x00A0;in&#x00A0;abbrvs.bib
+ &#x00A0;&#x00A0;type=abbreviations,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'abbreviations'&#x00A0;list
+ &#x00A0;&#x00A0;sort={letter-case}%&#x00A0;case-sensitive&#x00A0;letter&#x00A0;(non-locale)&#x00A0;sort
+ ]
+ \GlsXtrLoadResources[
+ &#x00A0;&#x00A0;src={syms},%&#x00A0;entries&#x00A0;in&#x00A0;syms.bib
+ &#x00A0;&#x00A0;type=symbols,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'symbols'&#x00A0;list
+ &#x00A0;&#x00A0;sort={use}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;first&#x00A0;use&#x00A0;in&#x00A0;the&#x00A0;document
+ ]
+ \GlsXtrLoadResources[
+ &#x00A0;&#x00A0;src={constants},%&#x00A0;entries&#x00A0;in&#x00A0;constants.bib
+ &#x00A0;&#x00A0;type=numbers,%&#x00A0;put&#x00A0;these&#x00A0;entries&#x00A0;in&#x00A0;the&#x00A0;'numbers'&#x00A0;list
+ &#x00A0;&#x00A0;sort-field={user1},%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;field
+ &#x00A0;&#x00A0;sort={double}%&#x00A0;double-precision&#x00A0;sort
+ ]
+</pre>
<!--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
@@ -2549,18 +2598,19 @@ class="cmtt-10">user1 </span>field. For
</p>
- <div class="verbatim" id="verbatim-58">
+ <pre class="verbatim" id="verbatim-58">
@number{pi,
- &#x00A0;<br />&#x00A0;&#x00A0;name={\ensuremath{\pi}},
- &#x00A0;<br />&#x00A0;&#x00A0;description={pi},
- &#x00A0;<br />&#x00A0;&#x00A0;user1={3.141592654}
- &#x00A0;<br />}
-</div>
+ &#x00A0;&#x00A0;name={\ensuremath{\pi}},
+ &#x00A0;&#x00A0;description={pi},
+ &#x00A0;&#x00A0;user1={3.141592654}
+ }
+</pre>
<!--l. 1357--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5077x3">Put
- <!--l. 1361--><p class="noindent" ><hr><div title="Definition"><span
+<li
+ class="enumerate" id="x1-5077x3">
+ <!--l. 1359--><p class="noindent" >Put
+ </p><!--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
@@ -2577,8 +2627,9 @@ class="cmtt-10">\GlsXtrLoadResources</span>
class="cmtt-10">\printunsrtglossaries </span></div><hr>
</p><!--l. 1369--><p class="noindent" >
</p></li>
- <li
- class="enumerate" id="x1-5079x4">Run LaTeX&#x00A0;on your document. The <span
+<li
+ class="enumerate" id="x1-5079x4">
+ <!--l. 1371--><p class="noindent" >Run LaTeX&#x00A0;on your document. The <span
class="cmss-10">record</span><a
id="dx1-5080"></a> option adds information to the
<span
@@ -2590,76 +2641,80 @@ class="cmtt-10">myDoc.tex</span>:
- <div class="verbatim" id="verbatim-59">
+</p>
+ <pre class="verbatim" id="verbatim-59">
pdflatex&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1377--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5083x5">Run <span
+<li
+ class="enumerate" id="x1-5083x5">
+ <!--l. 1379--><p class="noindent" >Run <span
class="cmtt-10">bib2gls</span><a
id="dx1-5084"></a>
- <div class="verbatim" id="verbatim-60">
+</p>
+ <pre class="verbatim" id="verbatim-60">
bib2gls&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1382--><p class="nopar" > or (if you need letter groups)
</p>
- <div class="verbatim" id="verbatim-61">
+ <pre class="verbatim" id="verbatim-61">
bib2gls&#x00A0;--group&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1386--><p class="nopar" >
</p></li>
- <li
- class="enumerate" id="x1-5086x6">Run LaTeX&#x00A0;again.</li></ol>
+<li
+ class="enumerate" id="x1-5086x6">
+ <!--l. 1388--><p class="noindent" >Run LaTeX&#x00A0;again.</p></li></ol>
<!--l. 1390--><p class="noindent" >Here&#8217;s a complete document (<span
class="cmtt-10">myDoc.tex</span>):
</p>
- <div class="verbatim" id="verbatim-62">
+ <pre class="verbatim" id="verbatim-62">
\documentclass{article}
- &#x00A0;<br />\usepackage[record]{glossaries-extra}
- &#x00A0;<br />\GlsXtrLoadResources&#x00A0;%&#x00A0;input&#x00A0;file&#x00A0;created&#x00A0;by&#x00A0;bib2gls
- &#x00A0;<br />&#x00A0;[%&#x00A0;instructions&#x00A0;to&#x00A0;bib2gls:
- &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;src={entries},&#x00A0;%&#x00A0;terms&#x00A0;defined&#x00A0;in&#x00A0;entries.bib
- &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={en-GB}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
- &#x00A0;<br />&#x00A0;]
- &#x00A0;<br />\newglossaryentry{sample}{name={sample},
- &#x00A0;<br />&#x00A0;&#x00A0;description={an&#x00A0;example}}
- &#x00A0;<br />\begin{document}
- &#x00A0;<br />A&#x00A0;\gls{sample}.
- &#x00A0;<br />\printunsrtglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;defined&#x00A0;entries
- &#x00A0;<br />\end{document}
-</div>
+ \usepackage[record]{glossaries-extra}
+ \GlsXtrLoadResources&#x00A0;%&#x00A0;input&#x00A0;file&#x00A0;created&#x00A0;by&#x00A0;bib2gls
+ &#x00A0;[%&#x00A0;instructions&#x00A0;to&#x00A0;bib2gls:
+ &#x00A0;&#x00A0;&#x00A0;src={entries},&#x00A0;%&#x00A0;terms&#x00A0;defined&#x00A0;in&#x00A0;entries.bib
+ &#x00A0;&#x00A0;&#x00A0;sort={en-GB}%&#x00A0;sort&#x00A0;according&#x00A0;to&#x00A0;this&#x00A0;locale
+ &#x00A0;]
+ \newglossaryentry{sample}{name={sample},
+ &#x00A0;&#x00A0;description={an&#x00A0;example}}
+ \begin{document}
+ A&#x00A0;\gls{sample}.
+ \printunsrtglossaries&#x00A0;%&#x00A0;iterate&#x00A0;over&#x00A0;all&#x00A0;defined&#x00A0;entries
+ \end{document}
+</pre>
<!--l. 1410--><p class="nopar" > The accompanying <span
class="cmtt-10">entries.bib </span>file:
</p>
- <div class="verbatim" id="verbatim-63">
+ <pre class="verbatim" id="verbatim-63">
@entry{sample,
- &#x00A0;<br />&#x00A0;&#x00A0;name&#x00A0;=&#x00A0;{sample},
- &#x00A0;<br />&#x00A0;&#x00A0;description&#x00A0;=&#x00A0;{an&#x00A0;example}
- &#x00A0;<br />}
-</div>
+ &#x00A0;&#x00A0;name&#x00A0;=&#x00A0;{sample},
+ &#x00A0;&#x00A0;description&#x00A0;=&#x00A0;{an&#x00A0;example}
+ }
+</pre>
<!--l. 1417--><p class="nopar" > Document build:
</p>
- <div class="verbatim" id="verbatim-64">
+ <pre class="verbatim" id="verbatim-64">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />bib2gls&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ bib2gls&#x00A0;myDoc
+ pdflatex&#x00A0;myDoc
+</pre>
<!--l. 1423--><p class="nopar" >
</p>
</dd></dl>
@@ -2678,22 +2733,22 @@ class="cmtt-10">myDoc.tex </span>might start with:
</p>
- <div class="verbatim" id="verbatim-65">
+ <pre class="verbatim" id="verbatim-65">
&#x00A0;%&#x00A0;arara:&#x00A0;pdflatex
-&#x00A0;<br />&#x00A0;%&#x00A0;arara:&#x00A0;makeglossaries
-&#x00A0;<br />&#x00A0;%&#x00A0;arara:&#x00A0;pdflatex
-&#x00A0;<br />&#x00A0;\documentclass{article}
-&#x00A0;<br />&#x00A0;\usepackage{glossaries}
-&#x00A0;<br />&#x00A0;\makeglossaries
-</div>
+&#x00A0;%&#x00A0;arara:&#x00A0;makeglossaries
+&#x00A0;%&#x00A0;arara:&#x00A0;pdflatex
+&#x00A0;\documentclass{article}
+&#x00A0;\usepackage{glossaries}
+&#x00A0;\makeglossaries
+</pre>
<!--l. 1440--><p class="nopar" > then to build the document you just need the single system call:
</p>
- <div class="verbatim" id="verbatim-66">
+ <pre class="verbatim" id="verbatim-66">
&#x00A0;arara&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1444--><p class="nopar" > (As from version 4.0, <span
class="cmtt-10">arara</span><a
id="dx1-5090"></a> also has directives for <span
@@ -2713,70 +2768,77 @@ earlier definition:
</p>
- <div class="verbatim" id="verbatim-67">
+ <pre class="verbatim" id="verbatim-67">
&#x00A0;\newglossaryentry{elite}
-&#x00A0;<br />&#x00A0;{
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={{\'e}lite},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
-&#x00A0;<br />&#x00A0;}
-</div>
+&#x00A0;{
+&#x00A0;&#x00A0;&#x00A0;name={{\'e}lite},
+&#x00A0;&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
+&#x00A0;}
+</pre>
<!--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
is interpreted depends on which option you have used:
</p><dl class="description"><dt class="description">
+ <!--l. 1464--><p class="noindent" >
<a
href="#option1"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;1</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description">By default, the accent command will be stripped so the sort value
- will be <span
-class="cmtt-10">elite</span>. This will put the entry in the &#8220;E&#8221; letter group. However
- if you use the <span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1464--><p class="noindent" >By default, the accent command will be stripped so the sort value will be
+ <span
+class="cmtt-10">elite</span>. This will put the entry in the &#8220;E&#8221; letter group. However if you use
+ the <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-5094"></a> package option, the sort value will be
- interpreted as the sequence of characters: <span class="obeylines-h"><span class="verb"><span
+ id="dx1-5094"></a> package option, the sort value will be interpreted as
+ the sequence of characters: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span> <span
class="cmtt-10">&#8217; e </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-10">}</span></span></span> <span
class="cmtt-10">l i t </span>and <span
-class="cmtt-10">e</span>. This will
- place this entry in the &#8220;symbols&#8221; group since it starts with a symbol.
- </dd><dt class="description">
+class="cmtt-10">e</span>. This will place this entry
+ in the &#8220;symbols&#8221; group since it starts with a symbol.
+ </p></dd><dt class="description">
+ <!--l. 1472--><p class="noindent" >
<a
href="#option2"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description">The sort key will be interpreted the sequence of characters: <span class="obeylines-h"><span class="verb"><span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1472--><p class="noindent" >The sort key will be interpreted the sequence of characters: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">&#8217;</span></span></span> <span
-class="cmtt-10">e</span>
- <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">}</span></span></span><span
-class="cmtt-10">lit </span>and <span
+class="cmtt-10">e </span><span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">}</span></span></span> <span
+class="cmtt-10">l i</span>
+ <span
+class="cmtt-10">t </span>and <span
class="cmtt-10">e</span>. The first character is an opening curly brace <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> so <span
class="cmtt-10">makeindex</span><a
- id="dx1-5095"></a>
- will put this entry in the &#8220;symbols&#8221; group.
- </dd><dt class="description">
+ id="dx1-5095"></a> will
+ put this entry in the &#8220;symbols&#8221; group.
+ </p></dd><dt class="description">
+ <!--l. 1478--><p class="noindent" >
<a
href="#option3"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description"><span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1478--><p class="noindent" ><span
class="cmtt-10">xindy</span><a
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
+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
@@ -2786,7 +2848,7 @@ class="cmtt-10">sort </span>value that <span
class="cmtt-10">xindy</span><a
id="dx1-5098"></a> will
accept.
- <!--l. 1485--><p class="noindent" ><div class="important" title="Important Note"> <span
+ </p><!--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
@@ -2797,12 +2859,17 @@ class="cmtt-10">xindy</span><a
has stripped all commands and braces. </div>
</p><!--l. 1490--><p class="noindent" >
</p></dd><dt class="description">
+
+
+
+ <!--l. 1492--><p class="noindent" >
<a
href="#option4"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;4</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description"><span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1492--><p class="noindent" ><span
class="cmtt-10">bib2gls</span><a
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
@@ -2814,14 +2881,11 @@ class="cmtt-10">lite</span>. It disregards unknown
class="cmtt-10">bib2gls</span><a
id="dx1-5103"></a> doesn&#8217;t mind
that.
- <!--l. 1499--><p class="noindent" >Note that even if the name is given as <span class="obeylines-h"><span class="verb"><span
+ </p><!--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 É
depending on the locale used by the sort comparator. In this case you
-
-
-
will need to ensure the document can support this character either
with <span
class="cmss-10">inputenc</span><a
@@ -2841,9 +2905,9 @@ class="cmss-10">inputenc</span><a
</p>
- <div class="verbatim" id="verbatim-68">
+ <pre class="verbatim" id="verbatim-68">
&#x00A0;\usepackage[utf8]{inputenc}
-</div>
+</pre>
<!--l. 1516--><p class="nopar" > and the entry is defined as: </p><div class="alltt">
<div class="obeylines-v">
<span
@@ -2873,59 +2937,70 @@ class="cmtt-10">}</span></span>
</div>
</div> then:
<dl class="description"><dt class="description">
+ <!--l. 1527--><p class="noindent" >
<a
href="#option1"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;1</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description">By default the sort value will be interpreted as <span
-class="cmtt-10">elite </span>so the entry
- will be put in the &#8220;E&#8221; letter group. If you use the <span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1527--><p class="noindent" >By default the sort value will be interpreted as <span
+class="cmtt-10">elite </span>so the entry will be
+ put in the &#8220;E&#8221; letter group. If you use the <span
class="cmss-10">sanitizesort</span><span
class="cmtt-10">=</span><span
class="cmss-10">true</span><a
- id="dx1-5107"></a> package
- option, the sort value will be interpreted as <span
+ 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
- sanitized (so it&#8217;s no longer an active character and is in fact seen as two
- octets 0xC3 0xA9) which will put this entry before the &#8220;A&#8221; letter group.
- (The group is determined by the first octet 0xC3.)
- </dd><dt class="description">
+class="cmtt-10">lite </span>where &eacute; has been sanitized
+ (so it&#8217;s no longer an active character and is in fact seen as two octets 0xC3
+ 0xA9) which will put this entry before the &#8220;A&#8221; letter group. (The group
+ is determined by the first octet 0xC3.)
+ </p></dd><dt class="description">
+ <!--l. 1536--><p class="noindent" >
<a
href="#option2"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description"><span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1536--><p class="noindent" ><span
class="cmtt-10">makeindex</span><a
- id="dx1-5108"></a> sees <span
-class="cmtt-10">&eacute;</span> as two octets (0xC3 0xA9) rather than a single
+ 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
class="cmtt-10">lite </span>in the 0xC3 (&#8220;&Atilde;&#8221;) letter group (which,
in this case, comes after &#8220;Z&#8221;).
- </dd><dt class="description">
+ </p></dd><dt class="description">
+ <!--l. 1541--><p class="noindent" >
<a
href="#option3"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description"><span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1541--><p class="noindent" ><span
class="cmtt-10">xindy</span><a
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.
- (In English, this would just be the &#8220;E&#8221; letter group, but another language
+class="cmtt-10">lite </span>and will place it in
+ whatever letter group is appropriate for the given language setting. (In
+ English, this would just be the &#8220;E&#8221; letter group, but another language
might put it in the &#8220;É&#8221; letter group.)
- </dd><dt class="description">
+
+
+
+ </p></dd><dt class="description">
+ <!--l. 1547--><p class="noindent" >
<a
href="#option4"><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;4</span></a><span
-class="cmbx-10">:</span> </dt><dd
-class="description">The <span
+class="cmbx-10">:</span> </p></dt><dd
+class="description">
+ <!--l. 1547--><p class="noindent" >The <span
class="cmss-10">inputenc</span><a
id="dx1-5110"></a> package doesn&#8217;t affect the encoding used with <span
class="cmtt-10">.bib </span>entry
@@ -2936,15 +3011,12 @@ class="cmtt-10">.bib </span>file
class="cmtt-10">bib2gls</span><a
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">
+class="cmtt-10">.bib </span>file: </p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">%</span><span
class="cmtt-10">&#x00A0;Encoding:</span><span
class="cmtt-10">&#x00A0;UTF-8</span>
-
-
-
</div>
</div>
<!--l. 1556--><p class="noindent" >With the correct encoding set up, <span
@@ -2984,14 +3056,14 @@ this:
</p>
- <div class="verbatim" id="verbatim-69">
+ <pre class="verbatim" id="verbatim-69">
\newglossaryentry{elite}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={{\'e}lite},
-&#x00A0;<br />&#x00A0;&#x00A0;sort={elite},
-&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={{\'e}lite},
+&#x00A0;&#x00A0;sort={elite},
+&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
+}
+</pre>
<!--l. 1577--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span
@@ -3051,10 +3123,10 @@ example:
</p>
- <div class="verbatim" id="verbatim-70">
+ <pre class="verbatim" id="verbatim-70">
&#x00A0;\newglossaryentry{P}{name={\P},sort={P},
-&#x00A0;<br />&#x00A0;&#x00A0;description={paragraph&#x00A0;symbol}}
-</div>
+&#x00A0;&#x00A0;description={paragraph&#x00A0;symbol}}
+</pre>
<!--l. 1598--><p class="nopar" >
</p>
<!--l. 1600--><p class="noindent" ><a
@@ -3073,9 +3145,9 @@ class="cmtt-10">\glsnamefont</span>:
</p>
- <div class="verbatim" id="verbatim-71">
+ <pre class="verbatim" id="verbatim-71">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
-</div>
+</pre>
<!--l. 1610--><p class="nopar" > Some classes and packages redefine the <span
class="cmss-10">description</span><a
id="dx1-6003"></a><a
@@ -3094,18 +3166,18 @@ option:
</p>
- <div class="verbatim" id="verbatim-72">
+ <pre class="verbatim" id="verbatim-72">
\usepackage[nopostdot]{glossaries}
-</div>
+</pre>
<!--l. 1621--><p class="nopar" > or to add it with <span
class="cmss-10">glossaries-extra</span>:
</p>
- <div class="verbatim" id="verbatim-73">
+ <pre class="verbatim" id="verbatim-73">
\usepackage[postdot]{glossaries-extra}
-</div>
+</pre>
<!--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
@@ -3117,31 +3189,32 @@ Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a> described in <a
href="#sec:printglossaries"><span
-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
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:printglossaries </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
class="cmtt-10">bib2gls</span><a
id="dx1-6008"></a> and <span
class="cmss-10">glossaries-extra</span><a
- id="dx1-6009"></a>) then location ranges will be compressed. For example, if
-an entry was used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
-href="#option2">2</a> or&#x00A0;<a
+ id="dx1-6009"></a>) then location ranges will be
+compressed. For example, if an entry was used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
+href="#option2">2</a>
+or&#x00A0;<a
href="#option3">3</a> or <a
-href="#option4">Option&#x00A0;4</a> the
-location list will appear as 1&#8211;3, but with <a
-href="#option1">Option&#x00A0;1</a> it will appear as 1, 2, 3. If you
-don&#8217;t want the locations displayed you can hide them using the <span
+href="#option4">Option&#x00A0;4</a> the location list will appear as 1&#8211;3, but with <a
+href="#option1">Option&#x00A0;1</a> it will
+appear as 1, 2, 3. If you don&#8217;t want the locations displayed you can hide them using
+the <span
class="cmss-10">nonumberlist</span><a
- id="dx1-6010"></a> package
-option:
+ id="dx1-6010"></a> package option:
</p>
- <div class="verbatim" id="verbatim-74">
+ <pre class="verbatim" id="verbatim-74">
\usepackage[nonumberlist]{glossaries}
-</div>
+</pre>
<!--l. 1639--><p class="nopar" > or with <span
class="cmtt-10">bib2gls</span><a
id="dx1-6011"></a> use <span
@@ -3160,9 +3233,9 @@ option:
</p>
- <div class="verbatim" id="verbatim-75">
+ <pre class="verbatim" id="verbatim-75">
\usepackage[nogroupskip]{glossaries}
-</div>
+</pre>
<!--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:
@@ -3180,9 +3253,9 @@ a&#x00A0;style that suits your document. For example:
</p>
- <div class="verbatim" id="verbatim-76">
+ <pre class="verbatim" id="verbatim-76">
\setglossarystyle{index}
-</div>
+</pre>
<!--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:
@@ -3190,14 +3263,15 @@ class="cmss-10">style</span><a
</p>
- <div class="verbatim" id="verbatim-77">
+ <pre class="verbatim" id="verbatim-77">
\usepackage[style=index]{glossaries}
-</div>
+</pre>
<!--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
+<li
+ class="enumerate" id="x1-6015x1">
+ <!--l. 1674--><p class="noindent" >You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief
phrase or short sentence. Try one of the &#8220;mcol&#8221; styles defined in the
<span
class="cmss-10">glossary-mcols</span><a
@@ -3205,60 +3279,65 @@ class="cmss-10">glossary-mcols</span><a
- <div class="verbatim" id="verbatim-78">
+</p>
+ <pre class="verbatim" id="verbatim-78">
\usepackage[nopostdot]{glossaries}
- &#x00A0;<br />\usepackage{glossary-mcols}
- &#x00A0;<br />\setglossarystyle{mcolindex}
-</div>
+ \usepackage{glossary-mcols}
+ \setglossarystyle{mcolindex}
+</pre>
<!--l. 1681--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-79">
+ <pre class="verbatim" id="verbatim-79">
\usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra}
-</div>
+</pre>
<!--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
+<li
+ class="enumerate" id="x1-6018x2">
+ <!--l. 1687--><p class="noindent" >You have entries where the name is a&#x00A0;word or phrase and the description spans
multiple paragraphs. Try one of the &#8220;altlist&#8221; styles. For example:
- <div class="verbatim" id="verbatim-80">
+</p>
+ <pre class="verbatim" id="verbatim-80">
\usepackage[nopostdot]{glossaries}
- &#x00A0;<br />\setglossarystyle{altlist}
-</div>
+ \setglossarystyle{altlist}
+</pre>
<!--l. 1693--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-81">
+ <pre class="verbatim" id="verbatim-81">
\usepackage[stylemods,style=altlist]{glossaries-extra}
-</div>
+</pre>
<!--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
+<li
+ class="enumerate" id="x1-6020x3">
+ <!--l. 1699--><p class="noindent" >You have entries where the name is a&#x00A0;single word, the description is
brief, and an associated symbol has been set. Use one of the styles that
display the symbol (not all of them do). For example, one of the tabular
styles:
- <div class="verbatim" id="verbatim-82">
+</p>
+ <pre class="verbatim" id="verbatim-82">
\usepackage[nopostdot,nonumberlist,style=long4col]{glossaries}
-</div>
+</pre>
<!--l. 1705--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
</p>
- <div class="verbatim" id="verbatim-83">
+ <pre class="verbatim" id="verbatim-83">
\usepackage[nopostdot,nonumberlist,style=tree]{glossaries}
-</div>
+</pre>
<!--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
@@ -3269,19 +3348,19 @@ style:
</p>
- <div class="verbatim" id="verbatim-84">
+ <pre class="verbatim" id="verbatim-84">
\setacronymstyle{long-short-desc}
-</div>
+</pre>
<!--l. 1718--><p class="nopar" > Define the acronyms with a&#x00A0;description:
</p>
- <div class="verbatim" id="verbatim-85">
+ <pre class="verbatim" id="verbatim-85">
\newacronym
-&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
-&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-</div>
+&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
+&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+</pre>
<!--l. 1724--><p class="nopar" > Alternatively with <span
class="cmss-10">glossaries-extra</span><a
id="dx1-6021"></a>:
@@ -3289,21 +3368,21 @@ class="cmss-10">glossaries-extra</span><a
</p>
- <div class="verbatim" id="verbatim-86">
+ <pre class="verbatim" id="verbatim-86">
\setabbreviationstyle{long-short-desc}
-&#x00A0;<br />\newabbreviation
-&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
-&#x00A0;<br />&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
-</div>
+\newabbreviation
+&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
+&#x00A0;{svm}{SVM}{support&#x00A0;vector&#x00A0;machine}
+</pre>
<!--l. 1732--><p class="nopar" >
</p><!--l. 1734--><p class="indent" > Choose a&#x00A0;glossary style that suits wide entry names. For example:
</p>
- <div class="verbatim" id="verbatim-87">
+ <pre class="verbatim" id="verbatim-87">
\setglossarystyle{altlist}
-</div>
+</pre>
<!--l. 1737--><p class="nopar" >
</p><!--l. 1739--><p class="noindent" >
</p>
@@ -3316,12 +3395,13 @@ class="cmss-10">glossaries</span><a
class="cmtt-10">main </span>glossary. When you define an entry
(using one of the commands described in <a
href="#sec:defterm"><span
-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:
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:defterm </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. 1749--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary[</span>&#x27E8;<span
class="cmitt-10">glg</span>&#x27E9;<span
@@ -3343,25 +3423,27 @@ argument &#x27E8;<span
class="cmti-10">title</span>&#x27E9; is the section or chapter heading used by <span
class="cmtt-10">\printglossary </span>or
<span
-class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions used by
-<span
+class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions
+used by <span
class="cmtt-10">makeindex</span><a
id="dx1-7002"></a>/<span
class="cmtt-10">xindy</span><a
id="dx1-7003"></a> (described in <a
href="#sec:printglossaries"><span
-class="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
+class="tcrm-1000">&sect;</span><span
+class="cmbx-10">??</span>sec:printglossaries </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
class="cmtt-10">bib2gls</span><a
- id="dx1-7004"></a> and <span
+ id="dx1-7004"></a> and
+<span
class="cmtt-10">\printunsrtglossaries</span>), then the &#x27E8;<span
class="cmti-10">glg</span>&#x27E9;, &#x27E8;<span
class="cmti-10">gls</span>&#x27E9; and &#x27E8;<span
-class="cmti-10">glo</span>&#x27E9;
-arguments aren&#8217;t relevant, in which case you may prefer to use the starred version
-where you don&#8217;t specify the extensions:
+class="cmti-10">glo</span>&#x27E9; 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
@@ -3393,9 +3475,9 @@ class="cmss-10">acronyms</span><a
</p>
- <div class="verbatim" id="verbatim-88">
+ <pre class="verbatim" id="verbatim-88">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-</div>
+</pre>
<!--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
@@ -3428,10 +3510,10 @@ a&#x00A0;list of notation:
</p>
- <div class="verbatim" id="verbatim-89">
+ <pre class="verbatim" id="verbatim-89">
&#x00A0;\usepackage[acronyms]{glossaries}
-&#x00A0;<br />&#x00A0;\newglossary[nlg]{notation}{not}{ntn}{Notation}
-</div>
+&#x00A0;\newglossary[nlg]{notation}{not}{ntn}{Notation}
+</pre>
<!--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
@@ -3440,36 +3522,36 @@ the preamble. For example:
</p>
- <div class="verbatim" id="verbatim-90">
+ <pre class="verbatim" id="verbatim-90">
&#x00A0;\newglossaryentry{gls:set}
-&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`main'&#x00A0;glossary
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name=set,
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;collection&#x00A0;of&#x00A0;distinct&#x00A0;objects}
-&#x00A0;<br />&#x00A0;}
-&#x00A0;<br />&#x00A0;%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`acronym'&#x00A0;glossary:
-&#x00A0;<br />&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />&#x00A0;\newglossaryentry{not:set}
-&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;type=notation,
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={\ensuremath{\mathcal{S}}},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
-</div>
+&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`main'&#x00A0;glossary
+&#x00A0;&#x00A0;&#x00A0;name=set,
+&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;collection&#x00A0;of&#x00A0;distinct&#x00A0;objects}
+&#x00A0;}
+&#x00A0;%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`acronym'&#x00A0;glossary:
+&#x00A0;\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+&#x00A0;\newglossaryentry{not:set}
+&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
+&#x00A0;&#x00A0;&#x00A0;type=notation,
+&#x00A0;&#x00A0;&#x00A0;name={\ensuremath{\mathcal{S}}},
+&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
+&#x00A0;&#x00A0;&#x00A0;sort={S}}
+</pre>
<!--l. 1815--><p class="nopar" > or if you don&#8217;t like using <span
class="cmtt-10">\ensuremath</span>:
</p>
- <div class="verbatim" id="verbatim-91">
+ <pre class="verbatim" id="verbatim-91">
&#x00A0;\newglossaryentry{not:set}
-&#x00A0;<br />&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;type=notation,
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={$\mathcal{S}$},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;text={\mathcal{S}},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;sort={S}}
-</div>
+&#x00A0;{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;`notation'&#x00A0;glossary:
+&#x00A0;&#x00A0;&#x00A0;type=notation,
+&#x00A0;&#x00A0;&#x00A0;name={$\mathcal{S}$},
+&#x00A0;&#x00A0;&#x00A0;text={\mathcal{S}},
+&#x00A0;&#x00A0;&#x00A0;description={A&#x00A0;set},
+&#x00A0;&#x00A0;&#x00A0;sort={S}}
+</pre>
<!--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
@@ -3506,31 +3588,31 @@ Instead you can assign the entry type with the resource command. For example:
</p>
- <div class="verbatim" id="verbatim-92">
+ <pre class="verbatim" id="verbatim-92">
&#x00A0;\usepackage[record,abbreviations,symbols]{glossaries-extra}
-&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
-&#x00A0;<br />&#x00A0;&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
-&#x00A0;<br />&#x00A0;]
-&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
-&#x00A0;<br />&#x00A0;&#x00A0;type={abbreviations}%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
-&#x00A0;<br />&#x00A0;]
-&#x00A0;<br />&#x00A0;\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
-&#x00A0;<br />&#x00A0;&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
-&#x00A0;<br />&#x00A0;]
-</div>
+&#x00A0;\GlsXtrLoadResources[
+&#x00A0;&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
+&#x00A0;&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
+&#x00A0;]
+&#x00A0;\GlsXtrLoadResources[
+&#x00A0;&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
+&#x00A0;&#x00A0;type={abbreviations}%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
+&#x00A0;]
+&#x00A0;\GlsXtrLoadResources[
+&#x00A0;&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
+&#x00A0;&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
+&#x00A0;]
+</pre>
<!--l. 1861--><p class="nopar" > Later in the document:
</p>
- <div class="verbatim" id="verbatim-93">
+ <pre class="verbatim" id="verbatim-93">
&#x00A0;\printunsrtglossary&#x00A0;%&#x00A0;main
-&#x00A0;<br />&#x00A0;\printunsrtglossary[type=abbreviations]
-&#x00A0;<br />&#x00A0;\printunsrtglossary[type=symbols]
-</div>
+&#x00A0;\printunsrtglossary[type=abbreviations]
+&#x00A0;\printunsrtglossary[type=symbols]
+</pre>
<!--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:
@@ -3598,35 +3680,39 @@ class="cmtt-10">notation</span>), specified using:
</p>
- <div class="verbatim" id="verbatim-94">
+ <pre class="verbatim" id="verbatim-94">
\usepackage[acronyms]{glossaries}
-&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
-</div>
+\newglossary[nlg]{notation}{not}{ntn}{Notation}
+</pre>
<!--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. 1908--><p class="indent" >
</p><dl class="description"><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1909--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1909--><p class="noindent" ><a
href="#option2">Option&#x00A0;2</a> Either use one <span
class="cmtt-10">makeglossaries</span><a
id="dx1-7023"></a> or <span
class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-7024"></a> call:
+ id="dx1-7024"></a>
+ call:
- <div class="verbatim" id="verbatim-95">
+</p>
+ <pre class="verbatim" id="verbatim-95">
makeglossaries&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1914--><p class="nopar" > or
</p>
- <div class="verbatim" id="verbatim-96">
+ <pre class="verbatim" id="verbatim-96">
makeglossaries-lite&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1918--><p class="nopar" > Or you need to run <span
class="cmtt-10">makeindex</span><a
id="dx1-7025"></a> three times:
@@ -3634,24 +3720,27 @@ class="cmtt-10">makeindex</span><a
</p>
- <div class="verbatim" id="verbatim-97">
+ <pre class="verbatim" id="verbatim-97">
makeindex&#x00A0;-t&#x00A0;myDoc.glg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
- &#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.alg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
- &#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.nlg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
-</div>
+ makeindex&#x00A0;-t&#x00A0;myDoc.alg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
+ makeindex&#x00A0;-t&#x00A0;myDoc.nlg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
+</pre>
<!--l. 1924--><p class="nopar" >
</p></dd><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1926--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1926--><p class="noindent" ><a
href="#option3">Option&#x00A0;3</a> Either use one <span
class="cmtt-10">makeglossaries</span><a
id="dx1-7026"></a> call:
- <div class="verbatim" id="verbatim-98">
+</p>
+ <pre class="verbatim" id="verbatim-98">
makeglossaries&#x00A0;myDoc
-</div>
+</pre>
<!--l. 1930--><p class="nopar" > Or you need to run <span
class="cmtt-10">xindy</span><a
id="dx1-7027"></a> three times (be careful not to insert line breaks
@@ -3660,29 +3749,32 @@ class="cmtt-10">xindy</span><a
</p>
- <div class="verbatim" id="verbatim-99">
+ <pre class="verbatim" id="verbatim-99">
xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.glg
- &#x00A0;<br />-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
- &#x00A0;<br />xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.alg
- &#x00A0;<br />-o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
- &#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>
+ -o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
+ xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.alg
+ -o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
+ xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.nlg
+ -o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
+</pre>
<!--l. 1940--><p class="nopar" >
</p></dd><dt class="description">
- </dt><dd
-class="description"><a
+ <!--l. 1942--><p class="noindent" >
+ </p></dt><dd
+class="description">
+ <!--l. 1942--><p class="noindent" ><a
href="#option4">Option&#x00A0;4</a> With <span
class="cmtt-10">bib2gls</span><a
id="dx1-7028"></a> only one call is required:
- <div class="verbatim" id="verbatim-100">
+</p>
+ <pre class="verbatim" id="verbatim-100">
pdflatex&#x00A0;myDoc
- &#x00A0;<br />bib2gls&#x00A0;--group&#x00A0;myDoc
- &#x00A0;<br />pdflatex&#x00A0;myDoc
-</div>
+ bib2gls&#x00A0;--group&#x00A0;myDoc
+ pdflatex&#x00A0;myDoc
+</pre>
<!--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. 1953--><p class="noindent" >
@@ -3712,10 +3804,10 @@ class="cmss-10">hyperref</span><a
</p>
- <div class="verbatim" id="verbatim-101">
+ <pre class="verbatim" id="verbatim-101">
\usepackage[colorlinks]{hyperref}
-&#x00A0;<br />\usepackage{glossaries}
-</div>
+\usepackage{glossaries}
+</pre>
<!--l. 1963--><p class="nopar" > If you use <span
class="cmss-10">hyperref</span><a
id="dx1-8007"></a> make sure you use PDFLaTeX&#x00A0;rather than the LaTeX&#x00A0;to DVI
@@ -3746,11 +3838,11 @@ glossary, then do:
</p>
- <div class="verbatim" id="verbatim-102">
+ <pre class="verbatim" id="verbatim-102">
\usepackage[colorlinks]{hyperref}
-&#x00A0;<br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
-&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
-</div>
+\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
+\newglossary[nlg]{notation}{not}{ntn}{Notation}
+</pre>
<!--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
@@ -3763,10 +3855,10 @@ option:
</p>
- <div class="verbatim" id="verbatim-103">
+ <pre class="verbatim" id="verbatim-103">
\usepackage[colorlinks]{hyperref}
-&#x00A0;<br />\usepackage[hyperfirst=false]{glossaries}
-</div>
+\usepackage[hyperfirst=false]{glossaries}
+</pre>
<!--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
@@ -3791,9 +3883,9 @@ class="cmtt-10">\texorpdfstring</span>. For example:
</p>
- <div class="verbatim" id="verbatim-104">
+ <pre class="verbatim" id="verbatim-104">
\section{The&#x00A0;\texorpdfstring{\gls{fishage}}{Fish&#x00A0;Age}}
-</div>
+</pre>
<!--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 page in your location list. Instead you can
@@ -3810,9 +3902,9 @@ For example, the following works:
</p>
- <div class="verbatim" id="verbatim-105">
+ <pre class="verbatim" id="verbatim-105">
\section{The&#x00A0;\glsentrytext{fishage}}
-</div>
+</pre>
<!--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
@@ -3822,9 +3914,9 @@ use in section headers. For example:
</p>
- <div class="verbatim" id="verbatim-106">
+ <pre class="verbatim" id="verbatim-106">
\section{The&#x00A0;\glsfmttext{fishage}}
-</div>
+</pre>
<!--l. 2025--><p class="nopar" >
</p><!--l. 2027--><p class="noindent" >
</p>
@@ -3842,21 +3934,21 @@ defined.
</p>
- <div class="verbatim" id="verbatim-107">
+ <pre class="verbatim" id="verbatim-107">
\longnewglossaryentry{devonian}{name={Devonian}}%
-&#x00A0;<br />{%
-&#x00A0;<br />&#x00A0;&#x00A0;The&#x00A0;geologic&#x00A0;period&#x00A0;spanning&#x00A0;from&#x00A0;the&#x00A0;end&#x00A0;of&#x00A0;the
-&#x00A0;<br />&#x00A0;&#x00A0;Silurian&#x00A0;Period&#x00A0;to&#x00A0;the&#x00A0;beginning&#x00A0;of&#x00A0;the&#x00A0;Carboniferous&#x00A0;Period.
-&#x00A0;<br />&#x00A0;&#x00A0;This&#x00A0;age&#x00A0;was&#x00A0;known&#x00A0;for&#x00A0;its&#x00A0;remarkable&#x00A0;variety&#x00A0;of
-&#x00A0;<br />&#x00A0;&#x00A0;fish&#x00A0;species.
-&#x00A0;<br />}
-&#x00A0;<br />\newglossaryentry{fishage}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={Fish&#x00A0;Age},
-&#x00A0;<br />&#x00A0;&#x00A0;description={Common&#x00A0;name&#x00A0;for&#x00A0;the&#x00A0;Devonian&#x00A0;period},
-&#x00A0;<br />&#x00A0;&#x00A0;see={devonian}
-&#x00A0;<br />}
-</div>
+{%
+&#x00A0;&#x00A0;The&#x00A0;geologic&#x00A0;period&#x00A0;spanning&#x00A0;from&#x00A0;the&#x00A0;end&#x00A0;of&#x00A0;the
+&#x00A0;&#x00A0;Silurian&#x00A0;Period&#x00A0;to&#x00A0;the&#x00A0;beginning&#x00A0;of&#x00A0;the&#x00A0;Carboniferous&#x00A0;Period.
+&#x00A0;&#x00A0;This&#x00A0;age&#x00A0;was&#x00A0;known&#x00A0;for&#x00A0;its&#x00A0;remarkable&#x00A0;variety&#x00A0;of
+&#x00A0;&#x00A0;fish&#x00A0;species.
+}
+\newglossaryentry{fishage}
+{
+&#x00A0;&#x00A0;name={Fish&#x00A0;Age},
+&#x00A0;&#x00A0;description={Common&#x00A0;name&#x00A0;for&#x00A0;the&#x00A0;Devonian&#x00A0;period},
+&#x00A0;&#x00A0;see={devonian}
+}
+</pre>
<!--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
@@ -3868,21 +3960,21 @@ class="cmti-10">label</span>&#x27E9;. For example:
</p>
- <div class="verbatim" id="verbatim-108">
+ <pre class="verbatim" id="verbatim-108">
\newglossaryentry{latinalph}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
-&#x00A0;<br />&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z},
-&#x00A0;<br />&#x00A0;&#x00A0;see=[see&#x00A0;also]{exlatinalph}
-&#x00A0;<br />}
-&#x00A0;<br />\newglossaryentry{exlatinalph}
-&#x00A0;<br />{
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;name={extended&#x00A0;Latin&#x00A0;alphabet},
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;description={The&#x00A0;Latin&#x00A0;alphabet&#x00A0;extended&#x00A0;to&#x00A0;include
-&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;other&#x00A0;letters&#x00A0;such&#x00A0;as&#x00A0;ligatures&#x00A0;or&#x00A0;diacritics.}
-&#x00A0;<br />}
-</div>
+{
+&#x00A0;&#x00A0;name={Latin&#x00A0;alphabet},
+&#x00A0;&#x00A0;description={alphabet&#x00A0;consisting&#x00A0;of&#x00A0;the&#x00A0;letters
+&#x00A0;&#x00A0;a,&#x00A0;\ldots,&#x00A0;z,&#x00A0;A,&#x00A0;\ldots,&#x00A0;Z},
+&#x00A0;&#x00A0;see=[see&#x00A0;also]{exlatinalph}
+}
+\newglossaryentry{exlatinalph}
+{
+&#x00A0;&#x00A0;&#x00A0;name={extended&#x00A0;Latin&#x00A0;alphabet},
+&#x00A0;&#x00A0;&#x00A0;description={The&#x00A0;Latin&#x00A0;alphabet&#x00A0;extended&#x00A0;to&#x00A0;include
+&#x00A0;&#x00A0;&#x00A0;other&#x00A0;letters&#x00A0;such&#x00A0;as&#x00A0;ligatures&#x00A0;or&#x00A0;diacritics.}
+}
+</pre>
<!--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
@@ -3891,12 +3983,12 @@ enclose the value in braces. For example:
</p>
- <div class="verbatim" id="verbatim-109">
+ <pre class="verbatim" id="verbatim-109">
\newacronym{ksvm}{ksvm}{kernel&#x00A0;support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />\newacronym
-&#x00A0;<br />&#x00A0;[see={[see&#x00A0;also]{ksvm}}]
-&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-</div>
+\newacronym
+&#x00A0;[see={[see&#x00A0;also]{ksvm}}]
+&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+</pre>
<!--l. 2078--><p class="nopar" > The <span
class="cmss-10">glossaries-extra</span><a
id="dx1-9001"></a> package provides a <span
@@ -3912,12 +4004,12 @@ class="cmsy-10">}</span>. For example:
</p>
- <div class="verbatim" id="verbatim-110">
+ <pre class="verbatim" id="verbatim-110">
\newabbreviation{ksvm}{ksvm}{kernel&#x00A0;support&#x00A0;vector&#x00A0;machine}
-&#x00A0;<br />\newabbreviation
-&#x00A0;<br />&#x00A0;[seealso={ksvm}]
-&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
-</div>
+\newabbreviation
+&#x00A0;[seealso={ksvm}]
+&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
+</pre>
<!--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
@@ -3935,22 +4027,22 @@ example:
</p>
- <div class="verbatim" id="verbatim-111">
+ <pre class="verbatim" id="verbatim-111">
\usepackage[record,abbreviations,symbols]{glossaries-extra}
-&#x00A0;<br />\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
-&#x00A0;<br />&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
-&#x00A0;<br />]
-&#x00A0;<br />\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
-&#x00A0;<br />&#x00A0;type={abbreviations},%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
-&#x00A0;<br />&#x00A0;save-locations=false%&#x00A0;no&#x00A0;number&#x00A0;list&#x00A0;for&#x00A0;these&#x00A0;entries
-&#x00A0;<br />]
-&#x00A0;<br />\GlsXtrLoadResources[
-&#x00A0;<br />&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
-&#x00A0;<br />&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
-&#x00A0;<br />]
-</div>
+\GlsXtrLoadResources[
+&#x00A0;src={terms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;terms.bib
+&#x00A0;type={main}%&#x00A0;put&#x00A0;in&#x00A0;main&#x00A0;glossary
+]
+\GlsXtrLoadResources[
+&#x00A0;src={abbrvs},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;abbrvs.bib
+&#x00A0;type={abbreviations},%&#x00A0;put&#x00A0;in&#x00A0;abbreviations&#x00A0;glossary
+&#x00A0;save-locations=false%&#x00A0;no&#x00A0;number&#x00A0;list&#x00A0;for&#x00A0;these&#x00A0;entries
+]
+\GlsXtrLoadResources[
+&#x00A0;src={syms},&#x00A0;%&#x00A0;entries&#x00A0;defined&#x00A0;in&#x00A0;syms.bib
+&#x00A0;type={symbols}%&#x00A0;put&#x00A0;in&#x00A0;symbols&#x00A0;glossary
+]
+</pre>
<!--l. 2111--><p class="nopar" >
</p><!--l. 2113--><p class="noindent" >
</p>
@@ -3958,38 +4050,48 @@ example:
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">
- <li class="itemize"><a
+ <li class="itemize">
+ <!--l. 2117--><p class="noindent" ><a
href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span
class="cmss-10">glossaries-extra </span>and <span
class="cmtt-10">bib2gls</span>: an introductory guide</a>.
- </li>
- <li class="itemize">The main <span
+ </p></li>
+ <li class="itemize">
+ <!--l. 2119--><p class="noindent" >The main <span
class="cmss-10">glossaries</span><a
id="dx1-10001"></a> <a
href="glossaries-user.html" >user manual</a>.
- </li>
- <li class="itemize">The <a
+ </p></li>
+ <li class="itemize">
+ <!--l. 2120--><p class="noindent" >The <a
href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries FAQ</a>.
- </li>
- <li class="itemize"><a
+ </p></li>
+ <li class="itemize">
+ <!--l. 2121--><p class="noindent" ><a
href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the
document build</a>.
- </li>
- <li class="itemize">The <a
+
+
+
+ </p></li>
+ <li class="itemize">
+ <!--l. 2124--><p class="noindent" >The <a
href="https://ctan.org/pkg/glossaries-extra" ><span
class="cmss-10">glossaries-extra</span></a> package.
- </li>
- <li class="itemize">The <a
+ </p></li>
+ <li class="itemize">
+ <!--l. 2125--><p class="noindent" >The <a
href="https://ctan.org/pkg/bib2gls" ><span
-class="cmtt-10">bib2gls</span></a> application.</li></ul>
+class="cmtt-10">bib2gls</span></a> application.</p></li></ul>
<!--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
+</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>