summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html392
1 files changed, 205 insertions, 187 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
index 35bb2428f90..eda478fcee2 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
+++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
@@ -10,7 +10,7 @@
<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="2016-04-30 18:29:00" />
+<meta name="date" content="2016-06-09 19:37:00" />
<style type="text/css">
<!--
@@ -209,7 +209,7 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle
>
<!--l. 44--><p class="noindent" >
</p><!--l. 44--><p class="noindent" ><span
-class="cmr-17">The glossaries package v4.23: a guide for</span>
+class="cmr-17">The glossaries package v4.25: a guide for</span>
<span
class="cmr-17">beginners</span>
</p>
@@ -222,7 +222,7 @@ 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-04-30</span></p></div>
+class="cmr-12">2016-06-09</span></p></div>
<div
class="abstract"
>
@@ -1036,29 +1036,47 @@ class="E">E</span>X</span></span>&#x00A0;then reads this file on the next
</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="enumerate" id="x1-5008x1">If you are using <span
+class="cmss-10">ngerman</span><a
+ id="dx1-5009"></a> or some other package that makes the
+ double-quote character <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">"</span></span></span> a shorthand, then use <span
+class="cmtt-10">\GlsSetQuote </span>to change
+ this to some other character. For example:
+
+
+
+ <div class="verbatim" id="verbatim-20">
+ \GlsSetQuote{+}
+</div>
+ <!--l. 566--><p class="nopar" > Use this as soon as possible after you&#8217;ve loaded the <span
+class="cmss-10">glossaries</span>
+ package.
+ </p></li>
+ <li
+ class="enumerate" id="x1-5011x2">Add <span
+class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
+ entries).
</li>
<li
- class="enumerate" id="x1-5010x2">Put
- <!--l. 565--><p class="noindent" ><hr><div title="Definition"><span
+ class="enumerate" id="x1-5013x3">Put
+ <!--l. 575--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>&#x27E8;<span
class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 566--><p class="noindent" >
+ </p><!--l. 576--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key
isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
- </p><!--l. 571--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 581--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 572--><p class="noindent" >
+ </p><!--l. 582--><p class="noindent" >
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="enumerate" id="x1-5015x4">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
@@ -1072,7 +1090,7 @@ class="cmtt-10">myDoc.ist</span>). If you look at your document at this point, y
glossary as it hasn&#8217;t been created yet.
</li>
<li
- class="enumerate" id="x1-5014x4">Run <span
+ class="enumerate" id="x1-5017x5">Run <span
class="cmtt-10">makeindex </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.ist </span>file
@@ -1085,10 +1103,10 @@ class="cmtt-10">.gls</span>. If you have access to a terminal or a command promp
- <div class="verbatim" id="verbatim-20">
+ <div class="verbatim" id="verbatim-21">
makeindex&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
</div>
- <!--l. 591--><p class="nopar" > (Replace <span
+ <!--l. 601--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document file. Avoid
spaces in the file name.) If you don&#8217;t know how to use the command
@@ -1097,20 +1115,20 @@ 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
+ </p><!--l. 609--><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">
+ <div class="verbatim" id="verbatim-22">
makeindex&#x00A0;-l&#x00A0;-s&#x00A0;myDoc.ist&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
</div>
- <!--l. 605--><p class="nopar" >
+ <!--l. 615--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5016x5">Once you have successfully completed the previous step, you can now run
+ class="enumerate" id="x1-5019x6">Once you have successfully completed the previous step, you can now run
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;on your document again.</li></ol>
</dd><dt class="description">
@@ -1119,7 +1137,7 @@ class="description"><a
id="option3"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10">&#x00A0;3</span>:
- <!--l. 613--><p class="noindent" >This option uses an application called <span
+ <!--l. 623--><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
@@ -1140,43 +1158,43 @@ 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" >
+ </p><!--l. 635--><p class="noindent" >
</p><ol class="enumerate1" >
<li
- class="enumerate" id="x1-5018x1">Add the <span
+ class="enumerate" id="x1-5021x1">Add the <span
class="cmtt-10">xindy </span>option to the <span
class="cmss-10">glossaries</span><a
- id="dx1-5019"></a> package option list:
+ id="dx1-5022"></a> package option list:
- <div class="verbatim" id="verbatim-22">
+ <div class="verbatim" id="verbatim-23">
\usepackage[xindy]{glossaries}
</div>
- <!--l. 630--><p class="nopar" >
+ <!--l. 640--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5021x2">Add <span
+ class="enumerate" id="x1-5024x2">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
</li>
<li
- class="enumerate" id="x1-5023x3">Put
- <!--l. 637--><p class="noindent" ><hr><div title="Definition"><span
+ class="enumerate" id="x1-5026x3">Put
+ <!--l. 647--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>&#x27E8;<span
class="cmitt-10">options</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
- </p><!--l. 638--><p class="noindent" >
+ </p><!--l. 648--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key
isn&#8217;t available in &#x27E8;<span
class="cmti-10">options</span>&#x27E9;.) Alternatively, use
- </p><!--l. 643--><p class="noindent" ><hr><div title="Definition"><span
+ </p><!--l. 653--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
- </p><!--l. 644--><p class="noindent" >
+ </p><!--l. 654--><p class="noindent" >
</p></li>
<li
- class="enumerate" id="x1-5025x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+ class="enumerate" id="x1-5028x4">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
@@ -1190,7 +1208,7 @@ class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, y
glossary as it hasn&#8217;t been created yet.
</li>
<li
- class="enumerate" id="x1-5027x5">Run <span
+ class="enumerate" id="x1-5030x5">Run <span
class="cmtt-10">xindy </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.xdy </span>file as
@@ -1204,11 +1222,11 @@ class="cmtt-10">.gls</span>. You
- <div class="verbatim" id="verbatim-23">
+ <div class="verbatim" id="verbatim-24">
xindy&#x00A0;&#x00A0;-L&#x00A0;english&#x00A0;-C&#x00A0;utf8&#x00A0;-I&#x00A0;xindy&#x00A0;-M&#x00A0;myDoc
&#x00A0;<br />-t&#x00A0;myDoc.glg&#x00A0;-o&#x00A0;myDoc.gls&#x00A0;myDoc.glo
</div>
- <!--l. 664--><p class="nopar" > (Replace <span
+ <!--l. 674--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document file. Avoid
spaces in the file name. If necessary, also replace <span
@@ -1220,7 +1238,7 @@ 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
+ </p><!--l. 684--><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:
@@ -1228,25 +1246,25 @@ class="cmtt-10">order=letter </span>package
</p>
- <div class="verbatim" id="verbatim-24">
+ <div class="verbatim" id="verbatim-25">
\usepackage[xindy,order=letter]{glossaries}
</div>
- <!--l. 680--><p class="nopar" >
+ <!--l. 690--><p class="nopar" >
</p></li>
<li
- class="enumerate" id="x1-5029x6">Once you have successfully completed the previous step, you can now run
+ class="enumerate" id="x1-5032x6">Once you have successfully completed the previous step, you can now run
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;on your document again.
</li></ol>
</dd></dl>
-<!--l. 689--><p class="indent" > For Options&#x00A0;<a
+<!--l. 699--><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
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
+ id="dx1-5033"></a> package provides a&#x00A0;script called
<span
class="cmtt-10">makeglossaries </span>that reads the <span
class="cmtt-10">.aux </span>file to determine what settings you have used
@@ -1261,10 +1279,10 @@ class="cmtt-10">myDoc.tex</span>, then run:
</p>
- <div class="verbatim" id="verbatim-25">
+ <div class="verbatim" id="verbatim-26">
makeglossaries&#x00A0;myDoc
</div>
-<!--l. 700--><p class="nopar" > (Replace <span
+<!--l. 710--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;document file. Avoid
spaces in the file name.) If you don&#8217;t know how to use the command prompt,
@@ -1277,13 +1295,13 @@ directives:
</p>
- <div class="verbatim" id="verbatim-26">
+ <div class="verbatim" id="verbatim-27">
&#x00A0;arara:&#x00A0;pdflatex
&#x00A0;<br />&#x00A0;arara:&#x00A0;makeglossaries
&#x00A0;<br />&#x00A0;arara:&#x00A0;pdflatex
</div>
-<!--l. 710--><p class="nopar" >
-</p><!--l. 712--><p class="indent" > The <span
+<!--l. 720--><p class="nopar" >
+</p><!--l. 722--><p class="indent" > The <span
class="cmtt-10">makeglossaries </span>script is written in Perl, so you need a&#x00A0;Perl interpreter
installed. If you are using a&#x00A0;Unix-like operating system then you most likely have one
installed. If you are using Windows with the <span class="TEX">T<span
@@ -1307,20 +1325,20 @@ class="cmtt-10">makeglossaries-lite.lua</span>:
</p>
- <div class="verbatim" id="verbatim-27">
+ <div class="verbatim" id="verbatim-28">
makeglossaries-lite.lua&#x00A0;myDoc
</div>
-<!--l. 726--><p class="nopar" >
-</p><!--l. 728--><p class="indent" > As a last resort you can try the package option <span
+<!--l. 736--><p class="nopar" >
+</p><!--l. 738--><p class="indent" > As a last resort you can try the package option <span
class="cmtt-10">automake</span>:
</p>
- <div class="verbatim" id="verbatim-28">
+ <div class="verbatim" id="verbatim-29">
\usepackage[automake]{glossaries}
</div>
-<!--l. 731--><p class="nopar" > This will attempt to use <span class="TEX">T<span
+<!--l. 741--><p class="nopar" > This will attempt to use <span class="TEX">T<span
class="E">E</span>X</span>&#8217;s <span
class="cmtt-10">\write18 </span>mechanism to run <span
class="cmtt-10">makeindex </span>or <span
@@ -1335,7 +1353,7 @@ 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
+</p><!--l. 751--><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
@@ -1344,14 +1362,14 @@ earlier definition:
</p>
- <div class="verbatim" id="verbatim-29">
+ <div class="verbatim" id="verbatim-30">
\newglossaryentry{elite}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={{\&#8217;e}lite},
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
-<!--l. 751--><p class="nopar" > No <span
+<!--l. 761--><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
@@ -1367,7 +1385,7 @@ class="description">By default, the accent command will be stripped so the sort
class="cmtt-10">elite</span>. This will put the entry in the &#8220;E&#8221; letter group. However
if you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-5031"></a> package option, the sort value will be
+ id="dx1-5034"></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
@@ -1402,9 +1420,9 @@ class="cmtt-10">xindy </span>disregards <span class="LATEX">L<span class="A">A</
class="E">E</span>X</span></span>&#x00A0;commands so it sorts on <span
class="cmtt-10">elite</span>, which
puts this entry in the &#8220;E&#8221; group.</dd></dl>
-<!--l. 776--><p class="indent" > If the <span
+<!--l. 786--><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">
+ id="dx1-5035"></a> package is used and the entry is defined as: </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
@@ -1437,7 +1455,7 @@ class="description">By default the sort value will be interpreted as <span
class="cmtt-10">elite </span>so the entry
will be put in the &#8220;E&#8221; letter group. If you use the <span
class="cmss-10">sanitizesort=true</span><a
- id="dx1-5033"></a> package
+ id="dx1-5036"></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
@@ -1468,12 +1486,12 @@ 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
+<!--l. 812--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is
to use <span
class="cmtt-10">xindy </span>(<a
href="#option3">Option&#x00A0;3</a>) with the <span
class="cmss-10">inputenc</span><a
- id="dx1-5034"></a> package. If you use <span
+ id="dx1-5037"></a> package. If you use <span
class="cmtt-10">makeindex </span>(<a
href="#option2">Option&#x00A0;2</a>)
you need to specify the <span
@@ -1482,7 +1500,7 @@ class="cmtt-10">sort </span>key like this:
</p>
- <div class="verbatim" id="verbatim-30">
+ <div class="verbatim" id="verbatim-31">
\newglossaryentry{elite}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={{\&#8217;e}lite},
@@ -1490,14 +1508,14 @@ class="cmtt-10">sort </span>key like this:
&#x00A0;<br />&#x00A0;&#x00A0;description={select&#x00A0;group&#x00A0;or&#x00A0;class}
&#x00A0;<br />}
</div>
-<!--l. 813--><p class="nopar" > If you use <a
+<!--l. 823--><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">name </span>key if you don&#8217;t set the <span
class="cmtt-10">sort</span>
key.
-</p><!--l. 818--><p class="indent" > If you use <a
+</p><!--l. 828--><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
@@ -1509,28 +1527,28 @@ href="#option3">Option&#x00A0;3</a>. For example:
</p>
- <div class="verbatim" id="verbatim-31">
+ <div class="verbatim" id="verbatim-32">
\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
+<!--l. 835--><p class="nopar" >
+</p><!--l. 837--><p class="indent" > <a
+href="#x1-50381">Table&#x00A0;1</a> summarises the main pros and cons of three options described
above.
</p>
<div class="table">
-<!--l. 830--><p class="indent" > <a
- id="x1-50351"></a></p><hr class="float" /><div class="float"
+<!--l. 840--><p class="indent" > <a
+ id="x1-50381"></a></p><hr class="float" /><div class="float"
>
<div class="caption"
><span class="id">Table&#x00A0;1: </span><span
-class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50351 -->
+class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50381 -->
<div class="tabular"> <table id="TBL-2" class="tabular"
cellspacing="0" cellpadding="0"
><colgroup id="TBL-2-1g"><col
@@ -1539,7 +1557,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. 836--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
+class="td11"> <!--l. 846--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
class="td11"> <a
href="#option1"><span
class="cmbx-10">Option</span><span
@@ -1554,7 +1572,7 @@ 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. 837--><p class="noindent" >Requires
+class="td11"> <!--l. 847--><p class="noindent" >Requires
an
external
application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
@@ -1566,7 +1584,7 @@ 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. 839--><p class="noindent" >Requires
+class="td11"> <!--l. 849--><p class="noindent" >Requires
Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
class="td11"> <span
class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
@@ -1576,7 +1594,7 @@ 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. 841--><p class="noindent" >Can
+class="td11"> <!--l. 851--><p class="noindent" >Can
sort
extended
Latin
@@ -1592,7 +1610,7 @@ 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. 844--><p class="noindent" >Efficient
+class="td11"> <!--l. 854--><p class="noindent" >Efficient
sort
algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
class="td11"> <span
@@ -1603,7 +1621,7 @@ 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. 846--><p class="noindent" >Can
+class="td11"> <!--l. 856--><p class="noindent" >Can
form
ranges
in
@@ -1618,7 +1636,7 @@ 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. 848--><p class="noindent" >Can
+class="td11"> <!--l. 858--><p class="noindent" >Can
have
non-standard
locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
@@ -1629,7 +1647,7 @@ class="pzdr-">&#x2718; </span></td><td style="white-space:nowrap; text-
class="td11"> <span
class="pzdr-">&#x2714; </span></td>
</tr></table></div>
-<!--l. 852--><p class="noindent" ><sup class="textsuperscript"><span
+<!--l. 862--><p class="noindent" ><sup class="textsuperscript"><span
class="cmsy-9">&#8224;</span></sup> Strips standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;accents so, for example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\AA</span></span></span> is treated the same as
@@ -1640,10 +1658,10 @@ A.
</p>
</div><hr class="endfloat" />
</div>
-<!--l. 856--><p class="noindent" ><a
+<!--l. 866--><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. 859--><p class="noindent" >The default glossary style uses the <span
+<!--l. 869--><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.
@@ -1656,22 +1674,22 @@ class="cmtt-10">\glsnamefont</span>:
</p>
- <div class="verbatim" id="verbatim-32">
+ <div class="verbatim" id="verbatim-33">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
</div>
-<!--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
+<!--l. 876--><p class="nopar" >
+</p><!--l. 878--><p class="indent" > By default, a&#x00A0;full stop is appended to the description. To prevent this from
happening use the <span
class="cmtt-10">nopostdot </span>package option:
</p>
- <div class="verbatim" id="verbatim-33">
+ <div class="verbatim" id="verbatim-34">
\usepackage[nopostdot]{glossaries}
</div>
-<!--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
+<!--l. 882--><p class="nopar" >
+</p><!--l. 884--><p class="indent" > By default, a&#x00A0;location list is displayed for each entry. This refers to the
document locations (for example, the page number) where the entry has been
referenced. If you use Options&#x00A0;<a
href="#option2">2</a> or&#x00A0;<a
@@ -1692,11 +1710,11 @@ option:
</p>
- <div class="verbatim" id="verbatim-34">
+ <div class="verbatim" id="verbatim-35">
\usepackage[nonumberlist]{glossaries}
</div>
-<!--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
+<!--l. 894--><p class="nopar" >
+</p><!--l. 896--><p class="indent" > Entries are grouped according to the first letter of each entry&#8217;s <span
class="cmtt-10">sort </span>key. By
default a&#x00A0;vertical gap is placed between letter groups. You can suppress this with the
<span
@@ -1705,22 +1723,22 @@ class="cmtt-10">nogroupskip </span>package option:
</p>
- <div class="verbatim" id="verbatim-35">
+ <div class="verbatim" id="verbatim-36">
\usepackage[nogroupskip]{glossaries}
</div>
-<!--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
+<!--l. 902--><p class="nopar" >
+</p><!--l. 904--><p class="indent" > If the default style doesn&#8217;t suit your document, you can change the style
using:
-</p><!--l. 897--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 907--><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. 898--><p class="noindent" >
+</p><!--l. 908--><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. 905--><p class="indent" > Examples:
+</p><!--l. 915--><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
@@ -1731,12 +1749,12 @@ class="cmss-10">glossary-mcols</span><a
- <div class="verbatim" id="verbatim-36">
+ <div class="verbatim" id="verbatim-37">
\usepackage[nogroupskip,nopostdot]{glossaries}
&#x00A0;<br />\usepackage{glossary-mcols}
&#x00A0;<br />\setglossarystyle{mcolindex}
</div>
- <!--l. 914--><p class="nopar" >
+ <!--l. 924--><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
@@ -1744,11 +1762,11 @@ class="cmss-10">glossary-mcols</span><a
- <div class="verbatim" id="verbatim-37">
+ <div class="verbatim" id="verbatim-38">
\usepackage[nopostdot]{glossaries}
&#x00A0;<br />\setglossarystyle{altlist}
</div>
- <!--l. 922--><p class="nopar" >
+ <!--l. 932--><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
@@ -1758,21 +1776,21 @@ class="cmss-10">glossary-mcols</span><a
- <div class="verbatim" id="verbatim-38">
+ <div class="verbatim" id="verbatim-39">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{long4col}
</div>
- <!--l. 931--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
+ <!--l. 941--><p class="nopar" > or one of the &#8220;tree&#8221; styles:
</p>
- <div class="verbatim" id="verbatim-39">
+ <div class="verbatim" id="verbatim-40">
\usepackage[nopostdot,nonumberlist]{glossaries}
&#x00A0;<br />\setglossarystyle{tree}
</div>
- <!--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
+ <!--l. 946--><p class="nopar" ></p></li></ol>
+<!--l. 949--><p class="indent" > If your glossary consists of a&#x00A0;list of acronyms and you also want to specify
a&#x00A0;description as well as the long form, then you need to use an acronym style that
will suit the glossary style. For example, use the <span
class="cmtt-10">long-short-desc </span>acronym
@@ -1781,34 +1799,34 @@ style:
</p>
- <div class="verbatim" id="verbatim-40">
+ <div class="verbatim" id="verbatim-41">
\setacronymstyle{long-short-desc}
</div>
-<!--l. 945--><p class="nopar" > Define the acronyms with a&#x00A0;description:
+<!--l. 955--><p class="nopar" > Define the acronyms with a&#x00A0;description:
</p>
- <div class="verbatim" id="verbatim-41">
+ <div class="verbatim" id="verbatim-42">
\newacronym
&#x00A0;<br />&#x00A0;[description={statistical&#x00A0;pattern&#x00A0;recognition&#x00A0;technique}]
&#x00A0;<br />&#x00A0;{svm}{svm}{support&#x00A0;vector&#x00A0;machine}
</div>
-<!--l. 951--><p class="nopar" > Choose a&#x00A0;glossary style that suits wide entry names:
+<!--l. 961--><p class="nopar" > Choose a&#x00A0;glossary style that suits wide entry names:
</p>
- <div class="verbatim" id="verbatim-42">
+ <div class="verbatim" id="verbatim-43">
\setglossarystyle{altlist}
</div>
-<!--l. 955--><p class="nopar" >
-</p><!--l. 957--><p class="noindent" >
+<!--l. 965--><p class="nopar" >
+</p><!--l. 967--><p class="noindent" >
</p>
-<!--l. 957--><p class="noindent" ><a
+<!--l. 967--><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. 960--><p class="noindent" >The <span
+<!--l. 970--><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
@@ -1820,7 +1838,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. 967--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 977--><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
@@ -1832,7 +1850,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. 968--><p class="noindent" >
+</p><!--l. 978--><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
@@ -1855,19 +1873,19 @@ 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. 981--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 991--><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. 982--><p class="noindent" >
-</p><!--l. 984--><p class="indent" > In the case of Options&#x00A0;<a
+</p><!--l. 992--><p class="noindent" >
+</p><!--l. 994--><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. 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
+</p><!--l. 997--><p class="indent" > Since it&#8217;s quite common for documents to have both a&#x00A0;list of terms and a&#x00A0;list of
acronyms, the <span
class="cmss-10">glossaries</span><a
id="dx1-7002"></a> package provides the package option <span
@@ -1878,23 +1896,23 @@ which is a&#x00A0;convenient shortcut for
</p>
- <div class="verbatim" id="verbatim-43">
+ <div class="verbatim" id="verbatim-44">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
-<!--l. 993--><p class="nopar" > The option also changes the behaviour of <span
+<!--l. 1003--><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. 998--><p class="indent" > For example, suppose you want a&#x00A0;main glossary for terms, a&#x00A0;list of acronyms and
+</p><!--l. 1008--><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-44">
+ <div class="verbatim" id="verbatim-45">
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1003--><p class="nopar" > After <span
+<!--l. 1013--><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:
@@ -1902,7 +1920,7 @@ the preamble. For example:
</p>
- <div class="verbatim" id="verbatim-45">
+ <div class="verbatim" id="verbatim-46">
\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,
@@ -1917,13 +1935,13 @@ the preamble. For example:
&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
</div>
-<!--l. 1022--><p class="nopar" > or if you don&#8217;t like using <span
+<!--l. 1032--><p class="nopar" > or if you don&#8217;t like using <span
class="cmtt-10">\ensuremath</span>:
</p>
- <div class="verbatim" id="verbatim-46">
+ <div class="verbatim" id="verbatim-47">
\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,
@@ -1932,39 +1950,39 @@ class="cmtt-10">\ensuremath</span>:
&#x00A0;<br />&#x00A0;&#x00A0;description={A&#x00A0;set},
&#x00A0;<br />&#x00A0;&#x00A0;sort={S}}
</div>
-<!--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
+<!--l. 1042--><p class="nopar" >
+</p><!--l. 1044--><p class="indent" > Each glossary is displayed using:
+</p><!--l. 1046--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[type=</span>&#x27E8;<span
class="cmitt-10">type</span>&#x27E9;<span
class="cmtt-10">] </span></div><hr>
-</p><!--l. 1037--><p class="noindent" >
+</p><!--l. 1047--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1040--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1050--><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. 1041--><p class="noindent" >
+</p><!--l. 1051--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>). Where &#x27E8;<span
class="cmti-10">type</span>&#x27E9; is the glossary label. If the type is omitted the
default <span
class="cmtt-10">main </span>glossary is assumed.
-</p><!--l. 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
+</p><!--l. 1055--><p class="indent" > There&#8217;s a&#x00A0;convenient shortcut that will display all the defined glossaries:
+</p><!--l. 1058--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
-</p><!--l. 1049--><p class="noindent" >
+</p><!--l. 1059--><p class="noindent" >
(<a
href="#option1">Option&#x00A0;1</a>) or
-</p><!--l. 1052--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1062--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
-</p><!--l. 1053--><p class="noindent" >
+</p><!--l. 1063--><p class="noindent" >
(Options&#x00A0;<a
href="#option2">2</a> and&#x00A0;<a
href="#option3">3</a>).
-</p><!--l. 1056--><p class="indent" > If you use <a
+</p><!--l. 1066--><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
@@ -1990,7 +2008,7 @@ 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. 1069--><p class="indent" > For example, suppose you have three glossaries in your document (<span
+</p><!--l. 1079--><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
@@ -1999,42 +2017,42 @@ class="cmtt-10">notation</span>), specified using:
</p>
- <div class="verbatim" id="verbatim-47">
+ <div class="verbatim" id="verbatim-48">
\usepackage[acronyms]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--l. 1075--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
+<!--l. 1085--><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. 1079--><p class="indent" >
+</p><!--l. 1089--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
href="#option2">Option&#x00A0;2</a>:
- <!--l. 1082--><p class="noindent" >You need to run <span
+ <!--l. 1092--><p class="noindent" >You need to run <span
class="cmtt-10">makeindex </span>three times:
</p>
- <div class="verbatim" id="verbatim-48">
+ <div class="verbatim" id="verbatim-49">
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. 1087--><p class="nopar" >
+ <!--l. 1097--><p class="nopar" >
</p></dd><dt class="description">
</dt><dd
class="description"><a
href="#option3">Option&#x00A0;3</a>:
- <!--l. 1091--><p class="noindent" >You need to run <span
+ <!--l. 1101--><p class="noindent" >You need to run <span
class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where
the line has wrapped.)
</p>
- <div class="verbatim" id="verbatim-49">
+ <div class="verbatim" id="verbatim-50">
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
@@ -2042,15 +2060,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. 1100--><p class="nopar" ></p></dd></dl>
-<!--l. 1103--><p class="noindent" >
+ <!--l. 1110--><p class="nopar" ></p></dd></dl>
+<!--l. 1113--><p class="noindent" >
</p>
-<!--l. 1103--><p class="noindent" ><a
+<!--l. 1113--><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. 1106--><p class="noindent" >Take care if you use the <span
+<!--l. 1116--><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
@@ -2068,11 +2086,11 @@ class="cmss-10">hyperref</span><a
</p>
- <div class="verbatim" id="verbatim-50">
+ <div class="verbatim" id="verbatim-51">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage{glossaries}
</div>
-<!--l. 1113--><p class="nopar" > If you use <span
+<!--l. 1123--><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
@@ -2081,16 +2099,16 @@ engine. The DVI format can&#8217;t break hyperlinks across a&#x00A0;line so long
(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. 1120--><p class="indent" > By default, if the <span
+</p><!--l. 1130--><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. 1125--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1135--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsdisablehyper </span></div><hr>
-</p><!--l. 1126--><p class="noindent" >
+</p><!--l. 1136--><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
@@ -2103,13 +2121,13 @@ glossary, then do:
</p>
- <div class="verbatim" id="verbatim-51">
+ <div class="verbatim" id="verbatim-52">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
&#x00A0;<br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
-<!--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
+<!--l. 1146--><p class="nopar" >
+</p><!--l. 1148--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you
want hyperlinks for subsequence references then use the <span
class="cmtt-10">hyperfirst=false </span>package
option:
@@ -2117,12 +2135,12 @@ option:
</p>
- <div class="verbatim" id="verbatim-52">
+ <div class="verbatim" id="verbatim-53">
\usepackage[colorlinks]{hyperref}
&#x00A0;<br />\usepackage[hyperfirst=false]{glossaries}
</div>
-<!--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
+<!--l. 1154--><p class="nopar" >
+</p><!--l. 1156--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn&#8217;t
specific to the <span
class="cmss-10">glossaries</span><a
id="dx1-8008"></a> package but is a&#x00A0;limitation of PDF bookmarks.
@@ -2140,18 +2158,18 @@ class="cmtt-10">\texorpdfstring</span>. For example:
</p>
- <div class="verbatim" id="verbatim-53">
+ <div class="verbatim" id="verbatim-54">
\section{The&#x00A0;\texorpdfstring{\gls{fishage}}{Fish&#x00A0;Age}}
</div>
-<!--l. 1154--><p class="nopar" > However, it&#8217;s not a&#x00A0;good idea to use commands like <span
+<!--l. 1164--><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. 1159--><p class="indent" > <hr><div title="Definition"><span
+</p><!--l. 1169--><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. 1160--><p class="noindent" >
+</p><!--l. 1170--><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:
@@ -2159,26 +2177,26 @@ For example, the following works:
</p>
- <div class="verbatim" id="verbatim-54">
+ <div class="verbatim" id="verbatim-55">
\section{The&#x00A0;\glsentrytext{fishage}}
</div>
-<!--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" >
+<!--l. 1175--><p class="nopar" > and it doesn&#8217;t put the table of contents in the location list.
+</p><!--l. 1178--><p class="noindent" >
</p>
-<!--l. 1168--><p class="noindent" ><a
+<!--l. 1178--><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. 1171--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
+<!--l. 1181--><p class="noindent" >You can add a&#x00A0;reference to another entry in a&#x00A0;location list using the <span
class="cmtt-10">see={</span>&#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. 1175--><p class="indent" > For example:
+</p><!--l. 1185--><p class="indent" > For example:
</p>
- <div class="verbatim" id="verbatim-55">
+ <div class="verbatim" id="verbatim-56">
\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
@@ -2193,7 +2211,7 @@ when you define an entry. The referenced entry must also be defined.
&#x00A0;<br />&#x00A0;&#x00A0;see={devonian}
&#x00A0;<br />}
</div>
-<!--l. 1192--><p class="nopar" > The cross-reference will appear as &#8220;<span
+<!--l. 1202--><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
@@ -2204,7 +2222,7 @@ class="cmti-10">label</span>&#x27E9;. For example:
</p>
- <div class="verbatim" id="verbatim-56">
+ <div class="verbatim" id="verbatim-57">
\newglossaryentry{latinalph}
&#x00A0;<br />{
&#x00A0;<br />&#x00A0;&#x00A0;name={Latin&#x00A0;alphabet},
@@ -2219,7 +2237,7 @@ class="cmti-10">label</span>&#x27E9;. For example:
&#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;other&#x00A0;letters&#x00A0;such&#x00A0;as&#x00A0;ligatures&#x00A0;or&#x00A0;diacritics.}
&#x00A0;<br />}
</div>
-<!--l. 1210--><p class="nopar" > If you use the <span
+<!--l. 1220--><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:
@@ -2227,35 +2245,35 @@ enclose the value in braces. For example:
</p>
- <div class="verbatim" id="verbatim-57">
+ <div class="verbatim" id="verbatim-58">
\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. 1219--><p class="nopar" >
-</p><!--l. 1221--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location
+<!--l. 1229--><p class="nopar" >
+</p><!--l. 1231--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location
list using the <span
class="cmtt-10">nonumberlist </span>package option, then the cross-reference will also be
suppressed.
-</p><!--l. 1225--><p class="noindent" >
+</p><!--l. 1235--><p class="noindent" >
</p>
-<!--l. 1225--><p class="noindent" ><a
+<!--l. 1235--><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. 1228--><p class="noindent" >Further information can be found in the main <span
+<!--l. 1238--><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="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries and glossaries-extra packages</a>
+on the <a
href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>&#x00A0;Community&#8217;s</a> Know How section and a&#x00A0;chapter on the <span
class="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>
</body></html>