diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | 1085 |
1 files changed, 646 insertions, 439 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index af3c5882ca6..683d4936342 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: a guide for beginners</title> +<head><title>The glossaries package v4.08: 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="2014-04-04 12:03:00" /> +<meta name="date" content="2014-07-31 17:35:00" /> <style type="text/css"> <!-- @@ -29,11 +29,11 @@ .cmtt-10{font-family: monospace;} .cmss-10{ font-family: sans-serif;} .cmss-10{ font-family: sans-serif;} -.cmitt-10{font-family: monospace; font-style: italic;} -.cmti-10{ font-style: italic;} .cmtt-9{font-size:90%;font-family: monospace;} .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} +.cmti-10{ font-style: italic;} +.cmitt-10{font-family: monospace; font-style: italic;} .cmbx-10{ font-weight: bold;} .cmbx-10{ font-weight: bold;} .cmsy-9{font-size:90%;} @@ -198,49 +198,67 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle -<h2 class="titleHead">The glossaries package: a guide for beginners</h2> +<h2 class="titleHead">The glossaries package v4.08: 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">2014-04-04</span></div> +class="cmr-12">2014-07-30</span></div> </div> <div class="abstract" > <div class="center" > -<!--l. 45--><p class="noindent" > -</p><!--l. 45--><p class="noindent" ><span +<!--l. 46--><p class="noindent" > +</p><!--l. 46--><p class="noindent" ><span class="cmbx-9">Abstract</span></p></div> - <!--l. 46--><p class="indent" > <span -class="cmr-9">This document is a brief guide to the </span><span + <!--l. 47--><p class="indent" > <span +class="cmr-9">The </span><span class="cmss-9">glossaries </span><span -class="cmr-9">package for beginners</span> +class="cmr-9">package is very flexible, but this means that it has a lot</span> <span -class="cmr-9">who find the size of the main user manual daunting and, as such, it only</span> +class="cmr-9">options, and since a user guide is supposed to provide a complete list of all</span> <span -class="cmr-9">covers the basics. For brevity some options to the commands described here</span> +class="cmr-9">the high-level user commands, the main user manual is quite big. This can</span> <span -class="cmr-9">are omitted. For a</span><span -class="cmr-9"> more detailed guide, see the </span><a +class="cmr-9">be rather daunting for beginners, so this document is a brief introduction</span> + <span +class="cmr-9">just to help get you started. If you find yourself saying, “Yeah, but how can</span> + <span +class="cmr-9">I do</span><span +class="cmr-9">…?” then it’s time to move on to the </span><a href="glossaries-user.html" ><span class="cmr-9">main user manual</span></a><span class="cmr-9">.</span> + </p><!--l. 56--><p class="indent" > <span +class="cmr-9">I’ve made some statements in this document that don’t actually tell you</span> + <span +class="cmr-9">the full truth, but it would clutter the document and cause confusion if I</span> + <span +class="cmr-9">keep writing “except when </span><span +class="cmr-9">…” or “but you can also do this, that or the other”</span> + <span +class="cmr-9">or “you can do it this way but you can also do it that way, but that way</span> + <span +class="cmr-9">may cause complications under certain circumstances”.</span> </p> </div> <h3 class="likesectionHead"><a id="x1-1000"></a>Contents</h3> <div class="tableofcontents"> <span class="sectionToc" >1 <a -href="#sec:defterm" id="QQ2-1-2">Defining Terms</a></span> +href="#sec:start" id="QQ2-1-2">Getting Started</a></span> <br /> <span class="sectionToc" >2 <a -href="#sec:useterm" id="QQ2-1-3">Using Entries</a></span> +href="#sec:defterm" id="QQ2-1-3">Defining Terms</a></span> <br /> <span class="sectionToc" >3 <a -href="#sec:acronyms" id="QQ2-1-4">Acronyms</a></span> +href="#sec:useterm" id="QQ2-1-4">Using Entries</a></span> <br /> <span class="sectionToc" >4 <a href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries</a></span> <br /> <span class="sectionToc" >5 <a href="#sec:glosstyle" id="QQ2-1-7">Customising the Glossary</a></span> + + + <br /> <span class="sectionToc" >6 <a href="#sec:multigloss" id="QQ2-1-8">Multiple Glossaries</a></span> <br /> <span class="sectionToc" >7 <a @@ -250,22 +268,243 @@ href="#sec:xr" id="QQ2-1-10">Cross-References</a></span> <br /> <span class="sectionToc" >9 <a href="#sec:moreinfo" id="QQ2-1-11">Further Information</a></span> </div> +<!--l. 66--><p class="noindent" > +</p> +<!--l. 66--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="sec:start"></a>Getting Started</h3> +<!--l. 69--><p class="noindent" >As with all packages, you need to load <span +class="cmss-10">glossaries </span>with <span +class="cmtt-10">\usepackage</span>, but there are +certain packages that must be loaded before <span +class="cmss-10">glossaries</span>, if they are required: <span +class="cmss-10">hyperref</span><a + id="dx1-2001"></a>, +<span +class="cmss-10">babel</span><a + id="dx1-2002"></a>, <span +class="cmss-10">polyglossia</span><a + id="dx1-2003"></a>, <span +class="cmss-10">inputenc</span><a + id="dx1-2004"></a> and <span +class="cmss-10">fontenc</span><a + id="dx1-2005"></a>. (You don’t have to load these packages, but if +you want them, you must load them before <span +class="cmss-10">glossaries</span>.) +</p><!--l. 76--><p class="indent" > Once you have loaded <span +class="cmss-10">glossaries</span>, you need to define your terms in the preamble and +then you can use them throughout the document. Here’s a simple example: -<!--l. 55--><p class="noindent" > </p> -<!--l. 55--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1 </span> <a + <div class="verbatim" id="verbatim-1"> +\documentclass{article} + <br />\usepackage{glossaries} + <br />\newglossaryentry{ex}{name={sample},description={an example}} + <br />\begin{document} + <br />Here’s my \gls{ex} term. + <br />\end{document} +</div> +<!--l. 89--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h"> + <br />Here’s my sample term. + <br /><spacer type=vertical size=10></span> +Here’s another example: + + + +</p> + <div class="verbatim" id="verbatim-2"> +\documentclass{article} + <br />\usepackage{glossaries} + <br />\setacronymstyle{long-short} + <br />\newacronym{svm}{SVM}{support vector machine} + <br />\begin{document} + <br />First use: \gls{svm}. Second use: \gls{svm}. + <br />\end{document} +</div> +<!--l. 107--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h"> + <br />First use: support vector machine (SVM). Second use: SVM. + <br /><spacer type=vertical size=10></span> +In this case, the text produced by <span +class="cmtt-10">\svm </span>changed after the first use. The first use +produced the long form followed by the short form in parentheses because I set the +acronym style to <span +class="cmtt-10">long-short</span>. I suggest you try the above two examples to +make sure you have the package correctly installed. If you get an <span +class="cmtt-10">undefined</span> +<span +class="cmtt-10">control sequence </span>error, check that the version number at the top of this +document matches the version you have installed. (Open the <span +class="cmtt-10">.log </span>file and search +for the line that starts with <span +class="cmtt-10">Package: glossaries </span>followed by a date and +version.) +</p><!--l. 123--><p class="indent" > If you like, you can put all your definitions in another file (for example, <span +class="cmtt-10">defns.tex</span>) +and load that file in the preamble using <span +class="cmtt-10">\loadglsentries </span>with the filename as the +argument. For example: + + + +</p> + <div class="verbatim" id="verbatim-3"> +\loadglsentries{defns} +</div> +<!--l. 128--><p class="nopar" > +</p><!--l. 130--><p class="indent" > Don’t try inserting formatting commands into the definitions as they can interfere +with the underlying mechanism. Instead, the formatting should be done by the style. +For example, suppose I want to replace <span +class="cmtt-10">SVM </span>in the above to <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textsc{svm}</span></span></span>, then I need +to select a style that uses <span +class="cmtt-10">\textsc</span>, like this: + + + +</p> + <div class="verbatim" id="verbatim-4"> +\documentclass{article} + <br />\usepackage{glossaries} + <br />\setacronymstyle{long-sc-short} + <br />\newacronym{svm}{svm}{support vector machine} + <br />\begin{document} + <br />First use: \gls{svm}. Second use: \gls{svm}. + <br />\end{document} +</div> +<!--l. 147--><p class="nopar" > +</p><!--l. 149--><p class="indent" > As you can hopefully see from the above examples, there are two main ways of +defining a term. In both cases, the term is given a label. In the first case the label +was <span +class="cmtt-10">ex </span>and in the second case the label was <span +class="cmtt-10">svm</span>. The label is just a way of +identifying the term (like the standard <span +class="cmtt-10">\label</span>/<span +class="cmtt-10">\ref </span>mechanism). It’s best to +just use the following alphanumerics in the labels: <span +class="cmtt-10">a</span>, …, <span +class="cmtt-10">z</span>, <span +class="cmtt-10">A</span>, …, <span +class="cmtt-10">Z</span>, <span +class="cmtt-10">0</span>, …, <span +class="cmtt-10">9</span>. +Sometimes you can also use punctuation characters but not if another package (such +as <span +class="cmss-10">babel</span><a + id="dx1-2006"></a>) meddles with them. Don’t try using any characters outside of the +basic Latin set (for example, é or ß) or things will go horribly wrong. This +warning only applies to the label. It doesn’t apply to the text that appears in the +document. +</p><!--l. 163--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes if you +want to display a sorted list of all the entries you have used in the document. The +<span +class="cmss-10">glossaries </span>package provides three options: use <span class="TEX">T<span +class="E">E</span>X</span> to perform the sorting; use +<span +class="cmtt-10">makeindex </span>to perform the sorting; use <span +class="cmtt-10">xindy </span>to perform the sorting. +</p><!--l. 170--><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: + + + +</p> + <div class="verbatim" id="verbatim-5"> +\documentclass{article} + <br />\usepackage{glossaries} + <br />\makenoidxglossaries + <br />\newglossaryentry{potato}{name={potato},plural={potatoes}, + <br /> description={starchy tuber}} + <br />\newglossaryentry{cabbage}{name={cabbage}, + <br /> description={vegetable with thick green or purple leaves}} + <br />\newglossaryentry{carrot}{name={carrot}, + <br /> description={orange root}} + <br />\begin{document} + <br />Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. + <br />\printnoidxglossaries + <br />\end{document} +</div> +<!--l. 195--><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 +glossary. It will only appear on the second run. The glossary has a vertical gap between +the “carrot” term and the “potato” term. This is because the entries in the glossaries +are grouped according to their first letter. If you don’t want this gap, just add +<span +class="cmtt-10">nogroupskip </span>to the package options: + + + +</p> + <div class="verbatim" id="verbatim-6"> +\usepackage[nogroupskip]{glossaries} +</div> +<!--l. 204--><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 +suppress it using the <span +class="cmtt-10">nonumberlist </span>package option: + + + +</p> + <div class="verbatim" id="verbatim-7"> +\usepackage[nonumberlist]{glossaries} +</div> +<!--l. 213--><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: + + + +</p> + <div class="verbatim" id="verbatim-8"> +\usepackage[nopostdot]{glossaries} +</div> +<!--l. 218--><p class="nopar" > +</p><!--l. 220--><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. 226--><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 +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 +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. 234--><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. 237--><p class="noindent" > +</p> +<!--l. 237--><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. 58--><p class="noindent" >When you use the <span +<!--l. 240--><p class="noindent" >When you use the <span class="cmss-10">glossaries</span><a - id="dx1-2001"></a> package, you need to define glossary entries in the + 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. 65--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> +</p><!--l. 247--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\newglossaryentry{</span><span @@ -300,42 +539,32 @@ class="cmmi-10">></span> class="cmtt-10">}</span></span> </div> </div> </div><hr> -<!--l. 73--><p class="noindent" > +<!--l. 255--><p class="noindent" > where <span class="cmmi-10"><</span><span class="cmti-10">label</span><span class="cmmi-10">> </span>is a unique label that identifies this entry. (Don’t include the angle brackets <span class="cmmi-10">< ></span>. They just indicate the parts of the code you need to change when you -use this command in your document.) As with similar labelling commands, such as -<span -class="cmtt-10">\label </span>or <span -class="cmtt-10">\bibitem</span>, the label should not contain active characters, so just use <span -class="cmtt-10">a</span>, …, <span -class="cmtt-10">z</span>, -<span -class="cmtt-10">A</span>, …, <span -class="cmtt-10">Z</span>, <span -class="cmtt-10">0</span>, …, <span -class="cmtt-10">9</span>. You may also be able to use some punctuation characters, unless they -have been made active (for example, via <span -class="cmss-10">babel</span><a - id="dx1-2002"></a>’s shorthand activation.) The -<span +use this command in your document.) The <span class="cmmi-10"><</span><span class="cmti-10">name</span><span -class="cmmi-10">> </span>is the word, phrase or symbol you are defining, and <span +class="cmmi-10">> </span>is the word, phrase or symbol + + + +you are defining, and <span class="cmmi-10"><</span><span class="cmti-10">description</span><span -class="cmmi-10">> </span>is the -description. -</p><!--l. 86--><p class="indent" > This command is a “short” command, which means that <span +class="cmmi-10">> </span>is the description to be displayed in the +glossary. +</p><!--l. 263--><p class="indent" > This command is a “short” command, which means that <span class="cmmi-10"><</span><span class="cmti-10">description</span><span class="cmmi-10">> </span>can’t contain a paragraph break. If you have a long description, you can instead use: -</p><!--l. 90--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> +</p><!--l. 267--><p class="indent" > <hr><div title="Definition"></p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\longnewglossaryentry{</span><span @@ -369,50 +598,47 @@ class="cmmi-10">></span><span class="cmtt-10">}</span> </div> </div> </div><hr> -<!--l. 98--><p class="noindent" > - - - -</p><!--l. 100--><p class="indent" > Examples: +<!--l. 275--><p class="noindent" > +</p><!--l. 277--><p class="indent" > Examples: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-2004x1">Define the term “set” with the label <span + class="enumerate" id="x1-3003x1">Define the term “set” with the label <span class="cmtt-10">set</span>: - <div class="verbatim" id="verbatim-1"> + <div class="verbatim" id="verbatim-9"> \newglossaryentry{set}  <br />{  <br />  name={set},  <br />  description={a collection of objects}  <br />} </div> - <!--l. 109--><p class="nopar" > + <!--l. 286--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-2006x2">Define the symbol <span + class="enumerate" id="x1-3005x2">Define the symbol <span class="cmsy-10">∅ </span>with the label <span class="cmtt-10">emptyset</span>: - <div class="verbatim" id="verbatim-2"> + <div class="verbatim" id="verbatim-10"> \newglossaryentry{emptyset}  <br />{  <br />  name={\ensuremath{\emptyset}},  <br />  description={the empty set}  <br />} </div> - <!--l. 119--><p class="nopar" > + <!--l. 296--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-2008x3">Define the phrase “Fish Age” with the label <span + class="enumerate" id="x1-3007x3">Define the phrase “Fish Age” with the label <span class="cmtt-10">fishage</span>: - <div class="verbatim" id="verbatim-3"> + <div class="verbatim" id="verbatim-11"> \longnewglossaryentry{fishage}  <br />{name={Fish Age}}  <br />{% @@ -423,28 +649,28 @@ class="cmtt-10">fishage</span>:  <br />  fish species.  <br />} </div> - <!--l. 134--><p class="nopar" > (The percent character discards the end of line character that would otherwise + <!--l. 311--><p class="nopar" > (The percent character discards the end of line character that would otherwise cause an unwanted space to appear at the start of the description.) </p></li> <li - class="enumerate" id="x1-2010x4">Take care if the first letter is an extended Latin or non-Latin character (either + class="enumerate" id="x1-3009x4">Take care if the first letter is an extended Latin or non-Latin character (either specified via a command such as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\’e</span></span></span> or explicitly via the <span class="cmss-10">inputenc</span><a - id="dx1-2011"></a> package such + id="dx1-3010"></a> package such as <span class="cmtt-10">é</span>). This first letter must be placed in a group: - <div class="verbatim" id="verbatim-4"> + <div class="verbatim" id="verbatim-12"> \newglossaryentry{elite}  <br />{  <br />  name={{\’e}lite},  <br />  description={select group or class}  <br />} </div> - <!--l. 150--><p class="nopar" > or </p><div class="alltt"> + <!--l. 327--><p class="nopar" > or </p><div class="alltt"> <div class="obeylines-v"> <span class="verb"><span class="cmtt-10">\newglossaryentry{elite}</span></span> @@ -468,8 +694,8 @@ class="cmtt-10"> class}</span></span> class="cmtt-10">}</span></span> </div> </div></li></ol> -<!--l. 161--><p class="indent" > Acronyms or abbreviations can be defined using -</p><!--l. 163--><p class="indent" > <hr><div title="Definition"><span +<!--l. 338--><p class="indent" > Acronyms or abbreviations can be defined using +</p><!--l. 340--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\newacronym{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span @@ -483,7 +709,7 @@ class="cmmi-10"><</span><span class="cmitt-10">long</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 164--><p class="noindent" > +</p><!--l. 341--><p class="noindent" > where <span class="cmmi-10"><</span><span class="cmti-10">label</span><span @@ -502,10 +728,10 @@ class="cmmi-10">> </span>is the long form. For example: </p> - <div class="verbatim" id="verbatim-5"> + <div class="verbatim" id="verbatim-13"> \newacronym{svm}{svm}{support vector machine} </div> -<!--l. 170--><p class="nopar" > This defines a glossary entry with the label <span +<!--l. 347--><p class="nopar" > This defines a glossary entry with the label <span class="cmtt-10">svm</span>. By default, the <span class="cmmi-10"><</span><span class="cmti-10">name</span><span @@ -527,24 +753,51 @@ argument: </p> - <div class="verbatim" id="verbatim-6"> + <div class="verbatim" id="verbatim-14"> \newacronym  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 181--><p class="nopar" > -</p><!--l. 183--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span +<!--l. 358--><p class="nopar" > +</p><!--l. 360--><p class="indent" > Before you define your acronyms, you need to specify which acronym style to use +with +</p><!--l. 363--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\setacronymstyle{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">style name</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 364--><p class="noindent" > +where <span +class="cmmi-10"><</span><span +class="cmti-10">style name</span><span +class="cmmi-10">> </span>is the name of the style. There are a number of predefined styles, +such as: <span +class="cmtt-10">long-short </span>(on first use display the long form with the short form in +parentheses); <span +class="cmtt-10">short-long </span>(on first use display the short form with the long form in +parentheses); <span +class="cmtt-10">long-short-desc </span>(like <span +class="cmtt-10">long-short </span>but you need to specify the +description); or <span +class="cmtt-10">short-long-desc </span>(like <span +class="cmtt-10">short-long </span>but you need to specify the +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. 376--><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. 189--><p class="indent" > For example: +</p><!--l. 382--><p class="indent" > For example: </p> - <div class="verbatim" id="verbatim-7"> + <div class="verbatim" id="verbatim-15"> \newglossaryentry{latinalph}  <br />{  <br />  name={Latin Alphabet}, @@ -553,9 +806,9 @@ class="cmtt-10">text </span>key as well.  <br />  a, \ldots, z, A, \ldots, Z}  <br />} </div> -<!--l. 198--><p class="nopar" > This will appear in the text as “Latin alphabet” but will be listed in the glossary as +<!--l. 391--><p class="nopar" > This will appear in the text as “Latin alphabet” but will be listed in the glossary as “Latin Alphabet”. -</p><!--l. 202--><p class="indent" > Another commonly used key is <span +</p><!--l. 395--><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 @@ -565,7 +818,7 @@ class="cmtt-10">plural </span>key to override it: </p> - <div class="verbatim" id="verbatim-8"> + <div class="verbatim" id="verbatim-16"> \newglossaryentry{oesophagus}  <br />{  <br />  name={{\oe}sophagus}, @@ -573,9 +826,9 @@ class="cmtt-10">plural </span>key to override it:  <br />  description={canal from mouth to stomach}  <br />} </div> -<!--l. 213--><p class="nopar" > (Remember from earlier that the initial ligature <span +<!--l. 406--><p class="nopar" > (Remember from earlier that the initial ligature <span class="cmtt-10">\oe </span>needs to be grouped.) -</p><!--l. 217--><p class="indent" > The plural forms for acronyms can be specified using the <span +</p><!--l. 410--><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: @@ -583,14 +836,14 @@ class="cmtt-10">shortplural </span>keys. For example: </p> - <div class="verbatim" id="verbatim-9"> + <div class="verbatim" id="verbatim-17"> \newacronym  <br /> [longplural={diagonal matrices}]  <br /> {dm}{DM}{diagonal matrix} </div> -<!--l. 223--><p class="nopar" > If omitted, the defaults are again obtained by appending an “s” to the singular +<!--l. 416--><p class="nopar" > If omitted, the defaults are again obtained by appending an “s” to the singular versions. -</p><!--l. 227--><p class="indent" > It’s also possible to have both a name and a corresponding symbol. Just use the +</p><!--l. 420--><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: @@ -598,7 +851,7 @@ class="cmtt-10">symbol </span>key for the symbol. For example: </p> - <div class="verbatim" id="verbatim-10"> + <div class="verbatim" id="verbatim-18"> \newglossaryentry{emptyset}  <br />{  <br />  name={empty set}, @@ -606,22 +859,22 @@ class="cmtt-10">symbol </span>key for the symbol. For example:  <br />  description={the set containing no elements}  <br />} </div> -<!--l. 237--><p class="nopar" > -</p><!--l. 239--><p class="noindent" > +<!--l. 430--><p class="nopar" > +</p><!--l. 432--><p class="noindent" > </p> -<!--l. 239--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a +<!--l. 432--><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. 242--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in your +<!--l. 435--><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. 246--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 439--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\gls{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 247--><p class="noindent" > +</p><!--l. 440--><p class="noindent" > where <span class="cmmi-10"><</span><span class="cmti-10">label</span><span @@ -629,23 +882,35 @@ class="cmmi-10">> </span>is the label you assigned to the entry when you <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. 252--><p class="indent" > If the entry was defined as an acronym (using <span +</p><!--l. 445--><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 +class="cmtt-10">\gls</span> +will create a hyperlink to the corresponding entry in the glossary. If you want to +suppress the hyperlink for a particular instance, use the starred form <span +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. 452--><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 -subsequent use. For example, <span class="obeylines-h"><span class="verb"><span -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. 259--><p class="indent" > If you want the plural form, you can use: -</p><!--l. 261--><p class="indent" > <hr><div title="Definition"><span +subsequent use. For example, if the acronym style is set to <span +class="cmtt-10">long-short</span>, then +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span> will display “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. 460--><p class="indent" > If you want the plural form, you can use: +</p><!--l. 462--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glspl{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 262--><p class="noindent" > +</p><!--l. 463--><p class="noindent" > instead of <span class="cmtt-10">\gls{</span><span class="cmmi-10"><</span><span @@ -653,189 +918,76 @@ class="cmti-10">label</span><span class="cmmi-10">></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. 266--><p class="indent" > If the term appears at the start of a sentence, you can convert the first letter to +</p><!--l. 467--><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. 269--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 470--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\Gls{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 270--><p class="noindent" > +</p><!--l. 471--><p class="noindent" > for the singular form or -</p><!--l. 273--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 474--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\Glspl{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 274--><p class="noindent" > + + + +</p><!--l. 475--><p class="noindent" > for the plural form. For example: </p> - <div class="verbatim" id="verbatim-11"> + <div class="verbatim" id="verbatim-19"> \Glspl{set} are collections. </div> -<!--l. 278--><p class="nopar" > produces “Sets are collections”. -</p><!--l. 281--><p class="indent" > If you’ve specified a symbol using the <span +<!--l. 479--><p class="nopar" > produces “Sets are collections”. +</p><!--l. 482--><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. 284--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 485--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glssymbol{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 285--><p class="noindent" > -</p><!--l. 287--><p class="noindent" > -</p> -<!--l. 287--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a - id="sec:acronyms"></a>Acronyms</h3> -<!--l. 290--><p class="noindent" >Recall from above, the first time you use an acronym with <span -class="cmtt-10">\gls</span>, it’s full form is -displayed but subsequent uses display only the short form. By default, the first use -displays <span -class="cmmi-10"><</span><span -class="cmti-10">long</span><span -class="cmmi-10">> </span>(<span -class="cmmi-10"><</span><span -class="cmti-10">short</span><span -class="cmmi-10">></span>). That is, the long form is displayed followed by the short -form in parentheses. You can change this first-use format with: -</p><!--l. 297--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\setacronymstyle{</span><span -class="cmmi-10"><</span><span -class="cmitt-10">style name</span><span -class="cmmi-10">></span><span -class="cmtt-10">} </span></div><hr> -</p><!--l. 298--><p class="noindent" > -(This must be used before you start defining your acronyms with <span -class="cmtt-10">\newacronym</span>.) There -are a number of predefined styles listed in <a -href="glossaries-user.html#sec:predefinedacrstyles" >Predefined Acronym Styles</a> in the main -<span -class="cmss-10">glossaries</span><a - id="dx1-4001"></a> user manual. Here are a few examples: - </p><ol class="enumerate1" > - <li - class="enumerate" id="x1-4003x1"><span -class="cmmi-10"><</span><span -class="cmti-10">short</span><span -class="cmmi-10">> </span>(<span -class="cmmi-10"><</span><span -class="cmti-10">long</span><span -class="cmmi-10">></span>) - - - - <div class="verbatim" id="verbatim-12"> - \setacronymstyle{short-long} -</div> - <!--l. 308--><p class="nopar" > This displays the short form followed by the long form in parentheses. - </p></li> - <li - class="enumerate" id="x1-4005x2"><span -class="cmmi-10"><</span><span -class="cmti-10">long</span><span -class="cmmi-10">> </span>(<span -class="cmtt-10">\textsc{</span><span -class="cmmi-10"><</span><span -class="cmti-10">short</span><span -class="cmmi-10">></span><span -class="cmtt-10">}</span>) - - - - <div class="verbatim" id="verbatim-13"> - \setacronymstyle{long-short-sc} -</div> - <!--l. 315--><p class="nopar" > This is like the default style but the short form is displayed in small caps. - Remember that when you use <span -class="cmtt-10">\textsc{</span><span -class="cmmi-10"><</span><span -class="cmti-10">text</span><span -class="cmmi-10">></span><span -class="cmtt-10">} </span>to generate small capitals, you - must specify <span -class="cmmi-10"><</span><span -class="cmti-10">text</span><span -class="cmmi-10">> </span>in lower case, so the short form of the acronym should be - defined in lower case. For example: - - - -</p> - <div class="verbatim" id="verbatim-14"> - \newacronym{svm}{svm}{support vector machine} -</div> - <!--l. 322--><p class="nopar" > - </p></li> - <li - class="enumerate" id="x1-4007x3"><span -class="cmmi-10"><</span><span -class="cmti-10">long</span><span -class="cmmi-10">> </span>(<span -class="cmtt-10">\textsmaller{</span><span -class="cmmi-10"><</span><span -class="cmti-10">short</span><span -class="cmmi-10">></span><span -class="cmtt-10">}</span>) - - - - <div class="verbatim" id="verbatim-15"> - \setacronymstyle{long-short-sm} -</div> - <!--l. 327--><p class="nopar" > This is similar to the previous style but uses <span -class="cmtt-10">\textsmaller </span>to format the short - form. Remember to load the <span -class="cmss-10">relsize</span><a - id="dx1-4008"></a> package, which defines <span -class="cmtt-10">\textsmaller</span>, if you - want to use this style. The short form now needs to be defined in upper - case: - - - -</p> - <div class="verbatim" id="verbatim-16"> - \newacronym{svm}{SVM}{support vector machine} -</div> - <!--l. 334--><p class="nopar" > -</p> - </li></ol> -<!--l. 338--><p class="noindent" > +</p><!--l. 486--><p class="noindent" > +</p><!--l. 488--><p class="noindent" > </p> -<!--l. 338--><p class="noindent" ><a +<!--l. 488--><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. 341--><p class="noindent" >Suppose you now want to display a list of all the entries you’ve referenced in your -document. This is where things start to get complicated and a lot of new users get -bewildered. You have three options: -</p><!--l. 346--><p class="indent" > +<!--l. 491--><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. 495--><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. 349--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted list, it + <!--l. 498--><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. 352--><p class="noindent" > + </p><!--l. 501--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5002x1">Add <span class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start defining your entries, as described in <a href="#sec:defterm"><span -class="cmsy-10">§</span>1 </a><a +class="cmsy-10">§</span>2 </a><a href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>). </li> <li class="enumerate" id="x1-5004x2">Put - <!--l. 359--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 508--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printnoidxglossary[sort=</span><span class="cmmi-10"><</span><span class="cmitt-10">order</span><span @@ -845,7 +997,7 @@ class="cmmi-10"><</span><span class="cmitt-10">other options</span><span class="cmmi-10">></span><span class="cmtt-10">] </span></div><hr> - </p><!--l. 360--><p class="noindent" > + </p><!--l. 509--><p class="noindent" > where you want your list of entries to appear. The sort <span class="cmmi-10"><</span><span class="cmti-10">order</span><span @@ -853,11 +1005,16 @@ class="cmmi-10">> </span>may be one of: <span class="cmtt-10">word </span>(word ordering), <span class="cmtt-10">letter </span>(letter ordering), <span -class="cmtt-10">case </span>(case-sensitive - letter ordering), <span +class="cmtt-10">case </span>(case-sensitive letter + ordering), <span class="cmtt-10">def </span>(in order of definition) or <span -class="cmtt-10">use </span>(in order of - use). +class="cmtt-10">use </span>(in order of use). Alternatively, + use + </p><!--l. 516--><p class="noindent" ><hr><div title="Definition"><span +class="cmtt-10">\printnoidxglossaries </span></div><hr> + </p><!--l. 517--><p class="noindent" > + to display all your glossaries (if you have more than one). This command + doesn’t have any arguments. </p></li> <li class="enumerate" id="x1-5006x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -874,7 +1031,7 @@ class="description"><a id="option2"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 2</span>: - <!--l. 374--><p class="noindent" >This option uses an application called <span + <!--l. 528--><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 @@ -886,7 +1043,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. 382--><p class="noindent" > + </p><!--l. 536--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5008x1">Add <span @@ -895,14 +1052,24 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5010x2">Put - <!--l. 388--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 542--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossary[</span><span class="cmmi-10"><</span><span class="cmitt-10">options</span><span class="cmmi-10">></span><span class="cmtt-10">] </span></div><hr> - </p><!--l. 389--><p class="noindent" > - where you want your list of entries (glossary) to appear. + </p><!--l. 543--><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="cmmi-10"><</span><span +class="cmti-10">options</span><span +class="cmmi-10">></span>.) Alternatively, use + </p><!--l. 548--><p class="noindent" ><hr><div title="Definition"><span +class="cmtt-10">\printglossaries </span></div><hr> + </p><!--l. 549--><p class="noindent" > + which will display all glossaries (if you have more than one). This command + doesn’t have any arguments. </p></li> <li class="enumerate" id="x1-5012x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -931,10 +1098,10 @@ class="cmtt-10">.gls</span>. If you have - <div class="verbatim" id="verbatim-17"> + <div class="verbatim" id="verbatim-20"> makeindex -s myDoc.ist -o myDoc.gls myDoc.glo </div> - <!--l. 407--><p class="nopar" > (Replace <span + <!--l. 568--><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 @@ -943,17 +1110,17 @@ 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. 415--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want + </p><!--l. 576--><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: </p> - <div class="verbatim" id="verbatim-18"> + <div class="verbatim" id="verbatim-21"> makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo </div> - <!--l. 420--><p class="nopar" > + <!--l. 581--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5016x5">Once you have successfully completed the previous step, you can now run @@ -965,7 +1132,7 @@ class="description"><a id="option3"></a><span class="cmbx-10">Option</span><span class="cmbx-10"> 3</span>: - <!--l. 428--><p class="noindent" >This option uses an application called <span + <!--l. 589--><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 @@ -986,7 +1153,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. 440--><p class="noindent" > + </p><!--l. 601--><p class="noindent" > </p><ol class="enumerate1" > <li class="enumerate" id="x1-5018x1">Add the <span @@ -996,10 +1163,10 @@ class="cmss-10">glossaries</span><a - <div class="verbatim" id="verbatim-19"> + <div class="verbatim" id="verbatim-22"> \usepackage[xindy]{glossaries} </div> - <!--l. 445--><p class="nopar" > + <!--l. 606--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5021x2">Add <span @@ -1008,14 +1175,22 @@ class="cmtt-10">\makeglossaries </span>to your preamble (before you start defini </li> <li class="enumerate" id="x1-5023x3">Put - <!--l. 452--><p class="noindent" ><hr><div title="Definition"><span + <!--l. 613--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\printglossary[</span><span class="cmmi-10"><</span><span class="cmitt-10">options</span><span class="cmmi-10">></span><span class="cmtt-10">] </span></div><hr> - </p><!--l. 453--><p class="noindent" > - where you want your list of entries (glossary) to appear. + </p><!--l. 614--><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="cmmi-10"><</span><span +class="cmti-10">options</span><span +class="cmmi-10">></span>.) Alternatively, use + </p><!--l. 619--><p class="noindent" ><hr><div title="Definition"><span +class="cmtt-10">\printglossaries </span></div><hr> + </p><!--l. 620--><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 @@ -1046,11 +1221,11 @@ class="cmtt-10">.gls</span>. - <div class="verbatim" id="verbatim-20"> + <div class="verbatim" id="verbatim-23"> xindy  -L english -C utf8 -I xindy -M myDoc  <br />-t myDoc.glg -o myDoc.gls myDoc.glo </div> - <!--l. 474--><p class="nopar" > (Replace <span + <!--l. 640--><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 @@ -1062,7 +1237,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. 484--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you + </p><!--l. 650--><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: @@ -1070,10 +1245,10 @@ class="cmtt-10">order=letter </span>package </p> - <div class="verbatim" id="verbatim-21"> + <div class="verbatim" id="verbatim-24"> \usepackage[xindy,order=letter]{glossaries} </div> - <!--l. 489--><p class="nopar" > + <!--l. 655--><p class="nopar" > </p></li> <li class="enumerate" id="x1-5029x6">Once you have successfully completed the previous step, you can now run @@ -1081,7 +1256,7 @@ class="cmtt-10">order=letter </span>package class="E">E</span>X</span></span> on your document again. </li></ol> </dd></dl> -<!--l. 498--><p class="indent" > For Options <a +<!--l. 664--><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 @@ -1103,10 +1278,10 @@ class="cmtt-10">myDoc.tex</span>, then run: </p> - <div class="verbatim" id="verbatim-22"> + <div class="verbatim" id="verbatim-25"> makeglossaries myDoc </div> -<!--l. 509--><p class="nopar" > (Replace <span +<!--l. 675--><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, @@ -1119,13 +1294,13 @@ directives: </p> - <div class="verbatim" id="verbatim-23"> + <div class="verbatim" id="verbatim-26">  arara: pdflatex  <br /> arara: makeglossaries  <br /> arara: pdflatex </div> -<!--l. 519--><p class="nopar" > -</p><!--l. 521--><p class="indent" > The <span +<!--l. 685--><p class="nopar" > +</p><!--l. 687--><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 @@ -1142,7 +1317,31 @@ href="#option2">Option 2</a> and can’t work out how to install Perl reason don’t want to install it) then just use <span class="cmtt-10">makeindex </span>directly, as described above. -</p><!--l. 533--><p class="indent" > When sorting the entries, the string comparisons are made according to each entry’s +</p><!--l. 699--><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-27"> +\usepackage[automake]{glossaries} +</div> +<!--l. 702--><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 +class="cmtt-10">xindy</span>. It +probably won’t work for <span +class="cmtt-10">xindy </span>and won’t work at all if the shell escape has been +disabled in your <span class="TEX">T<span +class="E">E</span>X</span> distribution. Most <span class="TEX">T<span +class="E">E</span>X</span> distributions will allow a restricted shell +escape, which will only allow trusted applications to be run. If the <span +class="cmtt-10">automake </span>option is +successful, you will still need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> twice for the glossaries to be +displayed. +</p><!--l. 712--><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 @@ -1151,14 +1350,14 @@ definition: </p> - <div class="verbatim" id="verbatim-24"> + <div class="verbatim" id="verbatim-28"> \newglossaryentry{elite}  <br />{  <br />  name={{\’e}lite},  <br />  description={select group or class}  <br />} </div> -<!--l. 543--><p class="nopar" > No <span +<!--l. 722--><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 @@ -1169,17 +1368,17 @@ href="#option1"><span class="cmbx-10">Option</span><span class="cmbx-10"> 1</span></a><span class="cmbx-10">:</span> </dt><dd -class="description">By default, the accent command will be stripped so the sort value - will be <span -class="cmtt-10">elite</span>. This will put the entry in the “E” letter group. If you use - the <span +class="description">By default, the accent command will be stripped so the sort value will + be <span +class="cmtt-10">elite</span>. This will put the entry in the “E” letter group. However if you + use the <span class="cmss-10">sanitizesort=true</span><a - id="dx1-5031"></a> package option, the sort value will be interpreted as the - sequence of characters: <span class="obeylines-h"><span class="verb"><span + id="dx1-5031"></a> package option, the sort value will be interpreted + as the sequence of characters: <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\</span></span></span> <span class="cmtt-10">’ e l i t </span>and <span -class="cmtt-10">e</span>. This will place this entry before - the “A” letter group since it starts with a symbol. +class="cmtt-10">e</span>. This will place this entry + before the “A” letter group since it starts with a symbol. </dd><dt class="description"> <a href="#option2"><span @@ -1209,7 +1408,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. 567--><p class="indent" > If the <span +<!--l. 746--><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"> @@ -1275,7 +1474,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. 593--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to +<!--l. 772--><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 @@ -1289,7 +1488,7 @@ class="cmtt-10">sort </span>key like this: </p> - <div class="verbatim" id="verbatim-25"> + <div class="verbatim" id="verbatim-29"> \newglossaryentry{elite}  <br />{  <br />  name={{\’e}lite}, @@ -1297,21 +1496,22 @@ class="cmtt-10">sort </span>key like this:  <br />  description={select group or class}  <br />} </div> -<!--l. 604--><p class="nopar" > If you use <a +<!--l. 783--><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. 609--><p class="indent" > <a -href="#x1-50351">Table 1</a> summarises the pros and cons of three options described above. +</p><!--l. 788--><p class="indent" > <a +href="#x1-50351">Table 1</a> summarises the main pros and cons of three options described +above. </p> <div class="table"> -<!--l. 612--><p class="indent" > <a +<!--l. 791--><p class="indent" > <a id="x1-50351"></a></p><hr class="float" /><div class="float" > @@ -1328,7 +1528,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. 618--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" +class="td11"> <!--l. 797--><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 @@ -1343,7 +1543,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. 619--><p class="noindent" >Requires +class="td11"> <!--l. 798--><p class="noindent" >Requires an external application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" @@ -1355,7 +1555,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. 621--><p class="noindent" >Requires +class="td11"> <!--l. 800--><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" @@ -1365,7 +1565,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. 623--><p class="noindent" >Can +class="td11"> <!--l. 802--><p class="noindent" >Can sort extended Latin @@ -1381,7 +1581,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. 626--><p class="noindent" >Efficient +class="td11"> <!--l. 805--><p class="noindent" >Efficient sort algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" class="td11"> <span @@ -1392,7 +1592,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. 628--><p class="noindent" >Can +class="td11"> <!--l. 807--><p class="noindent" >Can form ranges in @@ -1407,7 +1607,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. 630--><p class="noindent" >Can +class="td11"> <!--l. 809--><p class="noindent" >Can have non-standard locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" @@ -1417,22 +1617,8 @@ class="td11"> <span class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4" class="td11"> <span class="pzdr-">✔ </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. 632--><p class="noindent" ><span -class="cmtt-10">\newglossaryentry</span><a - id="dx1-5036"></a> - restricted - to - preamble? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2" -class="td11"> <span -class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3" -class="td11"> <span -class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-4" -class="td11"> <span -class="pzdr-">✘ </span></td> </tr></table></div> -<!--l. 636--><p class="noindent" ><sup class="textsuperscript"><span +<!--l. 813--><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 @@ -1443,11 +1629,13 @@ A. </p> </div><hr class="endfloat" /> </div> -<!--l. 640--><p class="noindent" ><a +<!--l. 817--><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. 643--><p class="noindent" >The default glossary style uses the <span -class="cmtt-10">description </span>environment to display the entry list. +<!--l. 820--><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. Each entry name is set in the optional argument of <span class="cmtt-10">\item </span>which means that it will typically be displayed in bold. You can switch to medium weight by redefining @@ -1457,22 +1645,22 @@ class="cmtt-10">\glsnamefont</span>: </p> - <div class="verbatim" id="verbatim-26"> + <div class="verbatim" id="verbatim-30"> \renewcommand*{\glsnamefont}[1]{\textmd{#1}} </div> -<!--l. 650--><p class="nopar" > -</p><!--l. 652--><p class="indent" > By default, a full stop is appended to the description. To prevent this from +<!--l. 827--><p class="nopar" > +</p><!--l. 829--><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-27"> + <div class="verbatim" id="verbatim-31"> \usepackage[nopostdot]{glossaries} </div> -<!--l. 656--><p class="nopar" > -</p><!--l. 658--><p class="indent" > By default, a location list is displayed for each entry. This refers to the document +<!--l. 833--><p class="nopar" > +</p><!--l. 835--><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 @@ -1492,11 +1680,11 @@ package option: </p> - <div class="verbatim" id="verbatim-28"> + <div class="verbatim" id="verbatim-32"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 668--><p class="nopar" > -</p><!--l. 670--><p class="indent" > Entries are grouped according to the first letter of each entry’s <span +<!--l. 845--><p class="nopar" > +</p><!--l. 847--><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 @@ -1505,76 +1693,76 @@ class="cmtt-10">nogroupskip </span>package option: </p> - <div class="verbatim" id="verbatim-29"> + <div class="verbatim" id="verbatim-33"> \usepackage[nogroupskip]{glossaries} </div> -<!--l. 676--><p class="nopar" > -</p><!--l. 678--><p class="indent" > If the default style doesn’t suit your document, you can change the style +<!--l. 853--><p class="nopar" > +</p><!--l. 855--><p class="indent" > If the default style doesn’t suit your document, you can change the style using: -</p><!--l. 681--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 858--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\setglossarystyle{</span><span class="cmmi-10"><</span><span class="cmitt-10">style name</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 682--><p class="noindent" > +</p><!--l. 859--><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. 689--><p class="indent" > Examples: +</p><!--l. 866--><p class="indent" > Examples: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-6002x1">You have entries where the name is a symbol and the description is a brief phrase + class="enumerate" id="x1-6004x1">You have entries where the name is a symbol and the description is a brief phrase or short sentence. Try one of the “mcol” styles defined in the <span class="cmss-10">glossary-mcols</span><a - id="dx1-6003"></a> + id="dx1-6005"></a> package. For example: - <div class="verbatim" id="verbatim-30"> + <div class="verbatim" id="verbatim-34"> \usepackage[nogroupskip,nopostdot]{glossaries}  <br />\usepackage{glossary-mcols}  <br />\setglossarystyle{mcolindex} </div> - <!--l. 698--><p class="nopar" > + <!--l. 875--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-6005x2">You have entries where the name is a word or phrase and the description spans + class="enumerate" id="x1-6007x2">You have entries where the name is a word or phrase and the description spans multiple paragraphs. Try one of the “altlist” styles. For example: - <div class="verbatim" id="verbatim-31"> + <div class="verbatim" id="verbatim-35"> \usepackage[nopostdot]{glossaries}  <br />\setglossarystyle{altlist} </div> - <!--l. 706--><p class="nopar" > + <!--l. 883--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-6007x3">You have entries where the name is a single word, the description is + class="enumerate" id="x1-6009x3">You have entries where the name is a single word, the description is brief, and an associated symbol has been set. Use one of the styles that display the symbol (not all of them do). For example, one of the tabular styles: - <div class="verbatim" id="verbatim-32"> + <div class="verbatim" id="verbatim-36"> \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{long4col} </div> - <!--l. 715--><p class="nopar" > or one of the “tree” styles: + <!--l. 892--><p class="nopar" > or one of the “tree” styles: </p> - <div class="verbatim" id="verbatim-33"> + <div class="verbatim" id="verbatim-37"> \usepackage[nopostdot,nonumberlist]{glossaries}  <br />\setglossarystyle{tree} </div> - <!--l. 720--><p class="nopar" ></p></li></ol> -<!--l. 723--><p class="indent" > If your glossary consists of a list of acronyms and you also want to specify + <!--l. 897--><p class="nopar" ></p></li></ol> +<!--l. 900--><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 @@ -1583,46 +1771,46 @@ style: </p> - <div class="verbatim" id="verbatim-34"> + <div class="verbatim" id="verbatim-38"> \setacronymstyle{long-short-desc} </div> -<!--l. 729--><p class="nopar" > Define the acronyms with a description: +<!--l. 906--><p class="nopar" > Define the acronyms with a description: </p> - <div class="verbatim" id="verbatim-35"> + <div class="verbatim" id="verbatim-39"> \newacronym  <br /> [description={statistical pattern recognition technique}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 735--><p class="nopar" > Choose a glossary style that suits wide entry names: +<!--l. 912--><p class="nopar" > Choose a glossary style that suits wide entry names: </p> - <div class="verbatim" id="verbatim-36"> + <div class="verbatim" id="verbatim-40"> \setglossarystyle{altlist} </div> -<!--l. 739--><p class="nopar" > -</p><!--l. 741--><p class="noindent" > +<!--l. 916--><p class="nopar" > +</p><!--l. 918--><p class="noindent" > </p> -<!--l. 741--><p class="noindent" ><a +<!--l. 918--><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. 744--><p class="noindent" >The <span +<!--l. 921--><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 (using one of the commands described in <a href="#sec:defterm"><span -class="cmsy-10">§</span>1 </a><a +class="cmsy-10">§</span>2 </a><a href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>), that entry is automatically assigned to the default glossary, unless you indicate otherwise using the <span class="cmtt-10">type </span>key. However you first need to make sure the desired glossary has been defined. This is done using: -</p><!--l. 751--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 928--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\newglossary[</span><span class="cmmi-10"><</span><span class="cmitt-10">glg</span><span @@ -1644,7 +1832,7 @@ class="cmmi-10"><</span><span class="cmitt-10">title</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 752--><p class="noindent" > +</p><!--l. 929--><p class="noindent" > The <span class="cmmi-10"><</span><span class="cmti-10">label</span><span @@ -1659,15 +1847,15 @@ class="cmti-10">title</span><span class="cmmi-10">> </span>is the section or chapter heading used by <span class="cmtt-10">\printglossary </span>or <span -class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions used -by <span +class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions used by +<span class="cmtt-10">makeindex</span>/<span class="cmtt-10">xindy </span>(described 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>). If you -use <a -href="#option1">Option 1</a> described above, the <span +href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>). If you use <a +href="#option1">Option 1</a> +described above, the <span class="cmmi-10"><</span><span class="cmti-10">glg</span><span class="cmmi-10">></span>, <span @@ -1676,47 +1864,61 @@ class="cmti-10">gls</span><span class="cmmi-10">> </span>and <span class="cmmi-10"><</span><span class="cmti-10">glo</span><span -class="cmmi-10">> </span>arguments are -ignored. In the case of Options <a +class="cmmi-10">> </span>arguments are ignored, in which +case you may prefer to use the starred version where you don’t specify the +extensions: +</p><!--l. 942--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\newglossary*{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">title</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 943--><p class="noindent" > +</p><!--l. 945--><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. 765--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of +</p><!--l. 948--><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 -class="cmtt-10">acronyms</span>, which is -a convenient shortcut for +class="cmtt-10">acronym </span>(or <span +class="cmtt-10">acronyms</span>), +which is a convenient shortcut for </p> - <div class="verbatim" id="verbatim-37"> + <div class="verbatim" id="verbatim-41"> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </div> -<!--l. 770--><p class="nopar" > It 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. 775--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and +<!--l. 954--><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. 959--><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-38"> + <div class="verbatim" id="verbatim-42"> \usepackage[acronyms]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 780--><p class="nopar" > After <span +<!--l. 964--><p class="nopar" > After <span class="cmtt-10">\makeglossaries </span>(or <span -class="cmtt-10">\makenoidxglossaries</span>) you can define the entries. For -example: +class="cmtt-10">\makenoidxglossaries</span>) you can define the entries in the +preamble. For example: </p> - <div class="verbatim" id="verbatim-39"> + <div class="verbatim" id="verbatim-43"> \newglossaryentry{gls:set}  <br />{% This entry goes in the ‘main’ glossary  <br />  name=set, @@ -1731,13 +1933,13 @@ example:  <br />  description={A set},  <br />  sort={S}} </div> -<!--l. 799--><p class="nopar" > or if you don’t like using <span +<!--l. 983--><p class="nopar" > or if you don’t like using <span class="cmtt-10">\ensuremath</span>: </p> - <div class="verbatim" id="verbatim-40"> + <div class="verbatim" id="verbatim-44"> \newglossaryentry{not:set}  <br />{% This entry goes in the ‘notation’ glossary:  <br />  type=notation, @@ -1746,24 +1948,24 @@ class="cmtt-10">\ensuremath</span>:  <br />  description={A set},  <br />  sort={S}} </div> -<!--l. 809--><p class="nopar" > -</p><!--l. 811--><p class="indent" > Each glossary is displayed using: -</p><!--l. 813--><p class="indent" > <hr><div title="Definition"><span +<!--l. 993--><p class="nopar" > +</p><!--l. 995--><p class="indent" > Each glossary is displayed using: +</p><!--l. 997--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossary[type=</span><span class="cmmi-10"><</span><span class="cmitt-10">type</span><span class="cmmi-10">></span><span class="cmtt-10">] </span></div><hr> -</p><!--l. 814--><p class="noindent" > +</p><!--l. 998--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 817--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1001--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printglossary[type=</span><span class="cmmi-10"><</span><span class="cmitt-10">type</span><span class="cmmi-10">></span><span class="cmtt-10">] </span></div><hr> -</p><!--l. 818--><p class="noindent" > +</p><!--l. 1002--><p class="noindent" > (Options <a href="#option2">2</a> and <a href="#option3">3</a>). Where <span @@ -1772,19 +1974,19 @@ class="cmti-10">type</span><span class="cmmi-10">> </span>is the glossary label. If the type is omitted the default <span class="cmtt-10">main </span>glossary is assumed. -</p><!--l. 822--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries: -</p><!--l. 825--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1006--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries: +</p><!--l. 1009--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printnoidxglossaries </span></div><hr> -</p><!--l. 826--><p class="noindent" > +</p><!--l. 1010--><p class="noindent" > (<a href="#option1">Option 1</a>) or -</p><!--l. 829--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1013--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\printglossaries </span></div><hr> -</p><!--l. 830--><p class="noindent" > +</p><!--l. 1014--><p class="noindent" > (Options <a href="#option2">2</a> and <a href="#option3">3</a>). -</p><!--l. 833--><p class="indent" > If you use <a +</p><!--l. 1017--><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> @@ -1817,7 +2019,7 @@ 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. 846--><p class="indent" > For example, suppose you have three glossaries in your document (<span +</p><!--l. 1030--><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 @@ -1826,42 +2028,42 @@ class="cmtt-10">notation</span>), specified using: </p> - <div class="verbatim" id="verbatim-41"> + <div class="verbatim" id="verbatim-45"> \usepackage[acronyms]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 852--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 1036--><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. 856--><p class="indent" > +</p><!--l. 1040--><p class="indent" > </p><dl class="description"><dt class="description"> </dt><dd class="description"><a href="#option2">Option 2</a>: - <!--l. 859--><p class="noindent" >You need to run <span + <!--l. 1043--><p class="noindent" >You need to run <span class="cmtt-10">makeindex </span>three times: </p> - <div class="verbatim" id="verbatim-42"> + <div class="verbatim" id="verbatim-46"> 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. 864--><p class="nopar" > + <!--l. 1048--><p class="nopar" > </p></dd><dt class="description"> </dt><dd class="description"><a href="#option3">Option 3</a>: - <!--l. 868--><p class="noindent" >You need to run <span + <!--l. 1052--><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-43"> + <div class="verbatim" id="verbatim-47"> 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 @@ -1869,15 +2071,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. 877--><p class="nopar" ></p></dd></dl> -<!--l. 880--><p class="noindent" > + <!--l. 1061--><p class="nopar" ></p></dd></dl> +<!--l. 1064--><p class="noindent" > </p> -<!--l. 880--><p class="noindent" ><a +<!--l. 1064--><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. 883--><p class="noindent" >Take care if you use the <span +<!--l. 1067--><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 @@ -1895,11 +2097,11 @@ class="cmss-10">hyperref</span><a </p> - <div class="verbatim" id="verbatim-44"> + <div class="verbatim" id="verbatim-48"> \usepackage[colorlinks]{hyperref}  <br />\usepackage{glossaries} </div> -<!--l. 890--><p class="nopar" > If you use <span +<!--l. 1074--><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 @@ -1908,16 +2110,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. 897--><p class="indent" > By default, if the <span +</p><!--l. 1081--><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 don’t want this to happen for -<span -class="cmti-10">all </span>your glossaries, then use -</p><!--l. 902--><p class="indent" > <hr><div title="Definition"><span +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. 1086--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsdisablehyper </span></div><hr> -</p><!--l. 903--><p class="noindent" > +</p><!--l. 1087--><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 @@ -1930,13 +2132,13 @@ glossary, then do: </p> - <div class="verbatim" id="verbatim-45"> + <div class="verbatim" id="verbatim-49"> \usepackage[colorlinks]{hyperref}  <br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} </div> -<!--l. 913--><p class="nopar" > -</p><!--l. 915--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want +<!--l. 1097--><p class="nopar" > +</p><!--l. 1099--><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: @@ -1944,12 +2146,12 @@ option: </p> - <div class="verbatim" id="verbatim-46"> + <div class="verbatim" id="verbatim-50"> \usepackage[colorlinks]{hyperref}  <br />\usepackage[hyperfirst=false]{glossaries} </div> -<!--l. 921--><p class="nopar" > -</p><!--l. 923--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This +<!--l. 1105--><p class="nopar" > +</p><!--l. 1107--><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. @@ -1967,49 +2169,49 @@ class="cmtt-10">\texorpdfstring</span>. For example: </p> - <div class="verbatim" id="verbatim-47"> + <div class="verbatim" id="verbatim-51"> \section{The \texorpdfstring{\gls{fishage}}{Fish Age}} </div> -<!--l. 931--><p class="nopar" > However, it’s not a good idea to use commands like <span +<!--l. 1115--><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. 936--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 1120--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsentrytext{</span><span class="cmmi-10"><</span><span class="cmitt-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 937--><p class="noindent" > +</p><!--l. 1121--><p class="noindent" > This is expandable provided that the <span -class="cmtt-10">text </span>key doesn’t containing non-expandable code. +class="cmtt-10">text </span>key doesn’t contain non-expandable code. For example, the following works: </p> - <div class="verbatim" id="verbatim-48"> + <div class="verbatim" id="verbatim-52"> \section{The \glsentrytext{fishage}} </div> -<!--l. 942--><p class="nopar" > and it doesn’t put the table of contents in the location list. -</p><!--l. 945--><p class="noindent" > +<!--l. 1126--><p class="nopar" > and it doesn’t put the table of contents in the location list. +</p><!--l. 1129--><p class="noindent" > </p> -<!--l. 945--><p class="noindent" ><a +<!--l. 1129--><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. 948--><p class="noindent" >You can add a reference to another entry in a location list using the <span +<!--l. 1132--><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="cmmi-10"><</span><span class="cmti-10">label</span><span class="cmmi-10">></span><span class="cmtt-10">}</span> key when you define an entry. The referenced entry must also be defined. -</p><!--l. 952--><p class="indent" > For example: +</p><!--l. 1136--><p class="indent" > For example: </p> - <div class="verbatim" id="verbatim-49"> + <div class="verbatim" id="verbatim-53"> \longnewglossaryentry{devonian}{name={Devonian}}%  <br />{%  <br />  The geologic period spanning from the end of the @@ -2024,7 +2226,7 @@ key when you define an entry. The referenced entry must also be defined.  <br />  see={devonian}  <br />} </div> -<!--l. 969--><p class="nopar" > The cross-reference will appear as “<span +<!--l. 1153--><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 @@ -2039,7 +2241,7 @@ class="cmmi-10">></span>. For example: </p> - <div class="verbatim" id="verbatim-50"> + <div class="verbatim" id="verbatim-54"> \newglossaryentry{latinalph}  <br />{  <br />  name={Latin alphabet}, @@ -2054,7 +2256,7 @@ class="cmmi-10">></span>. For example:  <br />   other letters such as ligatures or diacritics.}  <br />} </div> -<!--l. 987--><p class="nopar" > If you use the <span +<!--l. 1171--><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: @@ -2062,32 +2264,37 @@ enclose the value in braces. For example: </p> - <div class="verbatim" id="verbatim-51"> + <div class="verbatim" id="verbatim-55"> \newacronym{ksvm}{ksvm}{kernel support vector machine}  <br />\newacronym  <br /> [see={[see also]{ksvm}}]  <br /> {svm}{svm}{support vector machine} </div> -<!--l. 996--><p class="nopar" > -</p><!--l. 998--><p class="noindent" > +<!--l. 1180--><p class="nopar" > +</p><!--l. 1182--><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. 1186--><p class="noindent" > </p> -<!--l. 998--><p class="noindent" ><a +<!--l. 1186--><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. 1001--><p class="noindent" >Further information can be found in the main <span +<!--l. 1189--><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> and there is also -an <a +href="glossaries-user.html" >user manual</a> or in the <a +href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries +FAQ</a>. There is also an <a href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries package</a> on the <a href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> Community’s</a> Know How section -and a chapter on the <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-10002"></a> package in <a href="http://www.dickimaw-books.com/latex/thesis/" >Using <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> to Write a PhD Thesis</a>. -</p> +class="E">E</span>X</span></span> to Write a +PhD Thesis</a>. </p> </body></html> |