diff options
Diffstat (limited to 'Master/texmf-dist/doc')
59 files changed, 13942 insertions, 8022 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 2b871bf5843..ccf7c9631e4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,103 @@ glossaries change log: +v3.0 (Major changes): + + * Documentation has been restructured: + + - glossaries-user: main user manual + - glossariesbegin: cut-down introduction for beginners + - mfirstuc-manual: user manual for mfirstuc package + - glossaries.pdf: documented code for advanced users + - glossary2glossaries: upgrading from glossary.sty to glossaries.sty + + * Added new package options: + + - entrycounter : number main (level 0) entries in the glossary. + + - counterwithin : set parent counter for the entry counter. + + - subentrycounter : number level 1 entries in the glossary. + + - sort : set the sort order to + - standard alphabetical (sort=standard), + - order of definition (sort=def) + - order of use (sort=use) + + - seeautonumberlist : automatically activates the number list + for entries that use the "see" key. + + - savewrites : minimise number of \newwrite + + - compatible-2.07 : + + bug fixes in v3.0 have cause compatibility problems. This + package option will restore the old behaviour but bugs will + remain. (Should mostly only effect documents that used + \noist with a custom Xindy style file.) + + * \printglossary sets \currentglossary to the current glossary's + label. (Allows custom glossary styles access to the glossary + type.) + + * Modified internal workings of acronyms and: + + - Added starred versions of \acrshort etc. + + - Added "long", "short", "longplural" and "shortplural" keys + (Reserved for use with \newacronym.) + + - Added analogous "longaccess", "shortaccess", "longpluralaccess" + and "shortpluralaccess" keys for \newacronym in + glossaries-accsupp.sty + + * Added \glsseeitemformat to customise the text given in the link + created by \glsseeitem. + + * \newglossaryentry key "nonumberlist" now boolean. + + * added debugging commands \showgloname etc. + + * now loads etoolbox: + + - replaced \DeclareRobustCommand with \newrobustcmd + + - replaced \@ifundefined with \ifcsundef + + - replaced \let...\undefined with \undef... + + * Bug Fixes: + + - now works with equation counter in amsmath's align + environment. + + - Mixed counters now work with xindy option. + + - Fixed hyperlinks in location numbers where \theH<counter> + has a prefix not present in \the<counter>. + + - If title specified in \printglossary but toctitle hasn't + been specified, make toctitle same as supplied title. + + - \newglossaryentry "see" key and \glssee now sanitize and escape + special characters before writing to output file. (Allows + user to redefine \seename any point before \printglossary or + \printglossaries.) + + - \glshyperlink: Changed the default value of the optional argument + to \glsentrytext instead of \glsentryname. + + * mfirstuc.sty (v1.05): + + - added \glsmakefirstuc (replaces \@gls@makefirstuc) to make + it easier to customise. + + makeglossaries (v2.02): + + * now displays version number on startup unless -q + + * added more diagnostics to give more helpful messages than + those supplied by xindy or makeindex. + v2.07: * Fixed bug that ignored format key in \glsadd @@ -100,7 +198,7 @@ v2.01: * Moved \@do@wrglossary before term is displayed to prevent unwanted whatsit -v2.0 (1.2): +v2.0 (1.20): * Fixed ngerman caption bug in glossaries-babel.sty v1.19: diff --git a/Master/texmf-dist/doc/latex/glossaries/INSTALL b/Master/texmf-dist/doc/latex/glossaries/INSTALL index 87a687e7dac..e9acdea0050 100644 --- a/Master/texmf-dist/doc/latex/glossaries/INSTALL +++ b/Master/texmf-dist/doc/latex/glossaries/INSTALL @@ -83,7 +83,9 @@ Move the sample files (*.tex) to TEXMF/doc/latex/glossaries/sample/ Move the documentation (*.pdf) to TEXMF/doc/latex/glossaries/ -Move glossaries.sty, glossaries-babel.sty and mfirstuc.sty to +Move glossaries.sty, glossaries-babel.sty, +glossaries-polyglossia.sty, glossaries-compatible-207.sty and +mfirstuc.sty to TEXMF/tex/latex/glossaries/base/ Move glossaries-accsupp.sty to diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 62ebf04398c..f8cf784be5a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v2.07 +LaTeX Package : glossaries v3.0 -Last Modified : 2010-07-10 +Last Modified : 2011-04-02 Author : Nicola Talbot @@ -42,6 +42,7 @@ ifthen xkeyval *at least version 2.5f (2006/11/18)* xfor amsgen +etoolbox longtable (unless you use the nolong or nostyles package options) If the supertabular package is installed, it will also be loaded diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index 723df427412..b122907da37 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -5,21 +5,22 @@ <!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> <html xmlns="http://www.w3.org/1999/xhtml" > -<head><title>glossaries.sty v2.07: LaTeX2εPackage to Assist Generating Glossaries</title> +<head><title>User Manual for glossaries.sty v3.0</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <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 --> -<meta name="src" content="glossaries-manual.tex" /> -<meta name="date" content="2010-07-10 12:22:00" /> +<meta name="src" content="glossaries-user.tex" /> +<meta name="date" content="2011-04-04 11:04:00" /> <style type="text/css"> <!-- /* start css.sty */ +.cmr-7{font-size:70%;} +.cmmi-7{font-size:70%;font-style: italic;} .cmmi-10{font-style: italic;} .ecrm-1728{font-size:170%;} -.cmmi-12x-x-144{font-size:172%;font-style: italic;} .ecrm-1200{font-size:120%;} .ectt-1200{font-size:120%; font-family: monospace;} .ectt-1200{ font-family: monospace;} @@ -49,6 +50,20 @@ .ecss-1000{ font-family: sans-serif;} .ecss-1000{ font-family: sans-serif;} .ecss-1000{ font-family: sans-serif;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} .ectt-1000{ font-family: monospace;} .ectt-1000{ font-family: monospace;} .ectt-1000{ font-family: monospace;} @@ -63,6 +78,20 @@ .ectt-1000{ font-family: monospace;} .ectt-1000{ font-family: monospace;} .ectt-1000{ font-family: monospace;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} .ecrm-0900{font-size:90%;} .ecrm-0800{font-size:80%;} .ectt-0800{font-size:80%; font-family: monospace;} @@ -93,20 +122,6 @@ .ecss-0800{ font-family: sans-serif;} .ecss-0800{ font-family: sans-serif;} .ecss-0800{ font-family: sans-serif;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} .ecsx-1000{ font-weight: bold;} .ecsx-1000{ font-weight: bold;} .ecsx-1000{ font-weight: bold;} @@ -121,20 +136,6 @@ .ecsx-1000{ font-weight: bold;} .ecsx-1000{ font-weight: bold;} .ecsx-1000{ font-weight: bold;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} .ectt-0900{font-size:90%; font-family: monospace;} .ectt-0900{ font-family: monospace;} .ectt-0900{ font-family: monospace;} @@ -149,6 +150,7 @@ .ectt-0900{ font-family: monospace;} .ectt-0900{ font-family: monospace;} .ectt-0900{ font-family: monospace;} +.small-caps{font-variant: small-caps; } p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -260,6 +262,9 @@ div.abstract {width:100%;} table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } .alltt P { margin-bottom : 0em; margin-top : 0em; } .alltt { margin-bottom : 1em; margin-top : 1em; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +div.longtable{text-align:center;} +.supertabular {text-align:center} div.important { background-color:red; } /* end css.sty */ @@ -276,9 +281,7 @@ div.important { background-color:red; } -<h2 class="titleHead">glossaries.sty v2.07: <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span>2ε Package to Assist -Generating Glossaries</h2> +<h2 class="titleHead">User Manual for glossaries.sty v3.0</h2> <div class="author" ><span class="ecrm-1200">Nicola L.C. Talbot</span> <br /> <span @@ -293,134 +296,455 @@ class="ecrm-1200">NR4 7TJ. United Kingdom.</span> href="http://theoval.cmp.uea.ac.uk/~nlct/" class="url" ><span class="ectt-1200">http://theoval.cmp.uea.ac.uk/~nlct/</span></a></div><br /> <div class="date" ><span -class="ecrm-1200">2010-07-10</span></div> +class="ecrm-1200">2011-04-02</span></div> </div> -<!--l. 58--><p class="indent" > This is the user manual for the <span -class="ecss-1000">glossaries </span>package. Other documents accompanying -this manual: </p> - <ul class="itemize1"> - <li class="itemize"><a -href="glossariesbegin.html" >“The glossaries package: a guide for beginners”</a> - </li> - <li class="itemize"><a -href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a></li></ul> -<!--l. 65--><p class="noindent" >See the file <span -class="ectt-1000">INSTALL </span>for installation instructions. Related web resources: </p> - <ul class="itemize1"> - <li class="itemize"><a -href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" >The glossaries FAQ</a> - </li> - <li class="itemize"><a -href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263&Itemid=114" >Glossaries, Nomenclature, Lists of Symbols and Acronyms </a></li></ul> +<!--l. 228--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>bundle comes with the following documentation: + </p><dl class="description"><dt class="description"> +<a +href="glossariesbegin.pdf" class="url" ><span +class="ectt-1000">glossariesbegin.pdf</span></a> </dt><dd +class="description">If you are a complete beginner, start with <a +href="glossariesbegin.html" >“The glossaries + package: a guide for beginners”</a>. + </dd><dt class="description"> +<a +href="glossary2glossaries.pdf" class="url" ><span +class="ectt-1000">glossary2glossaries.pdf</span></a> </dt><dd +class="description">If you are moving over from the obsolete <span +class="ecss-1000">glossary</span><a + id="dx1-2"></a> + package, read <a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries + package”</a>. + </dd><dt class="description"> +<span +class="ecbx-1000">glossaries-user.pdf</span> </dt><dd +class="description">This document is the main user guide for the <span +class="ecss-1000">glossaries</span> + package. + </dd><dt class="description"> +<a +href="mfirstuc-manual.pdf" class="url" ><span +class="ectt-1000">mfirstuc-manual.pdf</span></a> </dt><dd +class="description">The commands provided by the <span +class="ecss-1000">mfirstuc</span><a + id="dx1-3"></a> package are + briefly described in <a +href="mfirstuc-manual.html" >“mfirstuc.sty: uppercasing first letter”</a>. + </dd><dt class="description"> +<a +href="glossaries.pdf" class="url" ><span +class="ectt-1000">glossaries.pdf</span></a> </dt><dd +class="description">Advanced users wishing to know more about the inner workings + of all the packages provided in the <span +class="ecss-1000">glossaries </span>bundle should read “Documented + Code for glossaries v3.0”. This includes how to iterate over all entry labels + defined in a given glossary or how to iterate over all glossary types, as well + as the documented code for the <span +class="ecss-1000">mfirstuc</span><a + id="dx1-4"></a> package. + </dd><dt class="description"> +<span +class="ecbx-1000">INSTALL</span> </dt><dd +class="description">Installation instructions. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">CHANGES</span> </dt><dd +class="description">Change log. + </dd><dt class="description"> +<span +class="ecbx-1000">README</span> </dt><dd +class="description">Package summary. + </dd></dl> +<!--l. 266--><p class="indent" > <div class="important" title="Important Note"> If you use <span +class="ecss-1000">hyperref</span><a + id="dx1-5"></a> and <span +class="ecss-1000">glossaries</span>, you must load <span +class="ecss-1000">hyperref</span><a + id="dx1-6"></a> <span +class="ecti-1000">first</span>. </div> +</p><!--l. 269--><p class="noindent" > +</p> <h3 class="likesectionHead"><a id="x1-1000"></a>Contents</h3> <div class="tableofcontents"> - <span class="sectionToc" >1 <a -href="#x1-20001" id="QQ2-1-2">Introduction</a></span> + <span class="sectionToc" ><a +href="#Q1-1-2">Glossary</a></span> +<br /> <span class="sectionToc" >1 <a +href="#x1-30001" id="QQ2-1-4">Introduction</a></span> <br />  <span class="subsectionToc" >1.1 <a -href="#x1-30001.1" id="QQ2-1-3">Sample Documents</a></span> +href="#x1-40001.1" id="QQ2-1-5">Sample Documents</a></span> <br />  <span class="subsectionToc" >1.2 <a -href="#x1-40001.2" id="QQ2-1-4">Multi-Lingual Support</a></span> +href="#x1-50001.2" id="QQ2-1-6">Multi-Lingual Support</a></span> <br />   <span class="subsubsectionToc" >1.2.1 <a -href="#x1-50001.2.1" id="QQ2-1-5">Changing the Fixed Names</a></span> +href="#x1-60001.2.1" id="QQ2-1-7">Changing the Fixed Names</a></span> <br />  <span class="subsectionToc" >1.3 <a -href="#x1-60001.3" id="QQ2-1-8">Generating the Associated Glossary Files</a></span> +href="#x1-70001.3" id="QQ2-1-10">Generating the Associated Glossary Files</a></span> <br />   <span class="subsubsectionToc" >1.3.1 <a -href="#x1-70001.3.1" id="QQ2-1-10">Using the makeglossaries Perl Script</a></span> +href="#x1-80001.3.1" id="QQ2-1-12">Using the makeglossaries Perl Script</a></span> <br />   <span class="subsubsectionToc" >1.3.2 <a -href="#x1-80001.3.2" id="QQ2-1-11">Using xindy explicitly</a></span> +href="#x1-90001.3.2" id="QQ2-1-13">Using xindy explicitly</a></span> <br />   <span class="subsubsectionToc" >1.3.3 <a -href="#x1-90001.3.3" id="QQ2-1-12">Using makeindex explicitly</a></span> +href="#x1-100001.3.3" id="QQ2-1-14">Using makeindex explicitly</a></span> <br />   <span class="subsubsectionToc" >1.3.4 <a -href="#x1-100001.3.4" id="QQ2-1-13">Note to Front-End and Script Developers</a></span> -<br />  <span class="subsectionToc" >1.4 <a -href="#x1-110001.4" id="QQ2-1-14">Troubleshooting</a></span> +href="#x1-110001.3.4" id="QQ2-1-15">Note to Front-End and Script Developers</a></span> <br /> <span class="sectionToc" >2 <a -href="#x1-120002" id="QQ2-1-15">Overview of Main User Commands</a></span> +href="#x1-120002" id="QQ2-1-16">Package Options</a></span> <br />  <span class="subsectionToc" >2.1 <a -href="#x1-130002.1" id="QQ2-1-16">Package Options</a></span> +href="#x1-130002.1" id="QQ2-1-17">General Options</a></span> <br />  <span class="subsectionToc" >2.2 <a -href="#x1-140002.2" id="QQ2-1-17">Defining Glossary Entries</a></span> -<br />   <span class="subsubsectionToc" >2.2.1 <a -href="#x1-150002.2.1" id="QQ2-1-18">Plurals</a></span> -<br />   <span class="subsubsectionToc" >2.2.2 <a -href="#x1-160002.2.2" id="QQ2-1-19">Sub-Entries</a></span> -<br />   <span class="subsubsectionToc" >2.2.3 <a -href="#x1-190002.2.3" id="QQ2-1-22">Loading Entries From a File</a></span> +href="#x1-140002.2" id="QQ2-1-18">Sectioning and TOC Options</a></span> <br />  <span class="subsectionToc" >2.3 <a -href="#x1-200002.3" id="QQ2-1-23">Number lists</a></span> +href="#x1-150002.3" id="QQ2-1-19">Glossary Appearance Options</a></span> <br />  <span class="subsectionToc" >2.4 <a -href="#x1-210002.4" id="QQ2-1-24">Links to Glossary Entries</a></span> -<br />   <span class="subsubsectionToc" >2.4.1 <a -href="#x1-220002.4.1" id="QQ2-1-26">Changing the format of the link text</a></span> -<br />   <span class="subsubsectionToc" >2.4.2 <a -href="#x1-230002.4.2" id="QQ2-1-27">Enabling and disabling hyperlinks to glossary entries</a></span> +href="#x1-160002.4" id="QQ2-1-20">Sorting Options</a></span> <br />  <span class="subsectionToc" >2.5 <a -href="#x1-240002.5" id="QQ2-1-28">Adding an Entry to the Glossary Without Generating Text</a></span> -<br />  <span class="subsectionToc" >2.6 <a -href="#x1-250002.6" id="QQ2-1-29">Cross-Referencing Entries</a></span> -<br />  <span class="subsectionToc" >2.7 <a -href="#x1-260002.7" id="QQ2-1-30">Using Glossary Terms Without Links</a></span> -<br />  <span class="subsectionToc" >2.8 <a -href="#x1-270002.8" id="QQ2-1-31">Displaying a glossary</a></span> -<br />   <span class="subsubsectionToc" >2.8.1 <a -href="#x1-280002.8.1" id="QQ2-1-32">Changing the way the entry name appears in the glossary</a></span> -<br />   <span class="subsubsectionToc" >2.8.2 <a -href="#x1-290002.8.2" id="QQ2-1-33">Xindy</a></span> -<br />  <span class="subsectionToc" >2.9 <a -href="#x1-330002.9" id="QQ2-1-37">Defining New Glossaries</a></span> -<br />  <span class="subsectionToc" >2.10 <a -href="#x1-340002.10" id="QQ2-1-38">Acronyms</a></span> -<br />   <span class="subsubsectionToc" >2.10.1 <a -href="#x1-350002.10.1" id="QQ2-1-41">Defining A Custom Acronym Style</a></span> -<br />   <span class="subsubsectionToc" >2.10.2 <a -href="#x1-360002.10.2" id="QQ2-1-42">Upgrading From the glossary Package</a></span> -<br />  <span class="subsectionToc" >2.11 <a -href="#x1-370002.11" id="QQ2-1-44">Unsetting and Resetting Entry Flags</a></span> -<br />  <span class="subsectionToc" >2.12 <a -href="#x1-380002.12" id="QQ2-1-45">Glossary Styles</a></span> -<br />   <span class="subsubsectionToc" >2.12.1 <a -href="#x1-390002.12.1" id="QQ2-1-47">List Styles</a></span> -<br />   <span class="subsubsectionToc" >2.12.2 <a -href="#x1-400002.12.2" id="QQ2-1-48">Longtable Styles</a></span> -<br />   <span class="subsubsectionToc" >2.12.3 <a -href="#x1-410002.12.3" id="QQ2-1-49">Longtable Styles (Ragged Right)</a></span> -<br />   <span class="subsubsectionToc" >2.12.4 <a -href="#x1-420002.12.4" id="QQ2-1-50">Supertabular Styles</a></span> -<br />   <span class="subsubsectionToc" >2.12.5 <a -href="#x1-430002.12.5" id="QQ2-1-51">Supertabular Styles (Ragged Right)</a></span> -<br />   <span class="subsubsectionToc" >2.12.6 <a -href="#x1-440002.12.6" id="QQ2-1-52">Tree-Like Styles</a></span> -<br />  <span class="subsectionToc" >2.13 <a -href="#x1-450002.13" id="QQ2-1-53">Defining your own glossary style</a></span> -<br />   <span class="subsubsectionToc" >2.13.1 <a -href="#x1-460002.13.1" id="QQ2-1-54">Example: creating a completely new style</a></span> -<br />   <span class="subsubsectionToc" >2.13.2 <a -href="#x1-470002.13.2" id="QQ2-1-55">Example: creating a new glossary style based on an existing style</a></span> -<br />   <span class="subsubsectionToc" >2.13.3 <a -href="#x1-480002.13.3" id="QQ2-1-56">Example: creating a glossary style that uses the <span -class="ecss-1000">user1</span>, …, <span -class="ecss-1000">user6 </span>keys</a></span> -<br />  <span class="subsectionToc" >2.14 <a -href="#x1-490002.14" id="QQ2-1-57">Accessibility Support</a></span> +href="#x1-170002.5" id="QQ2-1-21">Acronym Options</a></span> +<br /> <span class="sectionToc" >3 <a +href="#x1-180003" id="QQ2-1-22">Setting Up</a></span> +<br /> <span class="sectionToc" >4 <a +href="#x1-190004" id="QQ2-1-23">Defining Glossary Entries</a></span> +<br />  <span class="subsectionToc" >4.1 <a +href="#x1-200004.1" id="QQ2-1-24">Plurals</a></span> +<br />  <span class="subsectionToc" >4.2 <a +href="#x1-210004.2" id="QQ2-1-25">Sub-Entries</a></span> +<br />   <span class="subsubsectionToc" >4.2.1 <a +href="#x1-220004.2.1" id="QQ2-1-26">Hierarchical Categories</a></span> +<br />   <span class="subsubsectionToc" >4.2.2 <a +href="#x1-230004.2.2" id="QQ2-1-27">Homographs</a></span> +<br />  <span class="subsectionToc" >4.3 <a +href="#x1-240004.3" id="QQ2-1-28">Loading Entries From a File</a></span> +<br /> <span class="sectionToc" >5 <a +href="#x1-250005" id="QQ2-1-29">Number lists</a></span> +<br /> <span class="sectionToc" >6 <a +href="#x1-260006" id="QQ2-1-30">Links to Glossary Entries</a></span> +<br />  <span class="subsectionToc" >6.1 <a +href="#x1-270006.1" id="QQ2-1-32">Changing the format of the link text</a></span> +<br />  <span class="subsectionToc" >6.2 <a +href="#x1-280006.2" id="QQ2-1-33">Enabling and disabling hyperlinks to glossary entries</a></span> +<br /> <span class="sectionToc" >7 <a +href="#x1-290007" id="QQ2-1-34">Adding an Entry to the Glossary Without Generating Text</a></span> +<br /> <span class="sectionToc" >8 <a +href="#x1-300008" id="QQ2-1-35">Cross-Referencing Entries</a></span> +<br />  <span class="subsectionToc" >8.1 <a +href="#x1-310008.1" id="QQ2-1-36">Customising Cross-reference Text</a></span> +<br /> <span class="sectionToc" >9 <a +href="#x1-320009" id="QQ2-1-37">Using Glossary Terms Without Links</a></span> +<br /> <span class="sectionToc" >10 <a +href="#x1-3300010" id="QQ2-1-38">Displaying a glossary</a></span> +<br /> <span class="sectionToc" >11 <a +href="#x1-3400011" id="QQ2-1-39">Xindy</a></span> +<br />  <span class="subsectionToc" >11.1 <a +href="#x1-3500011.1" id="QQ2-1-40">Language and Encodings</a></span> +<br />  <span class="subsectionToc" >11.2 <a +href="#x1-3600011.2" id="QQ2-1-41">Locations and Number lists</a></span> +<br />  <span class="subsectionToc" >11.3 <a +href="#x1-3700011.3" id="QQ2-1-42">Glossary Groups</a></span> +<br /> <span class="sectionToc" >12 <a +href="#x1-3800012" id="QQ2-1-43">Defining New Glossaries</a></span> +<br /> <span class="sectionToc" >13 <a +href="#x1-3900013" id="QQ2-1-44">Acronyms</a></span> +<br />  <span class="subsectionToc" >13.1 <a +href="#x1-4000013.1" id="QQ2-1-46">Predefined Acronym Styles</a></span> +<br />  <span class="subsectionToc" >13.2 <a +href="#x1-4100013.2" id="QQ2-1-47">Displaying the List of Acronyms</a></span> +<br />  <span class="subsectionToc" >13.3 <a +href="#x1-4200013.3" id="QQ2-1-49">Defining A Custom Acronym Style</a></span> +<br />  <span class="subsectionToc" >13.4 <a +href="#x1-4300013.4" id="QQ2-1-50">Upgrading From the glossary Package</a></span> -<br /> <span class="sectionToc" >3 <a -href="#x1-500003" id="QQ2-1-58">Mfirstuc Package</a></span> +<br /> <span class="sectionToc" >14 <a +href="#x1-4400014" id="QQ2-1-52">Unsetting and Resetting Entry Flags</a></span> +<br /> <span class="sectionToc" >15 <a +href="#x1-4500015" id="QQ2-1-53">Glossary Styles</a></span> +<br />  <span class="subsectionToc" >15.1 <a +href="#x1-4600015.1" id="QQ2-1-55">List Styles</a></span> +<br />  <span class="subsectionToc" >15.2 <a +href="#x1-4700015.2" id="QQ2-1-56">Longtable Styles</a></span> +<br />  <span class="subsectionToc" >15.3 <a +href="#x1-4800015.3" id="QQ2-1-57">Longtable Styles (Ragged Right)</a></span> +<br />  <span class="subsectionToc" >15.4 <a +href="#x1-4900015.4" id="QQ2-1-58">Supertabular Styles</a></span> +<br />  <span class="subsectionToc" >15.5 <a +href="#x1-5000015.5" id="QQ2-1-59">Supertabular Styles (Ragged Right)</a></span> +<br />  <span class="subsectionToc" >15.6 <a +href="#x1-5100015.6" id="QQ2-1-60">Tree-Like Styles</a></span> +<br /> <span class="sectionToc" >16 <a +href="#x1-5200016" id="QQ2-1-61">Defining your own glossary style</a></span> +<br />  <span class="subsectionToc" >16.1 <a +href="#x1-5300016.1" id="QQ2-1-62">Example: creating a completely new style</a></span> +<br />  <span class="subsectionToc" >16.2 <a +href="#x1-5400016.2" id="QQ2-1-63">Example: creating a new glossary style based on an existing style</a></span> +<br />  <span class="subsectionToc" >16.3 <a +href="#x1-5500016.3" id="QQ2-1-64">Example: creating a glossary style that uses the <span +class="ecss-1000">user1</span>, …, <span +class="ecss-1000">user6 </span>keys</a></span> +<br /> <span class="sectionToc" >17 <a +href="#x1-5600017" id="QQ2-1-65">Accessibility Support</a></span> +<br /> <span class="sectionToc" >18 <a +href="#x1-5700018" id="QQ2-1-66">Troubleshooting</a></span> <br /> <span class="sectionToc" ><a -href="#Q1-1-59">Index</a></span> +href="#Q1-1-67">Index</a></span> </div> -<!--l. 79--><p class="noindent" > + + + +<!--l. 1--><p class="indent" > <a + id="likesection.1"></a><a + id="Q1-1-2"></a> </p> - <h3 class="sectionHead"><span class="titlemark">1 </span> <a - id="x1-20001"></a>Introduction</h3> + <h3 class="likesectionHead"><a + id="x1-2000"></a>Glossary</h3> +<!--l. 1--><p class="noindent" ><span +class="ecti-1000">This glossary style was setup using:</span> </p> +<table +cellpadding="0" border="0" cellspacing="0" +class="tabbing"><tr +style="vertical-align:baseline;" class="tabbing"><td style="width:94;" +class="tabbing"><span +class="ectt-1000">\usepackage[</span></td><td +class="tabbing"><span +class="ectt-1000">xindy,</span> +</td></tr></table> +<!--l. 1--><p class="indent" > </p><table +cellpadding="0" border="0" cellspacing="0" +class="tabbing"><tr +style="vertical-align:baseline;" class="tabbing"><td style="width:94;" +class="tabbing"> </td><td +class="tabbing"><span +class="ectt-1000">nonumberlist,</span></td></tr></table> +<!--l. 1--><p class="indent" > </p><table +cellpadding="0" border="0" cellspacing="0" +class="tabbing"><tr +style="vertical-align:baseline;" class="tabbing"><td style="width:94;" +class="tabbing"></td><td +class="tabbing"><span +class="ectt-1000">seeautonumberlist,</span></td></tr></table> +<!--l. 1--><p class="indent" > </p><table +cellpadding="0" border="0" cellspacing="0" +class="tabbing"><tr +style="vertical-align:baseline;" class="tabbing"><td style="width:94;" +class="tabbing"></td><td +class="tabbing"><span +class="ectt-1000">toc,</span></td></tr></table> +<!--l. 1--><p class="indent" > </p><table +cellpadding="0" border="0" cellspacing="0" +class="tabbing"><tr +style="vertical-align:baseline;" class="tabbing"><td style="width:94;" +class="tabbing"></td><td +class="tabbing"><span +class="ectt-1000">style=altlist]{glossaries}</span></td></tr></table> +<!--l. 1--><p class="indent" > +</p><!--l. 1--><p class="noindent" ><span +class="ectt-1000">\renewcommand*{\glsgroupskip</span><a + id="dx1-2001"></a><span +class="ectt-1000">}{}</span><br +class="newline" /><span +class="ectt-1000">\renewcommand*{\glsseeformat</span><a + id="dx1-2002"></a><span +class="ectt-1000">}[3][\seename</span><a + id="dx1-2003"></a><span +class="ectt-1000">]{(\xmakefirstuc</span><a + id="dx1-2004"></a><span +class="ectt-1000">{#1} </span><br +class="newline" /><span +class="ectt-1000">\glsseelist</span><a + id="dx1-2005"></a><span +class="ectt-1000">{#2}.)}</span> + </p><dl class="description"><dt class="description"> +<a + id="glo:entrylocation"></a><span +class="ecbx-1000">Entry location</span><a + id="dx1-2006"></a> </dt><dd +class="description"><br +class="newline" />The location of the entry in the document. This defaults to the page number + on which the entry appears. An entry may have multiple locations. <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:firstuse"></a><span +class="ecbx-1000">First use</span><a + id="dx1-2007"></a> </dt><dd +class="description"><br +class="newline" />The first time a glossary entry is used (from the start of the document or + after a reset) with one of the following commands: <span +class="ectt-1000">\gls</span><a + id="dx1-2008"></a>, <span +class="ectt-1000">\Gls</span><a + id="dx1-2009"></a>, <span +class="ectt-1000">\GLS</span><a + id="dx1-2010"></a>, <span +class="ectt-1000">\glspl</span><a + id="dx1-2011"></a>, + <span +class="ectt-1000">\Glspl</span><a + id="dx1-2012"></a>, <span +class="ectt-1000">\GLSpl</span><a + id="dx1-2013"></a> or <span +class="ectt-1000">\glsdisp</span><a + id="dx1-2014"></a>. (See <a +href="#glo:firstuseflag">first use flag</a> & <a +href="#glo:firstusetext">first use text</a>.) <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:firstuseflag"></a><span +class="ecbx-1000">First use flag</span><a + id="dx1-2015"></a> </dt><dd +class="description"><br +class="newline" />A conditional that determines whether or not the entry has been used + according to the rules of <a + id="dx1-2016"></a><a +href="#glo:firstuse">first use</a>. Commands to unset or reset this + conditional are described in <a +href="#x1-4400014">14 </a><a +href="#x1-4400014">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:firstusetext"></a><span +class="ecbx-1000">First use text</span><a + id="dx1-2017"></a> </dt><dd +class="description"><br +class="newline" />The text that is displayed on <a + id="dx1-2018"></a><a +href="#glo:firstuse">first use</a>, which is governed by the <span +class="ecss-1000">first</span><a + id="dx1-2019"></a> and + <span +class="ecss-1000">firstplural</span><a + id="dx1-2020"></a> keys of <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-2021"></a>. (May be overridden by <span +class="ectt-1000">\glsdisp</span><a + id="dx1-2022"></a>.) <br +class="newline" /> + + + + </dd><dt class="description"> +<a + id="glo:linktext"></a><span +class="ecbx-1000">Link text</span><a + id="dx1-2023"></a> </dt><dd +class="description"><br +class="newline" />The text produced by commands such as <span +class="ectt-1000">\gls</span><a + id="dx1-2024"></a>. It may or may not be a + hyperlink to the glossary. <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:locationlist"></a><span +class="ecbx-1000">Location list</span> </dt><dd +class="description"><br +class="newline" />A list of <a + id="dx1-2025"></a><a +href="#glo:entrylocation">entry locations</a>. (See <a +href="#glo:numberlist">number list<a + id="dx1-2026"></a></a>.)<br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:makeglossaries"></a><span +class="ectt-1000">makeglossaries</span><a + id="dx1-2027"></a> </dt><dd +class="description"><br +class="newline" />A <span +class="ecss-1000">glossaries</span><a + id="dx1-2028"></a> custom designed Perl script interface to <a + id="dx1-2029"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-2030"></a></a> and <a + id="dx1-2031"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-2032"></a></a>. + <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:makeindex"></a><span +class="ectt-1000">makeindex</span><a + id="dx1-2033"></a> </dt><dd +class="description"><br +class="newline" />An indexing application. <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:numberlist"></a><span +class="ecbx-1000">Number list</span><a + id="dx1-2034"></a> </dt><dd +class="description"><br +class="newline" />A list of <a + id="dx1-2035"></a><a +href="#glo:entrylocation">entry locations</a> (also called a location list). The number list can be + suppressed using the <span +class="ecss-1000">nonumberlist</span><a + id="dx1-2036"></a> package option. <br +class="newline" /> + </dd><dt class="description"> <a - id="dx1-2001"></a> -<!--l. 82--><p class="noindent" >The <span + id="glo:sanitize"></a><span +class="ecbx-1000">Sanitize</span><a + id="dx1-2037"></a> </dt><dd +class="description"><br +class="newline" />Converts command names into character sequences. That is, a command + called, say, <span +class="ectt-1000">\foo</span>, is converted into the sequence of characters: <span +class="ectt-1000">\</span>, <span +class="ectt-1000">f</span>, <span +class="ectt-1000">o</span>, <span +class="ectt-1000">o</span>. + Depending on the font, the backslash character may appear as a dash when + used in the main document text, so <span +class="ectt-1000">\foo </span>will appear as: —foo. + <!--l. 131--><p class="noindent" >When <span class="TEX">T<span +class="E">E</span>X</span> writes information to a file, fragile commands must be + protected. The <span +class="ecss-1000">name</span><a + id="dx1-2038"></a>, <span +class="ecss-1000">description</span><a + id="dx1-2039"></a> and <span +class="ecss-1000">symbol</span><a + id="dx1-2040"></a> keys all have their values written + to a file, which means that care must be taken if those values contain fragile + commands. There are two approaches: 1) the fragile commands must be + protected using <span +class="ectt-1000">\protect</span><a + id="dx1-2041"></a>; 2) the values are sanitized. Sanitizing the values + gets rid of the inconvenience of having to protect fragile commands, but at + the expense of no longer being able to use those values in the document. + Sanitization is governed by the package option <span +class="ecss-1000">sanitize</span><a + id="dx1-2042"></a> described in <a +href="#x1-130002.1">2.1 + </a><a +href="#x1-130002.1">General Options<!--tex4ht:ref: sec:pkgopts-general --></a>. <br +class="newline" /> + </p></dd><dt class="description"> +<a + id="glo:xindy"></a><span +class="ectt-1000">xindy</span><a + id="dx1-2043"></a> </dt><dd +class="description"><br +class="newline" />An flexible indexing application with multilingual support. <br +class="newline" /></dd></dl> +<!--l. 277--><p class="noindent" > +</p> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-30001"></a>Introduction</h3> +<!--l. 279--><p class="noindent" >The <span class="ecss-1000">glossaries </span>package is provided to assist generating glossaries. It has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports acronyms and glossary styles that @@ -428,91 +752,80 @@ include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary terms. Only those terms used<span class="footnote-mark"><a href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a - id="x1-2002f1"></a> + id="x1-3001f1"></a> in the document will be added to the glossary. -</p><!--l. 95--><p class="indent" > <span +</p><!--l. 292--><p class="indent" > <span class="ecbx-1000">This package replaces the </span><span class="ecsx-1000">glossary</span><a - id="dx1-2005"></a> <span + id="dx1-3005"></a> <span class="ecbx-1000">package which is now obsolete. </span>Please see the document <a href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> for assistance in upgrading. -</p><!--l. 99--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is +</p><!--l. 296--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is the necessity of having a large manual that can cover all the various settings. If you are daunted by the size of the manual, try starting off with the much shorter <a href="glossariesbegin.html" >guide for beginners</a>. -</p><!--l. 105--><p class="indent" > <div class="important" title="Important Note"> The <span +</p><!--l. 302--><p class="indent" > <div class="important" title="Important Note"> The <span class="ecss-1000">glossaries </span>package comes with a <a -href="http://www.perl.org/about.html" >Perl</a> script called <span +href="http://www.perl.org/about.html" >Perl</a> script called <a + id="dx1-3006"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-2006"></a>. This -provides a convenient interface to <span + id="dx1-3007"></a></a>. This +provides a convenient interface to <a + id="dx1-3008"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-2007"></a> or <span + id="dx1-3009"></a></a> or <a + id="dx1-3010"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-2008"></a>. It is strongly recommended that + id="dx1-3011"></a></a>. It is strongly recommended that you use this script, but <span class="ecti-1000">it is not essential</span>. If you are reluctant to install Perl, or for any -other reason you don’t want to use <span +other reason you don’t want to use <a + id="dx1-3012"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-2009"></a>, you can called <span + id="dx1-3013"></a>, you can called <a + id="dx1-3014"></a><span class="ectt-1000">makeindex</span><a - id="dx1-2010"></a> or -<span + id="dx1-3015"></a> or +<a + id="dx1-3016"></a><span class="ectt-1000">xindy</span><a - id="dx1-2011"></a> explicitly. See <a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further details. + id="dx1-3017"></a> explicitly. See <a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further details. </div> -</p><!--l. 115--><p class="noindent" > -</p><!--l. 117--><p class="indent" > This manual is structured as follows: </p> +</p><!--l. 312--><p class="noindent" > +</p><!--l. 314--><p class="indent" > The remainder of this introductory section covers the following: </p> <ul class="itemize1"> <li class="itemize"><a -href="#x1-120002">2 </a><a -href="#x1-120002">Overview of Main User Commands<!--tex4ht:ref: sec:overview --></a> gives an overview of the main user - commands and their syntax. - </li> - <li class="itemize"><a -href="#x1-500003">3 </a><a -href="#x1-500003">Mfirstuc Package<!--tex4ht:ref: sec:mfirstuc --></a> describes the associated <span -class="ecss-1000">mfirstuc </span>package. - </li></ul> -<!--l. 138--><p class="noindent" >The <a -href="glossaries.pdf" >PDF version</a> of this manual also describes more advanced commands in the -documented code section (such as determining if an entry or a glossary exists and -commands that iterate through defined terms or glossaries). -</p><!--l. 144--><p class="noindent" >The remainder of this introductory section covers the following: </p> - - - - <ul class="itemize1"> - <li class="itemize"><a -href="#x1-30001.1">1.1 </a><a -href="#x1-30001.1">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this +href="#x1-40001.1">1.1 </a><a +href="#x1-40001.1">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this package. </li> <li class="itemize"><a -href="#x1-40001.2">1.2 </a><a -href="#x1-40001.2">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write +href="#x1-50001.2">1.2 </a><a +href="#x1-50001.2">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a language other than English. </li> <li class="itemize"><a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use a post-processor to create the sorted glossaries for your document. - </li> - <li class="itemize"><a -href="#x1-110001.4">1.4 </a><a -href="#x1-110001.4">Troubleshooting<!--tex4ht:ref: sec:trouble --></a> provides some assistance in the event that you - encounter a problem.</li></ul> -<!--l. 161--><p class="noindent" > + </li></ul> + + + +<!--l. 328--><p class="noindent" > </p> -<!--l. 161--><p class="noindent" ><a +<!--l. 328--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.1 </span> <a - id="x1-30001.1"></a>Sample Documents</h4> -<!--l. 164--><p class="noindent" >The <span + id="x1-40001.1"></a>Sample Documents</h4> +<!--l. 331--><p class="noindent" >The <span class="ecss-1000">glossaries </span>package is provided with some sample documents that illustrate the various functions. These should be located in the <span class="ectt-1000">samples </span>subdirectory (folder) of @@ -525,18 +838,18 @@ glossaries documentation. For example, in a terminal or command prompt, type: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">texdoc -l glossaries</span></span> -</p><!--l. 173--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 340--><p class="indent" > <spacer type=vertical size=10> This should display the full pathname of the file <span class="ectt-1000">glossaries.pdf</span>. View the contents of that directory and see if it contains the <span class="ectt-1000">samples </span>subdirectory. -</p><!--l. 178--><p class="indent" > If you can’t find the sample files, they are available in the subdirectory +</p><!--l. 345--><p class="indent" > If you can’t find the sample files, they are available in the subdirectory <span class="ectt-1000">doc/latex/glossaries/samples/ </span>in the <span class="ectt-1000">glossaries.tds.zip </span>archive which can be downloaded from <a href="http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/" >CTAN</a>. -</p><!--l. 184--><p class="indent" > The sample documents are as follows: +</p><!--l. 351--><p class="indent" > The sample documents are as follows: </p><dl class="description"><dt class="description"> <span class="ecbx-1000">minimalgls.tex</span> </dt><dd @@ -545,70 +858,75 @@ class="description"> This document is a minimal working example. You can test yo the following steps: <ol class="enumerate1" > <li - class="enumerate" id="x1-3002x1">Run <span + class="enumerate" id="x1-4002x1">Run <span class="ectt-1000">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> either by typing <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">latex minimalgls</span></span> - <!--l. 195--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 362--><p class="noindent" ><spacer type=vertical size=10> in a terminal or by using the relevant button or menu item in your text editor or front-end. This will create the required associated files but you will - - - not see the glossary. If you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> you will also get warnings about non-existent references. These warnings may be ignored on the first run. - </p><!--l. 202--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span + </p><!--l. 369--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span class="ectt-1000">Missing</span><span class="ectt-1000"> \begin{document}</span></span></span> error, then it’s most likely that your version of <span class="ecss-1000">xkeyval</span><a - id="dx1-3003"></a> is out of date. Check the log file for a warning of + id="dx1-4003"></a> is out of date. Check the log file for a warning of that nature. If this is the case, you will need to update the <span class="ecss-1000">xkeyval</span> package. </p></li> <li - class="enumerate" id="x1-3005x2">Run <span + class="enumerate" id="x1-4005x2">Run <a + id="dx1-4006"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3006"></a> on the document. This can be done on a terminal + id="dx1-4007"></a></a> on the document. This can be done on a terminal either by typing <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeglossaries minimalgls</span></span> - <!--l. 212--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 379--><p class="noindent" ><spacer type=vertical size=10> or by typing <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">perl makeglossaries minimalgls</span></span> - </p><!--l. 216--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 383--><p class="noindent" ><spacer type=vertical size=10> If your system doesn’t recognise the command <span class="ectt-1000">perl </span>then it’s likely you don’t - have Perl installed. In which case you will need to use <span + + + + have Perl installed. In which case you will need to use <a + id="dx1-4008"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3007"></a> + id="dx1-4009"></a></a> directly. You can do this in a terminal by typing (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls</span> <span class="ectt-1000">minimalgls.glo</span></span> - </p><!--l. 223--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 390--><p class="noindent" ><spacer type=vertical size=10> (See <a -href="#x1-90001.3.3">1.3.3 </a><a -href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span +href="#x1-100001.3.3">1.3.3 </a><a +href="#x1-100001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <a + id="dx1-4010"></a><span class="ectt-1000">makeindex</span><a - id="dx1-3008"></a> + id="dx1-4011"></a> explicitly.) - </p><!--l. 227--><p class="noindent" >Note that if you need to specify the full path and the path contains + </p><!--l. 394--><p class="noindent" >Note that if you need to specify the full path and the path contains spaces, you will need to delimit the file names with the double-quote character. </p></li> <li - class="enumerate" id="x1-3010x3">Run <span + class="enumerate" id="x1-4013x3">Run <span class="ectt-1000">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> again (as step 1)</li></ol> - <!--l. 233--><p class="noindent" >You should now have a complete document. The number following each entry in + <!--l. 400--><p class="noindent" >You should now have a complete document. The number following each entry in the glossary is the location number. By default, this is the page number where the entry was referenced. </p></dd><dt class="description"> @@ -623,20 +941,21 @@ class="ectt-1000">latex sample4col</span> class="ectt-1000">makeglossaries sample4col</span> <br /><span class="ectt-1000">latex sample4col</span></span> - <!--l. 245--><p class="noindent" ><spacer type=vertical size=10> - As before, if you don’t have Perl installed, you will need to use <span + <!--l. 412--><p class="noindent" ><spacer type=vertical size=10> + As before, if you don’t have Perl installed, you will need to use <a + id="dx1-4014"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3011"></a> directly - - - - instead of using <span + id="dx1-4015"></a></a> directly + instead of using <a + id="dx1-4016"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3012"></a>. The vertical gap between entries is the gap + id="dx1-4017"></a></a>. The vertical gap between entries is the gap created at the start of each group. This can be suppressed by redefining <span class="ectt-1000">\glsgroupskip</span><a - id="dx1-3013"></a> after the glossary style has been set: + id="dx1-4018"></a> after the glossary style has been set: @@ -644,7 +963,7 @@ class="ectt-1000">\glsgroupskip</span><a <div class="verbatim" id="verbatim-1"> \renewcommand*{\glsgroupskip}{} </div> - <!--l. 253--><p class="nopar" > + <!--l. 420--><p class="nopar" > </p></dd><dt class="description"> <span class="ecbx-1000">sampleAcr.tex</span> </dt><dd @@ -660,7 +979,7 @@ class="ectt-1000">makeglossaries sampleAcr</span> class="ectt-1000">latex sampleAcr</span> <br /><span class="ectt-1000">latex sampleAcr</span></span> - <!--l. 264--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 431--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleAcrDesc.tex</span> </dt><dd @@ -677,16 +996,16 @@ class="ectt-1000">makeglossaries sampleAcrDesc</span> class="ectt-1000">latex sampleAcrDesc</span> <br /><span class="ectt-1000">latex sampleAcrDesc</span></span> - <!--l. 275--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 442--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleDesc.tex</span> </dt><dd class="description"> This is similar to the previous example, except that it defines the acronyms using <span class="ectt-1000">\newglossaryentry</span><a - id="dx1-3014"></a> instead of <span + id="dx1-4019"></a> instead of <span class="ectt-1000">\newacronym</span><a - id="dx1-3015"></a>. As with the + id="dx1-4020"></a>. As with the previous example, the glossary is added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h"> @@ -698,7 +1017,7 @@ class="ectt-1000">makeglossaries sampleDesc</span> class="ectt-1000">latex sampleDesc</span> <br /><span class="ectt-1000">latex sampleDesc</span></span> - <!--l. 287--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 454--><p class="noindent" ><spacer type=vertical size=10> @@ -714,16 +1033,30 @@ class="ectt-1000">latex sample-custom-acronym</span> class="ectt-1000">makeglossaries sample-custom-acronym</span> <br /><span class="ectt-1000">latex sample-custom-acronym</span></span> - <!--l. 296--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 463--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sample-crossref.tex</span> </dt><dd +class="description"> This document illustrates how to cross-reference entries in the + glossary. <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sample-crossref</span> + <br /><span +class="ectt-1000">makeglossaries sample-crossref</span> + <br /><span +class="ectt-1000">latex sample-crossref</span></span> + <!--l. 472--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleDB.tex</span> </dt><dd class="description"> This document illustrates how to load external files containing the glossary definitions. It also illustrates how to define a new glossary type. This - document has the number list<a - id="dx1-3016"></a> suppressed and uses <span + document has the <a + id="dx1-4021"></a><a +href="#glo:numberlist">number list<a + id="dx1-4022"></a></a> suppressed and uses <span class="ectt-1000">\glsaddall</span><a - id="dx1-3017"></a> to add all the + id="dx1-4023"></a> to add all the entries to the glossaries without referencing each one explicitly. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span @@ -732,32 +1065,39 @@ class="ectt-1000">latex sampleDB</span> class="ectt-1000">makeglossaries sampleDB</span> <br /><span class="ectt-1000">latex sampleDB</span></span> - <!--l. 308--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 484--><p class="noindent" ><spacer type=vertical size=10> The glossary definitions are stored in the accompanying files <span class="ectt-1000">database1.tex </span>and <span class="ectt-1000">database2.tex</span>. Note that if you don’t have Perl installed, you will need to use - <span + <a + id="dx1-4024"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3018"></a> twice instead of a single call to <span + id="dx1-4025"></a></a> twice instead of a single call to <a + id="dx1-4026"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3019"></a>: + id="dx1-4027"></a></a>: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-3021x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> + class="enumerate" id="x1-4029x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls</span> <span class="ectt-1000">sampleDB.glo</span></span> - <!--l. 317--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 493--><p class="noindent" ><spacer type=vertical size=10> </p></li> <li - class="enumerate" id="x1-3023x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> + class="enumerate" id="x1-4031x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> + + + <br /><span class="ectt-1000">makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not</span> <span class="ectt-1000">sampleDB.ntn</span></span> - <!--l. 321--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 497--><p class="noindent" ><spacer type=vertical size=10> </p></li></ol> </dd><dt class="description"> <span @@ -767,24 +1107,23 @@ class="description"> This document illustrates how to change the location to som class="ectt-1000">equation </span>counter is used since all glossary entries appear inside an <span class="ecss-1000">equation</span><a - id="dx1-3024"></a><a - id="dx1-3025"></a> environment. To create the document + id="dx1-4032"></a><a + id="dx1-4033"></a> environment. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">latex sampleEq</span> - - - <br /><span class="ectt-1000">makeglossaries sampleEq</span> <br /><span class="ectt-1000">latex sampleEq</span></span> - <!--l. 333--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 509--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleEqPg.tex</span> </dt><dd -class="description"> This is similar to the previous example, but the number lists<a - id="dx1-3026"></a> are a +class="description"> This is similar to the previous example, but the <a + id="dx1-4034"></a><a +href="#glo:numberlist">number list<a + id="dx1-4035"></a>s</a> are a mixture of page numbers and equation numbers. This example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run is required: @@ -797,7 +1136,7 @@ class="ectt-1000">makeglossaries sampleEqPg</span> class="ectt-1000">latex sampleEqPg</span> <br /><span class="ectt-1000">latex sampleEqPg</span></span> - <!--l. 345--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 521--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleSec.tex</span> </dt><dd @@ -815,7 +1154,10 @@ class="ectt-1000">makeglossaries sampleSec</span> class="ectt-1000">latex sampleSec</span> <br /><span class="ectt-1000">latex sampleSec</span></span> - <!--l. 357--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 533--><p class="noindent" ><spacer type=vertical size=10> + + + </p></dd><dt class="description"> <span class="ecbx-1000">sampleNtn.tex</span> </dt><dd @@ -831,41 +1173,44 @@ class="ectt-1000">makeglossaries sampleNtn</span> class="ectt-1000">latex sampleNtn</span> <br /><span class="ectt-1000">latex sampleNtn</span></span> - <!--l. 368--><p class="noindent" ><spacer type=vertical size=10> - Note that if you don’t have Perl installed, you will need to use <span + <!--l. 544--><p class="noindent" ><spacer type=vertical size=10> + Note that if you don’t have Perl installed, you will need to use <a + id="dx1-4036"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3027"></a> twice - instead of a single call to <span + id="dx1-4037"></a></a> twice + instead of a single call to <a + id="dx1-4038"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3028"></a>: - - - + id="dx1-4039"></a></a>: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-3030x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> + class="enumerate" id="x1-4041x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls</span> <span class="ectt-1000">sampleNtn.glo</span></span> - <!--l. 376--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 552--><p class="noindent" ><spacer type=vertical size=10> </p></li> <li - class="enumerate" id="x1-3032x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> + class="enumerate" id="x1-4043x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not</span> <span class="ectt-1000">sampleNtn.ntn</span></span> - <!--l. 380--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 556--><p class="noindent" ><spacer type=vertical size=10> </p></li></ol> </dd><dt class="description"> <span class="ecbx-1000">sample.tex</span> </dt><dd class="description"> This document illustrates some of the basics, including how to create child entries that use the same name as the parent entry. This example adds the - glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is required: - <spacer type=vertical size=10><span class="obeylines-h"> + glossary to the table of contents and it also uses <span +class="ectt-1000">\glsrefentry</span><a + id="dx1-4044"></a>, so an extra + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">latex sample</span> <br /><span @@ -874,18 +1219,22 @@ class="ectt-1000">makeglossaries sample</span> class="ectt-1000">latex sample</span> <br /><span class="ectt-1000">latex sample</span></span> - <!--l. 392--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 569--><p class="noindent" ><spacer type=vertical size=10> You can see the difference between word and letter ordering if you substitute <span class="ecss-1000">order=word</span><a - id="dx1-3033"></a> with <span + id="dx1-4045"></a> with <span class="ecss-1000">order=letter</span><a - id="dx1-3034"></a>. (Note that this will only have an effect if you use - <span + id="dx1-4046"></a>. (Note that this will only have an effect if you use + <a + id="dx1-4047"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3035"></a>. If you use <span + id="dx1-4048"></a></a>. If you use <a + id="dx1-4049"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3036"></a> explicitly, you will need to use the <span + id="dx1-4050"></a></a> explicitly, you will need to use the <span class="ectt-1000">-l</span> switch to indicate letter ordering.) </p></dd><dt class="description"> @@ -894,31 +1243,55 @@ class="ecbx-1000">sampletree.tex</span> </dt><dd class="description"> This document illustrates a hierarchical glossary structure where child entries have different names to their corresponding parent entry. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> + + + <br /><span class="ectt-1000">latex sampletree</span> <br /><span class="ectt-1000">makeglossaries sampletree</span> <br /><span class="ectt-1000">latex sampletree</span></span> - <!--l. 408--><p class="noindent" ><spacer type=vertical size=10> + <!--l. 585--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sample-dual.tex</span> </dt><dd +class="description"> This document illustrates how to define an entry that both appears + in the list of acronyms and in the main glossary. To create the document do: + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sample-dual</span> + <br /><span +class="ectt-1000">makeglossaries sample-dual</span> + <br /><span +class="ectt-1000">latex sample-dual</span></span> + <!--l. 594--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">samplexdy.tex</span> </dt><dd class="description"> This document illustrates how to use the <span class="ecss-1000">glossaries </span>package with - <span + <a + id="dx1-4051"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3037"></a> instead of <span + id="dx1-4052"></a></a> instead of <a + id="dx1-4053"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3038"></a>. The document uses UTF8 encoding (with the + id="dx1-4054"></a></a>. The document uses UTF8 encoding (with the <span class="ecss-1000">inputenc</span><a - id="dx1-3039"></a> package). The encoding is picked up by <span + id="dx1-4055"></a> package). The encoding is picked up by <a + id="dx1-4056"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3040"></a>. By default, this - document will create a <span + id="dx1-4057"></a></a>. By default, this + document will create a <a + id="dx1-4058"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3041"></a> style file called <span + id="dx1-4059"></a></a> style file called <span class="ectt-1000">samplexdy.xdy</span>, but if you uncomment the lines @@ -929,44 +1302,51 @@ class="ectt-1000">samplexdy.xdy</span>, but if you  <br />\noist  <br />\GlsSetXdyLanguage{} </div> - <!--l. 421--><p class="nopar" > it will set the style file to <span + <!--l. 607--><p class="nopar" > it will set the style file to <span class="ectt-1000">samplexdy-mc.xdy </span>instead. This provides an additional - letter group for entries starting with “Mc” or “Mac”. If you use <span + letter group for entries starting with “Mc” or “Mac”. If you use <a + id="dx1-4060"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3042"></a>, + id="dx1-4061"></a></a>, you don’t need to supply any additional information. If you don’t use - <span + <a + id="dx1-4062"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-3043"></a>, you will need to specify the required information. Note that if + id="dx1-4063"></a>, you will need to specify the required information. Note that if you set the style file to <span class="ectt-1000">samplexdy-mc.xdy </span>you must also specify <span class="ectt-1000">\noist</span><a - id="dx1-3044"></a>, + id="dx1-4064"></a>, otherwise the <span class="ecss-1000">glossaries </span>package will overwrite <span class="ectt-1000">samplexdy-mc.xdy </span>and you will lose the “Mc” letter group. - </p><!--l. 433--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> + </p><!--l. 619--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">latex samplexdy</span> <br /><span class="ectt-1000">makeglossaries samplexdy</span> <br /><span class="ectt-1000">latex samplexdy</span></span> - </p><!--l. 438--><p class="noindent" ><spacer type=vertical size=10> - If you don’t have Perl installed, you will have to call <span + </p><!--l. 624--><p class="noindent" ><spacer type=vertical size=10> + If you don’t have Perl installed, you will have to call <a + id="dx1-4065"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3045"></a> explicitly instead of - using <span + id="dx1-4066"></a></a> explicitly instead of + using <a + id="dx1-4067"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3046"></a>. If you are using the default style file <span + id="dx1-4068"></a></a>. If you are using the default style file <span class="ectt-1000">samplexdy.xdy</span>, then do (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o</span> <span class="ectt-1000">samplexdy.gls samplexdy.glo</span></span> - </p><!--l. 445--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 631--><p class="noindent" ><spacer type=vertical size=10> otherwise, if you are using <span class="ectt-1000">samplexdy-mc.xdy</span>, then do (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> @@ -974,17 +1354,57 @@ class="ectt-1000">samplexdy-mc.xdy</span>, then do (no line breaks): class="ectt-1000">xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls</span> <span class="ectt-1000">samplexdy.glo</span></span> - </p><!--l. 450--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 636--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">samplexdy2.tex</span> </dt><dd +class="description"> This document illustrates how to use the <span +class="ecss-1000">glossaries </span>package where + the location numbers don’t follow a standard format. This example will only work + with <a + id="dx1-4069"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-4070"></a></a>. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">pdflatex samplexdy2</span> + <br /><span +class="ectt-1000">makeglossaries samplexdy2</span> + <br /><span +class="ectt-1000">pdflatex samplexdy2</span></span> + <!--l. 646--><p class="noindent" ><spacer type=vertical size=10> + If you can’t use <a + id="dx1-4071"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-4072"></a></a> then you need to do: <spacer type=vertical size=10><span class="obeylines-h"> + + + + <br /><span +class="ectt-1000">xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o</span> + <span +class="ectt-1000">samplexdy2.gls samplexdy2.glo</span></span> + </p><!--l. 650--><p class="noindent" ><spacer type=vertical size=10> + See <a +href="#x1-3600011.2">11.2 </a><a +href="#x1-3600011.2">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details. </p></dd><dt class="description"> <span class="ecbx-1000">sampleutf8.tex</span> </dt><dd -class="description"> This is another example that uses <span +class="description"> This is another example that uses <a + id="dx1-4073"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3047"></a>. Unlike <span + id="dx1-4074"></a></a>. Unlike <a + id="dx1-4075"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3048"></a>, <span + id="dx1-4076"></a></a>, <a + id="dx1-4077"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3049"></a> + id="dx1-4078"></a></a> can cope with accented or non-Latin characters. This document uses UTF8 encoding. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span @@ -993,24 +1413,25 @@ class="ectt-1000">latex sampleutf8</span> class="ectt-1000">makeglossaries sampleutf8</span> <br /><span class="ectt-1000">latex sampleutf8</span></span> - <!--l. 460--><p class="noindent" ><spacer type=vertical size=10> - If you don’t have Perl installed, you will have to call <span + <!--l. 661--><p class="noindent" ><spacer type=vertical size=10> + If you don’t have Perl installed, you will have to call <a + id="dx1-4079"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-3050"></a> explicitly instead of - using <span + id="dx1-4080"></a></a> explicitly instead of + using <a + id="dx1-4081"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3051"></a> (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> - - - + id="dx1-4082"></a></a> (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o</span> <span class="ectt-1000">sampleutf8.gls sampleutf8.glo</span></span> - </p><!--l. 466--><p class="noindent" ><spacer type=vertical size=10> - </p><!--l. 468--><p class="noindent" >If you remove the <span + </p><!--l. 667--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 669--><p class="noindent" >If you remove the <span class="ecss-1000">xindy</span><a - id="dx1-3052"></a> option from <span + id="dx1-4083"></a> option from <span class="ectt-1000">sampleutf8.tex </span>and do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">latex sampleutf8</span> @@ -1018,56 +1439,70 @@ class="ectt-1000">latex sampleutf8</span> class="ectt-1000">makeglossaries sampleutf8</span> <br /><span class="ectt-1000">latex sampleutf8</span></span> - </p><!--l. 474--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 675--><p class="noindent" ><spacer type=vertical size=10> you will see that the entries that start with a non-Latin character now appear in the symbols group, and the word “manœuvre” is now after “manor” instead of - before it. If you are unable to use <span + before it. If you are unable to use <a + id="dx1-4084"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-3053"></a>, the call to <span + id="dx1-4085"></a></a>, the call to <a + id="dx1-4086"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-3054"></a> is as + id="dx1-4087"></a></a> is as follows (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls</span> <span class="ectt-1000">sampleutf8.glo</span></span> - </p><!--l. 482--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 683--><p class="noindent" ><spacer type=vertical size=10> </p></dd><dt class="description"> <span class="ecbx-1000">sampleaccsupp.tex</span> </dt><dd class="description"> This document uses the experimental <span class="ecss-1000">glossaries-accsupp</span><a - id="dx1-3055"></a> package. + id="dx1-4088"></a> package. The symbol is set to the replacement text. Note that some PDF viewers don’t use the accessibility support. Information about the <span class="ecss-1000">glossaries-accsupp </span>package can be found in <a -href="#x1-490002.14">2.14 </a><a -href="#x1-490002.14">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>. +href="#x1-5600017">17 </a><a +href="#x1-5600017">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>. </dd></dl> -<!--l. 494--><p class="noindent" > + + + +<!--l. 695--><p class="noindent" > </p> -<!--l. 494--><p class="noindent" ><a +<!--l. 695--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.2 </span> <a - id="x1-40001.2"></a>Multi-Lingual Support</h4> -<!--l. 497--><p class="noindent" >As from version 1.17, the <span -class="ecss-1000">glossaries </span>package can now be used with <span + id="x1-50001.2"></a>Multi-Lingual Support</h4> +<!--l. 698--><p class="noindent" >As from version 1.17, the <span +class="ecss-1000">glossaries </span>package can now be used with <a + id="dx1-5001"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-4001"></a> as well as -<span + id="dx1-5002"></a></a> as well as +<a + id="dx1-5003"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-4002"></a>. If you are writing in a language that uses accented characters or non-Latin -characters it is recommended that you use <span + id="dx1-5004"></a></a>. If you are writing in a language that uses accented characters or non-Latin +characters it is recommended that you use <a + id="dx1-5005"></a><span class="ectt-1000">xindy</span><a - id="dx1-4003"></a> as <span + id="dx1-5006"></a> as <a + id="dx1-5007"></a><span class="ectt-1000">makeindex</span><a - id="dx1-4004"></a> is hard-coded for + id="dx1-5008"></a> is hard-coded for Latin languages. This means that you are not restricted to the A, …, Z letter -groups. If you want to use <span +groups. If you want to use <a + id="dx1-5009"></a><span class="ectt-1000">xindy</span><a - id="dx1-4005"></a>, remember to use the <span + id="dx1-5010"></a>, remember to use the <span class="ecss-1000">xindy</span><a - id="dx1-4006"></a> package option. For + id="dx1-5011"></a> package option. For example: @@ -1080,67 +1515,99 @@ example:  <br />\usepackage{babel}  <br />\usepackage[xindy]{glossaries} </div> -<!--l. 511--><p class="nopar" > -</p><!--l. 513--><p class="indent" > <div class="important" title="Important Note"> If you use an accented or other expandable character at the start of an entry name, -you must place it in a group, or it will cause a problem for commands that -convert the first letter to uppercase (e.g. <span +<!--l. 712--><p class="nopar" > +</p><!--l. 714--><p class="indent" > <div class="important" title="Important Note"> Note that although an accented character, such as , looks like a plain character in +your tex file, it’s actually a macro and can therefore cause problems. +</p><!--l. 719--><p class="indent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-5013x1">If you use an accented (or other expandable) character at the start of an entry + name, you must place it in a group, or it will cause a problem for commands that + convert the first letter to uppercase (e.g. <span class="ectt-1000">\Gls</span><a - id="dx1-4007"></a>) due to expansion issues. For -example: + id="dx1-5014"></a>) due to expansion issues. For + example: -</p> - <div class="verbatim" id="verbatim-4"> -\newglossaryentry{elite}{name={{}lite}, - <br />description={select group or class}} + <div class="verbatim" id="verbatim-4"> + \newglossaryentry{elite}{name={{}lite}, +  <br />description={select group or class}} </div> -<!--l. 521--><p class="nopar" > </div> -</p><!--l. 522--><p class="noindent" > -</p><!--l. 524--><p class="indent" > If you use the <span + <!--l. 728--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-5016x2">If you use an accented (or other expandable) character in an entry name + and you haven’t switched off the <span +class="ecss-1000">name</span><a + id="dx1-5017"></a> key <a + id="dx1-5018"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-5019"></a></a>, you must use + commands like <span +class="ectt-1000">\glsentrytext</span><a + id="dx1-5020"></a> or <span +class="ectt-1000">\glstext</span><a + id="dx1-5021"></a> instead of <span +class="ectt-1000">\glsentryname</span><a + id="dx1-5022"></a> or + <span +class="ectt-1000">\glsname</span><a + id="dx1-5023"></a> or you will end up with strange looking characters in your + document. + </li></ol> +</div> +<!--l. 738--><p class="noindent" > +</p><!--l. 740--><p class="indent" > If you use the <span class="ecss-1000">inputenc</span><a - id="dx1-4008"></a> package, <span + id="dx1-5024"></a> package, <a + id="dx1-5025"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-4009"></a> will pick up the encoding from the -auxiliary file. If you use <span + id="dx1-5026"></a></a> will pick up the encoding from the +auxiliary file. If you use <a + id="dx1-5027"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-4010"></a> explicitly instead of via <span + id="dx1-5028"></a></a> explicitly instead of via <a + id="dx1-5029"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-4011"></a>, you may need + id="dx1-5030"></a>, you may need to specify the encoding using the <span -class="ectt-1000">-C </span>option. Read the <span +class="ectt-1000">-C </span>option. Read the <a + id="dx1-5031"></a><span class="ectt-1000">xindy</span><a - id="dx1-4012"></a> manual for further + id="dx1-5032"></a> manual for further details. -</p><!--l. 530--><p class="noindent" > +</p><!--l. 746--><p class="noindent" > </p> -<!--l. 530--><p class="noindent" ><a +<!--l. 746--><p class="noindent" ><a href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.2.1 </span> <a - id="x1-50001.2.1"></a>Changing the Fixed Names</h5> -<!--l. 533--><p class="noindent" >As from version 1.08, the <span + id="x1-60001.2.1"></a>Changing the Fixed Names</h5> +<!--l. 749--><p class="noindent" >As from version 1.08, the <span class="ecss-1000">glossaries </span>package now has limited multi-lingual support, thanks to all the people who have sent me the relevant translations either via email or via <span class="ectt-1000">comp.text.tex</span>. However you must load <span class="ecss-1000">babel</span><a - id="dx1-5001"></a> or <span + id="dx1-6001"></a> or <span class="ecss-1000">polyglossia</span><a - id="dx1-5002"></a> <span + id="dx1-6002"></a> <span class="ecti-1000">before </span><span class="ecss-1000">glossaries </span>to enable this. Note that if <span class="ecss-1000">babel</span><a - id="dx1-5003"></a> is loaded and the <span + id="dx1-6003"></a> is loaded and the <span class="ecss-1000">translator</span><a - id="dx1-5004"></a> package is detected on <span class="TEX">T<span + id="dx1-6004"></a> package is detected on <span class="TEX">T<span class="E">E</span>X</span>’s path, then the <span class="ecss-1000">translator</span><a - id="dx1-5005"></a> package will be loaded automatically. However, it may not pick + id="dx1-6005"></a> package will be loaded automatically. However, it may not pick up on the required languages so, if the predefined text is not translated, you may need to explicitly load the <span class="ecss-1000">translator</span><a - id="dx1-5006"></a> package with the required languages. For + id="dx1-6006"></a> package with the required languages. For example: @@ -1151,7 +1618,7 @@ example:  <br />\usepackage[spanish]{translator}  <br />\usepackage{glossaries} </div> -<!--l. 548--><p class="nopar" > Alternatively, specify the language as a class option rather than a package option. For +<!--l. 764--><p class="nopar" > Alternatively, specify the language as a class option rather than a package option. For example: @@ -1162,17 +1629,17 @@ example:  <br />\usepackage{babel}  <br />\usepackage{glossaries} </div> -<!--l. 556--><p class="nopar" > -</p><!--l. 558--><p class="indent" > If you want to use <span +<!--l. 772--><p class="nopar" > +</p><!--l. 774--><p class="indent" > If you want to use <span class="ecss-1000">ngerman</span><a - id="dx1-5007"></a> or <span + id="dx1-6007"></a> or <span class="ecss-1000">german</span><a - id="dx1-5008"></a> instead of <span + id="dx1-6008"></a> instead of <span class="ecss-1000">babel</span><a - id="dx1-5009"></a>, you will need to include the + id="dx1-6009"></a>, you will need to include the <span class="ecss-1000">translator</span><a - id="dx1-5010"></a> package to provide the translations. For example: + id="dx1-6010"></a> package to provide the translations. For example: @@ -1183,28 +1650,29 @@ class="ecss-1000">translator</span><a  <br />\usepackage{translator}  <br />\usepackage{glossaries} </div> -<!--l. 566--><p class="nopar" > -</p><!--l. 568--><p class="indent" > The languages are currently supported by the <span +<!--l. 782--><p class="nopar" > +</p><!--l. 784--><p class="indent" > The languages are currently supported by the <span class="ecss-1000">glossaries </span>package are listed in <a -href="#x1-50111">table 1</a>. +href="#x1-60111">table 1</a>. Please note that (apart from spelling mistakes) I don’t intend to change the +default translations as it will cause compatibility problems. </p> <div class="table"> -<!--l. 572--><p class="indent" > <a - id="x1-50111"></a></p><hr class="float" /><div class="float" +<!--l. 790--><p class="indent" > <a + id="x1-60111"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 1: </span><span -class="content">Supported Languages</span></div><!--tex4ht:label?: x1-50111 --> +class="content">Supported Languages</span></div><!--tex4ht:label?: x1-60111 --> <div class="center" > -<!--l. 575--><p class="noindent" > +<!--l. 793--><p class="noindent" > </p> <div class="tabular"> <table id="TBL-2" class="tabular" cellspacing="0" cellpadding="0" @@ -1269,28 +1737,28 @@ class="td11"> 1.08 </td></tr></table> </div><hr class="endfloat" /> </div> -<!--l. 594--><p class="indent" > The language dependent commands and <span +<!--l. 812--><p class="indent" > The language dependent commands and <span class="ecss-1000">translator</span><a - id="dx1-5012"></a> keys used by the glossaries + id="dx1-6012"></a> keys used by the glossaries package are listed in <a -href="#x1-50132">table 2</a>. +href="#x1-60132">table 2</a>. </p> <div class="table"> -<!--l. 597--><p class="indent" > <a - id="x1-50132"></a></p><hr class="float" /><div class="float" +<!--l. 815--><p class="indent" > <a + id="x1-60132"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 2: </span><span -class="content">Customised Text</span></div><!--tex4ht:label?: x1-50132 --> +class="content">Customised Text</span></div><!--tex4ht:label?: x1-60132 --> <div class="center" > -<!--l. 600--><p class="noindent" > +<!--l. 818--><p class="noindent" > </p> <div class="tabular"> <table id="TBL-3" class="tabular" cellspacing="0" cellpadding="0" @@ -1303,86 +1771,86 @@ class="td01"><span class="ecbx-1000">Command Name </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-1-2" class="td11"><span class="ecbx-1000">Translator Key Word </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-1-3" -class="td10"><!--l. 603--><p class="noindent" ><span +class="td10"><!--l. 821--><p class="noindent" ><span class="ecbx-1000">Purpose</span> </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-1" class="td01"><span class="ectt-1000">\glossaryname</span><a - id="dx1-5014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-2" + id="dx1-6014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-2" class="td11"><span class="ectt-1000">Glossary </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-2-3" -class="td10"><!--l. 604--><p class="noindent" >Title of the main glossary. </p></td> +class="td10"><!--l. 822--><p class="noindent" >Title of the main glossary. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-1" class="td01"><span class="ectt-1000">\acronymname</span><a - id="dx1-5015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-2" + id="dx1-6015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-2" class="td11"><span class="ectt-1000">Acronyms </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-3-3" -class="td10"><!--l. 605--><p class="noindent" >Title of the list of acronyms +class="td10"><!--l. 823--><p class="noindent" >Title of the list of acronyms (when used with package option <span class="ecss-1000">acronym</span><a - id="dx1-5016"></a>). </p></td> + id="dx1-6016"></a>). </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-1" class="td01"><span class="ectt-1000">\entryname</span><a - id="dx1-5017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-2" + id="dx1-6017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-2" class="td11"><span class="ectt-1000">Notation (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-4-3" -class="td10"><!--l. 608--><p class="noindent" >Header for first column in the +class="td10"><!--l. 826--><p class="noindent" >Header for first column in the glossary (for 2, 3 or 4 column glossaries that support headers).</p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-1" class="td01"><span class="ectt-1000">\descriptionname</span><a - id="dx1-5018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-2" + id="dx1-6018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-2" class="td11"><span class="ectt-1000">Description (glossaries)</span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-5-3" -class="td10"><!--l. 611--><p class="noindent" >Header for second column in the +class="td10"><!--l. 829--><p class="noindent" >Header for second column in the glossary (for 2, 3 or 4 column glossaries that support headers).</p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-1" class="td01"><span class="ectt-1000">\symbolname</span><a - id="dx1-5019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-2" + id="dx1-6019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-2" class="td11"><span class="ectt-1000">Symbol (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-6-3" -class="td10"><!--l. 613--><p class="noindent" >Header for symbol column in the +class="td10"><!--l. 831--><p class="noindent" >Header for symbol column in the glossary for glossary styles that support this option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-1" class="td01"><span class="ectt-1000">\pagelistname</span><a - id="dx1-5020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-2" + id="dx1-6020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-2" class="td11"><span class="ectt-1000">Page List (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-7-3" -class="td10"><!--l. 616--><p class="noindent" >Header for page list column in +class="td10"><!--l. 834--><p class="noindent" >Header for page list column in the glossary for glossaries that support this option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-1" class="td01"><span class="ectt-1000">\glssymbolsgroupname</span><a - id="dx1-5021"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-2" + id="dx1-6021"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-2" class="td11"><span class="ectt-1000">Symbols (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-8-3" -class="td10"><!--l. 619--><p class="noindent" >Header for symbols section of the +class="td10"><!--l. 837--><p class="noindent" >Header for symbols section of the glossary for glossary styles that support this option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-1" class="td01"><span class="ectt-1000">\glsnumbersgroupname</span><a - id="dx1-5022"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-2" + id="dx1-6022"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-2" class="td11"><span class="ectt-1000">Numbers (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-9-3" -class="td10"><!--l. 621--><p class="noindent" >Header for numbers section of +class="td10"><!--l. 839--><p class="noindent" >Header for numbers section of the glossary for glossary styles that support this option. </p></td> </tr></table></div></div> @@ -1391,56 +1859,96 @@ that support this option. </p></td> </div><hr class="endfloat" /> </div> -<!--l. 628--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations +<!--l. 846--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the <span class="ecss-1000">babel</span><a - id="dx1-5023"></a> package and do not have the + id="dx1-6023"></a> package and do not have the <span class="ecss-1000">translator</span><a - id="dx1-5024"></a> package installed, you need to be familiar with the advice given in -<a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words babel uses</a>. If you have the <span + id="dx1-6024"></a> package installed, you need to be familiar with the advice given in <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing +the words babel uses</a>. If you have the <span class="ecss-1000">translator</span><a - id="dx1-5025"></a> package installed, -then you can provide your own dictionary with the necessary modifications -(using <span -class="ectt-1000">\deftranslation</span>) and load it using <span -class="ectt-1000">\usedictionary</span>. Note that the -dictionaries are loaded at the beginning of the document, so it won’t have -any effect if you put <span -class="ectt-1000">\deftranslation </span>in the preamble. It should be put in -your personal dictionary instead. See the <span + id="dx1-6025"></a> package installed, then you can provide +your own dictionary with the necessary modifications (using <span +class="ectt-1000">\deftranslation</span>) and +load it using <span +class="ectt-1000">\usedictionary</span>. +</p><!--l. 856--><p class="indent" > <div class="important" title="Important Note"> Note that the dictionaries are loaded at the beginning of the document, so it won’t +have any effect if you put <span +class="ectt-1000">\deftranslation </span>in the preamble. It should be +put in your personal dictionary instead (as in the example below). See the +<span class="ecss-1000">translator</span><a - id="dx1-5026"></a> documentation for further -details. -</p><!--l. 642--><p class="indent" > If you are using <span + id="dx1-6026"></a> documentation for further details. (Now with <span +class="ecss-1000">beamer</span><a + id="dx1-6027"></a> documentation.) +</div> +</p><!--l. 863--><p class="noindent" > +</p><!--l. 865--><p class="indent" > Your custom dictionary doesn’t have to be just a translation from English to +another language. You may prefer to have a dictionary for a particular type of +document. For example, suppose your institution’s in-house reports have to have the +glossary labelled as “Nomenclature” and the page list should be labelled “Location”, +then you can create a file called, say, + + + +</p> + <div class="verbatim" id="verbatim-8"> +myinstitute-glossaries-dictionary-English.dict +</div> +<!--l. 873--><p class="nopar" > that contains the following: + + + +</p> + <div class="verbatim" id="verbatim-9"> +\ProvidesDictionary{myinstitute-glossaries-dictionary}{English} + <br />\deftranslation{Glossary}{Nomenclature} + <br />\deftranslation{Page List (glossaries)}{Location} +</div> +<!--l. 879--><p class="nopar" > You can now load it using: + + + +</p> + <div class="verbatim" id="verbatim-10"> +\usedictionary{myinstitute-glossaries-dictionary} +</div> +<!--l. 883--><p class="nopar" > (Make sure that <span +class="ectt-1000">myinstitute-glossaries-dictionary-English.dict </span>can be found +by <span class="TEX">T<span +class="E">E</span>X</span>.) If you want to share your custom dictionary, you can upload it to +<a +href="http://www.ctan.org/" >CTAN</a>. +</p><!--l. 888--><p class="indent" > If you are using <span class="ecss-1000">babel</span><a - id="dx1-5027"></a> and don’t want to use the <span + id="dx1-6028"></a> and don’t want to use the <span class="ecss-1000">translator</span><a - id="dx1-5028"></a> interface, you can + id="dx1-6029"></a> interface, you can suppress it using the package option <span class="ecss-1000">translate=false</span><a - id="dx1-5029"></a>, and either load <span + id="dx1-6030"></a>, and either load <span class="ecss-1000">glossaries-babel</span><a - id="dx1-5030"></a> + id="dx1-6031"></a> after <span class="ecss-1000">glossaries </span>or specify you’re own translations. For example: </p> - <div class="verbatim" id="verbatim-8"> + <div class="verbatim" id="verbatim-11"> \documentclass[british]{article}  <br />\usepackage{babel}  <br />\usepackage[translate=false]{glossaries}  <br />\usepackage{glossaries-babel} </div> -<!--l. 653--><p class="nopar" > or: +<!--l. 899--><p class="nopar" > or: </p> - <div class="verbatim" id="verbatim-9"> + <div class="verbatim" id="verbatim-12"> \documentclass[british]{article}  <br />\usepackage{babel}  <br />\usepackage[translate=false]{glossaries} @@ -1455,139 +1963,232 @@ class="ecss-1000">glossaries </span>or specify you’re own translations. Fo  <br />    \renewcommand*{\glsnumbersgroupname}{Numbers}%  <br />} </div> -<!--l. 671--><p class="nopar" > -</p><!--l. 673--><p class="indent" > If you are using <span +<!--l. 917--><p class="nopar" > +</p><!--l. 919--><p class="indent" > If you are using <span class="ecss-1000">polyglossia</span><a - id="dx1-5031"></a> instead of <span + id="dx1-6032"></a> instead of <span class="ecss-1000">babel</span><a - id="dx1-5032"></a>, <span + id="dx1-6033"></a>, <span class="ecss-1000">glossaries-polyglossia</span><a - id="dx1-5033"></a> will automatically + id="dx1-6034"></a> will automatically be loaded unless you specify the package option <span class="ecss-1000">translate=false</span><a - id="dx1-5034"></a>. -</p><!--l. 677--><p class="indent" > Note that <span + id="dx1-6035"></a>. +</p><!--l. 923--><p class="indent" > Note that <a + id="dx1-6036"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-5035"></a> provides much better multi-lingual support than <span + id="dx1-6037"></a></a> provides much better multi-lingual support than <a + id="dx1-6038"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-5036"></a>, so it’s -recommended that you use <span + id="dx1-6039"></a></a>, so it’s +recommended that you use <a + id="dx1-6040"></a><span class="ectt-1000">xindy</span><a - id="dx1-5037"></a> if you have glossary entries that contain diacritics or + id="dx1-6041"></a> if you have glossary entries that contain diacritics or non-Roman letters. See <a -href="#x1-290002.8.2">2.8.2 </a><a -href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details. +href="#x1-3400011">11 </a><a +href="#x1-3400011">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details. </p> -<!--l. 683--><p class="noindent" ><a +<!--l. 929--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.3 </span> <a - id="x1-60001.3"></a>Generating the Associated Glossary Files</h4> -<!--l. 686--><p class="noindent" >In order to generate a sorted glossary with compact location lists, it is necessary to use + id="x1-70001.3"></a>Generating the Associated Glossary Files</h4> +<!--l. 932--><p class="noindent" >In order to generate a sorted glossary with compact location lists, it is necessary to use an external indexing application as an intermediate step. It is this application that creates the file containing the code that typesets the glossary. If this step is omitted, the glossaries will not appear in your document. The two indexing applications that are most commonly used with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> are <span +class="E">E</span>X</span></span> are <a + id="dx1-7001"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6001"></a> and <span + id="dx1-7002"></a></a> and <a + id="dx1-7003"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6002"></a>. As from version 1.17, + id="dx1-7004"></a></a>. As from version 1.17, the <span class="ecss-1000">glossaries </span>package can be used with either of these applications. Previous versions -were designed to be used with <span +were designed to be used with <a + id="dx1-7005"></a><span class="ectt-1000">makeindex</span><a - id="dx1-6003"></a> only. Note that <span + id="dx1-7006"></a> only. Note that <a + id="dx1-7007"></a><span class="ectt-1000">xindy</span><a - id="dx1-6004"></a> has much better -multi-lingual support than <span + id="dx1-7008"></a> has much better +multi-lingual support than <a + id="dx1-7009"></a><span class="ectt-1000">makeindex</span><a - id="dx1-6005"></a>, so <span + id="dx1-7010"></a>, so <a + id="dx1-7011"></a><span class="ectt-1000">xindy</span><a - id="dx1-6006"></a> is recommended if you’re not writing -in English. Commands that only have an effect when <span + id="dx1-7012"></a> is recommended if you’re not writing +in English. Commands that only have an effect when <a + id="dx1-7013"></a><span class="ectt-1000">xindy</span><a - id="dx1-6007"></a> is used are described in -<a -href="#x1-290002.8.2">2.8.2 </a><a -href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a>. -</p><!--l. 702--><p class="indent" > The <span -class="ecss-1000">glossaries </span>package comes with the Perl script <span + id="dx1-7014"></a> is used are described in <a +href="#x1-3400011">11 +</a><a +href="#x1-3400011">Xindy<!--tex4ht:ref: sec:xindy --></a>. +</p><!--l. 947--><p class="indent" > The <span +class="ecss-1000">glossaries </span>package comes with the Perl script <a + id="dx1-7015"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-6008"></a> which will run -<span + id="dx1-7016"></a></a> which will run +<a + id="dx1-7017"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6009"></a> or <span + id="dx1-7018"></a></a> or <a + id="dx1-7019"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6010"></a> on all the glossary files using a customized style file (which is + id="dx1-7020"></a></a> on all the glossary files using a customized style file (which is created by <span class="ectt-1000">\makeglossaries</span><a - id="dx1-6011"></a>). See <a -href="#x1-70001.3.1">1.3.1 </a><a -href="#x1-70001.3.1">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for + id="dx1-7021"></a>). See <a +href="#x1-80001.3.1">1.3.1 </a><a +href="#x1-80001.3.1">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further details. Perl is stable, cross-platform, open source software that is used by a number of <span class="TEX">T<span class="E">E</span>X</span>-related applications. Further information is available at <a href="http://www.perl.org/about.html" class="url" ><span -class="ectt-1000">http://www.perl.org/about.html</span></a>. However, whilst it is strongly recommended that +class="ectt-1000">http://www.perl.org/about.html</span></a>. The advantages of using <a + id="dx1-7022"></a><span +class="ectt-1000">makeglossaries</span><a + id="dx1-7023"></a>: +</p> -you use the <span + <ul class="itemize1"> + <li class="itemize">It automatically detects whether to use <a + id="dx1-7024"></a><span +class="ectt-1000">makeindex</span><a + id="dx1-7025"></a> or <a + id="dx1-7026"></a><span +class="ectt-1000">xindy</span><a + id="dx1-7027"></a> and sets the + relevant application switches. + </li> + <li class="itemize">One call of <a + id="dx1-7028"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-6012"></a> script, it is possible to use the <span -class="ecss-1000">glossaries </span>package without -having Perl installed. In which case, if you have used the <span + id="dx1-7029"></a> will run <a + id="dx1-7030"></a><span +class="ectt-1000">makeindex</span><a + id="dx1-7031"></a>/<a + id="dx1-7032"></a><span +class="ectt-1000">xindy</span><a + id="dx1-7033"></a> for each glossary + type. + </li> + <li class="itemize">If things go wrong, <a + id="dx1-7034"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-7035"></a></a> will scan the messages from <a + id="dx1-7036"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-7037"></a></a> + or <a + id="dx1-7038"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-7039"></a></a> and attempt to diagnose the problem in relation to the <span +class="ecss-1000">glossaries</span> + package. This will hopefully provide more helpful messages in some cases. If + it can’t diagnose the problem, you will have to read the relevant transcript + file and see if you can work it out from the <a + id="dx1-7040"></a><span +class="ectt-1000">makeindex</span><a + id="dx1-7041"></a> or <a + id="dx1-7042"></a><span +class="ectt-1000">xindy</span><a + id="dx1-7043"></a> messages. + </li></ul> +<!--l. 973--><p class="indent" > Whilst it is strongly recommended that you use the <a + id="dx1-7044"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-7045"></a></a> script, it is +possible to use the <span +class="ecss-1000">glossaries </span>package without having Perl installed. In which case, +if you have used the <span class="ecss-1000">xindy</span><a - id="dx1-6013"></a> package option, you will -need to use <span + id="dx1-7046"></a> package option, you will need to use <a + id="dx1-7047"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6014"></a> (see <a -href="#x1-80001.3.2">1.3.2 </a><a -href="#x1-80001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a>), otherwise you will need to use -<span + id="dx1-7048"></a></a> (see +<a +href="#x1-90001.3.2">1.3.2 </a><a +href="#x1-90001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a>), otherwise you will need to use <a + id="dx1-7049"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6015"></a> (see <a -href="#x1-90001.3.3">1.3.3 </a><a -href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>). Note that some commands and -package options have no effect if you don’t use <span + id="dx1-7050"></a></a> (see +<a +href="#x1-100001.3.3">1.3.3 </a><a +href="#x1-100001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>). Note that some commands and package +options have no effect if you don’t use <a + id="dx1-7051"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-6016"></a>. These are listed in + id="dx1-7052"></a>. These are listed in <a -href="#x1-60303">table 3</a>. -</p><!--l. 720--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside the -glossary, you will need to do an additional <span +href="#x1-70813">table 3</a>. +</p><!--l. 983--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside the +glossary, you will need to do an additional <a + id="dx1-7053"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-6017"></a>, <span + id="dx1-7054"></a></a>, <a + id="dx1-7055"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6018"></a> or -<span + id="dx1-7056"></a></a> or +<a + id="dx1-7057"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6019"></a> run, as appropriate. For example, suppose you have defined the following -entries: + id="dx1-7058"></a></a> run, as appropriate. For example, suppose you have defined the following +entries:<span class="footnote-mark"><a +href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a + id="x1-7059f2"></a> </p> - <div class="verbatim" id="verbatim-10"> + <div class="verbatim" id="verbatim-13"> \newglossaryentry{citrusfruit}{name={citrus fruit},  <br />description={fruit of any citrus tree. (See also  <br />\gls{orange})}}  <br />\newglossaryentry{orange}{name={orange},  <br />description={an orange coloured fruit.}} </div> -<!--l. 732--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span +<!--l. 998--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\gls{citrusfruit}</span></span></span> in your document but don’t reference the <span class="ectt-1000">orange </span>entry, then the <span class="ectt-1000">orange </span>entry won’t appear in your glossary until you first -create the glossary and then do another run of <span +create the glossary and then do another run of <a + id="dx1-7063"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-6020"></a>, <span + id="dx1-7064"></a></a>, <a + id="dx1-7065"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6021"></a> or -<span + id="dx1-7066"></a></a> or +<a + id="dx1-7067"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6022"></a>. For example, if the document is called <span + id="dx1-7068"></a></a>. For example, if the document is called <span class="ectt-1000">myDoc.tex</span>, then you must do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span @@ -1600,30 +2201,40 @@ class="ectt-1000">latex myDoc</span> class="ectt-1000">makeglossaries myDoc</span> <br /><span class="ectt-1000">latex myDoc</span></span> -</p><!--l. 746--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 748--><p class="indent" > Likewise, an additional <span +</p><!--l. 1012--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1014--><p class="indent" > Likewise, an additional <a + id="dx1-7069"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-6023"></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-7070"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run -may push glossary entries across page boundaries, which means that the number lists<a - id="dx1-6024"></a> in +may push glossary entries across page boundaries, which means that the <a + id="dx1-7071"></a><a +href="#glo:numberlist">number list<a + id="dx1-7072"></a>s</a> in the glossary may need updating. -</p><!--l. 756--><p class="indent" > The examples in this document assume that you are accessing <span +</p><!--l. 1022--><p class="indent" > The examples in this document assume that you are accessing <a + id="dx1-7073"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-6025"></a>, <span + id="dx1-7074"></a></a>, <a + id="dx1-7075"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6026"></a> -or <span + id="dx1-7076"></a></a> +or <a + id="dx1-7077"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6027"></a> via a terminal. Windows users can use the MSDOS Prompt which is + id="dx1-7078"></a></a> via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the <span class="ecss-1000">Start->All Programs </span>menu or <span class="ecss-1000">Start->All Programs->Accessories</span> menu. -</p><!--l. 762--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will +</p><!--l. 1028--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the required application. The article <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" >“Glossaries, Nomenclature, List of Symbols and Acronyms”</a> in the <a @@ -1635,19 +2246,19 @@ from a WinEdt macro”</a> on the <span class="ectt-1000">comp.text.tex </span>newsgroup describes how to do it for WinEdt. For other editors see the editor’s user manual for further details. -</p><!--l. 774--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span +</p><!--l. 1040--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span class="ectt-1000">.glg</span><a - id="dx1-6028"></a> or <span + id="dx1-7079"></a> or <span class="ectt-1000">.alg</span><a - id="dx1-6029"></a>) for + id="dx1-7080"></a>) for messages. </p> <div class="table"> -<!--l. 777--><p class="indent" > <a - id="x1-60303"></a></p><hr class="float" /><div class="float" +<!--l. 1043--><p class="indent" > <a + id="x1-70813"></a></p><hr class="float" /><div class="float" > @@ -1657,7 +2268,7 @@ messages. class="content">Commands and package options that have no effect when using <span class="ectt-1000">xindy</span> or <span -class="ectt-1000">makeindex </span>explicitly</span></div><!--tex4ht:label?: x1-60303 --> +class="ectt-1000">makeindex </span>explicitly</span></div><!--tex4ht:label?: x1-70813 --> <div class="tabular"> <table id="TBL-4" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-4-1g"><col @@ -1667,17 +2278,21 @@ id="TBL-4-3" /></colgroup><tr style="vertical-align:baseline;" id="TBL-4-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-1" class="td01"><span class="ecbx-1000">Command or Package Option </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-2" -class="td11"><span +class="td11"><a + id="dx1-7082"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-6031"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3" -class="td10"><span + id="dx1-7083"></a></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3" +class="td10"><a + id="dx1-7084"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-6032"></a> </td> + id="dx1-7085"></a></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-1" class="td01"><span class="ecss-1000">order=letter</span><a - id="dx1-6033"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2" + id="dx1-7086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2" class="td11">use <span class="ectt-1000">-l </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3" class="td10">use <span @@ -1686,14 +2301,14 @@ class="ectt-1000">-M ord/letorder </span></td> style="vertical-align:baseline;" id="TBL-4-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-1" class="td01"><span class="ecss-1000">order=word</span><a - id="dx1-6034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2" + id="dx1-7087"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2" class="td11">default </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-3" class="td10">default </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-1" class="td01"><span class="ecss-1000">xindy</span><a - id="dx1-6035"></a>={<span + id="dx1-7088"></a>={<span class="ecss-1000">language=</span><span class="cmsy-10">⟨</span><span class="ecti-1000">lang</span><span @@ -1716,7 +2331,7 @@ class="cmsy-10">⟩</span></td> style="vertical-align:baseline;" id="TBL-4-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-1" class="td01"><span class="ectt-1000">\GlsSetXdyLanguage</span><a - id="dx1-6036"></a><span + id="dx1-7089"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">lang</span><span @@ -1732,7 +2347,7 @@ class="cmsy-10">⟩ </span></td> style="vertical-align:baseline;" id="TBL-4-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-1" class="td01"><span class="ectt-1000">\GlsSetXdyCodePage</span><a - id="dx1-6037"></a><span + id="dx1-7090"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">code</span><span @@ -1750,23 +2365,30 @@ class="cmsy-10">⟩ </span></td></tr></table> </div><hr class="endfloat" /> </div> -<!--l. 799--><p class="noindent" ><a +<!--l. 1065--><p class="noindent" ><a href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.1 </span> <a - id="x1-70001.3.1"></a>Using the makeglossaries Perl Script</h5> -<!--l. 802--><p class="noindent" >The <span + id="x1-80001.3.1"></a>Using the makeglossaries Perl Script</h5> +<!--l. 1068--><p class="noindent" >The <a + id="dx1-8001"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-7001"></a> script picks up the relevant information from the auxiliary (<span + id="dx1-8002"></a></a> script picks up the relevant information from the auxiliary (<span class="ectt-1000">.aux</span><a - id="dx1-7002"></a>) -file and will either call <span + id="dx1-8003"></a>) +file and will either call <a + id="dx1-8004"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-7003"></a> or <span + id="dx1-8005"></a></a> or <a + id="dx1-8006"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-7004"></a>, depending on the supplied information. + id="dx1-8007"></a></a>, depending on the supplied information. Therefore, you only need to pass the document’s name without the extension to -<span +<a + id="dx1-8008"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-7005"></a>. For example, if your document is called <span + id="dx1-8009"></a>. For example, if your document is called <span class="ectt-1000">myDoc.tex</span>, type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span @@ -1775,58 +2397,85 @@ class="ectt-1000">latex myDoc</span> class="ectt-1000">makeglossaries myDoc</span> <br /><span class="ectt-1000">latex myDoc</span></span> -</p><!--l. 813--><p class="indent" > <spacer type=vertical size=10> -You may need to explicitly load <span +</p><!--l. 1079--><p class="indent" > <spacer type=vertical size=10> +You may need to explicitly load <a + id="dx1-8010"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-7006"></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-8011"></a></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">perl makeglossaries myDoc</span></span> -</p><!--l. 817--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1083--><p class="indent" > <spacer type=vertical size=10> There is a batch file called <span class="ectt-1000">makeglossaries.bat </span>which does this for Windows users, but you must have Perl installed to be able to use it. -</p><!--l. 822--><p class="indent" > The <span +</p><!--l. 1088--><p class="indent" > The <a + id="dx1-8012"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-7007"></a> script contains POD (Plain Old Documentation). If you want, -you can create a man page for <span + id="dx1-8013"></a></a> script contains POD (Plain Old Documentation). If you +want, you can create a man page for <a + id="dx1-8014"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-7008"></a> using <span + id="dx1-8015"></a> using <span class="ectt-1000">pod2man</span><a - id="dx1-7009"></a> and move the resulting -file onto the man path. -</p><!--l. 828--><p class="noindent" > + id="dx1-8016"></a> and +move the resulting file onto the man path. Alternatively do <span +class="ectt-1000">makeglossaries</span> +<span +class="ectt-1000">--help </span>for a list of all options or <span +class="ectt-1000">makeglossaries --version </span>for the version +number. +</p><!--l. 1095--><p class="indent" > <div class="important" title="Important Note"> When upgrading the <span +class="ecss-1000">glossaries </span>package, make sure you also upgrade your version of +<a + id="dx1-8017"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-8018"></a></a>. The current version is 2.02. </div> +</p><!--l. 1099--><p class="noindent" > +</p><!--l. 1101--><p class="noindent" > </p> -<!--l. 828--><p class="noindent" ><a +<!--l. 1101--><p class="noindent" ><a href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.2 </span> <a - id="x1-80001.3.2"></a>Using xindy explicitly</h5> -<!--l. 831--><p class="noindent" >If you want to use <span + id="x1-90001.3.2"></a>Using xindy explicitly</h5> +<!--l. 1104--><p class="noindent" >If you want to use <a + id="dx1-9001"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8001"></a> to process the glossary files, you must make sure you have + id="dx1-9002"></a></a> to process the glossary files, you must make sure you have used the <span class="ecss-1000">xindy</span><a - id="dx1-8002"></a> package option: + id="dx1-9003"></a> package option: </p> - <div class="verbatim" id="verbatim-11"> + <div class="verbatim" id="verbatim-14"> \usepackage[xindy]{glossaries} </div> -<!--l. 836--><p class="nopar" > This is required regardless of whether you use <span +<!--l. 1109--><p class="nopar" > This is required regardless of whether you use <a + id="dx1-9004"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8003"></a> explicitly or whether it’s called -implicitly via <span + id="dx1-9005"></a></a> explicitly or whether it’s called +implicitly via <a + id="dx1-9006"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-8004"></a>. This causes the glossary entries to be written in raw -<span + id="dx1-9007"></a></a>. This causes the glossary entries to be written in raw +<a + id="dx1-9008"></a><span class="ectt-1000">xindy</span><a - id="dx1-8005"></a> format, so you need to use <span + id="dx1-9009"></a> format, so you need to use <span class="ectt-1000">-I xindy </span><span class="ecti-1000">not </span><span class="ectt-1000">-I tex</span>. -</p><!--l. 843--><p class="indent" > To run <span +</p><!--l. 1116--><p class="indent" > To run <a + id="dx1-9010"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8006"></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-9011"></a></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">xindy -L </span><span class="cmsy-10">⟨</span><span @@ -1854,7 +2503,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">base</span><span class="cmsy-10">⟩</span><span class="ectt-1000">.glo</span></span> -</p><!--l. 847--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1120--><p class="indent" > <spacer type=vertical size=10> where <span class="cmsy-10">⟨</span><span class="ecti-1000">language</span><span @@ -1867,23 +2516,25 @@ class="ecti-1000">base</span><span class="cmsy-10">⟩ </span>is the name of the document without the <span class="ectt-1000">.tex</span><a - id="dx1-8007"></a> extension and <span + id="dx1-9012"></a> extension and <span class="cmsy-10">⟨</span><span class="ecti-1000">style</span><span class="cmsy-10">⟩ </span>is the name of -the <span +the <a + id="dx1-9013"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8008"></a> style file without the <span + id="dx1-9014"></a></a> style file without the <span class="ectt-1000">.xdy</span><a - id="dx1-8009"></a> extension. The default name for this + id="dx1-9015"></a> extension. The default name for this style file is <span class="cmsy-10">⟨</span><span class="ecti-1000">base</span><span class="cmsy-10">⟩</span><span class="ectt-1000">.xdy</span><a - id="dx1-8010"></a> but can be changed via <span + id="dx1-9016"></a> but can be changed via <span class="ectt-1000">\setStyleFile</span><a - id="dx1-8011"></a><span + id="dx1-9017"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">style</span><span @@ -1892,73 +2543,84 @@ class="ectt-1000">}</span>. You may need to specify the full path name depending on the current working directory. If any of the file names contain spaces, you must delimit them using double-quotes. -</p><!--l. 858--><p class="indent" > For example, if your document is called <span +</p><!--l. 1131--><p class="indent" > For example, if your document is called <span class="ectt-1000">myDoc.tex </span>and you are using UTF8 encoding in English, then type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls</span> <span class="ectt-1000">myDoc.glo</span></span> -</p><!--l. 863--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 865--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of +</p><!--l. 1136--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1138--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of the other glossaries (including the list of acronyms if you have used the <span class="ecss-1000">acronym</span><a - id="dx1-8012"></a> + id="dx1-9018"></a> package option), substituting <span class="ectt-1000">.glg</span><a - id="dx1-8013"></a>, <span + id="dx1-9019"></a>, <span class="ectt-1000">.gls</span><a - id="dx1-8014"></a> and <span + id="dx1-9020"></a> and <span class="ectt-1000">.glo</span><a - id="dx1-8015"></a> with the relevant extensions. For + id="dx1-9021"></a> with the relevant extensions. For example, if you have used the <span class="ecss-1000">acronym</span><a - id="dx1-8016"></a> package option, then you would need to do: + id="dx1-9022"></a> package option, then you would need to do: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr</span> <span class="ectt-1000">myDoc.acn</span></span> -</p><!--l. 874--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1147--><p class="indent" > <spacer type=vertical size=10> For additional glossaries, the extensions are those supplied when you created the glossary with <span class="ectt-1000">\newglossary</span><a - id="dx1-8017"></a>. -</p><!--l. 878--><p class="indent" > Note that if you use <span + id="dx1-9023"></a>. +</p><!--l. 1151--><p class="indent" > Note that if you use <a + id="dx1-9024"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-8018"></a> instead, you can replace all those calls to -<span + id="dx1-9025"></a></a> instead, you can replace all those calls to +<a + id="dx1-9026"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8019"></a> with just one call to <span + id="dx1-9027"></a></a> with just one call to <a + id="dx1-9028"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-8020"></a>: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-9029"></a>: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeglossaries myDoc</span></span> -</p><!--l. 883--><p class="indent" > <spacer type=vertical size=10> -Note also that some commands and package options have no effect if you use <span +</p><!--l. 1156--><p class="indent" > <spacer type=vertical size=10> +Note also that some commands and package options have no effect if you use <a + id="dx1-9030"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-8021"></a> -explicitly instead of using <span + id="dx1-9031"></a></a> +explicitly instead of using <a + id="dx1-9032"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-8022"></a>. These are listed in <a -href="#x1-60303">table 3</a>. -</p><!--l. 890--><p class="noindent" > + id="dx1-9033"></a>. These are listed in <a +href="#x1-70813">table 3</a>. +</p><!--l. 1163--><p class="noindent" > </p> -<!--l. 890--><p class="noindent" ><a +<!--l. 1163--><p class="noindent" ><a href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.3 </span> <a - id="x1-90001.3.3"></a>Using makeindex explicitly</h5> -<!--l. 893--><p class="noindent" >If you want to use <span + id="x1-100001.3.3"></a>Using makeindex explicitly</h5> +<!--l. 1166--><p class="noindent" >If you want to use <a + id="dx1-10001"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-9001"></a> explicitly, you must make sure that you haven’t used the + id="dx1-10002"></a></a> explicitly, you must make sure that you haven’t used the <span class="ecss-1000">xindy</span><a - id="dx1-9002"></a> package option or the glossary entries will be written in the wrong format. To run -<span + id="dx1-10003"></a> package option or the glossary entries will be written in the wrong format. To run +<a + id="dx1-10004"></a><span class="ectt-1000">makeindex</span><a - id="dx1-9003"></a>, type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-10005"></a>, type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s </span><span class="cmsy-10">⟨</span><span @@ -1977,107 +2639,124 @@ class="cmsy-10">⟨</span><span class="ecti-1000">base</span><span class="cmsy-10">⟩</span><span class="ectt-1000">.glo</span></span> -</p><!--l. 900--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1173--><p class="indent" > <spacer type=vertical size=10> where <span class="cmsy-10">⟨</span><span class="ecti-1000">base</span><span class="cmsy-10">⟩ </span>is the name of your document without the <span class="ectt-1000">.tex</span><a - id="dx1-9004"></a> extension and + id="dx1-10006"></a> extension and <span class="cmsy-10">⟨</span><span class="ecti-1000">style</span><span class="cmsy-10">⟩</span><span class="ectt-1000">.ist</span><a - id="dx1-9005"></a> is the name of the <span + id="dx1-10007"></a> is the name of the <a + id="dx1-10008"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-9006"></a> style file. By default, this is <span + id="dx1-10009"></a></a> style file. By default, this is <span class="cmsy-10">⟨</span><span class="ecti-1000">base</span><span class="cmsy-10">⟩</span><span class="ectt-1000">.ist</span><a - id="dx1-9007"></a>, + id="dx1-10010"></a>, but may be changed via <span class="ectt-1000">\setStyleFile</span><a - id="dx1-9008"></a><span + id="dx1-10011"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">style</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}</span>. Note that there are other options, such as <span -class="ectt-1000">-l </span>(letter ordering). See the <span +class="ectt-1000">-l </span>(letter ordering). See the <a + id="dx1-10012"></a><span class="ectt-1000">makeindex</span><a - id="dx1-9009"></a> manual for further + id="dx1-10013"></a> manual for further details. -</p><!--l. 909--><p class="indent" > For example, if your document is called <span +</p><!--l. 1182--><p class="indent" > For example, if your document is called <span class="ectt-1000">myDoc.tex</span>, then type the following at the terminal: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo</span></span> -</p><!--l. 913--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1186--><p class="indent" > <spacer type=vertical size=10> Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the <span class="ecss-1000">acronym</span><a - id="dx1-9010"></a> package option) then you must call <span + id="dx1-10014"></a> package option) then you must call <a + id="dx1-10015"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-9011"></a> + id="dx1-10016"></a></a> for each glossary, substituting <span class="ectt-1000">.glg</span><a - id="dx1-9012"></a>, <span + id="dx1-10017"></a>, <span class="ectt-1000">.gls</span><a - id="dx1-9013"></a> and <span + id="dx1-10018"></a> and <span class="ectt-1000">.glo</span><a - id="dx1-9014"></a> with the relevant extensions. For + id="dx1-10019"></a> with the relevant extensions. For example, if you have used the <span class="ecss-1000">acronym</span><a - id="dx1-9015"></a> package option, then you need to type the + id="dx1-10020"></a> package option, then you need to type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn</span></span> -</p><!--l. 924--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1197--><p class="indent" > <spacer type=vertical size=10> For additional glossaries, the extensions are those supplied when you created the glossary with <span class="ectt-1000">\newglossary</span><a - id="dx1-9016"></a>. -</p><!--l. 928--><p class="indent" > Note that if you use <span + id="dx1-10021"></a>. +</p><!--l. 1201--><p class="indent" > Note that if you use <a + id="dx1-10022"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-9017"></a> instead, you can replace all those calls to -<span + id="dx1-10023"></a></a> instead, you can replace all those calls to +<a + id="dx1-10024"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-9018"></a> with just one call to <span + id="dx1-10025"></a></a> with just one call to <a + id="dx1-10026"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-9019"></a>: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-10027"></a>: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">makeglossaries myDoc</span></span> -</p><!--l. 933--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 1206--><p class="indent" > <spacer type=vertical size=10> Note also that some commands and package options have no effect if you use -<span +<a + id="dx1-10028"></a><span class="ectt-1000">makeindex</span><a - id="dx1-9020"></a> explicitly instead of using <span + id="dx1-10029"></a> explicitly instead of using <a + id="dx1-10030"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-9021"></a>. These are listed in + id="dx1-10031"></a></a>. These are listed in <a -href="#x1-60303">table 3</a>. -</p><!--l. 940--><p class="noindent" > +href="#x1-70813">table 3</a>. +</p><!--l. 1213--><p class="noindent" > </p> -<!--l. 940--><p class="noindent" ><a +<!--l. 1213--><p class="noindent" ><a href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.4 </span> <a - id="x1-100001.3.4"></a>Note to Front-End and Script Developers</h5> -<!--l. 942--><p class="noindent" >The information needed to determine whether to use <span + id="x1-110001.3.4"></a>Note to Front-End and Script Developers</h5> +<!--l. 1215--><p class="noindent" >The information needed to determine whether to use <a + id="dx1-11001"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-10001"></a> or <span + id="dx1-11002"></a></a> or <a + id="dx1-11003"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-10002"></a> and the + id="dx1-11004"></a></a> and the information needed to call those applications is stored in the auxiliary file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is stored in the auxiliary file. -</p><!--l. 949--><p class="indent" > The file extensions used by each defined glossary are given by -</p><!--l. 950--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1222--><p class="indent" > The file extensions used by each defined glossary are given by +</p><!--l. 1223--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\@newglossary</span><span class="ectt-0900"> </span></span><a - id="dx1-10003"></a> <span + id="dx1-11005"></a> <span class="ectt-1000">\@newglossary{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -2095,7 +2774,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">in-ext</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 952--><p class="noindent" > +</p><!--l. 1225--><p class="noindent" > @@ -2124,61 +2803,67 @@ as: </p> - <div class="verbatim" id="verbatim-12"> + <div class="verbatim" id="verbatim-15"> \@newglossary{main}{glg}{gls}{glo} </div> -<!--l. 964--><p class="nopar" > -</p><!--l. 966--><p class="indent" > The indexing application’s style file is specified by -</p><!--l. 967--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 1237--><p class="nopar" > +</p><!--l. 1239--><p class="indent" > The indexing application’s style file is specified by +</p><!--l. 1240--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\@istfilename</span><span class="ectt-0900"> </span></span><a - id="dx1-10004"></a> <span + id="dx1-11006"></a> <span class="ectt-1000">\@istfilename{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">filename</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 969--><p class="noindent" > -The file extension indicates whether to use <span +</p><!--l. 1242--><p class="noindent" > +The file extension indicates whether to use <a + id="dx1-11007"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-10005"></a> (<span + id="dx1-11008"></a></a> (<span class="ectt-1000">.ist</span><a - id="dx1-10006"></a>) or <span + id="dx1-11009"></a>) or <a + id="dx1-11010"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-10007"></a> (<span + id="dx1-11011"></a></a> (<span class="ectt-1000">.xdy</span><a - id="dx1-10008"></a>). Note + id="dx1-11012"></a>). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it’s important to call the correct one. -</p><!--l. 976--><p class="indent" > Word or letter ordering is specified by: -</p><!--l. 977--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1249--><p class="indent" > Word or letter ordering is specified by: +</p><!--l. 1250--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\@glsorder</span><span class="ectt-0900"> </span></span><a - id="dx1-10009"></a> <span + id="dx1-11013"></a> <span class="ectt-1000">\@glsorder{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">order</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 979--><p class="noindent" > +</p><!--l. 1252--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">order</span><span class="cmsy-10">⟩ </span>can be either <span class="ectt-1000">word </span>or <span class="ectt-1000">letter</span>. -</p><!--l. 982--><p class="indent" > If <span +</p><!--l. 1255--><p class="indent" > If <a + id="dx1-11014"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-10010"></a> should be used, the language and code page for each glossary is specified + id="dx1-11015"></a></a> should be used, the language and code page for each glossary is specified by -</p><!--l. 984--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1257--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\@xdylanguage</span><span class="ectt-0900"> </span></span><a - id="dx1-10011"></a><span class="marginpar"><span + id="dx1-11016"></a><span class="marginpar"><span class="ectt-0900">\@gls@codepage</span><span class="ectt-0900"> </span></span><a - id="dx1-10012"></a> <span + id="dx1-11017"></a> <span class="ectt-1000">\@xdylanguage{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -2198,7 +2883,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">code</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 987--><p class="noindent" > +</p><!--l. 1260--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -2211,438 +2896,337 @@ class="ectt-1000">english</span>) and class="cmsy-10">⟨</span><span class="ecti-1000">code</span><span class="cmsy-10">⟩ </span>is the encoding (e.g. <span -class="ectt-1000">utf8</span>). These commands are omitted if <span +class="ectt-1000">utf8</span>). These commands are omitted if <a + id="dx1-11018"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-10013"></a> should + id="dx1-11019"></a></a> should be used. -</p><!--l. 994--><p class="noindent" > +</p><!--l. 1267--><p class="noindent" > </p> -<!--l. 994--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.4 </span> <a - id="x1-110001.4"></a>Troubleshooting</h4> -<!--l. 997--><p class="noindent" >The <span -class="ecss-1000">glossaries </span>package comes with a minimal file called <span -class="ectt-1000">minimalgls.tex </span>which can be -used for testing. This should be located in the <span -class="ectt-1000">samples </span>subdirectory (folder) of the +<!--l. 1267--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-120002"></a>Package Options</h3> +<!--l. 1270--><p class="noindent" >This section describes the available <span +class="ecss-1000">glossaries </span>package options. +</p><!--l. 1272--><p class="noindent" > +</p> +<!--l. 1272--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.1 </span> <a + id="x1-130002.1"></a>General Options</h4> +<!--l. 1275--><p class="noindent" > + </p><dl class="description"><dt class="description"> <span -class="ecss-1000">glossaries </span>documentation directory. The location varies according to your operating -system and <span class="TEX">T<span -class="E">E</span>X</span> installation. For example, on my Linux partition it can be -found in <span -class="ectt-1000">/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/</span>. -Further information on debugging <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> code is available at -<a -href="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/" class="url" ><span -class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</span></a>. -</p><!--l. 1007--><p class="indent" > Below is a list of the most frequently asked questions. For other queries, consult the <span -class="ecss-1000">glossaries</span> -FAQ at <a -href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" class="url" ><span -class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html</span></a>. -</p><!--l. 1011--><p class="indent" > - </p><ol class="enumerate1" > - <li - class="enumerate" id="x1-11002x1"><span -class="ecbx-1000">Q. </span>I get the error message: +class="ecsx-1000">nowarn</span><a + id="dx1-13001"></a> </dt><dd +class="description">This suppresses all warnings generated by the <span +class="ecss-1000">glossaries </span>package. + </dd><dt class="description"> +<span +class="ecsx-1000">nomain</span><a + id="dx1-13002"></a> </dt><dd +class="description">This suppresses the creation of the main glossary. Note that if you use + this option, you must create another glossary in which to put all your entries - <div class="verbatim" id="verbatim-13"> - Missing \begin{document} -</div> - <!--l. 1015--><p class="nopar" > - </p><!--l. 1017--><p class="noindent" ><span -class="ecbx-1000">A. </span>Check you are using an up to date version of the <span -class="ecss-1000">xkeyval</span><a - id="dx1-11003"></a> package. - </p></li> - <li - class="enumerate" id="x1-11005x2"><span -class="ecbx-1000">Q. </span>I’ve used the <span -class="ecss-1000">smallcaps</span><a - id="dx1-11006"></a> option, but the acronyms are displayed in normal sized - upper case letters. - <!--l. 1023--><p class="noindent" ><span -class="ecbx-1000">A. </span>The <span -class="ecss-1000">smallcaps</span><a - id="dx1-11007"></a> package option uses <span -class="ectt-1000">\textsc </span>to typeset the acronyms. This - command converts lower case letters to small capitals, while upper case letters - remain their usual size. Therefore you need to specify the acronym in lower case - letters. - </p></li> - <li - class="enumerate" id="x1-11009x3"><span -class="ecbx-1000">Q. </span>My acronyms won’t break across a line when they’re expanded. - <!--l. 1031--><p class="noindent" ><span -class="ecbx-1000">A. </span>PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> can break hyperlinks across a line, but <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> can’t. If you - can’t use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> then disable the first use links using the package option - <span -class="ecss-1000">hyperfirst=false</span><a - id="dx1-11010"></a>. - </p></li> - <li - class="enumerate" id="x1-11012x4"><span -class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in? - <!--l. 1037--><p class="noindent" ><span -class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span -class="ecss-1000">smaller</span><a - id="dx1-11013"></a> package option and redefine + (either via the <span +class="ecss-1000">acronym</span><a + id="dx1-13003"></a> package option described in <a +href="#x1-170002.5">2.5 </a><a +href="#x1-170002.5">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a> + or via <span +class="ectt-1000">\newglossary</span><a + id="dx1-13004"></a> described in <a +href="#x1-3800012">12 </a><a +href="#x1-3800012">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">sanitize</span><a + id="dx1-13005"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option whose value is also a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>list. By + default, the <span +class="ecss-1000">glossaries </span>package <a + id="dx1-13006"></a><a +href="#glo:sanitize">sanitize<a + id="dx1-13007"></a>s</a> the values of the <span +class="ecss-1000">name</span><a + id="dx1-13008"></a>, <span +class="ecss-1000">description</span><a + id="dx1-13009"></a> and <span -class="ectt-1000">\acronymfont </span>to use the required typesetting command. For example, suppose - you would like the acronyms displayed in a sans-serif font, then you can +class="ecss-1000">symbol</span><a + id="dx1-13010"></a> keys used when defining a new glossary entry. This means that you can use + fragile commands in those keys, but it may lead to unexpected results if you try + to display these values within the document text. This sanitization can be + switched off using the <span +class="ecss-1000">sanitize</span><a + id="dx1-13011"></a> package option. For example, to switch off the + sanitization for the <span +class="ecss-1000">description</span><a + id="dx1-13012"></a> and <span +class="ecss-1000">name</span><a + id="dx1-13013"></a> keys, but not for the <span +class="ecss-1000">symbol</span><a + id="dx1-13014"></a> key, do: -</p> - <div class="verbatim" id="verbatim-14"> - \usepackage[smaller]{glossaries} -  <br />\renewcommand*{\acronymfont}[1]{\textsf{#1}} + <div class="verbatim" id="verbatim-16"> + \usepackage[sanitize={name=false,description=false,% +  <br />symbol=true}]{glossaries} </div> - <!--l. 1044--><p class="nopar" > - </p></li> - <li - class="enumerate" id="x1-11015x5"><span -class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in on first - use<a - id="dx1-11016"></a>? - <!--l. 1049--><p class="noindent" ><span -class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span -class="ecss-1000">smaller</span><a - id="dx1-11017"></a> package option and redefine + <!--l. 1301--><p class="nopar" > You can use <span +class="ecss-1000">sanitize=none</span><a + id="dx1-13015"></a> as a shortcut for<br +class="newline" /><span +class="ecss-1000">sanitize={name=false,description=false,symbol=false}</span>. + </p><!--l. 1305--><p class="noindent" ><div class="important" title="Important Note"><span +class="ecbx-1000">Note</span>: this sanitization only applies to the <span +class="ecss-1000">name</span><a + id="dx1-13016"></a>, <span +class="ecss-1000">description</span><a + id="dx1-13017"></a> and <span +class="ecss-1000">symbol</span><a + id="dx1-13018"></a> keys. It + doesn’t apply to any of the other keys (except the <span +class="ecss-1000">sort</span><a + id="dx1-13019"></a> key which is always + <a + id="dx1-13020"></a><a +href="#glo:sanitize">sanitized<a + id="dx1-13021"></a></a> if <span +class="ecss-1000">sort=standard</span><a + id="dx1-13022"></a> is in effect) so fragile commands contained in the value + of the other keys must always be protected using <span +class="ectt-1000">\protect</span>. Since the + value of the <span +class="ecss-1000">text</span><a + id="dx1-13023"></a> key is obtained from the <span +class="ecss-1000">name</span><a + id="dx1-13024"></a> key, you will still need to + protect fragile commands in the <span +class="ecss-1000">name</span><a + id="dx1-13025"></a> key if you don’t use the <span +class="ecss-1000">text</span><a + id="dx1-13026"></a> key. + </div> + </p><!--l. 1314--><p class="noindent" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">savewrites</span><a + id="dx1-13027"></a> </dt><dd +class="description">This is a boolean option to minimises the number of write registers used by + the <span +class="ecss-1000">glossaries </span>package. (Default is <span +class="ecss-1000">savewrites=false</span><a + id="dx1-13028"></a>.) There are only a limited + number of write registers, and if you have a large number of glossaries or if you + are using a class or other packages that create a lot of external files, you may + exceed the maximum number of available registers. If <span +class="ecss-1000">savewrites</span><a + id="dx1-13029"></a> is set, the + glossary information will be stored in token registers until the end of the + document when they will be written to the external files. If you run out of token + registers, you can use <span +class="ecss-1000">etex</span><a + id="dx1-13030"></a>. + <!--l. 1327--><p class="noindent" ><div class="important" title="Important Note"> If you want to use <span class="TEX">T<span +class="E">E</span>X</span>’s <span +class="ectt-1000">\write18</span><a + id="dx1-13031"></a> mechanism to call <a + id="dx1-13032"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-13033"></a></a> or <a + id="dx1-13034"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-13035"></a></a> from + your document and use <span +class="ecss-1000">savewrites</span><a + id="dx1-13036"></a>, you must create the external files with <span -class="ectt-1000">\firstacronymfont </span>to use the required command. Note that if you don’t want - the acronym on subsequent use to use <span -class="ectt-1000">\textsmaller</span>, you will also need to - redefine <span -class="ectt-1000">\acronymfont</span>, as above. For example to make the acronym emphasized - on first use<a - id="dx1-11018"></a>, but use the surrounding font for subsequent use, you can - do: +class="ectt-1000">\glswritefiles </span>before you call <a + id="dx1-13037"></a><span +class="ectt-1000">makeindex</span><a + id="dx1-13038"></a>/<a + id="dx1-13039"></a><span +class="ectt-1000">xindy</span><a + id="dx1-13040"></a>. Also set <span +class="ectt-1000">\glswritefiles </span>to + nothing or <span +class="ectt-1000">\relax </span>before the end of the document to avoid rewriting the files. For + example: </p> - <div class="verbatim" id="verbatim-15"> - \usepackage[smaller]{glossaries} -  <br />\renewcommand*{\firstacronymfont}[1]{\emph{#1}} -  <br />\renewcommand*{\acronymfont}[1]{#1} + <div class="verbatim" id="verbatim-17"> + \glswritefiles +  <br />\write18{makeindex -s \istfilename\space -t \jobname.glg +  <br />-o \jobname.gls \jobname} +  <br />\let\glswritefiles\relax </div> - <!--l. 1059--><p class="nopar" > - </p></li> - <li - class="enumerate" id="x1-11020x6"><span -class="ecbx-1000">Q. </span>I don’t have Perl installed, do I have to use <span -class="ectt-1000">makeglossaries</span><a - id="dx1-11021"></a>? - <!--l. 1064--><p class="noindent" ><span -class="ecbx-1000">A. </span>Although it is strongly recommended that you use <span -class="ectt-1000">makeglossaries</span><a - id="dx1-11022"></a>, you don’t - have to use it. For further details, read <a -href="#x1-80001.3.2">1.3.2 </a><a -href="#x1-80001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a> or <a -href="#x1-90001.3.3">1.3.3 - </a><a -href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>, depending on whether you want to use <span -class="ectt-1000">xindy</span><a - id="dx1-11023"></a> or + <!--l. 1339--><p class="nopar" > </div> + </p><!--l. 1340--><p class="noindent" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">translate</span><a + id="dx1-13041"></a> </dt><dd +class="description">This is a boolean option. The default is <span +class="ecss-1000">true</span><a + id="dx1-13042"></a> if <span +class="ecss-1000">babel</span><a + id="dx1-13043"></a>, <span +class="ecss-1000">polyglossia</span><a + id="dx1-13044"></a> or <span +class="ecss-1000">translator</span><a + id="dx1-13045"></a> + have been loaded, otherwise the default value is <span +class="ecss-1000">false</span><a + id="dx1-13046"></a>. + <!--l. 1347--><p class="noindent" > + </p><dl class="description"><dt class="description"> <span -class="ectt-1000">makeindex</span><a - id="dx1-11024"></a>. - </p></li> - <li - class="enumerate" id="x1-11026x7"><span -class="ecbx-1000">Q. </span>I’m used to using the <span -class="ecss-1000">glossary </span>package: are there any instructions on migrating - from the <span -class="ecss-1000">glossary</span><a - id="dx1-11027"></a> package to the <span -class="ecss-1000">glossaries </span>package? - <!--l. 1073--><p class="noindent" ><span -class="ecbx-1000">A. </span>Read <a -href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> which - should be available from the same location as this document. - </p></li> - <li - class="enumerate" id="x1-11029x8"><span -class="ecbx-1000">Q. </span>I’m using <span +class="ecsx-1000">translate=true</span><a + id="dx1-13047"></a> </dt><dd +class="description">If <span class="ecss-1000">babel</span><a - id="dx1-11030"></a> but the fixed names haven’t been translated. - <!--l. 1080--><p class="noindent" ><span -class="ecbx-1000">A. </span>The <span -class="ecss-1000">glossaries </span>package currently only supports the following languages: - Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, Italian, - Hungarian, Polish, Serbian and Spanish. If you want to add another language, - send me the translations, and I’ll add them to the next version. - </p><!--l. 1086--><p class="noindent" >If you are using one of the above languages, but the text hasn’t been translated, - try adding the <span + id="dx1-13048"></a> has been loaded and the <span class="ecss-1000">translator</span><a - id="dx1-11031"></a> package with the required languages explicitly (before - you load the <span -class="ecss-1000">glossaries </span>package). For example: - - - -</p> - <div class="verbatim" id="verbatim-16"> - \usepackage[ngerman]{babel} -  <br />\usepackage[ngerman]{translator} -  <br />\usepackage{glossaries} -</div> - <!--l. 1094--><p class="nopar" > Alternatively, you can add the language as a global option to the class file. Check - the <span -class="ecss-1000">translator </span>package documentation for further details. - </p></li> - <li - class="enumerate" id="x1-11033x9"><span -class="ecbx-1000">Q. </span>My acronyms contain strange characters when I use commands like + id="dx1-13049"></a> package is + installed, <span +class="ecss-1000">translator</span><a + id="dx1-13050"></a> will be loaded and the translations will be provided + by the <span +class="ecss-1000">translator</span><a + id="dx1-13051"></a> package interface. You can modify the translations by + providing your own dictionary. If the <span +class="ecss-1000">translator</span><a + id="dx1-13052"></a> package isn’t installed + and <span +class="ecss-1000">babel</span><a + id="dx1-13053"></a> is loaded, the <span +class="ecss-1000">glossaries-babel</span><a + id="dx1-13054"></a> package will be loaded and the + translations will be provided using <span +class="ecss-1000">babel</span>’s <span +class="ectt-1000">\addto\caption</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩</span> + mechanism. If <span +class="ecss-1000">polyglossia</span><a + id="dx1-13055"></a> has been loaded, <span +class="ecss-1000">glossaries-polyglossia</span><a + id="dx1-13056"></a> will be + loaded. + </dd><dt class="description"> <span -class="ectt-1000">\acrlong</span><a - id="dx1-11034"></a>. - <!--l. 1102--><p class="noindent" ><span -class="ecbx-1000">A. </span>Switch off the sanitization: - - - -</p> - <div class="verbatim" id="verbatim-17"> - \usepackage[sanitize=none]{glossaries} -</div> - <!--l. 1105--><p class="nopar" > and protect fragile commands. - </p></li> - <li - class="enumerate" id="x1-11036x10"><span -class="ecbx-1000">Q. </span>My glossaries haven’t appeared. - <!--l. 1110--><p class="noindent" ><span -class="ecbx-1000">A. </span>Remember to do the following: </p> - <ul class="itemize1"> - <li class="itemize">Add <span -class="ectt-1000">\makeglossaries</span><a - id="dx1-11037"></a> to the document preamble. - </li> - <li class="itemize">Use either <span -class="ectt-1000">\printglossary</span><a - id="dx1-11038"></a> for each glossary that has been defined or - <span -class="ectt-1000">\printglossaries</span><a - id="dx1-11039"></a>. - </li> - <li class="itemize">Use the commands listed in <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a -href="#x1-240002.5">2.5 - </a><a -href="#x1-240002.5">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a -href="#x1-250002.6">2.6 - </a><a -href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a> for each entry that you want to appear in - the glossary. - </li> - <li class="itemize">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> on your document, then run <span -class="ectt-1000">makeglossaries</span><a - id="dx1-11040"></a>, then run - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> on your document again. If you want the glossaries to appear - in the table of contents, you will need an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run. If any - of your entries cross-reference an entry that’s not referenced in the - main body of the document, you will need to run <span -class="ectt-1000">makeglossaries</span><a - id="dx1-11041"></a> - (see <a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>) after the second - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run, followed by another <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run.</li></ul> - <!--l. 1130--><p class="noindent" >Check the log files (<span -class="ectt-1000">.log</span><a - id="dx1-11042"></a>, <span -class="ectt-1000">.glg</span><a - id="dx1-11043"></a> etc) for any warnings. - </p></li> - <li - class="enumerate" id="x1-11045x11"><span -class="ecbx-1000">Q. </span>It is possible to change the rules used to sort the glossary entries? - <!--l. 1136--><p class="noindent" ><span -class="ecbx-1000">A. </span>If it’s for an individual entry, then you can use the entry’s <span -class="ecss-1000">sort</span><a - id="dx1-11046"></a> key to sort it - according to a different term. If it’s for the entire alphabet, then you will - need to use <span -class="ectt-1000">xindy</span><a - id="dx1-11047"></a> (instead of <span -class="ectt-1000">makeindex</span><a - id="dx1-11048"></a>) and use an appropriate <span -class="ectt-1000">xindy</span><a - id="dx1-11049"></a> - language module. Writing <span -class="ectt-1000">xindy</span><a - id="dx1-11050"></a> modules or styles is beyond the scope - of this manual. Further information about <span -class="ectt-1000">xindy</span><a - id="dx1-11051"></a> can be found at the +class="ecsx-1000">translate=false</span><a + id="dx1-13057"></a> </dt><dd +class="description">Don’t provide translations, even if <span +class="ecss-1000">babel</span><a + id="dx1-13058"></a> or <span +class="ecss-1000">polyglossia</span><a + id="dx1-13059"></a> has + been loaded. You can then provide you’re own translations or explicitly + load <span +class="ecss-1000">glossaries-babel</span><a + id="dx1-13060"></a> or <span +class="ecss-1000">glossaries-polyglossia</span><a + id="dx1-13061"></a>.</dd></dl> + <!--l. 1366--><p class="noindent" >See <a +href="#x1-60001.2.1">1.2.1 </a><a +href="#x1-60001.2.1">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details. + </p></dd><dt class="description"> +<span +class="ecsx-1000">hyperfirst</span><a + id="dx1-13062"></a> </dt><dd +class="description">This is a boolean option that specifies whether each term has a hyperlink on <a -href="http://xindy.sourceforge.net/" >Xindy Web Site</a>. There is also a link to the <span -class="ectt-1000">xindy</span><a - id="dx1-11052"></a> mailing list from that - site. -</p> - </li></ol> + id="dx1-13063"></a><a +href="#glo:firstuse">first use</a>. The default is <span +class="ecss-1000">hyperfirst=true</span><a + id="dx1-13064"></a> (terms on <a + id="dx1-13065"></a><a +href="#glo:firstuse">first use</a> have a hyperlink, + unless explicitly suppressed using starred versions of commands such as + <span +class="ectt-1000">\gls*</span><a + id="dx1-13066"></a>). + </dd></dl> -<!--l. 1149--><p class="noindent" > +<!--l. 1376--><p class="noindent" > </p> -<!--l. 1149--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a - id="x1-120002"></a>Overview of Main User Commands</h3> -<a - id="dx1-12001"></a> -<!--l. 1152--><p class="noindent" >This section is an overview of the main user commands and package options. If you find -this too complicated, try starting out with the <a -href="glossariesbegin.html" >guide for beginners</a>. -</p><!--l. 1156--><p class="noindent" > -</p> -<!--l. 1156--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.1 </span> <a - id="x1-130002.1"></a>Package Options</h4> -<!--l. 1159--><p class="noindent" >The <span -class="ecss-1000">glossaries </span>package options are as follows: +<!--l. 1376--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.2 </span> <a + id="x1-140002.2"></a>Sectioning and TOC Options</h4> +<!--l. 1379--><p class="noindent" > </p><dl class="description"><dt class="description"> <span -class="ecsx-1000">nowarn</span><a - id="dx1-13001"></a> </dt><dd -class="description">This suppresses all warnings generated by the <span -class="ecss-1000">glossaries </span>package. - </dd><dt class="description"> -<span -class="ecsx-1000">nomain</span><a - id="dx1-13002"></a> </dt><dd -class="description">This suppresses the creation of the main glossary. Note that if you use - this option, you must create another glossary in which to put all your entries - (either via the <span -class="ecss-1000">acronym</span><a - id="dx1-13003"></a> package option described below or via <span -class="ectt-1000">\newglossary</span><a - id="dx1-13004"></a> - described in <a -href="#x1-330002.9">2.9 </a><a -href="#x1-330002.9">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>). - </dd><dt class="description"> -<span class="ecsx-1000">toc</span><a - id="dx1-13005"></a> </dt><dd + id="dx1-14001"></a> </dt><dd class="description">Add the glossaries to the table of contents. Note that an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run is required with this option. Alternatively, you can switch this function on and off using - <!--l. 1173--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 1383--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glstoctrue</span><span class="ectt-0900"> </span></span><a - id="dx1-13006"></a> <span + id="dx1-14002"></a> <span class="ectt-1000">\glstoctrue </span></div><hr> - </p><!--l. 1175--><p class="noindent" > + </p><!--l. 1385--><p class="noindent" > and - </p><!--l. 1177--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + </p><!--l. 1387--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glstocfalse</span><span class="ectt-0900"> </span></span><a - id="dx1-13007"></a> <span + id="dx1-14003"></a> <span class="ectt-1000">\glstocfalse </span></div><hr> - </p><!--l. 1179--><p class="noindent" > + </p><!--l. 1389--><p class="noindent" > </p></dd><dt class="description"> <span class="ecsx-1000">numberline</span><a - id="dx1-13008"></a> </dt><dd + id="dx1-14004"></a> </dt><dd class="description">When used with <span class="ecss-1000">toc</span><a - id="dx1-13009"></a>, this will add <span -class="ectt-1000">\numberline</span><span class="obeylines-h"><span class="verb"><span + id="dx1-14005"></a>, this will add <span +class="ectt-1000">\numberline</span><a + id="dx1-14006"></a><span class="obeylines-h"><span class="verb"><span class="ectt-1000">{}</span></span></span> in the final argument of <span -class="ectt-1000">\addcontentsline</span>. This will align the table of contents +class="ectt-1000">\addcontentsline</span><a + id="dx1-14007"></a>. This will align the table of contents entry with the numbered section titles. Note that this option has no effect if the <span class="ecss-1000">toc</span><a - id="dx1-13010"></a> option is omitted. If <span + id="dx1-14008"></a> option is omitted. If <span class="ecss-1000">toc</span><a - id="dx1-13011"></a> is used without <span + id="dx1-14009"></a> is used without <span class="ecss-1000">numberline</span><a - id="dx1-13012"></a>, the + id="dx1-14010"></a>, the title will be aligned with the section numbers rather than the section titles. </dd><dt class="description"> <span -class="ecsx-1000">acronym</span><a - id="dx1-13013"></a> </dt><dd -class="description">This creates a new glossary with the label <span -class="ectt-1000">acronym</span>. This is equivalent - to: - - - - <div class="verbatim" id="verbatim-18"> - \newglossary[alg]{acronym}{acr}{acn}{\acronymname} -</div> - <!--l. 1193--><p class="nopar" > If the <span -class="ecss-1000">acronym</span><a - id="dx1-13014"></a> package option is used, <span -class="ectt-1000">\acronymtype</span><a - id="dx1-13015"></a> is set to <span -class="ectt-1000">acronym </span>otherwise it is set - to <span -class="ectt-1000">main</span>.<span class="footnote-mark"><a -href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a - id="x1-13016f2"></a> - Entries that are defined using <span -class="ectt-1000">\newacronym</span><a - id="dx1-13021"></a> are placed in the glossary whose - label is given by <span -class="ectt-1000">\acronymtype</span><a - id="dx1-13022"></a>, unless another glossary is explicitly - specified. - </p></dd><dt class="description"> -<span -class="ecsx-1000">acronymlists</span><a - id="dx1-13023"></a> </dt><dd -class="description">By default, only the <span -class="ectt-1000">acronym </span>glossary is considered to be a list of - acronyms. If you have other lists of acronyms, you can specify them - as a comma-separated list in the value of <span -class="ecss-1000">acronymlists</span><a - id="dx1-13024"></a>. For example, if - you want the <span -class="ectt-1000">main </span>glossary to also contain a list of acronyms, you can - do: - - - - <div class="verbatim" id="verbatim-19"> - \usepackage[acronym,acronymlists={main}]{glossaries} -</div> - <!--l. 1212--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add - glossaries you haven’t defined yet. For example: - - - -</p> - <div class="verbatim" id="verbatim-20"> - \usepackage[acronym,acronymlists={main,acronym2}]{glossaries} -  <br />\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} -</div> - <!--l. 1218--><p class="nopar" > - </p></dd><dt class="description"> -<span class="ecsx-1000">section</span><a - id="dx1-13025"></a> </dt><dd + id="dx1-14011"></a> </dt><dd class="description">This is a <span class="cmsy-10">⟨</span><span class="ecti-1000">key</span><span @@ -2657,110 +3241,112 @@ class="cmsy-10">⟩ </span>option. Its value should be the name of a sectio - <div class="verbatim" id="verbatim-21"> + <div class="verbatim" id="verbatim-18"> \usepackage[section=subsection]{glossaries} </div> - <!--l. 1228--><p class="nopar" > You can omit the value if you want to use sections, i.e.  + <!--l. 1407--><p class="nopar" > You can omit the value if you want to use sections, i.e.  </p> - <div class="verbatim" id="verbatim-22"> + <div class="verbatim" id="verbatim-19"> \usepackage[section]{glossaries} </div> - <!--l. 1232--><p class="nopar" > is equivalent to + <!--l. 1411--><p class="nopar" > is equivalent to </p> - <div class="verbatim" id="verbatim-23"> + <div class="verbatim" id="verbatim-20"> \usepackage[section=section]{glossaries} </div> - <!--l. 1236--><p class="nopar" > You can change this value later in the document using - </p><!--l. 1238--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 1415--><p class="nopar" > You can change this value later in the document using + </p><!--l. 1417--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\setglossarysection</span><span class="ectt-0900"> </span></span><a - id="dx1-13026"></a> <span + id="dx1-14012"></a> <span class="ectt-1000">\setglossarysection{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> - </p><!--l. 1240--><p class="noindent" > + </p><!--l. 1419--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩ </span>is the sectional unit. - </p><!--l. 1243--><p class="noindent" >The start of each glossary adds information to the page header via - </p><!--l. 1244--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + </p><!--l. 1422--><p class="noindent" >The start of each glossary adds information to the page header via + </p><!--l. 1423--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossarymark</span><span class="ectt-0900"> </span></span><a - id="dx1-13027"></a> <span + id="dx1-14013"></a> <span class="ectt-1000">\glossarymark{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary title</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> - </p><!--l. 1246--><p class="noindent" > + </p><!--l. 1425--><p class="noindent" > This defaults to <span -class="ectt-1000">\@mkboth</span>, but you may need to redefine it. For example, to only - change the right header: +class="ectt-1000">\@mkboth </span>unless <span +class="ecss-1000">memoir</span><a + id="dx1-14014"></a> is loaded, but you may need to redefine + it. For example, to only change the right header: </p> - <div class="verbatim" id="verbatim-24"> + <div class="verbatim" id="verbatim-21"> \renewcommand{\glossarymark}[1]{\markright{#1}} </div> - <!--l. 1251--><p class="nopar" > or to prevent it from changing the headers: + <!--l. 1431--><p class="nopar" > or to prevent it from changing the headers: </p> - <div class="verbatim" id="verbatim-25"> + <div class="verbatim" id="verbatim-22"> \renewcommand{\glossarymark}[1]{} </div> - <!--l. 1255--><p class="nopar" > - </p><!--l. 1257--><p class="noindent" >Occasionally you may find that another package defines <span + <!--l. 1435--><p class="nopar" > + </p><!--l. 1437--><p class="noindent" >Occasionally you may find that another package defines <span class="ectt-1000">\cleardoublepage </span>when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining <span class="ectt-1000">\glsclearpage</span><a - id="dx1-13028"></a>: + id="dx1-14015"></a>: </p> - <div class="verbatim" id="verbatim-26"> + <div class="verbatim" id="verbatim-23"> \renewcommand*{\glsclearpage}{\clearpage} </div> - <!--l. 1263--><p class="nopar" > + <!--l. 1443--><p class="nopar" > </p></dd><dt class="description"> <span class="ecsx-1000">numberedsection</span><a - id="dx1-13029"></a> </dt><dd + id="dx1-14016"></a> </dt><dd class="description">The glossaries are placed in unnumbered sectional units by default, but this can be changed using <span class="ecss-1000">numberedsection</span><a - id="dx1-13030"></a>. This option + id="dx1-14017"></a>. This option can take three possible values: <span class="ecss-1000">false</span><a - id="dx1-13031"></a> (no number, i.e. use starred form), + id="dx1-14018"></a> (no number, i.e. use starred form), <span class="ecss-1000">nolabel</span><a - id="dx1-13032"></a> (numbered, i.e. unstarred form, but not labelled) and <span + id="dx1-14019"></a> (numbered, i.e. unstarred form, but not labelled) and <span class="ecss-1000">autolabel</span><a - id="dx1-13033"></a> + id="dx1-14020"></a> (numbered with automatic labelling). If <span class="ecss-1000">numberedsection=autolabel</span><a - id="dx1-13034"></a> is used, + id="dx1-14021"></a> is used, each glossary is given a label that matches the glossary type, so the main (default) glossary is labelled <span class="ectt-1000">main</span>, the list of acronyms is labelled <span class="ectt-1000">acronym</span><span class="footnote-mark"><a href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a - id="x1-13035f3"></a> + id="x1-14022f3"></a> and additional glossaries are labelled using the value specified in the first mandatory argument to <span class="ectt-1000">\newglossary</span>. For example, if you load <span @@ -2769,98 +3355,244 @@ class="ecss-1000">glossaries</span> - <div class="verbatim" id="verbatim-27"> + <div class="verbatim" id="verbatim-24"> \usepackage[section,numberedsection=autolabel]{glossaries} </div> - <!--l. 1283--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using + <!--l. 1463--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using something like: </p> - <div class="verbatim" id="verbatim-28"> + <div class="verbatim" id="verbatim-25"> The main glossary is in section~\ref{main} and the list of  <br />acronyms is in section~\ref{acronym}. </div> - <!--l. 1289--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a + <!--l. 1469--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use <span class="ectt-1000">\acronymtype</span><a - id="dx1-13037"></a> which is set to <span + id="dx1-14024"></a> which is set to <span class="ectt-1000">main </span>if the <span class="ecss-1000">acronym</span><a - id="dx1-13038"></a> option is not used and is set to <span + id="dx1-14025"></a> option is not used and is set to <span class="ectt-1000">acronym </span>if the <span class="ecss-1000">acronym</span><a - id="dx1-13039"></a> option is used. + id="dx1-14026"></a> option is used. For example: </p> - <div class="verbatim" id="verbatim-29"> + <div class="verbatim" id="verbatim-26"> The list of acronyms is in section~\ref{\acronymtype}. </div> - <!--l. 1297--><p class="nopar" > - </p><!--l. 1299--><p class="noindent" >As from version 1.14, you can add a prefix to the label by redefining - </p><!--l. 1301--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 1477--><p class="nopar" > + </p><!--l. 1479--><p class="noindent" >As from version 1.14, you can add a prefix to the label by redefining + </p><!--l. 1481--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsautoprefix</span><span class="ectt-0900"> </span></span><a - id="dx1-13040"></a> <span + id="dx1-14027"></a> <span class="ectt-1000">\glsautoprefix </span></div><hr> - </p><!--l. 1303--><p class="noindent" > + </p><!--l. 1483--><p class="noindent" > For example: </p> - <div class="verbatim" id="verbatim-30"> + <div class="verbatim" id="verbatim-27"> \renewcommand*{\glsautoprefix}{glo:} </div> - <!--l. 1307--><p class="nopar" > will add <span + <!--l. 1487--><p class="nopar" > will add <span class="ectt-1000">glo: </span>to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows: </p> - <div class="verbatim" id="verbatim-31"> + <div class="verbatim" id="verbatim-28"> The list of acronyms is in section~\ref{glo:\acronymtype}. </div> - <!--l. 1312--><p class="nopar" > Or, if you are undecided on a prefix: + <!--l. 1492--><p class="nopar" > Or, if you are undecided on a prefix: </p> - <div class="verbatim" id="verbatim-32"> + <div class="verbatim" id="verbatim-29"> The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. </div> - <!--l. 1316--><p class="nopar" > + <!--l. 1496--><p class="nopar" > +</p> + </dd></dl> +<!--l. 1500--><p class="noindent" > +</p> +<!--l. 1500--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.3 </span> <a + id="x1-150002.3"></a>Glossary Appearance Options</h4> +<!--l. 1503--><p class="noindent" > + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">entrycounter</span><a + id="dx1-15001"></a> </dt><dd +class="description">This is a boolean option. (Default is <span +class="ecss-1000">entrycounter=false</span><a + id="dx1-15002"></a>.) If set, each + main (level 0) glossary entry will be numbered when using the standard + glossary styles. This option creates the counter <span class="marginpar"><span +class="ectt-0900">glossaryentry</span><span +class="ectt-0900"> </span></span><a + id="dx1-15003"></a><a + id="dx1-15004"></a><span +class="ecss-1000">glossaryentry</span>. + <!--l. 1510--><p class="noindent" >If you use this option, you can reference the entry number within the document + using + </p><!--l. 1512--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsrefentry</span><span +class="ectt-0900"> </span></span><a + id="dx1-15005"></a> <span +class="ectt-1000">\glsrefentry{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 1514--><p class="noindent" > + where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the label associated with that glossary entry. + </p><!--l. 1517--><p class="noindent" ><div class="important" title="Important Note"> If you use <span +class="ectt-1000">\glsrefentry</span>, you must run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> twice after creating the glossary + files using <a + id="dx1-15006"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-15007"></a></a>, <a + id="dx1-15008"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-15009"></a></a> or <a + id="dx1-15010"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-15011"></a></a> to ensure the cross-references + are up-to-date. </div> + </p><!--l. 1522--><p class="noindent" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">counterwithin</span><a + id="dx1-15012"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>is the name of a counter. If + used, this option will automatically set <span +class="ecss-1000">entrycounter=true</span><a + id="dx1-15013"></a> and the <span +class="ecss-1000">glossaryentry</span><a + id="dx1-15014"></a> + counter will be reset every time <span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>is incremented. + <!--l. 1530--><p class="noindent" ><div class="important" title="Important Note"> The <span +class="ecss-1000">glossaryentry</span><a + id="dx1-15015"></a> counter isn’t automatically reset at the start of each + glossary, except when glossary section numbering is on and the counter + used by <span +class="ecss-1000">counterwithin</span><a + id="dx1-15016"></a> is the same as the counter used in the glossary’s + sectioning command. If you want the counter reset at the start of each + glossary, you can redefine <span +class="ectt-1000">\glossarypreamble</span><a + id="dx1-15017"></a> so that it sets <span +class="ecss-1000">glossaryentry</span><a + id="dx1-15018"></a> to + zero: + + + +</p> + <div class="verbatim" id="verbatim-30"> + \renewcommand{\glossarypreamble}{% +  <br />  \setcounter{glossaryentry}{0}% +  <br />} +</div> + <!--l. 1541--><p class="nopar" > </div> + </p><!--l. 1542--><p class="noindent" > </p></dd><dt class="description"> <span +class="ecsx-1000">subentrycounter</span><a + id="dx1-15019"></a> </dt><dd +class="description">This is a boolean option. (Default is <span +class="ecss-1000">subentrycounter=false</span><a + id="dx1-15020"></a>.) If set, + each level 1 glossary entry will be numbered when using the standard glossary + styles. This option creates the counter <span class="marginpar"><span +class="ectt-0900">glossarysubentry</span><span +class="ectt-0900"> </span></span><a + id="dx1-15021"></a><a + id="dx1-15022"></a><span +class="ecss-1000">glossarysubentry</span>. The + counter is reset with each main (level 0) entry. Note that this package option is + independent of <span +class="ecss-1000">entrycounter</span><a + id="dx1-15023"></a>. You can reference the number within the document + using <span +class="ectt-1000">\glsrefentry</span><a + id="dx1-15024"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the label associated with the + sub-entry. (See above.) + </dd><dt class="description"> +<span class="ecsx-1000">style</span><a - id="dx1-13041"></a> </dt><dd + id="dx1-15025"></a> </dt><dd class="description">This is a <span class="cmsy-10">⟨</span><span class="ecti-1000">key</span><span class="cmsy-10">⟩</span>=<span class="cmsy-10">⟨</span><span class="ecti-1000">value</span><span -class="cmsy-10">⟩ </span>option. Its value should be the name of the glossary style - to use. Predefined glossary styles are listed in <a -href="#x1-380002.12">2.12 </a><a -href="#x1-380002.12">Glossary Styles<!--tex4ht:ref: sec:styles --></a>. +class="cmsy-10">⟩ </span>option. (Default is <span +class="ecss-1000">style=list</span><a + id="dx1-15026"></a>.) Its value should be the + name of the glossary style to use. This key may only be used for styles defined in + <span +class="ecss-1000">glossary-list</span><a + id="dx1-15027"></a>, <span +class="ecss-1000">glossary-long</span><a + id="dx1-15028"></a>, <span +class="ecss-1000">glossary-super</span><a + id="dx1-15029"></a> or <span +class="ecss-1000">glossary-tree</span><a + id="dx1-15030"></a>. (See <a +href="#x1-4500015">15 </a><a +href="#x1-4500015">Glossary + Styles<!--tex4ht:ref: sec:styles --></a>.) </dd><dt class="description"> <span class="ecsx-1000">nolong</span><a - id="dx1-13042"></a> </dt><dd + id="dx1-15031"></a> </dt><dd class="description">This prevents the <span class="ecss-1000">glossaries </span>package from automatically loading <span class="ecss-1000">glossary-long</span><a - id="dx1-13043"></a> + id="dx1-15032"></a> (which means that the <span class="ecss-1000">longtable</span><a - id="dx1-13044"></a> package also won’t be loaded). This reduces + id="dx1-15033"></a> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the <span @@ -2868,14 +3600,14 @@ class="ecss-1000">glossary-long </span>package. </dd><dt class="description"> <span class="ecsx-1000">nosuper</span><a - id="dx1-13045"></a> </dt><dd + id="dx1-15034"></a> </dt><dd class="description">This prevents the <span class="ecss-1000">glossaries </span>package from automatically loading <span class="ecss-1000">glossary-super</span><a - id="dx1-13046"></a> + id="dx1-15035"></a> (which means that the <span class="ecss-1000">supertabular</span><a - id="dx1-13047"></a> package also won’t be loaded). This reduces + id="dx1-15036"></a> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the <span @@ -2883,29 +3615,32 @@ class="ecss-1000">glossary-super </span>package. </dd><dt class="description"> <span class="ecsx-1000">nolist</span><a - id="dx1-13048"></a> </dt><dd + id="dx1-15037"></a> </dt><dd class="description">This prevents the <span class="ecss-1000">glossaries </span>package from automatically loading <span class="ecss-1000">glossary-list</span><a - id="dx1-13049"></a>. + id="dx1-15038"></a>. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the <span class="ecss-1000">glossary-list </span>package. Note that since the default style is <span class="ecss-1000">list</span><a - id="dx1-13050"></a>, + id="dx1-15039"></a>, + + + you will also need to use the <span class="ecss-1000">style</span><a - id="dx1-13051"></a> option to set the style to something + id="dx1-15040"></a> option to set the style to something else. </dd><dt class="description"> <span class="ecsx-1000">notree</span><a - id="dx1-13052"></a> </dt><dd + id="dx1-15041"></a> </dt><dd class="description">This prevents the <span class="ecss-1000">glossaries </span>package from automatically loading <span class="ecss-1000">glossary-tree</span><a - id="dx1-13053"></a>. + id="dx1-15042"></a>. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the <span @@ -2913,248 +3648,227 @@ class="ecss-1000">glossary-tree </span>package. </dd><dt class="description"> <span class="ecsx-1000">nostyles</span><a - id="dx1-13054"></a> </dt><dd + id="dx1-15043"></a> </dt><dd class="description">This prevents all the predefined styles from being loaded. This option is provided in the event that the user has custom styles that are not dependent on the styles provided by the <span class="ecss-1000">glossaries </span>package. Note that if you use this option, you can’t use the <span class="ecss-1000">style</span><a - id="dx1-13055"></a> package option. Instead you must either use + id="dx1-15044"></a> package option. Instead you must either use <span class="ectt-1000">\glossarystyle</span><a - id="dx1-13056"></a><span + id="dx1-15045"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">style</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span>or the <span class="ecss-1000">style</span><a - id="dx1-13057"></a> key in the optional argument to + id="dx1-15046"></a> key in the optional argument to <span class="ectt-1000">\printglossary</span><a - id="dx1-13058"></a>. - - - + id="dx1-15047"></a>. </dd><dt class="description"> <span class="ecsx-1000">nonumberlist</span><a - id="dx1-13059"></a> </dt><dd -class="description">This option will suppress the associated number lists<a - id="dx1-13060"></a> in the glossaries + id="dx1-15048"></a> </dt><dd +class="description">This option will suppress the associated <a + id="dx1-15049"></a><a +href="#glo:numberlist">number list<a + id="dx1-15050"></a>s</a> in the glossaries (see also <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>). +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">seeautonumberlist</span><a + id="dx1-15051"></a> </dt><dd +class="description">If you suppress the <a + id="dx1-15052"></a><a +href="#glo:numberlist">number list<a + id="dx1-15053"></a>s</a> with <span +class="ecss-1000">nonumberlist</span><a + id="dx1-15054"></a>, described above, + this will also suppress any cross-referencing information supplied by the <span +class="ecss-1000">see</span><a + id="dx1-15055"></a> key in + <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-15056"></a> or <span +class="ectt-1000">\glssee</span><a + id="dx1-15057"></a>. If you use <span +class="ecss-1000">seeautonumberlist</span><a + id="dx1-15058"></a>, the <span +class="ecss-1000">see</span><a + id="dx1-15059"></a> key will + automatically implement <span +class="ecss-1000">nonumberlist=false</span><a + id="dx1-15060"></a> for that entry. (Note this + doesn’t affect <span +class="ectt-1000">\glssee</span>.) For further details see <a +href="#x1-300008">8 </a><a +href="#x1-300008">Cross-Referencing + Entries<!--tex4ht:ref: sec:crossref --></a>. </dd><dt class="description"> <span class="ecsx-1000">counter</span><a - id="dx1-13061"></a> </dt><dd + id="dx1-15061"></a> </dt><dd class="description">This is a <span class="cmsy-10">⟨</span><span class="ecti-1000">key</span><span class="cmsy-10">⟩</span>=<span class="cmsy-10">⟨</span><span class="ecti-1000">value</span><span -class="cmsy-10">⟩ </span>option. The value should be the name of the default - counter to use in the number lists<a - id="dx1-13062"></a>. - <!--l. 1369--><p class="noindent" ><a - id="sanitize"></a> - </p></dd><dt class="description"> +class="cmsy-10">⟩ </span>option. (Default is <span +class="ecss-1000">counter=page</span><a + id="dx1-15062"></a>.) The value should be + the name of the default counter to use in the <a + id="dx1-15063"></a><a +href="#glo:numberlist">number list<a + id="dx1-15064"></a>s</a> (see <a +href="#x1-250005">5 </a><a +href="#x1-250005">Number + lists<!--tex4ht:ref: sec:numberlists --></a>). + </dd></dl> +<!--l. 1620--><p class="noindent" > +</p> +<!--l. 1620--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.4 </span> <a + id="x1-160002.4"></a>Sorting Options</h4> +<!--l. 1623--><p class="noindent" > + </p><dl class="description"><dt class="description"> <span -class="ecsx-1000">sanitize</span><a - id="dx1-13063"></a> </dt><dd +class="ecsx-1000">sort</span><a + id="dx1-16001"></a> </dt><dd class="description">This is a <span class="cmsy-10">⟨</span><span class="ecti-1000">key</span><span class="cmsy-10">⟩</span>=<span class="cmsy-10">⟨</span><span class="ecti-1000">value</span><span -class="cmsy-10">⟩ </span>option whose value is also a <span -class="cmsy-10">⟨</span><span -class="ecti-1000">key</span><span -class="cmsy-10">⟩</span>=<span -class="cmsy-10">⟨</span><span -class="ecti-1000">value</span><span -class="cmsy-10">⟩ </span>list. By - default, the <span -class="ecss-1000">glossaries </span>package sanitizes the values of the <span -class="ecss-1000">name</span><a - id="dx1-13064"></a>, <span -class="ecss-1000">description</span><a - id="dx1-13065"></a> and - <span -class="ecss-1000">symbol</span><a - id="dx1-13066"></a> keys used when defining a new glossary entry. This means that you can use - fragile commands in those keys, but it may lead to unexpected results if you try - to display these values within the document text. This sanitization can be - switched off using the <span -class="ecss-1000">sanitize</span><a - id="dx1-13067"></a> package option. For example, to switch off the - sanitization for the <span -class="ecss-1000">description</span><a - id="dx1-13068"></a> and <span -class="ecss-1000">name</span><a - id="dx1-13069"></a> keys, but not for the <span -class="ecss-1000">symbol</span><a - id="dx1-13070"></a> key, - do: +class="cmsy-10">⟩ </span>option where the option can only have one of the + following values: - <div class="verbatim" id="verbatim-33"> - \usepackage[sanitize={name=false,description=false,% -  <br />symbol=true}]{glossaries} -</div> - <!--l. 1385--><p class="nopar" > You can use <span -class="ecss-1000">sanitize=none</span><a - id="dx1-13071"></a> as a shortcut for<br -class="newline" /><span -class="ecss-1000">sanitize={name=false,description=false,symbol=false}</span>. - </p><!--l. 1389--><p class="noindent" ><div class="important" title="Important Note"><span -class="ecbx-1000">Note</span>: this sanitization only applies to the <span -class="ecss-1000">name</span><a - id="dx1-13072"></a>, <span -class="ecss-1000">description</span><a - id="dx1-13073"></a> and <span -class="ecss-1000">symbol</span><a - id="dx1-13074"></a> keys. It - doesn’t apply to any of the other keys (except the <span + <ul class="itemize1"> + <li class="itemize"><span +class="ecss-1000">standard</span><a + id="dx1-16002"></a> : entries are sorted according to the value of the <span class="ecss-1000">sort</span><a - id="dx1-13075"></a> key which is always - sanitized) so fragile commands contained in the value of the other keys must - always be protected using <span -class="ectt-1000">\protect</span>. Since the value of the <span -class="ecss-1000">text</span><a - id="dx1-13076"></a> key is obtained - from the <span -class="ecss-1000">name</span><a - id="dx1-13077"></a> key, you will still need to protect fragile commands in the <span + id="dx1-16003"></a> key used in + <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-16004"></a> (if present) or the <span class="ecss-1000">name</span><a - id="dx1-13078"></a> key - if you don’t use the <span -class="ecss-1000">text</span><a - id="dx1-13079"></a> key. </div> - </p><!--l. 1398--><p class="noindent" > + id="dx1-16005"></a> key (if <span +class="ecss-1000">sort</span><a + id="dx1-16006"></a> key is missing); + </li> + <li class="itemize"><span +class="ecss-1000">def</span><a + id="dx1-16007"></a> : entries are sorted in the order in which they were defined (the <span +class="ecss-1000">sort</span><a + id="dx1-16008"></a> + key in <span +class="ectt-1000">\newglossaryentry </span>is ignored); + </li> + <li class="itemize"><span +class="ecss-1000">use</span><a + id="dx1-16009"></a> : entries are sorted according to the order in which they are used in + the document (the <span +class="ecss-1000">sort</span><a + id="dx1-16010"></a> key in <span +class="ectt-1000">\newglossaryentry </span>is ignored).</li></ul> + <!--l. 1642--><p class="noindent" >The default is <span +class="ecss-1000">sort=standard</span><a + id="dx1-16011"></a>. </p></dd><dt class="description"> <span -class="ecsx-1000">description</span><a - id="dx1-13080"></a> </dt><dd -class="description">This option changes the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-13081"></a> to allow a description. - See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. - </dd><dt class="description"> -<span -class="ecsx-1000">footnote</span><a - id="dx1-13082"></a> </dt><dd -class="description">This option changes the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-13083"></a> and the way that - acronyms are displayed. See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. - </dd><dt class="description"> -<span -class="ecsx-1000">smallcaps</span><a - id="dx1-13084"></a> </dt><dd -class="description">This option changes the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-13085"></a> and the way that - acronyms are displayed. See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. - </dd><dt class="description"> -<span -class="ecsx-1000">smaller</span><a - id="dx1-13086"></a> </dt><dd -class="description">This option changes the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-13087"></a> and the way that acronyms - are displayed. If you use this option, you will need to include the <span -class="ecss-1000">relsize</span><a - id="dx1-13088"></a> package or - otherwise define <span -class="ectt-1000">\textsmaller</span><a - id="dx1-13089"></a> or redefine <span -class="ectt-1000">\acronymfont</span><a - id="dx1-13090"></a>. See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for - further details. - </dd><dt class="description"> -<span -class="ecsx-1000">dua</span><a - id="dx1-13091"></a> </dt><dd -class="description">This option changes the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-13092"></a> so that acronyms are always - expanded. See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. - </dd><dt class="description"> -<span -class="ecsx-1000">shortcuts</span><a - id="dx1-13093"></a> </dt><dd -class="description">This option provides shortcut commands for acronyms. See <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> - for further details. - </dd><dt class="description"> +class="ecsx-1000">order</span><a + id="dx1-16012"></a> </dt><dd +class="description">This may take two values: <span +class="ecss-1000">word</span><a + id="dx1-16013"></a> or <span +class="ecss-1000">letter</span><a + id="dx1-16014"></a>. The default is word ordering. + <!--l. 1648--><p class="noindent" ><div class="important" title="Important Note"> Note that the <span +class="ecss-1000">order</span><a + id="dx1-16015"></a> option has no effect if you don’t use <a + id="dx1-16016"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-16017"></a></a>. + </div> + </p><!--l. 1651--><p class="noindent" > + </p></dd><dt class="description"> <span class="ecsx-1000">makeindex</span><a - id="dx1-13094"></a> </dt><dd + id="dx1-16018"></a> </dt><dd class="description">(Default) The glossary information and indexing style file will be written in - <span + <a + id="dx1-16019"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-13095"></a> format. If you use <span + id="dx1-16020"></a></a> format. If you use <a + id="dx1-16021"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-13096"></a>, it will automatically detect that it - - - - needs to call <span + id="dx1-16022"></a></a>, it will automatically detect that it + needs to call <a + id="dx1-16023"></a><span class="ectt-1000">makeindex</span><a - id="dx1-13097"></a>. If you don’t use <span + id="dx1-16024"></a>. If you don’t use <a + id="dx1-16025"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-13098"></a>, you need to remember - to use <span + id="dx1-16026"></a>, you need to remember + to use <a + id="dx1-16027"></a><span class="ectt-1000">makeindex</span><a - id="dx1-13099"></a> not <span + id="dx1-16028"></a> not <a + id="dx1-16029"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-13100"></a>. The indexing style file will been given a <span + id="dx1-16030"></a></a>. The indexing style file will been given a <span class="ectt-1000">.ist</span><a - id="dx1-13101"></a> + id="dx1-16031"></a> extension. </dd><dt class="description"> <span class="ecsx-1000">xindy</span><a - id="dx1-13102"></a> </dt><dd -class="description">The glossary information and indexing style file will be written in <span + id="dx1-16032"></a> </dt><dd +class="description">The glossary information and indexing style file will be written in <a + id="dx1-16033"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-13103"></a> format. - If you use <span + id="dx1-16034"></a></a> format. + If you use <a + id="dx1-16035"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-13104"></a>, it will automatically detect that it needs to call - <span + id="dx1-16036"></a></a>, it will automatically detect that it needs to call + <a + id="dx1-16037"></a><span class="ectt-1000">xindy</span><a - id="dx1-13105"></a>. If you don’t use <span + id="dx1-16038"></a>. If you don’t use <a + id="dx1-16039"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-13106"></a>, you need to remember to use - <span + id="dx1-16040"></a>, you need to remember to use + <a + id="dx1-16041"></a><span class="ectt-1000">xindy</span><a - id="dx1-13107"></a> not <span + id="dx1-16042"></a> not <a + id="dx1-16043"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-13108"></a>. The indexing style file will been given a <span + id="dx1-16044"></a></a>. The indexing style file will been given a <span class="ectt-1000">.xdy</span><a - id="dx1-13109"></a> + id="dx1-16045"></a> extension. - <!--l. 1440--><p class="noindent" >The <span + <!--l. 1668--><p class="noindent" >The <span class="ecss-1000">xindy</span><a - id="dx1-13110"></a> package option may additionally have a value that is a <span + id="dx1-16046"></a> package option may additionally have a value that is a <span class="cmsy-10">⟨</span><span class="ecti-1000">key</span><span class="cmsy-10">⟩</span>=<span @@ -3166,260 +3880,292 @@ class="cmsy-10">⟩</span> </p> - <div class="verbatim" id="verbatim-34"> + <div class="verbatim" id="verbatim-31"> \usepackage[xindy={language=english,codepage=utf8}]{glossaries} </div> - <!--l. 1445--><p class="nopar" > You can also specify whether you want a number group in the glossary. This + <!--l. 1673--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to true, but can be suppressed. For example: </p> - <div class="verbatim" id="verbatim-35"> + <div class="verbatim" id="verbatim-32"> \usepackage[xindy={glsnumbers=false}]{glossaries} </div> - <!--l. 1450--><p class="nopar" > See <a -href="#x1-290002.8.2">2.8.2 </a><a -href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details on using <span + <!--l. 1678--><p class="nopar" > See <a +href="#x1-3400011">11 </a><a +href="#x1-3400011">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details on using <a + id="dx1-16047"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-13111"></a> with the <span + id="dx1-16048"></a></a> with the <span class="ecss-1000">glossaries</span> package. - </p></dd><dt class="description"> +</p> + </dd></dl> +<!--l. 1684--><p class="noindent" > +</p> +<!--l. 1684--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.5 </span> <a + id="x1-170002.5"></a>Acronym Options</h4> +<!--l. 1687--><p class="noindent" > + </p><dl class="description"><dt class="description"> <span -class="ecsx-1000">order</span><a - id="dx1-13112"></a> </dt><dd -class="description">This may take two values: <span -class="ecss-1000">word</span><a - id="dx1-13113"></a> or <span -class="ecss-1000">letter</span><a - id="dx1-13114"></a>. The default is word ordering. Note that - this option has no effect if you don’t use <span -class="ectt-1000">makeglossaries</span><a - id="dx1-13115"></a>. - </dd><dt class="description"> +class="ecsx-1000">acronym</span><a + id="dx1-17001"></a> </dt><dd +class="description">This creates a new glossary with the label <span +class="ectt-1000">acronym</span>. This is equivalent + to: + + + + <div class="verbatim" id="verbatim-33"> + \newglossary[alg]{acronym}{acr}{acn}{\acronymname} +</div> + <!--l. 1692--><p class="nopar" > If the <span +class="ecss-1000">acronym</span><a + id="dx1-17002"></a> package option is used, <span +class="ectt-1000">\acronymtype</span><a + id="dx1-17003"></a> is set to <span +class="ectt-1000">acronym </span>otherwise it is set + to <span +class="ectt-1000">main</span>.<span class="footnote-mark"><a +href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a + id="x1-17004f4"></a> + Entries that are defined using <span +class="ectt-1000">\newacronym</span><a + id="dx1-17009"></a> are placed in the glossary whose + label is given by <span +class="ectt-1000">\acronymtype</span><a + id="dx1-17010"></a>, unless another glossary is explicitly + specified. + </p></dd><dt class="description"> <span -class="ecsx-1000">translate</span><a - id="dx1-13116"></a> </dt><dd -class="description">This is a boolean option. The default is <span -class="ecss-1000">true</span><a - id="dx1-13117"></a> if <span -class="ecss-1000">babel</span><a - id="dx1-13118"></a>, <span -class="ecss-1000">polyglossia</span><a - id="dx1-13119"></a> or <span -class="ecss-1000">translator</span><a - id="dx1-13120"></a> - have been loaded, otherwise the default value is <span -class="ecss-1000">false</span><a - id="dx1-13121"></a>. - <!--l. 1464--><p class="noindent" > - </p><dl class="description"><dt class="description"> - <span -class="ecsx-1000">translate=true</span><a - id="dx1-13122"></a> </dt><dd -class="description">If <span -class="ecss-1000">babel</span><a - id="dx1-13123"></a> has been loaded and the <span -class="ecss-1000">translator</span><a - id="dx1-13124"></a> package is - installed, <span -class="ecss-1000">translator</span><a - id="dx1-13125"></a> will be loaded and the translations will be provided - by the <span -class="ecss-1000">translator</span><a - id="dx1-13126"></a> package interface. You can modify the translations by - providing your own dictionary. If the <span -class="ecss-1000">translator</span><a - id="dx1-13127"></a> package isn’t installed - and <span -class="ecss-1000">babel</span><a - id="dx1-13128"></a> is loaded, the <span -class="ecss-1000">glossaries-babel</span><a - id="dx1-13129"></a> package will be loaded and the - translations will be provided using <span -class="ecss-1000">babel</span>’s <span -class="ectt-1000">\addto\caption</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">language</span><span -class="cmsy-10">⟩</span> - mechanism. If <span -class="ecss-1000">polyglossia</span><a - id="dx1-13130"></a> has been loaded, <span -class="ecss-1000">glossaries-polyglossia</span><a - id="dx1-13131"></a> will be - loaded. - </dd><dt class="description"> +class="ecsx-1000">acronymlists</span><a + id="dx1-17011"></a> </dt><dd +class="description">By default, only the <span +class="ectt-1000">\acronymtype </span>glossary is considered to be a list of + acronyms. If you have other lists of acronyms, you can specify them as a + comma-separated list in the value of <span +class="ecss-1000">acronymlists</span><a + id="dx1-17012"></a>. For example, if you use the <span -class="ecsx-1000">translate=false</span><a - id="dx1-13132"></a> </dt><dd -class="description">Don’t provide translations, even if <span -class="ecss-1000">babel</span><a - id="dx1-13133"></a> or <span -class="ecss-1000">polyglossia</span><a - id="dx1-13134"></a> has - been loaded. You can then provide you’re own translations or explicitly - load <span -class="ecss-1000">glossaries-babel</span><a - id="dx1-13135"></a> or <span -class="ecss-1000">glossaries-polyglossia</span><a - id="dx1-13136"></a>.</dd></dl> - <!--l. 1483--><p class="noindent" >See <a -href="#x1-50001.2.1">1.2.1 </a><a -href="#x1-50001.2.1">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details. +class="ecss-1000">acronym</span><a + id="dx1-17013"></a> package option but you also want the <span +class="ectt-1000">main </span>glossary to also contain a list + of acronyms, you can do: + + + + <div class="verbatim" id="verbatim-34"> + \usepackage[acronym,acronymlists={main}]{glossaries} +</div> + <!--l. 1711--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add + glossaries you haven’t defined yet. For example: + + + +</p> + <div class="verbatim" id="verbatim-35"> + \usepackage[acronym,acronymlists={main,acronym2}]{glossaries} +  <br />\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} +</div> + <!--l. 1717--><p class="nopar" > </p></dd><dt class="description"> <span -class="ecsx-1000">hyperfirst</span><a - id="dx1-13137"></a> </dt><dd -class="description">This is a boolean option that specifies whether each term has a hyperlink on - first use<a - id="dx1-13138"></a>. The default is <span -class="ecss-1000">hyperfirst=true</span><a - id="dx1-13139"></a> (terms on first use have a hyperlink, - unless explicitly suppressed using starred versions of commands such as - <span -class="ectt-1000">\gls*</span>). +class="ecsx-1000">description</span><a + id="dx1-17014"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-17015"></a> to allow a description. + This option has no effect if you defined your own custom acronym style. See <a +href="#x1-3900013">13 + </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">footnote</span><a + id="dx1-17016"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-17017"></a> and the way that + acronyms are displayed. This option has no effect if you defined your own custom + acronym style. See <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">smallcaps</span><a + id="dx1-17018"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-17019"></a> and the way that + acronyms are displayed. This option may have no effect if you defined your own + custom acronym style. See <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">smaller</span><a + id="dx1-17020"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-17021"></a> and the way that acronyms + are displayed. If you use this option, you will need to include the <span +class="ecss-1000">relsize</span><a + id="dx1-17022"></a> package or + otherwise define <span +class="ectt-1000">\textsmaller</span><a + id="dx1-17023"></a> or redefine <span +class="ectt-1000">\acronymfont</span><a + id="dx1-17024"></a>. This option may have + no effect if you defined your own custom acronym style. See <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for + further details. + </dd><dt class="description"> +<span +class="ecsx-1000">dua</span><a + id="dx1-17025"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-17026"></a> so that acronyms are always + expanded. This option has no effect if you defined your own custom acronym + style. See <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">shortcuts</span><a + id="dx1-17027"></a> </dt><dd +class="description">This option provides shortcut commands for acronyms. See <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for + further details. </dd></dl> -<!--l. 1493--><p class="noindent" > +<!--l. 1751--><p class="noindent" > </p> -<!--l. 1493--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.2 </span> <a - id="x1-140002.2"></a>Defining Glossary Entries</h4> -<!--l. 1496--><p class="noindent" >All glossary entries must be defined before they are used, so it is better to define them in the preamble -to ensure this.<span class="footnote-mark"><a -href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a - id="x1-14001f4"></a> -However only those entries that occur in the document (using any of the commands -described in <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a -href="#x1-240002.5">2.5 </a><a -href="#x1-240002.5">Adding an Entry to the Glossary -Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a -href="#x1-250002.6">2.6 </a><a -href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. -Each time an entry is used in this way, a line is added to an associated glossary file -(<span -class="ectt-1000">.glo</span><a - id="dx1-14002"></a>), which then needs to be converted into a corresponding <span -class="ectt-1000">.gls</span><a - id="dx1-14003"></a> file which contains -the typeset glossary which is input by <span -class="ectt-1000">\printglossary</span><a - id="dx1-14004"></a> or <span -class="ectt-1000">\printglossaries</span><a - id="dx1-14005"></a>. The Perl -script <span -class="ectt-1000">makeglossaries</span><a - id="dx1-14006"></a> can be used to call <span -class="ectt-1000">makeindex</span><a - id="dx1-14007"></a> or <span -class="ectt-1000">xindy</span><a - id="dx1-14008"></a>, using a customised -indexing style file, for each of the glossaries that are defined in the document. Note -that there should be no need for you to explicitly edit or input any of these -external files. See <a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further -details. -</p><!--l. 1515--><p class="indent" > The command -</p><!--l. 1516--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 1751--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-180003"></a>Setting Up</h3> +<!--l. 1754--><p class="noindent" >The command +</p><!--l. 1755--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\makeglossaries</span><span class="ectt-0900"> </span></span><a - id="dx1-14009"></a> <span + id="dx1-18001"></a> <span class="ectt-1000">\makeglossaries </span></div><hr> -</p><!--l. 1518--><p class="noindent" > -must be placed in the preamble in order to create the customised <span +</p><!--l. 1757--><p class="noindent" > +must be placed in the preamble in order to create the customised <a + id="dx1-18002"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-14010"></a> (<span + id="dx1-18003"></a></a> (<span class="ectt-1000">.ist</span><a - id="dx1-14011"></a>) or -<span + id="dx1-18004"></a>) or +<a + id="dx1-18005"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14012"></a> (<span + id="dx1-18006"></a></a> (<span class="ectt-1000">.xdy</span><a - id="dx1-14013"></a>) style file and to ensure that glossary entries are written to the + id="dx1-18007"></a>) style file and to ensure that glossary entries are written to the appropriate output files. If you omit <span class="ectt-1000">\makeglossaries </span>none of the glossaries will be created. -</p><!--l. 1525--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span +</p><!--l. 1764--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span class="ecss-1000">glossaries </span>package must be placed before <span class="ectt-1000">\makeglossaries </span>as they are required when creating the customised style file. If you attempt to use those commands after <span class="ectt-1000">\makeglossaries </span>you will generate an error. </div> -</p><!--l. 1531--><p class="noindent" > -</p><!--l. 1533--><p class="indent" > You can suppress the creation of the customised <span +</p><!--l. 1770--><p class="noindent" > +</p><!--l. 1772--><p class="indent" > You can suppress the creation of the customised <a + id="dx1-18008"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14014"></a> or <span + id="dx1-18009"></a></a> or <a + id="dx1-18010"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-14015"></a> style file + id="dx1-18011"></a></a> style file using -</p><!--l. 1535--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1774--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\noist</span><span class="ectt-0900"> </span></span><a - id="dx1-14016"></a> <span + id="dx1-18012"></a> <span class="ectt-1000">\noist </span></div><hr> -</p><!--l. 1537--><p class="noindent" > +</p><!--l. 1776--><p class="noindent" > Note that this command must be used before <span class="ectt-1000">\makeglossaries</span>. -</p><!--l. 1540--><p class="indent" > The default name for the customised style file is given by <span +</p><!--l. 1778--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span +class="ectt-1000">.xdy</span><a + id="dx1-18013"></a> file created when using <span +class="ecss-1000">glossaries </span>version 2.07 +or below, you will need to use the <span +class="ecss-1000">compatible-2.07</span><a + id="dx1-18014"></a> package option with it. +</div> +</p><!--l. 1782--><p class="noindent" > +</p><!--l. 1784--><p class="indent" > The default name for the customised style file is given by <span class="ectt-1000">\jobname</span><a - id="dx1-14017"></a><span + id="dx1-18015"></a><span class="ectt-1000">.ist</span><a - id="dx1-14018"></a> -(for <span + id="dx1-18016"></a> +(for <a + id="dx1-18017"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-14019"></a>) or <span + id="dx1-18018"></a></a>) or <span class="ectt-1000">\jobname</span><a - id="dx1-14020"></a><span + id="dx1-18019"></a><span class="ectt-1000">.xdy</span><a - id="dx1-14021"></a> (for <span + id="dx1-18020"></a> (for <a + id="dx1-18021"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14022"></a>). This name may be changed + id="dx1-18022"></a></a>). This name may be changed using: -</p><!--l. 1544--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1788--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\setStyleFile</span><span class="ectt-0900"> </span></span><a - id="dx1-14023"></a> <span + id="dx1-18023"></a> <span class="ectt-1000">\setStyleFile{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1546--><p class="noindent" > +</p><!--l. 1790--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩ </span>is the name of the style file without the extension. Note that this command must be used before <span class="ectt-1000">\makeglossaries</span>. -</p><!--l. 1551--><p class="indent" > Each glossary entry is assigned a number list<a - id="dx1-14024"></a> that lists all the locations in the +</p><!--l. 1795--><p class="indent" > Each glossary entry is assigned a <a + id="dx1-18024"></a><a +href="#glo:numberlist">number list<a + id="dx1-18025"></a></a> that lists all the locations in the document where that entry was used. By default, the location refers to the page number but this may be overridden using the <span class="ecss-1000">counter</span><a - id="dx1-14025"></a> package option. The default form of + id="dx1-18026"></a> package option. The default form of the location number assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this - - - using -</p><!--l. 1558--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1802--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsSetCompositor</span><span class="ectt-0900"> </span></span><a - id="dx1-14026"></a> <span + id="dx1-18027"></a> <span class="ectt-1000">\glsSetCompositor{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">symbol</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1560--><p class="noindent" > +</p><!--l. 1804--><p class="noindent" > For example: @@ -3428,44 +4174,103 @@ For example: <div class="verbatim" id="verbatim-36"> \glsSetCompositor{-} </div> -<!--l. 1564--><p class="nopar" > Note that this command must be used before <span +<!--l. 1808--><p class="nopar" > Note that this command must be used before <span class="ectt-1000">\makeglossaries</span>. -</p><!--l. 1567--><p class="indent" > If you use <span +</p><!--l. 1811--><p class="indent" > If you use <a + id="dx1-18028"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14027"></a>, you can have a different compositor for page numbers starting + id="dx1-18029"></a></a>, you can have a different compositor for page numbers starting with an uppercase alphabetical character using: -</p><!--l. 1569--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 1813--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsSetAlphaCompositor</span><span class="ectt-0900"> </span></span><a - id="dx1-14028"></a> <span + id="dx1-18030"></a> <span class="ectt-1000">\glsSetAlphaCompositor{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">symbol</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1571--><p class="noindent" > +</p><!--l. 1815--><p class="noindent" > Note that this command has no effect if you haven’t used the <span class="ecss-1000">xindy</span><a - id="dx1-14029"></a> package option. For -example, if you want number lists<a - id="dx1-14030"></a> containing a mixture of A-1 and 2.3 style formats, + id="dx1-18031"></a> package option. For +example, if you want <a + id="dx1-18032"></a><a +href="#glo:numberlist">number list<a + id="dx1-18033"></a>s</a> containing a mixture of A-1 and 2.3 style formats, then do: </p> <div class="verbatim" id="verbatim-37"> -\glsSetCompositor{.} \glsSetAlphaCompositor{-} -</div> -<!--l. 1578--><p class="nopar" > See <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about number lists<a - id="dx1-14031"></a>. -</p><!--l. 1582--><p class="indent" > New glossary entries are defined using the command: -</p><!--l. 1583--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +\glsSetCompositor{.}\glsSetAlphaCompositor{-} +</div> +<!--l. 1822--><p class="nopar" > See <a +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about <a + id="dx1-18034"></a><a +href="#glo:numberlist">number list<a + id="dx1-18035"></a>s</a>. +</p><!--l. 1826--><p class="noindent" > +</p> +<!--l. 1826--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-190004"></a>Defining Glossary Entries</h3> +<!--l. 1829--><p class="noindent" >All glossary entries must be defined before they are used, so it is better to define them in the preamble +to ensure this.<span class="footnote-mark"><a +href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a + id="x1-19001f5"></a> +However only those entries that occur in the document (using any of the commands +described in <a +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a +href="#x1-290007">7 </a><a +href="#x1-290007">Adding an Entry to the Glossary Without +Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a +href="#x1-300008">8 </a><a +href="#x1-300008">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. Each time +an entry is used in this way, a line is added to an associated glossary file (<span +class="ectt-1000">.glo</span><a + id="dx1-19005"></a>), which +then needs to be converted into a corresponding <span +class="ectt-1000">.gls</span><a + id="dx1-19006"></a> file which contains the typeset +glossary which is input by <span +class="ectt-1000">\printglossary</span><a + id="dx1-19007"></a> or <span +class="ectt-1000">\printglossaries</span><a + id="dx1-19008"></a>. The Perl script +<a + id="dx1-19009"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-19010"></a></a> can be used to call <a + id="dx1-19011"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-19012"></a></a> or <a + id="dx1-19013"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-19014"></a></a>, using a customised indexing +style file, for each of the glossaries that are defined in the document. <span +class="ecbx-1000">Note that there</span> +<span +class="ecbx-1000">should be no need for you to explicitly edit or input any of these external</span> +<span +class="ecbx-1000">files.</span><span class="footnote-mark"><a +href="#fn6x0" id="fn6x0-bk"><sup class="textsuperscript">6</sup></a></span><a + id="x1-19015f6"></a> +See <a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further details. +</p><!--l. 1851--><p class="indent" > New glossary entries are defined using the command: +</p><!--l. 1852--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\newglossaryentry</span><span class="ectt-0900"> </span></span><a - id="dx1-14032"></a> <span + id="dx1-19017"></a> <span class="ectt-1000">\newglossaryentry{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -3475,7 +4280,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">key-val list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1585--><p class="noindent" > +</p><!--l. 1854--><p class="noindent" > The first argument, <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -3492,250 +4297,368 @@ class="ecti-1000">value</span><span class="cmsy-10">⟩ </span>list that supplies the relevant information about this entry. There are two required fields: <span class="ecss-1000">description</span><a - id="dx1-14033"></a> and either <span + id="dx1-19018"></a> and either <span class="ecss-1000">name</span><a - id="dx1-14034"></a> + id="dx1-19019"></a> or <span class="ecss-1000">parent</span><a - id="dx1-14035"></a>. Available fields are listed below: -</p><!--l. 1593--><p class="indent" > + id="dx1-19020"></a>. Available fields are listed below: +</p><!--l. 1862--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecsx-1000">name</span><a - id="dx1-14036"></a> </dt><dd + id="dx1-19021"></a> </dt><dd class="description">The name of the entry (as it will appear in the glossary). If this key is omitted and the <span class="ecss-1000">parent</span><a - id="dx1-14037"></a> key is supplied, this value will be the same as the + id="dx1-19022"></a> key is supplied, this value will be the same as the parent’s name. </dd><dt class="description"> <span class="ecsx-1000">description</span><a - id="dx1-14038"></a> </dt><dd + id="dx1-19023"></a> </dt><dd class="description">A brief description of this term (to appear in the glossary). Within this value, you can use - <!--l. 1600--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 1869--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\nopostdesc</span><span class="ectt-0900"> </span></span><a - id="dx1-14039"></a> <span + id="dx1-19024"></a> <span class="ectt-1000">\nopostdesc </span></div><hr> - </p><!--l. 1602--><p class="noindent" > + </p><!--l. 1871--><p class="noindent" > to suppress the description terminator for this entry. For example, if this + + + entry is a parent entry that doesn’t require a description, you can do <span class="obeylines-h"><span class="verb"><span class="ectt-1000">description={\nopostdesc}</span></span></span>. If you want a paragraph break in the description use - </p><!--l. 1608--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + </p><!--l. 1877--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glspar</span><span class="ectt-0900"> </span></span><a - id="dx1-14040"></a> <span + id="dx1-19025"></a> <span class="ectt-1000">\glspar </span></div><hr> - </p><!--l. 1610--><p class="noindent" > + </p><!--l. 1879--><p class="noindent" > However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use <span class="ectt-1000">\newline</span><a - id="dx1-14041"></a> not <span class="obeylines-h"><span class="verb"><span + id="dx1-19026"></a> not <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\\</span></span></span> if you want to force a line break. </p></dd><dt class="description"> <span class="ecsx-1000">parent</span><a - id="dx1-14042"></a> </dt><dd + id="dx1-19027"></a> </dt><dd class="description">The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See <a -href="#x1-160002.2.2">2.2.2 </a><a -href="#x1-160002.2.2">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details. +href="#x1-210004.2">4.2 </a><a +href="#x1-210004.2">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details. </dd><dt class="description"> <span class="ecsx-1000">descriptionplural</span><a - id="dx1-14043"></a> </dt><dd + id="dx1-19028"></a> </dt><dd class="description">The plural form of the description (as passed to <span class="ectt-1000">\glsdisplay</span><a - id="dx1-14044"></a> and + id="dx1-19029"></a> and <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-14045"></a> by <span + id="dx1-19030"></a> by <span class="ectt-1000">\glspl</span><a - id="dx1-14046"></a>, <span + id="dx1-19031"></a>, <span class="ectt-1000">\Glspl</span><a - id="dx1-14047"></a> and <span + id="dx1-19032"></a> and <span class="ectt-1000">\GLSpl</span><a - id="dx1-14048"></a>). If omitted, the value is set to + id="dx1-19033"></a>). If omitted, the value is set to the same as the <span class="ecss-1000">description</span><a - id="dx1-14049"></a> key. - - - + id="dx1-19034"></a> key. (Note that if you want the description to appear + in the main body of the document, you must switch off the description + <a + id="dx1-19035"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-19036"></a></a> using the <span +class="ecss-1000">sanitize</span><a + id="dx1-19037"></a> package option described in <a +href="#x1-130002.1">2.1 </a><a +href="#x1-130002.1">General + Options<!--tex4ht:ref: sec:pkgopts-general --></a>.) </dd><dt class="description"> <span class="ecsx-1000">text</span><a - id="dx1-14050"></a> </dt><dd + id="dx1-19038"></a> </dt><dd class="description">How this entry will appear in the document text when using <span class="ectt-1000">\gls</span><a - id="dx1-14051"></a> (or one of its + id="dx1-19039"></a> (or one of its uppercase variants). If this field is omitted, the value of the <span class="ecss-1000">name</span><a - id="dx1-14052"></a> key is + id="dx1-19040"></a> key is used. </dd><dt class="description"> <span class="ecsx-1000">first</span><a - id="dx1-14053"></a> </dt><dd -class="description">How the entry will appear in the document text the first time it is used with - <span + id="dx1-19041"></a> </dt><dd +class="description">How the entry will appear in the document text on <a + id="dx1-19042"></a><a +href="#glo:firstuse">first use</a> with <span class="ectt-1000">\gls</span><a - id="dx1-14054"></a><a - id="dx1-14055"></a> (or one of its uppercase variants). If this field is omitted, the value of the - <span + id="dx1-19043"></a> (or one of + its uppercase variants). If this field is omitted, the value of the <span class="ecss-1000">text</span><a - id="dx1-14056"></a> key is used. + id="dx1-19044"></a> key is used. + Note that if you use <span +class="ectt-1000">\glspl</span><a + id="dx1-19045"></a>, <span +class="ectt-1000">\Glspl</span><a + id="dx1-19046"></a>, <span +class="ectt-1000">\GLSpl</span><a + id="dx1-19047"></a>, <span +class="ectt-1000">\glsdisp</span><a + id="dx1-19048"></a> before using <span +class="ectt-1000">\gls</span><a + id="dx1-19049"></a>, the + <span +class="ecss-1000">firstplural</span><a + id="dx1-19050"></a> value won’t be used with <span +class="ectt-1000">\gls</span><a + id="dx1-19051"></a>. </dd><dt class="description"> <span class="ecsx-1000">plural</span><a - id="dx1-14057"></a> </dt><dd + id="dx1-19052"></a> </dt><dd class="description">How the entry will appear in the document text when using <span class="ectt-1000">\glspl</span><a - id="dx1-14058"></a> (or one of its + id="dx1-19053"></a> (or one of its uppercase variants). If this field is omitted, the value is obtained by appending <span class="ectt-1000">\glspluralsuffix</span><a - id="dx1-14059"></a> to the value of the <span + id="dx1-19054"></a> to the value of the <span class="ecss-1000">text</span><a - id="dx1-14060"></a> field. The default value of + id="dx1-19055"></a> field. The default value of <span -class="ectt-1000">\glspluralsuffix </span>is the letter “s”. +class="ectt-1000">\glspluralsuffix</span><a + id="dx1-19056"></a> is the letter “s”. </dd><dt class="description"> <span class="ecsx-1000">firstplural</span><a - id="dx1-14061"></a> </dt><dd -class="description">How the entry will appear in the document text the first time it is used with - <span + id="dx1-19057"></a> </dt><dd +class="description">How the entry will appear in the document text on <a + id="dx1-19058"></a><a +href="#glo:firstuse">first use</a> with <span class="ectt-1000">\glspl</span><a - id="dx1-14062"></a><a - id="dx1-14063"></a> (or one of its uppercase variants). If this field is omitted, the - value is obtained from the <span + id="dx1-19059"></a> (or + one of its uppercase variants). If this field is omitted, the value is obtained from + the <span class="ecss-1000">plural</span><a - id="dx1-14064"></a> key, if the <span + id="dx1-19060"></a> key, if the <span class="ecss-1000">first</span><a - id="dx1-14065"></a> key is omitted, or by - appending <span + id="dx1-19061"></a> key is omitted, or by appending <span class="ectt-1000">\glspluralsuffix</span><a - id="dx1-14066"></a> to the value of the <span + id="dx1-19062"></a> to + the value of the <span class="ecss-1000">first</span><a - id="dx1-14067"></a> field, if the <span + id="dx1-19063"></a> field, if the <span class="ecss-1000">first</span><a - id="dx1-14068"></a> field is - present. - <!--l. 1648--><p class="noindent" ><span + id="dx1-19064"></a> field is present. Note that if you use <span +class="ectt-1000">\gls</span><a + id="dx1-19065"></a>, + <span +class="ectt-1000">\Gls</span><a + id="dx1-19066"></a>, <span +class="ectt-1000">\GLS</span><a + id="dx1-19067"></a>, <span +class="ectt-1000">\glsdisp </span>before using <span +class="ectt-1000">\glspl</span><a + id="dx1-19068"></a>, the <span +class="ecss-1000">firstplural</span><a + id="dx1-19069"></a> value won’t be used with + <span +class="ectt-1000">\glspl</span><a + id="dx1-19070"></a>. + <!--l. 1925--><p class="noindent" ><span class="ecbx-1000">Note: </span>prior to version 1.13, the default value of <span class="ecss-1000">firstplural</span><a - id="dx1-14069"></a> was always taken by + id="dx1-19071"></a> was always taken by appending “s” to the <span class="ecss-1000">first</span><a - id="dx1-14070"></a> key, which meant that you had to specify both <span + id="dx1-19072"></a> key, which meant that you had to specify both <span class="ecss-1000">plural</span><a - id="dx1-14071"></a> and + id="dx1-19073"></a> and <span class="ecss-1000">firstplural</span><a - id="dx1-14072"></a>, even if you hadn’t used the <span + id="dx1-19074"></a>, even if you hadn’t used the <span class="ecss-1000">first</span><a - id="dx1-14073"></a> key. + id="dx1-19075"></a> key. + + + </p></dd><dt class="description"> <span class="ecsx-1000">symbol</span><a - id="dx1-14074"></a> </dt><dd + id="dx1-19076"></a> </dt><dd class="description">This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to <span class="ectt-1000">\relax</span>. Note that not all glossary styles display the - symbol. + symbol. (If you want the symbol to appear in the main body of the document, you + must switch off the symbol <a + id="dx1-19077"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-19078"></a></a> using the <span +class="ecss-1000">sanitize</span><a + id="dx1-19079"></a> package option described + in <a +href="#x1-130002.1">2.1 </a><a +href="#x1-130002.1">General Options<!--tex4ht:ref: sec:pkgopts-general --></a>.) </dd><dt class="description"> <span class="ecsx-1000">symbolplural</span><a - id="dx1-14075"></a> </dt><dd + id="dx1-19080"></a> </dt><dd class="description">This is the plural form of the symbol (as passed to <span class="ectt-1000">\glsdisplay</span><a - id="dx1-14076"></a> and + id="dx1-19081"></a> and <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-14077"></a> by <span + id="dx1-19082"></a> by <span class="ectt-1000">\glspl</span><a - id="dx1-14078"></a>, <span + id="dx1-19083"></a>, <span class="ectt-1000">\Glspl</span><a - id="dx1-14079"></a> and <span + id="dx1-19084"></a> and <span class="ectt-1000">\GLSpl</span><a - id="dx1-14080"></a>). If omitted, the value is set to + id="dx1-19085"></a>). If omitted, the value is set to the same as the <span class="ecss-1000">symbol</span><a - id="dx1-14081"></a> key. + id="dx1-19086"></a> key. </dd><dt class="description"> <span class="ecsx-1000">sort</span><a - id="dx1-14082"></a> </dt><dd -class="description">This value indicates how <span + id="dx1-19087"></a> </dt><dd +class="description">This value indicates how <a + id="dx1-19088"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-14083"></a> or <span + id="dx1-19089"></a></a> or <a + id="dx1-19090"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14084"></a> should sort this entry. If omitted, + id="dx1-19091"></a></a> should sort this entry. If omitted, the value is given by the <span class="ecss-1000">name</span><a - id="dx1-14085"></a> field. + id="dx1-19092"></a> field. In general, it’s best to use the <span +class="ecss-1000">sort</span><a + id="dx1-19093"></a> key if the + <span +class="ecss-1000">name</span><a + id="dx1-19094"></a> contains commands (e.g. <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ensuremath{\alpha}</span></span></span>). Note that the package + options <span +class="ecss-1000">sort=def</span><a + id="dx1-19095"></a> and <span +class="ecss-1000">sort=use</span><a + id="dx1-19096"></a> override the <span +class="ecss-1000">sort</span><a + id="dx1-19097"></a> key in <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-19098"></a> (see + <a +href="#x1-160002.4">2.4 </a><a +href="#x1-160002.4">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>). </dd><dt class="description"> <span class="ecsx-1000">type</span><a - id="dx1-14086"></a> </dt><dd -class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the - default glossary is assumed. The list of acronyms type is given by <span -class="ectt-1000">\acronymtype</span><a - id="dx1-14087"></a> - which will either be <span -class="ectt-1000">main </span>or <span -class="ectt-1000">acronym</span>, depending on whether the <span -class="ecss-1000">acronym</span><a - id="dx1-14088"></a> package - option was used. + id="dx1-19099"></a> </dt><dd +class="description">This specifies the label of the glossary in which this entry belongs. If omitted, + the default glossary is assumed unless <span +class="ectt-1000">\newacronym</span><a + id="dx1-19100"></a> is used (see <a +href="#x1-3900013">13 + </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a>). </dd><dt class="description"> <span class="ecsx-1000">user1</span><a - id="dx1-14089"></a><span + id="dx1-19101"></a><span class="ecbx-1000">, </span><span class="ecbx-1000">…, </span><span class="ecsx-1000">user6</span><a - id="dx1-14090"></a> </dt><dd -class="description">Six additional keys provided for any additional information the user - - - - may want to specify. (For example, an associated dimension or an alternative - plural.) + id="dx1-19102"></a><a + id="dx1-19103"></a><a + id="dx1-19104"></a><a + id="dx1-19105"></a><a + id="dx1-19106"></a> </dt><dd +class="description">Six keys provided for any additional information the user may want to + specify. (For example an associated dimension or an alternative plural or some + other grammatical construct.) </dd><dt class="description"> <span class="ecsx-1000">nonumberlist</span><a - id="dx1-14091"></a> </dt><dd -class="description">Suppress the number list<a - id="dx1-14092"></a> for this entry. + id="dx1-19107"></a> </dt><dd +class="description">A boolean key. If the value is missing or is <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">true</span></span></span>, this will suppress the + <a + id="dx1-19108"></a><a +href="#glo:numberlist">number list<a + id="dx1-19109"></a></a> just for this entry. Conversely, if you have used the package option + <span +class="ecss-1000">nonumberlist</span><a + id="dx1-19110"></a>, you can activate the <a + id="dx1-19111"></a>number list<a + id="dx1-19112"></a> just for this entry with + <span +class="ecss-1000">nonumberlist=false</span><a + id="dx1-19113"></a>. (See <a +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) </dd><dt class="description"> <span class="ecsx-1000">see</span><a - id="dx1-14093"></a> </dt><dd + id="dx1-19114"></a> </dt><dd class="description">Cross-reference another entry. Using the <span class="ecss-1000">see</span><a - id="dx1-14094"></a> key will automatically add this entry + id="dx1-19115"></a> key will automatically add this entry to the glossary, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. If you want to - override the “see” tag, you can supply the new tag in square brackets before the - label. For example <span class="obeylines-h"><span class="verb"><span + override the “see” tag, you can supply the new tag in square brackets before + the label. For example <span class="obeylines-h"><span class="verb"><span class="ectt-1000">see=[see</span><span -class="ectt-1000"> also]{anotherlabel}</span></span></span>. For further details, see <a -href="#x1-250002.6">2.6 - </a><a -href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>. +class="ectt-1000"> also]{anotherlabel}</span></span></span>. Note that if + you have suppressed the <a + id="dx1-19116"></a><a +href="#glo:numberlist">number list<a + id="dx1-19117"></a></a>, the cross-referencing information + won’t appear in the glossary. You can override this for individual glossary + entries using <span +class="ecss-1000">nonumberlist=false</span><a + id="dx1-19118"></a> (see above). Alternatively, you can use the + <span +class="ecss-1000">seeautonumberlist</span><a + id="dx1-19119"></a> package option. For further details, see <a +href="#x1-300008">8 </a><a +href="#x1-300008">Cross-Referencing + Entries<!--tex4ht:ref: sec:crossref --></a>. </dd></dl> -<!--l. 1693--><p class="noindent" >Note that if the name starts with an accented letter or non-Latin character, you must -group the accented letter, otherwise it will cause a problem for commands like <span -class="ectt-1000">\Gls </span>and + + + +<!--l. 1986--><p class="indent" > The following keys are reserved for <span +class="ectt-1000">\newacronym</span><a + id="dx1-19120"></a> (see <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a>): <span +class="ecss-1000">long</span><a + id="dx1-19121"></a>, +<span +class="ecss-1000">longplural</span><a + id="dx1-19122"></a>, <span +class="ecss-1000">short</span><a + id="dx1-19123"></a> and <span +class="ecss-1000">shortplural</span><a + id="dx1-19124"></a>. +</p><!--l. 1990--><p class="indent" > Note that if the name starts with an accented letter or non-Roman character, you +must group the character, otherwise it will cause a problem for commands like <span +class="ectt-1000">\Gls</span><a + id="dx1-19125"></a> and <span -class="ectt-1000">\Glspl</span>. For example: +class="ectt-1000">\Glspl</span><a + id="dx1-19126"></a>. For example: @@ -3744,9 +4667,9 @@ class="ectt-1000">\Glspl</span>. For example: \newglossaryentry{elite}{name={{\’e}lite},  <br />description={select group or class}} </div> -<!--l. 1700--><p class="nopar" > Note that the same applies if you are using the <span +<!--l. 1997--><p class="nopar" > Note that the same applies if you are using the <span class="ecss-1000">inputenc</span><a - id="dx1-14095"></a> package: + id="dx1-19127"></a> package: @@ -3755,28 +4678,32 @@ class="ecss-1000">inputenc</span><a \newglossaryentry{elite}{name={{}lite},  <br />description={select group or class}} </div> -<!--l. 1706--><p class="nopar" > Note that in both of the above examples, you will also need to supply the <span +<!--l. 2003--><p class="nopar" > Note that in both of the above examples, you will also need to supply the <span class="ecss-1000">sort</span><a - id="dx1-14096"></a> key if -you are using <span + id="dx1-19128"></a> key if +you are using <a + id="dx1-19129"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-14097"></a> whereas <span + id="dx1-19130"></a></a> whereas <a + id="dx1-19131"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-14098"></a> is usually able to sort accented letters + id="dx1-19132"></a></a> is usually able to sort accented letters correctly. -</p><!--l. 1714--><p class="noindent" > +</p><!--l. 2009--><p class="noindent" > </p> -<!--l. 1714--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.1 </span> <a - id="x1-150002.2.1"></a>Plurals</h5> -<!--l. 1715--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define +<!--l. 2009--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">4.1 </span> <a + id="x1-200004.1"></a>Plurals</h4> +<!--l. 2010--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending -</p><!--l. 1718--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2013--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glspluralsuffix</span><span class="ectt-0900"> </span></span><a - id="dx1-15001"></a> <span + id="dx1-20001"></a> <span class="ectt-1000">\glspluralsuffix </span></div><hr> -</p><!--l. 1720--><p class="noindent" > +</p><!--l. 2015--><p class="noindent" > to the singular form. This command defaults to the letter “s”. For example: @@ -3786,7 +4713,7 @@ to the singular form. This command defaults to the letter “s”. For e \newglossaryentry{cow}{name=cow,description={a fully grown  <br />female of any bovine animal}} </div> -<!--l. 1726--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if +<!--l. 2021--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in archaic English, you may want to use “kine” as the plural form, in which case you would have to do: @@ -3797,11 +4724,11 @@ which case you would have to do: \newglossaryentry{cow}{name=cow,plural=kine,  <br />description={a fully grown female of any bovine animal}} </div> -<!--l. 1734--><p class="nopar" > -</p><!--l. 1736--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) +<!--l. 2029--><p class="nopar" > +</p><!--l. 2031--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use the <span class="ecss-1000">plural</span><a - id="dx1-15002"></a> key for one of them and one of the user keys to specify the other + id="dx1-20002"></a> key for one of them and one of the user keys to specify the other plural form. For example: @@ -3812,7 +4739,7 @@ plural form. For example:  <br />female of any bovine animal (plural cows, archaic plural kine)},  <br />user1={kine}} </div> -<!--l. 1744--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span +<!--l. 2039--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspl{cow}</span></span></span> to produce “cows” and <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuseri{cow}</span></span></span> to produce “kine”. You can, of course, define an easy to remember synonym. For @@ -3824,51 +4751,63 @@ example: <div class="verbatim" id="verbatim-43"> \let\glsaltpl\glsuseri </div> -<!--l. 1750--><p class="nopar" > Then you don’t have to remember which key you used to store the alternative +<!--l. 2045--><p class="nopar" > Then you don’t have to remember which key you used to store the alternative plural. -</p><!--l. 1754--><p class="indent" > If you are using a language that usually forms plurals by appending a different +</p><!--l. 2049--><p class="indent" > If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine <span class="ectt-1000">\glspluralsuffix </span>as required. However, this must be done <span class="ecti-1000">before </span>the entries are defined. For languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the <span class="ecss-1000">plural</span><a - id="dx1-15003"></a> key + id="dx1-20003"></a> key (and the <span class="ecss-1000">firstplural</span><a - id="dx1-15004"></a> key where necessary). -</p><!--l. 1763--><p class="noindent" > + id="dx1-20004"></a> key where necessary). +</p><!--l. 2057--><p class="noindent" > </p> -<!--l. 1763--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.2 </span> <a - id="x1-160002.2.2"></a>Sub-Entries</h5> -<!--l. 1766--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order +<!--l. 2057--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">4.2 </span> <a + id="x1-210004.2"></a>Sub-Entries</h4> +<!--l. 2060--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into categories, in which case the sub-entry will have a different name to its -parent entry, or it may be used to distinguish different definitions for the same word, -in which case the sub-entries will have the same name as the parent entry. -Note that not all glossary styles support hierarchical entries and may display -all the entries in a flat format. Of the styles that support sub-entries, some -display the sub-entry’s name whilst others don’t. Therefore you need to ensure -that you use a suitable style. See <a -href="#x1-380002.12">2.12 </a><a -href="#x1-380002.12">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined -styles. -</p><!--l. 1778--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its +parent entry, or it may be used to distinguish different definitions for the same word, in +which case the sub-entries will have the same name as the parent entry. Note that not +all glossary styles support hierarchical entries and may display all the entries in a flat +format. Of the styles that support sub-entries, some display the sub-entry’s name whilst +others don’t. Therefore you need to ensure that you use a suitable style. (See <a +href="#x1-4500015">15 +</a><a +href="#x1-4500015">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined styles.) As from version 3.0, level 1 +sub-entries are automatically numbered in the predefined styles if you use the +<span +class="ecss-1000">subentrycounter</span><a + id="dx1-21001"></a> package option (see <a +href="#x1-150002.3">2.3 </a><a +href="#x1-150002.3">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further +details). +</p><!--l. 2075--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the -document, it will not have a number list<a - id="dx1-16001"></a>. -</p> -<!--l. 1784--><p class="noindent" ><a -href="#top">Top</a> -</p><!--l. 1784--><p class="noindent" ><span class="paragraphHead"><a - id="x1-170002.2.2"></a><span -class="ecbx-1000">Hierarchical Categories</span></span> - To arrange a glossary with hierarchical categories, you need to first define the -category and then define the sub-entries using the relevant category entry as the value -of the <span +document, it will not have a <a + id="dx1-21002"></a><a +href="#glo:numberlist">number list<a + id="dx1-21003"></a></a>. Note also that <a + id="dx1-21004"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-21005"></a></a> has a restriction on +the maximum sub-entry depth. +</p><!--l. 2081--><p class="noindent" > +</p> +<!--l. 2081--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">4.2.1 </span> <a + id="x1-220004.2.1"></a>Hierarchical Categories</h5> +<!--l. 2083--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category +and then define the sub-entries using the relevant category entry as the value of the +<span class="ecss-1000">parent</span><a - id="dx1-17001"></a> key. For example, suppose I want a glossary of mathematical symbols that -are divided into Greek letters and Roman letters. Then I can define the categories as + id="dx1-22001"></a> key. For example, suppose I want a glossary of mathematical symbols that are +divided into Greek letters and Roman letters. Then I can define the categories as follows: @@ -3880,37 +4819,36 @@ follows:  <br />\newglossaryentry{romanletter}{name={Roman letters},  <br />description={\nopostdesc}} </div> -<!--l. 1797--><p class="nopar" > -</p><!--l. 1799--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set +<!--l. 2095--><p class="nopar" > +</p><!--l. 2097--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the descriptions to <span class="ectt-1000">\nopostdesc</span><a - id="dx1-17002"></a>. This gives a blank description and suppresses the + id="dx1-22002"></a>. This gives a blank description and suppresses the description terminator. -</p><!--l. 1804--><p class="indent" > I can now define my sub-entries as follows: +</p><!--l. 2102--><p class="indent" > I can now define my sub-entries as follows: </p> <div class="verbatim" id="verbatim-45"> -\newglossaryentry{pi}{name={pi}, +\newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},  <br />description={ratio of the circumference of a circle to the diameter},  <br />parent=greekletter} - <br />\newglossaryentry{C}{name=C, + <br />\newglossaryentry{C}{name={\ensuremath{C}},sort={C},  <br />description={Euler’s constant},  <br />parent=romanletter} </div> -<!--l. 1813--><p class="nopar" > +<!--l. 2111--><p class="nopar" > +</p><!--l. 2114--><p class="noindent" > </p> -<!--l. 1816--><p class="noindent" ><a -href="#top">Top</a> -</p><!--l. 1816--><p class="noindent" ><span class="paragraphHead"><a - id="x1-180002.2.2"></a><span -class="ecbx-1000">Homographs</span></span> - Sub-entries that have the same name as the parent entry, don’t need to have the -<span +<!--l. 2114--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">4.2.2 </span> <a + id="x1-230004.2.2"></a>Homographs</h5> +<!--l. 2116--><p class="noindent" >Sub-entries that have the same name as the parent entry, don’t need to have the <span class="ecss-1000">name</span><a - id="dx1-18001"></a> key. For example, the word “glossary” can mean a list of technical words or a -collection of glosses. In both cases the plural is “glossaries”. So first define the parent + id="dx1-23001"></a> +key. For example, the word “glossary” can mean a list of technical words or a collection +of glosses. In both cases the plural is “glossaries”. So first define the parent entry: @@ -3921,36 +4859,49 @@ entry:  <br />description={\nopostdesc},  <br />plural={glossaries}} </div> -<!--l. 1825--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be +<!--l. 2125--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be suppressed using <span class="ectt-1000">\nopostdesc</span><a - id="dx1-18002"></a>. -</p><!--l. 1829--><p class="indent" > Now define the two different meanings of the word: + id="dx1-23002"></a>. +</p><!--l. 2129--><p class="indent" > Now define the two different meanings of the word: </p> <div class="verbatim" id="verbatim-47"> \newglossaryentry{glossarylist}{ - <br />description={1) list of technical words}, + <br />description={list of technical words},  <br />sort={1},  <br />parent={glossary}}  <br />\newglossaryentry{glossarycol}{ - <br />description={2) collection of glosses}, + <br />description={collection of glosses},  <br />sort={2},  <br />parent={glossary}} </div> -<!--l. 1840--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s -number list<a - id="dx1-18003"></a>, whereas if I reference any of the child entries, the location will be added to +<!--l. 2140--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s +<a + id="dx1-23003"></a><a +href="#glo:numberlist">number list<a + id="dx1-23004"></a></a>, whereas if I reference any of the child entries, the location will be added to the child entry’s number list. Note also that since the sub-entries have the same name, the <span class="ecss-1000">sort</span><a - id="dx1-18004"></a> key is required. -</p><!--l. 1847--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the + id="dx1-23005"></a> key is required unless you are using the <span +class="ecss-1000">sort=use</span><a + id="dx1-23006"></a> or <span +class="ecss-1000">sort=def</span><a + id="dx1-23007"></a> package +options. You can use the <span +class="ecss-1000">subentrycounter</span><a + id="dx1-23008"></a> package option to automatically number +the first-level child entries. See <a +href="#x1-150002.3">2.3 </a><a +href="#x1-150002.3">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further +details. +</p><!--l. 2151--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the parent entry, so the <span class="ecss-1000">plural</span><a - id="dx1-18005"></a> key was not required for the child entries. However, + id="dx1-23009"></a> key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example: @@ -3960,27 +4911,27 @@ example: <div class="verbatim" id="verbatim-48"> \newglossaryentry{bravo}{name={bravo},  <br />description={\nopostdesc}} - <br />\newglossaryentry{bravocry}{description={1) cry of approval (pl.\ bravos)}, + <br />\newglossaryentry{bravocry}{description={cry of approval (pl.\ bravos)},  <br />sort={1},  <br />plural={bravos},  <br />parent=bravo} - <br />\newglossaryentry{bravoruffian}{description={2) hired ruffian or + <br />\newglossaryentry{bravoruffian}{description={hired ruffian or  <br />killer (pl.\ bravoes)},  <br />sort={2},  <br />plural={bravoes},  <br />parent=bravo} </div> -<!--l. 1865--><p class="nopar" > -</p><!--l. 1868--><p class="noindent" > +<!--l. 2169--><p class="nopar" > +</p><!--l. 2172--><p class="noindent" > </p> -<!--l. 1868--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.3 </span> <a - id="x1-190002.2.3"></a>Loading Entries From a File</h5> -<!--l. 1871--><p class="noindent" >You can store all your glossary entry definitions in another file and use: -</p><!--l. 1873--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 2172--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">4.3 </span> <a + id="x1-240004.3"></a>Loading Entries From a File</h4> +<!--l. 2175--><p class="noindent" >You can store all your glossary entry definitions in another file and use: +</p><!--l. 2177--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\loadglsentries</span><span class="ectt-0900"> </span></span><a - id="dx1-19001"></a> <span + id="dx1-24001"></a> <span class="ectt-1000">\loadglsentries[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span @@ -3990,23 +4941,26 @@ class="cmsy-10">⟨</span><span class="ecti-1000">filename</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1875--><p class="noindent" > +</p><!--l. 2179--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">filename</span><span class="cmsy-10">⟩ </span>is the name of the file containing all the <span -class="ectt-1000">\newglossaryentry</span> +class="ectt-1000">\newglossaryentry</span><a + id="dx1-24002"></a> commands. The optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span class="cmsy-10">⟩ </span>is the name of the glossary to which those entries should belong, for those entries where the <span class="ecss-1000">type</span><a - id="dx1-19002"></a> key has been omitted (or, more + id="dx1-24003"></a> key has been omitted (or, more specifically, for those entries whose type has been specified by <span -class="ectt-1000">\glsdefaulttype</span>, which +class="ectt-1000">\glsdefaulttype</span><a + id="dx1-24004"></a>, which is what <span -class="ectt-1000">\newglossaryentry </span>uses by default). For example, suppose I have a file called +class="ectt-1000">\newglossaryentry</span><a + id="dx1-24005"></a> uses by default). For example, suppose I have a file called <span class="ectt-1000">myentries.tex </span>which contains: @@ -4023,7 +4977,7 @@ class="ectt-1000">myentries.tex </span>which contains:  <br />name={html},  <br />description={A mark up language}} </div> -<!--l. 1895--><p class="nopar" > and suppose in my document preamble I use the command: +<!--l. 2199--><p class="nopar" > and suppose in my document preamble I use the command: @@ -4031,7 +4985,7 @@ class="ectt-1000">myentries.tex </span>which contains: <div class="verbatim" id="verbatim-50"> \loadglsentries[languages]{myentries} </div> -<!--l. 1899--><p class="nopar" > then this will add the entries <span +<!--l. 2203--><p class="nopar" > then this will add the entries <span class="ectt-1000">tex </span>and <span class="ectt-1000">html </span>to the glossary whose type is given by <span @@ -4039,11 +4993,12 @@ class="ectt-1000">languages</span>, but the entry <span class="ectt-1000">perl </span>will be added to the main glossary, since it explicitly sets the type to <span class="ectt-1000">main</span>. -</p><!--l. 1905--><p class="indent" > <span +</p><!--l. 2209--><p class="indent" > <span class="ecbx-1000">Note: </span>if you use <span -class="ectt-1000">\newacronym </span>(see <a -href="#x1-340002.10">2.10 </a><a -href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a>) the type is set as +class="ectt-1000">\newacronym</span><a + id="dx1-24006"></a> (see <a +href="#x1-3900013">13 </a><a +href="#x1-3900013">Acronyms<!--tex4ht:ref: sec:acronyms --></a>) the type is set as <span class="obeylines-h"><span class="verb"><span class="ectt-1000">type=\acronymtype</span></span></span> unless you explicitly override it. For example, if my file <span @@ -4055,7 +5010,7 @@ class="ectt-1000">myacronyms.tex </span>contains: <div class="verbatim" id="verbatim-51"> \newacronym{aca}{aca}{a contrived acronym} </div> -<!--l. 1911--><p class="nopar" > then (supposing I have defined a new glossary type called <span +<!--l. 2215--><p class="nopar" > then (supposing I have defined a new glossary type called <span class="ectt-1000">altacronym</span>) @@ -4064,80 +5019,100 @@ class="ectt-1000">altacronym</span>) <div class="verbatim" id="verbatim-52"> \loadglsentries[altacronym]{myacronyms} </div> -<!--l. 1916--><p class="nopar" > will add <span +<!--l. 2220--><p class="nopar" > will add <span class="ectt-1000">aca </span>to the glossary type <span class="ectt-1000">acronym</span>, if the package option <span class="ecss-1000">acronym</span><a - id="dx1-19003"></a> has been specified, + id="dx1-24007"></a> has been specified, or will add <span class="ectt-1000">aca </span>to the glossary type <span class="ectt-1000">altacronym</span>, if the package option <span class="ecss-1000">acronym</span><a - id="dx1-19004"></a> is not + id="dx1-24008"></a> is not specified.<span class="footnote-mark"><a -href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a - id="x1-19005f5"></a> -In this instance, it is better to change <span -class="ectt-1000">myacronyms.tex </span>to: +href="#fn7x0" id="fn7x0-bk"><sup class="textsuperscript">7</sup></a></span><a + id="x1-24009f7"></a> +</p><!--l. 2228--><p class="indent" > If you have used the <span +class="ecss-1000">acronym</span><a + id="dx1-24013"></a> package option, there are two possible solutions to this +problem: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-24015x1">Change <span +class="ectt-1000">myacronyms.tex </span>so that entries are defined in the form: -</p> - <div class="verbatim" id="verbatim-53"> -\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} + <div class="verbatim" id="verbatim-53"> + \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} </div> -<!--l. 1926--><p class="nopar" > and now + <!--l. 2235--><p class="nopar" > and do: </p> - <div class="verbatim" id="verbatim-54"> -\loadglsentries[altacronym]{myacronyms} + <div class="verbatim" id="verbatim-54"> + \loadglsentries[altacronym]{myacronyms} </div> -<!--l. 1930--><p class="nopar" > will add <span -class="ectt-1000">aca </span>to the glossary type <span -class="ectt-1000">altacronym</span>, regardless of whether or not the package -option <span -class="ecss-1000">acronym</span><a - id="dx1-19007"></a> is used. -</p><!--l. 1935--><p class="indent" > Note that only those entries that have been used in the text will appear in the + <!--l. 2239--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-24017x2">Temporarily change <span +class="ectt-1000">\acronymtype </span>to the target glossary: + + + + <div class="verbatim" id="verbatim-55"> + \let\orgacronymtype\acronymtype +  <br />\def\acronymtype{altacronym} +  <br />\loadglsentries{myacronyms} +  <br />\let\acronymtype\orgacronymtype +</div> + <!--l. 2247--><p class="nopar" ></p></li></ol> +<!--l. 2250--><p class="indent" > Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also that <span class="ectt-1000">\loadglsentries </span>may only be used in the preamble. -</p><!--l. 1940--><p class="noindent" > +</p><!--l. 2255--><p class="noindent" > </p> -<!--l. 1940--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.3 </span> <a - id="x1-200002.3"></a>Number lists</h4> -<!--l. 1943--><p class="noindent" >Each entry in the glossary has an associated <span -class="ecti-1000">number list</span><a - id="dx1-20001"></a>. By default, these numbers +<!--l. 2255--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-250005"></a>Number lists</h3> +<!--l. 2258--><p class="noindent" >Each entry in the glossary has an associated <a + id="dx1-25001"></a><a +href="#glo:numberlist">number list<a + id="dx1-25002"></a></a>. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a -href="#x1-240002.5">2.5 </a><a -href="#x1-240002.5">Adding an Entry to the Glossary +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a +href="#x1-290007">7 </a><a +href="#x1-290007">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>). The number list can be suppressed using the <span class="ecss-1000">nonumberlist</span><a - id="dx1-20002"></a> + id="dx1-25003"></a> package option, or an alternative counter can be set as the default using the <span class="ecss-1000">counter</span><a - id="dx1-20003"></a> package option. The number list is also referred to as the location + id="dx1-25004"></a> package option. The number list is also referred to as the location list<a - id="dx1-20004"></a>. -</p><!--l. 1953--><p class="indent" > Both <span + id="dx1-25005"></a>. +</p><!--l. 2268--><p class="indent" > Both <a + id="dx1-25006"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-20005"></a> and <span + id="dx1-25007"></a></a> and <a + id="dx1-25008"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-20006"></a> concatenate a sequence of 3 or more consecutive pages -into a range. With <span + id="dx1-25009"></a></a> concatenate a sequence of 3 or more consecutive pages +into a range. With <a + id="dx1-25010"></a><span class="ectt-1000">xindy</span><a - id="dx1-20007"></a> you can vary the minimum sequence length using + id="dx1-25011"></a> you can vary the minimum sequence length using <span class="ectt-1000">\GlsSetXdyMinRangeLength</span><a - id="dx1-20008"></a><span + id="dx1-25012"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">n</span><span @@ -4148,179 +5123,200 @@ class="ecti-1000">n</span><span class="cmsy-10">⟩ </span>is either an integer or the keyword <span class="ectt-1000">none</span> which indicates that there should be no range formation. -</p><!--l. 1960--><p class="indent" > <div class="important" title="Important Note"> Note that <span +</p><!--l. 2275--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="ectt-1000">\GlsSetXdyMinRangeLength </span>must be used before <span class="ectt-1000">\makeglossaries</span><a - id="dx1-20009"></a> and + id="dx1-25013"></a> and has no effect if <span class="ectt-1000">\noist</span><a - id="dx1-20010"></a> is used. </div> -</p><!--l. 1963--><p class="noindent" > -</p><!--l. 1965--><p class="indent" > With both <span + id="dx1-25014"></a> is used. </div> +</p><!--l. 2278--><p class="noindent" > +</p><!--l. 2280--><p class="indent" > With both <a + id="dx1-25015"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-20011"></a> and <span + id="dx1-25016"></a></a> and <a + id="dx1-25017"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-20012"></a>, you can replace the separator and the closing + id="dx1-25018"></a></a>, you can replace the separator and the closing number in the range using: -</p><!--l. 1967--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2282--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsSetSuffixF</span><span class="ectt-0900"> </span></span><a - id="dx1-20013"></a> <span + id="dx1-25019"></a> <span class="ectt-1000">\glsSetSuffixF{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">suffix</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1969--><p class="noindent" > -</p><!--l. 1970--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2284--><p class="noindent" > +</p><!--l. 2285--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsSetSuffixFF</span><span class="ectt-0900"> </span></span><a - id="dx1-20014"></a> <span + id="dx1-25020"></a> <span class="ectt-1000">\glsSetSuffixFF{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">suffix</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 1972--><p class="noindent" > +</p><!--l. 2287--><p class="noindent" > where the former command specifies the suffix to use for a 2 page list and the latter specifies the suffix to use for longer lists. For example: </p> - <div class="verbatim" id="verbatim-55"> + <div class="verbatim" id="verbatim-56"> \glsSetSuffixF{f.}  <br />\glsSetSuffixFF{ff.} </div> -<!--l. 1979--><p class="nopar" > Note that if you use <span +<!--l. 2294--><p class="nopar" > Note that if you use <a + id="dx1-25021"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-20015"></a>, you will also need to set the minimum range length to 1 if + id="dx1-25022"></a></a>, you will also need to set the minimum range length to 1 if you want to change these suffixes: </p> - <div class="verbatim" id="verbatim-56"> + <div class="verbatim" id="verbatim-57"> \GlsSetXdyMinRangeLength{1} </div> -<!--l. 1985--><p class="nopar" > Note that if you use the <span +<!--l. 2300--><p class="nopar" > Note that if you use the <span class="ecss-1000">hyperref</span><a - id="dx1-20016"></a> package, you will need to use <span + id="dx1-25023"></a> package, you will need to use <span class="ectt-1000">\nohyperpage</span><a - id="dx1-20017"></a> in the + id="dx1-25024"></a> in the suffix to ensure that the hyperlinks work correctly. For example: </p> - <div class="verbatim" id="verbatim-57"> + <div class="verbatim" id="verbatim-58"> \glsSetSuffixF{\nohyperpage{f.}}  <br />\glsSetSuffixFF{\nohyperpage{ff.}} </div> -<!--l. 1992--><p class="nopar" > -</p><!--l. 1994--><p class="indent" > <div class="important" title="Important Note"> Note that <span +<!--l. 2307--><p class="nopar" > +</p><!--l. 2309--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="ectt-1000">\glsSetSuffixF </span>and <span class="ectt-1000">\glsSetSuffixFF </span>must be used before <span class="ectt-1000">\makeglossaries</span><a - id="dx1-20018"></a> and have no effect if <span + id="dx1-25025"></a> and have no effect if <span class="ectt-1000">\noist</span><a - id="dx1-20019"></a> is used. </div> -</p><!--l. 1998--><p class="noindent" > -</p><!--l. 2001--><p class="noindent" > + id="dx1-25026"></a> is used. </div> +</p><!--l. 2313--><p class="noindent" > +</p><!--l. 2316--><p class="noindent" > </p> -<!--l. 2001--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.4 </span> <a - id="x1-210002.4"></a>Links to Glossary Entries</h4> -<!--l. 2004--><p class="noindent" >Once you have defined a glossary entry using <span +<!--l. 2316--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-260006"></a>Links to Glossary Entries</h3> +<!--l. 2319--><p class="noindent" >Once you have defined a glossary entry using <span class="ectt-1000">\newglossaryentry</span><a - id="dx1-21001"></a>, you can refer to that + id="dx1-26001"></a>, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to -as the <span -class="ecti-1000">link text</span><a - id="dx1-21002"></a> (even if there are no hyperlinks). The commands in this section also add -a line to an external file that is used by <span +as the <a + id="dx1-26002"></a><a +href="#glo:linktext">link text<a + id="dx1-26003"></a></a> (even if there are no hyperlinks). The commands in this section also add +a line to an external file that is used by <a + id="dx1-26004"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-21003"></a> or <span + id="dx1-26005"></a></a> or <a + id="dx1-26006"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-21004"></a> to generate the relevant + id="dx1-26007"></a></a> to generate the relevant entry in the glossary. This information includes an associated location that -is added to the number list<a - id="dx1-21005"></a> for that entry. By default, the location refers to +is added to the <a + id="dx1-26008"></a><a +href="#glo:numberlist">number list<a + id="dx1-26009"></a></a> for that entry. By default, the location refers to the page number. For further information on number lists, see <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a>. -</p><!--l. 2016--><p class="indent" > <div class="important" title="Important Note"> It is strongly recommended that you don’t use the commands defined in this section -in the arguments of sectioning or caption commands. </div> -</p><!--l. 2020--><p class="noindent" > -</p><!--l. 2022--><p class="indent" > The above warning is particularly important if you are using the <span +</p><!--l. 2331--><p class="indent" > <div class="important" title="Important Note"> It is strongly recommended that you don’t use the commands defined in this section +in the arguments of sectioning or caption commands or any other command that has a +moving argument. </div> +</p><!--l. 2335--><p class="noindent" > +</p><!--l. 2337--><p class="indent" > The above warning is particularly important if you are using the <span class="ecss-1000">glossaries </span>package in conjunction with the <span class="ecss-1000">hyperref</span><a - id="dx1-21006"></a> package. Instead, use one of the commands listed in -<a -href="#x1-260002.7">2.7 </a><a -href="#x1-260002.7">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> (such as <span -class="ectt-1000">\glsentrytext</span>) or provide an + id="dx1-26010"></a> package. Instead, use one of the commands listed in <a +href="#x1-320009">9 +</a><a +href="#x1-320009">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> (such as <span +class="ectt-1000">\glsentrytext</span><a + id="dx1-26011"></a>) or provide an alternative via the optional argument to the sectioning/caption command. Examples: </p> - <div class="verbatim" id="verbatim-58"> + <div class="verbatim" id="verbatim-59"> \section{An overview of \glsentrytext{perl}}  <br />\section[An overview of Perl]{An overview of \gls{perl}} </div> -<!--l. 2031--><p class="nopar" > -</p><!--l. 2033--><p class="indent" > The way the link text<a - id="dx1-21007"></a> is displayed depends on -</p><!--l. 2034--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 2346--><p class="nopar" > +</p><!--l. 2348--><p class="indent" > The way the <a + id="dx1-26012"></a><a +href="#glo:linktext">link text<a + id="dx1-26013"></a></a> is displayed depends on +</p><!--l. 2349--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glstextformat</span><span class="ectt-0900"> </span></span><a - id="dx1-21008"></a> <span + id="dx1-26014"></a> <span class="ectt-1000">\glstextformat{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2036--><p class="noindent" > -For example, to make all link text<a - id="dx1-21009"></a> appear in a sans-serif font, do: +</p><!--l. 2351--><p class="noindent" > +For example, to make all <a + id="dx1-26015"></a><a +href="#glo:linktext">link text<a + id="dx1-26016"></a></a> appear in a sans-serif font, do: </p> - <div class="verbatim" id="verbatim-59"> + <div class="verbatim" id="verbatim-60"> \renewcommand*{\glstextformat}[1]{\textsf{#1}} </div> -<!--l. 2041--><p class="nopar" > -</p><!--l. 2043--><p class="indent" > Each entry has an associated conditional referred to as the first use flag<a - id="dx1-21010"></a>. This +<!--l. 2356--><p class="nopar" > +</p><!--l. 2358--><p class="indent" > Each entry has an associated conditional referred to as the <a + id="dx1-26017"></a><a +href="#glo:firstuseflag">first use flag</a>. This determines whether <span class="ectt-1000">\gls</span><a - id="dx1-21011"></a>, <span + id="dx1-26018"></a>, <span class="ectt-1000">\glspl</span><a - id="dx1-21012"></a> (and their uppercase variants) should use + id="dx1-26019"></a> (and their uppercase variants) should use the value of the <span class="ecss-1000">first</span><a - id="dx1-21013"></a> or <span + id="dx1-26020"></a> or <span class="ecss-1000">text</span><a - id="dx1-21014"></a> keys. Note that an entry can be used without -affecting the first use flag<a - id="dx1-21015"></a> (for example, when used with <span + id="dx1-26021"></a> keys. Note that an entry can be used without +affecting the <a + id="dx1-26022"></a><a +href="#glo:firstuseflag">first use flag</a> (for example, when used with <span class="ectt-1000">\glslink</span>). See <a -href="#x1-370002.11">2.11 +href="#x1-4400014">14 </a><a -href="#x1-370002.11">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for commands that unset or reset this +href="#x1-4400014">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for commands that unset or reset this conditional. -</p><!--l. 2051--><p class="indent" > The command: -</p><!--l. 2052--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2366--><p class="indent" > The command: +</p><!--l. 2367--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslink</span><span class="ectt-0900"> </span></span><a - id="dx1-21016"></a> <span + id="dx1-26023"></a> <span class="ectt-1000">\glslink[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4334,7 +5330,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2054--><p class="noindent" > +</p><!--l. 2369--><p class="noindent" > will place <span class="ectt-1000">\glstextformat{</span><span class="cmsy-10">⟨</span><span @@ -4349,10 +5345,11 @@ supported, <span class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩ </span>will be a hyperlink to the relevant line in the glossary. (Note that this -command doesn’t affect the first use flag<a - id="dx1-21017"></a>: use <span +command doesn’t affect the <a + id="dx1-26024"></a><a +href="#glo:firstuseflag">first use flag</a>: use <span class="ectt-1000">\glsdisp</span><a - id="dx1-21018"></a> instead.) The optional + id="dx1-26025"></a> instead.) The optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4364,25 +5361,30 @@ class="cmsy-10">⟨</span><span class="ecti-1000">value</span><span class="cmsy-10">⟩ </span>list which can take any of the following keys: -</p><!--l. 2064--><p class="indent" > +</p><!--l. 2379--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecsx-1000">format</span><a - id="dx1-21019"></a> </dt><dd + id="dx1-26026"></a> </dt><dd class="description">This specifies how to format the associated location number for this entry in - the glossary. This value is equivalent to the <span + the glossary. This value is equivalent to the <a + id="dx1-26027"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-21020"></a> encap value, + id="dx1-26028"></a></a> encap value, and (as with <span -class="ectt-1000">\index</span>) the value needs to be the name of a command +class="ectt-1000">\index</span><a + id="dx1-26029"></a>) the value needs to be the name of a command <span class="ecti-1000">without </span>the initial backslash. As with <span -class="ectt-1000">\index</span>, the characters <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\index</span><a + id="dx1-26030"></a>, the characters <span class="obeylines-h"><span class="verb"><span class="ectt-1000">(</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="ectt-1000">)</span></span></span> can also be used to specify the beginning and ending of a number range. Again as with <span -class="ectt-1000">\index</span>, the command should be the name of a command +class="ectt-1000">\index</span><a + id="dx1-26031"></a>, the command should be the name of a command which takes an argument (which will be the associated location). Be careful not to use a declaration (such as <span class="ectt-1000">bfseries</span>) instead of a text block @@ -4396,74 +5398,82 @@ class="ecti-1000">italic</span>) you will need to create a command that applies - <div class="verbatim" id="verbatim-60"> + <div class="verbatim" id="verbatim-61"> \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}} </div> - <!--l. 2081--><p class="nopar" > and use that command. - </p><!--l. 2084--><p class="noindent" >In this document, the standard formats refer to the standard text block + <!--l. 2396--><p class="nopar" > and use that command. + </p><!--l. 2399--><p class="noindent" >In this document, the standard formats refer to the standard text block commands such as <span class="ectt-1000">\textbf</span><a - id="dx1-21021"></a> or <span + id="dx1-26032"></a> or <span class="ectt-1000">\emph</span><a - id="dx1-21022"></a> or any of the commands listed in + id="dx1-26033"></a> or any of the commands listed in <a -href="#x1-210324">table 4</a>. - </p><!--l. 2088--><p class="noindent" ><div class="important" title="Important Note"> If you use <span +href="#x1-260474">table 4</a>. + </p><!--l. 2403--><p class="noindent" ><div class="important" title="Important Note"> If you use <a + id="dx1-26034"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-21023"></a> instead of <span + id="dx1-26035"></a></a> instead of <a + id="dx1-26036"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-21024"></a>, you must specify any non-standard formats + id="dx1-26037"></a></a>, you must specify any non-standard formats that you want to use with the <span class="ecss-1000">format</span><a - id="dx1-21025"></a> key using <span + id="dx1-26038"></a> key using <span class="ectt-1000">\GlsAddXdyAttribute</span><a - id="dx1-21026"></a><span + id="dx1-26039"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}</span>. - So if you use <span + So if you use <a + id="dx1-26040"></a><span class="ectt-1000">xindy</span><a - id="dx1-21027"></a> with the above example, you would need to add: + id="dx1-26041"></a> with the above example, you would need to add: </p> - <div class="verbatim" id="verbatim-61"> + <div class="verbatim" id="verbatim-62"> \GlsAddXdyAttribute{textbfem} </div> - <!--l. 2096--><p class="nopar" > </div> - </p><!--l. 2097--><p class="noindent" > - </p><!--l. 2099--><p class="noindent" >Note that unlike <span -class="ectt-1000">\index</span>, you can’t have anything following the command name, + <!--l. 2411--><p class="nopar" > See <a +href="#x1-3400011">11 </a><a +href="#x1-3400011">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details. </div> + </p><!--l. 2413--><p class="noindent" > + </p><!--l. 2415--><p class="noindent" >Note that unlike <span +class="ectt-1000">\index</span><a + id="dx1-26042"></a>, you can’t have anything following the command name, such as an asterisk or arguments. If you want to cross-reference another entry, either use the <span class="ecss-1000">see</span><a - id="dx1-21028"></a> key when you define the entry or use <span + id="dx1-26043"></a> key when you define the entry or use <span class="ectt-1000">\glssee</span><a - id="dx1-21029"></a> (described in <a -href="#x1-250002.6">2.6 + id="dx1-26044"></a> (described in <a +href="#x1-300008">8 </a><a -href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>). - </p><!--l. 2106--><p class="noindent" >If you are using hyperlinks and you want to change the font of the hyperlinked +href="#x1-300008">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>). + </p><!--l. 2422--><p class="noindent" >If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use <span class="ectt-1000">\hyperpage</span><a - id="dx1-21030"></a> (provided by the <span + id="dx1-26045"></a> (provided by the <span class="ecss-1000">hyperref</span><a - id="dx1-21031"></a> package) as the + id="dx1-26046"></a> package) as the locations may not refer to a page number. Instead, the <span class="ecss-1000">glossaries </span>package provides number formats listed in <a -href="#x1-210324">table 4</a>. +href="#x1-260474">table 4</a>. </p> <div class="table"> - <!--l. 2112--><p class="noindent" ><a - id="x1-210324"></a></p><hr class="float" /><div class="float" + <!--l. 2428--><p class="noindent" ><a + id="x1-260474"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 4: </span><span -class="content">Predefined Hyperlinked Location Formats</span></div><!--tex4ht:label?: x1-210324 --> +class="content">Predefined Hyperlinked Location Formats</span></div><!--tex4ht:label?: x1-260474 --> <div class="tabular"> <table id="TBL-5" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-5-1g"><col @@ -4472,68 +5482,68 @@ id="TBL-5-2" /></colgroup><tr style="vertical-align:baseline;" id="TBL-5-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-1" class="td11"><span class="ectt-1000">hyperrm</span><a - id="dx1-21033"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-2" + id="dx1-26048"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-2" class="td11">serif hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-1" class="td11"><span class="ectt-1000">hypersf</span><a - id="dx1-21034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2" + id="dx1-26049"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2" class="td11">sans-serif hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-1" class="td11"><span class="ectt-1000">hypertt</span><a - id="dx1-21035"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2" + id="dx1-26050"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2" class="td11">monospaced hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-1" class="td11"><span class="ectt-1000">hyperbf</span><a - id="dx1-21036"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2" + id="dx1-26051"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2" class="td11">bold hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-1" class="td11"><span class="ectt-1000">hypermd</span><a - id="dx1-21037"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2" + id="dx1-26052"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2" class="td11">medium weight hyperlink</td> </tr><tr style="vertical-align:baseline;" id="TBL-5-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-1" class="td11"><span class="ectt-1000">hyperit</span><a - id="dx1-21038"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2" + id="dx1-26053"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2" class="td11">italic hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-1" class="td11"><span class="ectt-1000">hypersl</span><a - id="dx1-21039"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2" + id="dx1-26054"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2" class="td11">slanted hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-1" class="td11"><span class="ectt-1000">hyperup</span><a - id="dx1-21040"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2" + id="dx1-26055"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2" class="td11">upright hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-1" class="td11"><span class="ectt-1000">hypersc</span><a - id="dx1-21041"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2" + id="dx1-26056"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2" class="td11">small caps hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-5-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-1" class="td11"><span class="ectt-1000">hyperemph</span><a - id="dx1-21042"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2" + id="dx1-26057"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2" class="td11">emphasized hyperlink </td></tr></table> </div> </div><hr class="endfloat" /> </div> - <!--l. 2132--><p class="noindent" >Note that if the <span + <!--l. 2448--><p class="noindent" >Note that if the <span class="ectt-1000">\hyperlink</span><a - id="dx1-21043"></a> command hasn’t been defined, the <span + id="dx1-26058"></a> command hasn’t been defined, the <span class="ectt-1000">hyper</span><span class="cmsy-10">⟨</span><span class="ecti-1000">xx</span><span @@ -4549,54 +5559,61 @@ class="ectt-1000">emph</span>). If you want to make a new format, you will need a command which takes one argument and use that. For example, if you want the location number to be in a bold sans-serif font, you can define a command called, say, <span -class="ectt-1000">\hyperbsf</span>: +class="ectt-1000">\hyperbsf</span><a + id="dx1-26059"></a>: </p> - <div class="verbatim" id="verbatim-62"> + <div class="verbatim" id="verbatim-63"> \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} </div> - <!--l. 2142--><p class="nopar" > and then use <span + <!--l. 2458--><p class="nopar" > and then use <span class="ectt-1000">hyperbsf </span>as the value for the <span class="ecss-1000">format</span><a - id="dx1-21044"></a> key. Remember that if you use - <span + id="dx1-26060"></a> key. (See also “Displaying + the glossary” in the documented code, <span +class="ectt-1000">glossaries.pdf</span>.) Remember + that if you use <a + id="dx1-26061"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-21045"></a>, you will need to add this to the list of location attributes: + id="dx1-26062"></a></a>, you will need to add this to the list of location + attributes: </p> - <div class="verbatim" id="verbatim-63"> + <div class="verbatim" id="verbatim-64"> \GlsAddXdyAttribute{hyperbsf} </div> - <!--l. 2149--><p class="nopar" > + <!--l. 2466--><p class="nopar" > </p></dd><dt class="description"> <span class="ecsx-1000">counter</span><a - id="dx1-21046"></a> </dt><dd + id="dx1-26063"></a> </dt><dd class="description">This specifies which counter to use for this location. This overrides the default counter used by this entry. (See also <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) </dd><dt class="description"> <span class="ecsx-1000">hyper</span><a - id="dx1-21047"></a> </dt><dd + id="dx1-26064"></a> </dt><dd class="description">This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting <span class="ectt-1000">hyper=true </span>will have no effect if <span -class="ectt-1000">\hyperlink </span>has not been defined.) The default value is +class="ectt-1000">\hyperlink</span><a + id="dx1-26065"></a> has not been defined.) The default value is <span class="ectt-1000">hyper=true</span>. </dd></dl> -<!--l. 2162--><p class="noindent" >There is also a starred version: -</p><!--l. 2163--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 2479--><p class="noindent" >There is also a starred version: +</p><!--l. 2480--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslink*</span><span class="ectt-0900"> </span></span><a - id="dx1-21048"></a> <span + id="dx1-26066"></a> <span class="ectt-1000">\glslink*[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4610,17 +5627,26 @@ class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2165--><p class="noindent" > +</p><!--l. 2482--><p class="noindent" > which is equivalent to <span class="ectt-1000">\glslink</span>, except it sets <span class="ectt-1000">hyper=false</span>. Similarly, all the following commands described in this section also have a starred version that disables the hyperlink. -</p><!--l. 2171--><p class="indent" > The command: -</p><!--l. 2172--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2488--><p class="indent" > <div class="important" title="Important Note"> Don’t use commands like <span +class="ectt-1000">\glslink </span>or <span +class="ectt-1000">\gls </span>in the <span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩ </span>argument of <span +class="ectt-1000">\glslink</span>. +</div> +</p><!--l. 2491--><p class="noindent" > +</p><!--l. 2493--><p class="indent" > The command: +</p><!--l. 2494--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\gls</span><span class="ectt-0900"> </span></span><a - id="dx1-21049"></a> <span + id="dx1-26067"></a> <span class="ectt-1000">\gls[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4634,32 +5660,35 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2174--><p class="noindent" > +</p><!--l. 2496--><p class="noindent" > is the same as <span -class="ectt-1000">\glslink</span>, except that the link text<a - id="dx1-21050"></a> is determined from the values of the +class="ectt-1000">\glslink</span>, except that the <a + id="dx1-26068"></a><a +href="#glo:linktext">link text<a + id="dx1-26069"></a></a> is determined from the values of the <span class="ecss-1000">text</span><a - id="dx1-21051"></a> and <span + id="dx1-26070"></a> and <span class="ecss-1000">first</span><a - id="dx1-21052"></a> keys supplied when the entry was defined using <span + id="dx1-26071"></a> keys supplied when the entry was defined using <span class="ectt-1000">\newglossaryentry</span><a - id="dx1-21053"></a>. If + id="dx1-26072"></a>. If the entry has been marked as having been used<a - id="dx1-21054"></a>, the value of the <span + id="dx1-26073"></a>, the value of the <span class="ecss-1000">text</span><a - id="dx1-21055"></a> key will be used, + id="dx1-26074"></a> key will be used, otherwise the value of the <span class="ecss-1000">first</span><a - id="dx1-21056"></a> key will be used. On completion, <span + id="dx1-26075"></a> key will be used. On completion, <span class="ectt-1000">\gls </span>will mark the -entry’s first use flag<a - id="dx1-21057"></a> as used. -</p><!--l. 2184--><p class="indent" > There are two uppercase variants: -</p><!--l. 2185--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +entry’s <a + id="dx1-26076"></a><a +href="#glo:firstuseflag">first use flag</a> as used. +</p><!--l. 2506--><p class="indent" > There are two uppercase variants: +</p><!--l. 2507--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Gls</span><span class="ectt-0900"> </span></span><a - id="dx1-21058"></a> <span + id="dx1-26077"></a> <span class="ectt-1000">\Gls[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4673,12 +5702,12 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2187--><p class="noindent" > +</p><!--l. 2509--><p class="noindent" > and -</p><!--l. 2189--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2511--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLS</span><span class="ectt-0900"> </span></span><a - id="dx1-21059"></a> <span + id="dx1-26078"></a> <span class="ectt-1000">\GLS[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4692,9 +5721,12 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2191--><p class="noindent" > +</p><!--l. 2513--><p class="noindent" > which make the first letter of the link text or all the link text uppercase, respectively. -</p><!--l. 2195--><p class="indent" > The final optional argument <span + + + +</p><!--l. 2517--><p class="indent" > The final optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span>, allows you to insert some additional @@ -4703,26 +5735,33 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>at the end of the link text, but this can be changed (see <a -href="#x1-220002.4.1">2.4.1 </a><a -href="#x1-220002.4.1">Changing the format of the link +href="#x1-270006.1">6.1 </a><a +href="#x1-270006.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). - - - -</p><!--l. 2201--><p class="indent" > The first optional argument <span +</p><!--l. 2522--><p class="indent" > The first optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span class="cmsy-10">⟩ </span>is the same as the optional argument to <span class="ectt-1000">\glslink</span><a - id="dx1-21060"></a>. As with <span -class="ectt-1000">\glslink</span>, these commands also have a starred version that disable + id="dx1-26079"></a>. As with <span +class="ectt-1000">\glslink</span><a + id="dx1-26080"></a>, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2205--><p class="indent" > There are also analogous plural forms: -</p><!--l. 2206--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2526--><p class="indent" > <div class="important" title="Important Note"> Don’t use commands like <span +class="ectt-1000">\glslink </span>or <span +class="ectt-1000">\gls </span>in the <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>argument of <span +class="ectt-1000">\gls </span>and +its variants. </div> +</p><!--l. 2529--><p class="noindent" > +</p><!--l. 2531--><p class="indent" > There are also analogous plural forms: +</p><!--l. 2532--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glspl</span><span class="ectt-0900"> </span></span><a - id="dx1-21061"></a> <span + id="dx1-26081"></a> <span class="ectt-1000">\glspl[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4736,11 +5775,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2208--><p class="noindent" > -</p><!--l. 2209--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2534--><p class="noindent" > +</p><!--l. 2535--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glspl</span><span class="ectt-0900"> </span></span><a - id="dx1-21062"></a> <span + id="dx1-26082"></a> <span class="ectt-1000">\Glspl[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4754,11 +5793,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2211--><p class="noindent" > -</p><!--l. 2212--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2537--><p class="noindent" > +</p><!--l. 2538--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSpl</span><span class="ectt-0900"> </span></span><a - id="dx1-21063"></a> <span + id="dx1-26083"></a> <span class="ectt-1000">\GLSpl[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4772,29 +5811,71 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2214--><p class="noindent" > +</p><!--l. 2540--><p class="noindent" > These determine the link text from the <span class="ecss-1000">plural</span><a - id="dx1-21064"></a> and <span + id="dx1-26084"></a> and <span class="ecss-1000">firstplural</span><a - id="dx1-21065"></a> keys supplied when the + id="dx1-26085"></a> keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2220--><p class="indent" > Note that <span -class="ectt-1000">\glslink </span>doesn’t use or affect the first use flag<a - id="dx1-21066"></a>, nor does it use +</p><!--l. 2546--><p class="indent" > <div class="important" title="Important Note"> Be careful when you use glossary entries in math mode especially if you are using +<span +class="ecss-1000">hyperref</span><a + id="dx1-26086"></a> as it can affect the spacing of subscripts and superscripts. For example, +suppose you have defined the following entry: + + + +</p> + <div class="verbatim" id="verbatim-65"> +\newglossaryentry{Falpha}{name={F_\alpha},description=sample} +</div> +<!--l. 2553--><p class="nopar" > and later you use it in math mode: + + + +</p> + <div class="verbatim" id="verbatim-66"> +$\gls{Falpha}^2$ +</div> +<!--l. 2557--><p class="nopar" > This will result in <span +class="cmmi-10">F</span><sub><span +class="cmmi-7">α</span></sub><sup><span +class="cmr-7">2</span></sup> instead of <span +class="cmmi-10">F</span><sub><span +class="cmmi-7">α</span></sub><sup><span +class="cmr-7">2</span></sup>. In this situation it’s best to bring the +superscript into the hyperlink using the final <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>optional argument: + + + +</p> + <div class="verbatim" id="verbatim-67"> +$\gls{Falpha}[^2]$ +</div> +<!--l. 2563--><p class="nopar" > </div> +</p><!--l. 2564--><p class="noindent" > +</p><!--l. 2566--><p class="indent" > Note that <span +class="ectt-1000">\glslink</span><a + id="dx1-26087"></a> doesn’t use or affect the <a + id="dx1-26088"></a><a +href="#glo:firstuseflag">first use flag</a>, nor does it use <span class="ectt-1000">\glsdisplay</span><a - id="dx1-21067"></a> or <span + id="dx1-26089"></a> or <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-21068"></a> (see <a -href="#x1-220002.4.1">2.4.1 </a><a -href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). + id="dx1-26090"></a> (see <a +href="#x1-270006.1">6.1 </a><a +href="#x1-270006.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). Instead, you can use: -</p><!--l. 2223--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2569--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsdisp</span><span class="ectt-0900"> </span></span><a - id="dx1-21069"></a> <span + id="dx1-26091"></a> <span class="ectt-1000">\glsdisp[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4808,32 +5889,34 @@ class="cmsy-10">⟨</span><span class="ecti-1000">link text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2225--><p class="noindent" > +</p><!--l. 2571--><p class="noindent" > This behaves in the same way as <span -class="ectt-1000">\gls</span>, except that it uses <span +class="ectt-1000">\gls</span><a + id="dx1-26092"></a>, except that it uses <span class="cmsy-10">⟨</span><span class="ecti-1000">link text</span><span class="cmsy-10">⟩ </span>instead of the value of the <span class="ecss-1000">first</span><a - id="dx1-21070"></a> or <span + id="dx1-26093"></a> or <span class="ecss-1000">text</span><a - id="dx1-21071"></a> key. (Note that this command always sets <span + id="dx1-26094"></a> key. (Note that this command always sets <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>to -nothing.) This command affects the first use flag<a - id="dx1-21072"></a>, and uses <span +nothing.) This command affects the <a + id="dx1-26095"></a><a +href="#glo:firstuseflag">first use flag</a>, and uses <span class="ectt-1000">\glsdisplay</span><a - id="dx1-21073"></a> or + id="dx1-26096"></a> or <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-21074"></a>. -</p><!--l. 2232--><p class="indent" > The command: -</p><!--l. 2233--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-26097"></a>. +</p><!--l. 2578--><p class="indent" > The command: +</p><!--l. 2579--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glstext</span><span class="ectt-0900"> </span></span><a - id="dx1-21075"></a> <span + id="dx1-26098"></a> <span class="ectt-1000">\glstext[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4847,14 +5930,15 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2235--><p class="noindent" > +</p><!--l. 2581--><p class="noindent" > is similar to <span class="ectt-1000">\gls</span><a - id="dx1-21076"></a> except that it always uses the value of the <span + id="dx1-26099"></a> except that it always uses the value of the <span class="ecss-1000">text</span><a - id="dx1-21077"></a> key and -does not affect the first use flag<a - id="dx1-21078"></a>. Unlike <span + id="dx1-26100"></a> key and +does not affect the <a + id="dx1-26101"></a><a +href="#glo:firstuseflag">first use flag</a>. Unlike <span class="ectt-1000">\gls</span>, the inserted text <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span @@ -4862,16 +5946,16 @@ class="cmsy-10">⟩ </span>is always appended to the link text since <span class="ectt-1000">\glstext </span>doesn’t use <span class="ectt-1000">\glsdisplay</span><a - id="dx1-21079"></a> or + id="dx1-26102"></a> or <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-21080"></a>. (The same is true for all the following commands described in this + id="dx1-26103"></a>. (The same is true for all the following commands described in this section.) -</p><!--l. 2244--><p class="indent" > There are also analogous commands: -</p><!--l. 2245--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2590--><p class="indent" > There are also analogous commands: +</p><!--l. 2591--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glstext</span><span class="ectt-0900"> </span></span><a - id="dx1-21081"></a> <span + id="dx1-26104"></a> <span class="ectt-1000">\Glstext[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4885,11 +5969,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2247--><p class="noindent" > -</p><!--l. 2248--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2593--><p class="noindent" > +</p><!--l. 2594--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLStext</span><span class="ectt-0900"> </span></span><a - id="dx1-21082"></a> <span + id="dx1-26105"></a> <span class="ectt-1000">\GLStext[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4903,13 +5987,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2250--><p class="noindent" > +</p><!--l. 2596--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2254--><p class="indent" > The command: -</p><!--l. 2255--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2600--><p class="indent" > The command: +</p><!--l. 2601--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-21083"></a> <span + id="dx1-26106"></a> <span class="ectt-1000">\glsfirst[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4923,26 +6007,23 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2257--><p class="noindent" > +</p><!--l. 2603--><p class="noindent" > is similar to <span -class="ectt-1000">\glstext</span><a - id="dx1-21084"></a> except that it always uses the value of the <span +class="ectt-1000">\glstext </span>except that it always uses the value of the <span class="ecss-1000">first</span><a - id="dx1-21085"></a> key. Again, + id="dx1-26107"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span -class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not affect the first use -flag<a - id="dx1-21086"></a>. -</p><!--l. 2263--><p class="indent" > There are also analogous commands: - - - -</p><!--l. 2264--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not affect the <a + id="dx1-26108"></a><a +href="#glo:firstuseflag">first use +flag</a>. +</p><!--l. 2609--><p class="indent" > There are also analogous commands: +</p><!--l. 2610--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-21087"></a> <span + id="dx1-26109"></a> <span class="ectt-1000">\Glsfirst[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4956,11 +6037,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2266--><p class="noindent" > -</p><!--l. 2267--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2612--><p class="noindent" > +</p><!--l. 2613--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-21088"></a> <span + id="dx1-26110"></a> <span class="ectt-1000">\GLSfirst[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4974,13 +6055,16 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2269--><p class="noindent" > +</p><!--l. 2615--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2273--><p class="indent" > The command: -</p><!--l. 2274--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + + + +</p><!--l. 2619--><p class="indent" > The command: +</p><!--l. 2620--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21089"></a> <span + id="dx1-26111"></a> <span class="ectt-1000">\glsplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -4994,22 +6078,22 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2276--><p class="noindent" > +</p><!--l. 2622--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21090"></a> except that it always uses the value of the <span + id="dx1-26112"></a> except that it always uses the value of the <span class="ecss-1000">plural</span><a - id="dx1-21091"></a> key. Again, + id="dx1-26113"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. -</p><!--l. 2282--><p class="indent" > There are also analogous commands: -</p><!--l. 2283--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2628--><p class="indent" > There are also analogous commands: +</p><!--l. 2629--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21092"></a> <span + id="dx1-26114"></a> <span class="ectt-1000">\Glsplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5023,11 +6107,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2285--><p class="noindent" > -</p><!--l. 2286--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2631--><p class="noindent" > +</p><!--l. 2632--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21093"></a> <span + id="dx1-26115"></a> <span class="ectt-1000">\GLSplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5041,13 +6125,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2288--><p class="noindent" > +</p><!--l. 2634--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2292--><p class="indent" > The command: -</p><!--l. 2293--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2638--><p class="indent" > The command: +</p><!--l. 2639--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsfirstplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21094"></a> <span + id="dx1-26116"></a> <span class="ectt-1000">\glsfirstplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5061,22 +6145,22 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2295--><p class="noindent" > +</p><!--l. 2641--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21095"></a> except that it always uses the value of the <span + id="dx1-26117"></a> except that it always uses the value of the <span class="ecss-1000">firstplural</span><a - id="dx1-21096"></a> key. Again, + id="dx1-26118"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. -</p><!--l. 2301--><p class="indent" > There are also analogous commands: -</p><!--l. 2302--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2647--><p class="indent" > There are also analogous commands: +</p><!--l. 2648--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsfirstplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21097"></a> <span + id="dx1-26119"></a> <span class="ectt-1000">\Glsfirstplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5090,11 +6174,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2304--><p class="noindent" > -</p><!--l. 2305--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2650--><p class="noindent" > +</p><!--l. 2651--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSfirstplural</span><span class="ectt-0900"> </span></span><a - id="dx1-21098"></a> <span + id="dx1-26120"></a> <span class="ectt-1000">\GLSfirstplural[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5108,13 +6192,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2307--><p class="noindent" > +</p><!--l. 2653--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2311--><p class="indent" > The command: -</p><!--l. 2312--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2657--><p class="indent" > The command: +</p><!--l. 2658--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsname</span><span class="ectt-0900"> </span></span><a - id="dx1-21099"></a> <span + id="dx1-26121"></a> <span class="ectt-1000">\glsname[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5128,29 +6212,31 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2314--><p class="noindent" > +</p><!--l. 2660--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21100"></a> except that it always uses the value of the <span + id="dx1-26122"></a> except that it always uses the value of the <span class="ecss-1000">name</span><a - id="dx1-21101"></a> key. Again, + id="dx1-26123"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the <span class="ecss-1000">name</span><a - id="dx1-21102"></a> key contains + id="dx1-26124"></a> key contains commands, you will have to disable the <a -href="#sanitize">sanitization</a> of the <span + id="dx1-26125"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-26126"></a></a> of the <span class="ecss-1000">name</span><a - id="dx1-21103"></a> key and protect fragile + id="dx1-26127"></a> key and protect fragile commands. -</p><!--l. 2323--><p class="indent" > There are also analogous commands: -</p><!--l. 2324--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2669--><p class="indent" > There are also analogous commands: +</p><!--l. 2670--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsname</span><span class="ectt-0900"> </span></span><a - id="dx1-21104"></a> <span + id="dx1-26128"></a> <span class="ectt-1000">\Glsname[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5164,11 +6250,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2326--><p class="noindent" > -</p><!--l. 2327--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2672--><p class="noindent" > +</p><!--l. 2673--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSname</span><span class="ectt-0900"> </span></span><a - id="dx1-21105"></a> <span + id="dx1-26129"></a> <span class="ectt-1000">\GLSname[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5182,16 +6268,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> - - - -</p><!--l. 2329--><p class="noindent" > +</p><!--l. 2675--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2333--><p class="indent" > The command: -</p><!--l. 2334--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2679--><p class="indent" > The command: +</p><!--l. 2680--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glssymbol</span><span class="ectt-0900"> </span></span><a - id="dx1-21106"></a> <span + id="dx1-26130"></a> <span class="ectt-1000">\glssymbol[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5205,29 +6288,34 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2336--><p class="noindent" > +</p><!--l. 2682--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21107"></a> except that it always uses the value of the <span + id="dx1-26131"></a> except that it always uses the value of the <span class="ecss-1000">symbol</span><a - id="dx1-21108"></a> key. Again, + id="dx1-26132"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as + + + having been used. Note: if you want to use this command and the <span class="ecss-1000">symbol</span><a - id="dx1-21109"></a> key contains + id="dx1-26133"></a> key contains commands, you will have to disable the <a -href="#sanitize">sanitization</a> of the <span + id="dx1-26134"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-26135"></a></a> of the <span class="ecss-1000">symbol</span><a - id="dx1-21110"></a> key and protect + id="dx1-26136"></a> key and protect fragile commands. -</p><!--l. 2345--><p class="indent" > There are also analogous commands: -</p><!--l. 2346--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2691--><p class="indent" > There are also analogous commands: +</p><!--l. 2692--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glssymbol</span><span class="ectt-0900"> </span></span><a - id="dx1-21111"></a> <span + id="dx1-26137"></a> <span class="ectt-1000">\Glssymbol[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5241,11 +6329,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2348--><p class="noindent" > -</p><!--l. 2349--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2694--><p class="noindent" > +</p><!--l. 2695--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSsymbol</span><span class="ectt-0900"> </span></span><a - id="dx1-21112"></a> <span + id="dx1-26138"></a> <span class="ectt-1000">\GLSsymbol[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5259,13 +6347,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2351--><p class="noindent" > +</p><!--l. 2697--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2355--><p class="indent" > The command: -</p><!--l. 2356--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2701--><p class="indent" > The command: +</p><!--l. 2702--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsdesc</span><span class="ectt-0900"> </span></span><a - id="dx1-21113"></a> <span + id="dx1-26139"></a> <span class="ectt-1000">\glsdesc[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5279,29 +6367,31 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2358--><p class="noindent" > +</p><!--l. 2704--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21114"></a> except that it always uses the value of the <span + id="dx1-26140"></a> except that it always uses the value of the <span class="ecss-1000">description</span><a - id="dx1-21115"></a> key. Again, + id="dx1-26141"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the <span class="ecss-1000">description</span><a - id="dx1-21116"></a> key + id="dx1-26142"></a> key contains commands, you will have to disable the <a -href="#sanitize">sanitization</a> of the <span + id="dx1-26143"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-26144"></a></a> of the <span class="ecss-1000">description</span><a - id="dx1-21117"></a> key and + id="dx1-26145"></a> key and protect fragile commands. -</p><!--l. 2367--><p class="indent" > There are also analogous commands: -</p><!--l. 2368--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2713--><p class="indent" > There are also analogous commands: +</p><!--l. 2714--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsdesc</span><span class="ectt-0900"> </span></span><a - id="dx1-21118"></a> <span + id="dx1-26146"></a> <span class="ectt-1000">\Glsdesc[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5315,11 +6405,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2370--><p class="noindent" > -</p><!--l. 2371--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2716--><p class="noindent" > +</p><!--l. 2717--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSdesc</span><span class="ectt-0900"> </span></span><a - id="dx1-21119"></a> <span + id="dx1-26147"></a> <span class="ectt-1000">\GLSdesc[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5333,13 +6423,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2373--><p class="noindent" > +</p><!--l. 2719--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. -</p><!--l. 2377--><p class="indent" > The command: -</p><!--l. 2378--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2723--><p class="indent" > The command: +</p><!--l. 2724--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuseri</span><span class="ectt-0900"> </span></span><a - id="dx1-21120"></a> <span + id="dx1-26148"></a> <span class="ectt-1000">\glsuseri[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5353,22 +6443,22 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2380--><p class="noindent" > +</p><!--l. 2726--><p class="noindent" > is similar to <span class="ectt-1000">\glstext</span><a - id="dx1-21121"></a> except that it always uses the value of the <span + id="dx1-26149"></a> except that it always uses the value of the <span class="ecss-1000">user1</span><a - id="dx1-21122"></a> key. Again, + id="dx1-26150"></a> key. Again, <span class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. -</p><!--l. 2386--><p class="indent" > There are also analogous commands: -</p><!--l. 2387--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2732--><p class="indent" > There are also analogous commands: +</p><!--l. 2733--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuseri</span><span class="ectt-0900"> </span></span><a - id="dx1-21123"></a> <span + id="dx1-26151"></a> <span class="ectt-1000">\Glsuseri[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5382,11 +6472,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2389--><p class="noindent" > -</p><!--l. 2390--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2735--><p class="noindent" > +</p><!--l. 2736--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuseri</span><span class="ectt-0900"> </span></span><a - id="dx1-21124"></a> <span + id="dx1-26152"></a> <span class="ectt-1000">\GLSuseri[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5400,16 +6490,13 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2392--><p class="noindent" > +</p><!--l. 2738--><p class="noindent" > As before, these commands also have a starred version that disable the hyperlink. Similarly for the other user keys: - - - -</p><!--l. 2395--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2741--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuserii</span><span class="ectt-0900"> </span></span><a - id="dx1-21125"></a> <span + id="dx1-26153"></a> <span class="ectt-1000">\glsuserii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5423,11 +6510,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2397--><p class="noindent" > -</p><!--l. 2398--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2743--><p class="noindent" > +</p><!--l. 2744--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuserii</span><span class="ectt-0900"> </span></span><a - id="dx1-21126"></a> <span + id="dx1-26154"></a> <span class="ectt-1000">\Glsuserii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5441,11 +6528,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2400--><p class="noindent" > -</p><!--l. 2401--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2746--><p class="noindent" > +</p><!--l. 2747--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuserii</span><span class="ectt-0900"> </span></span><a - id="dx1-21127"></a> <span + id="dx1-26155"></a> <span class="ectt-1000">\GLSuserii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5459,11 +6546,14 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2403--><p class="noindent" > -</p><!--l. 2404--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + + + +</p><!--l. 2749--><p class="noindent" > +</p><!--l. 2750--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuseriii</span><span class="ectt-0900"> </span></span><a - id="dx1-21128"></a> <span + id="dx1-26156"></a> <span class="ectt-1000">\glsuseriii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5477,11 +6567,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2406--><p class="noindent" > -</p><!--l. 2407--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2752--><p class="noindent" > +</p><!--l. 2753--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuseriii</span><span class="ectt-0900"> </span></span><a - id="dx1-21129"></a> <span + id="dx1-26157"></a> <span class="ectt-1000">\Glsuseriii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5495,11 +6585,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2409--><p class="noindent" > -</p><!--l. 2410--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2755--><p class="noindent" > +</p><!--l. 2756--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuseriii</span><span class="ectt-0900"> </span></span><a - id="dx1-21130"></a> <span + id="dx1-26158"></a> <span class="ectt-1000">\GLSuseriii[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5513,11 +6603,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2412--><p class="noindent" > -</p><!--l. 2413--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2758--><p class="noindent" > +</p><!--l. 2759--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuseriv</span><span class="ectt-0900"> </span></span><a - id="dx1-21131"></a> <span + id="dx1-26159"></a> <span class="ectt-1000">\glsuseriv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5531,11 +6621,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2415--><p class="noindent" > -</p><!--l. 2416--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2761--><p class="noindent" > +</p><!--l. 2762--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuseriv</span><span class="ectt-0900"> </span></span><a - id="dx1-21132"></a> <span + id="dx1-26160"></a> <span class="ectt-1000">\Glsuseriv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5549,11 +6639,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2418--><p class="noindent" > -</p><!--l. 2419--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2764--><p class="noindent" > +</p><!--l. 2765--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuseriv</span><span class="ectt-0900"> </span></span><a - id="dx1-21133"></a> <span + id="dx1-26161"></a> <span class="ectt-1000">\GLSuseriv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5567,11 +6657,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2421--><p class="noindent" > -</p><!--l. 2422--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2767--><p class="noindent" > +</p><!--l. 2768--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuserv</span><span class="ectt-0900"> </span></span><a - id="dx1-21134"></a> <span + id="dx1-26162"></a> <span class="ectt-1000">\glsuserv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5585,11 +6675,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2424--><p class="noindent" > -</p><!--l. 2425--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2770--><p class="noindent" > +</p><!--l. 2771--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuserv</span><span class="ectt-0900"> </span></span><a - id="dx1-21135"></a> <span + id="dx1-26163"></a> <span class="ectt-1000">\Glsuserv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5603,11 +6693,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2427--><p class="noindent" > -</p><!--l. 2428--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2773--><p class="noindent" > +</p><!--l. 2774--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuserv</span><span class="ectt-0900"> </span></span><a - id="dx1-21136"></a> <span + id="dx1-26164"></a> <span class="ectt-1000">\GLSuserv[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5621,11 +6711,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2430--><p class="noindent" > -</p><!--l. 2431--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2776--><p class="noindent" > +</p><!--l. 2777--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsuservi</span><span class="ectt-0900"> </span></span><a - id="dx1-21137"></a> <span + id="dx1-26165"></a> <span class="ectt-1000">\glsuservi[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5639,11 +6729,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2433--><p class="noindent" > -</p><!--l. 2434--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2779--><p class="noindent" > +</p><!--l. 2780--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsuservi</span><span class="ectt-0900"> </span></span><a - id="dx1-21138"></a> <span + id="dx1-26166"></a> <span class="ectt-1000">\Glsuservi[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5657,11 +6747,11 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2436--><p class="noindent" > -</p><!--l. 2437--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2782--><p class="noindent" > +</p><!--l. 2783--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GLSuservi</span><span class="ectt-0900"> </span></span><a - id="dx1-21139"></a> <span + id="dx1-26167"></a> <span class="ectt-1000">\GLSuservi[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -5675,26 +6765,28 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2439--><p class="noindent" > - - - -</p><!--l. 2443--><p class="noindent" > +</p><!--l. 2785--><p class="noindent" > +</p><!--l. 2787--><p class="noindent" > </p> -<!--l. 2443--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.4.1 </span> <a - id="x1-220002.4.1"></a>Changing the format of the link text</h5> -<!--l. 2446--><p class="noindent" >The format of the link text<a - id="dx1-22001"></a> for <span +<!--l. 2787--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a + id="x1-270006.1"></a>Changing the format of the link text</h4> +<!--l. 2790--><p class="noindent" >The format of the <a + id="dx1-27001"></a><a +href="#glo:linktext">link text<a + id="dx1-27002"></a></a> for <span class="ectt-1000">\gls</span><a - id="dx1-22002"></a>, <span + id="dx1-27003"></a>, <span class="ectt-1000">\glspl</span><a - id="dx1-22003"></a> and their uppercase variants is governed + id="dx1-27004"></a> and their uppercase variants is governed by two commands: -</p><!--l. 2448--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + + + +</p><!--l. 2792--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsdisplayfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-22004"></a> <span + id="dx1-27005"></a> <span class="ectt-1000">\glsdisplayfirst{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">first/first plural</span><span @@ -5713,13 +6805,14 @@ class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}</span> </div><hr> -</p><!--l. 2450--><p class="noindent" > -which is used the first time a glossary entry is used<a - id="dx1-22005"></a> in the text and -</p><!--l. 2453--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2794--><p class="noindent" > +which is used the <a + id="dx1-27006"></a><a +href="#glo:firstuse">first time</a> a glossary entry is used in the text and +</p><!--l. 2797--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsdisplay</span><span class="ectt-0900"> </span></span><a - id="dx1-22006"></a> <span + id="dx1-27007"></a> <span class="ectt-1000">\glsdisplay{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">text/plural</span><span @@ -5738,123 +6831,154 @@ class="ecti-1000">insert</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}</span> </div><hr> -</p><!--l. 2455--><p class="noindent" > +</p><!--l. 2799--><p class="noindent" > which is used subsequently. Both commands take four arguments: the first is either the singular or plural form given by the <span class="ecss-1000">text</span><a - id="dx1-22007"></a>, <span + id="dx1-27008"></a>, <span class="ecss-1000">plural</span><a - id="dx1-22008"></a>, <span + id="dx1-27009"></a>, <span class="ecss-1000">first</span><a - id="dx1-22009"></a> or <span + id="dx1-27010"></a> or <span class="ecss-1000">firstplural</span><a - id="dx1-22010"></a> keys (set when the + id="dx1-27011"></a> keys (set when the term was defined) depending on context; the second argument is the term’s description (as supplied by the <span class="ecss-1000">description</span><a - id="dx1-22011"></a> or <span + id="dx1-27012"></a> or <span class="ecss-1000">descriptionplural</span><a - id="dx1-22012"></a> keys); the third + id="dx1-27013"></a> keys); the third argument is the symbol associated with the term (as supplied by the <span class="ecss-1000">symbol</span><a - id="dx1-22013"></a> or + id="dx1-27014"></a> or <span class="ecss-1000">symbolplural</span><a - id="dx1-22014"></a> keys) and the fourth argument is the additional text supplied in the final + id="dx1-27015"></a> keys) and the fourth argument is the additional text supplied in the final optional argument to <span -class="ectt-1000">\gls </span>or <span -class="ectt-1000">\glspl </span>(or their uppercase variants). The default +class="ectt-1000">\gls</span><a + id="dx1-27016"></a> or <span +class="ectt-1000">\glspl</span><a + id="dx1-27017"></a> (or their uppercase variants). The default definitions of <span class="ectt-1000">\glsdisplay </span>and <span class="ectt-1000">\glsdisplayfirst </span>simply print the first argument immediately followed by the fourth argument. The remaining arguments are ignored. -</p><!--l. 2471--><p class="indent" > If required, you can access the label for the given entry via -</p><!--l. 2472--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2815--><p class="indent" > <div class="important" title="Important Note"> Care needs to be taken when redefining <span +class="ectt-1000">\glsdisplay </span>and <span +class="ectt-1000">\glsdisplayfirst </span>as +commands like <span +class="ectt-1000">\Gls</span><a + id="dx1-27018"></a> will expand the displayed text before applying <span +class="ectt-1000">\makefirstuc</span><a + id="dx1-27019"></a>. If +you want to use formatting commands, it’s best to define a robust version that deals +with all the formatting. For example, suppose you want the text to appear in bold +italic, it’s best to do something like: + + + +</p> + <div class="verbatim" id="verbatim-68"> +\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries #1}} + <br />\renewcommand{\glsdisplay}[4]{\textbfit{#1#4}} +</div> +<!--l. 2825--><p class="nopar" > See the <span +class="ecss-1000">mfirstuc</span><a + id="dx1-27020"></a> documentation for further details on the limitations of <span +class="ectt-1000">\makefirstuc</span><a + id="dx1-27021"></a>. +</div> +</p><!--l. 2828--><p class="noindent" > +</p><!--l. 2830--><p class="indent" > If required, you can access the label for the given entry via +</p><!--l. 2831--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslabel</span><span class="ectt-0900"> </span></span><a - id="dx1-22015"></a> <span + id="dx1-27022"></a> <span class="ectt-1000">\glslabel </span></div><hr> -</p><!--l. 2474--><p class="noindent" > +</p><!--l. 2833--><p class="noindent" > so it is possible to use this label in the definition of <span class="ectt-1000">\glsdisplay </span>or <span class="ectt-1000">\glsdisplayfirst</span> to supply additional information using any of the commands described in <a -href="#x1-260002.7">2.7 </a><a -href="#x1-260002.7">Using +href="#x1-320009">9 </a><a +href="#x1-320009">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>, if required. -</p><!--l. 2480--><p class="indent" > Note that <span +</p><!--l. 2839--><p class="indent" > Note that <span class="ectt-1000">\glsdisplay </span>and <span class="ectt-1000">\glsdisplayfirst </span>are not used by <span class="ectt-1000">\glslink</span><a - id="dx1-22016"></a>. If you + id="dx1-27023"></a>. If you want to supply your own link text, you need to use <span class="ectt-1000">\glsdisp</span><a - id="dx1-22017"></a> instead. -</p><!--l. 2484--><p class="indent" > For example, suppose you want a glossary of measurements and units, you can use + id="dx1-27024"></a> instead. +</p><!--l. 2843--><p class="indent" > For example, suppose you want a glossary of measurements and units, you can use the <span class="ecss-1000">symbol</span><a - id="dx1-22018"></a> key to store the unit: + id="dx1-27025"></a> key to store the unit: </p> - <div class="verbatim" id="verbatim-64"> + <div class="verbatim" id="verbatim-69"> \newglossaryentry{distance}{name=distance,  <br />description={The length between two points},  <br />symbol={km}} </div> -<!--l. 2490--><p class="nopar" > and now suppose you want <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\gls{distance}</span></span></span> to produce “distance (km)” on first use<a - id="dx1-22019"></a>, +<!--l. 2849--><p class="nopar" > and now suppose you want <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{distance}</span></span></span> to produce “distance (km)” on <a + id="dx1-27026"></a><a +href="#glo:firstuse">first use</a>, then you can redefine <span class="ectt-1000">\glsdisplayfirst </span>as follows: </p> - <div class="verbatim" id="verbatim-65"> + <div class="verbatim" id="verbatim-70"> \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} </div> -<!--l. 2496--><p class="nopar" > Note that the additional text is placed after <span class="obeylines-h"><span class="verb"><span +<!--l. 2855--><p class="nopar" > Note that the additional text is placed after <span class="obeylines-h"><span class="verb"><span class="ectt-1000">#1</span></span></span>, so <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\gls{distance}[’s]</span></span></span> will produce “distance’s (km)” rather than “distance (km)’s” which looks a bit odd (even though it may be in the context of “the distance (km) is measured between the two points” — but in this instance it would be better not to use a contraction). -</p><!--l. 2504--><p class="indent" > Note also that all of the link text<a - id="dx1-22020"></a> will be formatted according to <span +</p><!--l. 2863--><p class="indent" > Note also that all of the <a + id="dx1-27027"></a><a +href="#glo:linktext">link text<a + id="dx1-27028"></a></a> will be formatted according to <span class="ectt-1000">\glstextformat</span><a - id="dx1-22021"></a> + id="dx1-27029"></a> (described earlier). So if you do, say: </p> - <div class="verbatim" id="verbatim-66"> + <div class="verbatim" id="verbatim-71"> \renewcommand{\glstextformat}[1]{\textbf{#1}}  <br />\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} </div> -<!--l. 2509--><p class="nopar" > then <span class="obeylines-h"><span class="verb"><span +<!--l. 2868--><p class="nopar" > then <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\gls{distance}</span></span></span> will produce “<span class="ecbx-1000">distance (km)</span>”. -</p><!--l. 2512--><p class="indent" > If you have multiple glossaries, changing <span +</p><!--l. 2871--><p class="indent" > If you have multiple glossaries, changing <span class="ectt-1000">\glsdisplayfirst </span>and <span class="ectt-1000">\glsdisplay </span>will change the way entries for all of the glossaries appear when using the commands <span class="ectt-1000">\gls</span><a - id="dx1-22022"></a>, + id="dx1-27030"></a>, <span class="ectt-1000">\glspl</span><a - id="dx1-22023"></a>, their uppercase variants and <span + id="dx1-27031"></a>, their uppercase variants and <span class="ectt-1000">\glsdisp</span><a - id="dx1-22024"></a>. If you only want the change to affect + id="dx1-27032"></a>. If you only want the change to affect entries for a given glossary, then you need to use -</p><!--l. 2518--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2877--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\defglsdisplay</span><span class="ectt-0900"> </span></span><a - id="dx1-22025"></a> <span + id="dx1-27033"></a> <span class="ectt-1000">\defglsdisplay[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span @@ -5864,12 +6988,12 @@ class="cmsy-10">⟨</span><span class="ecti-1000">definition</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2520--><p class="noindent" > +</p><!--l. 2879--><p class="noindent" > and -</p><!--l. 2522--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2881--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\defglsdisplayfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-22026"></a> <span + id="dx1-27034"></a> <span class="ectt-1000">\defglsdisplayfirst[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span @@ -5879,17 +7003,17 @@ class="cmsy-10">⟨</span><span class="ecti-1000">definition</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2524--><p class="noindent" > +</p><!--l. 2883--><p class="noindent" > instead of redefining <span class="ectt-1000">\glsdisplay </span>and <span class="ectt-1000">\glsdisplayfirst</span>. -</p><!--l. 2527--><p class="indent" > Both <span +</p><!--l. 2886--><p class="indent" > Both <span class="ectt-1000">\defglsdisplay </span>and <span class="ectt-1000">\defglsdisplayfirst </span>take two arguments: the first (which is optional) is the glossary’s label<span class="footnote-mark"><a -href="#fn6x0" id="fn6x0-bk"><sup class="textsuperscript">6</sup></a></span><a - id="x1-22027f6"></a> +href="#fn8x0" id="fn8x0-bk"><sup class="textsuperscript">8</sup></a></span><a + id="x1-27035f8"></a> and the second is how the term should be displayed when it is invoked using commands <span class="ectt-1000">\gls</span>, <span @@ -5897,112 +7021,122 @@ class="ectt-1000">\glspl</span>, their uppercase variants and <span class="ectt-1000">\glsdisp</span>. This is similar to the way <span class="ectt-1000">\glsdisplayfirst </span>was redefined above. -</p><!--l. 2536--><p class="indent" > For example, suppose you have created a new glossary called <span +</p><!--l. 2895--><p class="indent" > For example, suppose you have created a new glossary called <span class="ectt-1000">notation </span>and you -want to change the way the entry is displayed on first use<a - id="dx1-22028"></a> so that it includes the +want to change the way the entry is displayed on <a + id="dx1-27036"></a><a +href="#glo:firstuse">first use</a> so that it includes the symbol, you can do: </p> - <div class="verbatim" id="verbatim-67"> + <div class="verbatim" id="verbatim-72"> \defglsdisplayfirst[notation]{#1#4 (denoted #3)} </div> -<!--l. 2541--><p class="nopar" > Now suppose you have defined an entry as follows: +<!--l. 2900--><p class="nopar" > Now suppose you have defined an entry as follows: </p> - <div class="verbatim" id="verbatim-68"> + <div class="verbatim" id="verbatim-73"> \newglossaryentry{set}{type=notation,  <br />  name=set,  <br />  description={A collection of objects},  <br />  symbol={$S$}  <br />} </div> -<!--l. 2549--><p class="nopar" > The first time you reference this entry it will be displayed as: “set (denoted <span +<!--l. 2908--><p class="nopar" > The <a + id="dx1-27037"></a><a +href="#glo:firstuse">first time</a> you reference this entry it will be displayed as: “set (denoted <span class="cmmi-10">S</span>)” (assuming <span class="ectt-1000">\gls</span><a - id="dx1-22029"></a> was used). -</p><!--l. 2553--><p class="indent" > Remember that if you use the <span + id="dx1-27038"></a> was used). +</p><!--l. 2912--><p class="indent" > Remember that if you use the <span class="ecss-1000">symbol</span><a - id="dx1-22030"></a> key, you need to use a glossary style that + id="dx1-27039"></a> key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. In addition, if you want either the -description or symbol to appear in the link text<a - id="dx1-22031"></a>, you will have to disable the +description or symbol to appear in the <a + id="dx1-27040"></a><a +href="#glo:linktext">link text<a + id="dx1-27041"></a></a>, you will have to disable the <a -href="#sanitize">sanitization</a> of these keys and protect fragile commands. -</p><!--l. 2560--><p class="noindent" > + id="dx1-27042"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-27043"></a></a> of these keys and protect fragile commands. +</p><!--l. 2919--><p class="noindent" > </p> -<!--l. 2560--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.4.2 </span> <a - id="x1-230002.4.2"></a>Enabling and disabling hyperlinks to glossary entries</h5> -<!--l. 2562--><p class="noindent" >If you load the <span +<!--l. 2919--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a + id="x1-280006.2"></a>Enabling and disabling hyperlinks to glossary entries</h4> +<!--l. 2921--><p class="noindent" >If you load the <span class="ecss-1000">hyperref</span><a - id="dx1-23001"></a> or <span + id="dx1-28001"></a> or <span class="ecss-1000">html</span><a - id="dx1-23002"></a> packages prior to loading the <span + id="dx1-28002"></a> packages prior to loading the <span class="ecss-1000">glossaries </span>package, commands such as <span class="ectt-1000">\glslink</span><a - id="dx1-23003"></a> and <span + id="dx1-28003"></a> and <span class="ectt-1000">\gls</span><a - id="dx1-23004"></a>, described above, will automatically have + id="dx1-28004"></a>, described above, will automatically have hyperlinks to the relevant glossary entry, unless the <span class="ecss-1000">hyper</span><a - id="dx1-23005"></a> option has been set to <span + id="dx1-28005"></a> option has been set to <span class="ectt-1000">false</span>. You can disable or enable links using: -</p><!--l. 2567--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2926--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsdisablehyper</span><span class="ectt-0900"> </span></span><a - id="dx1-23006"></a> <span + id="dx1-28006"></a> <span class="ectt-1000">\glsdisablehyper </span></div><hr> -</p><!--l. 2569--><p class="noindent" > +</p><!--l. 2928--><p class="noindent" > and -</p><!--l. 2571--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2930--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsenablehyper</span><span class="ectt-0900"> </span></span><a - id="dx1-23007"></a> <span + id="dx1-28007"></a> <span class="ectt-1000">\glsenablehyper </span></div><hr> -</p><!--l. 2573--><p class="noindent" > +</p><!--l. 2932--><p class="noindent" > respectively. The effect can be localised by placing the commands within a group. Note that you should only use <span class="ectt-1000">\glsenablehyper </span>if the commands <span class="ectt-1000">\hyperlink</span><a - id="dx1-23008"></a> and + id="dx1-28008"></a> and <span class="ectt-1000">\hypertarget</span><a - id="dx1-23009"></a> have been defined (for example, by the <span + id="dx1-28009"></a> have been defined (for example, by the <span class="ecss-1000">hyperref</span><a - id="dx1-23010"></a> package). -</p><!--l. 2579--><p class="indent" > You can disable just the first use links using the package option <span + id="dx1-28010"></a> package). +</p><!--l. 2938--><p class="indent" > You can disable just the <a + id="dx1-28011"></a><a +href="#glo:firstuse">first use</a> links using the package option <span class="ecss-1000">hyperfirst=false</span><a - id="dx1-23011"></a>. -Note that this option only affects commands that recognise the first use<a - id="dx1-23012"></a> flag, for + id="dx1-28012"></a>. +Note that this option only affects commands that recognise the <a + id="dx1-28013"></a><a +href="#glo:firstuseflag">first use flag</a>, for example <span class="ectt-1000">\gls</span><a - id="dx1-23013"></a>, <span + id="dx1-28014"></a>, <span class="ectt-1000">\glspl</span><a - id="dx1-23014"></a> and <span + id="dx1-28015"></a> and <span class="ectt-1000">\glsdisp</span><a - id="dx1-23015"></a> but not <span + id="dx1-28016"></a> but not <span class="ectt-1000">\glslink</span><a - id="dx1-23016"></a>. -</p><!--l. 2585--><p class="noindent" > + id="dx1-28017"></a>. +</p><!--l. 2944--><p class="noindent" > </p> -<!--l. 2585--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.5 </span> <a - id="x1-240002.5"></a>Adding an Entry to the Glossary Without Generating Text</h4> -<!--l. 2588--><p class="noindent" >It is possible to add a line in the glossary file without generating any text at that point +<!--l. 2944--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="x1-290007"></a>Adding an Entry to the Glossary Without Generating Text</h3> +<!--l. 2947--><p class="noindent" >It is possible to add a line in the glossary file without generating any text at that point in the document using: -</p><!--l. 2590--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 2949--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsadd</span><span class="ectt-0900"> </span></span><a - id="dx1-24001"></a> <span + id="dx1-29001"></a> <span class="ectt-1000">\glsadd[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -6015,18 +7149,19 @@ class="ectt-1000">} </span></div><hr> -</p><!--l. 2592--><p class="noindent" > +</p><!--l. 2951--><p class="noindent" > This is similar to <span class="ectt-1000">\glslink</span><a - id="dx1-24002"></a>, only it doesn’t produce any text (so therefore, + id="dx1-29002"></a>, only it doesn’t produce any text (so therefore, there is no <span class="ecss-1000">hyper</span><a - id="dx1-24003"></a> key available in <span + id="dx1-29003"></a> key available in <span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span class="cmsy-10">⟩ </span>but all the other options that can be used with <span -class="ectt-1000">\glslink </span>can be passed to <span +class="ectt-1000">\glslink</span><a + id="dx1-29004"></a> can be passed to <span class="ectt-1000">\glsadd</span>). For example, to add a page range to the glossary number list for the entry whose label is given by <span @@ -6035,31 +7170,32 @@ class="ectt-1000">set</span>: </p> - <div class="verbatim" id="verbatim-69"> + <div class="verbatim" id="verbatim-74"> \glsadd[format=(]{set}  <br />Lots of text about sets spanning many pages.  <br />\glsadd[format=)]{set} </div> -<!--l. 2603--><p class="nopar" > -</p><!--l. 2605--><p class="indent" > To add all entries that have been defined, use: -</p><!--l. 2606--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 2962--><p class="nopar" > +</p><!--l. 2964--><p class="indent" > To add all entries that have been defined, use: +</p><!--l. 2965--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsaddall</span><span class="ectt-0900"> </span></span><a - id="dx1-24004"></a> <span + id="dx1-29005"></a> <span class="ectt-1000">\glsaddall[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2608--><p class="noindent" > +</p><!--l. 2967--><p class="noindent" > The optional argument is the same as for <span class="ectt-1000">\glsadd</span>, except there is also a key <span class="ecss-1000">types</span><a - id="dx1-24005"></a> which can be used to specify which glossaries to use. This should be a + id="dx1-29006"></a> which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type <span -class="ectt-1000">\acronymtype</span>) +class="ectt-1000">\acronymtype</span><a + id="dx1-29007"></a>) and a list of notation (specified by the glossary type <span class="ectt-1000">notation</span>) then you can do: @@ -6067,91 +7203,200 @@ do: </p> - <div class="verbatim" id="verbatim-70"> + <div class="verbatim" id="verbatim-75"> \glsaddall[types={\acronymtype,notation}] </div> -<!--l. 2619--><p class="nopar" > -</p><!--l. 2622--><p class="noindent" > +<!--l. 2978--><p class="nopar" > +</p><!--l. 2980--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\glsadd </span>and <span +class="ectt-1000">\glsaddall </span>add the current location to the number list. In +the case of <span +class="ectt-1000">\glsaddall</span>, all entries in the glossary will have the same location +in the number list. If you want to use <span +class="ectt-1000">\glsaddall</span>, it’s best to suppress the +number list with the <span +class="ecss-1000">nonumberlist</span><a + id="dx1-29008"></a> package option. (See sections <a +href="#x1-150002.3">2.3<!--tex4ht:ref: sec:pkgopts-printglos --></a> and <a +href="#x1-250005">5<!--tex4ht:ref: sec:numberlists --></a>.) +</div> +</p><!--l. 2987--><p class="noindent" > +</p><!--l. 2989--><p class="indent" > The sample file <a +href="#x1-40001.1"><span +class="ectt-1000">sample-dual.tex</span></a> makes use of <span +class="ectt-1000">\glsadd </span>to allow for an entry that +should appear both in the main glossary and in the list of acronyms. This example sets +up the list of acronyms using the <span +class="ecss-1000">acronym</span><a + id="dx1-29009"></a> package option: + + + </p> -<!--l. 2622--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.6 </span> <a - id="x1-250002.6"></a>Cross-Referencing Entries</h4> -<!--l. 2625--><p class="noindent" >There are several ways of cross-referencing entries in the glossary: -</p><!--l. 2628--><p class="indent" > + <div class="verbatim" id="verbatim-76"> +\usepackage[acronym]{glossaries} +</div> +<!--l. 2995--><p class="nopar" > A new command is then defined to make it easier to define dual entries: + + + +</p> + <div class="verbatim" id="verbatim-77"> +\newcommand*{\newdualentry}[5][]{% + <br />  \newglossaryentry{main-#2}{name={#4},% + <br />  text={#3\protect\glsadd{#2}},% + <br />  description={#5},% + <br />  #1 + <br />  }% + <br />  \newacronym{#2}{#3\protect\glsadd{main-#2}}{#4} + <br />} +</div> +<!--l. 3007--><p class="nopar" > This has the following syntax: +</p><!--l. 3010--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1000">\newdualentry</span><a + id="dx1-29010"></a><span +class="ectt-1000">[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3011--><p class="noindent" > +You can then define a new dual entry: + + + +</p> + <div class="verbatim" id="verbatim-78"> +\newdualentry{svm}% label + <br />  {SVM}% abbreviation + <br />  {support vector machine}% long form + <br />  {Statistical pattern recognition technique}% description +</div> +<!--l. 3018--><p class="nopar" > Now you can reference the acronym with <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{svm}</span></span></span> or you can reference the entry in +the main glossary with <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{main-svm}</span></span></span>. +</p><!--l. 3022--><p class="noindent" > +</p> +<!--l. 3022--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="x1-300008"></a>Cross-Referencing Entries</h3> +<!--l. 3025--><p class="noindent" >There are several ways of cross-referencing entries in the glossary: +</p><!--l. 3028--><p class="indent" > </p><ol class="enumerate1" > <li - class="enumerate" id="x1-25002x1">You can use commands such as <span + class="enumerate" id="x1-30002x1">You can use commands such as <span class="ectt-1000">\gls</span><a - id="dx1-25003"></a> in the entries description. For example: + id="dx1-30003"></a> in the entries description. For example: - <div class="verbatim" id="verbatim-71"> + <div class="verbatim" id="verbatim-79"> \newglossaryentry{apple}{name=apple,  <br />description={firm, round fruit. See also \gls{pear}}} </div> - <!--l. 2634--><p class="nopar" > Note that with this method, if you don’t use the cross-referenced term in the - glossary, you will need two runs of <span + <!--l. 3034--><p class="nopar" > Note that with this method, if you don’t use the cross-referenced term in the + main part of the document, you will need two runs of <a + id="dx1-30004"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-25004"></a>: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="ectt-1000">latex filename</span> - <br /><span -class="ectt-1000">makeglossaries filename</span> - <br /><span -class="ectt-1000">latex filename</span> - <br /><span -class="ectt-1000">makeglossaries filename</span> - <br /><span -class="ectt-1000">latex filename</span></span> - </p><!--l. 2644--><p class="noindent" ><spacer type=vertical size=10> + id="dx1-30005"></a></a>: + + + +</p> + <div class="verbatim" id="verbatim-80"> + latex filename +  <br />makeglossaries filename +  <br />latex filename +  <br />makeglossaries filename +  <br />latex filename +</div> + <!--l. 3044--><p class="nopar" > + </p><!--l. 3046--><p class="noindent" ><div class="important" title="Important Note"> If you switch off the description <a + id="dx1-30006"></a><a +href="#glo:sanitize">sanitization<a + id="dx1-30007"></a></a>, you must protect fragile commands + like <span +class="ectt-1000">\gls</span><a + id="dx1-30008"></a>: + + + +</p> + <div class="verbatim" id="verbatim-81"> + \newglossaryentry{apple}{name=apple, +  <br />description={firm, round fruit. See also +  <br />\protect\gls{pear}}} +</div> + <!--l. 3054--><p class="nopar" > </div> + </p><!--l. 3055--><p class="noindent" > </p></li> <li - class="enumerate" id="x1-25006x2">As described in <a -href="#x1-140002.2">2.2 </a><a -href="#x1-140002.2">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>, you can use the <span + class="enumerate" id="x1-30010x2">As described in <a +href="#x1-190004">4 </a><a +href="#x1-190004">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>, you can use the <span class="ecss-1000">see</span><a - id="dx1-25007"></a> key when you + id="dx1-30011"></a> key when you define the entry. For example: - <div class="verbatim" id="verbatim-72"> + <div class="verbatim" id="verbatim-82"> \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -  <br />description={Series expansion}, see={TaylorsTheorem}} +  <br />description={Series expansion}, +  <br />see={TaylorsTheorem}} </div> - <!--l. 2651--><p class="nopar" > Note that in this case, the entry with the <span + <!--l. 3063--><p class="nopar" > Note that in this case, the entry with the <span class="ecss-1000">see</span><a - id="dx1-25008"></a> key will automatically be added to + id="dx1-30012"></a> key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the commands described in <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a -href="#x1-240002.5">2.5 </a><a -href="#x1-240002.5">Adding an Entry to the Glossary Without Generating +href="#x1-290007">7 </a><a +href="#x1-290007">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>. - </p><!--l. 2658--><p class="noindent" >You can optionally override the “see” tag using square brackets at the start of the - <span + </p><!--l. 3070--><p class="noindent" >The “see” tag is produce using <span +class="ectt-1000">\seename</span><a + id="dx1-30013"></a>, but can be overridden in specific + instances using square brackets at the start of the <span class="ecss-1000">see</span><a - id="dx1-25009"></a> value. For example: + id="dx1-30014"></a> value. For example: </p> - <div class="verbatim" id="verbatim-73"> + <div class="verbatim" id="verbatim-83"> \newglossaryentry{MaclaurinSeries}{name={Maclaurin series},  <br />description={Series expansion},  <br />see=[see also]{TaylorsTheorem}} </div> - <!--l. 2664--><p class="nopar" > + <!--l. 3077--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-25011x3">After you have defined the entry, use - <!--l. 2667--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + class="enumerate" id="x1-30016x3">After you have defined the entry, use + <!--l. 3080--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glssee</span><span class="ectt-0900"> </span></span><a - id="dx1-25012"></a> <span + id="dx1-30017"></a> <span class="ectt-1000">\glssee[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">tag</span><span @@ -6165,27 +7410,33 @@ class="cmsy-10">⟨</span><span class="ecti-1000">xr label list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> - </p><!--l. 2669--><p class="noindent" > + </p><!--l. 3082--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">xr label list</span><span -class="cmsy-10">⟩ </span>is a comma-separated list of entry labels to be cross-referenced, - <span +class="cmsy-10">⟩ </span>is a comma-separated list of entry labels to be + cross-referenced, <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span -class="cmsy-10">⟩ </span>is the label of the entry doing the cross-referencing and <span +class="cmsy-10">⟩ </span>is the label of the entry doing the cross-referencing + and <span +class="cmsy-10">⟨</span><span +class="ecti-1000">tag</span><span +class="cmsy-10">⟩ </span>is the “see” tag. (The default value of <span class="cmsy-10">⟨</span><span class="ecti-1000">tag</span><span -class="cmsy-10">⟩ </span>is the “see” - tag. For example: +class="cmsy-10">⟩ </span>is <span +class="ectt-1000">\seename</span><a + id="dx1-30018"></a>.) For + example: </p> - <div class="verbatim" id="verbatim-74"> + <div class="verbatim" id="verbatim-84"> \glssee[see also]{series}{FourierSeries,TaylorsTheorem} </div> - <!--l. 2676--><p class="nopar" > Note that this automatically adds the entry given by <span + <!--l. 3090--><p class="nopar" > Note that this automatically adds the entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>to the glossary but @@ -6194,411 +7445,561 @@ class="cmsy-10">⟨</span><span class="ecti-1000">xr label list</span><span class="cmsy-10">⟩</span>) to the glossary.</p></li></ol> -<!--l. 2682--><p class="indent" > In both cases 2 and 3 above, the cross-referenced information appears in the -number list<a - id="dx1-25013"></a>, whereas in case 1, the cross-referenced information appears in the -description. In cases 2 and 3, the default text for the “see” tag is given by +<!--l. 3096--><p class="indent" > In both cases 2 and 3 above, the cross-referenced information appears in the +<a + id="dx1-30019"></a><a +href="#glo:numberlist">number list<a + id="dx1-30020"></a></a>, whereas in case 1, the cross-referenced information appears in the +description. (See the <a +href="#x1-40001.1"><span +class="ectt-1000">sample-crossref.tex</span></a> example file that comes with this package.) +This means that in cases 2 and 3, the cross-referencing information won’t appear if you +have suppressed the <a + id="dx1-30021"></a>number list<a + id="dx1-30022"></a>. In this case, you will need to activate the <a + id="dx1-30023"></a>number list<a + id="dx1-30024"></a> +for the given entries using <span +class="ecss-1000">nonumberlist=false</span><a + id="dx1-30025"></a>. Alternatively, if you just use the <span +class="ecss-1000">see</span><a + id="dx1-30026"></a> key +instead of <span +class="ectt-1000">\glssee</span><a + id="dx1-30027"></a>, you can automatically activate the <a + id="dx1-30028"></a>number list<a + id="dx1-30029"></a> using the <span -class="ectt-1000">\seename</span><a - id="dx1-25014"></a>. -</p><!--l. 2688--><p class="noindent" > +class="ecss-1000">seeautonumberlist</span><a + id="dx1-30030"></a> package option. +</p><!--l. 3108--><p class="noindent" > +</p> +<!--l. 3108--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">8.1 </span> <a + id="x1-310008.1"></a>Customising Cross-reference Text</h4> +<!--l. 3110--><p class="noindent" >When you use either the <span +class="ecss-1000">see</span><a + id="dx1-31001"></a> key or the command <span +class="ectt-1000">\glssee</span>, the cross-referencing +information will be typeset in the glossary according to: +</p><!--l. 3113--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsseeformat</span><span +class="ectt-0900"> </span></span><a + id="dx1-31002"></a> <span +class="ectt-1000">\glsseeformat[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">tag</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label-list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">location</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3115--><p class="noindent" > +The default definition of <span +class="ectt-1000">\glsseeformat </span>is: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\emph{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">tag</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} \glsseelist{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label-list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> + <br /><spacer type=vertical size=10></span> +Note that the location is always ignored.<span class="footnote-mark"><a +href="#fn9x0" id="fn9x0-bk"><sup class="textsuperscript">9</sup></a></span><a + id="x1-31003f9"></a> +For example, if you want the tag to appear in bold, you can +do:<span class="footnote-mark"><a +href="#fn10x0" id="fn10x0-bk"><sup class="textsuperscript">10</sup></a></span><a + id="x1-31006f10"></a> + + + </p> -<!--l. 2688--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.7 </span> <a - id="x1-260002.7"></a>Using Glossary Terms Without Links</h4> -<!--l. 2691--><p class="noindent" >The commands described in this section display entry details without adding any + <div class="verbatim" id="verbatim-85"> +\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1} \glsseelist{#2}} +</div> +<!--l. 3130--><p class="nopar" > +</p><!--l. 3133--><p class="indent" > The list of labels is dealt with by <span +class="ectt-1000">\glsseelist</span>, which iterates through the list and +typesets each entry in the label. The entries are separated by +</p><!--l. 3136--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsseesep</span><span +class="ectt-0900"> </span></span><a + id="dx1-31009"></a> <span +class="ectt-1000">\glsseesep </span></div><hr> +</p><!--l. 3138--><p class="noindent" > +or (for the last pair) +</p><!--l. 3140--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsseelastsep</span><span +class="ectt-0900"> </span></span><a + id="dx1-31010"></a> <span +class="ectt-1000">\glsseelastsep </span></div><hr> +</p><!--l. 3142--><p class="noindent" > +These default to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">,\space</span></span></span> and <span +class="ectt-1000">\space\andname</span><a + id="dx1-31011"></a><span +class="ectt-1000">\space </span>respectively. The list entry text +is displayed using: +</p><!--l. 3146--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsseeitemformat</span><span +class="ectt-0900"> </span></span><a + id="dx1-31012"></a> <span +class="ectt-1000">\glsseeitemformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3148--><p class="noindent" > +This defaults to +<span +class="ectt-1000">\glsentrytext</span><a + id="dx1-31013"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>.<span class="footnote-mark"><a +href="#fn11x0" id="fn11x0-bk"><sup class="textsuperscript">11</sup></a></span><a + id="x1-31014f11"></a> +For example, to make the cross-referenced list use small caps: + + + +</p> + <div class="verbatim" id="verbatim-86"> +\renewcommand{\glsseeitemformat}[1]{\textsc{\glsentrytext{#1}}} +</div> +<!--l. 3155--><p class="nopar" > +</p><!--l. 3157--><p class="indent" > <div class="important" title="Important Note"> You can use <span +class="ectt-1000">\glsseeformat</span><a + id="dx1-31018"></a> and <span +class="ectt-1000">\glsseelist</span><a + id="dx1-31019"></a> in the main body of the text, but +they won’t automatically add the cross-referenced entries to the glossary. If you want +them added with that location, you can do: + + + +</p> + <div class="verbatim" id="verbatim-87"> +Some information (see also + <br />\glsseelist{FourierSeries,TaylorsTheorem}% + <br />\glsadd{FourierSeries}\glsadd{TaylorsTheorem}). +</div> +<!--l. 3166--><p class="nopar" > </div> +</p><!--l. 3167--><p class="noindent" > +</p><!--l. 3169--><p class="noindent" > +</p> +<!--l. 3169--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="x1-320009"></a>Using Glossary Terms Without Links</h3> +<!--l. 3172--><p class="noindent" >The commands described in this section display entry details without adding any information to the glossary. They don’t use <span -class="ectt-1000">\glstextformat</span>, they don’t have any -optional arguments, they don’t affect the first use flag<a - id="dx1-26001"></a> and, apart from <span +class="ectt-1000">\glstextformat</span><a + id="dx1-32001"></a>, they don’t have any +optional arguments, they don’t affect the <a + id="dx1-32002"></a><a +href="#glo:firstuseflag">first use flag</a> and, apart from <span class="ectt-1000">\glshyperlink</span><a - id="dx1-26002"></a>, + id="dx1-32003"></a>, they don’t produce hyperlinks. -</p><!--l. 2696--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3177--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryname</span><span class="ectt-0900"> </span></span><a - id="dx1-26003"></a> <span + id="dx1-32004"></a> <span class="ectt-1000">\glsentryname{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2698--><p class="noindent" > -</p><!--l. 2699--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3179--><p class="noindent" > +</p><!--l. 3180--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryname</span><span class="ectt-0900"> </span></span><a - id="dx1-26004"></a> <span + id="dx1-32005"></a> <span class="ectt-1000">\Glsentryname{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2701--><p class="noindent" > +</p><!--l. 3182--><p class="noindent" > These commands display the name of the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, as specified by the <span class="ecss-1000">name</span><a - id="dx1-26005"></a> key. <span + id="dx1-32006"></a> key. <span class="ectt-1000">\Glsentryname </span>makes the first letter uppercase. -</p><!--l. 2705--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3186--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentrytext</span><span class="ectt-0900"> </span></span><a - id="dx1-26006"></a> <span + id="dx1-32007"></a> <span class="ectt-1000">\glsentrytext{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2707--><p class="noindent" > -</p><!--l. 2708--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3188--><p class="noindent" > +</p><!--l. 3189--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentrytext</span><span class="ectt-0900"> </span></span><a - id="dx1-26007"></a> <span + id="dx1-32008"></a> <span class="ectt-1000">\Glsentrytext{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2710--><p class="noindent" > +</p><!--l. 3191--><p class="noindent" > These commands display the subsequent use text for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, as specified by the <span class="ecss-1000">text</span><a - id="dx1-26008"></a> key. <span + id="dx1-32009"></a> key. <span class="ectt-1000">\Glsentrytext </span>makes the first letter uppercase. -</p><!--l. 2714--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3195--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26009"></a> <span + id="dx1-32010"></a> <span class="ectt-1000">\glsentryplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2716--><p class="noindent" > -</p><!--l. 2717--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3197--><p class="noindent" > +</p><!--l. 3198--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26010"></a> <span + id="dx1-32011"></a> <span class="ectt-1000">\Glsentryplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2719--><p class="noindent" > +</p><!--l. 3200--><p class="noindent" > These commands display the subsequent use plural text for the glossary entry given by - - - <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, as specified by the <span class="ecss-1000">plural</span><a - id="dx1-26011"></a> key. <span + id="dx1-32012"></a> key. <span class="ectt-1000">\Glsentryplural </span>makes the first letter uppercase. -</p><!--l. 2724--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3205--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-26012"></a> <span + id="dx1-32013"></a> <span class="ectt-1000">\glsentryfirst{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2726--><p class="noindent" > -</p><!--l. 2727--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + + + +</p><!--l. 3207--><p class="noindent" > +</p><!--l. 3208--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryfirst</span><span class="ectt-0900"> </span></span><a - id="dx1-26013"></a> <span + id="dx1-32014"></a> <span class="ectt-1000">\Glsentryfirst{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2729--><p class="noindent" > -These commands display the first use text<a - id="dx1-26014"></a> for the glossary entry given by +</p><!--l. 3210--><p class="noindent" > +These commands display the <a + id="dx1-32015"></a><a +href="#glo:firstusetext">first use text</a> for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, as specified by the <span class="ecss-1000">first</span><a - id="dx1-26015"></a> key. <span + id="dx1-32016"></a> key. <span class="ectt-1000">\Glsentryfirst </span>makes the first letter uppercase. -</p><!--l. 2733--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3214--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryfirstplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26016"></a> <span + id="dx1-32017"></a> <span class="ectt-1000">\glsentryfirstplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2735--><p class="noindent" > -</p><!--l. 2736--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3216--><p class="noindent" > +</p><!--l. 3217--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryfirstplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26017"></a> <span + id="dx1-32018"></a> <span class="ectt-1000">\Glsentryfirstplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2738--><p class="noindent" > -These commands display the plural form of the first use text<a - id="dx1-26018"></a> for the glossary entry +</p><!--l. 3219--><p class="noindent" > +These commands display the plural form of the <a + id="dx1-32019"></a><a +href="#glo:firstusetext">first use text</a> for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, as specified by the <span class="ecss-1000">firstplural</span><a - id="dx1-26019"></a> key. <span + id="dx1-32020"></a> key. <span class="ectt-1000">\Glsentryfirstplural </span>makes the first letter uppercase. -</p><!--l. 2743--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3224--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentrydesc</span><span class="ectt-0900"> </span></span><a - id="dx1-26020"></a> <span + id="dx1-32021"></a> <span class="ectt-1000">\glsentrydesc{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2745--><p class="noindent" > -</p><!--l. 2746--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3226--><p class="noindent" > +</p><!--l. 3227--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentrydesc</span><span class="ectt-0900"> </span></span><a - id="dx1-26021"></a> <span + id="dx1-32022"></a> <span class="ectt-1000">\Glsentrydesc{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2748--><p class="noindent" > +</p><!--l. 3229--><p class="noindent" > These commands display the description for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. <span class="ectt-1000">\Glsentrydesc </span>makes the first letter uppercase. -</p><!--l. 2751--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3232--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentrydescplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26022"></a> <span + id="dx1-32023"></a> <span class="ectt-1000">\glsentrydescplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2753--><p class="noindent" > -</p><!--l. 2754--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3234--><p class="noindent" > +</p><!--l. 3235--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentrydescplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26023"></a> <span + id="dx1-32024"></a> <span class="ectt-1000">\Glsentrydescplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2756--><p class="noindent" > +</p><!--l. 3237--><p class="noindent" > These commands display the plural description for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. <span class="ectt-1000">\Glsentrydescplural </span>makes the first letter uppercase. -</p><!--l. 2760--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3241--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentrysymbol</span><span class="ectt-0900"> </span></span><a - id="dx1-26024"></a> <span + id="dx1-32025"></a> <span class="ectt-1000">\glsentrysymbol{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2762--><p class="noindent" > -</p><!--l. 2763--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3243--><p class="noindent" > +</p><!--l. 3244--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentrysymbol</span><span class="ectt-0900"> </span></span><a - id="dx1-26025"></a> <span + id="dx1-32026"></a> <span class="ectt-1000">\Glsentrysymbol{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2765--><p class="noindent" > +</p><!--l. 3246--><p class="noindent" > These commands display the symbol for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. <span class="ectt-1000">\Glsentrysymbol </span>makes the first letter uppercase. -</p><!--l. 2768--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3249--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentrysymbolplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26026"></a> <span + id="dx1-32027"></a> <span class="ectt-1000">\glsentrysymbolplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2770--><p class="noindent" > -</p><!--l. 2771--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3251--><p class="noindent" > +</p><!--l. 3252--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentrysymbolplural</span><span class="ectt-0900"> </span></span><a - id="dx1-26027"></a> <span + id="dx1-32028"></a> <span class="ectt-1000">\Glsentrysymbolplural{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2773--><p class="noindent" > +</p><!--l. 3254--><p class="noindent" > These commands display the plural symbol for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. <span class="ectt-1000">\Glsentrysymbolplural </span>makes the first letter uppercase. - - - -</p><!--l. 2777--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3258--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuseri</span><span class="ectt-0900"> </span></span><a - id="dx1-26028"></a> <span + id="dx1-32029"></a> <span class="ectt-1000">\glsentryuseri{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2779--><p class="noindent" > -</p><!--l. 2780--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3260--><p class="noindent" > + + + +</p><!--l. 3261--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuseri</span><span class="ectt-0900"> </span></span><a - id="dx1-26029"></a> <span + id="dx1-32030"></a> <span class="ectt-1000">\Glsentryuseri{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2782--><p class="noindent" > -</p><!--l. 2783--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3263--><p class="noindent" > +</p><!--l. 3264--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuserii</span><span class="ectt-0900"> </span></span><a - id="dx1-26030"></a> <span + id="dx1-32031"></a> <span class="ectt-1000">\glsentryuserii{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2785--><p class="noindent" > -</p><!--l. 2786--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3266--><p class="noindent" > +</p><!--l. 3267--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuserii</span><span class="ectt-0900"> </span></span><a - id="dx1-26031"></a> <span + id="dx1-32032"></a> <span class="ectt-1000">\Glsentryuserii{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2788--><p class="noindent" > -</p><!--l. 2789--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3269--><p class="noindent" > +</p><!--l. 3270--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuseriii</span><span class="ectt-0900"> </span></span><a - id="dx1-26032"></a> <span + id="dx1-32033"></a> <span class="ectt-1000">\glsentryuseriii{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2791--><p class="noindent" > -</p><!--l. 2792--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3272--><p class="noindent" > +</p><!--l. 3273--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuseriii</span><span class="ectt-0900"> </span></span><a - id="dx1-26033"></a> <span + id="dx1-32034"></a> <span class="ectt-1000">\Glsentryuseriii{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2794--><p class="noindent" > -</p><!--l. 2795--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3275--><p class="noindent" > +</p><!--l. 3276--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuseriv</span><span class="ectt-0900"> </span></span><a - id="dx1-26034"></a> <span + id="dx1-32035"></a> <span class="ectt-1000">\glsentryuseriv{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2797--><p class="noindent" > -</p><!--l. 2798--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3278--><p class="noindent" > +</p><!--l. 3279--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuseriv</span><span class="ectt-0900"> </span></span><a - id="dx1-26035"></a> <span + id="dx1-32036"></a> <span class="ectt-1000">\Glsentryuseriv{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2800--><p class="noindent" > -</p><!--l. 2801--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3281--><p class="noindent" > +</p><!--l. 3282--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuserv</span><span class="ectt-0900"> </span></span><a - id="dx1-26036"></a> <span + id="dx1-32037"></a> <span class="ectt-1000">\glsentryuserv{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2803--><p class="noindent" > -</p><!--l. 2804--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3284--><p class="noindent" > +</p><!--l. 3285--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuserv</span><span class="ectt-0900"> </span></span><a - id="dx1-26037"></a> <span + id="dx1-32038"></a> <span class="ectt-1000">\Glsentryuserv{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2806--><p class="noindent" > -</p><!--l. 2807--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3287--><p class="noindent" > +</p><!--l. 3288--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsentryuservi</span><span class="ectt-0900"> </span></span><a - id="dx1-26038"></a> <span + id="dx1-32039"></a> <span class="ectt-1000">\glsentryuservi{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2809--><p class="noindent" > -</p><!--l. 2810--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3290--><p class="noindent" > +</p><!--l. 3291--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\Glsentryuservi</span><span class="ectt-0900"> </span></span><a - id="dx1-26039"></a> <span + id="dx1-32040"></a> <span class="ectt-1000">\Glsentryuservi{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2812--><p class="noindent" > +</p><!--l. 3293--><p class="noindent" > These commands display the value of the user keys for the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. -</p><!--l. 2815--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3296--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glshyperlink</span><span class="ectt-0900"> </span></span><a - id="dx1-26040"></a> <span + id="dx1-32041"></a> <span class="ectt-1000">\glshyperlink[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">link text</span><span @@ -6608,85 +8009,94 @@ class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2817--><p class="noindent" > +</p><!--l. 3298--><p class="noindent" > This command provides a hyperlink to the glossary entry given by <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩ </span><span -class="ecbx-1000">but does</span> -<span -class="ecbx-1000">not add any information to the glossary file</span>. The link text is given by +class="ecbx-1000">but does not add</span> <span -class="ectt-1000">\glsentryname</span><a - id="dx1-26041"></a><span +class="ecbx-1000">any information to the glossary file</span>. The link text is given by <span +class="ectt-1000">\glsentrytext</span><a + id="dx1-32042"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">} </span>by default, but can be overridden using the optional -argument. -</p><!--l. 2823--><p class="indent" > <div class="important" title="Important Note"> If you use <span +class="ectt-1000">} </span>by +default<span class="footnote-mark"><a +href="#fn12x0" id="fn12x0-bk"><sup class="textsuperscript">12</sup></a></span><a + id="x1-32043f12"></a>, +but can be overridden using the optional argument. +</p><!--l. 3306--><p class="indent" > <div class="important" title="Important Note"> If you use <span class="ectt-1000">\glshyperlink</span>, you need to ensure that the relevant entry has been added to the glossary using any of the commands described in <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links to Glossary +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a -href="#x1-240002.5">2.5 </a><a -href="#x1-240002.5">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> otherwise +href="#x1-290007">7 </a><a +href="#x1-290007">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> otherwise you +will end up with an undefined link. </div> +</p><!--l. 3311--><p class="noindent" > -you will end up with a broken link. </div> -</p><!--l. 2828--><p class="noindent" > -</p><!--l. 2830--><p class="indent" > For further information see the section “Displaying entry details without adding -information to the glossary” in the document <a -href="glossaries.pdf" class="url" ><span -class="ectt-1000">glossaries.pdf</span></a>. -</p><!--l. 2836--><p class="noindent" > -</p> -<!--l. 2836--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.8 </span> <a - id="x1-270002.8"></a>Displaying a glossary</h4> -<!--l. 2839--><p class="noindent" >The command -</p><!--l. 2840--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3313--><p class="indent" > For further information see “Displaying entry details without adding information to +the glossary” in the documented code (<span +class="ectt-1000">glossaries.pdf</span>). +</p><!--l. 3317--><p class="noindent" > +</p> +<!--l. 3317--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="x1-3300010"></a>Displaying a glossary</h3> +<!--l. 3320--><p class="noindent" >The command +</p><!--l. 3321--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\printglossaries</span><span class="ectt-0900"> </span></span><a - id="dx1-27001"></a> <span + id="dx1-33001"></a> <span class="ectt-1000">\printglossaries </span></div><hr> -</p><!--l. 2842--><p class="noindent" > +</p><!--l. 3323--><p class="noindent" > will display all the glossaries in the order in which they were defined. Note that no -glossaries will appear until you have either used the Perl script <span +glossaries will appear until you have either used the Perl script <a + id="dx1-33002"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-27002"></a> or have -directly used <span + id="dx1-33003"></a></a> or have +directly used <a + id="dx1-33004"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-27003"></a> or <span + id="dx1-33005"></a></a> or <a + id="dx1-33006"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-27004"></a> (as described in <a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated + id="dx1-33007"></a></a> (as described in <a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>). If the glossary still does not appear after you re-<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> your -document, check the <span +document, check the <a + id="dx1-33008"></a><span class="ectt-1000">makeindex</span><a - id="dx1-27005"></a>/<span + id="dx1-33009"></a>/<a + id="dx1-33010"></a><span class="ectt-1000">xindy</span><a - id="dx1-27006"></a> log files to see if there is a problem. Remember + id="dx1-33011"></a> log files to see if there is a problem. Remember that you also need to use the command <span class="ectt-1000">\makeglossaries</span><a - id="dx1-27007"></a> in the preamble to enable the + id="dx1-33012"></a> in the preamble to enable the glossaries. -</p><!--l. 2853--><p class="indent" > An individual glossary can be displayed using: -</p><!--l. 2854--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3334--><p class="indent" > An individual glossary can be displayed using: +</p><!--l. 3335--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\printglossary</span><span class="ectt-0900"> </span></span><a - id="dx1-27008"></a> <span + id="dx1-33013"></a> <span class="ectt-1000">\printglossary[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 2856--><p class="noindent" > +</p><!--l. 3337--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">options</span><span @@ -6700,106 +8110,111 @@ class="cmsy-10">⟩ </span>list of options. The following keys are availabl </p><dl class="description"><dt class="description"> <span class="ecsx-1000">type</span><a - id="dx1-27009"></a> </dt><dd + id="dx1-33014"></a> </dt><dd class="description">The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For example, to print the list of acronyms: - <div class="verbatim" id="verbatim-75"> + <div class="verbatim" id="verbatim-88"> \printglossary[type=\acronymtype] </div> - <!--l. 2865--><p class="nopar" > + <!--l. 3346--><p class="nopar" > </p></dd><dt class="description"> <span class="ecsx-1000">title</span><a - id="dx1-27010"></a> </dt><dd + id="dx1-33015"></a> </dt><dd class="description">This is the glossary’s title (overriding the title specified when the glossary was defined). </dd><dt class="description"> <span class="ecsx-1000">toctitle</span><a - id="dx1-27011"></a> </dt><dd + id="dx1-33016"></a> </dt><dd class="description">This is the title to use for the table of contents (if the <span class="ecss-1000">toc</span><a - id="dx1-27012"></a> package option has + id="dx1-33017"></a> package option has been used). It may also be used for the page header, depending on the page style. - If omitted, the glossary title is used. + If omitted, the value of <span +class="ecss-1000">title</span><a + id="dx1-33018"></a> is used. </dd><dt class="description"> <span class="ecsx-1000">style</span><a - id="dx1-27013"></a> </dt><dd + id="dx1-33019"></a> </dt><dd class="description">This specifies which glossary style to use for this glossary, overriding the effect of the <span class="ecss-1000">style</span><a - id="dx1-27014"></a> package option or <span + id="dx1-33020"></a> package option or <span class="ectt-1000">\glossarystyle</span><a - id="dx1-27015"></a>. + id="dx1-33021"></a>. </dd><dt class="description"> <span class="ecsx-1000">numberedsection</span><a - id="dx1-27016"></a> </dt><dd + id="dx1-33022"></a> </dt><dd class="description">This specifies whether to use a numbered section for this glossary, overriding the effect of the <span class="ecss-1000">numberedsection</span><a - id="dx1-27017"></a> package option. This key has the same + id="dx1-33023"></a> package option. This key has the same syntax as the <span class="ecss-1000">numberedsection</span><a - id="dx1-27018"></a> package option, described in <a -href="#x1-130002.1">2.1 </a><a -href="#x1-130002.1">Package - Options<!--tex4ht:ref: sec:pkgopts --></a>. + id="dx1-33024"></a> package option, described in <a +href="#x1-140002.2">2.2 </a><a +href="#x1-140002.2">Sectioning and + TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. </dd><dt class="description"> <span class="ecsx-1000">nonumberlist</span><a - id="dx1-27019"></a> </dt><dd -class="description">Unlike the package option of the same name, this key is a boolean key. If - true (<span class="obeylines-h"><span class="verb"><span -class="ectt-1000">nonumberlist=true</span></span></span>) the numberlist is suppressed for this glossary. If false - (<span class="obeylines-h"><span class="verb"><span -class="ectt-1000">nonumberlist=false</span></span></span>) the numberlist is displayed for this glossary. If no value is - supplied, true is assumed. + id="dx1-33025"></a> </dt><dd +class="description">This is a boolean key. If true (<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">nonumberlist=true</span></span></span>) the numberlist is + suppressed for this glossary. If false (<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">nonumberlist=false</span></span></span>) the numberlist is + displayed for this glossary. If no value is supplied, true is assumed. </dd></dl> -<!--l. 2894--><p class="indent" > By default, the glossary is started either by <span -class="ectt-1000">\chapter* </span>or by <span -class="ectt-1000">\section*</span>, depending +<!--l. 3376--><p class="indent" > By default, the glossary is started either by <span +class="ectt-1000">\chapter*</span><a + id="dx1-33026"></a> or by <span +class="ectt-1000">\section*</span><a + id="dx1-33027"></a>, depending on whether or not <span -class="ectt-1000">\chapter </span>is defined. This can be overridden by the <span +class="ectt-1000">\chapter</span><a + id="dx1-33028"></a> is defined. This can be overridden by the <span class="ecss-1000">section</span><a - id="dx1-27020"></a> package + id="dx1-33029"></a> package option or the <span -class="ectt-1000">\setglossarysection </span>command. Numbered sectional units can be +class="ectt-1000">\setglossarysection</span><a + id="dx1-33030"></a> command. Numbered sectional units can be obtained using the <span class="ecss-1000">numberedsection</span><a - id="dx1-27021"></a> package option. Each glossary sets the page header + id="dx1-33031"></a> package option. Each glossary sets the page header via the command <span class="ectt-1000">\glossarymark</span><a - id="dx1-27022"></a>. If this mechanism is unsuitable for your -chosen class file or page style package, you will need to redefine <span + id="dx1-33032"></a>. If this mechanism is unsuitable for your chosen class +file or page style package, you will need to redefine <span class="ectt-1000">\glossarymark</span><a - id="dx1-27023"></a>. -Further information about these options and commands is given in <a -href="#x1-130002.1">2.1 </a><a -href="#x1-130002.1">Package -Options<!--tex4ht:ref: sec:pkgopts --></a>. -</p><!--l. 2905--><p class="indent" > Information can be added to the start of the glossary (after the title and before the + id="dx1-33033"></a>. Further +information about these options and commands is given in <a +href="#x1-140002.2">2.2 </a><a +href="#x1-140002.2">Sectioning and TOC +Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. +</p><!--l. 3387--><p class="indent" > Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -</p><!--l. 2907--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3389--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossarypreamble</span><span class="ectt-0900"> </span></span><a - id="dx1-27024"></a> <span + id="dx1-33034"></a> <span class="ectt-1000">\glossarypreamble </span></div><hr> -</p><!--l. 2909--><p class="noindent" > +</p><!--l. 3391--><p class="noindent" > For example: </p> - <div class="verbatim" id="verbatim-76"> + <div class="verbatim" id="verbatim-89"> \renewcommand{\glossarypreamble}{Numbers in italic indicate  <br />primary definitions.} </div> -<!--l. 2914--><p class="nopar" > This needs to be done before the glossary is displayed using <span +<!--l. 3396--><p class="nopar" > This needs to be done before the glossary is displayed using <span class="ectt-1000">\printglossaries </span>or <span class="ectt-1000">\printglossary</span>. Note that if you want a different preamble for each glossary, you will @@ -6811,145 +8226,168 @@ class="ectt-1000">\glossarypreamble </span>between each glossary. For example: </p> - <div class="verbatim" id="verbatim-77"> + <div class="verbatim" id="verbatim-90"> \renewcommand{\glossarypreamble}{Numbers in italic indicate  <br />primary definitions.}  <br />\printglossary  <br />\renewcommand{\glossarypreamble}{}  <br />\printglossary[type=acronym] </div> -<!--l. 2927--><p class="nopar" > Alternatively, you can do something like: +<!--l. 3409--><p class="nopar" > Alternatively, you can do something like: </p> - <div class="verbatim" id="verbatim-78"> + <div class="verbatim" id="verbatim-91"> \renewcommand{\glossarypreamble}{Numbers in italic indicate  <br />primary definitions.\gdef\glossarypreamble{}}  <br />\printglossaries </div> -<!--l. 2933--><p class="nopar" > which will print the preamble text for the first glossary and change the preamble to do +<!--l. 3415--><p class="nopar" > which will print the preamble text for the first glossary and change the preamble to do nothing for subsequent glossaries. (Note that <span class="ectt-1000">\gdef </span>is required as the glossary is placed within a group.) -</p><!--l. 2939--><p class="indent" > There is an analogous command called -</p><!--l. 2940--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3421--><p class="indent" > There is an analogous command called +</p><!--l. 3422--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossarypostamble</span><span class="ectt-0900"> </span></span><a - id="dx1-27025"></a> <span + id="dx1-33035"></a> <span class="ectt-1000">\glossarypostamble </span></div><hr> -</p><!--l. 2942--><p class="noindent" > +</p><!--l. 3424--><p class="noindent" > which is placed at the end of each glossary. -</p><!--l. 2945--><p class="noindent" > +</p><!--l. 3427--><p class="indent" > For example: suppose you are using the <span +class="ecss-1000">superheaderborder</span><a + id="dx1-33036"></a> +style<span class="footnote-mark"><a +href="#fn13x0" id="fn13x0-bk"><sup class="textsuperscript">13</sup></a></span><a + id="x1-33037f13"></a>, +and you want the glossary to be in two columns, but after the glossary you want to +switch back to one column mode, you could do: + + + </p> -<!--l. 2945--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.8.1 </span> <a - id="x1-280002.8.1"></a>Changing the way the entry name appears in the glossary</h5> -<!--l. 2948--><p class="noindent" >Within each glossary, each entry name is formatted according to -</p><!--l. 2949--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + <div class="verbatim" id="verbatim-92"> +\renewcommand*{\glossarysection}[2][]{% + <br />  \twocolumn[{\section*{#2}}]% + <br />  \setlength\glsdescwidth{0.6\linewidth}% + <br />  \glossarymark{\glossarytoctitle}% + <br />} + <br />\renewcommand*{\glossarypostamble}{\onecolumn} +</div> +<!--l. 3441--><p class="nopar" > +</p><!--l. 3443--><p class="indent" > Within each glossary, each entry name is formatted according to +</p><!--l. 3444--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsnamefont</span><span class="ectt-0900"> </span></span><a - id="dx1-28001"></a> <span + id="dx1-33041"></a> <span class="ectt-1000">\glsnamefont{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 2951--><p class="noindent" > +</p><!--l. 3446--><p class="noindent" > which takes one argument: the entry name. This command is always used regardless of the glossary style. By default, <span class="ectt-1000">\glsnamefont </span>simply displays its argument in whatever the surrounding font happens to be. This means that in the list-like glossary styles (defined in the <span class="ecss-1000">glossary-list</span><a - id="dx1-28002"></a> style file) the name will appear in bold, since the name is + id="dx1-33042"></a> style file) the name will appear in bold, since the name is placed in the optional argument of <span class="ectt-1000">\item</span>, whereas in the tabular styles (defined in the <span class="ecss-1000">glossary-long</span><a - id="dx1-28003"></a> and <span + id="dx1-33043"></a> and <span class="ecss-1000">glossary-super</span><a - id="dx1-28004"></a> style files) the name will appear in the normal font. The + id="dx1-33044"></a> style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the <span class="ecss-1000">glossary-tree</span><a - id="dx1-28005"></a> style file) also set the name in + id="dx1-33045"></a> style file) also set the name in bold. -</p><!--l. 2964--><p class="indent" > For example, suppose you want all the entry names to appear in medium weight +</p><!--l. 3459--><p class="indent" > For example, suppose you want all the entry names to appear in medium weight small caps, then you can do: </p> - <div class="verbatim" id="verbatim-79"> + <div class="verbatim" id="verbatim-93"> \renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} </div> -<!--l. 2968--><p class="nopar" > -</p><!--l. 2971--><p class="noindent" > +<!--l. 3463--><p class="nopar" > +</p><!--l. 3466--><p class="noindent" > </p> -<!--l. 2971--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.8.2 </span> <a - id="x1-290002.8.2"></a>Xindy</h5> -<!--l. 2974--><p class="noindent" >If you want to use <span +<!--l. 3466--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">11 </span> <a + id="x1-3400011"></a>Xindy</h3> +<!--l. 3469--><p class="noindent" >If you want to use <a + id="dx1-34001"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-29001"></a> to sort the glossary, you must use the package option + id="dx1-34002"></a></a> to sort the glossary, you must use the package option <span class="ecss-1000">xindy</span><a - id="dx1-29002"></a>: + id="dx1-34003"></a>: </p> - <div class="verbatim" id="verbatim-80"> + <div class="verbatim" id="verbatim-94"> \usepackage[xindy]{glossaries} </div> -<!--l. 2978--><p class="nopar" > This ensures that the glossary information is written in <span +<!--l. 3473--><p class="nopar" > This ensures that the glossary information is written in <a + id="dx1-34004"></a><span class="ectt-1000">xindy</span><a - id="dx1-29003"></a> syntax. -</p><!--l. 2982--><p class="indent" > <a -href="#x1-60001.3">1.3 </a><a -href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> covers how to use the external + id="dx1-34005"></a> syntax. +</p><!--l. 3477--><p class="indent" > <a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> covers how to use the external indexing application. This section covers the commands provided by the <span class="ecss-1000">glossaries</span> -package that allow you to adjust the <span +package that allow you to adjust the <a + id="dx1-34006"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-29004"></a> style file (<span + id="dx1-34007"></a></a> style file (<span class="ectt-1000">.xdy</span><a - id="dx1-29005"></a>) and parameters. -</p><!--l. 2987--><p class="indent" > To assist writing information to the <span + id="dx1-34008"></a>) and parameters. +</p><!--l. 3482--><p class="indent" > To assist writing information to the <a + id="dx1-34009"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-29006"></a> style file, the <span + id="dx1-34010"></a></a> style file, the <span class="ecss-1000">glossaries </span>package provides the following commands: -</p><!--l. 2990--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3485--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsopenbrace</span><span class="ectt-0900"> </span></span><a - id="dx1-29007"></a> <span + id="dx1-34011"></a> <span class="ectt-1000">\glsopenbrace </span></div><hr> -</p><!--l. 2992--><p class="noindent" > -</p><!--l. 2993--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3487--><p class="noindent" > +</p><!--l. 3488--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsclosebrace</span><span class="ectt-0900"> </span></span><a - id="dx1-29008"></a> <span + id="dx1-34012"></a> <span class="ectt-1000">\glsclosebrace </span></div><hr> -</p><!--l. 2995--><p class="noindent" > +</p><!--l. 3490--><p class="noindent" > which produce an open and closing brace. (This is needed because <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\{</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\}</span></span></span> don’t expand to a simple brace character when written to a file.) -</p><!--l. 3000--><p class="indent" > In addition, if you are using a package that makes the double quote character active +</p><!--l. 3495--><p class="indent" > In addition, if you are using a package that makes the double quote character active (e.g. <span class="ecss-1000">ngerman</span><a - id="dx1-29009"></a>) you can use: -</p><!--l. 3002--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-34013"></a>) you can use: +</p><!--l. 3497--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsquote</span><span class="ectt-0900"> </span></span><a - id="dx1-29010"></a> <span + id="dx1-34014"></a> <span class="ectt-1000">\glsquote{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3004--><p class="noindent" > +</p><!--l. 3499--><p class="noindent" > which will produce <span class="obeylines-h"><span class="verb"><span class="ectt-1000">"</span></span></span><span class="cmsy-10">⟨</span><span @@ -6960,52 +8398,62 @@ class="ectt-1000">\string"</span></span></span> to write the double-quote character. This document assumes that the double quote character has not been made active, so the examples just use <span class="obeylines-h"><span class="verb"><span class="ectt-1000">"</span></span></span> for clarity. -</p><!--l. 3010--><p class="indent" > If you want greater control over the <span +</p><!--l. 3505--><p class="indent" > If you want greater control over the <a + id="dx1-34015"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-29011"></a> style file than is available through the + id="dx1-34016"></a></a> style file than is available through the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> commands provided by the <span -class="ecss-1000">glossaries </span>package, you will need to edit the <span +class="ecss-1000">glossaries </span>package, you will need to edit the <a + id="dx1-34017"></a><span class="ectt-1000">xindy</span><a - id="dx1-29012"></a> + id="dx1-34018"></a> style file. In which case, you must use <span class="ectt-1000">\noist</span><a - id="dx1-29013"></a> to prevent the style file from being + id="dx1-34019"></a> to prevent the style file from being overwritten by the <span -class="ecss-1000">glossaries </span>package. For additional information about <span +class="ecss-1000">glossaries </span>package. For additional information about <a + id="dx1-34020"></a><span class="ectt-1000">xindy</span><a - id="dx1-29014"></a>, read the -<span + id="dx1-34021"></a>, read the +<a + id="dx1-34022"></a><span class="ectt-1000">xindy</span><a - id="dx1-29015"></a> documentation. -</p> -<!--l. 3018--><p class="noindent" ><a -href="#top">Top</a> -</p><!--l. 3018--><p class="noindent" ><span class="paragraphHead"><a - id="x1-300002.8.2"></a><span -class="ecbx-1000">Language and Encodings</span></span> - When you use <span + id="dx1-34023"></a> documentation. +</p><!--l. 3513--><p class="noindent" > +</p> +<!--l. 3513--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">11.1 </span> <a + id="x1-3500011.1"></a>Language and Encodings</h4> +<!--l. 3514--><p class="noindent" >When you use <a + id="dx1-35001"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-30001"></a>, you need to specify the language and encoding used -(unless you have written your own custom <span + id="dx1-35002"></a></a>, you need to specify the language and encoding used +(unless you have written your own custom <a + id="dx1-35003"></a><span class="ectt-1000">xindy</span><a - id="dx1-30002"></a> style file that defines the -relevant alphabet and sort rules). If you use <span + id="dx1-35004"></a> style file that defines the +relevant alphabet and sort rules). If you use <a + id="dx1-35005"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-30003"></a>, this information is + id="dx1-35006"></a></a>, this information is obtained from the document’s auxiliary (<span class="ectt-1000">.aux</span><a - id="dx1-30004"></a>) file. The <span + id="dx1-35007"></a>) file. The <span class="ecss-1000">glossaries </span>package attempts to find the root language, but in the event that it gets it wrong or -if <span +if <a + id="dx1-35008"></a><span class="ectt-1000">xindy</span><a - id="dx1-30005"></a> doesn’t support that language, then you can specify the language + id="dx1-35009"></a> doesn’t support that language, then you can specify the language using: -</p><!--l. 3028--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3523--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GlsSetXdyLanguage</span><span class="ectt-0900"> </span></span><a - id="dx1-30006"></a> <span + id="dx1-35010"></a> <span class="ectt-1000">\GlsSetXdyLanguage[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary type</span><span @@ -7019,7 +8467,7 @@ class="ectt-1000">}</span> -</p><!--l. 3030--><p class="noindent" > +</p><!--l. 3525--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">language</span><span @@ -7033,23 +8481,23 @@ glossary given by <span class="cmsy-10">⟨</span><span class="ecti-1000">glossary type</span><span class="cmsy-10">⟩</span>. -</p><!--l. 3038--><p class="indent" > If the <span +</p><!--l. 3533--><p class="indent" > If the <span class="ecss-1000">inputenc</span><a - id="dx1-30007"></a> package is used, the encoding will be obtained from the + id="dx1-35011"></a> package is used, the encoding will be obtained from the value of <span class="ectt-1000">\inputencodingname</span><a - id="dx1-30008"></a>. Alternatively, you can specify the encoding + id="dx1-35012"></a>. Alternatively, you can specify the encoding using: -</p><!--l. 3041--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3536--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GlsSetXdyCodePage</span><span class="ectt-0900"> </span></span><a - id="dx1-30009"></a> <span + id="dx1-35013"></a> <span class="ectt-1000">\GlsSetXdyCodePage{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">code</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3043--><p class="noindent" > +</p><!--l. 3538--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">code</span><span @@ -7058,11 +8506,11 @@ class="cmsy-10">⟩ </span>is the name of the encoding. For example: </p> - <div class="verbatim" id="verbatim-81"> + <div class="verbatim" id="verbatim-95"> \GlsSetXdyCodePage{utf8} </div> -<!--l. 3047--><p class="nopar" > -</p><!--l. 3049--><p class="indent" > Note that you can also specify the language and encoding using the package option +<!--l. 3542--><p class="nopar" > +</p><!--l. 3544--><p class="indent" > Note that you can also specify the language and encoding using the package option <span class="obeylines-h"><span class="verb"><span class="ectt-1000">xindy={language=</span></span></span><span class="cmsy-10">⟨</span><span @@ -7077,122 +8525,307 @@ class="ectt-1000">}</span></span></span>. For example: </p> - <div class="verbatim" id="verbatim-82"> + <div class="verbatim" id="verbatim-96"> \usepackage[xindy={language=english,codepage=utf8}]{glossaries} </div> -<!--l. 3055--><p class="nopar" > -</p><!--l. 3057--><p class="indent" > If you write your own custom <span +<!--l. 3550--><p class="nopar" > +</p><!--l. 3552--><p class="indent" > If you write your own custom <a + id="dx1-35014"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-30010"></a> style file that includes the language settings, + id="dx1-35015"></a></a> style file that includes the language settings, you need to set the language to nothing: </p> - <div class="verbatim" id="verbatim-83"> + <div class="verbatim" id="verbatim-97"> \GlsSetXdyLanguage{} </div> -<!--l. 3062--><p class="nopar" > (and remember to use <span +<!--l. 3557--><p class="nopar" > (and remember to use <span class="ectt-1000">\noist</span><a - id="dx1-30011"></a> to prevent the style file from being overwritten). -</p><!--l. 3066--><p class="indent" > <div class="important" title="Important Note"> The commands <span + id="dx1-35016"></a> to prevent the style file from being overwritten). +</p><!--l. 3561--><p class="indent" > <div class="important" title="Important Note"> The commands <span class="ectt-1000">\GlsSetXdyLanguage </span>and <span class="ectt-1000">\GlsSetXdyCodePage </span>have no effect if -you don’t use <span +you don’t use <a + id="dx1-35017"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-30012"></a>. If you call <span + id="dx1-35018"></a></a>. If you call <a + id="dx1-35019"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-30013"></a> without <span + id="dx1-35020"></a></a> without <a + id="dx1-35021"></a><span class="ectt-1000">makeglossaries</span><a - id="dx1-30014"></a> you need to + id="dx1-35022"></a> you need to remember to set the language and encoding using the <span class="ectt-1000">-L </span>and <span class="ectt-1000">-C </span>switches. </div> -</p><!--l. 3072--><p class="noindent" > +</p><!--l. 3567--><p class="noindent" > +</p><!--l. 3570--><p class="noindent" > </p> -<!--l. 3075--><p class="noindent" ><a -href="#top">Top</a> -</p><!--l. 3075--><p class="noindent" ><span class="paragraphHead"><a - id="x1-310002.8.2"></a><span -class="ecbx-1000">Locations and Number lists</span></span> - The most likely attributes used in the <span +<!--l. 3570--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">11.2 </span> <a + id="x1-3600011.2"></a>Locations and Number lists</h4> +<!--l. 3573--><p class="noindent" >If you use <span +class="ecss-1000">xindy</span><a + id="dx1-36001"></a>, the <span +class="ecss-1000">glossaries </span>package needs to know which counters you will be using +in the <a + id="dx1-36002"></a><a +href="#glo:numberlist">number list<a + id="dx1-36003"></a></a> in order to correctly format the <a + id="dx1-36004"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-36005"></a></a> style file. Counters specified +using the <span +class="ecss-1000">counter</span><a + id="dx1-36006"></a> package option or the <span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩ </span>option of <span +class="ectt-1000">\newglossary</span><a + id="dx1-36007"></a> are +automatically taken care of, but if you plan to use a different counter in the <span +class="ecss-1000">counter</span><a + id="dx1-36008"></a> key +for commands like <span +class="ectt-1000">\glslink</span><a + id="dx1-36009"></a>, then you need to identify these counters <span +class="ecti-1000">before</span> +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-36010"></a> using: +</p><!--l. 3581--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsAddXdyCounters</span><span +class="ectt-0900"> </span></span><a + id="dx1-36011"></a> <span +class="ectt-1000">\GlsAddXdyCounters{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3583--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter list</span><span +class="cmsy-10">⟩ </span>is a comma-separated list of counter names. +</p><!--l. 3586--><p class="indent" > The most likely attributes used in the <span class="ecss-1000">format</span><a - id="dx1-31001"></a> key (<span + id="dx1-36012"></a> key (<span class="ectt-1000">textrm</span><a - id="dx1-31002"></a>, <span + id="dx1-36013"></a>, <span class="ectt-1000">hyperrm</span><a - id="dx1-31003"></a> etc) are -automatically added to the <span + id="dx1-36014"></a> etc) are +automatically added to the <a + id="dx1-36015"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-31004"></a> style file, but if you want to use another attribute, + id="dx1-36016"></a></a> style file, but if you want to use another attribute, you need to add it using: -</p><!--l. 3081--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3590--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GlsAddXdyAttribute</span><span class="ectt-0900"> </span></span><a - id="dx1-31005"></a> <span + id="dx1-36017"></a> <span class="ectt-1000">\GlsAddXdyAttribute{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3083--><p class="noindent" > +</p><!--l. 3592--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩ </span>is the name of the attribute, as used in the <span class="ecss-1000">format</span><a - id="dx1-31006"></a> key. For example, + id="dx1-36018"></a> key. For example, suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this: </p> - <div class="verbatim" id="verbatim-84"> + <div class="verbatim" id="verbatim-98"> \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} </div> -<!--l. 3090--><p class="nopar" > but with <span +<!--l. 3599--><p class="nopar" > but with <a + id="dx1-36019"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-31007"></a>, I also need to add this as an allowed attribute: + id="dx1-36020"></a></a>, I also need to add this as an allowed attribute: </p> - <div class="verbatim" id="verbatim-85"> + <div class="verbatim" id="verbatim-99"> \GlsAddXdyAttribute{hyperbfit} </div> -<!--l. 3095--><p class="nopar" > -</p><!--l. 3097--><p class="indent" > <div class="important" title="Important Note"> Note that <span +<!--l. 3604--><p class="nopar" > +</p><!--l. 3606--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="ectt-1000">\GlsAddXdyAttribute </span>has no effect if <span class="ectt-1000">\noist</span><a - id="dx1-31008"></a> is used or if + id="dx1-36021"></a> is used or if <span class="ectt-1000">\makeglossaries</span><a - id="dx1-31009"></a> is omitted. -</p><!--l. 3101--><p class="indent" > <span -class="ectt-1000">\GlsAddXdyAttribute </span>must be used before <span + id="dx1-36022"></a> is omitted. <span +class="ectt-1000">\GlsAddXdyAttribute </span>must be used before +<span class="ectt-1000">\makeglossaries</span><a - id="dx1-31010"></a>. </div> -</p><!--l. 3102--><p class="noindent" > -</p><!--l. 3104--><p class="indent" > If the location numbers don’t get expanded to a simple Arabic or Roman number or + id="dx1-36023"></a>. Additionally, <span +class="ectt-1000">\GlsAddXdyCounters </span>must come before +<span +class="ectt-1000">\GlsAddXdyAttribute</span>. </div> +</p><!--l. 3612--><p class="noindent" > +</p><!--l. 3614--><p class="indent" > If the location numbers don’t get expanded to a simple Arabic or Roman number or a letter from a, …, z or A, …, Z, then you need to add a location style in the appropriate -format. -</p><!--l. 3108--><p class="indent" > For example, suppose you want the page numbers written as words rather than +format using +</p><!--l. 3617--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsAddXdyLocation</span><span +class="ectt-0900"> </span></span><a + id="dx1-36024"></a> <span +class="ectt-1000">\GlsAddXdyLocation[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">prefix-location</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">definition</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</div><hr> +</p><!--l. 3619--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the name of the format and <span +class="cmsy-10">⟨</span><span +class="ecti-1000">definition</span><span +class="cmsy-10">⟩ </span>is the <a + id="dx1-36025"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-36026"></a></a> definition. The +optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">prefix-location</span><span +class="cmsy-10">⟩ </span>is needed if <span +class="ectt-1000">\theH</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩ </span>either isn’t defined or is +different from <span +class="ectt-1000">\the</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩</span>. +</p><!--l. 3625--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsAddXdyLocation </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-36027"></a> is used or +if <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-36028"></a> is omitted. <span +class="ectt-1000">\GlsAddXdyLocation </span>must be used before +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-36029"></a>. </div> +</p><!--l. 3629--><p class="noindent" > +</p><!--l. 3631--><p class="indent" > For example, suppose I decide to use a somewhat eccentric numbering system for +sections that redefines <span +class="ectt-1000">\thesection </span>as follows: + + + +</p> + <div class="verbatim" id="verbatim-100"> +\renewcommand*{\thesection}{[\thechapter]\arabic{section}} +</div> +<!--l. 3635--><p class="nopar" > If I haven’t done <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">counter=section</span></span></span> in the package option, I need to specify that the +counter will be used as a location number: + + + +</p> + <div class="verbatim" id="verbatim-101"> +\GlsAddXdyCounters{section} +</div> +<!--l. 3641--><p class="nopar" > Next I need to add the location style (<span +class="ectt-1000">\thechapter </span>is assumed to be the standard +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\arabic{chapter}</span></span></span>): + + + +</p> + <div class="verbatim" id="verbatim-102"> +\GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]" + <br />  "arabic-numbers" + <br />} +</div> +<!--l. 3648--><p class="nopar" > Note that if I have further decided to use the <span +class="ecss-1000">hyperref</span><a + id="dx1-36030"></a> package and want to redefine +<span +class="ectt-1000">\theHsection </span>as: + + + +</p> + <div class="verbatim" id="verbatim-103"> +\renewcommand*{\theHsection}{\thepart.\thesection} + <br />\renewcommand*{\thepart}{\Roman{part}} +</div> +<!--l. 3654--><p class="nopar" > then I need to modify the <span +class="ectt-1000">\GlsAddXdyLocation </span>code above to: + + + +</p> + <div class="verbatim" id="verbatim-104"> +\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "[" + <br />  "arabic-numbers" :sep "]" "arabic-numbers" + <br />} +</div> +<!--l. 3660--><p class="nopar" > Since <span +class="ectt-1000">\Roman</span><a + id="dx1-36031"></a> will result in an empty string if the counter is zero, it’s a good idea to +add an extra location to catch this: + + + +</p> + <div class="verbatim" id="verbatim-105"> +\GlsAddXdyLocation{zero.section}{:sep "[" + <br />  "arabic-numbers" :sep "]" "arabic-numbers" + <br />} +</div> +<!--l. 3667--><p class="nopar" > The above example is illustrated in the accompanying sample file <a +href="#x1-40001.1"><span +class="ectt-1000">samplexdy2.tex</span></a>. +</p><!--l. 3671--><p class="indent" > Another example: suppose you want the page numbers written as words rather than digits and you use the <span class="ecss-1000">fmtcount</span><a - id="dx1-31011"></a> package to do this. You can redefine <span + id="dx1-36032"></a> package to do this. You can redefine <span class="ectt-1000">\thepage</span><a - id="dx1-31012"></a> as + id="dx1-36033"></a> as follows: </p> - <div class="verbatim" id="verbatim-86"> + <div class="verbatim" id="verbatim-106"> \renewcommand*{\thepage}{\Numberstring{page}} </div> -<!--l. 3113--><p class="nopar" > This gets expanded to <span class="obeylines-h"><span class="verb"><span +<!--l. 3676--><p class="nopar" > This gets expanded to <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\protect</span><span class="ectt-1000"> \Numberstringnum</span><span class="ectt-1000"> </span></span></span><span @@ -7210,40 +8843,130 @@ form: </p> - <div class="verbatim" id="verbatim-87"> + <div class="verbatim" id="verbatim-107"> \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space  <br />  \string\Numberstringnum\space\glsopenbrace"  <br />  "arabic-numbers" :sep "\glsclosebrace"} </div> -<!--l. 3121--><p class="nopar" > Note that it’s necessary to use <span +<!--l. 3684--><p class="nopar" > Note that it’s necessary to use <span class="ectt-1000">\space </span>to indicate that spaces also appear in the format, since, unlike <span class="TEX">T<span -class="E">E</span>X</span>, <span +class="E">E</span>X</span>, <a + id="dx1-36034"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-31013"></a> doesn’t ignore spaces after control + id="dx1-36035"></a></a> doesn’t ignore spaces after control sequences. -</p><!--l. 3126--><p class="indent" > <div class="important" title="Important Note"> Note that <span -class="ectt-1000">\GlsAddXdyLocation </span>has no effect if <span -class="ectt-1000">\noist</span><a - id="dx1-31014"></a> is used or if <span -class="ectt-1000">\makeglossaries</span><a - id="dx1-31015"></a> -is omitted. -</p><!--l. 3130--><p class="indent" > <span -class="ectt-1000">\GlsAddXdyLocation </span>must be used before <span -class="ectt-1000">\makeglossaries</span><a - id="dx1-31016"></a>. </div> -</p><!--l. 3131--><p class="noindent" > -</p><!--l. 3133--><p class="indent" > In the number list<a - id="dx1-31017"></a>, the locations are sorted according to type. The default ordering is: +</p><!--l. 3689--><p class="indent" > <span +class="ectt-1000">\GlsAddXdyLocation{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">definition</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>will define commands +</p><!--l. 3691--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1000">\glsX</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">X</span></span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">Hprefix</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">location</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3692--><p class="noindent" > +for each counter that has been identified either by the <span +class="ecss-1000">counter</span><a + id="dx1-36036"></a> package option, the +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩ </span>option for <span +class="ectt-1000">\newglossary</span><a + id="dx1-36037"></a> or in the argument of <span +class="ectt-1000">\GlsAddXdyCounters</span><a + id="dx1-36038"></a>. +</p><!--l. 3697--><p class="indent" > The first argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">Hprefix</span><span +class="cmsy-10">⟩ </span>is only relevant when used with the <span +class="ecss-1000">hyperref</span><a + id="dx1-36039"></a> package +and indicates that <span +class="ectt-1000">\the</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">Hcounter</span><span +class="cmsy-10">⟩ </span>is given by <span +class="ectt-1000">\Hprefix</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">.</span></span></span><span +class="ectt-1000">\the</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩</span>. The sample +file <a +href="#x1-40001.1"><span +class="ectt-1000">samplexdy.tex</span></a>, which comes with the <span +class="ecss-1000">glossaries </span>package, uses the default <span +class="ecss-1000">page</span><a + id="dx1-36040"></a> +counter for locations, and it uses the default <span +class="ectt-1000">\glsnumberformat</span><a + id="dx1-36041"></a> and a custom +<span +class="ectt-1000">\hyperbfit </span>format. A new <a + id="dx1-36042"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-36043"></a></a> location called <span +class="ectt-1000">Numberstring</span>, as illustrated above, is +defined to make the page numbers appear as “One”, “Two”, etc. In order for the location +numbers to hyperlink to the relevant pages, I need to redefine the necessary +<span +class="ectt-1000">\glsX</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">X</span></span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">format</span><span +class="cmsy-10">⟩ </span>commands: + + + +</p> + <div class="verbatim" id="verbatim-108"> +\renewcommand{\glsXpageXglsnumberformat}[2]{% + <br /> \linkpagenumber#2% + <br />} + <br />\renewcommand{\glsXpageXhyperbfit}[2]{% + <br /> \textbf{\em\linkpagenumber#2}% + <br />} + <br />\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} +</div> +<!--l. 3718--><p class="nopar" > +</p><!--l. 3720--><p class="indent" > In the <a + id="dx1-36044"></a><a +href="#glo:numberlist">number list<a + id="dx1-36045"></a></a>, the locations are sorted according to type. The default ordering is: <span class="ectt-1000">roman-page-numbers </span>(e.g. i), <span class="ectt-1000">arabic-page-numbers </span>(e.g. 1), <span class="ectt-1000">arabic-section-numbers</span> (e.g. 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen<span class="footnote-mark"><a -href="#fn7x0" id="fn7x0-bk"><sup class="textsuperscript">7</sup></a></span><a - id="x1-31018f7"></a>), +href="#fn14x0" id="fn14x0-bk"><sup class="textsuperscript">14</sup></a></span><a + id="x1-36046f14"></a>), <span class="ectt-1000">alpha-page-numbers </span>(e.g. a), <span class="ectt-1000">Roman-page-numbers </span>(e.g. I), @@ -7252,33 +8975,32 @@ class="ectt-1000">Alpha-page-numbers </span>(e.g. A), <span class="ectt-1000">Appendix-page-numbers </span>(e.g. A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen<span class="footnote-mark"><a -href="#fn8x0" id="fn8x0-bk"><sup class="textsuperscript">8</sup></a></span><a - id="x1-31020f8"></a>), +href="#fn15x0" id="fn15x0-bk"><sup class="textsuperscript">15</sup></a></span><a + id="x1-36048f15"></a>), user defined location names (as specified by <span class="ectt-1000">\GlsAddXdyLocation</span><a - id="dx1-31022"></a> in the order in which + id="dx1-36050"></a> in the order in which they were defined), <span class="ectt-1000">see </span>(cross-referenced entries). This ordering can be changed using: -</p><!--l. 3148--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3736--><p class="indent" > <span class="marginpar"><span class="ectt-0900">\GlsSetXdyLocationClassOrder</span><span class="ectt-0900"> </span></span><a - id="dx1-31023"></a> <span + id="dx1-36051"></a> +</p><!--l. 3738--><p class="indent" > <hr><div title="Definition"><span class="ectt-1000">\GlsSetXdyLocationClassOrder{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">location</span> -<span -class="ecti-1000">names</span><span +class="ecti-1000">location names</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3150--><p class="noindent" > +</p><!--l. 3739--><p class="noindent" > where each location name is delimited by double quote marks and separated by white space. For example: </p> - <div class="verbatim" id="verbatim-88"> + <div class="verbatim" id="verbatim-109"> \GlsSetXdyLocationClassOrder{  <br />  "arabic-page-numbers"  <br />  "arabic-section-numbers" @@ -7290,116 +9012,168 @@ space. For example:  <br />  "see"  <br />} </div> -<!--l. 3164--><p class="nopar" > -</p><!--l. 3166--><p class="indent" > <div class="important" title="Important Note"> Note that <span -class="ectt-1000">\GlsSetXdyLocationClassOrder </span>has no effect if <span +<!--l. 3753--><p class="nopar" > +</p><!--l. 3755--><p class="indent" > +<div class="important" title="Important Note">Note +that +<span +class="ectt-1000">\GlsSetXdyLocationClassOrder</span> +has +no +effect +if +<span class="ectt-1000">\noist</span><a - id="dx1-31024"></a> is used or if + id="dx1-36052"></a> +is +used +or +if <span class="ectt-1000">\makeglossaries</span><a - id="dx1-31025"></a> is omitted. -</p><!--l. 3170--><p class="indent" > <span -class="ectt-1000">\GlsSetXdyLocationClassOrder </span>must be used before <span + id="dx1-36053"></a> +is +omitted. +<span +class="ectt-1000">\GlsSetXdyLocationClassOrder</span> +must +be +used +before +<span class="ectt-1000">\makeglossaries</span><a - id="dx1-31026"></a>. + id="dx1-36054"></a>. </div> -</p><!--l. 3172--><p class="noindent" > -</p><!--l. 3174--><p class="indent" > If a number list<a - id="dx1-31027"></a> consists of a sequence of consecutive numbers, the range will be +</p><!--l. 3760--><p class="noindent" > +</p><!--l. 3762--><p class="indent" > If a <a + id="dx1-36055"></a><a +href="#glo:numberlist">number list<a + id="dx1-36056"></a></a> consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: -</p><!--l. 3178--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3766--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\GlsSetXdyMinRangeLength</span><span class="ectt-0900"> </span></span><a - id="dx1-31028"></a> <span + id="dx1-36057"></a> <span class="ectt-1000">\GlsSetXdyMinRangeLength{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">n</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3180--><p class="noindent" > + + + +</p><!--l. 3768--><p class="noindent" > For example: </p> - <div class="verbatim" id="verbatim-89"> + <div class="verbatim" id="verbatim-110"> \GlsSetXdyMinRangeLength{3} </div> -<!--l. 3184--><p class="nopar" > The argument may also be the keyword <span +<!--l. 3772--><p class="nopar" > The argument may also be the keyword <span class="ectt-1000">none</span>, to indicate that there should -be no range formations. See the <span +be no range formations. See the <a + id="dx1-36058"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-31029"></a> manual for further details on range + id="dx1-36059"></a></a> manual for further details on range formations. -</p><!--l. 3189--><p class="indent" > <div class="important" title="Important Note"> Note that <span +</p><!--l. 3777--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="ectt-1000">\GlsSetXdyMinRangeLength </span>has no effect if <span class="ectt-1000">\noist</span><a - id="dx1-31030"></a> is used or if + id="dx1-36060"></a> is used or if <span class="ectt-1000">\makeglossaries</span><a - id="dx1-31031"></a> is omitted. -</p><!--l. 3193--><p class="indent" > <span -class="ectt-1000">\GlsSetXdyMinRangeLength </span>must be used before <span + id="dx1-36061"></a> is omitted. <span +class="ectt-1000">\GlsSetXdyMinRangeLength </span>must be used before +<span class="ectt-1000">\makeglossaries</span><a - id="dx1-31032"></a>. </div> -</p><!--l. 3195--><p class="noindent" > -</p><!--l. 3197--><p class="indent" > See <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further details. -</p> -<!--l. 3200--><p class="noindent" ><a -href="#top">Top</a> -</p><!--l. 3200--><p class="noindent" ><span class="paragraphHead"><a - id="x1-320002.8.2"></a><span -class="ecbx-1000">Glossary Groups</span></span> - The glossary is divided into groups according to the first letter of the sort key. The + id="dx1-36062"></a>. </div> +</p><!--l. 3782--><p class="noindent" > +</p><!--l. 3784--><p class="indent" > See <a +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further details. +</p><!--l. 3787--><p class="noindent" > +</p> +<!--l. 3787--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">11.3 </span> <a + id="x1-3700011.3"></a>Glossary Groups</h4> +<!--l. 3789--><p class="noindent" >The glossary is divided into groups according to the first letter of the sort key. The <span class="ecss-1000">glossaries </span>package also adds a number group by default, unless you suppress it in the <span class="ecss-1000">xindy</span><a - id="dx1-32001"></a> package option. For example: + id="dx1-37001"></a> package option. For example: </p> - <div class="verbatim" id="verbatim-90"> + <div class="verbatim" id="verbatim-111"> \usepackage[xindy={glsnumbers=false}]{glossaries} </div> -<!--l. 3207--><p class="nopar" > Any entry that doesn’t go in one of the letter groups or the number group is placed in +<!--l. 3795--><p class="nopar" > Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group. -</p><!--l. 3211--><p class="indent" > If you have a number group, the default behaviour is to locate it before the “A” +</p><!--l. 3799--><p class="indent" > If you have a number group, the default behaviour is to locate it before the “A” letter group. If you are not using a Roman alphabet, you can change this -using<br -class="newline" /> <span +using: +</p><!--l. 3803--><p class="indent" > <span class="marginpar"><span +class="ectt-0900">\GlsSetXdyFirstLetterAfterDigits</span><span +class="ectt-0900"> </span></span><a + id="dx1-37002"></a> +</p><!--l. 3805--><p class="indent" > <hr><div title="Definition"><span class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">letter</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}</span> -</p><!--l. 3216--><p class="indent" > <div class="important" title="Important Note"> Note that <span -class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits </span>has no effect if <span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3806--><p class="noindent" > +</p><!--l. 3808--><p class="indent" > +<div class="important" title="Important Note">Note +that +<span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits</span> +has +no +effect +if +<span class="ectt-1000">\noist</span><a - id="dx1-32002"></a> is used or -if <span + id="dx1-37003"></a> +is +used +or +if +<span class="ectt-1000">\makeglossaries</span><a - id="dx1-32003"></a> is omitted. -</p><!--l. 3220--><p class="indent" > <span -class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits </span>must be used before <span + id="dx1-37004"></a> +is +omitted. +<span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits</span> +must +be +used +before +<span class="ectt-1000">\makeglossaries</span><a - id="dx1-32004"></a>. + id="dx1-37005"></a>. </div> -</p><!--l. 3222--><p class="noindent" > -</p><!--l. 3225--><p class="noindent" > +</p><!--l. 3813--><p class="noindent" > +</p><!--l. 3816--><p class="noindent" > </p> -<!--l. 3225--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.9 </span> <a - id="x1-330002.9"></a>Defining New Glossaries</h4> -<!--l. 3228--><p class="noindent" >A new glossary can be defined using: -</p><!--l. 3229--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + + + +<!--l. 3816--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">12 </span> <a + id="x1-3800012"></a>Defining New Glossaries</h3> +<!--l. 3819--><p class="noindent" >A new glossary can be defined using: +</p><!--l. 3820--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\newglossary</span><span class="ectt-0900"> </span></span><a - id="dx1-33001"></a> <span + id="dx1-38001"></a> <span class="ectt-1000">\newglossary[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">log-ext</span><span @@ -7426,102 +9200,111 @@ class="ecti-1000">counter</span><span class="cmsy-10">⟩</span><span class="ectt-1000">]</span> </div><hr> -</p><!--l. 3231--><p class="noindent" > +</p><!--l. 3822--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩ </span>is the label to assign to this glossary. The arguments <span class="cmsy-10">⟨</span><span class="ecti-1000">in-ext</span><span -class="cmsy-10">⟩ </span>and -<span +class="cmsy-10">⟩</span> +and <span class="cmsy-10">⟨</span><span class="ecti-1000">out-ext</span><span -class="cmsy-10">⟩ </span>specify the extensions to give to the input and output files for that -glossary, <span +class="cmsy-10">⟩ </span>specify the extensions to give to the input and output files for +that glossary, <span class="cmsy-10">⟨</span><span class="ecti-1000">title</span><span -class="cmsy-10">⟩ </span>is the default title for this new glossary and the final optional -argument <span +class="cmsy-10">⟩ </span>is the default title for this new glossary and the final +optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">counter</span><span -class="cmsy-10">⟩ </span>specifies which counter to use for the associated number -lists<a - id="dx1-33002"></a> (see also <a -href="#x1-200002.3">2.3 </a><a -href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>). The first optional argument specifies the -extension for the <span +class="cmsy-10">⟩ </span>specifies which counter to use for the associated +<a + id="dx1-38002"></a><a +href="#glo:numberlist">number list<a + id="dx1-38003"></a>s</a> (see also <a +href="#x1-250005">5 </a><a +href="#x1-250005">Number lists<!--tex4ht:ref: sec:numberlists --></a>). The first optional argument specifies the +extension for the <a + id="dx1-38004"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-33003"></a> or <span + id="dx1-38005"></a></a> or <a + id="dx1-38006"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-33004"></a> transcript file (this information is only -used by <span + id="dx1-38007"></a></a> transcript file (this information is only +used by <a + id="dx1-38008"></a><a +href="#glo:makeglossaries"><span class="ectt-1000">makeglossaries</span><a - id="dx1-33005"></a> which picks up the information from the auxiliary + id="dx1-38009"></a></a> which picks up the information from the auxiliary file). -</p><!--l. 3243--><p class="indent" > Note that the main (default) glossary is automatically created as: +</p><!--l. 3834--><p class="indent" > Note that the main (default) glossary is automatically created as: </p> - <div class="verbatim" id="verbatim-91"> + <div class="verbatim" id="verbatim-112"> \newglossary{main}{gls}{glo}{\glossaryname} </div> -<!--l. 3246--><p class="nopar" > so it can be identified by the label <span +<!--l. 3837--><p class="nopar" > so it can be identified by the label <span class="ectt-1000">main </span>(unless the <span class="ecss-1000">nomain</span><a - id="dx1-33006"></a> package option is used). + id="dx1-38010"></a> package option is used). Using the <span class="ecss-1000">acronym</span><a - id="dx1-33007"></a> package option is equivalent to: + id="dx1-38011"></a> package option is equivalent to: </p> - <div class="verbatim" id="verbatim-92"> + <div class="verbatim" id="verbatim-113"> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </div> -<!--l. 3252--><p class="nopar" > so it can be identified by the label <span +<!--l. 3843--><p class="nopar" > so it can be identified by the label <span class="ectt-1000">acronym</span>. If you are not sure whether the <span class="ecss-1000">acronym</span><a - id="dx1-33008"></a> + id="dx1-38012"></a> option has been used, you can identify the list of acronyms by the command <span class="marginpar"><span class="ectt-0900">\acronymtype</span><span class="ectt-0900"> </span></span><a - id="dx1-33009"></a><span + id="dx1-38013"></a><span class="ectt-1000">\acronymtype </span>which is set to <span class="ectt-1000">acronym</span>, if the <span class="ecss-1000">acronym</span><a - id="dx1-33010"></a> option has been + id="dx1-38014"></a> option has been used, otherwise it is set to <span class="ectt-1000">main</span>. Note that if you are using the main glossary as your list of acronyms, you need to declare it as a list of acronyms using the package option <span class="ecss-1000">acronymlists</span><a - id="dx1-33011"></a>. -</p><!--l. 3263--><p class="indent" > <div class="important" title="Important Note"> All glossaries must be defined before <span + id="dx1-38015"></a>. +</p><!--l. 3854--><p class="indent" > <div class="important" title="Important Note"> All glossaries must be defined before <span class="ectt-1000">\makeglossaries</span><a - id="dx1-33012"></a> to ensure that the relevant + id="dx1-38016"></a> to ensure that the relevant output files are opened. </div> -</p><!--l. 3266--><p class="noindent" > -</p><!--l. 3269--><p class="noindent" > +</p><!--l. 3857--><p class="noindent" > +</p><!--l. 3860--><p class="noindent" > </p> -<!--l. 3269--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.10 </span> <a - id="x1-340002.10"></a>Acronyms</h4> -<!--l. 3272--><p class="noindent" >You may have noticed in <a -href="#x1-140002.2">2.2 </a><a -href="#x1-140002.2">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that when you specify a new -entry, you can specify alternate text to use when the term is first used<a - id="dx1-34001"></a> in the document. +<!--l. 3860--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">13 </span> <a + id="x1-3900013"></a>Acronyms</h3> +<!--l. 3863--><p class="noindent" >You may have noticed in <a +href="#x1-190004">4 </a><a +href="#x1-190004">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that when you specify a new +entry, you can specify alternate text to use when the term is <a + id="dx1-39001"></a><a +href="#glo:firstuse">first used</a> in the document. This provides a useful means to define acronyms. For convenience, the <span class="ecss-1000">glossaries </span>package defines the command: -</p><!--l. 3277--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3868--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\newacronym</span><span class="ectt-0900"> </span></span><a - id="dx1-34002"></a> <span + id="dx1-39002"></a> <span class="ectt-1000">\newacronym[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">key-val list</span><span @@ -7539,94 +9322,212 @@ class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3280--><p class="noindent" > -By default, this is equivalent to: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="ectt-1000">\newglossaryentry{</span><span +</p><!--l. 3871--><p class="noindent" > +</p><!--l. 3873--><p class="indent" > This uses <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-39003"></a> to create an entry with the given label in the glossary +given by <span +class="ectt-1000">\acronymtype</span><a + id="dx1-39004"></a>. Amongst other things, it sets up the <span +class="ecss-1000">first</span><a + id="dx1-39005"></a> and <span +class="ecss-1000">text</span><a + id="dx1-39006"></a> keys and, +depending on the acronym style, may also use <span +class="ectt-1000">\defdisplayfirst</span><a + id="dx1-39007"></a> and <span +class="ectt-1000">\defdisplay</span><a + id="dx1-39008"></a> +(see <a +href="#x1-270006.1">6.1 </a><a +href="#x1-270006.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). +</p><!--l. 3879--><p class="indent" > The optional argument <span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span +class="ecti-1000">key-val list</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}{type=\acronymtype</span><a - id="dx1-34003"></a><span -class="ectt-1000">,</span> - <br /><span -class="ectt-1000">name={</span><span +class="ectt-1000">} </span>allows you to specify keys such as <span +class="ecss-1000">description</span><a + id="dx1-39009"></a> +(when used with the <span +class="ecss-1000">description</span><a + id="dx1-39010"></a> package option, described below) or you can override +plural forms of <span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">},</span> - <br /><span -class="ectt-1000">description={</span><span +class="cmsy-10">⟩ </span>or <span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">},</span> - <br /><span -class="ectt-1000">text={</span><span +class="cmsy-10">⟩ </span>using the <span +class="ecss-1000">shortplural</span><a + id="dx1-39011"></a> or <span +class="ecss-1000">longplural</span><a + id="dx1-39012"></a> keys. For +example: + + + +</p> + <div class="verbatim" id="verbatim-114"> +\newacronym[longplural={diagonal matrices}]{dm}{DM}{diagonal + <br />matrix} +</div> +<!--l. 3888--><p class="nopar" > If the <a + id="dx1-39013"></a><a +href="#glo:firstuse">first use</a> uses the plural form, <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspl{dm}</span></span></span> will display: diagonal matrices +(DMs). +</p><!--l. 3893--><p class="indent" > The following package options are available to change the acronym style: +</p><!--l. 3896--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">description</span><a + id="dx1-39014"></a> </dt><dd +class="description">With this package option, the <span +class="ecss-1000">description</span><a + id="dx1-39015"></a> key needs to be set in the + optional argument <span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">},</span> - <br /><span -class="ectt-1000">first={</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩ </span>of <span +class="ectt-1000">\newacronym</span>. (If this package option isn’t + used, the long form <span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span><span -class="ectt-1000">(</span><span +class="cmsy-10">⟩ </span>is put in the <span +class="ecss-1000">description</span><a + id="dx1-39016"></a> key.) + </dd><dt class="description"> +<span +class="ecsx-1000">footnote</span><a + id="dx1-39017"></a> </dt><dd +class="description">With this package option, on <a + id="dx1-39018"></a><a +href="#glo:firstuse">first use</a> the long form <span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">)},</span> - <br /><span -class="ectt-1000">plural={</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span>is placed in a + footnote. By default the long form in the footnote will link to the relevant + entry in the glossary or list of acronyms. You can prevent this link by + doing: + + + + <div class="verbatim" id="verbatim-115"> + \let\acrfootnote\acrnolinkfootnote +</div> + <!--l. 3910--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">smallcaps</span><a + id="dx1-39019"></a> </dt><dd +class="description">With this package option, the short form <span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">\glspluralsuffix},</span> - <br /><span -class="ectt-1000">firstplural={</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">\glspluralsuffix\space (</span><span +class="cmsy-10">⟩ </span>is typeset using + <span +class="ectt-1000">\textsc</span><a + id="dx1-39020"></a>. (Recall that <span +class="ectt-1000">\textsc </span>converts lower case characters into small + capitals and leaves upper case characters as they are. Therefore, you + need to have lower case characters in <span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">\glspluralsuffix)},</span> - <br /><span +class="cmsy-10">⟩ </span>for this option to have an + effect.) + </dd><dt class="description"> +<span +class="ecsx-1000">smaller</span><a + id="dx1-39021"></a> </dt><dd +class="description">This is similar to <span +class="ecss-1000">smallcaps</span><a + id="dx1-39022"></a>, except that <span +class="ectt-1000">\textsmaller</span><a + id="dx1-39023"></a> is used instead of + <span +class="ectt-1000">\textsc</span><a + id="dx1-39024"></a>. Note that the <span +class="ecss-1000">glossaries </span>package doesn’t define <span +class="ectt-1000">\textsmaller</span><a + id="dx1-39025"></a> nor does it + load any package that does so. If you use this option, you must make sure + <span +class="ectt-1000">\textsmaller</span><a + id="dx1-39026"></a> is defined (for example by loading <span +class="ecss-1000">relsize</span><a + id="dx1-39027"></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">dua</span><a + id="dx1-39028"></a> </dt><dd +class="description">This option will set both the <span +class="ecss-1000">first</span><a + id="dx1-39029"></a> and <span +class="ecss-1000">text</span><a + id="dx1-39030"></a> keys to the long form <span class="cmsy-10">⟨</span><span -class="ecti-1000">key-val list</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}</span> - <br /><spacer type=vertical size=10></span> -As mentioned in the previous section, the command <span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span>.</dd></dl> +<!--l. 3931--><p class="indent" > If you want to define your own custom acronym style, see <a +href="#x1-4200013.3">13.3 </a><a +href="#x1-4200013.3">Defining A Custom +Acronym Style<!--tex4ht:ref: sec:customacronym --></a>. +</p><!--l. 3934--><p class="indent" > <div class="important" title="Important Note"> If you try using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-39031"></a> for entries in a designated list of acronyms in +combination with any of the above named package options you are likely to get +unexpected results such as empty brackets or empty footnotes. +</p><!--l. 3940--><p class="indent" > If you don’t intend to use <span +class="ectt-1000">\newacronym</span><a + id="dx1-39032"></a> you should skip this section] and not use the +above package options. </div> +</p><!--l. 3942--><p class="noindent" > +</p><!--l. 3944--><p class="indent" > As mentioned in <a +href="#x1-140002.2">2.2 </a><a +href="#x1-140002.2">Sectioning and TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>, the command <span class="ectt-1000">\acronymtype</span><a - id="dx1-34004"></a> is the name of the -glossary in which the acronyms should appear. If the <span + id="dx1-39033"></a> is +the name of the glossary in which the acronyms should appear. If the <span class="ecss-1000">acronym</span><a - id="dx1-34005"></a> package option has been -used, this will be <span + id="dx1-39034"></a> package +option has been used, this will be <span class="ectt-1000">acronym</span>, otherwise it will be <span -class="ectt-1000">main</span>. The acronyms can then be used in -exactly the same way as any other glossary entry. If you want more than one list of -acronyms, you must identify the others using the package options <span +class="ectt-1000">main</span>. The acronyms can +then be used in exactly the same way as any other glossary entry. If you want more +than one list of acronyms, you must identify the others using the package options +<span class="ecss-1000">acronymlists</span><a - id="dx1-34006"></a>. This -ensures that options such as <span + id="dx1-39035"></a>. This ensures that options such as <span class="ecss-1000">footnote</span><a - id="dx1-34007"></a> and <span + id="dx1-39036"></a> and <span class="ecss-1000">smallcaps</span><a - id="dx1-34008"></a> work for the additional lists of -acronyms. + id="dx1-39037"></a> work for the +additional lists of acronyms. +</p><!--l. 3954--><p class="indent" > +<div class="important" title="Important Note">Since +<span +class="ectt-1000">\newacronym</span> +sets +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">type=\acronymtype</span></span></span>, +if -</p><!--l. 3302--><p class="indent" > <div class="important" title="Important Note"><span -class="ecbx-1000">Note: </span>since <span -class="ectt-1000">\newacronym </span>sets <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">type=\acronymtype</span></span></span>, if you want to load a file -containing acronym definitions using <span -class="ectt-1000">\loadglsentries[</span><span +you +want +to +load +a +file +containing +acronym +definitions +using +<span +class="ectt-1000">\loadglsentries</span><a + id="dx1-39038"></a><span +class="ectt-1000">[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span class="cmsy-10">⟩</span><span @@ -7634,123 +9535,131 @@ class="ectt-1000">]{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">filename</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}</span>, the -optional argument <span +class="ectt-1000">}</span>, +the +optional +argument +<span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span -class="cmsy-10">⟩ </span>will not have an effect unless you explicitly set the type as +class="cmsy-10">⟩</span> +will +not +have +an +effect +unless +you +explicitly +set +the +type +as <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">type=\glsdefaulttype</span></span></span> in the optional argument to <span +class="ectt-1000">type=\glsdefaulttype</span></span></span> +in +the +optional +argument +to +<span +class="ectt-1000">\newacronym</span><a + id="dx1-39039"></a>. +See +<a +href="#x1-240004.3">4.3 +</a><a +href="#x1-240004.3">Loading +Entries +From +a +File<!--tex4ht:ref: sec:loadglsentries --></a>. +</div> +</p><!--l. 3961--><p class="noindent" > +</p><!--l. 3963--><p class="indent" > Since <span class="ectt-1000">\newacronym</span><a - id="dx1-34009"></a>. See <a -href="#x1-190002.2.3">2.2.3 </a><a -href="#x1-190002.2.3">Loading -Entries From a File<!--tex4ht:ref: sec:loadglsentries --></a>. </div> -</p><!--l. 3309--><p class="noindent" > -</p><!--l. 3311--><p class="indent" > For example, the following defines the acronym IDN: + id="dx1-39040"></a> uses <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-39041"></a>, you can use commands like <span +class="ectt-1000">\gls</span><a + id="dx1-39042"></a> and +<span +class="ectt-1000">\glsreset</span><a + id="dx1-39043"></a> as with any other glossary entry. + + + +</p><!--l. 3967--><p class="indent" > For example, the following defines the acronym IDN: </p> - <div class="verbatim" id="verbatim-93"> + <div class="verbatim" id="verbatim-116"> \newacronym{idn}{IDN}{identification number} </div> -<!--l. 3314--><p class="nopar" > This is equivalent to: +<!--l. 3970--><p class="nopar" > <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{idn}</span></span></span> will produce “identification number (IDN)” on <a + id="dx1-39044"></a><a +href="#glo:firstuse">first use</a> and “IDN” on +subsequent uses. If you want to use the <span +class="ecss-1000">smallcaps</span><a + id="dx1-39045"></a> package option, you need to use lower +case characters for the shortened form: </p> - <div class="verbatim" id="verbatim-94"> -\newglossaryentry{idn}{type=\acronymtype, - <br />name={IDN}, - <br />description={identification number}, - <br />text={IDN}, - <br />first={identification number (IDN)}, - <br />plural={IDNs}, - <br />firstplural={identification numbers (IDNs)}} -</div> -<!--l. 3324--><p class="nopar" > so <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\gls{idn}</span></span></span> will produce “identification number (IDN)” on first use<a - id="dx1-34010"></a> and “IDN” on -subsequent uses. -</p><!--l. 3328--><p class="indent" > This section describes acronyms that have been defined using <span -class="ectt-1000">\newacronym</span><a - id="dx1-34011"></a>. -If you prefer to define your acronyms using <span -class="ectt-1000">\newglossaryentry</span><a - id="dx1-34012"></a> explicitly, -then you should skip this section and ignore the package options: <span -class="ecss-1000">smallcaps</span><a - id="dx1-34013"></a>, -<span -class="ecss-1000">smaller</span><a - id="dx1-34014"></a>, <span -class="ecss-1000">description</span><a - id="dx1-34015"></a>, <span -class="ecss-1000">dua</span><a - id="dx1-34016"></a> and <span -class="ecss-1000">footnote</span><a - id="dx1-34017"></a>, as these options change the definition of -<span -class="ectt-1000">\newacronym</span><a - id="dx1-34018"></a> for common acronym formats as well as the way that the link text -is displayed (see <a -href="#x1-220002.4.1">2.4.1 </a><a -href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). Likewise you -should ignore the package option <span -class="ecss-1000">shortcuts</span><a - id="dx1-34019"></a> and the new commands described in -this section, such as <span -class="ectt-1000">\acrshort</span><a - id="dx1-34020"></a>, as they vary according to the definition of -<span -class="ectt-1000">\newacronym</span><a - id="dx1-34021"></a>. -</p><!--l. 3340--><p class="indent" > If you want to define your own custom acronym style, see <a -href="#x1-350002.10.1">2.10.1 </a><a -href="#x1-350002.10.1">Defining A -Custom Acronym Style<!--tex4ht:ref: sec:customacronym --></a>. -</p><!--l. 3343--><p class="indent" > <div class="important" title="Important Note"> If you try using <span -class="ectt-1000">\newglossaryentry</span><a - id="dx1-34022"></a> for entries in a designated list of -acronyms in combination with any of the above named package options you are -likely to get unexpected results such as empty brackets or empty footnotes. + <div class="verbatim" id="verbatim-117"> +\newacronym{idn}{idn}{identification number} </div> -</p><!--l. 3348--><p class="noindent" > -</p><!--l. 3350--><p class="indent" > If you use any of the package options <span +<!--l. 3977--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{idn}</span></span></span> will produce “identification number (<span +class="eccc-1000"><span +class="small-caps">I</span><span +class="small-caps">D</span><span +class="small-caps">N</span></span>)” on <a + id="dx1-39046"></a><a +href="#glo:firstuse">first use</a> and “<span +class="eccc-1000">IDN</span>” on +subsequent uses. +</p><!--l. 3982--><p class="indent" > If you use any of the package options <span class="ecss-1000">smallcaps</span><a - id="dx1-34023"></a>, <span + id="dx1-39047"></a>, <span class="ecss-1000">smaller</span><a - id="dx1-34024"></a>, <span + id="dx1-39048"></a>, <span class="ecss-1000">description</span><a - id="dx1-34025"></a> or <span + id="dx1-39049"></a> or <span class="ecss-1000">footnote</span><a - id="dx1-34026"></a>, the -acronyms will be displayed in the document using: -</p><!--l. 3354--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-39050"></a>, the +short form <span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span>will be displayed in the document using: +</p><!--l. 3985--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\acronymfont</span><span class="ectt-0900"> </span></span><a - id="dx1-34027"></a> <span + id="dx1-39051"></a> <span class="ectt-1000">\acronymfont{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3356--><p class="noindent" > +</p><!--l. 3987--><p class="noindent" > and -</p><!--l. 3358--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 3989--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\firstacronymfont</span><span class="ectt-0900"> </span></span><a - id="dx1-34028"></a> <span + id="dx1-39052"></a> <span class="ectt-1000">\firstacronymfont{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3360--><p class="noindent" > +</p><!--l. 3991--><p class="noindent" > where <span -class="ectt-1000">\firstacronymfont </span>is applied on first use<a - id="dx1-34029"></a> and <span +class="ectt-1000">\firstacronymfont </span>is applied on <a + id="dx1-39053"></a><a +href="#glo:firstuse">first use</a> and <span class="ectt-1000">\acronymfont </span>is applied on subsequent use. Note that if you don’t use any of the above package options, changing the definition of <span @@ -7758,354 +9667,582 @@ class="ectt-1000">\acronymfont </span>or <span class="ectt-1000">\firstacronymfont </span>will have no effect. In this case, the recommended route is to use either the <span class="ecss-1000">smaller</span><a - id="dx1-34030"></a> or the <span + id="dx1-39054"></a> or the <span class="ecss-1000">smallcaps</span><a - id="dx1-34031"></a> package option and + id="dx1-39055"></a> package option and redefine <span class="ectt-1000">\acronymfont </span>and <span class="ectt-1000">\firstacronymfont </span>as required. (The <span class="ecss-1000">smallcaps</span><a - id="dx1-34032"></a> option sets + id="dx1-39056"></a> option sets the default plural suffix in an upright font to cancel the effect of <span -class="ectt-1000">\textsc</span>, +class="ectt-1000">\textsc</span><a + id="dx1-39057"></a>, whereas <span class="ecss-1000">smaller</span><a - id="dx1-34033"></a> sets the suffix in the surrounding font.) For example, if you want -acronyms in a normal font on first use and emphasized on subsequent use, - - - + id="dx1-39058"></a> sets the suffix in the surrounding font.) For example, if you want +acronyms in a normal font on <a + id="dx1-39059"></a><a +href="#glo:firstuse">first use</a> and emphasized on subsequent use, do: </p> - <div class="verbatim" id="verbatim-95"> + <div class="verbatim" id="verbatim-118"> \usepackage[smaller]{glossaries}  <br />\renewcommand*{\firstacronymfont}[1]{#1}  <br />\renewcommand*{\acronymfont}[1]{\emph{#1}} </div> -<!--l. 3377--><p class="nopar" > (Note that it is for this reason that the <span +<!--l. 4008--><p class="nopar" > (Note that it is for this reason that the <span class="ecss-1000">relsize</span><a - id="dx1-34034"></a> package is not automatically loaded + id="dx1-39060"></a> package is not automatically loaded when selecting the <span class="ecss-1000">smaller</span><a - id="dx1-34035"></a> package option.) -</p><!--l. 3382--><p class="indent" > <a -href="#x1-340405">Table 5</a> lists the package options that govern the acronym styles and how -the <span -class="ectt-1000">\newglossaryentry</span><a - id="dx1-34036"></a> keys are used to store <span + id="dx1-39061"></a> package option.) +</p><!--l. 4013--><p class="indent" > There are commands analogous to <span +class="ectt-1000">\glstext</span><a + id="dx1-39062"></a> (described in <a +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary +Entries<!--tex4ht:ref: sec:glslink --></a>) that allow you to access just the short form, just the long form or the full form, +without affecting the <a + id="dx1-39063"></a><a +href="#glo:firstuseflag">first use flag</a>. (Note that the full form isn’t necessarily the same as +the text produced on <a + id="dx1-39064"></a><a +href="#glo:firstuse">first use</a>.) +</p><!--l. 4019--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39065"></a> <span +class="ectt-1000">\acrshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4021--><p class="noindent" > +This displays the short form for the entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. The optional arguments are +the same as those for <span +class="ectt-1000">\glstext</span><a + id="dx1-39066"></a>. There is also a starred version to suppress the +hyperlink. There are also analogous upper case variants: +</p><!--l. 4026--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39067"></a> <span +class="ectt-1000">\Acrshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4028--><p class="noindent" > +</p><!--l. 4029--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39068"></a> <span +class="ectt-1000">\ACRshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4031--><p class="noindent" > +</p><!--l. 4033--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrlong</span><span +class="ectt-0900"> </span></span><a + id="dx1-39069"></a> <span +class="ectt-1000">\acrlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4035--><p class="noindent" > +This displays the long form for the entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. The optional arguments are +the same as before. There is also a starred version to suppress the hyperlink. There are +also analogous upper case variants: +</p><!--l. 4040--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrlong</span><span +class="ectt-0900"> </span></span><a + id="dx1-39070"></a> <span +class="ectt-1000">\Acrlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4042--><p class="noindent" > +</p><!--l. 4043--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39071"></a> <span +class="ectt-1000">\ACRlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4045--><p class="noindent" > +</p><!--l. 4047--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-39072"></a> <span +class="ectt-1000">\acrfull[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4049--><p class="noindent" > +This is equivalent to: <span class="marginpar"><span +class="ectt-0900">\acrfullformat</span><span +class="ectt-0900"> </span></span><a + id="dx1-39073"></a><span +class="ectt-1000">\acrfullformat</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">{</span></span></span><span +class="ectt-1000">\acrlong</span><a + id="dx1-39074"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">}{</span></span></span><span +class="ectt-1000">\acrshort</span><a + id="dx1-39075"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">}</span></span></span>. This +defaults to <span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span>(the long form) and -<span +class="cmsy-10">⟩ </span>(<span +class="ectt-1000">\acronymfont</span><a + id="dx1-39076"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span>(the short form). Note that the <span -class="ecss-1000">smallcaps</span><a - id="dx1-34037"></a> option redefines <span -class="ectt-1000">\acronymfont</span> -so that it sets its argument using <span -class="ectt-1000">\textsc </span>(so you should use lower case -characters in <span +class="ecti-1000">short</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>) regardless of the package options. There are +also analogous upper case variants: +</p><!--l. 4055--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-39077"></a> <span +class="ectt-1000">\Acrfull[</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span>) and the <span -class="ecss-1000">smaller</span><a - id="dx1-34038"></a> option redefines <span -class="ectt-1000">\acronymfont </span>to use -<span -class="ectt-1000">\textsmaller</span>,<span class="footnote-mark"><a -href="#fn9x0" id="fn9x0-bk"><sup class="textsuperscript">9</sup></a></span><a - id="x1-34039f9"></a> otherwise -<span -class="ectt-1000">\acronymfont </span>simply displays its argument in the surrounding font. +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4057--><p class="noindent" > +</p><!--l. 4058--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-39078"></a> <span +class="ectt-1000">\ACRfull[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> + + + +</p><!--l. 4060--><p class="noindent" > +</p><!--l. 4062--><p class="indent" > If you find the above commands too cumbersome to write, you can use +the <span +class="ecss-1000">shortcuts</span><a + id="dx1-39079"></a> package option to activate the shorter command names listed in +<a +href="#x1-390805">table 5</a>. </p> <div class="table"> -<!--l. 3394--><p class="indent" > <a - id="x1-340405"></a></p><hr class="float" /><div class="float" +<!--l. 4066--><p class="indent" > <a + id="x1-390805"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 5: </span><span -class="content">Package options governing <span -class="ectt-1000">\newacronym </span>and how the information is -stored in the keys for <span -class="ectt-1000">\newglossaryentry</span></span></div><!--tex4ht:label?: x1-340405 --> -<div class="center" -> -<!--l. 3398--><p class="noindent" > -</p> +class="content">Synonyms provided by the package option <span +class="ecss-1000">shortcuts</span><a + id="dx1-39081"></a></span></div><!--tex4ht:label?: x1-390805 --> <div class="tabular"> <table id="TBL-6" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-6-1g"><col id="TBL-6-1" /><col -id="TBL-6-2" /><col -id="TBL-6-3" /><col -id="TBL-6-4" /><col -id="TBL-6-5" /></colgroup><tr +id="TBL-6-2" /></colgroup><tr style="vertical-align:baseline;" id="TBL-6-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-1" class="td11"><span -class="ecbx-1000">Package Option</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-2" -class="td11"><span -class="ecss-1000">first</span><a - id="dx1-34041"></a> key </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-3" +class="ecbx-1000">Shortcut Command</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-2" class="td11"><span -class="ecss-1000">text</span><a - id="dx1-34042"></a> key</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-4" +class="ecbx-1000">Equivalent Command</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-1" class="td11"><span -class="ecss-1000">description</span><a - id="dx1-34043"></a> key</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-5" +class="ectt-1000">\acs</span><a + id="dx1-39082"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-2" class="td11"><span -class="ecss-1000">symbol</span><a - id="dx1-34044"></a> key</td> +class="ectt-1000">\acrshort</span><a + id="dx1-39083"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-1" + style="vertical-align:baseline;" id="TBL-6-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-1" class="td11"><span -class="ecss-1000">description</span><a - id="dx1-34045"></a>,<span -class="ecss-1000">footnote</span><a - id="dx1-34046"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-2" +class="ectt-1000">\Acs</span><a + id="dx1-39084"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-3" +class="ectt-1000">\Acrshort</span><a + id="dx1-39085"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-4" -class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-5" +class="ectt-1000">\acsp</span><a + id="dx1-39086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td> +class="ectt-1000">\acrshortpl</span><a + id="dx1-39087"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-1" + style="vertical-align:baseline;" id="TBL-6-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-1" class="td11"><span -class="ecss-1000">description</span><a - id="dx1-34047"></a>,<span -class="ecss-1000">dua</span><a - id="dx1-34048"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-2" +class="ectt-1000">\Acsp</span><a + id="dx1-39088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-3" +class="ectt-1000">\Acrshortpl</span><a + id="dx1-39089"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-4" -class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-5" +class="ectt-1000">\acl</span><a + id="dx1-39090"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td> +class="ectt-1000">\acrlong</span><a + id="dx1-39091"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-1" + style="vertical-align:baseline;" id="TBL-6-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-1" class="td11"><span -class="ecss-1000">description</span><a - id="dx1-34049"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-2" +class="ectt-1000">\Acl</span><a + id="dx1-39092"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-3" +class="ectt-1000">\Acrlong</span><a + id="dx1-39093"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-4" -class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-5" +class="ectt-1000">\aclp</span><a + id="dx1-39094"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td> +class="ectt-1000">\acrlongpl</span><a + id="dx1-39095"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-1" + style="vertical-align:baseline;" id="TBL-6-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-1" class="td11"><span -class="ecss-1000">footnote</span><a - id="dx1-34050"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-2" +class="ectt-1000">\Aclp</span><a + id="dx1-39096"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-3" +class="ectt-1000">\Acrlongpl</span><a + id="dx1-39097"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-10-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-4" +class="ectt-1000">\acf</span><a + id="dx1-39098"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-10-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-5" -class="td11"> </td> +class="ectt-1000">\acrfull</span><a + id="dx1-39099"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-1" + style="vertical-align:baseline;" id="TBL-6-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-11-1" class="td11"><span -class="ecss-1000">smallcaps</span><a - id="dx1-34051"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-2" +class="ectt-1000">\Acf</span><a + id="dx1-39100"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-11-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-3" +class="ectt-1000">\Acrfull</span><a + id="dx1-39101"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-12-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-4" +class="ectt-1000">\acfp</span><a + id="dx1-39102"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-12-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-5" +class="ectt-1000">\acrfullpl</span><a + id="dx1-39103"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-13-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td> +class="ectt-1000">\Acfp</span><a + id="dx1-39104"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-13-2" +class="td11"><span +class="ectt-1000">\Acrfullpl</span><a + id="dx1-39105"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-1" + style="vertical-align:baseline;" id="TBL-6-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-14-1" class="td11"><span -class="ecss-1000">smaller</span><a - id="dx1-34052"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-2" +class="ectt-1000">\ac</span><a + id="dx1-39106"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-14-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-3" +class="ectt-1000">\gls</span><a + id="dx1-39107"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-15-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-4" +class="ectt-1000">\Ac</span><a + id="dx1-39108"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-15-2" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-5" +class="ectt-1000">\Gls</span><a + id="dx1-39109"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-16-1" class="td11"><span -class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td> +class="ectt-1000">\acp</span><a + id="dx1-39110"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-16-2" +class="td11"><span +class="ectt-1000">\glspl</span><a + id="dx1-39111"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-6-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-1" + style="vertical-align:baseline;" id="TBL-6-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-17-1" class="td11"><span -class="ecss-1000">dua</span><a - id="dx1-34053"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-2" +class="ectt-1000">\Acp</span><a + id="dx1-39112"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-17-2" class="td11"><span +class="ectt-1000">\Glspl</span><a + id="dx1-39113"></a> </td></tr></table> +</div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 4092--><p class="indent" > It is also possible to access the long and short forms without adding information to +the glossary using commands analogous to <span +class="ectt-1000">\glsentrytext</span><a + id="dx1-39114"></a> (described in <a +href="#x1-320009">9 </a><a +href="#x1-320009">Using +Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>). +</p><!--l. 4096--><p class="indent" > The long form can be accessed using: +</p><!--l. 4097--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrylong</span><span +class="ectt-0900"> </span></span><a + id="dx1-39115"></a> <span +class="ectt-1000">\glsentrylong{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-3" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4099--><p class="noindent" > +or, with the first letter converted to upper case: +</p><!--l. 4101--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrylong</span><span +class="ectt-0900"> </span></span><a + id="dx1-39116"></a> <span +class="ectt-1000">\Glsentrylong{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-4" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4103--><p class="noindent" > +Plural forms: +</p><!--l. 4105--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrylongpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-39117"></a> <span +class="ectt-1000">\glsentrylongpl{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-5" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4107--><p class="noindent" > +</p><!--l. 4108--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrylongpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-39118"></a> <span +class="ectt-1000">\Glsentrylongpl{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩ </span></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-6-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-1" -class="td11">None of the above </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-2" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4110--><p class="noindent" > +</p><!--l. 4112--><p class="indent" > Similarly, to access the short form: +</p><!--l. 4113--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39119"></a> <span +class="ectt-1000">\glsentryshort{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span>(<span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4115--><p class="noindent" > +or, with the first letter converted to upper case: +</p><!--l. 4117--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-39120"></a> <span +class="ectt-1000">\Glsentryshort{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span>)</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-3" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4119--><p class="noindent" > +Plural forms: +</p><!--l. 4121--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryshortpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-39121"></a> <span +class="ectt-1000">\glsentryshortpl{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">abbrv</span><span -class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-4" -class="td11"><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4123--><p class="noindent" > +</p><!--l. 4124--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryshortpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-39122"></a> <span +class="ectt-1000">\Glsentryshortpl{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4126--><p class="noindent" > +</p><!--l. 4128--><p class="indent" > And the full form, <span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span -class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-5" -class="td11"> </td></tr></table> -</div></div> - - - - </div><hr class="endfloat" /> - </div> -<!--l. 3448--><p class="indent" > In case you can’t remember which key stores the long or short forms (or their -plurals) the <span -class="ecss-1000">glossaries </span>package provides the commands: </p> - <ul class="itemize1"> - <li class="itemize"><span class="marginpar"><span -class="ectt-0900">\glsshortkey</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="ecti-1000">short</span><span +class="cmsy-10">⟩</span>), can be obtained using: +</p><!--l. 4130--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryfull</span><span class="ectt-0900"> </span></span><a - id="dx1-34054"></a><span -class="ectt-1000">\glsshortkey </span>The key used to store the short form. - </li> - <li class="itemize"><span class="marginpar"><span -class="ectt-0900">\glsshortpluralkey</span><span + id="dx1-39123"></a> <span +class="ectt-1000">\glsentryfull{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4132--><p class="noindent" > +</p><!--l. 4133--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryfull</span><span class="ectt-0900"> </span></span><a - id="dx1-34055"></a><span -class="ectt-1000">\glsshortpluralkey </span>The key used to store the plural - version of the short form. - </li> - <li class="itemize"><span class="marginpar"><span -class="ectt-0900">\glslongkey</span><span + id="dx1-39124"></a> <span +class="ectt-1000">\Glsentryfull{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4135--><p class="noindent" > +</p><!--l. 4136--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryfullpl</span><span class="ectt-0900"> </span></span><a - id="dx1-34056"></a><span -class="ectt-1000">\glslongkey </span>The key used to store the long form. - </li> - <li class="itemize"><span class="marginpar"><span -class="ectt-0900">\glslongpluralkey</span><span -class="ectt-0900"> </span></span><a - id="dx1-34057"></a><span -class="ectt-1000">\glslongpluralkey </span>The key used to store the plural - version of the long form.</li></ul> -<!--l. 3461--><p class="noindent" >These can be used in the optional argument of <span -class="ectt-1000">\newacronym </span>to override the defaults. For -example: + id="dx1-39125"></a> <span +class="ectt-1000">\glsentryfullpl{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4138--><p class="noindent" > +</p><!--l. 4139--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryfullpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-39126"></a> <span +class="ectt-1000">\Glsentryfullpl{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4141--><p class="noindent" > </p> - <div class="verbatim" id="verbatim-96"> -\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal - <br />matrix} -</div> -<!--l. 3466--><p class="nopar" > If the first use<a - id="dx1-34058"></a> uses the plural form, <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glspl{dm}</span></span></span> will display: diagonal matrices -(DMs). -</p><!--l. 3470--><p class="indent" > Each of the package options <span -class="ecss-1000">smallcaps</span><a - id="dx1-34059"></a>, <span -class="ecss-1000">smaller</span><a - id="dx1-34060"></a>, <span -class="ecss-1000">footnote</span><a - id="dx1-34061"></a>, <span -class="ecss-1000">dua</span><a - id="dx1-34062"></a> and <span -class="ecss-1000">description</span><a - id="dx1-34063"></a> use -<span -class="ectt-1000">\defglsdisplay</span><a - id="dx1-34064"></a> and <span -class="ectt-1000">\defglsdisplayfirst</span><a - id="dx1-34065"></a> (described in <a -href="#x1-220002.4.1">2.4.1 </a><a -href="#x1-220002.4.1">Changing the format -of the link text<!--tex4ht:ref: sec:glsdisplay --></a>) to change the way the link text is displayed. This means that these -package options only work for the glossary type given by <span -class="ectt-1000">\acronymtype</span>. If you have -multiple lists of acronyms, you will need to make the appropriate changes for each -additional glossary type. +<!--l. 4143--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">13.1 </span> <a + id="x1-4000013.1"></a>Predefined Acronym Styles</h4> +<!--l. 4145--><p class="noindent" >Some of the acronym-related package options may be combined. Listed below are the +effects of different combinations. If you use an invalid combination, you’ll get an error +message. +</p><!--l. 4149--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecsx-1000">description</span><a - id="dx1-34066"></a><span + id="dx1-40001"></a><span class="ecbx-1000">,</span><span class="ecsx-1000">footnote</span><a - id="dx1-34067"></a> </dt><dd -class="description">When these two package options are used together, the first - use<a - id="dx1-34068"></a> displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-40002"></a> </dt><dd +class="description">When these two package options are used together, the <a + id="dx1-40003"></a><a +href="#glo:firstuse">first + use</a> displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">\firstacronymfont{</span><span class="cmsy-10">⟨</span><span @@ -8136,42 +10273,29 @@ class="cmsy-10">⟩</span> class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>indicates the text supplied in the final optional argument to <span -class="ectt-1000">\gls</span>, +class="ectt-1000">\gls</span><a + id="dx1-40004"></a>, <span -class="ectt-1000">\glspl </span>or their uppercase variants. - <!--l. 3494--><p class="noindent" >In this case, the long form is stored in the <span -class="ecss-1000">symbol</span><a - id="dx1-34069"></a> key. This means that the long - form will not be displayed in the list of acronyms unless you use a glossary style - that displays the entry’s symbol (for example, the <span -class="ecss-1000">index</span><a - id="dx1-34070"></a> style). Entries will be - sorted according to the short form. - </p><!--l. 3500--><p class="noindent" >Note also that when these two package options are used (in the given order), - the <span -class="ecss-1000">glossaries </span>package additionally implements the <span -class="ecss-1000">sanitize</span><a - id="dx1-34071"></a> option using - <a - id="dx1-34072"></a><a - id="dx1-34073"></a><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">sanitize={description=false,symbol=false}</span></span></span>, so remember to protect fragile - commands when defining acronyms. - </p></dd><dt class="description"> +class="ectt-1000">\glspl</span><a + id="dx1-40005"></a> or their uppercase variants. + </dd><dt class="description"> <span class="ecsx-1000">dua</span><a - id="dx1-34074"></a> </dt><dd + id="dx1-40006"></a> </dt><dd class="description">The <span class="ecss-1000">dua</span><a - id="dx1-34075"></a> package option always displays the expanded form and so may not be - used with <span + id="dx1-40007"></a> package option always makes <span +class="ectt-1000">\gls</span><a + id="dx1-40008"></a> display the expanded form and so may + not be used with <span class="ecss-1000">footnote</span><a - id="dx1-34076"></a>, <span + id="dx1-40009"></a>, <span class="ecss-1000">smaller</span><a - id="dx1-34077"></a> or <span + id="dx1-40010"></a> or <span class="ecss-1000">smallcaps</span><a - id="dx1-34078"></a>. Both first use<a - id="dx1-34079"></a> and subsequent use + id="dx1-40011"></a>. Both <a + id="dx1-40012"></a><a +href="#glo:firstuse">first use</a> and subsequent use displays the entry in the form: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmsy-10">⟨</span><span @@ -8180,51 +10304,25 @@ class="cmsy-10">⟩⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> - - - - <!--l. 3515--><p class="noindent" >If the <span -class="ecss-1000">description</span><a - id="dx1-34080"></a> package option is also used, the <span -class="ecss-1000">name</span><a - id="dx1-34081"></a> key is set to the long form, - otherwise the <span -class="ecss-1000">name</span><a - id="dx1-34082"></a> key is set to the short form and the <span -class="ecss-1000">description</span><a - id="dx1-34083"></a> key is set to - the long form. In both cases the <span -class="ecss-1000">symbol</span><a - id="dx1-34084"></a> is set to the short form. Therefore, if you - use the <span -class="ecss-1000">description</span><a - id="dx1-34085"></a> package option and you want the short form to appear in the - list of acronyms, you will need to use a glossary style that displays the entry’s - symbol (for example, the <span -class="ecss-1000">index</span><a - id="dx1-34086"></a> style). Entries will be sorted according to the long - form if the <span -class="ecss-1000">description</span><a - id="dx1-34087"></a> option is used, otherwise they will be sorted according to - the short form (unless overridden by the <span -class="ecss-1000">sort</span><a - id="dx1-34088"></a> key in the optional argument of - <span -class="ectt-1000">\newacronym</span><a - id="dx1-34089"></a>). - </p></dd><dt class="description"> + You can, however, access the short form using <span +class="ectt-1000">\acrshort</span><a + id="dx1-40013"></a> and its variants. + </dd><dt class="description"> <span class="ecsx-1000">description</span><a - id="dx1-34090"></a> </dt><dd -class="description">This package option displays the entry on first use<a - id="dx1-34091"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-40014"></a> </dt><dd +class="description">This package option displays the entry on <a + id="dx1-40015"></a><a +href="#glo:firstuse">first use</a> as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span class="cmsy-10">⟩⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>(<span -class="ectt-1000">\firstacronymfont{</span><span +class="ectt-1000">\firstacronymfont</span><a + id="dx1-40016"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span @@ -8241,73 +10339,19 @@ class="cmsy-10">⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> - Note also that if this package option is used, the <span -class="ecss-1000">glossaries </span>package additionally - implements the option <a - id="dx1-34092"></a><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile - commands when defining acronyms. - <!--l. 3543--><p class="noindent" >Note that with this option, you need to specify the description using the + <!--l. 4185--><p class="noindent" >Note that with this option, you need to specify the description using the <span class="ecss-1000">description</span><a - id="dx1-34093"></a> key in the optional argument of <span -class="ectt-1000">\newacronym</span><a - id="dx1-34094"></a>. When this option is - used without the <span -class="ecss-1000">footnote</span><a - id="dx1-34095"></a> or <span -class="ecss-1000">dua</span><a - id="dx1-34096"></a> options, the name field is specified - as - </p><!--l. 3548--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\acrnameformat</span><span -class="ectt-0900"> </span></span><a - id="dx1-34097"></a> <span -class="ectt-1000">\acrnameformat{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">short</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">long</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">} </span></div><hr> - </p><!--l. 3550--><p class="noindent" > - This defaults to <span -class="ectt-1000">\acronymfont</span><a - id="dx1-34098"></a><span -class="ectt-1000">{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">short</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}</span>, which means that the long form will not - appear in the list of acronyms by default. To change this, you need to redefine - <span -class="ectt-1000">\acrnameformat</span><a - id="dx1-34099"></a> as appropriate. For example, to display the long form followed - by the short form in parentheses do: - - - -</p> - <div class="verbatim" id="verbatim-97"> - \renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})} -</div> - <!--l. 3558--><p class="nopar" > Note that even if you redefine <span -class="ectt-1000">\acrnameformat</span><a - id="dx1-34100"></a>, the entries will be sorted - according to the short form, unless you override this using the <span -class="ecss-1000">sort</span><a - id="dx1-34101"></a> key in the - optional argument to <span + id="dx1-40017"></a> key in the optional argument of <span class="ectt-1000">\newacronym</span><a - id="dx1-34102"></a>. + id="dx1-40018"></a>. </p></dd><dt class="description"> <span class="ecsx-1000">footnote</span><a - id="dx1-34103"></a> </dt><dd -class="description">This package option displays the entry on first use<a - id="dx1-34104"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-40019"></a> </dt><dd +class="description">This package option displays the entry on <a + id="dx1-40020"></a><a +href="#glo:firstuse">first use</a> as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="ectt-1000">\firstacronymfont{</span><span class="cmsy-10">⟨</span><span @@ -8324,6 +10368,9 @@ class="cmsy-10">⟩</span><span class="ectt-1000">}</span> <br /><spacer type=vertical size=10></span> while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + + + <br /><span class="ectt-1000">\acronymfont{</span><span class="cmsy-10">⟨</span><span @@ -8335,64 +10382,41 @@ class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> Acronyms will be sorted according to the short form. - <!--l. 3575--><p class="noindent" >Note also that if this package option is used, the <span -class="ecss-1000">glossaries </span>package additionally - implements the option <a - id="dx1-34105"></a><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">sanitize={description=false}</span></span></span>, so remember to protect - fragile commands when defining acronyms. - </p><!--l. 3580--><p class="noindent" >Note that on first use<a - id="dx1-34106"></a>, it is the long form in the footnote that links to - the relevant glossary entry (where hyperlinks are enabled), whereas on - subsequent use, the acronym links to the relevant glossary entry. It is - possible to change this to make the acronym on first use<a - id="dx1-34107"></a> have the hyperlink - instead of the footnote, but since the footnote marker will also be a - hyperlink, you will have two hyperlinks in immediate succession. This can be - ambiguous where the hyperlinks are coloured rather than boxed. The code - required to change the first use<a - id="dx1-34108"></a> to make the acronym a hyperlink is as - follows: - - - -</p> - <div class="verbatim" id="verbatim-98"> -  \defglsdisplayfirst[\acronymtype]{% -  <br /> \noexpand\protect\noexpand -  <br />    \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% -  <br />    \noexpand\protect\noexpand\footnote{#2}}% -</div> - <!--l. 3594--><p class="nopar" > <span -class="ecbx-1000">Note </span>that this involves using internal commands (i.e. commands whose name - contains an <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">@</span></span></span> character), so if this code is place in a <span -class="ectt-1000">.tex </span>file it needs to be placed - within a <span -class="ectt-1000">\makeatletter </span>… <span -class="ectt-1000">\makeatother </span>pair. (See <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns" ><span -class="ectt-1000">\@ </span>and <span -class="ectt-1000">@ </span>in macro names</a> for - further details.) + <!--l. 4200--><p class="noindent" >Note that on <a + id="dx1-40021"></a><a +href="#glo:firstuse">first use</a>, it is the long form in the footnote that links to the relevant + glossary entry (where hyperlinks are enabled), whereas on subsequent use, the + acronym links to the relevant glossary entry. You can suppress the long form link + by setting: + + + +</p> + <div class="verbatim" id="verbatim-119"> + \let\acrfootnote\acrnolinkfootnote +</div> + <!--l. 4206--><p class="nopar" > </p></dd><dt class="description"> <span class="ecsx-1000">smallcaps</span><a - id="dx1-34109"></a> </dt><dd + id="dx1-40022"></a> </dt><dd class="description">If neither the <span class="ecss-1000">footnote</span><a - id="dx1-34110"></a> nor <span + id="dx1-40023"></a> nor <span class="ecss-1000">description</span><a - id="dx1-34111"></a> options have been set, this option - displays the entry on first use<a - id="dx1-34112"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-40024"></a> options have been set, this option + displays the entry on <a + id="dx1-40025"></a><a +href="#glo:firstuse">first use</a> as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span class="cmsy-10">⟩⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>(<span -class="ectt-1000">\firstacronymfont{</span><span +class="ectt-1000">\firstacronymfont</span><a + id="dx1-40026"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span @@ -8410,40 +10434,38 @@ class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> where <span -class="ectt-1000">\acronymfont </span>is set to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acronymfont</span><a + id="dx1-40027"></a> is set to <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textsc{#1}</span></span></span>. - <!--l. 3614--><p class="noindent" ><div class="important" title="Important Note"> Note that since the acronym is displayed using <span + <!--l. 4220--><p class="noindent" ><div class="important" title="Important Note"> Note that since the acronym is displayed using <span class="ectt-1000">\textsc</span><a - id="dx1-34113"></a>, the short form, <span + id="dx1-40028"></a>, the short form, <span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span>, should be specified in lower case. </div> - </p><!--l. 3619--><p class="noindent" > - </p><!--l. 3621--><p class="noindent" >Note also that if this package option is used, the <span -class="ecss-1000">glossaries </span>package additionally - implements the option <a - id="dx1-34114"></a><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile - commands when defining acronyms. + </p><!--l. 4225--><p class="noindent" > </p></dd><dt class="description"> <span class="ecsx-1000">smaller</span><a - id="dx1-34115"></a> </dt><dd + id="dx1-40029"></a> </dt><dd class="description">If neither the <span class="ecss-1000">footnote</span><a - id="dx1-34116"></a> nor <span + id="dx1-40030"></a> nor <span class="ecss-1000">description</span><a - id="dx1-34117"></a> options have been set, this option - displays the entry on first use<a - id="dx1-34118"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-40031"></a> options have been set, this option + displays the entry on <a + id="dx1-40032"></a><a +href="#glo:firstuse">first use</a> as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmsy-10">⟨</span><span class="ecti-1000">long</span><span class="cmsy-10">⟩⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩ </span>(<span -class="ectt-1000">\firstacronymfont{</span><span +class="ectt-1000">\firstacronymfont</span><a + id="dx1-40033"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span @@ -8451,7 +10473,9 @@ class="ectt-1000">}</span>) <br /><spacer type=vertical size=10></span> while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span -class="ectt-1000">\acronymfont{</span><span +class="ectt-1000">\acronymfont</span><a + id="dx1-40034"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span @@ -8461,47 +10485,43 @@ class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> where <span -class="ectt-1000">\acronymfont </span>is set to +class="ectt-1000">\acronymfont</span><a + id="dx1-40035"></a> is set to <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textsmaller{#1}</span></span></span>.<span class="footnote-mark"><a -href="#fn10x0" id="fn10x0-bk"><sup class="textsuperscript">10</sup></a></span><a - id="x1-34119f10"></a> +href="#fn16x0" id="fn16x0-bk"><sup class="textsuperscript">16</sup></a></span><a + id="x1-40036f16"></a> The entries will be sorted according to the short form. - - - - <!--l. 3642--><p class="noindent" ><div class="important" title="Important Note"> Remember to load a package that defines <span + <!--l. 4243--><p class="noindent" ><div class="important" title="Important Note"> Remember to load a package that defines <span class="ectt-1000">\textsmaller</span><a - id="dx1-34123"></a> (such as <span + id="dx1-40040"></a> (such as <span class="ecss-1000">relsize</span><a - id="dx1-34124"></a>) if you + id="dx1-40041"></a>) if you want to use this option, unless you want to redefine <span class="ectt-1000">\acronymfont</span><a - id="dx1-34125"></a> to use some + id="dx1-40042"></a> to use some other formatting command. </div> - </p><!--l. 3646--><p class="noindent" > - </p><!--l. 3648--><p class="noindent" >Note also that if this package option is used, the <span -class="ecss-1000">glossaries </span>package additionally - implements the option <a - id="dx1-34126"></a><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile - commands when defining acronyms. + </p><!--l. 4247--><p class="noindent" > + + + </p></dd><dt class="description"> <span class="ecbx-1000">None of the above</span> </dt><dd class="description">If none of the package options <span class="ecss-1000">smallcaps</span><a - id="dx1-34127"></a>, <span + id="dx1-40043"></a>, <span class="ecss-1000">smaller</span><a - id="dx1-34128"></a>, <span + id="dx1-40044"></a>, <span class="ecss-1000">footnote</span><a - id="dx1-34129"></a>, + id="dx1-40045"></a>, <span class="ecss-1000">dua</span><a - id="dx1-34130"></a> or <span + id="dx1-40046"></a> or <span class="ecss-1000">description</span><a - id="dx1-34131"></a> are used, then on first use<a - id="dx1-34132"></a> the entry is displayed as: + id="dx1-40047"></a> are used, then on <a + id="dx1-40048"></a><a +href="#glo:firstuse">first use</a> the entry is displayed as: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmsy-10">⟨</span><span @@ -8522,481 +10542,360 @@ class="cmsy-10">⟩⟨</span><span class="ecti-1000">insert</span><span class="cmsy-10">⟩</span> <br /><spacer type=vertical size=10></span> - Entries will be sorted according to the short form. Note that if none of the - acronym-related package options are used, the <span -class="ecss-1000">sanitize</span><a - id="dx1-34133"></a> option will not be - affected.</dd></dl> -<!--l. 3669--><p class="indent" > Recall from <a -href="#x1-210002.4">2.4 </a><a -href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> that you can access the values of -individual keys using commands like <span -class="ectt-1000">\glstext</span><a - id="dx1-34134"></a>, so it is possible to use these commands -to print just the long form or just the abbreviation without affecting the flag that -determines whether the entry has been used. However the keys that store the long and -short form vary depending on the acronym style, so the <span -class="ecss-1000">glossaries </span>package -provides commands that are set according to the package options. These are as -follows: -</p><!--l. 3677--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\acrshort</span><span -class="ectt-0900"> </span></span><a - id="dx1-34135"></a> <span -class="ectt-1000">\acrshort[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3679--><p class="noindent" > -</p><!--l. 3680--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\Acrshort</span><span -class="ectt-0900"> </span></span><a - id="dx1-34136"></a> <span -class="ectt-1000">\ACRshort[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3682--><p class="noindent" > -</p><!--l. 3683--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\ACRshort</span><span + Entries will be sorted according to the short form.</dd></dl> +<!--l. 4263--><p class="noindent" > +</p> +<!--l. 4263--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">13.2 </span> <a + id="x1-4100013.2"></a>Displaying the List of Acronyms</h4> +<!--l. 4265--><p class="noindent" >The list of acronyms is just like any other type of glossary and can be displayed on its +own using <span +class="ectt-1000">\printglossary</span><a + id="dx1-41001"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">[type=\acronymtype]</span></span></span> or with all the other glossaries +using <span +class="ectt-1000">\printglossaries</span><a + id="dx1-41002"></a>. However, care must be taken to choose a glossary +style that’s appropriate to your acronym style. The different acronym-related +package options store different information in the <span +class="ecss-1000">name</span><a + id="dx1-41003"></a>, <span +class="ecss-1000">description</span><a + id="dx1-41004"></a> and <span +class="ecss-1000">symbol</span><a + id="dx1-41005"></a> +keys. +</p><!--l. 4274--><p class="indent" > <a +href="#x1-410136">Table 6</a> lists the package options that govern the acronym styles and how the +information is stored in the keys used when displaying the glossary. Note that the +<span +class="ecss-1000">description</span><a + id="dx1-41006"></a> package option uses the following command in the <span +class="ecss-1000">name</span><a + id="dx1-41007"></a>: +</p><!--l. 4278--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrnameformat</span><span class="ectt-0900"> </span></span><a - id="dx1-34137"></a> <span -class="ectt-1000">\ACRshort[</span><span + id="dx1-41008"></a> <span +class="ectt-1000">\acrnameformat{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span +class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span +class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span +class="ecti-1000">long</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4280--><p class="noindent" > +This defaults to just <span +class="ectt-1000">\acronymfont{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span +class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3685--><p class="noindent" > -Print the abbreviated version with (if required) a hyperlink to the relevant entry in the -glossary. This is usually equivalent to <span -class="ectt-1000">\glstext</span><a - id="dx1-34138"></a> (or its uppercase variants) but may -additionally put the link text within the argument to <span +class="ectt-1000">}</span>. +</p><!--l. 4283--><p class="indent" > For example, if I use the package options <span +class="ecss-1000">description</span><a + id="dx1-41009"></a> and <span +class="ecss-1000">footnote</span><a + id="dx1-41010"></a>, then the name +field will contain the abbreviation and the symbol field will contain the long form. If I +then use the <span +class="ecss-1000">long4col</span><a + id="dx1-41011"></a> style, each entry in the list of acronyms will appear in the form: +<spacer type=vertical size=10><span class="obeylines-h"> + <br /><span class="ectt-1000">\acronymfont</span><a - id="dx1-34139"></a>. -</p><!--l. 3690--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\acrlong</span><span -class="ectt-0900"> </span></span><a - id="dx1-34140"></a> <span -class="ectt-1000">\acrlong[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3692--><p class="noindent" > -</p><!--l. 3693--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\Acrlong</span><span -class="ectt-0900"> </span></span><a - id="dx1-34141"></a> <span -class="ectt-1000">\ACRlong[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> - - - -</p><!--l. 3695--><p class="noindent" > -</p><!--l. 3696--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\ACRlong</span><span -class="ectt-0900"> </span></span><a - id="dx1-34142"></a> <span -class="ectt-1000">\ACRlong[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3698--><p class="noindent" > -Print the long version with (if required) a hyperlink to the relevant entry in the -glossary. This is may be equivalent to <span -class="ectt-1000">\glsdesc</span><a - id="dx1-34143"></a>, <span -class="ectt-1000">\glssymbol</span><a - id="dx1-34144"></a> or <span -class="ectt-1000">\glsfirst</span><a - id="dx1-34145"></a> (or their -uppercase variants), depending on package options. -</p><!--l. 3703--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\acrfull</span><span -class="ectt-0900"> </span></span><a - id="dx1-34146"></a> <span -class="ectt-1000">\acrfull[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3705--><p class="noindent" > -</p><!--l. 3706--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\Acrfull</span><span -class="ectt-0900"> </span></span><a - id="dx1-34147"></a> <span -class="ectt-1000">\ACRfull[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3708--><p class="noindent" > -</p><!--l. 3709--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\ACRfull</span><span -class="ectt-0900"> </span></span><a - id="dx1-34148"></a> <span -class="ectt-1000">\ACRfull[</span><span + id="dx1-41012"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">options</span><span +class="ecti-1000">abbrv</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">]{</span><span +class="ectt-1000">} </span><span class="cmsy-10">⟨</span><span -class="ecti-1000">label</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}[</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span> + <br /><span class="cmsy-10">⟨</span><span -class="ecti-1000">insert</span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">] </span></div><hr> -</p><!--l. 3711--><p class="noindent" > -Print the long version followed by the abbreviation in brackets with (if required) a -hyperlink to the relevant entry in the glossary. -</p><!--l. 3715--><p class="indent" > <div class="important" title="Important Note"> Note that if any of the above commands produce unexpected output and you -haven’t used any of the acronym-related package options, you will need to switch off the -sanitization<a - id="dx1-34149"></a>. For example: - - - -</p> - <div class="verbatim" id="verbatim-99"> -\usepackage[sanitize=none]{glossaries} -</div> -<!--l. 3722--><p class="nopar" > However, if you do this, you must remember to protect fragile commands when defining -acronyms or glossary entries. </div> -</p><!--l. 3725--><p class="noindent" > -</p><!--l. 3727--><p class="indent" > Note that if you change the definition of <span -class="ectt-1000">\newacronym</span><a - id="dx1-34150"></a>, you may additionally need to -change the above commands as well as changing the way the text is displayed using -<span -class="ectt-1000">\defglsdisplay</span><a - id="dx1-34151"></a> and <span -class="ectt-1000">\defglsdisplayfirst</span><a - id="dx1-34152"></a>. -</p><!--l. 3732--><p class="indent" > The package option <span -class="ecss-1000">shortcuts</span><a - id="dx1-34153"></a> provides the synonyms listed in <a -href="#x1-341556">table 6</a>. If any of -those commands generate an “undefined control sequence” error message, check -that you have enabled the shortcuts using the <span -class="ecss-1000">shortcuts</span><a - id="dx1-34154"></a> package option. Note -that there are no shortcuts for the commands that produce all upper case -text. +class="ecti-1000">location list</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> +Alternatively, you can define your own custom style (see <a +href="#x1-5200016">16 </a><a +href="#x1-5200016">Defining your own glossary +style<!--tex4ht:ref: sec:newglossarystyle --></a> for further details). </p> <div class="table"> -<!--l. 3739--><p class="indent" > <a - id="x1-341556"></a></p><hr class="float" /><div class="float" +<!--l. 4295--><p class="indent" > <a + id="x1-410136"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 6: </span><span -class="content">Synonyms provided by the package option <span -class="ecss-1000">shortcuts</span><a - id="dx1-34156"></a></span></div><!--tex4ht:label?: x1-341556 --> +class="content">Package options governing <span +class="ectt-1000">\newacronym </span>and how the information is +stored</span></div><!--tex4ht:label?: x1-410136 --> <div class="center" > -<!--l. 3742--><p class="noindent" > +<!--l. 4299--><p class="noindent" > </p> <div class="tabular"> <table id="TBL-7" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-7-1g"><col id="TBL-7-1" /><col -id="TBL-7-2" /></colgroup><tr +id="TBL-7-2" /><col +id="TBL-7-3" /><col +id="TBL-7-4" /><col +id="TBL-7-5" /></colgroup><tr style="vertical-align:baseline;" id="TBL-7-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-1" class="td11"><span -class="ecbx-1000">Shortcut Command</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-2" +class="ecbx-1000">Package Option</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-2" class="td11"><span -class="ecbx-1000">Equivalent Command</span></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-1" +class="ecss-1000">name</span><a + id="dx1-41014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-3" class="td11"><span -class="ectt-1000">\acs</span><a - id="dx1-34157"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-2" +class="ecss-1000">description</span><a + id="dx1-41015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-4" class="td11"><span -class="ectt-1000">\acrshort</span><a - id="dx1-34158"></a> </td> +class="ecss-1000">symbol</span><a + id="dx1-41016"></a> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-1" -class="td11"><span -class="ectt-1000">\Acs</span><a - id="dx1-34159"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-2" + style="vertical-align:baseline;" id="TBL-7-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-1" class="td11"><span -class="ectt-1000">\Acrshort</span><a - id="dx1-34160"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-1" +class="ecss-1000">description</span><a + id="dx1-41017"></a>,<span +class="ecss-1000">footnote</span><a + id="dx1-41018"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-2" class="td11"><span -class="ectt-1000">\acsp</span><a - id="dx1-34161"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-2" +class="ectt-1000">\acronymfont</span><a + id="dx1-41019"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-3" +class="td11">user supplied</td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-4" class="td11"><span -class="ectt-1000">\acrshortpl</span><a - id="dx1-34162"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-1" -class="td11"><span -class="ectt-1000">\Acsp</span><a - id="dx1-34163"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-2" + style="vertical-align:baseline;" id="TBL-7-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-1" class="td11"><span -class="ectt-1000">\Acrshortpl</span><a - id="dx1-34164"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-1" +class="ecss-1000">description</span><a + id="dx1-41020"></a>,<span +class="ecss-1000">dua</span><a + id="dx1-41021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-2" class="td11"><span -class="ectt-1000">\acl</span><a - id="dx1-34165"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-2" +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-3" +class="td11">user supplied</td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-4" class="td11"><span -class="ectt-1000">\acrlong</span><a - id="dx1-34166"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-1" -class="td11"><span -class="ectt-1000">\Acl</span><a - id="dx1-34167"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-2" + style="vertical-align:baseline;" id="TBL-7-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-1" class="td11"><span -class="ectt-1000">\Acrlong</span><a - id="dx1-34168"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-1" +class="ecss-1000">description</span><a + id="dx1-41022"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-2" class="td11"><span -class="ectt-1000">\aclp</span><a - id="dx1-34169"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-2" +class="ectt-1000">\acrnameformat</span><a + id="dx1-41023"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-3" +class="td11">user supplied</td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-4" class="td11"><span -class="ectt-1000">\acrlongpl</span><a - id="dx1-34170"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-1" -class="td11"><span -class="ectt-1000">\Aclp</span><a - id="dx1-34171"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-2" + style="vertical-align:baseline;" id="TBL-7-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-1" class="td11"><span -class="ectt-1000">\Acrlongpl</span><a - id="dx1-34172"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-1" +class="ecss-1000">footnote</span><a + id="dx1-41024"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-2" class="td11"><span -class="ectt-1000">\acf</span><a - id="dx1-34173"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-2" +class="ectt-1000">\acronymfont</span><a + id="dx1-41025"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-3" class="td11"><span -class="ectt-1000">\acrfull</span><a - id="dx1-34174"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-4" +class="td11"> </td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-1" + style="vertical-align:baseline;" id="TBL-7-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-1" class="td11"><span -class="ectt-1000">\Acf</span><a - id="dx1-34175"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-2" +class="ecss-1000">smallcaps</span><a + id="dx1-41026"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-2" class="td11"><span -class="ectt-1000">\Acrfull</span><a - id="dx1-34176"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-1" +class="ectt-1000">\acronymfont</span><a + id="dx1-41027"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-3" class="td11"><span -class="ectt-1000">\acfp</span><a - id="dx1-34177"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-2" +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-4" class="td11"><span -class="ectt-1000">\acrfullpl</span><a - id="dx1-34178"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-1" + style="vertical-align:baseline;" id="TBL-7-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-1" class="td11"><span -class="ectt-1000">\Acfp</span><a - id="dx1-34179"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-2" +class="ecss-1000">smaller</span><a + id="dx1-41028"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-2" class="td11"><span -class="ectt-1000">\Acrfullpl</span><a - id="dx1-34180"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-1" +class="ectt-1000">\acronymfont</span><a + id="dx1-41029"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-3" class="td11"><span -class="ectt-1000">\ac</span><a - id="dx1-34181"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-2" +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-4" class="td11"><span -class="ectt-1000">\gls</span><a - id="dx1-34182"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-1" + style="vertical-align:baseline;" id="TBL-7-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-1" class="td11"><span -class="ectt-1000">\Ac</span><a - id="dx1-34183"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-2" +class="ecss-1000">dua</span><a + id="dx1-41030"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-2" class="td11"><span -class="ectt-1000">\Gls</span><a - id="dx1-34184"></a> </td> -</tr><tr - style="vertical-align:baseline;" id="TBL-7-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-1" +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-3" class="td11"><span -class="ectt-1000">\acp</span><a - id="dx1-34185"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-2" +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-4" class="td11"><span -class="ectt-1000">\glspl</span><a - id="dx1-34186"></a> </td> +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td> </tr><tr - style="vertical-align:baseline;" id="TBL-7-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-1" + style="vertical-align:baseline;" id="TBL-7-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-1" +class="td11">None of the above </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-2" class="td11"><span -class="ectt-1000">\Acp</span><a - id="dx1-34187"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-2" +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-3" class="td11"><span -class="ectt-1000">\Glspl</span><a - id="dx1-34188"></a> </td></tr></table> +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-4" +class="td11"> </td></tr></table> </div></div> </div><hr class="endfloat" /> </div> -<!--l. 3765--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.10.1 </span> <a - id="x1-350002.10.1"></a>Defining A Custom Acronym Style</h5> -<!--l. 3768--><p class="noindent" >You may find that the predefined acronyms styles that come with the <span +<!--l. 4340--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">13.3 </span> <a + id="x1-4200013.3"></a>Defining A Custom Acronym Style</h4> +<!--l. 4343--><p class="noindent" >You may find that the predefined acronyms styles that come with the <span class="ecss-1000">glossaries </span>package don’t suit your requirements. In this case you can define your own style. This is done by redefining the following commands: -</p><!--l. 3772--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4347--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\CustomAcronymFields</span><span class="ectt-0900"> </span></span><a - id="dx1-35001"></a> <span + id="dx1-42001"></a> <span class="ectt-1000">\CustomAcronymFields </span></div><hr> -</p><!--l. 3774--><p class="noindent" > +</p><!--l. 4349--><p class="noindent" > This command sets up the keys for <span class="ectt-1000">\newglossaryentry</span><a - id="dx1-35002"></a> when you define an acronym + id="dx1-42002"></a> when you define an acronym using <span class="ectt-1000">\newacronym</span><a - id="dx1-35003"></a>. Within the definition of <span + id="dx1-42003"></a>. Within the definition of <span class="ectt-1000">\CustomAcronymFields</span>, you may use <span class="ectt-1000">\the\glslongtok</span><a - id="dx1-35004"></a> to access the long form, <span + id="dx1-42004"></a> to access the long form, <span class="ectt-1000">\the\glsshorttok</span><a - id="dx1-35005"></a> to access the short form + id="dx1-42005"></a> to access the short form and <span class="ectt-1000">\the\glslabeltok</span><a - id="dx1-35006"></a> to access the label. This command is typically used to set the + id="dx1-42006"></a> to access the label. This command is typically used to set the <span class="ecss-1000">name</span><a - id="dx1-35007"></a>, <span + id="dx1-42007"></a>, <span class="ecss-1000">first</span><a - id="dx1-35008"></a>, <span + id="dx1-42008"></a>, <span class="ecss-1000">firstplural</span><a - id="dx1-35009"></a>, <span + id="dx1-42009"></a>, <span class="ecss-1000">text</span><a - id="dx1-35010"></a> and <span + id="dx1-42010"></a> and <span class="ecss-1000">plural</span><a - id="dx1-35011"></a> keys. It may also be used to set the <span + id="dx1-42011"></a> keys. It may also be used to set the <span class="ecss-1000">symbol</span><a - id="dx1-35012"></a> or + id="dx1-42012"></a> or <span class="ecss-1000">description</span><a - id="dx1-35013"></a> keys depending on your requirements. -</p><!--l. 3785--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-42013"></a> keys depending on your requirements. +</p><!--l. 4360--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\SetCustomDisplayStyle</span><span class="ectt-0900"> </span></span><a - id="dx1-35014"></a> <span + id="dx1-42014"></a> <span class="ectt-1000">\SetCustomDisplayStyle{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3787--><p class="noindent" > +</p><!--l. 4362--><p class="noindent" > This is used to set up the display style for the glossary given by <span class="cmsy-10">⟨</span><span class="ecti-1000">type</span><span class="cmsy-10">⟩</span>. This should typically just use <span class="ectt-1000">\defglsdisplayfirst</span><a - id="dx1-35015"></a> and <span + id="dx1-42015"></a> and <span class="ectt-1000">\defglsdisplay</span><a - id="dx1-35016"></a>. -</p><!--l. 3792--><p class="indent" > Once you have redefined <span + id="dx1-42016"></a>. +</p><!--l. 4367--><p class="indent" > Once you have redefined <span class="ectt-1000">\CustomAcronymFields </span>and <span class="ectt-1000">\SetCustomDisplayStyle</span>, you must then switch to this style using -</p><!--l. 3794--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4369--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\SetCustomStyle</span><span class="ectt-0900"> </span></span><a - id="dx1-35017"></a> <span + id="dx1-42017"></a> <span class="ectt-1000">\SetCustomStyle </span></div><hr> -</p><!--l. 3796--><p class="noindent" > +</p><!--l. 4371--><p class="noindent" > Note that you may still use the <span class="ecss-1000">shortcuts</span><a - id="dx1-35018"></a> package option with your custom + id="dx1-42018"></a> package option with your custom style. -</p><!--l. 3800--><p class="indent" > <div class="important" title="Important Note"> If you omit <span +</p><!--l. 4375--><p class="indent" > <div class="important" title="Important Note"> If you omit <span class="ectt-1000">\SetCustomStyle</span>, or use it before you redefine <span class="ectt-1000">\CustomAcronymFields</span> and <span @@ -9004,168 +10903,218 @@ class="ectt-1000">\SetCustomDisplayStyle</span>, your new style won’t be c must set up the custom style before defining new acronyms. The acronyms must be defined using <span class="ectt-1000">\newacronym</span><a - id="dx1-35019"></a> not <span + id="dx1-42019"></a> not <span class="ectt-1000">\newglossaryentry</span><a - id="dx1-35020"></a>. </div> -</p><!--l. 3806--><p class="noindent" > -</p><!--l. 3808--><p class="indent" > As an example, suppose I want my acronym on first use to have the short form in + id="dx1-42020"></a>. </div> +</p><!--l. 4381--><p class="noindent" > +</p><!--l. 4383--><p class="indent" > As an example, suppose I want my acronym on <a + id="dx1-42021"></a><a +href="#glo:firstuse">first use</a> to have the short form in the text and the long form with the description in a footnote. Suppose also that I want -the short form to be put in small caps in the main body of the document, but I want -it in normal capitals in the list of acronyms. In my list of acronyms, I want -the long form as the name with the short form in brackets followed by the -description. -</p><!--l. 3816--><p class="indent" > First, I need to redefine <span +the short form to be put in small caps in the main body of the document, but I +want it in normal capitals in the list of acronyms. In my list of acronyms, +I want the long form as the name with the short form in brackets followed +by the description. That is, in the text I want <span +class="ectt-1000">\gls</span><a + id="dx1-42022"></a> on <a + id="dx1-42023"></a><a +href="#glo:firstuse">first use</a> to display: +<spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\textsc</span><a + id="dx1-42024"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}\footnote</span><span class="verb"><span +class="ectt-1000">{</span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span>: <span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span class="verb"><span +class="ectt-1000">}</span></span> + <br /><spacer type=vertical size=10></span> +on subsequent use: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\textsc</span><a + id="dx1-42025"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> + <br /><spacer type=vertical size=10></span> +and in the list of acronyms, each entry will be displayed in the form: <spacer type=vertical size=10><span class="obeylines-h"> + + + + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="ecti-1000">short</span><span +class="cmsy-10">⟩</span>) <span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> +</p><!--l. 4404--><p class="indent" > First, I need to redefine <span class="ectt-1000">\CustomAcronymFields</span><a - id="dx1-35021"></a> so that <span + id="dx1-42026"></a> so that <span class="ectt-1000">\newacronym</span><a - id="dx1-35022"></a> will correctly + id="dx1-42027"></a> will correctly set the <span class="ecss-1000">name</span><a - id="dx1-35023"></a>, <span + id="dx1-42028"></a>, <span class="ecss-1000">text</span><a - id="dx1-35024"></a> and <span + id="dx1-42029"></a> and <span class="ecss-1000">plural</span><a - id="dx1-35025"></a> keys. I want the long form to be stored in the + id="dx1-42030"></a> keys. I want the long form to be stored in the <span class="ecss-1000">name</span><a - id="dx1-35026"></a> and the short form to be stored in <span + id="dx1-42031"></a> and the short form to be stored in <span class="ecss-1000">text</span><a - id="dx1-35027"></a>. In addition, I’m going to set the + id="dx1-42032"></a>. In addition, I’m going to set the <span class="ecss-1000">symbol</span><a - id="dx1-35028"></a> to the short form in upper case so that it will appear in the list of + id="dx1-42033"></a> to the short form in upper case so that it will appear in the list of acronyms. </p> - <div class="verbatim" id="verbatim-100"> + <div class="verbatim" id="verbatim-120"> \renewcommand*{\CustomAcronymFields}{%  <br />  name={\the\glslongtok},%  <br />  symbol={\MakeUppercase{\the\glsshorttok}},%  <br />  text={\textsc{\the\glsshorttok}},% - <br />  plural={\textsc{\the\glsshorttok}s}% + <br />  plural={\textsc{\the\glsshorttok}\noexpand\acrpluralsuffix}%  <br />} </div> -<!--l. 3831--><p class="nopar" > -</p><!--l. 3833--><p class="indent" > Note that in this case I haven’t bothered with <span -class="ectt-1000">\acrpluralsuffix</span><a - id="dx1-35029"></a> and have just -inserted an “s”. -</p><!--l. 3836--><p class="indent" > When I use the custom acronym style, the short form is stored in <span -class="ecss-1000">user1</span><a - id="dx1-35030"></a>, -the plural short form is stored in <span -class="ecss-1000">user2</span><a - id="dx1-35031"></a>, the long form is stored in <span -class="ecss-1000">user3</span><a - id="dx1-35032"></a> and -the plural long form is stored in <span -class="ecss-1000">user4</span><a - id="dx1-35033"></a>. So when I use <span +<!--l. 4419--><p class="nopar" > +</p><!--l. 4421--><p class="indent" > When using <span +class="ectt-1000">\newacronym</span><a + id="dx1-42034"></a>, the short and long forms are stored in the <span +class="ecss-1000">short</span><a + id="dx1-42035"></a> and <span +class="ecss-1000">long</span><a + id="dx1-42036"></a> +keys, and the plural forms are stored in <span +class="ecss-1000">shortplural</span><a + id="dx1-42037"></a> and <span +class="ecss-1000">longplural</span><a + id="dx1-42038"></a>. So when I use +<span class="ectt-1000">\defglsdisplayfirst</span><a - id="dx1-35034"></a> -and <span + id="dx1-42039"></a> and <span class="ectt-1000">\defglsdisplay</span><a - id="dx1-35035"></a>, I can use <span -class="ectt-1000">\glsentryuseriii</span><a - id="dx1-35036"></a> to access the long form. -Recall from <a -href="#x1-220002.4.1">2.4.1 </a><a -href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>, that the optional + id="dx1-42040"></a>, I can use <span +class="ectt-1000">\glsentrylong</span><a + id="dx1-42041"></a> to access the +long form. Recall from <a +href="#x1-270006.1">6.1 </a><a +href="#x1-270006.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>, that the optional argument to <span class="ectt-1000">\defglsdisplayfirst</span><a - id="dx1-35037"></a> and <span + id="dx1-42042"></a> and <span class="ectt-1000">\defglsdisplay</span><a - id="dx1-35038"></a> indicates the glossary + id="dx1-42043"></a> indicates the glossary type. This is passed to <span class="ectt-1000">\SetCustomDisplayStyle</span><a - id="dx1-35039"></a>. The mandatory argument + id="dx1-42044"></a>. The mandatory argument sets up the definition of <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-35040"></a> and <span + id="dx1-42045"></a> and <span class="ectt-1000">\glsdisplay</span><a - id="dx1-35041"></a> for the given + id="dx1-42046"></a> for the given glossary, where the first argument corresponds to the <span class="ecss-1000">first</span><a - id="dx1-35042"></a>, <span + id="dx1-42047"></a>, <span class="ecss-1000">firstplural</span><a - id="dx1-35043"></a>, <span + id="dx1-42048"></a>, <span class="ecss-1000">text</span><a - id="dx1-35044"></a> or + id="dx1-42049"></a> or <span class="ecss-1000">plural</span><a - id="dx1-35045"></a>, as appropriate, the second argument corresponds to the <span + id="dx1-42050"></a>, as appropriate, the second argument corresponds to the <span class="ecss-1000">description</span><a - id="dx1-35046"></a>, + id="dx1-42051"></a>, the third corresponds to the <span class="ecss-1000">symbol</span><a - id="dx1-35047"></a> and the fourth argument is the inserted + id="dx1-42052"></a> and the fourth argument is the inserted text. </p> - <div class="verbatim" id="verbatim-101"> + <div class="verbatim" id="verbatim-121"> \renewcommand*{\SetCustomDisplayStyle}[1]{%  <br />  \defglsdisplayfirst[#1]{##1##4\protect\footnote{% - <br />    \glsentryuseriii{\glslabel}: ##2% + <br />    \glsentrylong{\glslabel}: ##2%  <br />  }}  <br />  \defglsdisplay[#1]{##1##4}%  <br />} </div> -<!--l. 3859--><p class="nopar" > -</p><!--l. 3861--><p class="indent" > Since we have a definition inside a definition, <span class="obeylines-h"><span class="verb"><span +<!--l. 4444--><p class="nopar" > +</p><!--l. 4446--><p class="indent" > Since we have a definition inside a definition, <span class="obeylines-h"><span class="verb"><span class="ectt-1000">#1</span></span></span> refers to the argument of <span class="ectt-1000">\SetCustomDisplayStyle</span><a - id="dx1-35048"></a>, and <span class="obeylines-h"><span class="verb"><span + id="dx1-42053"></a>, and <span class="obeylines-h"><span class="verb"><span class="ectt-1000">##1</span></span></span>, …, <span class="obeylines-h"><span class="verb"><span class="ectt-1000">##4</span></span></span>, refer to the arguments of <span class="ectt-1000">\glsdisplayfirst</span><a - id="dx1-35049"></a> + id="dx1-42054"></a> and <span class="ectt-1000">\glsdisplay</span><a - id="dx1-35050"></a>. -</p><!--l. 3866--><p class="indent" > Now that I’ve redefined <span + id="dx1-42055"></a>. +</p><!--l. 4451--><p class="indent" > Now that I’ve redefined <span class="ectt-1000">\CustomAcronymFields</span><a - id="dx1-35051"></a> and <span + id="dx1-42056"></a> and <span class="ectt-1000">\SetCustomDisplayStyle</span><a - id="dx1-35052"></a>, I + id="dx1-42057"></a>, I can set this style using </p> - <div class="verbatim" id="verbatim-102"> + <div class="verbatim" id="verbatim-122"> \SetCustomStyle </div> -<!--l. 3870--><p class="nopar" > and now I can define my acronyms: +<!--l. 4455--><p class="nopar" > and now I can define my acronyms: </p> - <div class="verbatim" id="verbatim-103"> + <div class="verbatim" id="verbatim-123"> \newacronym[description={set of tags for use in developing hypertext  <br />documents}]{html}{html}{Hyper Text Markup Language}  <br />\newacronym[description={language used to describe the layout of a  <br />document written in a markup language}]{css}{css}{Cascading Style  <br />Sheet} </div> -<!--l. 3879--><p class="nopar" > -</p><!--l. 3881--><p class="indent" > Note that since I’ve used the description in the main body of the text, I need to +<!--l. 4464--><p class="nopar" > +</p><!--l. 4466--><p class="indent" > Note that since I’ve used the description in the main body of the text, I need to switch off the sanitization otherwise any commands within the description won’t get interpreted. Also I want to use the <span class="ecss-1000">hyperref</span><a - id="dx1-35053"></a> package, but this will cause a problem on -first use as I’ll get nested hyperlinks, so I need to switch off the hyperlinks on first use. + id="dx1-42058"></a> package, but this will cause a problem on +<a + id="dx1-42059"></a><a +href="#glo:firstuse">first use</a> as I’ll get nested hyperlinks, so I need to switch off the hyperlinks on <a + id="dx1-42060"></a><a +href="#glo:firstuse">first use</a>. In addition, I want to use a glossary style that displays the symbol. Therefore, in my preamble I have: </p> - <div class="verbatim" id="verbatim-104"> + <div class="verbatim" id="verbatim-124"> \usepackage[colorlinks]{hyperref}  <br />\usepackage[acronym,         % create list of acronyms  <br />            nomain,          % don’t need main glossary for this example @@ -9175,25 +11124,25 @@ preamble I have:  <br />                             % will be used in the main text  <br />            ]{glossaries} </div> -<!--l. 3898--><p class="nopar" > -</p><!--l. 3900--><p class="indent" > Note that I haven’t used the <span +<!--l. 4483--><p class="nopar" > +</p><!--l. 4485--><p class="indent" > Note that I haven’t used the <span class="ecss-1000">description</span><a - id="dx1-35054"></a> or <span + id="dx1-42061"></a> or <span class="ecss-1000">footnote</span><a - id="dx1-35055"></a> package options. -</p><!--l. 3903--><p class="noindent" > + id="dx1-42062"></a> package options. +</p><!--l. 4488--><p class="noindent" > </p> -<!--l. 3903--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.10.2 </span> <a - id="x1-360002.10.2"></a>Upgrading From the glossary Package</h5> -<!--l. 3905--><p class="noindent" >Users of the obsolete <span +<!--l. 4488--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">13.4 </span> <a + id="x1-4300013.4"></a>Upgrading From the glossary Package</h4> +<!--l. 4490--><p class="noindent" >Users of the obsolete <span class="ecss-1000">glossary</span><a - id="dx1-36001"></a> package may recall that the syntax used to define new + id="dx1-43001"></a> package may recall that the syntax used to define new acronyms has changed with the replacement <span class="ecss-1000">glossaries </span>package. In addition, the old <span class="ecss-1000">glossary</span><a - id="dx1-36002"></a> package created the command <span + id="dx1-43002"></a> package created the command <span class="ectt-1000">\</span><span class="cmsy-10">⟨</span><span class="ecti-1000">acr-name</span><span @@ -9202,16 +11151,16 @@ class="cmsy-10">⟩ </span>when defining the acronym class="cmsy-10">⟨</span><span class="ecti-1000">acr-name</span><span class="cmsy-10">⟩</span>. -</p><!--l. 3911--><p class="indent" > In order to facilitate migrating from the old package to the new one, the <span +</p><!--l. 4496--><p class="indent" > In order to facilitate migrating from the old package to the new one, the <span class="ecss-1000">glossaries</span> package<span class="footnote-mark"><a -href="#fn11x0" id="fn11x0-bk"><sup class="textsuperscript">11</sup></a></span><a - id="x1-36003f11"></a> +href="#fn17x0" id="fn17x0-bk"><sup class="textsuperscript">17</sup></a></span><a + id="x1-43003f17"></a> provides the command: -</p><!--l. 3914--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4499--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\oldacronym</span><span class="ectt-0900"> </span></span><a - id="dx1-36004"></a> <span + id="dx1-43004"></a> <span class="ectt-1000">\oldacronym[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -9229,14 +11178,14 @@ class="cmsy-10">⟨</span><span class="ecti-1000">key-val list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3916--><p class="noindent" > +</p><!--l. 4501--><p class="noindent" > This uses the same syntax as the <span class="ecss-1000">glossary</span><a - id="dx1-36005"></a> package’s method of defining acronyms. It is + id="dx1-43005"></a> package’s method of defining acronyms. It is equivalent to:<br class="newline" /> <span class="ectt-1000">\newacronym</span><a - id="dx1-36006"></a><span + id="dx1-43006"></a><span class="ectt-1000">[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">key-val list</span><span @@ -9256,14 +11205,14 @@ class="cmsy-10">⟩</span><span class="ectt-1000">}</span><br class="newline" /> In addition, <span class="ectt-1000">\oldacronym</span><a - id="dx1-36007"></a> also defines the commands <span + id="dx1-43007"></a> also defines the commands <span class="ectt-1000">\</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>, which is equivalent to <span class="ectt-1000">\gls</span><a - id="dx1-36008"></a><span + id="dx1-43008"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -9275,7 +11224,7 @@ class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">*</span>, which is equivalent to <span class="ectt-1000">\Gls</span><a - id="dx1-36009"></a><span + id="dx1-43009"></a><span class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -9298,15 +11247,15 @@ class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>doesn’t allow you to use the first optional argument of <span class="ectt-1000">\gls</span><a - id="dx1-36010"></a> or <span + id="dx1-43010"></a> or <span class="ectt-1000">\Gls</span><a - id="dx1-36011"></a> — you will need to + id="dx1-43011"></a> — you will need to explicitly use <span class="ectt-1000">\gls</span><a - id="dx1-36012"></a> or <span + id="dx1-43012"></a> or <span class="ectt-1000">\Gls</span><a - id="dx1-36013"></a> to change the settings. -</p><!--l. 3931--><p class="indent" > <div class="important" title="Important Note"> Recall that, in general, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-43013"></a> to change the settings. +</p><!--l. 4516--><p class="indent" > <div class="important" title="Important Note"> Recall that, in general, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> ignores spaces following command names consisting of alphabetical characters. This is also true for <span class="ectt-1000">\</span><span @@ -9315,24 +11264,24 @@ class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>unless you additionally load the <span class="ecss-1000">xspace</span><a - id="dx1-36014"></a> package. </div> -</p><!--l. 3936--><p class="noindent" > + id="dx1-43014"></a> package. </div> +</p><!--l. 4521--><p class="noindent" > -</p><!--l. 3938--><p class="indent" > The <span +</p><!--l. 4523--><p class="indent" > The <span class="ecss-1000">glossaries </span>package doesn’t load the <span class="ecss-1000">xspace</span><a - id="dx1-36015"></a> package since there are both + id="dx1-43015"></a> package since there are both advantages and disadvantages to using <span class="ectt-1000">\xspace</span><a - id="dx1-36016"></a> in <span + id="dx1-43016"></a> in <span class="ectt-1000">\</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. If you don’t use the <span class="ecss-1000">xspace</span><a - id="dx1-36017"></a> + id="dx1-43017"></a> package you need to explicitly force a space using <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\␣</span></span></span> (backslash space) however you can follow <span @@ -9342,40 +11291,40 @@ class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>with additional text in square brackets (the final optional argument to <span class="ectt-1000">\gls</span><a - id="dx1-36018"></a>). If you use the <span + id="dx1-43018"></a>). If you use the <span class="ecss-1000">xspace</span><a - id="dx1-36019"></a> package you don’t need to escape the spaces but you + id="dx1-43019"></a> package you don’t need to escape the spaces but you can’t use the optional argument to insert text (you will have to explicitly use <span class="ectt-1000">\gls</span><a - id="dx1-36020"></a>). -</p><!--l. 3949--><p class="indent" > To illustrate this, suppose I define the acronym “abc” as follows: + id="dx1-43020"></a>). +</p><!--l. 4534--><p class="indent" > To illustrate this, suppose I define the acronym “abc” as follows: </p> - <div class="verbatim" id="verbatim-105"> + <div class="verbatim" id="verbatim-125"> \oldacronym{abc}{example acronym}{} </div> -<!--l. 3953--><p class="nopar" > This will create the command <span +<!--l. 4538--><p class="nopar" > This will create the command <span class="ectt-1000">\abc </span>and its starred version <span class="ectt-1000">\abc*</span>. <a -href="#x1-360237">Table 7</a> illustrates +href="#x1-430237">Table 7</a> illustrates the effect of <span class="ectt-1000">\abc </span>(on subsequent use) according to whether or not the <span class="ecss-1000">xspace</span><a - id="dx1-36021"></a> package + id="dx1-43021"></a> package has been loaded. As can be seen from the final row in the table, the <span class="ecss-1000">xspace</span><a - id="dx1-36022"></a> package + id="dx1-43022"></a> package prevents the optional argument from being recognised. </p> <div class="table"> -<!--l. 3961--><p class="indent" > <a - id="x1-360237"></a></p><hr class="float" /><div class="float" +<!--l. 4546--><p class="indent" > <a + id="x1-430237"></a></p><hr class="float" /><div class="float" > @@ -9384,7 +11333,7 @@ prevents the optional argument from being recognised. ><span class="id">Table 7: </span><span class="content">The effect of using <span class="ecss-1000">xspace </span>with <span -class="ectt-1000">\oldacronym</span></span></div><!--tex4ht:label?: x1-360237 --> +class="ectt-1000">\oldacronym</span></span></div><!--tex4ht:label?: x1-430237 --> <div class="tabular"> <table id="TBL-8" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-8-1g"><col @@ -9440,106 +11389,107 @@ class="td11">abc’s xyz </td></tr></table> </div><hr class="endfloat" /> </div> -<!--l. 3981--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.11 </span> <a - id="x1-370002.11"></a>Unsetting and Resetting Entry Flags</h4> -<!--l. 3984--><p class="noindent" >When using <span +<!--l. 4566--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">14 </span> <a + id="x1-4400014"></a>Unsetting and Resetting Entry Flags</h3> +<!--l. 4569--><p class="noindent" >When using <span class="ectt-1000">\gls</span><a - id="dx1-37001"></a>, <span + id="dx1-44001"></a>, <span class="ectt-1000">\glspl</span><a - id="dx1-37002"></a> and their uppercase variants it is possible that you may want + id="dx1-44002"></a> and their uppercase variants it is possible that you may want to use the value given by the <span class="ecss-1000">first</span><a - id="dx1-37003"></a> key, even though you have already used the glossary -entry<a - id="dx1-37004"></a>. Conversely, you may want to use the value given by the <span + id="dx1-44003"></a> key, even though you have already <a + id="dx1-44004"></a><a +href="#glo:firstuse">used</a> the glossary +entry. Conversely, you may want to use the value given by the <span class="ecss-1000">text</span><a - id="dx1-37005"></a> key, even though you + id="dx1-44005"></a> key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands: -</p><!--l. 3990--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4575--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsreset</span><span class="ectt-0900"> </span></span><a - id="dx1-37006"></a> <span + id="dx1-44006"></a> <span class="ectt-1000">\glsreset{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3992--><p class="noindent" > -</p><!--l. 3993--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4577--><p class="noindent" > +</p><!--l. 4578--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslocalreset</span><span class="ectt-0900"> </span></span><a - id="dx1-37007"></a> <span + id="dx1-44007"></a> <span class="ectt-1000">\glslocalreset{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3995--><p class="noindent" > +</p><!--l. 4580--><p class="noindent" > while the latter can be achieved by one of the following commands: -</p><!--l. 3997--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4582--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsunset</span><span class="ectt-0900"> </span></span><a - id="dx1-37008"></a> <span + id="dx1-44008"></a> <span class="ectt-1000">\glsunset{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 3999--><p class="noindent" > -</p><!--l. 4000--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4584--><p class="noindent" > +</p><!--l. 4585--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslocalunset</span><span class="ectt-0900"> </span></span><a - id="dx1-37009"></a> <span + id="dx1-44009"></a> <span class="ectt-1000">\glslocalunset{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4002--><p class="noindent" > +</p><!--l. 4587--><p class="noindent" > You can also reset or unset all entries for a given glossary or list of glossaries using: -</p><!--l. 4005--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4590--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsresetall</span><span class="ectt-0900"> </span></span><a - id="dx1-37010"></a> <span + id="dx1-44010"></a> <span class="ectt-1000">\glsresetall[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 4007--><p class="noindent" > -</p><!--l. 4008--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4592--><p class="noindent" > +</p><!--l. 4593--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslocalresetall</span><span class="ectt-0900"> </span></span><a - id="dx1-37011"></a> <span + id="dx1-44011"></a> <span class="ectt-1000">\glslocalresetall[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 4010--><p class="noindent" > -</p><!--l. 4011--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4595--><p class="noindent" > +</p><!--l. 4596--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsunsetall</span><span class="ectt-0900"> </span></span><a - id="dx1-37012"></a> <span + id="dx1-44012"></a> <span class="ectt-1000">\glsunsetall[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 4013--><p class="noindent" > -</p><!--l. 4014--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4598--><p class="noindent" > +</p><!--l. 4599--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslocalunsetall</span><span class="ectt-0900"> </span></span><a - id="dx1-37013"></a> <span + id="dx1-44013"></a> <span class="ectt-1000">\glslocalunsetall[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">glossary list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">] </span></div><hr> -</p><!--l. 4016--><p class="noindent" > +</p><!--l. 4601--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">glossary list</span><span @@ -9550,15 +11500,17 @@ of acronyms: </p> - <div class="verbatim" id="verbatim-106"> + <div class="verbatim" id="verbatim-126"> \glsresetall[main,acronym] </div> -<!--l. 4023--><p class="nopar" > -</p><!--l. 4025--><p class="indent" > You can determine whether an entry’s first use flag is set using: -</p><!--l. 4026--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +<!--l. 4608--><p class="nopar" > +</p><!--l. 4610--><p class="indent" > You can determine whether an entry’s <a + id="dx1-44014"></a><a +href="#glo:firstuseflag">first use flag</a> is set using: +</p><!--l. 4611--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\ifglsused</span><span class="ectt-0900"> </span></span><a - id="dx1-37014"></a> <span + id="dx1-44015"></a> <span class="ectt-1000">\ifglsused{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -9572,7 +11524,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">false part</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4028--><p class="noindent" > +</p><!--l. 4613--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -9584,27 +11536,37 @@ will be done, otherwise <span class="cmsy-10">⟨</span><span class="ecti-1000">false part</span><span class="cmsy-10">⟩ </span>will be done. -</p><!--l. 4034--><p class="noindent" > +</p><!--l. 4619--><p class="noindent" > </p> -<!--l. 4034--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.12 </span> <a - id="x1-380002.12"></a>Glossary Styles</h4> -<!--l. 4036--><p class="noindent" >The <span +<!--l. 4619--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">15 </span> <a + id="x1-4500015"></a>Glossary Styles</h3> +<!--l. 4621--><p class="noindent" >The <span class="ecss-1000">glossaries </span>package comes with some pre-defined glossary styles. Note that the styles are suited to different types of glossaries: some styles ignore the associated symbol; -some styles are not designed for hierarchical entries, so they display sub-entries in -the same way as they display top level entries; some styles are designed for -homographs, so they ignore the name for sub-entries. You should therefore pick a style -that suits your type of glossary. See <a -href="#x1-380018">table 8</a> for a summary of the available -styles. +some styles are not designed for hierarchical entries, so they display sub-entries in the +same way as they display top level entries; some styles are designed for homographs, so +they ignore the name for sub-entries. You should therefore pick a style that suits your +type of glossary. See <a +href="#x1-450048">table 8</a> for a summary of the available styles. The predefined styles +can accommodate numbered level 0 (main) and level 1 entries. See the package options +<span +class="ecss-1000">entrycounter</span><a + id="dx1-45001"></a>, <span +class="ecss-1000">counterwithin</span><a + id="dx1-45002"></a> and <span +class="ecss-1000">subentrycounter</span><a + id="dx1-45003"></a> described in <a +href="#x1-150002.3">2.3 </a><a +href="#x1-150002.3">Glossary Appearance +Options<!--tex4ht:ref: sec:pkgopts-printglos --></a>. </p> <div class="table"> -<!--l. 4046--><p class="indent" > <a - id="x1-380018"></a></p><hr class="float" /><div class="float" +<!--l. 4635--><p class="indent" > <a + id="x1-450048"></a></p><hr class="float" /><div class="float" > @@ -9616,20 +11578,22 @@ matches that doesn’t match any previously listed style (e.g. <span class="ectt-1000">long3col* </span>matches <span class="ecss-1000">long3col</span><a - id="dx1-38002"></a>, <span + id="dx1-45005"></a>, <span class="ecss-1000">long3colheader</span><a - id="dx1-38003"></a>, <span + id="dx1-45006"></a>, <span class="ecss-1000">long3colborder</span><a - id="dx1-38004"></a> and <span + id="dx1-45007"></a> and <span class="ecss-1000">long3colheaderborder</span><a - id="dx1-38005"></a>). A maximum + id="dx1-45008"></a>). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as — there is no limit, but -note that <span +note that <a + id="dx1-45009"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-38006"></a> imposes a limit of 2 sub-levels. If the homograph column is + id="dx1-45010"></a></a> imposes a limit of 2 sub-levels. If the homograph column is checked, then the name is not displayed for sub-entries. If the symbol column is -checked, then the symbol will be displayed if it has been defined.</span></div><!--tex4ht:label?: x1-380018 --> +checked, then the symbol will be displayed.</span></div><!--tex4ht:label?: x1-450048 --> <div class="tabular"> <table id="TBL-9" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-9-1g"><col @@ -9781,214 +11745,217 @@ class="pzdr-">✓ </span></td></tr></table></div> </div><hr class="endfloat" /> </div> -<!--l. 4085--><p class="indent" > The glossary style can be set using the <span +<!--l. 4674--><p class="indent" > The glossary style can be set using the <span class="ecss-1000">style</span><a - id="dx1-38007"></a> key in the optional argument to + id="dx1-45011"></a> key in the optional argument to <span class="ectt-1000">\printglossary</span><a - id="dx1-38008"></a> or using the command: -</p><!--l. 4087--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-45012"></a> or using the command: +</p><!--l. 4676--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossarystyle</span><span class="ectt-0900"> </span></span><a - id="dx1-38009"></a> <span + id="dx1-45013"></a> <span class="ectt-1000">\glossarystyle{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">style-name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4089--><p class="noindent" > +</p><!--l. 4678--><p class="noindent" > Some of the glossary styles may also be set using the <span class="ecss-1000">style</span><a - id="dx1-38010"></a> package option, it depends if + id="dx1-45014"></a> package option, it depends if the package in which they are defined is automatically loaded by the <span class="ecss-1000">glossaries</span> package. -</p><!--l. 4094--><p class="indent" > The tabular-like styles that allow multi-line descriptions and page lists use the +</p><!--l. 4683--><p class="indent" > The tabular-like styles that allow multi-line descriptions and page lists use the length <span class="marginpar"><span class="ectt-0900">\glsdescwidth</span><span class="ectt-0900"> </span></span><a - id="dx1-38011"></a><span + id="dx1-45015"></a><span class="ectt-1000">\glsdescwidth </span>to set the width of the description column and the length <span class="marginpar"><span class="ectt-0900">\glspagelistwidth</span><span class="ectt-0900"> </span></span><a - id="dx1-38012"></a><span + id="dx1-45016"></a><span class="ectt-1000">\glspagelistwidth </span>to set the width of the page list column.<span class="footnote-mark"><a -href="#fn12x0" id="fn12x0-bk"><sup class="textsuperscript">12</sup></a></span><a - id="x1-38013f12"></a> +href="#fn18x0" id="fn18x0-bk"><sup class="textsuperscript">18</sup></a></span><a + id="x1-45017f18"></a> These will need to be changed using <span class="ectt-1000">\setlength </span>if the glossary is too wide. Note that the <span class="ecss-1000">long4col</span><a - id="dx1-38017"></a> and <span + id="dx1-45021"></a> and <span class="ecss-1000">super4col</span><a - id="dx1-38018"></a> styles (and their header and border variations) don’t use + id="dx1-45022"></a> styles (and their header and border variations) don’t use these lengths as they are designed for single line entries. Instead you should use the analogous <span class="ecss-1000">altlong4col</span><a - id="dx1-38019"></a> and <span + id="dx1-45023"></a> and <span class="ecss-1000">altsuper4col</span><a - id="dx1-38020"></a> styles. If you want to explicitly create a line-break + id="dx1-45024"></a> styles. If you want to explicitly create a line-break within a multi-line description in a tabular-like style you should use <span class="ectt-1000">\newline</span><a - id="dx1-38021"></a> instead + id="dx1-45025"></a> instead of <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\\</span></span></span>. -</p><!--l. 4112--><p class="indent" > Note that if you use the <span +</p><!--l. 4701--><p class="indent" > Note that if you use the <span class="ecss-1000">style</span><a - id="dx1-38022"></a> key in the optional argument to <span + id="dx1-45026"></a> key in the optional argument to <span class="ectt-1000">\printglossary</span><a - id="dx1-38023"></a>, it + id="dx1-45027"></a>, it will override any previous style settings for the given glossary, so if, for example, you do </p> - <div class="verbatim" id="verbatim-107"> + <div class="verbatim" id="verbatim-127"> \renewcommand*{\glsgroupskip}{}  <br />\printglossary[style=long] </div> -<!--l. 4119--><p class="nopar" > then the new definition of <span +<!--l. 4708--><p class="nopar" > then the new definition of <span class="ectt-1000">\glsgroupskip</span><a - id="dx1-38024"></a> will not have an affect for this glossary, as + id="dx1-45028"></a> will not have an affect for this glossary, as <span class="ectt-1000">\glsgroupskip </span>is redefined by <span class="obeylines-h"><span class="verb"><span class="ectt-1000">style=long</span></span></span>. Likewise, <span class="ectt-1000">\glossarystyle</span><a - id="dx1-38025"></a> will also + id="dx1-45029"></a> will also override any previous style definitions, so, again </p> - <div class="verbatim" id="verbatim-108"> + <div class="verbatim" id="verbatim-128"> \renewcommand*{\glsgroupskip}{}  <br />\glossarystyle{long} </div> -<!--l. 4127--><p class="nopar" > will reset <span +<!--l. 4716--><p class="nopar" > will reset <span class="ectt-1000">\glsgroupskip </span>back to its default definition for the named glossary style (<span class="ecss-1000">long</span><a - id="dx1-38026"></a> in this case). If you want to modify the styles, either use <span + id="dx1-45030"></a> in this case). If you want to modify the styles, either use <span class="ectt-1000">\newglossarystyle</span><a - id="dx1-38027"></a> + id="dx1-45031"></a> (described in the next section) or make the modifications after <span class="ectt-1000">\glossarystyle</span><a - id="dx1-38028"></a>, + id="dx1-45032"></a>, e.g.: </p> - <div class="verbatim" id="verbatim-109"> + <div class="verbatim" id="verbatim-129"> \glossarystyle{long}  <br />\renewcommand*{\glsgroupskip}{} </div> -<!--l. 4136--><p class="nopar" > -<a - id="dx1-38029"></a> -</p><!--l. 4139--><p class="indent" > All the styles except for the three- and four-column styles and the <span +<!--l. 4725--><p class="nopar" > +</p><!--l. 4727--><p class="indent" > All the styles except for the three- and four-column styles and the <span class="ecss-1000">listdotted</span><a - id="dx1-38030"></a> style use + id="dx1-45033"></a> style use the command -</p><!--l. 4141--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 4729--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glspostdescription</span><span class="ectt-0900"> </span></span><a - id="dx1-38031"></a> <span + id="dx1-45034"></a> <span class="ectt-1000">\glspostdescription </span></div><hr> -</p><!--l. 4143--><p class="noindent" > +</p><!--l. 4731--><p class="noindent" > after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine <span class="ectt-1000">\glspostdescription </span>before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing <span class="ectt-1000">\nopostdesc</span><a - id="dx1-38032"></a> in the entry’s + id="dx1-45035"></a> in the entry’s description. </p> -<!--l. 4150--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.1 </span> <a - id="x1-390002.12.1"></a>List Styles</h5> -<!--l. 4153--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 4738--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.1 </span> <a + id="x1-4600015.1"></a>List Styles</h4> +<!--l. 4741--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-list</span><a - id="dx1-39001"></a>. Since they + id="dx1-46001"></a>. Since they all use the <span class="ecss-1000">description</span><a - id="dx1-39002"></a><a - id="dx1-39003"></a> environment, they are governed by the same parameters as that + id="dx1-46002"></a><a + id="dx1-46003"></a> environment, they are governed by the same parameters as that environment. These styles all ignore the entry’s symbol. Note that these styles will automatically be available unless you use the <span class="ecss-1000">nolist</span><a - id="dx1-39004"></a> or <span + id="dx1-46004"></a> or <span class="ecss-1000">nostyles</span><a - id="dx1-39005"></a> package + id="dx1-46005"></a> package options. -</p><!--l. 4160--><p class="indent" > +</p><!--l. 4748--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">list</span> </dt><dd class="description">The <span class="ecss-1000">list</span><a - id="dx1-39006"></a> style uses the <span + id="dx1-46006"></a> style uses the <span class="ecss-1000">description</span><a - id="dx1-39007"></a><a - id="dx1-39008"></a> environment. The entry name is placed in + id="dx1-46007"></a><a + id="dx1-46008"></a> environment. The entry name is placed in the optional argument of the <span -class="ectt-1000">\item </span>command (so it will appear in bold by - default). The description follows, and then the associated number list<a - id="dx1-39009"></a> for that +class="ectt-1000">\item</span><a + id="dx1-46009"></a> command (so it will appear in bold by + default). The description follows, and then the associated <a + id="dx1-46010"></a><a +href="#glo:numberlist">number list<a + id="dx1-46011"></a></a> for that entry. The symbol is ignored. If the entry has child entries, the description and number list follows (but not the name) for each child entry. Groups are separated using <span -class="ectt-1000">\indexspace</span>. +class="ectt-1000">\indexspace</span><a + id="dx1-46012"></a>. </dd><dt class="description"> <span class="ecbx-1000">listgroup</span> </dt><dd class="description">The <span class="ecss-1000">listgroup</span><a - id="dx1-39010"></a> style is like <span + id="dx1-46013"></a> style is like <span class="ecss-1000">list</span><a - id="dx1-39011"></a> but the glossary groups have headings. + id="dx1-46014"></a> but the glossary groups have headings. </dd><dt class="description"> <span class="ecbx-1000">listhypergroup</span> </dt><dd class="description">The <span class="ecss-1000">listhypergroup</span><a - id="dx1-39012"></a> style is like <span + id="dx1-46015"></a> style is like <span class="ecss-1000">listgroup</span><a - id="dx1-39013"></a> but has a navigation line at + id="dx1-46016"></a> but has a navigation line at the start of the glossary with links to each group that is present in the glossary. This requires an additional run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> to ensure the group information is up to date. In the navigation line, each group is separated by - - - - <!--l. 4178--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 4766--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glshypernavsep</span><span class="ectt-0900"> </span></span><a - id="dx1-39014"></a> <span + id="dx1-46017"></a> <span class="ectt-1000">\glshypernavsep </span></div><hr> - </p><!--l. 4180--><p class="noindent" > + + + + </p><!--l. 4768--><p class="noindent" > which defaults to a vertical bar with a space on either side. For example, to simply have a space separating each group, do: </p> - <div class="verbatim" id="verbatim-110"> + <div class="verbatim" id="verbatim-130"> \renewcommand*{\glshypernavsep}{\space} </div> - <!--l. 4185--><p class="nopar" > - </p><!--l. 4187--><p class="noindent" >Note that the hyper-navigation line is now (as from version 1.14) set inside the + <!--l. 4773--><p class="nopar" > + </p><!--l. 4775--><p class="noindent" >Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to <span -class="ectt-1000">\item </span>instead of after it to prevent a spurious +class="ectt-1000">\item</span><a + id="dx1-46018"></a> instead of after it to prevent a spurious space at the start. This can be changed by redefining <span class="ectt-1000">\glossaryheader</span><a - id="dx1-39015"></a>, + id="dx1-46019"></a>, but note that this needs to be done <span class="ecti-1000">after </span>the glossary style has been set. @@ -9997,58 +11964,60 @@ class="ecti-1000">after </span>the glossary style has been class="ecbx-1000">altlist</span> </dt><dd class="description">The <span class="ecss-1000">altlist</span><a - id="dx1-39016"></a> style is like <span + id="dx1-46020"></a> style is like <span class="ecss-1000">list</span><a - id="dx1-39017"></a> but the description starts on the line following the + id="dx1-46021"></a> but the description starts on the line following the name. (As with the <span class="ecss-1000">list</span><a - id="dx1-39018"></a> style, the symbol is ignored.) Each child entry starts a new + id="dx1-46022"></a> style, the symbol is ignored.) Each child entry starts a new line, but as with the <span class="ecss-1000">list</span><a - id="dx1-39019"></a> style, the name associated with each child entry is + id="dx1-46023"></a> style, the name associated with each child entry is ignored. </dd><dt class="description"> <span class="ecbx-1000">altlistgroup</span> </dt><dd class="description">The <span class="ecss-1000">altlistgroup</span><a - id="dx1-39020"></a> style is like <span + id="dx1-46024"></a> style is like <span class="ecss-1000">altlist</span><a - id="dx1-39021"></a> but the glossary groups have + id="dx1-46025"></a> but the glossary groups have headings. </dd><dt class="description"> <span class="ecbx-1000">altlisthypergroup</span> </dt><dd class="description">The <span class="ecss-1000">altlisthypergroup</span><a - id="dx1-39022"></a> style is like <span + id="dx1-46026"></a> style is like <span class="ecss-1000">altlistgroup</span><a - id="dx1-39023"></a> but has a set of links + id="dx1-46027"></a> but has a set of links to the glossary groups. The navigation line is the same as that for <span class="ecss-1000">listhypergroup</span><a - id="dx1-39024"></a>, + id="dx1-46028"></a>, described above. </dd><dt class="description"> <span class="ecbx-1000">listdotted</span> </dt><dd class="description">This style uses the <span class="ecss-1000">description</span><a - id="dx1-39025"></a><a - id="dx1-39026"></a> + id="dx1-46029"></a><a + id="dx1-46030"></a> environment.<span class="footnote-mark"><a -href="#fn13x0" id="fn13x0-bk"><sup class="textsuperscript">13</sup></a></span><a - id="x1-39027f13"></a> +href="#fn19x0" id="fn19x0-bk"><sup class="textsuperscript">19</sup></a></span><a + id="x1-46031f19"></a> Each entry starts with <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\item[]</span></span></span>, followed by the name followed by a dotted line, - followed by the description. Note that this style ignores both the number list<a - id="dx1-39028"></a> and + followed by the description. Note that this style ignores both the <a + id="dx1-46032"></a><a +href="#glo:numberlist">number list<a + id="dx1-46033"></a></a> and the symbol. The length - <!--l. 4212--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 4800--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glslistdottedwidth</span><span class="ectt-0900"> </span></span><a - id="dx1-39029"></a> <span + id="dx1-46034"></a> <span class="ectt-1000">\glslistdottedwidth </span></div><hr> - </p><!--l. 4214--><p class="noindent" > + </p><!--l. 4802--><p class="noindent" > governs where the description should start. This is a flat style, so child entries are formatted in the same way as the parent entries. </p></dd><dt class="description"> @@ -10056,57 +12025,59 @@ class="ectt-1000">\glslistdottedwidth </span></div><hr> class="ecbx-1000">sublistdotted</span> </dt><dd class="description">This is a variation on the <span class="ecss-1000">listdotted</span><a - id="dx1-39030"></a> style designed for hierarchical + id="dx1-46035"></a> style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as <span class="ecss-1000">listdotted</span><a - id="dx1-39031"></a>.</dd></dl> + id="dx1-46036"></a>.</dd></dl> -<!--l. 4225--><p class="noindent" > +<!--l. 4813--><p class="noindent" > </p> -<!--l. 4225--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.2 </span> <a - id="x1-400002.12.2"></a>Longtable Styles</h5> -<!--l. 4228--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 4813--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.2 </span> <a + id="x1-4700015.2"></a>Longtable Styles</h4> +<!--l. 4816--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-long</span><a - id="dx1-40001"></a>. Since + id="dx1-47001"></a>. Since they all use the <span class="ecss-1000">longtable</span><a - id="dx1-40002"></a><a - id="dx1-40003"></a> environment, they are governed by the same parameters + id="dx1-47002"></a><a + id="dx1-47003"></a> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the <span class="ecss-1000">nolong</span><a - id="dx1-40004"></a> or <span + id="dx1-47004"></a> or <span class="ecss-1000">nostyles</span><a - id="dx1-40005"></a> package options. These styles fully justify + id="dx1-47005"></a> package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in <a -href="#x1-410002.12.3">2.12.3 </a><a -href="#x1-410002.12.3">Longtable Styles (Ragged +href="#x1-4800015.3">15.3 </a><a +href="#x1-4800015.3">Longtable Styles (Ragged Right)<!--tex4ht:ref: sec:longraggedstyles --></a>. -</p><!--l. 4238--><p class="indent" > +</p><!--l. 4826--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">long</span> </dt><dd class="description">The <span class="ecss-1000">long</span><a - id="dx1-40006"></a> style uses the <span + id="dx1-47006"></a> style uses the <span class="ecss-1000">longtable</span><a - id="dx1-40007"></a><a - id="dx1-40008"></a> environment (defined by the <span + id="dx1-47007"></a><a + id="dx1-47008"></a> environment (defined by the <span class="ecss-1000">longtable</span><a - id="dx1-40009"></a> + id="dx1-47009"></a> package). It has two columns: the first column contains the entry’s name and - the second column contains the description followed by the number list<a - id="dx1-40010"></a>. The + the second column contains the description followed by the <a + id="dx1-47010"></a><a +href="#glo:numberlist">number list<a + id="dx1-47011"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-40011"></a>. + id="dx1-47012"></a>. Child entries have a similar format to the parent entries except that their name is suppressed. </dd><dt class="description"> @@ -10114,62 +12085,64 @@ class="ectt-1000">\glsdescwidth</span><a class="ecbx-1000">longborder</span> </dt><dd class="description">The <span class="ecss-1000">longborder</span><a - id="dx1-40012"></a> style is like <span + id="dx1-47013"></a> style is like <span class="ecss-1000">long</span><a - id="dx1-40013"></a> but has horizontal and vertical lines + id="dx1-47014"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">longheader</span> </dt><dd class="description">The <span class="ecss-1000">longheader</span><a - id="dx1-40014"></a> style is like <span + id="dx1-47015"></a> style is like <span class="ecss-1000">long</span><a - id="dx1-40015"></a> but has a header row. + id="dx1-47016"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">longheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">longheaderborder</span><a - id="dx1-40016"></a> style is like <span + id="dx1-47017"></a> style is like <span class="ecss-1000">longheader</span><a - id="dx1-40017"></a> but has + id="dx1-47018"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">long3col</span> </dt><dd class="description">The <span class="ecss-1000">long3col</span><a - id="dx1-40018"></a> style is like <span + id="dx1-47019"></a> style is like <span class="ecss-1000">long</span><a - id="dx1-40019"></a> but has three columns. The first column + id="dx1-47020"></a> but has three columns. The first column contains the entry’s name, the second column contains the description and - the third column contains the number list<a - id="dx1-40020"></a>. The entry’s symbol is ignored. The + the third column contains the <a + id="dx1-47021"></a><a +href="#glo:numberlist">number list<a + id="dx1-47022"></a></a>. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-40021"></a>, and + id="dx1-47023"></a>, and the width of the third column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-40022"></a>. + id="dx1-47024"></a>. </dd><dt class="description"> <span class="ecbx-1000">long3colborder</span> </dt><dd class="description">The <span class="ecss-1000">long3colborder</span><a - id="dx1-40023"></a> style is like the <span + id="dx1-47025"></a> style is like the <span class="ecss-1000">long3col</span><a - id="dx1-40024"></a> style but has + id="dx1-47026"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">long3colheader</span> </dt><dd class="description">The <span class="ecss-1000">long3colheader</span><a - id="dx1-40025"></a> style is like <span + id="dx1-47027"></a> style is like <span class="ecss-1000">long3col</span><a - id="dx1-40026"></a> but has a header row. + id="dx1-47028"></a> but has a header row. @@ -10178,167 +12151,169 @@ class="ecss-1000">long3col</span><a class="ecbx-1000">long3colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">long3colheaderborder</span><a - id="dx1-40027"></a> style is like <span + id="dx1-47029"></a> style is like <span class="ecss-1000">long3colheader</span><a - id="dx1-40028"></a> but + id="dx1-47030"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">long4col</span> </dt><dd class="description">The <span class="ecss-1000">long4col</span><a - id="dx1-40029"></a> style is like <span + id="dx1-47031"></a> style is like <span class="ecss-1000">long3col</span><a - id="dx1-40030"></a> but has an additional column in which + id="dx1-47032"></a> but has an additional column in which the entry’s associated symbol appears. This style is used for brief single line descriptions. The column widths are governed by the widest entry in the given column. Use <span class="ecss-1000">altlong4col</span><a - id="dx1-40031"></a> for multi-line descriptions. + id="dx1-47033"></a> for multi-line descriptions. </dd><dt class="description"> <span class="ecbx-1000">long4colborder</span> </dt><dd class="description">The <span class="ecss-1000">long4colborder</span><a - id="dx1-40032"></a> style is like the <span + id="dx1-47034"></a> style is like the <span class="ecss-1000">long4col</span><a - id="dx1-40033"></a> style but has + id="dx1-47035"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">long4colheader</span> </dt><dd class="description">The <span class="ecss-1000">long4colheader</span><a - id="dx1-40034"></a> style is like <span + id="dx1-47036"></a> style is like <span class="ecss-1000">long4col</span><a - id="dx1-40035"></a> but has a header row. + id="dx1-47037"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">long4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">long4colheaderborder</span><a - id="dx1-40036"></a> style is like <span + id="dx1-47038"></a> style is like <span class="ecss-1000">long4colheader</span><a - id="dx1-40037"></a> but + id="dx1-47039"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altlong4col</span> </dt><dd class="description">The <span class="ecss-1000">altlong4col</span><a - id="dx1-40038"></a> style is like <span + id="dx1-47040"></a> style is like <span class="ecss-1000">long4col</span><a - id="dx1-40039"></a> but allows multi-line descriptions + id="dx1-47041"></a> but allows multi-line descriptions and page lists. The width of the description column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-40040"></a> and the width of the page list column is governed by the + id="dx1-47042"></a> and the width of the page list column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-40041"></a>. The widths of the name and symbol columns + id="dx1-47043"></a>. The widths of the name and symbol columns are governed by the widest entry in the given column. </dd><dt class="description"> <span class="ecbx-1000">altlong4colborder</span> </dt><dd class="description">The <span class="ecss-1000">altlong4colborder</span><a - id="dx1-40042"></a> style is like the <span + id="dx1-47044"></a> style is like the <span class="ecss-1000">long4colborder</span><a - id="dx1-40043"></a> but + id="dx1-47045"></a> but allows multi-line descriptions and page lists. </dd><dt class="description"> <span class="ecbx-1000">altlong4colheader</span> </dt><dd class="description">The <span class="ecss-1000">altlong4colheader</span><a - id="dx1-40044"></a> style is like <span + id="dx1-47046"></a> style is like <span class="ecss-1000">long4colheader</span><a - id="dx1-40045"></a> but allows + id="dx1-47047"></a> but allows multi-line descriptions and page lists. </dd><dt class="description"> <span class="ecbx-1000">altlong4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">altlong4colheaderborder</span><a - id="dx1-40046"></a> + id="dx1-47048"></a> style is like <span class="ecss-1000">long4colheaderborder</span><a - id="dx1-40047"></a> but allows multi-line descriptions and page + id="dx1-47049"></a> but allows multi-line descriptions and page lists.</dd></dl> -<!--l. 4321--><p class="noindent" > +<!--l. 4909--><p class="noindent" > </p> -<!--l. 4321--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.3 </span> <a - id="x1-410002.12.3"></a>Longtable Styles (Ragged Right)</h5> -<!--l. 4324--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 4909--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.3 </span> <a + id="x1-4800015.3"></a>Longtable Styles (Ragged Right)</h4> + + + +<!--l. 4912--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-longragged</span><a - id="dx1-41001"></a>. + id="dx1-48001"></a>. These styles are analogous to those defined in <span class="ecss-1000">glossary-long</span><a - id="dx1-41002"></a> but the multiline + id="dx1-48002"></a> but the multiline columns are left justified instead of fully justified. Since these styles all use - - - the <span class="ecss-1000">longtable</span><a - id="dx1-41003"></a><a - id="dx1-41004"></a> environment, they are governed by the same parameters as that + id="dx1-48003"></a><a + id="dx1-48004"></a> environment, they are governed by the same parameters as that environment. The <span class="ecss-1000">glossary-longragged</span><a - id="dx1-41005"></a> package additionally requires the <span + id="dx1-48005"></a> package additionally requires the <span class="ecss-1000">array</span><a - id="dx1-41006"></a> + id="dx1-48006"></a> package. Note that these styles will only be available if you explicitly load <span class="ecss-1000">glossary-longragged</span><a - id="dx1-41007"></a>: + id="dx1-48007"></a>: </p> - <div class="verbatim" id="verbatim-111"> + <div class="verbatim" id="verbatim-131"> \usepackage{glossaries}  <br />\usepackage{glossary-longragged} </div> -<!--l. 4336--><p class="nopar" > Note that you can’t set these styles using the <span +<!--l. 4924--><p class="nopar" > Note that you can’t set these styles using the <span class="ecss-1000">style</span><a - id="dx1-41008"></a> package option since the styles + id="dx1-48008"></a> package option since the styles aren’t defined until after the <span class="ecss-1000">glossaries </span>package has been loaded. -</p><!--l. 4341--><p class="indent" > +</p><!--l. 4929--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">longragged</span> </dt><dd class="description">The <span class="ecss-1000">longragged</span><a - id="dx1-41009"></a> style has two columns: the first column contains the + id="dx1-48009"></a> style has two columns: the first column contains the entry’s name and the second column contains the (left-justified) description - followed by the number list<a - id="dx1-41010"></a>. The entry’s symbol is ignored. Sub groups are + followed by the <a + id="dx1-48010"></a><a +href="#glo:numberlist">number list<a + id="dx1-48011"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-41011"></a>. Child entries have a similar format to the parent + id="dx1-48012"></a>. Child entries have a similar format to the parent entries except that their name is suppressed. </dd><dt class="description"> <span class="ecbx-1000">longraggedborder</span> </dt><dd class="description">The <span class="ecss-1000">longraggedborder</span><a - id="dx1-41012"></a> style is like <span + id="dx1-48013"></a> style is like <span class="ecss-1000">longragged</span><a - id="dx1-41013"></a> but has + id="dx1-48014"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">longraggedheader</span> </dt><dd class="description">The <span class="ecss-1000">longraggedheader</span><a - id="dx1-41014"></a> style is like <span + id="dx1-48015"></a> style is like <span class="ecss-1000">longragged</span><a - id="dx1-41015"></a> but has a header + id="dx1-48016"></a> but has a header row. </dd><dt class="description"> <span @@ -10346,46 +12321,48 @@ class="ecbx-1000">longraggedheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">longraggedheaderborder</span><a - id="dx1-41016"></a> style is like <span + id="dx1-48017"></a> style is like <span class="ecss-1000">longraggedheader</span><a - id="dx1-41017"></a> but has horizontal and + id="dx1-48018"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">longragged3col</span> </dt><dd class="description">The <span class="ecss-1000">longragged3col</span><a - id="dx1-41018"></a> style is like <span + id="dx1-48019"></a> style is like <span class="ecss-1000">longragged</span><a - id="dx1-41019"></a> but has three + id="dx1-48020"></a> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the - (left justified) number list<a - id="dx1-41020"></a>. The entry’s symbol is ignored. The width of the + (left justified) <a + id="dx1-48021"></a><a +href="#glo:numberlist">number list<a + id="dx1-48022"></a></a>. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-41021"></a>, and the width + id="dx1-48023"></a>, and the width of the third column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-41022"></a>. + id="dx1-48024"></a>. </dd><dt class="description"> <span class="ecbx-1000">longragged3colborder</span> </dt><dd class="description">The <span class="ecss-1000">longragged3colborder</span><a - id="dx1-41023"></a> style is like the <span + id="dx1-48025"></a> style is like the <span class="ecss-1000">longragged3col</span><a - id="dx1-41024"></a> + id="dx1-48026"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">longragged3colheader</span> </dt><dd class="description">The <span class="ecss-1000">longragged3colheader</span><a - id="dx1-41025"></a> style is like <span + id="dx1-48027"></a> style is like <span class="ecss-1000">longragged3col</span><a - id="dx1-41026"></a> but + id="dx1-48028"></a> but has a header row. @@ -10395,25 +12372,25 @@ class="ecss-1000">longragged3col</span><a class="ecbx-1000">longragged3colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">longragged3colheaderborder</span><a - id="dx1-41027"></a> style is like + id="dx1-48029"></a> style is like <span class="ecss-1000">longragged3colheader</span><a - id="dx1-41028"></a> but has horizontal and vertical lines around it. + id="dx1-48030"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altlongragged4col</span> </dt><dd class="description">The <span class="ecss-1000">altlongragged4col</span><a - id="dx1-41029"></a> style is like <span + id="dx1-48031"></a> style is like <span class="ecss-1000">longragged3col</span><a - id="dx1-41030"></a> but has an + id="dx1-48032"></a> but has an additional column in which the entry’s associated symbol appears. The width of the description column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-41031"></a> and the + id="dx1-48033"></a> and the width of the page list column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-41032"></a>. + id="dx1-48034"></a>. The widths of the name and symbol columns are governed by the widest entry in the given column. </dd><dt class="description"> @@ -10422,78 +12399,80 @@ class="ecbx-1000">altlongragged4colborder</span> </dt><dd class="description">The <span class="ecss-1000">altlongragged4colborder</span><a - id="dx1-41033"></a> style is like the <span + id="dx1-48035"></a> style is like the <span class="ecss-1000">altlongragged4col</span><a - id="dx1-41034"></a> but has horizontal + id="dx1-48036"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altlongragged4colheader</span> </dt><dd class="description">The <span class="ecss-1000">altlongragged4colheader</span><a - id="dx1-41035"></a> style is like + id="dx1-48037"></a> style is like <span class="ecss-1000">altlongragged4col</span><a - id="dx1-41036"></a> but has a header row. + id="dx1-48038"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">altlongragged4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">altlongragged4colheaderborder</span><a - id="dx1-41037"></a> style is like + id="dx1-48039"></a> style is like <span class="ecss-1000">altlongragged4colheader</span><a - id="dx1-41038"></a> but has horizontal and vertical lines around it. + id="dx1-48040"></a> but has horizontal and vertical lines around it. </dd></dl> -<!--l. 4408--><p class="noindent" > +<!--l. 4996--><p class="noindent" > </p> -<!--l. 4408--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.4 </span> <a - id="x1-420002.12.4"></a>Supertabular Styles</h5> -<!--l. 4411--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 4996--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.4 </span> <a + id="x1-4900015.4"></a>Supertabular Styles</h4> +<!--l. 4999--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-super</span><a - id="dx1-42001"></a>. Since + id="dx1-49001"></a>. Since they all use the <span class="ecss-1000">supertabular</span><a - id="dx1-42002"></a><a - id="dx1-42003"></a> environment, they are governed by the same parameters + id="dx1-49002"></a><a + id="dx1-49003"></a> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the <span class="ecss-1000">nosuper</span><a - id="dx1-42004"></a> or <span + id="dx1-49004"></a> or <span class="ecss-1000">nostyles</span><a - id="dx1-42005"></a> package options. In general, the <span + id="dx1-49005"></a> package options. In general, the <span class="ecss-1000">longtable</span><a - id="dx1-42006"></a><a - id="dx1-42007"></a> + id="dx1-49006"></a><a + id="dx1-49007"></a> environment is better, but there are some circumstances where it is better to use <span class="ecss-1000">supertabular</span><a - id="dx1-42008"></a><a - id="dx1-42009"></a>.<span class="footnote-mark"><a -href="#fn14x0" id="fn14x0-bk"><sup class="textsuperscript">14</sup></a></span><a - id="x1-42010f14"></a> + id="dx1-49008"></a><a + id="dx1-49009"></a>.<span class="footnote-mark"><a +href="#fn20x0" id="fn20x0-bk"><sup class="textsuperscript">20</sup></a></span><a + id="x1-49010f20"></a> These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in <a -href="#x1-430002.12.5">2.12.5 </a><a -href="#x1-430002.12.5">Supertabular Styles +href="#x1-5000015.5">15.5 </a><a +href="#x1-5000015.5">Supertabular Styles (Ragged Right)<!--tex4ht:ref: sec:superraggedstyles --></a>. -</p><!--l. 4423--><p class="indent" > +</p><!--l. 5011--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">super</span> </dt><dd class="description">The <span class="ecss-1000">super</span><a - id="dx1-42012"></a> style uses the <span + id="dx1-49012"></a> style uses the <span class="ecss-1000">supertabular</span><a - id="dx1-42013"></a><a - id="dx1-42014"></a> environment (defined by the + id="dx1-49013"></a><a + id="dx1-49014"></a> environment (defined by the <span class="ecss-1000">supertabular</span><a - id="dx1-42015"></a> package). It has two columns: the first column contains the + id="dx1-49015"></a> package). It has two columns: the first column contains the entry’s name and the second column contains the description followed by the - number list<a - id="dx1-42016"></a>. The entry’s symbol is ignored. Sub groups are separated with + <a + id="dx1-49016"></a><a +href="#glo:numberlist">number list<a + id="dx1-49017"></a></a>. The entry’s symbol is ignored. Sub groups are separated with @@ -10501,110 +12480,112 @@ class="ecss-1000">supertabular</span><a in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-42017"></a>. Child entries have a similar format to the parent entries + id="dx1-49018"></a>. Child entries have a similar format to the parent entries except that their name is suppressed. </dd><dt class="description"> <span class="ecbx-1000">superborder</span> </dt><dd class="description">The <span class="ecss-1000">superborder</span><a - id="dx1-42018"></a> style is like <span + id="dx1-49019"></a> style is like <span class="ecss-1000">super</span><a - id="dx1-42019"></a> but has horizontal and vertical + id="dx1-49020"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">superheader</span> </dt><dd class="description">The <span class="ecss-1000">superheader</span><a - id="dx1-42020"></a> style is like <span + id="dx1-49021"></a> style is like <span class="ecss-1000">super</span><a - id="dx1-42021"></a> but has a header row. + id="dx1-49022"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">superheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">superheaderborder</span><a - id="dx1-42022"></a> style is like <span + id="dx1-49023"></a> style is like <span class="ecss-1000">superheader</span><a - id="dx1-42023"></a> but has + id="dx1-49024"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">super3col</span> </dt><dd class="description">The <span class="ecss-1000">super3col</span><a - id="dx1-42024"></a> style is like <span + id="dx1-49025"></a> style is like <span class="ecss-1000">super</span><a - id="dx1-42025"></a> but has three columns. The + id="dx1-49026"></a> but has three columns. The first column contains the entry’s name, the second column contains the - description and the third column contains the number list<a - id="dx1-42026"></a>. The entry’s + description and the third column contains the <a + id="dx1-49027"></a><a +href="#glo:numberlist">number list<a + id="dx1-49028"></a></a>. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-42027"></a>. The width of the third column is governed by the + id="dx1-49029"></a>. The width of the third column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-42028"></a>. + id="dx1-49030"></a>. </dd><dt class="description"> <span class="ecbx-1000">super3colborder</span> </dt><dd class="description">The <span class="ecss-1000">super3colborder</span><a - id="dx1-42029"></a> style is like the <span + id="dx1-49031"></a> style is like the <span class="ecss-1000">super3col</span><a - id="dx1-42030"></a> style but has + id="dx1-49032"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">super3colheader</span> </dt><dd class="description">The <span class="ecss-1000">super3colheader</span><a - id="dx1-42031"></a> style is like <span + id="dx1-49033"></a> style is like <span class="ecss-1000">super3col</span><a - id="dx1-42032"></a> but has a header + id="dx1-49034"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">super3colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">super3colheaderborder</span><a - id="dx1-42033"></a> style is like <span + id="dx1-49035"></a> style is like <span class="ecss-1000">super3colheader</span><a - id="dx1-42034"></a> + id="dx1-49036"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">super4col</span> </dt><dd class="description">The <span class="ecss-1000">super4col</span><a - id="dx1-42035"></a> style is like <span + id="dx1-49037"></a> style is like <span class="ecss-1000">super3col</span><a - id="dx1-42036"></a> but has an additional column in + id="dx1-49038"></a> but has an additional column in which the entry’s associated symbol appears. This style is designed for entries with brief single line descriptions. The column widths are governed by the widest entry in the given column. Use <span class="ecss-1000">altsuper4col</span><a - id="dx1-42037"></a> for multi-line descriptions. + id="dx1-49039"></a> for multi-line descriptions. </dd><dt class="description"> <span class="ecbx-1000">super4colborder</span> </dt><dd class="description">The <span class="ecss-1000">super4colborder</span><a - id="dx1-42038"></a> style is like the <span + id="dx1-49040"></a> style is like the <span class="ecss-1000">super4col</span><a - id="dx1-42039"></a> style but has + id="dx1-49041"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">super4colheader</span> </dt><dd class="description">The <span class="ecss-1000">super4colheader</span><a - id="dx1-42040"></a> style is like <span + id="dx1-49042"></a> style is like <span class="ecss-1000">super4col</span><a - id="dx1-42041"></a> but has a header + id="dx1-49043"></a> but has a header row. @@ -10614,168 +12595,172 @@ class="ecss-1000">super4col</span><a class="ecbx-1000">super4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">super4colheaderborder</span><a - id="dx1-42042"></a> style is like <span + id="dx1-49044"></a> style is like <span class="ecss-1000">super4colheader</span><a - id="dx1-42043"></a> + id="dx1-49045"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altsuper4col</span> </dt><dd class="description">The <span class="ecss-1000">altsuper4col</span><a - id="dx1-42044"></a> style is like <span + id="dx1-49046"></a> style is like <span class="ecss-1000">super4col</span><a - id="dx1-42045"></a> but allows multi-line + id="dx1-49047"></a> but allows multi-line descriptions and page lists. The width of the description column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-42046"></a> and the width of the page list column is + id="dx1-49048"></a> and the width of the page list column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-42047"></a>. The width of the name and + id="dx1-49049"></a>. The width of the name and symbol columns is governed by the widest entry in the given column. </dd><dt class="description"> <span class="ecbx-1000">altsuper4colborder</span> </dt><dd class="description">The <span class="ecss-1000">altsuper4colborder</span><a - id="dx1-42048"></a> style is like the <span + id="dx1-49050"></a> style is like the <span class="ecss-1000">super4colborder</span><a - id="dx1-42049"></a> style + id="dx1-49051"></a> style but allows multi-line descriptions and page lists. </dd><dt class="description"> <span class="ecbx-1000">altsuper4colheader</span> </dt><dd class="description">The <span class="ecss-1000">altsuper4colheader</span><a - id="dx1-42050"></a> style is like <span + id="dx1-49052"></a> style is like <span class="ecss-1000">super4colheader</span><a - id="dx1-42051"></a> but + id="dx1-49053"></a> but allows multi-line descriptions and page lists. </dd><dt class="description"> <span class="ecbx-1000">altsuper4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">altsuper4colheaderborder</span><a - id="dx1-42052"></a> style is like + id="dx1-49054"></a> style is like <span class="ecss-1000">super4colheaderborder</span><a - id="dx1-42053"></a> but allows multi-line descriptions and page lists.</dd></dl> -<!--l. 4507--><p class="noindent" > + id="dx1-49055"></a> but allows multi-line descriptions and page lists.</dd></dl> +<!--l. 5095--><p class="noindent" > </p> -<!--l. 4507--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.5 </span> <a - id="x1-430002.12.5"></a>Supertabular Styles (Ragged Right)</h5> -<!--l. 4510--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 5095--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.5 </span> <a + id="x1-5000015.5"></a>Supertabular Styles (Ragged Right)</h4> +<!--l. 5098--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-superragged</span><a - id="dx1-43001"></a>. + id="dx1-50001"></a>. These styles are analogous to those defined in <span class="ecss-1000">glossary-super</span><a - id="dx1-43002"></a> but the multiline + id="dx1-50002"></a> but the multiline columns are left justified instead of fully justified. Since these styles all use the <span class="ecss-1000">supertabular</span><a - id="dx1-43003"></a><a - id="dx1-43004"></a> environment, they are governed by the same parameters as that + id="dx1-50003"></a><a + id="dx1-50004"></a> environment, they are governed by the same parameters as that environment. The <span class="ecss-1000">glossary-superragged</span><a - id="dx1-43005"></a> package additionally requires the <span + id="dx1-50005"></a> package additionally requires the <span class="ecss-1000">array</span><a - id="dx1-43006"></a> + id="dx1-50006"></a> package. Note that these styles will only be available if you explicitly load <span class="ecss-1000">glossary-superragged</span><a - id="dx1-43007"></a>: + id="dx1-50007"></a>: </p> - <div class="verbatim" id="verbatim-112"> + <div class="verbatim" id="verbatim-132"> \usepackage{glossaries}  <br />\usepackage{glossary-superragged} </div> -<!--l. 4522--><p class="nopar" > Note that you can’t set these styles using the <span +<!--l. 5110--><p class="nopar" > Note that you can’t set these styles using the <span class="ecss-1000">style</span><a - id="dx1-43008"></a> package option since the styles + id="dx1-50008"></a> package option since the styles aren’t defined until after the <span class="ecss-1000">glossaries </span>package has been loaded. -</p><!--l. 4527--><p class="indent" > +</p><!--l. 5115--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">superragged</span> </dt><dd class="description">The <span class="ecss-1000">superragged</span><a - id="dx1-43009"></a> style uses the <span + id="dx1-50009"></a> style uses the <span class="ecss-1000">supertabular</span><a - id="dx1-43010"></a><a - id="dx1-43011"></a> environment (defined by + id="dx1-50010"></a><a + id="dx1-50011"></a> environment (defined by the <span class="ecss-1000">supertabular</span><a - id="dx1-43012"></a> package). It has two columns: the first column contains the + id="dx1-50012"></a> package). It has two columns: the first column contains the entry’s name and the second column contains the (left justified) description - followed by the number list<a - id="dx1-43013"></a>. The entry’s symbol is ignored. Sub groups are + followed by the <a + id="dx1-50013"></a><a +href="#glo:numberlist">number list<a + id="dx1-50014"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-43014"></a>. Child entries have a similar format to the parent + id="dx1-50015"></a>. Child entries have a similar format to the parent entries except that their name is suppressed. </dd><dt class="description"> <span class="ecbx-1000">superraggedborder</span> </dt><dd class="description">The <span class="ecss-1000">superraggedborder</span><a - id="dx1-43015"></a> style is like <span + id="dx1-50016"></a> style is like <span class="ecss-1000">superragged</span><a - id="dx1-43016"></a> but has + id="dx1-50017"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">superraggedheader</span> </dt><dd class="description">The <span class="ecss-1000">superraggedheader</span><a - id="dx1-43017"></a> style is like <span + id="dx1-50018"></a> style is like <span class="ecss-1000">superragged</span><a - id="dx1-43018"></a> but has a + id="dx1-50019"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">superraggedheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">superraggedheaderborder</span><a - id="dx1-43019"></a> style is like + id="dx1-50020"></a> style is like <span class="ecss-1000">superraggedheader</span><a - id="dx1-43020"></a> but has horizontal and vertical lines around it. + id="dx1-50021"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">superragged3col</span> </dt><dd class="description">The <span class="ecss-1000">superragged3col</span><a - id="dx1-43021"></a> style is like <span + id="dx1-50022"></a> style is like <span class="ecss-1000">superragged</span><a - id="dx1-43022"></a> but has three + id="dx1-50023"></a> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the - (left justified) number list<a - id="dx1-43023"></a>. The entry’s symbol is ignored. The width of the + (left justified) <a + id="dx1-50024"></a><a +href="#glo:numberlist">number list<a + id="dx1-50025"></a></a>. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length <span class="ectt-1000">\glsdescwidth</span><a - id="dx1-43024"></a>. The width of + id="dx1-50026"></a>. The width of the third column is governed by the length <span class="ectt-1000">\glspagelistwidth</span><a - id="dx1-43025"></a>. + id="dx1-50027"></a>. </dd><dt class="description"> <span class="ecbx-1000">superragged3colborder</span> </dt><dd class="description">The <span class="ecss-1000">superragged3colborder</span><a - id="dx1-43026"></a> style + id="dx1-50028"></a> style is like the <span class="ecss-1000">superragged3col</span><a - id="dx1-43027"></a> style but has horizontal and vertical lines around + id="dx1-50029"></a> style but has horizontal and vertical lines around it. @@ -10785,27 +12770,27 @@ class="ecss-1000">superragged3col</span><a class="ecbx-1000">superragged3colheader</span> </dt><dd class="description">The <span class="ecss-1000">superragged3colheader</span><a - id="dx1-43028"></a> style is like <span + id="dx1-50030"></a> style is like <span class="ecss-1000">superragged3col</span><a - id="dx1-43029"></a> + id="dx1-50031"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">superragged3colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">superragged3colheaderborder</span><a - id="dx1-43030"></a> style is like + id="dx1-50032"></a> style is like <span class="ecss-1000">superragged3colheader</span><a - id="dx1-43031"></a> but has horizontal and vertical lines around it. + id="dx1-50033"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altsuperragged4col</span> </dt><dd class="description">The <span class="ecss-1000">altsuperragged4col</span><a - id="dx1-43032"></a> style is like <span + id="dx1-50034"></a> style is like <span class="ecss-1000">superragged3col</span><a - id="dx1-43033"></a> but has + id="dx1-50035"></a> but has an additional column in which the entry’s associated symbol appears. The column widths for the name and symbol column are governed by the widest entry in the given column. @@ -10814,59 +12799,59 @@ class="ecss-1000">superragged3col</span><a class="ecbx-1000">altsuperragged4colborder</span> </dt><dd class="description">The <span class="ecss-1000">altsuperragged4colborder</span><a - id="dx1-43034"></a> style is like the + id="dx1-50036"></a> style is like the <span class="ecss-1000">altsuperragged4col</span><a - id="dx1-43035"></a> style but has horizontal and vertical lines around it. + id="dx1-50037"></a> style but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="ecbx-1000">altsuperragged4colheader</span> </dt><dd class="description">The <span class="ecss-1000">altsuperragged4colheader</span><a - id="dx1-43036"></a> style is like + id="dx1-50038"></a> style is like <span class="ecss-1000">altsuperragged4col</span><a - id="dx1-43037"></a> but has a header row. + id="dx1-50039"></a> but has a header row. </dd><dt class="description"> <span class="ecbx-1000">altsuperragged4colheaderborder</span> </dt><dd class="description">The <span class="ecss-1000">altsuperragged4colheaderborder</span><a - id="dx1-43038"></a> style is + id="dx1-50040"></a> style is like <span class="ecss-1000">altsuperragged4colheader</span><a - id="dx1-43039"></a> but has horizontal and vertical lines around it. + id="dx1-50041"></a> but has horizontal and vertical lines around it. </dd></dl> -<!--l. 4596--><p class="noindent" > +<!--l. 5183--><p class="noindent" > </p> -<!--l. 4596--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.6 </span> <a - id="x1-440002.12.6"></a>Tree-Like Styles</h5> -<!--l. 4599--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 5183--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">15.6 </span> <a + id="x1-5100015.6"></a>Tree-Like Styles</h4> +<!--l. 5186--><p class="noindent" >The styles described in this section are all defined in the package <span class="ecss-1000">glossary-tree</span><a - id="dx1-44001"></a>. These + id="dx1-51001"></a>. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have sub-entries. These styles will display the entry’s symbol if it exists. Note that these styles will automatically be available unless you use the <span class="ecss-1000">notree</span><a - id="dx1-44002"></a> or <span + id="dx1-51002"></a> or <span class="ecss-1000">nostyles</span><a - id="dx1-44003"></a> package + id="dx1-51003"></a> package options. -</p><!--l. 4607--><p class="indent" > +</p><!--l. 5194--><p class="indent" > </p><dl class="description"><dt class="description"> <span class="ecbx-1000">index</span> </dt><dd class="description">The <span class="ecss-1000">index</span><a - id="dx1-44004"></a> style is similar to the way indices are usually formatted in that + id="dx1-51004"></a> style is similar to the way indices are usually formatted in that it has a hierarchical structure up to three levels (the main level plus two sub-levels). The name is typeset in bold, and if the symbol is present it is set in parentheses after the name and before the description. Sub-entries are indented and also include the name, the symbol in brackets (if present) and the description. Groups are separated using <span class="ectt-1000">\indexspace</span><a - id="dx1-44005"></a>. + id="dx1-51005"></a>. @@ -10875,110 +12860,114 @@ class="ectt-1000">\indexspace</span><a class="ecbx-1000">indexgroup</span> </dt><dd class="description">The <span class="ecss-1000">indexgroup</span><a - id="dx1-44006"></a> style is similar to the <span + id="dx1-51006"></a> style is similar to the <span class="ecss-1000">index</span><a - id="dx1-44007"></a> style except that each + id="dx1-51007"></a> style except that each group has a heading. </dd><dt class="description"> <span class="ecbx-1000">indexhypergroup</span> </dt><dd class="description">The <span class="ecss-1000">indexhypergroup</span><a - id="dx1-44008"></a> style is like <span + id="dx1-51008"></a> style is like <span class="ecss-1000">indexgroup</span><a - id="dx1-44009"></a> but has a set of + id="dx1-51009"></a> but has a set of links to the glossary groups. The navigation line is the same as that for <span class="ecss-1000">listhypergroup</span><a - id="dx1-44010"></a>, described above. + id="dx1-51010"></a>, described above. </dd><dt class="description"> <span class="ecbx-1000">tree</span> </dt><dd class="description">The <span class="ecss-1000">tree</span><a - id="dx1-44011"></a> style is similar to the <span + id="dx1-51011"></a> style is similar to the <span class="ecss-1000">index</span><a - id="dx1-44012"></a> style except that it can have arbitrary - levels. (Note that <span + id="dx1-51012"></a> style except that it can have arbitrary + levels. (Note that <a + id="dx1-51013"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-44013"></a> is limited to three levels, so you will need to - use <span + id="dx1-51014"></a></a> is limited to three levels, so you will need to + use <a + id="dx1-51015"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-44014"></a> if you want more than three levels.) Each sub-level is indented by + id="dx1-51016"></a></a> if you want more than three levels.) Each sub-level is indented by <span class="marginpar"><span class="ectt-0900">\glstreeindent</span><span class="ectt-0900"> </span></span><a - id="dx1-44015"></a><span + id="dx1-51017"></a><span class="ectt-1000">\glstreeindent</span>. Note that the name, symbol (if present) and description are placed in the same paragraph block. If you want the name to be apart from the description, use the <span class="ecss-1000">alttree</span><a - id="dx1-44016"></a> style instead. (See + id="dx1-51018"></a> style instead. (See below.) </dd><dt class="description"> <span class="ecbx-1000">treegroup</span> </dt><dd class="description">The <span class="ecss-1000">treegroup</span><a - id="dx1-44017"></a> style is similar to the <span + id="dx1-51019"></a> style is similar to the <span class="ecss-1000">tree</span><a - id="dx1-44018"></a> style except that each group + id="dx1-51020"></a> style except that each group has a heading. </dd><dt class="description"> <span class="ecbx-1000">treehypergroup</span> </dt><dd class="description">The <span class="ecss-1000">treehypergroup</span><a - id="dx1-44019"></a> style is like <span + id="dx1-51021"></a> style is like <span class="ecss-1000">treegroup</span><a - id="dx1-44020"></a> but has a set of links to + id="dx1-51022"></a> but has a set of links to the glossary groups. The navigation line is the same as that for <span class="ecss-1000">listhypergroup</span><a - id="dx1-44021"></a>, + id="dx1-51023"></a>, described above. </dd><dt class="description"> <span class="ecbx-1000">treenoname</span> </dt><dd class="description">The <span class="ecss-1000">treenoname</span><a - id="dx1-44022"></a> style is like the <span + id="dx1-51024"></a> style is like the <span class="ecss-1000">tree</span><a - id="dx1-44023"></a> style except that the name for + id="dx1-51025"></a> style except that the name for each sub-entry is ignored. </dd><dt class="description"> <span class="ecbx-1000">treenonamegroup</span> </dt><dd class="description">The <span class="ecss-1000">treenonamegroup</span><a - id="dx1-44024"></a> style is similar to the <span + id="dx1-51026"></a> style is similar to the <span class="ecss-1000">treenoname</span><a - id="dx1-44025"></a> style + id="dx1-51027"></a> style except that each group has a heading. </dd><dt class="description"> <span class="ecbx-1000">treenonamehypergroup</span> </dt><dd class="description">The <span class="ecss-1000">treenonamehypergroup</span><a - id="dx1-44026"></a> + id="dx1-51028"></a> style is like <span class="ecss-1000">treenonamegroup</span><a - id="dx1-44027"></a> but has a set of links to the glossary groups. + id="dx1-51029"></a> but has a set of links to the glossary groups. The navigation line is the same as that for <span class="ecss-1000">listhypergroup</span><a - id="dx1-44028"></a>, described above. + id="dx1-51030"></a>, described above. </dd><dt class="description"> <span class="ecbx-1000">alttree</span> </dt><dd class="description">The <span class="ecss-1000">alttree</span><a - id="dx1-44029"></a> style is similar to the <span + id="dx1-51031"></a> style is similar to the <span class="ecss-1000">tree</span><a - id="dx1-44030"></a> style except that the indentation for each + id="dx1-51032"></a> style except that the indentation for each level is determined by the width of the text specified by - <!--l. 4659--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span + <!--l. 5246--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glssetwidest</span><span class="ectt-0900"> </span></span><a - id="dx1-44031"></a> <span + id="dx1-51033"></a> <span class="ectt-1000">\glssetwidest[</span><span class="cmsy-10">⟨</span><span class="ecti-1000">level</span><span @@ -10988,7 +12977,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> - </p><!--l. 4661--><p class="noindent" > + </p><!--l. 5248--><p class="noindent" > The optional argument <span class="cmsy-10">⟨</span><span class="ecti-1000">level</span><span @@ -11003,7 +12992,7 @@ class="cmsy-10">⟩ </span>is - </p><!--l. 4668--><p class="noindent" >For each level, the name is placed to the left of the paragraph block containing the + </p><!--l. 5255--><p class="noindent" >For each level, the name is placed to the left of the paragraph block containing the symbol (optional) and the description. If the symbol is present, it is placed in parentheses before the description. </p></dd><dt class="description"> @@ -11011,34 +13000,34 @@ class="cmsy-10">⟩ </span>is class="ecbx-1000">alttreegroup</span> </dt><dd class="description">The <span class="ecss-1000">alttreegroup</span><a - id="dx1-44032"></a> is like the <span + id="dx1-51034"></a> is like the <span class="ecss-1000">alttree</span><a - id="dx1-44033"></a> style except that each group has a + id="dx1-51035"></a> style except that each group has a heading. </dd><dt class="description"> <span class="ecbx-1000">alttreehypergroup</span> </dt><dd class="description">The <span class="ecss-1000">alttreehypergroup</span><a - id="dx1-44034"></a> style is like <span + id="dx1-51036"></a> style is like <span class="ecss-1000">alttreegroup</span><a - id="dx1-44035"></a> but has a set of + id="dx1-51037"></a> but has a set of links to the glossary groups. The navigation line is the same as that for <span class="ecss-1000">listhypergroup</span><a - id="dx1-44036"></a>, described above. + id="dx1-51038"></a>, described above. </dd></dl> -<!--l. 4685--><p class="noindent" > +<!--l. 5270--><p class="noindent" > </p> -<!--l. 4685--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.13 </span> <a - id="x1-450002.13"></a>Defining your own glossary style</h4> -<!--l. 4688--><p class="noindent" >If the predefined styles don’t fit your requirements, you can define your own style +<!--l. 5270--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">16 </span> <a + id="x1-5200016"></a>Defining your own glossary style</h3> +<!--l. 5273--><p class="noindent" >If the predefined styles don’t fit your requirements, you can define your own style using: -</p><!--l. 4690--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5275--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\newglossarystyle</span><span class="ectt-0900"> </span></span><a - id="dx1-45001"></a> <span + id="dx1-52001"></a> <span class="ectt-1000">\newglossarystyle{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span @@ -11048,7 +13037,7 @@ class="cmsy-10">⟨</span><span class="ecti-1000">definitions</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4692--><p class="noindent" > +</p><!--l. 5277--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span @@ -11058,94 +13047,102 @@ The second argument <span class="cmsy-10">⟨</span><span class="ecti-1000">definitions</span><span class="cmsy-10">⟩ </span>needs to redefine all of the following: -</p><!--l. 4697--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5282--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">theglossary</span><span class="ectt-0900"> </span></span><a - id="dx1-45002"></a><a - id="dx1-45003"></a> <span + id="dx1-52002"></a><a + id="dx1-52003"></a> <span class="ecss-1000">theglossary</span><a - id="dx1-45004"></a><a - id="dx1-45005"></a> </div><hr> -</p><!--l. 4699--><p class="noindent" > + id="dx1-52004"></a><a + id="dx1-52005"></a> </div><hr> +</p><!--l. 5284--><p class="noindent" > This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by <span -class="ectt-1000">\glossarypreamble</span>) or the glossary postamble (defined by <span -class="ectt-1000">\glossarypostamble</span>). For +class="ectt-1000">\glossarypreamble</span><a + id="dx1-52006"></a>) or the glossary postamble (defined by <span +class="ectt-1000">\glossarypostamble</span><a + id="dx1-52007"></a>). For example, the <span class="ecss-1000">list</span><a - id="dx1-45006"></a> style uses the <span + id="dx1-52008"></a> style uses the <span class="ecss-1000">description</span><a - id="dx1-45007"></a><a - id="dx1-45008"></a> environment, so the <span + id="dx1-52009"></a><a + id="dx1-52010"></a> environment, so the <span class="ecss-1000">theglossary</span><a - id="dx1-45009"></a><a - id="dx1-45010"></a> environment + id="dx1-52011"></a><a + id="dx1-52012"></a> environment is simply redefined to begin and end the <span class="ecss-1000">description</span><a - id="dx1-45011"></a><a - id="dx1-45012"></a> environment. -</p><!--l. 4708--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-52013"></a><a + id="dx1-52014"></a> environment. +</p><!--l. 5293--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossaryheader</span><span class="ectt-0900"> </span></span><a - id="dx1-45013"></a> <span + id="dx1-52015"></a> <span class="ectt-1000">\glossaryheader </span></div><hr> -</p><!--l. 4710--><p class="noindent" > +</p><!--l. 5295--><p class="noindent" > This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as <span -class="ectt-1000">\glossarypreamble</span>, which should not be affected by +class="ectt-1000">\glossarypreamble</span><a + id="dx1-52016"></a>, which should not be affected by changes in the glossary style. The <span class="ecss-1000">list</span><a - id="dx1-45014"></a> glossary style redefines <span -class="ectt-1000">\glossaryheader </span>to do + id="dx1-52017"></a> glossary style redefines <span +class="ectt-1000">\glossaryheader</span><a + id="dx1-52018"></a> to do nothing, whereas the <span class="ecss-1000">longheader</span><a - id="dx1-45015"></a> glossary style redefines <span + id="dx1-52019"></a> glossary style redefines <span class="ectt-1000">\glossaryheader </span>to do a header row. -</p><!--l. 4718--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5303--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsgroupheading</span><span class="ectt-0900"> </span></span><a - id="dx1-45016"></a> <span + id="dx1-52020"></a> <span class="ectt-1000">\glsgroupheading{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4720--><p class="noindent" > +</p><!--l. 5305--><p class="noindent" > This macro indicates what to do at the start of each logical block within the main body -of the glossary. If you use <span +of the glossary. If you use <a + id="dx1-52021"></a><a +href="#glo:makeindex"><span class="ectt-1000">makeindex</span><a - id="dx1-45017"></a> the glossary is sub-divided into a maximum of + id="dx1-52022"></a></a> the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the <span class="ecss-1000">sort</span><a - id="dx1-45018"></a> key (or + id="dx1-52023"></a> key (or <span class="ecss-1000">name</span><a - id="dx1-45019"></a> key if the <span + id="dx1-52024"></a> key if the <span class="ecss-1000">sort</span><a - id="dx1-45020"></a> key is omitted). The sub-divisions are in the following order: -symbols, numbers, A, …, Z. If you use <span + id="dx1-52025"></a> key is omitted). The sub-divisions are in the following order: +symbols, numbers, A, …, Z. If you use <a + id="dx1-52026"></a><a +href="#glo:xindy"><span class="ectt-1000">xindy</span><a - id="dx1-45021"></a>, the sub-divisions depend on the language + id="dx1-52027"></a></a>, the sub-divisions depend on the language settings. -</p><!--l. 4731--><p class="indent" > Note that the argument to <span +</p><!--l. 5316--><p class="indent" > Note that the argument to <span class="ectt-1000">\glsgroupheading </span>is a label <span class="ecti-1000">not </span>the group title. The group title can be obtained via -</p><!--l. 4734--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5319--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsgetgrouptitle</span><span class="ectt-0900"> </span></span><a - id="dx1-45022"></a> <span + id="dx1-52028"></a> <span class="ectt-1000">\glsgetgrouptitle{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4736--><p class="noindent" > +</p><!--l. 5321--><p class="noindent" > This obtains the title as follows: if <span class="ectt-1000">\</span><span class="cmsy-10">⟨</span><span @@ -11156,11 +13153,11 @@ otherwise the title is just <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span>. -</p><!--l. 4741--><p class="indent" > A navigation hypertarget can be created using -</p><!--l. 4742--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5326--><p class="indent" > A navigation hypertarget can be created using +</p><!--l. 5327--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsnavhypertarget</span><span class="ectt-0900"> </span></span><a - id="dx1-45023"></a> <span + id="dx1-52029"></a> <span class="ectt-1000">\glsnavhypertarget{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -11170,83 +13167,85 @@ class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4744--><p class="noindent" > +</p><!--l. 5329--><p class="noindent" > For further details about <span -class="ectt-1000">\glsnavhypertarget</span>, see the documented code of -<span -class="ecss-1000">glossary-hypernav</span><a - id="dx1-45024"></a> in <span -class="ectt-1000">glossaries.pdf</span>. -</p><!--l. 4750--><p class="indent" > Most of the predefined glossary styles redefine <span +class="ectt-1000">\glsnavhypertarget</span>, see the documented code +(<span +class="ectt-1000">glossaries.pdf</span>). +</p><!--l. 5334--><p class="indent" > Most of the predefined glossary styles redefine <span class="ectt-1000">\glsgroupheading </span>to simply ignore its argument. The <span class="ecss-1000">listhypergroup</span><a - id="dx1-45025"></a> style redefines <span + id="dx1-52030"></a> style redefines <span class="ectt-1000">\glsgroupheading </span>as follows: </p> - <div class="verbatim" id="verbatim-113"> + <div class="verbatim" id="verbatim-133"> \renewcommand*{\glsgroupheading}[1]{%  <br />\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} </div> -<!--l. 4756--><p class="nopar" > See also <span +<!--l. 5340--><p class="nopar" > See also <span class="ectt-1000">\glsgroupskip </span>below. (Note that command definitions within <span -class="ectt-1000">\newglossarystyle </span>must use <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newglossarystyle</span><a + id="dx1-52031"></a> must use <span class="obeylines-h"><span class="verb"><span class="ectt-1000">##1</span></span></span> instead of <span class="obeylines-h"><span class="verb"><span class="ectt-1000">#1</span></span></span> etc.) -</p><!--l. 4760--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5344--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glsgroupskip</span><span class="ectt-0900"> </span></span><a - id="dx1-45026"></a> <span + id="dx1-52032"></a> <span class="ectt-1000">\glsgroupskip </span></div><hr> -</p><!--l. 4762--><p class="noindent" > +</p><!--l. 5346--><p class="noindent" > This macro determines what to do after one logical group but before the header for the next logical group. The <span class="ecss-1000">list</span><a - id="dx1-45027"></a> glossary style simply redefines <span + id="dx1-52033"></a> glossary style simply redefines <span class="ectt-1000">\glsgroupskip </span>to be <span -class="ectt-1000">\indexspace</span>, whereas the tabular-like styles redefine <span +class="ectt-1000">\indexspace</span><a + id="dx1-52034"></a>, whereas the tabular-like styles redefine <span class="ectt-1000">\glsgroupskip </span>to produce a blank row. -</p><!--l. 4769--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5353--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossaryentryfield</span><span class="ectt-0900"> </span></span><a - id="dx1-45028"></a> <span + id="dx1-52035"></a> <span class="ectt-1000">\glossaryentryfield{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span -class="ecti-1000">formatted</span> -<span -class="ecti-1000">name</span><span +class="ecti-1000">formatted name</span><span class="cmsy-10">⟩</span><span class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">description</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}{</span><span +class="ectt-1000">}</span> +<span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">symbol</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">} {</span><span +class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">number list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4773--><p class="noindent" > +</p><!--l. 5356--><p class="noindent" > This macro indicates what to do for a given glossary entry. Note that <span class="cmsy-10">⟨</span><span class="ecti-1000">formatted name</span><span class="cmsy-10">⟩</span> will always be in the form <span -class="ectt-1000">\glsnamefont{</span><span +class="ectt-1000">\glsnamefont</span><a + id="dx1-52036"></a><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span @@ -11256,18 +13255,46 @@ class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>is the label used when the glossary entry was defined via either <span -class="ectt-1000">\newglossaryentry </span>or +class="ectt-1000">\newglossaryentry</span><a + id="dx1-52037"></a> or <span -class="ectt-1000">\newacronym</span>. -</p><!--l. 4781--><p class="indent" > Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) +class="ectt-1000">\newacronym</span><a + id="dx1-52038"></a>. +</p><!--l. 5364--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryitem</span><span +class="ectt-0900"> </span></span><a + id="dx1-52039"></a> <span +class="ectt-1000">\glsentryitem{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 5366--><p class="noindent" > +This macro will increment and display the associated counter for the main (level 0) +entries if the <span +class="ecss-1000">entrycounter</span><a + id="dx1-52040"></a> or <span +class="ecss-1000">counterwithin</span><a + id="dx1-52041"></a> package options have been used. This macro +is typically called by <span +class="ectt-1000">\glossaryentryfield </span>before <span +class="ectt-1000">\glstarget</span>. The format of the +counter is controlled by the macro +</p><!--l. 5372--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrycounterlabel</span><span +class="ectt-0900"> </span></span><a + id="dx1-52042"></a> <span +class="ectt-1000">\glsentrycounterlabel </span></div><hr> +</p><!--l. 5374--><p class="noindent" > +</p><!--l. 5376--><p class="indent" > Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine <span class="ectt-1000">\glossaryentryfield </span>to set the appropriate target. This is done using -</p><!--l. 4786--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +</p><!--l. 5381--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glstarget</span><span class="ectt-0900"> </span></span><a - id="dx1-45029"></a> <span + id="dx1-52043"></a> <span class="ectt-1000">\glstarget{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span @@ -11277,83 +13304,113 @@ class="cmsy-10">⟨</span><span class="ecti-1000">text</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4788--><p class="noindent" > +</p><!--l. 5383--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="ecti-1000">label</span><span class="cmsy-10">⟩ </span>is the entry’s label. Note that you don’t need to worry about whether the <span class="ecss-1000">hyperref</span><a - id="dx1-45030"></a> package has been loaded, as <span + id="dx1-52044"></a> package has been loaded, as <span class="ectt-1000">\glstarget </span>won’t create a target if <span class="ectt-1000">\hypertarget</span> hasn’t been defined. -</p><!--l. 4794--><p class="indent" > For example, the <span +</p><!--l. 5389--><p class="indent" > For example, the <span class="ecss-1000">list</span><a - id="dx1-45031"></a> style defines <span + id="dx1-52045"></a> style defines <span class="ectt-1000">\glossaryentryfield </span>as follows: </p> - <div class="verbatim" id="verbatim-114"> + <div class="verbatim" id="verbatim-134"> \renewcommand*{\glossaryentryfield}[5]{% - <br />\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} + <br />\item[\glsentryitem{##1}\glstarget{##1}{##2}] + <br />  ##3\glspostdescription \space ##5} </div> -<!--l. 4799--><p class="nopar" > -</p><!--l. 4801--><p class="indent" > Note also that <span +<!--l. 5395--><p class="nopar" > +</p><!--l. 5397--><p class="indent" > Note also that <span class="cmsy-10">⟨</span><span class="ecti-1000">number list</span><span class="cmsy-10">⟩ </span>will always be of the form<br -class="newline" /> <span -class="ectt-1000">\glossaryentrynumbers</span>{<span -class="ectt-1000">\relax</span><br +class="newline" /> +</p><!--l. 5399--><p class="indent" > <hr><div title="Definition"><span +class="ectt-1000">\glossaryentrynumbers</span><a + id="dx1-52046"></a><span +class="ectt-1000">{\relax</span><br class="newline" /><span -class="ectt-1000">\setentrycounter{</span><span +class="ectt-1000">\setentrycounter</span><a + id="dx1-52047"></a><span +class="ectt-1000">[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">Hprefix</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">counter name</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}\glsnumberformat{</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">format cmd</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">number(s)</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}</span>}<br -class="newline" /> where <span +class="ectt-1000">}}</span> +</div><hr> +</p><!--l. 5401--><p class="noindent" > +where <span class="cmsy-10">⟨</span><span class="ecti-1000">number(s)</span><span class="cmsy-10">⟩ </span>may contain <span -class="ectt-1000">\delimN </span>(to delimit individual numbers) and/or +class="ectt-1000">\delimN</span><a + id="dx1-52048"></a> (to delimit individual numbers) and/or <span -class="ectt-1000">\delimR </span>(to indicate a range of numbers). There may be multiple occurrences of +class="ectt-1000">\delimR</span><a + id="dx1-52049"></a> (to indicate a range of numbers). There may be multiple occurrences of <span -class="ectt-1000">\setentrycounter{</span><span +class="ectt-1000">\setentrycounter</span><a + id="dx1-52050"></a><span +class="ectt-1000">[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">Hprefix</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">counter name</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}\glsnumberformat{</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">format cmd</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">number(s)</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}</span>, but note that -the entire number list is enclosed within the argument to <span +class="ectt-1000">}</span>, +but note that the entire number list is enclosed within the argument of +<span class="ectt-1000">\glossaryentrynumbers</span><a - id="dx1-45032"></a>. The -user can redefine this to change the way the entire number list is formatted, regardless -of the glossary style. However the most common use of <span -class="ectt-1000">\glossaryentrynumbers </span>is to -provide a means of suppressing the number list altogether. (In fact, the <span + id="dx1-52051"></a>. The user can redefine this to change the way the entire +number list is formatted, regardless of the glossary style. However the most common use +of <span +class="ectt-1000">\glossaryentrynumbers</span><a + id="dx1-52052"></a> is to provide a means of suppressing the number list +altogether. (In fact, the <span class="ecss-1000">nonumberlist</span><a - id="dx1-45033"></a> -option redefines <span -class="ectt-1000">\glossaryentrynumbers </span>to ignore its argument.) Therefore, when you -define a new glossary style, you don’t need to worry about whether the user has -specified the <span + id="dx1-52053"></a> option redefines <span +class="ectt-1000">\glossaryentrynumbers</span><a + id="dx1-52054"></a> to +ignore its argument.) Therefore, when you define a new glossary style, you don’t +need to worry about whether the user has specified the <span class="ecss-1000">nonumberlist</span><a - id="dx1-45034"></a> package option. -</p><!--l. 4820--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span + id="dx1-52055"></a> package +option. +</p><!--l. 5418--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span class="ectt-0900">\glossarysubentryfield</span><span class="ectt-0900"> </span></span><a - id="dx1-45035"></a> <span + id="dx1-52056"></a> <span class="ectt-1000">\glossarysubentryfield{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">level</span><span @@ -11368,7 +13425,7 @@ class="ecti-1000">formatted</span> <span class="ecti-1000">name</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">}{</span><span +class="ectt-1000">} {</span><span class="cmsy-10">⟨</span><span class="ecti-1000">description</span><span class="cmsy-10">⟩</span><span @@ -11376,12 +13433,12 @@ class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">symbol</span><span class="cmsy-10">⟩</span><span -class="ectt-1000">} {</span><span +class="ectt-1000">}{</span><span class="cmsy-10">⟨</span><span class="ecti-1000">number list</span><span class="cmsy-10">⟩</span><span class="ectt-1000">} </span></div><hr> -</p><!--l. 4824--><p class="noindent" > +</p><!--l. 5421--><p class="noindent" > This is new to version 1.17, and is used to display sub-entries. The first argument, <span class="cmsy-10">⟨</span><span @@ -11389,43 +13446,83 @@ class="ecti-1000">level</span><span class="cmsy-10">⟩</span>, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for <span class="ectt-1000">\glossaryentryfield</span><a - id="dx1-45036"></a> + id="dx1-52057"></a> described above. -</p><!--l. 4831--><p class="indent" > For further details of these commands, see the documented code in -<span -class="ectt-1000">glossaries.pdf</span>. -</p><!--l. 4835--><p class="noindent" > +</p><!--l. 5428--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glssubentryitem</span><span +class="ectt-0900"> </span></span><a + id="dx1-52058"></a> <span +class="ectt-1000">\glssubentryitem{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 5430--><p class="noindent" > +This macro will increment and display the associated counter for the level 1 entries if +the <span +class="ecss-1000">subentrycounter</span><a + id="dx1-52059"></a> package options have been used. This macro is typically called by +<span +class="ectt-1000">\glossarysubentryfield </span>before <span +class="ectt-1000">\glstarget</span><a + id="dx1-52060"></a>. The format of the counter is controlled +by the macro +</p><!--l. 5436--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glssubentrycounterlabel</span><span +class="ectt-0900"> </span></span><a + id="dx1-52061"></a> <span +class="ectt-1000">\glssubentrycounterlabel </span></div><hr> +</p><!--l. 5438--><p class="noindent" > +</p><!--l. 5440--><p class="indent" > Note that <span +class="ectt-1000">\printglossary</span><a + id="dx1-52062"></a> (which <span +class="ectt-1000">\printglossaries</span><a + id="dx1-52063"></a> calls) sets +</p><!--l. 5442--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\currentglossary</span><span +class="ectt-0900"> </span></span><a + id="dx1-52064"></a> <span +class="ectt-1000">\currentglossary </span></div><hr> +</p><!--l. 5444--><p class="noindent" > +to the current glossary label, so it’s possible to create a glossary style that varies + + + +according to the glossary type. +</p><!--l. 5448--><p class="indent" > For further details of these commands, see “Displaying the glossary” in the +documented code (<span +class="ectt-1000">glossaries.pdf</span>). +</p><!--l. 5452--><p class="noindent" > </p> -<!--l. 4835--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.1 </span> <a - id="x1-460002.13.1"></a>Example: creating a completely new style</h5> -<!--l. 4837--><p class="noindent" >If you want a completely new style, you will need to redefine all of the commands and +<!--l. 5452--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">16.1 </span> <a + id="x1-5300016.1"></a>Example: creating a completely new style</h4> +<!--l. 5454--><p class="noindent" >If you want a completely new style, you will need to redefine all of the commands and the environment listed above. -</p><!--l. 4840--><p class="indent" > For example, suppose you want each entry to start with a bullet point. This means +</p><!--l. 5457--><p class="indent" > For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the <span class="ecss-1000">itemize</span><a - id="dx1-46001"></a><a - id="dx1-46002"></a> environment, so <span + id="dx1-53001"></a><a + id="dx1-53002"></a> environment, so <span class="ecss-1000">theglossary</span><a - id="dx1-46003"></a><a - id="dx1-46004"></a> should + id="dx1-53003"></a><a + id="dx1-53004"></a> should start and end that environment. Let’s also suppose that you don’t want anything between the glossary groups (so <span class="ectt-1000">\glsgroupheading</span><a - id="dx1-46005"></a> and <span + id="dx1-53005"></a> and <span class="ectt-1000">\glsgroupskip</span><a - id="dx1-46006"></a> should do + id="dx1-53006"></a> should do nothing) and suppose you don’t want anything to appear immediately after - - - <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\begin{theglossary}</span></span></span> (so <span class="ectt-1000">\glossaryheader</span><a - id="dx1-46007"></a> should do nothing). In addition, let’s + id="dx1-53007"></a> should do nothing). In addition, let’s suppose the symbol should appear in brackets after the name, followed by the -description and last of all the number list<a - id="dx1-46008"></a> should appear within square brackets at +description and last of all the <a + id="dx1-53008"></a><a +href="#glo:numberlist">number list<a + id="dx1-53009"></a></a> should appear within square brackets at the end. Then you can create this new glossary style, called, say, <span class="ectt-1000">mylist</span>, as follows: @@ -11433,7 +13530,7 @@ follows: </p> - <div class="verbatim" id="verbatim-115"> + <div class="verbatim" id="verbatim-135">  \newglossarystyle{mylist}{%  <br /> % put the glossary in the itemize environment:  <br /> \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}% @@ -11455,24 +13552,37 @@ follows:  <br />   \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}%  <br /> } </div> -<!--l. 4873--><p class="nopar" > Note that this style creates a flat glossary, where sub-entries are displayed in exactly -the same way as the top level entries. -</p><!--l. 4879--><p class="noindent" > +<!--l. 5490--><p class="nopar" > Note that this style creates a flat glossary, where sub-entries are displayed in exactly +the same way as the top level entries. It also hasn’t used <span +class="ectt-1000">\glsentryitem</span><a + id="dx1-53010"></a> or +<span +class="ectt-1000">\glssubentryitem</span><a + id="dx1-53011"></a> so it won’t be affected by the <span +class="ecss-1000">entrycounter</span><a + id="dx1-53012"></a>, <span +class="ecss-1000">counterwithin</span><a + id="dx1-53013"></a> or +<span +class="ecss-1000">subentrycounter</span><a + id="dx1-53014"></a> package options. +</p><!--l. 5498--><p class="noindent" > </p> -<!--l. 4879--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.2 </span> <a - id="x1-470002.13.2"></a>Example: creating a new glossary style based on an existing style</h5> -<a - id="dx1-47001"></a> -<!--l. 4883--><p class="noindent" >If you want to define a new style that is a slightly modified version of an existing style, +<!--l. 5498--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">16.2 </span> <a + id="x1-5400016.2"></a>Example: creating a new glossary style based on an existing style</h4> +<!--l. 5500--><p class="noindent" >If you want to define a new style that is a slightly modified version of an existing style, you can use <span -class="ectt-1000">\glossarystyle </span>within the second argument of <span -class="ectt-1000">\newglossarystyle</span> +class="ectt-1000">\glossarystyle</span><a + id="dx1-54001"></a> within the second argument of <span +class="ectt-1000">\newglossarystyle</span><a + id="dx1-54002"></a> followed by whatever alterations you require. For example, suppose you want a style like the <span class="ecss-1000">list</span><a - id="dx1-47002"></a> style but you don’t want the extra vertical space created by <span -class="ectt-1000">\indexspace</span> + id="dx1-54003"></a> style but you don’t want the extra vertical space created by <span +class="ectt-1000">\indexspace</span><a + id="dx1-54004"></a> between groups, then you can create a new glossary style called, say, <span class="ectt-1000">mylist </span>as follows: @@ -11480,44 +13590,44 @@ follows: </p> - <div class="verbatim" id="verbatim-116"> + <div class="verbatim" id="verbatim-136"> \newglossarystyle{mylist}{%  <br />\glossarystyle{list}% base this style on the list style  <br />\renewcommand{\glsgroupskip}{}% make nothing happen between groups  <br />} </div> -<!--l. 4896--><p class="nopar" > -</p><!--l. 4900--><p class="noindent" > +<!--l. 5513--><p class="nopar" > +</p><!--l. 5517--><p class="noindent" > </p> -<!--l. 4900--><p class="noindent" ><a -href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.3 </span> <a - id="x1-480002.13.3"></a>Example: creating a glossary style that uses the <span +<!--l. 5517--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">16.3 </span> <a + id="x1-5500016.3"></a>Example: creating a glossary style that uses the <span class="ecss-1000">user1</span>, …, <span class="ecss-1000">user6</span> -keys</h5> -<!--l. 4902--><p class="noindent" >Since <span +keys</h4> +<!--l. 5519--><p class="noindent" >Since <span class="ectt-1000">\glossaryentryfield</span><a - id="dx1-48001"></a> and <span + id="dx1-55001"></a> and <span class="ectt-1000">\glossarysubentryfield</span><a - id="dx1-48002"></a> provide the label for the + id="dx1-55002"></a> provide the label for the entry, it’s also possible to access the values of the generic user keys, such as <span class="ecss-1000">user1</span><a - id="dx1-48003"></a>. For + id="dx1-55003"></a>. For example, suppose each entry not only has an associated symbol, but also units (stored in <span class="ecss-1000">user1</span><a - id="dx1-48004"></a>) and dimension (stored in <span + id="dx1-55004"></a>) and dimension (stored in <span class="ecss-1000">user2</span><a - id="dx1-48005"></a>). Then you can define a glossary style that + id="dx1-55005"></a>). Then you can define a glossary style that displays each entry in a <span class="ecss-1000">longtable</span><a - id="dx1-48006"></a><a - id="dx1-48007"></a> as follows: + id="dx1-55006"></a><a + id="dx1-55007"></a> as follows: </p> - <div class="verbatim" id="verbatim-117"> + <div class="verbatim" id="verbatim-137"> \newglossarystyle{long6col}{%  <br /> % put the glossary in a longtable environment:  <br /> \renewenvironment{theglossary}% @@ -11530,8 +13640,9 @@ class="ecss-1000">longtable</span><a  <br />  \\\endhead}%  <br /> % No heading between groups:  <br />  \renewcommand*{\glsgroupheading}[1]{}% - <br /> % Main (level 0) entries displayed in a row: + <br /> % Main (level 0) entries displayed in a row optionally numbered:  <br />  \renewcommand*{\glossaryentryfield}[5]{% + <br />    \glsentryitem{##1}% Entry number if required  <br />    \glstarget{##1}{##2}% Name  <br />    & ##3% Description  <br />    & ##4% Symbol @@ -11540,2996 +13651,3862 @@ class="ecss-1000">longtable</span><a  <br />    & ##5% Page list  <br />    \\% end of row  <br />  }% - <br /> % Sub entries treated the same as level 0 entries: + <br /> % Similarly for sub-entries (no sub-entry numbers):  <br /> \renewcommand*{\glossarysubentryfield}[6]{% - <br />  \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% + <br />    % ignoring first argument (sub-level) + <br />    \glstarget{##2}{##3}% Name + <br />    & ##4% Description + <br />    & ##5% Symbol + <br />    & \glsentryuseri{##2}% Units + <br />    & \glsentryuserii{##2}% Dimensions + <br />    & ##6% Page list + <br />    \\% end of row + <br />  }%  <br /> % Nothing between groups:  <br /> \renewcommand*{\glsgroupskip}{}%  <br />} </div> -<!--l. 4938--><p class="nopar" > -</p><!--l. 4941--><p class="noindent" > +<!--l. 5564--><p class="nopar" > +</p><!--l. 5567--><p class="noindent" > </p> -<!--l. 4941--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.14 </span> <a - id="x1-490002.14"></a>Accessibility Support</h4> -<!--l. 4942--><p class="noindent" >Limited accessibility support is provided by the accompanying <span +<!--l. 5567--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">17 </span> <a + id="x1-5600017"></a>Accessibility Support</h3> + + + +<!--l. 5568--><p class="noindent" >Limited accessibility support is provided by the accompanying <span class="ecss-1000">glossaries-accsupp</span><a - id="dx1-49001"></a> + id="dx1-56001"></a> package, but note that this package is experimental and it requires the <span class="ecss-1000">accsupp</span><a - id="dx1-49002"></a> package + id="dx1-56002"></a> package which is also listed as experimental. This package defines additional keys that may be used when defining glossary entries. The keys are as follows: </p><dl class="description"><dt class="description"> <span class="ecsx-1000">access</span><a - id="dx1-49003"></a> </dt><dd + id="dx1-56003"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">name</span><a - id="dx1-49004"></a> key. + id="dx1-56004"></a> key. </dd><dt class="description"> <span class="ecsx-1000">textaccess</span><a - id="dx1-49005"></a> </dt><dd + id="dx1-56005"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">text</span><a - id="dx1-49006"></a> key. - - - + id="dx1-56006"></a> key. </dd><dt class="description"> <span class="ecsx-1000">firstaccess</span><a - id="dx1-49007"></a> </dt><dd + id="dx1-56007"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">first</span><a - id="dx1-49008"></a> key. + id="dx1-56008"></a> key. </dd><dt class="description"> <span class="ecsx-1000">pluralaccess</span><a - id="dx1-49009"></a> </dt><dd + id="dx1-56009"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">plural</span><a - id="dx1-49010"></a> key. + id="dx1-56010"></a> key. </dd><dt class="description"> <span class="ecsx-1000">firstpluralaccess</span><a - id="dx1-49011"></a> </dt><dd + id="dx1-56011"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">firstplural</span><a - id="dx1-49012"></a> key. + id="dx1-56012"></a> key. </dd><dt class="description"> <span class="ecsx-1000">symbolaccess</span><a - id="dx1-49013"></a> </dt><dd + id="dx1-56013"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">symbol</span><a - id="dx1-49014"></a> key. + id="dx1-56014"></a> key. </dd><dt class="description"> <span class="ecsx-1000">symbolpluralaccess</span><a - id="dx1-49015"></a> </dt><dd + id="dx1-56015"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">symbolplural</span><a - id="dx1-49016"></a> key. + id="dx1-56016"></a> key. </dd><dt class="description"> <span class="ecsx-1000">descriptionaccess</span><a - id="dx1-49017"></a> </dt><dd + id="dx1-56017"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">description</span><a - id="dx1-49018"></a> key. + id="dx1-56018"></a> key. </dd><dt class="description"> <span class="ecsx-1000">descriptionpluralaccess</span><a - id="dx1-49019"></a> </dt><dd + id="dx1-56019"></a> </dt><dd class="description">The replacement text corresponding to the <span class="ecss-1000">descriptionplural</span><a - id="dx1-49020"></a> key. + id="dx1-56020"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">longaccess</span><a + id="dx1-56021"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">long</span><a + id="dx1-56022"></a> key (used by + <span +class="ectt-1000">\newacronym</span><a + id="dx1-56023"></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">shortaccess</span><a + id="dx1-56024"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">short</span><a + id="dx1-56025"></a> key (used by + <span +class="ectt-1000">\newacronym</span><a + id="dx1-56026"></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">longpluralaccess</span><a + id="dx1-56027"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">longplural</span><a + id="dx1-56028"></a> key (used + by <span +class="ectt-1000">\newacronym</span><a + id="dx1-56029"></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">shortpluralaccess</span><a + id="dx1-56030"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">shortplural</span><a + id="dx1-56031"></a> key (used + by <span +class="ectt-1000">\newacronym</span><a + id="dx1-56032"></a>). </dd></dl> -<!--l. 4978--><p class="indent" > For example: +<!--l. 5615--><p class="noindent" >For example: </p> - <div class="verbatim" id="verbatim-118"> + <div class="verbatim" id="verbatim-138"> \newglossaryentry{tex}{name={\TeX},description={Document preparation  <br />language},access={TeX}} </div> -<!--l. 4982--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span +<!--l. 5619--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span class="ectt-1000">\gls{tex}</span></span></span> will be equivalent to </p> - <div class="verbatim" id="verbatim-119"> + <div class="verbatim" id="verbatim-139"> \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} </div> -<!--l. 4986--><p class="nopar" > See the section “glossaries-accsupp code” in the document <span -class="ectt-1000">glossaries.pdf </span>for further -details. It is recommended that you also read the <span +<!--l. 5623--><p class="nopar" > The sample file <a +href="#x1-40001.1"><span +class="ectt-1000">sampleaccsupp.tex</span></a> illustrates the <span +class="ecss-1000">glossaries-accsupp</span><a + id="dx1-56033"></a> package. +</p><!--l. 5627--><p class="indent" > See the documented code (<span +class="ectt-1000">glossaries.pdf</span>) for further details. It is recommended +that you also read the <span class="ecss-1000">accsupp</span><a - id="dx1-49021"></a> documentation. -</p><!--l. 4992--><p class="noindent" > + id="dx1-56034"></a> documentation. +</p><!--l. 5631--><p class="noindent" > </p> -<!--l. 4992--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a - id="x1-500003"></a>Mfirstuc Package</h3> -<!--l. 4995--><p class="noindent" >The <span -class="ecss-1000">glossaries </span>bundle is supplied with the package <span -class="ecss-1000">mfirstuc</span><a - id="dx1-50001"></a> which provides the -command: -</p><!--l. 4997--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\makefirstuc</span><span -class="ectt-0900"> </span></span><a - id="dx1-50002"></a> <span -class="ectt-1000">\makefirstuc{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">stuff </span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 4999--><p class="noindent" > -which makes the first object of <span -class="cmsy-10">⟨</span><span -class="ecti-1000">stuff </span><span -class="cmsy-10">⟩ </span>uppercase unless <span -class="cmsy-10">⟨</span><span -class="ecti-1000">stuff </span><span -class="cmsy-10">⟩ </span>starts with a control -sequence followed by a non-empty group, in which case the first object in the group is -converted to uppercase. Examples: </p> - <ul class="itemize1"> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{abc}</span></span></span> produces Abc - </li> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\emph{abc}}</span></span></span> produces <span -class="ecti-1000">Abc </span>(<span -class="ectt-1000">\MakeUppercase</span><a - id="dx1-50003"></a> has been - applied to the letter “a” rather than <span -class="ectt-1000">\emph</span>.) Note however that - <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{\em</span><span -class="ectt-1000"> abc}}</span></span></span> produces <span -class="ecti-1000">ABC </span>and <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">{\makefirstuc{\em</span><span -class="ectt-1000"> abc}}</span></span></span> - produces abc. - </li> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{\’a}bc}</span></span></span> produces bc - </li> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\ae</span><span -class="ectt-1000"> bc}</span></span></span> produces bc - </li> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{\ae}bc}</span></span></span> produces bc - </li> - <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{</span><span -class="ectt-1000">}bc}</span></span></span> produces bc - </li></ul> -<!--l. 5022--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be -placed in a group (even if you are using the <span -class="ecss-1000">inputenc</span><a - id="dx1-50004"></a> package) due to expansion -issues. +<!--l. 5631--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">18 </span> <a + id="x1-5700018"></a>Troubleshooting</h3> +<!--l. 5634--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package comes with a minimal file called <span +class="ectt-1000">minimalgls.tex </span>which can be +used for testing. This should be located in the <span +class="ectt-1000">samples </span>subdirectory (folder) of the +<span +class="ecss-1000">glossaries </span>documentation directory. The location varies according to your operating +system and <span class="TEX">T<span +class="E">E</span>X</span> installation. For example, on my Linux partition it can be +found in <span +class="ectt-1000">/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/</span>. +Further information on debugging <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code is available at +<a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/" class="url" ><span +class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</span></a>. +</p><!--l. 5644--><p class="indent" > Below is a list of the most frequently asked questions. For other queries, consult the <span +class="ecss-1000">glossaries</span> +FAQ at <a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" class="url" ><span +class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html</span></a>. +</p><!--l. 5648--><p class="indent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-57002x1"><span +class="ecbx-1000">Q. </span>I get the error message: -</p><!--l. 5026--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span -class="ecss-1000">mfirstuc</span>, a bug fix resulted in a change in output if the first -object is a control sequence followed by an empty group. Prior to version 1.02, -<span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\ae{}bc}</span></span></span> produced Bc. However as from version 1.02, it now produces -bc. </div> -</p><!--l. 5032--><p class="noindent" > -</p><!--l. 5034--><p class="indent" > Note also that + <div class="verbatim" id="verbatim-140"> + Missing \begin{document} +</div> + <!--l. 5652--><p class="nopar" > + </p><!--l. 5654--><p class="noindent" ><span +class="ecbx-1000">A. </span>Check you are using an up to date version of the <span +class="ecss-1000">xkeyval</span><a + id="dx1-57003"></a> package. + </p></li> + <li + class="enumerate" id="x1-57005x2"><span +class="ecbx-1000">Q. </span>When I use <a + id="dx1-57006"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-57007"></a></a>, I get the following error message: + + + + <div class="verbatim" id="verbatim-141"> + ERROR: CHAR: index 0 should be less than the length of the string +</div> + <!--l. 5661--><p class="nopar" > + </p><!--l. 5663--><p class="noindent" ><span +class="ecbx-1000">A.</span> <a + id="dx1-57008"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-57009"></a></a> discards all commands and braces from the sort string. If your sort + string (either specified by the <span +class="ecss-1000">sort</span><a + id="dx1-57010"></a> key or the <span +class="ecss-1000">name</span><a + id="dx1-57011"></a> key) only consists of + commands, this will be treated by <a + id="dx1-57012"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57013"></a> as an empty sort string, which produces + an error message in newer versions of <a + id="dx1-57014"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57015"></a>. For example, the following will cause + a problem: </p> - <div class="verbatim" id="verbatim-120"> -\newcommand{\abc}{abc} - <br />\makefirstuc{\abc} + <div class="verbatim" id="verbatim-142"> + \newglossaryentry{alpha}{name={\ensuremath{\alpha}}, +  <br />  description=alpha} </div> -<!--l. 5038--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span -class="ectt-1000">\makefirstuc </span>is -<span -class="ectt-1000">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\MakeUppercase\abc</span></span></span>. Whereas: + <!--l. 5672--><p class="nopar" > Either use a different sort key for the entry, for example: </p> - <div class="verbatim" id="verbatim-121"> -\newcommand{\abc}{abc} - <br />\expandafter\makefirstuc\expandafter{\abc} + <div class="verbatim" id="verbatim-143"> + \newglossaryentry{alpha}{sort=alpha, +  <br />  name={\ensuremath{\alpha}}, +  <br />  description=alpha} </div> -<!--l. 5045--><p class="nopar" > produces: Abc. There is a short cut command which will do this:<br -class="newline" /> -</p><!--l. 5047--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\xmakefirstuc</span><span -class="ectt-0900"> </span></span><a - id="dx1-50005"></a> <span -class="ectt-1000">\xmakefirstuc{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">stuff </span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 5049--><p class="noindent" > -This is equivalent to <span -class="ectt-1000">\expandafter\makefirstuc\expandafter{</span><span -class="cmsy-10">⟨</span><span -class="ecti-1000">stuff </span><span -class="cmsy-10">⟩</span><span -class="ectt-1000">}</span>. -So + <!--l. 5678--><p class="nopar" > or, if all entries are like this, you may prefer to use the <span +class="ecss-1000">sort=use</span><a + id="dx1-57016"></a> or <span +class="ecss-1000">sort=def</span><a + id="dx1-57017"></a> + package options. See <a +href="#x1-160002.4">2.4 </a><a +href="#x1-160002.4">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a> for further details of the <span +class="ecss-1000">sort</span><a + id="dx1-57018"></a> + option. + </p></li> + <li + class="enumerate" id="x1-57020x3"><span +class="ecbx-1000">Q. </span>I’ve used the <span +class="ecss-1000">smallcaps</span><a + id="dx1-57021"></a> option, but the acronyms are displayed in normal sized + upper case letters. + <!--l. 5687--><p class="noindent" ><span +class="ecbx-1000">A. </span>The <span +class="ecss-1000">smallcaps</span><a + id="dx1-57022"></a> package option uses <span +class="ectt-1000">\textsc</span><a + id="dx1-57023"></a> to typeset the acronyms. This + command converts lower case letters to small capitals, while upper case letters + remain their usual size. Therefore you need to specify the acronym in lower case + letters. + </p></li> + <li + class="enumerate" id="x1-57025x4"><span +class="ecbx-1000">Q. </span>My acronyms won’t break across a line when they’re expanded. + <!--l. 5695--><p class="noindent" ><span +class="ecbx-1000">A. </span>PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> can break hyperlinks across a line, but <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> can’t. If you + can’t use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> then disable the <a + id="dx1-57026"></a><a +href="#glo:firstuse">first use</a> links using the package option + <span +class="ecss-1000">hyperfirst=false</span><a + id="dx1-57027"></a>. + </p></li> + <li + class="enumerate" id="x1-57029x5"><span +class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in? + <!--l. 5701--><p class="noindent" ><span +class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span +class="ecss-1000">smaller</span><a + id="dx1-57030"></a> package option and redefine + <span +class="ectt-1000">\acronymfont</span><a + id="dx1-57031"></a> to use the required typesetting command. For example, suppose + you would like the acronyms displayed in a sans-serif font, then you can + do: </p> - <div class="verbatim" id="verbatim-122"> -\newcommand{\abc}{abc} - <br />\xmakefirstuc{\abc} + <div class="verbatim" id="verbatim-144"> + \usepackage[smaller]{glossaries} +  <br />\renewcommand*{\acronymfont}[1]{\textsf{#1}} </div> -<!--l. 5054--><p class="nopar" > produces: Abc. -</p><!--l. 5057--><p class="indent" > If you want to use an alternative command to convert to uppercase, for example -<span -class="ectt-1000">\MakeTextUppercase</span>,<span class="footnote-mark"><a -href="#fn15x0" id="fn15x0-bk"><sup class="textsuperscript">15</sup></a></span><a - id="x1-50006f15"></a> -you can redefine the internal command <span -class="ectt-1000">\@gls@makefirstuc</span>. For example: + <!--l. 5708--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-57033x6"><span +class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in on <a + id="dx1-57034"></a><a +href="#glo:firstuse">first + use</a>? + <!--l. 5713--><p class="noindent" ><span +class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span +class="ecss-1000">smaller</span><a + id="dx1-57035"></a> package option and redefine + <span +class="ectt-1000">\firstacronymfont</span><a + id="dx1-57036"></a> to use the required command. Note that if you don’t want + the acronym on subsequent use to use <span +class="ectt-1000">\textsmaller</span><a + id="dx1-57037"></a>, you will also need to + redefine <span +class="ectt-1000">\acronymfont</span><a + id="dx1-57038"></a>, as above. For example to make the acronym emphasized + on <a + id="dx1-57039"></a><a +href="#glo:firstuse">first use</a>, but use the surrounding font for subsequent use, you can + do: </p> - <div class="verbatim" id="verbatim-123"> -\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} + <div class="verbatim" id="verbatim-145"> + \usepackage[smaller]{glossaries} +  <br />\renewcommand*{\firstacronymfont}[1]{\emph{#1}} +  <br />\renewcommand*{\acronymfont}[1]{#1} </div> -<!--l. 5063--><p class="nopar" > (Remember that command names that contain the @ character must either be placed -in packages or be placed between <span -class="ectt-1000">\makeatletter </span>and <span -class="ectt-1000">\makeatother</span>.) + <!--l. 5723--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-57041x7"><span +class="ecbx-1000">Q. </span>I don’t have Perl installed, do I have to use <a + id="dx1-57042"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-57043"></a></a>? + <!--l. 5728--><p class="noindent" ><span +class="ecbx-1000">A. </span>Although it is strongly recommended that you use <a + id="dx1-57044"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-57045"></a></a>, you don’t + have to use it. For further details, read <a +href="#x1-90001.3.2">1.3.2 </a><a +href="#x1-90001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a> or <a +href="#x1-100001.3.3">1.3.3 + </a><a +href="#x1-100001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>, depending on whether you want to use <a + id="dx1-57046"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-57047"></a></a> or + <a + id="dx1-57048"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-57049"></a></a>. + </p></li> + <li + class="enumerate" id="x1-57051x8"><span +class="ecbx-1000">Q. </span>I’m used to using the <span +class="ecss-1000">glossary </span>package: are there any instructions on migrating + from the <span +class="ecss-1000">glossary</span><a + id="dx1-57052"></a> package to the <span +class="ecss-1000">glossaries </span>package? + <!--l. 5737--><p class="noindent" ><span +class="ecbx-1000">A. </span>Read <a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> which + should be available from the same location as this document. + </p></li> + <li + class="enumerate" id="x1-57054x9"><span +class="ecbx-1000">Q. </span>I’m using <span +class="ecss-1000">babel</span><a + id="dx1-57055"></a> but the fixed names haven’t been translated. + <!--l. 5744--><p class="noindent" ><span +class="ecbx-1000">A. </span>The <span +class="ecss-1000">glossaries </span>package currently only supports the following languages: + Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, Italian, + Hungarian, Polish, Serbian and Spanish. If you want to add another language, + send me the translations, and I’ll add them to the next version. + </p><!--l. 5750--><p class="noindent" >If you are using one of the above languages, but the text hasn’t been translated, + try adding the <span +class="ecss-1000">translator</span><a + id="dx1-57056"></a> package with the required languages explicitly (before + you load the <span +class="ecss-1000">glossaries </span>package). For example: + + + +</p> + <div class="verbatim" id="verbatim-146"> + \usepackage[ngerman]{babel} +  <br />\usepackage[ngerman]{translator} +  <br />\usepackage{glossaries} +</div> + <!--l. 5758--><p class="nopar" > Alternatively, you can add the language as a global option to the class file. Check + the <span +class="ecss-1000">translator </span>package documentation for further details. + </p></li> + <li + class="enumerate" id="x1-57058x10"><span +class="ecbx-1000">Q. </span>My acronyms contain strange characters when I use commands like + <span +class="ectt-1000">\acrlong</span><a + id="dx1-57059"></a>. + <!--l. 5766--><p class="noindent" ><span +class="ecbx-1000">A. </span>Switch off the sanitization: + + + +</p> + <div class="verbatim" id="verbatim-147"> + \usepackage[sanitize=none]{glossaries} +</div> + <!--l. 5769--><p class="nopar" > and protect fragile commands. + </p></li> + <li + class="enumerate" id="x1-57061x11"><span +class="ecbx-1000">Q. </span>Weird characters appear when I use <span +class="ectt-1000">\glsentryname</span><a + id="dx1-57062"></a> or <span +class="ectt-1000">\glsname</span><a + id="dx1-57063"></a>. + <!--l. 5775--><p class="noindent" ><span +class="ecbx-1000">A. </span>Either use <span +class="ectt-1000">\glsentrytext</span><a + id="dx1-57064"></a> or <span +class="ectt-1000">\glstext</span><a + id="dx1-57065"></a>, respectively, or switch off the + sanitization for the <span +class="ecss-1000">name</span><a + id="dx1-57066"></a> key: + + + +</p> + <div class="verbatim" id="verbatim-148"> + \usepackage[sanitize={name=false}]{glossaries} +</div> + <!--l. 5780--><p class="nopar" > and protect fragile commands. + </p></li> + <li + class="enumerate" id="x1-57068x12"><span +class="ecbx-1000">Q. </span>Weird characters appear when I try to display an entry’s description. + <!--l. 5786--><p class="noindent" ><span +class="ecbx-1000">A. </span>Switch off the sanitization for the <span +class="ecss-1000">description</span><a + id="dx1-57069"></a> key: -</p><!--l. 5074--><p class="indent" > <a - id="likesection.1"></a><a - id="Q1-1-59"></a> +</p> + <div class="verbatim" id="verbatim-149"> + \usepackage[sanitize={description=false}]{glossaries} +</div> + <!--l. 5790--><p class="nopar" > and protect fragile commands. + </p></li> + <li + class="enumerate" id="x1-57071x13"><span +class="ecbx-1000">Q. </span>My glossaries haven’t appeared. + <!--l. 5795--><p class="noindent" ><span +class="ecbx-1000">A. </span>Remember to do the following: </p> + <ul class="itemize1"> + <li class="itemize">Add <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-57072"></a> to the document preamble. + </li> + <li class="itemize">Use either <span +class="ectt-1000">\printglossary</span><a + id="dx1-57073"></a> for each glossary that has been defined or + <span +class="ectt-1000">\printglossaries</span><a + id="dx1-57074"></a>. + </li> + <li class="itemize">Use the commands listed in <a +href="#x1-260006">6 </a><a +href="#x1-260006">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a +href="#x1-290007">7 </a><a +href="#x1-290007">Adding an + Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a +href="#x1-300008">8 </a><a +href="#x1-300008">Cross-Referencing + Entries<!--tex4ht:ref: sec:crossref --></a> for each entry that you want to appear in the glossary. + </li> + <li class="itemize">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document, then run <a + id="dx1-57075"></a><a +href="#glo:makeglossaries"><span +class="ectt-1000">makeglossaries</span><a + id="dx1-57076"></a></a>, then run + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document again. If you want the glossaries to appear + in the table of contents, you will need an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. If any + of your entries cross-reference an entry that’s not referenced in the + main body of the document, you will need to run <a + id="dx1-57077"></a><span +class="ectt-1000">makeglossaries</span><a + id="dx1-57078"></a> + (see <a +href="#x1-70001.3">1.3 </a><a +href="#x1-70001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>) after the second + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run, followed by another <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run.</li></ul> + <!--l. 5815--><p class="noindent" >Check the log files (<span +class="ectt-1000">.log</span><a + id="dx1-57079"></a>, <span +class="ectt-1000">.glg</span><a + id="dx1-57080"></a> etc) for any warnings. + </p></li> + <li + class="enumerate" id="x1-57082x14"><span +class="ecbx-1000">Q. </span>It is possible to change the rules used to sort the glossary entries? + <!--l. 5821--><p class="noindent" ><span +class="ecbx-1000">A. </span>If it’s for an individual entry, then you can use the entry’s <span +class="ecss-1000">sort</span><a + id="dx1-57083"></a> key to sort it + according to a different term. If it’s for the entire alphabet, then you will + need to use <a + id="dx1-57084"></a><a +href="#glo:xindy"><span +class="ectt-1000">xindy</span><a + id="dx1-57085"></a></a> (instead of <a + id="dx1-57086"></a><a +href="#glo:makeindex"><span +class="ectt-1000">makeindex</span><a + id="dx1-57087"></a></a>) and use an appropriate <a + id="dx1-57088"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57089"></a> + language module. Writing <a + id="dx1-57090"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57091"></a> modules or styles is beyond the scope + of this manual. Further information about <a + id="dx1-57092"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57093"></a> can be found at the + <a +href="http://xindy.sourceforge.net/" >Xindy Web Site</a>. There is also a link to the <a + id="dx1-57094"></a><span +class="ectt-1000">xindy</span><a + id="dx1-57095"></a> mailing list from that + site. + </p><!--l. 5831--><p class="noindent" >If you want to sort according to order of definition or order of use, use the <span +class="ecss-1000">sort</span><a + id="dx1-57096"></a> + package option described in <a +href="#x1-160002.4">2.4 </a><a +href="#x1-160002.4">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>. +</p> + </li></ol> + + + + + + +<!--l. 5838--><p class="indent" > <a + id="likesection.2"></a><a + id="Q1-1-67"></a> </p> <!--l. 2--><p class="noindent" ><a href="#top">Top</a></p><h3 class="likesectionHead"><a - id="x1-510003"></a>Index</h3> + id="x1-5800018"></a>Index</h3> <!--l. 4--><p class="noindent" > <span class="ecbx-1000">Symbols</span> </p> <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\@gls@codepage</span></span></span>  <a -href="glossaries-manual.html#dx1-10012" ><span +href="glossaries-user.html#dx1-11017" ><span class="ecti-1000">1</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\@glsorder</span></span></span>  <a -href="glossaries-manual.html#dx1-10009" ><span +href="glossaries-user.html#dx1-11013" ><span class="ecti-1000">2</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\@istfilename</span></span></span>  <a -href="glossaries-manual.html#dx1-10004" ><span +href="glossaries-user.html#dx1-11006" ><span class="ecti-1000">3</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\@newglossary</span></span></span>  <a -href="glossaries-manual.html#dx1-10003" ><span +href="glossaries-user.html#dx1-11005" ><span class="ecti-1000">4</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\@xdylanguage</span></span></span>  <a -href="glossaries-manual.html#dx1-10011" ><span +href="glossaries-user.html#dx1-11016" ><span class="ecti-1000">5</span></a> <br /></span> <p class="theindex"> <span class="ecbx-1000">A</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Ac</span></span></span>  <a -href="glossaries-manual.html#dx1-34183" ><span class="underline">6</span></a> <br /></span> +href="glossaries-user.html#dx1-39108" >6</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\ac</span></span></span>  <a -href="glossaries-manual.html#dx1-34181" ><span class="underline">7</span></a> <br /></span> +href="glossaries-user.html#dx1-39106" >7</a> <br /></span> <span class="index-item"><span class="ecss-1000">accsupp </span>package  <a -href="glossaries-manual.html#dx1-49002" >8</a>, <a -href="glossaries-manual.html#dx1-49021" >9</a> <br /></span> +href="glossaries-user.html#dx1-56002" >8</a>, <a +href="glossaries-user.html#dx1-56034" >9</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acf</span></span></span>  <a -href="glossaries-manual.html#dx1-34175" ><span class="underline">10</span></a> <br /></span> +href="glossaries-user.html#dx1-39100" >10</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acf</span></span></span>  <a -href="glossaries-manual.html#dx1-34173" ><span class="underline">11</span></a> <br /></span> +href="glossaries-user.html#dx1-39098" >11</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acfp</span></span></span>  <a -href="glossaries-manual.html#dx1-34179" ><span class="underline">12</span></a> <br /></span> +href="glossaries-user.html#dx1-39104" >12</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acfp</span></span></span>  <a -href="glossaries-manual.html#dx1-34177" ><span class="underline">13</span></a> <br /></span> +href="glossaries-user.html#dx1-39102" >13</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acl</span></span></span>  <a -href="glossaries-manual.html#dx1-34167" ><span class="underline">14</span></a> <br /></span> +href="glossaries-user.html#dx1-39092" >14</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acl</span></span></span>  <a -href="glossaries-manual.html#dx1-34165" ><span class="underline">15</span></a> <br /></span> +href="glossaries-user.html#dx1-39090" >15</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Aclp</span></span></span>  <a -href="glossaries-manual.html#dx1-34171" ><span class="underline">16</span></a> <br /></span> +href="glossaries-user.html#dx1-39096" >16</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\aclp</span></span></span>  <a -href="glossaries-manual.html#dx1-34169" ><span class="underline">17</span></a> <br /></span> +href="glossaries-user.html#dx1-39094" >17</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acp</span></span></span>  <a -href="glossaries-manual.html#dx1-34187" ><span class="underline">18</span></a> <br /></span> +href="glossaries-user.html#dx1-39112" >18</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acp</span></span></span>  <a -href="glossaries-manual.html#dx1-34185" ><span class="underline">19</span></a> <br /></span> +href="glossaries-user.html#dx1-39110" >19</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\ACRfull</span></span></span>  <a -href="glossaries-manual.html#dx1-34148" ><span +href="glossaries-user.html#dx1-39078" ><span class="ecti-1000">20</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acrfull</span></span></span>  <a -href="glossaries-manual.html#dx1-34147" ><span +href="glossaries-user.html#dx1-39077" ><span class="ecti-1000">21</span></a>, <a -href="glossaries-manual.html#dx1-34176" ><span class="underline">22</span></a> <br /></span> +href="glossaries-user.html#dx1-39101" >22</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrfull</span></span></span>  <a -href="glossaries-manual.html#dx1-34146" ><span +href="glossaries-user.html#dx1-39072" ><span class="ecti-1000">23</span></a>, <a -href="glossaries-manual.html#dx1-34174" ><span class="underline">24</span></a> <br /></span> +href="glossaries-user.html#dx1-39099" >24</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrfullformat</span></span></span>  <a +href="glossaries-user.html#dx1-39073" ><span +class="ecti-1000">25</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acrfullpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34180" ><span class="underline">25</span></a> <br /></span> +href="glossaries-user.html#dx1-39105" >26</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrfullpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34178" ><span class="underline">26</span></a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\ACRlong</span></span></span>  <a -href="glossaries-manual.html#dx1-34142" ><span -class="ecti-1000">27</span></a> <br /></span> +href="glossaries-user.html#dx1-39103" >27</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acrlong</span></span></span>  <a -href="glossaries-manual.html#dx1-34141" ><span +href="glossaries-user.html#dx1-39070" ><span class="ecti-1000">28</span></a>, <a -href="glossaries-manual.html#dx1-34168" ><span class="underline">29</span></a> <br /></span> +href="glossaries-user.html#dx1-39093" >29</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrlong</span></span></span>  <a -href="glossaries-manual.html#dx1-11034" ><span class="underline">30</span></a>, <a -href="glossaries-manual.html#dx1-34140" ><span -class="ecti-1000">31</span></a>, <a -href="glossaries-manual.html#dx1-34166" ><span class="underline">32</span></a> <br /></span> +href="glossaries-user.html#dx1-39069" ><span +class="ecti-1000">30</span></a>, <a +href="glossaries-user.html#dx1-39074" >31</a>, <a +href="glossaries-user.html#dx1-39091" >32</a>, <a +href="glossaries-user.html#dx1-57059" >33</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acrlongpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34172" ><span class="underline">33</span></a> <br /></span> +href="glossaries-user.html#dx1-39097" >34</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrlongpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34170" ><span class="underline">34</span></a> <br /></span> +href="glossaries-user.html#dx1-39095" >35</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrnameformat</span></span></span>  <a -href="glossaries-manual.html#dx1-34097" ><span -class="ecti-1000">35</span></a>, <a -href="glossaries-manual.html#dx1-34099" ><span class="underline">36</span></a>, <a -href="glossaries-manual.html#dx1-34100" ><span class="underline">37</span></a> <br /></span> +href="glossaries-user.html#dx1-41008" ><span +class="ecti-1000">36</span></a>, <a +href="glossaries-user.html#dx1-41023" >37</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acronymfont</span></span></span>  <a -href="glossaries-manual.html#dx1-13090" ><span class="underline">38</span></a>, <a -href="glossaries-manual.html#dx1-34027" ><span +href="glossaries-user.html#dx1-17024" >38</a>, <a +href="glossaries-user.html#dx1-39051" ><span class="ecti-1000">39</span></a>, <a -href="glossaries-manual.html#dx1-34098" ><span class="underline">40</span></a>, <a -href="glossaries-manual.html#dx1-34125" ><span class="underline">41</span></a>, <a -href="glossaries-manual.html#dx1-34139" ><span class="underline">42</span></a> <br /></span> +href="glossaries-user.html#dx1-39076" >40</a>, <a +href="glossaries-user.html#dx1-40027" >41</a>, <a +href="glossaries-user.html#dx1-40034" >42</a>, <a +href="glossaries-user.html#dx1-40035" >43</a>, <a +href="glossaries-user.html#dx1-40042" >44</a>, <a +href="glossaries-user.html#dx1-41012" >45</a>, <a +href="glossaries-user.html#dx1-41019" >46</a>, <a +href="glossaries-user.html#dx1-41025" >47</a>, <a +href="glossaries-user.html#dx1-41027" >48</a>, <a +href="glossaries-user.html#dx1-41029" >49</a>, <a +href="glossaries-user.html#dx1-57031" >50</a>, <a +href="glossaries-user.html#dx1-57038" >51</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acronymname</span></span></span>  <a -href="glossaries-manual.html#dx1-5015" ><span class="underline">43</span></a> <br /></span> +href="glossaries-user.html#dx1-6015" >52</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acronymtype</span></span></span>  <a -href="glossaries-manual.html#dx1-13015" ><span class="underline">44</span></a>, <a -href="glossaries-manual.html#dx1-13022" ><span class="underline">45</span></a>, <a -href="glossaries-manual.html#dx1-13037" ><span class="underline">46</span></a>, <a -href="glossaries-manual.html#dx1-14087" ><span class="underline">47</span></a>, <a -href="glossaries-manual.html#dx1-33009" ><span -class="ecti-1000">48</span></a>, <a -href="glossaries-manual.html#dx1-34003" ><span class="underline">49</span></a>, <a -href="glossaries-manual.html#dx1-34004" ><span class="underline">50</span></a>, <a -href="glossaries-manual.html#dx1-13017" ><span class="underline">51</span></a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\acrpluralsuffix</span></span></span>  <a -href="glossaries-manual.html#dx1-35029" ><span class="underline">52</span></a> <br /></span> +href="glossaries-user.html#dx1-14024" >53</a>, <a +href="glossaries-user.html#dx1-17003" >54</a>, <a +href="glossaries-user.html#dx1-17010" >55</a>, <a +href="glossaries-user.html#dx1-29007" >56</a>, <a +href="glossaries-user.html#dx1-38013" ><span +class="ecti-1000">57</span></a>, <a +href="glossaries-user.html#dx1-39004" >58</a>, <a +href="glossaries-user.html#dx1-39033" >59</a>, <a +href="glossaries-user.html#dx1-17005" >60</a>, <a +href="glossaries-user.html#dx1-24010" >61</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\ACRshort</span></span></span>  <a -href="glossaries-manual.html#dx1-34137" ><span -class="ecti-1000">53</span></a> <br /></span> +href="glossaries-user.html#dx1-39068" ><span +class="ecti-1000">62</span></a>, <a +href="glossaries-user.html#dx1-39071" ><span +class="ecti-1000">63</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrshort</span></span></span>  <a +href="glossaries-user.html#dx1-39067" ><span +class="ecti-1000">64</span></a>, <a +href="glossaries-user.html#dx1-39085" >65</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\Acrshort</span></span></span>  <a -href="glossaries-manual.html#dx1-34136" ><span -class="ecti-1000">54</span></a>, <a -href="glossaries-manual.html#dx1-34160" ><span class="underline">55</span></a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrshort</span></span></span>  <a -href="glossaries-manual.html#dx1-34020" ><span class="underline">56</span></a>, <a -href="glossaries-manual.html#dx1-34135" ><span -class="ecti-1000">57</span></a>, <a -href="glossaries-manual.html#dx1-34158" ><span class="underline">58</span></a> <br /></span> +href="glossaries-user.html#dx1-39065" ><span +class="ecti-1000">66</span></a>, <a +href="glossaries-user.html#dx1-39075" >67</a>, <a +href="glossaries-user.html#dx1-39083" >68</a>, <a +href="glossaries-user.html#dx1-40013" >69</a>, <a +href="glossaries-user.html#dx1-3004" >70</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acrshortpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34164" ><span class="underline">59</span></a> <br /></span> +href="glossaries-user.html#dx1-39089" >71</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acrshortpl</span></span></span>  <a -href="glossaries-manual.html#dx1-34162" ><span class="underline">60</span></a> <br /></span> +href="glossaries-user.html#dx1-39087" >72</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acs</span></span></span>  <a -href="glossaries-manual.html#dx1-34159" ><span class="underline">61</span></a> <br /></span> +href="glossaries-user.html#dx1-39084" >73</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acs</span></span></span>  <a -href="glossaries-manual.html#dx1-34157" ><span class="underline">62</span></a> <br /></span> +href="glossaries-user.html#dx1-39082" >74</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Acsp</span></span></span>  <a -href="glossaries-manual.html#dx1-34163" ><span class="underline">63</span></a> <br /></span> +href="glossaries-user.html#dx1-39088" >75</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\acsp</span></span></span>  <a -href="glossaries-manual.html#dx1-34161" ><span class="underline">64</span></a> <br /></span> +href="glossaries-user.html#dx1-39086" >76</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\addcontentsline</span></span></span>  <a +href="glossaries-user.html#dx1-14007" >77</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\andname</span></span></span>  <a +href="glossaries-user.html#dx1-31011" >78</a> <br /></span> <span class="index-item"><span class="ecss-1000">array </span>package  <a -href="glossaries-manual.html#dx1-41006" >65</a>, <a -href="glossaries-manual.html#dx1-43006" >66</a> <br /></span> +href="glossaries-user.html#dx1-48006" >79</a>, <a +href="glossaries-user.html#dx1-50006" >80</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">B</span> <span class="index-item"><span class="ecss-1000">babel </span>package  <a -href="glossaries-manual.html#dx1-5001" >67</a>, <a -href="glossaries-manual.html#dx1-5003" >68</a>, <a -href="glossaries-manual.html#dx1-5009" >69</a>, <a -href="glossaries-manual.html#dx1-5023" >70</a>, <a -href="glossaries-manual.html#dx1-5027" >71</a>, <a -href="glossaries-manual.html#dx1-5032" >72</a>, <a -href="glossaries-manual.html#dx1-11030" >73</a>, <a -href="glossaries-manual.html#dx1-13118" >74</a>, <a -href="glossaries-manual.html#dx1-13123" >75</a>, <a -href="glossaries-manual.html#dx1-13128" >76</a>, <a -href="glossaries-manual.html#dx1-13133" >77</a> <br /></span> +href="glossaries-user.html#dx1-6001" >81</a>, <a +href="glossaries-user.html#dx1-6003" >82</a>, <a +href="glossaries-user.html#dx1-6009" >83</a>, <a +href="glossaries-user.html#dx1-6023" >84</a>, <a +href="glossaries-user.html#dx1-6028" >85</a>, <a +href="glossaries-user.html#dx1-6033" >86</a>, <a +href="glossaries-user.html#dx1-13043" >87</a>, <a +href="glossaries-user.html#dx1-13048" >88</a>, <a +href="glossaries-user.html#dx1-13053" >89</a>, <a +href="glossaries-user.html#dx1-13058" >90</a>, <a +href="glossaries-user.html#dx1-57055" >91</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">beamer </span>package  <a +href="glossaries-user.html#dx1-6027" >92</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">C</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\chapter</span></span></span>  <a +href="glossaries-user.html#dx1-33028" >93</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\chapter*</span></span></span>  <a +href="glossaries-user.html#dx1-33026" >94</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\currentglossary</span></span></span>  <a +href="glossaries-user.html#dx1-52064" ><span +class="ecti-1000">95</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\CustomAcronymFields</span></span></span>  <a -href="glossaries-manual.html#dx1-35001" ><span -class="ecti-1000">78</span></a>, <a -href="glossaries-manual.html#dx1-35021" ><span class="underline">79</span></a>, <a -href="glossaries-manual.html#dx1-35051" ><span class="underline">80</span></a> <br /></span> +href="glossaries-user.html#dx1-42001" ><span +class="ecti-1000">96</span></a>, <a +href="glossaries-user.html#dx1-42026" >97</a>, <a +href="glossaries-user.html#dx1-42056" >98</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">D</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\defdisplay</span></span></span>  <a +href="glossaries-user.html#dx1-39008" >99</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\defdisplayfirst</span></span></span>  <a +href="glossaries-user.html#dx1-39007" >100</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\defglsdisplay</span></span></span>  <a -href="glossaries-manual.html#dx1-22025" ><span -class="ecti-1000">81</span></a>, <a -href="glossaries-manual.html#dx1-34064" ><span class="underline">82</span></a>, <a -href="glossaries-manual.html#dx1-34151" ><span class="underline">83</span></a>, <a -href="glossaries-manual.html#dx1-35016" ><span class="underline">84</span></a>, <a -href="glossaries-manual.html#dx1-35035" ><span class="underline">85</span></a>, <a -href="glossaries-manual.html#dx1-35038" ><span class="underline">86</span></a> <br /></span> +href="glossaries-user.html#dx1-27033" ><span +class="ecti-1000">101</span></a>, <a +href="glossaries-user.html#dx1-42016" >102</a>, <a +href="glossaries-user.html#dx1-42040" >103</a>, <a +href="glossaries-user.html#dx1-42043" >104</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\defglsdisplayfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-22026" ><span -class="ecti-1000">87</span></a>, <a -href="glossaries-manual.html#dx1-34065" ><span class="underline">88</span></a>, <a -href="glossaries-manual.html#dx1-34152" ><span class="underline">89</span></a>, <a -href="glossaries-manual.html#dx1-35015" ><span class="underline">90</span></a>, <a -href="glossaries-manual.html#dx1-35034" ><span class="underline">91</span></a>, <a -href="glossaries-manual.html#dx1-35037" ><span class="underline">92</span></a> <br /></span> +href="glossaries-user.html#dx1-27034" ><span +class="ecti-1000">105</span></a>, <a +href="glossaries-user.html#dx1-42015" >106</a>, <a +href="glossaries-user.html#dx1-42039" >107</a>, <a +href="glossaries-user.html#dx1-42042" >108</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\delimN</span></span></span>  <a +href="glossaries-user.html#dx1-52048" >109</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\delimR</span></span></span>  <a +href="glossaries-user.html#dx1-52049" >110</a> <br /></span> <span class="index-item"><span class="ectt-1000">description </span>(environment)  <a -href="glossaries-manual.html#dx1-39002" ><span class="underline">93</span></a>, <a -href="glossaries-manual.html#dx1-39007" ><span class="underline">94</span></a>, <a -href="glossaries-manual.html#dx1-39025" ><span class="underline">95</span></a>, <a -href="glossaries-manual.html#dx1-45007" ><span class="underline">96</span></a>, <a -href="glossaries-manual.html#dx1-45011" ><span class="underline">97</span></a> <br /></span> +href="glossaries-user.html#dx1-46002" >111</a>, <a +href="glossaries-user.html#dx1-46007" >112</a>, <a +href="glossaries-user.html#dx1-46029" >113</a>, <a +href="glossaries-user.html#dx1-52009" >114</a>, <a +href="glossaries-user.html#dx1-52013" >115</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\descriptionname</span></span></span>  <a -href="glossaries-manual.html#dx1-5018" ><span class="underline">98</span></a> <br /></span> +href="glossaries-user.html#dx1-6018" >116</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">E</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\emph</span></span></span>  <a -href="glossaries-manual.html#dx1-21022" ><span class="underline">99</span></a> <br /></span> +href="glossaries-user.html#dx1-26033" >117</a> <br /></span> +<span class="index-item">entry location  <a +href="glossaries-user.html#dx1-2006" ><span +class="ecbx-1000">118</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\entryname</span></span></span>  <a -href="glossaries-manual.html#dx1-5017" ><span class="underline">100</span></a> <br /></span> +href="glossaries-user.html#dx1-6017" >119</a> <br /></span> <span class="index-item">environments:<br /></span> <span class="index-subitem">    <span class="ectt-1000">description</span>  <a -href="glossaries-manual.html#dx1-39003" ><span class="underline">101</span></a>, <a -href="glossaries-manual.html#dx1-39008" ><span class="underline">102</span></a>, <a -href="glossaries-manual.html#dx1-39026" ><span class="underline">103</span></a>, <a -href="glossaries-manual.html#dx1-45008" ><span class="underline">104</span></a>, <a -href="glossaries-manual.html#dx1-45012" ><span class="underline">105</span></a> <br /></span> +href="glossaries-user.html#dx1-46003" >120</a>, <a +href="glossaries-user.html#dx1-46008" >121</a>, <a +href="glossaries-user.html#dx1-46030" >122</a>, <a +href="glossaries-user.html#dx1-52010" >123</a>, <a +href="glossaries-user.html#dx1-52014" >124</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">equation</span>  <a -href="glossaries-manual.html#dx1-3025" ><span class="underline">106</span></a> <br /></span> +href="glossaries-user.html#dx1-4033" >125</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">itemize</span>  <a -href="glossaries-manual.html#dx1-46002" ><span class="underline">107</span></a> <br /></span> +href="glossaries-user.html#dx1-53002" >126</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longtable</span>  <a -href="glossaries-manual.html#dx1-40003" ><span class="underline">108</span></a>, <a -href="glossaries-manual.html#dx1-40008" ><span class="underline">109</span></a>, <a -href="glossaries-manual.html#dx1-41004" ><span class="underline">110</span></a>, <a -href="glossaries-manual.html#dx1-42007" ><span class="underline">111</span></a>, <a -href="glossaries-manual.html#dx1-48007" ><span class="underline">112</span></a> <br /></span> +href="glossaries-user.html#dx1-47003" >127</a>, <a +href="glossaries-user.html#dx1-47008" >128</a>, <a +href="glossaries-user.html#dx1-48004" >129</a>, <a +href="glossaries-user.html#dx1-49007" >130</a>, <a +href="glossaries-user.html#dx1-55007" >131</a>, <a +href="glossaries-user.html#dx1-33040" >132</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">supertabular</span>  <a -href="glossaries-manual.html#dx1-42003" ><span class="underline">113</span></a>, <a -href="glossaries-manual.html#dx1-42009" ><span class="underline">114</span></a>, <a -href="glossaries-manual.html#dx1-42014" ><span class="underline">115</span></a>, <a -href="glossaries-manual.html#dx1-43004" ><span class="underline">116</span></a>, <a -href="glossaries-manual.html#dx1-43011" ><span class="underline">117</span></a> <br /></span> +href="glossaries-user.html#dx1-49003" >133</a>, <a +href="glossaries-user.html#dx1-49009" >134</a>, <a +href="glossaries-user.html#dx1-49014" >135</a>, <a +href="glossaries-user.html#dx1-50004" >136</a>, <a +href="glossaries-user.html#dx1-50011" >137</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">theglossary</span>  <a -href="glossaries-manual.html#dx1-45003" ><span -class="ecti-1000">118</span></a>, <a -href="glossaries-manual.html#dx1-45005" ><span class="underline">119</span></a>, <a -href="glossaries-manual.html#dx1-45010" ><span class="underline">120</span></a>, <a -href="glossaries-manual.html#dx1-46004" ><span class="underline">121</span></a> <br /></span> +href="glossaries-user.html#dx1-52003" ><span +class="ecti-1000">138</span></a>, <a +href="glossaries-user.html#dx1-52005" >139</a>, <a +href="glossaries-user.html#dx1-52012" >140</a>, <a +href="glossaries-user.html#dx1-53004" >141</a> <br /></span> + + + <span class="index-item"><span class="ectt-1000">equation </span>(environment)  <a -href="glossaries-manual.html#dx1-3024" ><span class="underline">122</span></a> <br /></span> +href="glossaries-user.html#dx1-4032" >142</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">etex </span>package  <a +href="glossaries-user.html#dx1-13030" >143</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">F</span> <span class="index-item">file types<br /></span> <span class="index-subitem">    <span class="ectt-1000">.alg</span>  <a -href="glossaries-manual.html#dx1-6029" >123</a> <br /></span> +href="glossaries-user.html#dx1-7080" >144</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.aux</span>  <a -href="glossaries-manual.html#dx1-7002" >124</a>, <a -href="glossaries-manual.html#dx1-30004" >125</a> <br /></span> +href="glossaries-user.html#dx1-8003" >145</a>, <a +href="glossaries-user.html#dx1-35007" >146</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.glg</span>  <a -href="glossaries-manual.html#dx1-6028" >126</a>, <a -href="glossaries-manual.html#dx1-8013" >127</a>, <a -href="glossaries-manual.html#dx1-9012" >128</a>, <a -href="glossaries-manual.html#dx1-11043" >129</a> <br /></span> +href="glossaries-user.html#dx1-7079" >147</a>, <a +href="glossaries-user.html#dx1-9019" >148</a>, <a +href="glossaries-user.html#dx1-10017" >149</a>, <a +href="glossaries-user.html#dx1-57080" >150</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.glo</span>  <a -href="glossaries-manual.html#dx1-8015" >130</a>, <a -href="glossaries-manual.html#dx1-9014" >131</a>, <a -href="glossaries-manual.html#dx1-14002" >132</a> <br /></span> +href="glossaries-user.html#dx1-9021" >151</a>, <a +href="glossaries-user.html#dx1-10019" >152</a>, <a +href="glossaries-user.html#dx1-19005" >153</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.gls</span>  <a -href="glossaries-manual.html#dx1-8014" >133</a>, <a -href="glossaries-manual.html#dx1-9013" >134</a>, <a -href="glossaries-manual.html#dx1-14003" >135</a> <br /></span> - - - +href="glossaries-user.html#dx1-9020" >154</a>, <a +href="glossaries-user.html#dx1-10018" >155</a>, <a +href="glossaries-user.html#dx1-19006" >156</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.ist</span>  <a -href="glossaries-manual.html#dx1-9005" >136</a>, <a -href="glossaries-manual.html#dx1-9007" >137</a>, <a -href="glossaries-manual.html#dx1-10006" >138</a>, <a -href="glossaries-manual.html#dx1-13101" >139</a>, <a -href="glossaries-manual.html#dx1-14011" >140</a>, <a -href="glossaries-manual.html#dx1-14018" >141</a> <br /></span> +href="glossaries-user.html#dx1-10007" >157</a>, <a +href="glossaries-user.html#dx1-10010" >158</a>, <a +href="glossaries-user.html#dx1-11009" >159</a>, <a +href="glossaries-user.html#dx1-16031" >160</a>, <a +href="glossaries-user.html#dx1-18004" >161</a>, <a +href="glossaries-user.html#dx1-18016" >162</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.log</span>  <a -href="glossaries-manual.html#dx1-11042" >142</a> <br /></span> +href="glossaries-user.html#dx1-57079" >163</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.tex</span>  <a -href="glossaries-manual.html#dx1-8007" >143</a>, <a -href="glossaries-manual.html#dx1-9004" >144</a> <br /></span> +href="glossaries-user.html#dx1-9012" >164</a>, <a +href="glossaries-user.html#dx1-10006" >165</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">.xdy</span>  <a -href="glossaries-manual.html#dx1-8009" >145</a>, <a -href="glossaries-manual.html#dx1-8010" >146</a>, <a -href="glossaries-manual.html#dx1-10008" >147</a>, <a -href="glossaries-manual.html#dx1-13109" >148</a>, <a -href="glossaries-manual.html#dx1-14013" >149</a>, <a -href="glossaries-manual.html#dx1-14021" >150</a>, <a -href="glossaries-manual.html#dx1-29005" >151</a> <br /></span> +href="glossaries-user.html#dx1-9015" >166</a>, <a +href="glossaries-user.html#dx1-9016" >167</a>, <a +href="glossaries-user.html#dx1-11012" >168</a>, <a +href="glossaries-user.html#dx1-16045" >169</a>, <a +href="glossaries-user.html#dx1-18007" >170</a>, <a +href="glossaries-user.html#dx1-18013" >171</a>, <a +href="glossaries-user.html#dx1-18020" >172</a>, <a +href="glossaries-user.html#dx1-34008" >173</a> <br /></span> <span class="index-item">first use  <a -href="glossaries-manual.html#dx1-11016" ><span class="underline">152</span></a>, <a -href="glossaries-manual.html#dx1-11018" ><span class="underline">153</span></a>, <a -href="glossaries-manual.html#dx1-13138" ><span class="underline">154</span></a>, <a -href="glossaries-manual.html#dx1-22005" ><span class="underline">155</span></a>, <a -href="glossaries-manual.html#dx1-22019" ><span class="underline">156</span></a>, <a -href="glossaries-manual.html#dx1-22028" ><span class="underline">157</span></a>, <a -href="glossaries-manual.html#dx1-23012" ><span class="underline">158</span></a>, <a -href="glossaries-manual.html#dx1-34001" ><span class="underline">159</span></a>, <a -href="glossaries-manual.html#dx1-34010" ><span class="underline">160</span></a>, <a -href="glossaries-manual.html#dx1-34029" ><span class="underline">161</span></a>, <a -href="glossaries-manual.html#dx1-34058" ><span class="underline">162</span></a>, <a -href="glossaries-manual.html#dx1-34068" ><span class="underline">163</span></a>, <a -href="glossaries-manual.html#dx1-34079" ><span class="underline">164</span></a>, <a -href="glossaries-manual.html#dx1-34091" ><span class="underline">165</span></a>, <a -href="glossaries-manual.html#dx1-34104" ><span class="underline">166</span></a>, <a -href="glossaries-manual.html#dx1-34106" ><span class="underline">167</span></a>, <a -href="glossaries-manual.html#dx1-34107" ><span class="underline">168</span></a>, <a -href="glossaries-manual.html#dx1-34108" ><span class="underline">169</span></a>, <a -href="glossaries-manual.html#dx1-34112" ><span class="underline">170</span></a>, <a -href="glossaries-manual.html#dx1-34118" ><span class="underline">171</span></a>, <a -href="glossaries-manual.html#dx1-34132" ><span class="underline">172</span></a>, <a -href="glossaries-manual.html#dx1-37004" ><span class="underline">173</span></a> <br /></span> +href="glossaries-user.html#dx1-2007" >174</a> <br /></span> <span class="index-subitem">    flag  <a -href="glossaries-manual.html#dx1-21010" ><span class="underline">174</span></a>, <a -href="glossaries-manual.html#dx1-21015" ><span class="underline">175</span></a>, <a -href="glossaries-manual.html#dx1-21017" ><span class="underline">176</span></a>, <a -href="glossaries-manual.html#dx1-21054" ><span class="underline">177</span></a>, <a -href="glossaries-manual.html#dx1-21057" ><span class="underline">178</span></a>, <a -href="glossaries-manual.html#dx1-21066" ><span class="underline">179</span></a>, <a -href="glossaries-manual.html#dx1-21072" ><span class="underline">180</span></a>, <a -href="glossaries-manual.html#dx1-21078" ><span class="underline">181</span></a>, <a -href="glossaries-manual.html#dx1-21086" ><span class="underline">182</span></a>, <a -href="glossaries-manual.html#dx1-26001" ><span class="underline">183</span></a> <br /></span> +href="glossaries-user.html#dx1-2015" >175</a>, <a +href="glossaries-user.html#dx1-26073" >176</a> <br /></span> <span class="index-subitem">    text  <a -href="glossaries-manual.html#dx1-14055" ><span class="underline">184</span></a>, <a -href="glossaries-manual.html#dx1-14063" ><span class="underline">185</span></a>, <a -href="glossaries-manual.html#dx1-26014" ><span class="underline">186</span></a>, <a -href="glossaries-manual.html#dx1-26018" ><span class="underline">187</span></a> <br /></span> +href="glossaries-user.html#dx1-2017" >177</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\firstacronymfont</span></span></span>  <a -href="glossaries-manual.html#dx1-34028" ><span -class="ecti-1000">188</span></a> <br /></span> +href="glossaries-user.html#dx1-39052" ><span +class="ecti-1000">178</span></a>, <a +href="glossaries-user.html#dx1-40016" >179</a>, <a +href="glossaries-user.html#dx1-40026" >180</a>, <a +href="glossaries-user.html#dx1-40033" >181</a>, <a +href="glossaries-user.html#dx1-57036" >182</a> <br /></span> <span class="index-item"><span class="ecss-1000">flowfram </span>package  <a -href="glossaries-manual.html#dx1-42011" >189</a> <br /></span> +href="glossaries-user.html#dx1-49011" >183</a> <br /></span> <span class="index-item"><span class="ecss-1000">fmtcount </span>package  <a -href="glossaries-manual.html#dx1-31011" >190</a> <br /></span> +href="glossaries-user.html#dx1-36032" >184</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">G</span> <span class="index-item"><span class="ecss-1000">german </span>package  <a -href="glossaries-manual.html#dx1-5008" >191</a> <br /></span> +href="glossaries-user.html#dx1-6008" >185</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossaries </span>package  <a +href="glossaries-user.html#dx1-2028" >186</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossaries-accsupp </span>package  <a -href="glossaries-manual.html#dx1-3055" >192</a>, <a -href="glossaries-manual.html#dx1-49001" >193</a> <br /></span> +href="glossaries-user.html#dx1-4088" >187</a>, <a +href="glossaries-user.html#dx1-56001" >188</a>, <a +href="glossaries-user.html#dx1-56033" >189</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossaries-babel </span>package  <a -href="glossaries-manual.html#dx1-5030" >194</a>, <a -href="glossaries-manual.html#dx1-13129" >195</a>, <a -href="glossaries-manual.html#dx1-13135" >196</a> <br /></span> +href="glossaries-user.html#dx1-6031" >190</a>, <a +href="glossaries-user.html#dx1-13054" >191</a>, <a +href="glossaries-user.html#dx1-13060" >192</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossaries-polyglossia </span>package  <a -href="glossaries-manual.html#dx1-5033" >197</a>, <a -href="glossaries-manual.html#dx1-13131" >198</a>, <a -href="glossaries-manual.html#dx1-13136" >199</a> <br /></span> +href="glossaries-user.html#dx1-6034" >193</a>, <a +href="glossaries-user.html#dx1-13056" >194</a>, <a +href="glossaries-user.html#dx1-13061" >195</a> <br /></span> +<span class="index-item">glossary counters:<br /></span> +<span class="index-subitem">    <span +class="ectt-1000">glossaryentry</span>  <a +href="glossaries-user.html#dx1-15004" ><span +class="ecti-1000">196</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">glossarysubentry</span>  <a +href="glossaries-user.html#dx1-15022" ><span +class="ecti-1000">197</span></a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary </span>package  <a -href="glossaries-manual.html#dx1-2005" >200</a>, <a -href="glossaries-manual.html#dx1-11027" >201</a>, <a -href="glossaries-manual.html#dx1-36001" >202</a>, <a -href="glossaries-manual.html#dx1-36002" >203</a>, <a -href="glossaries-manual.html#dx1-36005" >204</a> <br /></span> +href="glossaries-user.html#dx1-2" >198</a>, <a +href="glossaries-user.html#dx1-3005" >199</a>, <a +href="glossaries-user.html#dx1-43001" >200</a>, <a +href="glossaries-user.html#dx1-43002" >201</a>, <a +href="glossaries-user.html#dx1-43005" >202</a>, <a +href="glossaries-user.html#dx1-57052" >203</a> <br /></span> <span class="index-item">glossary styles:<br /></span> <span class="index-subitem">    <span class="ectt-1000">altlist</span>  <a -href="glossaries-manual.html#dx1-39016" ><span class="underline">205</span></a>, <a -href="glossaries-manual.html#dx1-39021" ><span class="underline">206</span></a> <br /></span> +href="glossaries-user.html#dx1-46020" >204</a>, <a +href="glossaries-user.html#dx1-46025" >205</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlistgroup</span>  <a -href="glossaries-manual.html#dx1-39020" ><span class="underline">207</span></a>, <a -href="glossaries-manual.html#dx1-39023" ><span class="underline">208</span></a> <br /></span> +href="glossaries-user.html#dx1-46024" >206</a>, <a +href="glossaries-user.html#dx1-46027" >207</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlisthypergroup</span>  <a -href="glossaries-manual.html#dx1-39022" ><span class="underline">209</span></a> <br /></span> +href="glossaries-user.html#dx1-46026" >208</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlong4col</span>  <a -href="glossaries-manual.html#dx1-38019" ><span class="underline">210</span></a>, <a -href="glossaries-manual.html#dx1-40031" ><span class="underline">211</span></a>, <a -href="glossaries-manual.html#dx1-40038" ><span class="underline">212</span></a> <br /></span> +href="glossaries-user.html#dx1-45023" >209</a>, <a +href="glossaries-user.html#dx1-47033" >210</a>, <a +href="glossaries-user.html#dx1-47040" >211</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlong4colborder</span>  <a -href="glossaries-manual.html#dx1-40042" ><span class="underline">213</span></a> <br /></span> +href="glossaries-user.html#dx1-47044" >212</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlong4colheader</span>  <a -href="glossaries-manual.html#dx1-40044" ><span class="underline">214</span></a> <br /></span> +href="glossaries-user.html#dx1-47046" >213</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlong4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-40046" ><span class="underline">215</span></a> <br /></span> +href="glossaries-user.html#dx1-47048" >214</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlongragged4col</span>  <a -href="glossaries-manual.html#dx1-41029" ><span class="underline">216</span></a>, <a -href="glossaries-manual.html#dx1-41034" ><span class="underline">217</span></a>, <a -href="glossaries-manual.html#dx1-41036" ><span class="underline">218</span></a> <br /></span> +href="glossaries-user.html#dx1-48031" >215</a>, <a +href="glossaries-user.html#dx1-48036" >216</a>, <a +href="glossaries-user.html#dx1-48038" >217</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlongragged4colborder</span>  <a -href="glossaries-manual.html#dx1-41033" ><span class="underline">219</span></a> <br /></span> +href="glossaries-user.html#dx1-48035" >218</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlongragged4colheader</span>  <a -href="glossaries-manual.html#dx1-41035" ><span class="underline">220</span></a>, <a -href="glossaries-manual.html#dx1-41038" ><span class="underline">221</span></a> <br /></span> +href="glossaries-user.html#dx1-48037" >219</a>, <a +href="glossaries-user.html#dx1-48040" >220</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altlongragged4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-41037" ><span class="underline">222</span></a> <br /></span> +href="glossaries-user.html#dx1-48039" >221</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuper4col</span>  <a -href="glossaries-manual.html#dx1-38020" ><span class="underline">223</span></a>, <a -href="glossaries-manual.html#dx1-42037" ><span class="underline">224</span></a>, <a -href="glossaries-manual.html#dx1-42044" ><span class="underline">225</span></a> <br /></span> +href="glossaries-user.html#dx1-45024" >222</a>, <a +href="glossaries-user.html#dx1-49039" >223</a>, <a +href="glossaries-user.html#dx1-49046" >224</a> <br /></span> + + + <span class="index-subitem">    <span class="ectt-1000">altsuper4colborder</span>  <a -href="glossaries-manual.html#dx1-42048" ><span class="underline">226</span></a> <br /></span> +href="glossaries-user.html#dx1-49050" >225</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuper4colheader</span>  <a -href="glossaries-manual.html#dx1-42050" ><span class="underline">227</span></a> <br /></span> +href="glossaries-user.html#dx1-49052" >226</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuper4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-42052" ><span class="underline">228</span></a> <br /></span> +href="glossaries-user.html#dx1-49054" >227</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuperragged4col</span>  <a -href="glossaries-manual.html#dx1-43032" ><span class="underline">229</span></a>, <a -href="glossaries-manual.html#dx1-43035" ><span class="underline">230</span></a>, <a -href="glossaries-manual.html#dx1-43037" ><span class="underline">231</span></a> <br /></span> +href="glossaries-user.html#dx1-50034" >228</a>, <a +href="glossaries-user.html#dx1-50037" >229</a>, <a +href="glossaries-user.html#dx1-50039" >230</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuperragged4colborder</span>  <a -href="glossaries-manual.html#dx1-43034" ><span class="underline">232</span></a> <br /></span> +href="glossaries-user.html#dx1-50036" >231</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuperragged4colheader</span>  <a -href="glossaries-manual.html#dx1-43036" ><span class="underline">233</span></a>, <a -href="glossaries-manual.html#dx1-43039" ><span class="underline">234</span></a> <br /></span> +href="glossaries-user.html#dx1-50038" >232</a>, <a +href="glossaries-user.html#dx1-50041" >233</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">altsuperragged4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-43038" ><span class="underline">235</span></a> <br /></span> +href="glossaries-user.html#dx1-50040" >234</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">alttree</span>  <a -href="glossaries-manual.html#dx1-44016" ><span class="underline">236</span></a>, <a -href="glossaries-manual.html#dx1-44029" ><span class="underline">237</span></a>, <a -href="glossaries-manual.html#dx1-44033" ><span class="underline">238</span></a> <br /></span> +href="glossaries-user.html#dx1-51018" >235</a>, <a +href="glossaries-user.html#dx1-51031" >236</a>, <a +href="glossaries-user.html#dx1-51035" >237</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">alttreegroup</span>  <a -href="glossaries-manual.html#dx1-44032" ><span class="underline">239</span></a>, <a -href="glossaries-manual.html#dx1-44035" ><span class="underline">240</span></a> <br /></span> +href="glossaries-user.html#dx1-51034" >238</a>, <a +href="glossaries-user.html#dx1-51037" >239</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">alttreehypergroup</span>  <a -href="glossaries-manual.html#dx1-44034" ><span class="underline">241</span></a> <br /></span> +href="glossaries-user.html#dx1-51036" >240</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">index</span>  <a -href="glossaries-manual.html#dx1-34070" ><span class="underline">242</span></a>, <a -href="glossaries-manual.html#dx1-34086" ><span class="underline">243</span></a>, <a -href="glossaries-manual.html#dx1-44004" ><span class="underline">244</span></a>, <a -href="glossaries-manual.html#dx1-44007" ><span class="underline">245</span></a>, <a -href="glossaries-manual.html#dx1-44012" ><span class="underline">246</span></a> <br /></span> +href="glossaries-user.html#dx1-51004" >241</a>, <a +href="glossaries-user.html#dx1-51007" >242</a>, <a +href="glossaries-user.html#dx1-51012" >243</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">indexgroup</span>  <a -href="glossaries-manual.html#dx1-44006" ><span class="underline">247</span></a>, <a -href="glossaries-manual.html#dx1-44009" ><span class="underline">248</span></a> <br /></span> +href="glossaries-user.html#dx1-51006" >244</a>, <a +href="glossaries-user.html#dx1-51009" >245</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">indexhypergroup</span>  <a -href="glossaries-manual.html#dx1-44008" ><span class="underline">249</span></a> <br /></span> +href="glossaries-user.html#dx1-51008" >246</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">list</span>  <a -href="glossaries-manual.html#dx1-13050" ><span class="underline">250</span></a>, <a -href="glossaries-manual.html#dx1-39006" ><span class="underline">251</span></a>, <a -href="glossaries-manual.html#dx1-39011" ><span class="underline">252</span></a>, <a -href="glossaries-manual.html#dx1-39017" ><span class="underline">253</span></a>, <a -href="glossaries-manual.html#dx1-39018" ><span class="underline">254</span></a>, <a -href="glossaries-manual.html#dx1-39019" ><span class="underline">255</span></a>, <a -href="glossaries-manual.html#dx1-45006" ><span class="underline">256</span></a>, <a -href="glossaries-manual.html#dx1-45014" ><span class="underline">257</span></a>, <a -href="glossaries-manual.html#dx1-45027" ><span class="underline">258</span></a>, <a -href="glossaries-manual.html#dx1-45031" ><span class="underline">259</span></a>, <a -href="glossaries-manual.html#dx1-47002" ><span class="underline">260</span></a> <br /></span> +href="glossaries-user.html#dx1-15039" >247</a>, <a +href="glossaries-user.html#dx1-46006" >248</a>, <a +href="glossaries-user.html#dx1-46014" >249</a>, <a +href="glossaries-user.html#dx1-46021" >250</a>, <a +href="glossaries-user.html#dx1-46022" >251</a>, <a +href="glossaries-user.html#dx1-46023" >252</a>, <a +href="glossaries-user.html#dx1-52008" >253</a>, <a +href="glossaries-user.html#dx1-52017" >254</a>, <a +href="glossaries-user.html#dx1-52033" >255</a>, <a +href="glossaries-user.html#dx1-52045" >256</a>, <a +href="glossaries-user.html#dx1-54003" >257</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">listdotted</span>  <a -href="glossaries-manual.html#dx1-38030" ><span class="underline">261</span></a>, <a -href="glossaries-manual.html#dx1-39030" ><span class="underline">262</span></a>, <a -href="glossaries-manual.html#dx1-39031" ><span class="underline">263</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-45033" >258</a>, <a +href="glossaries-user.html#dx1-46035" >259</a>, <a +href="glossaries-user.html#dx1-46036" >260</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">listgroup</span>  <a -href="glossaries-manual.html#dx1-39010" ><span class="underline">264</span></a>, <a -href="glossaries-manual.html#dx1-39013" ><span class="underline">265</span></a> <br /></span> +href="glossaries-user.html#dx1-46013" >261</a>, <a +href="glossaries-user.html#dx1-46016" >262</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">listhypergroup</span>  <a -href="glossaries-manual.html#dx1-39012" ><span class="underline">266</span></a>, <a -href="glossaries-manual.html#dx1-39024" ><span class="underline">267</span></a>, <a -href="glossaries-manual.html#dx1-44010" ><span class="underline">268</span></a>, <a -href="glossaries-manual.html#dx1-44021" ><span class="underline">269</span></a>, <a -href="glossaries-manual.html#dx1-44028" ><span class="underline">270</span></a>, <a -href="glossaries-manual.html#dx1-44036" ><span class="underline">271</span></a>, <a -href="glossaries-manual.html#dx1-45025" ><span class="underline">272</span></a> <br /></span> +href="glossaries-user.html#dx1-46015" >263</a>, <a +href="glossaries-user.html#dx1-46028" >264</a>, <a +href="glossaries-user.html#dx1-51010" >265</a>, <a +href="glossaries-user.html#dx1-51023" >266</a>, <a +href="glossaries-user.html#dx1-51030" >267</a>, <a +href="glossaries-user.html#dx1-51038" >268</a>, <a +href="glossaries-user.html#dx1-52030" >269</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long</span>  <a -href="glossaries-manual.html#dx1-38026" ><span class="underline">273</span></a>, <a -href="glossaries-manual.html#dx1-40006" ><span class="underline">274</span></a>, <a -href="glossaries-manual.html#dx1-40013" ><span class="underline">275</span></a>, <a -href="glossaries-manual.html#dx1-40015" ><span class="underline">276</span></a>, <a -href="glossaries-manual.html#dx1-40019" ><span class="underline">277</span></a> <br /></span> +href="glossaries-user.html#dx1-45030" >270</a>, <a +href="glossaries-user.html#dx1-47006" >271</a>, <a +href="glossaries-user.html#dx1-47014" >272</a>, <a +href="glossaries-user.html#dx1-47016" >273</a>, <a +href="glossaries-user.html#dx1-47020" >274</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long3col</span>  <a -href="glossaries-manual.html#dx1-38002" ><span class="underline">278</span></a>, <a -href="glossaries-manual.html#dx1-40018" ><span class="underline">279</span></a>, <a -href="glossaries-manual.html#dx1-40024" ><span class="underline">280</span></a>, <a -href="glossaries-manual.html#dx1-40026" ><span class="underline">281</span></a>, <a -href="glossaries-manual.html#dx1-40030" ><span class="underline">282</span></a> <br /></span> +href="glossaries-user.html#dx1-45005" >275</a>, <a +href="glossaries-user.html#dx1-47019" >276</a>, <a +href="glossaries-user.html#dx1-47026" >277</a>, <a +href="glossaries-user.html#dx1-47028" >278</a>, <a +href="glossaries-user.html#dx1-47032" >279</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long3colborder</span>  <a -href="glossaries-manual.html#dx1-38004" ><span class="underline">283</span></a>, <a -href="glossaries-manual.html#dx1-40023" ><span class="underline">284</span></a> <br /></span> +href="glossaries-user.html#dx1-45007" >280</a>, <a +href="glossaries-user.html#dx1-47025" >281</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long3colheader</span>  <a -href="glossaries-manual.html#dx1-38003" ><span class="underline">285</span></a>, <a -href="glossaries-manual.html#dx1-40025" ><span class="underline">286</span></a>, <a -href="glossaries-manual.html#dx1-40028" ><span class="underline">287</span></a> <br /></span> +href="glossaries-user.html#dx1-45006" >282</a>, <a +href="glossaries-user.html#dx1-47027" >283</a>, <a +href="glossaries-user.html#dx1-47030" >284</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long3colheaderborder</span>  <a -href="glossaries-manual.html#dx1-38005" ><span class="underline">288</span></a>, <a -href="glossaries-manual.html#dx1-40027" ><span class="underline">289</span></a> <br /></span> +href="glossaries-user.html#dx1-45008" >285</a>, <a +href="glossaries-user.html#dx1-47029" >286</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long4col</span>  <a -href="glossaries-manual.html#dx1-38017" ><span class="underline">290</span></a>, <a -href="glossaries-manual.html#dx1-40029" ><span class="underline">291</span></a>, <a -href="glossaries-manual.html#dx1-40033" ><span class="underline">292</span></a>, <a -href="glossaries-manual.html#dx1-40035" ><span class="underline">293</span></a>, <a -href="glossaries-manual.html#dx1-40039" ><span class="underline">294</span></a> <br /></span> +href="glossaries-user.html#dx1-41011" >287</a>, <a +href="glossaries-user.html#dx1-45021" >288</a>, <a +href="glossaries-user.html#dx1-47031" >289</a>, <a +href="glossaries-user.html#dx1-47035" >290</a>, <a +href="glossaries-user.html#dx1-47037" >291</a>, <a +href="glossaries-user.html#dx1-47041" >292</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long4colborder</span>  <a -href="glossaries-manual.html#dx1-40032" ><span class="underline">295</span></a>, <a -href="glossaries-manual.html#dx1-40043" ><span class="underline">296</span></a> <br /></span> +href="glossaries-user.html#dx1-47034" >293</a>, <a +href="glossaries-user.html#dx1-47045" >294</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long4colheader</span>  <a -href="glossaries-manual.html#dx1-40034" ><span class="underline">297</span></a>, <a -href="glossaries-manual.html#dx1-40037" ><span class="underline">298</span></a>, <a -href="glossaries-manual.html#dx1-40045" ><span class="underline">299</span></a> <br /></span> +href="glossaries-user.html#dx1-47036" >295</a>, <a +href="glossaries-user.html#dx1-47039" >296</a>, <a +href="glossaries-user.html#dx1-47047" >297</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">long4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-40036" ><span class="underline">300</span></a>, <a -href="glossaries-manual.html#dx1-40047" ><span class="underline">301</span></a> <br /></span> +href="glossaries-user.html#dx1-47038" >298</a>, <a +href="glossaries-user.html#dx1-47049" >299</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longborder</span>  <a -href="glossaries-manual.html#dx1-40012" ><span class="underline">302</span></a> <br /></span> +href="glossaries-user.html#dx1-47013" >300</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longheader</span>  <a -href="glossaries-manual.html#dx1-40014" ><span class="underline">303</span></a>, <a -href="glossaries-manual.html#dx1-40017" ><span class="underline">304</span></a>, <a -href="glossaries-manual.html#dx1-45015" ><span class="underline">305</span></a> <br /></span> +href="glossaries-user.html#dx1-47015" >301</a>, <a +href="glossaries-user.html#dx1-47018" >302</a>, <a +href="glossaries-user.html#dx1-52019" >303</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longheaderborder</span>  <a -href="glossaries-manual.html#dx1-40016" ><span class="underline">306</span></a> <br /></span> +href="glossaries-user.html#dx1-47017" >304</a>, <a +href="glossaries-user.html#dx1-33038" >305</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longragged</span>  <a -href="glossaries-manual.html#dx1-41009" ><span class="underline">307</span></a>, <a -href="glossaries-manual.html#dx1-41013" ><span class="underline">308</span></a>, <a -href="glossaries-manual.html#dx1-41015" ><span class="underline">309</span></a>, <a -href="glossaries-manual.html#dx1-41019" ><span class="underline">310</span></a> <br /></span> +href="glossaries-user.html#dx1-48009" >306</a>, <a +href="glossaries-user.html#dx1-48014" >307</a>, <a +href="glossaries-user.html#dx1-48016" >308</a>, <a +href="glossaries-user.html#dx1-48020" >309</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longragged3col</span>  <a -href="glossaries-manual.html#dx1-41018" ><span class="underline">311</span></a>, <a -href="glossaries-manual.html#dx1-41024" ><span class="underline">312</span></a>, <a -href="glossaries-manual.html#dx1-41026" ><span class="underline">313</span></a>, <a -href="glossaries-manual.html#dx1-41030" ><span class="underline">314</span></a> <br /></span> +href="glossaries-user.html#dx1-48019" >310</a>, <a +href="glossaries-user.html#dx1-48026" >311</a>, <a +href="glossaries-user.html#dx1-48028" >312</a>, <a +href="glossaries-user.html#dx1-48032" >313</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longragged3colborder</span>  <a -href="glossaries-manual.html#dx1-41023" ><span class="underline">315</span></a> <br /></span> +href="glossaries-user.html#dx1-48025" >314</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longragged3colheader</span>  <a -href="glossaries-manual.html#dx1-41025" ><span class="underline">316</span></a>, <a -href="glossaries-manual.html#dx1-41028" ><span class="underline">317</span></a> <br /></span> +href="glossaries-user.html#dx1-48027" >315</a>, <a +href="glossaries-user.html#dx1-48030" >316</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longragged3colheaderborder</span>  <a -href="glossaries-manual.html#dx1-41027" ><span class="underline">318</span></a> <br /></span> +href="glossaries-user.html#dx1-48029" >317</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longraggedborder</span>  <a -href="glossaries-manual.html#dx1-41012" ><span class="underline">319</span></a> <br /></span> +href="glossaries-user.html#dx1-48013" >318</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longraggedheader</span>  <a -href="glossaries-manual.html#dx1-41014" ><span class="underline">320</span></a>, <a -href="glossaries-manual.html#dx1-41017" ><span class="underline">321</span></a> <br /></span> +href="glossaries-user.html#dx1-48015" >319</a>, <a +href="glossaries-user.html#dx1-48018" >320</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">longraggedheaderborder</span>  <a -href="glossaries-manual.html#dx1-41016" ><span class="underline">322</span></a> <br /></span> +href="glossaries-user.html#dx1-48017" >321</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super</span>  <a -href="glossaries-manual.html#dx1-42012" ><span class="underline">323</span></a>, <a -href="glossaries-manual.html#dx1-42019" ><span class="underline">324</span></a>, <a -href="glossaries-manual.html#dx1-42021" ><span class="underline">325</span></a>, <a -href="glossaries-manual.html#dx1-42025" ><span class="underline">326</span></a> <br /></span> +href="glossaries-user.html#dx1-49012" >322</a>, <a +href="glossaries-user.html#dx1-49020" >323</a>, <a +href="glossaries-user.html#dx1-49022" >324</a>, <a +href="glossaries-user.html#dx1-49026" >325</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super3col</span>  <a -href="glossaries-manual.html#dx1-42024" ><span class="underline">327</span></a>, <a -href="glossaries-manual.html#dx1-42030" ><span class="underline">328</span></a>, <a -href="glossaries-manual.html#dx1-42032" ><span class="underline">329</span></a>, <a -href="glossaries-manual.html#dx1-42036" ><span class="underline">330</span></a> <br /></span> +href="glossaries-user.html#dx1-49025" >326</a>, <a +href="glossaries-user.html#dx1-49032" >327</a>, <a +href="glossaries-user.html#dx1-49034" >328</a>, <a +href="glossaries-user.html#dx1-49038" >329</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super3colborder</span>  <a -href="glossaries-manual.html#dx1-42029" ><span class="underline">331</span></a> <br /></span> +href="glossaries-user.html#dx1-49031" >330</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super3colheader</span>  <a -href="glossaries-manual.html#dx1-42031" ><span class="underline">332</span></a>, <a -href="glossaries-manual.html#dx1-42034" ><span class="underline">333</span></a> <br /></span> +href="glossaries-user.html#dx1-49033" >331</a>, <a +href="glossaries-user.html#dx1-49036" >332</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super3colheaderborder</span>  <a -href="glossaries-manual.html#dx1-42033" ><span class="underline">334</span></a> <br /></span> +href="glossaries-user.html#dx1-49035" >333</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super4col</span>  <a -href="glossaries-manual.html#dx1-38018" ><span class="underline">335</span></a>, <a -href="glossaries-manual.html#dx1-42035" ><span class="underline">336</span></a>, <a -href="glossaries-manual.html#dx1-42039" ><span class="underline">337</span></a>, <a -href="glossaries-manual.html#dx1-42041" ><span class="underline">338</span></a>, <a -href="glossaries-manual.html#dx1-42045" ><span class="underline">339</span></a> <br /></span> +href="glossaries-user.html#dx1-45022" >334</a>, <a +href="glossaries-user.html#dx1-49037" >335</a>, <a +href="glossaries-user.html#dx1-49041" >336</a>, <a +href="glossaries-user.html#dx1-49043" >337</a>, <a +href="glossaries-user.html#dx1-49047" >338</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super4colborder</span>  <a -href="glossaries-manual.html#dx1-42038" ><span class="underline">340</span></a>, <a -href="glossaries-manual.html#dx1-42049" ><span class="underline">341</span></a> <br /></span> +href="glossaries-user.html#dx1-49040" >339</a>, <a +href="glossaries-user.html#dx1-49051" >340</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super4colheader</span>  <a -href="glossaries-manual.html#dx1-42040" ><span class="underline">342</span></a>, <a -href="glossaries-manual.html#dx1-42043" ><span class="underline">343</span></a>, <a -href="glossaries-manual.html#dx1-42051" ><span class="underline">344</span></a> <br /></span> +href="glossaries-user.html#dx1-49042" >341</a>, <a +href="glossaries-user.html#dx1-49045" >342</a>, <a +href="glossaries-user.html#dx1-49053" >343</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">super4colheaderborder</span>  <a -href="glossaries-manual.html#dx1-42042" ><span class="underline">345</span></a>, <a -href="glossaries-manual.html#dx1-42053" ><span class="underline">346</span></a> <br /></span> +href="glossaries-user.html#dx1-49044" >344</a>, <a +href="glossaries-user.html#dx1-49055" >345</a> <br /></span> + + + <span class="index-subitem">    <span class="ectt-1000">superborder</span>  <a -href="glossaries-manual.html#dx1-42018" ><span class="underline">347</span></a> <br /></span> +href="glossaries-user.html#dx1-49019" >346</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superheader</span>  <a -href="glossaries-manual.html#dx1-42020" ><span class="underline">348</span></a>, <a -href="glossaries-manual.html#dx1-42023" ><span class="underline">349</span></a> <br /></span> +href="glossaries-user.html#dx1-49021" >347</a>, <a +href="glossaries-user.html#dx1-49024" >348</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superheaderborder</span>  <a -href="glossaries-manual.html#dx1-42022" ><span class="underline">350</span></a> <br /></span> +href="glossaries-user.html#dx1-33036" >349</a>, <a +href="glossaries-user.html#dx1-49023" >350</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superragged</span>  <a -href="glossaries-manual.html#dx1-43009" ><span class="underline">351</span></a>, <a -href="glossaries-manual.html#dx1-43016" ><span class="underline">352</span></a>, <a -href="glossaries-manual.html#dx1-43018" ><span class="underline">353</span></a>, <a -href="glossaries-manual.html#dx1-43022" ><span class="underline">354</span></a> <br /></span> +href="glossaries-user.html#dx1-50009" >351</a>, <a +href="glossaries-user.html#dx1-50017" >352</a>, <a +href="glossaries-user.html#dx1-50019" >353</a>, <a +href="glossaries-user.html#dx1-50023" >354</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superragged3col</span>  <a -href="glossaries-manual.html#dx1-43021" ><span class="underline">355</span></a>, <a -href="glossaries-manual.html#dx1-43027" ><span class="underline">356</span></a>, <a -href="glossaries-manual.html#dx1-43029" ><span class="underline">357</span></a>, <a -href="glossaries-manual.html#dx1-43033" ><span class="underline">358</span></a> <br /></span> +href="glossaries-user.html#dx1-50022" >355</a>, <a +href="glossaries-user.html#dx1-50029" >356</a>, <a +href="glossaries-user.html#dx1-50031" >357</a>, <a +href="glossaries-user.html#dx1-50035" >358</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superragged3colborder</span>  <a -href="glossaries-manual.html#dx1-43026" ><span class="underline">359</span></a> <br /></span> +href="glossaries-user.html#dx1-50028" >359</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superragged3colheader</span>  <a -href="glossaries-manual.html#dx1-43028" ><span class="underline">360</span></a>, <a -href="glossaries-manual.html#dx1-43031" ><span class="underline">361</span></a> <br /></span> +href="glossaries-user.html#dx1-50030" >360</a>, <a +href="glossaries-user.html#dx1-50033" >361</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superragged3colheaderborder</span>  <a -href="glossaries-manual.html#dx1-43030" ><span class="underline">362</span></a> <br /></span> +href="glossaries-user.html#dx1-50032" >362</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superraggedborder</span>  <a -href="glossaries-manual.html#dx1-43015" ><span class="underline">363</span></a> <br /></span> +href="glossaries-user.html#dx1-50016" >363</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superraggedheader</span>  <a -href="glossaries-manual.html#dx1-43017" ><span class="underline">364</span></a>, <a -href="glossaries-manual.html#dx1-43020" ><span class="underline">365</span></a> <br /></span> +href="glossaries-user.html#dx1-50018" >364</a>, <a +href="glossaries-user.html#dx1-50021" >365</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">superraggedheaderborder</span>  <a -href="glossaries-manual.html#dx1-43019" ><span class="underline">366</span></a> <br /></span> +href="glossaries-user.html#dx1-50020" >366</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">tree</span>  <a -href="glossaries-manual.html#dx1-44011" ><span class="underline">367</span></a>, <a -href="glossaries-manual.html#dx1-44018" ><span class="underline">368</span></a>, <a -href="glossaries-manual.html#dx1-44023" ><span class="underline">369</span></a>, <a -href="glossaries-manual.html#dx1-44030" ><span class="underline">370</span></a> <br /></span> +href="glossaries-user.html#dx1-51011" >367</a>, <a +href="glossaries-user.html#dx1-51020" >368</a>, <a +href="glossaries-user.html#dx1-51025" >369</a>, <a +href="glossaries-user.html#dx1-51032" >370</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">treegroup</span>  <a -href="glossaries-manual.html#dx1-44017" ><span class="underline">371</span></a>, <a -href="glossaries-manual.html#dx1-44020" ><span class="underline">372</span></a> <br /></span> +href="glossaries-user.html#dx1-51019" >371</a>, <a +href="glossaries-user.html#dx1-51022" >372</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">treehypergroup</span>  <a -href="glossaries-manual.html#dx1-44019" ><span class="underline">373</span></a> <br /></span> +href="glossaries-user.html#dx1-51021" >373</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">treenoname</span>  <a -href="glossaries-manual.html#dx1-44022" ><span class="underline">374</span></a>, <a -href="glossaries-manual.html#dx1-44025" ><span class="underline">375</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-51024" >374</a>, <a +href="glossaries-user.html#dx1-51027" >375</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">treenonamegroup</span>  <a -href="glossaries-manual.html#dx1-44024" ><span class="underline">376</span></a>, <a -href="glossaries-manual.html#dx1-44027" ><span class="underline">377</span></a> <br /></span> +href="glossaries-user.html#dx1-51026" >376</a>, <a +href="glossaries-user.html#dx1-51029" >377</a> <br /></span> <span class="index-subitem">    <span class="ectt-1000">treenonamehypergroup</span>  <a -href="glossaries-manual.html#dx1-44026" ><span class="underline">378</span></a> <br /></span> -<span class="index-item"><span -class="ecss-1000">glossary-hypernav </span>package  <a -href="glossaries-manual.html#dx1-45024" >379</a> <br /></span> +href="glossaries-user.html#dx1-51028" >378</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-list </span>package  <a -href="glossaries-manual.html#dx1-13049" >380</a>, <a -href="glossaries-manual.html#dx1-28002" >381</a>, <a -href="glossaries-manual.html#dx1-39001" >382</a> <br /></span> +href="glossaries-user.html#dx1-15027" >379</a>, <a +href="glossaries-user.html#dx1-15038" >380</a>, <a +href="glossaries-user.html#dx1-33042" >381</a>, <a +href="glossaries-user.html#dx1-46001" >382</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-long </span>package  <a -href="glossaries-manual.html#dx1-13043" >383</a>, <a -href="glossaries-manual.html#dx1-28003" >384</a>, <a -href="glossaries-manual.html#dx1-40001" >385</a>, <a -href="glossaries-manual.html#dx1-41002" >386</a> <br /></span> +href="glossaries-user.html#dx1-15028" >383</a>, <a +href="glossaries-user.html#dx1-15032" >384</a>, <a +href="glossaries-user.html#dx1-33043" >385</a>, <a +href="glossaries-user.html#dx1-47001" >386</a>, <a +href="glossaries-user.html#dx1-48002" >387</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-longragged </span>package  <a -href="glossaries-manual.html#dx1-41001" >387</a>, <a -href="glossaries-manual.html#dx1-41005" >388</a>, <a -href="glossaries-manual.html#dx1-41007" >389</a> <br /></span> +href="glossaries-user.html#dx1-48001" >388</a>, <a +href="glossaries-user.html#dx1-48005" >389</a>, <a +href="glossaries-user.html#dx1-48007" >390</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-super </span>package  <a -href="glossaries-manual.html#dx1-13046" >390</a>, <a -href="glossaries-manual.html#dx1-28004" >391</a>, <a -href="glossaries-manual.html#dx1-42001" >392</a>, <a -href="glossaries-manual.html#dx1-43002" >393</a> <br /></span> +href="glossaries-user.html#dx1-15029" >391</a>, <a +href="glossaries-user.html#dx1-15035" >392</a>, <a +href="glossaries-user.html#dx1-33044" >393</a>, <a +href="glossaries-user.html#dx1-49001" >394</a>, <a +href="glossaries-user.html#dx1-50002" >395</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-superragged </span>package  <a -href="glossaries-manual.html#dx1-43001" >394</a>, <a -href="glossaries-manual.html#dx1-43005" >395</a>, <a -href="glossaries-manual.html#dx1-43007" >396</a> <br /></span> +href="glossaries-user.html#dx1-50001" >396</a>, <a +href="glossaries-user.html#dx1-50005" >397</a>, <a +href="glossaries-user.html#dx1-50007" >398</a> <br /></span> <span class="index-item"><span class="ecss-1000">glossary-tree </span>package  <a -href="glossaries-manual.html#dx1-13053" >397</a>, <a -href="glossaries-manual.html#dx1-28005" >398</a>, <a -href="glossaries-manual.html#dx1-44001" >399</a> <br /></span> +href="glossaries-user.html#dx1-15030" >399</a>, <a +href="glossaries-user.html#dx1-15042" >400</a>, <a +href="glossaries-user.html#dx1-33045" >401</a>, <a +href="glossaries-user.html#dx1-51001" >402</a> <br /></span> +<span class="index-item"><span +class="ectt-1000">glossaryentry </span>(counter)  <a +href="glossaries-user.html#dx1-15003" ><span +class="ecti-1000">403</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossaryentry </span>counter  <a +href="glossaries-user.html#dx1-15014" >404</a>, <a +href="glossaries-user.html#dx1-15015" >405</a>, <a +href="glossaries-user.html#dx1-15018" >406</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossaryentryfield</span></span></span>  <a -href="glossaries-manual.html#dx1-45028" ><span -class="ecti-1000">400</span></a>, <a -href="glossaries-manual.html#dx1-45036" ><span class="underline">401</span></a>, <a -href="glossaries-manual.html#dx1-48001" ><span class="underline">402</span></a> <br /></span> +href="glossaries-user.html#dx1-52035" ><span +class="ecti-1000">407</span></a>, <a +href="glossaries-user.html#dx1-52057" >408</a>, <a +href="glossaries-user.html#dx1-55001" >409</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossaryentrynumbers</span></span></span>  <a -href="glossaries-manual.html#dx1-45032" ><span class="underline">403</span></a> <br /></span> +href="glossaries-user.html#dx1-52046" >410</a>, <a +href="glossaries-user.html#dx1-52051" >411</a>, <a +href="glossaries-user.html#dx1-52052" >412</a>, <a +href="glossaries-user.html#dx1-52054" >413</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossaryheader</span></span></span>  <a -href="glossaries-manual.html#dx1-39015" ><span class="underline">404</span></a>, <a -href="glossaries-manual.html#dx1-45013" ><span -class="ecti-1000">405</span></a>, <a -href="glossaries-manual.html#dx1-46007" ><span class="underline">406</span></a> <br /></span> +href="glossaries-user.html#dx1-46019" >414</a>, <a +href="glossaries-user.html#dx1-52015" ><span +class="ecti-1000">415</span></a>, <a +href="glossaries-user.html#dx1-52018" >416</a>, <a +href="glossaries-user.html#dx1-53007" >417</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossarymark</span></span></span>  <a -href="glossaries-manual.html#dx1-13027" ><span -class="ecti-1000">407</span></a>, <a -href="glossaries-manual.html#dx1-27022" ><span class="underline">408</span></a>, <a -href="glossaries-manual.html#dx1-27023" ><span class="underline">409</span></a> <br /></span> +href="glossaries-user.html#dx1-14013" ><span +class="ecti-1000">418</span></a>, <a +href="glossaries-user.html#dx1-33032" >419</a>, <a +href="glossaries-user.html#dx1-33033" >420</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossaryname</span></span></span>  <a -href="glossaries-manual.html#dx1-5014" ><span class="underline">410</span></a> <br /></span> +href="glossaries-user.html#dx1-6014" >421</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossarypostamble</span></span></span>  <a -href="glossaries-manual.html#dx1-27025" ><span -class="ecti-1000">411</span></a> <br /></span> +href="glossaries-user.html#dx1-33035" ><span +class="ecti-1000">422</span></a>, <a +href="glossaries-user.html#dx1-52007" >423</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossarypreamble</span></span></span>  <a -href="glossaries-manual.html#dx1-27024" ><span -class="ecti-1000">412</span></a> <br /></span> +href="glossaries-user.html#dx1-15017" >424</a>, <a +href="glossaries-user.html#dx1-33034" ><span +class="ecti-1000">425</span></a>, <a +href="glossaries-user.html#dx1-52006" >426</a>, <a +href="glossaries-user.html#dx1-52016" >427</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossarystyle</span></span></span>  <a -href="glossaries-manual.html#dx1-13056" ><span class="underline">413</span></a>, <a -href="glossaries-manual.html#dx1-27015" ><span class="underline">414</span></a>, <a -href="glossaries-manual.html#dx1-38009" ><span -class="ecti-1000">415</span></a>, <a -href="glossaries-manual.html#dx1-38025" ><span class="underline">416</span></a>, <a -href="glossaries-manual.html#dx1-38028" ><span class="underline">417</span></a> <br /></span> +href="glossaries-user.html#dx1-15045" >428</a>, <a +href="glossaries-user.html#dx1-33021" >429</a>, <a +href="glossaries-user.html#dx1-45013" ><span +class="ecti-1000">430</span></a>, <a +href="glossaries-user.html#dx1-45029" >431</a>, <a +href="glossaries-user.html#dx1-45032" >432</a>, <a +href="glossaries-user.html#dx1-54001" >433</a> <br /></span> +<span class="index-item"><span +class="ectt-1000">glossarysubentry </span>(counter)  <a +href="glossaries-user.html#dx1-15021" ><span +class="ecti-1000">434</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glossarysubentryfield</span></span></span>  <a -href="glossaries-manual.html#dx1-45035" ><span -class="ecti-1000">418</span></a>, <a -href="glossaries-manual.html#dx1-48002" ><span class="underline">419</span></a> <br /></span> +href="glossaries-user.html#dx1-52056" ><span +class="ecti-1000">435</span></a>, <a +href="glossaries-user.html#dx1-55002" >436</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLS</span></span></span>  <a -href="glossaries-manual.html#dx1-21059" ><span -class="ecti-1000">420</span></a> <br /></span> +href="glossaries-user.html#dx1-2010" >437</a>, <a +href="glossaries-user.html#dx1-19067" >438</a>, <a +href="glossaries-user.html#dx1-26078" ><span +class="ecti-1000">439</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Gls</span></span></span>  <a -href="glossaries-manual.html#dx1-4007" ><span class="underline">421</span></a>, <a -href="glossaries-manual.html#dx1-21058" ><span -class="ecti-1000">422</span></a>, <a -href="glossaries-manual.html#dx1-34184" ><span class="underline">423</span></a>, <a -href="glossaries-manual.html#dx1-36009" ><span class="underline">424</span></a>, <a -href="glossaries-manual.html#dx1-36011" ><span class="underline">425</span></a>, <a -href="glossaries-manual.html#dx1-36013" ><span class="underline">426</span></a> <br /></span> +href="glossaries-user.html#dx1-2009" >440</a>, <a +href="glossaries-user.html#dx1-5014" >441</a>, <a +href="glossaries-user.html#dx1-19066" >442</a>, <a +href="glossaries-user.html#dx1-19125" >443</a>, <a +href="glossaries-user.html#dx1-26077" ><span +class="ecti-1000">444</span></a>, <a +href="glossaries-user.html#dx1-27018" >445</a>, <a +href="glossaries-user.html#dx1-39109" >446</a>, <a +href="glossaries-user.html#dx1-43009" >447</a>, <a +href="glossaries-user.html#dx1-43011" >448</a>, <a +href="glossaries-user.html#dx1-43013" >449</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\gls</span></span></span>  <a -href="glossaries-manual.html#dx1-14051" ><span class="underline">427</span></a>, <a -href="glossaries-manual.html#dx1-14054" ><span class="underline">428</span></a>, <a -href="glossaries-manual.html#dx1-21011" ><span class="underline">429</span></a>, <a -href="glossaries-manual.html#dx1-21049" ><span -class="ecti-1000">430</span></a>, <a -href="glossaries-manual.html#dx1-21076" ><span class="underline">431</span></a>, <a -href="glossaries-manual.html#dx1-22002" ><span class="underline">432</span></a>, <a -href="glossaries-manual.html#dx1-22022" ><span class="underline">433</span></a>, <a -href="glossaries-manual.html#dx1-22029" ><span class="underline">434</span></a>, <a -href="glossaries-manual.html#dx1-23004" ><span class="underline">435</span></a>, <a -href="glossaries-manual.html#dx1-23013" ><span class="underline">436</span></a>, <a -href="glossaries-manual.html#dx1-25003" ><span class="underline">437</span></a>, <a -href="glossaries-manual.html#dx1-34182" ><span class="underline">438</span></a>, <a -href="glossaries-manual.html#dx1-36008" ><span class="underline">439</span></a>, <a -href="glossaries-manual.html#dx1-36010" ><span class="underline">440</span></a>, <a -href="glossaries-manual.html#dx1-36012" ><span class="underline">441</span></a>, <a -href="glossaries-manual.html#dx1-36018" ><span class="underline">442</span></a>, <a -href="glossaries-manual.html#dx1-36020" ><span class="underline">443</span></a>, <a -href="glossaries-manual.html#dx1-37001" ><span class="underline">444</span></a> <br /></span> +href="glossaries-user.html#dx1-2008" >450</a>, <a +href="glossaries-user.html#dx1-2024" >451</a>, <a +href="glossaries-user.html#dx1-19039" >452</a>, <a +href="glossaries-user.html#dx1-19043" >453</a>, <a +href="glossaries-user.html#dx1-19049" >454</a>, <a +href="glossaries-user.html#dx1-19051" >455</a>, <a +href="glossaries-user.html#dx1-19065" >456</a>, <a +href="glossaries-user.html#dx1-26018" >457</a>, <a +href="glossaries-user.html#dx1-26067" ><span +class="ecti-1000">458</span></a>, <a +href="glossaries-user.html#dx1-26092" >459</a>, <a +href="glossaries-user.html#dx1-26099" >460</a>, <a +href="glossaries-user.html#dx1-27003" >461</a>, <a +href="glossaries-user.html#dx1-27016" >462</a>, <a +href="glossaries-user.html#dx1-27030" >463</a>, <a +href="glossaries-user.html#dx1-27038" >464</a>, <a +href="glossaries-user.html#dx1-28004" >465</a>, <a +href="glossaries-user.html#dx1-28014" >466</a>, <a +href="glossaries-user.html#dx1-30003" >467</a>, <a +href="glossaries-user.html#dx1-30008" >468</a>, <a +href="glossaries-user.html#dx1-39042" >469</a>, <a +href="glossaries-user.html#dx1-39107" >470</a>, <a +href="glossaries-user.html#dx1-40004" >471</a>, <a +href="glossaries-user.html#dx1-40008" >472</a>, <a +href="glossaries-user.html#dx1-42022" >473</a>, <a +href="glossaries-user.html#dx1-43008" >474</a>, <a +href="glossaries-user.html#dx1-43010" >475</a>, <a +href="glossaries-user.html#dx1-43012" >476</a>, <a +href="glossaries-user.html#dx1-43018" >477</a>, <a +href="glossaries-user.html#dx1-43020" >478</a>, <a +href="glossaries-user.html#dx1-44001" >479</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls*</span></span></span>  <a +href="glossaries-user.html#dx1-13066" >480</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsadd</span></span></span>  <a -href="glossaries-manual.html#dx1-24001" ><span -class="ecti-1000">445</span></a> <br /></span> +href="glossaries-user.html#dx1-29001" ><span +class="ecti-1000">481</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsaddall</span></span></span>  <a -href="glossaries-manual.html#dx1-3017" ><span class="underline">446</span></a>, <a -href="glossaries-manual.html#dx1-24004" ><span -class="ecti-1000">447</span></a> <br /></span> +href="glossaries-user.html#dx1-4023" >482</a>, <a +href="glossaries-user.html#dx1-29005" ><span +class="ecti-1000">483</span></a> <br /></span> <span class="index-item"><span class="ectt-1000">\glsaddall </span>options<br /></span> <span class="index-subitem">    <span class="ecss-1000">types</span>  <a -href="glossaries-manual.html#dx1-24005" >448</a> <br /></span> +href="glossaries-user.html#dx1-29006" >484</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsAddXdyAttribute</span></span></span>  <a -href="glossaries-manual.html#dx1-21026" ><span class="underline">449</span></a>, <a -href="glossaries-manual.html#dx1-31005" ><span -class="ecti-1000">450</span></a> <br /></span> +href="glossaries-user.html#dx1-26039" >485</a>, <a +href="glossaries-user.html#dx1-36017" ><span +class="ecti-1000">486</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsAddXdyCounters</span></span></span>  <a +href="glossaries-user.html#dx1-36011" ><span +class="ecti-1000">487</span></a>, <a +href="glossaries-user.html#dx1-36038" >488</a> <br /></span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsAddXdyLocation</span></span></span>  <a -href="glossaries-manual.html#dx1-31022" ><span class="underline">451</span></a> <br /></span> +href="glossaries-user.html#dx1-36024" ><span +class="ecti-1000">489</span></a>, <a +href="glossaries-user.html#dx1-36050" >490</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsautoprefix</span></span></span>  <a -href="glossaries-manual.html#dx1-13040" ><span -class="ecti-1000">452</span></a> <br /></span> +href="glossaries-user.html#dx1-14027" ><span +class="ecti-1000">491</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsclearpage</span></span></span>  <a -href="glossaries-manual.html#dx1-13028" ><span class="underline">453</span></a> <br /></span> +href="glossaries-user.html#dx1-14015" >492</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsclosebrace</span></span></span>  <a -href="glossaries-manual.html#dx1-29008" ><span -class="ecti-1000">454</span></a> <br /></span> +href="glossaries-user.html#dx1-34012" ><span +class="ecti-1000">493</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdefaulttype</span></span></span>  <a -href="glossaries-manual.html#dx1-13018" ><span class="underline">455</span></a>, <a -href="glossaries-manual.html#dx1-13020" ><span class="underline">456</span></a> <br /></span> +href="glossaries-user.html#dx1-24004" >494</a>, <a +href="glossaries-user.html#dx1-17006" >495</a>, <a +href="glossaries-user.html#dx1-17008" >496</a>, <a +href="glossaries-user.html#dx1-24011" >497</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSdesc</span></span></span>  <a -href="glossaries-manual.html#dx1-21119" ><span -class="ecti-1000">457</span></a> <br /></span> +href="glossaries-user.html#dx1-26147" ><span +class="ecti-1000">498</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsdesc</span></span></span>  <a -href="glossaries-manual.html#dx1-21118" ><span -class="ecti-1000">458</span></a> <br /></span> +href="glossaries-user.html#dx1-26146" ><span +class="ecti-1000">499</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdesc</span></span></span>  <a -href="glossaries-manual.html#dx1-21113" ><span -class="ecti-1000">459</span></a>, <a -href="glossaries-manual.html#dx1-34143" ><span class="underline">460</span></a> <br /></span> +href="glossaries-user.html#dx1-26139" ><span +class="ecti-1000">500</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdescwidth</span></span></span>  <a -href="glossaries-manual.html#dx1-38011" ><span -class="ecti-1000">461</span></a>, <a -href="glossaries-manual.html#dx1-40011" ><span class="underline">462</span></a>, <a -href="glossaries-manual.html#dx1-40021" ><span class="underline">463</span></a>, <a -href="glossaries-manual.html#dx1-40040" ><span class="underline">464</span></a>, <a -href="glossaries-manual.html#dx1-41011" ><span class="underline">465</span></a>, <a -href="glossaries-manual.html#dx1-41021" ><span class="underline">466</span></a>, <a -href="glossaries-manual.html#dx1-41031" ><span class="underline">467</span></a>, <a -href="glossaries-manual.html#dx1-42017" ><span class="underline">468</span></a>, <a -href="glossaries-manual.html#dx1-42027" ><span class="underline">469</span></a>, <a -href="glossaries-manual.html#dx1-42046" ><span class="underline">470</span></a>, <a -href="glossaries-manual.html#dx1-43014" ><span class="underline">471</span></a>, <a -href="glossaries-manual.html#dx1-43024" ><span class="underline">472</span></a> <br /></span> +href="glossaries-user.html#dx1-45015" ><span +class="ecti-1000">501</span></a>, <a +href="glossaries-user.html#dx1-47012" >502</a>, <a +href="glossaries-user.html#dx1-47023" >503</a>, <a +href="glossaries-user.html#dx1-47042" >504</a>, <a +href="glossaries-user.html#dx1-48012" >505</a>, <a +href="glossaries-user.html#dx1-48023" >506</a>, <a +href="glossaries-user.html#dx1-48033" >507</a>, <a +href="glossaries-user.html#dx1-49018" >508</a>, <a +href="glossaries-user.html#dx1-49029" >509</a>, <a +href="glossaries-user.html#dx1-49048" >510</a>, <a +href="glossaries-user.html#dx1-50015" >511</a>, <a +href="glossaries-user.html#dx1-50026" >512</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdisablehyper</span></span></span>  <a -href="glossaries-manual.html#dx1-23006" ><span -class="ecti-1000">473</span></a> <br /></span> +href="glossaries-user.html#dx1-28006" ><span +class="ecti-1000">513</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdisp</span></span></span>  <a -href="glossaries-manual.html#dx1-21018" ><span class="underline">474</span></a>, <a -href="glossaries-manual.html#dx1-21069" ><span -class="ecti-1000">475</span></a>, <a -href="glossaries-manual.html#dx1-22017" ><span class="underline">476</span></a>, <a -href="glossaries-manual.html#dx1-22024" ><span class="underline">477</span></a>, <a -href="glossaries-manual.html#dx1-23015" ><span class="underline">478</span></a> <br /></span> +href="glossaries-user.html#dx1-2014" >514</a>, <a +href="glossaries-user.html#dx1-2022" >515</a>, <a +href="glossaries-user.html#dx1-19048" >516</a>, <a +href="glossaries-user.html#dx1-26025" >517</a>, <a +href="glossaries-user.html#dx1-26091" ><span +class="ecti-1000">518</span></a>, <a +href="glossaries-user.html#dx1-27024" >519</a>, <a +href="glossaries-user.html#dx1-27032" >520</a>, <a +href="glossaries-user.html#dx1-28016" >521</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdisplay</span></span></span>  <a -href="glossaries-manual.html#dx1-14044" ><span class="underline">479</span></a>, <a -href="glossaries-manual.html#dx1-14076" ><span class="underline">480</span></a>, <a -href="glossaries-manual.html#dx1-21067" ><span class="underline">481</span></a>, <a -href="glossaries-manual.html#dx1-21073" ><span class="underline">482</span></a>, <a -href="glossaries-manual.html#dx1-21079" ><span class="underline">483</span></a>, <a -href="glossaries-manual.html#dx1-22006" ><span -class="ecti-1000">484</span></a>, <a -href="glossaries-manual.html#dx1-35041" ><span class="underline">485</span></a>, <a -href="glossaries-manual.html#dx1-35050" ><span class="underline">486</span></a> <br /></span> +href="glossaries-user.html#dx1-19029" >522</a>, <a +href="glossaries-user.html#dx1-19081" >523</a>, <a +href="glossaries-user.html#dx1-26089" >524</a>, <a +href="glossaries-user.html#dx1-26096" >525</a>, <a +href="glossaries-user.html#dx1-26102" >526</a>, <a +href="glossaries-user.html#dx1-27007" ><span +class="ecti-1000">527</span></a>, <a +href="glossaries-user.html#dx1-42046" >528</a>, <a +href="glossaries-user.html#dx1-42055" >529</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsdisplayfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-14045" ><span class="underline">487</span></a>, <a -href="glossaries-manual.html#dx1-14077" ><span class="underline">488</span></a>, <a -href="glossaries-manual.html#dx1-21068" ><span class="underline">489</span></a>, <a -href="glossaries-manual.html#dx1-21074" ><span class="underline">490</span></a>, <a -href="glossaries-manual.html#dx1-21080" ><span class="underline">491</span></a>, <a -href="glossaries-manual.html#dx1-22004" ><span -class="ecti-1000">492</span></a>, <a -href="glossaries-manual.html#dx1-35040" ><span class="underline">493</span></a>, <a -href="glossaries-manual.html#dx1-35049" ><span class="underline">494</span></a> <br /></span> +href="glossaries-user.html#dx1-19030" >530</a>, <a +href="glossaries-user.html#dx1-19082" >531</a>, <a +href="glossaries-user.html#dx1-26090" >532</a>, <a +href="glossaries-user.html#dx1-26097" >533</a>, <a +href="glossaries-user.html#dx1-26103" >534</a>, <a +href="glossaries-user.html#dx1-27005" ><span +class="ecti-1000">535</span></a>, <a +href="glossaries-user.html#dx1-42045" >536</a>, <a +href="glossaries-user.html#dx1-42054" >537</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsenablehyper</span></span></span>  <a -href="glossaries-manual.html#dx1-23007" ><span -class="ecti-1000">495</span></a> <br /></span> +href="glossaries-user.html#dx1-28007" ><span +class="ecti-1000">538</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrycounterlabel</span></span></span>  <a +href="glossaries-user.html#dx1-52042" ><span +class="ecti-1000">539</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentrydesc</span></span></span>  <a -href="glossaries-manual.html#dx1-26021" ><span -class="ecti-1000">496</span></a> <br /></span> +href="glossaries-user.html#dx1-32022" ><span +class="ecti-1000">540</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentrydesc</span></span></span>  <a -href="glossaries-manual.html#dx1-26020" ><span -class="ecti-1000">497</span></a> <br /></span> +href="glossaries-user.html#dx1-32021" ><span +class="ecti-1000">541</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentrydescplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26023" ><span -class="ecti-1000">498</span></a> <br /></span> +href="glossaries-user.html#dx1-32024" ><span +class="ecti-1000">542</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentrydescplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26022" ><span -class="ecti-1000">499</span></a> <br /></span> +href="glossaries-user.html#dx1-32023" ><span +class="ecti-1000">543</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-26013" ><span -class="ecti-1000">500</span></a> <br /></span> +href="glossaries-user.html#dx1-32014" ><span +class="ecti-1000">544</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-26012" ><span -class="ecti-1000">501</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-32013" ><span +class="ecti-1000">545</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryfirstplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26017" ><span -class="ecti-1000">502</span></a> <br /></span> +href="glossaries-user.html#dx1-32018" ><span +class="ecti-1000">546</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryfirstplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26016" ><span -class="ecti-1000">503</span></a> <br /></span> +href="glossaries-user.html#dx1-32017" ><span +class="ecti-1000">547</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryfull</span></span></span>  <a +href="glossaries-user.html#dx1-39124" ><span +class="ecti-1000">548</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryfull</span></span></span>  <a +href="glossaries-user.html#dx1-39123" ><span +class="ecti-1000">549</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryfullpl</span></span></span>  <a +href="glossaries-user.html#dx1-39126" ><span +class="ecti-1000">550</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryfullpl</span></span></span>  <a +href="glossaries-user.html#dx1-39125" ><span +class="ecti-1000">551</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryitem</span></span></span>  <a +href="glossaries-user.html#dx1-52039" ><span +class="ecti-1000">552</span></a>, <a +href="glossaries-user.html#dx1-53010" >553</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrylong</span></span></span>  <a +href="glossaries-user.html#dx1-39116" ><span +class="ecti-1000">554</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrylong</span></span></span>  <a +href="glossaries-user.html#dx1-39115" ><span +class="ecti-1000">555</span></a>, <a +href="glossaries-user.html#dx1-42041" >556</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrylongpl</span></span></span>  <a +href="glossaries-user.html#dx1-39118" ><span +class="ecti-1000">557</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrylongpl</span></span></span>  <a +href="glossaries-user.html#dx1-39117" ><span +class="ecti-1000">558</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryname</span></span></span>  <a -href="glossaries-manual.html#dx1-26004" ><span -class="ecti-1000">504</span></a> <br /></span> +href="glossaries-user.html#dx1-32005" ><span +class="ecti-1000">559</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryname</span></span></span>  <a -href="glossaries-manual.html#dx1-26003" ><span -class="ecti-1000">505</span></a>, <a -href="glossaries-manual.html#dx1-26041" ><span class="underline">506</span></a> <br /></span> +href="glossaries-user.html#dx1-5022" >560</a>, <a +href="glossaries-user.html#dx1-32004" ><span +class="ecti-1000">561</span></a>, <a +href="glossaries-user.html#dx1-57062" >562</a>, <a +href="glossaries-user.html#dx1-32044" >563</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26010" ><span -class="ecti-1000">507</span></a> <br /></span> +href="glossaries-user.html#dx1-32011" ><span +class="ecti-1000">564</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26009" ><span -class="ecti-1000">508</span></a> <br /></span> +href="glossaries-user.html#dx1-32010" ><span +class="ecti-1000">565</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryshort</span></span></span>  <a +href="glossaries-user.html#dx1-39120" ><span +class="ecti-1000">566</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryshort</span></span></span>  <a +href="glossaries-user.html#dx1-39119" ><span +class="ecti-1000">567</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryshortpl</span></span></span>  <a +href="glossaries-user.html#dx1-39122" ><span +class="ecti-1000">568</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryshortpl</span></span></span>  <a +href="glossaries-user.html#dx1-39121" ><span +class="ecti-1000">569</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentrysymbol</span></span></span>  <a -href="glossaries-manual.html#dx1-26025" ><span -class="ecti-1000">509</span></a> <br /></span> +href="glossaries-user.html#dx1-32026" ><span +class="ecti-1000">570</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentrysymbol</span></span></span>  <a -href="glossaries-manual.html#dx1-26024" ><span -class="ecti-1000">510</span></a> <br /></span> +href="glossaries-user.html#dx1-32025" ><span +class="ecti-1000">571</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentrysymbolplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26027" ><span -class="ecti-1000">511</span></a> <br /></span> +href="glossaries-user.html#dx1-32028" ><span +class="ecti-1000">572</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentrysymbolplural</span></span></span>  <a -href="glossaries-manual.html#dx1-26026" ><span -class="ecti-1000">512</span></a> <br /></span> +href="glossaries-user.html#dx1-32027" ><span +class="ecti-1000">573</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentrytext</span></span></span>  <a -href="glossaries-manual.html#dx1-26007" ><span -class="ecti-1000">513</span></a> <br /></span> +href="glossaries-user.html#dx1-32008" ><span +class="ecti-1000">574</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentrytext</span></span></span>  <a -href="glossaries-manual.html#dx1-26006" ><span -class="ecti-1000">514</span></a> <br /></span> +href="glossaries-user.html#dx1-5020" >575</a>, <a +href="glossaries-user.html#dx1-26011" >576</a>, <a +href="glossaries-user.html#dx1-31013" >577</a>, <a +href="glossaries-user.html#dx1-32007" ><span +class="ecti-1000">578</span></a>, <a +href="glossaries-user.html#dx1-32042" >579</a>, <a +href="glossaries-user.html#dx1-39114" >580</a>, <a +href="glossaries-user.html#dx1-57064" >581</a> <br /></span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuseri</span></span></span>  <a -href="glossaries-manual.html#dx1-26029" ><span -class="ecti-1000">515</span></a> <br /></span> +href="glossaries-user.html#dx1-32030" ><span +class="ecti-1000">582</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuseri</span></span></span>  <a -href="glossaries-manual.html#dx1-26028" ><span -class="ecti-1000">516</span></a> <br /></span> +href="glossaries-user.html#dx1-32029" ><span +class="ecti-1000">583</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuserii</span></span></span>  <a -href="glossaries-manual.html#dx1-26031" ><span -class="ecti-1000">517</span></a> <br /></span> +href="glossaries-user.html#dx1-32032" ><span +class="ecti-1000">584</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuserii</span></span></span>  <a -href="glossaries-manual.html#dx1-26030" ><span -class="ecti-1000">518</span></a> <br /></span> +href="glossaries-user.html#dx1-32031" ><span +class="ecti-1000">585</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuseriii</span></span></span>  <a -href="glossaries-manual.html#dx1-26033" ><span -class="ecti-1000">519</span></a> <br /></span> +href="glossaries-user.html#dx1-32034" ><span +class="ecti-1000">586</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuseriii</span></span></span>  <a -href="glossaries-manual.html#dx1-26032" ><span -class="ecti-1000">520</span></a>, <a -href="glossaries-manual.html#dx1-35036" ><span class="underline">521</span></a> <br /></span> +href="glossaries-user.html#dx1-32033" ><span +class="ecti-1000">587</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuseriv</span></span></span>  <a -href="glossaries-manual.html#dx1-26035" ><span -class="ecti-1000">522</span></a> <br /></span> +href="glossaries-user.html#dx1-32036" ><span +class="ecti-1000">588</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuseriv</span></span></span>  <a -href="glossaries-manual.html#dx1-26034" ><span -class="ecti-1000">523</span></a> <br /></span> +href="glossaries-user.html#dx1-32035" ><span +class="ecti-1000">589</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuserv</span></span></span>  <a -href="glossaries-manual.html#dx1-26037" ><span -class="ecti-1000">524</span></a> <br /></span> +href="glossaries-user.html#dx1-32038" ><span +class="ecti-1000">590</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuserv</span></span></span>  <a -href="glossaries-manual.html#dx1-26036" ><span -class="ecti-1000">525</span></a> <br /></span> +href="glossaries-user.html#dx1-32037" ><span +class="ecti-1000">591</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsentryuservi</span></span></span>  <a -href="glossaries-manual.html#dx1-26039" ><span -class="ecti-1000">526</span></a> <br /></span> +href="glossaries-user.html#dx1-32040" ><span +class="ecti-1000">592</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsentryuservi</span></span></span>  <a -href="glossaries-manual.html#dx1-26038" ><span -class="ecti-1000">527</span></a> <br /></span> +href="glossaries-user.html#dx1-32039" ><span +class="ecti-1000">593</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-21088" ><span -class="ecti-1000">528</span></a> <br /></span> +href="glossaries-user.html#dx1-26110" ><span +class="ecti-1000">594</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-21087" ><span -class="ecti-1000">529</span></a> <br /></span> +href="glossaries-user.html#dx1-26109" ><span +class="ecti-1000">595</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsfirst</span></span></span>  <a -href="glossaries-manual.html#dx1-21083" ><span -class="ecti-1000">530</span></a>, <a -href="glossaries-manual.html#dx1-34145" ><span class="underline">531</span></a> <br /></span> +href="glossaries-user.html#dx1-26106" ><span +class="ecti-1000">596</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSfirstplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21098" ><span -class="ecti-1000">532</span></a> <br /></span> +href="glossaries-user.html#dx1-26120" ><span +class="ecti-1000">597</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsfirstplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21097" ><span -class="ecti-1000">533</span></a> <br /></span> +href="glossaries-user.html#dx1-26119" ><span +class="ecti-1000">598</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsfirstplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21094" ><span -class="ecti-1000">534</span></a> <br /></span> +href="glossaries-user.html#dx1-26116" ><span +class="ecti-1000">599</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsgetgrouptitle</span></span></span>  <a -href="glossaries-manual.html#dx1-45022" ><span -class="ecti-1000">535</span></a> <br /></span> +href="glossaries-user.html#dx1-52028" ><span +class="ecti-1000">600</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsgroupheading</span></span></span>  <a -href="glossaries-manual.html#dx1-45016" ><span -class="ecti-1000">536</span></a>, <a -href="glossaries-manual.html#dx1-46005" ><span class="underline">537</span></a> <br /></span> +href="glossaries-user.html#dx1-52020" ><span +class="ecti-1000">601</span></a>, <a +href="glossaries-user.html#dx1-53005" >602</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsgroupskip</span></span></span>  <a -href="glossaries-manual.html#dx1-3013" ><span class="underline">538</span></a>, <a -href="glossaries-manual.html#dx1-38024" ><span class="underline">539</span></a>, <a -href="glossaries-manual.html#dx1-45026" ><span -class="ecti-1000">540</span></a>, <a -href="glossaries-manual.html#dx1-46006" ><span class="underline">541</span></a> <br /></span> +href="glossaries-user.html#dx1-2001" >603</a>, <a +href="glossaries-user.html#dx1-4018" >604</a>, <a +href="glossaries-user.html#dx1-45028" >605</a>, <a +href="glossaries-user.html#dx1-52032" ><span +class="ecti-1000">606</span></a>, <a +href="glossaries-user.html#dx1-53006" >607</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glshyperlink</span></span></span>  <a -href="glossaries-manual.html#dx1-26002" ><span class="underline">542</span></a>, <a -href="glossaries-manual.html#dx1-26040" ><span -class="ecti-1000">543</span></a> <br /></span> +href="glossaries-user.html#dx1-32003" >608</a>, <a +href="glossaries-user.html#dx1-32041" ><span +class="ecti-1000">609</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glshypernavsep</span></span></span>  <a -href="glossaries-manual.html#dx1-39014" ><span -class="ecti-1000">544</span></a> <br /></span> +href="glossaries-user.html#dx1-46017" ><span +class="ecti-1000">610</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslabel</span></span></span>  <a -href="glossaries-manual.html#dx1-22015" ><span -class="ecti-1000">545</span></a> <br /></span> +href="glossaries-user.html#dx1-27022" ><span +class="ecti-1000">611</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslabeltok</span></span></span>  <a -href="glossaries-manual.html#dx1-35006" ><span class="underline">546</span></a> <br /></span> +href="glossaries-user.html#dx1-42006" >612</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslink</span></span></span>  <a -href="glossaries-manual.html#dx1-21016" ><span -class="ecti-1000">547</span></a>, <a -href="glossaries-manual.html#dx1-21060" ><span class="underline">548</span></a>, <a -href="glossaries-manual.html#dx1-22016" ><span class="underline">549</span></a>, <a -href="glossaries-manual.html#dx1-23003" ><span class="underline">550</span></a>, <a -href="glossaries-manual.html#dx1-23016" ><span class="underline">551</span></a>, <a -href="glossaries-manual.html#dx1-24002" ><span class="underline">552</span></a> <br /></span> +href="glossaries-user.html#dx1-26023" ><span +class="ecti-1000">613</span></a>, <a +href="glossaries-user.html#dx1-26079" >614</a>, <a +href="glossaries-user.html#dx1-26080" >615</a>, <a +href="glossaries-user.html#dx1-26087" >616</a>, <a +href="glossaries-user.html#dx1-27023" >617</a>, <a +href="glossaries-user.html#dx1-28003" >618</a>, <a +href="glossaries-user.html#dx1-28017" >619</a>, <a +href="glossaries-user.html#dx1-29002" >620</a>, <a +href="glossaries-user.html#dx1-29004" >621</a>, <a +href="glossaries-user.html#dx1-36009" >622</a> <br /></span> <span class="index-item"><span class="ectt-1000">\glslink </span>options<br /></span> <span class="index-subitem">    <span class="ecss-1000">counter</span>  <a -href="glossaries-manual.html#dx1-21046" >553</a> <br /></span> +href="glossaries-user.html#dx1-26063" >623</a>, <a +href="glossaries-user.html#dx1-36008" >624</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">format</span>  <a -href="glossaries-manual.html#dx1-21019" >554</a>, <a -href="glossaries-manual.html#dx1-21025" >555</a>, <a -href="glossaries-manual.html#dx1-31001" >556</a>, <a -href="glossaries-manual.html#dx1-31006" >557</a> <br /></span> +href="glossaries-user.html#dx1-26026" >625</a>, <a +href="glossaries-user.html#dx1-26038" >626</a>, <a +href="glossaries-user.html#dx1-36012" >627</a>, <a +href="glossaries-user.html#dx1-36018" >628</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">hyper</span>  <a -href="glossaries-manual.html#dx1-21047" >558</a>, <a -href="glossaries-manual.html#dx1-23005" >559</a>, <a -href="glossaries-manual.html#dx1-24003" >560</a> <br /></span> +href="glossaries-user.html#dx1-26064" >629</a>, <a +href="glossaries-user.html#dx1-28005" >630</a>, <a +href="glossaries-user.html#dx1-29003" >631</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslink*</span></span></span>  <a -href="glossaries-manual.html#dx1-21048" ><span -class="ecti-1000">561</span></a> <br /></span> +href="glossaries-user.html#dx1-26066" ><span +class="ecti-1000">632</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslistdottedwidth</span></span></span>  <a -href="glossaries-manual.html#dx1-39029" ><span -class="ecti-1000">562</span></a> <br /></span> +href="glossaries-user.html#dx1-46034" ><span +class="ecti-1000">633</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslocalreset</span></span></span>  <a -href="glossaries-manual.html#dx1-37007" ><span -class="ecti-1000">563</span></a> <br /></span> +href="glossaries-user.html#dx1-44007" ><span +class="ecti-1000">634</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslocalresetall</span></span></span>  <a -href="glossaries-manual.html#dx1-37011" ><span -class="ecti-1000">564</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-44011" ><span +class="ecti-1000">635</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslocalunset</span></span></span>  <a -href="glossaries-manual.html#dx1-37009" ><span -class="ecti-1000">565</span></a> <br /></span> +href="glossaries-user.html#dx1-44009" ><span +class="ecti-1000">636</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslocalunsetall</span></span></span>  <a -href="glossaries-manual.html#dx1-37013" ><span -class="ecti-1000">566</span></a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glslongkey</span></span></span>  <a -href="glossaries-manual.html#dx1-34056" ><span -class="ecti-1000">567</span></a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glslongpluralkey</span></span></span>  <a -href="glossaries-manual.html#dx1-34057" ><span -class="ecti-1000">568</span></a> <br /></span> +href="glossaries-user.html#dx1-44013" ><span +class="ecti-1000">637</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glslongtok</span></span></span>  <a -href="glossaries-manual.html#dx1-35004" ><span class="underline">569</span></a> <br /></span> +href="glossaries-user.html#dx1-42004" >638</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSname</span></span></span>  <a -href="glossaries-manual.html#dx1-21105" ><span -class="ecti-1000">570</span></a> <br /></span> +href="glossaries-user.html#dx1-26129" ><span +class="ecti-1000">639</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsname</span></span></span>  <a -href="glossaries-manual.html#dx1-21104" ><span -class="ecti-1000">571</span></a> <br /></span> +href="glossaries-user.html#dx1-26128" ><span +class="ecti-1000">640</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsname</span></span></span>  <a -href="glossaries-manual.html#dx1-21099" ><span -class="ecti-1000">572</span></a> <br /></span> +href="glossaries-user.html#dx1-5023" >641</a>, <a +href="glossaries-user.html#dx1-26121" ><span +class="ecti-1000">642</span></a>, <a +href="glossaries-user.html#dx1-57063" >643</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsnamefont</span></span></span>  <a -href="glossaries-manual.html#dx1-28001" ><span -class="ecti-1000">573</span></a> <br /></span> +href="glossaries-user.html#dx1-33041" ><span +class="ecti-1000">644</span></a>, <a +href="glossaries-user.html#dx1-52036" >645</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsnavhypertarget</span></span></span>  <a -href="glossaries-manual.html#dx1-45023" ><span -class="ecti-1000">574</span></a> <br /></span> +href="glossaries-user.html#dx1-52029" ><span +class="ecti-1000">646</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsnumberformat</span></span></span>  <a +href="glossaries-user.html#dx1-36041" >647</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsnumbersgroupname</span></span></span>  <a -href="glossaries-manual.html#dx1-5022" ><span class="underline">575</span></a> <br /></span> +href="glossaries-user.html#dx1-6022" >648</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsopenbrace</span></span></span>  <a -href="glossaries-manual.html#dx1-29007" ><span -class="ecti-1000">576</span></a> <br /></span> +href="glossaries-user.html#dx1-34011" ><span +class="ecti-1000">649</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspagelistwidth</span></span></span>  <a -href="glossaries-manual.html#dx1-38012" ><span -class="ecti-1000">577</span></a>, <a -href="glossaries-manual.html#dx1-40022" ><span class="underline">578</span></a>, <a -href="glossaries-manual.html#dx1-40041" ><span class="underline">579</span></a>, <a -href="glossaries-manual.html#dx1-41022" ><span class="underline">580</span></a>, <a -href="glossaries-manual.html#dx1-41032" ><span class="underline">581</span></a>, <a -href="glossaries-manual.html#dx1-42028" ><span class="underline">582</span></a>, <a -href="glossaries-manual.html#dx1-42047" ><span class="underline">583</span></a>, <a -href="glossaries-manual.html#dx1-43025" ><span class="underline">584</span></a> <br /></span> +href="glossaries-user.html#dx1-45016" ><span +class="ecti-1000">650</span></a>, <a +href="glossaries-user.html#dx1-47024" >651</a>, <a +href="glossaries-user.html#dx1-47043" >652</a>, <a +href="glossaries-user.html#dx1-48024" >653</a>, <a +href="glossaries-user.html#dx1-48034" >654</a>, <a +href="glossaries-user.html#dx1-49030" >655</a>, <a +href="glossaries-user.html#dx1-49049" >656</a>, <a +href="glossaries-user.html#dx1-50027" >657</a> <br /></span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspar</span></span></span>  <a -href="glossaries-manual.html#dx1-14040" ><span -class="ecti-1000">585</span></a> <br /></span> +href="glossaries-user.html#dx1-19025" ><span +class="ecti-1000">658</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSpl</span></span></span>  <a -href="glossaries-manual.html#dx1-14048" ><span class="underline">586</span></a>, <a -href="glossaries-manual.html#dx1-14080" ><span class="underline">587</span></a>, <a -href="glossaries-manual.html#dx1-21063" ><span -class="ecti-1000">588</span></a> <br /></span> +href="glossaries-user.html#dx1-2013" >659</a>, <a +href="glossaries-user.html#dx1-19033" >660</a>, <a +href="glossaries-user.html#dx1-19047" >661</a>, <a +href="glossaries-user.html#dx1-19085" >662</a>, <a +href="glossaries-user.html#dx1-26083" ><span +class="ecti-1000">663</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glspl</span></span></span>  <a -href="glossaries-manual.html#dx1-14047" ><span class="underline">589</span></a>, <a -href="glossaries-manual.html#dx1-14079" ><span class="underline">590</span></a>, <a -href="glossaries-manual.html#dx1-21062" ><span -class="ecti-1000">591</span></a>, <a -href="glossaries-manual.html#dx1-34188" ><span class="underline">592</span></a> <br /></span> +href="glossaries-user.html#dx1-2012" >664</a>, <a +href="glossaries-user.html#dx1-19032" >665</a>, <a +href="glossaries-user.html#dx1-19046" >666</a>, <a +href="glossaries-user.html#dx1-19084" >667</a>, <a +href="glossaries-user.html#dx1-19126" >668</a>, <a +href="glossaries-user.html#dx1-26082" ><span +class="ecti-1000">669</span></a>, <a +href="glossaries-user.html#dx1-39113" >670</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspl</span></span></span>  <a -href="glossaries-manual.html#dx1-14046" ><span class="underline">593</span></a>, <a -href="glossaries-manual.html#dx1-14058" ><span class="underline">594</span></a>, <a -href="glossaries-manual.html#dx1-14062" ><span class="underline">595</span></a>, <a -href="glossaries-manual.html#dx1-14078" ><span class="underline">596</span></a>, <a -href="glossaries-manual.html#dx1-21012" ><span class="underline">597</span></a>, <a -href="glossaries-manual.html#dx1-21061" ><span -class="ecti-1000">598</span></a>, <a -href="glossaries-manual.html#dx1-22003" ><span class="underline">599</span></a>, <a -href="glossaries-manual.html#dx1-22023" ><span class="underline">600</span></a>, <a -href="glossaries-manual.html#dx1-23014" ><span class="underline">601</span></a>, <a -href="glossaries-manual.html#dx1-34186" ><span class="underline">602</span></a>, <a -href="glossaries-manual.html#dx1-37002" ><span class="underline">603</span></a> <br /></span> +href="glossaries-user.html#dx1-2011" >671</a>, <a +href="glossaries-user.html#dx1-19031" >672</a>, <a +href="glossaries-user.html#dx1-19045" >673</a>, <a +href="glossaries-user.html#dx1-19053" >674</a>, <a +href="glossaries-user.html#dx1-19059" >675</a>, <a +href="glossaries-user.html#dx1-19068" >676</a>, <a +href="glossaries-user.html#dx1-19070" >677</a>, <a +href="glossaries-user.html#dx1-19083" >678</a>, <a +href="glossaries-user.html#dx1-26019" >679</a>, <a +href="glossaries-user.html#dx1-26081" ><span +class="ecti-1000">680</span></a>, <a +href="glossaries-user.html#dx1-27004" >681</a>, <a +href="glossaries-user.html#dx1-27017" >682</a>, <a +href="glossaries-user.html#dx1-27031" >683</a>, <a +href="glossaries-user.html#dx1-28015" >684</a>, <a +href="glossaries-user.html#dx1-39111" >685</a>, <a +href="glossaries-user.html#dx1-40005" >686</a>, <a +href="glossaries-user.html#dx1-44002" >687</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21093" ><span -class="ecti-1000">604</span></a> <br /></span> +href="glossaries-user.html#dx1-26115" ><span +class="ecti-1000">688</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21092" ><span -class="ecti-1000">605</span></a> <br /></span> +href="glossaries-user.html#dx1-26114" ><span +class="ecti-1000">689</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsplural</span></span></span>  <a -href="glossaries-manual.html#dx1-21089" ><span -class="ecti-1000">606</span></a> <br /></span> +href="glossaries-user.html#dx1-26111" ><span +class="ecti-1000">690</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspluralsuffix</span></span></span>  <a -href="glossaries-manual.html#dx1-14059" ><span class="underline">607</span></a>, <a -href="glossaries-manual.html#dx1-14066" ><span class="underline">608</span></a>, <a -href="glossaries-manual.html#dx1-15001" ><span -class="ecti-1000">609</span></a> <br /></span> +href="glossaries-user.html#dx1-19054" >691</a>, <a +href="glossaries-user.html#dx1-19056" >692</a>, <a +href="glossaries-user.html#dx1-19062" >693</a>, <a +href="glossaries-user.html#dx1-20001" ><span +class="ecti-1000">694</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glspostdescription</span></span></span>  <a -href="glossaries-manual.html#dx1-38031" ><span -class="ecti-1000">610</span></a> <br /></span> +href="glossaries-user.html#dx1-45034" ><span +class="ecti-1000">695</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsquote</span></span></span>  <a -href="glossaries-manual.html#dx1-29010" ><span -class="ecti-1000">611</span></a> <br /></span> +href="glossaries-user.html#dx1-34014" ><span +class="ecti-1000">696</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsrefentry</span></span></span>  <a +href="glossaries-user.html#dx1-4044" >697</a>, <a +href="glossaries-user.html#dx1-15005" ><span +class="ecti-1000">698</span></a>, <a +href="glossaries-user.html#dx1-15024" >699</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsreset</span></span></span>  <a -href="glossaries-manual.html#dx1-37006" ><span -class="ecti-1000">612</span></a> <br /></span> +href="glossaries-user.html#dx1-39043" >700</a>, <a +href="glossaries-user.html#dx1-44006" ><span +class="ecti-1000">701</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsresetall</span></span></span>  <a -href="glossaries-manual.html#dx1-37010" ><span -class="ecti-1000">613</span></a> <br /></span> +href="glossaries-user.html#dx1-44010" ><span +class="ecti-1000">702</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glssee</span></span></span>  <a -href="glossaries-manual.html#dx1-21029" ><span class="underline">614</span></a>, <a -href="glossaries-manual.html#dx1-25012" ><span -class="ecti-1000">615</span></a>, <a -href="glossaries-manual.html#dx1-2003" ><span class="underline">616</span></a> <br /></span> +href="glossaries-user.html#dx1-15057" >703</a>, <a +href="glossaries-user.html#dx1-26044" >704</a>, <a +href="glossaries-user.html#dx1-30017" ><span +class="ecti-1000">705</span></a>, <a +href="glossaries-user.html#dx1-30027" >706</a>, <a +href="glossaries-user.html#dx1-3002" >707</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsseeformat</span></span></span>  <a +href="glossaries-user.html#dx1-2002" >708</a>, <a +href="glossaries-user.html#dx1-31002" ><span +class="ecti-1000">709</span></a>, <a +href="glossaries-user.html#dx1-31018" >710</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsseeitemformat</span></span></span>  <a +href="glossaries-user.html#dx1-31012" ><span +class="ecti-1000">711</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsseelastsep</span></span></span>  <a +href="glossaries-user.html#dx1-31010" ><span +class="ecti-1000">712</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsseelist</span></span></span>  <a +href="glossaries-user.html#dx1-2005" >713</a>, <a +href="glossaries-user.html#dx1-31019" >714</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsseesep</span></span></span>  <a +href="glossaries-user.html#dx1-31009" ><span +class="ecti-1000">715</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsSetAlphaCompositor</span></span></span>  <a -href="glossaries-manual.html#dx1-14028" ><span -class="ecti-1000">617</span></a> <br /></span> +href="glossaries-user.html#dx1-18030" ><span +class="ecti-1000">716</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsSetCompositor</span></span></span>  <a -href="glossaries-manual.html#dx1-14026" ><span -class="ecti-1000">618</span></a> <br /></span> +href="glossaries-user.html#dx1-18027" ><span +class="ecti-1000">717</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsSetSuffixF</span></span></span>  <a -href="glossaries-manual.html#dx1-20013" ><span -class="ecti-1000">619</span></a> <br /></span> +href="glossaries-user.html#dx1-25019" ><span +class="ecti-1000">718</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsSetSuffixFF</span></span></span>  <a -href="glossaries-manual.html#dx1-20014" ><span -class="ecti-1000">620</span></a> <br /></span> +href="glossaries-user.html#dx1-25020" ><span +class="ecti-1000">719</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glssetwidest</span></span></span>  <a -href="glossaries-manual.html#dx1-44031" ><span -class="ecti-1000">621</span></a> <br /></span> +href="glossaries-user.html#dx1-51033" ><span +class="ecti-1000">720</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsSetXdyCodePage</span></span></span>  <a -href="glossaries-manual.html#dx1-6037" ><span class="underline">622</span></a>, <a -href="glossaries-manual.html#dx1-30009" ><span -class="ecti-1000">623</span></a> <br /></span> +href="glossaries-user.html#dx1-7090" >721</a>, <a +href="glossaries-user.html#dx1-35013" ><span +class="ecti-1000">722</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits</span></span></span>  <a +href="glossaries-user.html#dx1-37002" ><span +class="ecti-1000">723</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsSetXdyLanguage</span></span></span>  <a -href="glossaries-manual.html#dx1-6036" ><span class="underline">624</span></a>, <a -href="glossaries-manual.html#dx1-30006" ><span -class="ecti-1000">625</span></a> <br /></span> +href="glossaries-user.html#dx1-7089" >724</a>, <a +href="glossaries-user.html#dx1-35010" ><span +class="ecti-1000">725</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsSetXdyLocationClassOrder</span></span></span>  <a -href="glossaries-manual.html#dx1-31023" ><span -class="ecti-1000">626</span></a> <br /></span> +href="glossaries-user.html#dx1-36051" ><span +class="ecti-1000">726</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GlsSetXdyMinRangeLength</span></span></span>  <a -href="glossaries-manual.html#dx1-20008" ><span class="underline">627</span></a>, <a -href="glossaries-manual.html#dx1-31028" ><span -class="ecti-1000">628</span></a> <br /></span> +href="glossaries-user.html#dx1-25012" >727</a>, <a +href="glossaries-user.html#dx1-36057" ><span +class="ecti-1000">728</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glsshortkey</span></span></span>  <a -href="glossaries-manual.html#dx1-34054" ><span -class="ecti-1000">629</span></a> <br /></span> +class="ectt-1000">\glsshorttok</span></span></span>  <a +href="glossaries-user.html#dx1-42005" >729</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glsshortpluralkey</span></span></span>  <a -href="glossaries-manual.html#dx1-34055" ><span -class="ecti-1000">630</span></a> <br /></span> +class="ectt-1000">\glssubentrycounterlabel</span></span></span>  <a +href="glossaries-user.html#dx1-52061" ><span +class="ecti-1000">730</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\glsshorttok</span></span></span>  <a -href="glossaries-manual.html#dx1-35005" ><span class="underline">631</span></a> <br /></span> +class="ectt-1000">\glssubentryitem</span></span></span>  <a +href="glossaries-user.html#dx1-52058" ><span +class="ecti-1000">731</span></a>, <a +href="glossaries-user.html#dx1-53011" >732</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSsymbol</span></span></span>  <a -href="glossaries-manual.html#dx1-21112" ><span -class="ecti-1000">632</span></a> <br /></span> +href="glossaries-user.html#dx1-26138" ><span +class="ecti-1000">733</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glssymbol</span></span></span>  <a -href="glossaries-manual.html#dx1-21111" ><span -class="ecti-1000">633</span></a> <br /></span> +href="glossaries-user.html#dx1-26137" ><span +class="ecti-1000">734</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glssymbol</span></span></span>  <a -href="glossaries-manual.html#dx1-21106" ><span -class="ecti-1000">634</span></a>, <a -href="glossaries-manual.html#dx1-34144" ><span class="underline">635</span></a> <br /></span> +href="glossaries-user.html#dx1-26130" ><span +class="ecti-1000">735</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glssymbolsgroupname</span></span></span>  <a -href="glossaries-manual.html#dx1-5021" ><span class="underline">636</span></a> <br /></span> +href="glossaries-user.html#dx1-6021" >736</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstarget</span></span></span>  <a -href="glossaries-manual.html#dx1-45029" ><span -class="ecti-1000">637</span></a> <br /></span> +href="glossaries-user.html#dx1-52043" ><span +class="ecti-1000">737</span></a>, <a +href="glossaries-user.html#dx1-52060" >738</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLStext</span></span></span>  <a -href="glossaries-manual.html#dx1-21082" ><span -class="ecti-1000">638</span></a> <br /></span> +href="glossaries-user.html#dx1-26105" ><span +class="ecti-1000">739</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glstext</span></span></span>  <a -href="glossaries-manual.html#dx1-21081" ><span -class="ecti-1000">639</span></a> <br /></span> +href="glossaries-user.html#dx1-26104" ><span +class="ecti-1000">740</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstext</span></span></span>  <a -href="glossaries-manual.html#dx1-21075" ><span -class="ecti-1000">640</span></a>, <a -href="glossaries-manual.html#dx1-21084" ><span class="underline">641</span></a>, <a -href="glossaries-manual.html#dx1-21090" ><span class="underline">642</span></a>, <a -href="glossaries-manual.html#dx1-21095" ><span class="underline">643</span></a>, <a -href="glossaries-manual.html#dx1-21100" ><span class="underline">644</span></a>, <a -href="glossaries-manual.html#dx1-21107" ><span class="underline">645</span></a>, <a -href="glossaries-manual.html#dx1-21114" ><span class="underline">646</span></a>, <a -href="glossaries-manual.html#dx1-21121" ><span class="underline">647</span></a>, <a -href="glossaries-manual.html#dx1-34134" ><span class="underline">648</span></a>, <a -href="glossaries-manual.html#dx1-34138" ><span class="underline">649</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-5021" >741</a>, <a +href="glossaries-user.html#dx1-26098" ><span +class="ecti-1000">742</span></a>, <a +href="glossaries-user.html#dx1-26112" >743</a>, <a +href="glossaries-user.html#dx1-26117" >744</a>, <a +href="glossaries-user.html#dx1-26122" >745</a>, <a +href="glossaries-user.html#dx1-26131" >746</a>, <a +href="glossaries-user.html#dx1-26140" >747</a>, <a +href="glossaries-user.html#dx1-26149" >748</a>, <a +href="glossaries-user.html#dx1-39062" >749</a>, <a +href="glossaries-user.html#dx1-39066" >750</a>, <a +href="glossaries-user.html#dx1-57065" >751</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstextformat</span></span></span>  <a -href="glossaries-manual.html#dx1-21008" ><span -class="ecti-1000">650</span></a>, <a -href="glossaries-manual.html#dx1-22021" ><span class="underline">651</span></a> <br /></span> +href="glossaries-user.html#dx1-26014" ><span +class="ecti-1000">752</span></a>, <a +href="glossaries-user.html#dx1-27029" >753</a>, <a +href="glossaries-user.html#dx1-32001" >754</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstocfalse</span></span></span>  <a -href="glossaries-manual.html#dx1-13007" ><span -class="ecti-1000">652</span></a> <br /></span> +href="glossaries-user.html#dx1-14003" ><span +class="ecti-1000">755</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstoctrue</span></span></span>  <a -href="glossaries-manual.html#dx1-13006" ><span -class="ecti-1000">653</span></a> <br /></span> +href="glossaries-user.html#dx1-14002" ><span +class="ecti-1000">756</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glstreeindent</span></span></span>  <a -href="glossaries-manual.html#dx1-44015" ><span -class="ecti-1000">654</span></a> <br /></span> +href="glossaries-user.html#dx1-51017" ><span +class="ecti-1000">757</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsunset</span></span></span>  <a -href="glossaries-manual.html#dx1-37008" ><span -class="ecti-1000">655</span></a> <br /></span> +href="glossaries-user.html#dx1-44008" ><span +class="ecti-1000">758</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsunsetall</span></span></span>  <a -href="glossaries-manual.html#dx1-37012" ><span -class="ecti-1000">656</span></a> <br /></span> +href="glossaries-user.html#dx1-44012" ><span +class="ecti-1000">759</span></a> <br /></span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuseri</span></span></span>  <a -href="glossaries-manual.html#dx1-21124" ><span -class="ecti-1000">657</span></a> <br /></span> +href="glossaries-user.html#dx1-26152" ><span +class="ecti-1000">760</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuseri</span></span></span>  <a -href="glossaries-manual.html#dx1-21123" ><span -class="ecti-1000">658</span></a> <br /></span> +href="glossaries-user.html#dx1-26151" ><span +class="ecti-1000">761</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuseri</span></span></span>  <a -href="glossaries-manual.html#dx1-21120" ><span -class="ecti-1000">659</span></a> <br /></span> +href="glossaries-user.html#dx1-26148" ><span +class="ecti-1000">762</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuserii</span></span></span>  <a -href="glossaries-manual.html#dx1-21127" ><span -class="ecti-1000">660</span></a> <br /></span> +href="glossaries-user.html#dx1-26155" ><span +class="ecti-1000">763</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuserii</span></span></span>  <a -href="glossaries-manual.html#dx1-21126" ><span -class="ecti-1000">661</span></a> <br /></span> +href="glossaries-user.html#dx1-26154" ><span +class="ecti-1000">764</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuserii</span></span></span>  <a -href="glossaries-manual.html#dx1-21125" ><span -class="ecti-1000">662</span></a> <br /></span> +href="glossaries-user.html#dx1-26153" ><span +class="ecti-1000">765</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuseriii</span></span></span>  <a -href="glossaries-manual.html#dx1-21130" ><span -class="ecti-1000">663</span></a> <br /></span> +href="glossaries-user.html#dx1-26158" ><span +class="ecti-1000">766</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuseriii</span></span></span>  <a -href="glossaries-manual.html#dx1-21129" ><span -class="ecti-1000">664</span></a> <br /></span> +href="glossaries-user.html#dx1-26157" ><span +class="ecti-1000">767</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuseriii</span></span></span>  <a -href="glossaries-manual.html#dx1-21128" ><span -class="ecti-1000">665</span></a> <br /></span> +href="glossaries-user.html#dx1-26156" ><span +class="ecti-1000">768</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuseriv</span></span></span>  <a -href="glossaries-manual.html#dx1-21133" ><span -class="ecti-1000">666</span></a> <br /></span> +href="glossaries-user.html#dx1-26161" ><span +class="ecti-1000">769</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuseriv</span></span></span>  <a -href="glossaries-manual.html#dx1-21132" ><span -class="ecti-1000">667</span></a> <br /></span> +href="glossaries-user.html#dx1-26160" ><span +class="ecti-1000">770</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuseriv</span></span></span>  <a -href="glossaries-manual.html#dx1-21131" ><span -class="ecti-1000">668</span></a> <br /></span> +href="glossaries-user.html#dx1-26159" ><span +class="ecti-1000">771</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuserv</span></span></span>  <a -href="glossaries-manual.html#dx1-21136" ><span -class="ecti-1000">669</span></a> <br /></span> +href="glossaries-user.html#dx1-26164" ><span +class="ecti-1000">772</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuserv</span></span></span>  <a -href="glossaries-manual.html#dx1-21135" ><span -class="ecti-1000">670</span></a> <br /></span> +href="glossaries-user.html#dx1-26163" ><span +class="ecti-1000">773</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuserv</span></span></span>  <a -href="glossaries-manual.html#dx1-21134" ><span -class="ecti-1000">671</span></a> <br /></span> +href="glossaries-user.html#dx1-26162" ><span +class="ecti-1000">774</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\GLSuservi</span></span></span>  <a -href="glossaries-manual.html#dx1-21139" ><span -class="ecti-1000">672</span></a> <br /></span> +href="glossaries-user.html#dx1-26167" ><span +class="ecti-1000">775</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\Glsuservi</span></span></span>  <a -href="glossaries-manual.html#dx1-21138" ><span -class="ecti-1000">673</span></a> <br /></span> +href="glossaries-user.html#dx1-26166" ><span +class="ecti-1000">776</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\glsuservi</span></span></span>  <a -href="glossaries-manual.html#dx1-21137" ><span -class="ecti-1000">674</span></a> <br /></span> +href="glossaries-user.html#dx1-26165" ><span +class="ecti-1000">777</span></a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">H</span> <span class="index-item"><span class="ecss-1000">html </span>package  <a -href="glossaries-manual.html#dx1-23002" >675</a> <br /></span> +href="glossaries-user.html#dx1-28002" >778</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperbf</span></span></span>  <a -href="glossaries-manual.html#dx1-21036" ><span class="underline">676</span></a> <br /></span> +href="glossaries-user.html#dx1-26051" >779</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperbsf</span></span></span>  <a +href="glossaries-user.html#dx1-26059" >780</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperemph</span></span></span>  <a -href="glossaries-manual.html#dx1-21042" ><span class="underline">677</span></a> <br /></span> +href="glossaries-user.html#dx1-26057" >781</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperit</span></span></span>  <a -href="glossaries-manual.html#dx1-21038" ><span class="underline">678</span></a> <br /></span> +href="glossaries-user.html#dx1-26053" >782</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperlink</span></span></span>  <a -href="glossaries-manual.html#dx1-21043" ><span class="underline">679</span></a>, <a -href="glossaries-manual.html#dx1-23008" ><span class="underline">680</span></a> <br /></span> +href="glossaries-user.html#dx1-26058" >783</a>, <a +href="glossaries-user.html#dx1-26065" >784</a>, <a +href="glossaries-user.html#dx1-28008" >785</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypermd</span></span></span>  <a -href="glossaries-manual.html#dx1-21037" ><span class="underline">681</span></a> <br /></span> +href="glossaries-user.html#dx1-26052" >786</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperpage</span></span></span>  <a -href="glossaries-manual.html#dx1-21030" ><span class="underline">682</span></a> <br /></span> +href="glossaries-user.html#dx1-26045" >787</a> <br /></span> <span class="index-item"><span class="ecss-1000">hyperref </span>package  <a -href="glossaries-manual.html#dx1-20016" >683</a>, <a -href="glossaries-manual.html#dx1-21006" >684</a>, <a -href="glossaries-manual.html#dx1-21031" >685</a>, <a -href="glossaries-manual.html#dx1-23001" >686</a>, <a -href="glossaries-manual.html#dx1-23010" >687</a>, <a -href="glossaries-manual.html#dx1-35053" >688</a>, <a -href="glossaries-manual.html#dx1-45030" >689</a> <br /></span> +href="glossaries-user.html#dx1-5" >788</a>, <a +href="glossaries-user.html#dx1-6" >789</a>, <a +href="glossaries-user.html#dx1-25023" >790</a>, <a +href="glossaries-user.html#dx1-26010" >791</a>, <a +href="glossaries-user.html#dx1-26046" >792</a>, <a +href="glossaries-user.html#dx1-26086" >793</a>, <a +href="glossaries-user.html#dx1-28001" >794</a>, <a +href="glossaries-user.html#dx1-28010" >795</a>, <a +href="glossaries-user.html#dx1-36030" >796</a>, <a +href="glossaries-user.html#dx1-36039" >797</a>, <a +href="glossaries-user.html#dx1-42058" >798</a>, <a +href="glossaries-user.html#dx1-52044" >799</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperrm</span></span></span>  <a -href="glossaries-manual.html#dx1-21033" ><span class="underline">690</span></a>, <a -href="glossaries-manual.html#dx1-31003" ><span class="underline">691</span></a> <br /></span> +href="glossaries-user.html#dx1-26048" >800</a>, <a +href="glossaries-user.html#dx1-36014" >801</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypersc</span></span></span>  <a -href="glossaries-manual.html#dx1-21041" ><span class="underline">692</span></a> <br /></span> +href="glossaries-user.html#dx1-26056" >802</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypersf</span></span></span>  <a -href="glossaries-manual.html#dx1-21034" ><span class="underline">693</span></a> <br /></span> +href="glossaries-user.html#dx1-26049" >803</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypersl</span></span></span>  <a -href="glossaries-manual.html#dx1-21039" ><span class="underline">694</span></a> <br /></span> +href="glossaries-user.html#dx1-26054" >804</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypertarget</span></span></span>  <a -href="glossaries-manual.html#dx1-23009" ><span class="underline">695</span></a> <br /></span> +href="glossaries-user.html#dx1-28009" >805</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hypertt</span></span></span>  <a -href="glossaries-manual.html#dx1-21035" ><span class="underline">696</span></a> <br /></span> +href="glossaries-user.html#dx1-26050" >806</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\hyperup</span></span></span>  <a -href="glossaries-manual.html#dx1-21040" ><span class="underline">697</span></a> <br /></span> +href="glossaries-user.html#dx1-26055" >807</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">I</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\ifglsused</span></span></span>  <a -href="glossaries-manual.html#dx1-37014" ><span -class="ecti-1000">698</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-44015" ><span +class="ecti-1000">808</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\index</span></span></span>  <a +href="glossaries-user.html#dx1-26029" >809</a>, <a +href="glossaries-user.html#dx1-26030" >810</a>, <a +href="glossaries-user.html#dx1-26031" >811</a>, <a +href="glossaries-user.html#dx1-26042" >812</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\indexspace</span></span></span>  <a -href="glossaries-manual.html#dx1-44005" ><span class="underline">699</span></a> <br /></span> +href="glossaries-user.html#dx1-46012" >813</a>, <a +href="glossaries-user.html#dx1-51005" >814</a>, <a +href="glossaries-user.html#dx1-52034" >815</a>, <a +href="glossaries-user.html#dx1-54004" >816</a> <br /></span> <span class="index-item"><span class="ecss-1000">inputenc </span>package  <a -href="glossaries-manual.html#dx1-3039" >700</a>, <a -href="glossaries-manual.html#dx1-4008" >701</a>, <a -href="glossaries-manual.html#dx1-14095" >702</a>, <a -href="glossaries-manual.html#dx1-30007" >703</a>, <a -href="glossaries-manual.html#dx1-50004" >704</a> <br /></span> +href="glossaries-user.html#dx1-4055" >817</a>, <a +href="glossaries-user.html#dx1-5024" >818</a>, <a +href="glossaries-user.html#dx1-19127" >819</a>, <a +href="glossaries-user.html#dx1-35011" >820</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\inputencodingname</span></span></span>  <a -href="glossaries-manual.html#dx1-30008" ><span class="underline">705</span></a> <br /></span> +href="glossaries-user.html#dx1-35012" >821</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\item</span></span></span>  <a +href="glossaries-user.html#dx1-46009" >822</a>, <a +href="glossaries-user.html#dx1-46018" >823</a> <br /></span> + + + <span class="index-item"><span class="ectt-1000">itemize </span>(environment)  <a -href="glossaries-manual.html#dx1-46001" ><span class="underline">706</span></a> <br /></span> +href="glossaries-user.html#dx1-53001" >824</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">J</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\jobname</span></span></span>  <a -href="glossaries-manual.html#dx1-14017" ><span class="underline">707</span></a>, <a -href="glossaries-manual.html#dx1-14020" ><span class="underline">708</span></a> <br /></span> +href="glossaries-user.html#dx1-18015" >825</a>, <a +href="glossaries-user.html#dx1-18019" >826</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">L</span> <span class="index-item">link text  <a -href="glossaries-manual.html#dx1-21002" ><span class="underline">709</span></a>, <a -href="glossaries-manual.html#dx1-21007" ><span class="underline">710</span></a>, <a -href="glossaries-manual.html#dx1-21009" ><span class="underline">711</span></a>, <a -href="glossaries-manual.html#dx1-21050" ><span class="underline">712</span></a>, <a -href="glossaries-manual.html#dx1-22001" ><span class="underline">713</span></a>, <a -href="glossaries-manual.html#dx1-22020" ><span class="underline">714</span></a>, <a -href="glossaries-manual.html#dx1-22031" ><span class="underline">715</span></a> <br /></span> +href="glossaries-user.html#dx1-2023" ><span +class="ecbx-1000">827</span></a>, <a +href="glossaries-user.html#dx1-26003" >828</a>, <a +href="glossaries-user.html#dx1-26013" >829</a>, <a +href="glossaries-user.html#dx1-26016" >830</a>, <a +href="glossaries-user.html#dx1-26069" >831</a>, <a +href="glossaries-user.html#dx1-27002" >832</a>, <a +href="glossaries-user.html#dx1-27028" >833</a>, <a +href="glossaries-user.html#dx1-27041" >834</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\loadglsentries</span></span></span>  <a -href="glossaries-manual.html#dx1-19001" ><span -class="ecti-1000">716</span></a> <br /></span> +href="glossaries-user.html#dx1-24001" ><span +class="ecti-1000">835</span></a>, <a +href="glossaries-user.html#dx1-39038" >836</a>, <a +href="glossaries-user.html#dx1-19004" >837</a> <br /></span> <span class="index-item">location list  <span class="ecti-1000">see </span><a -href="glossaries-manual.html#dx1-20004" >number list</a> <br /></span> +href="glossaries-user.html#dx1-25005" >number list</a> <br /></span> <span class="index-item"><span class="ectt-1000">longtable </span>(environment)  <a -href="glossaries-manual.html#dx1-40002" ><span class="underline">718</span></a>, <a -href="glossaries-manual.html#dx1-40007" ><span class="underline">719</span></a>, <a -href="glossaries-manual.html#dx1-41003" ><span class="underline">720</span></a>, <a -href="glossaries-manual.html#dx1-42006" ><span class="underline">721</span></a>, <a -href="glossaries-manual.html#dx1-48006" ><span class="underline">722</span></a> <br /></span> +href="glossaries-user.html#dx1-47002" >839</a>, <a +href="glossaries-user.html#dx1-47007" >840</a>, <a +href="glossaries-user.html#dx1-48003" >841</a>, <a +href="glossaries-user.html#dx1-49006" >842</a>, <a +href="glossaries-user.html#dx1-55006" >843</a>, <a +href="glossaries-user.html#dx1-33039" >844</a> <br /></span> <span class="index-item"><span class="ecss-1000">longtable </span>package  <a -href="glossaries-manual.html#dx1-13044" >723</a>, <a -href="glossaries-manual.html#dx1-40009" >724</a> <br /></span> +href="glossaries-user.html#dx1-15033" >845</a>, <a +href="glossaries-user.html#dx1-47009" >846</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">M</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\makefirstuc</span></span></span>  <a -href="glossaries-manual.html#dx1-50002" ><span -class="ecti-1000">725</span></a>, <a -href="glossaries-manual.html#dx1-34122" ><span class="underline">726</span></a> <br /></span> +href="glossaries-user.html#dx1-27019" >847</a>, <a +href="glossaries-user.html#dx1-27021" >848</a>, <a +href="glossaries-user.html#dx1-40039" >849</a> <br /></span> +<span class="index-item">makeglossaries  <a +href="glossaries-user.html#dx1-2027" ><span +class="ecbx-1000">850</span></a> <br /></span> <span class="index-item"><span class="ectt-1000">makeglossaries</span>  <a -href="glossaries-manual.html#dx1-2006" >727</a>, <a -href="glossaries-manual.html#dx1-2009" >728</a>, <a -href="glossaries-manual.html#dx1-3006" >729</a>, <a -href="glossaries-manual.html#dx1-3012" >730</a>, <a -href="glossaries-manual.html#dx1-3019" >731</a>, <a -href="glossaries-manual.html#dx1-3028" >732</a>, <a -href="glossaries-manual.html#dx1-3035" >733</a>, <a -href="glossaries-manual.html#dx1-3040" >734</a>, <a -href="glossaries-manual.html#dx1-3042" >735</a>, <a -href="glossaries-manual.html#dx1-3043" >736</a>, <a -href="glossaries-manual.html#dx1-3046" >737</a>, <a -href="glossaries-manual.html#dx1-3051" >738</a>, <a -href="glossaries-manual.html#dx1-3053" >739</a>, <a -href="glossaries-manual.html#dx1-4009" >740</a>, <a -href="glossaries-manual.html#dx1-4011" >741</a>, <a -href="glossaries-manual.html#dx1-6008" >742</a>, <a -href="glossaries-manual.html#dx1-6012" >743</a>, <a -href="glossaries-manual.html#dx1-6016" >744</a>, <a -href="glossaries-manual.html#dx1-6017" >745</a>, <a -href="glossaries-manual.html#dx1-6020" >746</a>, <a -href="glossaries-manual.html#dx1-6023" >747</a>, <a -href="glossaries-manual.html#dx1-6025" >748</a>, <a -href="glossaries-manual.html#dx1-7001" >749</a>, <a -href="glossaries-manual.html#dx1-7005" >750</a>, <a -href="glossaries-manual.html#dx1-7006" >751</a>, <a -href="glossaries-manual.html#dx1-7007" >752</a>, <a -href="glossaries-manual.html#dx1-7008" >753</a>, <a -href="glossaries-manual.html#dx1-8004" >754</a>, <a -href="glossaries-manual.html#dx1-8018" >755</a>, <a -href="glossaries-manual.html#dx1-8020" >756</a>, <a -href="glossaries-manual.html#dx1-8022" >757</a>, <a -href="glossaries-manual.html#dx1-9017" >758</a>, <a -href="glossaries-manual.html#dx1-9019" >759</a>, <a -href="glossaries-manual.html#dx1-9021" >760</a>, <a -href="glossaries-manual.html#dx1-11021" >761</a>, <a -href="glossaries-manual.html#dx1-11022" >762</a>, <a -href="glossaries-manual.html#dx1-11040" >763</a>, <a -href="glossaries-manual.html#dx1-11041" >764</a>, <a -href="glossaries-manual.html#dx1-13096" >765</a>, <a -href="glossaries-manual.html#dx1-13098" >766</a>, <a -href="glossaries-manual.html#dx1-13104" >767</a>, <a -href="glossaries-manual.html#dx1-13106" >768</a>, <a -href="glossaries-manual.html#dx1-13115" >769</a>, <a -href="glossaries-manual.html#dx1-14006" >770</a>, <a -href="glossaries-manual.html#dx1-25004" >771</a>, <a -href="glossaries-manual.html#dx1-27002" >772</a>, <a -href="glossaries-manual.html#dx1-30003" >773</a>, <a -href="glossaries-manual.html#dx1-30012" >774</a>, <a -href="glossaries-manual.html#dx1-30014" >775</a>, <a -href="glossaries-manual.html#dx1-33005" >776</a> <br /></span> +href="glossaries-user.html#dx1-3007" >851</a>, <a +href="glossaries-user.html#dx1-3013" >852</a>, <a +href="glossaries-user.html#dx1-4007" >853</a>, <a +href="glossaries-user.html#dx1-4017" >854</a>, <a +href="glossaries-user.html#dx1-4027" >855</a>, <a +href="glossaries-user.html#dx1-4039" >856</a>, <a +href="glossaries-user.html#dx1-4048" >857</a>, <a +href="glossaries-user.html#dx1-4057" >858</a>, <a +href="glossaries-user.html#dx1-4061" >859</a>, <a +href="glossaries-user.html#dx1-4063" >860</a>, <a +href="glossaries-user.html#dx1-4068" >861</a>, <a +href="glossaries-user.html#dx1-4072" >862</a>, <a +href="glossaries-user.html#dx1-4082" >863</a>, <a +href="glossaries-user.html#dx1-4085" >864</a>, <a +href="glossaries-user.html#dx1-5026" >865</a>, <a +href="glossaries-user.html#dx1-5030" >866</a>, <a +href="glossaries-user.html#dx1-7016" >867</a>, <a +href="glossaries-user.html#dx1-7023" >868</a>, <a +href="glossaries-user.html#dx1-7029" >869</a>, <a +href="glossaries-user.html#dx1-7035" >870</a>, <a +href="glossaries-user.html#dx1-7045" >871</a>, <a +href="glossaries-user.html#dx1-7052" >872</a>, <a +href="glossaries-user.html#dx1-7054" >873</a>, <a +href="glossaries-user.html#dx1-7064" >874</a>, <a +href="glossaries-user.html#dx1-7070" >875</a>, <a +href="glossaries-user.html#dx1-7074" >876</a>, <a +href="glossaries-user.html#dx1-8002" >877</a>, <a +href="glossaries-user.html#dx1-8009" >878</a>, <a +href="glossaries-user.html#dx1-8011" >879</a>, <a +href="glossaries-user.html#dx1-8013" >880</a>, <a +href="glossaries-user.html#dx1-8015" >881</a>, <a +href="glossaries-user.html#dx1-8018" >882</a>, <a +href="glossaries-user.html#dx1-9007" >883</a>, <a +href="glossaries-user.html#dx1-9025" >884</a>, <a +href="glossaries-user.html#dx1-9029" >885</a>, <a +href="glossaries-user.html#dx1-9033" >886</a>, <a +href="glossaries-user.html#dx1-10023" >887</a>, <a +href="glossaries-user.html#dx1-10027" >888</a>, <a +href="glossaries-user.html#dx1-10031" >889</a>, <a +href="glossaries-user.html#dx1-15007" >890</a>, <a +href="glossaries-user.html#dx1-16017" >891</a>, <a +href="glossaries-user.html#dx1-16022" >892</a>, <a +href="glossaries-user.html#dx1-16026" >893</a>, <a +href="glossaries-user.html#dx1-16036" >894</a>, <a +href="glossaries-user.html#dx1-16040" >895</a>, <a +href="glossaries-user.html#dx1-19010" >896</a>, <a +href="glossaries-user.html#dx1-30005" >897</a>, <a +href="glossaries-user.html#dx1-33003" >898</a>, <a +href="glossaries-user.html#dx1-35006" >899</a>, <a +href="glossaries-user.html#dx1-35018" >900</a>, <a +href="glossaries-user.html#dx1-35022" >901</a>, <a +href="glossaries-user.html#dx1-38009" >902</a>, <a +href="glossaries-user.html#dx1-57043" >903</a>, <a +href="glossaries-user.html#dx1-57045" >904</a>, <a +href="glossaries-user.html#dx1-57076" >905</a>, <a +href="glossaries-user.html#dx1-57078" >906</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\makeglossaries</span></span></span>  <a -href="glossaries-manual.html#dx1-6011" ><span class="underline">777</span></a>, <a -href="glossaries-manual.html#dx1-11037" ><span class="underline">778</span></a>, <a -href="glossaries-manual.html#dx1-14009" ><span -class="ecti-1000">779</span></a>, <a -href="glossaries-manual.html#dx1-20009" ><span class="underline">780</span></a>, <a -href="glossaries-manual.html#dx1-20018" ><span class="underline">781</span></a>, <a -href="glossaries-manual.html#dx1-27007" ><span class="underline">782</span></a>, <a -href="glossaries-manual.html#dx1-31009" ><span class="underline">783</span></a>, <a -href="glossaries-manual.html#dx1-31010" ><span class="underline">784</span></a>, <a -href="glossaries-manual.html#dx1-31015" ><span class="underline">785</span></a>, <a -href="glossaries-manual.html#dx1-31016" ><span class="underline">786</span></a>, <a -href="glossaries-manual.html#dx1-31025" ><span class="underline">787</span></a>, <a -href="glossaries-manual.html#dx1-31026" ><span class="underline">788</span></a>, <a -href="glossaries-manual.html#dx1-31031" ><span class="underline">789</span></a>, <a -href="glossaries-manual.html#dx1-31032" ><span class="underline">790</span></a>, <a -href="glossaries-manual.html#dx1-32003" ><span class="underline">791</span></a>, <a -href="glossaries-manual.html#dx1-32004" ><span class="underline">792</span></a>, <a -href="glossaries-manual.html#dx1-33012" ><span class="underline">793</span></a> <br /></span> +href="glossaries-user.html#dx1-7021" >907</a>, <a +href="glossaries-user.html#dx1-18001" ><span +class="ecti-1000">908</span></a>, <a +href="glossaries-user.html#dx1-25013" >909</a>, <a +href="glossaries-user.html#dx1-25025" >910</a>, <a +href="glossaries-user.html#dx1-33012" >911</a>, <a +href="glossaries-user.html#dx1-36010" >912</a>, <a +href="glossaries-user.html#dx1-36022" >913</a>, <a +href="glossaries-user.html#dx1-36023" >914</a>, <a +href="glossaries-user.html#dx1-36028" >915</a>, <a +href="glossaries-user.html#dx1-36029" >916</a>, <a +href="glossaries-user.html#dx1-36053" >917</a>, <a +href="glossaries-user.html#dx1-36054" >918</a>, <a +href="glossaries-user.html#dx1-36061" >919</a>, <a +href="glossaries-user.html#dx1-36062" >920</a>, <a +href="glossaries-user.html#dx1-37004" >921</a>, <a +href="glossaries-user.html#dx1-37005" >922</a>, <a +href="glossaries-user.html#dx1-38016" >923</a>, <a +href="glossaries-user.html#dx1-57072" >924</a> <br /></span> +<span class="index-item">makeindex  <a +href="glossaries-user.html#dx1-2033" ><span +class="ecbx-1000">925</span></a> <br /></span> <span class="index-item"><span class="ectt-1000">makeindex</span>  <a -href="glossaries-manual.html#dx1-2007" >794</a>, <a -href="glossaries-manual.html#dx1-2010" >795</a>, <a -href="glossaries-manual.html#dx1-3007" >796</a>, <a -href="glossaries-manual.html#dx1-3008" >797</a>, <a -href="glossaries-manual.html#dx1-3011" >798</a>, <a -href="glossaries-manual.html#dx1-3018" >799</a>, <a -href="glossaries-manual.html#dx1-3027" >800</a>, <a -href="glossaries-manual.html#dx1-3036" >801</a>, <a -href="glossaries-manual.html#dx1-3038" >802</a>, <a -href="glossaries-manual.html#dx1-3048" >803</a>, <a -href="glossaries-manual.html#dx1-3054" >804</a>, <a -href="glossaries-manual.html#dx1-4002" >805</a>, <a -href="glossaries-manual.html#dx1-4004" >806</a>, <a -href="glossaries-manual.html#dx1-5036" >807</a>, <a -href="glossaries-manual.html#dx1-6001" >808</a>, <a -href="glossaries-manual.html#dx1-6003" >809</a>, <a -href="glossaries-manual.html#dx1-6005" >810</a>, <a -href="glossaries-manual.html#dx1-6009" >811</a>, <a -href="glossaries-manual.html#dx1-6015" >812</a>, <a -href="glossaries-manual.html#dx1-6018" >813</a>, <a -href="glossaries-manual.html#dx1-6021" >814</a>, <a -href="glossaries-manual.html#dx1-6027" >815</a>, <a -href="glossaries-manual.html#dx1-6031" >816</a>, <a -href="glossaries-manual.html#dx1-7004" >817</a>, <a -href="glossaries-manual.html#dx1-9001" >818</a>, <a -href="glossaries-manual.html#dx1-9003" >819</a>, <a -href="glossaries-manual.html#dx1-9006" >820</a>, <a -href="glossaries-manual.html#dx1-9009" >821</a>, <a -href="glossaries-manual.html#dx1-9011" >822</a>, <a -href="glossaries-manual.html#dx1-9018" >823</a>, <a -href="glossaries-manual.html#dx1-9020" >824</a>, <a -href="glossaries-manual.html#dx1-10002" >825</a>, <a -href="glossaries-manual.html#dx1-10005" >826</a>, <a -href="glossaries-manual.html#dx1-10013" >827</a>, <a -href="glossaries-manual.html#dx1-11024" >828</a>, <a -href="glossaries-manual.html#dx1-11048" >829</a>, <a -href="glossaries-manual.html#dx1-13095" >830</a>, <a -href="glossaries-manual.html#dx1-13097" >831</a>, <a -href="glossaries-manual.html#dx1-13099" >832</a>, <a -href="glossaries-manual.html#dx1-13108" >833</a>, <a -href="glossaries-manual.html#dx1-14007" >834</a>, <a -href="glossaries-manual.html#dx1-14010" >835</a>, <a -href="glossaries-manual.html#dx1-14015" >836</a>, <a -href="glossaries-manual.html#dx1-14019" >837</a>, <a -href="glossaries-manual.html#dx1-14083" >838</a>, <a -href="glossaries-manual.html#dx1-14097" >839</a>, <a -href="glossaries-manual.html#dx1-20005" >840</a>, <a -href="glossaries-manual.html#dx1-20011" >841</a>, <a -href="glossaries-manual.html#dx1-21003" >842</a>, <a -href="glossaries-manual.html#dx1-21020" >843</a>, <a -href="glossaries-manual.html#dx1-21024" >844</a>, <a -href="glossaries-manual.html#dx1-27003" >845</a>, <a -href="glossaries-manual.html#dx1-27005" >846</a>, <a -href="glossaries-manual.html#dx1-33003" >847</a>, <a -href="glossaries-manual.html#dx1-38006" >848</a>, <a -href="glossaries-manual.html#dx1-44013" >849</a>, <a -href="glossaries-manual.html#dx1-45017" >850</a> <br /></span> -<span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\MakeUppercase</span></span></span>  <a -href="glossaries-manual.html#dx1-50003" ><span class="underline">851</span></a> <br /></span> +href="glossaries-user.html#dx1-2032" >926</a>, <a +href="glossaries-user.html#dx1-3009" >927</a>, <a +href="glossaries-user.html#dx1-3015" >928</a>, <a +href="glossaries-user.html#dx1-4009" >929</a>, <a +href="glossaries-user.html#dx1-4011" >930</a>, <a +href="glossaries-user.html#dx1-4015" >931</a>, <a +href="glossaries-user.html#dx1-4025" >932</a>, <a +href="glossaries-user.html#dx1-4037" >933</a>, <a +href="glossaries-user.html#dx1-4050" >934</a>, <a +href="glossaries-user.html#dx1-4054" >935</a>, <a +href="glossaries-user.html#dx1-4076" >936</a>, <a +href="glossaries-user.html#dx1-4087" >937</a>, <a +href="glossaries-user.html#dx1-5004" >938</a>, <a +href="glossaries-user.html#dx1-5008" >939</a>, <a +href="glossaries-user.html#dx1-6039" >940</a>, <a +href="glossaries-user.html#dx1-7002" >941</a>, <a +href="glossaries-user.html#dx1-7006" >942</a>, <a +href="glossaries-user.html#dx1-7010" >943</a>, <a +href="glossaries-user.html#dx1-7018" >944</a>, <a +href="glossaries-user.html#dx1-7025" >945</a>, <a +href="glossaries-user.html#dx1-7031" >946</a>, <a +href="glossaries-user.html#dx1-7037" >947</a>, <a +href="glossaries-user.html#dx1-7041" >948</a>, <a +href="glossaries-user.html#dx1-7050" >949</a>, <a +href="glossaries-user.html#dx1-7056" >950</a>, <a +href="glossaries-user.html#dx1-7066" >951</a>, <a +href="glossaries-user.html#dx1-7078" >952</a>, <a +href="glossaries-user.html#dx1-7083" >953</a>, <a +href="glossaries-user.html#dx1-8007" >954</a>, <a +href="glossaries-user.html#dx1-10002" >955</a>, <a +href="glossaries-user.html#dx1-10005" >956</a>, <a +href="glossaries-user.html#dx1-10009" >957</a>, <a +href="glossaries-user.html#dx1-10013" >958</a>, <a +href="glossaries-user.html#dx1-10016" >959</a>, <a +href="glossaries-user.html#dx1-10025" >960</a>, <a +href="glossaries-user.html#dx1-10029" >961</a>, <a +href="glossaries-user.html#dx1-11004" >962</a>, <a +href="glossaries-user.html#dx1-11008" >963</a>, <a +href="glossaries-user.html#dx1-11019" >964</a>, <a +href="glossaries-user.html#dx1-13033" >965</a>, <a +href="glossaries-user.html#dx1-13038" >966</a>, <a +href="glossaries-user.html#dx1-15009" >967</a>, <a +href="glossaries-user.html#dx1-16020" >968</a>, <a +href="glossaries-user.html#dx1-16024" >969</a>, <a +href="glossaries-user.html#dx1-16028" >970</a>, <a +href="glossaries-user.html#dx1-16044" >971</a>, <a +href="glossaries-user.html#dx1-18003" >972</a>, <a +href="glossaries-user.html#dx1-18011" >973</a>, <a +href="glossaries-user.html#dx1-18018" >974</a>, <a +href="glossaries-user.html#dx1-19012" >975</a>, <a +href="glossaries-user.html#dx1-19089" >976</a>, <a +href="glossaries-user.html#dx1-19130" >977</a>, <a +href="glossaries-user.html#dx1-21005" >978</a>, <a +href="glossaries-user.html#dx1-25007" >979</a>, <a +href="glossaries-user.html#dx1-25016" >980</a>, <a +href="glossaries-user.html#dx1-26005" >981</a>, <a +href="glossaries-user.html#dx1-26028" >982</a>, <a +href="glossaries-user.html#dx1-26037" >983</a>, <a +href="glossaries-user.html#dx1-33005" >984</a>, <a +href="glossaries-user.html#dx1-33009" >985</a>, <a +href="glossaries-user.html#dx1-38005" >986</a>, <a +href="glossaries-user.html#dx1-45010" >987</a>, <a +href="glossaries-user.html#dx1-51014" >988</a>, <a +href="glossaries-user.html#dx1-52022" >989</a>, <a +href="glossaries-user.html#dx1-57049" >990</a>, <a +href="glossaries-user.html#dx1-57087" >991</a>, <a +href="glossaries-user.html#dx1-31005" >992</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">memoir </span>class  <a +href="glossaries-user.html#dx1-14014" >993</a> <br /></span> <span class="index-item"><span class="ecss-1000">mfirstuc </span>package  <a -href="glossaries-manual.html#dx1-50001" >852</a> <br /></span> +href="glossaries-user.html#dx1-3" >994</a>, <a +href="glossaries-user.html#dx1-4" >995</a>, <a +href="glossaries-user.html#dx1-27020" >996</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">N</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\newacronym</span></span></span>  <a -href="glossaries-manual.html#dx1-3015" ><span class="underline">853</span></a>, <a -href="glossaries-manual.html#dx1-13021" ><span class="underline">854</span></a>, <a -href="glossaries-manual.html#dx1-13081" ><span class="underline">855</span></a>, <a -href="glossaries-manual.html#dx1-13083" ><span class="underline">856</span></a>, <a -href="glossaries-manual.html#dx1-13085" ><span class="underline">857</span></a>, <a -href="glossaries-manual.html#dx1-13087" ><span class="underline">858</span></a>, <a -href="glossaries-manual.html#dx1-13092" ><span class="underline">859</span></a>, <a -href="glossaries-manual.html#dx1-34002" ><span -class="ecti-1000">860</span></a>, <a -href="glossaries-manual.html#dx1-34009" ><span class="underline">861</span></a>, <a -href="glossaries-manual.html#dx1-34011" ><span class="underline">862</span></a>, <a -href="glossaries-manual.html#dx1-34018" ><span class="underline">863</span></a>, <a -href="glossaries-manual.html#dx1-34021" ><span class="underline">864</span></a>, <a -href="glossaries-manual.html#dx1-34089" ><span class="underline">865</span></a>, <a -href="glossaries-manual.html#dx1-34094" ><span class="underline">866</span></a>, <a -href="glossaries-manual.html#dx1-34102" ><span class="underline">867</span></a>, <a -href="glossaries-manual.html#dx1-34150" ><span class="underline">868</span></a>, <a -href="glossaries-manual.html#dx1-35003" ><span class="underline">869</span></a>, <a -href="glossaries-manual.html#dx1-35019" ><span class="underline">870</span></a>, <a -href="glossaries-manual.html#dx1-35022" ><span class="underline">871</span></a>, <a -href="glossaries-manual.html#dx1-36006" ><span class="underline">872</span></a> <br /></span> +href="glossaries-user.html#dx1-4020" >997</a>, <a +href="glossaries-user.html#dx1-17009" >998</a>, <a +href="glossaries-user.html#dx1-17015" >999</a>, <a +href="glossaries-user.html#dx1-17017" >1000</a>, <a +href="glossaries-user.html#dx1-17019" >1001</a>, <a +href="glossaries-user.html#dx1-17021" >1002</a>, <a +href="glossaries-user.html#dx1-17026" >1003</a>, <a +href="glossaries-user.html#dx1-19100" >1004</a>, <a +href="glossaries-user.html#dx1-19120" >1005</a>, <a +href="glossaries-user.html#dx1-24006" >1006</a>, <a +href="glossaries-user.html#dx1-39002" ><span +class="ecti-1000">1007</span></a>, <a +href="glossaries-user.html#dx1-39032" >1008</a>, <a +href="glossaries-user.html#dx1-39039" >1009</a>, <a +href="glossaries-user.html#dx1-39040" >1010</a>, <a +href="glossaries-user.html#dx1-40018" >1011</a>, <a +href="glossaries-user.html#dx1-42003" >1012</a>, <a +href="glossaries-user.html#dx1-42019" >1013</a>, <a +href="glossaries-user.html#dx1-42027" >1014</a>, <a +href="glossaries-user.html#dx1-42034" >1015</a>, <a +href="glossaries-user.html#dx1-43006" >1016</a>, <a +href="glossaries-user.html#dx1-52038" >1017</a>, <a +href="glossaries-user.html#dx1-56023" >1018</a>, <a +href="glossaries-user.html#dx1-56026" >1019</a>, <a +href="glossaries-user.html#dx1-56029" >1020</a>, <a +href="glossaries-user.html#dx1-56032" >1021</a>, <a +href="glossaries-user.html#dx1-19003" >1022</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newdualentry</span></span></span>  <a +href="glossaries-user.html#dx1-29010" >1023</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\newglossary</span></span></span>  <a -href="glossaries-manual.html#dx1-8017" ><span class="underline">873</span></a>, <a -href="glossaries-manual.html#dx1-9016" ><span class="underline">874</span></a>, <a -href="glossaries-manual.html#dx1-13004" ><span class="underline">875</span></a>, <a -href="glossaries-manual.html#dx1-33001" ><span -class="ecti-1000">876</span></a> <br /></span> +href="glossaries-user.html#dx1-9023" >1024</a>, <a +href="glossaries-user.html#dx1-10021" >1025</a>, <a +href="glossaries-user.html#dx1-13004" >1026</a>, <a +href="glossaries-user.html#dx1-36007" >1027</a>, <a +href="glossaries-user.html#dx1-36037" >1028</a>, <a +href="glossaries-user.html#dx1-38001" ><span +class="ecti-1000">1029</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\newglossaryentry</span></span></span>  <a -href="glossaries-manual.html#dx1-3014" ><span class="underline">877</span></a>, <a -href="glossaries-manual.html#dx1-14032" ><span -class="ecti-1000">878</span></a>, <a -href="glossaries-manual.html#dx1-21001" ><span class="underline">879</span></a>, <a -href="glossaries-manual.html#dx1-21053" ><span class="underline">880</span></a>, <a -href="glossaries-manual.html#dx1-34012" ><span class="underline">881</span></a>, <a -href="glossaries-manual.html#dx1-34022" ><span class="underline">882</span></a>, <a -href="glossaries-manual.html#dx1-34036" ><span class="underline">883</span></a>, <a -href="glossaries-manual.html#dx1-35002" ><span class="underline">884</span></a>, <a -href="glossaries-manual.html#dx1-35020" ><span class="underline">885</span></a> <br /></span> +href="glossaries-user.html#dx1-2021" >1030</a>, <a +href="glossaries-user.html#dx1-4019" >1031</a>, <a +href="glossaries-user.html#dx1-15056" >1032</a>, <a +href="glossaries-user.html#dx1-16004" >1033</a>, <a +href="glossaries-user.html#dx1-19017" ><span +class="ecti-1000">1034</span></a>, <a +href="glossaries-user.html#dx1-19098" >1035</a>, <a +href="glossaries-user.html#dx1-24002" >1036</a>, <a +href="glossaries-user.html#dx1-24005" >1037</a>, <a +href="glossaries-user.html#dx1-26001" >1038</a>, <a +href="glossaries-user.html#dx1-26072" >1039</a>, <a +href="glossaries-user.html#dx1-39003" >1040</a>, <a +href="glossaries-user.html#dx1-39031" >1041</a>, <a +href="glossaries-user.html#dx1-39041" >1042</a>, <a +href="glossaries-user.html#dx1-42002" >1043</a>, <a +href="glossaries-user.html#dx1-42020" >1044</a>, <a +href="glossaries-user.html#dx1-52037" >1045</a>, <a +href="glossaries-user.html#dx1-19002" >1046</a> <br /></span> <span class="index-item"><span class="ectt-1000">\newglossaryentry </span>options<br /></span> <span class="index-subitem">    <span class="ecss-1000">access</span>  <a -href="glossaries-manual.html#dx1-49003" >886</a> <br /></span> +href="glossaries-user.html#dx1-56003" >1047</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">description</span>  <a -href="glossaries-manual.html#dx1-13065" >887</a>, <a -href="glossaries-manual.html#dx1-13068" >888</a>, <a -href="glossaries-manual.html#dx1-13073" >889</a>, <a -href="glossaries-manual.html#dx1-14033" >890</a>, <a -href="glossaries-manual.html#dx1-14038" >891</a>, <a -href="glossaries-manual.html#dx1-14049" >892</a>, <a -href="glossaries-manual.html#dx1-21115" >893</a>, <a -href="glossaries-manual.html#dx1-21116" >894</a>, <a -href="glossaries-manual.html#dx1-21117" >895</a>, <a -href="glossaries-manual.html#dx1-22011" >896</a>, <a -href="glossaries-manual.html#dx1-34043" >897</a>, <a -href="glossaries-manual.html#dx1-34083" >898</a>, <a -href="glossaries-manual.html#dx1-34093" >899</a>, <a -href="glossaries-manual.html#dx1-35013" >900</a>, <a -href="glossaries-manual.html#dx1-35046" >901</a>, <a -href="glossaries-manual.html#dx1-49018" >902</a> <br /></span> +href="glossaries-user.html#dx1-2039" >1048</a>, <a +href="glossaries-user.html#dx1-13009" >1049</a>, <a +href="glossaries-user.html#dx1-13012" >1050</a>, <a +href="glossaries-user.html#dx1-13017" >1051</a>, <a +href="glossaries-user.html#dx1-19018" >1052</a>, <a +href="glossaries-user.html#dx1-19023" >1053</a>, <a +href="glossaries-user.html#dx1-19034" >1054</a>, <a +href="glossaries-user.html#dx1-26141" >1055</a>, <a +href="glossaries-user.html#dx1-26142" >1056</a>, <a +href="glossaries-user.html#dx1-26145" >1057</a>, <a +href="glossaries-user.html#dx1-27012" >1058</a>, <a +href="glossaries-user.html#dx1-39009" >1059</a>, <a +href="glossaries-user.html#dx1-39015" >1060</a>, <a +href="glossaries-user.html#dx1-39016" >1061</a>, <a +href="glossaries-user.html#dx1-40017" >1062</a>, <a +href="glossaries-user.html#dx1-41004" >1063</a>, <a +href="glossaries-user.html#dx1-41015" >1064</a>, <a +href="glossaries-user.html#dx1-42013" >1065</a>, <a +href="glossaries-user.html#dx1-42051" >1066</a>, <a +href="glossaries-user.html#dx1-56018" >1067</a>, <a +href="glossaries-user.html#dx1-57069" >1068</a>, <a +href="glossaries-user.html#dx1-7062" >1069</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">descriptionaccess</span>  <a -href="glossaries-manual.html#dx1-49017" >903</a> <br /></span> +href="glossaries-user.html#dx1-56017" >1070</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">descriptionplural</span>  <a -href="glossaries-manual.html#dx1-14043" >904</a>, <a -href="glossaries-manual.html#dx1-22012" >905</a>, <a -href="glossaries-manual.html#dx1-49020" >906</a> <br /></span> +href="glossaries-user.html#dx1-19028" >1071</a>, <a +href="glossaries-user.html#dx1-27013" >1072</a>, <a +href="glossaries-user.html#dx1-56020" >1073</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">descriptionpluralaccess</span>  <a -href="glossaries-manual.html#dx1-49019" >907</a> <br /></span> +href="glossaries-user.html#dx1-56019" >1074</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">first</span>  <a -href="glossaries-manual.html#dx1-14053" >908</a>, <a -href="glossaries-manual.html#dx1-14065" >909</a>, <a -href="glossaries-manual.html#dx1-14067" >910</a>, <a -href="glossaries-manual.html#dx1-14068" >911</a>, <a -href="glossaries-manual.html#dx1-14070" >912</a>, <a -href="glossaries-manual.html#dx1-14073" >913</a>, <a -href="glossaries-manual.html#dx1-21013" >914</a>, <a -href="glossaries-manual.html#dx1-21052" >915</a>, <a -href="glossaries-manual.html#dx1-21056" >916</a>, <a -href="glossaries-manual.html#dx1-21070" >917</a>, <a -href="glossaries-manual.html#dx1-21085" >918</a>, <a -href="glossaries-manual.html#dx1-22009" >919</a>, <a -href="glossaries-manual.html#dx1-26015" >920</a>, <a -href="glossaries-manual.html#dx1-34041" >921</a>, <a -href="glossaries-manual.html#dx1-35008" >922</a>, <a -href="glossaries-manual.html#dx1-35042" >923</a>, <a -href="glossaries-manual.html#dx1-37003" >924</a>, <a -href="glossaries-manual.html#dx1-49008" >925</a> <br /></span> +href="glossaries-user.html#dx1-2019" >1075</a>, <a +href="glossaries-user.html#dx1-19041" >1076</a>, <a +href="glossaries-user.html#dx1-19061" >1077</a>, <a +href="glossaries-user.html#dx1-19063" >1078</a>, <a +href="glossaries-user.html#dx1-19064" >1079</a>, <a +href="glossaries-user.html#dx1-19072" >1080</a>, <a +href="glossaries-user.html#dx1-19075" >1081</a>, <a +href="glossaries-user.html#dx1-26020" >1082</a>, <a +href="glossaries-user.html#dx1-26071" >1083</a>, <a +href="glossaries-user.html#dx1-26075" >1084</a>, <a +href="glossaries-user.html#dx1-26093" >1085</a>, <a +href="glossaries-user.html#dx1-26107" >1086</a>, <a +href="glossaries-user.html#dx1-27010" >1087</a>, <a +href="glossaries-user.html#dx1-32016" >1088</a>, <a +href="glossaries-user.html#dx1-39005" >1089</a>, <a +href="glossaries-user.html#dx1-39029" >1090</a>, <a +href="glossaries-user.html#dx1-42008" >1091</a>, <a +href="glossaries-user.html#dx1-42047" >1092</a>, <a +href="glossaries-user.html#dx1-44003" >1093</a>, <a +href="glossaries-user.html#dx1-56008" >1094</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">firstaccess</span>  <a -href="glossaries-manual.html#dx1-49007" >926</a> <br /></span> +href="glossaries-user.html#dx1-56007" >1095</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">firstplural</span>  <a -href="glossaries-manual.html#dx1-14061" >927</a>, <a -href="glossaries-manual.html#dx1-14069" >928</a>, <a -href="glossaries-manual.html#dx1-14072" >929</a>, <a -href="glossaries-manual.html#dx1-15004" >930</a>, <a -href="glossaries-manual.html#dx1-21065" >931</a>, <a -href="glossaries-manual.html#dx1-21096" >932</a>, <a -href="glossaries-manual.html#dx1-22010" >933</a>, <a -href="glossaries-manual.html#dx1-26019" >934</a>, <a -href="glossaries-manual.html#dx1-35009" >935</a>, <a -href="glossaries-manual.html#dx1-35043" >936</a>, <a -href="glossaries-manual.html#dx1-49012" >937</a> <br /></span> +href="glossaries-user.html#dx1-2020" >1096</a>, <a +href="glossaries-user.html#dx1-19050" >1097</a>, <a +href="glossaries-user.html#dx1-19057" >1098</a>, <a +href="glossaries-user.html#dx1-19069" >1099</a>, <a +href="glossaries-user.html#dx1-19071" >1100</a>, <a +href="glossaries-user.html#dx1-19074" >1101</a>, <a +href="glossaries-user.html#dx1-20004" >1102</a>, <a +href="glossaries-user.html#dx1-26085" >1103</a>, <a +href="glossaries-user.html#dx1-26118" >1104</a>, <a +href="glossaries-user.html#dx1-27011" >1105</a>, <a +href="glossaries-user.html#dx1-32020" >1106</a>, <a +href="glossaries-user.html#dx1-42009" >1107</a>, <a +href="glossaries-user.html#dx1-42048" >1108</a>, <a +href="glossaries-user.html#dx1-56012" >1109</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">firstpluralaccess</span>  <a -href="glossaries-manual.html#dx1-49011" >938</a> <br /></span> +href="glossaries-user.html#dx1-56011" >1110</a> <br /></span> + + + <span class="index-subitem">    <span class="ecss-1000">format</span>  <a -href="glossaries-manual.html#dx1-21044" >939</a> <br /></span> +href="glossaries-user.html#dx1-26060" >1111</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">long</span>  <a +href="glossaries-user.html#dx1-19121" >1112</a>, <a +href="glossaries-user.html#dx1-42036" >1113</a>, <a +href="glossaries-user.html#dx1-56022" >1114</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">longaccess</span>  <a +href="glossaries-user.html#dx1-56021" >1115</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">longplural</span>  <a +href="glossaries-user.html#dx1-19122" >1116</a>, <a +href="glossaries-user.html#dx1-39012" >1117</a>, <a +href="glossaries-user.html#dx1-42038" >1118</a>, <a +href="glossaries-user.html#dx1-56028" >1119</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">longpluralaccess</span>  <a +href="glossaries-user.html#dx1-56027" >1120</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">name</span>  <a -href="glossaries-manual.html#dx1-13064" >940</a>, <a -href="glossaries-manual.html#dx1-13069" >941</a>, <a -href="glossaries-manual.html#dx1-13072" >942</a>, <a -href="glossaries-manual.html#dx1-13077" >943</a>, <a -href="glossaries-manual.html#dx1-13078" >944</a>, <a -href="glossaries-manual.html#dx1-14034" >945</a>, <a -href="glossaries-manual.html#dx1-14036" >946</a>, <a -href="glossaries-manual.html#dx1-14052" >947</a>, <a -href="glossaries-manual.html#dx1-14085" >948</a>, <a -href="glossaries-manual.html#dx1-18001" >949</a>, <a -href="glossaries-manual.html#dx1-21101" >950</a>, <a -href="glossaries-manual.html#dx1-21102" >951</a>, <a -href="glossaries-manual.html#dx1-21103" >952</a>, <a -href="glossaries-manual.html#dx1-26005" >953</a>, <a -href="glossaries-manual.html#dx1-34081" >954</a>, <a -href="glossaries-manual.html#dx1-34082" >955</a>, <a -href="glossaries-manual.html#dx1-35007" >956</a>, <a -href="glossaries-manual.html#dx1-35023" >957</a>, <a -href="glossaries-manual.html#dx1-35026" >958</a>, <a -href="glossaries-manual.html#dx1-45019" >959</a>, <a -href="glossaries-manual.html#dx1-49004" >960</a> <br /></span> +href="glossaries-user.html#dx1-2038" >1121</a>, <a +href="glossaries-user.html#dx1-5017" >1122</a>, <a +href="glossaries-user.html#dx1-13008" >1123</a>, <a +href="glossaries-user.html#dx1-13013" >1124</a>, <a +href="glossaries-user.html#dx1-13016" >1125</a>, <a +href="glossaries-user.html#dx1-13024" >1126</a>, <a +href="glossaries-user.html#dx1-13025" >1127</a>, <a +href="glossaries-user.html#dx1-16005" >1128</a>, <a +href="glossaries-user.html#dx1-19019" >1129</a>, <a +href="glossaries-user.html#dx1-19021" >1130</a>, <a +href="glossaries-user.html#dx1-19040" >1131</a>, <a +href="glossaries-user.html#dx1-19092" >1132</a>, <a +href="glossaries-user.html#dx1-19094" >1133</a>, <a +href="glossaries-user.html#dx1-23001" >1134</a>, <a +href="glossaries-user.html#dx1-26123" >1135</a>, <a +href="glossaries-user.html#dx1-26124" >1136</a>, <a +href="glossaries-user.html#dx1-26127" >1137</a>, <a +href="glossaries-user.html#dx1-32006" >1138</a>, <a +href="glossaries-user.html#dx1-41003" >1139</a>, <a +href="glossaries-user.html#dx1-41007" >1140</a>, <a +href="glossaries-user.html#dx1-41014" >1141</a>, <a +href="glossaries-user.html#dx1-42007" >1142</a>, <a +href="glossaries-user.html#dx1-42028" >1143</a>, <a +href="glossaries-user.html#dx1-42031" >1144</a>, <a +href="glossaries-user.html#dx1-52024" >1145</a>, <a +href="glossaries-user.html#dx1-56004" >1146</a>, <a +href="glossaries-user.html#dx1-57011" >1147</a>, <a +href="glossaries-user.html#dx1-57066" >1148</a>, <a +href="glossaries-user.html#dx1-31015" >1149</a>, <a +href="glossaries-user.html#dx1-32045" >1150</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nonumberlist</span>  <a -href="glossaries-manual.html#dx1-14091" >961</a> <br /></span> - - - +href="glossaries-user.html#dx1-19107" >1151</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">parent</span>  <a -href="glossaries-manual.html#dx1-14035" >962</a>, <a -href="glossaries-manual.html#dx1-14037" >963</a>, <a -href="glossaries-manual.html#dx1-14042" >964</a>, <a -href="glossaries-manual.html#dx1-17001" >965</a> <br /></span> +href="glossaries-user.html#dx1-19020" >1152</a>, <a +href="glossaries-user.html#dx1-19022" >1153</a>, <a +href="glossaries-user.html#dx1-19027" >1154</a>, <a +href="glossaries-user.html#dx1-22001" >1155</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">plural</span>  <a -href="glossaries-manual.html#dx1-14057" >966</a>, <a -href="glossaries-manual.html#dx1-14064" >967</a>, <a -href="glossaries-manual.html#dx1-14071" >968</a>, <a -href="glossaries-manual.html#dx1-15002" >969</a>, <a -href="glossaries-manual.html#dx1-15003" >970</a>, <a -href="glossaries-manual.html#dx1-18005" >971</a>, <a -href="glossaries-manual.html#dx1-21064" >972</a>, <a -href="glossaries-manual.html#dx1-21091" >973</a>, <a -href="glossaries-manual.html#dx1-22008" >974</a>, <a -href="glossaries-manual.html#dx1-26011" >975</a>, <a -href="glossaries-manual.html#dx1-35011" >976</a>, <a -href="glossaries-manual.html#dx1-35025" >977</a>, <a -href="glossaries-manual.html#dx1-35045" >978</a>, <a -href="glossaries-manual.html#dx1-49010" >979</a> <br /></span> +href="glossaries-user.html#dx1-19052" >1156</a>, <a +href="glossaries-user.html#dx1-19060" >1157</a>, <a +href="glossaries-user.html#dx1-19073" >1158</a>, <a +href="glossaries-user.html#dx1-20002" >1159</a>, <a +href="glossaries-user.html#dx1-20003" >1160</a>, <a +href="glossaries-user.html#dx1-23009" >1161</a>, <a +href="glossaries-user.html#dx1-26084" >1162</a>, <a +href="glossaries-user.html#dx1-26113" >1163</a>, <a +href="glossaries-user.html#dx1-27009" >1164</a>, <a +href="glossaries-user.html#dx1-32012" >1165</a>, <a +href="glossaries-user.html#dx1-42011" >1166</a>, <a +href="glossaries-user.html#dx1-42030" >1167</a>, <a +href="glossaries-user.html#dx1-42050" >1168</a>, <a +href="glossaries-user.html#dx1-56010" >1169</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">pluralaccess</span>  <a -href="glossaries-manual.html#dx1-49009" >980</a> <br /></span> +href="glossaries-user.html#dx1-56009" >1170</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">see</span>  <a -href="glossaries-manual.html#dx1-14093" >981</a>, <a -href="glossaries-manual.html#dx1-14094" >982</a>, <a -href="glossaries-manual.html#dx1-21028" >983</a>, <a -href="glossaries-manual.html#dx1-25007" >984</a>, <a -href="glossaries-manual.html#dx1-25008" >985</a>, <a -href="glossaries-manual.html#dx1-25009" >986</a>, <a -href="glossaries-manual.html#dx1-2004" >987</a> <br /></span> +href="glossaries-user.html#dx1-15055" >1171</a>, <a +href="glossaries-user.html#dx1-15059" >1172</a>, <a +href="glossaries-user.html#dx1-19114" >1173</a>, <a +href="glossaries-user.html#dx1-19115" >1174</a>, <a +href="glossaries-user.html#dx1-26043" >1175</a>, <a +href="glossaries-user.html#dx1-30011" >1176</a>, <a +href="glossaries-user.html#dx1-30012" >1177</a>, <a +href="glossaries-user.html#dx1-30014" >1178</a>, <a +href="glossaries-user.html#dx1-30026" >1179</a>, <a +href="glossaries-user.html#dx1-31001" >1180</a>, <a +href="glossaries-user.html#dx1-3003" >1181</a>, <a +href="glossaries-user.html#dx1-31008" >1182</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">short</span>  <a +href="glossaries-user.html#dx1-19123" >1183</a>, <a +href="glossaries-user.html#dx1-42035" >1184</a>, <a +href="glossaries-user.html#dx1-56025" >1185</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">shortaccess</span>  <a +href="glossaries-user.html#dx1-56024" >1186</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">shortplural</span>  <a +href="glossaries-user.html#dx1-19124" >1187</a>, <a +href="glossaries-user.html#dx1-39011" >1188</a>, <a +href="glossaries-user.html#dx1-42037" >1189</a>, <a +href="glossaries-user.html#dx1-56031" >1190</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">shortpluralaccess</span>  <a +href="glossaries-user.html#dx1-56030" >1191</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">sort</span>  <a -href="glossaries-manual.html#dx1-11046" >988</a>, <a -href="glossaries-manual.html#dx1-13075" >989</a>, <a -href="glossaries-manual.html#dx1-14082" >990</a>, <a -href="glossaries-manual.html#dx1-14096" >991</a>, <a -href="glossaries-manual.html#dx1-18004" >992</a>, <a -href="glossaries-manual.html#dx1-34088" >993</a>, <a -href="glossaries-manual.html#dx1-34101" >994</a>, <a -href="glossaries-manual.html#dx1-45018" >995</a>, <a -href="glossaries-manual.html#dx1-45020" >996</a> <br /></span> +href="glossaries-user.html#dx1-13019" >1192</a>, <a +href="glossaries-user.html#dx1-16003" >1193</a>, <a +href="glossaries-user.html#dx1-16006" >1194</a>, <a +href="glossaries-user.html#dx1-16008" >1195</a>, <a +href="glossaries-user.html#dx1-16010" >1196</a>, <a +href="glossaries-user.html#dx1-19087" >1197</a>, <a +href="glossaries-user.html#dx1-19093" >1198</a>, <a +href="glossaries-user.html#dx1-19097" >1199</a>, <a +href="glossaries-user.html#dx1-19128" >1200</a>, <a +href="glossaries-user.html#dx1-23005" >1201</a>, <a +href="glossaries-user.html#dx1-52023" >1202</a>, <a +href="glossaries-user.html#dx1-52025" >1203</a>, <a +href="glossaries-user.html#dx1-57010" >1204</a>, <a +href="glossaries-user.html#dx1-57083" >1205</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">symbol</span>  <a -href="glossaries-manual.html#dx1-13066" >997</a>, <a -href="glossaries-manual.html#dx1-13070" >998</a>, <a -href="glossaries-manual.html#dx1-13074" >999</a>, <a -href="glossaries-manual.html#dx1-14074" >1000</a>, <a -href="glossaries-manual.html#dx1-14081" >1001</a>, <a -href="glossaries-manual.html#dx1-21108" >1002</a>, <a -href="glossaries-manual.html#dx1-21109" >1003</a>, <a -href="glossaries-manual.html#dx1-21110" >1004</a>, <a -href="glossaries-manual.html#dx1-22013" >1005</a>, <a -href="glossaries-manual.html#dx1-22018" >1006</a>, <a -href="glossaries-manual.html#dx1-22030" >1007</a>, <a -href="glossaries-manual.html#dx1-34044" >1008</a>, <a -href="glossaries-manual.html#dx1-34069" >1009</a>, <a -href="glossaries-manual.html#dx1-34084" >1010</a>, <a -href="glossaries-manual.html#dx1-35012" >1011</a>, <a -href="glossaries-manual.html#dx1-35028" >1012</a>, <a -href="glossaries-manual.html#dx1-35047" >1013</a>, <a -href="glossaries-manual.html#dx1-49014" >1014</a> <br /></span> +href="glossaries-user.html#dx1-2040" >1206</a>, <a +href="glossaries-user.html#dx1-13010" >1207</a>, <a +href="glossaries-user.html#dx1-13014" >1208</a>, <a +href="glossaries-user.html#dx1-13018" >1209</a>, <a +href="glossaries-user.html#dx1-19076" >1210</a>, <a +href="glossaries-user.html#dx1-19086" >1211</a>, <a +href="glossaries-user.html#dx1-26132" >1212</a>, <a +href="glossaries-user.html#dx1-26133" >1213</a>, <a +href="glossaries-user.html#dx1-26136" >1214</a>, <a +href="glossaries-user.html#dx1-27014" >1215</a>, <a +href="glossaries-user.html#dx1-27025" >1216</a>, <a +href="glossaries-user.html#dx1-27039" >1217</a>, <a +href="glossaries-user.html#dx1-41005" >1218</a>, <a +href="glossaries-user.html#dx1-41016" >1219</a>, <a +href="glossaries-user.html#dx1-42012" >1220</a>, <a +href="glossaries-user.html#dx1-42033" >1221</a>, <a +href="glossaries-user.html#dx1-42052" >1222</a>, <a +href="glossaries-user.html#dx1-56014" >1223</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">symbolaccess</span>  <a -href="glossaries-manual.html#dx1-49013" >1015</a> <br /></span> +href="glossaries-user.html#dx1-56013" >1224</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">symbolplural</span>  <a -href="glossaries-manual.html#dx1-14075" >1016</a>, <a -href="glossaries-manual.html#dx1-22014" >1017</a>, <a -href="glossaries-manual.html#dx1-49016" >1018</a> <br /></span> +href="glossaries-user.html#dx1-19080" >1225</a>, <a +href="glossaries-user.html#dx1-27015" >1226</a>, <a +href="glossaries-user.html#dx1-56016" >1227</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">symbolpluralaccess</span>  <a -href="glossaries-manual.html#dx1-49015" >1019</a> <br /></span> +href="glossaries-user.html#dx1-56015" >1228</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">text</span>  <a -href="glossaries-manual.html#dx1-13076" >1020</a>, <a -href="glossaries-manual.html#dx1-13079" >1021</a>, <a -href="glossaries-manual.html#dx1-14050" >1022</a>, <a -href="glossaries-manual.html#dx1-14056" >1023</a>, <a -href="glossaries-manual.html#dx1-14060" >1024</a>, <a -href="glossaries-manual.html#dx1-21014" >1025</a>, <a -href="glossaries-manual.html#dx1-21051" >1026</a>, <a -href="glossaries-manual.html#dx1-21055" >1027</a>, <a -href="glossaries-manual.html#dx1-21071" >1028</a>, <a -href="glossaries-manual.html#dx1-21077" >1029</a>, <a -href="glossaries-manual.html#dx1-22007" >1030</a>, <a -href="glossaries-manual.html#dx1-26008" >1031</a>, <a -href="glossaries-manual.html#dx1-34042" >1032</a>, <a -href="glossaries-manual.html#dx1-35010" >1033</a>, <a -href="glossaries-manual.html#dx1-35024" >1034</a>, <a -href="glossaries-manual.html#dx1-35027" >1035</a>, <a -href="glossaries-manual.html#dx1-35044" >1036</a>, <a -href="glossaries-manual.html#dx1-37005" >1037</a>, <a -href="glossaries-manual.html#dx1-49006" >1038</a> <br /></span> +href="glossaries-user.html#dx1-13023" >1229</a>, <a +href="glossaries-user.html#dx1-13026" >1230</a>, <a +href="glossaries-user.html#dx1-19038" >1231</a>, <a +href="glossaries-user.html#dx1-19044" >1232</a>, <a +href="glossaries-user.html#dx1-19055" >1233</a>, <a +href="glossaries-user.html#dx1-26021" >1234</a>, <a +href="glossaries-user.html#dx1-26070" >1235</a>, <a +href="glossaries-user.html#dx1-26074" >1236</a>, <a +href="glossaries-user.html#dx1-26094" >1237</a>, <a +href="glossaries-user.html#dx1-26100" >1238</a>, <a +href="glossaries-user.html#dx1-27008" >1239</a>, <a +href="glossaries-user.html#dx1-32009" >1240</a>, <a +href="glossaries-user.html#dx1-39006" >1241</a>, <a +href="glossaries-user.html#dx1-39030" >1242</a>, <a +href="glossaries-user.html#dx1-42010" >1243</a>, <a +href="glossaries-user.html#dx1-42029" >1244</a>, <a +href="glossaries-user.html#dx1-42032" >1245</a>, <a +href="glossaries-user.html#dx1-42049" >1246</a>, <a +href="glossaries-user.html#dx1-44005" >1247</a>, <a +href="glossaries-user.html#dx1-56006" >1248</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">textaccess</span>  <a -href="glossaries-manual.html#dx1-49005" >1039</a> <br /></span> +href="glossaries-user.html#dx1-56005" >1249</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">type</span>  <a -href="glossaries-manual.html#dx1-14086" >1040</a>, <a -href="glossaries-manual.html#dx1-19002" >1041</a> <br /></span> +href="glossaries-user.html#dx1-19099" >1250</a>, <a +href="glossaries-user.html#dx1-24003" >1251</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">user1</span>  <a -href="glossaries-manual.html#dx1-1001" >1042</a>, <a -href="glossaries-manual.html#dx1-14089" >1043</a>, <a -href="glossaries-manual.html#dx1-21122" >1044</a>, <a -href="glossaries-manual.html#dx1-35030" >1045</a>, <a -href="glossaries-manual.html#x1-480002.13.3" >1046</a>, <a -href="glossaries-manual.html#dx1-48003" >1047</a>, <a -href="glossaries-manual.html#dx1-48004" >1048</a> <br /></span> +href="glossaries-user.html#dx1-1001" >1252</a>, <a +href="glossaries-user.html#dx1-19101" >1253</a>, <a +href="glossaries-user.html#dx1-26150" >1254</a>, <a +href="glossaries-user.html#x1-5500016.3" >1255</a>, <a +href="glossaries-user.html#dx1-55003" >1256</a>, <a +href="glossaries-user.html#dx1-55004" >1257</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">user2</span>  <a -href="glossaries-manual.html#dx1-35031" >1049</a>, <a -href="glossaries-manual.html#dx1-48005" >1050</a> <br /></span> +href="glossaries-user.html#dx1-19103" >1258</a>, <a +href="glossaries-user.html#dx1-55005" >1259</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">user3</span>  <a -href="glossaries-manual.html#dx1-35032" >1051</a> <br /></span> +href="glossaries-user.html#dx1-19104" >1260</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">user4</span>  <a -href="glossaries-manual.html#dx1-35033" >1052</a> <br /></span> +href="glossaries-user.html#dx1-19105" >1261</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user5</span>  <a +href="glossaries-user.html#dx1-19106" >1262</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">user6</span>  <a -href="glossaries-manual.html#dx1-1002" >1053</a>, <a -href="glossaries-manual.html#dx1-14090" >1054</a>, <a -href="glossaries-manual.html#x1-480002.13.3" >1055</a> <br /></span> +href="glossaries-user.html#dx1-1002" >1263</a>, <a +href="glossaries-user.html#dx1-19102" >1264</a>, <a +href="glossaries-user.html#x1-5500016.3" >1265</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\newglossarystyle</span></span></span>  <a -href="glossaries-manual.html#dx1-38027" ><span class="underline">1056</span></a>, <a -href="glossaries-manual.html#dx1-45001" ><span -class="ecti-1000">1057</span></a> <br /></span> +href="glossaries-user.html#dx1-45031" >1266</a>, <a +href="glossaries-user.html#dx1-52001" ><span +class="ecti-1000">1267</span></a>, <a +href="glossaries-user.html#dx1-52031" >1268</a>, <a +href="glossaries-user.html#dx1-54002" >1269</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\newline</span></span></span>  <a -href="glossaries-manual.html#dx1-14041" ><span class="underline">1058</span></a>, <a -href="glossaries-manual.html#dx1-38021" ><span class="underline">1059</span></a> <br /></span> +href="glossaries-user.html#dx1-19026" >1270</a>, <a +href="glossaries-user.html#dx1-45025" >1271</a> <br /></span> <span class="index-item"><span class="ecss-1000">ngerman </span>package  <a -href="glossaries-manual.html#dx1-5007" >1060</a>, <a -href="glossaries-manual.html#dx1-29009" >1061</a> <br /></span> +href="glossaries-user.html#dx1-6007" >1272</a>, <a +href="glossaries-user.html#dx1-34013" >1273</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\nohyperpage</span></span></span>  <a -href="glossaries-manual.html#dx1-20017" ><span class="underline">1062</span></a> <br /></span> +href="glossaries-user.html#dx1-25024" >1274</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\noist</span></span></span>  <a -href="glossaries-manual.html#dx1-3044" ><span class="underline">1063</span></a>, <a -href="glossaries-manual.html#dx1-14016" ><span -class="ecti-1000">1064</span></a>, <a -href="glossaries-manual.html#dx1-20010" ><span class="underline">1065</span></a>, <a -href="glossaries-manual.html#dx1-20019" ><span class="underline">1066</span></a>, <a -href="glossaries-manual.html#dx1-29013" ><span class="underline">1067</span></a>, <a -href="glossaries-manual.html#dx1-30011" ><span class="underline">1068</span></a>, <a -href="glossaries-manual.html#dx1-31008" ><span class="underline">1069</span></a>, <a -href="glossaries-manual.html#dx1-31014" ><span class="underline">1070</span></a>, <a -href="glossaries-manual.html#dx1-31024" ><span class="underline">1071</span></a>, <a -href="glossaries-manual.html#dx1-31030" ><span class="underline">1072</span></a>, <a -href="glossaries-manual.html#dx1-32002" ><span class="underline">1073</span></a> <br /></span> +href="glossaries-user.html#dx1-4064" >1275</a>, <a +href="glossaries-user.html#dx1-18012" ><span +class="ecti-1000">1276</span></a>, <a +href="glossaries-user.html#dx1-25014" >1277</a>, <a +href="glossaries-user.html#dx1-25026" >1278</a>, <a +href="glossaries-user.html#dx1-34019" >1279</a>, <a +href="glossaries-user.html#dx1-35016" >1280</a>, <a +href="glossaries-user.html#dx1-36021" >1281</a>, <a +href="glossaries-user.html#dx1-36027" >1282</a>, <a +href="glossaries-user.html#dx1-36052" >1283</a>, <a +href="glossaries-user.html#dx1-36060" >1284</a>, <a +href="glossaries-user.html#dx1-37003" >1285</a>, <a +href="glossaries-user.html#dx1-19016" >1286</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\nopostdesc</span></span></span>  <a -href="glossaries-manual.html#dx1-14039" ><span -class="ecti-1000">1074</span></a>, <a -href="glossaries-manual.html#dx1-17002" ><span class="underline">1075</span></a>, <a -href="glossaries-manual.html#dx1-18002" ><span class="underline">1076</span></a>, <a -href="glossaries-manual.html#dx1-38032" ><span class="underline">1077</span></a> <br /></span> +href="glossaries-user.html#dx1-19024" ><span +class="ecti-1000">1287</span></a>, <a +href="glossaries-user.html#dx1-22002" >1288</a>, <a +href="glossaries-user.html#dx1-23002" >1289</a>, <a +href="glossaries-user.html#dx1-45035" >1290</a> <br /></span> <span class="index-item">number list  <a -href="glossaries-manual.html#dx1-3016" ><span class="underline">1078</span></a>, <a -href="glossaries-manual.html#dx1-3026" ><span class="underline">1079</span></a>, <a -href="glossaries-manual.html#dx1-6024" ><span class="underline">1080</span></a>, <a -href="glossaries-manual.html#dx1-13060" ><span class="underline">1081</span></a>, <a -href="glossaries-manual.html#dx1-13062" ><span class="underline">1082</span></a>, <a -href="glossaries-manual.html#dx1-14024" ><span class="underline">1083</span></a>, <a -href="glossaries-manual.html#dx1-14030" ><span class="underline">1084</span></a>, <a -href="glossaries-manual.html#dx1-14031" ><span class="underline">1085</span></a>, <a -href="glossaries-manual.html#dx1-14092" ><span class="underline">1086</span></a>, <a -href="glossaries-manual.html#dx1-16001" ><span class="underline">1087</span></a>, <a -href="glossaries-manual.html#dx1-18003" ><span class="underline">1088</span></a>, <a -href="glossaries-manual.html#dx1-20001" ><span class="underline">1089</span></a>, <a -href="glossaries-manual.html#dx1-21005" ><span class="underline">1090</span></a>, <a -href="glossaries-manual.html#dx1-25013" ><span class="underline">1091</span></a>, <a -href="glossaries-manual.html#dx1-31017" ><span class="underline">1092</span></a>, <a -href="glossaries-manual.html#dx1-31027" ><span class="underline">1093</span></a>, <a -href="glossaries-manual.html#dx1-33002" ><span class="underline">1094</span></a>, <a -href="glossaries-manual.html#dx1-39009" ><span class="underline">1095</span></a>, <a -href="glossaries-manual.html#dx1-39028" ><span class="underline">1096</span></a>, <a -href="glossaries-manual.html#dx1-40010" ><span class="underline">1097</span></a>, <a -href="glossaries-manual.html#dx1-40020" ><span class="underline">1098</span></a>, <a -href="glossaries-manual.html#dx1-41010" ><span class="underline">1099</span></a>, <a -href="glossaries-manual.html#dx1-41020" ><span class="underline">1100</span></a>, <a -href="glossaries-manual.html#dx1-42016" ><span class="underline">1101</span></a>, <a -href="glossaries-manual.html#dx1-42026" ><span class="underline">1102</span></a>, <a -href="glossaries-manual.html#dx1-43013" ><span class="underline">1103</span></a>, <a -href="glossaries-manual.html#dx1-43023" ><span class="underline">1104</span></a>, <a -href="glossaries-manual.html#dx1-46008" ><span class="underline">1105</span></a> <br /></span> +href="glossaries-user.html#dx1-2026" >1291</a>, <a +href="glossaries-user.html#dx1-2034" ><span +class="ecbx-1000">1292</span></a>, <a +href="glossaries-user.html#dx1-4022" >1293</a>, <a +href="glossaries-user.html#dx1-4035" >1294</a>, <a +href="glossaries-user.html#dx1-7072" >1295</a>, <a +href="glossaries-user.html#dx1-15050" >1296</a>, <a +href="glossaries-user.html#dx1-15053" >1297</a>, <a +href="glossaries-user.html#dx1-15064" >1298</a>, <a +href="glossaries-user.html#dx1-18025" >1299</a>, <a +href="glossaries-user.html#dx1-18033" >1300</a>, <a +href="glossaries-user.html#dx1-18035" >1301</a>, <a +href="glossaries-user.html#dx1-19109" >1302</a>, <a +href="glossaries-user.html#dx1-19112" >1303</a>, <a +href="glossaries-user.html#dx1-19117" >1304</a>, <a +href="glossaries-user.html#dx1-21003" >1305</a>, <a +href="glossaries-user.html#dx1-23004" >1306</a>, <a +href="glossaries-user.html#dx1-25002" >1307</a>, <a +href="glossaries-user.html#dx1-26009" >1308</a>, <a +href="glossaries-user.html#dx1-30020" >1309</a>, <a +href="glossaries-user.html#dx1-30022" >1310</a>, <a +href="glossaries-user.html#dx1-30024" >1311</a>, <a +href="glossaries-user.html#dx1-30029" >1312</a>, <a +href="glossaries-user.html#dx1-36003" >1313</a>, <a +href="glossaries-user.html#dx1-36045" >1314</a>, <a +href="glossaries-user.html#dx1-36056" >1315</a>, <a +href="glossaries-user.html#dx1-38003" >1316</a>, <a +href="glossaries-user.html#dx1-46011" >1317</a>, <a +href="glossaries-user.html#dx1-46033" >1318</a>, <a +href="glossaries-user.html#dx1-47011" >1319</a>, <a +href="glossaries-user.html#dx1-47022" >1320</a>, <a +href="glossaries-user.html#dx1-48011" >1321</a>, <a +href="glossaries-user.html#dx1-48022" >1322</a>, <a +href="glossaries-user.html#dx1-49017" >1323</a>, <a +href="glossaries-user.html#dx1-49028" >1324</a>, <a +href="glossaries-user.html#dx1-50014" >1325</a>, <a +href="glossaries-user.html#dx1-50025" >1326</a>, <a +href="glossaries-user.html#dx1-53009" >1327</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\numberline</span></span></span>  <a +href="glossaries-user.html#dx1-14006" >1328</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">O</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\oldacronym</span></span></span>  <a -href="glossaries-manual.html#dx1-36004" ><span -class="ecti-1000">1106</span></a>, <a -href="glossaries-manual.html#dx1-36007" ><span class="underline">1107</span></a> <br /></span> +href="glossaries-user.html#dx1-43004" ><span +class="ecti-1000">1329</span></a>, <a +href="glossaries-user.html#dx1-43007" >1330</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">P</span> + + + <span class="index-item">package options:<br /></span> <span class="index-subitem">    <span class="ecss-1000">acronym</span>  <a -href="glossaries-manual.html#dx1-5016" ><span class="underline">1108</span></a>, <a -href="glossaries-manual.html#dx1-8012" ><span class="underline">1109</span></a>, <a -href="glossaries-manual.html#dx1-8016" ><span class="underline">1110</span></a>, <a -href="glossaries-manual.html#dx1-9010" ><span class="underline">1111</span></a>, <a -href="glossaries-manual.html#dx1-9015" ><span class="underline">1112</span></a>, <a -href="glossaries-manual.html#dx1-13003" ><span class="underline">1113</span></a>, <a -href="glossaries-manual.html#dx1-13013" ><span class="underline">1114</span></a>, <a -href="glossaries-manual.html#dx1-13014" ><span class="underline">1115</span></a>, <a -href="glossaries-manual.html#dx1-13038" ><span class="underline">1116</span></a>, <a -href="glossaries-manual.html#dx1-13039" ><span class="underline">1117</span></a>, <a -href="glossaries-manual.html#dx1-14088" ><span class="underline">1118</span></a>, <a -href="glossaries-manual.html#dx1-19003" ><span class="underline">1119</span></a>, <a -href="glossaries-manual.html#dx1-19004" ><span class="underline">1120</span></a>, <a -href="glossaries-manual.html#dx1-19007" ><span class="underline">1121</span></a>, <a -href="glossaries-manual.html#dx1-33007" ><span class="underline">1122</span></a>, <a -href="glossaries-manual.html#dx1-33008" ><span class="underline">1123</span></a>, <a -href="glossaries-manual.html#dx1-33010" ><span class="underline">1124</span></a>, <a -href="glossaries-manual.html#dx1-34005" ><span class="underline">1125</span></a>, <a -href="glossaries-manual.html#dx1-13019" ><span class="underline">1126</span></a>, <a -href="glossaries-manual.html#dx1-13036" ><span class="underline">1127</span></a>, <a -href="glossaries-manual.html#dx1-19006" ><span class="underline">1128</span></a> <br /></span> +href="glossaries-user.html#dx1-6016" >1331</a>, <a +href="glossaries-user.html#dx1-9018" >1332</a>, <a +href="glossaries-user.html#dx1-9022" >1333</a>, <a +href="glossaries-user.html#dx1-10014" >1334</a>, <a +href="glossaries-user.html#dx1-10020" >1335</a>, <a +href="glossaries-user.html#dx1-13003" >1336</a>, <a +href="glossaries-user.html#dx1-14025" >1337</a>, <a +href="glossaries-user.html#dx1-14026" >1338</a>, <a +href="glossaries-user.html#dx1-17001" >1339</a>, <a +href="glossaries-user.html#dx1-17002" >1340</a>, <a +href="glossaries-user.html#dx1-17013" >1341</a>, <a +href="glossaries-user.html#dx1-24007" >1342</a>, <a +href="glossaries-user.html#dx1-24008" >1343</a>, <a +href="glossaries-user.html#dx1-24013" >1344</a>, <a +href="glossaries-user.html#dx1-29009" >1345</a>, <a +href="glossaries-user.html#dx1-38011" >1346</a>, <a +href="glossaries-user.html#dx1-38012" >1347</a>, <a +href="glossaries-user.html#dx1-38014" >1348</a>, <a +href="glossaries-user.html#dx1-39034" >1349</a>, <a +href="glossaries-user.html#dx1-14023" >1350</a>, <a +href="glossaries-user.html#dx1-17007" >1351</a>, <a +href="glossaries-user.html#dx1-24012" >1352</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">acronymlists</span>  <a -href="glossaries-manual.html#dx1-13023" ><span class="underline">1129</span></a>, <a -href="glossaries-manual.html#dx1-13024" ><span class="underline">1130</span></a>, <a -href="glossaries-manual.html#dx1-33011" ><span class="underline">1131</span></a>, <a -href="glossaries-manual.html#dx1-34006" ><span class="underline">1132</span></a> <br /></span> +href="glossaries-user.html#dx1-17011" >1353</a>, <a +href="glossaries-user.html#dx1-17012" >1354</a>, <a +href="glossaries-user.html#dx1-38015" >1355</a>, <a +href="glossaries-user.html#dx1-39035" >1356</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">compatible-2.07</span>  <a +href="glossaries-user.html#dx1-18014" >1357</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">counter</span>  <a -href="glossaries-manual.html#dx1-13061" ><span class="underline">1133</span></a>, <a -href="glossaries-manual.html#dx1-14025" ><span class="underline">1134</span></a>, <a -href="glossaries-manual.html#dx1-20003" ><span class="underline">1135</span></a> <br /></span> +href="glossaries-user.html#dx1-15061" >1358</a>, <a +href="glossaries-user.html#dx1-18026" >1359</a>, <a +href="glossaries-user.html#dx1-25004" >1360</a>, <a +href="glossaries-user.html#dx1-36006" >1361</a>, <a +href="glossaries-user.html#dx1-36036" >1362</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">page</span>  <a +href="glossaries-user.html#dx1-15062" >1363</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">counterwithin</span>  <a +href="glossaries-user.html#dx1-15012" >1364</a>, <a +href="glossaries-user.html#dx1-15016" >1365</a>, <a +href="glossaries-user.html#dx1-45002" >1366</a>, <a +href="glossaries-user.html#dx1-52041" >1367</a>, <a +href="glossaries-user.html#dx1-53013" >1368</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">description</span>  <a -href="glossaries-manual.html#dx1-13080" ><span class="underline">1136</span></a>, <a -href="glossaries-manual.html#dx1-34015" ><span class="underline">1137</span></a>, <a -href="glossaries-manual.html#dx1-34025" ><span class="underline">1138</span></a>, <a -href="glossaries-manual.html#dx1-34045" ><span class="underline">1139</span></a>, <a -href="glossaries-manual.html#dx1-34047" ><span class="underline">1140</span></a>, <a -href="glossaries-manual.html#dx1-34049" ><span class="underline">1141</span></a>, <a -href="glossaries-manual.html#dx1-34063" ><span class="underline">1142</span></a>, <a -href="glossaries-manual.html#dx1-34066" ><span class="underline">1143</span></a>, <a -href="glossaries-manual.html#dx1-34080" ><span class="underline">1144</span></a>, <a -href="glossaries-manual.html#dx1-34085" ><span class="underline">1145</span></a>, <a -href="glossaries-manual.html#dx1-34087" ><span class="underline">1146</span></a>, <a -href="glossaries-manual.html#dx1-34090" ><span class="underline">1147</span></a>, <a -href="glossaries-manual.html#dx1-34111" ><span class="underline">1148</span></a>, <a -href="glossaries-manual.html#dx1-34117" ><span class="underline">1149</span></a>, <a -href="glossaries-manual.html#dx1-34131" ><span class="underline">1150</span></a>, <a -href="glossaries-manual.html#dx1-35054" ><span class="underline">1151</span></a> <br /></span> +href="glossaries-user.html#dx1-17014" >1369</a>, <a +href="glossaries-user.html#dx1-39010" >1370</a>, <a +href="glossaries-user.html#dx1-39014" >1371</a>, <a +href="glossaries-user.html#dx1-39049" >1372</a>, <a +href="glossaries-user.html#dx1-40001" >1373</a>, <a +href="glossaries-user.html#dx1-40014" >1374</a>, <a +href="glossaries-user.html#dx1-40024" >1375</a>, <a +href="glossaries-user.html#dx1-40031" >1376</a>, <a +href="glossaries-user.html#dx1-40047" >1377</a>, <a +href="glossaries-user.html#dx1-41006" >1378</a>, <a +href="glossaries-user.html#dx1-41009" >1379</a>, <a +href="glossaries-user.html#dx1-41017" >1380</a>, <a +href="glossaries-user.html#dx1-41020" >1381</a>, <a +href="glossaries-user.html#dx1-41022" >1382</a>, <a +href="glossaries-user.html#dx1-42061" >1383</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">dua</span>  <a -href="glossaries-manual.html#dx1-13091" ><span class="underline">1152</span></a>, <a -href="glossaries-manual.html#dx1-34016" ><span class="underline">1153</span></a>, <a -href="glossaries-manual.html#dx1-34048" ><span class="underline">1154</span></a>, <a -href="glossaries-manual.html#dx1-34053" ><span class="underline">1155</span></a>, <a -href="glossaries-manual.html#dx1-34062" ><span class="underline">1156</span></a>, <a -href="glossaries-manual.html#dx1-34074" ><span class="underline">1157</span></a>, <a -href="glossaries-manual.html#dx1-34075" ><span class="underline">1158</span></a>, <a -href="glossaries-manual.html#dx1-34096" ><span class="underline">1159</span></a>, <a -href="glossaries-manual.html#dx1-34130" ><span class="underline">1160</span></a> <br /></span> +href="glossaries-user.html#dx1-17025" >1384</a>, <a +href="glossaries-user.html#dx1-39028" >1385</a>, <a +href="glossaries-user.html#dx1-40006" >1386</a>, <a +href="glossaries-user.html#dx1-40007" >1387</a>, <a +href="glossaries-user.html#dx1-40046" >1388</a>, <a +href="glossaries-user.html#dx1-41021" >1389</a>, <a +href="glossaries-user.html#dx1-41030" >1390</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">entrycounter</span>  <a +href="glossaries-user.html#dx1-15001" >1391</a>, <a +href="glossaries-user.html#dx1-15023" >1392</a>, <a +href="glossaries-user.html#dx1-45001" >1393</a>, <a +href="glossaries-user.html#dx1-52040" >1394</a>, <a +href="glossaries-user.html#dx1-53012" >1395</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">false</span>  <a +href="glossaries-user.html#dx1-15002" >1396</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">true</span>  <a +href="glossaries-user.html#dx1-15013" >1397</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">footnote</span>  <a -href="glossaries-manual.html#dx1-13082" ><span class="underline">1161</span></a>, <a -href="glossaries-manual.html#dx1-34007" ><span class="underline">1162</span></a>, <a -href="glossaries-manual.html#dx1-34017" ><span class="underline">1163</span></a>, <a -href="glossaries-manual.html#dx1-34026" ><span class="underline">1164</span></a>, <a -href="glossaries-manual.html#dx1-34046" ><span class="underline">1165</span></a>, <a -href="glossaries-manual.html#dx1-34050" ><span class="underline">1166</span></a>, <a -href="glossaries-manual.html#dx1-34061" ><span class="underline">1167</span></a>, <a -href="glossaries-manual.html#dx1-34067" ><span class="underline">1168</span></a>, <a -href="glossaries-manual.html#dx1-34076" ><span class="underline">1169</span></a>, <a -href="glossaries-manual.html#dx1-34095" ><span class="underline">1170</span></a>, <a -href="glossaries-manual.html#dx1-34103" ><span class="underline">1171</span></a>, <a -href="glossaries-manual.html#dx1-34110" ><span class="underline">1172</span></a>, <a -href="glossaries-manual.html#dx1-34116" ><span class="underline">1173</span></a>, <a -href="glossaries-manual.html#dx1-34129" ><span class="underline">1174</span></a>, <a -href="glossaries-manual.html#dx1-35055" ><span class="underline">1175</span></a> <br /></span> +href="glossaries-user.html#dx1-17016" >1398</a>, <a +href="glossaries-user.html#dx1-39017" >1399</a>, <a +href="glossaries-user.html#dx1-39036" >1400</a>, <a +href="glossaries-user.html#dx1-39050" >1401</a>, <a +href="glossaries-user.html#dx1-40002" >1402</a>, <a +href="glossaries-user.html#dx1-40009" >1403</a>, <a +href="glossaries-user.html#dx1-40019" >1404</a>, <a +href="glossaries-user.html#dx1-40023" >1405</a>, <a +href="glossaries-user.html#dx1-40030" >1406</a>, <a +href="glossaries-user.html#dx1-40045" >1407</a>, <a +href="glossaries-user.html#dx1-41010" >1408</a>, <a +href="glossaries-user.html#dx1-41018" >1409</a>, <a +href="glossaries-user.html#dx1-41024" >1410</a>, <a +href="glossaries-user.html#dx1-42062" >1411</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">hyperfirst</span>  <a -href="glossaries-manual.html#dx1-13137" ><span class="underline">1176</span></a> <br /></span> +href="glossaries-user.html#dx1-13062" >1412</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">false</span>  <a -href="glossaries-manual.html#dx1-11010" ><span class="underline">1177</span></a>, <a -href="glossaries-manual.html#dx1-23011" ><span class="underline">1178</span></a> <br /></span> +href="glossaries-user.html#dx1-28012" >1413</a>, <a +href="glossaries-user.html#dx1-57027" >1414</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">true</span>  <a -href="glossaries-manual.html#dx1-13139" ><span class="underline">1179</span></a> <br /></span> +href="glossaries-user.html#dx1-13064" >1415</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">makeindex</span>  <a -href="glossaries-manual.html#dx1-13094" ><span class="underline">1180</span></a> <br /></span> +href="glossaries-user.html#dx1-16018" >1416</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nolist</span>  <a -href="glossaries-manual.html#dx1-13048" ><span class="underline">1181</span></a>, <a -href="glossaries-manual.html#dx1-39004" ><span class="underline">1182</span></a> <br /></span> - - - +href="glossaries-user.html#dx1-15037" >1417</a>, <a +href="glossaries-user.html#dx1-46004" >1418</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nolong</span>  <a -href="glossaries-manual.html#dx1-13042" ><span class="underline">1183</span></a>, <a -href="glossaries-manual.html#dx1-40004" ><span class="underline">1184</span></a>, <a -href="glossaries-manual.html#dx1-38014" ><span class="underline">1185</span></a> <br /></span> +href="glossaries-user.html#dx1-15031" >1419</a>, <a +href="glossaries-user.html#dx1-47004" >1420</a>, <a +href="glossaries-user.html#dx1-45018" >1421</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nomain</span>  <a -href="glossaries-manual.html#dx1-13002" ><span class="underline">1186</span></a>, <a -href="glossaries-manual.html#dx1-33006" ><span class="underline">1187</span></a> <br /></span> +href="glossaries-user.html#dx1-13002" >1422</a>, <a +href="glossaries-user.html#dx1-38010" >1423</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nonumberlist</span>  <a -href="glossaries-manual.html#dx1-13059" ><span class="underline">1188</span></a>, <a -href="glossaries-manual.html#dx1-20002" ><span class="underline">1189</span></a>, <a -href="glossaries-manual.html#dx1-45033" ><span class="underline">1190</span></a>, <a -href="glossaries-manual.html#dx1-45034" ><span class="underline">1191</span></a> <br /></span> +href="glossaries-user.html#dx1-2036" >1424</a>, <a +href="glossaries-user.html#dx1-15048" >1425</a>, <a +href="glossaries-user.html#dx1-15054" >1426</a>, <a +href="glossaries-user.html#dx1-19110" >1427</a>, <a +href="glossaries-user.html#dx1-25003" >1428</a>, <a +href="glossaries-user.html#dx1-29008" >1429</a>, <a +href="glossaries-user.html#dx1-52053" >1430</a>, <a +href="glossaries-user.html#dx1-52055" >1431</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nostyles</span>  <a -href="glossaries-manual.html#dx1-13054" ><span class="underline">1192</span></a>, <a -href="glossaries-manual.html#dx1-39005" ><span class="underline">1193</span></a>, <a -href="glossaries-manual.html#dx1-40005" ><span class="underline">1194</span></a>, <a -href="glossaries-manual.html#dx1-42005" ><span class="underline">1195</span></a>, <a -href="glossaries-manual.html#dx1-44003" ><span class="underline">1196</span></a>, <a -href="glossaries-manual.html#dx1-38016" ><span class="underline">1197</span></a> <br /></span> +href="glossaries-user.html#dx1-15043" >1432</a>, <a +href="glossaries-user.html#dx1-46005" >1433</a>, <a +href="glossaries-user.html#dx1-47005" >1434</a>, <a +href="glossaries-user.html#dx1-49005" >1435</a>, <a +href="glossaries-user.html#dx1-51003" >1436</a>, <a +href="glossaries-user.html#dx1-45020" >1437</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nosuper</span>  <a -href="glossaries-manual.html#dx1-13045" ><span class="underline">1198</span></a>, <a -href="glossaries-manual.html#dx1-42004" ><span class="underline">1199</span></a>, <a -href="glossaries-manual.html#dx1-38015" ><span class="underline">1200</span></a> <br /></span> +href="glossaries-user.html#dx1-15034" >1438</a>, <a +href="glossaries-user.html#dx1-49004" >1439</a>, <a +href="glossaries-user.html#dx1-45019" >1440</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">notree</span>  <a -href="glossaries-manual.html#dx1-13052" ><span class="underline">1201</span></a>, <a -href="glossaries-manual.html#dx1-44002" ><span class="underline">1202</span></a> <br /></span> +href="glossaries-user.html#dx1-15041" >1441</a>, <a +href="glossaries-user.html#dx1-51002" >1442</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">nowarn</span>  <a -href="glossaries-manual.html#dx1-13001" ><span class="underline">1203</span></a> <br /></span> +href="glossaries-user.html#dx1-13001" >1443</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">numberedsection</span>  <a -href="glossaries-manual.html#dx1-13029" ><span class="underline">1204</span></a>, <a -href="glossaries-manual.html#dx1-13030" ><span class="underline">1205</span></a>, <a -href="glossaries-manual.html#dx1-27017" ><span class="underline">1206</span></a>, <a -href="glossaries-manual.html#dx1-27018" ><span class="underline">1207</span></a>, <a -href="glossaries-manual.html#dx1-27021" ><span class="underline">1208</span></a> <br /></span> +href="glossaries-user.html#dx1-14016" >1444</a>, <a +href="glossaries-user.html#dx1-14017" >1445</a>, <a +href="glossaries-user.html#dx1-33023" >1446</a>, <a +href="glossaries-user.html#dx1-33024" >1447</a>, <a +href="glossaries-user.html#dx1-33031" >1448</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">autolabel</span>  <a -href="glossaries-manual.html#dx1-13033" ><span class="underline">1209</span></a>, <a -href="glossaries-manual.html#dx1-13034" ><span class="underline">1210</span></a> <br /></span> +href="glossaries-user.html#dx1-14020" >1449</a>, <a +href="glossaries-user.html#dx1-14021" >1450</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">false</span>  <a -href="glossaries-manual.html#dx1-13031" ><span class="underline">1211</span></a> <br /></span> +href="glossaries-user.html#dx1-14018" >1451</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">nolabel</span>  <a -href="glossaries-manual.html#dx1-13032" ><span class="underline">1212</span></a> <br /></span> +href="glossaries-user.html#dx1-14019" >1452</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">numberline</span>  <a -href="glossaries-manual.html#dx1-13008" ><span class="underline">1213</span></a>, <a -href="glossaries-manual.html#dx1-13012" ><span class="underline">1214</span></a> <br /></span> +href="glossaries-user.html#dx1-14004" >1453</a>, <a +href="glossaries-user.html#dx1-14010" >1454</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">order</span>  <a -href="glossaries-manual.html#dx1-13112" ><span class="underline">1215</span></a> <br /></span> +href="glossaries-user.html#dx1-16012" >1455</a>, <a +href="glossaries-user.html#dx1-16015" >1456</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">letter</span>  <a -href="glossaries-manual.html#dx1-3034" ><span class="underline">1216</span></a>, <a -href="glossaries-manual.html#dx1-6033" ><span class="underline">1217</span></a>, <a -href="glossaries-manual.html#dx1-13114" ><span class="underline">1218</span></a> <br /></span> +href="glossaries-user.html#dx1-4046" >1457</a>, <a +href="glossaries-user.html#dx1-7086" >1458</a>, <a +href="glossaries-user.html#dx1-16014" >1459</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">word</span>  <a -href="glossaries-manual.html#dx1-3033" ><span class="underline">1219</span></a>, <a -href="glossaries-manual.html#dx1-6034" ><span class="underline">1220</span></a>, <a -href="glossaries-manual.html#dx1-13113" ><span class="underline">1221</span></a> <br /></span> +href="glossaries-user.html#dx1-4045" >1460</a>, <a +href="glossaries-user.html#dx1-7087" >1461</a>, <a +href="glossaries-user.html#dx1-16013" >1462</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">sanitize</span>  <a -href="glossaries-manual.html#dx1-13063" ><span class="underline">1222</span></a>, <a -href="glossaries-manual.html#dx1-13067" ><span class="underline">1223</span></a>, <a -href="glossaries-manual.html#dx1-34071" ><span class="underline">1224</span></a>, <a -href="glossaries-manual.html#dx1-34133" ><span class="underline">1225</span></a>, <a -href="glossaries-manual.html#dx1-34149" ><span class="underline">1226</span></a> <br /></span> -<span class="index-subsubitem">        <span -class="ecss-1000">description</span>  <a -href="glossaries-manual.html#dx1-34072" ><span class="underline">1227</span></a>, <a -href="glossaries-manual.html#dx1-34105" ><span class="underline">1228</span></a> <br /></span> +href="glossaries-user.html#dx1-2042" >1463</a>, <a +href="glossaries-user.html#dx1-13005" >1464</a>, <a +href="glossaries-user.html#dx1-13011" >1465</a>, <a +href="glossaries-user.html#dx1-19037" >1466</a>, <a +href="glossaries-user.html#dx1-19079" >1467</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">none</span>  <a -href="glossaries-manual.html#dx1-13071" ><span class="underline">1229</span></a> <br /></span> +href="glossaries-user.html#dx1-13015" >1468</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">savewrites</span>  <a +href="glossaries-user.html#dx1-13027" >1469</a>, <a +href="glossaries-user.html#dx1-13029" >1470</a>, <a +href="glossaries-user.html#dx1-13036" >1471</a> <br /></span> <span class="index-subsubitem">        <span -class="ecss-1000">symbol</span>  <a -href="glossaries-manual.html#dx1-34073" ><span class="underline">1230</span></a>, <a -href="glossaries-manual.html#dx1-34092" ><span class="underline">1231</span></a>, <a -href="glossaries-manual.html#dx1-34114" ><span class="underline">1232</span></a>, <a -href="glossaries-manual.html#dx1-34126" ><span class="underline">1233</span></a> <br /></span> +class="ecss-1000">false</span>  <a +href="glossaries-user.html#dx1-13028" >1472</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">section</span>  <a -href="glossaries-manual.html#dx1-13025" ><span class="underline">1234</span></a>, <a -href="glossaries-manual.html#dx1-27020" ><span class="underline">1235</span></a> <br /></span> +href="glossaries-user.html#dx1-14011" >1473</a>, <a +href="glossaries-user.html#dx1-33029" >1474</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">seeautonumberlist</span>  <a +href="glossaries-user.html#dx1-15051" >1475</a>, <a +href="glossaries-user.html#dx1-15058" >1476</a>, <a +href="glossaries-user.html#dx1-19119" >1477</a>, <a +href="glossaries-user.html#dx1-30030" >1478</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">shortcuts</span>  <a -href="glossaries-manual.html#dx1-13093" ><span class="underline">1236</span></a>, <a -href="glossaries-manual.html#dx1-34019" ><span class="underline">1237</span></a>, <a -href="glossaries-manual.html#dx1-34153" ><span class="underline">1238</span></a>, <a -href="glossaries-manual.html#dx1-34154" ><span class="underline">1239</span></a>, <a -href="glossaries-manual.html#dx1-34156" ><span class="underline">1240</span></a>, <a -href="glossaries-manual.html#dx1-35018" ><span class="underline">1241</span></a> <br /></span> +href="glossaries-user.html#dx1-17027" >1479</a>, <a +href="glossaries-user.html#dx1-39079" >1480</a>, <a +href="glossaries-user.html#dx1-39081" >1481</a>, <a +href="glossaries-user.html#dx1-42018" >1482</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">smallcaps</span>  <a -href="glossaries-manual.html#dx1-11006" ><span class="underline">1242</span></a>, <a -href="glossaries-manual.html#dx1-11007" ><span class="underline">1243</span></a>, <a -href="glossaries-manual.html#dx1-13084" ><span class="underline">1244</span></a>, <a -href="glossaries-manual.html#dx1-34008" ><span class="underline">1245</span></a>, <a -href="glossaries-manual.html#dx1-34013" ><span class="underline">1246</span></a>, <a -href="glossaries-manual.html#dx1-34023" ><span class="underline">1247</span></a>, <a -href="glossaries-manual.html#dx1-34031" ><span class="underline">1248</span></a>, <a -href="glossaries-manual.html#dx1-34032" ><span class="underline">1249</span></a>, <a -href="glossaries-manual.html#dx1-34037" ><span class="underline">1250</span></a>, <a -href="glossaries-manual.html#dx1-34051" ><span class="underline">1251</span></a>, <a -href="glossaries-manual.html#dx1-34059" ><span class="underline">1252</span></a>, <a -href="glossaries-manual.html#dx1-34078" ><span class="underline">1253</span></a>, <a -href="glossaries-manual.html#dx1-34109" ><span class="underline">1254</span></a>, <a -href="glossaries-manual.html#dx1-34127" ><span class="underline">1255</span></a> <br /></span> +href="glossaries-user.html#dx1-17018" >1483</a>, <a +href="glossaries-user.html#dx1-39019" >1484</a>, <a +href="glossaries-user.html#dx1-39022" >1485</a>, <a +href="glossaries-user.html#dx1-39037" >1486</a>, <a +href="glossaries-user.html#dx1-39045" >1487</a>, <a +href="glossaries-user.html#dx1-39047" >1488</a>, <a +href="glossaries-user.html#dx1-39055" >1489</a>, <a +href="glossaries-user.html#dx1-39056" >1490</a>, <a +href="glossaries-user.html#dx1-40011" >1491</a>, <a +href="glossaries-user.html#dx1-40022" >1492</a>, <a +href="glossaries-user.html#dx1-40043" >1493</a>, <a +href="glossaries-user.html#dx1-41026" >1494</a>, <a +href="glossaries-user.html#dx1-57021" >1495</a>, <a +href="glossaries-user.html#dx1-57022" >1496</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">smaller</span>  <a -href="glossaries-manual.html#dx1-11013" ><span class="underline">1256</span></a>, <a -href="glossaries-manual.html#dx1-11017" ><span class="underline">1257</span></a>, <a -href="glossaries-manual.html#dx1-13086" ><span class="underline">1258</span></a>, <a -href="glossaries-manual.html#dx1-34014" ><span class="underline">1259</span></a>, <a -href="glossaries-manual.html#dx1-34024" ><span class="underline">1260</span></a>, <a -href="glossaries-manual.html#dx1-34030" ><span class="underline">1261</span></a>, <a -href="glossaries-manual.html#dx1-34033" ><span class="underline">1262</span></a>, <a -href="glossaries-manual.html#dx1-34035" ><span class="underline">1263</span></a>, <a -href="glossaries-manual.html#dx1-34038" ><span class="underline">1264</span></a>, <a -href="glossaries-manual.html#dx1-34052" ><span class="underline">1265</span></a>, <a -href="glossaries-manual.html#dx1-34060" ><span class="underline">1266</span></a>, <a -href="glossaries-manual.html#dx1-34077" ><span class="underline">1267</span></a>, <a -href="glossaries-manual.html#dx1-34115" ><span class="underline">1268</span></a>, <a -href="glossaries-manual.html#dx1-34128" ><span class="underline">1269</span></a> <br /></span> +href="glossaries-user.html#dx1-17020" >1497</a>, <a +href="glossaries-user.html#dx1-39021" >1498</a>, <a +href="glossaries-user.html#dx1-39048" >1499</a>, <a +href="glossaries-user.html#dx1-39054" >1500</a>, <a +href="glossaries-user.html#dx1-39058" >1501</a>, <a +href="glossaries-user.html#dx1-39061" >1502</a>, <a +href="glossaries-user.html#dx1-40010" >1503</a>, <a +href="glossaries-user.html#dx1-40029" >1504</a>, <a +href="glossaries-user.html#dx1-40044" >1505</a>, <a +href="glossaries-user.html#dx1-41028" >1506</a>, <a +href="glossaries-user.html#dx1-57030" >1507</a>, <a +href="glossaries-user.html#dx1-57035" >1508</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">sort</span>  <a +href="glossaries-user.html#dx1-16001" >1509</a>, <a +href="glossaries-user.html#dx1-57018" >1510</a>, <a +href="glossaries-user.html#dx1-57096" >1511</a> <br /></span> + + + +<span class="index-subsubitem">        <span +class="ecss-1000">def</span>  <a +href="glossaries-user.html#dx1-16007" >1512</a>, <a +href="glossaries-user.html#dx1-19095" >1513</a>, <a +href="glossaries-user.html#dx1-23007" >1514</a>, <a +href="glossaries-user.html#dx1-57017" >1515</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">standard</span>  <a +href="glossaries-user.html#dx1-13022" >1516</a>, <a +href="glossaries-user.html#dx1-16002" >1517</a>, <a +href="glossaries-user.html#dx1-16011" >1518</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">use</span>  <a +href="glossaries-user.html#dx1-16009" >1519</a>, <a +href="glossaries-user.html#dx1-19096" >1520</a>, <a +href="glossaries-user.html#dx1-23006" >1521</a>, <a +href="glossaries-user.html#dx1-57016" >1522</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">style</span>  <a -href="glossaries-manual.html#dx1-13041" ><span class="underline">1270</span></a>, <a -href="glossaries-manual.html#dx1-13051" ><span class="underline">1271</span></a>, <a -href="glossaries-manual.html#dx1-13055" ><span class="underline">1272</span></a>, <a -href="glossaries-manual.html#dx1-27014" ><span class="underline">1273</span></a>, <a -href="glossaries-manual.html#dx1-38010" ><span class="underline">1274</span></a>, <a -href="glossaries-manual.html#dx1-41008" ><span class="underline">1275</span></a>, <a -href="glossaries-manual.html#dx1-43008" ><span class="underline">1276</span></a> <br /></span> +href="glossaries-user.html#dx1-15025" >1523</a>, <a +href="glossaries-user.html#dx1-15040" >1524</a>, <a +href="glossaries-user.html#dx1-15044" >1525</a>, <a +href="glossaries-user.html#dx1-33020" >1526</a>, <a +href="glossaries-user.html#dx1-45014" >1527</a>, <a +href="glossaries-user.html#dx1-48008" >1528</a>, <a +href="glossaries-user.html#dx1-50008" >1529</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">list</span>  <a +href="glossaries-user.html#dx1-15026" >1530</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">subentrycounter</span>  <a +href="glossaries-user.html#dx1-15019" >1531</a>, <a +href="glossaries-user.html#dx1-21001" >1532</a>, <a +href="glossaries-user.html#dx1-23008" >1533</a>, <a +href="glossaries-user.html#dx1-45003" >1534</a>, <a +href="glossaries-user.html#dx1-52059" >1535</a>, <a +href="glossaries-user.html#dx1-53014" >1536</a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">false</span>  <a +href="glossaries-user.html#dx1-15020" >1537</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">toc</span>  <a -href="glossaries-manual.html#dx1-13005" ><span class="underline">1277</span></a>, <a -href="glossaries-manual.html#dx1-13009" ><span class="underline">1278</span></a>, <a -href="glossaries-manual.html#dx1-13010" ><span class="underline">1279</span></a>, <a -href="glossaries-manual.html#dx1-13011" ><span class="underline">1280</span></a>, <a -href="glossaries-manual.html#dx1-27012" ><span class="underline">1281</span></a> <br /></span> +href="glossaries-user.html#dx1-14001" >1538</a>, <a +href="glossaries-user.html#dx1-14005" >1539</a>, <a +href="glossaries-user.html#dx1-14008" >1540</a>, <a +href="glossaries-user.html#dx1-14009" >1541</a>, <a +href="glossaries-user.html#dx1-33017" >1542</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">translate</span>  <a -href="glossaries-manual.html#dx1-13116" ><span class="underline">1282</span></a> <br /></span> +href="glossaries-user.html#dx1-13041" >1543</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">false</span>  <a -href="glossaries-manual.html#dx1-5029" ><span class="underline">1283</span></a>, <a -href="glossaries-manual.html#dx1-5034" ><span class="underline">1284</span></a>, <a -href="glossaries-manual.html#dx1-13121" ><span class="underline">1285</span></a>, <a -href="glossaries-manual.html#dx1-13132" ><span class="underline">1286</span></a> <br /></span> +href="glossaries-user.html#dx1-6030" >1544</a>, <a +href="glossaries-user.html#dx1-6035" >1545</a>, <a +href="glossaries-user.html#dx1-13046" >1546</a>, <a +href="glossaries-user.html#dx1-13057" >1547</a> <br /></span> <span class="index-subsubitem">        <span class="ecss-1000">true</span>  <a -href="glossaries-manual.html#dx1-13117" ><span class="underline">1287</span></a>, <a -href="glossaries-manual.html#dx1-13122" ><span class="underline">1288</span></a> <br /></span> +href="glossaries-user.html#dx1-13042" >1548</a>, <a +href="glossaries-user.html#dx1-13047" >1549</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">xindy</span>  <a -href="glossaries-manual.html#dx1-3052" ><span class="underline">1289</span></a>, <a -href="glossaries-manual.html#dx1-4006" ><span class="underline">1290</span></a>, <a -href="glossaries-manual.html#dx1-6013" ><span class="underline">1291</span></a>, <a -href="glossaries-manual.html#dx1-6035" ><span class="underline">1292</span></a>, <a -href="glossaries-manual.html#dx1-8002" ><span class="underline">1293</span></a>, <a -href="glossaries-manual.html#dx1-9002" ><span class="underline">1294</span></a>, <a -href="glossaries-manual.html#dx1-13102" ><span class="underline">1295</span></a>, <a -href="glossaries-manual.html#dx1-13110" ><span class="underline">1296</span></a>, <a -href="glossaries-manual.html#dx1-14029" ><span class="underline">1297</span></a>, <a -href="glossaries-manual.html#dx1-29002" ><span class="underline">1298</span></a>, <a -href="glossaries-manual.html#dx1-32001" ><span class="underline">1299</span></a> <br /></span> +href="glossaries-user.html#dx1-4083" >1550</a>, <a +href="glossaries-user.html#dx1-5011" >1551</a>, <a +href="glossaries-user.html#dx1-7046" >1552</a>, <a +href="glossaries-user.html#dx1-7088" >1553</a>, <a +href="glossaries-user.html#dx1-9003" >1554</a>, <a +href="glossaries-user.html#dx1-10003" >1555</a>, <a +href="glossaries-user.html#dx1-16032" >1556</a>, <a +href="glossaries-user.html#dx1-16046" >1557</a>, <a +href="glossaries-user.html#dx1-18031" >1558</a>, <a +href="glossaries-user.html#dx1-34003" >1559</a>, <a +href="glossaries-user.html#dx1-36001" >1560</a>, <a +href="glossaries-user.html#dx1-37001" >1561</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">page </span>counter  <a +href="glossaries-user.html#dx1-36040" >1562</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\pagelistname</span></span></span>  <a -href="glossaries-manual.html#dx1-5020" ><span class="underline">1300</span></a> <br /></span> +href="glossaries-user.html#dx1-6020" >1563</a> <br /></span> <span class="index-item"><span class="ectt-1000">pod2man</span>  <a -href="glossaries-manual.html#dx1-7009" >1301</a> <br /></span> +href="glossaries-user.html#dx1-8016" >1564</a> <br /></span> <span class="index-item"><span class="ecss-1000">polyglossia </span>package  <a -href="glossaries-manual.html#dx1-5002" >1302</a>, <a -href="glossaries-manual.html#dx1-5031" >1303</a>, <a -href="glossaries-manual.html#dx1-13119" >1304</a>, <a -href="glossaries-manual.html#dx1-13130" >1305</a>, <a -href="glossaries-manual.html#dx1-13134" >1306</a> <br /></span> +href="glossaries-user.html#dx1-6002" >1565</a>, <a +href="glossaries-user.html#dx1-6032" >1566</a>, <a +href="glossaries-user.html#dx1-13044" >1567</a>, <a +href="glossaries-user.html#dx1-13055" >1568</a>, <a +href="glossaries-user.html#dx1-13059" >1569</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\printglossaries</span></span></span>  <a -href="glossaries-manual.html#dx1-11039" ><span class="underline">1307</span></a>, <a -href="glossaries-manual.html#dx1-14005" ><span class="underline">1308</span></a>, <a -href="glossaries-manual.html#dx1-27001" ><span -class="ecti-1000">1309</span></a> <br /></span> +href="glossaries-user.html#dx1-19008" >1570</a>, <a +href="glossaries-user.html#dx1-33001" ><span +class="ecti-1000">1571</span></a>, <a +href="glossaries-user.html#dx1-41002" >1572</a>, <a +href="glossaries-user.html#dx1-52063" >1573</a>, <a +href="glossaries-user.html#dx1-57074" >1574</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\printglossary</span></span></span>  <a -href="glossaries-manual.html#dx1-11038" ><span class="underline">1310</span></a>, <a -href="glossaries-manual.html#dx1-13058" ><span class="underline">1311</span></a>, <a -href="glossaries-manual.html#dx1-14004" ><span class="underline">1312</span></a>, <a -href="glossaries-manual.html#dx1-27008" ><span -class="ecti-1000">1313</span></a>, <a -href="glossaries-manual.html#dx1-38008" ><span class="underline">1314</span></a>, <a -href="glossaries-manual.html#dx1-38023" ><span class="underline">1315</span></a> <br /></span> +href="glossaries-user.html#dx1-15047" >1575</a>, <a +href="glossaries-user.html#dx1-19007" >1576</a>, <a +href="glossaries-user.html#dx1-33013" ><span +class="ecti-1000">1577</span></a>, <a +href="glossaries-user.html#dx1-41001" >1578</a>, <a +href="glossaries-user.html#dx1-45012" >1579</a>, <a +href="glossaries-user.html#dx1-45027" >1580</a>, <a +href="glossaries-user.html#dx1-52062" >1581</a>, <a +href="glossaries-user.html#dx1-57073" >1582</a> <br /></span> <span class="index-item"><span class="ectt-1000">\printglossary </span>options<br /></span> <span class="index-subitem">    <span class="ecss-1000">nonumberlist</span>  <a -href="glossaries-manual.html#dx1-27019" >1316</a> <br /></span> +href="glossaries-user.html#dx1-33025" >1583</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">numberedsection</span>  <a -href="glossaries-manual.html#dx1-27016" >1317</a> <br /></span> +href="glossaries-user.html#dx1-33022" >1584</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">style</span>  <a -href="glossaries-manual.html#dx1-13057" >1318</a>, <a -href="glossaries-manual.html#dx1-27013" >1319</a>, <a -href="glossaries-manual.html#dx1-38007" >1320</a>, <a -href="glossaries-manual.html#dx1-38022" >1321</a> <br /></span> +href="glossaries-user.html#dx1-15046" >1585</a>, <a +href="glossaries-user.html#dx1-33019" >1586</a>, <a +href="glossaries-user.html#dx1-45011" >1587</a>, <a +href="glossaries-user.html#dx1-45026" >1588</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">title</span>  <a -href="glossaries-manual.html#dx1-27010" >1322</a> <br /></span> +href="glossaries-user.html#dx1-33015" >1589</a>, <a +href="glossaries-user.html#dx1-33018" >1590</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">toctitle</span>  <a -href="glossaries-manual.html#dx1-27011" >1323</a> <br /></span> +href="glossaries-user.html#dx1-33016" >1591</a> <br /></span> <span class="index-subitem">    <span class="ecss-1000">type</span>  <a -href="glossaries-manual.html#dx1-27009" >1324</a> <br /></span> +href="glossaries-user.html#dx1-33014" >1592</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\protect</span></span></span>  <a +href="glossaries-user.html#dx1-2041" >1593</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">R</span> <span class="index-item"><span class="ecss-1000">relsize </span>package  <a -href="glossaries-manual.html#dx1-13088" >1325</a>, <a -href="glossaries-manual.html#dx1-34034" >1326</a>, <a -href="glossaries-manual.html#dx1-34124" >1327</a> <br /></span> +href="glossaries-user.html#dx1-17022" >1594</a>, <a +href="glossaries-user.html#dx1-39027" >1595</a>, <a +href="glossaries-user.html#dx1-39060" >1596</a>, <a +href="glossaries-user.html#dx1-40041" >1597</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Roman</span></span></span>  <a +href="glossaries-user.html#dx1-36031" >1598</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">S</span> - - - +<span class="index-item">sanitize  <a +href="glossaries-user.html#dx1-2037" ><span +class="ecbx-1000">1599</span></a>, <a +href="glossaries-user.html#dx1-5019" >1600</a>, <a +href="glossaries-user.html#dx1-13007" >1601</a>, <a +href="glossaries-user.html#dx1-13021" >1602</a>, <a +href="glossaries-user.html#dx1-19036" >1603</a>, <a +href="glossaries-user.html#dx1-19078" >1604</a>, <a +href="glossaries-user.html#dx1-26126" >1605</a>, <a +href="glossaries-user.html#dx1-26135" >1606</a>, <a +href="glossaries-user.html#dx1-26144" >1607</a>, <a +href="glossaries-user.html#dx1-27043" >1608</a>, <a +href="glossaries-user.html#dx1-30007" >1609</a>, <a +href="glossaries-user.html#dx1-7061" >1610</a>, <a +href="glossaries-user.html#dx1-31017" >1611</a>, <a +href="glossaries-user.html#dx1-32047" >1612</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\section*</span></span></span>  <a +href="glossaries-user.html#dx1-33027" >1613</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\seename</span></span></span>  <a -href="glossaries-manual.html#dx1-25014" ><span class="underline">1328</span></a> <br /></span> +href="glossaries-user.html#dx1-2003" >1614</a>, <a +href="glossaries-user.html#dx1-30013" >1615</a>, <a +href="glossaries-user.html#dx1-30018" >1616</a>, <a +href="glossaries-user.html#dx1-31007" >1617</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\setAlphaCompositor</span></span></span>  <a -href="glossaries-manual.html#dx1-31021" ><span class="underline">1329</span></a> <br /></span> +href="glossaries-user.html#dx1-36049" >1618</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\setCompositor</span></span></span>  <a -href="glossaries-manual.html#dx1-31019" ><span class="underline">1330</span></a> <br /></span> +href="glossaries-user.html#dx1-36047" >1619</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\SetCustomDisplayStyle</span></span></span>  <a -href="glossaries-manual.html#dx1-35014" ><span -class="ecti-1000">1331</span></a>, <a -href="glossaries-manual.html#dx1-35039" ><span class="underline">1332</span></a>, <a -href="glossaries-manual.html#dx1-35048" ><span class="underline">1333</span></a>, <a -href="glossaries-manual.html#dx1-35052" ><span class="underline">1334</span></a> <br /></span> +href="glossaries-user.html#dx1-42014" ><span +class="ecti-1000">1620</span></a>, <a +href="glossaries-user.html#dx1-42044" >1621</a>, <a +href="glossaries-user.html#dx1-42053" >1622</a>, <a +href="glossaries-user.html#dx1-42057" >1623</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\SetCustomStyle</span></span></span>  <a -href="glossaries-manual.html#dx1-35017" ><span -class="ecti-1000">1335</span></a> <br /></span> +href="glossaries-user.html#dx1-42017" ><span +class="ecti-1000">1624</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\setentrycounter</span></span></span>  <a +href="glossaries-user.html#dx1-52047" >1625</a>, <a +href="glossaries-user.html#dx1-52050" >1626</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\setglossarysection</span></span></span>  <a -href="glossaries-manual.html#dx1-13026" ><span -class="ecti-1000">1336</span></a> <br /></span> +href="glossaries-user.html#dx1-14012" ><span +class="ecti-1000">1627</span></a>, <a +href="glossaries-user.html#dx1-33030" >1628</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\setStyleFile</span></span></span>  <a -href="glossaries-manual.html#dx1-8011" ><span class="underline">1337</span></a>, <a -href="glossaries-manual.html#dx1-9008" ><span class="underline">1338</span></a>, <a -href="glossaries-manual.html#dx1-14023" ><span -class="ecti-1000">1339</span></a> <br /></span> +href="glossaries-user.html#dx1-9017" >1629</a>, <a +href="glossaries-user.html#dx1-10011" >1630</a>, <a +href="glossaries-user.html#dx1-18023" ><span +class="ecti-1000">1631</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\smaller</span></span></span>  <a -href="glossaries-manual.html#dx1-34120" ><span class="underline">1340</span></a> <br /></span> +href="glossaries-user.html#dx1-40037" >1632</a> <br /></span> <span class="index-item"><span class="ectt-1000">supertabular </span>(environment)  <a -href="glossaries-manual.html#dx1-42002" ><span class="underline">1341</span></a>, <a -href="glossaries-manual.html#dx1-42008" ><span class="underline">1342</span></a>, <a -href="glossaries-manual.html#dx1-42013" ><span class="underline">1343</span></a>, <a -href="glossaries-manual.html#dx1-43003" ><span class="underline">1344</span></a>, <a -href="glossaries-manual.html#dx1-43010" ><span class="underline">1345</span></a> <br /></span> +href="glossaries-user.html#dx1-49002" >1633</a>, <a +href="glossaries-user.html#dx1-49008" >1634</a>, <a +href="glossaries-user.html#dx1-49013" >1635</a>, <a +href="glossaries-user.html#dx1-50003" >1636</a>, <a +href="glossaries-user.html#dx1-50010" >1637</a> <br /></span> + + + <span class="index-item"><span class="ecss-1000">supertabular </span>package  <a -href="glossaries-manual.html#dx1-13047" >1346</a>, <a -href="glossaries-manual.html#dx1-42015" >1347</a>, <a -href="glossaries-manual.html#dx1-43012" >1348</a> <br /></span> +href="glossaries-user.html#dx1-15036" >1638</a>, <a +href="glossaries-user.html#dx1-49015" >1639</a>, <a +href="glossaries-user.html#dx1-50012" >1640</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\symbolname</span></span></span>  <a -href="glossaries-manual.html#dx1-5019" ><span class="underline">1349</span></a> <br /></span> +href="glossaries-user.html#dx1-6019" >1641</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">T</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textbf</span></span></span>  <a -href="glossaries-manual.html#dx1-21021" ><span class="underline">1350</span></a> <br /></span> +href="glossaries-user.html#dx1-26032" >1642</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textrm</span></span></span>  <a -href="glossaries-manual.html#dx1-31002" ><span class="underline">1351</span></a> <br /></span> +href="glossaries-user.html#dx1-36013" >1643</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textsc</span></span></span>  <a -href="glossaries-manual.html#dx1-34113" ><span class="underline">1352</span></a> <br /></span> +href="glossaries-user.html#dx1-39020" >1644</a>, <a +href="glossaries-user.html#dx1-39024" >1645</a>, <a +href="glossaries-user.html#dx1-39057" >1646</a>, <a +href="glossaries-user.html#dx1-40028" >1647</a>, <a +href="glossaries-user.html#dx1-42024" >1648</a>, <a +href="glossaries-user.html#dx1-42025" >1649</a>, <a +href="glossaries-user.html#dx1-57023" >1650</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\textsmaller</span></span></span>  <a -href="glossaries-manual.html#dx1-13089" ><span class="underline">1353</span></a>, <a -href="glossaries-manual.html#dx1-34123" ><span class="underline">1354</span></a>, <a -href="glossaries-manual.html#dx1-34121" ><span class="underline">1355</span></a> <br /></span> +href="glossaries-user.html#dx1-17023" >1651</a>, <a +href="glossaries-user.html#dx1-39023" >1652</a>, <a +href="glossaries-user.html#dx1-39025" >1653</a>, <a +href="glossaries-user.html#dx1-39026" >1654</a>, <a +href="glossaries-user.html#dx1-40040" >1655</a>, <a +href="glossaries-user.html#dx1-57037" >1656</a>, <a +href="glossaries-user.html#dx1-40038" >1657</a> <br /></span> <span class="index-item"><span class="ectt-1000">theglossary </span>(environment)  <a -href="glossaries-manual.html#dx1-45002" ><span -class="ecti-1000">1356</span></a>, <a -href="glossaries-manual.html#dx1-45004" ><span class="underline">1357</span></a>, <a -href="glossaries-manual.html#dx1-45009" ><span class="underline">1358</span></a>, <a -href="glossaries-manual.html#dx1-46003" ><span class="underline">1359</span></a> <br /></span> +href="glossaries-user.html#dx1-52002" ><span +class="ecti-1000">1658</span></a>, <a +href="glossaries-user.html#dx1-52004" >1659</a>, <a +href="glossaries-user.html#dx1-52011" >1660</a>, <a +href="glossaries-user.html#dx1-53003" >1661</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\thepage</span></span></span>  <a -href="glossaries-manual.html#dx1-31012" ><span class="underline">1360</span></a> <br /></span> +href="glossaries-user.html#dx1-36033" >1662</a> <br /></span> <span class="index-item"><span class="ecss-1000">translator </span>package  <a -href="glossaries-manual.html#dx1-5004" >1361</a>, <a -href="glossaries-manual.html#dx1-5005" >1362</a>, <a -href="glossaries-manual.html#dx1-5006" >1363</a>, <a -href="glossaries-manual.html#dx1-5010" >1364</a>, <a -href="glossaries-manual.html#dx1-5012" >1365</a>, <a -href="glossaries-manual.html#dx1-5024" >1366</a>, <a -href="glossaries-manual.html#dx1-5025" >1367</a>, <a -href="glossaries-manual.html#dx1-5026" >1368</a>, <a -href="glossaries-manual.html#dx1-5028" >1369</a>, <a -href="glossaries-manual.html#dx1-11031" >1370</a>, <a -href="glossaries-manual.html#dx1-13120" >1371</a>, <a -href="glossaries-manual.html#dx1-13124" >1372</a>, <a -href="glossaries-manual.html#dx1-13125" >1373</a>, <a -href="glossaries-manual.html#dx1-13126" >1374</a>, <a -href="glossaries-manual.html#dx1-13127" >1375</a> <br /></span> +href="glossaries-user.html#dx1-6004" >1663</a>, <a +href="glossaries-user.html#dx1-6005" >1664</a>, <a +href="glossaries-user.html#dx1-6006" >1665</a>, <a +href="glossaries-user.html#dx1-6010" >1666</a>, <a +href="glossaries-user.html#dx1-6012" >1667</a>, <a +href="glossaries-user.html#dx1-6024" >1668</a>, <a +href="glossaries-user.html#dx1-6025" >1669</a>, <a +href="glossaries-user.html#dx1-6026" >1670</a>, <a +href="glossaries-user.html#dx1-6029" >1671</a>, <a +href="glossaries-user.html#dx1-13045" >1672</a>, <a +href="glossaries-user.html#dx1-13049" >1673</a>, <a +href="glossaries-user.html#dx1-13050" >1674</a>, <a +href="glossaries-user.html#dx1-13051" >1675</a>, <a +href="glossaries-user.html#dx1-13052" >1676</a>, <a +href="glossaries-user.html#dx1-57056" >1677</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">W</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\write18</span></span></span>  <a +href="glossaries-user.html#dx1-13031" >1678</a> <br /></span> </p><p class="theindex"> <span class="ecbx-1000">X</span> +<span class="index-item">xindy  <a +href="glossaries-user.html#dx1-2043" ><span +class="ecbx-1000">1679</span></a> <br /></span> <span class="index-item"><span class="ectt-1000">xindy</span>  <a -href="glossaries-manual.html#dx1-2008" >1376</a>, <a -href="glossaries-manual.html#dx1-2011" >1377</a>, <a -href="glossaries-manual.html#dx1-3037" >1378</a>, <a -href="glossaries-manual.html#dx1-3041" >1379</a>, <a -href="glossaries-manual.html#dx1-3045" >1380</a>, <a -href="glossaries-manual.html#dx1-3047" >1381</a>, <a -href="glossaries-manual.html#dx1-3049" >1382</a>, <a -href="glossaries-manual.html#dx1-3050" >1383</a>, <a -href="glossaries-manual.html#dx1-4001" >1384</a>, <a -href="glossaries-manual.html#dx1-4003" >1385</a>, <a -href="glossaries-manual.html#dx1-4005" >1386</a>, <a -href="glossaries-manual.html#dx1-4010" >1387</a>, <a -href="glossaries-manual.html#dx1-4012" >1388</a>, <a -href="glossaries-manual.html#dx1-5035" >1389</a>, <a -href="glossaries-manual.html#dx1-5037" >1390</a>, <a -href="glossaries-manual.html#dx1-6002" >1391</a>, <a -href="glossaries-manual.html#dx1-6004" >1392</a>, <a -href="glossaries-manual.html#dx1-6006" >1393</a>, <a -href="glossaries-manual.html#dx1-6007" >1394</a>, <a -href="glossaries-manual.html#dx1-6010" >1395</a>, <a -href="glossaries-manual.html#dx1-6014" >1396</a>, <a -href="glossaries-manual.html#dx1-6019" >1397</a>, <a -href="glossaries-manual.html#dx1-6022" >1398</a>, <a -href="glossaries-manual.html#dx1-6026" >1399</a>, <a -href="glossaries-manual.html#dx1-6032" >1400</a>, <a -href="glossaries-manual.html#dx1-7003" >1401</a>, <a -href="glossaries-manual.html#dx1-8001" >1402</a>, <a -href="glossaries-manual.html#dx1-8003" >1403</a>, <a -href="glossaries-manual.html#dx1-8005" >1404</a>, <a -href="glossaries-manual.html#dx1-8006" >1405</a>, <a -href="glossaries-manual.html#dx1-8008" >1406</a>, <a -href="glossaries-manual.html#dx1-8019" >1407</a>, <a -href="glossaries-manual.html#dx1-8021" >1408</a>, <a -href="glossaries-manual.html#dx1-10001" >1409</a>, <a -href="glossaries-manual.html#dx1-10007" >1410</a>, <a -href="glossaries-manual.html#dx1-10010" >1411</a>, <a -href="glossaries-manual.html#dx1-11023" >1412</a>, <a -href="glossaries-manual.html#dx1-11047" >1413</a>, <a -href="glossaries-manual.html#dx1-11049" >1414</a>, <a -href="glossaries-manual.html#dx1-11050" >1415</a>, <a -href="glossaries-manual.html#dx1-11051" >1416</a>, <a -href="glossaries-manual.html#dx1-11052" >1417</a>, <a -href="glossaries-manual.html#dx1-13100" >1418</a>, <a -href="glossaries-manual.html#dx1-13103" >1419</a>, <a -href="glossaries-manual.html#dx1-13105" >1420</a>, <a -href="glossaries-manual.html#dx1-13107" >1421</a>, <a -href="glossaries-manual.html#dx1-13111" >1422</a>, <a -href="glossaries-manual.html#dx1-14008" >1423</a>, <a -href="glossaries-manual.html#dx1-14012" >1424</a>, <a -href="glossaries-manual.html#dx1-14014" >1425</a>, <a -href="glossaries-manual.html#dx1-14022" >1426</a>, <a -href="glossaries-manual.html#dx1-14027" >1427</a>, <a -href="glossaries-manual.html#dx1-14084" >1428</a>, <a -href="glossaries-manual.html#dx1-14098" >1429</a>, <a -href="glossaries-manual.html#dx1-20006" >1430</a>, <a -href="glossaries-manual.html#dx1-20007" >1431</a>, <a -href="glossaries-manual.html#dx1-20012" >1432</a>, <a -href="glossaries-manual.html#dx1-20015" >1433</a>, <a -href="glossaries-manual.html#dx1-21004" >1434</a>, <a -href="glossaries-manual.html#dx1-21023" >1435</a>, <a -href="glossaries-manual.html#dx1-21027" >1436</a>, <a -href="glossaries-manual.html#dx1-21045" >1437</a>, <a -href="glossaries-manual.html#dx1-27004" >1438</a>, <a -href="glossaries-manual.html#dx1-27006" >1439</a>, <a -href="glossaries-manual.html#dx1-29001" >1440</a>, <a -href="glossaries-manual.html#dx1-29003" >1441</a>, <a -href="glossaries-manual.html#dx1-29004" >1442</a>, <a -href="glossaries-manual.html#dx1-29006" >1443</a>, <a -href="glossaries-manual.html#dx1-29011" >1444</a>, <a -href="glossaries-manual.html#dx1-29012" >1445</a>, <a -href="glossaries-manual.html#dx1-29014" >1446</a>, <a -href="glossaries-manual.html#dx1-29015" >1447</a>, <a -href="glossaries-manual.html#dx1-30001" >1448</a>, <a -href="glossaries-manual.html#dx1-30002" >1449</a>, <a -href="glossaries-manual.html#dx1-30005" >1450</a>, <a -href="glossaries-manual.html#dx1-30010" >1451</a>, <a -href="glossaries-manual.html#dx1-30013" >1452</a>, <a -href="glossaries-manual.html#dx1-31004" >1453</a>, <a -href="glossaries-manual.html#dx1-31007" >1454</a>, <a -href="glossaries-manual.html#dx1-31013" >1455</a>, <a -href="glossaries-manual.html#dx1-31029" >1456</a>, <a -href="glossaries-manual.html#dx1-33004" >1457</a>, <a -href="glossaries-manual.html#dx1-44014" >1458</a>, <a -href="glossaries-manual.html#dx1-45021" >1459</a> <br /></span> +href="glossaries-user.html#dx1-2030" >1680</a>, <a +href="glossaries-user.html#dx1-3011" >1681</a>, <a +href="glossaries-user.html#dx1-3017" >1682</a>, <a +href="glossaries-user.html#dx1-4052" >1683</a>, <a +href="glossaries-user.html#dx1-4059" >1684</a>, <a +href="glossaries-user.html#dx1-4066" >1685</a>, <a +href="glossaries-user.html#dx1-4070" >1686</a>, <a +href="glossaries-user.html#dx1-4074" >1687</a>, <a +href="glossaries-user.html#dx1-4078" >1688</a>, <a +href="glossaries-user.html#dx1-4080" >1689</a>, <a +href="glossaries-user.html#dx1-5002" >1690</a>, <a +href="glossaries-user.html#dx1-5006" >1691</a>, <a +href="glossaries-user.html#dx1-5010" >1692</a>, <a +href="glossaries-user.html#dx1-5028" >1693</a>, <a +href="glossaries-user.html#dx1-5032" >1694</a>, <a +href="glossaries-user.html#dx1-6037" >1695</a>, <a +href="glossaries-user.html#dx1-6041" >1696</a>, <a +href="glossaries-user.html#dx1-7004" >1697</a>, <a +href="glossaries-user.html#dx1-7008" >1698</a>, <a +href="glossaries-user.html#dx1-7012" >1699</a>, <a +href="glossaries-user.html#dx1-7014" >1700</a>, <a +href="glossaries-user.html#dx1-7020" >1701</a>, <a +href="glossaries-user.html#dx1-7027" >1702</a>, <a +href="glossaries-user.html#dx1-7033" >1703</a>, <a +href="glossaries-user.html#dx1-7039" >1704</a>, <a +href="glossaries-user.html#dx1-7043" >1705</a>, <a +href="glossaries-user.html#dx1-7048" >1706</a>, <a +href="glossaries-user.html#dx1-7058" >1707</a>, <a +href="glossaries-user.html#dx1-7068" >1708</a>, <a +href="glossaries-user.html#dx1-7076" >1709</a>, <a +href="glossaries-user.html#dx1-7085" >1710</a>, <a +href="glossaries-user.html#dx1-8005" >1711</a>, <a +href="glossaries-user.html#dx1-9002" >1712</a>, <a +href="glossaries-user.html#dx1-9005" >1713</a>, <a +href="glossaries-user.html#dx1-9009" >1714</a>, <a +href="glossaries-user.html#dx1-9011" >1715</a>, <a +href="glossaries-user.html#dx1-9014" >1716</a>, <a +href="glossaries-user.html#dx1-9027" >1717</a>, <a +href="glossaries-user.html#dx1-9031" >1718</a>, <a +href="glossaries-user.html#dx1-11002" >1719</a>, <a +href="glossaries-user.html#dx1-11011" >1720</a>, <a +href="glossaries-user.html#dx1-11015" >1721</a>, <a +href="glossaries-user.html#dx1-13035" >1722</a>, <a +href="glossaries-user.html#dx1-13040" >1723</a>, <a +href="glossaries-user.html#dx1-15011" >1724</a>, <a +href="glossaries-user.html#dx1-16030" >1725</a>, <a +href="glossaries-user.html#dx1-16034" >1726</a>, <a +href="glossaries-user.html#dx1-16038" >1727</a>, <a +href="glossaries-user.html#dx1-16042" >1728</a>, <a +href="glossaries-user.html#dx1-16048" >1729</a>, <a +href="glossaries-user.html#dx1-18006" >1730</a>, <a +href="glossaries-user.html#dx1-18009" >1731</a>, <a +href="glossaries-user.html#dx1-18022" >1732</a>, <a +href="glossaries-user.html#dx1-18029" >1733</a>, <a +href="glossaries-user.html#dx1-19014" >1734</a>, <a +href="glossaries-user.html#dx1-19091" >1735</a>, <a +href="glossaries-user.html#dx1-19132" >1736</a>, <a +href="glossaries-user.html#dx1-25009" >1737</a>, <a +href="glossaries-user.html#dx1-25011" >1738</a>, <a +href="glossaries-user.html#dx1-25018" >1739</a>, <a +href="glossaries-user.html#dx1-25022" >1740</a>, <a +href="glossaries-user.html#dx1-26007" >1741</a>, <a +href="glossaries-user.html#dx1-26035" >1742</a>, <a +href="glossaries-user.html#dx1-26041" >1743</a>, <a +href="glossaries-user.html#dx1-26062" >1744</a>, <a +href="glossaries-user.html#dx1-33007" >1745</a>, <a +href="glossaries-user.html#dx1-33011" >1746</a>, <a +href="glossaries-user.html#dx1-34002" >1747</a>, <a +href="glossaries-user.html#dx1-34005" >1748</a>, <a +href="glossaries-user.html#dx1-34007" >1749</a>, <a +href="glossaries-user.html#dx1-34010" >1750</a>, <a +href="glossaries-user.html#dx1-34016" >1751</a>, <a +href="glossaries-user.html#dx1-34018" >1752</a>, <a +href="glossaries-user.html#dx1-34021" >1753</a>, <a +href="glossaries-user.html#dx1-34023" >1754</a>, <a +href="glossaries-user.html#dx1-35002" >1755</a>, <a +href="glossaries-user.html#dx1-35004" >1756</a>, <a +href="glossaries-user.html#dx1-35009" >1757</a>, <a +href="glossaries-user.html#dx1-35015" >1758</a>, <a +href="glossaries-user.html#dx1-35020" >1759</a>, <a +href="glossaries-user.html#dx1-36005" >1760</a>, <a +href="glossaries-user.html#dx1-36016" >1761</a>, <a +href="glossaries-user.html#dx1-36020" >1762</a>, <a +href="glossaries-user.html#dx1-36026" >1763</a>, <a +href="glossaries-user.html#dx1-36035" >1764</a>, <a +href="glossaries-user.html#dx1-36043" >1765</a>, <a +href="glossaries-user.html#dx1-36059" >1766</a>, <a +href="glossaries-user.html#dx1-38007" >1767</a>, <a +href="glossaries-user.html#dx1-51016" >1768</a>, <a +href="glossaries-user.html#dx1-52027" >1769</a>, <a +href="glossaries-user.html#dx1-57007" >1770</a>, <a +href="glossaries-user.html#dx1-57009" >1771</a>, <a +href="glossaries-user.html#dx1-57013" >1772</a>, <a +href="glossaries-user.html#dx1-57015" >1773</a>, <a +href="glossaries-user.html#dx1-57047" >1774</a>, <a +href="glossaries-user.html#dx1-57085" >1775</a>, <a +href="glossaries-user.html#dx1-57089" >1776</a>, <a +href="glossaries-user.html#dx1-57091" >1777</a>, <a +href="glossaries-user.html#dx1-57093" >1778</a>, <a +href="glossaries-user.html#dx1-57095" >1779</a> <br /></span> <span class="index-item"><span class="ecss-1000">xkeyval </span>package  <a -href="glossaries-manual.html#dx1-3003" >1460</a>, <a -href="glossaries-manual.html#dx1-11003" >1461</a> <br /></span> +href="glossaries-user.html#dx1-4003" >1780</a>, <a +href="glossaries-user.html#dx1-57003" >1781</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\xmakefirstuc</span></span></span>  <a -href="glossaries-manual.html#dx1-50005" ><span -class="ecti-1000">1462</span></a> <br /></span> +href="glossaries-user.html#dx1-2004" >1782</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="ectt-1000">\xspace</span></span></span>  <a -href="glossaries-manual.html#dx1-36016" ><span class="underline">1463</span></a> <br /></span> +href="glossaries-user.html#dx1-43016" >1783</a> <br /></span> <span class="index-item"><span class="ecss-1000">xspace </span>package  <a -href="glossaries-manual.html#dx1-36014" >1464</a>, <a -href="glossaries-manual.html#dx1-36015" >1465</a>, <a -href="glossaries-manual.html#dx1-36017" >1466</a>, <a -href="glossaries-manual.html#dx1-36019" >1467</a>, <a -href="glossaries-manual.html#dx1-36021" >1468</a>, <a -href="glossaries-manual.html#dx1-36022" >1469</a> <br /></span> +href="glossaries-user.html#dx1-43014" >1784</a>, <a +href="glossaries-user.html#dx1-43015" >1785</a>, <a +href="glossaries-user.html#dx1-43017" >1786</a>, <a +href="glossaries-user.html#dx1-43019" >1787</a>, <a +href="glossaries-user.html#dx1-43021" >1788</a>, <a +href="glossaries-user.html#dx1-43022" >1789</a> <br /></span> </p></div> -<!--l. 5074--><p class="noindent" ><a -href="#top">Top</a> -</p> - <div class="footnotes"><!--l. 91--><p class="indent" > <span class="footnote-mark"><a + <div class="footnotes"><!--l. 289--><p class="indent" > <span class="footnote-mark"><a href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span -class="ecrm-0800">that is, if the term has been referenced using any of the commands described in </span><a -href="#x1-210002.4"><span -class="ecrm-0800">2.4 </span></a><a -href="#x1-210002.4"><span +class="ecrm-0800">That is, if the term has been referenced using any of the commands described in </span><a +href="#x1-260006"><span +class="ecrm-0800">6 </span></a><a +href="#x1-260006"><span class="ecrm-0800">Links to</span> <span -class="ecrm-0800">Glossary Entries</span><!--tex4ht:ref: sec:glslink --></a><span -class="ecrm-0800">, </span><a -href="#x1-240002.5"><span -class="ecrm-0800">2.5 </span></a><a -href="#x1-240002.5"><span +class="ecrm-0800">Glossary Entries</span><!--tex4ht:ref: sec:glslink --></a> <span +class="ecrm-0800">and </span><a +href="#x1-290007"><span +class="ecrm-0800">7 </span></a><a +href="#x1-290007"><span class="ecrm-0800">Adding an Entry to the Glossary Without Generating Text</span><!--tex4ht:ref: sec:glsadd --></a> <span class="ecrm-0800">or via </span><span class="ectt-0800">\glssee</span><a - id="dx1-2003"></a> <span + id="dx1-3002"></a> <span class="ecrm-0800">(or</span> <span class="ecrm-0800">the </span><span class="ecss-0800">see</span><a - id="dx1-2004"></a> <span -class="ecrm-0800">key)</span></p> -<!--l. 1199--><p class="noindent" ><span class="footnote-mark"><a + id="dx1-3003"></a> <span +class="ecrm-0800">key) or commands such as </span><span +class="ectt-0800">\acrshort</span><a + id="dx1-3004"></a><span +class="ecrm-0800">.</span></p> +<!--l. 990--><p class="indent" > <span class="footnote-mark"><a href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span +class="ecrm-0800">Note that I’m assuming the</span> <a + id="dx1-7060"></a><a +href="#glo:sanitize"><span +class="ecrm-0800">sanitization</span><a + id="dx1-7061"></a></a> <span +class="ecrm-0800">has been switched on for the </span><span +class="ecss-0800">description</span><a + id="dx1-7062"></a> <span +class="ecrm-0800">key, which is</span> +<span +class="ecrm-0800">why I haven’t used </span><span +class="ectt-0800">\protect\gls </span><span +class="ecrm-0800">in the description.</span></p> +<!--l. 1457--><p class="noindent" ><span class="footnote-mark"><a +href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span +class="ecrm-0800">if the </span><span +class="ecss-0800">acronym</span><a + id="dx1-14023"></a> <span +class="ecrm-0800">option is used, otherwise the list of acronyms is the main glossary</span></p> +<!--l. 1698--><p class="noindent" ><span class="footnote-mark"><a +href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span class="ecrm-0800">Actually it sets </span><span class="ectt-0800">\acronymtype</span><a - id="dx1-13017"></a> <span + id="dx1-17005"></a> <span class="ecrm-0800">to </span><span class="ectt-0800">\glsdefaulttype</span><a - id="dx1-13018"></a> <span + id="dx1-17006"></a> <span class="ecrm-0800">if the </span><span class="ecss-0800">acronym</span><a - id="dx1-13019"></a> <span + id="dx1-17007"></a> <span class="ecrm-0800">package option is not used, but</span> <span class="ectt-0800">\glsdefaulttype</span><a - id="dx1-13020"></a> <span + id="dx1-17008"></a> <span class="ecrm-0800">usually has the value </span><span class="ectt-0800">main</span><span class="ecrm-0800">.</span></p> -<!--l. 1277--><p class="noindent" ><span class="footnote-mark"><a -href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span -class="ecrm-0800">if the </span><span -class="ecss-0800">acronym</span><a - id="dx1-13036"></a> <span -class="ecrm-0800">option is used, otherwise the list of acronyms is the main glossary</span></p> -<!--l. 1500--><p class="indent" > <span class="footnote-mark"><a -href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span +<!--l. 1833--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span class="ecrm-0800">The only preamble restriction on </span><span -class="ectt-0800">\newglossaryentry </span><span +class="ectt-0800">\newglossaryentry</span><a + id="dx1-19002"></a> <span class="ecrm-0800">and </span><span -class="ectt-0800">\newacronym </span><span +class="ectt-0800">\newacronym</span><a + id="dx1-19003"></a> <span class="ecrm-0800">was removed in version</span> <span class="ecrm-0800">1.13, but the restriction remains for </span><span -class="ectt-0800">\loadglsentries</span><span +class="ectt-0800">\loadglsentries</span><a + id="dx1-19004"></a><span class="ecrm-0800">.</span></p> -<!--l. 1922--><p class="indent" > <span class="footnote-mark"><a -href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span +<!--l. 1848--><p class="indent" > <span class="footnote-mark"><a +href="#fn6x0-bk" id="fn6x0"><sup class="textsuperscript">6</sup></a></span><span +class="ecrm-0800">Except possibly the style file but then you’ll need to use </span><span +class="ectt-0800">\noist</span><a + id="dx1-19016"></a> <span +class="ecrm-0800">to prevent your changes from</span> +<span +class="ecrm-0800">being overwritten.</span></p> +<!--l. 2226--><p class="indent" > <span class="footnote-mark"><a +href="#fn7x0-bk" id="fn7x0"><sup class="textsuperscript">7</sup></a></span><span class="ecrm-0800">This is because </span><span -class="ectt-0800">\acronymtype </span><span +class="ectt-0800">\acronymtype</span><a + id="dx1-24010"></a> <span class="ecrm-0800">is set to </span><span -class="ectt-0800">\glsdefaulttype </span><span +class="ectt-0800">\glsdefaulttype</span><a + id="dx1-24011"></a> <span class="ecrm-0800">if the </span><span class="ecss-0800">acronym</span><a - id="dx1-19006"></a> <span + id="dx1-24012"></a> <span class="ecrm-0800">package option is not</span> <span class="ecrm-0800">used.</span></p> -<!--l. 2531--><p class="indent" > <span class="footnote-mark"><a -href="#fn6x0-bk" id="fn6x0"><sup class="textsuperscript">6</sup></a></span><span +<!--l. 2890--><p class="indent" > <span class="footnote-mark"><a +href="#fn8x0-bk" id="fn8x0"><sup class="textsuperscript">8</sup></a></span><span class="ectt-0800">main </span><span class="ecrm-0800">for the main (default) glossary, </span><span class="ectt-0800">\acronymtype </span><span @@ -14538,82 +17515,133 @@ class="ecrm-0800">for the list of acronyms, or the name</span> class="ecrm-0800">supplied in the first mandatory argument to </span><span class="ectt-0800">\newglossary </span><span class="ecrm-0800">for additional glossaries.</span></p> -<!--l. 3138--><p class="indent" > <span class="footnote-mark"><a -href="#fn7x0-bk" id="fn7x0"><sup class="textsuperscript">7</sup></a></span><span +<!--l. 3122--><p class="indent" > <span class="footnote-mark"><a +href="#fn9x0-bk" id="fn9x0"><sup class="textsuperscript">9</sup></a></span><a + id="dx1-31004"></a><a +href="#glo:makeindex"><span +class="ectt-0800">makeindex</span><a + id="dx1-31005"></a></a> <span +class="ecrm-0800">will always assign a location number, even if it’s not needed, so it needs to be</span> +<span +class="ecrm-0800">discarded.</span></p><!--l. 3127--><p class="indent" > <span class="footnote-mark"><a +href="#fn10x0-bk" id="fn10x0"><sup class="textsuperscript">10</sup></a></span><span +class="ecrm-0800">Ifyou redefine </span><span +class="ectt-0800">\glsseeformat</span><span +class="ecrm-0800">, keep the default value of the optional argument as </span><span +class="ectt-0800">\seename</span><a + id="dx1-31007"></a> <span +class="ecrm-0800">as</span> +<span +class="ecrm-0800">both </span><span +class="ecss-0800">see</span><a + id="dx1-31008"></a> <span +class="ecrm-0800">and </span><span +class="ectt-0800">\glssee </span><span +class="ecrm-0800">explicitly write </span><span +class="ectt-0800">[\seename] </span><span +class="ecrm-0800">in the output file if no optional argument is</span> +<span +class="ecrm-0800">given.</span></p> +<!--l. 3151--><p class="indent" > <span class="footnote-mark"><a +href="#fn11x0-bk" id="fn11x0"><sup class="textsuperscript">11</sup></a></span><span +class="ecrm-0800">In versions before 3.0, </span><span +class="ectt-0800">\glsentryname </span><span +class="ecrm-0800">was used, but this can cause problems when the </span><span +class="ecss-0800">name</span><a + id="dx1-31015"></a> +<span +class="ecrm-0800">key is</span> <a + id="dx1-31016"></a><a +href="#glo:sanitize"><span +class="ecrm-0800">sanitized</span><a + id="dx1-31017"></a></a><span +class="ecrm-0800">.</span></p> +<!--l. 3304--><p class="indent" > <span class="footnote-mark"><a +href="#fn12x0-bk" id="fn12x0"><sup class="textsuperscript">12</sup></a></span><span +class="ecrm-0800">versions before 3.0 used </span><span +class="ectt-0800">\glsentryname</span><a + id="dx1-32044"></a> <span +class="ecrm-0800">as the default, but this can cause problems when </span><span +class="ecss-0800">name</span><a + id="dx1-32045"></a> +<span +class="ecrm-0800">has been</span> <a + id="dx1-32046"></a><a +href="#glo:sanitize"><span +class="ecrm-0800">sanitized</span><a + id="dx1-32047"></a></a><span +class="ecrm-0800">.</span></p><!--l. 3430--><p class="indent" > <span class="footnote-mark"><a +href="#fn13x0-bk" id="fn13x0"><sup class="textsuperscript">13</sup></a></span><span +class="ecrm-0800">you can’t use the </span><span +class="ecss-0800">longheaderborder</span><a + id="dx1-33038"></a> <span +class="ecrm-0800">style for this example as you can’t use the </span><span +class="ecss-0800">longtable</span><a + id="dx1-33039"></a><a + id="dx1-33040"></a> +<span +class="ecrm-0800">environment in two column mode.</span></p><!--l. 3725--><p class="indent" > <span class="footnote-mark"><a +href="#fn14x0-bk" id="fn14x0"><sup class="textsuperscript">14</sup></a></span><span class="ecrm-0800">see </span><span class="ectt-0800">\setCompositor</span><a - id="dx1-31019"></a> <span + id="dx1-36047"></a> <span class="ecrm-0800">described in </span><a -href="#x1-140002.2"><span -class="ecrm-0800">2.2 </span></a><a -href="#x1-140002.2"><span -class="ecrm-0800">Defining Glossary Entries</span><!--tex4ht:ref: sec:newglosentry --></a></p> -<!--l. 3144--><p class="indent" > <span class="footnote-mark"><a -href="#fn8x0-bk" id="fn8x0"><sup class="textsuperscript">8</sup></a></span><span +href="#x1-180003"><span +class="ecrm-0800">3 </span></a><a +href="#x1-180003"><span +class="ecrm-0800">Setting Up</span><!--tex4ht:ref: sec:setup --></a></p> +<!--l. 3731--><p class="indent" > <span class="footnote-mark"><a +href="#fn15x0-bk" id="fn15x0"><sup class="textsuperscript">15</sup></a></span><span class="ecrm-0800">see </span><span class="ectt-0800">\setAlphaCompositor</span><a - id="dx1-31021"></a> <span + id="dx1-36049"></a> <span class="ecrm-0800">described in </span><a -href="#x1-140002.2"><span -class="ecrm-0800">2.2 </span></a><a -href="#x1-140002.2"><span -class="ecrm-0800">Defining Glossary Entries</span><!--tex4ht:ref: sec:newglosentry --></a></p> -<!--l. 3391--><p class="indent" > <span class="footnote-mark"><a -href="#fn9x0-bk" id="fn9x0"><sup class="textsuperscript">9</sup></a></span><span -class="ecrm-0800">you will need to load a package, such as </span><span -class="ecss-0800">relsize</span><span -class="ecrm-0800">, that defines </span><span -class="ectt-0800">\textsmaller </span><span -class="ecrm-0800">if you use this</span> -<span -class="ecrm-0800">option.</span></p> -<!--l. 3639--><p class="noindent" ><span class="footnote-mark"><a -href="#fn10x0-bk" id="fn10x0"><sup class="textsuperscript">10</sup></a></span><span +href="#x1-180003"><span +class="ecrm-0800">3 </span></a><a +href="#x1-180003"><span +class="ecrm-0800">Setting Up</span><!--tex4ht:ref: sec:setup --></a></p> +<!--l. 4240--><p class="noindent" ><span class="footnote-mark"><a +href="#fn16x0-bk" id="fn16x0"><sup class="textsuperscript">16</sup></a></span><span class="ecrm-0800">not that this was change from using </span><span class="ectt-0800">\smaller</span><a - id="dx1-34120"></a> <span + id="dx1-40037"></a> <span class="ecrm-0800">to </span><span class="ectt-0800">\textsmaller</span><a - id="dx1-34121"></a> <span + id="dx1-40038"></a> <span class="ecrm-0800">as declarations cause a problem for</span> <span class="ectt-0800">\makefirstuc</span><a - id="dx1-34122"></a><span + id="dx1-40039"></a><span class="ecrm-0800">.</span></p> -<!--l. 3912--><p class="indent" > <span class="footnote-mark"><a -href="#fn11x0-bk" id="fn11x0"><sup class="textsuperscript">11</sup></a></span><span -class="ecrm-0800">as from version 1.18</span></p><!--l. 4101--><p class="indent" > <span class="footnote-mark"><a -href="#fn12x0-bk" id="fn12x0"><sup class="textsuperscript">12</sup></a></span><span +<!--l. 4497--><p class="indent" > <span class="footnote-mark"><a +href="#fn17x0-bk" id="fn17x0"><sup class="textsuperscript">17</sup></a></span><span +class="ecrm-0800">as from version 1.18</span></p><!--l. 4690--><p class="indent" > <span class="footnote-mark"><a +href="#fn18x0-bk" id="fn18x0"><sup class="textsuperscript">18</sup></a></span><span class="ecrm-0800">these lengths will not be available if you use both the </span><span class="ecss-0800">nolong</span><a - id="dx1-38014"></a> <span + id="dx1-45018"></a> <span class="ecrm-0800">and </span><span class="ecss-0800">nosuper</span><a - id="dx1-38015"></a> <span + id="dx1-45019"></a> <span class="ecrm-0800">package</span> <span class="ecrm-0800">options or if you use the </span><span class="ecss-0800">nostyles</span><a - id="dx1-38016"></a> <span + id="dx1-45020"></a> <span class="ecrm-0800">package option unless you explicitly load the relevant</span> <span class="ecrm-0800">package.</span></p> -<!--l. 4208--><p class="noindent" ><span class="footnote-mark"><a -href="#fn13x0-bk" id="fn13x0"><sup class="textsuperscript">13</sup></a></span><span +<!--l. 4796--><p class="noindent" ><span class="footnote-mark"><a +href="#fn19x0-bk" id="fn19x0"><sup class="textsuperscript">19</sup></a></span><span class="ecrm-0800">This style was supplied by Axel</span><span class="ecrm-0800"> Menzel.</span></p> -<!--l. 4419--><p class="indent" > <span class="footnote-mark"><a -href="#fn14x0-bk" id="fn14x0"><sup class="textsuperscript">14</sup></a></span><span +<!--l. 5007--><p class="indent" > <span class="footnote-mark"><a +href="#fn20x0-bk" id="fn20x0"><sup class="textsuperscript">20</sup></a></span><span class="ecrm-0800">e.g.</span><span class="ecrm-0800"> with the </span><span class="ecss-0800">flowfram</span><a - id="dx1-42011"></a> <span -class="ecrm-0800">package.</span></p> -<!--l. 5059--><p class="indent" > <span class="footnote-mark"><a -href="#fn15x0-bk" id="fn15x0"><sup class="textsuperscript">15</sup></a></span><span -class="ecrm-0800">defined in the </span><span -class="ecss-0800">textcase </span><span -class="ecrm-0800">package</span></p> </div> + id="dx1-49011"></a> <span +class="ecrm-0800">package.</span></p> </div> </body></html> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index fe43fadfd68..0c1a701352c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -4,31 +4,195 @@ \usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} +\ifpdf +\usepackage{mathpazo} +\usepackage[scaled=.88]{helvet} +\usepackage{courier} +\fi \usepackage[colorlinks, bookmarks, hyperindex=false, pdfauthor={Nicola L.C. Talbot}, - pdftitle={glossaries.sty: LaTeX2e Package to Assist Generating Glossaries}, + pdftitle={User Manual for glossaries.sty}, pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} +\usepackage{xr-hyper} +\usepackage[xindy,nonumberlist,seeautonumberlist,toc,style=altlist]{glossaries} + +\renewcommand*{\glsgroupskip}{} + +\renewcommand*{\glsseeformat}[3][\seename]{% + (\xmakefirstuc{#1} \glsseelist{#2}.)% +} + +\renewcommand*{\glossarypreamble}{% +\emph{This glossary style was setup using:} +\begin{ttfamily} +\begin{tabbing} +\cs{usepackage}[\=xindy,\\ +\+\>nonumberlist,\\ + seeautonumberlist,\\ + toc,\\ + style=altlist]\{glossaries\} +\end{tabbing} +\cs{renewcommand*}\{\ics{glsgroupskip}\}\{\}\newline +\cs{renewcommand*}\{\ics{glsseeformat}\}[3][\ics{seename}]\{(\ics{xmakefirstuc}\{\#1\} \newline +\ics{glsseelist}\{\#2\}.)\} +\end{ttfamily} +} + +\ifpdf +\else + % Need an extra line break in the html version + % (Don't have time to fiddle with cfg files!) + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glsentryitem{#1}\glstarget{#1}{#2}]\mbox{}\newline + #3\glspostdescription\space #5\newline}% +\fi + +\makeglossaries + +\renewcommand*{\main}[1]{\hyperpage{#1}} +\newcommand*{\htextbf}[1]{\textbf{\hyperpage{#1}}} +\newcommand*{\itermdef}[1]{\index{#1|htextbf}} + +\IndexPrologue{} + +\newglossaryentry{xindy}{ +name={\appfmt{xindy}\index{xindy|htextbf}}, +sort={xindy}, +text={\protect\app{xindy}}, +description={An flexible indexing application with multilingual +support} +} + +\newglossaryentry{makeindex}{% +name={\appfmt{makeindex}\index{makeindex|htextbf}},% +sort={makeindex},% +text={\protect\app{makeindex}},% +description={An indexing application}, +} + +\newglossaryentry{makeglossaries}{% +name={\appfmt{makeglossaries}\index{makeglossaries|htextbf}},% +sort={makeglossaries},% +text={\protect\app{makeglossaries}},% +description={A \sty{glossaries} custom designed Perl script interface +to \gls{xindy} and \gls{makeindex}} +} + +\newglossaryentry{numberlist}{% +name={Number list\itermdef{number list}},% +sort={number list},% +text={\protect\term{number list}},% +description={A list of \glslink{entrylocation}{entry locations} (also +called a location list). The number list can be suppressed using the +\pkgopt{nonumberlist} package option} +} + +\newglossaryentry{entrylocation}{% +name={Entry location\itermdef{entry location}},% +sort={entry location},% +text={\protect\term{entry location}},% +description={The location of the entry in the document. This +defaults to the page number on which the entry appears. An entry may +have multiple locations} +} + +\newglossaryentry{locationlist}{% +name={Location list},% +sort={location list},% +description={A list of \glslink{entrylocation}{entry locations}},% +see={numberlist} +} + +\newglossaryentry{linktext}{% +name={Link text\itermdef{link text}}, +sort={link text},% +text={\protect\term{link text}}, +description={The text produced by commands such as \ics{gls}. It may +or may not be a hyperlink to the glossary} +} + +\let\glsd\glsuseri +\let\glsation\glsuserii + +\newglossaryentry{firstuse}{% +name={First use\ifirstuse}, +sort={first use},% +text={first use},% +user1={first used}, +description={The first time a glossary entry is used (from the start of the document or after a reset) with one of the +following commands: \ics{gls}, \ics{Gls}, \ics{GLS}, \ics{glspl}, +\ics{Glspl}, \ics{GLSpl} or \ics{glsdisp}. +\glsseeformat{firstuseflag,firstusetext}{}\nopostdesc}% +} + +\newglossaryentry{firstuseflag}{% +name={First use flag\ifirstuseflag}, +sort={first use flag},% +text={first use flag},% +description={A conditional that determines whether or not the entry +has been used according to the rules of \gls{firstuse}. Commands +to unset or reset this conditional are described in +\sectionref{sec:glsunset}}% +} + +\newglossaryentry{firstusetext}{% +name={First use text\ifirstusetext}, +sort={first use text},% +text={first use text},% +description={The text that is displayed on \gls{firstuse}, which is +governed by the \gloskey{first} and \gloskey{firstplural} keys of +\ics{newglossaryentry}. (May be overridden by +\ics{glsdisp}.)\nopostdesc}% +} + +\newglossaryentry{sanitize}{% +name={Sanitize\itermdef{sanitize}},% +sort={sanitize}, +text={\protect\term{sanitize}},% +user1={sanitized\protect\iterm{sanitize}},% +user2={sanitization\protect\iterm{sanitize}}, +description={Converts command names into character sequences. That is, a command called, +say, \cs{foo}, is converted into the sequence of characters: +\cs{}, \texttt{f}, \texttt{o}, \texttt{o}. Depending on the font, +the backslash character may appear as a dash when used in the +main document text, so \cs{foo} will appear as: ---foo. +\glspar +When \TeX\ writes information to a file, fragile +commands must be protected. The \gloskey{name}, \gloskey{description} +and \gloskey{symbol} keys all have their values written to a file, +which means that care must be taken if those values contain fragile +commands. There are two approaches: 1) the fragile commands must be +protected using \ics{protect}; 2) the values are sanitized. +Sanitizing the values gets rid of the inconvenience of having to +protect fragile commands, but at the expense of no longer being able +to use those values in the document. Sanitization is governed by the +package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}} +} + +\ifpdf +\externaldocument{glossaries} +\fi \doxitem{Option}{option}{package options} \doxitem{GlsKey}{key}{glossary keys} \doxitem{Style}{style}{glossary styles} +\doxitem{Counter}{counter}{glossary counters} \setcounter{IndexColumns}{2} -\CheckSum{11106} - \newcommand*{\tick}{\ding{51}} \newcommand*{\ifirstuse}{\iterm{first use}} -\newcommand*{\firstuse}{first use\ifirstuse} -\newcommand*{\firstuseflag}{first use flag\ifirstuseflag} -\newcommand*{\firstusetext}{first use text\ifirstusetext} - \newcommand*{\ifirstuseflag}{\iterm{first use>flag}} \newcommand*{\ifirstusetext}{\iterm{first use>text}} +\newcommand*{\firstuse}{\gls{firstuse}} +\newcommand*{\firstuseflag}{\gls{firstuseflag}} +\newcommand*{\firstusetext}{\gls{firstusetext}} + + \newcommand*{\istkey}[1]{\appfmt{#1}\index{makeindex=\appfmt{makeindex}>#1=\texttt{#1}|hyperpage}} \newcommand*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}} \newcommand*{\mkidxspch}{\index{makeindex=\appfmt{makeindex}>special characters|hyperpage}} @@ -38,13 +202,19 @@ \newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles:>#1={\protect\ttfamily#1}|main}} +\newcommand*{\samplefile}[1]{\hyperref[ex:sample#1]{\texttt{sample#1.tex}}} + +\ifpdf + \newcommand*{\htmldoc}[2]{\qt{#1}} +\else + \newcommand*{\htmldoc}[2]{\href{#2.html}{\qt{#1}}} +\fi \begin{document} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{glossaries.sty v2.07: - \LaTeXe\ Package to Assist Generating Glossaries} + \title{User Manual for glossaries.sty v3.0} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -52,44 +222,71 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{2010-07-10} + \date{2011-04-02} \maketitle -This is the user manual for the \styfmt{glossaries} package. Other -documents accompanying this manual: -\begin{itemize} -\item \qtdocref{The glossaries package: a guide for beginners}{glossariesbegin} -\item \qtdocref{Upgrading from the glossary package to the -glossaries package}{glossary2glossaries} -\end{itemize} -See the file \texttt{INSTALL} for installation instructions. -Related web resources: -\begin{itemize} -\item -\urlfootref{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}{The glossaries FAQ} +\noindent +The \styfmt{glossaries} bundle comes with the following documentation: +\begin{description} +\item[\url{glossariesbegin.pdf}] +If you are a complete beginner, start with +\htmldoc{The glossaries package: a guide for +beginners}{glossariesbegin}. + +\item[\url{glossary2glossaries.pdf}] +If you are moving over from the obsolete \sty{glossary} package, +read \htmldoc{Upgrading from the glossary package to the +glossaries package}{glossary2glossaries}. + +\item[glossaries-user.pdf] +This document is the main user guide for the \styfmt{glossaries} +package. -\item -\urlfootref{http://www.latex-community.org/index.php?option=com_content&view=article&id=263&Itemid=114}{Glossaries, -Nomenclature, Lists of Symbols and Acronyms } -\end{itemize} +\item[\url{mfirstuc-manual.pdf}] +The commands provided by the \sty{mfirstuc} package are briefly +described in \htmldoc{mfirstuc.sty: uppercasing first +letter}{mfirstuc-manual}. + +\item[\url{glossaries.pdf}] +Advanced users wishing to know more about the inner workings of all the +packages provided in the \styfmt{glossaries} bundle should read +\qt{Documented Code for glossaries v3.0}. +This includes how to iterate over all entry labels defined in a +given glossary or how to iterate over all glossary types, as well as +the documented code for the \sty{mfirstuc} package. + +\item[INSTALL] Installation instructions. + +\item[CHANGES] Change log. + +\item[README] Package summary. + +\end{description} + +\begin{important} +If you use \sty{hyperref} and \styfmt{glossaries}, you must load +\sty{hyperref} \emph{first}. +\end{important} \clearpage \tableofcontents +\clearpage +\printglossaries + \section{Introduction} - \changes{1.0}{2007 May 16}{Initial version} The \styfmt{glossaries} package is provided to assist generating glossaries. It has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports acronyms and glossary styles that include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary -terms. Only those terms used\footnote{that is, if the term has been +terms. Only those terms used\footnote{That is, if the term has been referenced using any of the commands described in -\sectionref{sec:glslink}, \sectionref{sec:glsadd} or via -\ics{glssee} (or the \gloskey{see} key)} in the document will be -added to the glossary. +\sectionref{sec:glslink} and \sectionref{sec:glsadd} or via +\ics{glssee} (or the \gloskey{see} key) or commands such as +\ics{acrshort}.} in the document will be added to the glossary. \textbf{This package replaces the \sty{glossary} package which is now obsolete.} Please see the document \qtdocref{Upgrading from the @@ -105,44 +302,16 @@ size of the manual, try starting off with the much shorter \begin{important} The \styfmt{glossaries} package comes with a \href{http://www.perl.org/about.html}{Perl} script called -\app{makeglossaries}. This provides a convenient interface to -\app{makeindex} or \app{xindy}. It is strongly recommended +\gls{makeglossaries}. This provides a convenient interface to +\gls{makeindex} or \gls{xindy}. It is strongly recommended that you use this script, but \emph{it is not essential}. If you are reluctant to install Perl, or for any other reason you don't want to -use \app{makeglossaries}, you can called \app{makeindex} or -\app{xindy} explicitly. See \sectionref{sec:makeglossaries} for +use \gls*{makeglossaries}, you can called \gls*{makeindex} or +\gls*{xindy} explicitly. See \sectionref{sec:makeglossaries} for further details. \end{important} -This manual is structured as follows: -\begin{itemize} -\item \sectionref{sec:overview} gives an overview of the main user -commands and their syntax. - -\item \sectionref{sec:mfirstuc} describes the associated -\styfmt{mfirstuc} package. - -\ifpdf - \item \sectionref{sec:code} contains the documented source code for - those who want to know more about how the package works. This - describes more advanced commands, such as determining if an entry or - a glossary exists and commands that iterate through defined terms or - glossaries. - - \item \sectionref{sec:code:mfirstuc} contains the documented code for - the \styfmt{mfirstuc} package. -\fi -\end{itemize} -\ifpdf -\else - The \href{glossaries.pdf}{PDF version} of this manual also describes - more advanced commands in the documented code section (such as - determining if an entry or a glossary exists and commands that - iterate through defined terms or glossaries). -\fi - -\noindent The remainder of this introductory section covers the -following: +The remainder of this introductory section covers the following: \begin{itemize} \item \sectionref{sec:samples} lists the sample documents provided with this package. @@ -153,8 +322,6 @@ wish to write in a language other than English. \item \sectionref{sec:makeglossaries} describes how to use a post-processor to create the sorted glossaries for your document. -\item \sectionref{sec:trouble} provides some assistance in the event -that you encounter a problem. \end{itemize} @@ -205,7 +372,7 @@ latex minimalgls If this is the case, you will need to update the \styfmt{xkeyval} package. - \item Run \app{makeglossaries} on the document. This can + \item Run \gls{makeglossaries} on the document. This can be done on a terminal either by typing \begin{prompt} makeglossaries minimalgls @@ -216,13 +383,13 @@ perl makeglossaries minimalgls \end{prompt} If your system doesn't recognise the command \texttt{perl} then it's likely you don't have Perl installed. In which case you - will need to use \app{makeindex} directly. You can do this + will need to use \gls{makeindex} directly. You can do this in a terminal by typing (all on one line): \begin{prompt} makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo \end{prompt} (See \sectionref{sec:makeindexapp} for further details on using - \app{makeindex} explicitly.) + \gls*{makeindex} explicitly.) Note that if you need to specify the full path and the path contains spaces, you will need to delimit the file names with @@ -244,8 +411,8 @@ makeglossaries sample4col latex sample4col \end{prompt} As before, if you don't have Perl installed, you will need to use -\app{makeindex} directly instead of using -\app{makeglossaries}. The vertical gap between entries is the +\gls{makeindex} directly instead of using +\gls{makeglossaries}. The vertical gap between entries is the gap created at the start of each group. This can be suppressed by redefining \ics{glsgroupskip} after the glossary style has been set: \begin{verbatim} @@ -295,10 +462,19 @@ makeglossaries sample-custom-acronym latex sample-custom-acronym \end{prompt} +\item[sample-crossref.tex]\label{ex:sample-crossref} +This document illustrates how to cross-reference entries in the +glossary. +\begin{prompt} +latex sample-crossref +makeglossaries sample-crossref +latex sample-crossref +\end{prompt} + \item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how to load external files containing the glossary definitions. It also illustrates how to define a new glossary type. This document has the -\term{number list} suppressed and uses \ics{glsaddall} to add all +\gls{numberlist} suppressed and uses \ics{glsaddall} to add all the entries to the glossaries without referencing each one explicitly. To create the document do: \begin{prompt} @@ -308,8 +484,8 @@ latex sampleDB \end{prompt} The glossary definitions are stored in the accompanying files \texttt{database1.tex} and \texttt{database2.tex}. Note that if you -don't have Perl installed, you will need to use \app{makeindex} -twice instead of a single call to \app{makeglossaries}: +don't have Perl installed, you will need to use \gls{makeindex} +twice instead of a single call to \gls{makeglossaries}: \begin{enumerate} \item Create the main glossary: \begin{prompt} @@ -333,7 +509,7 @@ latex sampleEq \end{prompt} \item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the -previous example, but the number lists\iterm{number list} are a +previous example, but the \glspl{numberlist} are a mixture of page numbers and equation numbers. This example adds the glossary to the table of contents, so an extra \LaTeX\ run is required: @@ -367,8 +543,8 @@ latex sampleNtn latex sampleNtn \end{prompt} Note that if you don't have Perl installed, you will need to use -\app{makeindex} twice instead of a single call to -\app{makeglossaries}: +\gls{makeindex} twice instead of a single call to +\gls{makeglossaries}: \begin{enumerate} \item Create the main glossary: \begin{prompt} @@ -383,7 +559,8 @@ makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn \item[sample.tex]\label{ex:sample} This document illustrates some of the basics, including how to create child entries that use the same name as the parent entry. This example adds the glossary to the -table of contents, so an extra \LaTeX\ run is required: +table of contents and it also uses \ics{glsrefentry}, so an extra \LaTeX\ +run is required: \begin{prompt} latex sample makeglossaries sample @@ -393,7 +570,7 @@ latex sample You can see the difference between word and letter ordering if you substitute \pkgopt[word]{order} with \pkgopt[letter]{order}. (Note that this will only have an effect if you use -\app{makeglossaries}. If you use \app{makeindex} explicitly, +\gls{makeglossaries}. If you use \gls{makeindex} explicitly, you will need to use the \texttt{-l} switch to indicate letter ordering.) @@ -407,12 +584,21 @@ makeglossaries sampletree latex sampletree \end{prompt} +\item[sample-dual.tex]\label{ex:sample-dual} This document +illustrates how to define an entry that both appears in the list of +acronyms and in the main glossary. To create the document do: +\begin{prompt} +latex sample-dual +makeglossaries sample-dual +latex sample-dual +\end{prompt} + \item[samplexdy.tex]\label{ex:samplexdy} This document illustrates -how to use the \styfmt{glossaries} package with \app{xindy} instead -of \app{makeindex}. The document uses UTF8 encoding (with the +how to use the \styfmt{glossaries} package with \gls{xindy} instead +of \gls{makeindex}. The document uses UTF8 encoding (with the \sty{inputenc} package). The encoding is picked up by -\app{makeglossaries}. By default, this document will create a -\app{xindy} style file called \texttt{samplexdy.xdy}, but if you +\gls{makeglossaries}. By default, this document will create a +\gls{xindy} style file called \texttt{samplexdy.xdy}, but if you uncomment the lines \begin{verbatim} \setStyleFile{samplexdy-mc} @@ -421,9 +607,9 @@ uncomment the lines \end{verbatim} it will set the style file to \texttt{samplexdy-mc.xdy} instead. This provides an additional letter group for entries starting with -\qt{Mc} or \qt{Mac}. If you use \app{makeglossaries}, you don't +\qt{Mc} or \qt{Mac}. If you use \gls{makeglossaries}, you don't need to supply any additional information. If you don't use -\app{makeglossaries}, you will need to specify the required +\gls*{makeglossaries}, you will need to specify the required information. Note that if you set the style file to \texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, otherwise the \styfmt{glossaries} package will overwrite @@ -437,7 +623,7 @@ makeglossaries samplexdy latex samplexdy \end{prompt} If you don't have Perl installed, you will have to call -\app{xindy} explicitly instead of using \app{makeglossaries}. +\gls{xindy} explicitly instead of using \gls{makeglossaries}. If you are using the default style file \texttt{samplexdy.xdy}, then do (no line breaks): \begin{prompt} @@ -449,9 +635,24 @@ otherwise, if you are using \texttt{samplexdy-mc.xdy}, then do xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo \end{prompt} +\item[samplexdy2.tex]\label{ex:samplexdy2} This document illustrates +how to use the \styfmt{glossaries} package where the location +numbers don't follow a standard format. This example will only work +with \gls{xindy}. To create the document do: +\begin{prompt} +pdflatex samplexdy2 +makeglossaries samplexdy2 +pdflatex samplexdy2 +\end{prompt} +If you can't use \gls{makeglossaries} then you need to do: +\begin{prompt} +xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo +\end{prompt} +See \sectionref{sec:xindyloc} for further details. + \item[sampleutf8.tex]\label{ex:sampleutf8} This is another example -that uses \app{xindy}. Unlike \app{makeindex}, -\app{xindy} can cope with accented or non-Latin characters. This +that uses \gls{xindy}. Unlike \gls{makeindex}, +\gls{xindy} can cope with accented or non-Latin characters. This document uses UTF8 encoding. To create the document do: \begin{prompt} latex sampleutf8 @@ -459,7 +660,7 @@ makeglossaries sampleutf8 latex sampleutf8 \end{prompt} If you don't have Perl installed, you will have to call -\app{xindy} explicitly instead of using \app{makeglossaries} +\gls{xindy} explicitly instead of using \gls{makeglossaries} (no line breaks): \begin{prompt} xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo @@ -475,7 +676,7 @@ latex sampleutf8 you will see that the entries that start with a non-Latin character now appear in the symbols group, and the word \qt{man\oe uvre} is now after \qt{manor} instead of before it. If you are unable to use -\app{makeglossaries}, the call to \app{makeindex} is as +\gls{makeglossaries}, the call to \gls{makeindex} is as follows (no line breaks): \begin{prompt} makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo @@ -495,12 +696,12 @@ about the \styfmt{glossaries-accsupp} package can be found in \label{sec:languages} As from version 1.17, the \styfmt{glossaries} package can now be -used with \app{xindy} as well as \app{makeindex}. If you +used with \gls{xindy} as well as \gls{makeindex}. If you are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use \app{xindy} -as \app{makeindex} is hard-coded for Latin languages. This +non-Latin characters it is recommended that you use \gls*{xindy} +as \gls*{makeindex} is hard-coded for Latin languages. This means that you are not restricted to the A, \ldots, Z letter groups. -If you want to use \app{xindy}, remember to use the +If you want to use \gls*{xindy}, remember to use the \pkgopt{xindy} package option. For example: \begin{verbatim} \documentclass[frenchb]{article} @@ -511,7 +712,13 @@ If you want to use \app{xindy}, remember to use the \end{verbatim} \begin{important} -If you use an accented or other expandable character at the start of +Note that although an accented character, such as é, looks like a plain +character in your tex file, it's actually a macro and can therefore +cause problems. + +\begin{enumerate} +\item +If you use an accented (or other expandable) character at the start of an entry name, you must place it in a group, or it will cause a problem for commands that convert the first letter to uppercase (e.g.\ \ics{Gls}) due to expansion issues. For example: @@ -519,13 +726,22 @@ a problem for commands that convert the first letter to uppercase \newglossaryentry{elite}{name={{é}lite}, description={select group or class}} \end{verbatim} + +\item If you use an accented (or other expandable) character in an +entry name and you haven't switched off the \gloskey{name} key +\glsation{sanitize}, you must use commands like +\ics{glsentrytext} or \ics{glstext} instead of \ics{glsentryname} or +\ics{glsname} or you will end up with strange looking characters in +your document. + +\end{enumerate} \end{important} -If you use the \sty{inputenc} package, \app{makeglossaries} +If you use the \sty{inputenc} package, \gls{makeglossaries} will pick up the encoding from the auxiliary file. If you use -\app{xindy} explicitly instead of via \app{makeglossaries}, +\gls{xindy} explicitly instead of via \gls*{makeglossaries}, you may need to specify the encoding using the \texttt{-C} -option. Read the \app{xindy} manual for further details. +option. Read the \gls*{xindy} manual for further details. \subsubsection{Changing the Fixed Names} \label{sec:fixednames} @@ -567,7 +783,9 @@ to provide the translations. For example: The languages are currently supported by the \styfmt{glossaries} package are listed in -\tableref{tab:supportedlanguages}. +\tableref{tab:supportedlanguages}. Please note that (apart from +spelling mistakes) I don't intend to change the default translations +as it will cause compatibility problems. \begin{table}[htbp] \caption{Supported Languages} @@ -633,11 +851,39 @@ installed, you need to be familiar with the advice given in the words babel uses}. If you have the \sty{translator} package installed, then you can provide your own dictionary with the necessary modifications (using \cs{deftranslation}) and load it -using \cs{usedictionary}. Note that the dictionaries are loaded at -the beginning of the document, so it won't have any effect if you -put \cs{deftranslation} in the preamble. It should be put in your -personal dictionary instead. See the \sty{translator} documentation -for further details. +using \cs{usedictionary}. + +\begin{important} +Note that the dictionaries are loaded at the beginning of the +document, so it won't have any effect if you put \cs{deftranslation} +in the preamble. It should be put in your personal dictionary +instead (as in the example below). See the \sty{translator} +documentation for further details. (Now with \sty{beamer} +documentation.) +\end{important} + +Your custom dictionary doesn't have to be just a translation from +English to another language. You may prefer to have a dictionary for +a particular type of document. For example, suppose your +institution's in-house reports have to have the glossary labelled as +\qt{Nomenclature} and the page list should be labelled +\qt{Location}, then you can create a file called, say, +\begin{verbatim} +myinstitute-glossaries-dictionary-English.dict +\end{verbatim} +that contains the following: +\begin{verbatim} +\ProvidesDictionary{myinstitute-glossaries-dictionary}{English} +\deftranslation{Glossary}{Nomenclature} +\deftranslation{Page List (glossaries)}{Location} +\end{verbatim} +You can now load it using: +\begin{verbatim} +\usedictionary{myinstitute-glossaries-dictionary} +\end{verbatim} +(Make sure that \texttt{myinstitute-glossaries-dictionary-English.dict} +can be found by \TeX.) If you want to share your custom dictionary, +you can upload it to \href{http://www.ctan.org/}{CTAN}. If you are using \sty{babel} and don't want to use the \sty{translator} interface, you can suppress it using the package @@ -674,8 +920,8 @@ If you are using \sty{polyglossia} instead of \sty{babel}, \sty{glossaries-polyglossia} will automatically be loaded unless you specify the package option \pkgopt[false]{translate}. -Note that \app{xindy} provides much better multi-lingual support -than \app{makeindex}, so it's recommended that you use \app{xindy} +Note that \gls{xindy} provides much better multi-lingual support +than \gls{makeindex}, so it's recommended that you use \gls*{xindy} if you have glossary entries that contain diacritics or non-Roman letters. See \sectionref{sec:xindy} for further details. @@ -689,39 +935,59 @@ intermediate step. It is this application that creates the file containing the code that typesets the glossary. If this step is omitted, the glossaries will not appear in your document. The two indexing applications that are most commonly used with \LaTeX\ are -\app{makeindex} and \app{xindy}. As from version 1.17, the +\gls{makeindex} and \gls{xindy}. As from version 1.17, the \styfmt{glossaries} package can be used with either of these applications. Previous versions were designed to be used with -\app{makeindex} only. Note that \app{xindy} has much better -multi-lingual support than \app{makeindex}, so \app{xindy} is +\gls*{makeindex} only. Note that \gls*{xindy} has much better +multi-lingual support than \gls*{makeindex}, so \gls*{xindy} is recommended if you're not writing in English. Commands that only -have an effect when \app{xindy} is used are described in +have an effect when \gls*{xindy} is used are described in \sectionref{sec:xindy}. - The \styfmt{glossaries} package comes with the Perl script -\app{makeglossaries} which will run \app{makeindex} or \app{xindy} +\gls{makeglossaries} which will run \gls{makeindex} or \gls{xindy} on all the glossary files using a customized style file (which is created by \ics{makeglossaries}). See \sectionref{sec:makeglossariesapp} for further details. Perl is stable, cross-platform, open source software that is used by a number of \TeX-related applications. Further information is available at \url{http://www.perl.org/about.html}. -However, whilst it is strongly recommended that you use the -\app{makeglossaries} script, it is possible to use the +The advantages of using \gls*{makeglossaries}: +\begin{itemize} +\item It automatically detects whether to use \gls*{makeindex} or +\gls*{xindy} and sets the relevant application switches. + +\item One call of \gls*{makeglossaries} will run +\gls*{makeindex}/\gls*{xindy} for each glossary type. + +\item If things go wrong, \gls{makeglossaries} will scan the +messages from \gls{makeindex} or \gls{xindy} and attempt to diagnose +the problem in relation to the \styfmt{glossaries} package. This +will hopefully provide more helpful messages in some cases. If it +can't diagnose the problem, you will have to read the relevant transcript +file and see if you can work it out from the \gls*{makeindex} or +\gls*{xindy} messages. + +\end{itemize} + +Whilst it is strongly recommended that you use the +\gls{makeglossaries} script, it is possible to use the \styfmt{glossaries} package without having Perl installed. In which case, if you have used the \pkgopt{xindy} package option, you will -need to use \app{xindy} (see \sectionref{sec:xindyapp}), otherwise -you will need to use \app{makeindex} (see +need to use \gls{xindy} (see \sectionref{sec:xindyapp}), otherwise +you will need to use \gls{makeindex} (see \sectionref{sec:makeindexapp}). Note that some commands and package -options have no effect if you don't use \app{makeglossaries}. These +options have no effect if you don't use \gls*{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to -do an additional \app{makeglossaries}, \app{makeindex} -or \app{xindy} run, as appropriate. For example, -suppose you have defined the following entries: +do an additional \gls{makeglossaries}, \gls{makeindex} +or \gls{xindy} run, as appropriate. For example, +suppose you have defined the following entries:\footnote{Note that +I'm assuming the \glsation{sanitize} has been switched on for the +\gloskey{description} key, which is why I haven't used +\cs{protect}\cs{gls} in the description.} \begin{verbatim} \newglossaryentry{citrusfruit}{name={citrus fruit}, description={fruit of any citrus tree. (See also @@ -734,7 +1000,7 @@ and suppose you have \verb|\gls{citrusfruit}| in your document but don't reference the \texttt{orange} entry, then the \texttt{orange} entry won't appear in your glossary until you first create the glossary and then do another run -of \app{makeglossaries}, \app{makeindex} or \app{xindy}. +of \gls{makeglossaries}, \gls{makeindex} or \gls{xindy}. For example, if the document is called \texttt{myDoc.tex}, then you must do: \begin{prompt} @@ -745,16 +1011,16 @@ makeglossaries myDoc latex myDoc \end{prompt} -Likewise, an additional \app{makeglossaries} and \LaTeX\ run +Likewise, an additional \gls{makeglossaries} and \LaTeX\ run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second \LaTeX\ run may push glossary entries across page boundaries, which -means that the number lists\iterm{number list} in the glossary may +means that the \glspl{numberlist} in the glossary may need updating. The examples in this document assume that you are accessing -\app{makeglossaries}, \app{xindy} or \app{makeindex} via a terminal. +\gls{makeglossaries}, \gls{xindy} or \gls{makeindex} via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the \menu{Start}\submenu{All Programs} menu or \menu{Start}\submenu{All Programs}\submenu{Accessories} menu. @@ -780,8 +1046,8 @@ using \texttt{xindy} or \texttt{makeindex} explicitly} \label{tab:makeglossariesCmds} \vskip\baselineskip \begin{tabular}{@{}lll@{}} -\bfseries Command or Package Option & \app{makeindex} & -\app{xindy}\\ +\bfseries Command or Package Option & \gls{makeindex} & +\gls{xindy}\\ \pkgopt[letter]{order} & use \texttt{-l} & use \texttt{-M ord/letorder}\\ \pkgopt[word]{order} & default & default\\ @@ -799,11 +1065,11 @@ use \texttt{-C} \meta{code} \subsubsection{Using the makeglossaries Perl Script} \label{sec:makeglossariesapp} -The \app{makeglossaries} script picks up the relevant information +The \gls{makeglossaries} script picks up the relevant information from the auxiliary (\filetype{.aux}) file and will either call -\app{xindy} or \app{makeindex}, depending on the supplied +\gls{xindy} or \gls{makeindex}, depending on the supplied information. Therefore, you only need to pass the document's name -without the extension to \app{makeglossaries}. For example, if your +without the extension to \gls*{makeglossaries}. For example, if your document is called \texttt{myDoc.tex}, type the following in your terminal: \begin{prompt} @@ -811,7 +1077,7 @@ latex myDoc makeglossaries myDoc latex myDoc \end{prompt} -You may need to explicitly load \app{makeglossaries} into Perl: +You may need to explicitly load \gls{makeglossaries} into Perl: \begin{prompt} perl makeglossaries myDoc \end{prompt} @@ -819,28 +1085,35 @@ There is a batch file called \texttt{makeglossaries.bat} which does this for Windows users, but you must have Perl installed to be able to use it. -The \app{makeglossaries} script contains POD (Plain Old +The \gls{makeglossaries} script contains POD (Plain Old Documentation). If you want, you can create a man page for -\app{makeglossaries} using \app{pod2man} and move the -resulting file onto the man path. +\gls*{makeglossaries} using \app{pod2man} and move the +resulting file onto the man path. Alternatively do +\texttt{makeglossaries -{}-help} for a list of all options or +\texttt{makeglossaries -{}-version} for the version number. +\begin{important} +When upgrading the \styfmt{glossaries} package, make sure you also +upgrade your version of \gls{makeglossaries}. The current version is +2.02. +\end{important} \subsubsection{Using xindy explicitly} \label{sec:xindyapp} -If you want to use \app{xindy} to process the glossary +If you want to use \gls{xindy} to process the glossary files, you must make sure you have used the \pkgopt{xindy} package option: \begin{verbatim} \usepackage[xindy]{glossaries} \end{verbatim} -This is required regardless of whether you use \app{xindy} +This is required regardless of whether you use \gls{xindy} explicitly or whether it's called implicitly via -\app{makeglossaries}. This causes the glossary -entries to be written in raw \app{xindy} format, so you need to +\gls{makeglossaries}. This causes the glossary +entries to be written in raw \gls*{xindy} format, so you need to use \texttt{-I xindy} \emph{not} \texttt{-I tex}. -To run \app{xindy} type the following in your terminal +To run \gls{xindy} type the following in your terminal (all on one line): \begin{prompt} xindy -L \meta{language} -C \meta{encoding} -I xindy -M \meta{style} -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo @@ -848,7 +1121,7 @@ xindy -L \meta{language} -C \meta{encoding} -I xindy -M \meta{style} -t \meta{ba where \meta{language} is the required language name, \meta{encoding} is the encoding, \meta{base} is the name of the document without the \filetype{.tex} extension and \meta{style} is the name of the -\app{xindy} style file without the \filetype{.xdy} extension. +\gls{xindy} style file without the \filetype{.xdy} extension. The default name for this style file is \meta{base}\filetype{.xdy} but can be changed via \ics{setStyleFile}\marg{style}. You may need to specify the full path name depending on the current working @@ -875,35 +1148,35 @@ xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn For additional glossaries, the extensions are those supplied when you created the glossary with \ics{newglossary}. -Note that if you use \app{makeglossaries} instead, you can -replace all those calls to \app{xindy} with just one call -to \app{makeglossaries}: +Note that if you use \gls{makeglossaries} instead, you can +replace all those calls to \gls{xindy} with just one call +to \gls*{makeglossaries}: \begin{prompt} makeglossaries myDoc \end{prompt} Note also that some commands and package options have no effect if -you use \app{xindy} explicitly instead of using -\app{makeglossaries}. These are listed in +you use \gls{xindy} explicitly instead of using +\gls*{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. \subsubsection{Using makeindex explicitly} \label{sec:makeindexapp} -If you want to use \app{makeindex} explicitly, you must +If you want to use \gls{makeindex} explicitly, you must make sure that you haven't used the \pkgopt{xindy} package option or the glossary entries will be written in the wrong -format. To run \app{makeindex}, type the following in +format. To run \gls*{makeindex}, type the following in your terminal: \begin{prompt} makeindex -s \meta{style}.ist -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo \end{prompt} where \meta{base} is the name of your document without the \filetype{.tex} extension and \meta{style}\filetype{.ist} is the -name of the \app{makeindex} style file. By default, this is +name of the \gls{makeindex} style file. By default, this is \meta{base}\filetype{.ist}, but may be changed via \ics{setStyleFile}\marg{style}. Note that there are other options, -such as \texttt{-l} (letter ordering). See the \app{makeindex} +such as \texttt{-l} (letter ordering). See the \gls*{makeindex} manual for further details. For example, if your document is called \texttt{myDoc.tex}, then @@ -914,7 +1187,7 @@ makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the \pkgopt{acronym} package option) then you must call -\app{makeindex} for each glossary, substituting +\gls{makeindex} for each glossary, substituting \filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the relevant extensions. For example, if you have used the \pkgopt{acronym} package option, then you need to type the @@ -925,22 +1198,22 @@ makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn For additional glossaries, the extensions are those supplied when you created the glossary with \ics{newglossary}. -Note that if you use \app{makeglossaries} instead, you can -replace all those calls to \app{makeindex} with just one call -to \app{makeglossaries}: +Note that if you use \gls{makeglossaries} instead, you can +replace all those calls to \gls{makeindex} with just one call +to \gls*{makeglossaries}: \begin{prompt} makeglossaries myDoc \end{prompt} Note also that some commands and package options have no effect if -you use \app{makeindex} explicitly instead of using -\app{makeglossaries}. These are listed in +you use \gls*{makeindex} explicitly instead of using +\gls{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. \subsubsection{Note to Front-End and Script Developers} -The information needed to determine whether to use \app{xindy} -or \app{makeindex} and the information needed to call those +The information needed to determine whether to use \gls{xindy} +or \gls{makeindex} and the information needed to call those applications is stored in the auxiliary file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is @@ -967,8 +1240,8 @@ The indexing application's style file is specified by \begin{definition}[\DescribeMacro{\@istfilename}] \cs{@istfilename}\marg{filename} \end{definition} -The file extension indicates whether to use \app{makeindex} -(\filetype{.ist}) or \app{xindy} (\filetype{.xdy}). Note that +The file extension indicates whether to use \gls{makeindex} +(\filetype{.ist}) or \gls{xindy} (\filetype{.xdy}). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it's important to call the correct one. @@ -979,7 +1252,7 @@ Word or letter ordering is specified by: \end{definition} where \meta{order} can be either \texttt{word} or \texttt{letter}. -If \app{xindy} should be used, the language and code page +If \gls{xindy} should be used, the language and code page for each glossary is specified by \begin{definition}[\DescribeMacro{\@xdylanguage}\DescribeMacro{\@gls@codepage}] \cs{@xdylanguage}\marg{label}\marg{language}\\ @@ -988,185 +1261,122 @@ for each glossary is specified by where \meta{label} identifies the glossary, \meta{language} is the root language (e.g.\ \texttt{english}) and \meta{code} is the encoding (e.g.\ \texttt{utf8}). These commands are omitted -if \app{makeindex} should be used. - - -\subsection{Troubleshooting} -\label{sec:trouble} - -The \styfmt{glossaries} package comes with a minimal file called -\texttt{minimalgls.tex} which can be used for testing. This -should be located in the \texttt{samples} subdirectory (folder) -of the \styfmt{glossaries} documentation directory. The location -varies according to your operating system and \TeX\ installation. -For example, on my Linux partition it can be found in -\texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. -Further information on debugging \LaTeX\ code is available at -\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. - -Below is a list of the most frequently asked questions. For -other queries, consult the \styfmt{glossaries} FAQ at -\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. +if \gls{makeindex} should be used. -\begin{enumerate} -\item \textbf{Q.} I get the error message: -\begin{verbatim} -Missing \begin{document} -\end{verbatim} -\textbf{A.} Check you are using an up to date version of the \sty{xkeyval} -package. - -\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms -are displayed in normal sized upper case letters. - -\textbf{A.} The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset -the acronyms. This command converts lower case letters to small -capitals, while upper case letters remain their usual size. Therefore -you need to specify the acronym in lower case letters. - -\item \textbf{Q.} My acronyms won't break across a line when they're -expanded. +\section{Package Options} +\label{sec:pkgopts} -\textbf{A.} PDF\LaTeX\ can break hyperlinks across a line, but -\LaTeX\ can't. If you can't use PDF\LaTeX\ then disable the first use -links using the package option \pkgopt[false]{hyperfirst}. +This section describes the available \styfmt{glossaries} package options. -\item \textbf{Q.} How do I change the font that the acronyms are displayed in? +\subsection{General Options} +\label{sec:pkgopts-general} -\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package -option and redefine \cs{acronymfont} to use the required typesetting -command. For example, suppose you would like the acronyms displayed in -a sans-serif font, then you can do: -\begin{verbatim} -\usepackage[smaller]{glossaries} -\renewcommand*{\acronymfont}[1]{\textsf{#1}} -\end{verbatim} +\begin{description} +\item[\pkgopt{nowarn}] This suppresses all warnings generated by +the \styfmt{glossaries} package. -\item \textbf{Q.} How do I change the font that the acronyms are displayed in -on \firstuse? +\item[\pkgopt{nomain}] This suppresses the creation of the main +glossary. Note that if you use this option, you must create another +glossary in which to put all your entries (either via the +\pkgopt{acronym} package option described in +\sectionref{sec:pkgopts-acronym} or via \ics{newglossary} described +in \sectionref{sec:newglossary}). -\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package -option and redefine \cs{firstacronymfont} to use the required -command. Note that if you don't want the acronym on subsequent use -to use \cs{textsmaller}, you will also need to redefine \cs{acronymfont}, -as above. For example to make the acronym emphasized on -\firstuse, but use the surrounding font for subsequent use, you can do: +\item[\pkgopt{sanitize}] This is a +\meta{key}=\meta{value} option whose value is also a +\meta{key}=\meta{value} list. By default, the \styfmt{glossaries} +package \glspl{sanitize} the values of the \gloskey{name}, +\gloskey{description} and \gloskey{symbol} keys used when defining a +new glossary entry. This means that you can use fragile commands in +those keys, but it may lead to unexpected results if you try to +display these values within the document text. This sanitization can +be switched off using the \pkgopt{sanitize} package option. +For example, to switch off the sanitization +for the \gloskey{description} and \gloskey{name} keys, but not for +the \gloskey{symbol} key, do: \begin{verbatim} -\usepackage[smaller]{glossaries} -\renewcommand*{\firstacronymfont}[1]{\emph{#1}} -\renewcommand*{\acronymfont}[1]{#1} +\usepackage[sanitize={name=false,description=false,% +symbol=true}]{glossaries} \end{verbatim} +You can use \pkgopt[none]{sanitize} as a shortcut for\newline +\pkgoptfmt{sanitize=\{name=false,description=false,symbol=false\}}. -\item \textbf{Q.} I don't have Perl installed, do I have to use -\app{makeglossaries}? - -\textbf{A.} Although it is strongly recommended that you use -\app{makeglossaries}, you don't have to use it. For further details, -read \sectionref{sec:xindyapp} or \sectionref{sec:makeindexapp}, -depending on whether you want to use \app{xindy} or \app{makeindex}. - -\item \textbf{Q.} I'm used to using the \styfmt{glossary} package: are there any -instructions on migrating from the \sty{glossary} package to the -\styfmt{glossaries} package? - -\textbf{A.} Read \qtdocref{Upgrading from the glossary package to -the glossaries package}{glossary2glossaries} which should be -available from the same location as this document. - -\item \textbf{Q.} I'm using \sty{babel} but the fixed names haven't -been translated. - -\textbf{A.} The \styfmt{glossaries} package currently only supports -the following languages: Brazilian Portuguese, Danish, Dutch, -English, French, German, Irish, Italian, Hungarian, Polish, Serbian and -Spanish. If you want to add another language, send me the -translations, and I'll add them to the next version. - -If you are using one of the above languages, but the text hasn't been -translated, try adding the \sty{translator} package with the -required languages explicitly (before you load the \styfmt{glossaries} -package). For example: -\begin{verbatim} -\usepackage[ngerman]{babel} -\usepackage[ngerman]{translator} -\usepackage{glossaries} -\end{verbatim} -Alternatively, you can add the language as a global option -to the class file. Check the \styfmt{translator} package documentation -for further details. +\begin{important}% +\textbf{Note}: this sanitization only applies to the \gloskey{name}, +\gloskey{description} and \gloskey{symbol} keys. It doesn't apply +to any of the other keys (except the \gloskey{sort} key which is +always \glsd{sanitize} if \pkgopt[standard]{sort} is in effect) so fragile commands contained in the value of +the other keys must always be protected using \cs{protect}. +Since the value of the \gloskey{text} key is obtained from the +\gloskey{name} key, you will still need to protect fragile commands +in the \gloskey{name} key if you don't use the \gloskey{text} key. +\end{important} -\item \textbf{Q.} My acronyms contain strange characters when I use commands -like \ics{acrlong}. +\item[\pkgopt{savewrites}] This is a boolean option to minimises the +number of write registers used by the \styfmt{glossaries} package. +(Default is \pkgopt[false]{savewrites}.) There are only a limited +number of write registers, and if you have a large number of +glossaries or if you are using a class or other packages that +create a lot of external files, you may exceed the maximum number +of available registers. If \pkgopt{savewrites} is set, the glossary +information will be stored in token registers until the end of the +document when they will be written to the external files. If you run +out of token registers, you can use \sty{etex}. -\textbf{A.} Switch off the sanitization: +\begin{important} +If you want to use \TeX's \ics{write18} mechanism to call +\gls{makeindex} or \gls{xindy} from your document and use +\pkgopt{savewrites}, you must create the external files with +\cs{glswritefiles} before you call \gls*{makeindex}/\gls*{xindy}. Also set +\cs{glswritefiles} to nothing or \cs{relax} before the end of the +document to avoid rewriting the files. For example: \begin{verbatim} -\usepackage[sanitize=none]{glossaries} +\glswritefiles +\write18{makeindex -s \istfilename\space -t \jobname.glg +-o \jobname.gls \jobname} +\let\glswritefiles\relax \end{verbatim} -and protect fragile commands. - -\item \textbf{Q.} My glossaries haven't appeared. - -\textbf{A.} Remember to do the following: -\begin{itemize} -\item Add \ics{makeglossaries} to the document preamble. - -\item Use either \ics{printglossary} for each glossary that has -been defined or \ics{printglossaries}. - -\item Use the commands listed in \sectionref{sec:glslink}, -\sectionref{sec:glsadd} or \sectionref{sec:crossref} for each entry -that you want to appear in the glossary. - -\item Run \LaTeX\ on your document, then run \app{makeglossaries}, -then run \LaTeX\ on your document again. If you want the glossaries -to appear in the table of contents, you will need an extra \LaTeX\ -run. If any of your entries cross-reference an entry that's not -referenced in the main body of the document, you will need to run -\app{makeglossaries} (see \sectionref{sec:makeglossaries}) after the -second \LaTeX\ run, followed by another \LaTeX\ run. -\end{itemize} - -Check the log files (\filetype{.log}, \filetype{.glg} etc) for any -warnings. +\end{important} -\item \textbf{Q.} It is possible to change the rules used to sort -the glossary entries? +\item[\pkgopt{translate}] This is a boolean option. The default is +\pkgoptval{true}{translate} if \sty{babel}, \sty{polyglossia} or +\sty{translator} have been loaded, otherwise the default value is +\pkgoptval{false}{translate}. -\textbf{A.} If it's for an individual entry, then you can use the -entry's \gloskey{sort} key to sort it according to a different term. -If it's for the entire alphabet, then you will need to use -\app{xindy} (instead of \app{makeindex}) and use an appropriate -\app{xindy} language module. Writing \app{xindy} modules or styles -is beyond the scope of this manual. Further information about -\app{xindy} can be found at the -\urlfootref{http://xindy.sourceforge.net/}{Xindy Web Site}. There is -also a link to the \app{xindy} mailing list from that site. + \begin{description} + \item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded + and the \sty{translator} package is installed, \sty{translator} + will be loaded and the translations will be provided by the + \sty{translator} package interface. You can modify the + translations by providing your own dictionary. If the + \sty{translator} package isn't installed and \sty{babel} is + loaded, the \sty{glossaries-babel} package will + be loaded and the translations will be provided using \styfmt{babel}'s + \cs{addto}\cs{caption}\meta{language} mechanism. If + \sty{polyglossia} has been loaded, \sty{glossaries-polyglossia} + will be loaded. -\end{enumerate} + \item[{\pkgopt[false]{translate}}] Don't provide translations, even + if \sty{babel} or \sty{polyglossia} has been loaded. You can + then provide you're own translations or explicitly load + \sty{glossaries-babel} or \sty{glossaries-polyglossia}. + \end{description} +See \sectionref{sec:fixednames} for further details. -\section{Overview of Main User Commands}\label{sec:overview} - \changes{1.02}{2007 May 25}{added overview section} +\item[\pkgopt{hyperfirst}] This is a boolean option that specifies +whether each term has a hyperlink on \firstuse. The default is +\pkgopt[true]{hyperfirst} (terms on \gls{firstuse} have a hyperlink, +unless explicitly suppressed using starred versions of commands +such as \ics{gls*}). -This section is an overview of the main user commands and package -options. If you find this too complicated, try starting out with the -\docref{guide for beginners}{glossariesbegin}. +\end{description} -\subsection{Package Options} -\label{sec:pkgopts} +\subsection{Sectioning and TOC Options} +\label{sec:pkgopts-sec} -The \styfmt{glossaries} package options are as follows: \begin{description} -\item[\pkgopt{nowarn}] This suppresses all warnings generated by -the \styfmt{glossaries} package. - -\item[\pkgopt{nomain}] This suppresses the creation of the main -glossary. Note that if you use this option, you must create another -glossary in which to put all your entries (either via the -\pkgopt{acronym} package option described below or via -\ics{newglossary} described in \sectionref{sec:newglossary}). - \item[\pkgopt{toc}] Add the glossaries to the table of contents. Note that an extra \LaTeX\ run is required with this option. Alternatively, you can switch this function on and off using @@ -1179,44 +1389,13 @@ and \end{definition} \item[\pkgopt{numberline}] When used with \pkgopt{toc}, this will -add \cs{numberline}\verb|{}| in the final argument of -\cs{addcontentsline}. This will align the table of contents entry +add \ics{numberline}\verb|{}| in the final argument of +\ics{addcontentsline}. This will align the table of contents entry with the numbered section titles. Note that this option has no effect if the \pkgopt{toc} option is omitted. If \pkgopt{toc} is used without \pkgopt{numberline}, the title will be aligned with the section numbers rather than the section titles. -\item[\pkgopt{acronym}] This creates a new glossary with the -label \texttt{acronym}. This is equivalent to: -\begin{verbatim} -\newglossary[alg]{acronym}{acr}{acn}{\acronymname} -\end{verbatim} -If the \pkgopt{acronym} package option is used, \ics{acronymtype} -is set to \texttt{acronym} otherwise it is set to -\texttt{main}.\footnote{Actually it sets \ics{acronymtype} to -\ics{glsdefaulttype} if the \pkgopt{acronym} package option is -not used, but \ics{glsdefaulttype} usually has the value -\texttt{main}.} -Entries that are defined using \ics{newacronym} are placed in -the glossary whose label is given by \ics{acronymtype}, unless -another glossary is explicitly specified. - -\item[\pkgopt{acronymlists}] By default, only the \texttt{acronym} -glossary is considered to be a list of acronyms. If you have other -lists of acronyms, you can specify them as a comma-separated list -in the value of \pkgopt{acronymlists}. For example, if you want -the \texttt{main} glossary to also contain a list of acronyms, you -can do: -\begin{verbatim} -\usepackage[acronym,acronymlists={main}]{glossaries} -\end{verbatim} -No check is performed to determine if the listed glossaries exist, -so you can add glossaries you haven't defined yet. For example: -\begin{verbatim} -\usepackage[acronym,acronymlists={main,acronym2}]{glossaries} -\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} -\end{verbatim} - \item[\pkgopt{section}] This is a \meta{key}=\meta{value} option. Its value should be the name of a sectional unit (e.g.\ chapter). This will make the glossaries appear in the named sectional unit, @@ -1244,7 +1423,8 @@ The start of each glossary adds information to the page header via \begin{definition}[\DescribeMacro{\glossarymark}] \cs{glossarymark}\marg{glossary title} \end{definition} -This defaults to \cs{@mkboth}, but you may need to redefine it. +This defaults to \cs{@mkboth} unless \cls{memoir} is loaded, but you may +need to redefine it. For example, to only change the right header: \begin{verbatim} \renewcommand{\glossarymark}[1]{\markright{#1}} @@ -1315,10 +1495,69 @@ Or, if you are undecided on a prefix: The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. \end{verbatim} +\end{description} + +\subsection{Glossary Appearance Options} +\label{sec:pkgopts-printglos} + +\begin{description} +\item[\pkgopt{entrycounter}] This is a boolean option. (Default +is \pkgopt[false]{entrycounter}.) If set, each main (level~0) +glossary entry will be numbered when using the standard glossary +styles. This option creates the counter +\DescribeCounter{glossaryentry}\ctrfmt{glossaryentry}. + +If you use this option, you can reference the entry number +within the document using +\begin{definition}[\DescribeMacro{\glsrefentry}] +\cs{glsrefentry}\marg{label} +\end{definition} +where \meta{label} is the label associated with that glossary entry. + +\begin{important} +If you use \cs{glsrefentry}, you must run \LaTeX\ twice after +creating the glossary files using \gls{makeglossaries}, +\gls{makeindex} or \gls{xindy} to ensure the cross-references are +up-to-date. +\end{important} -\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its -value should be the name of the glossary style to use. Predefined -glossary styles are listed in \sectionref{sec:styles}. +\item[\pkgopt{counterwithin}] This is a \meta{key}=\meta{value} +option where \meta{value} is the name of a counter. If used, this +option will automatically set \pkgopt[true]{entrycounter} and the +\ctr{glossaryentry} counter will be reset every time \meta{value} is +incremented. + +\begin{important} +The \ctr{glossaryentry} counter isn't automatically reset at the +start of each glossary, except when glossary section numbering is on +and the counter used by \pkgopt{counterwithin} is the same as the +counter used in the glossary's sectioning command. If you want +the counter reset at the start of each glossary, you can redefine +\ics{glossarypreamble} so that it sets \ctr{glossaryentry} to zero: +\begin{verbatim} +\renewcommand{\glossarypreamble}{% + \setcounter{glossaryentry}{0}% +} +\end{verbatim} +\end{important} + +\item[\pkgopt{subentrycounter}] This is a boolean option. (Default +is \pkgopt[false]{subentrycounter}.) If set, each level~1 +glossary entry will be numbered when using the standard glossary +styles. This option creates the counter +\DescribeCounter{glossarysubentry}\ctrfmt{glossarysubentry}. +The counter is reset with each main (level~0) entry. Note that this +package option is independent of \pkgopt{entrycounter}. You can +reference the number within the document using +\ics{glsrefentry}\marg{label} where \meta{label} is the label +associated with the sub-entry. (See above.) + +\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. +(Default is \pkgopt[list]{style}.) Its value should be the name of +the glossary style to use. This key may only be used for styles +defined in \sty{glossary-list}, \sty{glossary-long}, +\sty{glossary-super} or \sty{glossary-tree}. (See +\sectionref{sec:styles}.) \item[\pkgopt{nolong}] This prevents the \styfmt{glossaries} package from automatically loading \sty{glossary-long} (which means that @@ -1359,82 +1598,71 @@ the \gloskey[printglossary]{style} key in the optional argument to \ics{printglossary}. \item[\pkgopt{nonumberlist}] This option will suppress the -associated number lists\iterm{number list} in the glossaries (see also +associated \glspl{numberlist} in the glossaries (see also \sectionref{sec:numberlists}). -\item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option. The -value should be the name of the default counter to use in the number -lists\iterm{number list}. +\item[\pkgopt{seeautonumberlist}] If you suppress the +\glspl{numberlist} with \pkgopt{nonumberlist}, described above, this +will also suppress any cross-referencing information supplied by the +\gloskey{see} key in \ics{newglossaryentry} or \ics{glssee}. If you +use \pkgopt{seeautonumberlist}, the \gloskey{see} key will +automatically implement \gloskey{nonumberlist=false} for that entry. +(Note this doesn't affect \cs{glssee}.) For further details see +\sectionref{sec:crossref}. -\hypertarget{sanitize}{}\relax \item[\pkgopt{sanitize}] This is a -\meta{key}=\meta{value} option whose value is also a -\meta{key}=\meta{value} list. By default, the \styfmt{glossaries} -package sanitizes the values of the \gloskey{name}, -\gloskey{description} and \gloskey{symbol} keys used when defining a -new glossary entry. This means that you can use fragile commands in -those keys, but it may lead to unexpected results if you try to -display these values within the document text. This sanitization can -be switched off using the \pkgopt{sanitize} package option. \ifpdf -(See \sectionref{sec:pkgopt} and \sectionref{sec:newentry} for -further details.) \fi For example, to switch off the sanitization -for the \gloskey{description} and \gloskey{name} keys, but not for -the \gloskey{symbol} key, do: -\begin{verbatim} -\usepackage[sanitize={name=false,description=false,% -symbol=true}]{glossaries} -\end{verbatim} -You can use \pkgopt[none]{sanitize} as a shortcut for\newline -\pkgoptfmt{sanitize=\{name=false,description=false,symbol=false\}}. +\item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option. +(Default is \pkgopt[page]{counter}.) The value should be the name of +the default counter to use in the \glspl{numberlist} +(see \sectionref{sec:numberlists}). -\begin{important}% -\textbf{Note}: this sanitization only applies to the \gloskey{name}, -\gloskey{description} and \gloskey{symbol} keys. It doesn't apply -to any of the other keys (except the \gloskey{sort} key which is -always sanitized) so fragile commands contained in the value of -the other keys must always be protected using \cs{protect}. -Since the value of the \gloskey{text} key is obtained from the -\gloskey{name} key, you will still need to protect fragile commands -in the \gloskey{name} key if you don't use the \gloskey{text} key. -\end{important} +\end{description} -\item[\pkgopt{description}] This option changes the definition of -\ics{newacronym} to allow a description. See \sectionref{sec:acronyms} -for further details. +\subsection{Sorting Options} +\label{sec:pkgopts-sort} -\item[\pkgopt{footnote}] This option changes the definition of -\ics{newacronym} and the way that acronyms are displayed. See -\sectionref{sec:acronyms} for further details. +\begin{description} +\item[\pkgopt{sort}] This is a \meta{key}=\meta{value} option where +the option can only have one of the following values: -\item[\pkgopt{smallcaps}] This option changes the definition of -\ics{newacronym} and the way that acronyms are displayed. See -\sectionref{sec:acronyms} for further details. +\begin{itemize} +\item \pkgoptval{standard}{sort} : entries are sorted according to +the value of the \gloskey{sort} key used in \ics{newglossaryentry} +(if present) or the \gloskey{name} key (if \gloskey{sort} key is +missing); + +\item \pkgoptval{def}{sort} : entries are sorted in the order in +which they were defined (the \gloskey{sort} key in +\cs{newglossaryentry} is ignored); + +\item \pkgoptval{use}{sort} : entries are sorted according to the +order in which they are used in the document (the \gloskey{sort} key +in \cs{newglossaryentry} is ignored). +\end{itemize} -\item[\pkgopt{smaller}] This option changes the definition of -\ics{newacronym} and the way that acronyms are displayed. -If you use this option, you will need to include the \sty{relsize} -package or otherwise define \ics{textsmaller} or redefine -\ics{acronymfont}. See \sectionref{sec:acronyms} for further details. +The default is \pkgopt[standard]{sort}. -\item[\pkgopt{dua}] This option changes the definition of -\ics{newacronym} so that acronyms are always expanded. -See \sectionref{sec:acronyms} for further details. +\item[\pkgopt{order}] This may take two values: +\pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default +is word ordering. -\item[\pkgopt{shortcuts}] This option provides shortcut commands -for acronyms. See \sectionref{sec:acronyms} for further details. +\begin{important} +Note that the \pkgopt{order} option has no effect if you don't use +\gls{makeglossaries}. +\end{important} \item[\pkgopt{makeindex}] (Default) The glossary information and -indexing style file will be written in \app{makeindex} format. If -you use \app{makeglossaries}, it will automatically detect that it -needs to call \app{makeindex}. If you don't use -\app{makeglossaries}, you need to remember to use \app{makeindex} -not \app{xindy}. The indexing style file will been given a +indexing style file will be written in \gls{makeindex} format. If +you use \gls{makeglossaries}, it will automatically detect that it +needs to call \gls*{makeindex}. If you don't use +\gls*{makeglossaries}, you need to remember to use \gls*{makeindex} +not \gls{xindy}. The indexing style file will been given a \filetype{.ist} extension. \item[\pkgopt{xindy}] The glossary information and indexing style -file will be written in \app{xindy} format. If you use -\app{makeglossaries}, it will automatically detect that it needs to -call \app{xindy}. If you don't use \app{makeglossaries}, you need to -remember to use \app{xindy} not \app{makeindex}. The indexing style +file will be written in \gls{xindy} format. If you use +\gls{makeglossaries}, it will automatically detect that it needs to +call \gls*{xindy}. If you don't use \gls*{makeglossaries}, you need to +remember to use \gls*{xindy} not \gls{makeindex}. The indexing style file will been given a \filetype{.xdy} extension. The \pkgopt{xindy} package option may additionally have a value that @@ -1448,76 +1676,87 @@ glossary. This defaults to true, but can be suppressed. For example: \begin{verbatim} \usepackage[xindy={glsnumbers=false}]{glossaries} \end{verbatim} -See \sectionref{sec:xindy} for further details on using \app{xindy} +See \sectionref{sec:xindy} for further details on using \gls{xindy} with the \styfmt{glossaries} package. -\item[\pkgopt{order}] This may take two values: -\pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default -is word ordering. Note that this option has no effect if you -don't use \app{makeglossaries}. +\end{description} -\item[\pkgopt{translate}] This is a boolean option. The default is -\pkgoptval{true}{translate} if \sty{babel}, \sty{polyglossia} or -\sty{translator} have been loaded, otherwise the default value is -\pkgoptval{false}{translate}. +\subsection{Acronym Options} +\label{sec:pkgopts-acronym} - \begin{description} - \item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded - and the \sty{translator} package is installed, \sty{translator} - will be loaded and the translations will be provided by the - \sty{translator} package interface. You can modify the - translations by providing your own dictionary. If the - \sty{translator} package isn't installed and \sty{babel} is - loaded, the \sty{glossaries-babel} package will - be loaded and the translations will be provided using \styfmt{babel}'s - \cs{addto}\cs{caption}\meta{language} mechanism. If - \sty{polyglossia} has been loaded, \sty{glossaries-polyglossia} - will be loaded. +\begin{description} +\item[\pkgopt{acronym}] This creates a new glossary with the +label \texttt{acronym}. This is equivalent to: +\begin{verbatim} +\newglossary[alg]{acronym}{acr}{acn}{\acronymname} +\end{verbatim} +If the \pkgopt{acronym} package option is used, \ics{acronymtype} +is set to \texttt{acronym} otherwise it is set to +\texttt{main}.\footnote{Actually it sets \ics{acronymtype} to +\ics{glsdefaulttype} if the \pkgopt{acronym} package option is +not used, but \ics{glsdefaulttype} usually has the value +\texttt{main}.} +Entries that are defined using \ics{newacronym} are placed in +the glossary whose label is given by \ics{acronymtype}, unless +another glossary is explicitly specified. - \item[{\pkgopt[false]{translate}}] Don't provide translations, even - if \sty{babel} or \sty{polyglossia} has been loaded. You can - then provide you're own translations or explicitly load - \sty{glossaries-babel} or \sty{glossaries-polyglossia}. - \end{description} +\item[\pkgopt{acronymlists}] By default, only the \cs{acronymtype} +glossary is considered to be a list of acronyms. If you have other +lists of acronyms, you can specify them as a comma-separated list +in the value of \pkgopt{acronymlists}. For example, if you use the +\pkgopt{acronym} package option but you also want the \texttt{main} +glossary to also contain a list of acronyms, you can do: +\begin{verbatim} +\usepackage[acronym,acronymlists={main}]{glossaries} +\end{verbatim} +No check is performed to determine if the listed glossaries exist, +so you can add glossaries you haven't defined yet. For example: +\begin{verbatim} +\usepackage[acronym,acronymlists={main,acronym2}]{glossaries} +\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} +\end{verbatim} -See \sectionref{sec:fixednames} for further details. +\item[\pkgopt{description}] This option changes the definition of +\ics{newacronym} to allow a description. This option has no effect if +you defined your own custom acronym style. See +\sectionref{sec:acronyms} for further details. -\item[\pkgopt{hyperfirst}] This is a boolean option that specifies -whether each term has a hyperlink on \firstuse. The default is -\pkgopt[true]{hyperfirst} (terms on first use have a hyperlink, -unless explicitly suppressed using starred versions of commands -such as \cs{gls*}). +\item[\pkgopt{footnote}] This option changes the definition of +\ics{newacronym} and the way that acronyms are displayed. This +option has no effect if you defined your own custom acronym style. See +\sectionref{sec:acronyms} for further details. -\end{description} +\item[\pkgopt{smallcaps}] This option changes the definition of +\ics{newacronym} and the way that acronyms are displayed. This +option may have no effect if you defined your own custom acronym +style. See \sectionref{sec:acronyms} for further details. -\subsection{Defining Glossary Entries} -\label{sec:newglosentry} +\item[\pkgopt{smaller}] This option changes the definition of +\ics{newacronym} and the way that acronyms are displayed. If you use +this option, you will need to include the \sty{relsize} package or +otherwise define \ics{textsmaller} or redefine \ics{acronymfont}. +This option may have no effect if you defined your own custom acronym +style. See \sectionref{sec:acronyms} for further details. -All glossary entries must be defined before they are used, so it is -better to define them in the preamble to ensure this.\footnote{The -only preamble restriction on \cs{newglossaryentry} and -\cs{newacronym} was removed in version 1.13, but the restriction -remains for \cs{loadglsentries}.} However only those entries that -occur in the document (using any of the commands described in -\sectionref{sec:glslink}, \sectionref{sec:glsadd} or -\sectionref{sec:crossref}) will appear in the glossary. Each time an -entry is used in this way, a line is added to an associated glossary -file (\filetype{.glo}), which then needs to be converted into a -corresponding \filetype{.gls} file which contains the typeset -glossary which is input by \ics{printglossary} or -\ics{printglossaries}. The Perl script \app{makeglossaries} can be -used to call \app{makeindex} or \app{xindy}, using a customised -indexing style file, for each of the glossaries that are defined in -the document. Note that there should be no need for you to -explicitly edit or input any of these external files. See -\sectionref{sec:makeglossaries} for further details. +\item[\pkgopt{dua}] This option changes the definition of +\ics{newacronym} so that acronyms are always expanded. This +option has no effect if you defined your own custom acronym style. +See \sectionref{sec:acronyms} for further details. + +\item[\pkgopt{shortcuts}] This option provides shortcut commands +for acronyms. See \sectionref{sec:acronyms} for further details. + +\end{description} + +\section{Setting Up} +\label{sec:setup} The command \begin{definition}[\DescribeMacro{\makeglossaries}] \cs{makeglossaries} \end{definition} must be placed in the preamble in order to create the customised -\app{makeindex} (\filetype{.ist}) or \app{xindy} (\filetype{.xdy}) +\gls{makeindex} (\filetype{.ist}) or \gls{xindy} (\filetype{.xdy}) style file and to ensure that glossary entries are written to the appropriate output files. If you omit \cs{makeglossaries} none of the glossaries will be created. @@ -1530,16 +1769,21 @@ to use those commands after \cs{makeglossaries} you will generate an error. \end{important} -You can suppress the creation of the customised \app{xindy} -or \app{makeindex} style file using +You can suppress the creation of the customised \gls{xindy} +or \gls{makeindex} style file using \begin{definition}[\DescribeMacro{\noist}] \cs{noist} \end{definition} Note that this command must be used before \cs{makeglossaries}. +\begin{important} +Note that if you have a custom \filetype{.xdy} file created when using +\styfmt{glossaries} version 2.07 or below, you will need to use the +\pkgopt{compatible-2.07} package option with it. +\end{important} The default name for the customised style file is given by -\ics{jobname}\filetype{.ist} (for \app{makeindex}) or -\ics{jobname}\filetype{.xdy} (for \app{xindy}). This name may be +\ics{jobname}\filetype{.ist} (for \gls{makeindex}) or +\ics{jobname}\filetype{.xdy} (for \gls{xindy}). This name may be changed using: \begin{definition}[\DescribeMacro{\setStyleFile}] \cs{setStyleFile}\marg{name} @@ -1548,7 +1792,7 @@ where \meta{name} is the name of the style file without the extension. Note that this command must be used before \cs{makeglossaries}. -Each glossary entry is assigned a \term{number list} that lists all +Each glossary entry is assigned a \gls{numberlist} that lists all the locations in the document where that entry was used. By default, the location refers to the page number but this may be overridden using the \pkgopt{counter} package option. The default form of @@ -1564,20 +1808,45 @@ For example: \end{verbatim} Note that this command must be used before \cs{makeglossaries}. -If you use \app{xindy}, you can have a different compositor for page +If you use \gls{xindy}, you can have a different compositor for page numbers starting with an uppercase alphabetical character using: \begin{definition}[\DescribeMacro{\glsSetAlphaCompositor}] \cs{glsSetAlphaCompositor}\marg{symbol} \end{definition} Note that this command has no effect if you haven't used the -\pkgopt{xindy} package option. For example, if you want number -lists\iterm{number list} containing a mixture of A-1 and 2.3 style +\pkgopt{xindy} package option. For example, if you want +\glspl{numberlist} containing a mixture of A-1 and 2.3 style formats, then do: \begin{verbatim} -\glsSetCompositor{.} \glsSetAlphaCompositor{-} +\glsSetCompositor{.}\glsSetAlphaCompositor{-} \end{verbatim} See \sectionref{sec:numberlists} for further information about -number lists\iterm{number list}. +\glspl{numberlist}. + +\section{Defining Glossary Entries} +\label{sec:newglosentry} + +All glossary entries must be defined before they are used, so it is +better to define them in the preamble to ensure this.\footnote{The +only preamble restriction on \ics{newglossaryentry} and +\ics{newacronym} was removed in version 1.13, but the restriction +remains for \ics{loadglsentries}.} However only those entries that +occur in the document (using any of the commands described in +\sectionref{sec:glslink}, \sectionref{sec:glsadd} or +\sectionref{sec:crossref}) will appear in the glossary. Each time an +entry is used in this way, a line is added to an associated glossary +file (\filetype{.glo}), which then needs to be converted into a +corresponding \filetype{.gls} file which contains the typeset +glossary which is input by \ics{printglossary} or +\ics{printglossaries}. The Perl script \gls{makeglossaries} can be +used to call \gls{makeindex} or \gls{xindy}, using a customised +indexing style file, for each of the glossaries that are defined in +the document. \textbf{Note that there should be no need for you to +explicitly edit or input any of these external +files.}\footnote{Except possibly the style file but then you'll need +to use \ics{noist} to prevent your changes from being +overwritten.} See +\sectionref{sec:makeglossaries} for further details. New glossary entries are defined using the command: \begin{definition}[\DescribeMacro{\newglossaryentry}] @@ -1617,33 +1886,41 @@ not \verb"\\" if you want to force a line break. the parent entry must be defined before its sub-entries. See \sectionref{sec:subentries} for further details. -\item[{\gloskey{descriptionplural}}] The plural form of the +\item[{\gloskey{descriptionplural}}] The plural form of the description (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value -is set to the same as the \gloskey{description} key. +is set to the same as the \gloskey{description} key. (Note that if +you want the description to appear in the main body of the document, +you must switch off the description \glsation{sanitize} using the +\pkgopt{sanitize} package option described in +\sectionref{sec:pkgopts-general}.) \item[{\gloskey{text}}] How this entry will appear in the document text when using \ics{gls} (or one of its uppercase variants). If this field is omitted, the value of the \gloskey{name} key is used. \item[{\gloskey{first}}] How the entry will appear in the document text -the first time it is used with \ics{gls}\ifirstusetext\ (or one of its uppercase +on \firstuse\ with \ics{gls} (or one of its uppercase variants). If this field is omitted, the value of the \gloskey{text} -key is used. +key is used. Note that if you use \ics{glspl}, \ics{Glspl}, +\ics{GLSpl}, \ics{glsdisp} before using \ics{gls}, the +\gloskey{firstplural} value won't be used with \ics{gls}. \item[{\gloskey{plural}}] How the entry will appear in the document text -when using \ics{glspl} (or one of its uppercase variants). -If this field is omitted, the value is obtained by appending -\ics{glspluralsuffix} to the value of the \gloskey{text} field. -The default value of \cs{glspluralsuffix} is the letter -\qt{s}. +when using \ics{glspl} (or one of its uppercase variants). If this +field is omitted, the value is obtained by appending +\ics{glspluralsuffix} to the value of the \gloskey{text} field. The +default value of \ics{glspluralsuffix} is the letter \qt{s}. \item[{\gloskey{firstplural}}] How the entry will appear in the -document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its +document text on \firstuse\ with \ics{glspl} (or one of its uppercase variants). If this field is omitted, the value is obtained from the \gloskey{plural} key, if the \gloskey{first} key is omitted, or by appending \ics{glspluralsuffix} to the value of the -\gloskey{first} field, if the \gloskey{first} field is present. +\gloskey{first} field, if the \gloskey{first} field is present. Note +that if you use \ics{gls}, \ics{Gls}, \ics{GLS}, \cs{glsdisp} before +using \ics{glspl}, the \gloskey{firstplural} value won't be used +with \ics{glspl}. \textbf{Note:} prior to version 1.13, the default value of \gloskey{firstplural} was always taken by appending \qt{s} to the @@ -1651,34 +1928,45 @@ or by appending \ics{glspluralsuffix} to the value of the \gloskey{plural} and \gloskey{firstplural}, even if you hadn't used the \gloskey{first} key. -\item[{\gloskey{symbol}}] This field is provided to allow the user to -specify an associated symbol. If omitted, the value is set to -\cs{relax}. Note that not all glossary styles display the -symbol. +\item[{\gloskey{symbol}}] This field is provided to allow the user +to specify an associated symbol. If omitted, the value is set to +\cs{relax}. Note that not all glossary styles display the symbol. +(If you want the symbol to appear in the main body of the document, +you must switch off the symbol \glsation{sanitize} using the +\pkgopt{sanitize} package option described in +\sectionref{sec:pkgopts-general}.) \item[{\gloskey{symbolplural}}] This is the plural form of the symbol (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value is set to the same as the \gloskey{symbol} key. -\item[{\gloskey{sort}}] This value indicates how \app{makeindex} -or \app{xindy} should sort this entry. If omitted, the value is -given by the \gloskey{name} field. +\item[{\gloskey{sort}}] This value indicates how \gls{makeindex} or +\gls{xindy} should sort this entry. If omitted, the value is given +by the \gloskey{name} field. In general, it's best to use the +\gloskey{sort} key if the \gloskey{name} contains commands (e.g.\ +\verb|\ensuremath{\alpha}|). Note that the package options +\pkgopt[def]{sort} and \pkgopt[use]{sort} override the +\gloskey{sort} key in \ics{newglossaryentry} (see +\sectionref{sec:pkgopts-sort}). \item[{\gloskey{type}}] This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is -assumed. The list of acronyms type is given by -\ics{acronymtype} which will either be \texttt{main} or -\texttt{acronym}, depending on whether the \pkgopt{acronym} package -option was used. - -\item[{\gloskey{user1}, \ldots, \gloskey{user6}}] Six additional -keys provided for any additional information the user may want -to specify. (For example, an associated dimension or an alternative -plural.) - -\item[{\gloskey{nonumberlist}}] Suppress the \term{number list} for -this entry. +assumed unless \ics{newacronym} is used (see +\sectionref{sec:acronyms}). + +\item[{\gloskey{user1}, \ldots, \gloskey{user6}% +\igloskey{user2}\igloskey{user3}\igloskey{user4}\igloskey{user5}}] +Six keys provided for any additional information the user may want +to specify. (For example an associated dimension or an alternative +plural or some other grammatical construct.) + +\item[{\gloskey{nonumberlist}}] A boolean key. If the value is +missing or is "true", this will suppress the \gls{numberlist} just for +this entry. Conversely, if you have used the package option +\pkgopt{nonumberlist}, you can activate the \gls*{numberlist} just +for this entry with \gloskey{nonumberlist=false}. +(See \sectionref{sec:numberlists}.) \item[{\gloskey{see}}] Cross-reference another entry. Using the \gloskey{see} key will automatically add this entry to the @@ -1686,13 +1974,22 @@ glossary, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. If you want to override the \qt{see} tag, you can supply the new tag in square brackets before the label. For example -\verb|see=[see also]{anotherlabel}|. For further details, -see \sectionref{sec:crossref}. +\verb|see=[see also]{anotherlabel}|. Note that if you have +suppressed the \gls{numberlist}, the cross-referencing information +won't appear in the glossary. You can override this for individual +glossary entries using \gloskey{nonumberlist=false} (see above). +Alternatively, you can use the \pkgopt{seeautonumberlist} package +option. For further details, see \sectionref{sec:crossref}. \end{description} -Note that if the name starts with an accented letter or non-Latin -character, you must group the accented letter, otherwise it will -cause a problem for commands like \cs{Gls} and \cs{Glspl}. + +The following keys are reserved for \ics{newacronym} (see +\sectionref{sec:acronyms}): \gloskey{long}, \gloskey{longplural}, +\gloskey{short} and \gloskey{shortplural}. + +Note that if the name starts with an accented letter or non-Roman +character, you must group the character, otherwise it will +cause a problem for commands like \ics{Gls} and \ics{Glspl}. For example: \begin{verbatim} \newglossaryentry{elite}{name={{\'e}lite}, @@ -1705,13 +2002,11 @@ package: description={select group or class}} \end{verbatim} Note that in both of the above examples, you will also need to -supply the \gloskey{sort} key if you are using \app{makeindex} -whereas \app{xindy} is usually able to sort accented letters +supply the \gloskey{sort} key if you are using \gls{makeindex} +whereas \gls{xindy} is usually able to sort accented letters correctly. - - -\subsubsection{Plurals} +\subsection{Plurals} You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending @@ -1759,35 +2054,38 @@ form plurals by simply appending a suffix, all the plural forms must be specified using the \gloskey{plural} key (and the \gloskey{firstplural} key where necessary). - -\subsubsection{Sub-Entries} +\subsection{Sub-Entries} \label{sec:subentries} As from version 1.17, it is possible to specify sub-entries. These -may be used to order the glossary into categories, in which case -the sub-entry will have a different name to its parent entry, or -it may be used to distinguish different definitions for the same -word, in which case the sub-entries will have the same name as -the parent entry. Note that not all glossary styles support -hierarchical entries and may display all the entries in a flat -format. Of the styles that support sub-entries, some display the -sub-entry's name whilst others don't. Therefore you need to -ensure that you use a suitable style. See \sectionref{sec:styles} -for a list of predefined styles. +may be used to order the glossary into categories, in which case the +sub-entry will have a different name to its parent entry, or it may +be used to distinguish different definitions for the same word, in +which case the sub-entries will have the same name as the parent +entry. Note that not all glossary styles support hierarchical +entries and may display all the entries in a flat format. Of the +styles that support sub-entries, some display the sub-entry's name +whilst others don't. Therefore you need to ensure that you use a +suitable style. (See \sectionref{sec:styles} for a list of predefined +styles.) As from version 3.0, level~1 sub-entries are automatically +numbered in the predefined styles if you use the +\pkgopt{subentrycounter} package option (see +\sectionref{sec:pkgopts-printglos} for further details). Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not -have a \term{number list}. +have a \gls{numberlist}. Note also that \gls{makeindex} has a +restriction on the maximum sub-entry depth. +\subsubsection{Hierarchical Categories} -\paragraph{Hierarchical Categories} To arrange a glossary -with hierarchical categories, you need to first define the -category and then define the sub-entries using the relevant -category entry as the value of the \gloskey{parent} key. For -example, suppose I want a glossary of mathematical symbols that -are divided into Greek letters and Roman letters. Then I can -define the categories as follows: +To arrange a glossary with hierarchical categories, you need to +first define the category and then define the sub-entries using the +relevant category entry as the value of the \gloskey{parent} key. +For example, suppose I want a glossary of mathematical symbols that +are divided into Greek letters and Roman letters. Then I can define +the categories as follows: \begin{verbatim} \newglossaryentry{greekletter}{name={Greek letters}, description={\nopostdesc}} @@ -1803,21 +2101,23 @@ description terminator. I can now define my sub-entries as follows: \begin{verbatim} -\newglossaryentry{pi}{name={pi}, +\newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi}, description={ratio of the circumference of a circle to the diameter}, parent=greekletter} -\newglossaryentry{C}{name=C, +\newglossaryentry{C}{name={\ensuremath{C}},sort={C}, description={Euler's constant}, parent=romanletter} \end{verbatim} -\paragraph{Homographs} Sub-entries that have the same name as -the parent entry, don't need to have the \gloskey{name} key. -For example, the word \qt{glossary} can mean a list of technical -words or a collection of glosses. In both cases the plural is -\qt{glossaries}. So first define the parent entry: +\subsubsection{Homographs} + +Sub-entries that have the same name as the parent entry, don't need +to have the \gloskey{name} key. For example, the word \qt{glossary} +can mean a list of technical words or a collection of glosses. In +both cases the plural is \qt{glossaries}. So first define the parent +entry: \begin{verbatim} \newglossaryentry{glossary}{name=glossary, description={\nopostdesc}, @@ -1829,20 +2129,24 @@ terminator needs to be suppressed using \ics{nopostdesc}. Now define the two different meanings of the word: \begin{verbatim} \newglossaryentry{glossarylist}{ -description={1) list of technical words}, +description={list of technical words}, sort={1}, parent={glossary}} \newglossaryentry{glossarycol}{ -description={2) collection of glosses}, +description={collection of glosses}, sort={2}, parent={glossary}} \end{verbatim} Note that if I reference the parent entry, the location will be -added to the parent's \term{number list}, whereas if I reference -any of the child entries, the location will be added to the child -entry's number list. Note also that since the sub-entries have the -same name, the \gloskey{sort} key is required. +added to the parent's \gls{numberlist}, whereas if I reference any +of the child entries, the location will be added to the child +entry's number list. Note also that since the sub-entries have the +same name, the \gloskey{sort} key is required unless you are using +the \pkgopt[use]{sort} or \pkgopt[def]{sort} package options. You +can use the \pkgopt{subentrycounter} package option to automatically +number the first-level child entries. See +\sectionref{sec:pkgopts-printglos} for further details. In the above example, the plural form for both of the child entries is the same as the parent entry, so the \gloskey{plural} key was @@ -1852,12 +2156,12 @@ have different plurals, they will need to be specified. For example: \newglossaryentry{bravo}{name={bravo}, description={\nopostdesc}} -\newglossaryentry{bravocry}{description={1) cry of approval (pl.\ bravos)}, +\newglossaryentry{bravocry}{description={cry of approval (pl.\ bravos)}, sort={1}, plural={bravos}, parent=bravo} -\newglossaryentry{bravoruffian}{description={2) hired ruffian or +\newglossaryentry{bravoruffian}{description={hired ruffian or killer (pl.\ bravoes)}, sort={2}, plural={bravoes}, @@ -1865,7 +2169,7 @@ parent=bravo} \end{verbatim} -\subsubsection{Loading Entries From a File} +\subsection{Loading Entries From a File} \label{sec:loadglsentries} You can store all your glossary entry definitions in another @@ -1874,12 +2178,12 @@ file and use: \cs{loadglsentries}\oarg{type}\marg{filename} \end{definition} where \meta{filename} is the name of the file containing all the -\cs{newglossaryentry} commands. The optional argument +\ics{newglossaryentry} commands. The optional argument \meta{type} is the name of the glossary to which those entries should belong, for those entries where the \gloskey{type} key has been omitted (or, more specifically, for those entries whose -type has been specified by \cs{glsdefaulttype}, which is what -\cs{newglossaryentry} uses by default). For example, suppose I have +type has been specified by \ics{glsdefaulttype}, which is what +\ics{newglossaryentry} uses by default). For example, suppose I have a file called \texttt{myentries.tex} which contains: \begin{verbatim} \newglossaryentry{perl}{type=main, @@ -1902,7 +2206,7 @@ to the glossary whose type is given by \texttt{languages}, but the entry \texttt{perl} will be added to the main glossary, since it explicitly sets the type to \texttt{main}. -\textbf{Note:} if you use \cs{newacronym} (see +\textbf{Note:} if you use \ics{newacronym} (see \sectionref{sec:acronyms}) the type is set as \verb|type=\acronymtype| unless you explicitly override it. For example, if my file \texttt{myacronyms.tex} contains: @@ -1918,41 +2222,52 @@ will add \texttt{aca} to the glossary type \texttt{acronym}, if the package option \pkgopt{acronym} has been specified, or will add \texttt{aca} to the glossary type \texttt{altacronym}, if the package option \pkgopt{acronym} is not specified.\footnote{This is -because \cs{acronymtype} is set to \cs{glsdefaulttype} if the -\pkgopt{acronym} package option is not used.} In this instance, it -is better to change \texttt{myacronyms.tex} to: +because \ics{acronymtype} is set to \ics{glsdefaulttype} if the +\pkgopt{acronym} package option is not used.} + +If you have used the \pkgopt{acronym} package option, +there are two possible solutions to this problem: +\begin{enumerate} +\item Change \texttt{myacronyms.tex} so that entries are defined in +the form: \begin{verbatim} \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} \end{verbatim} -and now +and do: \begin{verbatim} \loadglsentries[altacronym]{myacronyms} \end{verbatim} -will add \texttt{aca} to the glossary type \texttt{altacronym}, -regardless of whether or not the package option \pkgopt{acronym} is -used. + +\item Temporarily change \cs{acronymtype} to the target glossary: +\begin{verbatim} +\let\orgacronymtype\acronymtype +\def\acronymtype{altacronym} +\loadglsentries{myacronyms} +\let\acronymtype\orgacronymtype +\end{verbatim} +\end{enumerate} Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also that \cs{loadglsentries} may only be used in the preamble. -\subsection{Number lists} +\section{Number lists} \label{sec:numberlists} -Each entry in the glossary has an associated \termdef{number list}. -By default, -these numbers refer to the pages on which that entry has been used -(using any of the commands described in \sectionref{sec:glslink} -and \sectionref{sec:glsadd}). The number list can be suppressed using -the \pkgopt{nonumberlist} package option, or an alternative counter -can be set as the default using the \pkgopt{counter} package option. -The number list is also referred to as the location -list\index{location list|see{number list}}. - -Both \app{makeindex} and \app{xindy} concatenate a +Each entry in the glossary has an associated \gls{numberlist}. +By default, these numbers refer to the pages on which that entry has +been used (using any of the commands described in +\sectionref{sec:glslink} and \sectionref{sec:glsadd}). The number +list can be suppressed using the \pkgopt{nonumberlist} package +option, or an alternative counter can be set as the default using +the \pkgopt{counter} package option. The number list is also +referred to as the location list\index{location list|see{number +list}}. + +Both \gls{makeindex} and \gls{xindy} concatenate a sequence of 3 or more consecutive pages into a range. With -\app{xindy} you can vary the minimum sequence length using +\gls*{xindy} you can vary the minimum sequence length using \ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either an integer or the keyword \texttt{none} which indicates that there should be no range formation. @@ -1962,7 +2277,7 @@ Note that \cs{GlsSetXdyMinRangeLength} must be used before \ics{makeglossaries} and has no effect if \ics{noist} is used. \end{important} -With both \app{makeindex} and \app{xindy}, you can replace +With both \gls{makeindex} and \gls{xindy}, you can replace the separator and the closing number in the range using: \begin{definition}[\DescribeMacro{\glsSetSuffixF}] \cs{glsSetSuffixF}\marg{suffix} @@ -1977,7 +2292,7 @@ For example: \glsSetSuffixF{f.} \glsSetSuffixFF{ff.} \end{verbatim} -Note that if you use \app{xindy}, you will also need to +Note that if you use \gls{xindy}, you will also need to set the minimum range length to 1 if you want to change these suffixes: \begin{verbatim} @@ -1998,31 +2313,31 @@ used. \end{important} -\subsection{Links to Glossary Entries} +\section{Links to Glossary Entries} \label{sec:glslink} Once you have defined a glossary entry using \ics{newglossaryentry}, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred -to as the \termdef{link text} (even if there are no hyperlinks). The +to as the \gls{linktext} (even if there are no hyperlinks). The commands in this section also add a line to an external file that is -used by \app{makeindex} or \app{xindy} to generate the relevant +used by \gls{makeindex} or \gls{xindy} to generate the relevant entry in the glossary. This information includes an associated -location that is added to the \term{number list} for that entry. By +location that is added to the \gls{numberlist} for that entry. By default, the location refers to the page number. For further information on number lists, see \sectionref{sec:numberlists}. \begin{important} It is strongly recommended that you don't use the commands defined in this section in the arguments of sectioning or caption -commands. +commands or any other command that has a moving argument. \end{important} The above warning is particularly important if you are using the \styfmt{glossaries} package in conjunction with the \sty{hyperref} package. Instead, use one of the commands listed in -\sectionref{sec:glsnolink} (such as \cs{glsentrytext}) or provide an +\sectionref{sec:glsnolink} (such as \ics{glsentrytext}) or provide an alternative via the optional argument to the sectioning/caption command. Examples: \begin{verbatim} @@ -2030,11 +2345,11 @@ command. Examples: \section[An overview of Perl]{An overview of \gls{perl}} \end{verbatim} -The way the \term{link text} is displayed depends on +The way the \gls{linktext} is displayed depends on \begin{definition}[\DescribeMacro{\glstextformat}] \cs{glstextformat}\marg{text} \end{definition} -For example, to make all \term{link text} appear in a sans-serif +For example, to make all \gls{linktext} appear in a sans-serif font, do: \begin{verbatim} \renewcommand*{\glstextformat}[1]{\textsf{#1}} @@ -2064,11 +2379,11 @@ following keys: \begin{description} \item[{\gloskey[glslink]{format}}] This specifies how to format the associated location number for this entry in the glossary. This -value is equivalent to the \app{makeindex} encap value, and (as -with \cs{index}) the value needs to be the name of a command -\emph{without} the initial backslash. As with \cs{index}, the +value is equivalent to the \gls{makeindex} encap value, and (as +with \ics{index}) the value needs to be the name of a command +\emph{without} the initial backslash. As with \ics{index}, the characters \verb"(" and \verb")" can also be used to specify the -beginning and ending of a number range. Again as with \cs{index}, +beginning and ending of a number range. Again as with \ics{index}, the command should be the name of a command which takes an argument (which will be the associated location). Be careful not to use a declaration (such as \texttt{bfseries}) instead of a text block command @@ -2086,17 +2401,18 @@ block commands such as \ics{textbf} or \ics{emph} or any of the commands listed in \tableref{tab:hyperxx}. \begin{important} -If you use \app{xindy} instead of \app{makeindex}, you +If you use \gls{xindy} instead of \gls{makeindex}, you must specify any non-standard formats that you want to use with the \gloskey[glslink]{format} key using \ics{GlsAddXdyAttribute}\marg{name}. So if you use -\app{xindy} with the above example, you would need to add: +\gls*{xindy} with the above example, you would need to add: \begin{verbatim} \GlsAddXdyAttribute{textbfem} \end{verbatim} +See \sectionref{sec:xindy} for further details. \end{important} -Note that unlike \cs{index}, you can't have anything following the +Note that unlike \ics{index}, you can't have anything following the command name, such as an asterisk or arguments. If you want to cross-reference another entry, either use the \gloskey{see} key when you define the entry or use \ics{glssee} (described in @@ -2129,21 +2445,22 @@ formats listed in \tableref{tab:hyperxx}. \par \end{table} -Note that if the \ics{hyperlink} command hasn't been defined, -the \texttt{hyper}\meta{xx} formats are equivalent to the -analogous \texttt{text}\meta{xx} font commands (and \texttt{hyperemph} -is equivalent to \texttt{emph}). If you want to -make a new format, you will need to define a command which takes -one argument and use that. For example, if you want the location -number to be in a bold sans-serif font, you can define a -command called, say, \cs{hyperbsf}: +Note that if the \ics{hyperlink} command hasn't been defined, the +\texttt{hyper}\meta{xx} formats are equivalent to the analogous +\texttt{text}\meta{xx} font commands (and \texttt{hyperemph} is +equivalent to \texttt{emph}). If you want to make a new format, you +will need to define a command which takes one argument and use that. +For example, if you want the location number to be in a bold +sans-serif font, you can define a command called, say, +\ics{hyperbsf}: \begin{verbatim} \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} \end{verbatim} and then use \texttt{hyperbsf} as the value for the \gloskey{format} -key. \ifpdf (See also \sectionref{sec:code:printglos}.) \fi -Remember that if you use \app{xindy}, you will need to add -this to the list of location attributes: +key. (See also \ifpdf section~\ref*{sec:code:printglos} \fi +\qt{Displaying the glossary} in the documented code, +\texttt{glossaries.pdf}.) Remember that if you use \gls{xindy}, you +will need to add this to the list of location attributes: \begin{verbatim} \GlsAddXdyAttribute{hyperbsf} \end{verbatim} @@ -2155,7 +2472,7 @@ used by this entry. (See also \sectionref{sec:numberlists}.) \item[{\gloskey[glslink]{hyper}}] This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting \texttt{hyper=true} will have no -effect if \cs{hyperlink} has not been defined.) The default +effect if \ics{hyperlink} has not been defined.) The default value is \texttt{hyper=true}. \end{description} @@ -2168,17 +2485,22 @@ which is equivalent to \cs{glslink}, except it sets described in this section also have a starred version that disables the hyperlink. +\begin{important} +Don't use commands like \cs{glslink} or \cs{gls} in the \meta{text} +argument of \cs{glslink}. +\end{important} + The command: \begin{definition}[\DescribeMacro{\gls}] \cs{gls}\oarg{options}\marg{label}\oarg{insert} \end{definition} -is the same as \cs{glslink}, except that the \term{link text} +is the same as \cs{glslink}, except that the \gls{linktext} is determined from the values of the \gloskey{text} and \gloskey{first} keys supplied when the entry was defined using \ics{newglossaryentry}. If the entry has been marked as having been used\ifirstuseflag, the value of the \gloskey{text} key will be used, otherwise the value of the \gloskey{first} key will be used. -On completion, \cs{gls} will mark the entry's first use flag\ifirstuseflag\ as +On completion, \cs{gls} will mark the entry's \gls{firstuseflag} as used. There are two uppercase variants: @@ -2197,11 +2519,15 @@ some additional text into the link text. By default, this will append \meta{insert} at the end of the link text, but this can be changed (see \sectionref{sec:glsdisplay}). - The first optional argument \meta{options} is the same as the optional -argument to \ics{glslink}. As with \cs{glslink}, these commands also +argument to \ics{glslink}. As with \ics{glslink}, these commands also have a starred version that disable the hyperlink. +\begin{important} +Don't use commands like \cs{glslink} or \cs{gls} in the \meta{insert} +argument of \cs{gls} and its variants. +\end{important} + There are also analogous plural forms: \begin{definition}[\DescribeMacro{\glspl}] \cs{glspl}\oarg{options}\marg{label}\oarg{insert} @@ -2217,13 +2543,33 @@ These determine the link text from the \gloskey{plural} and defined. As before, these commands also have a starred version that disable the hyperlink. -Note that \cs{glslink} doesn't use or affect the \firstuseflag, +\begin{important} +Be careful when you use glossary entries in math mode especially if you +are using \sty{hyperref} as it can affect the spacing of subscripts and +superscripts. For example, suppose you have defined the following +entry: +\begin{verbatim} +\newglossaryentry{Falpha}{name={F_\alpha},description=sample} +\end{verbatim} +and later you use it in math mode: +\begin{verbatim} +$\gls{Falpha}^2$ +\end{verbatim} +This will result in $F_\alpha{}^2$ instead of $F_\alpha^2$. In this +situation it's best to bring the superscript into the hyperlink using +the final \meta{insert} optional argument: +\begin{verbatim} +$\gls{Falpha}[^2]$ +\end{verbatim} +\end{important} + +Note that \ics{glslink} doesn't use or affect the \firstuseflag, nor does it use \ics{glsdisplay} or \ics{glsdisplayfirst} (see \sectionref{sec:glsdisplay}). Instead, you can use: \begin{definition}[\DescribeMacro{\glsdisp}] \cs{glsdisp}\oarg{options}\marg{label}\marg{link text} \end{definition} -This behaves in the same way as \cs{gls}, except that it uses +This behaves in the same way as \ics{gls}, except that it uses \meta{link text} instead of the value of the \gloskey{first} or \gloskey{text} key. (Note that this command always sets \meta{insert} to nothing.) This command affects the \firstuseflag, @@ -2255,7 +2601,7 @@ The command: \begin{definition}[\DescribeMacro{\glsfirst}] \cs{glsfirst}\oarg{options}\marg{label}\oarg{insert} \end{definition} -is similar to \ics{glstext} except that it always uses the value +is similar to \cs{glstext} except that it always uses the value of the \gloskey{first} key. Again, \meta{insert} is always appended to the end of the link text and does not affect the \firstuseflag. @@ -2317,7 +2663,7 @@ the \gloskey{name} key. Again, \meta{insert} is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the \gloskey{name} key contains commands, you will have to disable the -\hyperlink{sanitize}{sanitization} of the \gloskey{name} key and +\glsation{sanitize} of the \gloskey{name} key and protect fragile commands. There are also analogous commands: @@ -2339,7 +2685,7 @@ the \gloskey{symbol} key. Again, \meta{insert} is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the \gloskey{symbol} key contains commands, you will have to disable the -\hyperlink{sanitize}{sanitization} of the \gloskey{symbol} key and +\glsation{sanitize} of the \gloskey{symbol} key and protect fragile commands. There are also analogous commands: @@ -2361,7 +2707,7 @@ the \gloskey{description} key. Again, \meta{insert} is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the \gloskey{description} key contains commands, you will have to -disable the \hyperlink{sanitize}{sanitization} of the +disable the \glsation{sanitize} of the \gloskey{description} key and protect fragile commands. There are also analogous commands: @@ -2438,18 +2784,16 @@ the hyperlink. Similarly for the other user keys: \cs{GLSuservi}\oarg{options}\marg{text}\oarg{insert} \end{definition} - - -\subsubsection{Changing the format of the link text} +\subsection{Changing the format of the link text} \label{sec:glsdisplay} -The format of the \term{link text} for \ics{gls}, \ics{glspl} +The format of the \gls{linktext} for \ics{gls}, \ics{glspl} and their uppercase variants is governed by two commands: \begin{definition}[\DescribeMacro{\glsdisplayfirst}] \cs{glsdisplayfirst}\marg{first/first plural}\marg{description}\marg{symbol}\marg{insert} \end{definition} which is used the -first time a glossary entry is used\ifirstuse\ in the text and +\glslink{firstuse}{first time} a glossary entry is used in the text and \begin{definition}[\DescribeMacro{\glsdisplay}] \cs{glsdisplay}\marg{text/plural}\marg{description}\marg{symbol}\marg{insert} \end{definition} @@ -2462,12 +2806,27 @@ description (as supplied by the \gloskey{description} or \gloskey{descriptionplural} keys); the third argument is the symbol associated with the term (as supplied by the \gloskey{symbol} or \gloskey{symbolplural} keys) and the fourth argument is the additional text -supplied in the final optional argument to \cs{gls} or -\cs{glspl} (or their uppercase variants). The default definitions +supplied in the final optional argument to \ics{gls} or +\ics{glspl} (or their uppercase variants). The default definitions of \cs{glsdisplay} and \cs{glsdisplayfirst} simply print the first argument immediately followed by the fourth argument. The remaining arguments are ignored. +\begin{important} +Care needs to be taken when redefining \cs{glsdisplay} and +\cs{glsdisplayfirst} as commands like \ics{Gls} will expand the +displayed text before applying \ics{makefirstuc}. If you want to use +formatting commands, it's best to define a robust version that deals +with all the formatting. For example, suppose you want +the text to appear in bold italic, it's best to do something like: +\begin{verbatim} +\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries #1}} +\renewcommand{\glsdisplay}[4]{\textbfit{#1#4}} +\end{verbatim} +See the \sty{mfirstuc} documentation for further details on the +limitations of \ics{makefirstuc}. +\end{important} + If required, you can access the label for the given entry via \begin{definition}[\DescribeMacro{\glslabel}] \cs{glslabel} @@ -2501,7 +2860,7 @@ it may be in the context of \qt{the distance (km) is measured between the two points} --- but in this instance it would be better not to use a contraction). -Note also that all of the \term{link text} will be formatted according +Note also that all of the \gls{linktext} will be formatted according to \ics{glstextformat} (described earlier). So if you do, say: \begin{verbatim} \renewcommand{\glstextformat}[1]{\textbf{#1}} @@ -2547,17 +2906,17 @@ Now suppose you have defined an entry as follows: symbol={$S$} } \end{verbatim} -The first time you reference this entry it will be displayed as: +The \glslink{firstuse}{first time} you reference this entry it will be displayed as: \qt{set (denoted $S$)} (assuming \ics{gls} was used). Remember that if you use the \gloskey{symbol} key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. In addition, if you want either the description or symbol -to appear in the \term{link text}, you will have to disable the -\hyperlink{sanitize}{sanitization} of these keys and protect fragile +to appear in the \gls{linktext}, you will have to disable the +\glsation{sanitize} of these keys and protect fragile commands. -\subsubsection{Enabling and disabling hyperlinks to glossary entries} +\subsection{Enabling and disabling hyperlinks to glossary entries} If you load the \sty{hyperref} or \sty{html} packages prior to loading the \styfmt{glossaries} package, commands such as \ics{glslink} @@ -2576,13 +2935,13 @@ within a group. Note that you should only use \cs{glsenablehyper} if the commands \ics{hyperlink} and \ics{hypertarget} have been defined (for example, by the \sty{hyperref} package). -You can disable just the first use links using the package +You can disable just the \gls{firstuse} links using the package option \pkgopt[false]{hyperfirst}. Note that this option only -affects commands that recognise the \firstuse\ flag, for example +affects commands that recognise the \firstuseflag, for example \ics{gls}, \ics{glspl} and \ics{glsdisp} but not \ics{glslink}. -\subsection{Adding an Entry to the Glossary Without Generating Text} +\section{Adding an Entry to the Glossary Without Generating Text} \label{sec:glsadd} It is possible to add a line in the glossary file without @@ -2593,7 +2952,7 @@ generating any text at that point in the document using: This is similar to \ics{glslink}, only it doesn't produce any text (so therefore, there is no \gloskey[glslink]{hyper} key available in \meta{options} but all the other options that can -be used with \cs{glslink} can be passed to \cs{glsadd}). +be used with \ics{glslink} can be passed to \cs{glsadd}). For example, to add a page range to the glossary number list for the entry whose label is given by \texttt{set}: \begin{verbatim} @@ -2611,15 +2970,56 @@ there is also a key \gloskey[glsaddall]{types} which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by -the glossary type \cs{acronymtype}) and a list of +the glossary type \ics{acronymtype}) and a list of notation (specified by the glossary type \texttt{notation}) then you can do: \begin{verbatim} \glsaddall[types={\acronymtype,notation}] \end{verbatim} +\begin{important} +Note that \cs{glsadd} and \cs{glsaddall} add the current location to +the number list. In the case of \cs{glsaddall}, all entries in the +glossary will have the same location in the number list. If you want +to use \cs{glsaddall}, it's best to suppress the number list with +the \pkgopt{nonumberlist} package option. (See +sections~\ref{sec:pkgopts-printglos} and~\ref{sec:numberlists}.) +\end{important} + +The sample file \samplefile{-dual} makes use of \cs{glsadd} to +allow for an entry that should appear both in the main glossary and +in the list of acronyms. This example sets up the list of acronyms +using the \pkgopt{acronym} package option: +\begin{verbatim} +\usepackage[acronym]{glossaries} +\end{verbatim} +A new command is then defined to make it easier to define dual +entries: +\begin{verbatim} +\newcommand*{\newdualentry}[5][]{% + \newglossaryentry{main-#2}{name={#4},% + text={#3\protect\glsadd{#2}},% + description={#5},% + #1 + }% + \newacronym{#2}{#3\protect\glsadd{main-#2}}{#4} +} +\end{verbatim} +This has the following syntax: +\begin{definition} +\ics{newdualentry}\oarg{options}\marg{label}\marg{abbrv}\marg{long}\marg{description} +\end{definition} +You can then define a new dual entry: +\begin{verbatim} +\newdualentry{svm}% label + {SVM}% abbreviation + {support vector machine}% long form + {Statistical pattern recognition technique}% description +\end{verbatim} +Now you can reference the acronym with \verb|\gls{svm}| or you can +reference the entry in the main glossary with \verb|\gls{main-svm}|. -\subsection{Cross-Referencing Entries} +\section{Cross-Referencing Entries} \label{sec:crossref} There are several ways of cross-referencing entries in the @@ -2632,22 +3032,34 @@ entries description. For example: \newglossaryentry{apple}{name=apple, description={firm, round fruit. See also \gls{pear}}} \end{verbatim} -Note that with this method, if you don't use the -cross-referenced term in the glossary, you will need two runs of -\app{makeglossaries}: -\begin{prompt} +Note that with this method, if you don't use the cross-referenced term +in the main part of the document, you will need two runs of +\gls{makeglossaries}: +\begin{verbatim} latex filename makeglossaries filename latex filename makeglossaries filename latex filename -\end{prompt} +\end{verbatim} + +\begin{important} +If you switch off the description +\glsation{sanitize}, you must protect fragile +commands like \ics{gls}: +\begin{verbatim} +\newglossaryentry{apple}{name=apple, +description={firm, round fruit. See also +\protect\gls{pear}}} +\end{verbatim} +\end{important} \item As described in \sectionref{sec:newglosentry}, you can use the \gloskey{see} key when you define the entry. For example: \begin{verbatim} \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -description={Series expansion}, see={TaylorsTheorem}} +description={Series expansion}, +see={TaylorsTheorem}} \end{verbatim} Note that in this case, the entry with the \gloskey{see} key will automatically be added to the glossary, but the cross-referenced @@ -2655,7 +3067,8 @@ entry won't. You therefore need to ensure that you use the cross-referenced term with the commands described in \sectionref{sec:glslink} or \sectionref{sec:glsadd}. -You can optionally override the \qt{see} tag using square brackets +The \qt{see} tag is produce using \ics{seename}, but can be +overridden in specific instances using square brackets at the start of the \gloskey{see} value. For example: \begin{verbatim} \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, @@ -2670,6 +3083,7 @@ see=[see also]{TaylorsTheorem}} where \meta{xr label list} is a comma-separated list of entry labels to be cross-referenced, \meta{label} is the label of the entry doing the cross-referencing and \meta{tag} is the \qt{see} tag. +(The default value of \meta{tag} is \ics{seename}.) For example: \begin{verbatim} \glssee[see also]{series}{FourierSeries,TaylorsTheorem} @@ -2679,18 +3093,85 @@ the glossary but doesn't add the cross-referenced entries (specified by \meta{xr label list}) to the glossary. \end{enumerate} -In both cases~2 and 3 above, the cross-referenced information appears -in the \term{number list}, whereas in case~1, the cross-referenced -information appears in the description. In cases~2 and~3, the -default text for the \qt{see} tag is given by \ics{seename}. +In both cases~2 and 3 above, the cross-referenced information +appears in the \gls{numberlist}, whereas in case~1, the +cross-referenced information appears in the description. (See the +\samplefile{-crossref} example file that comes with this package.) +This means that in cases~2 and~3, the cross-referencing information +won't appear if you have suppressed the \gls*{numberlist}. In this +case, you will need to activate the \gls*{numberlist} for the given +entries using \gloskey{nonumberlist=false}. Alternatively, if you +just use the \gloskey{see} key instead of \ics{glssee}, you can +automatically activate the \gls*{numberlist} using the +\pkgopt{seeautonumberlist} package option. + +\subsection{Customising Cross-reference Text} + +When you use either the \gloskey{see} key or the command +\cs{glssee}, the cross-referencing information will be typeset in the +glossary according to: +\begin{definition}[\DescribeMacro{\glsseeformat}] +\cs{glsseeformat}\oarg{tag}\marg{label-list}\marg{location} +\end{definition} +The default definition of \cs{glsseeformat} is: +\begin{display} +\cs{emph}\marg{tag} \cs{glsseelist}\marg{label-list} +\end{display} +Note that the location is always ignored.\footnote{\gls{makeindex} +will always assign a location number, even if it's not needed, so it +needs to be discarded.} For example, if you want the tag to appear +in bold, you can do:\footnote{If you redefine \cs{glsseeformat}, +keep the default value of the optional argument as \ics{seename} as +both \gloskey{see} and \cs{glssee} explicitly write +\texttt[\cs{seename}\texttt] in the output file if no optional +argument is given.} +\begin{verbatim} +\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1} \glsseelist{#2}} +\end{verbatim} + + +The list of labels is dealt with by \cs{glsseelist}, which iterates +through the list and typesets each entry in the label. The entries +are separated by +\begin{definition}[\DescribeMacro{\glsseesep}] +\cs{glsseesep} +\end{definition} +or (for the last pair) +\begin{definition}[\DescribeMacro{\glsseelastsep}] +\cs{glsseelastsep} +\end{definition} +These default to ",\space" and +\cs{space}\ics{andname}\cs{space} respectively. The list entry text +is displayed using: +\begin{definition}[\DescribeMacro{\glsseeitemformat}] +\cs{glsseeitemformat}\marg{label} +\end{definition} +This defaults to \ics{glsentrytext}\marg{label}.\footnote{In +versions before 3.0, \cs{glsentryname} was used, but this can cause +problems when the \gloskey{name} key is \glsd{sanitize}.} For example, to +make the cross-referenced list use small caps: +\begin{verbatim} +\renewcommand{\glsseeitemformat}[1]{\textsc{\glsentrytext{#1}}} +\end{verbatim} +\begin{important} +You can use \ics{glsseeformat} and \ics{glsseelist} in the main body +of the text, but they won't automatically add the cross-referenced +entries to the glossary. If you want them added with that location, +you can do: +\begin{verbatim} +Some information (see also +\glsseelist{FourierSeries,TaylorsTheorem}% +\glsadd{FourierSeries}\glsadd{TaylorsTheorem}). +\end{verbatim} +\end{important} -\subsection{Using Glossary Terms Without Links} +\section{Using Glossary Terms Without Links} \label{sec:glsnolink} The commands described in this section display entry details without adding any information to the glossary. They don't use -\cs{glstextformat}, they don't have any optional arguments, they +\ics{glstextformat}, they don't have any optional arguments, they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce hyperlinks. \begin{definition}[\DescribeMacro{\glsentryname}] @@ -2818,22 +3299,22 @@ entry given by \meta{label}. This command provides a hyperlink to the glossary entry given by \meta{label} \textbf{but does not add any information to the glossary file}. The link text is given by -\ics{glsentryname}\marg{label} by default, but can be overridden -using the optional argument. +\ics{glsentrytext}\marg{label} by default\footnote{versions before +3.0 used \ics{glsentryname} as the default, but this can cause +problems when \gloskey{name} has been \glsd{sanitize}.}, but can be +overridden using the optional argument. \begin{important} If you use \cs{glshyperlink}, you need to ensure that the relevant entry has been added to the glossary using any of the commands described in \sectionref{sec:glslink} or \sectionref{sec:glsadd} -otherwise you will end up with a broken link. +otherwise you will end up with an undefined link. \end{important} -For further information see \ifpdf -\sectionref{sec:code:glsnolink}\else the section \qt{Displaying -entry details without adding information to the glossary} in the -document \url{glossaries.pdf}\fi. - +For further information see \ifpdf section~\ref*{sec:code:glsnolink} +\fi \qt{Displaying entry details without adding information to the +glossary} in the documented code (\texttt{glossaries.pdf}). -\subsection{Displaying a glossary} +\section{Displaying a glossary} \label{sec:printglossary} The command @@ -2842,11 +3323,11 @@ The command \end{definition} will display all the glossaries in the order in which they were defined. Note that no glossaries will appear until you have either -used the Perl script \app{makeglossaries} or have directly used -\app{makeindex} or \app{xindy} (as described in +used the Perl script \gls{makeglossaries} or have directly used +\gls{makeindex} or \gls{xindy} (as described in \sectionref{sec:makeglossaries}). If the glossary still does not appear after you re-\LaTeX\ your document, check the -\app{makeindex}/\app{xindy} log files to see if there is a problem. +\gls*{makeindex}/\gls*{xindy} log files to see if there is a problem. Remember that you also need to use the command \ics{makeglossaries} in the preamble to enable the glossaries. @@ -2871,7 +3352,8 @@ defined). \item[{\gloskey[printglossary]{toctitle}}] This is the title to use for the table of contents (if the \pkgopt{toc} package option has been used). It may also be used for the page header, -depending on the page style. If omitted, the glossary title is used. +depending on the page style. If omitted, the value of +\gloskey[printglossary]{title} is used. \item[{\gloskey[printglossary]{style}}] This specifies which glossary style to use for this glossary, overriding the effect @@ -2881,26 +3363,26 @@ of the \pkgopt{style} package option or \ics{glossarystyle}. whether to use a numbered section for this glossary, overriding the effect of the \pkgopt{numberedsection} package option. This key has the same syntax as the \pkgopt{numberedsection} package -option, described in \sectionref{sec:pkgopts}. +option, described in \sectionref{sec:pkgopts-sec}. -\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option -of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist -is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is -displayed for this glossary. If no value is supplied, true is -assumed. +\item[{\gloskey[printglossary]{nonumberlist}}] This is a boolean +key. If true (\verb|nonumberlist=true|) the numberlist is suppressed +for this glossary. If false (\verb|nonumberlist=false|) the +numberlist is displayed for this glossary. If no value is supplied, +true is assumed. \end{description} -By default, the glossary is started either by \cs{chapter*} or by -\cs{section*}, depending on whether or not \cs{chapter} is defined. +By default, the glossary is started either by \ics{chapter*} or by +\ics{section*}, depending on whether or not \ics{chapter} is defined. This can be overridden by the \pkgopt{section} package option or the -\cs{setglossarysection} command. Numbered sectional units can be +\ics{setglossarysection} command. Numbered sectional units can be obtained using the \pkgopt{numberedsection} package option. Each glossary sets the page header via the command \ics{glossarymark}. If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine \ics{glossarymark}. Further information about these options and commands is given in -\sectionref{sec:pkgopts}. +\sectionref{sec:pkgopts-sec}. Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining @@ -2942,8 +3424,21 @@ There is an analogous command called \end{definition} which is placed at the end of each glossary. -\subsubsection{Changing the way the entry name appears in the glossary} -\label{sec:glsnamefont} +For example: suppose you are using the \glostyle{superheaderborder} +style\footnote{you can't use the \glostyle{longheaderborder} style +for this example as you can't use the \env{longtable} environment in +two column mode.}, and you want the glossary to be in two columns, +but after the glossary you want to switch back to one column mode, +you could do: +\begin{verbatim} +\renewcommand*{\glossarysection}[2][]{% + \twocolumn[{\section*{#2}}]% + \setlength\glsdescwidth{0.6\linewidth}% + \glossarymark{\glossarytoctitle}% +} + +\renewcommand*{\glossarypostamble}{\onecolumn} +\end{verbatim} Within each glossary, each entry name is formatted according to \begin{definition}[\DescribeMacro{\glsnamefont}] @@ -2968,23 +3463,23 @@ medium weight small caps, then you can do: \end{verbatim} -\subsubsection{Xindy} +\section{Xindy} \label{sec:xindy} -If you want to use \app{xindy} to sort the glossary, you +If you want to use \gls{xindy} to sort the glossary, you must use the package option \pkgopt{xindy}: \begin{verbatim} \usepackage[xindy]{glossaries} \end{verbatim} This ensures that the glossary information is written in -\app{xindy} syntax. +\gls*{xindy} syntax. \sectionref{sec:makeglossaries} covers how to use the external indexing application. This section covers the commands provided by the \styfmt{glossaries} package that allow you to adjust the -\app{xindy} style file (\filetype{.xdy}) and parameters. +\gls{xindy} style file (\filetype{.xdy}) and parameters. -To assist writing information to the \app{xindy} style +To assist writing information to the \gls{xindy} style file, the \styfmt{glossaries} package provides the following commands: \begin{definition}[\DescribeMacro{\glsopenbrace}] @@ -3007,23 +3502,23 @@ you can use \verb|\string"| to write the double-quote character. This document assumes that the double quote character has not been made active, so the examples just use \verb|"| for clarity. -If you want greater control over the \app{xindy} style file than is +If you want greater control over the \gls{xindy} style file than is available through the \LaTeX\ commands provided by the -\styfmt{glossaries} package, you will need to edit the \app{xindy} +\styfmt{glossaries} package, you will need to edit the \gls*{xindy} style file. In which case, you must use \ics{noist} to prevent the style file from being overwritten by the \styfmt{glossaries} -package. For additional information about \app{xindy}, read the -\app{xindy} documentation. +package. For additional information about \gls*{xindy}, read the +\gls*{xindy} documentation. -\paragraph{Language and Encodings} -When you use \app{xindy}, you need to specify the language +\subsection{Language and Encodings} +When you use \gls{xindy}, you need to specify the language and encoding used (unless you have written your own custom -\app{xindy} style file that defines the relevant alphabet -and sort rules). If you use \app{makeglossaries}, +\gls*{xindy} style file that defines the relevant alphabet +and sort rules). If you use \gls{makeglossaries}, this information is obtained from the document's auxiliary (\filetype{.aux}) file. The \styfmt{glossaries} package attempts to find the root language, but in the event that it gets it wrong or if -\app{xindy} doesn't support that language, then you can +\gls*{xindy} doesn't support that language, then you can specify the language using: \begin{definition}[\DescribeMacro{\GlsSetXdyLanguage}] \cs{GlsSetXdyLanguage}\oarg{glossary type}\marg{language} @@ -3054,7 +3549,7 @@ For example: \usepackage[xindy={language=english,codepage=utf8}]{glossaries} \end{verbatim} -If you write your own custom \app{xindy} style file that +If you write your own custom \gls{xindy} style file that includes the language settings, you need to set the language to nothing: \begin{verbatim} @@ -3065,18 +3560,32 @@ being overwritten). \begin{important} The commands \cs{GlsSetXdyLanguage} and \cs{GlsSetXdyCodePage} -have no effect if you don't use \app{makeglossaries}. If -you call \app{xindy} without \app{makeglossaries} you +have no effect if you don't use \gls{makeglossaries}. If +you call \gls{xindy} without \gls*{makeglossaries} you need to remember to set the language and encoding using the \texttt{-L} and \texttt{-C} switches. \end{important} -\paragraph{Locations and Number lists} +\subsection{Locations and Number lists} +\label{sec:xindyloc} + +If you use \pkgopt{xindy}, the \styfmt{glossaries} package needs to +know which counters you will be using in the \gls{numberlist} in order to correctly format the \gls{xindy} style +file. Counters specified using the \pkgopt{counter} package option +or the \meta{counter} option of \ics{newglossary} are +automatically taken care of, but if you plan to use a different +counter in the \gloskey[glslink]{counter} key for commands like +\ics{glslink}, then you need to identify these counters \emph{before} +\ics{makeglossaries} using: +\begin{definition}[\DescribeMacro{\GlsAddXdyCounters}] +\cs{GlsAddXdyCounters}\marg{counter list} +\end{definition} +where \meta{counter list} is a comma-separated list of counter names. The most likely attributes used in the \gloskey[glslink]{format} key (\locfmt{textrm}, \locfmt{hyperrm} etc) are automatically added -to the \app{xindy} style file, but if you want to use another +to the \gls{xindy} style file, but if you want to use another attribute, you need to add it using: \begin{definition}[\DescribeMacro{\GlsAddXdyAttribute}] \cs{GlsAddXdyAttribute}\marg{name} @@ -3088,7 +3597,7 @@ command that will do this: \begin{verbatim} \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} \end{verbatim} -but with \app{xindy}, I also need to add this as an allowed +but with \gls{xindy}, I also need to add this as an allowed attribute: \begin{verbatim} \GlsAddXdyAttribute{hyperbfit} @@ -3097,15 +3606,69 @@ attribute: \begin{important} Note that \cs{GlsAddXdyAttribute} has no effect if \ics{noist} is used or if \ics{makeglossaries} is omitted. - \cs{GlsAddXdyAttribute} must be used before \ics{makeglossaries}. +Additionally, \cs{GlsAddXdyCounters} must come before +\cs{GlsAddXdyAttribute}. \end{important} If the location numbers don't get expanded to a simple Arabic or Roman number or a letter from a, \ldots, z or A, \ldots, Z, then -you need to add a location style in the appropriate format. +you need to add a location style in the appropriate format using +\begin{definition}[\DescribeMacro{\GlsAddXdyLocation}] +\cs{GlsAddXdyLocation}\oarg{prefix-location}\marg{name}\marg{definition} +\end{definition} +where \meta{name} is the name of the format and \meta{definition} is +the \gls{xindy} definition. The optional argument \meta{prefix-location} +is needed if \cs{theH}\meta{counter} either isn't defined or is +different from \cs{the}\meta{counter}. + +\begin{important} +Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is +used or if \ics{makeglossaries} is omitted. +\cs{GlsAddXdyLocation} must be used before \ics{makeglossaries}. +\end{important} + +For example, suppose I decide to use a somewhat eccentric numbering +system for sections that redefines \cs{thesection} as follows: +\begin{verbatim} +\renewcommand*{\thesection}{[\thechapter]\arabic{section}} +\end{verbatim} +If I haven't done "counter=section" in the package +option, I need to specify that the counter will be used as a +location number: +\begin{verbatim} +\GlsAddXdyCounters{section} +\end{verbatim} +Next I need to add the location style (\cs{thechapter} is assumed to +be the standard \verb"\arabic{chapter}"): +\begin{verbatim} +\GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]" + "arabic-numbers" +} +\end{verbatim} +Note that if I have further decided to use the \sty{hyperref} +package and want to redefine \cs{theHsection} as: +\begin{verbatim} +\renewcommand*{\theHsection}{\thepart.\thesection} +\renewcommand*{\thepart}{\Roman{part}} +\end{verbatim} +then I need to modify the \cs{GlsAddXdyLocation} code above to: +\begin{verbatim} +\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} +\end{verbatim} +Since \ics{Roman} will result in an empty string if the counter is +zero, it's a good idea to add an extra location to catch this: +\begin{verbatim} +\GlsAddXdyLocation{zero.section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} +\end{verbatim} +The above example is illustrated in the accompanying sample file +\samplefile{xdy2}. -For example, suppose you want the page numbers written as words +Another example: suppose you want the page numbers written as words rather than digits and you use the \sty{fmtcount} package to do this. You can redefine \ics{thepage} as follows: \begin{verbatim} @@ -3121,31 +3684,57 @@ define a new location that has that form: \end{verbatim} Note that it's necessary to use \cs{space} to indicate that spaces also appear in the format, since, unlike \TeX, -\app{xindy} doesn't ignore spaces after control sequences. +\gls{xindy} doesn't ignore spaces after control sequences. + +\cs{GlsAddXdyLocation}\marg{name}\marg{definition} will define commands +\begin{definition} +\cs{glsX}\meta{counter}"X"\meta{name}\marg{Hprefix}\marg{location} +\end{definition} +for each counter that has been identified either by the +\pkgopt{counter} package option, the \meta{counter} option for +\ics{newglossary} or in the argument of \ics{GlsAddXdyCounters}. + +The first argument \meta{Hprefix} is only relevant when used with +the \sty{hyperref} package and indicates that \cs{the}\meta{Hcounter} +is given by \cs{Hprefix}"."\cs{the}\meta{counter}. The sample +file \samplefile{xdy}, which comes with the \styfmt{glossaries} +package, uses the default \ctr{page} counter for locations, and it +uses the default \ics{glsnumberformat} and a custom \cs{hyperbfit} +format. A new \gls{xindy} location called \texttt{Numberstring}, as +illustrated above, is defined to make the page numbers appear as +\qt{One}, \qt{Two}, etc. In order for the location numbers to +hyperlink to the relevant pages, I need to redefine the necessary +\cs{glsX}\meta{counter}"X"\meta{format} commands: +\begin{verbatim} +\renewcommand{\glsXpageXglsnumberformat}[2]{% + \linkpagenumber#2% +} -\begin{important} -Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is -used or if \ics{makeglossaries} is omitted. +\renewcommand{\glsXpageXhyperbfit}[2]{% + \textbf{\em\linkpagenumber#2}% +} -\cs{GlsAddXdyLocation} must be used before \ics{makeglossaries}. -\end{important} +\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} +\end{verbatim} -In the \term{number list}, the locations are sorted according to +In the \gls{numberlist}, the locations are sorted according to type. The default ordering is: \texttt{roman-page-numbers} (e.g.\ i), \texttt{arabic-page-numbers} (e.g.\ 1), \texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen\footnote{see -\ics{setCompositor} described in \sectionref{sec:newglosentry}}), +\ics{setCompositor} described in \sectionref{sec:setup}}), \texttt{alpha-page-numbers} (e.g.\ a), \texttt{Roman-page-numbers} (e.g.\ I), \texttt{Alpha-page-numbers} (e.g.\ A), \texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen\footnote{see \ics{setAlphaCompositor} described in -\sectionref{sec:newglosentry}}), user defined location names (as +\sectionref{sec:setup}}), user defined location names (as specified by \ics{GlsAddXdyLocation} in the order in which they were defined), \texttt{see} (cross-referenced entries). This ordering can be changed using: -\begin{definition}[\DescribeMacro{\GlsSetXdyLocationClassOrder}] + +\DescribeMacro{\GlsSetXdyLocationClassOrder} +\begin{definition} \cs{GlsSetXdyLocationClassOrder}\marg{location names} \end{definition} where each location name is delimited by double quote marks and @@ -3163,15 +3752,14 @@ separated by white space. For example: } \end{verbatim} -\begin{important} +\begin{important}\raggedright Note that \cs{GlsSetXdyLocationClassOrder} has no effect if \ics{noist} is used or if \ics{makeglossaries} is omitted. - \cs{GlsSetXdyLocationClassOrder} must be used before \ics{makeglossaries}. \end{important} -If a \term{number list} consists of a sequence of consecutive +If a \gls{numberlist} consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: @@ -3183,13 +3771,12 @@ For example: \GlsSetXdyMinRangeLength{3} \end{verbatim} The argument may also be the keyword \texttt{none}, to indicate that -there should be no range formations. See the \app{xindy} +there should be no range formations. See the \gls{xindy} manual for further details on range formations. \begin{important} Note that \cs{GlsSetXdyMinRangeLength} has no effect if \ics{noist} is used or if \ics{makeglossaries} is omitted. - \cs{GlsSetXdyMinRangeLength} must be used before \ics{makeglossaries}. \end{important} @@ -3197,7 +3784,8 @@ is used or if \ics{makeglossaries} is omitted. See \sectionref{sec:numberlists} for further details. -\paragraph{Glossary Groups} +\subsection{Glossary Groups} + The glossary is divided into groups according to the first letter of the sort key. The \styfmt{glossaries} package also adds a number group by default, unless you suppress it in the @@ -3210,19 +3798,22 @@ number group is placed in the default group. If you have a number group, the default behaviour is to locate it before the \qt{A} letter group. If you are not using a -Roman alphabet, you can change this using\\[10pt] +Roman alphabet, you can change this using: + +\DescribeMacro{\GlsSetXdyFirstLetterAfterDigits} +\begin{definition} \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} +\end{definition} -\begin{important} +\begin{important}\raggedright Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if \ics{noist} is used or if \ics{makeglossaries} is omitted. - \cs{GlsSetXdyFirstLetterAfterDigits} must be used before -\ics{makeglossaries}. +\ics{makeglossaries}.\par \end{important} -\subsection{Defining New Glossaries} +\section{Defining New Glossaries} \label{sec:newglossary} A new glossary can be defined using: @@ -3234,10 +3825,10 @@ arguments \meta{in-ext} and \meta{out-ext} specify the extensions to give to the input and output files for that glossary, \meta{title} is the default title for this new glossary and the final optional argument \meta{counter} specifies which counter to use for the -associated number lists\iterm{number list} (see also +associated \glspl{numberlist} (see also \sectionref{sec:numberlists}). The first optional argument specifies -the extension for the \app{makeindex} or \app{xindy} transcript file -(this information is only used by \app{makeglossaries} which picks +the extension for the \gls{makeindex} or \gls{xindy} transcript file +(this information is only used by \gls{makeglossaries} which picks up the information from the auxiliary file). Note that the main (default) glossary is automatically created as: @@ -3266,30 +3857,91 @@ ensure that the relevant output files are opened. \end{important} -\subsection{Acronyms} +\section{Acronyms} \label{sec:acronyms} You may have noticed in \sectionref{sec:newglosentry} that when you specify a new entry, you can specify alternate text to use when the -term is first used\ifirstuse\ in the document. This provides a +term is \glsd{firstuse} in the document. This provides a useful means to define acronyms. For convenience, the \styfmt{glossaries} package defines the command: \begin{definition}[\DescribeMacro{\newacronym}] \cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long} \end{definition} -By default, this is equivalent to: -\begin{display}\ttfamily -\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype}, -name=\textrm{\marg{abbrv}}, -description=\textrm{\marg{long}}, -text=\textrm{\marg{abbrv}}, -first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\}, -plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\}, -firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} (\textrm{\meta{abbrv}}\cs{glspluralsuffix})\}, -\textrm{\meta{key-val list}}\} -\end{display} -As mentioned in the previous section, the command + +This uses \ics{newglossaryentry} to create an entry with the given +label in the glossary given by \ics{acronymtype}. Amongst other +things, it sets up the \gloskey{first} and \gloskey{text} keys and, +depending on the acronym style, may also use \ics{defdisplayfirst} +and \ics{defdisplay} (see \sectionref{sec:glsdisplay}). + +The optional argument \marg{key-val list} allows you to specify keys +such as \gloskey{description} (when used with the +\pkgopt{description} package option, described below) or you can +override plural forms of \meta{abbrv} or \meta{long} using the +\gloskey{shortplural} or \gloskey{longplural} keys. +For example: +\begin{verbatim} +\newacronym[longplural={diagonal matrices}]{dm}{DM}{diagonal +matrix} +\end{verbatim} +If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will +display: diagonal matrices (DMs). + + +The following package options are available to change the acronym +style: + +\begin{description} +\item[\pkgopt{description}] +With this package option, the \gloskey{description} key needs to be +set in the optional argument \meta{key-val list} of \cs{newacronym}. +(If this package option isn't used, the long form \meta{long} is put +in the \gloskey{description} key.) + +\item[\pkgopt{footnote}] +With this package option, on \gls{firstuse} the long form \meta{long} is +placed in a footnote. By default the long form in the footnote will +link to the relevant entry in the glossary or list of acronyms. You +can prevent this link by doing: +\begin{verbatim} +\let\acrfootnote\acrnolinkfootnote +\end{verbatim} + +\item[\pkgopt{smallcaps}] +With this package option, the short form \meta{abbrv} is typeset +using \ics{textsc}. (Recall that \cs{textsc} converts lower case +characters into small capitals and leaves upper case characters as +they are. Therefore, you need to have lower case characters in +\meta{abbrv} for this option to have an effect.) + +\item[\pkgopt{smaller}] +This is similar to \pkgopt{smallcaps}, except that \ics{textsmaller} +is used instead of \ics{textsc}. Note that the \styfmt{glossaries} +package doesn't define \ics{textsmaller} nor does it load any +package that does so. If you use this option, you must make sure +\ics{textsmaller} is defined (for example by loading \sty{relsize}). + +\item[\pkgopt{dua}] +This option will set both the \gloskey{first} and \gloskey{text} +keys to the long form \meta{long}. +\end{description} + +If you want to define your own custom acronym style, see +\sectionref{sec:customacronym}. + +\begin{important} +If you try using \ics{newglossaryentry} for entries in a designated +list of acronyms in combination with any of the above named package +options you are likely to get unexpected results such as empty +brackets or empty footnotes. + +If you don't intend to use \ics{newacronym} you should skip this section] +and not use the above package options. +\end{important} + +As mentioned in \sectionref{sec:pkgopts-sec}, the command \ics{acronymtype} is the name of the glossary in which the acronyms should appear. If the \pkgopt{acronym} package option has been used, this will be \texttt{acronym}, otherwise it will be \texttt{main}. @@ -3299,58 +3951,37 @@ identify the others using the package options \pkgopt{acronymlists}. This ensures that options such as \pkgopt{footnote} and \pkgopt{smallcaps} work for the additional lists of acronyms. -\begin{important}% -\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|, +\begin{important}\raggedright +Since \cs{newacronym} sets \verb|type=\acronymtype|, if you want to load a file containing acronym definitions using -\cs{loadglsentries}\oarg{type}\marg{filename}, the optional argument +\ics{loadglsentries}\oarg{type}\marg{filename}, the optional argument \meta{type} will not have an effect unless you explicitly set the type as \verb|type=\glsdefaulttype| in the optional argument to \ics{newacronym}. See \sectionref{sec:loadglsentries}. \end{important} +Since \ics{newacronym} uses \ics{newglossaryentry}, you can use +commands like \ics{gls} and \ics{glsreset} as with any other +glossary entry. + For example, the following defines the acronym IDN: \begin{verbatim} \newacronym{idn}{IDN}{identification number} \end{verbatim} -This is equivalent to: -\begin{verbatim} -\newglossaryentry{idn}{type=\acronymtype, -name={IDN}, -description={identification number}, -text={IDN}, -first={identification number (IDN)}, -plural={IDNs}, -firstplural={identification numbers (IDNs)}} -\end{verbatim} -so \verb|\gls{idn}| will produce \qt{identification number (IDN)} on -\firstuse\ and \qt{IDN} on subsequent uses. - -This section describes acronyms that have been defined using -\ics{newacronym}. If you prefer to define your acronyms using -\ics{newglossaryentry} explicitly, then you should skip this section -and ignore the package options: \pkgopt{smallcaps}, -\pkgopt{smaller}, \pkgopt{description}, \pkgopt{dua} and -\pkgopt{footnote}, as these options change the definition of -\ics{newacronym} for common acronym formats as well as the way that -the link text is displayed (see \sectionref{sec:glsdisplay}). -Likewise you should ignore the package option \pkgopt{shortcuts} and -the new commands described in this section, such as \ics{acrshort}, -as they vary according to the definition of \ics{newacronym}. - -If you want to define your own custom acronym style, see -\sectionref{sec:customacronym}. - -\begin{important} -If you try using \ics{newglossaryentry} for entries in a designated -list of acronyms in combination with any of the above named package -options you are likely to get unexpected results such as empty -brackets or empty footnotes. -\end{important} +\verb|\gls{idn}| will produce \qt{identification number (IDN)} on +\firstuse\ and \qt{IDN} on subsequent uses. If you want to use the +\pkgopt{smallcaps} package option, you need to use lower case +characters for the shortened form: +\begin{verbatim} +\newacronym{idn}{idn}{identification number} +\end{verbatim} +Now \verb|\gls{idn}| will produce \qt{identification number +(\textsc{idn})} on \firstuse\ and \qt{\textsc{IDN}} on subsequent +uses. -If you use any of the package options \pkgopt{smallcaps}, -\pkgopt{smaller}, \pkgopt{description} or -\pkgopt{footnote}, the acronyms will be displayed in the document -using: +If you use any of the package options \pkgopt{smallcaps}, +\pkgopt{smaller}, \pkgopt{description} or \pkgopt{footnote}, the +short form \meta{abbrv} will be displayed in the document using: \begin{definition}[\DescribeMacro{\acronymfont}] \cs{acronymfont}\marg{text} \end{definition} @@ -3366,115 +3997,154 @@ this case, the recommended route is to use either the \pkgopt{smaller} or the \pkgopt{smallcaps} package option and redefine \cs{acronymfont} and \cs{firstacronymfont} as required. (The \pkgopt{smallcaps} option sets the default plural suffix in an -upright font to cancel the effect of \cs{textsc}, whereas -\pkgopt{smaller} sets the suffix in the surrounding font.) -For example, if you want acronyms in a normal font on first use and +upright font to cancel the effect of \ics{textsc}, whereas +\pkgopt{smaller} sets the suffix in the surrounding font.) For +example, if you want acronyms in a normal font on \gls{firstuse} and emphasized on subsequent use, do: \begin{verbatim} \usepackage[smaller]{glossaries} \renewcommand*{\firstacronymfont}[1]{#1} \renewcommand*{\acronymfont}[1]{\emph{#1}} \end{verbatim} -(Note that it is for this reason that the \sty{relsize} package -is not automatically loaded when selecting the -\pkgopt{smaller} package option.) +(Note that it is for this reason that the \sty{relsize} package is +not automatically loaded when selecting the \pkgopt{smaller} package +option.) -\Tableref{tab:acronymsettings} lists the package options that govern -the acronym styles and how the \ics{newglossaryentry} keys are used -to store \meta{long} (the long form) and \meta{abbrv} (the short -form). Note that the \pkgopt{smallcaps} option redefines -\cs{acronymfont} so that it sets its argument using \cs{textsc} (so -you should use lower case characters in \meta{abbrv}) and the -\pkgopt{smaller} option redefines \cs{acronymfont} to use -\cs{textsmaller},\footnote{you will need to load a package, such as -\styfmt{relsize}, that defines \cs{textsmaller} if you use this -option.}\ otherwise \cs{acronymfont} simply displays its argument in -the surrounding font. +There are commands analogous to \ics{glstext} (described in +\sectionref{sec:glslink}) that allow you to access just the short +form, just the long form or the full form, without affecting the +\gls{firstuseflag}. (Note that the full form isn't necessarily the same +as the text produced on \firstuse.) + +\begin{definition}[\DescribeMacro{\acrshort}] +\cs{acrshort}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +This displays the short form for the entry given by \meta{label}. +The optional arguments are the same as those for \ics{glstext}. +There is also a starred version to suppress the hyperlink. There are +also analogous upper case variants: +\begin{definition}[\DescribeMacro{\Acrshort}] +\cs{Acrshort}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +\begin{definition}[\DescribeMacro{\ACRshort}] +\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert} +\end{definition} + +\begin{definition}[\DescribeMacro{\acrlong}] +\cs{acrlong}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +This displays the long form for the entry given by \meta{label}. +The optional arguments are the same as before. There is also a starred +version to suppress the hyperlink. There are also analogous upper case +variants: +\begin{definition}[\DescribeMacro{\Acrlong}] +\cs{Acrlong}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +\begin{definition}[\DescribeMacro{\ACRshort}] +\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert} +\end{definition} + +\begin{definition}[\DescribeMacro{\acrfull}] +\cs{acrfull}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +This is equivalent to: +\DescribeMacro{\acrfullformat}\cs{acrfullformat}"{"\ics{acrlong}"}{"\ics{acrshort}"}". +This defaults to \meta{long} (\ics{acronymfont}\marg{short}) +regardless of the package options. There are also analogous upper +case variants: +\begin{definition}[\DescribeMacro{\Acrfull}] +\cs{Acrfull}\oarg{options}\marg{label}\oarg{insert} +\end{definition} +\begin{definition}[\DescribeMacro{\ACRfull}] +\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert} +\end{definition} + +If you find the above commands too cumbersome to write, you can use +the \pkgopt{shortcuts} package option to activate the shorter +command names listed in \tableref{tab:shortcuts}. \begin{table}[htbp] -\caption{Package options governing \cs{newacronym} and how the -information is stored in the keys for \cs{newglossaryentry}} -\label{tab:acronymsettings} -\begin{center} -\begin{tabular}{lllll} -\bfseries Package Option & -\gloskey{first} key & -\gloskey{text} key & -\gloskey{description} key & -\gloskey{symbol} key\\ -\pkgopt{description},\pkgopt{footnote} & -\meta{abbrv} & -\meta{abbrv} & -user supplied & -\meta{long}\\ -\pkgopt{description},\pkgopt{dua} & -\meta{long} & -\meta{long} & -user supplied & -\meta{abbrv}\\ -\pkgopt{description} & -\meta{long} & -\meta{abbrv} & -user supplied & -\meta{abbrv}\\ -\pkgopt{footnote} & -\meta{abbrv} & -\meta{abbrv} & -\meta{long} & - \\ -\pkgopt{smallcaps} & -\meta{long} & -\meta{abbrv} & -\meta{long} & -\meta{abbrv}\\ -\pkgopt{smaller} & -\meta{long} & -\meta{abbrv} & -\meta{long} & -\meta{abbrv}\\ -\pkgopt{dua} & -\meta{long} & -\meta{long} & -\meta{long} & -\meta{abbrv}\\ -None of the above& -\meta{long} (\meta{abbrv}) & -\meta{abbrv} & -\meta{long} & +\caption[Synonyms provided by the package option shortcuts]{Synonyms provided by the package option \pkgopt{shortcuts}} +\label{tab:shortcuts} +\vskip\baselineskip +\centering +\begin{tabular}{ll} +\bfseries Shortcut Command & \bfseries Equivalent Command\\ +\ics{acs} & \ics{acrshort}\\ +\ics{Acs} & \ics{Acrshort}\\ +\ics{acsp} & \ics{acrshortpl}\\ +\ics{Acsp} & \ics{Acrshortpl}\\ +\ics{acl} & \ics{acrlong}\\ +\ics{Acl} & \ics{Acrlong}\\ +\ics{aclp} & \ics{acrlongpl}\\ +\ics{Aclp} & \ics{Acrlongpl}\\ +\ics{acf} & \ics{acrfull}\\ +\ics{Acf} & \ics{Acrfull}\\ +\ics{acfp} & \ics{acrfullpl}\\ +\ics{Acfp} & \ics{Acrfullpl}\\ +\ics{ac} & \ics{gls}\\ +\ics{Ac} & \ics{Gls}\\ +\ics{acp} & \ics{glspl}\\ +\ics{Acp} & \ics{Glspl} \end{tabular} -\end{center} \end{table} -In case you can't remember which key stores the long or short forms -(or their plurals) the \styfmt{glossaries} package provides the -commands: -\begin{itemize} -\item\DescribeMacro{\glsshortkey}\cs{glsshortkey} -The key used to store the short form. -\item\DescribeMacro{\glsshortpluralkey}\cs{glsshortpluralkey} -The key used to store the plural version of the short form. -\item\DescribeMacro{\glslongkey}\cs{glslongkey} -The key used to store the long form. -\item\DescribeMacro{\glslongpluralkey}\cs{glslongpluralkey} -The key used to store the plural version of the long form. -\end{itemize} -These can be used in the optional argument of \cs{newacronym} -to override the defaults. For example: -\begin{verbatim} -\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal -matrix} -\end{verbatim} -If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will -display: diagonal matrices (DMs). +It is also possible to access the long and short forms without +adding information to the glossary using commands analogous to +\ics{glsentrytext} (described in \sectionref{sec:glsnolink}). -Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, -\pkgopt{footnote}, \pkgopt{dua} and \pkgopt{description} use -\ics{defglsdisplay} and \ics{defglsdisplayfirst} (described in -\sectionref{sec:glsdisplay}) to change the way the link text is -displayed. This means that these package options only work for the -glossary type given by \cs{acronymtype}. If you have multiple lists -of acronyms, you will need to make the appropriate changes for each -additional glossary type. +The long form can be accessed using: +\begin{definition}[\DescribeMacro{\glsentrylong}] +\cs{glsentrylong}\marg{label} +\end{definition} +or, with the first letter converted to upper case: +\begin{definition}[\DescribeMacro{\Glsentrylong}] +\cs{Glsentrylong}\marg{label} +\end{definition} +Plural forms: +\begin{definition}[\DescribeMacro{\glsentrylongpl}] +\cs{glsentrylongpl}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\Glsentrylongpl}] +\cs{Glsentrylongpl}\marg{label} +\end{definition} + +Similarly, to access the short form: +\begin{definition}[\DescribeMacro{\glsentryshort}] +\cs{glsentryshort}\marg{label} +\end{definition} +or, with the first letter converted to upper case: +\begin{definition}[\DescribeMacro{\Glsentryshort}] +\cs{Glsentryshort}\marg{label} +\end{definition} +Plural forms: +\begin{definition}[\DescribeMacro{\glsentryshortpl}] +\cs{glsentryshortpl}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\Glsentryshortpl}] +\cs{Glsentryshortpl}\marg{label} +\end{definition} + +And the full form, \meta{long} (\meta{short}), can be obtained +using: +\begin{definition}[\DescribeMacro{\glsentryfull}] +\cs{glsentryfull}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\Glsentryfull}] +\cs{Glsentryfull}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\glsentryfullpl}] +\cs{glsentryfullpl}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\Glsentryfullpl}] +\cs{Glsentryfullpl}\marg{label} +\end{definition} + +\subsection{Predefined Acronym Styles} + +Some of the acronym-related package options may be combined. Listed +below are the effects of different combinations. If you use an +invalid combination, you'll get an error message. \begin{description} \item[\pkgopt{description},\pkgopt{footnote}]\ifpdf\mbox{}\par\fi @@ -3488,78 +4158,33 @@ while subsequent use displays the entry as: \cs{acronymfont}\marg{abbrv}\meta{insert} \end{display} where \meta{insert} indicates the text supplied in the final -optional argument to \cs{gls}, \cs{glspl} or their uppercase +optional argument to \ics{gls}, \ics{glspl} or their uppercase variants. -In this case, the long form is stored in the \gloskey{symbol} key. -This means that the long form will not be displayed in the list of -acronyms unless you use a glossary style that displays the entry's -symbol (for example, the \glostyle{index} style). Entries will -be sorted according to the short form. - -Note also that when these two package options are used (in the -given order), the \styfmt{glossaries} package additionally implements the -\pkgopt{sanitize} option using -\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so -remember to protect fragile commands when defining acronyms. - \item[\pkgopt{dua}]\ifpdf\mbox{}\par\fi -The \pkgopt{dua} package option always displays the expanded -form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or -\pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the -entry in the form: +The \pkgopt{dua} package option always makes \ics{gls} display the +expanded form and so may not be used with \pkgopt{footnote}, +\pkgopt{smaller} or \pkgopt{smallcaps}. Both \firstuse\ and subsequent +use displays the entry in the form: \begin{display} \meta{long}\meta{insert} \end{display} - -If the \pkgopt{description} package option is also used, the -\gloskey{name} key is set to the long form, otherwise the -\gloskey{name} key is set to the short form and the -\gloskey{description} key is set to the long form. In both -cases the \gloskey{symbol} is set to the short form. Therefore, -if you use the \pkgopt{description} package option and you want -the short form to appear in the list of acronyms, you will need -to use a glossary style that displays the entry's symbol (for -example, the \glostyle{index} style). Entries will be sorted -according to the long form if the \pkgopt{description} option -is used, otherwise they will be sorted according to the -short form (unless overridden by the \gloskey{sort} key in -the optional argument of \ics{newacronym}). +You can, however, access the short form using \ics{acrshort} and its +variants. \item[\pkgopt{description}]\ifpdf\mbox{}\par\fi This package option displays the entry on \firstuse\ as: \begin{display} -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\meta{long}\meta{insert} (\ics{firstacronymfont}\marg{abbrv}) \end{display} while subsequent use displays the entry as: \begin{display} \cs{acronymfont}\marg{abbrv}\meta{insert} \end{display} -Note also that if this package option is used, the \styfmt{glossaries} -package additionally implements the option -\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so -remember to protect fragile commands when defining acronyms. Note that with this option, you need to specify the description using the \gloskey{description} key in the optional argument -of \ics{newacronym}. When this option is used without -the \pkgopt{footnote} or \pkgopt{dua} options, the name field -is specified as -\begin{definition}[\DescribeMacro{\acrnameformat}] -\cs{acrnameformat}\marg{short}\marg{long} -\end{definition} -This defaults to \ics{acronymfont}\marg{short}, which means that the -long form will not appear in the list of acronyms by default. -To change this, you need to redefine \ics{acrnameformat} as -appropriate. For example, to display the long form followed -by the short form in parentheses do: -\begin{verbatim} -\renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})} -\end{verbatim} -Note that even if you redefine \ics{acrnameformat}, the -entries will be sorted according to the short form, unless you -override this using the \gloskey{sort} key in the optional -argument to \ics{newacronym}. +of \ics{newacronym}. \item[\pkgopt{footnote}]\ifpdf\mbox{}\par\fi This package option displays the entry on \firstuse\ as: @@ -3572,44 +4197,25 @@ while subsequent use displays the entry as: \end{display} Acronyms will be sorted according to the short form. -Note also that if this package option is used, the \styfmt{glossaries} -package additionally implements the option -\ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so -remember to protect fragile commands when defining acronyms. - Note that on \firstuse, it is the long form in the footnote that links to the relevant glossary entry (where hyperlinks are enabled), whereas on subsequent use, the acronym links to the relevant -glossary entry. It is possible to change this to make the acronym on -\firstuse\ have the hyperlink instead of the footnote, but since the -footnote marker will also be a hyperlink, you will have two -hyperlinks in immediate succession. This can be ambiguous where the -hyperlinks are coloured rather than boxed. The code required to -change the \firstuse\ to make the acronym a hyperlink is as follows: -\begin{verbatim} - \defglsdisplayfirst[\acronymtype]{% - \noexpand\protect\noexpand - \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% - \noexpand\protect\noexpand\footnote{#2}}% -\end{verbatim} -\textbf{Note} that this involves using internal commands (i.e.\ -commands whose name contains an \verb|@| character), so if this code -is place in a \texttt{.tex} file it needs to be placed within a -\cs{makeatletter} \ldots\ \cs{makeatother} pair. (See -\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}{\cs{@} -and \texttt{@} in macro names} for further details.) +glossary entry. You can suppress the long form link by setting: +\begin{verbatim} +\let\acrfootnote\acrnolinkfootnote +\end{verbatim} \item[\pkgopt{smallcaps}]\ifpdf\mbox{}\par\fi If neither the \pkgopt{footnote} nor \pkgopt{description} options have been set, this option displays the entry on \firstuse\ as: \begin{display} -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\meta{long}\meta{insert} (\ics{firstacronymfont}\marg{abbrv}) \end{display} while subsequent use displays the entry as: \begin{display} \cs{acronymfont}\marg{abbrv}\meta{insert} \end{display} -where \cs{acronymfont} is set to \verb|\textsc{#1}|. +where \ics{acronymfont} is set to \verb|\textsc{#1}|. \begin{important} Note that since the acronym is displayed using \ics{textsc}, @@ -3618,22 +4224,17 @@ the short form, \meta{abbrv}, should be specified in lower case. "\textsc{ABC}" produces \textsc{ABC}.)\fi \end{important} -Note also that if this package option is used, the \styfmt{glossaries} -package additionally implements the option -\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so -remember to protect fragile commands when defining acronyms. - \item[\pkgopt{smaller}]\ifpdf\mbox{}\par\fi If neither the \pkgopt{footnote} nor \pkgopt{description} options have been set, this option displays the entry on \firstuse\ as: \begin{display} -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\meta{long}\meta{insert} (\ics{firstacronymfont}\marg{abbrv}) \end{display} while subsequent use displays the entry as: \begin{display} -\cs{acronymfont}\marg{abbrv}\meta{insert} +\ics{acronymfont}\marg{abbrv}\meta{insert} \end{display} -where \cs{acronymfont} is set to +where \ics{acronymfont} is set to \verb|\textsmaller{#1}|.\footnote{not that this was change from using \ics{smaller} to \ics{textsmaller} as declarations cause a problem for \ics{makefirstuc}.} @@ -3645,11 +4246,6 @@ Remember to load a package that defines \ics{textsmaller} (such as to redefine \ics{acronymfont} to use some other formatting command. \end{important} -Note also that if this package option is used, the \styfmt{glossaries} -package additionally implements the option -\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so -remember to protect fragile commands when defining acronyms. - \item[None of the above]\ifpdf \mbox{}\par\fi If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, @@ -3662,107 +4258,86 @@ while subsequent use displays the entry as: \meta{abbrv}\meta{insert} \end{display} Entries will be sorted according to the short form. -Note that if none of the acronym-related package options are used, -the \pkgopt{sanitize} option will not be affected. \end{description} -Recall from \sectionref{sec:glslink} that you can access the values -of individual keys using commands like \ics{glstext}, so it is -possible to use these commands to print just the long form or just -the abbreviation without affecting the flag that determines whether -the entry has been used. However the keys that store the long and -short form vary depending on the acronym style, so the -\styfmt{glossaries} package provides commands that are set according -to the package options. These are as follows: -\begin{definition}[\DescribeMacro{\acrshort}] -\cs{acrshort}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\Acrshort}] -\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\ACRshort}] -\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -Print the abbreviated version with (if required) a hyperlink to the -relevant entry in the glossary. This is usually equivalent to -\ics{glstext} (or its uppercase variants) but may additionally put -the link text within the argument to \ics{acronymfont}. -\begin{definition}[\DescribeMacro{\acrlong}] -\cs{acrlong}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\Acrlong}] -\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\ACRlong}] -\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -Print the long version with (if required) a hyperlink to the -relevant entry in the glossary. This is may be equivalent to -\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase -variants), depending on package options. -\begin{definition}[\DescribeMacro{\acrfull}] -\cs{acrfull}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\Acrfull}] -\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -\begin{definition}[\DescribeMacro{\ACRfull}] -\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert} -\end{definition} -Print the long version followed by the abbreviation in brackets with -(if required) a hyperlink to the relevant entry in the glossary. +\subsection{Displaying the List of Acronyms} -\begin{important} -Note that if any of the above commands produce unexpected output -and you haven't used any of the acronym-related package options, -you will need to switch off the sanitization\ipkgopt{sanitize}. -For example: -\begin{verbatim} -\usepackage[sanitize=none]{glossaries} -\end{verbatim} -However, if you do this, you must remember to protect fragile -commands when defining acronyms or glossary entries. -\end{important} +The list of acronyms is just like any other type of glossary and can +be displayed on its own using +\ics{printglossary}"[type=\acronymtype]" or with all the other +glossaries using \ics{printglossaries}. However, care must be taken +to choose a glossary style that's appropriate to your acronym style. +The different acronym-related package options store different +information in the \gloskey{name}, \gloskey{description} and +\gloskey{symbol} keys. -Note that if you change the definition of \ics{newacronym}, you -may additionally need to change the above commands as well as -changing the way the text is displayed using \ics{defglsdisplay} -and \ics{defglsdisplayfirst}. +\Tableref{tab:acronymsettings} lists the package options that govern +the acronym styles and how the information is stored in the keys +used when displaying the glossary. Note that the \pkgopt{description} +package option uses the following command in the \gloskey{name}: +\begin{definition}[\DescribeMacro{\acrnameformat}] +\cs{acrnameformat}\marg{abbrv}\marg{long} +\end{definition} +This defaults to just \cs{acronymfont}\marg{abbrv}. -The package option \pkgopt{shortcuts} provides the synonyms listed -in \tableref{tab:shortcuts}. If any of those commands generate -an \qt{undefined control sequence} error message, check that you -have enabled the shortcuts using the \pkgopt{shortcuts} package -option. Note that there are no shortcuts for the commands that -produce all upper case text. +For example, if I use the package options \pkgopt{description} and +\pkgopt{footnote}, then the name field will contain the abbreviation +and the symbol field will contain the long form. If I then use the +\glostyle{long4col} style, each entry in the list of acronyms will +appear in the form: +\begin{display} +\ics{acronymfont}\marg{abbrv} \meta{description} \meta{long} +\meta{location list} +\end{display} +Alternatively, you can define your own custom style (see +\sectionref{sec:newglossarystyle} for further details). \begin{table}[htbp] -\caption[Synonyms provided by the package option shortcuts]{Synonyms provided by the package option \pkgopt{shortcuts}} -\label{tab:shortcuts} +\caption{Package options governing \cs{newacronym} and how the +information is stored} +\label{tab:acronymsettings} \begin{center} -\begin{tabular}{ll} -\bfseries Shortcut Command & \bfseries Equivalent Command\\ -\ics{acs} & \ics{acrshort}\\ -\ics{Acs} & \ics{Acrshort}\\ -\ics{acsp} & \ics{acrshortpl}\\ -\ics{Acsp} & \ics{Acrshortpl}\\ -\ics{acl} & \ics{acrlong}\\ -\ics{Acl} & \ics{Acrlong}\\ -\ics{aclp} & \ics{acrlongpl}\\ -\ics{Aclp} & \ics{Acrlongpl}\\ -\ics{acf} & \ics{acrfull}\\ -\ics{Acf} & \ics{Acrfull}\\ -\ics{acfp} & \ics{acrfullpl}\\ -\ics{Acfp} & \ics{Acrfullpl}\\ -\ics{ac} & \ics{gls}\\ -\ics{Ac} & \ics{Gls}\\ -\ics{acp} & \ics{glspl}\\ -\ics{Acp} & \ics{Glspl} +\begin{tabular}{lllll} +\bfseries Package Option & +\gloskey{name} & +\gloskey{description} & +\gloskey{symbol}\\ +\pkgopt{description},\pkgopt{footnote} & +\ics{acronymfont}\marg{abbrv} & +user supplied & +\meta{long}\\ +\pkgopt{description},\pkgopt{dua} & +\meta{long} & +user supplied & +\meta{abbrv}\\ +\pkgopt{description} & +\ics{acrnameformat}\marg{abbrv}\marg{long} & +user supplied & +\meta{abbrv}\\ +\pkgopt{footnote} & +\ics{acronymfont}\marg{abbrv} & +\meta{long} & + \\ +\pkgopt{smallcaps} & +\ics{acronymfont}\marg{abbrv} & +\meta{long} & +\meta{abbrv}\\ +\pkgopt{smaller} & +\ics{acronymfont}\marg{abbrv} & +\meta{long} & +\meta{abbrv}\\ +\pkgopt{dua} & +\meta{abbrv} & +\meta{long} & +\meta{abbrv}\\ +None of the above& +\meta{abbrv} & +\meta{long} & \end{tabular} \end{center} \end{table} -\subsubsection{Defining A Custom Acronym Style} +\subsection{Defining A Custom Acronym Style} \label{sec:customacronym} You may find that the predefined acronyms styles that come with the @@ -3805,13 +4380,26 @@ before defining new acronyms. The acronyms must be defined using \ics{newacronym} not \ics{newglossaryentry}. \end{important} -As an example, suppose I want my acronym on first use to have the +As an example, suppose I want my acronym on \gls{firstuse} to have the short form in the text and the long form with the description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of the document, but I want it in normal capitals in the list of acronyms. In my list of acronyms, I want the long form as the name with the short form in brackets followed by -the description. +the description. That is, in the text I want \ics{gls} on \gls{firstuse} +to display: +\begin{display} +\ics{textsc}\marg{abbrv}\cs{footnote}"{"\meta{long}: \meta{description}"}" +\end{display} +on subsequent use: +\begin{display} +\ics{textsc}\marg{abbrv} +\end{display} +and in the list of acronyms, each entry will be displayed in the +form: +\begin{display} +\meta{long} (\meta{short}) \meta{description} +\end{display} First, I need to redefine \ics{CustomAcronymFields} so that \ics{newacronym} will correctly set the \gloskey{name}, @@ -3826,18 +4414,15 @@ of acronyms. name={\the\glslongtok},% symbol={\MakeUppercase{\the\glsshorttok}},% text={\textsc{\the\glsshorttok}},% - plural={\textsc{\the\glsshorttok}s}% + plural={\textsc{\the\glsshorttok}\noexpand\acrpluralsuffix}% } \end{verbatim} -Note that in this case I haven't bothered with \ics{acrpluralsuffix} -and have just inserted an \qt{s}. - -When I use the custom acronym style, the short form is stored in -\gloskey{user1}, the plural short form is stored in \gloskey{user2}, -the long form is stored in \gloskey{user3} and the plural long form -is stored in \gloskey{user4}. So when I use \ics{defglsdisplayfirst} -and \ics{defglsdisplay}, I can use \ics{glsentryuseriii} to access +When using \ics{newacronym}, the short and long forms are stored in +the \gloskey{short} and \gloskey{long} keys, and the plural forms +are stored in \gloskey{shortplural} and \gloskey{longplural}. +So when I use \ics{defglsdisplayfirst} +and \ics{defglsdisplay}, I can use \ics{glsentrylong} to access the long form. Recall from \sectionref{sec:glsdisplay}, that the optional argument to \ics{defglsdisplayfirst} and \ics{defglsdisplay} indicates the glossary type. This is passed to @@ -3852,7 +4437,7 @@ the \gloskey{description}, the third corresponds to the \begin{verbatim} \renewcommand*{\SetCustomDisplayStyle}[1]{% \defglsdisplayfirst[#1]{##1##4\protect\footnote{% - \glsentryuseriii{\glslabel}: ##2% + \glsentrylong{\glslabel}: ##2% }} \defglsdisplay[#1]{##1##4}% } @@ -3881,9 +4466,9 @@ Sheet} Note that since I've used the description in the main body of the text, I need to switch off the sanitization otherwise any commands within the description won't get interpreted. Also I want to use the -\sty{hyperref} package, but this will cause a problem on first use +\sty{hyperref} package, but this will cause a problem on \gls{firstuse} as I'll get nested hyperlinks, so I need to switch off the -hyperlinks on first use. In addition, I want to use a glossary style +hyperlinks on \gls{firstuse}. In addition, I want to use a glossary style that displays the symbol. Therefore, in my preamble I have: \begin{verbatim} @@ -3900,7 +4485,7 @@ that displays the symbol. Therefore, in my preamble I have: Note that I haven't used the \pkgopt{description} or \pkgopt{footnote} package options. -\subsubsection{Upgrading From the glossary Package} +\subsection{Upgrading From the glossary Package} \label{sec:oldacronym} Users of the obsolete \sty{glossary} package may recall that the syntax used to define new acronyms has changed with the @@ -3978,13 +4563,13 @@ optional argument from being recognised. -\subsection{Unsetting and Resetting Entry Flags} +\section{Unsetting and Resetting Entry Flags} \label{sec:glsunset} When using \ics{gls}, \ics{glspl} and their uppercase variants it is possible that you may want to use the value given by the -\gloskey{first} key, even though you have already used the glossary -entry\ifirstuse. Conversely, you may want to use the value given by the +\gloskey{first} key, even though you have already \glslink{firstuse}{used} the glossary +entry. Conversely, you may want to use the value given by the \gloskey{text} key, even though you haven't used the glossary entry. The former can be achieved by one of the following commands: \begin{definition}[\DescribeMacro{\glsreset}] @@ -4022,7 +4607,7 @@ list of acronyms: \glsresetall[main,acronym] \end{verbatim} -You can determine whether an entry's first use flag is set using: +You can determine whether an entry's \gls{firstuseflag} is set using: \begin{definition}[\DescribeMacro{\ifglsused}] \cs{ifglsused}\marg{label}\marg{true part}\marg{false part} \end{definition} @@ -4031,7 +4616,7 @@ entry has been used, \meta{true part} will be done, otherwise \meta{false part} will be done. -\subsection{Glossary Styles} +\section{Glossary Styles} \label{sec:styles} The \styfmt{glossaries} package comes with some pre-defined glossary styles. Note that the styles are suited to different @@ -4041,7 +4626,11 @@ so they display sub-entries in the same way as they display top level entries; some styles are designed for homographs, so they ignore the name for sub-entries. You should therefore pick a style that suits your type of glossary. See \tableref{tab:styles} for -a summary of the available styles. +a summary of the available styles. The predefined styles can +accommodate numbered level~0 (main) and level~1 entries. See the +package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and +\pkgopt{subentrycounter} described in +\sectionref{sec:pkgopts-printglos}. \begin{table}[htbp] \caption[Glossary Styles]{Glossary Styles. An asterisk in the style @@ -4052,10 +4641,10 @@ matches \glostyle{long3col}, \glostyle{long3colheader}, A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as --- there is no limit, but note that -\app{makeindex} imposes a limit of 2 sub-levels. If the +\gls{makeindex} imposes a limit of 2 sub-levels. If the homograph column is checked, then the name is not displayed for sub-entries. If the symbol column is checked, then the symbol will -be displayed if it has been defined.} +be displayed.} \label{tab:styles} \vskip\baselineskip \centering @@ -4135,7 +4724,6 @@ in the next section) or make the modifications after \renewcommand*{\glsgroupskip}{} \end{verbatim} - \changes{1.03}{2007 July 4}{'glspostdescription added} All the styles except for the three- and four-column styles and the \glostyle{listdotted} style use the command \begin{definition}[\DescribeMacro{\glspostdescription}] @@ -4147,7 +4735,7 @@ a comma) you will need to redefine \cs{glspostdescription} before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \ics{nopostdesc} in the entry's description. -\subsubsection{List Styles} +\subsection{List Styles} \label{sec:liststyles} The styles described in this section are all defined in the package @@ -4160,11 +4748,11 @@ these styles will automatically be available unless you use the \begin{description} \item[list] The \glostyle{list} style uses the \env{description} environment. The entry name is placed in the optional argument of -the \cs{item} command (so it will appear in bold by default). The -description follows, and then the associated \term{number list} for +the \ics{item} command (so it will appear in bold by default). The +description follows, and then the associated \gls{numberlist} for that entry. The symbol is ignored. If the entry has child entries, the description and number list follows (but not the name) for each -child entry. Groups are separated using \cs{indexspace}. +child entry. Groups are separated using \ics{indexspace}. \item[listgroup] The \glostyle{listgroup} style is like \glostyle{list} but the glossary groups have headings. @@ -4185,7 +4773,7 @@ example, to simply have a space separating each group, do: \end{verbatim} Note that the hyper-navigation line is now (as from version 1.14) -set inside the optional argument to \cs{item} instead of after it +set inside the optional argument to \ics{item} instead of after it to prevent a spurious space at the start. This can be changed by redefining \ics{glossaryheader}, but note that this needs to be done \emph{after} the glossary style has been set. @@ -4208,7 +4796,7 @@ groups. The navigation line is the same as that for environment.\footnote{This style was supplied by Axel~Menzel.} Each entry starts with \verb|\item[]|, followed by the name followed by a dotted line, followed by the description. Note that this style -ignores both the \term{number list} and the symbol. The length +ignores both the \gls{numberlist} and the symbol. The length \begin{definition}[\DescribeMacro{\glslistdottedwidth}] \cs{glslistdottedwidth} \end{definition} @@ -4222,7 +4810,7 @@ the same manner as \glostyle{listdotted}. \end{description} -\subsubsection{Longtable Styles} +\subsection{Longtable Styles} \label{sec:longstyles} The styles described in this section are all defined in the package @@ -4239,7 +4827,7 @@ analogous styles described in \sectionref{sec:longraggedstyles}. \item[long] The \glostyle{long} style uses the \env{longtable} environment (defined by the \sty{longtable} package). It has two columns: the first column contains the entry's name and the second -column contains the description followed by the \term{number list}. +column contains the description followed by the \gls{numberlist}. The entry's symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The @@ -4260,7 +4848,7 @@ around it. \item[long3col] The \glostyle{long3col} style is like \glostyle{long} but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the \term{number list}. +and the third column contains the \gls{numberlist}. The entry's symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length @@ -4318,7 +4906,7 @@ descriptions and page lists. \end{description} -\subsubsection{Longtable Styles (Ragged Right)} +\subsection{Longtable Styles (Ragged Right)} \label{sec:longraggedstyles} The styles described in this section are all defined in the package @@ -4342,7 +4930,7 @@ the \styfmt{glossaries} package has been loaded. \item[longragged] The \glostyle{longragged} style has two columns: the first column contains the entry's name and the second column contains the (left-justified) description followed by the -\term{number list}. The entry's symbol is ignored. +\gls{numberlist}. The entry's symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length @@ -4363,7 +4951,7 @@ vertical lines around it. \glostyle{longragged} but has three columns. The first column contains the entry's name, the second column contains the (left justified) description and the third column contains the (left -justified) \term{number list}. The entry's symbol is ignored. The +justified) \gls{numberlist}. The entry's symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length \ics{glsdescwidth}, and the width of the third column is governed by @@ -4405,7 +4993,7 @@ lines around it. \end{description} -\subsubsection{Supertabular Styles} +\subsection{Supertabular Styles} \label{sec:superstyles} The styles described in this section are all defined in the package @@ -4424,7 +5012,7 @@ analogous styles described in \sectionref{sec:superraggedstyles}. \item[super] The \glostyle{super} style uses the \env{supertabular} environment (defined by the \sty{supertabular} package). It has two columns: the first column contains the entry's name and the second -column contains the description followed by the \term{number list}. +column contains the description followed by the \gls{numberlist}. The entry's symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The @@ -4445,7 +5033,7 @@ around it. \item[super3col] The \glostyle{super3col} style is like \glostyle{super} but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the \term{number list}. The +and the third column contains the \gls{numberlist}. The entry's symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length @@ -4504,7 +5092,7 @@ descriptions and page lists. \end{description} -\subsubsection{Supertabular Styles (Ragged Right)} +\subsection{Supertabular Styles (Ragged Right)} \label{sec:superraggedstyles} The styles described in this section are all defined in the package @@ -4529,7 +5117,7 @@ the \styfmt{glossaries} package has been loaded. \env{supertabular} environment (defined by the \sty{supertabular} package). It has two columns: the first column contains the entry's name and the second column contains the (left -justified) description followed by the \term{number list}. The +justified) description followed by the \gls{numberlist}. The entry's symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the @@ -4552,7 +5140,7 @@ around it. \glostyle{superragged} but has three columns. The first column contains the entry's name, the second column contains the (left justified) description and the third column contains the (left -justified) \term{number list}. The entry's symbol is ignored. The +justified) \gls{numberlist}. The entry's symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \ics{glsdescwidth}. The width of the third column is governed by the @@ -4592,8 +5180,7 @@ lines around it. \end{description} - -\subsubsection{Tree-Like Styles} +\subsection{Tree-Like Styles} \label{sec:treestyles} The styles described in this section are all defined in the package @@ -4624,8 +5211,8 @@ groups. The navigation line is the same as that for \item[tree] The \glostyle{tree} style is similar to the \glostyle{index} style except that it can have arbitrary levels. -(Note that \app{makeindex} is limited to three levels, so -you will need to use \app{xindy} if you want more than +(Note that \gls{makeindex} is limited to three levels, so +you will need to use \gls{xindy} if you want more than three levels.) Each sub-level is indented by \DescribeMacro{\glstreeindent}\cs{glstreeindent}. Note that the name, symbol (if present) and description are placed in the @@ -4680,9 +5267,7 @@ groups. The navigation line is the same as that for \end{description} - - -\subsection{Defining your own glossary style} +\section{Defining your own glossary style} \label{sec:newglossarystyle} If the predefined styles don't fit your requirements, you can @@ -4699,8 +5284,8 @@ needs to redefine all of the following: \end{definition} This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, -the glossary preamble (defined by \cs{glossarypreamble}) or the -glossary postamble (defined by \cs{glossarypostamble}). For example, +the glossary preamble (defined by \ics{glossarypreamble}) or the +glossary postamble (defined by \ics{glossarypostamble}). For example, the \glostyle{list} style uses the \env{description} environment, so the \env{theglossary} environment is simply redefined to begin and end the \env{description} environment. @@ -4710,9 +5295,9 @@ and end the \env{description} environment. \end{definition} This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as -\cs{glossarypreamble}, which should not be affected by changes in +\ics{glossarypreamble}, which should not be affected by changes in the glossary style. The \glostyle{list} glossary style redefines -\cs{glossaryheader} to do nothing, whereas the \glostyle{longheader} +\ics{glossaryheader} to do nothing, whereas the \glostyle{longheader} glossary style redefines \cs{glossaryheader} to do a header row. \begin{definition}[\DescribeMacro{\glsgroupheading}] @@ -4720,12 +5305,12 @@ glossary style redefines \cs{glossaryheader} to do a header row. \end{definition} This macro indicates what to do at the start of each logical block within the main body -of the glossary. If you use \app{makeindex} the glossary is +of the glossary. If you use \gls{makeindex} the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the \gloskey{sort} key (or \gloskey{name} key if the \gloskey{sort} key is omitted). The sub-divisions are in the following order: symbols, numbers, A, -\ldots, Z\@. If you use \app{xindy}, the sub-divisions depend on +\ldots, Z\@. If you use \gls{xindy}, the sub-divisions depend on the language settings. Note that the argument to \cs{glsgroupheading} @@ -4743,9 +5328,8 @@ A navigation hypertarget can be created using \cs{glsnavhypertarget}\marg{label}\marg{text} \end{definition} For further details about \cs{glsnavhypertarget}, see -\ifpdf\sectionref{sec:code:hypernav}\else the documented code of -\sty{glossary-hypernav} in \texttt{glossaries.pdf}\fi. - +\ifpdf section~\ref*{sec:code:hypernav} in \fi the documented code +(\texttt{glossaries.pdf}). Most of the predefined glossary styles redefine \cs{glsgroupheading} to simply ignore its argument. The \glostyle{listhypergroup} style @@ -4755,28 +5339,39 @@ redefines \cs{glsgroupheading} as follows: \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} \end{verbatim} See also \cs{glsgroupskip} below. (Note that command definitions within -\cs{newglossarystyle} must use \verb|##1| instead of \verb|#1| etc.) +\ics{newglossarystyle} must use \verb|##1| instead of \verb|#1| etc.) \begin{definition}[\DescribeMacro{\glsgroupskip}] \cs{glsgroupskip} \end{definition} This macro determines what to do after one logical group but before the header for the next logical group. The \glostyle{list} glossary -style simply redefines \cs{glsgroupskip} to be \cs{indexspace}, +style simply redefines \cs{glsgroupskip} to be \ics{indexspace}, whereas the tabular-like styles redefine \cs{glsgroupskip} to produce a blank row. \begin{definition}[\DescribeMacro{\glossaryentryfield}] -\cs{glossaryentryfield}\marg{label}\marg{formatted -name}\marg{description}\marg{symbol} -\marg{number list} +\cs{glossaryentryfield}\marg{label}\marg{formatted name}\marg{description} +\marg{symbol}\marg{number list} \end{definition} This macro indicates what to do for a given glossary entry. Note that \meta{formatted name} will always be in the form -\cs{glsnamefont}\marg{name}. This allows the user to set a given +\ics{glsnamefont}\marg{name}. This allows the user to set a given font for the entry name, regardless of the glossary style used. Note that \meta{label} is the label used when the glossary entry -was defined via either \cs{newglossaryentry} or \cs{newacronym}. +was defined via either \ics{newglossaryentry} or \ics{newacronym}. + +\begin{definition}[\DescribeMacro{\glsentryitem}] +\cs{glsentryitem}\marg{label} +\end{definition} +This macro will increment and display the associated counter for the +main (level~0) entries if the \pkgopt{entrycounter} or +\pkgopt{counterwithin} package options have been used. This macro +is typically called by \cs{glossaryentryfield} before \cs{glstarget}. +The format of the counter is controlled by the macro +\begin{definition}[\DescribeMacro{\glsentrycounterlabel}] +\cs{glsentrycounterlabel} +\end{definition} Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. @@ -4795,32 +5390,34 @@ For example, the \glostyle{list} style defines \cs{glossaryentryfield} as follows: \begin{verbatim} \renewcommand*{\glossaryentryfield}[5]{% -\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} +\item[\glsentryitem{##1}\glstarget{##1}{##2}] + ##3\glspostdescription \space ##5} \end{verbatim} -Note also that \meta{number list} will always be of the form\\[10pt] -\cs{glossaryentrynumbers}\{\cs{relax}\\ -\cs{setentrycounter}\marg{counter name}\cs{glsnumberformat}\marg{number(s)}\}\\[10pt] +Note also that \meta{number list} will always be of the form\\ +\begin{definition} +\ics{glossaryentrynumbers}\{\cs{relax}\\ +\ics{setentrycounter}\oarg{Hprefix}\marg{counter name}\meta{format cmd}\marg{number(s)}\} +\end{definition} where \meta{number(s)} -may contain \cs{delimN} (to delimit individual numbers) and/or -\cs{delimR} (to indicate a range of numbers). There may be +may contain \ics{delimN} (to delimit individual numbers) and/or +\ics{delimR} (to indicate a range of numbers). There may be multiple occurrences of -\cs{setentrycounter}\marg{counter name}\cs{glsnumberformat}\marg{number(s)}, but note +\ics{setentrycounter}\oarg{Hprefix}\marg{counter name}\meta{format cmd}\marg{number(s)}, but note that the entire number list is enclosed within the argument -to \ics{glossaryentrynumbers}. The user can redefine this to change +of \linebreak\ics{glossaryentrynumbers}. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of -\cs{glossaryentrynumbers} is to provide a means of suppressing the +\ics{glossaryentrynumbers} is to provide a means of suppressing the number list altogether. (In fact, the \pkgopt{nonumberlist} option -redefines \cs{glossaryentrynumbers} to ignore its argument.) +redefines \ics{glossaryentrynumbers} to ignore its argument.) Therefore, when you define a new glossary style, you don't need to worry about whether the user has specified the \pkgopt{nonumberlist} package option. \begin{definition}[\DescribeMacro{\glossarysubentryfield}] -\cs{glossarysubentryfield}\marg{level}\marg{label}\marg{formatted -name}\marg{description}\marg{symbol} -\marg{number list} +\cs{glossarysubentryfield}\marg{level}\marg{label}\marg{formatted name} +\marg{description}\marg{symbol}\marg{number list} \end{definition} This is new to version 1.17, and is used to display sub-entries. The first argument, \meta{level}, indicates the sub-entry level. @@ -4828,11 +5425,31 @@ This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \ics{glossaryentryfield} described above. -For further details of these commands, see -\ifpdf\sectionref{sec:code:printglos}\else the documented code in -\texttt{glossaries.pdf}\fi. +\begin{definition}[\DescribeMacro{\glssubentryitem}] +\cs{glssubentryitem}\marg{label} +\end{definition} +This macro will increment and display the associated counter for the +level~1 entries if the \pkgopt{subentrycounter} package options have +been used. This macro is typically called by \cs{glossarysubentryfield} +before \ics{glstarget}. The format of the counter is controlled by +the macro +\begin{definition}[\DescribeMacro{\glssubentrycounterlabel}] +\cs{glssubentrycounterlabel} +\end{definition} + +Note that \ics{printglossary} (which \ics{printglossaries} calls) +sets +\begin{definition}[\DescribeMacro{\currentglossary}] +\cs{currentglossary} +\end{definition} +to the current glossary label, so it's possible to create a glossary +style that varies according to the glossary type. + +For further details of these commands, see \ifpdf +section~\ref*{sec:code:printglos} \fi \qt{Displaying the glossary} +in the documented code (\texttt{glossaries.pdf}). -\subsubsection{Example: creating a completely new style} +\subsection{Example: creating a completely new style} If you want a completely new style, you will need to redefine all of the commands and the environment listed above. @@ -4846,7 +5463,7 @@ should do nothing) and suppose you don't want anything to appear immediately after \verb|\begin{theglossary}| (so \ics{glossaryheader} should do nothing). In addition, let's suppose the symbol should appear in brackets after the name, followed by the description and -last of all the \term{number list} should appear within square brackets +last of all the \gls{numberlist} should appear within square brackets at the end. Then you can create this new glossary style, called, say, \texttt{mylist}, as follows: \begin{verbatim} @@ -4873,19 +5490,19 @@ at the end. Then you can create this new glossary style, called, say, \end{verbatim} Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries. +It also hasn't used \ics{glsentryitem} or \ics{glssubentryitem} so +it won't be affected by the \pkgopt{entrycounter}, +\pkgopt{counterwithin} or \pkgopt{subentrycounter} package options. - -\subsubsection{Example: creating a new glossary style based on an +\subsection{Example: creating a new glossary style based on an existing style} -\changes{1.11}{2008 March 1}{Fixed error in manual (glossary style -is set using \cs{glossarystyle} not \cs{setglossarystyle})}% If you want to define a new style that is a slightly modified -version of an existing style, you can use \cs{glossarystyle} -within the second argument of \cs{newglossarystyle} followed by +version of an existing style, you can use \ics{glossarystyle} +within the second argument of \ics{newglossarystyle} followed by whatever alterations you require. For example, suppose you want a style like the \glostyle{list} style but you don't want the extra -vertical space created by \cs{indexspace} between groups, then you +vertical space created by \ics{indexspace} between groups, then you can create a new glossary style called, say, \texttt{mylist} as follows: \begin{verbatim} @@ -4895,9 +5512,9 @@ follows: } \end{verbatim} - -\subsubsection{Example: creating a glossary style that uses the -\gloskey{user1}, \ldots, \gloskey{user6} keys} +\subsection{Example: creating a glossary style that uses the +\texorpdfstring{\gloskey{user1}}{user1}, \ldots, +\texorpdfstring{\gloskey{user6}}{user6} keys} Since \ics{glossaryentryfield} and \ics{glossarysubentryfield} provide the label for the entry, it's also possible to access @@ -4919,8 +5536,9 @@ that displays each entry in a \env{longtable} as follows: \\\endhead}% % No heading between groups: \renewcommand*{\glsgroupheading}[1]{}% - % Main (level 0) entries displayed in a row: + % Main (level 0) entries displayed in a row optionally numbered: \renewcommand*{\glossaryentryfield}[5]{% + \glsentryitem{##1}% Entry number if required \glstarget{##1}{##2}% Name & ##3% Description & ##4% Symbol @@ -4929,16 +5547,24 @@ that displays each entry in a \env{longtable} as follows: & ##5% Page list \\% end of row }% - % Sub entries treated the same as level 0 entries: + % Similarly for sub-entries (no sub-entry numbers): \renewcommand*{\glossarysubentryfield}[6]{% - \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% + % ignoring first argument (sub-level) + \glstarget{##2}{##3}% Name + & ##4% Description + & ##5% Symbol + & \glsentryuseri{##2}% Units + & \glsentryuserii{##2}% Dimensions + & ##6% Page list + \\% end of row + }% % Nothing between groups: \renewcommand*{\glsgroupskip}{}% } \end{verbatim} -\subsection{Accessibility Support}\label{sec:accsupp} +\section{Accessibility Support}\label{sec:accsupp} Limited accessibility support is provided by the accompanying \sty{glossaries-accsupp} package, but note that this package is experimental and it requires the \sty{accsupp} package @@ -4973,8 +5599,19 @@ to the \gloskey{description} key. \item[{\gloskey{descriptionpluralaccess}}] The replacement text corresponding to the \gloskey{descriptionplural} key. -\end{description} +\item[{\gloskey{longaccess}}] The replacement text corresponding to +the \gloskey{long} key (used by \ics{newacronym}). + +\item[{\gloskey{shortaccess}}] The replacement text corresponding to +the \gloskey{short} key (used by \ics{newacronym}). + +\item[{\gloskey{longpluralaccess}}] The replacement text corresponding to +the \gloskey{longplural} key (used by \ics{newacronym}). + +\item[{\gloskey{shortpluralaccess}}] The replacement text corresponding to +the \gloskey{shortplural} key (used by \ics{newacronym}). +\end{description} For example: \begin{verbatim} \newglossaryentry{tex}{name={\TeX},description={Document preparation @@ -4984,93 +5621,221 @@ Now \verb|\gls{tex}| will be equivalent to \begin{verbatim} \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} \end{verbatim} -See \ifpdf \sectionref{sec:code:accsupp} \else the section -\qt{glossaries-accsupp code} in the document \texttt{glossaries.pdf} -\fi for further details. It is recommended that you also read the -\sty{accsupp} documentation. +The sample file \samplefile{accsupp} illustrates the +\sty{glossaries-accsupp} package. -\section{Mfirstuc Package} -\label{sec:mfirstuc} +See \ifpdf section~\ref*{sec:code:accsupp} in \fi the documented code +(\texttt{glossaries.pdf}) for further details. It is recommended +that you also read the \sty{accsupp} documentation. -The \styfmt{glossaries} bundle is supplied with the package -\sty{mfirstuc} which provides the command: -\begin{definition}[\DescribeMacro{\makefirstuc}] -\cs{makefirstuc}\marg{stuff} -\end{definition} -which makes the first object of -\meta{stuff} uppercase unless \meta{stuff} starts with a control -sequence followed by a non-empty group, in which case the first -object in the group is converted to uppercase. Examples: -\begin{itemize} -\item \verb|\makefirstuc{abc}| produces Abc +\section{Troubleshooting} +\label{sec:trouble} -\item \verb|\makefirstuc{\emph{abc}}| produces \emph{Abc} -(\ics{MakeUppercase} has been applied to the letter \qt{a} rather -than \cs{emph}.) Note however that -\verb|\makefirstuc{{\em abc}}| produces \emph{ABC} and -\verb|{\makefirstuc{\em abc}}| produces abc. +The \styfmt{glossaries} package comes with a minimal file called +\texttt{minimalgls.tex} which can be used for testing. This +should be located in the \texttt{samples} subdirectory (folder) +of the \styfmt{glossaries} documentation directory. The location +varies according to your operating system and \TeX\ installation. +For example, on my Linux partition it can be found in +\texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. +Further information on debugging \LaTeX\ code is available at +\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. -\item \verb|\makefirstuc{{\'a}bc}| produces \MakeUppercase{\'a}bc +Below is a list of the most frequently asked questions. For +other queries, consult the \styfmt{glossaries} FAQ at +\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. -\item \verb|\makefirstuc{\ae bc}| produces \MakeUppercase{\ae}bc +\begin{enumerate} +\item \textbf{Q.} I get the error message: +\begin{verbatim} +Missing \begin{document} +\end{verbatim} -\item \verb|\makefirstuc{{\ae}bc}| produces \MakeUppercase{\ae}bc +\textbf{A.} Check you are using an up to date version of the \sty{xkeyval} +package. -\item \verb|\makefirstuc{{ä}bc}| produces \MakeUppercase{ä}bc +\item \textbf{Q.} When I use \gls{xindy}, I get the following error +message: +\begin{verbatim} +ERROR: CHAR: index 0 should be less than the length of the string +\end{verbatim} -\end{itemize} -Note that non-Latin or accented characters appearing at the -start of the text must be placed in a group (even if you are -using the \sty{inputenc} package) due to expansion issues. +\textbf{A.} \gls{xindy} discards all commands and braces from the +sort string. If your sort string (either specified by the \gloskey{sort} +key or the \gloskey{name} key) only consists of commands, this will +be treated by \gls*{xindy} as an empty sort string, which produces an +error message in newer versions of \gls*{xindy}. For example, the +following will cause a problem: +\begin{verbatim} +\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + description=alpha} +\end{verbatim} +Either use a different sort key for the entry, for example: +\begin{verbatim} +\newglossaryentry{alpha}{sort=alpha, + name={\ensuremath{\alpha}}, + description=alpha} +\end{verbatim} +or, if all entries are like this, you may prefer to use the +\pkgopt[use]{sort} or \pkgopt[def]{sort} package options. See +\sectionref{sec:pkgopts-sort} for further details of the \pkgopt{sort} +option. -\begin{important} -In version 1.02 of \styfmt{mfirstuc}, a bug fix resulted in a change -in output if the first object is a control sequence followed by -an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}| -produced \ae Bc. However as from version 1.02, it now produces -\AE bc. -\end{important} +\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms +are displayed in normal sized upper case letters. + +\textbf{A.} The \pkgopt{smallcaps} package option uses \ics{textsc} to typeset +the acronyms. This command converts lower case letters to small +capitals, while upper case letters remain their usual size. Therefore +you need to specify the acronym in lower case letters. + +\item \textbf{Q.} My acronyms won't break across a line when they're +expanded. -Note also that +\textbf{A.} PDF\LaTeX\ can break hyperlinks across a line, but +\LaTeX\ can't. If you can't use PDF\LaTeX\ then disable the \gls{firstuse} +links using the package option \pkgopt[false]{hyperfirst}. + +\item \textbf{Q.} How do I change the font that the acronyms are displayed in? + +\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package +option and redefine \ics{acronymfont} to use the required typesetting +command. For example, suppose you would like the acronyms displayed in +a sans-serif font, then you can do: \begin{verbatim} -\newcommand{\abc}{abc} -\makefirstuc{\abc} +\usepackage[smaller]{glossaries} +\renewcommand*{\acronymfont}[1]{\textsf{#1}} \end{verbatim} -produces: ABC. This is because the first object in the argument of -\cs{makefirstuc} is \cs{abc}, so it does \verb|\MakeUppercase\abc|. -Whereas: + +\item \textbf{Q.} How do I change the font that the acronyms are displayed in +on \firstuse? + +\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package +option and redefine \ics{firstacronymfont} to use the required +command. Note that if you don't want the acronym on subsequent use +to use \ics{textsmaller}, you will also need to redefine \ics{acronymfont}, +as above. For example to make the acronym emphasized on +\firstuse, but use the surrounding font for subsequent use, you can do: \begin{verbatim} -\newcommand{\abc}{abc} -\expandafter\makefirstuc\expandafter{\abc} +\usepackage[smaller]{glossaries} +\renewcommand*{\firstacronymfont}[1]{\emph{#1}} +\renewcommand*{\acronymfont}[1]{#1} \end{verbatim} -produces: Abc. There is a short cut command which will do this:\\[10pt] -\begin{definition}[\DescribeMacro{\xmakefirstuc}] -\cs{xmakefirstuc}\marg{stuff} -\end{definition} -This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuff}. So + +\item \textbf{Q.} I don't have Perl installed, do I have to use +\gls{makeglossaries}? + +\textbf{A.} Although it is strongly recommended that you use +\gls{makeglossaries}, you don't have to use it. For further details, +read \sectionref{sec:xindyapp} or \sectionref{sec:makeindexapp}, +depending on whether you want to use \gls{xindy} or \gls{makeindex}. + +\item \textbf{Q.} I'm used to using the \styfmt{glossary} package: are there any +instructions on migrating from the \sty{glossary} package to the +\styfmt{glossaries} package? + +\textbf{A.} Read \qtdocref{Upgrading from the glossary package to +the glossaries package}{glossary2glossaries} which should be +available from the same location as this document. + +\item \textbf{Q.} I'm using \sty{babel} but the fixed names haven't +been translated. + +\textbf{A.} The \styfmt{glossaries} package currently only supports +the following languages: Brazilian Portuguese, Danish, Dutch, +English, French, German, Irish, Italian, Hungarian, Polish, Serbian and +Spanish. If you want to add another language, send me the +translations, and I'll add them to the next version. + +If you are using one of the above languages, but the text hasn't been +translated, try adding the \sty{translator} package with the +required languages explicitly (before you load the \styfmt{glossaries} +package). For example: \begin{verbatim} -\newcommand{\abc}{abc} -\xmakefirstuc{\abc} +\usepackage[ngerman]{babel} +\usepackage[ngerman]{translator} +\usepackage{glossaries} \end{verbatim} -produces: Abc. +Alternatively, you can add the language as a global option +to the class file. Check the \styfmt{translator} package documentation +for further details. + +\item \textbf{Q.} My acronyms contain strange characters when I use commands +like \ics{acrlong}. -If you want to use an alternative command to convert to uppercase, -for example \cs{MakeTextUppercase},\footnote{defined in the -\styfmt{textcase} package} you can redefine the internal -command \cs{@gls@makefirstuc}. For example: +\textbf{A.} Switch off the sanitization: \begin{verbatim} -\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} +\usepackage[sanitize=none]{glossaries} \end{verbatim} -(Remember that command names that contain the @ character must -either be placed in packages or be placed between \cs{makeatletter} -and \cs{makeatother}.) +and protect fragile commands. + +\item \textbf{Q.} Weird characters appear when I use +\ics{glsentryname} or \ics{glsname}. +\textbf{A.} Either use \ics{glsentrytext} or \ics{glstext}, +respectively, or switch off the sanitization for the \gloskey{name} +key: +\begin{verbatim} +\usepackage[sanitize={name=false}]{glossaries} +\end{verbatim} +and protect fragile commands. +\item \textbf{Q.} Weird characters appear when I try to display an +entry's description. -\StopEventually{% - \clearpage\phantomsection - \addcontentsline{toc}{section}{Index}\PrintIndex - -} +\textbf{A.} Switch off the sanitization for the \gloskey{description} +key: +\begin{verbatim} +\usepackage[sanitize={description=false}]{glossaries} +\end{verbatim} +and protect fragile commands. + +\item \textbf{Q.} My glossaries haven't appeared. + +\textbf{A.} Remember to do the following: +\begin{itemize} +\item Add \ics{makeglossaries} to the document preamble. + +\item Use either \ics{printglossary} for each glossary that has +been defined or \ics{printglossaries}. + +\item Use the commands listed in \sectionref{sec:glslink}, +\sectionref{sec:glsadd} or \sectionref{sec:crossref} for each entry +that you want to appear in the glossary. + +\item Run \LaTeX\ on your document, then run \gls{makeglossaries}, +then run \LaTeX\ on your document again. If you want the glossaries +to appear in the table of contents, you will need an extra \LaTeX\ +run. If any of your entries cross-reference an entry that's not +referenced in the main body of the document, you will need to run +\gls*{makeglossaries} (see \sectionref{sec:makeglossaries}) after the +second \LaTeX\ run, followed by another \LaTeX\ run. +\end{itemize} + +Check the log files (\filetype{.log}, \filetype{.glg} etc) for any +warnings. + +\item \textbf{Q.} It is possible to change the rules used to sort +the glossary entries? + +\textbf{A.} If it's for an individual entry, then you can use the +entry's \gloskey{sort} key to sort it according to a different term. +If it's for the entire alphabet, then you will need to use +\gls{xindy} (instead of \gls{makeindex}) and use an appropriate +\gls*{xindy} language module. Writing \gls*{xindy} modules or styles +is beyond the scope of this manual. Further information about +\gls*{xindy} can be found at the +\urlfootref{http://xindy.sourceforge.net/}{Xindy Web Site}. There is +also a link to the \gls*{xindy} mailing list from that site. + +If you want to sort according to order of definition or order of +use, use the \pkgopt{sort} package option described in +\sectionref{sec:pkgopts-sort}. + +\end{enumerate} + + +\clearpage\phantomsection +\addcontentsline{toc}{section}{Index}\PrintIndex \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf Binary files differindex 0ace931cbf6..0ecffe0a406 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index d416448d693..785571cdd77 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="2010-07-10 12:22:00" /> +<meta name="date" content="2011-04-04 11:04:00" /> <style type="text/css"> <!-- @@ -21,7 +21,6 @@ .cmr-12{font-size:120%;} .cmr-9{font-size:90%;} .cmbx-9{font-size:90%; font-weight: bold;} -.cmbx-9{ font-weight: bold;} .cmss-9{font-size:90%; font-family: sans-serif;} .cmss-9{ font-family: sans-serif;} .cmtt-10{font-family: monospace;} @@ -31,8 +30,6 @@ .cmtt-9{font-size:90%;font-family: monospace;} .cmtt-9{font-family: monospace;} .cmti-10{ font-style: italic;} -.cmbx-10{ font-weight: bold;} -.cmbx-10{ font-weight: bold;} p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -162,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">2010-05-28</span></div> +class="cmr-12">2011-04-02</span></div> </div> <div class="abstract" @@ -180,7 +177,7 @@ class="cmr-9">package for beginners who</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-manual.html" ><span +href="glossaries-user.html" ><span class="cmr-9">main user manual</span></a><span class="cmr-9">.</span> </p> @@ -216,59 +213,61 @@ class="cmss-10">ifthen</span><a class="cmss-10">xkeyval</span><a id="dx1-2002"></a> (at least version 2.5f), <span class="cmss-10">xfor</span><a - id="dx1-2003"></a> and <span + id="dx1-2003"></a>, <span class="cmss-10">amsgen</span><a - id="dx1-2004"></a>. You may also -need <span + 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 - id="dx1-2005"></a>, <span + id="dx1-2006"></a>, <span class="cmss-10">supertabular</span><a - id="dx1-2006"></a> and <span + id="dx1-2007"></a> and <span class="cmss-10">array</span><a - id="dx1-2007"></a>, depending on what glossary style you + 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 assistance. -</p><!--l. 48--><p class="indent" > In addition, you need an indexing application. The <span +</p><!--l. 49--><p class="indent" > In addition, you need an indexing application. The <span class="cmss-10">glossaries</span><a - id="dx1-2008"></a> package is configured to + id="dx1-2009"></a> package is configured to use either <span class="cmtt-10">makeindex</span><a - id="dx1-2009"></a> or <span + id="dx1-2010"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-2010"></a>. <span + id="dx1-2011"></a>. <span class="cmtt-10">Makeindex</span><a - id="dx1-2011"></a> should be available on all <span class="TEX">T<span + 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-2012"></a> installed, but it can be downloaded from the + id="dx1-2013"></a> installed, but it can be downloaded from the <a href="http://www.xindy.org/" >xindy home page</a>. The <span class="cmss-10">glossaries</span><a - id="dx1-2013"></a> package provides a helper Perl script called + id="dx1-2014"></a> package provides a helper Perl script called <span class="cmtt-10">makeglossaries</span><a - id="dx1-2014"></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-2015"></a> or <span + id="dx1-2016"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-2016"></a>. If you want to + id="dx1-2017"></a>. If you want to use <span class="cmtt-10">makeglossaries</span><a - id="dx1-2017"></a>, you need to have Perl installed, but you can use <span + id="dx1-2018"></a>, you need to have Perl installed, but you can use <span class="cmtt-10">makeindex</span><a - id="dx1-2018"></a> or + id="dx1-2019"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-2019"></a> directly if you prefer. -</p><!--l. 59--><p class="noindent" > + id="dx1-2020"></a> directly if you prefer. +</p><!--l. 60--><p class="noindent" > </p> -<!--l. 59--><p class="noindent" ><a +<!--l. 60--><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. 62--><p class="noindent" >The most obvious things to do is to remember to load the <span +<!--l. 63--><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: @@ -278,17 +277,18 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-1"> \usepackage{glossaries} </div> -<!--l. 66--><p class="nopar" > Note that the <span +<!--l. 67--><p class="nopar" > +</p><!--l. 68--><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 - id="dx1-3002"></a> package (contrary to -the general advice that <span + 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 + id="dx1-3004"></a> +package should also be loaded after <span class="cmss-10">html</span><a id="dx1-3005"></a>, <span class="cmss-10">inputenc</span><a @@ -296,8 +296,9 @@ class="cmss-10">inputenc</span><a class="cmss-10">babel</span><a id="dx1-3007"></a> and <span class="cmss-10">ngerman</span><a - id="dx1-3008"></a>. -</p><!--l. 73--><p class="indent" > If you want to use <span + id="dx1-3008"></a>. </div> +</p><!--l. 74--><p class="noindent" > +</p><!--l. 76--><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 @@ -310,24 +311,24 @@ specify this in the package options: <div class="verbatim" id="verbatim-2"> \usepackage[xindy]{glossaries} </div> -<!--l. 77--><p class="nopar" > Other package options are described in <a -href="glossaries-manual.html#sec:pkgopts" >Package Options</a> in the main <span +<!--l. 80--><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. 84--><p class="indent" > Next, you need to enable the creation of the various external files that are required +</p><!--l. 85--><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. 87--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 88--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\makeglossaries </span></div><hr> -</p><!--l. 88--><p class="noindent" > -</p><!--l. 90--><p class="noindent" > +</p><!--l. 89--><p class="noindent" > +</p><!--l. 91--><p class="noindent" > </p> -<!--l. 90--><p class="noindent" ><a +<!--l. 91--><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. 93--><p class="noindent" >You must define terms or symbols before you can use them in the document. This is +<!--l. 94--><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. 97--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 98--><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 @@ -337,7 +338,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. 98--><p class="noindent" > +</p><!--l. 99--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -347,7 +348,7 @@ 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 information for the term. A full list of available keys can be found in <a -href="glossaries-manual.html#sec:newglosentry" >Defining Glossary +href="glossaries-user.html#sec:newglosentry" >Defining Glossary Entries</a> in the main <span class="cmss-10">glossaries</span><a id="dx1-4001"></a> user manual. The principle keys are <span @@ -410,9 +411,10 @@ term: <div class="verbatim" id="verbatim-5"> \newglossaryentry{oesophagus}{name=\oe sophagus,  <br />description={canal from mouth to stomach}, - <br />plural=\oe sophagi,sort=oesophagus} + <br />plural=\oe sophagi, + <br />sort=oesophagus} </div> -<!--l. 140--><p class="nopar" > Note, however, that if you use the <span +<!--l. 141--><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 @@ -431,8 +433,8 @@ class="cmtt-10">xindy</span><a  <br />description={canal from mouth to stomach},  <br />plural=œsophagi} </div> -<!--l. 148--><p class="nopar" > -</p><!--l. 150--><p class="indent" > If the name starts with an accented character, the first character must be +<!--l. 149--><p class="nopar" > +</p><!--l. 151--><p class="indent" > If the name starts with an accented character, the first character must be grouped: @@ -443,7 +445,7 @@ grouped:  <br />description={select group of people},  <br />sort=elite} </div> -<!--l. 156--><p class="nopar" > or +<!--l. 157--><p class="nopar" > or @@ -452,8 +454,8 @@ grouped: \newglossaryentry{elite}{name={}lite,  <br />description={select group of people}} </div> -<!--l. 161--><p class="nopar" > -</p><!--l. 163--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For +<!--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 example: @@ -464,7 +466,7 @@ example:  <br />description={ratio of circumference of circle to its  <br />diameter},sort=pi} </div> -<!--l. 169--><p class="nopar" > It’s also possible to have a name and a symbol. For example: +<!--l. 170--><p class="nopar" > It’s also possible to have a name and a symbol. For example: @@ -474,28 +476,28 @@ example:  <br />description={a collection of objects},  <br />symbol={\ensuremath{\mathcal{S}}}} </div> -<!--l. 175--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary. -</p><!--l. 179--><p class="noindent" > +<!--l. 176--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary. +</p><!--l. 180--><p class="noindent" > </p> -<!--l. 179--><p class="noindent" ><a +<!--l. 180--><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. 182--><p class="noindent" >Once you have defined a term, you can use it in the document. The <span +<!--l. 183--><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 -href="glossaries-manual.html#sec:glslink" >Links to Glossary +href="glossaries-user.html#sec:glslink" >Links to Glossary 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. 191--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 189--><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. 192--><p class="noindent" > +</p><!--l. 190--><p class="noindent" > This prints the term associated with <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -506,13 +508,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. 199--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 197--><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. 200--><p class="noindent" > +</p><!--l. 198--><p class="noindent" > This prints the plural of the term associated with <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -520,23 +522,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. 206--><p class="indent" > There are also versions that convert the first character to upper case if you need to +</p><!--l. 204--><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. 209--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 207--><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. 210--><p class="noindent" > +</p><!--l. 208--><p class="noindent" > and -</p><!--l. 213--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 211--><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. 214--><p class="noindent" > +</p><!--l. 212--><p class="noindent" > For example: @@ -546,37 +548,37 @@ For example: \Glspl{electrolyte} usually exist as solutions of salts,  <br />bases or acids. </div> -<!--l. 219--><p class="nopar" > -</p><!--l. 221--><p class="indent" > Note that these commands all have two optional arguments that aren’t discussed +<!--l. 217--><p class="nopar" > +</p><!--l. 219--><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-manual.html#sec:glslink" >Links to Glossary Entries</a> in the main <span +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. 229--><p class="indent" > <span -class="cmbx-10">Caveat: </span>don’t use these commands in moving arguments, such as those used by +</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 +class="cmtt-10">\chapter</span>, <span -class="cmtt-10">\chapter</span>, <span class="cmtt-10">\section </span>and <span -class="cmtt-10">\caption</span>. You can, instead, use commands such -as -</p><!--l. 233--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\caption</span>. </div> +</p><!--l. 227--><p class="noindent" > +You can, instead, use commands such as +</p><!--l. 230--><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="noindent" > +</p><!--l. 231--><p class="noindent" > See <a -href="glossaries-manual.html#sec:glsnolink" >Using Glossary Terms Without Links</a> in the main <span +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. 241--><p class="noindent" > +</p><!--l. 235--><p class="noindent" > </p> -<!--l. 241--><p class="noindent" ><a +<!--l. 235--><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. 244--><p class="noindent" >The <span +<!--l. 238--><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 @@ -590,13 +592,13 @@ be placed in a separate list of acronyms: <div class="verbatim" id="verbatim-12"> \usepackage[acronym]{glossaries} </div> -<!--l. 250--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see +<!--l. 244--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see <a -href="glossaries-manual.html#sec:acronyms" >Acronyms</a> in the main <span +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. 258--><p class="indent" > Acronyms must be defined before use and are defined using: -</p><!--l. 260--><p class="indent" > <hr><div title="Definition"><span +</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 class="cmtt-10">\newacronym{</span><span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -610,7 +612,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. 261--><p class="noindent" > +</p><!--l. 252--><p class="noindent" > where <span class="cmsy-10">⟨</span><span class="cmti-10">label</span><span @@ -629,8 +631,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. 267--><p class="nopar" > -</p><!--l. 269--><p class="indent" > Once the acronym is defined, it can be used in the same way as any other glossary +<!--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 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 @@ -649,7 +651,7 @@ example: <div class="verbatim" id="verbatim-14"> A \gls{svm} was implemented. </div> -<!--l. 276--><p class="nopar" > If this is the first time this term has been used, the above would produce: +<!--l. 267--><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> @@ -657,31 +659,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. 289--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 280--><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. 290--><p class="noindent" > +</p><!--l. 281--><p class="noindent" > or you can reset all acronyms using -</p><!--l. 293--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 284--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsresetall </span></div><hr> -</p><!--l. 294--><p class="noindent" > +</p><!--l. 285--><p class="noindent" > For further details on resetting and unsetting acronyms, see <a -href="glossaries-manual.html#sec:glsunset" >Unsetting and Resetting +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. 302--><p class="noindent" > +</p><!--l. 291--><p class="noindent" > </p> -<!--l. 302--><p class="noindent" ><a +<!--l. 291--><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. 305--><p class="noindent" >In order to display the sorted list of terms, you first need to use -</p><!--l. 308--><p class="indent" > <hr><div title="Definition"><span +<!--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 class="cmtt-10">\printglossaries </span></div><hr> -</p><!--l. 309--><p class="noindent" > +</p><!--l. 298--><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, @@ -689,7 +691,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. 317--><p class="indent" > Suppose your document is called <span +</p><!--l. 306--><p class="indent" > Suppose your document is called <span class="cmtt-10">myDoc.tex</span>, then you need to: </p><ol class="enumerate1" > <li @@ -703,7 +705,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. 325--><p class="nopar" > + <!--l. 314--><p class="nopar" > </p></li> <li class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by the <span @@ -728,17 +730,17 @@ class="cmss-10">glossaries</span><a <div class="verbatim" id="verbatim-16"> makeglossaries myDoc </div> - <!--l. 336--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as WinEdt + <!--l. 325--><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. 342--><p class="noindent" >If you don’t have Perl installed, you will need to call <span + </p><!--l. 331--><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 id="dx1-7011"></a> explicitly. This is more complicated and is described in <a -href="glossaries-manual.html#sec:makeglossaries" >Generating the Associated +href="glossaries-user.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> in the main <span class="cmss-10">glossaries</span><a id="dx1-7012"></a> user manual. @@ -747,14 +749,14 @@ 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. 353--><p class="noindent" >Note that sometimes you may have to repeat steps 2 and 3. -</p><!--l. 355--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default +<!--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 style uses the <span class="cmss-10">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 -href="glossaries-manual.html#sec:styles" >Glossary Styles</a> in the main <span +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 @@ -769,17 +771,17 @@ class="cmss-10">nonumberlist</span><a <div class="verbatim" id="verbatim-17"> \usepackage[nonumberlist]{glossaries} </div> -<!--l. 368--><p class="nopar" > -</p><!--l. 370--><p class="indent" > Further information can be found in the main <span +<!--l. 353--><p class="nopar" > +</p><!--l. 355--><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-manual.html" >user manual</a> and there is +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 section. -</p><!--l. 378--><p class="noindent" ><a +</p><!--l. 361--><p class="noindent" ><a href="#top">Top</a></p> </body></html> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf Binary files differindex 30ff54aa7e8..81b7999a5c8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 6c2899afc2f..750445bdd81 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -4,7 +4,7 @@ \ifpdf \usepackage[T1]{fontenc} \usepackage{mathpazo} -\usepackage[scaled=.86]{helvet} +\usepackage[scaled=.88]{helvet} \usepackage{courier} \usepackage{xr-hyper} \fi @@ -13,12 +13,12 @@ \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2010-05-28} +\date{2011-04-02} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} -\ifpdf\externaldocument{glossaries}\fi +\ifpdf\externaldocument{glossaries-user}\fi \begin{document} \maketitle @@ -27,7 +27,7 @@ This document is a brief guide to the \styfmt{glossaries} package for beginners who find the size of the main user manual daunting and, as such, it only covers the basics. For more advanced topics, see the -\altdocref{main user manual}{glossaries}{glossaries-manual}. +\docref{main user manual}{glossaries-user}. \end{abstract} \tableofcontents @@ -37,7 +37,8 @@ such, it only covers the basics. For more advanced topics, see the You need to have the \styfmt{glossaries} package installed. You also need to have the following packages installed: \sty{ifthen}, -\sty{xkeyval} (at least version 2.5f), \sty{xfor} and \sty{amsgen}. +\sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and +\sty{etoolbox}. You may also need \sty{longtable}, \sty{supertabular} and \sty{array}, depending on what glossary style you want to use. All these packages can be downloaded from CTAN if you don't have them @@ -64,11 +65,13 @@ The most obvious things to do is to remember to load the \begin{verbatim} \usepackage{glossaries} \end{verbatim} +\begin{important} Note that the \styfmt{glossaries} package must be loaded \emph{after} the \sty{hyperref} package (contrary to the general advice that \sty{hyperref} should be loaded last). The \sty{glossaries} package should also be loaded after \sty{html}, \sty{inputenc}, \sty{babel} and \sty{ngerman}. +\end{important} If you want to use \app{xindy} rather than \app{makeindex} to sort the glossaries, you need to specify this in the package options: @@ -76,9 +79,7 @@ glossaries, you need to specify this in the package options: \usepackage[xindy]{glossaries} \end{verbatim} Other package options are described in -%\latexhtml{section~\ref{sec:pkgopts}}{the section -%\htmladdnormallink{\qt{Package Options}}{glossaries-manual.html#sec:pkgopts}} -\xrsectionref{sec:pkgopts}{glossaries-manual}{Package Options} +\xrsectionref{sec:pkgopts}{glossaries-user}{Package Options} in the main \sty{glossaries} user manual. Next, you need to enable the creation of the various external @@ -100,9 +101,8 @@ where \meta{label} is a unique label used to identify the term. The second argument, \meta{settings}, 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 -\xrsectionref{sec:newglosentry}{glossaries-manual}{Defining Glossary +\xrsectionref{sec:newglosentry}{glossaries-user}{Defining Glossary Entries} -%\latexhtml{section~\ref{sec:newglosentry}}{\htmladdnormallink{\qt{Defining Glossary Entries}}{glossaries-manual.html#sec:newglosentry}} in the main \sty{glossaries} user manual. The principle keys are \gloskey{name} and \gloskey{description}. @@ -136,7 +136,8 @@ specify how to sort the term: \begin{verbatim} \newglossaryentry{oesophagus}{name=\oe sophagus, description={canal from mouth to stomach}, -plural=\oe sophagi,sort=oesophagus} +plural=\oe sophagi, +sort=oesophagus} \end{verbatim} Note, however, that if you use the \sty{inputenc} package and \app{xindy}, you can use the encoded character \texttt{œ} rather than @@ -181,11 +182,8 @@ in the glossary. Once you have defined a term, you can use it in the document. The \sty{glossaries} package provides a number of commands that are -described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to -Glossary Entries} -%\latexhtml{section~\ref{sec:glslink}}{the section -%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} - in the main \sty{glossaries} user manual. +described in \xrsectionref{sec:glslink}{glossaries-user}{Links to +Glossary Entries} in the main \sty{glossaries} user manual. Here, I shall just cover the main commands: \begin{definition} \cs{gls}\marg{label} @@ -218,25 +216,21 @@ For example: bases or acids. \end{verbatim} -Note that these commands all have two optional arguments that -aren't discussed here, but they are -described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to -Glossary Entries} -%\latexhtml{section~\ref{sec:glslink}}{the section -%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} -in the main \sty{glossaries} user manual. +Note that these commands all have two optional arguments that aren't +discussed here, but they are described in +\xrsectionref{sec:glslink}{glossaries-user}{Links to Glossary +Entries} in the main \sty{glossaries} user manual. -\textbf{Caveat:} don't use these commands in moving arguments, such +\begin{important} +Don't use these commands in moving arguments, such as those used by \cs{chapter}, \cs{section} and \cs{caption}. +\end{important} You can, instead, use commands such as \begin{definition} \cs{glsentrytext}\marg{label} \end{definition} -See \xrsectionref{sec:glsnolink}{glossaries-manual}{Using Glossary -Terms Without Links} -%\latexhtml{section~\ref{sec:glsnolink}}{the section -%\htmladdnormallink{\qt{Using Glossary Terms Without Links}}{glossaries-manual.html#sec:glsnolink}} -in the main \sty{glossaries} user manual. +See \xrsectionref{sec:glsnolink}{glossaries-user}{Using Glossary +Terms Without Links} in the main \sty{glossaries} user manual. \section{Acronyms} \label{acronyms} @@ -249,11 +243,8 @@ placed in a separate list of acronyms: \usepackage[acronym]{glossaries} \end{verbatim} There are other options that govern how acronyms appear. For further -details, see \xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} -%\latexhtml{section~\ref{sec:acronyms}}{the section -%\htmladdnormallink{\qt{Acronyms}}{glossaries-manual.html#sec:acronyms}} -in -the main \sty{glossaries} user manual. +details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} +in the main \sty{glossaries} user manual. Acronyms must be defined before use and are defined using: \begin{definition} @@ -293,10 +284,8 @@ or you can reset all acronyms using \cs{glsresetall} \end{definition} For further details on resetting and unsetting acronyms, see -\xrsectionref{sec:glsunset}{glossaries-manual}{Unsetting and +\xrsectionref{sec:glsunset}{glossaries-user}{Unsetting and Resetting Entry Flags} -%\latexhtml{section~\ref{sec:glsunset}}{the section -%\htmladdnormallink{\qt{Unsetting and Resetting Entry Flags}}{glossaries-manual.html#sec:glsunset}} in the main \sty{glossaries} user manual. \section{Displaying the Glossary or List of Acronyms} @@ -339,13 +328,11 @@ 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. -If you don't have Perl installed, you will need to call \app{makeindex} -or \app{xindy} explicitly. This is more complicated and is described in -\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the -Associated Glossary Files} -%\latexhtml{section~\ref{sec:makeglossaries}}{the section -%\htmladdnormallink{\qt{Generating the Associated Glossary Files}}{glossaries-manual.html#sec:makeglossaries}} -in the main \sty{glossaries} user manual. +If you don't have Perl installed, you will need to call +\app{makeindex} or \app{xindy} explicitly. This is more complicated +and is described in +\xrsectionref{sec:makeglossaries}{glossaries-user}{Generating the +Associated Glossary Files} in the main \sty{glossaries} user manual. \item Once you have successfully run the indexing application, you need to build/\LaTeX\ your document again (see step~1). @@ -355,9 +342,7 @@ Note that sometimes you may have to repeat steps~2 and~3. The appearance of the glossary depends on the glossary style in use. The default style uses the \env{description} environment, but there are many other styles available. These are described -in \xrsectionref{sec:styles}{glossaries-manual}{Glossary Styles} -%\latexhtml{section~\ref{sec:styles}}{the section -%\htmladdnormallink{\qt{Glossary Styles}}{glossaries-manual.html#sec:styles}} +in \xrsectionref{sec:styles}{glossaries-user}{Glossary Styles} in the main \sty{glossaries} user manual. By default, a number or list of numbers will appear after each entry in the glossary. This indicates the page (or pages) @@ -368,9 +353,7 @@ the \pkgopt{nonumberlist} package option: \end{verbatim} Further information can be found in the main \sty{glossaries} -\altdocref{user manual}{glossaries}{glossaries-manual} -%\latexhtml{user manual (\href{glossaries.pdf}{glossaries.pdf})}{\htmladdnormallink{user -%manual}{glossaries-manual.html}} +\docref{user manual}{glossaries-user} and there is also an \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} on the \urlfootref{http://www.latex-community.org/}{\LaTeX\ Community's} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 5714b324cc3..9174defea75 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.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="glossary2glossaries.tex" /> -<meta name="date" content="2010-07-10 12:22:00" /> +<meta name="date" content="2011-04-04 11:04:00" /> <style type="text/css"> <!-- @@ -176,17 +176,17 @@ glossaries package</h2> <div class="author" ><span class="cmr-12">Nicola L.C. Talbot</span></div><br /> <div class="date" ><span -class="cmr-12">2010-05-28</span></div> +class="cmr-12">2011-04-02</span></div> </div> <div class="abstract" > <div class="center" > -<!--l. 35--><p class="noindent" > -</p><!--l. 35--><p class="noindent" ><span +<!--l. 38--><p class="noindent" > +</p><!--l. 38--><p class="noindent" ><span class="cmbx-9">Abstract</span></p></div> - <!--l. 36--><p class="indent" > <span + <!--l. 39--><p class="indent" > <span class="cmr-9">The purpose of this document is to provide advice if you want to</span> <span class="cmr-9">convert a </span><span class="LATEX"><span @@ -259,11 +259,11 @@ href="#x1-170009" id="QQ2-1-18">Processing Your Document</a></span> <br /> <span class="sectionToc" >10 <a href="#x1-1800010" id="QQ2-1-19">Troubleshooting</a></span> </div> -<!--l. 43--><p class="noindent" > +<!--l. 46--><p class="noindent" > </p> <h3 class="sectionHead"><span class="titlemark">1 </span> <a id="x1-20001"></a>Why the Need for a New Package?</h3> -<!--l. 46--><p class="noindent" >The <span +<!--l. 49--><p class="noindent" >The <span class="cmss-10">glossary </span>package started out as an example in a tutorial, but I decided that I may as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and unable to adapt well to the wide variation in glossary styles. Users began making @@ -321,12 +321,12 @@ href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a </li> <li class="itemize">different acronym styles are supported. </li></ul> -<!--l. 94--><p class="noindent" > +<!--l. 97--><p class="noindent" > </p> -<!--l. 94--><p class="noindent" ><a +<!--l. 97--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a id="x1-30002"></a>Package Options</h3> -<!--l. 96--><p class="noindent" >When converting a document that currently uses the obsolete <span +<!--l. 99--><p class="noindent" >When converting a document that currently uses the obsolete <span class="cmss-10">glossary </span>package to the replacement <span class="cmss-10">glossaries </span>package, it should be fairly obvious that the first thing you need @@ -344,7 +344,7 @@ options. -<!--l. 105--><p class="indent" > <a +<!--l. 108--><p class="indent" > <a id="x1-30011"></a></p><hr class="float" /><div class="float" > @@ -357,7 +357,7 @@ class="cmss-10">glossary </span>to <span class="cmss-10">glossaries </span>package options</span></div><!--tex4ht:label?: x1-30011 --> <div class="center" > -<!--l. 109--><p class="noindent" > +<!--l. 112--><p class="noindent" > </p> <div class="tabular"> <table id="TBL-2" class="tabular" cellspacing="0" cellpadding="0" @@ -494,12 +494,12 @@ class="cmti-10">no corresponding option </span></td></tr></table> </div><hr class="endfloat" /> </div> -<!--l. 143--><p class="noindent" ><a +<!--l. 146--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a id="x1-40003"></a>Defining new glossary types</h3> -<!--l. 145--><p class="noindent" >If you have created new glossary types, you will need to replace all instances +<!--l. 148--><p class="noindent" >If you have created new glossary types, you will need to replace all instances of -</p><!--l. 147--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 150--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\newglossarytype</span><a @@ -542,7 +542,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 152--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 155--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\newglossary</span><a @@ -572,7 +572,7 @@ class="cmtt-10">}</span> <br /></span> in the preamble, and, if the new glossary requires a different style to the main (default) glossary, you will also need to put -</p><!--l. 157--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 160--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glossarystyle</span><a @@ -588,7 +588,7 @@ immediately before the glossary is displayed, or you can specify the style when display the glossary using <span class="cmtt-10">\printglossary</span><a id="dx1-4004"></a> (see below). -</p><!--l. 164--><p class="indent" > The <span +</p><!--l. 167--><p class="indent" > The <span class="cmsy-10">⟨</span><span class="cmti-10">old style list</span><span class="cmsy-10">⟩ </span>optional argument can be converted to <span @@ -597,7 +597,7 @@ class="cmti-10">new style</span><span class="cmsy-10">⟩ </span>using the same mapping given in Table <a href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. -</p><!--l. 168--><p class="indent" > For example, if your document contains the following: +</p><!--l. 171--><p class="indent" > For example, if your document contains the following: @@ -606,7 +606,7 @@ href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. \newglossarytype[nlg]{notation}{not}{ntn}[style=long,header]  <br />\newcommand{\notationname}{Index of Notation} </div> -<!--l. 172--><p class="nopar" > You will need to replace the above two lines with: +<!--l. 175--><p class="nopar" > You will need to replace the above two lines with: @@ -614,7 +614,7 @@ href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. <div class="verbatim" id="verbatim-2"> \newglossary[nlg]{notation}{not}{ntn}{Index of Notation} </div> -<!--l. 176--><p class="nopar" > in the preamble and +<!--l. 179--><p class="nopar" > in the preamble and @@ -622,7 +622,7 @@ href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. <div class="verbatim" id="verbatim-3"> \glossarystyle{longheader} </div> -<!--l. 180--><p class="nopar" > immediately prior to displaying this glossary. Alternatively, you can specify the +<!--l. 183--><p class="nopar" > immediately prior to displaying this glossary. Alternatively, you can specify the style using the <span class="cmss-10">style</span><a id="dx1-4005"></a> key in the optional argument of <span @@ -636,8 +636,8 @@ example: <div class="verbatim" id="verbatim-4"> \printglossary[type=notation,style=longheader] </div> -<!--l. 186--><p class="nopar" > -</p><!--l. 188--><p class="indent" > Note that the glossary title is no longer specified using <span +<!--l. 189--><p class="nopar" > +</p><!--l. 191--><p class="indent" > Note that the glossary title is no longer specified using <span class="cmtt-10">\</span><span class="cmsy-10">⟨</span><span class="cmti-10">glossary-type</span><span @@ -666,16 +666,16 @@ class="cmss-10">toctitle</span><a optional argument to <span class="cmtt-10">\printglossary</span><a id="dx1-4011"></a>. -</p><!--l. 198--><p class="noindent" > +</p><!--l. 201--><p class="noindent" > </p> -<!--l. 198--><p class="noindent" ><a +<!--l. 201--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="x1-50004"></a><span class="cmtt-10">\make</span><span class="cmsy-10">⟨</span><span class="cmti-10">glossary name</span><span class="cmsy-10">⟩</span></h3> -<!--l. 200--><p class="noindent" >All instances of <span +<!--l. 203--><p class="noindent" >All instances of <span class="cmtt-10">\make</span><span class="cmsy-10">⟨</span><span class="cmti-10">glossary name</span><span @@ -696,7 +696,7 @@ contained the following: \makeglossary  <br />\makeacronym </div> -<!--l. 207--><p class="nopar" > then you should replace both lines with the single line: +<!--l. 210--><p class="nopar" > then you should replace both lines with the single line: @@ -704,13 +704,13 @@ contained the following: <div class="verbatim" id="verbatim-6"> \makeglossaries </div> -<!--l. 211--><p class="nopar" > -</p><!--l. 213--><p class="noindent" > +<!--l. 214--><p class="nopar" > +</p><!--l. 216--><p class="noindent" > </p> -<!--l. 213--><p class="noindent" ><a +<!--l. 216--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a id="x1-60005"></a>Storing glossary information</h3> -<!--l. 215--><p class="noindent" >With the old <span +<!--l. 218--><p class="noindent" >With the old <span class="cmss-10">glossary </span>package you could optionally store glossary information for later use, or you could simply use <span class="cmtt-10">\glossary</span><a @@ -733,8 +733,8 @@ href="#x1-110006.4"><span class="cmsy-10"></span>6.4 </a><a href="#x1-110006.4"><span class="cmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. -</p><!--l. 226--><p class="indent" > Substitute all instances of -</p><!--l. 227--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 229--><p class="indent" > Substitute all instances of +</p><!--l. 230--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\storeglosentry</span><a @@ -751,7 +751,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 231--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 234--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\newglossaryentry</span><a @@ -769,11 +769,11 @@ class="cmtt-10">}</span> <br /></span> This should be fairly easy to do using the search and replace facility in your editor (but see notes below). -</p><!--l. 237--><p class="indent" > If you have used the optional argument of <span +</p><!--l. 240--><p class="indent" > If you have used the optional argument of <span class="cmtt-10">\storeglosentry</span><a id="dx1-6009"></a> (i.e. you have multiple glossaries) then you will need to substitute -</p><!--l. 240--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 243--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\storeglosentry</span><a @@ -794,7 +794,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 244--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 247--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\newglossaryentry</span><a @@ -818,7 +818,7 @@ class="cmtt-10">}</span></span> <br /></span> -</p><!--l. 248--><p class="indent" > The glossary entry information <span +</p><!--l. 251--><p class="indent" > The glossary entry information <span class="cmsy-10">⟨</span><span class="cmti-10">gls-entry</span><span class="cmsy-10">⟩ </span>may also need changing. If <span @@ -843,7 +843,7 @@ internally. For example, if your document contains the following: \storeglosentry{card}{name={$"|\mathcal{S}"|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> -<!--l. 257--><p class="nopar" > then you will need to replace it with: +<!--l. 260--><p class="nopar" > then you will need to replace it with: @@ -852,8 +852,8 @@ internally. For example, if your document contains the following: \newglossaryentry{card}{name={$|\mathcal{S}|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> -<!--l. 262--><p class="nopar" > -</p><!--l. 264--><p class="indent" > The <span +<!--l. 265--><p class="nopar" > +</p><!--l. 267--><p class="indent" > The <span class="cmss-10">format</span><a id="dx1-6013"></a> and <span class="cmss-10">number</span><a @@ -863,12 +863,12 @@ class="cmtt-10">\storeglosentry</span><a <span class="cmtt-10">\newglossaryentry</span><a id="dx1-6016"></a>. -</p><!--l. 268--><p class="noindent" > +</p><!--l. 271--><p class="noindent" > </p> -<!--l. 268--><p class="noindent" ><a +<!--l. 271--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a id="x1-70006"></a>Adding an entry to the glossary</h3> -<!--l. 270--><p class="noindent" >The <span +<!--l. 273--><p class="noindent" >The <span class="cmss-10">glossary </span>package provided two basic means to add information to the glossary: firstly, the term was defined using <span class="cmtt-10">\storeglosentry</span><a @@ -885,16 +885,16 @@ class="cmtt-10">\glossary</span><a id="dx1-7005"></a>. This second approach is unavailable with the <span class="cmss-10">glossaries</span> package. -</p><!--l. 279--><p class="noindent" > +</p><!--l. 282--><p class="noindent" > </p> -<!--l. 279--><p class="noindent" ><a +<!--l. 282--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a id="x1-80006.1"></a><span class="cmtt-10">\useglosentry</span></h4> -<!--l. 282--><p class="noindent" >The <span +<!--l. 285--><p class="noindent" >The <span class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined term without producing any text in the document using -</p><!--l. 285--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 288--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\useglosentry</span><a @@ -911,7 +911,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 289--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 292--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glsadd</span><a @@ -960,16 +960,16 @@ class="cmsy-10">⟩</span>. -</p><!--l. 300--><p class="noindent" > +</p><!--l. 303--><p class="noindent" > </p> -<!--l. 300--><p class="noindent" ><a +<!--l. 303--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a id="x1-90006.2"></a><span class="cmtt-10">\useGlosentry</span></h4> -<!--l. 302--><p class="noindent" >The <span +<!--l. 305--><p class="noindent" >The <span class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined term with the given text using -</p><!--l. 304--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 307--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\useGlosentry</span><a @@ -990,7 +990,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 308--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 311--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glslink</span><a @@ -1022,13 +1022,13 @@ class="cmsy-10"></span>6.1 </a><a href="#x1-80006.1"><span class="cmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. -</p><!--l. 314--><p class="noindent" > +</p><!--l. 317--><p class="noindent" > </p> -<!--l. 314--><p class="noindent" ><a +<!--l. 317--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a id="x1-100006.3"></a><span class="cmtt-10">\gls</span></h4> -<!--l. 316--><p class="noindent" >Both the <span +<!--l. 319--><p class="noindent" >Both the <span class="cmss-10">glossary </span>and the <span class="cmss-10">glossaries </span>packages define the command <span class="cmtt-10">\gls</span><a @@ -1043,13 +1043,13 @@ class="cmtt-10">\gls</span><a id="dx1-10004"></a> also takes a final optional argument which can be used to insert text into the automatically generated text. -</p><!--l. 323--><p class="noindent" > +</p><!--l. 326--><p class="noindent" > </p> -<!--l. 323--><p class="noindent" ><a +<!--l. 326--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a id="x1-110006.4"></a><span class="cmtt-10">\glossary</span></h4> -<!--l. 326--><p class="noindent" >When using the <span +<!--l. 329--><p class="noindent" >When using the <span class="cmss-10">glossaries </span>package, you should not use <span class="cmtt-10">\glossary</span><a id="dx1-11001"></a> @@ -1081,7 +1081,7 @@ class="cmtt-10">\glslink</span><a id="dx1-11016"></a>, <span class="cmtt-10">\gls</span><a id="dx1-11017"></a> etc. -</p><!--l. 349--><p class="indent" > If you don’t like the idea of continually scrolling back to the preamble to type all +</p><!--l. 352--><p class="indent" > If you don’t like the idea of continually scrolling back to the preamble to type all your <span class="cmtt-10">\newglossaryentry</span><a id="dx1-11018"></a> commands, you may prefer to create a new file, in which to @@ -1091,19 +1091,19 @@ store all these commands, and then input that file in your document’s prea text editors and front-ends allow you to have multiple files open, and you can tab back and forth between them. -</p><!--l. 356--><p class="noindent" > +</p><!--l. 359--><p class="noindent" > </p> -<!--l. 356--><p class="noindent" ><a +<!--l. 359--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a id="x1-120007"></a>Acronyms</h3> -<!--l. 358--><p class="noindent" >In the <span +<!--l. 361--><p class="noindent" >In the <span class="cmss-10">glossary </span>package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new <span class="cmss-10">glossaries</span> package treats acronyms in exactly the same way as normal glossary terms. In fact, in the <span class="cmss-10">glossaries </span>package, the default definition of: -</p><!--l. 363--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 366--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\newacronym</span><a @@ -1128,7 +1128,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> is a shortcut for: -</p><!--l. 367--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 370--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\newglossaryentry</span><a @@ -1196,7 +1196,7 @@ class="cmti-10">options</span><span class="cmsy-10">⟩}</span> <br /></div><hr> <br /></span> -</p><!--l. 378--><p class="indent" > This is different to the <span +</p><!--l. 381--><p class="indent" > This is different to the <span class="cmss-10">glossary </span>package which set the <span class="cmss-10">name</span><a id="dx1-12003"></a> key to <span @@ -1217,7 +1217,7 @@ class="cmss-10">description</span><a optional argument of <span class="cmtt-10">\newacronym</span><a id="dx1-12007"></a>. -</p><!--l. 386--><p class="indent" > For example, if your document originally had the following: +</p><!--l. 389--><p class="indent" > For example, if your document originally had the following: @@ -1226,7 +1226,7 @@ class="cmtt-10">\newacronym</span><a \newacronym{SVM}{Support Vector Machine}{description=Statistical  <br />pattern recognition technique} </div> -<!--l. 390--><p class="nopar" > Then you would need to load the <span +<!--l. 393--><p class="nopar" > Then you would need to load the <span class="cmss-10">glossaries </span>package using the <span class="cmss-10">description</span><a id="dx1-12008"></a> package @@ -1238,7 +1238,7 @@ option, for example: <div class="verbatim" id="verbatim-10"> \usepackage[description]{glossaries} </div> -<!--l. 395--><p class="nopar" > and change the acronym definition to: +<!--l. 398--><p class="nopar" > and change the acronym definition to: @@ -1247,13 +1247,13 @@ option, for example: \newacronym[description=Statistical pattern recognition  <br />technique]{svm}{SVM}{Support Vector Machine} </div> -<!--l. 400--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such +<!--l. 403--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such as <span class="cmtt-10">\gls</span><a id="dx1-12009"></a> or <span class="cmtt-10">\glsadd</span><a id="dx1-12010"></a>. -</p><!--l. 404--><p class="indent" > With the old <span +</p><!--l. 407--><p class="indent" > With the old <span class="cmss-10">glossary </span>package, when you defined an acronym, it also defined a command <span class="cmtt-10">\</span><span @@ -1276,7 +1276,7 @@ above example, you will also need to replace all occurrences of <span class="cmtt-10">\SVM </span>with <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{svm}</span></span></span>. -</p><!--l. 414--><p class="indent" > If you have used <span +</p><!--l. 417--><p class="indent" > If you have used <span class="cmtt-10">\useacronym</span><a id="dx1-12012"></a> instead of <span class="cmtt-10">\</span><span @@ -1284,7 +1284,7 @@ class="cmsy-10">⟨</span><span class="cmti-10">acr-name</span><span class="cmsy-10">⟩</span>, then you will need to replace all occurrences of -</p><!--l. 416--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 419--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\useacronym</span><a @@ -1301,7 +1301,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 420--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 423--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\gls</span><a @@ -1332,7 +1332,7 @@ class="cmsy-10">⟨</span><span class="cmti-10">label</span><span class="cmsy-10">⟩</span><span class="cmtt-10">}</span>. -</p><!--l. 427--><p class="indent" > Alternatively (as from v1.18 of the <span +</p><!--l. 430--><p class="indent" > Alternatively (as from v1.18 of the <span class="cmss-10">glossaries </span>package), you can use <span class="cmtt-10">\oldacronym</span><a id="dx1-12017"></a> @@ -1346,33 +1346,33 @@ class="cmsy-10">⟨</span><span class="cmti-10">acr-name</span><span class="cmsy-10">⟩</span>. For example, if your document originally had the following: -</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 435--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <div class="verbatim" id="verbatim-12"> -<!--l. 436--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical -</p><!--l. 436--><p class="noindent" >pattern recognition technique} +<!--l. 439--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 439--><p class="noindent" >pattern recognition technique} </p></div> -<!--l. 436--><p class="nopar" > +<!--l. 439--><p class="nopar" > </div><hr> -</p><!--l. 437--><p class="noindent" ></p></span> +</p><!--l. 440--><p class="noindent" ></p></span> then you can change this to: -</p><!--l. 439--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 442--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <div class="verbatim" id="verbatim-13"> -<!--l. 443--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical -</p><!--l. 443--><p class="noindent" >pattern recognition technique} +<!--l. 446--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 446--><p class="noindent" >pattern recognition technique} </p></div> -<!--l. 443--><p class="nopar" > +<!--l. 446--><p class="nopar" > </div><hr> -</p><!--l. 444--><p class="noindent" ></p></span> +</p><!--l. 447--><p class="noindent" ></p></span> You can then continue to use <span class="cmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> generally ignores @@ -1384,7 +1384,7 @@ class="cmti-10">acr-name</span><span class="cmsy-10">⟩</span>, unless you also load the <span class="cmss-10">xspace </span>package. (See <a -href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span class="cmss-10">glossaries </span>documentation for further details.) Note that <span class="cmtt-10">\oldacronym</span><a @@ -1496,18 +1496,18 @@ in place of <span class="cmtt-10">\acrlong</span><a id="dx1-13015"></a>. </p><!--l. 493--><p class="indent" > See <a -href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span class="cmss-10">glossaries </span>manual for further details of how to use these commands. -</p><!--l. 502--><p class="noindent" > +</p><!--l. 499--><p class="noindent" > </p> -<!--l. 502--><p class="noindent" ><a +<!--l. 499--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a id="x1-140007.2"></a><span class="cmtt-10">\ifacronymfirstuse</span></h4> -<!--l. 504--><p class="noindent" >The <span +<!--l. 501--><p class="noindent" >The <span class="cmss-10">glossary </span>package command -</p><!--l. 505--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 502--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\ifacronymfirstuse</span><a @@ -1529,7 +1529,7 @@ class="cmtt-10">}</span> <br /></span> can be replaced by the <span class="cmss-10">glossaries </span>command: -</p><!--l. 509--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 506--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\ifglsused</span><a @@ -1555,20 +1555,20 @@ class="cmtt-10">\ifglsused</span><a class="cmtt-10">\ifacronymfirstuse</span><a id="dx1-14004"></a> which is why the last two arguments have been reversed. -</p><!--l. 518--><p class="noindent" > +</p><!--l. 515--><p class="noindent" > </p> -<!--l. 518--><p class="noindent" ><a +<!--l. 515--><p class="noindent" ><a href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a id="x1-150007.3"></a><span class="cmtt-10">\resetacronym </span>and <span class="cmtt-10">\unsetacronym</span></h4> -<!--l. 520--><p class="noindent" >The <span +<!--l. 517--><p class="noindent" >The <span class="cmss-10">glossary </span>package allows you to reset and unset the acronym flag which is used to determine whether the acronym has been used in the document. The <span class="cmss-10">glossaries </span>package also provides a means to do this on either a local or a global level. To reset an acronym, you will need to replace: -</p><!--l. 525--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 522--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\resetacronym</span><a @@ -1584,7 +1584,7 @@ class="cmtt-10">}</span> <br /></span> with either -</p><!--l. 529--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 526--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glsreset</span><a @@ -1597,7 +1597,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> or -</p><!--l. 533--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 530--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glslocalreset</span><a @@ -1609,8 +1609,8 @@ class="cmsy-10">⟩</span><span class="cmtt-10">}</span> <br /></div><hr> <br /></span> -</p><!--l. 537--><p class="indent" > To unset an acronym, you will need to replace: -</p><!--l. 538--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 534--><p class="indent" > To unset an acronym, you will need to replace: +</p><!--l. 535--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\unsetacronym</span><a @@ -1623,7 +1623,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> with either -</p><!--l. 542--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 539--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glsunset</span><a @@ -1636,7 +1636,7 @@ class="cmtt-10">}</span> <br /></div><hr> <br /></span> or -</p><!--l. 546--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 543--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glslocalunset</span><a @@ -1648,8 +1648,8 @@ class="cmsy-10">⟩</span><span class="cmtt-10">}</span> <br /></div><hr> <br /></span> -</p><!--l. 550--><p class="indent" > To reset all acronyms, you will need to replace: -</p><!--l. 551--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 547--><p class="indent" > To reset all acronyms, you will need to replace: +</p><!--l. 548--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\resetallacronyms</span><a @@ -1657,7 +1657,7 @@ class="cmtt-10">\resetallacronyms</span><a <br /></div><hr> <br /></span> with -</p><!--l. 555--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 552--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glsresetall</span><a @@ -1671,7 +1671,7 @@ class="cmtt-10">]</span> or -</p><!--l. 559--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 556--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glslocalresetall</span><a @@ -1682,7 +1682,7 @@ class="cmtt-10">]</span> <br /></div><hr> <br /></span> To unset all acronyms, you will need to replace: -</p><!--l. 563--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 560--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossary</span></span><span class="obeylines-h"> <span class="cmtt-10">\unsetallacronyms</span><a @@ -1690,7 +1690,7 @@ class="cmtt-10">\unsetallacronyms</span><a <br /></div><hr> <br /></span> with -</p><!--l. 567--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 564--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glsunsetall</span><a @@ -1701,7 +1701,7 @@ class="cmtt-10">]</span> <br /></div><hr> <br /></span> or -</p><!--l. 571--><p class="indent" > <hr><div><span class="marginpar"><span +</p><!--l. 568--><p class="indent" > <hr><div><span class="marginpar"><span class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span class="cmtt-10">\glslocalunsetall</span><a @@ -1711,12 +1711,12 @@ class="cmtt-10">[\acronymtype</span><a class="cmtt-10">]</span> <br /></div><hr> <br /></span> -</p><!--l. 575--><p class="noindent" > +</p><!--l. 572--><p class="noindent" > </p> -<!--l. 575--><p class="noindent" ><a +<!--l. 572--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a id="x1-160008"></a>Displaying the glossary</h3> -<!--l. 577--><p class="noindent" >The <span +<!--l. 574--><p class="noindent" >The <span class="cmss-10">glossary </span>package provides the command <span class="cmtt-10">\printglossary</span><a id="dx1-16001"></a> (or <span @@ -1749,7 +1749,7 @@ say: \printglossary  <br />\printglossary[acronym] </div> -<!--l. 588--><p class="nopar" > or +<!--l. 585--><p class="nopar" > or @@ -1758,7 +1758,7 @@ say: \printglossary  <br />\printacronym </div> -<!--l. 593--><p class="nopar" > then you will need to replace this with either +<!--l. 590--><p class="nopar" > then you will need to replace this with either @@ -1766,7 +1766,7 @@ say: <div class="verbatim" id="verbatim-16"> \printglossaries </div> -<!--l. 597--><p class="nopar" > or +<!--l. 594--><p class="nopar" > or @@ -1775,8 +1775,8 @@ say: \printglossary  <br />\printglossary[type=\acronymtype] </div> -<!--l. 602--><p class="nopar" > -</p><!--l. 604--><p class="indent" > The <span +<!--l. 599--><p class="nopar" > +</p><!--l. 601--><p class="indent" > The <span class="cmss-10">glossary </span>package allows you to specify a short title (for the table of contents and page header) by defining a command of the form <span class="cmtt-10">\short</span><span @@ -1800,7 +1800,7 @@ class="cmtt-10">notation</span>, and you had defined <div class="verbatim" id="verbatim-18"> \newcommand{\shortnotationname}{Notation} </div> -<!--l. 614--><p class="nopar" > then you would need to use the <span +<!--l. 611--><p class="nopar" > then you would need to use the <span class="cmss-10">toctitle</span><a id="dx1-16007"></a> key: @@ -1810,17 +1810,17 @@ class="cmss-10">toctitle</span><a <div class="verbatim" id="verbatim-19"> \printglossary[type=notation,toctitle=Notation] </div> -<!--l. 618--><p class="nopar" > The <span +<!--l. 615--><p class="nopar" > The <span class="cmss-10">glossaries </span>package will ignore <span class="cmtt-10">\shortnotationname</span><a id="dx1-16008"></a>, so unless you have used it elsewhere in the document, you may as well remove the definition. -</p><!--l. 623--><p class="noindent" > +</p><!--l. 620--><p class="noindent" > </p> -<!--l. 623--><p class="noindent" ><a +<!--l. 620--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a id="x1-170009"></a>Processing Your Document</h3> -<!--l. 625--><p class="noindent" >If you convert your document from using the <span +<!--l. 622--><p class="noindent" >If you convert your document from using the <span class="cmss-10">glossary </span>package to the <span class="cmss-10">glossaries </span>package, you will need to delete any of the additional files, such as the <span @@ -1846,7 +1846,7 @@ class="cmtt-10">xindy</span><a multilingual, the new <span class="cmss-10">glossaries </span>package is a much better option for non-English documents. -</p><!--l. 638--><p class="indent" > For further information on using <span +</p><!--l. 635--><p class="indent" > For further information on using <span class="cmtt-10">makeglossaries</span><a id="dx1-17007"></a>, <span class="cmtt-10">makeindex</span><a @@ -1854,15 +1854,15 @@ class="cmtt-10">makeindex</span><a class="cmtt-10">xindy</span><a id="dx1-17009"></a> to create your glossaries, see <a -href="glossaries-manual.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span +href="glossaries-user.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span class="cmss-10">glossaries</span> documentation. -</p><!--l. 647--><p class="noindent" > +</p><!--l. 641--><p class="noindent" > </p> -<!--l. 647--><p class="noindent" ><a +<!--l. 641--><p class="noindent" ><a href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a id="x1-1800010"></a>Troubleshooting</h3> -<!--l. 649--><p class="noindent" >Please check the <a +<!--l. 643--><p class="noindent" >Please check the <a href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" >FAQ</a> for the <span class="cmss-10">glossaries </span>package if you have any problems. </p><!--l. 2--><p class="noindent" > @@ -1871,86 +1871,327 @@ class="cmss-10">glossaries </span>package if you have any problems. href="#top">Top</a></p><h3 class="likesectionHead"><a id="x1-1900010"></a>Index</h3> <!--l. 4--><p class="noindent" > <span -class="cmbx-10">F</span> +class="cmbx-10">A</span> </p> - <div class="theindex"><span class="index-item">file types<br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.glo</span>  13 <br /></span> + <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acl</span></span></span>  <a +href="glossary2glossaries.html#dx1-13014" ><span class="underline">1</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrln</span></span></span>  <a +href="glossary2glossaries.html#dx1-13001" ><span class="underline">2</span></a>, <a +href="glossary2glossaries.html#dx1-13008" ><span class="underline">3</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrlong</span></span></span>  <a +href="glossary2glossaries.html#dx1-13009" ><span class="underline">4</span></a>, <a +href="glossary2glossaries.html#dx1-13015" ><span class="underline">5</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrlongpl</span></span></span>  <a +href="glossary2glossaries.html#dx1-13011" ><span class="underline">6</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acronymname</span></span></span>  <a +href="glossary2glossaries.html#dx1-4008" ><span class="underline">7</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acronymtype</span></span></span>  <a +href="glossary2glossaries.html#dx1-15009" ><span class="underline">8</span></a>, <a +href="glossary2glossaries.html#dx1-15011" ><span class="underline">9</span></a>, <a +href="glossary2glossaries.html#dx1-15014" ><span class="underline">10</span></a>, <a +href="glossary2glossaries.html#dx1-15016" ><span class="underline">11</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrsh</span></span></span>  <a +href="glossary2glossaries.html#dx1-13002" ><span class="underline">12</span></a>, <a +href="glossary2glossaries.html#dx1-13006" ><span class="underline">13</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrshort</span></span></span>  <a +href="glossary2glossaries.html#dx1-13007" ><span class="underline">14</span></a>, <a +href="glossary2glossaries.html#dx1-13013" ><span class="underline">15</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrshortpl</span></span></span>  <a +href="glossary2glossaries.html#dx1-13010" ><span class="underline">16</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acs</span></span></span>  <a +href="glossary2glossaries.html#dx1-13012" ><span class="underline">17</span></a> <br /></span> <p class="theindex"> <span +class="cmbx-10">F</span> +<span class="index-item">file types<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">.glo</span>  <a +href="glossary2glossaries.html#dx1-17001" >18</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">G</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossary</span></span></span>  <a +href="glossary2glossaries.html#dx1-6001" ><span class="underline">19</span></a>, <a +href="glossary2glossaries.html#dx1-6006" ><span class="underline">20</span></a>, <a +href="glossary2glossaries.html#dx1-7005" ><span class="underline">21</span></a>, <a +href="glossary2glossaries.html#dx1-11001" ><span class="underline">22</span></a>, <a +href="glossary2glossaries.html#dx1-11008" ><span class="underline">23</span></a>, <a +href="glossary2glossaries.html#dx1-11013" ><span class="underline">24</span></a>, <a +href="glossary2glossaries.html#dx1-6003" ><span class="underline">25</span></a>, <a +href="glossary2glossaries.html#dx1-11003" ><span class="underline">26</span></a>, <a +href="glossary2glossaries.html#dx1-11011" ><span class="underline">27</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossaryname</span></span></span>  <a +href="glossary2glossaries.html#dx1-4007" ><span class="underline">28</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossarystyle</span></span></span>  <a +href="glossary2glossaries.html#dx1-4003" ><span class="underline">29</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Gls</span></span></span>  <a +href="glossary2glossaries.html#dx1-12016" ><span class="underline">30</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls</span></span></span>  <a +href="glossary2glossaries.html#dx1-7004" ><span class="underline">31</span></a>, <a +href="glossary2glossaries.html#dx1-10001" ><span class="underline">32</span></a>, <a +href="glossary2glossaries.html#dx1-10004" ><span class="underline">33</span></a>, <a +href="glossary2glossaries.html#dx1-11017" ><span class="underline">34</span></a>, <a +href="glossary2glossaries.html#dx1-12009" ><span class="underline">35</span></a>, <a +href="glossary2glossaries.html#dx1-12011" ><span class="underline">36</span></a>, <a +href="glossary2glossaries.html#dx1-12014" ><span class="underline">37</span></a>, <a +href="glossary2glossaries.html#dx1-12020" ><span class="underline">38</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\gls </span>options<br /></span> - - - <span class="index-subitem">    <span -class="cmss-10">counter</span>  7 <br /></span> +class="cmss-10">counter</span>  <a +href="glossary2glossaries.html#dx1-10003" >39</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">number</span>  7 <br /></span> +class="cmss-10">number</span>  <a +href="glossary2glossaries.html#dx1-10002" >40</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsadd</span></span></span>  <a +href="glossary2glossaries.html#dx1-8002" ><span class="underline">41</span></a>, <a +href="glossary2glossaries.html#dx1-11015" ><span class="underline">42</span></a>, <a +href="glossary2glossaries.html#dx1-12010" ><span class="underline">43</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\glsadd </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">counter</span>  6 <br /></span> +class="cmss-10">counter</span>  <a +href="glossary2glossaries.html#dx1-8005" >44</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslink</span></span></span>  <a +href="glossary2glossaries.html#dx1-9002" ><span class="underline">45</span></a>, <a +href="glossary2glossaries.html#dx1-11016" ><span class="underline">46</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslocalreset</span></span></span>  <a +href="glossary2glossaries.html#dx1-15003" ><span class="underline">47</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslocalresetall</span></span></span>  <a +href="glossary2glossaries.html#dx1-15010" ><span class="underline">48</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslocalunset</span></span></span>  <a +href="glossary2glossaries.html#dx1-15006" ><span class="underline">49</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslocalunsetall</span></span></span>  <a +href="glossary2glossaries.html#dx1-15015" ><span class="underline">50</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsreset</span></span></span>  <a +href="glossary2glossaries.html#dx1-15002" ><span class="underline">51</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsresetall</span></span></span>  <a +href="glossary2glossaries.html#dx1-15008" ><span class="underline">52</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsunset</span></span></span>  <a +href="glossary2glossaries.html#dx1-15005" ><span class="underline">53</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsunsetall</span></span></span>  <a +href="glossary2glossaries.html#dx1-15013" ><span class="underline">54</span></a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">I</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ifacronymfirstuse</span></span></span>  <a +href="glossary2glossaries.html#dx1-14001" ><span class="underline">55</span></a>, <a +href="glossary2glossaries.html#dx1-14004" ><span class="underline">56</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ifglsused</span></span></span>  <a +href="glossary2glossaries.html#dx1-14002" ><span class="underline">57</span></a>, <a +href="glossary2glossaries.html#dx1-14003" ><span class="underline">58</span></a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">M</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makeacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-5002" ><span class="underline">59</span></a> <br /></span> <span class="index-item"><span -class="cmtt-10">makeglos</span>  13 <br /></span> +class="cmtt-10">makeglos</span>  <a +href="glossary2glossaries.html#dx1-17002" >60</a> <br /></span> <span class="index-item"><span -class="cmtt-10">makeglossaries</span>  13 <br /></span> +class="cmtt-10">makeglossaries</span>  <a +href="glossary2glossaries.html#dx1-17003" >61</a>, <a +href="glossary2glossaries.html#dx1-17007" >62</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makeglossaries</span></span></span>  <a +href="glossary2glossaries.html#dx1-5003" ><span class="underline">63</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makeglossary</span></span></span>  <a +href="glossary2glossaries.html#dx1-5001" ><span class="underline">64</span></a> <br /></span> + + + <span class="index-item"><span -class="cmtt-10">makeindex</span>  2, 6, 7, 13 <br /></span> +class="cmtt-10">makeindex</span>  <a +href="glossary2glossaries.html#dx1-2003" >65</a>, <a +href="glossary2glossaries.html#dx1-2006" >66</a>, <a +href="glossary2glossaries.html#dx1-6012" >67</a>, <a +href="glossary2glossaries.html#dx1-17004" >68</a>, <a +href="glossary2glossaries.html#dx1-17008" >69</a>, <a +href="glossary2glossaries.html#dx1-2002" >70</a>, <a +href="glossary2glossaries.html#dx1-11004" >71</a>, <a +href="glossary2glossaries.html#dx1-11006" >72</a>, <a +href="glossary2glossaries.html#dx1-11012" >73</a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">N</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-12001" ><span class="underline">74</span></a>, <a +href="glossary2glossaries.html#dx1-12007" ><span class="underline">75</span></a>, <a +href="glossary2glossaries.html#dx1-12018" ><span class="underline">76</span></a>, <a +href="glossary2glossaries.html#dx1-13003" ><span class="underline">77</span></a>, <a +href="glossary2glossaries.html#dx1-13005" ><span class="underline">78</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newglossary</span></span></span>  <a +href="glossary2glossaries.html#dx1-4002" ><span class="underline">79</span></a>, <a +href="glossary2glossaries.html#dx1-4009" ><span class="underline">80</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newglossaryentry</span></span></span>  <a +href="glossary2glossaries.html#dx1-6005" ><span class="underline">81</span></a>, <a +href="glossary2glossaries.html#dx1-6008" ><span class="underline">82</span></a>, <a +href="glossary2glossaries.html#dx1-6011" ><span class="underline">83</span></a>, <a +href="glossary2glossaries.html#dx1-6016" ><span class="underline">84</span></a>, <a +href="glossary2glossaries.html#dx1-11014" ><span class="underline">85</span></a>, <a +href="glossary2glossaries.html#dx1-11018" ><span class="underline">86</span></a>, <a +href="glossary2glossaries.html#dx1-12002" ><span class="underline">87</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\newglossaryentry </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">description</span>  8 <br /></span> +class="cmss-10">description</span>  <a +href="glossary2glossaries.html#dx1-12004" >88</a>, <a +href="glossary2glossaries.html#dx1-12006" >89</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">name</span>  8 <br /></span> +class="cmss-10">name</span>  <a +href="glossary2glossaries.html#dx1-12003" >90</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newglossarytype</span></span></span>  <a +href="glossary2glossaries.html#dx1-4001" ><span class="underline">91</span></a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">O</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\oldacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-12017" ><span class="underline">92</span></a>, <a +href="glossary2glossaries.html#dx1-12019" ><span class="underline">93</span></a>, <a +href="glossary2glossaries.html#dx1-13004" ><span class="underline">94</span></a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">P</span> <span class="index-item">package options:<br /></span> <span class="index-subitem">    <span -class="cmss-10">description</span>  <span class="underline">8</span> <br /></span> +class="cmss-10">description</span>  <a +href="glossary2glossaries.html#dx1-12005" ><span class="underline">95</span></a>, <a +href="glossary2glossaries.html#dx1-12008" ><span class="underline">96</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\printglossaries</span></span></span>  <a +href="glossary2glossaries.html#dx1-16002" ><span class="underline">97</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\printglossary</span></span></span>  <a +href="glossary2glossaries.html#dx1-4004" ><span class="underline">98</span></a>, <a +href="glossary2glossaries.html#dx1-4006" ><span class="underline">99</span></a>, <a +href="glossary2glossaries.html#dx1-4011" ><span class="underline">100</span></a>, <a +href="glossary2glossaries.html#dx1-16001" ><span class="underline">101</span></a>, <a +href="glossary2glossaries.html#dx1-16003" ><span class="underline">102</span></a>, <a +href="glossary2glossaries.html#dx1-16004" ><span class="underline">103</span></a>, <a +href="glossary2glossaries.html#dx1-16006" ><span class="underline">104</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\printglossary </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">style</span>  4 <br /></span> +class="cmss-10">style</span>  <a +href="glossary2glossaries.html#dx1-4005" >105</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">toctitle</span>  4, 12 <br /></span> +class="cmss-10">toctitle</span>  <a +href="glossary2glossaries.html#dx1-4010" >106</a>, <a +href="glossary2glossaries.html#dx1-16005" >107</a>, <a +href="glossary2glossaries.html#dx1-16007" >108</a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">R</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\resetacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-15001" ><span class="underline">109</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\resetallacronyms</span></span></span>  <a +href="glossary2glossaries.html#dx1-15007" ><span class="underline">110</span></a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">S</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\shortnotationname</span></span></span>  <a +href="glossary2glossaries.html#dx1-16008" ><span class="underline">111</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\storeglosentry</span></span></span>  <a +href="glossary2glossaries.html#dx1-6004" ><span class="underline">112</span></a>, <a +href="glossary2glossaries.html#dx1-6007" ><span class="underline">113</span></a>, <a +href="glossary2glossaries.html#dx1-6009" ><span class="underline">114</span></a>, <a +href="glossary2glossaries.html#dx1-6010" ><span class="underline">115</span></a>, <a +href="glossary2glossaries.html#dx1-6015" ><span class="underline">116</span></a>, <a +href="glossary2glossaries.html#dx1-7001" ><span class="underline">117</span></a>, <a +href="glossary2glossaries.html#dx1-11009" ><span class="underline">118</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\storeglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">format</span>  6 <br /></span> +class="cmss-10">format</span>  <a +href="glossary2glossaries.html#dx1-6013" >119</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">number</span>  6 <br /></span> +class="cmss-10">number</span>  <a +href="glossary2glossaries.html#dx1-6014" >120</a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">U</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\unsetacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-15004" ><span class="underline">121</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\unsetallacronyms</span></span></span>  <a +href="glossary2glossaries.html#dx1-15012" ><span class="underline">122</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\useacronym</span></span></span>  <a +href="glossary2glossaries.html#dx1-12012" ><span class="underline">123</span></a>, <a +href="glossary2glossaries.html#dx1-12013" ><span class="underline">124</span></a>, <a +href="glossary2glossaries.html#dx1-12015" ><span class="underline">125</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\useGlosentry</span></span></span>  <a +href="glossary2glossaries.html#dx1-7003" ><span class="underline">126</span></a>, <a +href="glossary2glossaries.html#dx1-9001" ><span class="underline">127</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\useglosentry</span></span></span>  <a +href="glossary2glossaries.html#dx1-7002" ><span class="underline">128</span></a>, <a +href="glossary2glossaries.html#dx1-8001" ><span class="underline">129</span></a> <br /></span> + + + <span class="index-item"><span class="cmtt-10">\useglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">format</span>  6 <br /></span> +class="cmss-10">format</span>  <a +href="glossary2glossaries.html#dx1-8003" >130</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">number</span>  6 <br /></span> +class="cmss-10">number</span>  <a +href="glossary2glossaries.html#dx1-8004" >131</a> <br /></span> </p><p class="theindex"> <span class="cmbx-10">X</span> <span class="index-item"><span -class="cmtt-10">xindy</span>  2, 7, 13 <br /></span> +class="cmtt-10">xindy</span>  <a +href="glossary2glossaries.html#dx1-2004" >132</a>, <a +href="glossary2glossaries.html#dx1-2005" >133</a>, <a +href="glossary2glossaries.html#dx1-17005" >134</a>, <a +href="glossary2glossaries.html#dx1-17006" >135</a>, <a +href="glossary2glossaries.html#dx1-17009" >136</a>, <a +href="glossary2glossaries.html#dx1-11005" >137</a>, <a +href="glossary2glossaries.html#dx1-11007" >138</a> <br /></span> </p></div> - - - - <div class="footnotes"><!--l. 68--><p class="noindent" ><span class="footnote-mark"><a + <div class="footnotes"><!--l. 71--><p class="noindent" ><span class="footnote-mark"><a href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span class="cmr-8">as from v1.17. Previous versions were designed to be used with </span><span class="cmtt-8">makeindex</span><a id="dx1-2002"></a> <span class="cmr-8">only</span></p> -<!--l. 83--><p class="noindent" ><span class="footnote-mark"><a +<!--l. 86--><p class="noindent" ><span class="footnote-mark"><a href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span -class="cmr-8">as from v1.17</span></p><!--l. 220--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">as from v1.17</span></p><!--l. 223--><p class="indent" > <span class="footnote-mark"><a href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span class="cmr-8">mainly because having a key value list in </span><span class="cmtt-8">\glossary</span><a @@ -1958,7 +2199,7 @@ class="cmtt-8">\glossary</span><a class="cmr-8">caused problems, but it also helps</span> <span class="cmr-8">consistency.</span></p> -<!--l. 334--><p class="indent" > <span class="footnote-mark"><a +<!--l. 337--><p class="indent" > <span class="footnote-mark"><a href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span class="cmr-8">This is because </span><span class="cmtt-8">\glossary</span><a @@ -1990,7 +2231,7 @@ class="cmr-8">or</span> class="cmtt-8">xindy</span><a id="dx1-11007"></a><span class="cmr-8">.</span></p> -<!--l. 343--><p class="indent" > <span class="footnote-mark"><a +<!--l. 346--><p class="indent" > <span class="footnote-mark"><a href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span class="cmr-8">From the user’s point of view, using </span><span class="cmtt-8">\glossary</span><a diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf Binary files differindex e2c8865973a..5fe519fdaa7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index 384ae3995d6..82848a3e53f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -1,12 +1,15 @@ \documentclass{nlctdoc} -\usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot}, +\usepackage{xr} +\usepackage[colorlinks, + bookmarks, + hyperindex=false, + pdfauthor={Nicola L.C. Talbot}, pdftitle={Upgrading from the glossary package to the glossaries package}]{hyperref} -\usepackage{xr-hyper} \ifpdf -\externaldocument{glossaries} +\externaldocument{glossaries-user} \fi \IndexPrologue{\section*{Index}} @@ -15,7 +18,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2010-05-28} +\date{2011-04-02} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines @@ -447,10 +450,7 @@ You can then continue to use \cs{SVM}\@. However, remember that alphabetical characters. You will therefore need to force a space after \cs{}\meta{acr-name}, unless you also load the \styfmt{xspace} package. (See -\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} -%\latexhtml{section~\ref*{sec:acronyms}}{the -%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} -%section} +\xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} of the \styfmt{glossaries} documentation for further details.) Note that \ics{oldacronym} uses its first argument to define the acronym's label (as used by commands like \ics{gls}), so @@ -491,10 +491,7 @@ form) as well as upper case variations. If you use the \ics{acrlong}. See -\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} -%\latexhtml{section~\ref*{sec:acronyms}}{the -%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} -%section} +\xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} of the \styfmt{glossaries} manual for further details of how to use these commands. @@ -637,11 +634,8 @@ non-English documents. For further information on using \app{makeglossaries}, \app{makeindex} or \app{xindy} to create your glossaries, see -\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the +\xrsectionref{sec:makeglossaries}{glossaries-user}{Generating the Associated Glossary Files} -%\latexhtml{section~\ref*{sec:makeglossaries}}{the -%\htmladdnormallink{Generating the Associated Glossary -%Files}{glossaries-manual.html#sec:makeglossaries} section} of the \styfmt{glossaries} documentation. \section{Troubleshooting} diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html new file mode 100644 index 00000000000..9e087f7bed5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html @@ -0,0 +1,400 @@ +<a + id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<!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>mfirstuc.sty v1.05: uppercasing first letter</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<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 --> +<meta name="src" content="mfirstuc-manual.tex" /> +<meta name="date" content="2011-04-04 11:04:00" /> + +<style type="text/css"> +<!-- + +/* start css.sty */ +.ecrm-1728{font-size:170%;} +.ecrm-1200{font-size:120%;} +.ectt-1200{font-size:120%; font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ectt-0900{font-size:90%; font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecrm-0900{font-size:90%;} +.ecrm-0800{font-size:80%;} +.ecss-0800{font-size:80%; font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;} +div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;} +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.bar-css {text-decoration:overline;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +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%;} +table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } +.alltt P { margin-bottom : 0em; margin-top : 0em; } +.alltt { margin-bottom : 1em; margin-top : 1em; } +div.important { background-color:red; } +/* end css.sty */ + + +--> +</style> +</head><body +> + <div class="maketitle"> + + + + + + + +<h2 class="titleHead">mfirstuc.sty v1.05: uppercasing first letter</h2> + <div class="author" ><span +class="ecrm-1200">Nicola L.C. Talbot</span> +<br /> <span +class="ecrm-1200">School of Computing Sciences</span> +<br /> <span +class="ecrm-1200">University of East Anglia</span> +<br /> <span +class="ecrm-1200">Norwich. Norfolk</span> +<br /> <span +class="ecrm-1200">NR4 7TJ. United Kingdom.</span> +<br /><a +href="http://theoval.cmp.uea.ac.uk/~nlct/" class="url" ><span +class="ectt-1200">http://theoval.cmp.uea.ac.uk/~nlct/</span></a></div><br /> +<div class="date" ><span +class="ecrm-1200">2011-04-02</span></div> + </div> +<!--l. 27--><p class="indent" > The <span +class="ecss-1000">glossaries </span>bundle is supplied with the package <span +class="ecss-1000">mfirstuc</span><a + id="dx1-2"></a> which provides the +command: +</p><!--l. 29--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\makefirstuc</span><span +class="ectt-0900"> </span></span><a + id="dx1-3"></a> <span +class="ectt-1000">\makefirstuc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 31--><p class="noindent" > +This makes the first object of <span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩ </span>uppercase unless <span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩ </span>starts with a control +sequence followed by a non-empty group, in which case the first object in the group is +converted to uppercase. Examples: </p> + <ul class="itemize1"> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{abc}</span></span></span> produces Abc. + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\emph{abc}}</span></span></span> produces <span +class="ecti-1000">Abc </span>(<span +class="ectt-1000">\MakeUppercase</span><a + id="dx1-4"></a> has been applied to + the letter “a” rather than <span +class="ectt-1000">\emph</span>). Note however that + + + + <div class="verbatim" id="verbatim-1"> + \makefirstuc{{\em abc}} +</div> + <!--l. 44--><p class="nopar" > produces <span +class="ecti-1000">ABC </span>(first object is <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">{\em</span><span +class="ectt-1000"> abc}</span></span></span> so equivalent to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\MakeUppercase{\em</span><span +class="ectt-1000"> abc}</span></span></span>), + and + + + +</p> + <div class="verbatim" id="verbatim-2"> + {\makefirstuc{\em abc}} +</div> + <!--l. 49--><p class="nopar" > produces abc (<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\em</span></span></span> doesn’t have an argument therefore first object is <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\em</span></span></span> so + equivalent to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">{\MakeUppercase{\em}abc}</span></span></span>). + </p></li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{\’a}bc}</span></span></span> produces bc. + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\ae</span><span +class="ectt-1000"> bc}</span></span></span> produces bc. + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{\ae}bc}</span></span></span> produces bc. + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{</span><span +class="ectt-1000">}bc}</span></span></span> produces bc. + </li></ul> +<!--l. 63--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be +placed in a group (even if you are using the <span +class="ecss-1000">inputenc</span><a + id="dx1-5"></a> package) due to expansion +issues. +</p><!--l. 67--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span +class="ecss-1000">mfirstuc</span>, a bug fix resulted in a change in output if the first +object is a control sequence followed by an empty group. Prior to version 1.02, +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\ae{}bc}</span></span></span> produced Bc. However as from version 1.02, it now produces +bc. </div> +</p><!--l. 73--><p class="noindent" > +</p><!--l. 75--><p class="indent" > Note also that + + + +</p> + <div class="verbatim" id="verbatim-3"> +\newcommand{\abc}{abc} + <br />\makefirstuc{\abc} +</div> +<!--l. 79--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span +class="ectt-1000">\makefirstuc </span>is +<span +class="ectt-1000">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\MakeUppercase{\abc}</span></span></span>. Whereas: + + + +</p> + <div class="verbatim" id="verbatim-4"> +\newcommand{\abc}{abc} + <br />\expandafter\makefirstuc\expandafter{\abc} +</div> +<!--l. 86--><p class="nopar" > produces: Abc. There is a short cut command which will do this: +</p><!--l. 88--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\xmakefirstuc</span><span +class="ectt-0900"> </span></span><a + id="dx1-6"></a> <span +class="ectt-1000">\xmakefirstuc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 90--><p class="noindent" > +This is equivalent to <span +class="ectt-1000">\expandafter\makefirstuc\expandafter{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. +So + + + +</p> + <div class="verbatim" id="verbatim-5"> +\newcommand{\abc}{abc} + <br />\xmakefirstuc{\abc} +</div> +<!--l. 95--><p class="nopar" > produces: Abc. +</p><!--l. 100--><p class="indent" > <div class="important" title="Important Note"> <span +class="ectt-1000">\xmakefirstuc </span>only performs one level expansion on the first object in its +argument. It does not fully expand the entire argument. </div> +</p><!--l. 104--><p class="noindent" > +</p><!--l. 106--><p class="indent" > If you want to use an alternative command to convert to uppercase, for example +<span +class="ectt-1000">\MakeTextUppercase</span>,<span class="footnote-mark"><a +href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a + id="x1-7f1"></a> +you can redefine <span +class="ectt-1000">\glsmakefirstuc</span>. For example: + + + +</p> + <div class="verbatim" id="verbatim-6"> +\renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase #1} +</div> +<!--l. 112--><p class="nopar" > +</p> + <div class="footnotes"><!--l. 108--><p class="indent" > <span class="footnote-mark"><a +href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span +class="ecrm-0800">defined in the </span><span +class="ecss-0800">textcase </span><span +class="ecrm-0800">package</span></p> </div> + +</body></html> + + + + diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex new file mode 100644 index 00000000000..d01adf94f70 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex @@ -0,0 +1,114 @@ +\documentclass{nlctdoc} + +\usepackage{alltt} +\usepackage{mfirstuc} +\usepackage{pifont} +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage[colorlinks, + bookmarks, + hyperindex=false, + pdfauthor={Nicola L.C. Talbot}, + pdftitle={mfirstuc.sty: uppercasing first letter}, + pdfkeywords={LaTeX,package,uppercase}]{hyperref} + +\begin{document} + \title{mfirstuc.sty v1.05: uppercasing first letter} + \author{Nicola L.C. Talbot\\[10pt] +School of Computing Sciences\\ +University of East Anglia\\ +Norwich. Norfolk\\ +NR4 7TJ. United Kingdom.\\ +\url{http://theoval.cmp.uea.ac.uk/~nlct/}} + + \date{2011-04-02} + \maketitle + +The \styfmt{glossaries} bundle is supplied with the package +\sty{mfirstuc} which provides the command: +\begin{definition}[\DescribeMacro{\makefirstuc}] +\cs{makefirstuc}\marg{stuff} +\end{definition} +This makes the first object of +\meta{stuff} uppercase unless \meta{stuff} starts with a control +sequence followed by a non-empty group, in which case the first +object in the group is converted to uppercase. Examples: +\begin{itemize} +\item |\makefirstuc{abc}| produces \makefirstuc{abc}. + +\item |\makefirstuc{\emph{abc}}| produces \makefirstuc{\emph{abc}} +(\ics{MakeUppercase} has been applied to the letter \qt{a} rather +than \cs{emph}). Note however that +\begin{verbatim} +\makefirstuc{{\em abc}} +\end{verbatim} +produces \makefirstuc{{\em abc}} (first object is |{\em abc}| so +equivalent to |\MakeUppercase{\em abc}|), and +\begin{verbatim} +{\makefirstuc{\em abc}} +\end{verbatim} +produces {\makefirstuc{\em abc}} (|\em| doesn't have an argument +therefore first object is |\em| so equivalent to +|{\MakeUppercase{\em}abc}|). + +\item |\makefirstuc{{\'a}bc}| produces \makefirstuc{{\'a}bc}. + +\item |\makefirstuc{\ae bc}| produces \makefirstuc{\ae bc}. + +\item |\makefirstuc{{\ae}bc}| produces \makefirstuc{{\ae}bc}. + +\item |\makefirstuc{{ä}bc}| produces \makefirstuc{{ä}bc}. + +\end{itemize} +Note that non-Latin or accented characters appearing at the +start of the text must be placed in a group (even if you are +using the \sty{inputenc} package) due to expansion issues. + +\begin{important} +In version 1.02 of \styfmt{mfirstuc}, a bug fix resulted in a change +in output if the first object is a control sequence followed by +an empty group. Prior to version 1.02, |\makefirstuc{\ae{}bc}| +produced \ae Bc. However as from version 1.02, it now produces +\AE bc. +\end{important} + +Note also that +\begin{verbatim} +\newcommand{\abc}{abc} +\makefirstuc{\abc} +\end{verbatim} +produces: ABC. This is because the first object in the argument of +\cs{makefirstuc} is \cs{abc}, so it does |\MakeUppercase{\abc}|. +Whereas: +\begin{verbatim} +\newcommand{\abc}{abc} +\expandafter\makefirstuc\expandafter{\abc} +\end{verbatim} +produces: Abc. There is a short cut command which will do this: +\begin{definition}[\DescribeMacro{\xmakefirstuc}] +\cs{xmakefirstuc}\marg{stuff} +\end{definition} +This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuff}. So +\begin{verbatim} +\newcommand{\abc}{abc} +\xmakefirstuc{\abc} +\end{verbatim} +produces: +\newcommand{\abc}{abc}% +\xmakefirstuc{\abc}. + +\begin{important} +\cs{xmakefirstuc} only performs one level expansion on the first +object in its argument. It does not fully expand the entire +argument. +\end{important} + +If you want to use an alternative command to convert to uppercase, +for example \cs{MakeTextUppercase},\footnote{defined in the +\styfmt{textcase} package} you can redefine \cs{glsmakefirstuc}. +For example: +\begin{verbatim} +\renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase #1} +\end{verbatim} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/database2.tex b/Master/texmf-dist/doc/latex/glossaries/samples/database2.tex index 1fb3042e36b..55bc08a1c47 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/database2.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/database2.tex @@ -14,7 +14,7 @@ description={the ``at'' symbol}} \newglossaryentry{excl}{name={!}, description={the exclamation mark symbol}} -\newglossaryentry{bar}{name={$|$}, +\newglossaryentry{bar}{name={\ensuremath{|}}, description={the vertical bar symbol}} \newglossaryentry{hash}{name={\#}, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf Binary files differnew file mode 100644 index 00000000000..cf3b7b30f64 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index db5a04d7f77..d2e575aaec8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -1,3 +1,5 @@ + % This file is public domain. + % % This is a minimal file for testing and debugging % the glossaries package. Change the class file as % desired, and add the relevant package options to diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf Binary files differnew file mode 100644 index 00000000000..85a7fb542f6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex new file mode 100644 index 00000000000..1dbf3154bfa --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex @@ -0,0 +1,31 @@ +\documentclass{article} + +\usepackage[colorlinks]{hyperref} +\usepackage[sanitize={description=false}]{glossaries} + +\makeglossaries + +\renewcommand{\glsseeitemformat}[1]{\textsc{\glsentryname{#1}}} + +\newglossaryentry{pear}{name=pear, +description={an oddly shaped fruit}} + +\newglossaryentry{apple}{name=apple, +description={firm, round fruit}, +see=[see also]{pear}} + +\newglossaryentry{banana}{name=banana, +description={a yellow fruit with an even odder shape than +a \protect\gls{pear}}} + +\newglossaryentry{fruit}{name=fruit, +description={sweet, fleshy product of plant containing seed}} + +\glssee{fruit}{pear,apple,banana} + +\begin{document} +\gls{pear}, \gls{apple} and \gls{banana}. + +\printglossaries + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf Binary files differnew file mode 100644 index 00000000000..57008b6f803 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex index bd63d817500..a0de228a23f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{report} \usepackage[colorlinks]{hyperref} @@ -38,14 +39,14 @@ % ##3 corresponds to the 'symbol' key % ##4 is the inserted text given by the final optional argument to % commands like \gls - % The short form can be obtained via \glsentryuseri{\glslabel} + % The short form can be obtained via \glsentryshort{\glslabel} % The plural short form can be obtained via - % \glsentryuserii{\glslabel} - % The long form can be obtained via \glsentryuseriii{\glslabel} + % \glsentryshortplural{\glslabel} + % The long form can be obtained via \glsentrylong{\glslabel} % The plural long form can be obtained via - % \glsentryuseriv{\glslabel} + % \glsentrylongplural{\glslabel} \defglsdisplayfirst[#1]{##1##4\protect\footnote{% - \glsentryuseriii{\glslabel}: ##2}}% + \glsentrylong{\glslabel}: ##2}}% % ##1 corresponds to the 'text' key % the rest as above \defglsdisplay[#1]{##1##4}% diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf Binary files differnew file mode 100644 index 00000000000..408f4315c72 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex new file mode 100644 index 00000000000..0da681150ed --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex @@ -0,0 +1,29 @@ + % This file is public domain +\documentclass{article} + +\usepackage[acronym]{glossaries} + + % \newdualentry[main options]{label}{short}{long}{description} + +\newcommand*{\newdualentry}[5][]{% + \newglossaryentry{main-#2}{name={#4},% + text={#3\protect\glsadd{#2}},% + description={#5},% + #1 + }% + \newacronym{#2}{#3\protect\glsadd{main-#2}}{#4} +} + +\newdualentry{svm}% label + {SVM}% abbreviation + {support vector machine}% long form + {Statistical pattern recognition technique}% description + +\makeglossaries + +\begin{document} + +\gls{svm}. + +\printglossaries +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf Binary files differnew file mode 100644 index 00000000000..82cc6a96a6a --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex index bfea39f9672..86b299ab7a4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex @@ -1,27 +1,28 @@ + % This file is public domain \documentclass[a4paper]{report} \usepackage[plainpages=false,colorlinks]{hyperref} -\usepackage[toc,style=treenoname,order=word,acronym]{glossaries} +\usepackage[toc,style=treenoname,order=word,subentrycounter]{glossaries} \makeglossaries +\newglossaryentry{Perl}{name=\texttt{Perl}, +sort=Perl, % need a sort key because name contains a command +description=A scripting language} + \newglossaryentry{glossary}{name=glossary, description={\nopostdesc}, plural={glossaries}} -\newglossaryentry{glossarylist}{ -description={1) list of technical words}, -sort={1}, -parent={glossary}} - \newglossaryentry{glossarycol}{ -description={2) collection of glosses}, +description={collection of glosses}, sort={2}, parent={glossary}} -\newglossaryentry{Perl}{name=\texttt{Perl}, -sort=Perl, % need a sort key because name contains a command -description=A scripting language} +\newglossaryentry{glossarylist}{ +description={list of technical words}, +sort={1}, +parent={glossary}} \newglossaryentry{pagelist}{name=page list, % description value has to be enclosed in braces @@ -54,12 +55,12 @@ female of any bovine animal}} \newglossaryentry{bravo}{name={bravo}, description={\nopostdesc}} -\newglossaryentry{bravo1}{description={1) cry of approval (pl.\ bravos)}, +\newglossaryentry{bravo1}{description={cry of approval (pl.\ bravos)}, sort={1}, plural={bravos}, parent=bravo} -\newglossaryentry{bravo2}{description={2) hired ruffian or killer (pl.\ bravoes)}, +\newglossaryentry{bravo2}{description={hired ruffian or killer (pl.\ bravoes)}, sort={2}, plural={bravoes}, parent=bravo} @@ -83,11 +84,11 @@ description={large seal}} \chapter{Introduction} \pagenumbering{arabic} -A \gls{glossarylist} is a very useful addition to any -technical document, although a \gls{glossarycol} can -also simply be a collection of glosses, which is -another thing entirely. Some documents have -multiple \glspl{glossarylist}. +A \gls{glossarylist} (definition~\glsrefentry{glossarylist}) is a +very useful addition to any technical document, although a +\gls{glossarycol} (definition~\glsrefentry{glossarycol}) can also +simply be a collection of glosses, which is another thing entirely. +Some documents have multiple \glspl{glossarylist}. Once you have run your document through \LaTeX, you will then need to run the \texttt{.glo} file through @@ -115,9 +116,10 @@ explicitly specify the alternative form using \verb|\glslink|. \Glspl{seal} and \glspl{sealion} have regular plural forms. \Gls{bravo} is a homograph, but the plural forms are spelt -differently. The plural of \gls{bravo1}, a cry of approval, -is \glspl{bravo1}, whereas the plural of \gls{bravo2}, a hired -ruffian or killer, is \glspl{bravo2}. +differently. The plural of \gls{bravo1}, a cry of approval +(definition~\glsrefentry{bravo1}), is \glspl{bravo1}, whereas the +plural of \gls{bravo2}, a hired ruffian or killer +(definition~\glsrefentry{bravo2}), is \glspl{bravo2}. \Glspl{par} can cause a problem in commands, so care is needed when having a paragraph break in a \gls{glossarylist} entry. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf Binary files differnew file mode 100644 index 00000000000..5f6a43ba02c --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex index 8467841b6e3..846a5056571 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass[a4paper]{article} \usepackage[style=long4colheaderborder]{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf Binary files differnew file mode 100644 index 00000000000..c7a5f27ad9b --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex index 3addc9d8a47..9dcd5f69e84 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex @@ -1,7 +1,11 @@ + % This file is public domain \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} -\usepackage[style=long,toc]{glossaries} +\usepackage[style=long,% use 'long' style for the glossary + toc,% add glossary to table of contents + smallcaps% Use small caps for acronyms + ]{glossaries} \makeglossaries @@ -19,29 +23,59 @@ \chapter{Support Vector Machines} \Glspl{svm} are used widely in the area of pattern recognition. +Subsequent use: \gls{svm}. -This is the text produced without a link: \glsentrytext{svm}. -This is the text produced on first use without a link: -\glsentryfirst{svm}. This is the entry's description without -a link: \glsentrydesc{svm}. +Short version: \acrshort{svm}. Long version: \acrlong{svm}. Full +version: \acrfull{svm}. Description: \glsentrydesc{svm}. This is the entry in uppercase: \GLS{svm}. \chapter{Kernel Support Vector Machines} The \gls{ksvm} is \ifglsused{svm}{an}{a} \gls{svm} that uses -the so called ``kernel trick''. Plural: \glspl{ksvm}. +the so called ``kernel trick''. Plural: \glspl{ksvm}. Resetting +acronyms. \glsresetall Possessive: \gls{ksvm}['s]. Make the glossary entry number bold for this -one \gls[format=hyperbf]{svm}. +one \gls[format=hyperbf]{ksvm}. + +\chapter{Short, Long and Full Forms} + +These commands don't affect the first use flag: + +\begin{center} +\begin{tabular}{lll} + & Unstarred & Starred\\ +acrshort & \acrshort{svm} & \acrshort*{svm}\\ +Acrshort & \Acrshort{svm} & \Acrshort*{svm}\\ +ACRshort & \ACRshort{svm} & \ACRshort*{svm}\\ +acrlong & \acrlong{svm} & \acrlong*{svm}\\ +Acrlong & \Acrlong{svm} & \Acrlong*{svm}\\ +ACRlong & \ACRlong{svm} & \ACRlong*{svm}\\ +acrfull & \acrfull{svm} & \acrfull*{svm}\\ +Acrfull & \Acrfull{svm} & \Acrfull*{svm}\\ +ACRfull & \ACRfull{svm} & \ACRfull*{svm}\\ +\\ +& Insert Unstarred & Insert Starred\\ +acrshort & \acrshort{svm}['s] & \acrshort*{svm}['s]\\ +Acrshort & \Acrshort{svm}['s] & \Acrshort*{svm}['s]\\ +ACRshort & \ACRshort{svm}['s] & \ACRshort*{svm}['s]\\ +acrlong & \acrlong{svm}['s] & \acrlong*{svm}['s]\\ +Acrlong & \Acrlong{svm}['s] & \Acrlong*{svm}['s]\\ +ACRlong & \ACRlong{svm}['s] & \ACRlong*{svm}['s]\\ +acrfull & \acrfull{svm}['s] & \acrfull*{svm}['s]\\ +Acrfull & \Acrfull{svm}['s] & \Acrfull*{svm}['s]\\ +ACRfull & \ACRfull{svm}['s] & \ACRfull*{svm}['s] +\end{tabular} +\end{center} \chapter{Another chapter} You don't need to worry about makeindex's special characters: \gls{rna}. -\printglossary[title={Acronyms}] +\printglossary[title={List of Acronyms}] \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf Binary files differnew file mode 100644 index 00000000000..858149b703c --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex index 3ff8cd0ad83..e57550ce872 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex @@ -1,23 +1,33 @@ + % This file is public domain \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} -\usepackage[style=altlist, % use altlist style +\usepackage[acronym,% create 'acronym' glossary type + nomain,% 'main' glossary not needed as using 'acronym' + style=altlist, % use altlist style toc, % add the glossary to the table of contents sanitize={description=false},% want to use description in main document + smallcaps,% description% acronyms have a user-supplied description ]{glossaries} \makeglossaries +\renewcommand*{\glsseeitemformat}[1]{\acronymfont{\glsentrytext{#1}}} + +\renewcommand*{\acrnameformat}[2]{\acronymfont{#1} (#2)} + + +\renewcommand*{\glsnamefont}[1]{\textmd{#1}} + \newacronym[description={Statistical pattern recognition technique~\protect\cite{svm}}, % acronym's description -name={Support vector machine (svm)}% change the default way of displaying the entry name in the list of acronyms ]{svm}{svm}{support vector machine} \newacronym[description={Statistical pattern recognition technique -using the ``kernel trick'' (see also \glshyperlink[SVM]{svm})},% acronym's description -name={Kernel support vector machine (ksvm)}% change the default way of displaying the entry name in the list of acronyms +using the ``kernel trick''},% acronym's description +see={[see also]{svm}}, ]{ksvm}{ksvm}{kernel support vector machine} @@ -30,10 +40,8 @@ The \gls{svm} is used widely in the area of pattern recognition. % plural form with initial letter in uppercase: \Glspl{svm} are \ldots -This is the text produced without a link: \glsentrytext{svm}. -This is the text produced on first use without a link: -\glsentryfirst{svm}. This is the entry's description without -a link: \glsentrydesc{svm}. +Short version: \acrshort{svm}. Long version: \acrlong{svm}. Full +version: \acrfull{svm}. Description: \glsentrydesc{svm}. This is the entry in uppercase: \GLS{svm}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf Binary files differnew file mode 100644 index 00000000000..82e40cd570c --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex index 651e4694551..a19501afad7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{article} \usepackage[colorlinks,plainpages=false]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf Binary files differnew file mode 100644 index 00000000000..9327d851c54 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex index 8802d88d1b9..c1a3aadc015 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex @@ -1,3 +1,6 @@ + % This file is public domain + % + % See also sampleAcrDesc.tex \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf Binary files differnew file mode 100644 index 00000000000..02e0d7db571 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index d7f43bc7952..53b84ddc551 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass[a4paper,12pt]{report} \usepackage{amsmath} @@ -12,7 +13,7 @@ % redefine the way hyperref creates the target for equations % so that the glossary links to equation numbers work -\renewcommand*\theHequation{\thechapter.\arabic{equation}} + \renewcommand*\theHequation{\theHchapter.\arabic{equation}} % Change the glossary headings diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf Binary files differnew file mode 100644 index 00000000000..73eb8983d61 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex index c29175f5416..63af21a2bc9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex @@ -1,3 +1,5 @@ + % This file is public domain + % % To ensure that the page numbers are up-to-date: % % latex sampleEqPg diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf Binary files differnew file mode 100644 index 00000000000..7fe700a622d --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex index 9901c7ab61d..cd682b4e230 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex @@ -1,8 +1,9 @@ + % This file is public domain \documentclass{report} \usepackage[plainpages=false,colorlinks]{hyperref} \usepackage{html} -\usepackage[toc]{glossaries} +\usepackage[toc,savewrites,xindy]{glossaries} % Define a new glossary type called notation \newglossary[nlg]{notation}{not}{ntn}{Notation} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf Binary files differnew file mode 100644 index 00000000000..fb906f8b3da --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex index ccefe8c19e1..e6d5a11cce0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{report} \usepackage[plainpages=false,colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf Binary files differnew file mode 100644 index 00000000000..33d606336b2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex index 0ebf51dbe5a..b22b08fbe5d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{article} \usepackage[acronym,smallcaps]{glossaries-accsupp} @@ -6,7 +7,7 @@ \newglossaryentry{dr}{name=Dr,description={Doctor},access={Doctor}} -\newacronym[\glsshortaccesskey=S V M]{svm}{svm}{support vector machine} +\newacronym[shortaccess=S V M]{svm}{svm}{support vector machine} \newacronym{eg}{e.g.}{for example} @@ -14,9 +15,12 @@ \gls{dr}~Jones. \gls{dr}~Jones. -\Gls{eg}, \gls{eg} +\Gls{eg}, \gls{eg}, \acrshort{eg}, \acrlong{eg}, \acrfull{eg}. -\gls{svm}. \gls{svm}. +\Acrshort{eg}, \ACRshort{eg}. \Acrlong{eg}, \ACRlong{eg}. +\Acrfull{eg}, \ACRfull{eg}. + +\gls{svm}. \gls{svm}, \acrshort{svm}, \acrlong{svm}, \acrfull{svm}. \printglossaries \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf Binary files differnew file mode 100644 index 00000000000..145ebedbf99 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex index bd6219b8519..fd7099e1dbf 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{article} \usepackage[acronym,footnote,acronymlists={main,acronym2}]{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf Binary files differnew file mode 100644 index 00000000000..2906295efc4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex index 529e19baa42..98d667d7ca9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf Binary files differnew file mode 100644 index 00000000000..af383ebc00b --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex index 7f885e678b2..e249fee0214 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex @@ -1,3 +1,4 @@ + % This file is public domain \documentclass{article} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf Binary files differnew file mode 100644 index 00000000000..bd668751104 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.tex new file mode 100644 index 00000000000..de97247c19f --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.tex @@ -0,0 +1,232 @@ + % This file is public domain. + % + % This is a sample document illustrating how to use the + % glossaries package with xindy using the compatibility option. + % To create the document: + % + % latex samplexdy-compatible207 + % makeglossaries samplexdy-compatible207 + % latex samplexdy-compatible207 + % + % If you don't have Perl installed, then use one of the + % following instead of makeglossaries: + % + % If you want to have a separate "Mc" letter group do: + % + % xindy -I xindy -M samplexdy-mc207 -t samplexdy-compatible207.glg -o samplexdy-compatible207.gls samplexdy-compatible207.glo + % + % Otherwise do: + % + % xindy -L english -C utf8 -I xindy -M samplexdy-compatible207 -t samplexdy-compatible207.glg -o samplexdy-compatible207.gls samplexdy-compatible207.glo + % +\documentclass{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{fmtcount} + + % remove redefinition of \thepage below if you want to uncomment + % the following line: + % \usepackage[colorlinks]{hyperref} + +\usepackage[xindy,compatible-2.07,style=altlistgroup]{glossaries} + + % Define a new command to do bold italic (it uses \hyperbf + % rather than \textbf in case I later introduce hyperlinks + % - although I would have to remove the fancy page numbering + % if I wanted to do that): + +\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} + + % Need to add this to the list of attributes in order + % to use it with xindy: + % (This command will have no effect if \noist is used) + +\GlsAddXdyAttribute{hyperbfit} + + % Redefine the page numbers so that they appear as a word: + + \renewcommand*{\thepage}{\Numberstring{page}} + + % Need to add this to the list of location styles. + % \Numberstring{page} gets expanded to + % \protect \Numberstringnum {<n>} (where <n> is the page number) + % so need to define the location in that format: + % (This command will have no effect if \noist is used) + +\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space + \string\Numberstringnum\space\glsopenbrace" + "arabic-numbers" :sep "\glsclosebrace"} + + % To have Mc as a separate group uncomment the following three + % lines: + + \setStyleFile{samplexdy-mc207} % note no extension + \noist + \GlsSetXdyLanguage{} + + % The above three lines specify to use samplexdy-mc.xdy (supplied + % with this file) and don't overwrite it. The language is + % unset using \GlsSetXdyLanguage{} as all the language + % dependent information is contained in samplexdy-mc.xdy + % Note that using \noist means that commands like + % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have + % an effect. + + % Write the style file (if \noist isn't used) + % and activate glossary entries + +\makeglossaries + + % Define glossary entries + % \glshyperlink is used instead of \gls to prevent the glossary + % page numbers also appear in the locations, however I need + % to ensure that the referenced entries are added to the + % glossary via commands that use \glslink, \glsadd or \glssee + +\newglossaryentry{mcadam}{name={McAdam, John Loudon}, +first={John Loudon McAdam},text={McAdam}, +description={Scottish engineer}} + +\newglossaryentry{maclaurin}{name={Maclaurin, Colin}, +first={Colin Maclaurin},text={Maclaurin}, +description={Scottish mathematician best known for the +\gls{maclaurinseries}}} + +\newglossaryentry{maclaurinseries}{name={Maclaurin series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylorstheorem}{name={Taylor's theorem}, +description={Theorem expressing a function $f(x)$ as the sum of +a polynomial and a remainder: +\[f(x) = f(a)+f'(a)(x-a)+f''(a)(x-a^2)/2!+\cdots+R_n\] +If $n\to\infty$ the expansion is a \glshyperlink{taylorseries} +and if $a=0$, the series is called a +\gls{maclaurinseries}}} + +\newglossaryentry{taylorseries}{name={Taylor series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylor}{name={Taylor, Brook}, +first={Brook Taylor},text={Taylor}, +description={English mathematician}} + +\newglossaryentry{mcnemar}{name={McNemar, Quinn}, +first={Quinn McNemar},text={McNemar}, +description={Mathematician who introduced +\gls{mcnemarstest}. This entry has the number list +suppressed},nonumberlist} + +\newglossaryentry{mcnemarstest}{name={McNemar's test}, +description={A nonparametric test introduced by +\gls{mcnemar} in 1947}} + +\newglossaryentry{mach}{name={Mach, Ernst}, +first={Ernst Mach},text={Mach}, + % if using samplexdy-mc.xdy, the following line is needed + % to prevent this entry being put in the "Mc" group +sort={mach, Ernst}, +description={Czech/Austrian physicist and philosopher}} + +\newglossaryentry{machnumber}{name={Mach number}, + % if using samplexdy-mc.xdy, the following line is needed + % to prevent this entry being put in the "Mc" group +sort={mach number}, +description={Ratio of the speed of a body in a fluid to the +speed of sound in that fluid named after \gls{mach}}} + +\newglossaryentry{malthus}{name={Malthus, Thomas Robert}, +first={Thomas Robert Malthus},text={Malthus}, +description={English mathematician, sociologist and classicist}} + +\newglossaryentry{ampereandre}{name={Ampère, André-Marie}, +first={André-Marie Ampère},text={Ampère}, +description={French mathematician and physicist}} + +\newglossaryentry{ampere}{name={ampere}, +description={SI unit of electric current named after +\gls{ampereandre}}} + +\newglossaryentry{archimedes}{name={Archimedes of Syracuse}, +first={Archimedes of Syracuse},text={Archimedes}, +description={Greek mathematician}} + +\newglossaryentry{archimedesprinciple}{name={Archemedes' principle}, +description={Principle that if a body is submerged in a fluid +it experiences upthrust equal to the weight of the displaced +fluid. Named after \gls{archimedes}}} + +\newglossaryentry{galton}{name={Galton, Sir Francis}, +first={Sir Francis Galton},text={Galton}, +description={English anthropologist}} + +\newglossaryentry{gauss}{name={Gauss, Karl Friedrich}, +first={Karl Friedrich Gauss},text={Gauss}, +description={German mathematician}} + +\newglossaryentry{gaussianint}{name={Gaussian integer}, +description={Complex number where both real and imaginary +parts are integers}} + +\newglossaryentry{peano}{name={Peano, Giuseppe}, +first={Giuseppe Peano},text={Peano}, +description={Italian mathematician}} + +\newglossaryentry{peanoscurve}{name={Peano's curve}, +description={A space-filling curve discovered by +\gls{peano}}} + +\newglossaryentry{pearson}{name={Pearson, Karl}, +first={Karl Pearson},text={Pearson}, +description={English mathematician}} + +\newglossaryentry{pearspmcc}{name={Pearson's product moment +correlation coefficient},description={Product moment correlation +coefficient named after \gls{pearson}}} + +\begin{document} +\title{Sample Document Using the Glossaries Package With Xindy} +\author{Nicola Talbot} +\maketitle + +\section{\glsentryfirst{gauss}} + +This is a section on \gls[format=(]{gauss}. This section spans +several pages. + +\newpage + +This page talks about \glspl[format=hyperbfit]{gaussianint}. Since +it's the principle definition, the user-defined hyperbfit format is +used. + +\newpage + +The section on \gls[format=)]{gauss} ends here. + +\section{Series Expansions} + +This section is about series expansions. It mentions +\gls{maclaurin} and \gls{taylor}. It also discusses +\gls{taylorstheorem} which is related to the \gls{taylorseries}. +The \gls{maclaurinseries} is a special case of the +\gls{taylorseries}. + +\section{\glsentryname{archimedesprinciple}} + +This section discusses \gls{archimedesprinciple} which was +introduced by \gls{archimedes}. + +\section{Another section} + +This section covers \gls{mach} who introduced the \gls{machnumber}. +It also mentions \gls{ampereandre} after whom the +SI unit \gls{ampere} is named. It then discusses \gls{galton} +and \gls{malthus}. Finally it mentions \gls{mcadam}. + +\newpage +This page discusses \gls{mcnemar} who introduced +\gls{mcnemarstest} and \gls{peano} who discovered \gls{peanoscurve}. + +\printglossaries +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy index 7c8d2b9e484..22f392f9aa9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy @@ -414,53 +414,286 @@ ; list of allowed attributes (number formats) (define-attributes (("default" + "hyperbfit" + "pagehyperbfit" "glsnumberformat" + "pageglsnumberformat" "textrm" + "pagetextrm" "textsf" + "pagetextsf" "texttt" + "pagetexttt" "textbf" + "pagetextbf" "textmd" + "pagetextmd" "textit" + "pagetextit" "textup" + "pagetextup" "textsl" + "pagetextsl" "textsc" + "pagetextsc" "emph" + "pageemph" "glshypernumber" + "pageglshypernumber" "hyperrm" + "pagehyperrm" "hypersf" + "pagehypersf" "hypertt" + "pagehypertt" "hyperbf" + "pagehyperbf" "hypermd" + "pagehypermd" "hyperit" + "pagehyperit" "hyperup" + "pagehyperup" "hypersl" + "pagehypersl" "hypersc" + "pagehypersc" "hyperemph" - "hyperbfit"))) + "pagehyperemph"))) ; user defined alphabets ; location class definitions (define-location-class "roman-page-numbers" - ("roman-numbers-lowercase")) + ( :sep "{}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-roman-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-roman-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-roman-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-roman-page-numbers" + ( :sep "{" "alpha" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-roman-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-roman-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-roman-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "roman-numbers-lowercase" :sep "}" ) + :min-range-length 2 +) (define-location-class "Roman-page-numbers" - ("roman-numbers-uppercase")) + ( :sep "{}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-Roman-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-Roman-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-Roman-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-Roman-page-numbers" + ( :sep "{" "alpha" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-Roman-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-Roman-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-Roman-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "roman-numbers-uppercase" :sep "}" ) + :min-range-length 2 +) (define-location-class "arabic-page-numbers" - ("arabic-numbers")) + ( :sep "{}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-arabic-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-arabic-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-arabic-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-arabic-page-numbers" + ( :sep "{" "alpha" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-arabic-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-arabic-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-arabic-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "arabic-numbers" :sep "}" ) + :min-range-length 2 +) (define-location-class "alpha-page-numbers" - ("alpha")) + ( :sep "{}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-alpha-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-alpha-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-alpha-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-alpha-page-numbers" + ( :sep "{" "alpha" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-alpha-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-alpha-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-alpha-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "alpha" :sep "}" ) + :min-range-length 2 +) (define-location-class "Alpha-page-numbers" - ("ALPHA")) + ( :sep "{}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-Alpha-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-Alpha-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-Alpha-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-Alpha-page-numbers" + ( :sep "{" "alpha" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-Alpha-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-Alpha-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-Alpha-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "ALPHA" :sep "}" ) + :min-range-length 2 +) (define-location-class "Appendix-page-numbers" - ("ALPHA" :sep "." "arabic-numbers")) + ( :sep "{}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-Appendix-page-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-Appendix-page-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-Appendix-page-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-Appendix-page-numbers" + ( :sep "{" "alpha" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-Appendix-page-numbers" + ( :sep "{" "ALPHA" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-Appendix-page-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-Appendix-page-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "ALPHA" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) (define-location-class "arabic-section-numbers" - ("arabic-numbers" :sep "." "arabic-numbers")) + ( :sep "{}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "roman-page-numbers-arabic-section-numbers" + ( :sep "{" "roman-numbers-lowercase" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Roman-page-numbers-arabic-section-numbers" + ( :sep "{" "roman-numbers-uppercase" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-page-numbers-arabic-section-numbers" + ( :sep "{" "arabic-numbers" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "alpha-page-numbers-arabic-section-numbers" + ( :sep "{" "alpha" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Alpha-page-numbers-arabic-section-numbers" + ( :sep "{" "ALPHA" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "Appendix-page-numbers-arabic-section-numbers" + ( :sep "{" "ALPHA" :sep "." "arabic-numbers" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) +(define-location-class "arabic-section-numbers-arabic-section-numbers" + ( :sep "{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}{" "arabic-numbers" :sep "." "arabic-numbers" :sep "}" ) + :min-range-length 2 +) ; user defined location classes (define-location-class "Numberstring" - (:sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}")) + (:sep "{}{" :sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}" :sep "}")) ; define cross-reference class @@ -482,11 +715,35 @@ ; define the glossary markup (markup-index - :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble~n\begin{theglossary}\glossaryheader~n" - :close "~n\end{theglossary}~n\glossarypostamble~n" + :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble +\providecommand*\glsXpageXhyperbfit[2]{\setentrycounter[#1]{page}\hyperbfit{#2}} +\providecommand*\glsXpageXglsnumberformat[2]{\setentrycounter[#1]{page}\glsnumberformat{#2}} +\providecommand*\glsXpageXtextrm[2]{\setentrycounter[#1]{page}\textrm{#2}} +\providecommand*\glsXpageXtextsf[2]{\setentrycounter[#1]{page}\textsf{#2}} +\providecommand*\glsXpageXtexttt[2]{\setentrycounter[#1]{page}\texttt{#2}} +\providecommand*\glsXpageXtextbf[2]{\setentrycounter[#1]{page}\textbf{#2}} +\providecommand*\glsXpageXtextmd[2]{\setentrycounter[#1]{page}\textmd{#2}} +\providecommand*\glsXpageXtextit[2]{\setentrycounter[#1]{page}\textit{#2}} +\providecommand*\glsXpageXtextup[2]{\setentrycounter[#1]{page}\textup{#2}} +\providecommand*\glsXpageXtextsl[2]{\setentrycounter[#1]{page}\textsl{#2}} +\providecommand*\glsXpageXtextsc[2]{\setentrycounter[#1]{page}\textsc{#2}} +\providecommand*\glsXpageXemph[2]{\setentrycounter[#1]{page}\emph{#2}} +\providecommand*\glsXpageXglshypernumber[2]{\setentrycounter[#1]{page}\glshypernumber{#2}} +\providecommand*\glsXpageXhyperrm[2]{\setentrycounter[#1]{page}\hyperrm{#2}} +\providecommand*\glsXpageXhypersf[2]{\setentrycounter[#1]{page}\hypersf{#2}} +\providecommand*\glsXpageXhypertt[2]{\setentrycounter[#1]{page}\hypertt{#2}} +\providecommand*\glsXpageXhyperbf[2]{\setentrycounter[#1]{page}\hyperbf{#2}} +\providecommand*\glsXpageXhypermd[2]{\setentrycounter[#1]{page}\hypermd{#2}} +\providecommand*\glsXpageXhyperit[2]{\setentrycounter[#1]{page}\hyperit{#2}} +\providecommand*\glsXpageXhyperup[2]{\setentrycounter[#1]{page}\hyperup{#2}} +\providecommand*\glsXpageXhypersl[2]{\setentrycounter[#1]{page}\hypersl{#2}} +\providecommand*\glsXpageXhypersc[2]{\setentrycounter[#1]{page}\hypersc{#2}} +\providecommand*\glsXpageXhyperemph[2]{\setentrycounter[#1]{page}\hyperemph{#2}} +\begin{theglossary}\glossaryheader~n" + :close "%~n\end{theglossary}\glossarypostamble~n" :tree) (markup-letter-group-list :sep "\glsgroupskip~n") -(markup-indexentry :open "~n" :depth 0) +(markup-indexentry :open "\relax\glsresetentrylist~n") (markup-locclass-list :open "{\glossaryentrynumbers{\relax " :sep ", " :close "}}") (markup-locref-list :sep "\delimN ") @@ -494,75 +751,75 @@ ; define format to use for locations -(markup-locref :open "~n\setentrycounter{page}\glsnumberformat{" - :close "}" - :attr "glsnumberformat") -(markup-locref :open "~n\setentrycounter{page}\textrm{" - :close "}" - :attr "textrm") -(markup-locref :open "~n\setentrycounter{page}\textsf{" - :close "}" - :attr "textsf") -(markup-locref :open "~n\setentrycounter{page}\texttt{" - :close "}" - :attr "texttt") -(markup-locref :open "~n\setentrycounter{page}\textbf{" - :close "}" - :attr "textbf") -(markup-locref :open "~n\setentrycounter{page}\textmd{" - :close "}" - :attr "textmd") -(markup-locref :open "~n\setentrycounter{page}\textit{" - :close "}" - :attr "textit") -(markup-locref :open "~n\setentrycounter{page}\textup{" - :close "}" - :attr "textup") -(markup-locref :open "~n\setentrycounter{page}\textsl{" - :close "}" - :attr "textsl") -(markup-locref :open "~n\setentrycounter{page}\textsc{" - :close "}" - :attr "textsc") -(markup-locref :open "~n\setentrycounter{page}\emph{" - :close "}" - :attr "emph") -(markup-locref :open "~n\setentrycounter{page}\glshypernumber{" - :close "}" - :attr "glshypernumber") -(markup-locref :open "~n\setentrycounter{page}\hyperrm{" - :close "}" - :attr "hyperrm") -(markup-locref :open "~n\setentrycounter{page}\hypersf{" - :close "}" - :attr "hypersf") -(markup-locref :open "~n\setentrycounter{page}\hypertt{" - :close "}" - :attr "hypertt") -(markup-locref :open "~n\setentrycounter{page}\hyperbf{" - :close "}" - :attr "hyperbf") -(markup-locref :open "~n\setentrycounter{page}\hypermd{" - :close "}" - :attr "hypermd") -(markup-locref :open "~n\setentrycounter{page}\hyperit{" - :close "}" - :attr "hyperit") -(markup-locref :open "~n\setentrycounter{page}\hyperup{" - :close "}" - :attr "hyperup") -(markup-locref :open "~n\setentrycounter{page}\hypersl{" - :close "}" - :attr "hypersl") -(markup-locref :open "~n\setentrycounter{page}\hypersc{" - :close "}" - :attr "hypersc") -(markup-locref :open "~n\setentrycounter{page}\hyperemph{" - :close "}" - :attr "hyperemph") -(markup-locref :open "~n\setentrycounter{page}\hyperbfit{" - :close "}" - :attr "hyperbfit") +(markup-locref :open "~n\glsXpageXhyperbfit" + :close "" + :attr "pagehyperbfit") +(markup-locref :open "~n\glsXpageXglsnumberformat" + :close "" + :attr "pageglsnumberformat") +(markup-locref :open "~n\glsXpageXtextrm" + :close "" + :attr "pagetextrm") +(markup-locref :open "~n\glsXpageXtextsf" + :close "" + :attr "pagetextsf") +(markup-locref :open "~n\glsXpageXtexttt" + :close "" + :attr "pagetexttt") +(markup-locref :open "~n\glsXpageXtextbf" + :close "" + :attr "pagetextbf") +(markup-locref :open "~n\glsXpageXtextmd" + :close "" + :attr "pagetextmd") +(markup-locref :open "~n\glsXpageXtextit" + :close "" + :attr "pagetextit") +(markup-locref :open "~n\glsXpageXtextup" + :close "" + :attr "pagetextup") +(markup-locref :open "~n\glsXpageXtextsl" + :close "" + :attr "pagetextsl") +(markup-locref :open "~n\glsXpageXtextsc" + :close "" + :attr "pagetextsc") +(markup-locref :open "~n\glsXpageXemph" + :close "" + :attr "pageemph") +(markup-locref :open "~n\glsXpageXglshypernumber" + :close "" + :attr "pageglshypernumber") +(markup-locref :open "~n\glsXpageXhyperrm" + :close "" + :attr "pagehyperrm") +(markup-locref :open "~n\glsXpageXhypersf" + :close "" + :attr "pagehypersf") +(markup-locref :open "~n\glsXpageXhypertt" + :close "" + :attr "pagehypertt") +(markup-locref :open "~n\glsXpageXhyperbf" + :close "" + :attr "pagehyperbf") +(markup-locref :open "~n\glsXpageXhypermd" + :close "" + :attr "pagehypermd") +(markup-locref :open "~n\glsXpageXhyperit" + :close "" + :attr "pagehyperit") +(markup-locref :open "~n\glsXpageXhyperup" + :close "" + :attr "pagehyperup") +(markup-locref :open "~n\glsXpageXhypersl" + :close "" + :attr "pagehypersl") +(markup-locref :open "~n\glsXpageXhypersc" + :close "" + :attr "pagehypersc") +(markup-locref :open "~n\glsXpageXhyperemph" + :close "" + :attr "pagehyperemph") ; define letter group list format @@ -573,10 +830,14 @@ (markup-letter-group :open-head "\glsgroupheading{" :close-head "}") +; additional letter groups + (define-letter-group "glsnumbers" :prefixes ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9") :before "A") +; additional sort rules + ; The following is copied from xindy/lang/english/utf8-lang.xdy (define-sort-rule-orientations (forward backward forward forward)) diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc207.xdy b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc207.xdy new file mode 100644 index 00000000000..7c8d2b9e484 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc207.xdy @@ -0,0 +1,591 @@ +;; xindy style file for samplexdy.tex that has Mc letter group + +(define-letter-group "A" :prefixes ("")) +(define-letter-group "B" :after "A" :prefixes ("")) +(define-letter-group "C" :after "B" :prefixes ("")) +(define-letter-group "D" :after "C" :prefixes ("")) +(define-letter-group "E" :after "D" :prefixes ("")) +(define-letter-group "F" :after "E" :prefixes ("")) +(define-letter-group "G" :after "F" :prefixes ("")) +(define-letter-group "H" :after "G" :prefixes ("¤")) +(define-letter-group "I" :after "H" :prefixes ("¨")) +(define-letter-group "J" :after "I" :prefixes ("¬")) +(define-letter-group "K" :after "J" :prefixes ("®")) +(define-letter-group "L" :after "K" :prefixes ("´")) +(define-letter-group "Mc" :after "L" :prefixes ("»")) +(define-letter-group "M" :after "Mc" :prefixes ("»")) +(define-letter-group "N" :after "M" :prefixes ("¼")) +(define-letter-group "O" :after "N" :prefixes ("Ã")) +(define-letter-group "P" :after "O" :prefixes ("È")) +(define-letter-group "Q" :after "P" :prefixes ("Ê")) +(define-letter-group "R" :after "Q" :prefixes ("Ë")) +(define-letter-group "S" :after "R" :prefixes ("Ð")) +(define-letter-group "T" :after "S" :prefixes ("Ú")) +(define-letter-group "U" :after "T" :prefixes ("à")) +(define-letter-group "V" :after "U" :prefixes ("å")) +(define-letter-group "W" :after "V" :prefixes ("æ")) +(define-letter-group "X" :after "W" :prefixes ("ë")) +(define-letter-group "Y" :after "X" :prefixes ("í")) +(define-letter-group "È" :after "Y" :prefixes ("ï")) +(define-letter-group "Z" :after "È" :prefixes ("ð")) +(define-letter-group "Ã" :after "Z" :prefixes ("ö")) +(define-letter-group "Æ¿" :after "Ã" :prefixes ("÷")) + +(define-rule-set "en-alphabetize" + + :rules (("à " "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("æ" "" :string) + ("Ã" "" :string) + ("ç" "" :string) + ("ð" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("è" "" :string) + ("ë" "" :string) + ("ê" "" :string) + ("é" "" :string) + ("Ã" "¨" :string) + ("ï" "¨" :string) + ("Ã" "¼" :string) + ("ñ" "¼" :string) + ("Ã" "Ã" :string) + ("Ã" "Ã" :string) + ("ô" "Ã" :string) + ("ö" "Ã" :string) + ("Å" "Ã" :string) + ("Å" "Ã" :string) + ("È" "ï" :string) + ("È" "ï" :string) + ("þ" "ö" :string) + ("Ã" "ö" :string) + ("Ç·" "÷" :string) + ("Æ¿" "÷" :string) + ("a" "" :string) + ("A" "" :string) + ("b" "" :string) + ("B" "" :string) + ("C" "" :string) + ("c" "" :string) + ("d" "" :string) + ("D" "" :string) + ("E" "" :string) + ("e" "" :string) + ("F" "" :string) + ("f" "" :string) + ("g" "" :string) + ("G" "" :string) + ("H" "¤" :string) + ("h" "¤" :string) + ("I" "¨" :string) + ("i" "¨" :string) + ("J" "¬" :string) + ("j" "¬" :string) + ("K" "®" :string) + ("k" "®" :string) + ("L" "´" :string) + ("l" "´" :string) + ("Mc" "»" :string) + ("Mac" "»" :string) + ("M" "»" :string) + ("m" "»" :string) + ("N" "¼" :string) + ("n" "¼" :string) + ("O" "Ã" :string) + ("o" "Ã" :string) + ("P" "È" :string) + ("p" "È" :string) + ("q" "Ê" :string) + ("Q" "Ê" :string) + ("r" "Ë" :string) + ("R" "Ë" :string) + ("S" "Ð" :string) + ("s" "Ð" :string) + ("T" "Ú" :string) + ("t" "Ú" :string) + ("u" "à" :string) + ("U" "à" :string) + ("v" "å" :string) + ("V" "å" :string) + ("w" "æ" :string) + ("W" "æ" :string) + ("X" "ë" :string) + ("x" "ë" :string) + ("Y" "í" :string) + ("y" "í" :string) + ("z" "ð" :string) + ("Z" "ð" :string) + )) + +(define-rule-set "en-resolve-diacritics" + + :rules (("È" "¢" :string) + ("þ" "¢" :string) + ("Ç·" "¢" :string) + ("Ã" "¢" :string) + ("È" "¢" :string) + ("Æ¿" "¢" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("ð" "£" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("ï" "£" :string) + ("ö" "£" :string) + ("ñ" "£" :string) + ("ç" "£" :string) + ("à " "£" :string) + ("Ã" "£" :string) + ("é" "£" :string) + ("Ã" "£" :string) + ("Ã" "¤" :string) + ("ô" "¤" :string) + ("Ã" "¤" :string) + ("è" "¤" :string) + ("Ã" "¥" :string) + ("ë" "¥" :string) + ("Ã" "¦" :string) + ("ê" "¦" :string) + ("Å" "ÿ" :string) + ("Ã" "ÿ" :string) + ("Å" "ÿ" :string) + ("æ" "ÿ" :string) + ("S" "¢" :string) + ("K" "¢" :string) + ("d" "¢" :string) + ("Y" "¢" :string) + ("E" "¢" :string) + ("y" "¢" :string) + ("g" "¢" :string) + ("e" "¢" :string) + ("J" "¢" :string) + ("q" "¢" :string) + ("D" "¢" :string) + ("b" "¢" :string) + ("z" "¢" :string) + ("w" "¢" :string) + ("Q" "¢" :string) + ("M" "¢" :string) + ("C" "¢" :string) + ("L" "¢" :string) + ("X" "¢" :string) + ("P" "¢" :string) + ("T" "¢" :string) + ("a" "¢" :string) + ("N" "¢" :string) + ("j" "¢" :string) + ("Z" "¢" :string) + ("u" "¢" :string) + ("k" "¢" :string) + ("t" "¢" :string) + ("W" "¢" :string) + ("v" "¢" :string) + ("s" "¢" :string) + ("B" "¢" :string) + ("H" "¢" :string) + ("c" "¢" :string) + ("I" "¢" :string) + ("G" "¢" :string) + ("U" "¢" :string) + ("F" "¢" :string) + ("r" "¢" :string) + ("x" "¢" :string) + ("V" "¢" :string) + ("h" "¢" :string) + ("f" "¢" :string) + ("i" "¢" :string) + ("A" "¢" :string) + ("O" "¢" :string) + ("n" "¢" :string) + ("m" "¢" :string) + ("l" "¢" :string) + ("p" "¢" :string) + ("R" "¢" :string) + ("o" "¢" :string) + )) + +(define-rule-set "en-resolve-case" + + :rules (("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ç·" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("È" "8" :string) + ("Ã" "8" :string) + ("Ã" "89" :string) + ("Å" "89" :string) + ("ð" "9" :string) + ("ô" "9" :string) + ("È" "9" :string) + ("ï" "9" :string) + ("ö" "9" :string) + ("ñ" "9" :string) + ("ç" "9" :string) + ("à " "9" :string) + ("þ" "9" :string) + ("è" "9" :string) + ("ë" "9" :string) + ("ê" "9" :string) + ("é" "9" :string) + ("Æ¿" "9" :string) + ("Å" "99" :string) + ("æ" "99" :string) + ("S" "8" :string) + ("K" "8" :string) + ("Y" "8" :string) + ("E" "8" :string) + ("J" "8" :string) + ("D" "8" :string) + ("Q" "8" :string) + ("M" "8" :string) + ("C" "8" :string) + ("L" "8" :string) + ("X" "8" :string) + ("P" "8" :string) + ("T" "8" :string) + ("N" "8" :string) + ("Z" "8" :string) + ("W" "8" :string) + ("B" "8" :string) + ("H" "8" :string) + ("I" "8" :string) + ("G" "8" :string) + ("U" "8" :string) + ("F" "8" :string) + ("V" "8" :string) + ("A" "8" :string) + ("O" "8" :string) + ("R" "8" :string) + ("d" "9" :string) + ("y" "9" :string) + ("g" "9" :string) + ("e" "9" :string) + ("q" "9" :string) + ("b" "9" :string) + ("z" "9" :string) + ("w" "9" :string) + ("a" "9" :string) + ("j" "9" :string) + ("u" "9" :string) + ("k" "9" :string) + ("t" "9" :string) + ("v" "9" :string) + ("s" "9" :string) + ("c" "9" :string) + ("r" "9" :string) + ("x" "9" :string) + ("h" "9" :string) + ("f" "9" :string) + ("i" "9" :string) + ("n" "9" :string) + ("m" "9" :string) + ("l" "9" :string) + ("p" "9" :string) + ("o" "9" :string) + )) + +(define-rule-set "en-ignore-special" + + :rules (("-" "" :string) + ("!" "" :string) + ("{" "" :string) + ("'" "" :string) + ("}" "" :string) + ("?" "" :string) + ("." "" :string) + )) + +(define-rule-set "en-resolve-special" + + :rules (("Ã" "¤" :string) + ("Ã" "¤" :string) + ("ð" "¤" :string) + ("Ã" "¤" :string) + ("Ã" "¤" :string) + ("Ã" "¤" :string) + ("ô" "¤" :string) + ("Ã" "¤" :string) + ("È" "¤" :string) + ("ï" "¤" :string) + ("Ã" "¤" :string) + ("ö" "¤" :string) + ("ñ" "¤" :string) + ("Ã" "¤" :string) + ("ç" "¤" :string) + ("Ã" "¤" :string) + ("à " "¤" :string) + ("þ" "¤" :string) + ("Ç·" "¤" :string) + ("è" "¤" :string) + ("Ã" "¤" :string) + ("ë" "¤" :string) + ("Ã" "¤" :string) + ("ê" "¤" :string) + ("é" "¤" :string) + ("È" "¤" :string) + ("Æ¿" "¤" :string) + ("Ã" "¤" :string) + ("Å" "¤¤" :string) + ("Ã" "¤¤" :string) + ("Å" "¤¤" :string) + ("æ" "¤¤" :string) + ("?" "¡" :string) + ("!" "¢" :string) + ("." "£" :string) + ("S" "¤" :string) + ("K" "¤" :string) + ("d" "¤" :string) + ("Y" "¤" :string) + ("E" "¤" :string) + ("y" "¤" :string) + ("g" "¤" :string) + ("e" "¤" :string) + ("J" "¤" :string) + ("q" "¤" :string) + ("D" "¤" :string) + ("b" "¤" :string) + ("z" "¤" :string) + ("w" "¤" :string) + ("Q" "¤" :string) + ("M" "¤" :string) + ("C" "¤" :string) + ("L" "¤" :string) + ("X" "¤" :string) + ("P" "¤" :string) + ("T" "¤" :string) + ("a" "¤" :string) + ("N" "¤" :string) + ("j" "¤" :string) + ("Z" "¤" :string) + ("u" "¤" :string) + ("k" "¤" :string) + ("t" "¤" :string) + ("W" "¤" :string) + ("v" "¤" :string) + ("s" "¤" :string) + ("B" "¤" :string) + ("H" "¤" :string) + ("c" "¤" :string) + ("I" "¤" :string) + ("G" "¤" :string) + ("U" "¤" :string) + ("F" "¤" :string) + ("r" "¤" :string) + ("x" "¤" :string) + ("V" "¤" :string) + ("h" "¤" :string) + ("f" "¤" :string) + ("i" "¤" :string) + ("A" "¤" :string) + ("O" "¤" :string) + ("n" "¤" :string) + ("m" "¤" :string) + ("l" "¤" :string) + ("p" "¤" :string) + ("R" "¤" :string) + ("o" "¤" :string) + ("-" "¥" :string) + ("'" "¦" :string) + ("{" "§" :string) + ("}" "¨" :string) + )) + +; The following section is customised for samplexdy.tex +; (copied from samplexdy.xdy automatically generated by +; samplexdy.tex) + +; required styles + +(require "tex.xdy") + +; list of allowed attributes (number formats) + +(define-attributes (("default" + "glsnumberformat" + "textrm" + "textsf" + "texttt" + "textbf" + "textmd" + "textit" + "textup" + "textsl" + "textsc" + "emph" + "glshypernumber" + "hyperrm" + "hypersf" + "hypertt" + "hyperbf" + "hypermd" + "hyperit" + "hyperup" + "hypersl" + "hypersc" + "hyperemph" + "hyperbfit"))) + +; user defined alphabets + +; location class definitions + +(define-location-class "roman-page-numbers" + ("roman-numbers-lowercase")) +(define-location-class "Roman-page-numbers" + ("roman-numbers-uppercase")) +(define-location-class "arabic-page-numbers" + ("arabic-numbers")) +(define-location-class "alpha-page-numbers" + ("alpha")) +(define-location-class "Alpha-page-numbers" + ("ALPHA")) +(define-location-class "Appendix-page-numbers" + ("ALPHA" :sep "." "arabic-numbers")) +(define-location-class "arabic-section-numbers" + ("arabic-numbers" :sep "." "arabic-numbers")) + +; user defined location classes + +(define-location-class "Numberstring" + (:sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}")) + +; define cross-reference class + +(define-crossref-class "see" :unverified ) +(markup-crossref-list :class "see" + :open "\glsseeformat" :close "{}") + +; define the order of the location classes +(define-location-class-order ( + "roman-page-numbers" + "arabic-page-numbers" + "arabic-section-numbers" + "alpha-page-numbers" + "Roman-page-numbers" + "Alpha-page-numbers" + "Appendix-page-numbers" + "see" )) + +; define the glossary markup + +(markup-index + :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble~n\begin{theglossary}\glossaryheader~n" + :close "~n\end{theglossary}~n\glossarypostamble~n" + :tree) +(markup-letter-group-list :sep "\glsgroupskip~n") +(markup-indexentry :open "~n" :depth 0) +(markup-locclass-list :open "{\glossaryentrynumbers{\relax " + :sep ", " :close "}}") +(markup-locref-list :sep "\delimN ") +(markup-range :sep "\delimR ") + +; define format to use for locations + +(markup-locref :open "~n\setentrycounter{page}\glsnumberformat{" + :close "}" + :attr "glsnumberformat") +(markup-locref :open "~n\setentrycounter{page}\textrm{" + :close "}" + :attr "textrm") +(markup-locref :open "~n\setentrycounter{page}\textsf{" + :close "}" + :attr "textsf") +(markup-locref :open "~n\setentrycounter{page}\texttt{" + :close "}" + :attr "texttt") +(markup-locref :open "~n\setentrycounter{page}\textbf{" + :close "}" + :attr "textbf") +(markup-locref :open "~n\setentrycounter{page}\textmd{" + :close "}" + :attr "textmd") +(markup-locref :open "~n\setentrycounter{page}\textit{" + :close "}" + :attr "textit") +(markup-locref :open "~n\setentrycounter{page}\textup{" + :close "}" + :attr "textup") +(markup-locref :open "~n\setentrycounter{page}\textsl{" + :close "}" + :attr "textsl") +(markup-locref :open "~n\setentrycounter{page}\textsc{" + :close "}" + :attr "textsc") +(markup-locref :open "~n\setentrycounter{page}\emph{" + :close "}" + :attr "emph") +(markup-locref :open "~n\setentrycounter{page}\glshypernumber{" + :close "}" + :attr "glshypernumber") +(markup-locref :open "~n\setentrycounter{page}\hyperrm{" + :close "}" + :attr "hyperrm") +(markup-locref :open "~n\setentrycounter{page}\hypersf{" + :close "}" + :attr "hypersf") +(markup-locref :open "~n\setentrycounter{page}\hypertt{" + :close "}" + :attr "hypertt") +(markup-locref :open "~n\setentrycounter{page}\hyperbf{" + :close "}" + :attr "hyperbf") +(markup-locref :open "~n\setentrycounter{page}\hypermd{" + :close "}" + :attr "hypermd") +(markup-locref :open "~n\setentrycounter{page}\hyperit{" + :close "}" + :attr "hyperit") +(markup-locref :open "~n\setentrycounter{page}\hyperup{" + :close "}" + :attr "hyperup") +(markup-locref :open "~n\setentrycounter{page}\hypersl{" + :close "}" + :attr "hypersl") +(markup-locref :open "~n\setentrycounter{page}\hypersc{" + :close "}" + :attr "hypersc") +(markup-locref :open "~n\setentrycounter{page}\hyperemph{" + :close "}" + :attr "hyperemph") +(markup-locref :open "~n\setentrycounter{page}\hyperbfit{" + :close "}" + :attr "hyperbfit") + +; define letter group list format + +(markup-letter-group-list :sep "\glsgroupskip~n") + +; letter group headings + +(markup-letter-group :open-head "\glsgroupheading{" + :close-head "}") + +(define-letter-group "glsnumbers" + :prefixes ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9") + :before "A") + +; The following is copied from xindy/lang/english/utf8-lang.xdy + +(define-sort-rule-orientations (forward backward forward forward)) +(use-rule-set :run 0 + :rule-set ("en-alphabetize" "en-ignore-special")) +(use-rule-set :run 1 + :rule-set ("en-resolve-diacritics" "en-ignore-special")) +(use-rule-set :run 2 + :rule-set ("en-resolve-case" "en-ignore-special")) +(use-rule-set :run 3 + :rule-set ("en-resolve-special")) + diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf Binary files differnew file mode 100644 index 00000000000..518290e3a2f --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex index 548c8021198..faa5efb4ace 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex @@ -1,3 +1,5 @@ + % This file is public domain. + % % This is a sample document illustrating how to use the % glossaries package with xindy. To create the document: % @@ -22,16 +24,10 @@ \usepackage[T1]{fontenc} \usepackage{fmtcount} - % remove redefinition of \thepage below if you want to uncomment - % the following line: - % \usepackage[colorlinks]{hyperref} - +\usepackage[colorlinks,plainpages]{hyperref} \usepackage[xindy,style=altlistgroup]{glossaries} - % Define a new command to do bold italic (it uses \hyperbf - % rather than \textbf in case I later introduce hyperlinks - % - although I would have to remove the fancy page numbering - % if I wanted to do that): + % Define a new command to do bold italic: \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} @@ -55,6 +51,10 @@ \string\Numberstringnum\space\glsopenbrace" "arabic-numbers" :sep "\glsclosebrace"} + % (Need to redefine \glsXpageXhyperbfit and + % \glsXpageXglsnumberformat after \makeglossaries to get the + % hyperlinks working correctly.) + % To have Mc as a separate group uncomment the following three % lines: @@ -75,6 +75,24 @@ \makeglossaries + % Each page location will be specified in the form: + % + % "\glsXpageXglsnumberformat{}{\protect \Numberstringnum "\marg{n}"}" + % or + % "\glsXpageXhyperbfit{}{\protect \Numberstringnum "\marg{n}"}" + % + % Redefine to allow hyperlinks: + +\renewcommand{\glsXpageXglsnumberformat}[2]{% + \linkpagenumber#2% +} + +\renewcommand{\glsXpageXhyperbfit}[2]{% + \textbf{\em\linkpagenumber#2}% +} + +\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} + % Define glossary entries % \glshyperlink is used instead of \gls to prevent the glossary % page numbers also appear in the locations, however I need diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf Binary files differnew file mode 100644 index 00000000000..3078c980405 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex new file mode 100644 index 00000000000..d6d12d8087d --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex @@ -0,0 +1,66 @@ + % This file is public domain + % + % This is a sample document illustrating how to use the + % glossaries package with xindy. To create the document: + % + % pdflatex samplexdy2 + % makeglossaries samplexdy2 + % pdflatex samplexdy2 + % + % This sample file won't work with makeindex + % +\documentclass{report} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage[colorlinks]{hyperref} +\usepackage[xindy,counter=section]{glossaries} + + % Set up somewhat eccentric section numbering system: + +\renewcommand*{\thesection}{[\thechapter]\arabic{section}} + +\renewcommand*{\theHsection}{\thepart.\thesection} +\renewcommand*{\thepart}{\Roman{part}} + +\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} + + % If part is 0, then \thepart will be empty, so add an extra + % case to catch this: + +\GlsAddXdyLocation{zero.section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} + + % (Note that the above will stop xindy giving a warning, but the + % location hyper links will be invalid if no \part is used.) + +\makeglossaries + +\newglossaryentry{sample}{name=sample,description={an example}} +\newglossaryentry{sample2}{name=sample2,description={another example}} + +\begin{document} +This is a sample document illustrating Xindy specific commands in +the glossaries package. + +\part{First Part} + +\chapter{Sample Chapter} + +\section{First Section} + +\gls{sample}. \gls{sample2}. + +\section{Second Section} + +\gls{sample2}. + +\section{Third Section} + +\gls{sample}. \gls{sample2}. + +\printglossaries +\end{document} |