diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html | 180 |
1 files changed, 92 insertions, 88 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 785571cdd77..0aad1ee76de 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -11,7 +11,7 @@ <meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> <!-- xhtml,fn-in,css-in --> <meta name="src" content="glossariesbegin.tex" /> -<meta name="date" content="2011-04-04 11:04:00" /> +<meta name="date" content="2011-04-13 19:40:00" /> <style type="text/css"> <!-- @@ -159,7 +159,7 @@ div.important { background-color:red; } <div class="author" ><span class="cmr-12">Nicola L.C. Talbot</span></div><br /> <div class="date" ><span -class="cmr-12">2011-04-02</span></div> +class="cmr-12">2011-04-12</span></div> </div> <div class="abstract" @@ -242,32 +242,36 @@ class="cmtt-10">Makeindex</span><a 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>. The <span + 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 + id="dx1-2014"></a> package provides a helper Perl script called <span class="cmtt-10">makeglossaries</span><a - id="dx1-2015"></a> which will act as an interface to <span + id="dx1-2015"></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 + id="dx1-2017"></a>. If you want to use <span class="cmtt-10">makeglossaries</span><a - id="dx1-2018"></a>, you need to have Perl installed, but you can use <span -class="cmtt-10">makeindex</span><a - id="dx1-2019"></a> or + id="dx1-2018"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-2020"></a> directly if you prefer. -</p><!--l. 60--><p class="noindent" > + id="dx1-2019"></a>, you need to have Perl installed. If you don’t have Perl installed, you can still use +<span +class="cmss-10">glossaries </span>but you can only use it with <span +class="cmtt-10">makeindex</span><a + id="dx1-2020"></a>. +</p><!--l. 64--><p class="noindent" > </p> -<!--l. 60--><p class="noindent" ><a +<!--l. 64--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a id="x1-30002"></a>Getting Started</h3> -<!--l. 63--><p class="noindent" >The most obvious things to do is to remember to load the <span +<!--l. 67--><p class="noindent" >The most obvious things to do is to remember to load the <span class="cmss-10">glossaries</span><a id="dx1-3001"></a> package: @@ -277,8 +281,8 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-1"> \usepackage{glossaries} </div> -<!--l. 67--><p class="nopar" > -</p><!--l. 68--><p class="indent" > <div class="important" title="Important Note"> Note that the <span +<!--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 @@ -297,8 +301,8 @@ class="cmss-10">babel</span><a id="dx1-3007"></a> and <span class="cmss-10">ngerman</span><a id="dx1-3008"></a>. </div> -</p><!--l. 74--><p class="noindent" > -</p><!--l. 76--><p class="indent" > If you want to use <span +</p><!--l. 78--><p class="noindent" > +</p><!--l. 80--><p class="indent" > If you want to use <span class="cmtt-10">xindy</span><a id="dx1-3009"></a> rather than <span class="cmtt-10">makeindex</span><a @@ -311,24 +315,24 @@ specify this in the package options: <div class="verbatim" id="verbatim-2"> \usepackage[xindy]{glossaries} </div> -<!--l. 80--><p class="nopar" > Other package options are described in <a +<!--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 id="dx1-3011"></a> user manual. -</p><!--l. 85--><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 files that are required by the indexing application. This is done using: -</p><!--l. 88--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 92--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\makeglossaries </span></div><hr> -</p><!--l. 89--><p class="noindent" > -</p><!--l. 91--><p class="noindent" > +</p><!--l. 93--><p class="noindent" > +</p><!--l. 95--><p class="noindent" > </p> -<!--l. 91--><p class="noindent" ><a +<!--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. 94--><p class="noindent" >You must define terms or symbols before you can use them in the document. This is +<!--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. 98--><p class="indent" > <hr><div title="Definition"><span +</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 @@ -338,7 +342,7 @@ class="cmsy-10">⟨</span><span class="cmti-10">settings</span><span class="cmsy-10">⟩</span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 99--><p class="noindent" > +</p><!--l. 103--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -357,7 +361,7 @@ class="cmss-10">name</span><a <span class="cmss-10">description</span><a id="dx1-4003"></a>. -</p><!--l. 109--><p class="indent" > For example, to define the term “electrolyte”: +</p><!--l. 113--><p class="indent" > For example, to define the term “electrolyte”: @@ -366,7 +370,7 @@ class="cmss-10">description</span><a \newglossaryentry{electrolyte}{name=electrolyte,  <br />description={solution able to conduct electric current}} </div> -<!--l. 113--><p class="nopar" > In the above example, the label and the name happen to be the same. In the next +<!--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: @@ -377,13 +381,13 @@ example, the name contains a ligature but the label doesn’t:  <br />description={canal from mouth to stomach},  <br />plural=\oe sophagi} </div> -<!--l. 121--><p class="nopar" > In this case the label is <span +<!--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. 126--><p class="indent" > When you define terms, it is important to remember that they will be sorted by an +</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="E">E</span>X</span></span> commands. <span class="cmtt-10">Xindy</span><a @@ -414,7 +418,7 @@ term:  <br />plural=\oe sophagi,  <br />sort=oesophagus} </div> -<!--l. 141--><p class="nopar" > Note, however, that if you use the <span +<!--l. 145--><p class="nopar" > Note, however, that if you use the <span class="cmss-10">inputenc</span><a id="dx1-4008"></a> package and <span class="cmtt-10">xindy</span><a @@ -433,8 +437,8 @@ class="cmtt-10">xindy</span><a  <br />description={canal from mouth to stomach},  <br />plural=œsophagi} </div> -<!--l. 149--><p class="nopar" > -</p><!--l. 151--><p class="indent" > If the name starts with an accented character, the first character must be +<!--l. 153--><p class="nopar" > +</p><!--l. 155--><p class="indent" > If the name starts with an accented character, the first character must be grouped: @@ -445,7 +449,7 @@ grouped:  <br />description={select group of people},  <br />sort=elite} </div> -<!--l. 157--><p class="nopar" > or +<!--l. 161--><p class="nopar" > or @@ -454,8 +458,8 @@ grouped: \newglossaryentry{elite}{name={é}lite,  <br />description={select group of people}} </div> -<!--l. 162--><p class="nopar" > -</p><!--l. 164--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For +<!--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 example: @@ -466,7 +470,7 @@ example:  <br />description={ratio of circumference of circle to its  <br />diameter},sort=pi} </div> -<!--l. 170--><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: @@ -476,13 +480,13 @@ example:  <br />description={a collection of objects},  <br />symbol={\ensuremath{\mathcal{S}}}} </div> -<!--l. 176--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary. -</p><!--l. 180--><p class="noindent" > +<!--l. 180--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary. +</p><!--l. 184--><p class="noindent" > </p> -<!--l. 180--><p class="noindent" ><a +<!--l. 184--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="x1-50004"></a>Using a Term</h3> -<!--l. 183--><p class="noindent" >Once you have defined a term, you can use it in the document. The <span +<!--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 id="dx1-5001"></a> package provides a number of commands that are described in <a @@ -491,13 +495,13 @@ Entries</a> in the main <span class="cmss-10">glossaries</span><a id="dx1-5002"></a> user manual. Here, I shall just cover the main commands: -</p><!--l. 189--><p class="indent" > <hr><div title="Definition"><span +</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. 190--><p class="noindent" > +</p><!--l. 194--><p class="noindent" > This prints the term associated with <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -508,13 +512,13 @@ class="cmss-10">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. 197--><p class="indent" > <hr><div title="Definition"><span +</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. 198--><p class="noindent" > +</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 @@ -522,23 +526,23 @@ class="cmsy-10">⟩</span>, so <span class="obeylines-h"><span class="verb" 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. 204--><p class="indent" > There are also versions that convert the first character to upper case if you need to +</p><!--l. 208--><p class="indent" > There are also versions that convert the first character to upper case if you need to start a sentence with a term: -</p><!--l. 207--><p class="indent" > <hr><div title="Definition"><span +</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. 208--><p class="noindent" > +</p><!--l. 212--><p class="noindent" > and -</p><!--l. 211--><p class="indent" > <hr><div title="Definition"><span +</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. 212--><p class="noindent" > +</p><!--l. 216--><p class="noindent" > For example: @@ -548,37 +552,37 @@ For example: \Glspl{electrolyte} usually exist as solutions of salts,  <br />bases or acids. </div> -<!--l. 217--><p class="nopar" > -</p><!--l. 219--><p class="indent" > Note that these commands all have two optional arguments that aren’t discussed +<!--l. 221--><p class="nopar" > +</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 id="dx1-5004"></a> user manual. -</p><!--l. 224--><p class="indent" > <div class="important" title="Important Note"> Don’t use these commands in moving arguments, such as those used by <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">\chapter</span>, <span class="cmtt-10">\section </span>and <span class="cmtt-10">\caption</span>. </div> -</p><!--l. 227--><p class="noindent" > +</p><!--l. 231--><p class="noindent" > You can, instead, use commands such as -</p><!--l. 230--><p class="indent" > <hr><div title="Definition"><span +</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. 231--><p class="noindent" > +</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 id="dx1-5005"></a> user manual. -</p><!--l. 235--><p class="noindent" > +</p><!--l. 239--><p class="noindent" > </p> -<!--l. 235--><p class="noindent" ><a +<!--l. 239--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a id="x1-60005"></a>Acronyms</h3> -<!--l. 238--><p class="noindent" >The <span +<!--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 @@ -592,13 +596,13 @@ be placed in a separate list of acronyms: <div class="verbatim" id="verbatim-12"> \usepackage[acronym]{glossaries} </div> -<!--l. 244--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see +<!--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 id="dx1-6003"></a> user manual. -</p><!--l. 249--><p class="indent" > Acronyms must be defined before use and are defined using: -</p><!--l. 251--><p class="indent" > <hr><div title="Definition"><span +</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 @@ -612,7 +616,7 @@ class="cmsy-10">⟨</span><span class="cmti-10">full</span><span class="cmsy-10">⟩</span><span class="cmtt-10">} </span></div><hr> -</p><!--l. 252--><p class="noindent" > +</p><!--l. 256--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -631,8 +635,8 @@ class="cmsy-10">⟩ </span>is the fully expanded text. For example: <div class="verbatim" id="verbatim-13"> \newacronym{label}{svm}{support vector machine} </div> -<!--l. 258--><p class="nopar" > -</p><!--l. 260--><p class="indent" > Once the acronym is defined, it can be used in the same way as any other glossary +<!--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 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 @@ -651,7 +655,7 @@ example: <div class="verbatim" id="verbatim-14"> A \gls{svm} was implemented. </div> -<!--l. 267--><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 first time this term has been used, the above would produce: <spacer type=vertical size=10><span class="obeylines-h"> <br />A support vector machine (svm) was implemented. <br /><spacer type=vertical size=10></span> @@ -659,31 +663,31 @@ otherwise it would produce: <spacer type=vertical size=10><span class="obeylines <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. 280--><p class="indent" > <hr><div title="Definition"><span +</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. 281--><p class="noindent" > +</p><!--l. 285--><p class="noindent" > or you can reset all acronyms using -</p><!--l. 284--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 288--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsresetall </span></div><hr> -</p><!--l. 285--><p class="noindent" > +</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 id="dx1-6004"></a> user manual. -</p><!--l. 291--><p class="noindent" > +</p><!--l. 295--><p class="noindent" > </p> -<!--l. 291--><p class="noindent" ><a +<!--l. 295--><p class="noindent" ><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. 294--><p class="noindent" >In order to display the sorted list of terms, you first need to use -</p><!--l. 297--><p class="indent" > <hr><div title="Definition"><span +<!--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> -</p><!--l. 298--><p class="noindent" > +</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, @@ -691,7 +695,7 @@ 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 process. -</p><!--l. 306--><p class="indent" > Suppose your document is called <span +</p><!--l. 310--><p class="indent" > Suppose your document is called <span class="cmtt-10">myDoc.tex</span>, then you need to: </p><ol class="enumerate1" > <li @@ -705,7 +709,7 @@ class="E">E</span>X</span></span> your document, either by clicking on an <div class="verbatim" id="verbatim-15"> latex myDoc </div> - <!--l. 314--><p class="nopar" > + <!--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 @@ -730,11 +734,11 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-16"> makeglossaries myDoc </div> - <!--l. 325--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as WinEdt + <!--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. 331--><p class="noindent" >If you don’t have Perl installed, you will need to call <span + </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 id="dx1-7010"></a> or <span class="cmtt-10">xindy</span><a @@ -749,8 +753,8 @@ class="cmss-10">glossaries</span><a class="enumerate" id="x1-7014x3">Once you have successfully run the indexing application, you need to 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. 340--><p class="noindent" >Note that sometimes you may have to repeat steps 2 and 3. -</p><!--l. 342--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default +<!--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 style uses the <span class="cmss-10">description</span><a id="dx1-7015"></a><a @@ -771,8 +775,8 @@ class="cmss-10">nonumberlist</span><a <div class="verbatim" id="verbatim-17"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 353--><p class="nopar" > -</p><!--l. 355--><p class="indent" > Further information can be found in the main <span +<!--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 id="dx1-7019"></a> <a href="glossaries-user.html" >user manual</a> and there is @@ -781,7 +785,7 @@ href="http://www.latex-community.org/index.php?option=com_content&view=article&i 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. -</p><!--l. 361--><p class="noindent" ><a +</p><!--l. 365--><p class="noindent" ><a href="#top">Top</a></p> </body></html> |