diff options
author | Karl Berry <karl@freefriends.org> | 2012-05-21 23:39:22 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-05-21 23:39:22 +0000 |
commit | 18d3ed873290d987fea4820b83615c3f35c44770 (patch) | |
tree | e8bcd6aed2fe7e4915136f79f257a8c0abf94215 /Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | |
parent | dcf30bb52ae0db1fc2f0bef28179723d65e23618 (diff) |
glossaries 3.02 (21may12)
git-svn-id: svn://tug.org/texlive/trunk@26547 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | 710 |
1 files changed, 347 insertions, 363 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 0aad1ee76de..6902c2084ef 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -1,35 +1,41 @@ -<a - id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!--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> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> <meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> -<!-- xhtml,fn-in,css-in --> +<!-- xhtml,fn-in,css-in,uni-html4,utf8 --> <meta name="src" content="glossariesbegin.tex" /> -<meta name="date" content="2011-04-13 19:40:00" /> +<meta name="date" content="2012-05-21 14:51:00" /> <style type="text/css"> <!-- /* start css.sty */ -.cmr-17{font-size:170%;} -.cmr-12{font-size:120%;} -.cmr-9{font-size:90%;} -.cmbx-9{font-size:90%; font-weight: bold;} -.cmss-9{font-size:90%; font-family: sans-serif;} -.cmss-9{ font-family: sans-serif;} -.cmtt-10{font-family: monospace;} -.cmtt-10{font-family: monospace;} -.cmss-10{ font-family: sans-serif;} -.cmss-10{ font-family: sans-serif;} -.cmtt-9{font-size:90%;font-family: monospace;} -.cmtt-9{font-family: monospace;} -.cmti-10{ font-style: italic;} +.futr8t-x-x-109{} +.ecss-1095{ font-family: sans-serif;} +.ecss-1095{ font-family: sans-serif;} +.ecss-1095{ font-family: sans-serif;} +.ecss-1095{ font-family: sans-serif;} +.ecsx-2074{font-size:181%; font-weight: bold;} +.ecsx-2074{ font-weight: bold;} +.ecsx-2074{ font-weight: bold;} +.ecsx-2074{ font-weight: bold;} +.futr8t-x-x-144{font-size:130%;} +.ectt-1095{ font-family: monospace;} +.ectt-1095{ font-family: monospace;} +.ectt-1095{ font-family: monospace;} +.ectt-1095{ font-family: monospace;} +.ectt-1000{font-size:90%; font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.futri8t-x-x-109{} +.futsy-x-x-109{} p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -138,6 +144,7 @@ div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } .quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } .abstract p {margin-left:5%; margin-right:5%;} div.abstract {width:100%;} +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } div.important { background-color:red; } /* end css.sty */ @@ -147,335 +154,319 @@ div.important { background-color:red; } </style> </head><body > - <div class="maketitle"> + <div class="maketitle"> - - +<div class="minipage"><a + id="top"></a> +</div> -<h2 class="titleHead">The glossaries package: a guide for beginners</h2> +<h2 class="titleHead">The glossaries package: a guide for +beginners</h2> <div class="author" ><span -class="cmr-12">Nicola L.C. Talbot</span></div><br /> +class="futr8t-x-x-144">Nicola L.C. Talbot</span></div><br /> <div class="date" ><span -class="cmr-12">2011-04-12</span></div> - </div> - <div +class="futr8t-x-x-144">2012-05-21</span></div> + </div> + <div class="abstract" > -<div class="center" -> -<!--l. 26--><p class="noindent" > -</p><!--l. 26--><p class="noindent" ><span -class="cmbx-9">Abstract</span></p></div> - <!--l. 27--><p class="indent" > <span -class="cmr-9">This document is a brief guide to the </span><span -class="cmss-9">glossaries </span><span -class="cmr-9">package for beginners who</span> - <span -class="cmr-9">find the size of the main user manual daunting and, as such, it only covers</span> - <span -class="cmr-9">the basics. For more advanced topics, see the </span><a -href="glossaries-user.html" ><span -class="cmr-9">main user manual</span></a><span -class="cmr-9">.</span> + <!--l. 27--><p class="indent" > This document is a brief guide to the <span +class="ecss-1095">glossaries </span>package for + beginners who + as such, it only covers the basics. For more advanced topics, see the + <a +href="glossaries-user.html" >main user manual</a>. </p> </div> - <h3 class="likesectionHead"><a + <h3 class="likesectionHead"><a id="x1-1000"></a>Contents</h3> - <div class="tableofcontents"> - <span class="sectionToc" >1 <a + <div class="tableofcontents"> + <span class="sectionToc" >1 <a href="#x1-20001" id="QQ2-1-2">What Do I Need?</a></span> -<br /> <span class="sectionToc" >2 <a +<br /> <span class="sectionToc" >2 <a href="#x1-30002" id="QQ2-1-3">Getting Started</a></span> -<br /> <span class="sectionToc" >3 <a -href="#x1-40003" id="QQ2-1-4">Defining a Term or Symbol</a></span> -<br /> <span class="sectionToc" >4 <a +<br /> <span class="sectionToc" >3 <a +href="#x1-40003" id="QQ2-1-4">De +<br /> <span class="sectionToc" >4 <a href="#x1-50004" id="QQ2-1-5">Using a Term</a></span> -<br /> <span class="sectionToc" >5 <a +<br /> <span class="sectionToc" >5 <a href="#x1-60005" id="QQ2-1-6">Acronyms</a></span> -<br /> <span class="sectionToc" >6 <a +<br /> <span class="sectionToc" >6 <a href="#x1-70006" id="QQ2-1-7">Displaying the Glossary or List of Acronyms</a></span> - </div> + </div> - <!--l. 35--><p class="noindent" > </p> - <h3 class="sectionHead"><span class="titlemark">1 </span> <a + <h3 class="sectionHead"><span class="titlemark">1 </span> <a id="x1-20001"></a>What Do I Need?</h3> <!--l. 38--><p class="noindent" >You need to have the <span -class="cmss-10">glossaries </span>package installed. You also need to have the following +class="ecss-1095">glossaries </span>package installed. You also need to have the following packages installed: <span -class="cmss-10">ifthen</span><a +class="ecss-1095">ifthen</span><a id="dx1-2001"></a>, <span -class="cmss-10">xkeyval</span><a +class="ecss-1095">xkeyval</span><a id="dx1-2002"></a> (at least version 2.5f), <span -class="cmss-10">xfor</span><a +class="ecss-1095">xfor</span><a id="dx1-2003"></a>, <span -class="cmss-10">amsgen</span><a +class="ecss-1095">amsgen</span><a id="dx1-2004"></a> and <span -class="cmss-10">etoolbox</span><a - id="dx1-2005"></a>. You -may also need <span -class="cmss-10">longtable</span><a +class="ecss-1095">etoolbox</span><a + id="dx1-2005"></a>. +You may also need <span +class="ecss-1095">longtable</span><a id="dx1-2006"></a>, <span -class="cmss-10">supertabular</span><a - id="dx1-2007"></a> and <span -class="cmss-10">array</span><a - id="dx1-2008"></a>, depending on what glossary style you -want to use. All these packages can be downloaded from CTAN if you don’t -have them installed. See <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings" >“Installing things on a (La)TeX System”</a> for further +class="ecss-1095">supertabular</span><a + id="dx1-2007"></a>, <span +class="ecss-1095">array</span><a + id="dx1-2008"></a> or <span +class="ecss-1095">multicol</span><a + id="dx1-2009"></a>, depending on what +glossary style you want to use. All these packages can be downloaded from CTAN if +you don't have them installed. See <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings" > assistance. -</p><!--l. 49--><p class="indent" > In addition, you need an indexing application. The <span -class="cmss-10">glossaries</span><a - id="dx1-2009"></a> package is configured to -use either <span -class="cmtt-10">makeindex</span><a - id="dx1-2010"></a> or <span -class="cmtt-10">xindy</span><a - id="dx1-2011"></a>. <span -class="cmtt-10">Makeindex</span><a - id="dx1-2012"></a> should be available on all <span class="TEX">T<span -class="E">E</span>X</span> systems. It’s -possible you may not have <span -class="cmtt-10">xindy</span><a - id="dx1-2013"></a> installed, but it can be downloaded from the <a -href="http://www.xindy.org/" >xindy -home page</a>. MiKTeX users may find the <a -href="http://www.latex-community.org/forum/viewtopic.php?f=51&t=5383" >Xindy for MiKTeX</a> thread on the LaTeX -Community Forum helpful. -</p><!--l. 57--><p class="indent" > The <span -class="cmss-10">glossaries</span><a - id="dx1-2014"></a> package provides a helper Perl script called <span -class="cmtt-10">makeglossaries</span><a - id="dx1-2015"></a> which +</p><!--l. 49--><p class="indent" > In addition, you need an indexing application. The <span +class="ecss-1095">glossaries</span><a + id="dx1-2010"></a> package is con +to use either <span +class="ectt-1095">makeindex</span><a + id="dx1-2011"></a> or <span +class="ectt-1095">xindy</span><a + id="dx1-2012"></a>. <span +class="ectt-1095">Makeindex</span><a + id="dx1-2013"></a> should be available on all +<span class="TEX">T<span +class="E">E</span>X</span> systems. It's possible you may not have <span +class="ectt-1095">xindy</span><a + id="dx1-2014"></a> installed, but it can be +downloaded from the <a +href="http://www.xindy.org/" >xindy home page</a>. MiKTeX users may +href="http://www.latex-community.org/forum/viewtopic.php?f=51&t=5383" >Xindy for MiKTeX</a> +thread on the LaTeX Community Forum helpful. +</p><!--l. 57--><p class="indent" > The <span +class="ecss-1095">glossaries</span><a + id="dx1-2015"></a> package provides a helper Perl script called <span +class="ectt-1095">makeglossaries</span><a + id="dx1-2016"></a> which will act as an interface to <span -class="cmtt-10">makeindex</span><a - id="dx1-2016"></a> or <span -class="cmtt-10">xindy</span><a - id="dx1-2017"></a>. If you want to use <span -class="cmtt-10">makeglossaries</span><a - id="dx1-2018"></a> or -<span -class="cmtt-10">xindy</span><a - id="dx1-2019"></a>, you need to have Perl installed. If you don’t have Perl installed, you can still use +class="ectt-1095">makeindex</span><a + id="dx1-2017"></a> or <span +class="ectt-1095">xindy</span><a + id="dx1-2018"></a>. If you want to use <span +class="ectt-1095">makeglossaries</span><a + id="dx1-2019"></a> or <span -class="cmss-10">glossaries </span>but you can only use it with <span -class="cmtt-10">makeindex</span><a - id="dx1-2020"></a>. +class="ectt-1095">xindy</span><a + id="dx1-2020"></a>, you need to have Perl installed. If you don't have Perl installed, you can still +use <span +class="ecss-1095">glossaries </span>but you can only use it with <span +class="ectt-1095">makeindex</span><a + id="dx1-2021"></a>. </p><!--l. 64--><p class="noindent" > </p> <!--l. 64--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a id="x1-30002"></a>Getting Started</h3> <!--l. 67--><p class="noindent" >The most obvious things to do is to remember to load the <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-3001"></a> package: - </p> - <div class="verbatim" id="verbatim-1"> + <div class="verbatim" id="verbatim-1"> \usepackage{glossaries} </div> <!--l. 71--><p class="nopar" > -</p><!--l. 72--><p class="indent" > <div class="important" title="Important Note"> Note that the <span -class="cmss-10">glossaries </span>package must be loaded <span -class="cmti-10">after </span>the <span -class="cmss-10">hyperref</span><a +</p><!--l. 72--><p class="indent" > <div class="important" title="Important Note"> Note that the <span +class="ecss-1095">glossaries </span>package must be loaded <span +class="futri8t-x-x-109">after </span>the <span +class="ecss-1095">hyperref</span><a id="dx1-3002"></a> package (contrary to the general advice that <span -class="cmss-10">hyperref</span><a - id="dx1-3003"></a> should be loaded last). The <span -class="cmss-10">glossaries</span><a - id="dx1-3004"></a> -package should also be loaded after <span -class="cmss-10">html</span><a +class="ecss-1095">hyperref</span><a + id="dx1-3003"></a> should be loaded last). The +<span +class="ecss-1095">glossaries</span><a + id="dx1-3004"></a> package should also be loaded after <span +class="ecss-1095">html</span><a id="dx1-3005"></a>, <span -class="cmss-10">inputenc</span><a +class="ecss-1095">inputenc</span><a id="dx1-3006"></a>, <span -class="cmss-10">babel</span><a +class="ecss-1095">babel</span><a id="dx1-3007"></a> and <span -class="cmss-10">ngerman</span><a - id="dx1-3008"></a>. </div> +class="ecss-1095">ngerman</span><a + id="dx1-3008"></a>. +</div> </p><!--l. 78--><p class="noindent" > -</p><!--l. 80--><p class="indent" > If you want to use <span -class="cmtt-10">xindy</span><a +</p><!--l. 80--><p class="indent" > If you want to use <span +class="ectt-1095">xindy</span><a id="dx1-3009"></a> rather than <span -class="cmtt-10">makeindex</span><a +class="ectt-1095">makeindex</span><a id="dx1-3010"></a> to sort the glossaries, you need to specify this in the package options: - </p> - <div class="verbatim" id="verbatim-2"> + <div class="verbatim" id="verbatim-2"> \usepackage[xindy]{glossaries} </div> <!--l. 84--><p class="nopar" > Other package options are described in <a href="glossaries-user.html#sec:pkgopts" >Package Options</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-3011"></a> user manual. -</p><!--l. 89--><p class="indent" > Next, you need to enable the creation of the various external files that are required +</p><!--l. 89--><p class="indent" > Next, you need to enable the creation of the various external by the indexing application. This is done using: -</p><!--l. 92--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\makeglossaries </span></div><hr> +</p><!--l. 92--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\makeglossaries </span></div><hr> </p><!--l. 93--><p class="noindent" > </p><!--l. 95--><p class="noindent" > </p> <!--l. 95--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a - id="x1-40003"></a>Defining a Term or Symbol</h3> -<!--l. 98--><p class="noindent" >You must define terms or symbols before you can use them in the document. This is -best done in the preamble. Each term is defined using: -</p><!--l. 102--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\newglossaryentry{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">}{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">settings</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-40003"></a>De +<!--l. 98--><p class="noindent" >You must de +best done in the preamble. Each term is de +</p><!--l. 102--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\newglossaryentry{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">}{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">settings</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 103--><p class="noindent" > where <span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩ </span>is a unique label used to identify the term. The second argument, +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i </span>is a unique label used to identify the term. The second argument, <span -class="cmsy-10">⟨</span><span -class="cmti-10">settings</span><span -class="cmsy-10">⟩</span>, is a key=value comma separated list that is used to set the required +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">settings</span><span +class="futsy-x-x-109">i</span>, is a key=value comma separated list that is used to set the required information for the term. A full list of available keys can be found in <a -href="glossaries-user.html#sec:newglosentry" >Defining Glossary -Entries</a> in the main <span -class="cmss-10">glossaries</span><a +href="glossaries-user.html#sec:newglosentry" >De +Glossary Entries</a> in the main <span +class="ecss-1095">glossaries</span><a id="dx1-4001"></a> user manual. The principle keys are <span -class="cmss-10">name</span><a +class="ecss-1095">name</span><a id="dx1-4002"></a> and <span -class="cmss-10">description</span><a +class="ecss-1095">description</span><a id="dx1-4003"></a>. -</p><!--l. 113--><p class="indent" > For example, to define the term “electrolyte”: +</p><!--l. 113--><p class="indent" > For example, to de - </p> - <div class="verbatim" id="verbatim-3"> + <div class="verbatim" id="verbatim-3"> \newglossaryentry{electrolyte}{name=electrolyte,  <br />description={solution able to conduct electric current}} </div> <!--l. 117--><p class="nopar" > In the above example, the label and the name happen to be the same. In the next -example, the name contains a ligature but the label doesn’t: +example, the name contains a ligature but the label doesn't: - </p> - <div class="verbatim" id="verbatim-4"> + <div class="verbatim" id="verbatim-4"> \newglossaryentry{oesophagus}{name=\oe sophagus,  <br />description={canal from mouth to stomach},  <br />plural=\oe sophagi} </div> <!--l. 125--><p class="nopar" > In this case the label is <span -class="cmtt-10">oesophagus</span>. Note that in this case, the plural has to be -specified using the <span -class="cmss-10">plural</span><a - id="dx1-4004"></a> key since it isn’t formed by simply appending the letter -“s”. -</p><!--l. 130--><p class="indent" > When you define terms, it is important to remember that they will be sorted by an -external application that doesn’t interpret <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="ectt-1095">oesophagus</span>. Note that in this case, the plural has to be +speci +class="ecss-1095">plural</span><a + id="dx1-4004"></a> key since it isn't formed by simply appending the letter + +</p><!--l. 130--><p class="indent" > When you de +external application that doesn't interpret <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> commands. <span -class="cmtt-10">Xindy</span><a +class="ectt-1095">Xindy</span><a id="dx1-4005"></a> is a little more <span class="TEX">T<span class="E">E</span>X</span>-aware than <span -class="cmtt-10">makeindex</span><a +class="ectt-1095">makeindex</span><a id="dx1-4006"></a>, but for this example they will both mis-sort <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\oe</span><span -class="cmtt-10"> sophagus</span></span></span>. Xindy will ignore the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\oe␣</span></span></span> part and will sort it according to <span -class="cmtt-10">sophagus</span>, -so it will be placed with the terms starting with an “s”. <span -class="cmtt-10">Makeindex</span><a - id="dx1-4007"></a>, on the other hand, -will sort it according to <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\oe␣sophagus</span></span></span> which starts with a symbol (the backslash), so it -will end up in the symbol group. You therefore need to specify how to sort the -term: +class="ectt-1095">\oe</span><span +class="ectt-1095"> sophagus</span></span></span>. Xindy will ignore the <span class="obeylines-h"><span class="verb"><span +class="ectt-1095">\oe␣</span></span></span> part and will sort it according to +<span +class="ectt-1095">sophagus</span>, so it will be placed with the terms starting with an +class="ectt-1095">Makeindex</span><a + id="dx1-4007"></a>, on the +other hand, will sort it according to <span class="obeylines-h"><span class="verb"><span +class="ectt-1095">\oe␣sophagus</span></span></span> which starts with a symbol (the +backslash), so it will end up in the symbol group. You therefore need to specify how +to sort the term: - </p> - <div class="verbatim" id="verbatim-5"> + <div class="verbatim" id="verbatim-5"> \newglossaryentry{oesophagus}{name=\oe sophagus,  <br />description={canal from mouth to stomach},  <br />plural=\oe sophagi,  <br />sort=oesophagus} </div> <!--l. 145--><p class="nopar" > Note, however, that if you use the <span -class="cmss-10">inputenc</span><a +class="ecss-1095">inputenc</span><a id="dx1-4008"></a> package and <span -class="cmtt-10">xindy</span><a +class="ectt-1095">xindy</span><a id="dx1-4009"></a>, you can use the encoded character <span -class="cmtt-10">œ </span>rather than <span -class="cmtt-10">\oe </span>and <span -class="cmtt-10">xindy</span><a +class="ectt-1095">œ </span>rather than <span +class="ectt-1095">\oe </span>and <span +class="ectt-1095">xindy</span><a id="dx1-4010"></a> will sort it correctly: - </p> - <div class="verbatim" id="verbatim-6"> + <div class="verbatim" id="verbatim-6"> \newglossaryentry{oesophagus}{name=œsophagus,  <br />description={canal from mouth to stomach},  <br />plural=œsophagi} </div> <!--l. 153--><p class="nopar" > -</p><!--l. 155--><p class="indent" > If the name starts with an accented character, the first character must be +</p><!--l. 155--><p class="indent" > If the name starts with an accented character, the grouped: - </p> - <div class="verbatim" id="verbatim-7"> + <div class="verbatim" id="verbatim-7"> \newglossaryentry{elite}{name={\’e}lite,  <br />description={select group of people},  <br />sort=elite} </div> <!--l. 161--><p class="nopar" > or - </p> - <div class="verbatim" id="verbatim-8"> + <div class="verbatim" id="verbatim-8"> \newglossaryentry{elite}{name={é}lite,  <br />description={select group of people}} </div> <!--l. 166--><p class="nopar" > -</p><!--l. 168--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For +</p><!--l. 168--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For example: - </p> - <div class="verbatim" id="verbatim-9"> + <div class="verbatim" id="verbatim-9"> \newglossaryentry{pi}{name={\ensuremath{\pi}},  <br />description={ratio of circumference of circle to its  <br />diameter},sort=pi} </div> -<!--l. 174--><p class="nopar" > It’s also possible to have a name and a symbol. For example: +<!--l. 174--><p class="nopar" > It's also possible to have a name and a symbol. For example: - </p> - <div class="verbatim" id="verbatim-10"> + <div class="verbatim" id="verbatim-10"> \newglossaryentry{set}{name=set,  <br />description={a collection of objects},  <br />symbol={\ensuremath{\mathcal{S}}}} @@ -484,219 +475,215 @@ example: </p><!--l. 184--><p class="noindent" > </p> <!--l. 184--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="x1-50004"></a>Using a Term</h3> -<!--l. 187--><p class="noindent" >Once you have defined a term, you can use it in the document. The <span -class="cmss-10">glossaries</span><a +<!--l. 187--><p class="noindent" >Once you have de +class="ecss-1095">glossaries</span><a id="dx1-5001"></a> package provides a number of commands that are described in <a href="glossaries-user.html#sec:glslink" >Links to Glossary Entries</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-5002"></a> user manual. Here, I shall just cover the main commands: -</p><!--l. 193--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\gls{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 193--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\gls{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 194--><p class="noindent" > This prints the term associated with <span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span>. Using the example in the previous section, -<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{oesophagus}</span></span></span> will display œsophagus. If the <span -class="cmss-10">hyperref</span><a +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span>. Using the example in the previous +section, <span class="obeylines-h"><span class="verb"><span +class="ectt-1095">\gls{oesophagus}</span></span></span> will display +class="ecss-1095">hyperref</span><a id="dx1-5003"></a> package has also been loaded, the term will also be hyperlinked to the relevant entry in the glossary. -</p><!--l. 201--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\glspl{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 201--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\glspl{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 202--><p class="noindent" > This prints the plural of the term associated with <span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span>, so <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glspl{oesophagus}</span></span></span> will -display œsophagi. Again, the text will be a hyperlink to the relevant entry in the -glossary, if hyperlinks are defined. -</p><!--l. 208--><p class="indent" > There are also versions that convert the first character to upper case if you need to +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span>, so <span class="obeylines-h"><span class="verb"><span +class="ectt-1095">\glspl{oesophagus}</span></span></span> +will display +glossary, if hyperlinks are de +</p><!--l. 208--><p class="indent" > There are also versions that convert the start a sentence with a term: -</p><!--l. 211--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\Gls{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 211--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\Gls{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 212--><p class="noindent" > and -</p><!--l. 215--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\Glspl{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 215--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\Glspl{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 216--><p class="noindent" > For example: - </p> - <div class="verbatim" id="verbatim-11"> + <div class="verbatim" id="verbatim-11"> \Glspl{electrolyte} usually exist as solutions of salts,  <br />bases or acids. </div> <!--l. 221--><p class="nopar" > -</p><!--l. 223--><p class="indent" > Note that these commands all have two optional arguments that aren’t discussed +</p><!--l. 223--><p class="indent" > Note that these commands all have two optional arguments that aren't discussed here, but they are described in <a href="glossaries-user.html#sec:glslink" >Links to Glossary Entries</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-5004"></a> user manual. -</p><!--l. 228--><p class="indent" > <div class="important" title="Important Note"> Don’t use these commands in moving arguments, such as those used by <span -class="cmtt-10">\chapter</span>, +</p><!--l. 228--><p class="indent" > <div class="important" title="Important Note"> Don't use these commands in moving arguments, such as those used by <span -class="cmtt-10">\section </span>and <span -class="cmtt-10">\caption</span>. </div> +class="ectt-1095">\chapter</span>, <span +class="ectt-1095">\section </span>and <span +class="ectt-1095">\caption</span>. </div> </p><!--l. 231--><p class="noindent" > You can, instead, use commands such as -</p><!--l. 234--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\glsentrytext{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 234--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\glsentrytext{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 235--><p class="noindent" > See <a href="glossaries-user.html#sec:glsnolink" >Using Glossary Terms Without Links</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-5005"></a> user manual. </p><!--l. 239--><p class="noindent" > </p> <!--l. 239--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a id="x1-60005"></a>Acronyms</h3> <!--l. 242--><p class="noindent" >The <span -class="cmss-10">glossaries</span><a - id="dx1-6001"></a> package also allows you to define acronyms. By default, acronyms will be -added to the main glossary, but if you use the <span -class="cmss-10">acronym</span><a - id="dx1-6002"></a> package option, acronyms will -be placed in a separate list of acronyms: +class="ecss-1095">glossaries</span><a + id="dx1-6001"></a> package also allows you to de +be added to the main glossary, but if you use the <span +class="ecss-1095">acronym</span><a + id="dx1-6002"></a> package option, acronyms +will be placed in a separate list of acronyms: - </p> - <div class="verbatim" id="verbatim-12"> + <div class="verbatim" id="verbatim-12"> \usepackage[acronym]{glossaries} </div> <!--l. 248--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see <a href="glossaries-user.html#sec:acronyms" >Acronyms</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-6003"></a> user manual. -</p><!--l. 253--><p class="indent" > Acronyms must be defined before use and are defined using: -</p><!--l. 255--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\newacronym{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">}{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">abbrv</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">}{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">full</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 253--><p class="indent" > Acronyms must be de +</p><!--l. 255--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\newacronym{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">}{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">abbrv</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">}{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">full</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 256--><p class="noindent" > where <span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩ </span>is the label identifying the acronym, <span -class="cmsy-10">⟨</span><span -class="cmti-10">abbrv</span><span -class="cmsy-10">⟩ </span>is the abbreviated form and -<span -class="cmsy-10">⟨</span><span -class="cmti-10">full</span><span -class="cmsy-10">⟩ </span>is the fully expanded text. For example: +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i </span>is the label identifying the acronym, <span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">abbrv</span><span +class="futsy-x-x-109">i </span>is the abbreviated form +and <span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">full</span><span +class="futsy-x-x-109">i </span>is the fully expanded text. For example: - </p> - <div class="verbatim" id="verbatim-13"> + <div class="verbatim" id="verbatim-13"> \newacronym{label}{svm}{support vector machine} </div> <!--l. 262--><p class="nopar" > -</p><!--l. 264--><p class="indent" > Once the acronym is defined, it can be used in the same way as any other glossary +</p><!--l. 264--><p class="indent" > Once the acronym is de term with commands such as <span -class="cmtt-10">\gls </span>and <span -class="cmtt-10">\glspl</span>. On first use, the default will display +class="ectt-1095">\gls </span>and <span +class="ectt-1095">\glspl</span>. On <span -class="cmsy-10">⟨</span><span -class="cmti-10">full</span><span -class="cmsy-10">⟩ </span>(<span -class="cmsy-10">⟨</span><span -class="cmti-10">abbrv</span><span -class="cmsy-10">⟩</span>). On subsequent use, only the abbreviation will appear. For +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">full</span><span +class="futsy-x-x-109">i </span>(<span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">abbrv</span><span +class="futsy-x-x-109">i</span>). On subsequent use, only the abbreviation will appear. For example: - </p> - <div class="verbatim" id="verbatim-14"> + <div class="verbatim" id="verbatim-14"> A \gls{svm} was implemented. </div> -<!--l. 271--><p class="nopar" > If this is the first time this term has been used, the above would produce: +<!--l. 271--><p class="nopar" > If this is the <spacer type=vertical size=10><span class="obeylines-h"> - <br />A support vector machine (svm) was implemented. - <br /><spacer type=vertical size=10></span> + <br />A support vector machine (svm) was implemented. + <br /><spacer type=vertical size=10></span> otherwise it would produce: <spacer type=vertical size=10><span class="obeylines-h"> - <br />A svm was implemented. - <br /><spacer type=vertical size=10></span> + <br />A svm was implemented. + <br /><spacer type=vertical size=10></span> You can reset an acronym so that the next use fully expands it again using: -</p><!--l. 284--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\glsreset{</span><span -class="cmsy-10">⟨</span><span -class="cmti-10">label</span><span -class="cmsy-10">⟩</span><span -class="cmtt-10">} </span></div><hr> +</p><!--l. 284--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\glsreset{</span><span +class="futsy-x-x-109">h</span><span +class="futri8t-x-x-109">label</span><span +class="futsy-x-x-109">i</span><span +class="ectt-1095">} </span></div><hr> </p><!--l. 285--><p class="noindent" > or you can reset all acronyms using -</p><!--l. 288--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\glsresetall </span></div><hr> +</p><!--l. 288--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\glsresetall </span></div><hr> </p><!--l. 289--><p class="noindent" > For further details on resetting and unsetting acronyms, see <a href="glossaries-user.html#sec:glsunset" >Unsetting and Resetting Entry Flags</a> in the main <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-6004"></a> user manual. </p><!--l. 295--><p class="noindent" > </p> <!--l. 295--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a id="x1-70006"></a>Displaying the Glossary or List of Acronyms</h3> -<!--l. 298--><p class="noindent" >In order to display the sorted list of terms, you first need to use -</p><!--l. 301--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\printglossaries </span></div><hr> +<!--l. 298--><p class="noindent" >In order to display the sorted list of terms, you +</p><!--l. 301--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1095">\printglossaries </span></div><hr> </p><!--l. 302--><p class="noindent" > at the place where you want the glossary and list of acronyms to appear. Note that <span -class="cmtt-10">\printglossaries </span>won’t produce any text the first time you create your document, +class="ectt-1095">\printglossaries </span>won't produce any text the as an external indexing application needs to be used to sort and collate the entries. Creating the completed document is therefore <span -class="cmti-10">at least </span>a three step +class="futri8t-x-x-109">at least </span>a three step process. -</p><!--l. 310--><p class="indent" > Suppose your document is called <span -class="cmtt-10">myDoc.tex</span>, then you need to: +</p><!--l. 310--><p class="indent" > Suppose your document is called <span +class="ectt-1095">myDoc.tex</span>, then you need to: </p><ol class="enumerate1" > <li class="enumerate" id="x1-7002x1">Build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span @@ -704,7 +691,6 @@ class="E">E</span>X</span></span> your document, either by clicking on an your front-end/text editor or by typing the following at a terminal/command prompt: - <div class="verbatim" id="verbatim-15"> latex myDoc @@ -712,41 +698,40 @@ class="E">E</span>X</span></span> your document, either by clicking on an <!--l. 318--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by the <span -class="cmss-10">glossaries</span><a + class="enumerate" id="x1-7004x2">Run the indexing application on the external +class="ecss-1095">glossaries</span><a id="dx1-7005"></a> package. If you have used the <span -class="cmss-10">xindy</span><a +class="ecss-1095">xindy</span><a id="dx1-7006"></a> package option, you must use <span -class="cmtt-10">xindy</span><a +class="ectt-1095">xindy</span><a id="dx1-7007"></a>, otherwise you must use <span -class="cmtt-10">makeindex</span><a +class="ectt-1095">makeindex</span><a id="dx1-7008"></a>. The <span -class="cmss-10">glossaries</span><a +class="ecss-1095">glossaries</span><a id="dx1-7009"></a> package comes with a convenient Perl wrapper that calls the appropriate indexing application the - required number of times with the required options. If you have Perl installed, all - you need to do is type + required number of times with the required options. If you have Perl installed, + all you need to do is type - <div class="verbatim" id="verbatim-16"> makeglossaries myDoc </div> - <!--l. 329--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as WinEdt - or TeXnicCenter) and you want it to automatically run makeglossaries - when you build your document, you will need to consult the front-end’s + <!--l. 329--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as + WinEdt or TeXnicCenter) and you want it to automatically run makeglossaries + when you build your document, you will need to consult the front-end's documentation. - </p><!--l. 335--><p class="noindent" >If you don’t have Perl installed, you will need to call <span -class="cmtt-10">makeindex</span><a + </p><!--l. 335--><p class="noindent" >If you don't have Perl installed, you will need to call <span +class="ectt-1095">makeindex</span><a id="dx1-7010"></a> or <span -class="cmtt-10">xindy</span><a +class="ectt-1095">xindy</span><a id="dx1-7011"></a> explicitly. This is more complicated and is described in <a -href="glossaries-user.html#sec:makeglossaries" >Generating the Associated - Glossary Files</a> in the main <span -class="cmss-10">glossaries</span><a +href="glossaries-user.html#sec:makeglossaries" >Generating the + Associated Glossary Files</a> in the main <span +class="ecss-1095">glossaries</span><a id="dx1-7012"></a> user manual. </p></li> <li @@ -754,36 +739,35 @@ class="cmss-10">glossaries</span><a build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> your document again (see step 1).</li></ol> <!--l. 344--><p class="noindent" >Note that sometimes you may have to repeat steps 2 and 3. -</p><!--l. 346--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default +</p><!--l. 346--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default style uses the <span -class="cmss-10">description</span><a +class="ecss-1095">description</span><a id="dx1-7015"></a><a - id="dx1-7016"></a> environment, but there are many other styles available. These -are described in <a + id="dx1-7016"></a> environment, but there are many other styles available. +These are described in <a href="glossaries-user.html#sec:styles" >Glossary Styles</a> in the main <span -class="cmss-10">glossaries</span><a - id="dx1-7017"></a> user manual. By default, a -number or list of numbers will appear after each entry in the glossary. This indicates -the page (or pages) on which the term was used. This list can be suppressed using the -<span -class="cmss-10">nonumberlist</span><a +class="ecss-1095">glossaries</span><a + id="dx1-7017"></a> user manual. By default, +a number or list of numbers will appear after each entry in the glossary. This +indicates the page (or pages) on which the term was used. This list can be suppressed +using the <span +class="ecss-1095">nonumberlist</span><a id="dx1-7018"></a> package option: - </p> - <div class="verbatim" id="verbatim-17"> + <div class="verbatim" id="verbatim-17"> \usepackage[nonumberlist]{glossaries} </div> <!--l. 357--><p class="nopar" > -</p><!--l. 359--><p class="indent" > Further information can be found in the main <span -class="cmss-10">glossaries</span><a +</p><!--l. 359--><p class="indent" > Further information can be found in the main <span +class="ecss-1095">glossaries</span><a id="dx1-7019"></a> <a href="glossaries-user.html" >user manual</a> and 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 +class="E">E</span>X</span></span> Community's</a> Know How section. </p><!--l. 365--><p class="noindent" ><a href="#top">Top</a></p> |