diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | 507 |
1 files changed, 260 insertions, 247 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index f870f7c0bc6..0329a70d59d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -4,13 +4,13 @@ <!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> <html xmlns="http://www.w3.org/1999/xhtml" > -<head><title>The glossaries package v4.15: a guide for beginners</title> +<head><title>The glossaries package v4.16: a guide for beginners</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)" /> <meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" /> <!-- xhtml,fn-in,css-in,uni-html4,utf8 --> <meta name="src" content="glossariesbegin.tex" /> -<meta name="date" content="2015-03-16 18:44:00" /> +<meta name="date" content="2015-07-08 13:23:00" /> <style type="text/css"> <!-- @@ -197,11 +197,11 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle -<h2 class="titleHead">The glossaries package v4.15: a guide for beginners</h2> +<h2 class="titleHead">The glossaries package v4.16: a guide for beginners</h2> <div class="author" ><span class="cmr-12">Nicola L.C. Talbot</span></div><br /> <div class="date" ><span -class="cmr-12">2015-03-16</span></div> +class="cmr-12">2015-07-08</span></div> </div> <div class="abstract" @@ -214,7 +214,8 @@ class="cmbx-9">Abstract</span></p></div> <!--l. 47--><p class="indent" > <span class="cmr-9">The </span><span class="cmss-9">glossaries </span><span -class="cmr-9">package is very flexible, but this means that it has a lot</span> +class="cmr-9">package is very flexible, but this means that it has a</span><span +class="cmr-9"> lot</span> <span class="cmr-9">options, and since a user guide is supposed to provide a complete list of all</span> <span @@ -276,7 +277,8 @@ href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span cla class="cmss-10">glossaries </span>with <span class="cmtt-10">\usepackage</span>, but there are certain packages that must be loaded before <span -class="cmss-10">glossaries</span>, if they are required: <span +class="cmss-10">glossaries</span>, <span +class="cmti-10">if </span>they are required: <span class="cmss-10">hyperref</span><a id="dx1-2001"></a>, <span @@ -425,12 +427,12 @@ class="E">E</span>X</span> to perform the sorting; use class="cmtt-10">makeindex </span>to perform the sorting; use <span class="cmtt-10">xindy </span>to perform the sorting. </p><!--l. 187--><p class="indent" > The first option (using <span class="TEX">T<span -class="E">E</span>X</span>) is the simplest and easiest method, but it’s -inefficient. To use this method, add <span -class="cmtt-10">\makenoidxglossaries </span>to the preamble and -put <span -class="cmtt-10">\printnoidxglossaries </span>at the place where you want your glossary. For -example: +class="E">E</span>X</span>) is the simplest and easiest method, but it’s inefficient +and the sorting is done according to the English alphabet. To use this method, add +<span +class="cmtt-10">\makenoidxglossaries </span>to the preamble and put <span +class="cmtt-10">\printnoidxglossaries </span>at the place +where you want your glossary. For example: @@ -450,7 +452,7 @@ example:  <br />\printnoidxglossaries  <br />\end{document} </div> -<!--l. 212--><p class="nopar" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 213--><p class="nopar" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> (or pdf<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>) <span class="cmti-10">twice</span>. The first run won’t show the @@ -466,7 +468,7 @@ class="cmtt-10">nogroupskip </span>to the package options: <div class="verbatim" id="verbatim-6"> \usepackage[nogroupskip]{glossaries} </div> -<!--l. 221--><p class="nopar" > If you try out this example you may also notice that the description is followed by a +<!--l. 222--><p class="nopar" > If you try out this example you may also notice that the description is followed by a full stop (period) and a number. The number is the location in the document where the entry was used, so you can lookup the term in the glossary and be directed to the relevant pages. It may be that you don’t want this back-reference, in which case you can @@ -479,7 +481,7 @@ class="cmtt-10">nonumberlist </span>package option: <div class="verbatim" id="verbatim-7"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 230--><p class="nopar" > If you don’t like the terminating full stop, you can suppress that with the <span +<!--l. 231--><p class="nopar" > If you don’t like the terminating full stop, you can suppress that with the <span class="cmtt-10">nopostdot</span> package option: @@ -489,42 +491,42 @@ package option: <div class="verbatim" id="verbatim-8"> \usepackage[nopostdot]{glossaries} </div> -<!--l. 235--><p class="nopar" > -</p><!--l. 237--><p class="indent" > You may have noticed that I’ve used another command in the above example: +<!--l. 236--><p class="nopar" > +</p><!--l. 238--><p class="indent" > You may have noticed that I’ve used another command in the above example: <span class="cmtt-10">\glspl</span>. This displays the plural form. By default, this is just the singular form with the letter “s” appended, but in the case of “potato” I had to specify the correct plural using the <span class="cmtt-10">plural </span>key. -</p><!--l. 243--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span +</p><!--l. 244--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span class="E">E</span>X</span> to sort the entries is the simplest but least -efficient method. If you have a large glossary or if your terms contain non-Latin -characters, then you will have a much faster build time if you use <span +efficient method. If you have a large glossary or if your terms contain non-Latin or +extended Latin characters, then you will have a much faster build time if you use +<span class="cmtt-10">makeindex </span>or <span -class="cmtt-10">xindy</span>. -If you are using extended Latin or non-Latin characters, then <span -class="cmtt-10">xindy </span>is the -recommended method. These two methods are described in more detail in <a +class="cmtt-10">xindy</span>. If you are using extended Latin or non-Latin characters, then +<span +class="cmtt-10">xindy </span>is the recommended method. These two methods are described in more detail in +<a href="#sec:printglossaries"><span class="cmsy-10">§</span>4 </a><a -href="#sec:printglossaries">Displaying -a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>. -</p><!--l. 251--><p class="indent" > The rest of this document briefly describes the main commands provided by the +href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>. +</p><!--l. 253--><p class="indent" > The rest of this document briefly describes the main commands provided by the <span class="cmss-10">glossaries </span>package. -</p><!--l. 254--><p class="noindent" > +</p><!--l. 256--><p class="noindent" > </p> -<!--l. 254--><p class="noindent" ><a +<!--l. 256--><p class="noindent" ><a href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a id="sec:defterm"></a>Defining Terms</h3> -<!--l. 257--><p class="noindent" >When you use the <span +<!--l. 259--><p class="noindent" >When you use the <span class="cmss-10">glossaries</span><a id="dx1-3001"></a> package, you need to define glossary entries in the document preamble. These entries could be a word, phrase, acronym or symbol. They’re usually accompanied by a description, which could be a short sentence or an in-depth explanation that spans multiple paragraphs. The simplest method of defining an entry is to use: -</p><!--l. 264--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> +</p><!--l. 266--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\newglossaryentry{</span>⟨<span @@ -551,7 +553,7 @@ class="cmitt-10"> options</span>⟩ class="cmtt-10">}</span></span> </div> </div> </div><hr> -<!--l. 272--><p class="noindent" > +<!--l. 274--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is a unique label that identifies this entry. (Don’t include the angle brackets ⟨ ⟩. They just indicate the parts of the code you need to change when you use @@ -563,11 +565,11 @@ class="cmti-10">name</span>⟩ is the word, phrase or symbol you are defining, and ⟨<span class="cmti-10">description</span>⟩ is the description to be displayed in the glossary. -</p><!--l. 280--><p class="indent" > This command is a “short” command, which means that ⟨<span +</p><!--l. 282--><p class="indent" > This command is a “short” command, which means that ⟨<span class="cmti-10">description</span>⟩ can’t contain a paragraph break. If you have a long description, you can instead use: -</p><!--l. 284--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> +</p><!--l. 286--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\longnewglossaryentry{</span>⟨<span @@ -593,8 +595,8 @@ class="cmitt-10">description</span>⟩<span class="cmtt-10">}</span> </div> </div> </div><hr> -<!--l. 292--><p class="noindent" > -</p><!--l. 294--><p class="indent" > Examples: +<!--l. 294--><p class="noindent" > +</p><!--l. 296--><p class="indent" > Examples: </p><ol class="enumerate1" > <li class="enumerate" id="x1-3003x1">Define the term “set” with the label <span @@ -609,7 +611,7 @@ class="cmtt-10">set</span>:  <br />  description={a collection of objects}  <br />} </div> - <!--l. 303--><p class="nopar" > + <!--l. 305--><p class="nopar" > </p></li> <li class="enumerate" id="x1-3005x2">Define the symbol <span @@ -625,7 +627,7 @@ class="cmtt-10">emptyset</span>:  <br />  description={the empty set}  <br />} </div> - <!--l. 313--><p class="nopar" > + <!--l. 315--><p class="nopar" > </p></li> <li class="enumerate" id="x1-3007x3">Define the phrase “Fish Age” with the label <span @@ -644,7 +646,7 @@ class="cmtt-10">fishage</span>:  <br />  fish species.  <br />} </div> - <!--l. 328--><p class="nopar" > (The percent character discards the end of line character that would otherwise + <!--l. 330--><p class="nopar" > (The percent character discards the end of line character that would otherwise cause an unwanted space to appear at the start of the description.) </p></li> <li @@ -665,7 +667,7 @@ class="cmtt-10">é</span>). This first letter must be placed in a g  <br />  description={select group or class}  <br />} </div> - <!--l. 344--><p class="nopar" > or </p><div class="alltt"> + <!--l. 346--><p class="nopar" > or </p><div class="alltt"> <div class="obeylines-v"> <span class="verb"><span class="cmtt-10">\newglossaryentry{elite}</span></span> @@ -689,12 +691,12 @@ class="cmtt-10"> class}</span></span> class="cmtt-10">}</span></span> </div> </div></li></ol> -<!--l. 354--><p class="noindent" >(For further details, see the section <a +<!--l. 356--><p class="noindent" >(For further details, see the section <a href="mfirstuc-manual.html" >“UTF-8”</a> in the <span class="cmss-10">mfirstuc</span><a id="dx1-3011"></a> user manual.) -</p><!--l. 358--><p class="indent" > Acronyms or abbreviations can be defined using -</p><!--l. 360--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 360--><p class="indent" > Acronyms (or other abbreviations) can be defined using +</p><!--l. 362--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\newacronym{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -702,15 +704,15 @@ class="cmitt-10">short</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 361--><p class="noindent" > +</p><!--l. 363--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the label (as with the <span class="cmtt-10">\newglossaryentry </span>and the <span class="cmtt-10">\longnewglossaryentry</span> commands), ⟨<span -class="cmti-10">short</span>⟩ is the abbreviation or acronym and ⟨<span -class="cmti-10">long</span>⟩ is the long form. For -example: +class="cmti-10">short</span>⟩ is the short form and ⟨<span +class="cmti-10">long</span>⟩ is the long form. For example, the +following defines an abbreviation: @@ -718,7 +720,7 @@ example: <div class="verbatim" id="verbatim-13"> \newacronym{svm}{svm}{support vector machine} </div> -<!--l. 367--><p class="nopar" > This defines a glossary entry with the label <span +<!--l. 370--><p class="nopar" > This defines a glossary entry with the label <span class="cmtt-10">svm</span>. By default, the ⟨<span class="cmti-10">name</span>⟩ is set to ⟨<span @@ -737,14 +739,14 @@ argument:  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 378--><p class="nopar" > -</p><!--l. 380--><p class="indent" > Before you define your acronyms, you need to specify which acronym style to use -with -</p><!--l. 383--><p class="indent" > <hr><div title="Definition"><span +<!--l. 381--><p class="nopar" > +</p><!--l. 383--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to +specify which style to use with +</p><!--l. 386--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\setacronymstyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 384--><p class="noindent" > +</p><!--l. 387--><p class="noindent" > where ⟨<span class="cmti-10">style name</span>⟩ is the name of the style. There are a number of predefined styles, such as: <span @@ -761,13 +763,13 @@ description). There are some other styles as well that use <span class="cmtt-10">\textsc </span>to typeset the acronym or that use a footnote on first use. See the main user guide for further details. -</p><!--l. 396--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span +</p><!--l. 399--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span class="cmtt-10">name</span> key used above indicates how the term should appear in the list of entries (glossary). If the term should appear differently when you reference it in the document, you need to use the <span class="cmtt-10">text </span>key as well. -</p><!--l. 402--><p class="indent" > For example: +</p><!--l. 405--><p class="indent" > For example: @@ -781,9 +783,9 @@ class="cmtt-10">text </span>key as well.  <br />  a, \ldots, z, A, \ldots, Z}  <br />} </div> -<!--l. 411--><p class="nopar" > This will appear in the text as “Latin alphabet” but will be listed in the glossary as +<!--l. 414--><p class="nopar" > This will appear in the text as “Latin alphabet” but will be listed in the glossary as “Latin Alphabet”. -</p><!--l. 415--><p class="indent" > Another commonly used key is <span +</p><!--l. 418--><p class="indent" > Another commonly used key is <span class="cmtt-10">plural </span>for specifying the plural of the term. This defaults to the value of the <span class="cmtt-10">text </span>key with an “s” appended, but if this is incorrect, just @@ -801,9 +803,9 @@ class="cmtt-10">plural </span>key to override it:  <br />  description={canal from mouth to stomach}  <br />} </div> -<!--l. 426--><p class="nopar" > (Remember from earlier that the initial ligature <span +<!--l. 429--><p class="nopar" > (Remember from earlier that the initial ligature <span class="cmtt-10">\oe </span>needs to be grouped.) -</p><!--l. 430--><p class="indent" > The plural forms for acronyms can be specified using the <span +</p><!--l. 433--><p class="indent" > The plural forms for acronyms can be specified using the <span class="cmtt-10">longplural </span>and <span class="cmtt-10">shortplural </span>keys. For example: @@ -816,9 +818,9 @@ class="cmtt-10">shortplural </span>keys. For example:  <br /> [longplural={diagonal matrices}]  <br /> {dm}{DM}{diagonal matrix} </div> -<!--l. 436--><p class="nopar" > If omitted, the defaults are again obtained by appending an “s” to the singular +<!--l. 439--><p class="nopar" > If omitted, the defaults are again obtained by appending an “s” to the singular versions. -</p><!--l. 440--><p class="indent" > It’s also possible to have both a name and a corresponding symbol. Just use the +</p><!--l. 443--><p class="indent" > It’s also possible to have both a name and a corresponding symbol. Just use the <span class="cmtt-10">name </span>key for the name and the <span class="cmtt-10">symbol </span>key for the symbol. For example: @@ -834,26 +836,26 @@ class="cmtt-10">symbol </span>key for the symbol. For example:  <br />  description={the set containing no elements}  <br />} </div> -<!--l. 450--><p class="nopar" > -</p><!--l. 452--><p class="noindent" > +<!--l. 453--><p class="nopar" > +</p><!--l. 455--><p class="noindent" > </p> -<!--l. 452--><p class="noindent" ><a +<!--l. 455--><p class="noindent" ><a href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a id="sec:useterm"></a>Using Entries</h3> -<!--l. 455--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in your +<!--l. 458--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in your document. There are a number of commands to do this, but the most common one is: -</p><!--l. 459--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 462--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\gls{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 460--><p class="noindent" > +</p><!--l. 463--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the label you assigned to the entry when you defined it. For example, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{fishage}</span></span></span> will display “Fish Age” in the text (given the definition from the previous section). -</p><!--l. 465--><p class="indent" > If you are using the <span +</p><!--l. 468--><p class="indent" > If you are using the <span class="cmss-10">hyperref</span><a id="dx1-4001"></a> package (remember to load it before <span class="cmss-10">glossaries</span>) <span @@ -864,7 +866,7 @@ class="cmtt-10">\gls* </span>for example, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls*{fishage}</span></span></span>. The other commands described in this section all have a similar starred form. -</p><!--l. 472--><p class="indent" > If the entry was defined as an acronym (using <span +</p><!--l. 475--><p class="indent" > If the entry was defined as an acronym (using <span class="cmtt-10">\newacronym </span>described above), then <span class="cmtt-10">\gls </span>will display the full form the first time it’s used and just the short form on @@ -874,33 +876,33 @@ class="cmtt-10">long-short</span>, then class="cmtt-10">\gls{svm}</span></span></span> will display “support vector machine (svm)” the first time it’s used, but the next occurrence of <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{svm}</span></span></span> will just display “svm”. -</p><!--l. 480--><p class="indent" > If you want the plural form, you can use: -</p><!--l. 482--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 483--><p class="indent" > If you want the plural form, you can use: +</p><!--l. 485--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glspl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 483--><p class="noindent" > +</p><!--l. 486--><p class="noindent" > instead of <span class="cmtt-10">\gls{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>. For example, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspl{set}</span></span></span> displays “sets”. -</p><!--l. 487--><p class="indent" > If the term appears at the start of a sentence, you can convert the first letter to +</p><!--l. 490--><p class="indent" > If the term appears at the start of a sentence, you can convert the first letter to upper case using: -</p><!--l. 490--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 493--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\Gls{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 491--><p class="noindent" > +</p><!--l. 494--><p class="noindent" > for the singular form or -</p><!--l. 494--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 497--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\Glspl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 495--><p class="noindent" > +</p><!--l. 498--><p class="noindent" > for the plural form. For example: @@ -909,34 +911,34 @@ for the plural form. For example: <div class="verbatim" id="verbatim-19"> \Glspl{set} are collections. </div> -<!--l. 499--><p class="nopar" > produces “Sets are collections”. -</p><!--l. 502--><p class="indent" > If you’ve specified a symbol using the <span +<!--l. 502--><p class="nopar" > produces “Sets are collections”. +</p><!--l. 505--><p class="indent" > If you’ve specified a symbol using the <span class="cmtt-10">symbol </span>key, you can display it using: -</p><!--l. 505--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 508--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glssymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 506--><p class="noindent" > -</p><!--l. 508--><p class="noindent" > +</p><!--l. 509--><p class="noindent" > +</p><!--l. 511--><p class="noindent" > </p> -<!--l. 508--><p class="noindent" ><a +<!--l. 511--><p class="noindent" ><a href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="sec:printglossaries"></a>Displaying a List of Entries</h3> -<!--l. 511--><p class="noindent" >In <a +<!--l. 514--><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 your glossary. Here they are again in a little more detail: -</p><!--l. 515--><p class="indent" > +</p><!--l. 518--><p class="indent" > </p><dl class="description"><dt class="description"> </dt><dd class="description"><a id="option1"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 1</span>: - <!--l. 518--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted list, it + <!--l. 521--><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. - </p><!--l. 521--><p class="noindent" > + </p><!--l. 524--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5002x1">Add <span @@ -948,13 +950,13 @@ href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>). </li> <li class="enumerate" id="x1-5004x2">Put - <!--l. 528--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 531--><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. 529--><p class="noindent" > + </p><!--l. 532--><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 @@ -965,9 +967,9 @@ class="cmtt-10">case </span>(case-sensitive letter class="cmtt-10">def </span>(in order of definition) or <span class="cmtt-10">use </span>(in order of use). Alternatively, use - </p><!--l. 536--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 539--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printnoidxglossaries </span></div><hr> - </p><!--l. 537--><p class="noindent" > + </p><!--l. 540--><p class="noindent" > to display all your glossaries (if you have more than one). This command doesn’t have any arguments. </p></li> @@ -986,7 +988,7 @@ class="description"><a id="option2"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 2</span>: - <!--l. 548--><p class="noindent" >This option uses an application called <span + <!--l. 551--><p class="noindent" >This option uses an application called <span class="cmtt-10">makeindex </span>to sort the entries. This application comes with all modern <span class="TEX">T<span class="E">E</span>X</span> distributions, but it’s hard-coded for the @@ -998,7 +1000,7 @@ class="cmtt-10">makeindex</span> writes a 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> then reads this file on the next run. - </p><!--l. 556--><p class="noindent" > + </p><!--l. 559--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5008x1">Add <span @@ -1007,18 +1009,18 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5010x2">Put - <!--l. 562--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 565--><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. 563--><p class="noindent" > + </p><!--l. 566--><p class="noindent" > where you want your list of entries (glossary) to appear. (The <span class="cmtt-10">sort </span>key isn’t available in ⟨<span class="cmti-10">options</span>⟩.) Alternatively, use - </p><!--l. 568--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 571--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> - </p><!--l. 569--><p class="noindent" > + </p><!--l. 572--><p class="noindent" > which will display all glossaries (if you have more than one). This command doesn’t have any arguments. </p></li> @@ -1052,7 +1054,7 @@ class="cmtt-10">.gls</span>. If you have <div class="verbatim" id="verbatim-20"> makeindex -s myDoc.ist -o myDoc.gls myDoc.glo </div> - <!--l. 588--><p class="nopar" > (Replace <span + <!--l. 591--><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. Avoid spaces in the file name.) If you don’t know how to use the command @@ -1061,7 +1063,7 @@ class="cmtt-10">makeindex </span>via your text editor, but each editor has a different method of doing this, so I can’t give a general description. You will have to check your editor’s manual. - </p><!--l. 596--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want + </p><!--l. 599--><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">-l </span>switch: @@ -1071,7 +1073,7 @@ class="cmtt-10">-l </span>switch: <div class="verbatim" id="verbatim-21"> makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo </div> - <!--l. 602--><p class="nopar" > + <!--l. 605--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5016x5">Once you have successfully completed the previous step, you can now run @@ -1083,7 +1085,7 @@ class="description"><a id="option3"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 3</span>: - <!--l. 610--><p class="noindent" >This option uses an application called <span + <!--l. 613--><p class="noindent" >This option uses an application called <span class="cmtt-10">xindy </span>to sort the entries. This application is more flexible than <span class="cmtt-10">makeindex </span>and is able to sort extended Latin or non-Latin @@ -1104,7 +1106,7 @@ class="cmtt-10">xindy </span>writes a 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> then reads this file on the next run. - </p><!--l. 622--><p class="noindent" > + </p><!--l. 625--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5018x1">Add the <span @@ -1117,7 +1119,7 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-22"> \usepackage[xindy]{glossaries} </div> - <!--l. 627--><p class="nopar" > + <!--l. 630--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5021x2">Add <span @@ -1126,18 +1128,18 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5023x3">Put - <!--l. 634--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 637--><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. 635--><p class="noindent" > + </p><!--l. 638--><p class="noindent" > where you want your list of entries (glossary) to appear. (The <span class="cmtt-10">sort </span>key isn’t available in ⟨<span class="cmti-10">options</span>⟩.) Alternatively, use - </p><!--l. 640--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 643--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> - </p><!--l. 641--><p class="noindent" > + </p><!--l. 644--><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 @@ -1172,7 +1174,7 @@ class="cmtt-10">.gls</span>. xindy  -L english -C utf8 -I xindy -M myDoc  <br />-t myDoc.glg -o myDoc.gls myDoc.glo </div> - <!--l. 661--><p class="nopar" > (Replace <span + <!--l. 664--><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. Avoid spaces in the file name. If necessary, also replace <span @@ -1184,7 +1186,7 @@ class="cmtt-10">xindy </span>via your text editor, but each editor has a different method of doing this, so I can’t give a general description. You will have to check your editor’s manual. - </p><!--l. 671--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you + </p><!--l. 674--><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: @@ -1195,7 +1197,7 @@ class="cmtt-10">order=letter </span>package <div class="verbatim" id="verbatim-24"> \usepackage[xindy,order=letter]{glossaries} </div> - <!--l. 677--><p class="nopar" > + <!--l. 680--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5029x6">Once you have successfully completed the previous step, you can now run @@ -1203,7 +1205,7 @@ class="cmtt-10">order=letter </span>package class="E">E</span>X</span></span> on your document again. </li></ol> </dd></dl> -<!--l. 686--><p class="indent" > For Options <a +<!--l. 689--><p class="indent" > For Options <a href="#option2">2</a> and <a href="#option3">3</a>, it can be difficult to remember all the parameters required for <span @@ -1228,7 +1230,7 @@ class="cmtt-10">myDoc.tex</span>, then run: <div class="verbatim" id="verbatim-25"> makeglossaries myDoc </div> -<!--l. 697--><p class="nopar" > (Replace <span +<!--l. 700--><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. Avoid spaces in the file name.) If you don’t know how to use the command prompt, @@ -1246,8 +1248,8 @@ directives:  <br /> arara: makeglossaries  <br /> arara: pdflatex </div> -<!--l. 707--><p class="nopar" > -</p><!--l. 709--><p class="indent" > The <span +<!--l. 710--><p class="nopar" > +</p><!--l. 712--><p class="indent" > The <span class="cmtt-10">makeglossaries </span>script is written in Perl, so you need a Perl interpreter installed. If you are using a Unix-like operating system then you most likely have one installed. If you are using Windows with the <span class="TEX">T<span @@ -1255,25 +1257,36 @@ class="E">E</span>X</span> Live distribution, then you can use the Perl interpreter that comes with <span class="TEX">T<span class="E">E</span>X</span> Live. If you are using Windows and MiK<span class="TEX">T<span -class="E">E</span>X</span> then you need to install a Perl distribution for Windows. If you are using -<a +class="E">E</span>X</span> then you need to install a Perl distribution for Windows. If you are +using <a href="#option3">Option 3</a>, then you need to do this anyway as <span -class="cmtt-10">xindy </span>is also written in Perl. If -you are using <a -href="#option2">Option 2</a> and can’t work out how to install Perl (or for some -reason don’t want to install it) then just use <span -class="cmtt-10">makeindex </span>directly, as described -above. -</p><!--l. 721--><p class="indent" > As a last resort you can try the package option <span -class="cmtt-10">automake</span>: +class="cmtt-10">xindy </span>is also written in +Perl. If you are using <a +href="#option2">Option 2</a> and can’t work out how to install Perl (or +for some reason don’t want to install it) then just use <span +class="cmtt-10">makeindex </span>directly, as +described above, or you can use a Lua alternative to <span +class="cmtt-10">makeglossaries </span>called +<span +class="cmtt-10">makeglossaries-lite.lua</span>: </p> <div class="verbatim" id="verbatim-27"> +makeglossaries-lite.lua myDoc +</div> +<!--l. 726--><p class="nopar" > +</p><!--l. 728--><p class="indent" > As a last resort you can try the package option <span +class="cmtt-10">automake</span>: + + + +</p> + <div class="verbatim" id="verbatim-28"> \usepackage[automake]{glossaries} </div> -<!--l. 724--><p class="nopar" > This will attempt to use <span class="TEX">T<span +<!--l. 731--><p class="nopar" > This will attempt to use <span class="TEX">T<span class="E">E</span>X</span>’s <span class="cmtt-10">\write18 </span>mechanism to run <span class="cmtt-10">makeindex </span>or <span @@ -1288,7 +1301,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> twice for the glossaries to be displayed. -</p><!--l. 734--><p class="indent" > When sorting the entries, the string comparisons are made according to each entry’s +</p><!--l. 741--><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 earlier @@ -1297,14 +1310,14 @@ definition: </p> - <div class="verbatim" id="verbatim-28"> + <div class="verbatim" id="verbatim-29"> \newglossaryentry{elite}  <br />{  <br />  name={{\’e}lite},  <br />  description={select group or class}  <br />} </div> -<!--l. 744--><p class="nopar" > No <span +<!--l. 751--><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 is @@ -1355,7 +1368,7 @@ class="cmtt-10">xindy </span>disregards <span class="LATEX">L<span class="A">A</ class="E">E</span>X</span></span> commands so it sorts on <span class="cmtt-10">elite</span>, which puts this entry in the “E” group.</dd></dl> -<!--l. 769--><p class="indent" > If the <span +<!--l. 776--><p class="indent" > If the <span class="cmss-10">inputenc</span><a id="dx1-5032"></a> package is used and the entry is defined as: </p><div class="alltt"> <div class="obeylines-v"> @@ -1421,7 +1434,7 @@ class="cmtt-10">é</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 “E” letter group.)</dd></dl> -<!--l. 795--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to +<!--l. 802--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to use <span class="cmtt-10">xindy </span>(<a href="#option3">Option 3</a>) with the <span @@ -1435,7 +1448,7 @@ class="cmtt-10">sort </span>key like this: </p> - <div class="verbatim" id="verbatim-29"> + <div class="verbatim" id="verbatim-30"> \newglossaryentry{elite}  <br />{  <br />  name={{\’e}lite}, @@ -1443,14 +1456,14 @@ class="cmtt-10">sort </span>key like this:  <br />  description={select group or class}  <br />} </div> -<!--l. 806--><p class="nopar" > If you use <a +<!--l. 813--><p class="nopar" > If you use <a href="#option1">Option 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’t set the <span class="cmtt-10">sort</span> key. -</p><!--l. 811--><p class="indent" > <a +</p><!--l. 818--><p class="indent" > <a href="#x1-50351">Table 1</a> summarises the main pros and cons of three options described above. </p> @@ -1458,7 +1471,7 @@ above. -<!--l. 814--><p class="indent" > <a +<!--l. 821--><p class="indent" > <a id="x1-50351"></a></p><hr class="float" /><div class="float" > @@ -1475,7 +1488,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. 820--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" +class="td11"> <!--l. 827--><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 @@ -1490,7 +1503,7 @@ class="cmbx-10">Option</span><span class="cmbx-10"> 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. 821--><p class="noindent" >Requires +class="td11"> <!--l. 828--><p class="noindent" >Requires an external application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" @@ -1502,7 +1515,7 @@ class="td11"> <span class="pzdr-">✔ </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. 823--><p class="noindent" >Requires +class="td11"> <!--l. 830--><p class="noindent" >Requires Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2" class="td11"> <span class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3" @@ -1512,7 +1525,7 @@ class="td11"> <span class="pzdr-">✔ </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. 825--><p class="noindent" >Can +class="td11"> <!--l. 832--><p class="noindent" >Can sort extended Latin @@ -1528,7 +1541,7 @@ class="td11"> <span class="pzdr-">✔ </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. 828--><p class="noindent" >Efficient +class="td11"> <!--l. 835--><p class="noindent" >Efficient sort algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" class="td11"> <span @@ -1539,7 +1552,7 @@ class="td11"> <span class="pzdr-">✔ </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. 830--><p class="noindent" >Can +class="td11"> <!--l. 837--><p class="noindent" >Can form ranges in @@ -1554,7 +1567,7 @@ class="td11"> <span class="pzdr-">✔ </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. 832--><p class="noindent" >Can +class="td11"> <!--l. 839--><p class="noindent" >Can have non-standard locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" @@ -1565,7 +1578,7 @@ class="pzdr-">✘ </span></td><td style="white-space:nowrap; text- class="td11"> <span class="pzdr-">✔ </span></td> </tr></table></div> -<!--l. 836--><p class="noindent" ><sup class="textsuperscript"><span +<!--l. 843--><p class="noindent" ><sup class="textsuperscript"><span class="cmsy-9">†</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> accents so, for example, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\AA</span></span></span> is treated the same as @@ -1576,10 +1589,10 @@ A. </p> </div><hr class="endfloat" /> </div> -<!--l. 840--><p class="noindent" ><a +<!--l. 847--><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. 843--><p class="noindent" >The default glossary style uses the <span +<!--l. 850--><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. @@ -1592,22 +1605,22 @@ class="cmtt-10">\glsnamefont</span>: </p> - <div class="verbatim" id="verbatim-30"> + <div class="verbatim" id="verbatim-31"> \renewcommand*{\glsnamefont}[1]{\textmd{#1}} </div> -<!--l. 850--><p class="nopar" > -</p><!--l. 852--><p class="indent" > By default, a full stop is appended to the description. To prevent this from +<!--l. 857--><p class="nopar" > +</p><!--l. 859--><p class="indent" > By default, a 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-31"> + <div class="verbatim" id="verbatim-32"> \usepackage[nopostdot]{glossaries} </div> -<!--l. 856--><p class="nopar" > -</p><!--l. 858--><p class="indent" > By default, a location list is displayed for each entry. This refers to the document +<!--l. 863--><p class="nopar" > +</p><!--l. 865--><p class="indent" > By default, a 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 <a href="#option2">2</a> or <a @@ -1627,11 +1640,11 @@ package option: </p> - <div class="verbatim" id="verbatim-32"> + <div class="verbatim" id="verbatim-33"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 868--><p class="nopar" > -</p><!--l. 870--><p class="indent" > Entries are grouped according to the first letter of each entry’s <span +<!--l. 875--><p class="nopar" > +</p><!--l. 877--><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 @@ -1640,22 +1653,22 @@ class="cmtt-10">nogroupskip </span>package option: </p> - <div class="verbatim" id="verbatim-33"> + <div class="verbatim" id="verbatim-34"> \usepackage[nogroupskip]{glossaries} </div> -<!--l. 876--><p class="nopar" > -</p><!--l. 878--><p class="indent" > If the default style doesn’t suit your document, you can change the style +<!--l. 883--><p class="nopar" > +</p><!--l. 885--><p class="indent" > If the default style doesn’t suit your document, you can change the style using: -</p><!--l. 881--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 888--><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. 882--><p class="noindent" > +</p><!--l. 889--><p class="noindent" > There are a number of predefined styles. Glossaries can vary from a list of symbols with a terse description to a list of words or phrases with descriptions that span multiple paragraphs, so there’s no “one style fits all” solution. You need to choose a style that suits your document. -</p><!--l. 889--><p class="indent" > Examples: +</p><!--l. 896--><p class="indent" > Examples: </p><ol class="enumerate1" > <li class="enumerate" id="x1-6004x1">You have entries where the name is a symbol and the description is a brief phrase @@ -1666,12 +1679,12 @@ class="cmss-10">glossary-mcols</span><a - <div class="verbatim" id="verbatim-34"> + <div class="verbatim" id="verbatim-35"> \usepackage[nogroupskip,nopostdot]{glossaries}  <br />\usepackage{glossary-mcols}  <br />\setglossarystyle{mcolindex} </div> - <!--l. 898--><p class="nopar" > + <!--l. 905--><p class="nopar" > </p></li> <li class="enumerate" id="x1-6007x2">You have entries where the name is a word or phrase and the description spans @@ -1679,11 +1692,11 @@ class="cmss-10">glossary-mcols</span><a - <div class="verbatim" id="verbatim-35"> + <div class="verbatim" id="verbatim-36"> \usepackage[nopostdot]{glossaries}  <br />\setglossarystyle{altlist} </div> - <!--l. 906--><p class="nopar" > + <!--l. 913--><p class="nopar" > </p></li> <li class="enumerate" id="x1-6009x3">You have entries where the name is a single word, the description is @@ -1693,21 +1706,21 @@ class="cmss-10">glossary-mcols</span><a - <div class="verbatim" id="verbatim-36"> + <div class="verbatim" id="verbatim-37"> \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{long4col} </div> - <!--l. 915--><p class="nopar" > or one of the “tree” styles: + <!--l. 922--><p class="nopar" > or one of the “tree” styles: </p> - <div class="verbatim" id="verbatim-37"> + <div class="verbatim" id="verbatim-38"> \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{tree} </div> - <!--l. 920--><p class="nopar" ></p></li></ol> -<!--l. 923--><p class="indent" > If your glossary consists of a list of acronyms and you also want to specify + <!--l. 927--><p class="nopar" ></p></li></ol> +<!--l. 930--><p class="indent" > If your glossary consists of a list of acronyms and you also want to specify a 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 @@ -1716,34 +1729,34 @@ style: </p> - <div class="verbatim" id="verbatim-38"> + <div class="verbatim" id="verbatim-39"> \setacronymstyle{long-short-desc} </div> -<!--l. 929--><p class="nopar" > Define the acronyms with a description: +<!--l. 936--><p class="nopar" > Define the acronyms with a description: </p> - <div class="verbatim" id="verbatim-39"> + <div class="verbatim" id="verbatim-40"> \newacronym  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 935--><p class="nopar" > Choose a glossary style that suits wide entry names: +<!--l. 942--><p class="nopar" > Choose a glossary style that suits wide entry names: </p> - <div class="verbatim" id="verbatim-40"> + <div class="verbatim" id="verbatim-41"> \setglossarystyle{altlist} </div> -<!--l. 939--><p class="nopar" > -</p><!--l. 941--><p class="noindent" > +<!--l. 946--><p class="nopar" > +</p><!--l. 948--><p class="noindent" > </p> -<!--l. 941--><p class="noindent" ><a +<!--l. 948--><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. 944--><p class="noindent" >The <span +<!--l. 951--><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 @@ -1755,7 +1768,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. 951--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 958--><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 @@ -1767,7 +1780,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. 952--><p class="noindent" > +</p><!--l. 959--><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 @@ -1790,19 +1803,19 @@ 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. 965--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 972--><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. 966--><p class="noindent" > -</p><!--l. 968--><p class="indent" > In the case of Options <a +</p><!--l. 973--><p class="noindent" > +</p><!--l. 975--><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 class="cmtt-10">\makeglossaries</span>. -</p><!--l. 971--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of +</p><!--l. 978--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of acronyms, the <span class="cmss-10">glossaries</span><a id="dx1-7002"></a> package provides the package option <span @@ -1813,23 +1826,23 @@ which is a convenient shortcut for </p> - <div class="verbatim" id="verbatim-41"> + <div class="verbatim" id="verbatim-42"> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </div> -<!--l. 977--><p class="nopar" > The option also changes the behaviour of <span +<!--l. 984--><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. 982--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and +</p><!--l. 989--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and a list of notation: </p> - <div class="verbatim" id="verbatim-42"> + <div class="verbatim" id="verbatim-43"> \usepackage[acronyms]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 987--><p class="nopar" > After <span +<!--l. 994--><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: @@ -1837,7 +1850,7 @@ preamble. For example: </p> - <div class="verbatim" id="verbatim-43"> + <div class="verbatim" id="verbatim-44"> \newglossaryentry{gls:set}  <br />{% This entry goes in the ‘main’ glossary  <br />  name=set, @@ -1852,13 +1865,13 @@ preamble. For example:  <br />  description={A set},  <br />  sort={S}} </div> -<!--l. 1006--><p class="nopar" > or if you don’t like using <span +<!--l. 1013--><p class="nopar" > or if you don’t like using <span class="cmtt-10">\ensuremath</span>: </p> - <div class="verbatim" id="verbatim-44"> + <div class="verbatim" id="verbatim-45"> \newglossaryentry{not:set}  <br />{% This entry goes in the ‘notation’ glossary:  <br />  type=notation, @@ -1867,39 +1880,39 @@ class="cmtt-10">\ensuremath</span>:  <br />  description={A set},  <br />  sort={S}} </div> -<!--l. 1016--><p class="nopar" > -</p><!--l. 1018--><p class="indent" > Each glossary is displayed using: -</p><!--l. 1020--><p class="indent" > <hr><div title="Definition"><span +<!--l. 1023--><p class="nopar" > +</p><!--l. 1025--><p class="indent" > Each glossary is displayed using: +</p><!--l. 1027--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossary[type=</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 1021--><p class="noindent" > +</p><!--l. 1028--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 1024--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1031--><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. 1025--><p class="noindent" > +</p><!--l. 1032--><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. 1029--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries: -</p><!--l. 1032--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1036--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries: +</p><!--l. 1039--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossaries </span></div><hr> -</p><!--l. 1033--><p class="noindent" > +</p><!--l. 1040--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 1036--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1043--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> -</p><!--l. 1037--><p class="noindent" > +</p><!--l. 1044--><p class="noindent" > (Options <a href="#option2">2</a> and <a href="#option3">3</a>). -</p><!--l. 1040--><p class="indent" > If you use <a +</p><!--l. 1047--><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 href="#option3">3</a> @@ -1925,7 +1938,7 @@ 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. 1053--><p class="indent" > For example, suppose you have three glossaries in your document (<span +</p><!--l. 1060--><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 @@ -1934,42 +1947,42 @@ class="cmtt-10">notation</span>), specified using: </p> - <div class="verbatim" id="verbatim-45"> + <div class="verbatim" id="verbatim-46"> \usepackage[acronyms]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 1059--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 1066--><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. 1063--><p class="indent" > +</p><!--l. 1070--><p class="indent" > </p><dl class="description"><dt class="description"> </dt><dd class="description"><a href="#option2">Option 2</a>: - <!--l. 1066--><p class="noindent" >You need to run <span + <!--l. 1073--><p class="noindent" >You need to run <span class="cmtt-10">makeindex </span>three times: </p> - <div class="verbatim" id="verbatim-46"> + <div class="verbatim" id="verbatim-47"> makeindex -t myDoc.glg -s myDoc.ist -o myDoc.gls myDoc.glo  <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. 1071--><p class="nopar" > + <!--l. 1078--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a href="#option3">Option 3</a>: - <!--l. 1075--><p class="noindent" >You need to run <span + <!--l. 1082--><p class="noindent" >You need to run <span class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where the line has wrapped.) </p> - <div class="verbatim" id="verbatim-47"> + <div class="verbatim" id="verbatim-48"> xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.glg  <br />-o myDoc.gls myDoc.glo  <br />xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.alg @@ -1977,15 +1990,15 @@ class="cmtt-10">xindy </span>three times (be careful not to insert line breaks w  <br />xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg  <br />-o myDoc.not myDoc.ntn </div> - <!--l. 1084--><p class="nopar" ></p></dd></dl> -<!--l. 1087--><p class="noindent" > + <!--l. 1091--><p class="nopar" ></p></dd></dl> +<!--l. 1094--><p class="noindent" > </p> -<!--l. 1087--><p class="noindent" ><a +<!--l. 1094--><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. 1090--><p class="noindent" >Take care if you use the <span +<!--l. 1097--><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 @@ -2003,11 +2016,11 @@ class="cmss-10">hyperref</span><a </p> - <div class="verbatim" id="verbatim-48"> + <div class="verbatim" id="verbatim-49"> \usepackage[colorlinks]{hyperref}  <br />\usepackage{glossaries} </div> -<!--l. 1097--><p class="nopar" > If you use <span +<!--l. 1104--><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> rather than the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -2016,16 +2029,16 @@ engine. The DVI format can’t break hyperlinks across a line so long entries (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. 1104--><p class="indent" > By default, if the <span +</p><!--l. 1111--><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 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. 1109--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1116--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsdisablehyper </span></div><hr> -</p><!--l. 1110--><p class="noindent" > +</p><!--l. 1117--><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’t want hyperlinks for entries in @@ -2038,13 +2051,13 @@ glossary, then do: </p> - <div class="verbatim" id="verbatim-49"> + <div class="verbatim" id="verbatim-50"> \usepackage[colorlinks]{hyperref}  <br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 1120--><p class="nopar" > -</p><!--l. 1122--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want +<!--l. 1127--><p class="nopar" > +</p><!--l. 1129--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want hyperlinks for subsequence references then use the <span class="cmtt-10">hyperfirst=false </span>package option: @@ -2052,12 +2065,12 @@ option: </p> - <div class="verbatim" id="verbatim-50"> + <div class="verbatim" id="verbatim-51"> \usepackage[colorlinks]{hyperref}  <br />\usepackage[hyperfirst=false]{glossaries} </div> -<!--l. 1128--><p class="nopar" > -</p><!--l. 1130--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This +<!--l. 1135--><p class="nopar" > +</p><!--l. 1137--><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-8008"></a> package but is a limitation of PDF bookmarks. @@ -2075,18 +2088,18 @@ class="cmtt-10">\texorpdfstring</span>. For example: </p> - <div class="verbatim" id="verbatim-51"> + <div class="verbatim" id="verbatim-52"> \section{The \texorpdfstring{\gls{fishage}}{Fish Age}} </div> -<!--l. 1138--><p class="nopar" > However, it’s not a good idea to use commands like <span +<!--l. 1145--><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. 1143--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1150--><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. 1144--><p class="noindent" > +</p><!--l. 1151--><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: @@ -2094,26 +2107,26 @@ For example, the following works: </p> - <div class="verbatim" id="verbatim-52"> + <div class="verbatim" id="verbatim-53"> \section{The \glsentrytext{fishage}} </div> -<!--l. 1149--><p class="nopar" > and it doesn’t put the table of contents in the location list. -</p><!--l. 1152--><p class="noindent" > +<!--l. 1156--><p class="nopar" > and it doesn’t put the table of contents in the location list. +</p><!--l. 1159--><p class="noindent" > </p> -<!--l. 1152--><p class="noindent" ><a +<!--l. 1159--><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. 1155--><p class="noindent" >You can add a reference to another entry in a location list using the <span +<!--l. 1162--><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</span>⟩<span class="cmtt-10">} </span>key when you define an entry. The referenced entry must also be defined. -</p><!--l. 1159--><p class="indent" > For example: +</p><!--l. 1166--><p class="indent" > For example: </p> - <div class="verbatim" id="verbatim-53"> + <div class="verbatim" id="verbatim-54"> \longnewglossaryentry{devonian}{name={Devonian}}%  <br />{%  <br />  The geologic period spanning from the end of the @@ -2128,7 +2141,7 @@ when you define an entry. The referenced entry must also be defined.  <br />  see={devonian}  <br />} </div> -<!--l. 1176--><p class="nopar" > The cross-reference will appear as “<span +<!--l. 1183--><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 @@ -2139,7 +2152,7 @@ class="cmti-10">label</span>⟩. For example: </p> - <div class="verbatim" id="verbatim-54"> + <div class="verbatim" id="verbatim-55"> \newglossaryentry{latinalph}  <br />{  <br />  name={Latin alphabet}, @@ -2154,7 +2167,7 @@ class="cmti-10">label</span>⟩. For example:  <br />   other letters such as ligatures or diacritics.}  <br />} </div> -<!--l. 1194--><p class="nopar" > If you use the <span +<!--l. 1201--><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: @@ -2162,23 +2175,23 @@ enclose the value in braces. For example: </p> - <div class="verbatim" id="verbatim-55"> + <div class="verbatim" id="verbatim-56"> \newacronym{ksvm}{ksvm}{kernel support vector machine}  <br />\newacronym  <br /> [see={[see also]{ksvm}}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 1203--><p class="nopar" > -</p><!--l. 1205--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location list +<!--l. 1210--><p class="nopar" > +</p><!--l. 1212--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location list using the <span class="cmtt-10">nonumberlist </span>package option, then the cross-reference will also be suppressed. -</p><!--l. 1209--><p class="noindent" > +</p><!--l. 1216--><p class="noindent" > </p> -<!--l. 1209--><p class="noindent" ><a +<!--l. 1216--><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. 1212--><p class="noindent" >Further information can be found in the main <span +<!--l. 1219--><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 |