summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-01-26 22:53:06 +0000
committerKarl Berry <karl@freefriends.org>2016-01-26 22:53:06 +0000
commit9144cd7fe8a83679a67b2739e85be044b997c4a7 (patch)
tree1bdb3b0ad9936940a275eb7a44463157a85f9986 /Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
parent8d88e6714a570bf2b598132718ae2beb4641c80b (diff)
glossaries (24jan15)
git-svn-id: svn://tug.org/texlive/trunk@39488 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html1206
1 files changed, 629 insertions, 577 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
index 4df38cac1c2..647cd7542a2 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
+++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
@@ -4,13 +4,13 @@
<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
<html xmlns="http://www.w3.org/1999/xhtml"
>
-<head><title>The glossaries package v4.20: a guide for beginners</title>
+<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/)" />
<!-- xhtml,fn-in,css-in,uni-html4,utf8 -->
<meta name="src" content="glossariesbegin.tex" />
-<meta name="date" content="2015-11-30 12:19:00" />
+<meta name="date" content="2016-01-24 16:29:00" />
<style type="text/css">
<!--
@@ -18,6 +18,10 @@
/* start css.sty */
.cmr-17{font-size:170%;}
.cmr-12{font-size:120%;}
+.cmtt-12{font-size:120%;font-family: monospace;}
+.cmtt-12{font-family: monospace;}
+.cmtt-12{font-family: monospace;}
+.cmtt-12{font-family: monospace;}
.cmr-9{font-size:90%;}
.cmbx-9{font-size:90%; font-weight: bold;}
.cmbx-9{ font-weight: bold;}
@@ -26,12 +30,14 @@
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
+.cmtt-10{font-family: monospace;}
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
.cmti-10{ font-style: italic;}
.cmtt-9{font-size:90%;font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmtt-9{font-family: monospace;}
+.cmtt-9{font-family: monospace;}
.cmitt-10{font-family: monospace; font-style: italic;}
.cmbx-10{ font-weight: bold;}
.cmbx-10{ font-weight: bold;}
@@ -188,21 +194,35 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle
</style>
</head><body
>
- <div class="maketitle"><a
+<!--l. 44--><p class="noindent" ><a
id="top"></a>
-
+</p><!--l. 44--><p class="indent" >
+
-
-
+
+</p><!--l. 44--><p class="indent" >
+
-
-
-<h2 class="titleHead">The glossaries package v4.20: a guide for beginners</h2>
- <div class="author" ><span
-class="cmr-12">Nicola L.C. Talbot</span></div><br />
-<div class="date" ><span
-class="cmr-12">2015-11-30</span></div>
- </div>
+
+</p>
+<div class="center"
+>
+<!--l. 44--><p class="noindent" >
+</p><!--l. 44--><p class="noindent" ><span
+class="cmr-17">The glossaries package v4.21: 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"
+class="td11"> <span
+class="cmr-12">Nicola L.C. Talbot </span></td></tr></table>
+</div>
+<!--l. 44--><p class="noindent" ><span
+class="cmr-12">2016-01-24</span></p></div>
<div
class="abstract"
>
@@ -223,24 +243,24 @@ class="cmr-9">the high-level user commands, the main user manual is quite big. T
<span
class="cmr-9">be rather daunting for beginners, so this document is a brief introduction</span>
<span
-class="cmr-9">just to help get you started. If you find yourself saying, &#8220;Yeah, but how can</span>
+class="cmr-9">just to help get you started. If you find yourself saying, &#8220;Yeah, but how</span>
<span
-class="cmr-9">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
class="cmr-9">.</span>
</p><!--l. 56--><p class="indent" > <span
-class="cmr-9">I&#8217;ve made some statements in this document that don&#8217;t actually tell you</span>
+class="cmr-9">I&#8217;ve made some statements in this document that don&#8217;t actually tell</span>
<span
-class="cmr-9">the full truth, but it would clutter the document and cause confusion if I</span>
+class="cmr-9">you the full truth, but it would clutter the document and cause confusion</span>
<span
-class="cmr-9">keep writing &#8220;except when </span><span
-class="cmr-9">&#x2026;&#8221; or &#8220;but you can also do this, that or the other&#8221;</span>
+class="cmr-9">if I keep writing &#8220;except when </span><span
+class="cmr-9">&#x2026;&#8221; or &#8220;but you can also do this, that or</span>
<span
-class="cmr-9">or &#8220;you can do it this way but you can also do it that way, but that way</span>
+class="cmr-9">the other&#8221; or &#8220;you can do it this way but you can also do it that way, but</span>
<span
-class="cmr-9">may cause complications under certain circumstances&#8221;.</span>
+class="cmr-9">that way may cause complications under certain circumstances&#8221;.</span>
</p>
</div>
<h3 class="likesectionHead"><a
@@ -248,6 +268,9 @@ class="cmr-9">may cause complications under certain circumstances&#8221;.</span>
<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
href="#sec:defterm" id="QQ2-1-3">Defining Terms</a></span>
<br /> <span class="sectionToc" >3 <a
@@ -256,9 +279,6 @@ href="#sec:useterm" id="QQ2-1-4">Using Entries</a></span>
href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries</a></span>
<br /> <span class="sectionToc" >5 <a
href="#sec:glosstyle" id="QQ2-1-7">Customising the Glossary</a></span>
-
-
-
<br /> <span class="sectionToc" >6 <a
href="#sec:multigloss" id="QQ2-1-8">Multiple Glossaries</a></span>
<br /> <span class="sectionToc" >7 <a
@@ -275,13 +295,13 @@ href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span cla
id="sec:start"></a>Getting Started</h3>
<!--l. 69--><p class="noindent" >As with all packages, you need to load <span
class="cmss-10">glossaries </span>with <span
-class="cmtt-10">\usepackage</span>, but there are
-certain packages that must be loaded before <span
+class="cmtt-10">\usepackage</span>, but
+there are certain packages that must be loaded before <span
class="cmss-10">glossaries</span>, <span
-class="cmti-10">if </span>they are required: <span
+class="cmti-10">if </span>they are
+required: <span
class="cmss-10">hyperref</span><a
- id="dx1-2001"></a>,
-<span
+ id="dx1-2001"></a>, <span
class="cmss-10">babel</span><a
id="dx1-2002"></a>, <span
class="cmss-10">polyglossia</span><a
@@ -289,27 +309,30 @@ class="cmss-10">polyglossia</span><a
class="cmss-10">inputenc</span><a
id="dx1-2004"></a> and <span
class="cmss-10">fontenc</span><a
- id="dx1-2005"></a>. (You don&#8217;t have to load these packages, but if
-you want them, you must load them before <span
+ id="dx1-2005"></a>. (You don&#8217;t have
+to load these packages, but if you want them, you must load them before
+<span
class="cmss-10">glossaries</span>.)
-</p><!--l. 76--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant language
-module. Each language module is called <span
+</p><!--l. 76--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant
+language module. Each language module is called <span
class="cmtt-10">glossaries-</span>&#x27E8;<span
-class="cmti-10">language</span>&#x27E9;, where &#x27E8;<span
-class="cmti-10">language</span>&#x27E9; is the
-root language name. For example, <span
-class="cmtt-10">glossaries-french </span>or <span
-class="cmtt-10">glossaries-german</span>. If a
-language module is required, the <span
-class="cmss-10">glossaries </span>package will automatically try to load it and
-will give a warning if the module isn&#8217;t found. </div>
+class="cmti-10">language</span>&#x27E9;, where
+&#x27E8;<span
+class="cmti-10">language</span>&#x27E9; is the root language name. For example, <span
+class="cmtt-10">glossaries-french </span>or
+<span
+class="cmtt-10">glossaries-german</span>. If a language module is required, the <span
+class="cmss-10">glossaries </span>package will
+automatically try to load it and will give a warning if the module isn&#8217;t found.
+</div>
</p><!--l. 84--><p class="noindent" >
</p><!--l. 86--><p class="indent" > Once you have loaded <span
-class="cmss-10">glossaries</span>, you need to define your terms in the preamble and
-then you can use them throughout the document. Here&#8217;s a simple example:
-
+class="cmss-10">glossaries</span>, you need to define your terms in the
+preamble and then you can use them throughout the document. Here&#8217;s a simple
+example:
+
-
+
</p>
<div class="verbatim" id="verbatim-1">
\documentclass{article}
@@ -323,9 +346,9 @@ then you can use them throughout the document. Here&#8217;s a simple example:
<br />Here&#8217;s my sample term.
<br /><spacer type=vertical size=10></span>
Here&#8217;s another example:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-2">
\documentclass{article}
@@ -353,29 +376,30 @@ class="cmtt-10">.log </span>file and search
for the line that starts with <span
class="cmtt-10">Package: glossaries </span>followed by a date and
version.)
-</p><!--l. 133--><p class="indent" > If you like, you can put all your definitions in another file (for example, <span
-class="cmtt-10">defns.tex</span>)
-and load that file in the preamble using <span
-class="cmtt-10">\loadglsentries </span>with the filename as the
-argument. For example:
-
-
-
+</p><!--l. 133--><p class="indent" > If you like, you can put all your definitions in another file (for example,
+<span
+class="cmtt-10">defns.tex</span>) and load that file in the preamble using <span
+class="cmtt-10">\loadglsentries </span>with the
+filename as the argument. For example:
+
+
+
</p>
<div class="verbatim" id="verbatim-3">
\loadglsentries{defns}
</div>
<!--l. 138--><p class="nopar" >
-</p><!--l. 140--><p class="indent" > Don&#8217;t try inserting formatting commands into the definitions as they can interfere
-with the underlying mechanism. Instead, the formatting should be done by the style.
-For example, suppose I&#x00A0;want to replace <span
-class="cmtt-10">SVM </span>in the above to <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\textsc{svm}</span></span></span>, then I&#x00A0;need
-to select a style that uses <span
-class="cmtt-10">\textsc</span>, like this:
-
-
-
+</p><!--l. 140--><p class="indent" > Don&#8217;t try inserting formatting commands into the definitions as they can
+interfere with the underlying mechanism. Instead, the formatting should
+be done by the style. For example, suppose I&#x00A0;want to replace <span
+class="cmtt-10">SVM </span>in the
+above to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\textsc{svm}</span></span></span>, then I&#x00A0;need to select a style that uses <span
+class="cmtt-10">\textsc</span>, like
+this:
+
+
+
</p>
<div class="verbatim" id="verbatim-4">
\documentclass{article}
@@ -394,48 +418,51 @@ class="cmtt-10">ex </span>and in the second case the label was <span
class="cmtt-10">svm</span>. The label is just a way of
identifying the term (like the standard <span
class="cmtt-10">\label</span>/<span
-class="cmtt-10">\ref </span>mechanism). It&#8217;s best to
-just use the following alphanumerics in the labels: <span
+class="cmtt-10">\ref </span>mechanism). It&#8217;s best to just use
+the following alphanumerics in the labels: <span
class="cmtt-10">a</span>, &#x2026;, <span
class="cmtt-10">z</span>, <span
class="cmtt-10">A</span>, &#x2026;, <span
class="cmtt-10">Z</span>, <span
class="cmtt-10">0</span>, &#x2026;, <span
-class="cmtt-10">9</span>.
-Sometimes you can also use punctuation characters but not if another package (such
-as <span
+class="cmtt-10">9</span>. Sometimes you can
+also use punctuation characters but not if another package (such as <span
class="cmss-10">babel</span><a
- id="dx1-2006"></a>) meddles with them. Don&#8217;t try using any characters outside of the
-basic Latin set (for example, &eacute; or &szlig;) or things will go horribly wrong. This
-warning only applies to the label. It doesn&#8217;t apply to the text that appears in the
+ id="dx1-2006"></a>)
+meddles with them. Don&#8217;t try using any characters outside of the basic Latin
+set (for example, &eacute; or &szlig;) or things will go horribly wrong. This warning
+only applies to the label. It doesn&#8217;t apply to the text that appears in the
document.
</p><!--l. 173--><p class="indent" > <div class="important" title="Important Note"> Don&#8217;t use <span
-class="cmtt-10">\gls </span>in chapter or section headings as it can have some unpleasant
-side-effects. Instead use <span
-class="cmtt-10">\glsentrytext </span>for regular entries and one of <span
-class="cmtt-10">\glsentryshort</span>,
-<span
+class="cmtt-10">\gls </span>in chapter or section headings as it can have some
+unpleasant side-effects. Instead use <span
+class="cmtt-10">\glsentrytext </span>for regular entries and
+one of <span
+class="cmtt-10">\glsentryshort</span>, <span
class="cmtt-10">\glsentrylong </span>or <span
-class="cmtt-10">\glsentryfull </span>for acronyms. </div>
+class="cmtt-10">\glsentryfull </span>for acronyms.
+</div>
</p><!--l. 178--><p class="noindent" >
-</p><!--l. 180--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes if you
-want to display a sorted list of all the entries you have used in the document. The
-<span
+</p><!--l. 180--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes
+if you want to display a sorted list of all the entries you have used in the
+document. The <span
class="cmss-10">glossaries </span>package provides three options: use <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;to perform the sorting; use
-<span
+class="E">E</span>X</span>&#x00A0;to perform the
+sorting; use <span
class="cmtt-10">makeindex </span>to perform the sorting; use <span
-class="cmtt-10">xindy </span>to perform the sorting.
+class="cmtt-10">xindy </span>to perform the
+sorting.
</p><!--l. 187--><p class="indent" > The first option (using <span class="TEX">T<span
-class="E">E</span>X</span>) is the simplest and easiest method, but it&#8217;s inefficient
-and the sorting is done according to the English alphabet. To use this method, add
+class="E">E</span>X</span>) is the simplest and easiest method, but
+it&#8217;s inefficient and the sorting is done according to the English alphabet.
+To use this method, add <span
+class="cmtt-10">\makenoidxglossaries </span>to the preamble and put
<span
-class="cmtt-10">\makenoidxglossaries </span>to the preamble and put <span
-class="cmtt-10">\printnoidxglossaries </span>at the place
-where you want your glossary. For example:
-
+class="cmtt-10">\printnoidxglossaries </span>at the place where you want your glossary. For
+example:
+
-
+
</p>
<div class="verbatim" id="verbatim-5">
\documentclass{article}
@@ -455,28 +482,30 @@ where you want your glossary. For example:
<!--l. 213--><p class="nopar" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;(or pdf<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>) <span
-class="cmti-10">twice</span>. The first run won&#8217;t show the
-glossary. It will only appear on the second run. The glossary has a vertical gap between
-the &#8220;carrot&#8221; term and the &#8220;potato&#8221; term. This is because the entries in the glossaries
-are grouped according to their first letter. If you don&#8217;t want this gap, just add
-<span
-class="cmtt-10">nogroupskip </span>to the package options:
-
-
-
+class="cmti-10">twice</span>. The first run won&#8217;t
+show the glossary. It will only appear on the second run. The glossary has
+a vertical gap between the &#8220;carrot&#8221; term and the &#8220;potato&#8221; term. This is
+because the entries in the glossaries are grouped according to their first
+letter. If you don&#8217;t want this gap, just add <span
+class="cmtt-10">nogroupskip </span>to the package
+options:
+
+
+
</p>
<div class="verbatim" id="verbatim-6">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 222--><p class="nopar" > If you try out this example you may also notice that the description is followed by a
-full stop (period) and a number. The number is the location in the document where the
-entry was used, so you can lookup the term in the glossary and be directed to the
-relevant pages. It may be that you don&#8217;t want this back-reference, in which case you can
-suppress it using the <span
-class="cmtt-10">nonumberlist </span>package option:
-
+<!--l. 222--><p class="nopar" > If you try out this example you may also notice that the description is followed
+by a full stop (period) and a number. The number is the location in the
+document where the entry was used, so you can lookup the term in the glossary
+and be directed to the relevant pages. It may be that you don&#8217;t want this
+back-reference, in which case you can suppress it using the <span
+class="cmtt-10">nonumberlist </span>package
+option:
+
-
+
</p>
<div class="verbatim" id="verbatim-7">
\usepackage[nonumberlist]{glossaries}
@@ -484,9 +513,9 @@ class="cmtt-10">nonumberlist </span>package option:
<!--l. 231--><p class="nopar" > If you don&#8217;t like the terminating full stop, you can suppress that with the <span
class="cmtt-10">nopostdot</span>
package option:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-8">
\usepackage[nopostdot]{glossaries}
@@ -494,9 +523,9 @@ package option:
<!--l. 236--><p class="nopar" >
</p><!--l. 238--><p class="indent" > You may have noticed that I&#8217;ve used another command in the above example:
<span
-class="cmtt-10">\glspl</span>. This displays the plural form. By default, this is just the singular form with the
-letter &#8220;s&#8221; appended, but in the case of &#8220;potato&#8221; I had to specify the correct plural using
-the <span
+class="cmtt-10">\glspl</span>. This displays the plural form. By default, this is just the singular form with
+the letter &#8220;s&#8221; appended, but in the case of &#8220;potato&#8221; I had to specify the correct
+plural using the <span
class="cmtt-10">plural </span>key.
</p><!--l. 244--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span
class="E">E</span>X</span>&#x00A0;to sort the entries is the simplest but least
@@ -506,8 +535,8 @@ extended Latin characters, then you will have a much faster build time if you us
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>. If you are using extended Latin or non-Latin characters, then
<span
-class="cmtt-10">xindy </span>is the recommended method. These two methods are described in more detail in
-<a
+class="cmtt-10">xindy </span>is the recommended method. These two methods are described in more detail
+in <a
href="#sec:printglossaries"><span
class="cmsy-10">&sect;</span>4 </a><a
href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
@@ -524,8 +553,8 @@ class="cmss-10">glossaries</span><a
id="dx1-3001"></a> package, you need to define glossary entries in the
document preamble. These entries could be a&#x00A0;word, phrase, acronym or symbol.
They&#8217;re usually accompanied by a&#x00A0;description, which could be a short sentence or an
-in-depth explanation that spans multiple paragraphs. The simplest method of defining
-an entry is to use:
+in-depth explanation that spans multiple paragraphs. The simplest method of
+defining an entry is to use:
</p><!--l. 266--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
@@ -555,13 +584,13 @@ class="cmtt-10">}</span></span>
</div> </div><hr>
<!--l. 274--><p class="noindent" >
where &#x27E8;<span
-class="cmti-10">label</span>&#x27E9; is a unique label that identifies this entry. (Don&#8217;t include the angle brackets &#x27E8;
-&#x27E9;. They just indicate the parts of the code you need to change when you use
+class="cmti-10">label</span>&#x27E9; is a unique label that identifies this entry. (Don&#8217;t include the angle
+brackets &#x27E8; &#x27E9;. They just indicate the parts of the code you need to change when you use
this command in your document.) The &#x27E8;<span
class="cmti-10">name</span>&#x27E9; is the word, phrase or symbol
-
+
-
+
you are defining, and &#x27E8;<span
class="cmti-10">description</span>&#x27E9; is the description to be displayed in the
glossary.
@@ -601,9 +630,9 @@ class="cmtt-10">}</span>
<li
class="enumerate" id="x1-3003x1">Define the term &#8220;set&#8221; with the label <span
class="cmtt-10">set</span>:
-
+
-
+
<div class="verbatim" id="verbatim-9">
\newglossaryentry{set}
&#x00A0;<br />{
@@ -617,9 +646,9 @@ class="cmtt-10">set</span>:
class="enumerate" id="x1-3005x2">Define the symbol <span
class="cmsy-10">&#x2205; </span>with the label <span
class="cmtt-10">emptyset</span>:
-
+
-
+
<div class="verbatim" id="verbatim-10">
\newglossaryentry{emptyset}
&#x00A0;<br />{
@@ -632,9 +661,9 @@ class="cmtt-10">emptyset</span>:
<li
class="enumerate" id="x1-3007x3">Define the phrase &#8220;Fish Age&#8221; with the label <span
class="cmtt-10">fishage</span>:
-
+
-
+
<div class="verbatim" id="verbatim-11">
\longnewglossaryentry{fishage}
&#x00A0;<br />{name={Fish&#x00A0;Age}}
@@ -657,9 +686,9 @@ class="cmss-10">inputenc</span><a
id="dx1-3010"></a> package such
as <span
class="cmtt-10">&eacute;</span>). This first letter must be placed in a&#x00A0;group:
-
+
-
+
<div class="verbatim" id="verbatim-12">
\newglossaryentry{elite}
&#x00A0;<br />{
@@ -713,26 +742,26 @@ commands), &#x27E8;<span
class="cmti-10">short</span>&#x27E9; is the short form and &#x27E8;<span
class="cmti-10">long</span>&#x27E9; is the long form. For example, the
following defines an abbreviation:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-13">
\newacronym{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
<!--l. 370--><p class="nopar" > This defines a glossary entry with the label <span
class="cmtt-10">svm</span>. By default, the &#x27E8;<span
-class="cmti-10">name</span>&#x27E9; is
-set to &#x27E8;<span
+class="cmti-10">name</span>&#x27E9; is set
+to &#x27E8;<span
class="cmti-10">short</span>&#x27E9; (&#8220;svm&#8221; in the above example) and the &#x27E8;<span
class="cmti-10">description</span>&#x27E9; is set to &#x27E8;<span
class="cmti-10">long</span>&#x27E9;
(&#8220;support vector machine&#8221; in the above example). If, instead, you want to
be able to specify your own description you can do this using the optional
argument:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-14">
\newacronym
@@ -765,14 +794,14 @@ acronym or that use a footnote on first use. See the main user guide for further
details.
</p><!--l. 399--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span
class="cmtt-10">name</span>
-key used above indicates how the term should appear in the list of entries (glossary). If
-the term should appear differently when you reference it in the document, you need to
-use the <span
+key used above indicates how the term should appear in the list of entries (glossary).
+If the term should appear differently when you reference it in the document, you need
+to use the <span
class="cmtt-10">text </span>key as well.
</p><!--l. 405--><p class="indent" > For example:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-15">
\newglossaryentry{latinalph}
@@ -788,12 +817,12 @@ class="cmtt-10">text </span>key as well.
</p><!--l. 418--><p class="indent" > Another commonly used key is <span
class="cmtt-10">plural </span>for specifying the plural of the term. This
defaults to the value of the <span
-class="cmtt-10">text </span>key with an &#8220;s&#8221; appended, but if this is incorrect, just
-use the <span
+class="cmtt-10">text </span>key with an &#8220;s&#8221; appended, but if this is incorrect,
+just use the <span
class="cmtt-10">plural </span>key to override it:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-16">
\newglossaryentry{oesophagus}
@@ -809,9 +838,9 @@ class="cmtt-10">\oe </span>needs to be grouped.)
class="cmtt-10">longplural </span>and
<span
class="cmtt-10">shortplural </span>keys. For example:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-17">
\newacronym
@@ -820,13 +849,14 @@ class="cmtt-10">shortplural </span>keys. For example:
</div>
<!--l. 439--><p class="nopar" > If omitted, the defaults are again obtained by appending an &#8220;s&#8221; to the singular
versions.
-</p><!--l. 443--><p class="indent" > It&#8217;s also possible to have both a&#x00A0;name and a&#x00A0;corresponding symbol. Just use the
-<span
+</p><!--l. 443--><p class="indent" > It&#8217;s also possible to have both a&#x00A0;name and a&#x00A0;corresponding symbol.
+Just use the <span
class="cmtt-10">name </span>key for the name and the <span
-class="cmtt-10">symbol </span>key for the symbol. For example:
-
+class="cmtt-10">symbol </span>key for the symbol. For
+example:
+
-
+
</p>
<div class="verbatim" id="verbatim-18">
\newglossaryentry{emptyset}
@@ -842,9 +872,9 @@ class="cmtt-10">symbol </span>key for the symbol. For example:
<!--l. 455--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a
id="sec:useterm"></a>Using Entries</h3>
-<!--l. 458--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in your
-document. There are a&#x00A0;number of commands to do this, but the most common one
-is:
+<!--l. 458--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in
+your document. There are a&#x00A0;number of commands to do this, but the most common
+one is:
</p><!--l. 462--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\gls{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
@@ -867,15 +897,16 @@ example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls*{fishage}</span></span></span>. The other commands described in this section all have a
similar starred form.
</p><!--l. 475--><p class="indent" > If the entry was defined as an acronym (using <span
-class="cmtt-10">\newacronym </span>described above), then
+class="cmtt-10">\newacronym </span>described above),
+then <span
+class="cmtt-10">\gls </span>will display the full form the first time it&#8217;s used and just the
+short form on subsequent use. For example, if the acronym style is set to
<span
-class="cmtt-10">\gls </span>will display the full form the first time it&#8217;s used and just the short form on
-subsequent use. For example, if the acronym style is set to <span
-class="cmtt-10">long-short</span>, then
-<span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\gls{svm}</span></span></span> will display &#8220;support vector machine (svm)&#8221; the first time it&#8217;s used, but the
-next occurrence of <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\gls{svm}</span></span></span> will just display &#8220;svm&#8221;.
+class="cmtt-10">long-short</span>, then <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{svm}</span></span></span> will display &#8220;support vector machine (svm)&#8221; the
+first time it&#8217;s used, but the next occurrence of <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\gls{svm}</span></span></span> will just display
+&#8220;svm&#8221;.
</p><!--l. 483--><p class="indent" > If you want the plural form, you can use:
</p><!--l. 485--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glspl{</span>&#x27E8;<span
@@ -895,25 +926,26 @@ class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 494--><p class="noindent" >
for the singular form or
+
+
+
</p><!--l. 497--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Glspl{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-
-
-
</p><!--l. 498--><p class="noindent" >
for the plural form. For example:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-19">
\Glspl{set}&#x00A0;are&#x00A0;collections.
</div>
<!--l. 502--><p class="nopar" > produces &#8220;Sets are collections&#8221;.
</p><!--l. 505--><p class="indent" > If you&#8217;ve specified a symbol using the <span
-class="cmtt-10">symbol </span>key, you can display it using:
+class="cmtt-10">symbol </span>key, you can display it
+using:
</p><!--l. 508--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glssymbol{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
@@ -927,8 +959,8 @@ href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span cla
<!--l. 514--><p class="noindent" >In <a
href="#sec:start"><span
class="cmsy-10">&sect;</span>1 </a><a
-href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a> I mentioned that there are three options you can choose from to
-create your glossary. Here they are again in a little more detail:
+href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a> I mentioned that there are three options you can choose from
+to create your glossary. Here they are again in a little more detail:
</p><!--l. 518--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
@@ -958,30 +990,30 @@ class="cmitt-10">other options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 532--><p class="noindent" >
where you want your list of entries to appear. The sort &#x27E8;<span
-class="cmti-10">order</span>&#x27E9; may be one of:
- <span
+class="cmti-10">order</span>&#x27E9; may be one
+ of: <span
class="cmtt-10">word </span>(word ordering), <span
class="cmtt-10">letter </span>(letter ordering), <span
-class="cmtt-10">case </span>(case-sensitive letter
- ordering), <span
+class="cmtt-10">case </span>(case-sensitive
+ letter ordering), <span
class="cmtt-10">def </span>(in order of definition) or <span
-class="cmtt-10">use </span>(in order of use). Alternatively,
- use
+class="cmtt-10">use </span>(in order of use).
+ Alternatively, use
</p><!--l. 539--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
</p><!--l. 540--><p class="noindent" >
to display all your glossaries (if you have more than one). This command
doesn&#8217;t have any arguments.
+
+
+
</p></li>
<li
class="enumerate" id="x1-5006x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;twice on your document. (As you would do to make a&#x00A0;table of
- contents appear.) For example, click twice on the &#8220;typeset&#8221; or &#8220;build&#8221; or
- &#8220;PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;twice on your document. (As you would do to make a&#x00A0;table
+ of contents appear.) For example, click twice on the &#8220;typeset&#8221; or &#8220;build&#8221;
+ or &#8220;PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#8221; button in your editor.</li></ol>
-
-
-
</dd><dt class="description">
</dt><dd
class="description"><a
@@ -989,23 +1021,24 @@ class="description"><a
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;2</span>:
<!--l. 551--><p class="noindent" >This option uses an application called <span
-class="cmtt-10">makeindex </span>to sort the entries. This
- application comes with all modern <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;distributions, but it&#8217;s hard-coded for the
- non-extended Latin alphabet. This process involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;write the
- glossary information to a temporary file which <span
+class="cmtt-10">makeindex </span>to sort the entries.
+ This application comes with all modern <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;distributions, but it&#8217;s
+ hard-coded for the non-extended Latin alphabet. This process involves
+ making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;write the glossary information to a temporary file which
+ <span
class="cmtt-10">makeindex </span>reads. Then <span
-class="cmtt-10">makeindex</span>
- writes a&#x00A0;new file containing the code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;then reads
- this file on the next run.
+class="cmtt-10">makeindex </span>writes a&#x00A0;new file containing the
+ code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;then reads this file on the next
+ run.
</p><!--l. 559--><p class="noindent" >
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-5008x1">Add <span
-class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
- entries).
+class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining
+ your entries).
</li>
<li
class="enumerate" id="x1-5010x2">Put
@@ -1015,42 +1048,43 @@ class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 566--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
-class="cmtt-10">sort </span>key isn&#8217;t
- available in &#x27E8;<span
+class="cmtt-10">sort </span>key
+ isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
</p><!--l. 571--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
</p><!--l. 572--><p class="noindent" >
- which will display all glossaries (if you have more than one). This command
- doesn&#8217;t have any arguments.
+ which will display all glossaries (if you have more than one). This
+ command doesn&#8217;t have any arguments.
</p></li>
<li
class="enumerate" id="x1-5012x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions <span
-class="cmtt-10">.glo</span>
- and <span
+class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions
+ <span
+class="cmtt-10">.glo </span>and <span
class="cmtt-10">.ist </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;document is called <span
-class="cmtt-10">myDoc.tex</span>, then
- you&#8217;ll have two extra files called <span
-class="cmtt-10">myDoc.glo </span>and <span
-class="cmtt-10">myDoc.ist</span>). If you look at
- your document at this point, you won&#8217;t see the glossary as it hasn&#8217;t been
- created yet.
+class="E">E</span>X</span></span>&#x00A0;document is called
+ <span
+class="cmtt-10">myDoc.tex</span>, then you&#8217;ll have two extra files called <span
+class="cmtt-10">myDoc.glo </span>and
+ <span
+class="cmtt-10">myDoc.ist</span>). If you look at your document at this point, you won&#8217;t see the
+ glossary as it hasn&#8217;t been created yet.
</li>
<li
class="enumerate" id="x1-5014x4">Run <span
class="cmtt-10">makeindex </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
-class="cmtt-10">.ist </span>file as the
- style so that it creates an output file with the extension <span
-class="cmtt-10">.gls</span>. If you have
- access to a terminal or a command prompt (for example, the MSDOS
- command prompt for Windows users or the bash console for Unix-like users)
- then you need to run the command:
-
-
-
+class="cmtt-10">.ist </span>file
+ as the style so that it creates an output file with the extension
+ <span
+class="cmtt-10">.gls</span>. If you have access to a terminal or a command prompt (for
+ example, the MSDOS command prompt for Windows users or
+ the bash console for Unix-like users) then you need to run the
+ command:
+
+
+
<div class="verbatim" id="verbatim-20">
makeindex&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
</div>
@@ -1063,12 +1097,12 @@ class="cmtt-10">makeindex </span>via your text editor,
but each editor has a different method of doing this, so I&#x00A0;can&#8217;t
give a&#x00A0;general description. You will have to check your editor&#8217;s
manual.
- </p><!--l. 599--><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
+ </p><!--l. 599--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
+ want letter ordering you need to add the <span
class="cmtt-10">-l </span>switch:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-21">
makeindex&#x00A0;-l&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
@@ -1086,24 +1120,24 @@ class="description"><a
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span>:
<!--l. 613--><p class="noindent" >This option uses an application called <span
-class="cmtt-10">xindy </span>to sort the entries. This application
- is more flexible than <span
-class="cmtt-10">makeindex </span>and is able to sort extended Latin or non-Latin
- alphabets. It comes with <span class="TEX">T<span
+class="cmtt-10">xindy </span>to sort the entries. This
+ application is more flexible than <span
+class="cmtt-10">makeindex </span>and is able to sort extended Latin
+ or non-Latin alphabets. It comes with <span class="TEX">T<span
class="E">E</span>X</span>&#x00A0;Live but not with MiK<span class="TEX">T<span
-class="E">E</span>X</span>. Since <span
-class="cmtt-10">xindy </span>is a Perl
- script, if you are using MiK<span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;you will not only need to install <span
-class="cmtt-10">xindy</span>, you
- will also need to install Perl. In a&#x00A0;similar way to <a
-href="#option2">Option&#x00A0;2</a>, this option
- involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;write the glossary information to a&#x00A0;temporary
- file which <span
+class="E">E</span>X</span>. Since
+ <span
+class="cmtt-10">xindy </span>is a Perl script, if you are using MiK<span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;you will not only need to
+ install <span
+class="cmtt-10">xindy</span>, you will also need to install Perl. In a&#x00A0;similar way to <a
+href="#option2">Option&#x00A0;2</a>,
+ this option involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;write the glossary information to
+ a&#x00A0;temporary file which <span
class="cmtt-10">xindy </span>reads. Then <span
-class="cmtt-10">xindy </span>writes a&#x00A0;new file containing the
- code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="cmtt-10">xindy </span>writes a&#x00A0;new file containing
+ the code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;then reads this file on the next
run.
</p><!--l. 625--><p class="noindent" >
@@ -1113,9 +1147,9 @@ class="E">E</span>X</span></span>&#x00A0;then reads this file on the next
class="cmtt-10">xindy </span>option to the <span
class="cmss-10">glossaries</span><a
id="dx1-5019"></a> package option list:
-
+
-
+
<div class="verbatim" id="verbatim-22">
\usepackage[xindy]{glossaries}
</div>
@@ -1134,8 +1168,8 @@ class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 638--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
-class="cmtt-10">sort </span>key isn&#8217;t
- available in &#x27E8;<span
+class="cmtt-10">sort </span>key
+ isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
</p><!--l. 643--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
@@ -1143,17 +1177,17 @@ class="cmtt-10">\printglossaries </span></div><hr>
</p></li>
<li
class="enumerate" id="x1-5025x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions <span
-class="cmtt-10">.glo</span>
- and <span
+class="E">E</span>X</span></span>&#x00A0;on your document. This creates files with the extensions
+ <span
+class="cmtt-10">.glo </span>and <span
class="cmtt-10">.xdy </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;document is called <span
-class="cmtt-10">myDoc.tex</span>, then
- you&#8217;ll have two extra files called <span
-class="cmtt-10">myDoc.glo </span>and <span
-class="cmtt-10">myDoc.xdy</span>). If you look at
- your document at this point, you won&#8217;t see the glossary as it hasn&#8217;t been
- created yet.
+class="E">E</span>X</span></span>&#x00A0;document is called
+ <span
+class="cmtt-10">myDoc.tex</span>, then you&#8217;ll have two extra files called <span
+class="cmtt-10">myDoc.glo </span>and
+ <span
+class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, you won&#8217;t see the
+ glossary as it hasn&#8217;t been created yet.
</li>
<li
class="enumerate" id="x1-5027x5">Run <span
@@ -1161,15 +1195,15 @@ class="cmtt-10">xindy </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.xdy </span>file as
a&#x00A0;module so that it creates an output file with the extension <span
-class="cmtt-10">.gls</span>.
- You also need to set the language name and input encoding. If you
- have access to a terminal or a command prompt (for example, the
+class="cmtt-10">.gls</span>. You
+ also need to set the language name and input encoding. If you have
+ access to a terminal or a command prompt (for example, the
MSDOS command prompt for Windows users or the bash console for
Unix-like users) then you need to run the command (all on one
line):
-
+
-
+
<div class="verbatim" id="verbatim-23">
xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc
&#x00A0;<br />-t&#x00A0;myDoc.glg&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
@@ -1178,21 +1212,21 @@ class="cmtt-10">.gls</span>.
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document file. Avoid
spaces in the file name. If necessary, also replace <span
-class="cmtt-10">english </span>with the name of
- your language and <span
-class="cmtt-10">utf8 </span>with your input encoding.) If you don&#8217;t know how to
- use the command prompt, then you can probably access <span
-class="cmtt-10">xindy </span>via your text
- editor, but each editor has a different method of doing this, so I&#x00A0;can&#8217;t
- give a&#x00A0;general description. You will have to check your editor&#8217;s
+class="cmtt-10">english </span>with the name
+ of your language and <span
+class="cmtt-10">utf8 </span>with your input encoding.) If you don&#8217;t know
+ how to use the command prompt, then you can probably access <span
+class="cmtt-10">xindy </span>via
+ your text editor, but each editor has a different method of doing this, so
+ I&#x00A0;can&#8217;t give a&#x00A0;general description. You will have to check your editor&#8217;s
manual.
</p><!--l. 674--><p class="noindent" >The default sort is word order (&#8220;sea lion&#8221; comes before &#8220;seal&#8221;). If you
want letter ordering you need to add the <span
class="cmtt-10">order=letter </span>package
option:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-24">
\usepackage[xindy,order=letter]{glossaries}
@@ -1207,25 +1241,25 @@ class="E">E</span>X</span></span>&#x00A0;on your document again.
</dd></dl>
<!--l. 689--><p class="indent" > For Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
-href="#option3">3</a>, it can be difficult to remember all the parameters required for
-<span
+href="#option3">3</a>, it can be difficult to remember all the parameters required
+for <span
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>, so the <span
class="cmss-10">glossaries</span><a
- id="dx1-5030"></a> package provides a&#x00A0;script called <span
-class="cmtt-10">makeglossaries</span>
-that reads the <span
-class="cmtt-10">.aux </span>file to determine what settings you have used and will then run
+ id="dx1-5030"></a> package provides a&#x00A0;script called
<span
+class="cmtt-10">makeglossaries </span>that reads the <span
+class="cmtt-10">.aux </span>file to determine what settings you have used
+and will then run <span
class="cmtt-10">makeindex </span>or <span
-class="cmtt-10">xindy</span>. Again, this is a&#x00A0;command line application and can be run in
-a&#x00A0;terminal or command prompt. For example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;document is in the file
-<span
+class="cmtt-10">xindy</span>. Again, this is a&#x00A0;command line application
+and can be run in a&#x00A0;terminal or command prompt. For example, if your
+<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span></span>&#x00A0;document is in the file <span
class="cmtt-10">myDoc.tex</span>, then run:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-25">
makeglossaries&#x00A0;myDoc
@@ -1239,9 +1273,9 @@ class="cmtt-10">makeglossaries </span>via your text editor. Check your
editor&#8217;s manual for advice. If you are using <span
class="cmtt-10">arara </span>then you can just use the
directives:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-26">
&#x00A0;arara:&#x00A0;pdflatex
@@ -1253,25 +1287,25 @@ directives:
class="cmtt-10">makeglossaries </span>script is written in Perl, so you need a&#x00A0;Perl interpreter
installed. If you are using a&#x00A0;Unix-like operating system then you most likely have one
installed. If you are using Windows with the <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;Live distribution, then you can use
-the Perl interpreter that comes with <span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;Live distribution, then you can
+use the Perl interpreter that comes with <span class="TEX">T<span
class="E">E</span>X</span>&#x00A0;Live. If you are using Windows and
MiK<span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;then you need to install a&#x00A0;Perl distribution for Windows. If you are
-using <a
+class="E">E</span>X</span>&#x00A0;then you need to install a&#x00A0;Perl distribution for Windows. If you are using
+<a
href="#option3">Option&#x00A0;3</a>, then you need to do this anyway as <span
-class="cmtt-10">xindy </span>is also written in
-Perl. If you are using <a
-href="#option2">Option&#x00A0;2</a> and can&#8217;t work out how to install Perl (or
-for some reason don&#8217;t want to install it) then just use <span
+class="cmtt-10">xindy </span>is also written in Perl.
+If you are using <a
+href="#option2">Option&#x00A0;2</a> and can&#8217;t work out how to install Perl (or for
+some reason don&#8217;t want to install it) then just use <span
class="cmtt-10">makeindex </span>directly, as
described above, or you can use a&#x00A0;Lua alternative to <span
class="cmtt-10">makeglossaries </span>called
<span
class="cmtt-10">makeglossaries-lite.lua</span>:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-27">
makeglossaries-lite.lua&#x00A0;myDoc
@@ -1279,9 +1313,9 @@ makeglossaries-lite.lua&#x00A0;myDoc
<!--l. 726--><p class="nopar" >
</p><!--l. 728--><p class="indent" > As a last resort you can try the package option <span
class="cmtt-10">automake</span>:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-28">
\usepackage[automake]{glossaries}
@@ -1295,20 +1329,20 @@ probably won&#8217;t work for <span
class="cmtt-10">xindy </span>and won&#8217;t work at all if the shell escape has been
disabled in your <span class="TEX">T<span
class="E">E</span>X</span>&#x00A0;distribution. Most <span class="TEX">T<span
-class="E">E</span>X</span>&#x00A0;distributions will allow a restricted shell
-escape, which will only allow trusted applications to be run. If the <span
-class="cmtt-10">automake </span>option is
-successful, you will still need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+class="E">E</span>X</span>&#x00A0;distributions will allow a restricted
+shell escape, which will only allow trusted applications to be run. If the <span
+class="cmtt-10">automake</span>
+option is successful, you will still need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;twice for the glossaries to be
displayed.
-</p><!--l. 741--><p class="indent" > When sorting the entries, the string comparisons are made according to each entry&#8217;s
-<span
+</p><!--l. 741--><p class="indent" > When sorting the entries, the string comparisons are made according to each
+entry&#8217;s <span
class="cmtt-10">sort </span>key. If this is omitted, the <span
-class="cmtt-10">name </span>key is used. For example, recall the earlier
-definition:
-
+class="cmtt-10">name </span>key is used. For example, recall the
+earlier definition:
+
-
+
</p>
<div class="verbatim" id="verbatim-29">
\newglossaryentry{elite}
@@ -1320,25 +1354,25 @@ definition:
<!--l. 751--><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:
+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">
<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="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="cmss-10">sanitizesort=true</span><a
- id="dx1-5031"></a> package option, the sort value will be interpreted
- as the sequence of characters: <span class="obeylines-h"><span class="verb"><span
+ id="dx1-5031"></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="cmtt-10">&#8217; e l i t </span>and <span
-class="cmtt-10">e</span>. This will place this entry
- before the &#8220;A&#8221; letter group since it starts with a symbol.
+class="cmtt-10">e</span>. This will place
+ this entry before the &#8220;A&#8221; letter group since it starts with a symbol.
</dd><dt class="description">
<a
href="#option2"><span
@@ -1349,10 +1383,10 @@ class="description">The sort key will be interpreted the sequence of characters:
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">l i t </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">lit </span>and <span
class="cmtt-10">e</span>. The first character is an opening curly brace <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> so <span
class="cmtt-10">makeindex</span>
@@ -1366,8 +1400,8 @@ class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">xindy </span>disregards <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;commands so it sorts on <span
-class="cmtt-10">elite</span>, which puts
- this entry in the &#8220;E&#8221; group.</dd></dl>
+class="cmtt-10">elite</span>, which
+ puts this entry in the &#8220;E&#8221; group.</dd></dl>
<!--l. 776--><p class="indent" > If the <span
class="cmss-10">inputenc</span><a
id="dx1-5032"></a> package is used and the entry is defined as: </p><div class="alltt">
@@ -1400,18 +1434,18 @@ 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="cmtt-10">elite </span>so the entry
+ will be put in the &#8220;E&#8221; letter group. If you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-5033"></a> package option,
- the sort value will be interpreted as <span
+ id="dx1-5033"></a> package
+ option, the sort value will be interpreted as <span
class="cmtt-10">&eacute;</span><span
-class="cmtt-10">lite </span>where &eacute; has been sanitized (so
- it&#8217;s no longer an active character) which will put this entry before the &#8220;A&#8221;
- letter group.
-
+class="cmtt-10">lite </span>where &eacute; has been
+ sanitized (so it&#8217;s no longer an active character) which will put this entry
+ before the &#8220;A&#8221; letter group.
+
-
+
</dd><dt class="description">
<a
href="#option2"><span
@@ -1431,22 +1465,22 @@ class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">xindy </span>will correctly recognise the sort value <span
class="cmtt-10">&eacute;</span><span
-class="cmtt-10">lite </span>and will place it
- in whatever letter group is appropriate for the given language setting. (In
- English, this would just be the &#8220;E&#8221; letter group.)</dd></dl>
-<!--l. 802--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to
-use <span
+class="cmtt-10">lite </span>and will place
+ it in whatever letter group is appropriate for the given language setting.
+ (In English, this would just be the &#8220;E&#8221; letter group.)</dd></dl>
+<!--l. 802--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is
+to use <span
class="cmtt-10">xindy </span>(<a
href="#option3">Option&#x00A0;3</a>) with the <span
class="cmss-10">inputenc</span><a
id="dx1-5034"></a> package. If you use <span
class="cmtt-10">makeindex </span>(<a
-href="#option2">Option&#x00A0;2</a>) you
-need to specify the <span
+href="#option2">Option&#x00A0;2</a>)
+you need to specify the <span
class="cmtt-10">sort </span>key like this:
-
+
-
+
</p>
<div class="verbatim" id="verbatim-30">
\newglossaryentry{elite}
@@ -1458,25 +1492,42 @@ class="cmtt-10">sort </span>key like this:
</div>
<!--l. 813--><p class="nopar" > If you use <a
href="#option1">Option&#x00A0;1</a>, you may or may not need to use the <span
-class="cmtt-10">sort </span>key, but you will need
-to be careful about fragile commands in the <span
+class="cmtt-10">sort </span>key, but you will
+need to be careful about fragile commands in the <span
class="cmtt-10">name </span>key if you don&#8217;t set the <span
class="cmtt-10">sort</span>
key.
-</p><!--l. 818--><p class="indent" > <a
+</p><!--l. 818--><p class="indent" > If you use <a
+href="#option3">Option&#x00A0;3</a> and the <span
+class="cmtt-10">name </span>only contains a command (such as <span
+class="cmtt-10">\P</span>) you
+must add the <span
+class="cmtt-10">sort </span>key. This is also advisable for the other options, but is essential
+for <a
+href="#option3">Option&#x00A0;3</a>. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-31">
+\newglossaryentry{P}{name={\P},sort={P},
+&#x00A0;<br />&#x00A0;description={paragraph&#x00A0;symbol}}
+</div>
+<!--l. 825--><p class="nopar" >
+</p><!--l. 827--><p class="indent" > <a
href="#x1-50351">Table&#x00A0;1</a> summarises the main pros and cons of three options described
above.
</p>
<div class="table">
-
+
-
-<!--l. 821--><p class="indent" > <a
+
+<!--l. 830--><p class="indent" > <a
id="x1-50351"></a></p><hr class="float" /><div class="float"
>
-
+
-
+
<div class="caption"
><span class="id">Table&#x00A0;1: </span><span
class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50351 -->
@@ -1488,7 +1539,7 @@ id="TBL-2-2" /><col
id="TBL-2-3" /><col
id="TBL-2-4" /></colgroup><tr
style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:wrap; text-align:left;" id="TBL-2-1-1"
-class="td11"> <!--l. 827--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
+class="td11"> <!--l. 836--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
class="td11"> <a
href="#option1"><span
class="cmbx-10">Option</span><span
@@ -1503,10 +1554,10 @@ class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span></a> </td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:wrap; text-align:left;" id="TBL-2-2-1"
-class="td11"> <!--l. 828--><p class="noindent" >Requires
+class="td11"> <!--l. 837--><p class="noindent" >Requires
an
external
- application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
+ application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
class="td11"> <span
class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
class="td11"> <span
@@ -1515,8 +1566,8 @@ class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:wrap; text-align:left;" id="TBL-2-3-1"
-class="td11"> <!--l. 830--><p class="noindent" >Requires
- Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
+class="td11"> <!--l. 839--><p class="noindent" >Requires
+ Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
class="td11"> <span
class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
class="td11"> <span
@@ -1525,13 +1576,13 @@ class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:wrap; text-align:left;" id="TBL-2-4-1"
-class="td11"> <!--l. 832--><p class="noindent" >Can
+class="td11"> <!--l. 841--><p class="noindent" >Can
sort
extended
Latin
or
non-Latin
- alphabets? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
+ alphabets? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
class="td11"> <span
class="pzdr-">&#x2718;</span><sup class="textsuperscript"><span
class="cmsy-9">&#8224;</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
@@ -1541,9 +1592,9 @@ class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:wrap; text-align:left;" id="TBL-2-5-1"
-class="td11"> <!--l. 835--><p class="noindent" >Efficient
+class="td11"> <!--l. 844--><p class="noindent" >Efficient
sort
- algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
+ algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
class="td11"> <span
class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
class="td11"> <span
@@ -1552,13 +1603,13 @@ class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:wrap; text-align:left;" id="TBL-2-6-1"
-class="td11"> <!--l. 837--><p class="noindent" >Can
+class="td11"> <!--l. 846--><p class="noindent" >Can
form
ranges
in
the
location
- lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
+ lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
class="td11"> <span
class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
class="td11"> <span
@@ -1567,10 +1618,10 @@ class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:wrap; text-align:left;" id="TBL-2-7-1"
-class="td11"> <!--l. 839--><p class="noindent" >Can
+class="td11"> <!--l. 848--><p class="noindent" >Can
have
non-standard
- locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
+ locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
class="td11"> <span
class="pzdr-">&#x2714; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
class="td11"> <span
@@ -1578,21 +1629,21 @@ class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-
class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr></table></div>
-<!--l. 843--><p class="noindent" ><sup class="textsuperscript"><span
+<!--l. 852--><p class="noindent" ><sup class="textsuperscript"><span
class="cmsy-9">&#8224;</span></sup> Strips standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;accents so, for example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\AA</span></span></span> is treated the same as
A.
-
+
-
+
</p>
</div><hr class="endfloat" />
</div>
-<!--l. 847--><p class="noindent" ><a
+<!--l. 856--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a
id="sec:glosstyle"></a>Customising the Glossary</h3>
-<!--l. 850--><p class="noindent" >The default glossary style uses the <span
+<!--l. 859--><p class="noindent" >The default glossary style uses the <span
class="cmss-10">description</span><a
id="dx1-6001"></a><a
id="dx1-6002"></a> environment to display the entry list.
@@ -1601,162 +1652,163 @@ class="cmtt-10">\item </span>which means that it will
typically be displayed in bold. You can switch to medium weight by redefining
<span
class="cmtt-10">\glsnamefont</span>:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-31">
+ <div class="verbatim" id="verbatim-32">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
</div>
-<!--l. 857--><p class="nopar" >
-</p><!--l. 859--><p class="indent" > By default, a&#x00A0;full stop is appended to the description. To prevent this from
+<!--l. 866--><p class="nopar" >
+</p><!--l. 868--><p class="indent" > By default, a&#x00A0;full stop is appended to the description. To prevent this from
happening use the <span
class="cmtt-10">nopostdot </span>package option:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-32">
+ <div class="verbatim" id="verbatim-33">
\usepackage[nopostdot]{glossaries}
</div>
-<!--l. 863--><p class="nopar" >
-</p><!--l. 865--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry. This refers to the document
-locations (for example, the page number) where the entry has been referenced. If you
-use Options&#x00A0;<a
+<!--l. 872--><p class="nopar" >
+</p><!--l. 874--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry. This refers to the
+document locations (for example, the page number) where the entry has been
+referenced. If you use Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a> described in <a
href="#sec:printglossaries"><span
class="cmsy-10">&sect;</span>4 </a><a
-href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a> location ranges will be
-compressed. For example, if an entry was used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
-href="#option2">2</a>
-or&#x00A0;<a
-href="#option3">3</a> the location list will appear as 1&#8211;3, but with <a
-href="#option1">Option&#x00A0;1</a> it will appear as 1, 2, 3. If
-you don&#8217;t want the locations displayed you can hide them using the <span
-class="cmtt-10">nonumberlist</span>
-package option:
-
+href="#sec:printglossaries">Displaying a List of
+Entries<!--tex4ht:ref: sec:printglossaries --></a> location ranges will be compressed. For example, if an entry was
+used on pages&#x00A0;1, 2 and&#x00A0;3, with Options&#x00A0;<a
+href="#option2">2</a> or&#x00A0;<a
+href="#option3">3</a> the location list will appear
+as 1&#8211;3, but with <a
+href="#option1">Option&#x00A0;1</a> it will appear as 1, 2, 3. If you don&#8217;t want the
+locations displayed you can hide them using the <span
+class="cmtt-10">nonumberlist </span>package
+option:
+
-
+
</p>
- <div class="verbatim" id="verbatim-33">
+ <div class="verbatim" id="verbatim-34">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--l. 875--><p class="nopar" >
-</p><!--l. 877--><p class="indent" > Entries are grouped according to the first letter of each entry&#8217;s <span
-class="cmtt-10">sort </span>key. By default
-a&#x00A0;vertical gap is placed between letter groups. You can suppress this with the
+<!--l. 884--><p class="nopar" >
+</p><!--l. 886--><p class="indent" > Entries are grouped according to the first letter of each entry&#8217;s <span
+class="cmtt-10">sort </span>key. By
+default a&#x00A0;vertical gap is placed between letter groups. You can suppress this with the
<span
class="cmtt-10">nogroupskip </span>package option:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-34">
+ <div class="verbatim" id="verbatim-35">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--l. 883--><p class="nopar" >
-</p><!--l. 885--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
+<!--l. 892--><p class="nopar" >
+</p><!--l. 894--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
using:
-</p><!--l. 888--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 897--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\setglossarystyle{</span>&#x27E8;<span
class="cmitt-10">style name</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 889--><p class="noindent" >
+</p><!--l. 898--><p class="noindent" >
There are a&#x00A0;number of predefined styles. Glossaries can vary from a&#x00A0;list of symbols
with a&#x00A0;terse description to a&#x00A0;list of words or phrases with descriptions that span
multiple paragraphs, so there&#8217;s no &#8220;one style fits all&#8221; solution. You need to choose
a&#x00A0;style that suits your document.
-</p><!--l. 896--><p class="indent" > Examples:
+</p><!--l. 905--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-6004x1">You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief phrase
- or short sentence. Try one of the &#8220;mcol&#8221; styles defined in the <span
+ class="enumerate" id="x1-6004x1">You have entries where the name is a&#x00A0;symbol and the description is a&#x00A0;brief
+ phrase or short sentence. Try one of the &#8220;mcol&#8221; styles defined in the
+ <span
class="cmss-10">glossary-mcols</span><a
- id="dx1-6005"></a>
- package. For example:
-
+ id="dx1-6005"></a> package. For example:
+
-
- <div class="verbatim" id="verbatim-35">
+
+ <div class="verbatim" id="verbatim-36">
\usepackage[nogroupskip,nopostdot]{glossaries}
&#x00A0;<br />\usepackage{glossary-mcols}
&#x00A0;<br />\setglossarystyle{mcolindex}
</div>
- <!--l. 905--><p class="nopar" >
+ <!--l. 914--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6007x2">You have entries where the name is a&#x00A0;word or phrase and the description spans
multiple paragraphs. Try one of the &#8220;altlist&#8221; styles. For example:
-
+
-
- <div class="verbatim" id="verbatim-36">
+
+ <div class="verbatim" id="verbatim-37">
\usepackage[nopostdot]{glossaries}
&#x00A0;<br />\setglossarystyle{altlist}
</div>
- <!--l. 913--><p class="nopar" >
+ <!--l. 922--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6009x3">You have entries where the name is a&#x00A0;single word, the description is
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-37">
+
+ <div class="verbatim" id="verbatim-38">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{long4col}
</div>
- <!--l. 922--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
-
+ <!--l. 931--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
+
-
+
</p>
- <div class="verbatim" id="verbatim-38">
+ <div class="verbatim" id="verbatim-39">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{tree}
</div>
- <!--l. 927--><p class="nopar" ></p></li></ol>
-<!--l. 930--><p class="indent" > If your glossary consists of a&#x00A0;list of acronyms and you also want to specify
+ <!--l. 936--><p class="nopar" ></p></li></ol>
+<!--l. 939--><p class="indent" > If your glossary consists of a&#x00A0;list of acronyms and you also want to specify
a&#x00A0;description as well as the long form, then you need to use an acronym style that
will suit the glossary style. For example, use the <span
class="cmtt-10">long-short-desc </span>acronym
style:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-39">
+ <div class="verbatim" id="verbatim-40">
\setacronymstyle{long-short-desc}
</div>
-<!--l. 936--><p class="nopar" > Define the acronyms with a&#x00A0;description:
-
+<!--l. 945--><p class="nopar" > Define the acronyms with a&#x00A0;description:
+
-
+
</p>
- <div class="verbatim" id="verbatim-40">
+ <div class="verbatim" id="verbatim-41">
\newacronym
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 942--><p class="nopar" > Choose a&#x00A0;glossary style that suits wide entry names:
-
+<!--l. 951--><p class="nopar" > Choose a&#x00A0;glossary style that suits wide entry names:
+
-
+
</p>
- <div class="verbatim" id="verbatim-41">
+ <div class="verbatim" id="verbatim-42">
\setglossarystyle{altlist}
</div>
-<!--l. 946--><p class="nopar" >
-</p><!--l. 948--><p class="noindent" >
+<!--l. 955--><p class="nopar" >
+</p><!--l. 957--><p class="noindent" >
</p>
-<!--l. 948--><p class="noindent" ><a
+<!--l. 957--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a
id="sec:multigloss"></a>Multiple Glossaries</h3>
-<!--l. 951--><p class="noindent" >The <span
+<!--l. 960--><p class="noindent" >The <span
class="cmss-10">glossaries</span><a
id="dx1-7001"></a> package predefines a&#x00A0;default <span
class="cmtt-10">main </span>glossary. When you define an entry
@@ -1768,7 +1820,7 @@ automatically assigned to the default glossary, unless you indicate otherwise us
<span
class="cmtt-10">type </span>key. However you first need to make sure the desired glossary has been defined.
This is done using:
-</p><!--l. 958--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 967--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary[</span>&#x27E8;<span
class="cmitt-10">glg</span>&#x27E9;<span
class="cmtt-10">]{</span>&#x27E8;<span
@@ -1780,7 +1832,7 @@ class="cmitt-10">glo</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">title</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 959--><p class="noindent" >
+</p><!--l. 968--><p class="noindent" >
The &#x27E8;<span
class="cmti-10">label</span>&#x27E9; is a&#x00A0;label that uniquely identifies this new glossary. As with other types of
identifying labels, be careful not to use active characters in &#x27E8;<span
@@ -1803,54 +1855,54 @@ class="cmti-10">gls</span>&#x27E9; and &#x27E8;<span
class="cmti-10">glo</span>&#x27E9; arguments are ignored, in which
case you may prefer to use the starred version where you don&#8217;t specify the
extensions:
-</p><!--l. 972--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 981--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary*{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">}{</span>&#x27E8;<span
class="cmitt-10">title</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 973--><p class="noindent" >
-</p><!--l. 975--><p class="indent" > In the case of Options&#x00A0;<a
+</p><!--l. 982--><p class="noindent" >
+</p><!--l. 984--><p class="indent" > In the case of Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a>, all glossary definitions must come before
<span
class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 978--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
+</p><!--l. 987--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
acronyms, the <span
class="cmss-10">glossaries</span><a
id="dx1-7002"></a> package provides the package option <span
class="cmtt-10">acronym </span>(or <span
class="cmtt-10">acronyms</span>),
which is a&#x00A0;convenient shortcut for
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-42">
+ <div class="verbatim" id="verbatim-43">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
-<!--l. 984--><p class="nopar" > The option also changes the behaviour of <span
+<!--l. 993--><p class="nopar" > The option also changes the behaviour of <span
class="cmtt-10">\newacronym </span>so that acronyms are
automatically put in the list of acronyms instead of the main glossary.
-</p><!--l. 989--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
+</p><!--l. 998--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
a&#x00A0;list of notation:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-43">
+ <div class="verbatim" id="verbatim-44">
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 994--><p class="nopar" > After <span
+<!--l. 1003--><p class="nopar" > After <span
class="cmtt-10">\makeglossaries </span>(or <span
-class="cmtt-10">\makenoidxglossaries</span>) you can define the entries in the
-preamble. For example:
-
+class="cmtt-10">\makenoidxglossaries</span>) you can define the entries in
+the preamble. For example:
+
-
+
</p>
- <div class="verbatim" id="verbatim-44">
+ <div class="verbatim" id="verbatim-45">
\newglossaryentry{gls:set}
&#x00A0;<br />{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;&#8216;main&#8217;&#x00A0;glossary
&#x00A0;<br />&#x00A0;&#x00A0;name=set,
@@ -1865,13 +1917,13 @@ preamble. For example:
&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
</div>
-<!--l. 1013--><p class="nopar" > or if you don&#8217;t like using <span
+<!--l. 1022--><p class="nopar" > or if you don&#8217;t like using <span
class="cmtt-10">\ensuremath</span>:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-45">
+ <div class="verbatim" id="verbatim-46">
\newglossaryentry{not:set}
&#x00A0;<br />{%&#x00A0;This&#x00A0;entry&#x00A0;goes&#x00A0;in&#x00A0;the&#x00A0;&#8216;notation&#8217;&#x00A0;glossary:
&#x00A0;<br />&#x00A0;&#x00A0;type=notation,
@@ -1880,109 +1932,109 @@ class="cmtt-10">\ensuremath</span>:
&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
</div>
-<!--l. 1023--><p class="nopar" >
-</p><!--l. 1025--><p class="indent" > Each glossary is displayed using:
-</p><!--l. 1027--><p class="indent" > <hr><div title="Definition"><span
+<!--l. 1032--><p class="nopar" >
+</p><!--l. 1034--><p class="indent" > Each glossary is displayed using:
+</p><!--l. 1036--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[type=</span>&#x27E8;<span
class="cmitt-10">type</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 1028--><p class="noindent" >
+</p><!--l. 1037--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1031--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1040--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossary[type=</span>&#x27E8;<span
class="cmitt-10">type</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 1032--><p class="noindent" >
+</p><!--l. 1041--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>). Where &#x27E8;<span
-class="cmti-10">type</span>&#x27E9; is the glossary label. If the type is omitted the default
-<span
+class="cmti-10">type</span>&#x27E9; is the glossary label. If the type is omitted the
+default <span
class="cmtt-10">main </span>glossary is assumed.
-</p><!--l. 1036--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries:
-</p><!--l. 1039--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1045--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries:
+</p><!--l. 1048--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
-</p><!--l. 1040--><p class="noindent" >
+</p><!--l. 1049--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1043--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1052--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
-</p><!--l. 1044--><p class="noindent" >
+</p><!--l. 1053--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>).
-</p><!--l. 1047--><p class="indent" > If you use <a
+</p><!--l. 1056--><p class="indent" > If you use <a
href="#option1">Option&#x00A0;1</a>, you don&#8217;t need to do anything else. If you use Options&#x00A0;<a
-href="#option2">2</a> or&#x00A0;<a
-href="#option3">3</a>
-with the <span
-class="cmtt-10">makeglossaries </span>Perl script, you similarly don&#8217;t need to do anything else. If
-you use Options&#x00A0;<a
+href="#option2">2</a>
+or&#x00A0;<a
+href="#option3">3</a> with the <span
+class="cmtt-10">makeglossaries </span>Perl script, you similarly don&#8217;t need to do anything
+else. If you use Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
href="#option3">3</a> without the <span
-class="cmtt-10">makeglossaries </span>Perl script then you need to make
-sure you run <span
+class="cmtt-10">makeglossaries </span>Perl script then you
+need to make sure you run <span
class="cmtt-10">makeindex</span>/<span
class="cmtt-10">xindy </span><span
class="cmti-10">for each defined glossary</span>. The &#x27E8;<span
-class="cmti-10">gls</span>&#x27E9; and &#x27E8;<span
-class="cmti-10">glo</span>&#x27E9; arguments of
-<span
+class="cmti-10">gls</span>&#x27E9; and
+&#x27E8;<span
+class="cmti-10">glo</span>&#x27E9; arguments of <span
class="cmtt-10">\newglossary </span>specify the file extensions to use instead of <span
-class="cmtt-10">.gls </span>and <span
-class="cmtt-10">.glo</span>. The optional
-argument &#x27E8;<span
-class="cmti-10">glg</span>&#x27E9; is the file extension for the transcript file. This should be different for each
-glossary in case you need to check for <span
+class="cmtt-10">.gls </span>and
+<span
+class="cmtt-10">.glo</span>. The optional argument &#x27E8;<span
+class="cmti-10">glg</span>&#x27E9; is the file extension for the transcript file. This
+should be different for each glossary in case you need to check for <span
class="cmtt-10">makeindex</span>/<span
-class="cmtt-10">xindy </span>errors or warnings if things go
-wrong.
-</p><!--l. 1060--><p class="indent" > For example, suppose you have three glossaries in your document (<span
+class="cmtt-10">xindy</span>
+errors or warnings if things go wrong.
+</p><!--l. 1069--><p class="indent" > For example, suppose you have three glossaries in your document (<span
class="cmtt-10">main</span>, <span
class="cmtt-10">acronym</span>
and <span
class="cmtt-10">notation</span>), specified using:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-46">
+ <div class="verbatim" id="verbatim-47">
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1066--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+<!--l. 1075--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document is in a&#x00A0;file called <span
class="cmtt-10">myDoc.tex</span>):
-</p><!--l. 1070--><p class="indent" >
+</p><!--l. 1079--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
href="#option2">Option&#x00A0;2</a>:
- <!--l. 1073--><p class="noindent" >You need to run <span
+ <!--l. 1082--><p class="noindent" >You need to run <span
class="cmtt-10">makeindex </span>three times:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-47">
+ <div class="verbatim" id="verbatim-48">
makeindex&#x00A0;-t&#x00A0;myDoc.glg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
&#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.alg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.acr&#x00A0;myDoc.acn
&#x00A0;<br />makeindex&#x00A0;-t&#x00A0;myDoc.nlg&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
</div>
- <!--l. 1078--><p class="nopar" >
+ <!--l. 1087--><p class="nopar" >
</p></dd><dt class="description">
</dt><dd
class="description"><a
href="#option3">Option&#x00A0;3</a>:
- <!--l. 1082--><p class="noindent" >You need to run <span
-class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where the
- line has wrapped.)
-
+ <!--l. 1091--><p class="noindent" >You need to run <span
+class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where
+ the line has wrapped.)
+
-
+
</p>
- <div class="verbatim" id="verbatim-48">
+ <div class="verbatim" id="verbatim-49">
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
@@ -1990,15 +2042,15 @@ class="cmtt-10">xindy </span>three times (be careful not to insert line breaks w
&#x00A0;<br />xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc&#x00A0;-t&#x00A0;myDoc.nlg
&#x00A0;<br />-o&#x00A0;myDoc.not&#x00A0;myDoc.ntn
</div>
- <!--l. 1091--><p class="nopar" ></p></dd></dl>
-<!--l. 1094--><p class="noindent" >
+ <!--l. 1100--><p class="nopar" ></p></dd></dl>
+<!--l. 1103--><p class="noindent" >
</p>
-<!--l. 1094--><p class="noindent" ><a
+<!--l. 1103--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a
id="sec:hyperref"></a><span
class="cmss-10">glossaries </span>and <span
class="cmss-10">hyperref</span></h3>
-<!--l. 1097--><p class="noindent" >Take care if you use the <span
+<!--l. 1106--><p class="noindent" >Take care if you use the <span
class="cmss-10">glossaries</span><a
id="dx1-8001"></a> package with <span
class="cmss-10">hyperref</span><a
@@ -2012,66 +2064,66 @@ class="cmti-10">after</span>
<span
class="cmss-10">hyperref</span><a
id="dx1-8005"></a>:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-49">
+ <div class="verbatim" id="verbatim-50">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage{glossaries}
</div>
-<!--l. 1104--><p class="nopar" > If you use <span
+<!--l. 1113--><p class="nopar" > If you use <span
class="cmss-10">hyperref</span><a
id="dx1-8006"></a> make sure you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;rather than the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;to DVI
-engine. The DVI format can&#8217;t break hyperlinks across a&#x00A0;line so long glossary
-entries (such as the full form of acronyms) won&#8217;t line wrap with the DVI engine.
+engine. The DVI format can&#8217;t break hyperlinks across a&#x00A0;line so long glossary entries
+(such as the full form of acronyms) won&#8217;t line wrap with the DVI engine.
Also, hyperlinks in sub- or superscripts aren&#8217;t correctly sized with the DVI
format.
-</p><!--l. 1111--><p class="indent" > By default, if the <span
+</p><!--l. 1120--><p class="indent" > By default, if the <span
class="cmss-10">hyperref</span><a
id="dx1-8007"></a> package has been loaded, commands like <span
class="cmtt-10">\gls </span>will form
a&#x00A0;hyperlink to the relevant entry in the glossary. If you to disable this for <span
class="cmti-10">all </span>your
glossaries, then use
-</p><!--l. 1116--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1125--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsdisablehyper </span></div><hr>
-</p><!--l. 1117--><p class="noindent" >
+</p><!--l. 1126--><p class="noindent" >
If you want hyperlinks suppressed for entries in specific glossaries, then use the
<span
-class="cmtt-10">nohypertypes </span>package option. For example, if you don&#8217;t want hyperlinks for entries in
-the <span
+class="cmtt-10">nohypertypes </span>package option. For example, if you don&#8217;t want hyperlinks for entries
+in the <span
class="cmtt-10">acronym </span>and <span
class="cmtt-10">notation </span>glossaries but you do want them for entries in the <span
class="cmtt-10">main</span>
glossary, then do:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-50">
+ <div class="verbatim" id="verbatim-51">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1127--><p class="nopar" >
-</p><!--l. 1129--><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
+<!--l. 1136--><p class="nopar" >
+</p><!--l. 1138--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
+want hyperlinks for subsequence references then use the <span
class="cmtt-10">hyperfirst=false </span>package
option:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-51">
+ <div class="verbatim" id="verbatim-52">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[hyperfirst=false]{glossaries}
</div>
-<!--l. 1135--><p class="nopar" >
-</p><!--l. 1137--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This
-isn&#8217;t specific to the <span
+<!--l. 1144--><p class="nopar" >
+</p><!--l. 1146--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn&#8217;t
+specific to the <span
class="cmss-10">glossaries</span><a
id="dx1-8008"></a> package but is a&#x00A0;limitation of PDF bookmarks.
Non-expandable commands include commands like <span
@@ -2084,49 +2136,49 @@ class="cmss-10">hyperref</span><a
id="dx1-8009"></a> package provides a&#x00A0;way of specifying alternative text for the PDF
bookmarks via <span
class="cmtt-10">\texorpdfstring</span>. For example:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-52">
+ <div class="verbatim" id="verbatim-53">
\section{The&#x00A0;\texorpdfstring{\gls{fishage}}{Fish&#x00A0;Age}}
</div>
-<!--l. 1145--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
+<!--l. 1154--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
class="cmtt-10">\gls </span>in a&#x00A0;section heading as
you&#8217;ll end up with the table of contents in your location list. Instead you can
use
-</p><!--l. 1150--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1159--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsentrytext{</span>&#x27E8;<span
class="cmitt-10">label</span>&#x27E9;<span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 1151--><p class="noindent" >
+</p><!--l. 1160--><p class="noindent" >
This is expandable provided that the <span
class="cmtt-10">text </span>key doesn&#8217;t contain non-expandable code.
For example, the following works:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-53">
+ <div class="verbatim" id="verbatim-54">
\section{The&#x00A0;\glsentrytext{fishage}}
</div>
-<!--l. 1156--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
-</p><!--l. 1159--><p class="noindent" >
+<!--l. 1165--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
+</p><!--l. 1168--><p class="noindent" >
</p>
-<!--l. 1159--><p class="noindent" ><a
+<!--l. 1168--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a
id="sec:xr"></a>Cross-References</h3>
-<!--l. 1162--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
+<!--l. 1171--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
class="cmtt-10">see={</span>&#x27E8;<span
class="cmti-10">label</span>&#x27E9;<span
class="cmtt-10">} </span>key
when you define an entry. The referenced entry must also be defined.
-</p><!--l. 1166--><p class="indent" > For example:
-
+</p><!--l. 1175--><p class="indent" > For example:
+
-
+
</p>
- <div class="verbatim" id="verbatim-54">
+ <div class="verbatim" id="verbatim-55">
\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
@@ -2141,18 +2193,18 @@ when you define an entry. The referenced entry must also be defined.
&#x00A0;<br />&#x00A0;&#x00A0;see={devonian}
&#x00A0;<br />}
</div>
-<!--l. 1183--><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
+<!--l. 1192--><p class="nopar" > The cross-reference will appear as &#8220;<span
+class="cmti-10">see </span>Devonian&#8221;. You can change the &#8220;see&#8221; tag
+using the format <span
class="cmtt-10">see=[</span>&#x27E8;<span
class="cmti-10">tag</span>&#x27E9;<span
class="cmtt-10">]</span>&#x27E8;<span
class="cmti-10">label</span>&#x27E9;. For example:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-55">
+ <div class="verbatim" id="verbatim-56">
\newglossaryentry{latinalph}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;alphabet},
@@ -2167,47 +2219,47 @@ class="cmti-10">label</span>&#x27E9;. For example:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;other&#x00A0;letters&#x00A0;such&#x00A0;as&#x00A0;ligatures&#x00A0;or&#x00A0;diacritics.}
&#x00A0;<br />}
</div>
-<!--l. 1201--><p class="nopar" > If you use the <span
+<!--l. 1210--><p class="nopar" > If you use the <span
class="cmtt-10">see </span>key in the optional argument of <span
class="cmtt-10">\newacronym</span>, make sure you
enclose the value in braces. For example:
-
+
-
+
</p>
- <div class="verbatim" id="verbatim-56">
+ <div class="verbatim" id="verbatim-57">
\newacronym{ksvm}{ksvm}{kernel&#x00A0;support&#x00A0;vector&#x00A0;machine}
&#x00A0;<br />\newacronym
&#x00A0;<br />&#x00A0;[see={[see&#x00A0;also]{ksvm}}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 1210--><p class="nopar" >
-</p><!--l. 1212--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location list
-using the <span
+<!--l. 1219--><p class="nopar" >
+</p><!--l. 1221--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location
+list using the <span
class="cmtt-10">nonumberlist </span>package option, then the cross-reference will also be
suppressed.
-</p><!--l. 1216--><p class="noindent" >
+</p><!--l. 1225--><p class="noindent" >
</p>
-<!--l. 1216--><p class="noindent" ><a
+<!--l. 1225--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a
id="sec:moreinfo"></a>Further Information</h3>
-<!--l. 1219--><p class="noindent" >Further information can be found in the main <span
+<!--l. 1228--><p class="noindent" >Further information can be found in the main <span
class="cmss-10">glossaries</span><a
id="dx1-10001"></a> <a
-href="glossaries-user.html" >user manual</a> or in the <a
-href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries
-FAQ</a>. There is also an <a
-href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries package</a> on the <a
+href="glossaries-user.html" >user manual</a> or in the
+<a
+href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries FAQ</a>. There is also an <a
+href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries package</a> on the
+<a
href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;Community&#8217;s</a>
-Know How section and a&#x00A0;chapter on the <span
+class="E">E</span>X</span></span>&#x00A0;Community&#8217;s</a> Know How section and a&#x00A0;chapter on the <span
class="cmss-10">glossaries</span><a
- id="dx1-10002"></a> package in <a
+ id="dx1-10002"></a> package in
+<a
href="http://www.dickimaw-books.com/latex/thesis/" >Using <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
-class="E">E</span>X</span></span>&#x00A0;to Write a
-PhD Thesis</a>. </p>
+class="E">E</span>X</span></span>&#x00A0;to Write a PhD Thesis</a>. </p>
</body></html>
-
+