diff options
author | Karl Berry <karl@freefriends.org> | 2018-05-23 22:08:06 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-05-23 22:08:06 +0000 |
commit | 450bfa54886ef9c35469b032209d325cbaf0e590 (patch) | |
tree | 5f93606f15ad227df16d412189f526a497bc8169 /Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | |
parent | e0004046da4d90c93c3221cc8acf2aedb5035f26 (diff) |
glossaries (23may18)
git-svn-id: svn://tug.org/texlive/trunk@47817 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.html | 453 |
1 files changed, 228 insertions, 225 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index e3354e4036c..ea9e0762cbf 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -255,7 +255,7 @@ span#textcolor40{color:#00FF00} > <!--l. 55--><p class="noindent" > </p><!--l. 55--><p class="noindent" ><span -class="cmr-17">The glossaries package v4.38: a guide for</span> +class="cmr-17">The glossaries package v4.39: a guide for</span> <span class="cmr-17">beginners</span> </p> @@ -268,7 +268,7 @@ class="td11"> <span class="cmr-12">Nicola L.C. Talbot </span></td></tr></table> </div> <!--l. 55--><p class="noindent" ><span -class="cmr-12">2018-05-10</span></p></div> +class="cmr-12">2018-05-23</span></p></div> <div class="abstract" > @@ -1721,22 +1721,25 @@ href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span cla <!--l. 909--><p class="noindent" >In <a href="#sec:start"><span class="cmsy-10">§</span>1 </a><a -href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a>, I mentioned that there are three options you can choose from -to create an automatically sorted glossary with the base <span -class="cmss-10">glossaries </span>package. These are -also available with the extension package <span -class="cmss-10">glossaries-extra </span>along with a fourth option. -These four options are listed below in a little more detail. <a -href="#x1-50011">Table 1</a> summarises the -main advantages and disadvantages. (There’s a more detailed summary in the main -<span -class="cmss-10">glossaries </span>user manual.) +href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a>, I mentioned that there are three options you can +choose from to create an automatically sorted glossary with the base <span +class="cmss-10">glossaries</span> +package. These are also available with the extension package <span +class="cmss-10">glossaries-extra</span> +along with a fourth option. These four options are listed below in a little +more detail. <a +href="#x1-50011">Table 1</a> summarises the main advantages and disadvantages. +(There’s a more detailed summary in the main <span +class="cmss-10">glossaries </span>user manual.) See also +<a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document +build</a>. </p> <div class="table"> -<!--l. 918--><p class="indent" > <a +<!--l. 919--><p class="indent" > <a id="x1-50011"></a></p><hr class="float" /><div class="float" > @@ -1754,7 +1757,7 @@ id="TBL-2-3" /><col id="TBL-2-4" /><col id="TBL-2-5" /></colgroup><tr style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:wrap; text-align:left;" id="TBL-2-1-1" -class="td11"> <!--l. 924--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" +class="td11"> <!--l. 925--><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 @@ -1773,7 +1776,7 @@ class="cmbx-10">Option</span><span class="cmbx-10"> 4</span></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:wrap; text-align:left;" id="TBL-2-2-1" -class="td11"> <!--l. 926--><p class="noindent" >Requires +class="td11"> <!--l. 927--><p class="noindent" >Requires <span class="cmss-10">glossaries-extra</span><a id="dx1-5002"></a>? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" @@ -1787,7 +1790,7 @@ class="td11"> <span id="textcolor4"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:wrap; text-align:left;" id="TBL-2-3-1" -class="td11"> <!--l. 928--><p class="noindent" >Requires +class="td11"> <!--l. 929--><p class="noindent" >Requires an external application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2" @@ -1801,7 +1804,7 @@ class="td11"> <span id="textcolor8"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:wrap; text-align:left;" id="TBL-2-4-1" -class="td11"> <!--l. 930--><p class="noindent" >Requires +class="td11"> <!--l. 931--><p class="noindent" >Requires Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2" class="td11"> <span id="textcolor9"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3" @@ -1813,7 +1816,7 @@ class="td11"> <span id="textcolor12"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:wrap; text-align:left;" id="TBL-2-5-1" -class="td11"> <!--l. 932--><p class="noindent" >Requires +class="td11"> <!--l. 933--><p class="noindent" >Requires Java? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" class="td11"> <span id="textcolor13"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3" @@ -1825,7 +1828,7 @@ class="td11"> <span id="textcolor16"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:wrap; text-align:left;" id="TBL-2-6-1" -class="td11"> <!--l. 934--><p class="noindent" >Can +class="td11"> <!--l. 935--><p class="noindent" >Can sort extended Latin @@ -1842,7 +1845,7 @@ class="td11"> <span id="textcolor20"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:wrap; text-align:left;" id="TBL-2-7-1" -class="td11"> <!--l. 937--><p class="noindent" >Efficient +class="td11"> <!--l. 938--><p class="noindent" >Efficient sort algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" class="td11"> <span id="textcolor21"><span @@ -1855,7 +1858,7 @@ class="td11"> <span id="textcolor24"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:wrap; text-align:left;" id="TBL-2-8-1" -class="td11"> <!--l. 939--><p class="noindent" >Can +class="td11"> <!--l. 940--><p class="noindent" >Can use different sort @@ -1873,7 +1876,7 @@ class="td11"> <span id="textcolor28"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:wrap; text-align:left;" id="TBL-2-9-1" -class="td11"> <!--l. 941--><p class="noindent" >Any +class="td11"> <!--l. 942--><p class="noindent" >Any problematic sort values? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2" @@ -1887,7 +1890,7 @@ class="td11"> <span id="textcolor32"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:wrap; text-align:left;" id="TBL-2-10-1" -class="td11"> <!--l. 943--><p class="noindent" >Can +class="td11"> <!--l. 944--><p class="noindent" >Can form ranges in @@ -1904,7 +1907,7 @@ class="td11"> <span id="textcolor36"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:wrap; text-align:left;" id="TBL-2-11-1" -class="td11"> <!--l. 945--><p class="noindent" >Can +class="td11"> <!--l. 946--><p class="noindent" >Can have non-standard locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2" @@ -1918,7 +1921,7 @@ class="cmsy-9">†</span></sup> </td><td style="white-space:nowrap; text- class="td11"> <span id="textcolor40"><span class="pzdr-">✔</span></span> </td> </tr></table></div> -<!--l. 948--><p class="noindent" ><sup class="textsuperscript"><span +<!--l. 949--><p class="noindent" ><sup class="textsuperscript"><span class="cmsy-9">†</span></sup> <span class="cmr-8">Requires some setting up.</span> @@ -1933,7 +1936,7 @@ class="description"><a id="option1"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 1</span>: - <!--l. 955--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted + <!--l. 956--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted list, it doesn’t work for non-Latin alphabets. The <span class="cmtt-10">name </span>mustn’t contain commands (or, if it does, the <span @@ -1956,13 +1959,13 @@ href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>). </li> <li class="enumerate" id="x1-5009x2">Put - <!--l. 969--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 970--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printnoidxglossary[sort=</span>⟨<span class="cmitt-10">order</span>⟩<span class="cmtt-10">,</span>⟨<span class="cmitt-10">other options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 970--><p class="noindent" > + </p><!--l. 971--><p class="noindent" > where you want your list of entries to appear. The sort ⟨<span class="cmti-10">order</span>⟩ may be one of: <span @@ -1973,12 +1976,12 @@ class="cmtt-10">case </span>(case-sensitive class="cmtt-10">def </span>(in order of definition) or <span class="cmtt-10">use </span>(in order of use). Alternatively, use - </p><!--l. 977--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 978--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printnoidxglossaries </span></div><hr> - </p><!--l. 978--><p class="noindent" > + </p><!--l. 979--><p class="noindent" > to display all your glossaries (if you have more than one). This command doesn’t have any arguments. - </p><!--l. 982--><p class="noindent" >This option allows you to have different sort methods. For example: + </p><!--l. 983--><p class="noindent" >This option allows you to have different sort methods. For example: @@ -1987,7 +1990,7 @@ class="cmtt-10">\printnoidxglossaries </span></div><hr> \printnoidxglossary[sort=word]% main glossary  <br />\printnoidxglossary[type=symbols,sort=use]% symbols glossary </div> - <!--l. 987--><p class="nopar" > + <!--l. 988--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5011x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -1995,7 +1998,7 @@ class="E">E</span>X</span></span> twice on your document. (As you would d of contents appear.) For example, click twice on the “typeset” or “build” or “PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>” button in your editor.</li></ol> - <!--l. 993--><p class="noindent" >Here’s a complete document (<span + <!--l. 994--><p class="noindent" >Here’s a complete document (<span class="cmtt-10">myDoc.tex</span>): @@ -2012,7 +2015,7 @@ class="cmtt-10">myDoc.tex</span>):  <br />\printnoidxglossaries % iterate over all indexed entries  <br />\end{document} </div> - <!--l. 1009--><p class="nopar" > Document build: + <!--l. 1010--><p class="nopar" > Document build: @@ -2021,14 +2024,14 @@ class="cmtt-10">myDoc.tex</span>): pdflatex myDoc  <br />pdflatex myDoc </div> - <!--l. 1014--><p class="nopar" > + <!--l. 1015--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a id="option2"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 2</span>: - <!--l. 1018--><p class="noindent" >This option uses an application called <span + <!--l. 1019--><p class="noindent" >This option uses an application called <span class="cmtt-10">makeindex</span><a id="dx1-5012"></a> to sort the entries. This application comes with all modern <span class="TEX">T<span @@ -2069,7 +2072,7 @@ class="cmtt-10">\GlsSetQuote </span>to change this to some other character. <div class="verbatim" id="verbatim-43"> \GlsSetQuote{+} </div> - <!--l. 1037--><p class="nopar" > Use this as soon as possible after you’ve loaded the <span + <!--l. 1038--><p class="nopar" > Use this as soon as possible after you’ve loaded the <span class="cmss-10">glossaries</span> package. </p></li> @@ -2080,21 +2083,21 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5025x3">Put - <!--l. 1046--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 1047--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossary[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 1047--><p class="noindent" > + </p><!--l. 1048--><p class="noindent" > where you want your list of entries (glossary) to appear. (The <span class="cmtt-10">sort </span>key isn’t available in ⟨<span class="cmti-10">options</span>⟩.) Alternatively, use - </p><!--l. 1052--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 1053--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> - </p><!--l. 1053--><p class="noindent" > + </p><!--l. 1054--><p class="noindent" > which will display all glossaries (if you have more than one). This command doesn’t have any arguments. - </p><!--l. 1057--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified + </p><!--l. 1058--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified with one of the package options: <span class="cmss-10">sort=standard</span><a id="dx1-5026"></a> (default), <span @@ -2103,7 +2106,7 @@ class="cmss-10">sort=use</span><a <span class="cmss-10">sort=def</span><a id="dx1-5028"></a>. </div> - </p><!--l. 1062--><p class="noindent" > + </p><!--l. 1063--><p class="noindent" > </p></li> <li class="enumerate" id="x1-5030x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -2134,7 +2137,7 @@ class="cmtt-10">.tex</span>) extension. If you have access to a terminal or a co <div class="verbatim" id="verbatim-44"> makeglossaries myDoc </div> - <!--l. 1078--><p class="nopar" > (Replace <span + <!--l. 1079--><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> document file without the <span @@ -2149,8 +2152,8 @@ class="cmtt-10">makeglossaries-lite</span><a <div class="verbatim" id="verbatim-45"> makeglossaries-lite myDoc </div> - <!--l. 1085--><p class="nopar" > - </p><!--l. 1087--><p class="noindent" ><div class="important" title="Important Note"> Some beginners get confused by <span + <!--l. 1086--><p class="nopar" > + </p><!--l. 1088--><p class="noindent" ><div class="important" title="Important Note"> Some beginners get confused by <span class="cmtt-10">makeglossaries</span><a id="dx1-5035"></a> the application (run as a system command) and <span @@ -2159,8 +2162,8 @@ class="E">E</span>X</span></span> command which should be typed in the document preamble. These are two different concepts that happen to have similar looking names. </div> - </p><!--l. 1093--><p class="noindent" > - </p><!--l. 1095--><p class="noindent" >If you don’t know how to use the command prompt, then you can + </p><!--l. 1094--><p class="noindent" > + </p><!--l. 1096--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably configure your text editor to add <span class="cmtt-10">makeglossaries</span><a id="dx1-5036"></a> (or @@ -2179,8 +2182,8 @@ class="cmss-10">automake</span><a <div class="verbatim" id="verbatim-46"> \usepackage[automake]{glossaries} </div> - <!--l. 1105--><p class="nopar" > - </p><!--l. 1107--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you + <!--l. 1106--><p class="nopar" > + </p><!--l. 1108--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the <span class="cmss-10">order=letter</span><a id="dx1-5039"></a> package @@ -2192,13 +2195,13 @@ class="cmss-10">order=letter</span><a <div class="verbatim" id="verbatim-47"> \usepackage[order=letter]{glossaries} </div> - <!--l. 1112--><p class="nopar" > + <!--l. 1113--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5041x6">Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> on your document again.</li></ol> - <!--l. 1117--><p class="noindent" >Here’s a complete document (<span + <!--l. 1118--><p class="noindent" >Here’s a complete document (<span class="cmtt-10">myDoc.tex</span>): @@ -2215,7 +2218,7 @@ class="cmtt-10">myDoc.tex</span>):  <br />\printglossaries % input files created by makeindex  <br />\end{document} </div> - <!--l. 1133--><p class="nopar" > Document build: + <!--l. 1134--><p class="nopar" > Document build: @@ -2225,7 +2228,7 @@ class="cmtt-10">myDoc.tex</span>):  <br />makeglossaries myDoc  <br />pdflatex myDoc </div> - <!--l. 1139--><p class="nopar" > or + <!--l. 1140--><p class="nopar" > or @@ -2235,14 +2238,14 @@ class="cmtt-10">myDoc.tex</span>):  <br />makeglossaries-lite myDoc  <br />pdflatex myDoc </div> - <!--l. 1145--><p class="nopar" > + <!--l. 1146--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a id="option3"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 3</span>: - <!--l. 1150--><p class="noindent" >This option uses an application called <span + <!--l. 1151--><p class="noindent" >This option uses an application called <span class="cmtt-10">xindy</span><a id="dx1-5042"></a> to sort the entries. This application is more flexible than <span @@ -2286,7 +2289,7 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-51"> \usepackage[xindy]{glossaries} </div> - <!--l. 1169--><p class="nopar" > + <!--l. 1170--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5054x2">Add <span @@ -2295,19 +2298,19 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5056x3">Put - <!--l. 1176--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 1177--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossary[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 1177--><p class="noindent" > + </p><!--l. 1178--><p class="noindent" > where you want your list of entries (glossary) to appear. (The <span class="cmtt-10">sort </span>key isn’t available in ⟨<span class="cmti-10">options</span>⟩.) Alternatively, use - </p><!--l. 1182--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 1183--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> - </p><!--l. 1183--><p class="noindent" > - </p><!--l. 1185--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified + </p><!--l. 1184--><p class="noindent" > + </p><!--l. 1186--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified with one of the package options: <span class="cmss-10">sort=standard</span><a id="dx1-5057"></a> (default), <span @@ -2316,7 +2319,7 @@ class="cmss-10">sort=use</span><a <span class="cmss-10">sort=def</span><a id="dx1-5059"></a>. </div> - </p><!--l. 1190--><p class="noindent" > + </p><!--l. 1191--><p class="noindent" > </p></li> <li class="enumerate" id="x1-5061x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -2347,7 +2350,7 @@ class="cmtt-10">.tex </span>extension). If you have access to a terminal or a co <div class="verbatim" id="verbatim-52"> makeglossaries myDoc </div> - <!--l. 1206--><p class="nopar" > (Replace <span + <!--l. 1207--><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> document file without the <span @@ -2357,7 +2360,7 @@ class="cmtt-10">.tex </span>extension. Avoid spaces in the file name. If you don class="cmtt-10">makeglossaries</span><a id="dx1-5065"></a> as a build tool. - </p><!--l. 1214--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you + </p><!--l. 1215--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the <span class="cmtt-10">order=letter </span>package option: @@ -2368,14 +2371,14 @@ class="cmtt-10">order=letter </span>package <div class="verbatim" id="verbatim-53"> \usepackage[xindy,order=letter]{glossaries} </div> - <!--l. 1220--><p class="nopar" > + <!--l. 1221--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5067x6">Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> on your document again. </li></ol> - <!--l. 1226--><p class="noindent" >Here’s a complete document (<span + <!--l. 1227--><p class="noindent" >Here’s a complete document (<span class="cmtt-10">myDoc.tex</span>): @@ -2392,7 +2395,7 @@ class="cmtt-10">myDoc.tex</span>):  <br />\printglossaries % input files created by xindy  <br />\end{document} </div> - <!--l. 1242--><p class="nopar" > Document build: + <!--l. 1243--><p class="nopar" > Document build: @@ -2402,14 +2405,14 @@ class="cmtt-10">myDoc.tex</span>):  <br />makeglossaries myDoc  <br />pdflatex myDoc </div> - <!--l. 1248--><p class="nopar" > + <!--l. 1249--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a id="option4"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 4</span>: - <!--l. 1252--><p class="noindent" >This requires the extension package <span + <!--l. 1253--><p class="noindent" >This requires the extension package <span class="cmss-10">glossaries-extra</span><a id="dx1-5068"></a> and an application called <span @@ -2445,17 +2448,17 @@ class="cmss-10">glossaries-extra</span><a <div class="verbatim" id="verbatim-56"> \usepackage[record]{glossaries-extra} </div> - <!--l. 1271--><p class="nopar" > + <!--l. 1272--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5075x2">Add one or more - <!--l. 1275--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 1276--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\GlsXtrLoadResources[src={</span>⟨<span class="cmitt-10">bib list</span>⟩<span class="cmtt-10">},</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 1276--><p class="noindent" > + </p><!--l. 1277--><p class="noindent" > to your preamble where ⟨<span class="cmti-10">bib list</span>⟩ is the list of <span class="cmtt-10">.bib </span>files containing the @@ -2493,7 +2496,7 @@ class="cmtt-10">.bib </span>files containing the  <br />  sort={double}% double-precision sort  <br />] </div> - <!--l. 1308--><p class="nopar" > The last resource set assumes that the entries defined in the file + <!--l. 1309--><p class="nopar" > The last resource set assumes that the entries defined in the file <span class="cmtt-10">constants.bib </span>have a number stored in the <span class="cmtt-10">user1 </span>field. For @@ -2509,26 +2512,26 @@ class="cmtt-10">user1 </span>field. For  <br />  user1={3.141592654}  <br />} </div> - <!--l. 1318--><p class="nopar" > + <!--l. 1319--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5077x3">Put - <!--l. 1322--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 1323--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printunsrtglossary[type={</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">},</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 1323--><p class="noindent" > + </p><!--l. 1324--><p class="noindent" > where you want your list of entries (glossary) to appear. (The <span class="cmtt-10">sort </span>key isn’t available in ⟨<span class="cmti-10">options</span>⟩. It needs to be used in <span class="cmtt-10">\GlsXtrLoadResources</span> instead.) Alternatively, use - </p><!--l. 1329--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 1330--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printunsrtglossaries </span></div><hr> - </p><!--l. 1330--><p class="noindent" > + </p><!--l. 1331--><p class="noindent" > </p></li> <li class="enumerate" id="x1-5079x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -2547,7 +2550,7 @@ class="cmtt-10">myDoc.tex</span>: <div class="verbatim" id="verbatim-59"> pdflatex myDoc </div> - <!--l. 1338--><p class="nopar" > + <!--l. 1339--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5083x5">Run <span @@ -2559,7 +2562,7 @@ class="cmtt-10">bib2gls</span><a <div class="verbatim" id="verbatim-60"> bib2gls myDoc </div> - <!--l. 1343--><p class="nopar" > or (if you need letter groups) + <!--l. 1344--><p class="nopar" > or (if you need letter groups) @@ -2567,12 +2570,12 @@ class="cmtt-10">bib2gls</span><a <div class="verbatim" id="verbatim-61"> bib2gls --group myDoc </div> - <!--l. 1347--><p class="nopar" > + <!--l. 1348--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5086x6">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> again.</li></ol> - <!--l. 1351--><p class="noindent" >Here’s a complete document (<span + <!--l. 1352--><p class="noindent" >Here’s a complete document (<span class="cmtt-10">myDoc.tex</span>): @@ -2593,7 +2596,7 @@ class="cmtt-10">myDoc.tex</span>):  <br />\printunsrtglossaries % iterate over all defined entries  <br />\end{document} </div> - <!--l. 1371--><p class="nopar" > The accompanying <span + <!--l. 1372--><p class="nopar" > The accompanying <span class="cmtt-10">entries.bib </span>file: @@ -2605,7 +2608,7 @@ class="cmtt-10">entries.bib </span>file:  <br />  description = {an example}  <br />} </div> - <!--l. 1378--><p class="nopar" > Document build: + <!--l. 1379--><p class="nopar" > Document build: @@ -2615,10 +2618,10 @@ class="cmtt-10">entries.bib </span>file:  <br />bib2gls myDoc  <br />pdflatex myDoc </div> - <!--l. 1384--><p class="nopar" > + <!--l. 1385--><p class="nopar" > </p> </dd></dl> -<!--l. 1388--><p class="indent" > If you are having difficulty integrating <span +<!--l. 1389--><p class="indent" > If you are having difficulty integrating <span class="cmtt-10">makeglossaries</span><a id="dx1-5087"></a> into your document build process, you may want to consider using <span @@ -2641,7 +2644,7 @@ class="cmtt-10">myDoc.tex </span>might start with:  <br /> \usepackage{glossaries}  <br /> \makeglossaries </div> -<!--l. 1401--><p class="nopar" > then to build the document you just need the single system call: +<!--l. 1402--><p class="nopar" > then to build the document you just need the single system call: @@ -2649,7 +2652,7 @@ class="cmtt-10">myDoc.tex </span>might start with: <div class="verbatim" id="verbatim-66">  arara myDoc </div> -<!--l. 1405--><p class="nopar" > (The currently pending version 4.0 of <span +<!--l. 1406--><p class="nopar" > (The currently pending version 4.0 of <span class="cmtt-10">arara</span><a id="dx1-5090"></a> has directives for <span class="cmtt-10">makeglossaries-lite</span><a @@ -2662,7 +2665,7 @@ class="cmtt-10">makeglossaries.yaml </span>file and replace <span class="cmtt-10">makeglossaries</span><a id="dx1-5093"></a> as appropriate.) -</p><!--l. 1412--><p class="indent" > When sorting the entries, the string comparisons are made according to each +</p><!--l. 1413--><p class="indent" > When sorting the entries, the string comparisons are made according to each entry’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 @@ -2678,7 +2681,7 @@ earlier definition:  <br />   description={select group or class}  <br /> } </div> -<!--l. 1422--><p class="nopar" > No <span +<!--l. 1423--><p class="nopar" > No <span class="cmtt-10">sort </span>key was used, so it’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">{\’e}lite</span></span></span>. How this @@ -2743,7 +2746,7 @@ class="cmtt-10">sort </span>value that <span class="cmtt-10">xindy</span><a id="dx1-5098"></a> will accept. - <!--l. 1448--><p class="noindent" ><div class="important" title="Important Note"> <span + <!--l. 1449--><p class="noindent" ><div class="important" title="Important Note"> <span class="cmtt-10">xindy</span><a id="dx1-5099"></a> merges entries with duplicate sort values. <span class="cmtt-10">xindy</span><a @@ -2752,7 +2755,7 @@ class="cmtt-10">xindy</span><a class="cmtt-10">xindy</span><a id="dx1-5101"></a> has stripped all commands and braces. </div> - </p><!--l. 1453--><p class="noindent" > + </p><!--l. 1454--><p class="noindent" > </p></dd><dt class="description"> <a href="#option4"><span @@ -2772,7 +2775,7 @@ class="cmtt-10">lite</span>. It disregards unknown class="cmtt-10">bib2gls</span><a id="dx1-5103"></a> doesn’t mind that. - <!--l. 1462--><p class="noindent" >Note that even if the name is given as <span class="obeylines-h"><span class="verb"><span + <!--l. 1463--><p class="noindent" >Note that even if the name is given as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">{\’e}lite</span></span></span>, the letter group heading (if the <span class="obeylines-h"><span class="verb"><span class="cmtt-10">--group</span></span></span> switch is used) may end up with the character É @@ -2788,7 +2791,7 @@ class="E">E</span>X</span></span> engine with native UTF-8 support. </p> </dd></dl> -<!--l. 1472--><p class="indent" > If the <span +<!--l. 1473--><p class="indent" > If the <span class="cmss-10">inputenc</span><a id="dx1-5105"></a> package is used: @@ -2798,7 +2801,7 @@ class="cmss-10">inputenc</span><a <div class="verbatim" id="verbatim-68">  \usepackage[utf8]{inputenc} </div> -<!--l. 1475--><p class="nopar" > and the entry is defined as: </p><div class="alltt"> +<!--l. 1476--><p class="nopar" > and the entry is defined as: </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10"> </span><span class="verb"><span @@ -2899,7 +2902,7 @@ class="cmtt-10"> UTF-8</span> </div> </div> - <!--l. 1515--><p class="noindent" >With the correct encoding set up, <span + <!--l. 1516--><p class="noindent" >With the correct encoding set up, <span class="cmtt-10">bib2gls</span><a id="dx1-5111"></a> will determine that the sort value is <span @@ -2914,7 +2917,7 @@ class="cmtt-10">lite </span>in the group. </p> </dd></dl> -<!--l. 1524--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is +<!--l. 1525--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to use either <span class="cmtt-10">xindy</span><a id="dx1-5112"></a> (<a @@ -2944,7 +2947,7 @@ this:  <br />  description={select group or class}  <br />} </div> -<!--l. 1536--><p class="nopar" > or </p><div class="alltt"> +<!--l. 1537--><p class="nopar" > or </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\newglossaryentry</span><span @@ -2988,7 +2991,7 @@ need to be careful about fragile commands in the <span class="cmtt-10">name </span>key if you don’t set the <span class="cmtt-10">sort</span> key. -<!--l. 1550--><p class="indent" > If you use <a +<!--l. 1551--><p class="indent" > If you use <a href="#option3">Option 3</a> and the <span class="cmtt-10">name </span>only contains a command or commands (such as <span @@ -3007,12 +3010,12 @@ example:  \newglossaryentry{P}{name={\P},sort={P},  <br />  description={paragraph symbol}} </div> -<!--l. 1557--><p class="nopar" > +<!--l. 1558--><p class="nopar" > </p> -<!--l. 1559--><p class="noindent" ><a +<!--l. 1560--><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. 1562--><p class="noindent" >The default glossary style uses the <span +<!--l. 1563--><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. @@ -3028,14 +3031,14 @@ class="cmtt-10">\glsnamefont</span>: <div class="verbatim" id="verbatim-71"> \renewcommand*{\glsnamefont}[1]{\textmd{#1}} </div> -<!--l. 1569--><p class="nopar" > Some classes and packages redefine the <span +<!--l. 1570--><p class="nopar" > Some classes and packages redefine the <span class="cmss-10">description</span><a id="dx1-6003"></a><a id="dx1-6004"></a> environment in such as way that’s incompatible with the <span class="cmss-10">glossaries </span>package. In which case you’ll need to select a different glossary style (see below). -</p><!--l. 1575--><p class="indent" > By default, a full stop is appended to the description (unless you use +</p><!--l. 1576--><p class="indent" > By default, a full stop is appended to the description (unless you use <span class="cmss-10">glossaries-extra</span><a id="dx1-6005"></a>). To prevent this from happening use the <span @@ -3049,7 +3052,7 @@ option: <div class="verbatim" id="verbatim-72"> \usepackage[nopostdot]{glossaries} </div> -<!--l. 1580--><p class="nopar" > or to add it with <span +<!--l. 1581--><p class="nopar" > or to add it with <span class="cmss-10">glossaries-extra</span>: @@ -3058,8 +3061,8 @@ class="cmss-10">glossaries-extra</span>: <div class="verbatim" id="verbatim-73"> \usepackage[postdot]{glossaries-extra} </div> -<!--l. 1584--><p class="nopar" > -</p><!--l. 1586--><p class="indent" > By default, a location list is displayed for each entry (unless you use +<!--l. 1585--><p class="nopar" > +</p><!--l. 1587--><p class="indent" > By default, a location list is displayed for each entry (unless you use <span class="cmtt-10">\printunsrtglossary </span>without <span class="cmtt-10">bib2gls</span><a @@ -3094,14 +3097,14 @@ option: <div class="verbatim" id="verbatim-74"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 1598--><p class="nopar" > or with <span +<!--l. 1599--><p class="nopar" > or with <span class="cmtt-10">bib2gls</span><a id="dx1-6011"></a> use <span class="cmtt-10">save-locations=false </span>in the optional argument of the appropriate <span class="cmtt-10">\GlsXtrLoadResources </span>(it’s possible to have some resource sets with locations and some without). -</p><!--l. 1604--><p class="indent" > Entries are grouped according to the first letter of each entry’s <span +</p><!--l. 1605--><p class="indent" > Entries are grouped according to the first letter of each entry’s <span class="cmtt-10">sort </span>key. By default a vertical gap is placed between letter groups. You can suppress this with the <span @@ -3114,14 +3117,14 @@ class="cmss-10">nogroupskip</span><a <div class="verbatim" id="verbatim-75"> \usepackage[nogroupskip]{glossaries} </div> -<!--l. 1610--><p class="nopar" > -</p><!--l. 1612--><p class="indent" > If the default style doesn’t suit your document, you can change the style +<!--l. 1611--><p class="nopar" > +</p><!--l. 1613--><p class="indent" > If the default style doesn’t suit your document, you can change the style using: -</p><!--l. 1615--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1616--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\setglossarystyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 1616--><p class="noindent" > +</p><!--l. 1617--><p class="noindent" > <a href="http://www.dickimaw-books.com/gallery/glossaries-styles/" >There are a number of predefined styles.</a> Glossaries can vary from a list of symbols with a terse description to a list of words or phrases with descriptions that span @@ -3134,7 +3137,7 @@ a style that suits your document. For example: <div class="verbatim" id="verbatim-76"> \setglossarystyle{index} </div> -<!--l. 1624--><p class="nopar" > You can also use the <span +<!--l. 1625--><p class="nopar" > You can also use the <span class="cmss-10">style</span><a id="dx1-6013"></a> package option for the preloaded styles. For example: @@ -3144,8 +3147,8 @@ class="cmss-10">style</span><a <div class="verbatim" id="verbatim-77"> \usepackage[style=index]{glossaries} </div> -<!--l. 1629--><p class="nopar" > -</p><!--l. 1631--><p class="indent" > Examples: +<!--l. 1630--><p class="nopar" > +</p><!--l. 1632--><p class="indent" > Examples: </p><ol class="enumerate1" > <li class="enumerate" id="x1-6015x1">You have entries where the name is a symbol and the description is a brief @@ -3161,7 +3164,7 @@ class="cmss-10">glossary-mcols</span><a  <br />\usepackage{glossary-mcols}  <br />\setglossarystyle{mcolindex} </div> - <!--l. 1640--><p class="nopar" > or + <!--l. 1641--><p class="nopar" > or @@ -3169,7 +3172,7 @@ class="cmss-10">glossary-mcols</span><a <div class="verbatim" id="verbatim-79"> \usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra} </div> - <!--l. 1644--><p class="nopar" > + <!--l. 1645--><p class="nopar" > </p></li> <li class="enumerate" id="x1-6018x2">You have entries where the name is a word or phrase and the description spans @@ -3181,7 +3184,7 @@ class="cmss-10">glossary-mcols</span><a \usepackage[nopostdot]{glossaries}  <br />\setglossarystyle{altlist} </div> - <!--l. 1652--><p class="nopar" > or + <!--l. 1653--><p class="nopar" > or @@ -3189,7 +3192,7 @@ class="cmss-10">glossary-mcols</span><a <div class="verbatim" id="verbatim-81"> \usepackage[stylemods,style=altlist]{glossaries-extra} </div> - <!--l. 1656--><p class="nopar" > + <!--l. 1657--><p class="nopar" > </p></li> <li class="enumerate" id="x1-6020x3">You have entries where the name is a single word, the description is @@ -3203,7 +3206,7 @@ class="cmss-10">glossary-mcols</span><a \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{long4col} </div> - <!--l. 1665--><p class="nopar" > or one of the “tree” styles: + <!--l. 1666--><p class="nopar" > or one of the “tree” styles: @@ -3212,8 +3215,8 @@ class="cmss-10">glossary-mcols</span><a \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{tree} </div> - <!--l. 1670--><p class="nopar" ></p></li></ol> -<!--l. 1673--><p class="indent" > If your glossary consists of a list of abbreviations and you also want to specify + <!--l. 1671--><p class="nopar" ></p></li></ol> +<!--l. 1674--><p class="indent" > If your glossary consists of a list of abbreviations and you also want to specify a description as well as the long form, then you need to use an abbreviation style that will suit the glossary style. For example, use the <span class="cmtt-10">long-short-desc </span>acronym @@ -3225,7 +3228,7 @@ style: <div class="verbatim" id="verbatim-84"> \setacronymstyle{long-short-desc} </div> -<!--l. 1679--><p class="nopar" > Define the acronyms with a description: +<!--l. 1680--><p class="nopar" > Define the acronyms with a description: @@ -3235,7 +3238,7 @@ style:  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{SVM}{support vector machine} </div> -<!--l. 1685--><p class="nopar" > Alternatively with <span +<!--l. 1686--><p class="nopar" > Alternatively with <span class="cmss-10">glossaries-extra</span><a id="dx1-6021"></a>: @@ -3248,8 +3251,8 @@ class="cmss-10">glossaries-extra</span><a  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{SVM}{support vector machine} </div> -<!--l. 1693--><p class="nopar" > -</p><!--l. 1695--><p class="indent" > Choose a glossary style that suits wide entry names. For example: +<!--l. 1694--><p class="nopar" > +</p><!--l. 1696--><p class="indent" > Choose a glossary style that suits wide entry names. For example: @@ -3257,13 +3260,13 @@ class="cmss-10">glossaries-extra</span><a <div class="verbatim" id="verbatim-87"> \setglossarystyle{altlist} </div> -<!--l. 1698--><p class="nopar" > -</p><!--l. 1700--><p class="noindent" > +<!--l. 1699--><p class="nopar" > +</p><!--l. 1701--><p class="noindent" > </p> -<!--l. 1700--><p class="noindent" ><a +<!--l. 1701--><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. 1703--><p class="noindent" >The <span +<!--l. 1704--><p class="noindent" >The <span class="cmss-10">glossaries</span><a id="dx1-7001"></a> package predefines a default <span class="cmtt-10">main </span>glossary. When you define an entry @@ -3275,7 +3278,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. 1710--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1711--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\newglossary[</span>⟨<span class="cmitt-10">glg</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -3287,7 +3290,7 @@ class="cmitt-10">glo</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">title</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 1711--><p class="noindent" > +</p><!--l. 1712--><p class="noindent" > The ⟨<span class="cmti-10">label</span>⟩ is a label that uniquely identifies this new glossary. As with other types of identifying labels, be careful not to use active characters in ⟨<span @@ -3315,14 +3318,14 @@ class="cmti-10">gls</span>⟩ and ⟨<span class="cmti-10">glo</span>⟩ arguments are ignored, in which case you may prefer to use the starred version where you don’t specify the extensions: -</p><!--l. 1725--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1726--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\newglossary*{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">title</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 1726--><p class="noindent" > -</p><!--l. 1728--><p class="indent" > In the case of Options <a +</p><!--l. 1727--><p class="noindent" > +</p><!--l. 1729--><p class="indent" > In the case of Options <a href="#option2">2</a> or <a href="#option3">3</a>, all glossary definitions must come before <span @@ -3332,7 +3335,7 @@ of <a href="#option4">Option 4</a>, all glossary definitions must come before any <span class="cmtt-10">\GlsXtrLoadResources</span> that requires them. -</p><!--l. 1733--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of +</p><!--l. 1734--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of abbreviations, the <span class="cmss-10">glossaries</span><a id="dx1-7005"></a> package provides the package option <span @@ -3348,7 +3351,7 @@ class="cmss-10">acronyms</span><a <div class="verbatim" id="verbatim-88"> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </div> -<!--l. 1739--><p class="nopar" > The option also changes the behaviour of <span +<!--l. 1740--><p class="nopar" > The option also changes the behaviour of <span class="cmtt-10">\newacronym </span>so that acronyms are automatically put in the list of acronyms instead of the main glossary. The <span @@ -3360,7 +3363,7 @@ class="cmss-10">abbreviations</span><a id="dx1-7009"></a> to create a list of abbreviations for <span class="cmtt-10">\newabbreviation</span>. -</p><!--l. 1747--><p class="indent" > There are some other package options for creating commonly used lists: <span +</p><!--l. 1748--><p class="indent" > There are some other package options for creating commonly used lists: <span class="cmss-10">symbols</span><a id="dx1-7010"></a> (lists of symbols), <span @@ -3374,7 +3377,7 @@ class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>). -</p><!--l. 1752--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and +</p><!--l. 1753--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and a list of notation: @@ -3384,7 +3387,7 @@ a list of notation:  \usepackage[acronyms]{glossaries}  <br /> \newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 1757--><p class="nopar" > After <span +<!--l. 1758--><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: @@ -3407,7 +3410,7 @@ the preamble. For example:  <br />   description={A set},  <br />   sort={S}} </div> -<!--l. 1776--><p class="nopar" > or if you don’t like using <span +<!--l. 1777--><p class="nopar" > or if you don’t like using <span class="cmtt-10">\ensuremath</span>: @@ -3422,34 +3425,34 @@ class="cmtt-10">\ensuremath</span>:  <br />   description={A set},  <br />   sort={S}} </div> -<!--l. 1786--><p class="nopar" > -</p><!--l. 1788--><p class="indent" > Each glossary is displayed using: -</p><!--l. 1790--><p class="indent" > <hr><div title="Definition"><span +<!--l. 1787--><p class="nopar" > +</p><!--l. 1789--><p class="indent" > Each glossary is displayed using: +</p><!--l. 1791--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossary[type=</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 1791--><p class="noindent" > +</p><!--l. 1792--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 1794--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1795--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printglossary[type=</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 1795--><p class="noindent" > +</p><!--l. 1796--><p class="noindent" > (Options <a href="#option2">2</a> and <a href="#option3">3</a>). Where ⟨<span class="cmti-10">type</span>⟩ is the glossary label. If the type is omitted the default <span class="cmtt-10">main </span>glossary is assumed. -</p><!--l. 1799--><p class="indent" > If you’re using <span +</p><!--l. 1800--><p class="indent" > If you’re using <span class="cmtt-10">bib2gls</span><a id="dx1-7013"></a> then each glossary is displayed using: -</p><!--l. 1802--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1803--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printunsrtglossary[type=</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 1803--><p class="noindent" > +</p><!--l. 1804--><p class="noindent" > With this method you don’t use <span class="cmtt-10">\makeglossaries </span>or <span class="cmtt-10">\makenoidxglossaries</span>. @@ -3473,7 +3476,7 @@ Instead you can assign the entry type with the resource command. For example:  <br />  type={symbols}% put in symbols glossary  <br /> ] </div> -<!--l. 1822--><p class="nopar" > Later in the document: +<!--l. 1823--><p class="nopar" > Later in the document: @@ -3483,26 +3486,26 @@ Instead you can assign the entry type with the resource command. For example:  <br /> \printunsrtglossary[type=abbreviations]  <br /> \printunsrtglossary[type=symbols] </div> -<!--l. 1828--><p class="nopar" > -</p><!--l. 1830--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries +<!--l. 1829--><p class="nopar" > +</p><!--l. 1831--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries depending on the indexing method: -</p><!--l. 1833--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1834--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossaries </span></div><hr> -</p><!--l. 1834--><p class="noindent" > +</p><!--l. 1835--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 1837--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1838--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> -</p><!--l. 1838--><p class="noindent" > +</p><!--l. 1839--><p class="noindent" > (Options <a href="#option2">2</a> and <a href="#option3">3</a>) or (<span class="cmss-10">glossaries-extra</span><a id="dx1-7014"></a> only) -</p><!--l. 1841--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1842--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printunsrtglossaries </span></div><hr> -</p><!--l. 1842--><p class="noindent" > -</p><!--l. 1844--><p class="indent" > If you use <a +</p><!--l. 1843--><p class="noindent" > +</p><!--l. 1845--><p class="indent" > If you use <a href="#option1">Option 1</a>, you don’t need to do anything else. If you use Options <a href="#option2">2</a> or <a @@ -3537,7 +3540,7 @@ class="cmtt-10">makeindex</span><a class="cmtt-10">xindy</span><a id="dx1-7021"></a> errors or warnings if things go wrong. -</p><!--l. 1858--><p class="indent" > For example, suppose you have three glossaries in your document (<span +</p><!--l. 1859--><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 @@ -3550,10 +3553,10 @@ class="cmtt-10">notation</span>), specified using: \usepackage[acronyms]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 1864--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 1865--><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> document is in a file called <span class="cmtt-10">myDoc.tex</span>): -</p><!--l. 1868--><p class="indent" > +</p><!--l. 1869--><p class="indent" > </p><dl class="description"><dt class="description"> </dt><dd class="description"><a @@ -3568,7 +3571,7 @@ class="cmtt-10">makeglossaries-lite</span><a <div class="verbatim" id="verbatim-95"> makeglossaries myDoc </div> - <!--l. 1874--><p class="nopar" > or + <!--l. 1875--><p class="nopar" > or @@ -3576,7 +3579,7 @@ class="cmtt-10">makeglossaries-lite</span><a <div class="verbatim" id="verbatim-96"> makeglossaries-lite myDoc </div> - <!--l. 1878--><p class="nopar" > Or you need to run <span + <!--l. 1879--><p class="nopar" > Or you need to run <span class="cmtt-10">makeindex</span><a id="dx1-7024"></a> three times: @@ -3588,7 +3591,7 @@ class="cmtt-10">makeindex</span><a  <br />makeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn  <br />makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn </div> - <!--l. 1884--><p class="nopar" > + <!--l. 1885--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a @@ -3601,7 +3604,7 @@ class="cmtt-10">makeglossaries</span><a <div class="verbatim" id="verbatim-98"> makeglossaries myDoc </div> - <!--l. 1890--><p class="nopar" > Or you need to run <span + <!--l. 1891--><p class="nopar" > Or you need to run <span class="cmtt-10">xindy</span><a id="dx1-7026"></a> three times (be careful not to insert line breaks where the line has wrapped.) @@ -3617,7 +3620,7 @@ class="cmtt-10">xindy</span><a  <br />xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg  <br />-o myDoc.not myDoc.ntn </div> - <!--l. 1900--><p class="nopar" > + <!--l. 1901--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a @@ -3632,16 +3635,16 @@ class="cmtt-10">bib2gls</span><a  <br />bib2gls --group myDoc  <br />pdflatex myDoc </div> - <!--l. 1908--><p class="nopar" > (Omit <span class="obeylines-h"><span class="verb"><span + <!--l. 1909--><p class="nopar" > (Omit <span class="obeylines-h"><span class="verb"><span class="cmtt-10">--group</span></span></span> if you don’t need letter groups.)</p></dd></dl> -<!--l. 1913--><p class="noindent" > +<!--l. 1914--><p class="noindent" > </p> -<!--l. 1913--><p class="noindent" ><a +<!--l. 1914--><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. 1916--><p class="noindent" >Take care if you use the <span +<!--l. 1917--><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 @@ -3665,7 +3668,7 @@ class="cmss-10">hyperref</span><a \usepackage[colorlinks]{hyperref}  <br />\usepackage{glossaries} </div> -<!--l. 1923--><p class="nopar" > If you use <span +<!--l. 1924--><p class="nopar" > If you use <span class="cmss-10">hyperref</span><a id="dx1-8007"></a> make sure you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> rather than the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -3674,16 +3677,16 @@ engine. The DVI format can’t break hyperlinks across a line so long (such as the full form of acronyms) won’t line wrap with the DVI engine. Also, hyperlinks in sub- or superscripts aren’t correctly sized with the DVI format. -</p><!--l. 1930--><p class="indent" > By default, if the <span +</p><!--l. 1931--><p class="indent" > By default, if the <span class="cmss-10">hyperref</span><a id="dx1-8008"></a> package has been loaded, commands like <span class="cmtt-10">\gls </span>will form a 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. 1935--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1936--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsdisablehyper </span></div><hr> -</p><!--l. 1936--><p class="noindent" > +</p><!--l. 1937--><p class="noindent" > If you want hyperlinks suppressed for entries in specific glossaries, then use the <span class="cmss-10">nohypertypes</span><a @@ -3702,8 +3705,8 @@ glossary, then do:  <br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 1946--><p class="nopar" > -</p><!--l. 1948--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you +<!--l. 1947--><p class="nopar" > +</p><!--l. 1949--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want hyperlinks for subsequence references then use the <span class="cmss-10">hyperfirst=false</span><a id="dx1-8010"></a> package @@ -3716,8 +3719,8 @@ option: \usepackage[colorlinks]{hyperref}  <br />\usepackage[hyperfirst=false]{glossaries} </div> -<!--l. 1954--><p class="nopar" > -</p><!--l. 1956--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn’t +<!--l. 1955--><p class="nopar" > +</p><!--l. 1957--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This isn’t specific to the <span class="cmss-10">glossaries</span><a id="dx1-8011"></a> package but is a limitation of PDF bookmarks. @@ -3738,15 +3741,15 @@ class="cmtt-10">\texorpdfstring</span>. For example: <div class="verbatim" id="verbatim-104"> \section{The \texorpdfstring{\gls{fishage}}{Fish Age}} </div> -<!--l. 1964--><p class="nopar" > However, it’s not a good idea to use commands like <span +<!--l. 1965--><p class="nopar" > However, it’s not a good idea to use commands like <span class="cmtt-10">\gls </span>in a section heading as you’ll end up with the table of contents in your location list. Instead you can use -</p><!--l. 1969--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1970--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsentrytext{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 1970--><p class="noindent" > +</p><!--l. 1971--><p class="noindent" > This is expandable provided that the <span class="cmtt-10">text </span>key doesn’t contain non-expandable code. For example, the following works: @@ -3757,8 +3760,8 @@ For example, the following works: <div class="verbatim" id="verbatim-105"> \section{The \glsentrytext{fishage}} </div> -<!--l. 1975--><p class="nopar" > and it doesn’t put the table of contents in the location list. -</p><!--l. 1978--><p class="indent" > If you use <span +<!--l. 1976--><p class="nopar" > and it doesn’t put the table of contents in the location list. +</p><!--l. 1979--><p class="indent" > If you use <span class="cmss-10">glossaries-extra</span><a id="dx1-8013"></a> then use the commands that are provided specifically for use in section headers. For example: @@ -3769,19 +3772,19 @@ use in section headers. For example: <div class="verbatim" id="verbatim-106"> \section{The \glsfmttext{fishage}} </div> -<!--l. 1982--><p class="nopar" > -</p><!--l. 1984--><p class="noindent" > +<!--l. 1983--><p class="nopar" > +</p><!--l. 1985--><p class="noindent" > </p> -<!--l. 1984--><p class="noindent" ><a +<!--l. 1985--><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. 1987--><p class="noindent" >You can add a reference to another entry in a location list using the <span +<!--l. 1988--><p class="noindent" >You can add a reference to another entry in a location list using the <span class="cmtt-10">see={</span>⟨<span class="cmti-10">label list</span>⟩<span class="cmtt-10">}</span> key when you define an entry. The referenced entry (or entries) must also be defined. -</p><!--l. 1991--><p class="indent" > For example: +</p><!--l. 1992--><p class="indent" > For example: @@ -3801,7 +3804,7 @@ defined.  <br />  see={devonian}  <br />} </div> -<!--l. 2008--><p class="nopar" > The cross-reference will appear as “<span +<!--l. 2009--><p class="nopar" > The cross-reference will appear as “<span class="cmti-10">see </span>Devonian”. You can change the “see” tag using the format <span class="cmtt-10">see=[</span>⟨<span @@ -3827,7 +3830,7 @@ class="cmti-10">label</span>⟩. For example:  <br />   other letters such as ligatures or diacritics.}  <br />} </div> -<!--l. 2026--><p class="nopar" > If you use the <span +<!--l. 2027--><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: @@ -3841,7 +3844,7 @@ enclose the value in braces. For example:  <br /> [see={[see also]{ksvm}}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 2035--><p class="nopar" > The <span +<!--l. 2036--><p class="nopar" > The <span class="cmss-10">glossaries-extra</span><a id="dx1-9001"></a> package provides a <span class="cmtt-10">seealso </span>key. This doesn’t allow a tag but @@ -3862,8 +3865,8 @@ class="cmsy-10">}</span>. For example:  <br /> [seealso={ksvm}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 2044--><p class="nopar" > -</p><!--l. 2046--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the +<!--l. 2045--><p class="nopar" > +</p><!--l. 2047--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location list using the <span class="cmss-10">nonumberlist</span><a id="dx1-9002"></a> package option, then the cross-reference @@ -3895,43 +3898,43 @@ example:  <br /> type={symbols}% put in symbols glossary  <br />] </div> -<!--l. 2068--><p class="nopar" > -</p><!--l. 2070--><p class="noindent" > +<!--l. 2069--><p class="nopar" > +</p><!--l. 2071--><p class="noindent" > </p> -<!--l. 2070--><p class="noindent" ><a +<!--l. 2071--><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. 2073--><p class="noindent" >Further information can be found in the main <span + <ul class="itemize1"> + <li class="itemize"><a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: an introductory guide</a>. + </li> + <li class="itemize">The main <span 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>. See also the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-10002"></a> package and the <span -class="cmtt-10">bib2gls</span><a - id="dx1-10003"></a> document, both -of which can be found on CTAN (<a -href="http://ctan.org/pkg/glossaries-extra" class="url" ><span -class="cmtt-10">http://ctan.org/pkg/glossaries-extra</span></a> and -<a -href="http://ctan.org/pkg/bib2gls" class="url" ><span -class="cmtt-10">http://ctan.org/pkg/bib2gls</span></a>). There is also an <a -href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries and -glossaries-extra packages</a> on the <a -href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> Community’s</a> Know How section and -a chapter on the <span -class="cmss-10">glossaries</span><a - id="dx1-10004"></a> package in <a -href="http://www.dickimaw-books.com/latex/thesis/" >Using <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> to Write a PhD Thesis</a>. -</p><div class="footnotes"><!--l. 1031--><p class="noindent" ><span class="footnote-mark"><a +href="glossaries-user.html" >user manual</a>. + </li> + <li class="itemize">The <a +href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries FAQ</a>. + </li> + <li class="itemize"><a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the + document build</a>. + </li> + <li class="itemize">The <a +href="https://ctan.org/pkg/glossaries-extra" ><span +class="cmss-10">glossaries-extra</span></a> package. + </li> + <li class="itemize">The <a +href="https://ctan.org/pkg/bib2gls" ><span +class="cmtt-10">bib2gls</span></a> application.</li></ul> + <div class="footnotes"><!--l. 1032--><p class="noindent" ><span class="footnote-mark"><a href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span class="cmr-8">deprecated, use </span><span class="cmss-8">babel</span><a id="dx1-5021"></a> <span -class="cmr-8">instead</span></p> </div> +class="cmr-8">instead</span></p> </div> </body></html> |