diff options
author | Manuel Pégourié-Gonnard <mpg@elzevir.fr> | 2008-05-22 12:12:33 +0000 |
---|---|---|
committer | Manuel Pégourié-Gonnard <mpg@elzevir.fr> | 2008-05-22 12:12:33 +0000 |
commit | ce57a552309046a4cc494db73b145392d23854d8 (patch) | |
tree | 31e74f95d0e1055a9be38ceeff043b0da92c6b55 /Master/texmf-dist/doc/latex/glossaries | |
parent | 5d73f3920ec5a45afe3f6a89f59cbf5ba5f90a8f (diff) |
-mglossaries v1.13 (2008/05/18)
git-svn-id: svn://tug.org/texlive/trunk@8285 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/CHANGES | 41 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/INSTALL | 8 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html | 2627 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex | 600 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries.pdf | bin | 470424 -> 739936 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf | bin | 170076 -> 170294 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex | 1 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex | 35 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex | 66 |
11 files changed, 2205 insertions, 1179 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 7b3154dacee..c7b21c9e29c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,46 @@ glossaries change log: +v1.13 : + * Fixed bug in long4colheaderborder that puts an extra row + at the end of the glossary. + + * Fixed bug in \glstext etc that ignored 3rd argument (thanks + to Franz Fischer for pointing this out). + + * Removed only preamble restriction on \newglossaryentry and + \newacronym. + + * Added \glspluralsuffix. + + * Changed firstplural default so that it takes its value from + the plural key if the first key is omitted. + + * Added \acrshortpl, \Acrshortpl, \ACRshortpl, \acrlongpl, + \Acrlongpl, \ACRlongpl, \acrfullpl, \Acrfullpl, \ACRfullpl. + + * Fixed bugs in \Acrshort etc. + + * Add package options "smaller" and "shortcuts". + + * Acronym default plural forms now implemented for the additional + acronym styles. + + * Fixed makeglossaries to allow filenames with spaces. + + * Fixed error in documentation describing \glsaddall + - optional argument should be a key=value list. + + * Added Polish support (thanks to Piotr Formella for supplying + the translations). + + * If babel is loaded and translator package is found on TeX's + path, then the translator package will now be automatically + loaded. + +mfirstuc v1.01 (13 May 2008): + + * Added \xmakefirstuc (expands argument before applying \makefirstuc) + v1.12 (8 March 2008): * Fixed bug that causes \glspl to print the plural short form on first use instead of the plural long form. diff --git a/Master/texmf-dist/doc/latex/glossaries/INSTALL b/Master/texmf-dist/doc/latex/glossaries/INSTALL index b101d883416..cfe9abd7580 100644 --- a/Master/texmf-dist/doc/latex/glossaries/INSTALL +++ b/Master/texmf-dist/doc/latex/glossaries/INSTALL @@ -56,7 +56,7 @@ latex glossaries.ins To create the package documentation (glossaries.pdf): pdflatex glossaries.dtx -makeindex -s gind.ist glossaries +makeindex -s gind.ist glossaries.idx makeindex -s gglo.ist -o glossaries.gls glossaries.glo pdflatex glossaries.dtx pdflatex glossaries.dtx @@ -76,11 +76,11 @@ Move the sample files (*.tex) to TEXMF/doc/latex/glossaries/sample/ Move the documentation (*.pdf) to TEXMF/doc/latex/glossaries/ -Move glossaries.sty and mfirstuc.sty to TEXMF/tex/latex/glossaries/base/ +Move glossaries.sty, glossaries-babel.sty and mfirstuc.sty to TEXMF/tex/latex/glossaries/base/ -Move the other style files (*.sty) to TEXMF/tex/latex/glossaries/styles/ +Move the other style files (glossary-*.sty) to TEXMF/tex/latex/glossaries/styles/ -Move the dictionary files (*.dic) to TEXMF/tex/latex/glossaries/dict/ +Move the dictionary files (*.dict) to TEXMF/tex/latex/glossaries/dict/ Move makeglossaries to somewhere on your path, e.g. /usr/bin/. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html index ba1371b0e38..2d75f7cafa5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html @@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds Jens Lippmann, Marek Rouchal, Martin Wilck and others --> <HTML> <HEAD> -<TITLE>glossaries.sty v 1.12: LaTeX2e Package to Assist Generating Glossaries</TITLE> -<META NAME="description" CONTENT="glossaries.sty v 1.12: LaTeX2e Package to Assist Generating Glossaries"> +<TITLE>glossaries.sty v 1.13: LaTeX2e Package to Assist Generating Glossaries</TITLE> +<META NAME="description" CONTENT="glossaries.sty v 1.13: LaTeX2e Package to Assist Generating Glossaries"> <META NAME="keywords" CONTENT="glossaries-manual"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -27,7 +27,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds <P> - <H1 ALIGN="CENTER">glossaries.sty v 1.12: LaTeX2e Package to Assist Generating Glossaries</H1> + <H1 ALIGN="CENTER">glossaries.sty v 1.13: LaTeX2e Package to Assist Generating Glossaries</H1> <P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot <BR> <BR> @@ -40,7 +40,7 @@ Norwich. Norfolk NR4 7TJ. United Kingdom. <BR><TT><A NAME="tex2html1" HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT></STRONG></P> -<P ALIGN="CENTER"><STRONG>8th March 2008</STRONG></P> +<P ALIGN="CENTER"><STRONG>12th May 2008</STRONG></P> <BR> <H2><A NAME="SECTION00010000000000000000"> @@ -49,47 +49,49 @@ Contents</A> <!--Table of Contents--> <UL> -<LI><A NAME="tex2html35" +<LI><A NAME="tex2html44" HREF="glossaries-manual.html#SECTION00020000000000000000">Introduction</A> <UL> -<LI><A NAME="tex2html36" - HREF="glossaries-manual.html#SECTION00021000000000000000">Generating the associated glossary files</A> -<LI><A NAME="tex2html37" - HREF="glossaries-manual.html#SECTION00022000000000000000">Troubleshooting</A> +<LI><A NAME="tex2html45" + HREF="glossaries-manual.html#SECTION00021000000000000000">Multi-Lingual Support</A> +<LI><A NAME="tex2html46" + HREF="glossaries-manual.html#SECTION00022000000000000000">Generating the associated glossary files</A> +<LI><A NAME="tex2html47" + HREF="glossaries-manual.html#SECTION00023000000000000000">Troubleshooting</A> </UL> <BR> -<LI><A NAME="tex2html38" +<LI><A NAME="tex2html48" HREF="glossaries-manual.html#SECTION00030000000000000000">A Quick Guide For The Impatient</A> -<LI><A NAME="tex2html39" +<LI><A NAME="tex2html49" HREF="glossaries-manual.html#SECTION00040000000000000000">Overview</A> <UL> -<LI><A NAME="tex2html40" +<LI><A NAME="tex2html50" HREF="glossaries-manual.html#SECTION00041000000000000000">Package Options</A> -<LI><A NAME="tex2html41" +<LI><A NAME="tex2html51" HREF="glossaries-manual.html#SECTION00042000000000000000">Defining Glossary Entries</A> -<LI><A NAME="tex2html42" +<LI><A NAME="tex2html52" HREF="glossaries-manual.html#SECTION00043000000000000000">Number lists</A> -<LI><A NAME="tex2html43" +<LI><A NAME="tex2html53" HREF="glossaries-manual.html#SECTION00044000000000000000">Links to Glossary Entries</A> -<LI><A NAME="tex2html44" +<LI><A NAME="tex2html54" HREF="glossaries-manual.html#SECTION00045000000000000000">Adding an entry to the glossary without generating text</A> -<LI><A NAME="tex2html45" +<LI><A NAME="tex2html55" HREF="glossaries-manual.html#SECTION00046000000000000000">Displaying a glossary</A> -<LI><A NAME="tex2html46" +<LI><A NAME="tex2html56" HREF="glossaries-manual.html#SECTION00047000000000000000">Defining New Glossaries</A> -<LI><A NAME="tex2html47" +<LI><A NAME="tex2html57" HREF="glossaries-manual.html#SECTION00048000000000000000">Acronyms</A> -<LI><A NAME="tex2html48" +<LI><A NAME="tex2html58" HREF="glossaries-manual.html#SECTION00049000000000000000">Unsetting and resetting entry flags</A> -<LI><A NAME="tex2html49" +<LI><A NAME="tex2html59" HREF="glossaries-manual.html#SECTION000410000000000000000">Glossary Styles</A> -<LI><A NAME="tex2html50" +<LI><A NAME="tex2html60" HREF="glossaries-manual.html#SECTION000411000000000000000">Defining your own glossary style</A> </UL> <BR> -<LI><A NAME="tex2html51" +<LI><A NAME="tex2html61" HREF="glossaries-manual.html#SECTION00050000000000000000">Mfirstuc Package</A> -<LI><A NAME="tex2html52" +<LI><A NAME="tex2html62" HREF="glossaries-manual.html#SECTION00060000000000000000">Index</A> </UL> <!--End of Table of Contents--> @@ -107,23 +109,10 @@ 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 where only those terms used in the text are added to the glossary. -This package replaces the <TT>glossary</TT><A NAME="1873"></A> package which is now +This package replaces the <TT>glossary</TT><A NAME="2194"></A> package which is now obsolete. <P> -As from version 1.08, the <TT>glossaries</TT> package now has -limited multi-lingual support, thanks to all the people who have sent -me the relevant translations either via email or via comp.text.tex. -However you must load <TT>babel</TT><A NAME="1877"></A> <I>before</I> -<TT>glossaries</TT> to enable this. -As from version 1.1, the <TT>glossaries</TT> package also supports -Till Tantau's <TT>translator</TT><A NAME="1883"></A> package provided it is loaded -before the <TT>glossaries</TT> package. This makes it easier to change -the default translations or add new dictionaries. -If you don't want to use the predefined translations, you can use the -package option <TT>translate=false</TT><A NAME="1894"></A> and supply your own translations. - -<P> This documentation is structured as follows: <A HREF="glossaries-manual.html#sec:quick">A Quick Guide For The Impatient</A> is for people who want a few quick pointers of how to get started, without having to read through lengthy descriptions, @@ -138,7 +127,153 @@ package. <P> -<H2><A NAME="SECTION00021000000000000000"></A> +<H2><A NAME="SECTION00021000000000000000"> +Multi-Lingual Support</A> +</H2> + +<P> +As from version 1.08, the <TT>glossaries</TT> package now has +limited multi-lingual support, thanks to all the people who have sent +me the relevant translations either via email or via +<TT>comp.text.tex</TT>. +However you must load <TT>babel</TT><A NAME="2203"></A> <I>before</I> +<TT>glossaries</TT> to enable this. Note that if <TT>babel</TT><A NAME="2207"></A> is loaded +and the <TT>translator</TT><A NAME="2210"></A> package is detected on T<SMALL>E</SMALL>X's path, then the +<TT>translator</TT><A NAME="2213"></A> package will be loaded automatically. + +<P> +If you want to use <TT>ngerman</TT><A NAME="2216"></A> or <TT>german</TT><A NAME="2219"></A> instead +of <TT>babel</TT><A NAME="2222"></A>, you will need to include the <TT>translator</TT><A NAME="2225"></A> package +to provide the translations. For example: +<PRE> +\documentclass[ngerman]{article} +\usepackage{ngerman} +\usepackage{translator} +\usepackage{glossaries} +</PRE> + +<P> +The following languages are currently supported: +<DIV ALIGN="CENTER"> +<TABLE CELLPADDING=3> +<TR><TH ALIGN="LEFT"><B>Language </B></TH> +<TH ALIGN="CENTER"><B>As from version</B></TH> +</TR> +<TR><TD ALIGN="LEFT">Danish</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">Dutch</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">English</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">French</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">German</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">Irish</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">Italian</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">Hungarian</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +<TR><TD ALIGN="LEFT">Polish</TD> +<TD ALIGN="CENTER">1.13</TD> +</TR> +<TR><TD ALIGN="LEFT">Spanish</TD> +<TD ALIGN="CENTER">1.08</TD> +</TR> +</TABLE> +</DIV> +The language dependent commands and <TT>translator</TT><A NAME="2228"></A> keys used by the +glossaries package are listed in <A HREF="glossaries-manual.html#tab:predefinednames">table </A><A HREF="glossaries-manual.html#tab:predefinednames">1</A>. + +<P> +<BR><P></P> +<DIV ALIGN="CENTER"> + +<A NAME="tab:predefinednames"></A> +<DIV ALIGN="CENTER"> +<A NAME="203"></A> +<TABLE CELLPADDING=3> +<CAPTION><STRONG>Table 1:</STRONG> +Customised Text</CAPTION> +<TR><TD ALIGN="LEFT"> </TD><TH ALIGN="LEFT"><B>Command Name </B></TH> +<TH ALIGN="LEFT"><B>Translator key word </B></TH> +<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=200><B>What it's for</B></TH> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\glossaryname</TT><A NAME="2234"></A></TD> +<TD ALIGN="LEFT"><TT>Glossary</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Title of the main glossary.</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\acronymname</TT><A NAME="2237"></A></TD> +<TD ALIGN="LEFT"><TT>Acronyms</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Title of the list of acronyms +(when used with package option <TT>acronym</TT><A NAME="2245"></A>).</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\entryname</TT><A NAME="2249"></A></TD> +<TD ALIGN="LEFT"><TT>Notation (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for first column in glossary (for 2, 3 or 4 column glossaries +that support headers).</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\descriptionname</TT><A NAME="2252"></A></TD> +<TD ALIGN="LEFT"><TT>Description (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for second column in glossary (for 2, 3 or 4 column glossaries +that support headers).</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\symbolname</TT><A NAME="2255"></A></TD> +<TD ALIGN="LEFT"><TT>Symbol (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for symbol +column in glossary for glossary styles that support this option.</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\pagelistname</TT><A NAME="2258"></A></TD> +<TD ALIGN="LEFT"><TT>Page List (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for page list column in glossary for glossaries that support +this option.</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\glssymbolsgroupname</TT><A NAME="2261"></A></TD> +<TD ALIGN="LEFT"><TT>Symbols (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for symbols section of the glossary for glossary styles that +support this option.</TD> +<TD ALIGN="LEFT"> </TD></TR> +<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\glsnumbersgroupname</TT><A NAME="2264"></A></TD> +<TD ALIGN="LEFT"><TT>Numbers (glossaries)</TT></TD> +<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for +numbers section of the glossary for glossary styles that support +this option.</TD> +<TD ALIGN="LEFT"> </TD></TR> +</TABLE> +</DIV> +</DIV> +<BR> + +<P> +Due to the varied nature of glossaries, it's likely that the +predefined translations may not be appropriate. If you are using +the <TT>babel</TT><A NAME="2267"></A> package and do not have the <TT>translator</TT><A NAME="2270"></A> package +installed, you need to be familiar with the +advice on <A NAME="tex2html4" + HREF="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords">changing the words babel uses</A>. + +<P> +If you have the <TT>translator</TT><A NAME="2273"></A> package installed, then it becomes +much easier to change the default translations. For example, if you +are writing in Irish and you want <TT>\symbolname</TT> to produce +"Siombail" instead of "Comhartha", then you can put the following +in your document preamble: +<PRE> +\deftranslation[to=Irish]{Symbol (glossaries)}{Siombail} +</PRE> + +<P> + +<H2><A NAME="SECTION00022000000000000000"></A> <A NAME="sec:makeglossaries"></A> <BR> Generating the associated glossary files @@ -146,9 +281,9 @@ Generating the associated glossary files <P> The <TT>glossaries</TT> package comes with the Perl script -<TT>makeglossaries</TT><A NAME="1901"></A> which will run <TT>makeindex</TT><A NAME="1904"></A> on -all the glossary files using a customized <TT>makeindex</TT><A NAME="1907"></A> -<TT>.ist</TT><A NAME="1910"></A> style file (which is created by <TT>\makeglossaries</TT><A NAME="1912"></A>). +<TT>makeglossaries</TT><A NAME="2277"></A> which will run <TT>makeindex</TT><A NAME="2280"></A> on +all the glossary files using a customized <TT>makeindex</TT><A NAME="2283"></A> +<TT>.ist</TT><A NAME="2286"></A> style file (which is created by <TT>\makeglossaries</TT><A NAME="2288"></A>). The relevant extensions are obtained from the auxiliary file, so you should only pass the basename as the argument. For example, if your document is called @@ -158,18 +293,19 @@ latex myfile makeglossaries myfile latex myfile </PRE> -You may need to explicitly load <TT>makeglossaries</TT><A NAME="1915"></A> into +You may need to explicitly load <TT>makeglossaries</TT><A NAME="2291"></A> into Perl: <PRE> perl makeglossaries myfile </PRE> There is a batch file called <TT>makeglossaries.bat</TT> which -does this for Windows users. +does this for Windows users, but you must have Perl installed to +be able to use it. <P> If you don't have Perl installed, you will have to run -<TT>makeindex</TT><A NAME="1918"></A> for each glossary type you have defined. -For example, if you have used the <TT>acronym</TT><A NAME="1926"></A> package option +<TT>makeindex</TT><A NAME="2294"></A> for each glossary type you have defined. +For example, if you have used the <TT>acronym</TT><A NAME="2302"></A> package option then you will have both a main glossary as well as a list of acronyms, so you will need to do (assuming your document is called <TT>myfile.tex</TT>): <PRE> @@ -178,35 +314,35 @@ makeindex -s myfile.ist -t myfile.alg -o myfile.acr myfile.acn </PRE> This requires remembering all extensions for each of the glossaries defined in your document, so where possible you should use -<TT>makeglossaries</TT><A NAME="1930"></A> instead to reduce the possibility of error. +<TT>makeglossaries</TT><A NAME="2306"></A> instead to reduce the possibility of error. Don't pass all the glossary files in a single call to -<TT>makeindex</TT><A NAME="1933"></A> or it will merge all your glossaries into a +<TT>makeindex</TT><A NAME="2309"></A> or it will merge all your glossaries into a single glossary. <P> If any problems occur, remember to check the transcript files -(e.g. <TT>.glg</TT><A NAME="1936"></A> or <TT>.alg</TT><A NAME="1938"></A>) for messages. +(e.g. <TT>.glg</TT><A NAME="2312"></A> or <TT>.alg</TT><A NAME="2314"></A>) for messages. <P> <A HREF="glossaries-manual.html#top">Top</A> <P> -<H2><A NAME="SECTION00022000000000000000"> +<H2><A NAME="SECTION00023000000000000000"> Troubleshooting</A> </H2> <P> -The glossaries package comes with a minimal file called +The <TT>glossaries</TT> package comes with a minimal file called <TT>minimalgls.tex</TT> which can be used for testing. This should be located in <TT>texmf/doc/latex/glossaries/samples/</TT>. Further information on debugging LaTeX code is available at -<TT><A NAME="tex2html2" +<TT><A NAME="tex2html5" HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</A></TT>. <P> There is a list of frequently asked questions for the <TT>glossaries</TT> package available at -<TT><A NAME="tex2html3" +<TT><A NAME="tex2html6" HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html</A></TT>. <P> <A HREF="glossaries-manual.html#top">Top</A> @@ -221,18 +357,19 @@ A Quick Guide For The Impatient <P> This section is for people who want a few quick pointers -of how to get started, without having to read through -lengthy descriptions. +of how to get started. However it is recommended that you read +<A HREF="glossaries-manual.html#sec:overview">the overview section</A> +for additional commands and advice not listed here. <P> <OL> -<LI>Load <TT>glossaries</TT> <I>after</I> <TT>hyperref</TT><A NAME="1948"></A>: +<LI>Load <TT>glossaries</TT> <I>after</I> <TT>hyperref</TT><A NAME="2325"></A>: <PRE> \usepackage{hyperref} \usepackage{glossaries} </PRE> -Similarly for the <TT>html</TT><A NAME="1951"></A> package: +Similarly for the <TT>html</TT><A NAME="2328"></A> package: <PRE> \usepackage{html} \usepackage{glossaries} @@ -240,19 +377,19 @@ Similarly for the <TT>html</TT><A NAME="1951"></A> package: <P> </LI> -<LI>Always use <TT>\makeglossaries</TT><A NAME="1954"></A> if you want the glossary +<LI>Always use <TT>\makeglossaries</TT><A NAME="2331"></A> if you want the glossary entries to be written to the glossary file: <PRE> \documentclass{article} \usepackage{glossaries} \makeglossaries </PRE> -If you don't use <TT>\makeglossaries</TT><A NAME="1957"></A>, your glossaries will +If you don't use <TT>\makeglossaries</TT><A NAME="2334"></A>, your glossaries will not appear in the document! <P> </LI> -<LI>Use <TT>\printglossaries</TT><A NAME="1960"></A> to make your glossaries appear +<LI>Use <TT>\printglossaries</TT><A NAME="2337"></A> to make your glossaries appear in the document at that point. For example: <PRE> \maketitle @@ -265,13 +402,13 @@ document text will appear in the glossary. <P> </LI> <LI>When you have created your document, run LaTeX on it, -then the Perl script <TT>makeglossaries</TT><A NAME="1963"></A>, then run LaTeX on it again: +then the Perl script <TT>makeglossaries</TT><A NAME="2340"></A>, then run LaTeX on it again: <PRE> latex myfile makeglossaries myfile latex myfile </PRE> -(You may need to run LaTeX again if you have used the <TT>toc</TT><A NAME="1971"></A> +(You may need to run LaTeX again if you have used the <TT>toc</TT><A NAME="2348"></A> package option.) If you use Windows, there is a batch file called <TT>makeglossaries.bat</TT> which you can use, but you will @@ -281,23 +418,23 @@ still need Perl installed. </LI> <LI>New glossaries can be defined using: <P> -<TT>\newglossary</TT><A NAME="1975"></A><TT>[</TT><EM>log-ext</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>in-ext</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>title</EM><TT>}</TT> +<TT>\newglossary</TT><A NAME="2352"></A><TT>[</TT><EM>log-ext</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>in-ext</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>title</EM><TT>}</TT> <P> where <I>label</I> is an identifying label, <I>in-ext</I> is the extension of the file to be created -by <TT>makeindex</TT><A NAME="1978"></A> (called by <TT>makeglossaries</TT><A NAME="1981"></A>), +by <TT>makeindex</TT><A NAME="2355"></A> (called by <TT>makeglossaries</TT><A NAME="2358"></A>), <I>out-ext</I> is the extension of the file to be read by -<TT>makeindex</TT><A NAME="1984"></A> and <I>title</I> is the title for this +<TT>makeindex</TT><A NAME="2361"></A> and <I>title</I> is the title for this new glossary. The first optional argument <I>log-ext</I> specifies -the extension of the <TT>makeindex</TT><A NAME="1987"></A> transcript file. Example: +the extension of the <TT>makeindex</TT><A NAME="2364"></A> transcript file. Example: <PRE> \newglossary[nlg]{notation}{not}{ntn}{Notation} </PRE> This glossary's label is <TT>notation</TT> and its title -will be Notation. If you use <TT>makeglossaries</TT><A NAME="1990"></A>, the -<TT>makeindex</TT><A NAME="1993"></A> transcript will be written to a file with the -extension <TT>.nlg</TT><A NAME="1996"></A>. If <I>log-ext</I> is omitted, the extension -<TT>.glg</TT><A NAME="1998"></A> will be used. +will be Notation. If you use <TT>makeglossaries</TT><A NAME="2367"></A>, the +<TT>makeindex</TT><A NAME="2370"></A> transcript will be written to a file with the +extension <TT>.nlg</TT><A NAME="2373"></A>. If <I>log-ext</I> is omitted, the extension +<TT>.glg</TT><A NAME="2375"></A> will be used. <P> </LI> @@ -312,7 +449,7 @@ extension <TT>.nlg</TT><A NAME="1996"></A>. If <I>log-ext</I> is omitted, the ex <P> </LI> -<LI>If you use the <TT>acronym</TT><A NAME="2005"></A> package option, the +<LI>If you use the <TT>acronym</TT><A NAME="2382"></A> package option, the <TT>glossaries</TT> package will automatically create a new glossary type labelled <TT>acronym</TT>: @@ -323,8 +460,8 @@ will automatically create a new glossary type labelled <P> </LI> <LI>If your pages have a hyphen compositor (i.e. your page -numbers appear in the form 2-1), redefine <TT>\glscompositor</TT><A NAME="2010"></A> -<I>before</I> <TT>\makeglossaries</TT><A NAME="2013"></A>: +numbers appear in the form 2-1), redefine <TT>\glscompositor</TT><A NAME="2387"></A> +<I>before</I> <TT>\makeglossaries</TT><A NAME="2390"></A>: <PRE> \documentclass{article} \usepackage{glossaries} @@ -335,7 +472,7 @@ numbers appear in the form 2-1), redefine <TT>\glscompositor</TT><A NAME="20 <P> </LI> <LI>To add the glossaries to the table of contents use the -<TT>toc</TT><A NAME="2021"></A> package option: +<TT>toc</TT><A NAME="2398"></A> package option: <PRE> \usepackage[toc]{glossaries} </PRE> @@ -344,10 +481,10 @@ numbers appear in the form 2-1), redefine <TT>\glscompositor</TT><A NAME="20 </LI> <LI>Define a new entry with: <P> -<TT>\newglossaryentry</TT><A NAME="2025"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT> +<TT>\newglossaryentry</TT><A NAME="2402"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT> <P> -The <I>key-val list</I> must at least contain a <TT>name</TT><A NAME="2028"></A> -key and a <TT>description</TT><A NAME="2031"></A> key. +The <I>key-val list</I> must at least contain a <TT>name</TT><A NAME="2405"></A> +key and a <TT>description</TT><A NAME="2408"></A> key. For example: <PRE> \newglossaryentry{perl}{name=Perl, @@ -361,7 +498,7 @@ to use to identify it. </LI> <LI>If the entry name starts with an accented letter, you will need to group the first letter (otherwise it will cause a -problem for <TT>\Gls</TT><A NAME="2034"></A> and <TT>\Glspl</TT><A NAME="2037"></A>): +problem for <TT>\Gls</TT><A NAME="2411"></A> and <TT>\Glspl</TT><A NAME="2414"></A>): <PRE> \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}} @@ -375,7 +512,7 @@ description={canal from mouth to stomach}} <P> </LI> -<LI>If you have multiple glossaries, use the <TT>type</TT><A NAME="2040"></A> +<LI>If you have multiple glossaries, use the <TT>type</TT><A NAME="2417"></A> key to specify in which glossary the entry belongs. For example: <PRE> \newglossary{languages}{lan}{lng}{Index of Languages} @@ -386,7 +523,7 @@ key to specify in which glossary the entry belongs. For example: description=A scripting language, type=languages} </PRE> -If <TT>type</TT><A NAME="2043"></A> is omitted, the default glossary is used. +If <TT>type</TT><A NAME="2420"></A> is omitted, the default glossary is used. <P> </LI> @@ -402,7 +539,7 @@ description={A list of individual pages or page ranges </LI> <LI>Plural forms are assumed to be the singular form with an "s" appended, unless otherwise specified. To specify an -irregular plural, use the <TT>plural</TT><A NAME="2046"></A> key. For example: +irregular plural, use the <TT>plural</TT><A NAME="2423"></A> key. For example: <PRE> \newglossaryentry{matrix}{name=matrix, description=rectangular array of quantities, @@ -442,7 +579,7 @@ and subsequently appears as "SM" or "SMs". </LI> <LI>The quick and easy way to define an acronym is to use: <P> -<TT>\newacronym</TT><A NAME="2049"></A><TT>[</TT><EM>key-val list</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>abbrev</EM><TT>}{</TT><EM>long</EM><TT>}</TT> +<TT>\newacronym</TT><A NAME="2426"></A><TT>[</TT><EM>key-val list</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>abbrev</EM><TT>}{</TT><EM>long</EM><TT>}</TT> <P> For example: <PRE> @@ -458,30 +595,30 @@ first={support vector machine (SVM)}, plural={SVMs}, firstplural={support vector machines (SVMs)}} </PRE> -(The value of <TT>\acronymtype</TT><A NAME="2052"></A> varies depending on whether -the <TT>acronym</TT><A NAME="2060"></A> package option is used or not. +(The value of <TT>\acronymtype</TT><A NAME="2429"></A> varies depending on whether +the <TT>acronym</TT><A NAME="2437"></A> package option is used or not. The optional argument <I>key-val list</I> can be used to -override any of the <TT>\newglossaryentry</TT><A NAME="2064"></A> keys; for +override any of the <TT>\newglossaryentry</TT><A NAME="2441"></A> keys; for example, if the acronym has an irregular plural.) <P> </LI> <LI>The font used to display the entry name in the glossary -is governed by <TT>\glsnamefont</TT><A NAME="2067"></A>. This can be redefined +is governed by <TT>\glsnamefont</TT><A NAME="2444"></A>. This can be redefined as required. For example, to make the entry names appear in a medium sans-serif font do: <PRE> \renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}} </PRE> Note that the list-like glossary styles defined in the -<TT>glossary-list</TT><A NAME="2070"></A> package place the entry name in -the optional argument to <TT>\item</TT><A NAME="2073"></A>, so they will -appear in bold, unless you redefine <TT>\glsnamefont</TT><A NAME="2076"></A> to counteract the +<TT>glossary-list</TT><A NAME="2447"></A> package place the entry name in +the optional argument to <TT>\item</TT><A NAME="2450"></A>, so they will +appear in bold, unless you redefine <TT>\glsnamefont</TT><A NAME="2453"></A> to counteract the bold font. <P> </LI> -<LI>In the document use <TT>\gls</TT><A NAME="2079"></A><TT>{</TT><EM>label</EM><TT>}</TT> +<LI>In the document use <TT>\gls</TT><A NAME="2456"></A><TT>{</TT><EM>label</EM><TT>}</TT> to use a predefined term (this will also enter the term into the associated glossary output file). For example: <PRE> @@ -493,21 +630,21 @@ A \gls{singmtx} is a matrix with a zero determinant. <LI>Other variations: <UL> -<LI><TT>\Gls</TT><A NAME="2082"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>, +<LI><TT>\Gls</TT><A NAME="2459"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>, but with first letter in upper case </LI> -<LI><TT>\GLS</TT><A NAME="2085"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>, +<LI><TT>\GLS</TT><A NAME="2462"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>, but all upper case. </LI> -<LI><TT>\glspl</TT><A NAME="2088"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural +<LI><TT>\glspl</TT><A NAME="2465"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural </LI> -<LI><TT>\Glspl</TT><A NAME="2091"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural with +<LI><TT>\Glspl</TT><A NAME="2468"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural with first letter in upper case </LI> -<LI><TT>\GLSpl</TT><A NAME="2094"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural but +<LI><TT>\GLSpl</TT><A NAME="2471"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural but all upper case </LI> -<LI><TT>\glslink</TT><A NAME="2097"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>link text</EM><TT>}</TT> : +<LI><TT>\glslink</TT><A NAME="2474"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>link text</EM><TT>}</TT> : use <I>link text</I> to link to the given entry in the glossary. </LI> </UL> @@ -528,8 +665,8 @@ The \gls{singmtx}['s] dimensions \ldots <P> </LI> <LI>The format of the associated entry number can be -changed using the <TT>format</TT><A NAME="2100"></A> key in the optional argument. -Note that the value of the <TT>format</TT><A NAME="2103"></A> key should be the +changed using the <TT>format</TT><A NAME="2477"></A> key in the optional argument. +Note that the value of the <TT>format</TT><A NAME="2480"></A> key should be the name of a command <I>without</I> the initial backslash. For example: <PRE> @@ -545,23 +682,23 @@ it will no longer have a hyperlink (if hyperlinks are enabled.) change the font whilst ensuring that the number remains a hyperlink. These are of the form <TT>\hyper</TT><I>xx</I> and are equivalent to the standard font changing commands of the -form <TT>\text</TT><I>xx</I>, as well as <TT>\hyperemph</TT><A NAME="2107"></A> -(which uses <TT>\emph</TT><A NAME="2110"></A>.) For example: +form <TT>\text</TT><I>xx</I>, as well as <TT>\hyperemph</TT><A NAME="2484"></A> +(which uses <TT>\emph</TT><A NAME="2487"></A>.) For example: <PRE> The primary definition of \glspl[format=hyperbf]{singmtx}. </PRE> <P> </LI> -<LI>Don't use declarations in <TT>format</TT><A NAME="2113"></A> as this can +<LI>Don't use declarations in <TT>format</TT><A NAME="2490"></A> as this can cause unpredictable results, as there is no guarantee that the effect will be localised to the required text. <P> </LI> <LI>Entries can be added to the glossary without producing -any text using <TT>\glsadd</TT><A NAME="2116"></A><TT>{</TT><EM>label</EM><TT>}</TT> or -<TT>\glsaddall</TT><A NAME="2119"></A>. These commands also taken an optional +any text using <TT>\glsadd</TT><A NAME="2493"></A><TT>{</TT><EM>label</EM><TT>}</TT> or +<TT>\glsaddall</TT><A NAME="2496"></A>. These commands also taken an optional argument where you can specify the format. For example <PRE> \glsadd[format=hyperbf]{singmtx} @@ -574,8 +711,8 @@ any text where the command occurs. </LI> <LI>A number range can be entered using <code>format=(</code> and <code>format=)</code> to mark the beginning and ending of the -range<A NAME="tex2html4" - HREF="#foot378"><SUP>1</SUP></A>. For example: +range<A NAME="tex2html7" + HREF="#foot446"><SUP>1</SUP></A>. For example: <PRE> \glsadd[format=(]{singmtx} This is a very long section all about \glspl{singmtx}. @@ -584,7 +721,7 @@ range<A NAME="tex2html4" \glsadd[format=)]{singmtx} </PRE> -This is equivalent to <TT>makeindex</TT><A NAME="2122"></A>'s <code>|(</code> and <code>|)</code> +This is equivalent to <TT>makeindex</TT><A NAME="2499"></A>'s <code>|(</code> and <code>|)</code> formats. <P> @@ -606,13 +743,13 @@ formats. <LI>Only those terms that have actually been used in the document will be placed in the glossary. If you have defined a term that doesn't appear in the document, then it means -you haven't used it in the text (either via <TT>\glslink</TT><A NAME="2125"></A> -or <TT>\gls</TT><A NAME="2128"></A> and related commands, or via <TT>\glsadd</TT><A NAME="2131"></A> -or <TT>\glsaddall</TT><A NAME="2134"></A>.) +you haven't used it in the text (either via <TT>\glslink</TT><A NAME="2502"></A> +or <TT>\gls</TT><A NAME="2505"></A> and related commands, or via <TT>\glsadd</TT><A NAME="2508"></A> +or <TT>\glsaddall</TT><A NAME="2511"></A>.) <P> </LI> -<LI>To change the sorting order, use the <TT>sort</TT><A NAME="2137"></A> key. +<LI>To change the sorting order, use the <TT>sort</TT><A NAME="2514"></A> key. For example: <PRE> \newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}}, @@ -622,7 +759,7 @@ sort=U} <P> </LI> -<LI>You don't need to escape <TT>makeindex</TT><A NAME="2140"></A>'s special characters: +<LI>You don't need to escape <TT>makeindex</TT><A NAME="2517"></A>'s special characters: <PRE> \newglossaryentry{quote}{name={"}, description={Double quote character}} @@ -644,21 +781,21 @@ description={A metric measurement of length}, symbol={m}} </PRE> The predefined glossary styles that display the entry symbol -are: <TT>long4col</TT><A NAME="2143"></A>, <TT>long4colheader</TT><A NAME="2145"></A>, -<TT>long4colborder</TT><A NAME="2147"></A>, <TT>long4colheaderborder</TT><A NAME="2149"></A>, -<TT>super4col</TT><A NAME="2151"></A>, <TT>super4colheader</TT><A NAME="2153"></A>, -<TT>super4colborder</TT><A NAME="2155"></A> and <TT>super4colheaderborder</TT><A NAME="2157"></A>. +are: <TT>long4col</TT><A NAME="2520"></A>, <TT>long4colheader</TT><A NAME="2522"></A>, +<TT>long4colborder</TT><A NAME="2524"></A>, <TT>long4colheaderborder</TT><A NAME="2526"></A>, +<TT>super4col</TT><A NAME="2528"></A>, <TT>super4colheader</TT><A NAME="2530"></A>, +<TT>super4colborder</TT><A NAME="2532"></A> and <TT>super4colheaderborder</TT><A NAME="2534"></A>. All the other styles supplied by this package ignore the associated symbol. <P> </LI> -<LI>Glossary styles can be set using the <TT>style</TT><A NAME="2164"></A> +<LI>Glossary styles can be set using the <TT>style</TT><A NAME="2541"></A> package option. For example: <PRE> \usepackage[style=long3col]{glossaries} </PRE> -or using <TT>\glossarystyle</TT><A NAME="2168"></A><TT>{</TT><EM>style</EM><TT>}</TT>. For example: +or using <TT>\glossarystyle</TT><A NAME="2545"></A><TT>{</TT><EM>style</EM><TT>}</TT>. For example: <PRE> \glossarystyle{altlist} </PRE> @@ -668,7 +805,7 @@ bundle are listed in <A HREF="glossaries-manual.html#sec:styles">Glossary Styles <P> </LI> <LI>The list of numbers associated with each glossary entry -can be suppressed using the package option <TT>nonumberlist</TT><A NAME="2177"></A>: +can be suppressed using the package option <TT>nonumberlist</TT><A NAME="2554"></A>: <PRE> \usepackage[nonumberlist]{glossaries} </PRE> @@ -677,14 +814,14 @@ can be suppressed using the package option <TT>nonumberlist</TT><A NAME="2177">< </LI> <LI>By default, the glossaries will appear in an unnumbered chapter if chapters are defined, otherwise in an unnumbered -section. This can be changed using the <TT>section</TT><A NAME="2186"></A> package +section. This can be changed using the <TT>section</TT><A NAME="2563"></A> package option. For example, to make the glossaries appear in an unnumbered section, even if chapters are defined, do: <PRE> \usepackage[section]{glossaries} </PRE> Other sectional units can also be specified as -<TT>section</TT><A NAME="2195"></A>=<I>value</I>. For example, to make the glossaries +<TT>section</TT><A NAME="2572"></A>=<I>value</I>. For example, to make the glossaries appear in unnumbered subsections: <PRE> \usepackage[section=subsection]{glossaries} @@ -712,28 +849,28 @@ Package Options</A> <P> The <TT>glossaries</TT> package options are as follows: <DL> -<DT><STRONG><TT>toc</TT><A NAME="2208"></A></STRONG></DT> +<DT><STRONG><TT>toc</TT><A NAME="2585"></A></STRONG></DT> <DD>Add the glossaries to the table of contents. <P> </DD> -<DT><STRONG><TT>numberline</TT><A NAME="2217"></A></STRONG></DT> -<DD>When used with <TT>toc</TT><A NAME="2226"></A>, this will +<DT><STRONG><TT>numberline</TT><A NAME="2594"></A></STRONG></DT> +<DD>When used with <TT>toc</TT><A NAME="2603"></A>, this will add <TT>\numberline</TT><code>{}</code> in the final argument of <TT>\addcontentsline</TT>. This will align the table of contents entry with the numbered section titles. Note that this option has no -effect if the <TT>toc</TT><A NAME="2235"></A> option is omitted. If <TT>toc</TT><A NAME="2244"></A> is -used without <TT>numberline</TT><A NAME="2253"></A>, the title will be aligned with +effect if the <TT>toc</TT><A NAME="2612"></A> option is omitted. If <TT>toc</TT><A NAME="2621"></A> is +used without <TT>numberline</TT><A NAME="2630"></A>, the title will be aligned with the section numbers rather than the section titles. <P> </DD> -<DT><STRONG><TT>acronym</TT><A NAME="2262"></A></STRONG></DT> +<DT><STRONG><TT>acronym</TT><A NAME="2639"></A></STRONG></DT> <DD>Make a separate glossary for acronyms. <P> </DD> -<DT><STRONG><TT>section</TT><A NAME="2271"></A></STRONG></DT> +<DT><STRONG><TT>section</TT><A NAME="2648"></A></STRONG></DT> <DD>This is a <I>key</I>=<I>value</I> 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, @@ -751,22 +888,22 @@ is equivalent to \usepackage[section=section]{glossaries} </PRE> You can change this value later in the document using -<TT>\setglossarysection</TT><A NAME="2275"></A><TT>{</TT><EM>type</EM><TT>}</TT>. +<TT>\setglossarysection</TT><A NAME="2652"></A><TT>{</TT><EM>type</EM><TT>}</TT>. <P> </DD> -<DT><STRONG><TT>numberedsection</TT><A NAME="2283"></A></STRONG></DT> +<DT><STRONG><TT>numberedsection</TT><A NAME="2660"></A></STRONG></DT> <DD>The glossaries are placed in unnumbered sectional units by default, -but this can be changed using <TT>numberedsection</TT><A NAME="2292"></A>. This option can take -three possible values: <TT>false</TT><A NAME="2296"></A> (no -number, i.e. use starred form), <TT>nolabel</TT><A NAME="2298"></A> +but this can be changed using <TT>numberedsection</TT><A NAME="2669"></A>. This option can take +three possible values: <TT>false</TT><A NAME="2673"></A> (no +number, i.e. use starred form), <TT>nolabel</TT><A NAME="2675"></A> (numbered, i.e. unstarred form, but not labelled) and -<TT>autolabel</TT><A NAME="2300"></A> (numbered with automatic -labelling). If <TT>numberedsection=autolabel</TT><A NAME="2309"></A> is used, each +<TT>autolabel</TT><A NAME="2677"></A> (numbered with automatic +labelling). If <TT>numberedsection=autolabel</TT><A NAME="2686"></A> is used, each glossary is given a label that matches the glossary type, so the main (default) glossary is labelled <TT>main</TT>, the list of -acronyms is labelled <TT>acronym</TT><A NAME="tex2html5" - HREF="#foot1737"><SUP>2</SUP></A> and additional glossaries are labelled +acronyms is labelled <TT>acronym</TT><A NAME="tex2html8" + HREF="#foot2039"><SUP>2</SUP></A> and additional glossaries are labelled using the value specified in the first mandatory argument to <TT>\newglossary</TT>. For example, if you load <TT>glossaries</TT> using: @@ -781,100 +918,104 @@ acronyms is in section~\ref{acronym}. </PRE> If you can't decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use -<TT>\acronymtype</TT><A NAME="2321"></A> which is set to <TT>main</TT> if the -<TT>acronym</TT><A NAME="2329"></A> option is not used and is set to <TT>acronym</TT> -if the <TT>acronym</TT><A NAME="2338"></A> option is used. For example: +<TT>\acronymtype</TT><A NAME="2698"></A> which is set to <TT>main</TT> if the +<TT>acronym</TT><A NAME="2706"></A> option is not used and is set to <TT>acronym</TT> +if the <TT>acronym</TT><A NAME="2715"></A> option is used. For example: <PRE> The list of acronyms is in section~\ref{\acronymtype}. </PRE> <P> </DD> -<DT><STRONG><TT>style</TT><A NAME="2347"></A></STRONG></DT> +<DT><STRONG><TT>style</TT><A NAME="2724"></A></STRONG></DT> <DD>This is a <I>key</I>=<I>value</I> option. Its value should be the name of the glossary style to use. Predefined glossary styles are listed <A HREF="glossaries-manual.html#sec:styles">later</A>. <P> </DD> -<DT><STRONG><TT>nonumberlist</TT><A NAME="2356"></A></STRONG></DT> +<DT><STRONG><TT>nonumberlist</TT><A NAME="2733"></A></STRONG></DT> <DD>This option will suppress the -associated number lists<A NAME="2359"></A> in the glossaries (see also +associated number lists<A NAME="2736"></A> in the glossaries (see also <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.) <P> </DD> -<DT><STRONG><TT>counter</TT><A NAME="2366"></A></STRONG></DT> +<DT><STRONG><TT>counter</TT><A NAME="2743"></A></STRONG></DT> <DD>This is a <I>key</I>=<I>value</I> option. The value should be the name of the default counter to use in the number -lists<A NAME="2369"></A>. +lists<A NAME="2746"></A>. <P> <A NAME="sanitize"></A> </DD> -<DT><STRONG><TT>sanitize</TT><A NAME="2376"></A></STRONG></DT> +<DT><STRONG><TT>sanitize</TT><A NAME="2753"></A></STRONG></DT> <DD>This is a <I>key</I>=<I>value</I> option whose value is also a <I>key</I>=<I>value</I> list. By default, the <TT>glossaries</TT> package sanitizes the values of the -<TT>name</TT><A NAME="2381"></A>, <TT>description</TT><A NAME="2384"></A> and <TT>symbol</TT><A NAME="2387"></A> keys used +<TT>name</TT><A NAME="2758"></A>, <TT>description</TT><A NAME="2761"></A> and <TT>symbol</TT><A NAME="2764"></A> keys used when defining a new glossary entry. This may lead to unexpected results if you try to display these values within the document text. This -sanitization can be switched off using the <TT>sanitize</TT><A NAME="2395"></A> package +sanitization can be switched off using the <TT>sanitize</TT><A NAME="2772"></A> package option. For example, to switch off the sanitization for the -<TT>description</TT><A NAME="2399"></A> and <TT>name</TT><A NAME="2402"></A> keys, but not for the -<TT>symbol</TT><A NAME="2405"></A> key, do: +<TT>description</TT><A NAME="2776"></A> and <TT>name</TT><A NAME="2779"></A> keys, but not for the +<TT>symbol</TT><A NAME="2782"></A> key, do: <PRE> \usepackage[sanitize={name=false,description=false,% symbol=true}]{glossaries} </PRE> <P> -<B>Note</B>: this sanitization only applies to the <TT>name</TT><A NAME="2408"></A>, -<TT>description</TT><A NAME="2411"></A> and <TT>symbol</TT><A NAME="2414"></A> keys. It doesn't apply -to any of the other keys (except the <TT>sort</TT><A NAME="2417"></A> key which is +<B>Note</B>: this sanitization only applies to the <TT>name</TT><A NAME="2785"></A>, +<TT>description</TT><A NAME="2788"></A> and <TT>symbol</TT><A NAME="2791"></A> keys. It doesn't apply +to any of the other keys (except the <TT>sort</TT><A NAME="2794"></A> key which is always sanitized) so fragile commands contained in the value of the other keys must always be protected using <TT>\protect</TT>. -Since the value of the <TT>text</TT><A NAME="2420"></A> key is obtained from the -<TT>name</TT><A NAME="2423"></A> key, you will still need to protect fragile commands -in the <TT>name</TT><A NAME="2426"></A> key if you don't use the <TT>text</TT><A NAME="2429"></A> key. +Since the value of the <TT>text</TT><A NAME="2797"></A> key is obtained from the +<TT>name</TT><A NAME="2800"></A> key, you will still need to protect fragile commands +in the <TT>name</TT><A NAME="2803"></A> key if you don't use the <TT>text</TT><A NAME="2806"></A> key. <P> </DD> -<DT><STRONG><TT>babel</TT><A NAME="2437"></A></STRONG></DT> -<DD>This is a boolean key and is for use when -the <TT>glossaries</TT> package is used in conjunction with the -<TT>babel</TT><A NAME="2442"></A> package. The default is <TT>babel=true</TT><A NAME="2452"></A>, which -adds the glossary translations to <TT>babel</TT><A NAME="2454"></A>'s captions. If -you don't like the translations provided by the <TT>glossaries</TT> -package, you can set <TT>babel=false</TT><A NAME="2465"></A> and provide your own -translations. +<DT><STRONG><TT>description</TT><A NAME="2814"></A></STRONG></DT> +<DD>This option changes the definition of +<TT>\newacronym</TT><A NAME="2818"></A> to allow a description. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> +for further details. <P> </DD> -<DT><STRONG><TT>description</TT><A NAME="2472"></A></STRONG></DT> +<DT><STRONG><TT>footnote</TT><A NAME="2826"></A></STRONG></DT> <DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="2476"></A> to allow a description. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> +<TT>\newacronym</TT><A NAME="2830"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> for further details. <P> </DD> -<DT><STRONG><TT>footnote</TT><A NAME="2484"></A></STRONG></DT> +<DT><STRONG><TT>smallcaps</TT><A NAME="2838"></A></STRONG></DT> <DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="2488"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> +<TT>\newacronym</TT><A NAME="2842"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> for further details. <P> </DD> -<DT><STRONG><TT>smallcaps</TT><A NAME="2496"></A></STRONG></DT> +<DT><STRONG><TT>smaller</TT><A NAME="2850"></A></STRONG></DT> <DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="2500"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> +<TT>\newacronym</TT><A NAME="2854"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> for further details. <P> </DD> -<DT><STRONG><TT>dua</TT><A NAME="2508"></A></STRONG></DT> +<DT><STRONG><TT>dua</TT><A NAME="2862"></A></STRONG></DT> <DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="2512"></A> so that acronyms are always expanded. +<TT>\newacronym</TT><A NAME="2866"></A> so that acronyms are always expanded. +See <A HREF="glossaries-manual.html#sec:acronyms">later</A> +for further details. + +<P> +</DD> +<DT><STRONG><TT>shortcuts</TT><A NAME="2874"></A></STRONG></DT> +<DD>This option provides shortcut commands +for acronyms. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> for further details. @@ -893,23 +1034,25 @@ Defining Glossary Entries </H2> <P> -All glossary entries that are used in a document must be defined in -the preamble. Only those entries that occur in the document +All glossary entries must be defined before they are used, so it +is better to define them in the preamble to ensure this.<A NAME="tex2html9" + HREF="#foot2059"><SUP>3</SUP></A> However +only those entries that occur in the document (using any of the commands described in <A HREF="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A> and <A HREF="glossaries-manual.html#sec:glsadd">Adding an entry to the glossary without generating text</A>) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary -(<TT>.glo</TT><A NAME="2518"></A>) file, which then needs to be converted into a -corresponding <TT>.gls</TT><A NAME="2520"></A> file which contains the typeset glossary -which is input by <TT>\printglossary</TT><A NAME="2522"></A> or -<TT>\printglossaries</TT><A NAME="2525"></A>. The Perl script <TT>makeglossaries</TT><A NAME="2528"></A> -can be used to call <TT>makeindex</TT><A NAME="2531"></A>, using a customised -<TT>.ist</TT><A NAME="2534"></A> style file, for each of the glossaries that are defined +(<TT>.glo</TT><A NAME="2881"></A>) file, which then needs to be converted into a +corresponding <TT>.gls</TT><A NAME="2883"></A> file which contains the typeset glossary +which is input by <TT>\printglossary</TT><A NAME="2885"></A> or +<TT>\printglossaries</TT><A NAME="2888"></A>. The Perl script <TT>makeglossaries</TT><A NAME="2891"></A> +can be used to call <TT>makeindex</TT><A NAME="2894"></A>, using a customised +<TT>.ist</TT><A NAME="2897"></A> 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. <P> The command <TT>\makeglossaries</TT> must be placed in the preamble in -order to create the customised <TT>makeindex</TT><A NAME="2536"></A> <TT>.ist</TT><A NAME="2539"></A> +order to create the customised <TT>makeindex</TT><A NAME="2899"></A> <TT>.ist</TT><A NAME="2902"></A> style file and to ensure that glossary entries are written to the appropriate output file. If you omit <TT>\makeglossaries</TT> none of the glossaries will be created. Note that if your page numbers use a @@ -931,100 +1074,106 @@ The first argument, <I>label</I>, must be a unique label with which to identify this entry. The second argument, <I>key-val list</I>, is a <I>key</I>=<I>value</I> list that supplies the relevant information -about this entry. There are two required fields: <TT>name</TT><A NAME="2541"></A> and -<TT>description</TT><A NAME="2544"></A>. Available fields are listed below: +about this entry. There are two required fields: <TT>name</TT><A NAME="2904"></A> and +<TT>description</TT><A NAME="2907"></A>. Available fields are listed below: <P> <DL> -<DT><STRONG><TT>name</TT><A NAME="2547"></A></STRONG></DT> +<DT><STRONG><TT>name</TT><A NAME="2910"></A></STRONG></DT> <DD>The name of the entry (as it will appear in the glossary). <P> </DD> -<DT><STRONG><TT>description</TT><A NAME="2550"></A></STRONG></DT> +<DT><STRONG><TT>description</TT><A NAME="2913"></A></STRONG></DT> <DD>A brief description of this term (to appear in the glossary). <P> </DD> -<DT><STRONG><TT>descriptionplural</TT><A NAME="2553"></A></STRONG></DT> +<DT><STRONG><TT>descriptionplural</TT><A NAME="2916"></A></STRONG></DT> <DD>The plural form of the -description (as passed to <TT>\glsdisplay</TT><A NAME="2556"></A> and <TT>\glsdisplayfirst</TT><A NAME="2559"></A> -by <TT>\glspl</TT><A NAME="2562"></A>, <TT>\Glspl</TT><A NAME="2565"></A> and <TT>\GLSpl</TT><A NAME="2568"></A>). If omitted, the value -is set to the same as the <TT>description</TT><A NAME="2571"></A> key. +description (as passed to <TT>\glsdisplay</TT><A NAME="2919"></A> and <TT>\glsdisplayfirst</TT><A NAME="2922"></A> +by <TT>\glspl</TT><A NAME="2925"></A>, <TT>\Glspl</TT><A NAME="2928"></A> and <TT>\GLSpl</TT><A NAME="2931"></A>). If omitted, the value +is set to the same as the <TT>description</TT><A NAME="2934"></A> key. <P> </DD> -<DT><STRONG><TT>text</TT><A NAME="2574"></A></STRONG></DT> +<DT><STRONG><TT>text</TT><A NAME="2937"></A></STRONG></DT> <DD>How this entry will appear in the document text -when using <TT>\gls</TT><A NAME="2577"></A> (or one of its uppercase variants). If this -field is omitted, the value of the <TT>name</TT><A NAME="2580"></A> key is used. +when using <TT>\gls</TT><A NAME="2940"></A> (or one of its uppercase variants). If this +field is omitted, the value of the <TT>name</TT><A NAME="2943"></A> key is used. <P> </DD> -<DT><STRONG><TT>first</TT><A NAME="2583"></A></STRONG></DT> +<DT><STRONG><TT>first</TT><A NAME="2946"></A></STRONG></DT> <DD>How the entry will appear in the document text -the first time it is used with <TT>\gls</TT><A NAME="2586"></A> (or one of its uppercase -variants). If this field is omitted, the value of the <TT>text</TT><A NAME="2589"></A> +the first time it is used with <TT>\gls</TT><A NAME="2949"></A> (or one of its uppercase +variants). If this field is omitted, the value of the <TT>text</TT><A NAME="2952"></A> key is used. <P> </DD> -<DT><STRONG><TT>plural</TT><A NAME="2592"></A></STRONG></DT> +<DT><STRONG><TT>plural</TT><A NAME="2955"></A></STRONG></DT> <DD>How the entry will appear in the document text -when using <TT>\glspl</TT><A NAME="2595"></A> (or one of its uppercase variants). -If this field is omitted, the value is obtained by appending an -"s" to the value of the <TT>text</TT><A NAME="2598"></A> field. +when using <TT>\glspl</TT><A NAME="2958"></A> (or one of its uppercase variants). +If this field is omitted, the value is obtained by appending +<TT>\glspluralsuffix</TT><A NAME="2961"></A> to the value of the <TT>text</TT><A NAME="2964"></A> field. <P> </DD> -<DT><STRONG><TT>firstplural</TT><A NAME="2601"></A></STRONG></DT> -<DD>How the entry will appear in the document -text the first time it is used with <TT>\glspl</TT><A NAME="2604"></A> (or one of -its uppercase variants). If this field is omitted, the value is -obtained by appending an "s" to the value of the <TT>first</TT><A NAME="2607"></A> -field. +<DT><STRONG><TT>firstplural</TT><A NAME="2967"></A></STRONG></DT> +<DD>How the entry will appear in the +document text the first time it is used with <TT>\glspl</TT><A NAME="2970"></A> (or one of its +uppercase variants). If this field is omitted, the value is obtained +from the <TT>plural</TT><A NAME="2973"></A> key, if the <TT>first</TT><A NAME="2976"></A> key is omitted, +or by appending <TT>\glspluralsuffix</TT><A NAME="2979"></A> to the value of the +<TT>first</TT><A NAME="2982"></A> field, if the <TT>first</TT><A NAME="2985"></A> field is present. +<B>Note:</B> prior to version 1.13, the default value of +<TT>firstplural</TT><A NAME="2988"></A> was always taken by appending "s" to the +<TT>first</TT><A NAME="2991"></A> key, which meant that you had to specify both +<TT>plural</TT><A NAME="2994"></A> and <TT>firstplural</TT><A NAME="2997"></A>, even if you hadn't +used the <TT>first</TT><A NAME="3000"></A> key. <P> </DD> -<DT><STRONG><TT>symbol</TT><A NAME="2610"></A></STRONG></DT> +<DT><STRONG><TT>symbol</TT><A NAME="3003"></A></STRONG></DT> <DD>This field is provided to allow the user to specify an associated symbol, but most glossary styles ignore this value. If omitted, the value is set to <TT>\relax</TT>. <P> </DD> -<DT><STRONG><TT>symbolplural</TT><A NAME="2613"></A></STRONG></DT> +<DT><STRONG><TT>symbolplural</TT><A NAME="3006"></A></STRONG></DT> <DD>This is the plural form of the -symbol (as passed to <TT>\glsdisplay</TT><A NAME="2616"></A> and <TT>\glsdisplayfirst</TT><A NAME="2619"></A> -by <TT>\glspl</TT><A NAME="2622"></A>, <TT>\Glspl</TT><A NAME="2625"></A> and <TT>\GLSpl</TT><A NAME="2628"></A>). If omitted, the value -is set to the same as the <TT>symbol</TT><A NAME="2631"></A> key. +symbol (as passed to <TT>\glsdisplay</TT><A NAME="3009"></A> and <TT>\glsdisplayfirst</TT><A NAME="3012"></A> +by <TT>\glspl</TT><A NAME="3015"></A>, <TT>\Glspl</TT><A NAME="3018"></A> and <TT>\GLSpl</TT><A NAME="3021"></A>). If omitted, the value +is set to the same as the <TT>symbol</TT><A NAME="3024"></A> key. <P> </DD> -<DT><STRONG><TT>sort</TT><A NAME="2634"></A></STRONG></DT> -<DD>This value indicates how <TT>makeindex</TT><A NAME="2637"></A> +<DT><STRONG><TT>sort</TT><A NAME="3027"></A></STRONG></DT> +<DD>This value indicates how <TT>makeindex</TT><A NAME="3030"></A> should sort this entry. If omitted, the value is given by the -<TT>name</TT><A NAME="2640"></A> field. This value is equivalent to -<TT>makeindex</TT><A NAME="2643"></A>'s "actual" character (which is usually the +<TT>name</TT><A NAME="3033"></A> field. This value is equivalent to +<TT>makeindex</TT><A NAME="3036"></A>'s "actual" character (which is usually the at-sign @ although the <TT>glossaries</TT> package uses a different symbol). <P> </DD> -<DT><STRONG><TT>type</TT><A NAME="2647"></A></STRONG></DT> +<DT><STRONG><TT>type</TT><A NAME="3040"></A></STRONG></DT> <DD>This is the glossary type to which this entry -belongs. If omitted, the default glossary is assumed -(<TT>type=main</TT>). The list of acronyms type is given by -<TT>\acronymtype</TT><A NAME="2650"></A> which will either be <TT>main</TT> or -<TT>acronym</TT>, depending on whether the <TT>acronym</TT><A NAME="2658"></A> package +belongs. If omitted, the default glossary is assumed. +The list of acronyms type is given by +<TT>\acronymtype</TT><A NAME="3043"></A> which will either be <TT>main</TT> or +<TT>acronym</TT>, depending on whether the <TT>acronym</TT><A NAME="3051"></A> package option was used. </DD> </DL> Note that if the key starts with an accented letter, you must group the accented letter, otherwise it will cause a -problem for <TT>\Gls</TT> and <TT>\Glspl</TT>. For example: +problem for commands like <TT>\Gls</TT> and <TT>\Glspl</TT>. For example: <PRE> \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}} @@ -1043,10 +1192,73 @@ name={\oe sophagus}, description={canal from mouth to stomach}} </PRE> but don't do <code>\oe{}sophagus</code> as it will confuse -<TT>\makefirstuc</TT><A NAME="2662"></A> (described +<TT>\makefirstuc</TT><A NAME="3055"></A> (described <A HREF="glossaries-manual.html#sec:mfirstuc">later</A>) and will produce oeSophagus instead of -OEsophagus. +OEsophagus. + +<P> +<A HREF="glossaries-manual.html#top">Top</A> + +<P> + +<H3><A NAME="SECTION00042100000000000000"> +Plurals</A> +</H3> +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 <TT>\glspluralsuffix</TT> to +the singular form. This command defaults to <TT>s</TT>. For example: +<PRE> +\newglossaryentry{cow}{name=cow,description={a fully grown +female of any bovine animal}} +</PRE> +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: +<PRE> +\newglossaryentry{cow}{name=cow,plural=kine, +description={a fully grown female of any bovine animal}} +</PRE> + +<P> +If you are writing in a language that supports +multiple plurals (for a given term) then use the <TT>plural</TT><A NAME="3061"></A> key +for one of them (typically the one you are most likely to use) and +for the others you will need to explicitly write the plural form using +<TT>\glslink</TT> rather than using <TT>\glspl</TT>. Returning to the cow +example above, suppose you will mostly be using "cows" as the +plural, but occasionally you want to use "kine" as the plural, +then define the term as +<PRE> +\newglossaryentry{cow}{name=cow,description={a fully grown +female of any bovine animal (plural cows, archaic plural kine)}} +</PRE> +and use <code>\glspl{cow}</code> to produce "cows" and use +<code>\glslink{cow}{kine}</code> to produce "kine". + +<P> +If you are using a language that usually forms plurals +by appending a different letter, or sequence of letters, you can +redefine <TT>\glspluralsuffix</TT> as required. However, this must be +done <I>before</I> 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 <TT>plural</TT><A NAME="3064"></A> key (and the <TT>firstplural</TT><A NAME="3067"></A> +key where necessary). + +<P> + +<P> +<A HREF="glossaries-manual.html#top">Top</A> + +<P> + +<H3><A NAME="SECTION00042200000000000000"></A> +<A NAME="sec:loadglsentries"></A> +<BR> +Loading Entries From a File +</H3> <P> You can store all your glossary entry definitions in another @@ -1058,9 +1270,67 @@ file, and use: where <I>filename</I> is the name of the file containing all the <TT>\newglossaryentry</TT> commands. The optional argument <I>type</I> is the name of the glossary to which those entries -should belong, for those entries where the <TT>type</TT><A NAME="2665"></A> key has -been omitted. Note that only those entries that have been used +should belong, for those entries where the <TT>type</TT><A NAME="3073"></A> key has +been omitted (or, more specifically, for those entries whose +type has been specified by <TT>\glsdefaulttype</TT>, which is what +<TT>\newglossaryentry</TT> uses by default). For example, suppose I have +a file called <TT>myentries.tex</TT> which contains: +<PRE> +\newglossaryentry{perl}{type=main, +name={Perl}, +description={A scripting language}} + +\newglossaryentry{tex}{name={\TeX}, +description={A typesetting language}} + +\newglossaryentry{html}{type=\glsdefaulttype, +name={html}, +description={A mark up language}} +</PRE> +and suppose in my document preamble I use the command: +<PRE> +\loadglsentries[languages]{myentries} +</PRE> +then this will add the entries <TT>tex</TT> and <TT>html</TT> +to the glossary whose type is given by <TT>languages</TT>, but +the entry <TT>perl</TT> will be added to the main glossary, since +it explicitly sets the type to <TT>main</TT>. + +<P> +<B>Note:</B> if you +use <TT>\newacronym</TT> (see <A HREF="glossaries-manual.html#sec:acronyms">later</A>) +the type is set as <code>type=\acronymtype</code> +unless you explicitly override it. For example, if my file +<TT>myacronyms.tex</TT> contains: +<PRE> +\newacronym{aca}{aca}{a contrived acronym} +</PRE> +then (supposing I have defined a new glossary type called +<TT>altacronym</TT>) +<PRE> +\loadglsentries[altacronym]{myacronyms} +</PRE> +will add <TT>aca</TT> to the glossary type <TT>acronym</TT>, if the +package option <TT>acronym</TT><A NAME="3081"></A> has been specified, or will add +<TT>aca</TT> to the glossary type <TT>altacronym</TT>, if the +package option <TT>acronym</TT><A NAME="3090"></A> is not specified. In this instance, +it is better to change <TT>myacronyms.tex</TT> to: +<PRE> +\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} +</PRE> +and now +<PRE> +\loadglsentries[altacronym]{myacronyms} +</PRE> +will add <TT>aca</TT> to the glossary type <TT>altacronym</TT>, +regardless of whether or not the package option <TT>acronym</TT><A NAME="3099"></A> is +used. + +<P> +Note that only those entries that have been used in the text will appear in the relevant glossaries. +Note also that <TT>\loadglsentries</TT> may only be used in the +preamble. <P> <A HREF="glossaries-manual.html#top">Top</A> @@ -1073,13 +1343,13 @@ Number lists </H2> <P> -Each entry in the glossary has an associated <I>number list</I><A NAME="2671"></A>. +Each entry in the glossary has an associated <I>number list</I><A NAME="3106"></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="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A> and <A HREF="glossaries-manual.html#sec:glsadd">Adding an entry to the glossary without generating text</A>). The number list can be suppressed using -the <TT>nonumberlist</TT><A NAME="2678"></A> package option, or an alternative counter -can be set as the default using the <TT>counter</TT><A NAME="2687"></A> package option. +the <TT>nonumberlist</TT><A NAME="3113"></A> package option, or an alternative counter +can be set as the default using the <TT>counter</TT><A NAME="3122"></A> package option. <P> <A HREF="glossaries-manual.html#top">Top</A> @@ -1093,16 +1363,16 @@ Links to Glossary Entries <P> Once you have defined a glossary entry using -<TT>\newglossaryentry</TT><A NAME="2694"></A>, you can refer to that entry in the +<TT>\newglossaryentry</TT><A NAME="3129"></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 -<I>link text</I><A NAME="2697"></A> (even if there are no hyperlinks). +<I>link text</I><A NAME="3132"></A> (even if there are no hyperlinks). <P> -The way the link text<A NAME="2698"></A> is displayed +The way the link text<A NAME="3133"></A> is displayed depends on <TT>\glstextformat{</TT><EM>text</EM><TT>}</TT>. -For example, to make all link text<A NAME="2699"></A> appear in a sans-serif +For example, to make all link text<A NAME="3134"></A> appear in a sans-serif font, do: <PRE> \renewcommand*{\glstextformat}[1]{\textsf{#1}} @@ -1114,19 +1384,19 @@ The command: <BR><TT>\glslink[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> <BR> <BR> -will place <I>text</I> in the document at that point and add -a line into the associated glossary file for the glossary entry -given by <I>label</I>. If hyperlinks are supported, <I>text</I> -will be a hyperlink to the relevant line in the glossary. The -optional argument <I>options</I> must be a <I>key</I>=<I>value</I> -list which can take any of the following keys: +will place <TT>\glstextformat{</TT><EM>text</EM><TT>}</TT> in the document at that point +and add a line into the associated glossary file for the glossary entry +given by <I>label</I>. If hyperlinks are supported, <I>text</I> will be +a hyperlink to the relevant line in the glossary. The optional argument +<I>options</I> must be a <I>key</I>=<I>value</I> list which can take +any of the following keys: <P> <DL> -<DT><STRONG><TT>format</TT><A NAME="2701"></A></STRONG></DT> +<DT><STRONG><TT>format</TT><A NAME="3136"></A></STRONG></DT> <DD>This specifies how to format the associated number for this entry in the glossary. This value is -equivalent to the <TT>makeindex</TT><A NAME="2704"></A> encap value, and (as with +equivalent to the <TT>makeindex</TT><A NAME="3139"></A> encap value, and (as with <TT>\index</TT>) the value needs to be the name of a command <I>without</I> the initial backslash. As with <TT>\index</TT>, the characters <code>(</code> and <code>)</code> can also be used to specify the beginning and ending of a @@ -1144,7 +1414,7 @@ and use that command. <P> If you are using hyperlinks and you want to change the font of the -hyperlink, don't use <TT>\hyperpage</TT> (provided by the <TT>hyperref</TT><A NAME="2707"></A> +hyperlink, don't use <TT>\hyperpage</TT> (provided by the <TT>hyperref</TT><A NAME="3142"></A> package) as the numbers may not refer to a page number. Instead, the <TT>glossaries</TT> package provides the following number formats: @@ -1203,19 +1473,19 @@ command called, say, <TT>\hyperbsf</TT>: <PRE> \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} </PRE> -and then use <TT>hyperbsf</TT> as the value for the <TT>format</TT><A NAME="2711"></A> +and then use <TT>hyperbsf</TT> as the value for the <TT>format</TT><A NAME="3146"></A> key. <P> </DD> -<DT><STRONG><TT>counter</TT><A NAME="2714"></A></STRONG></DT> +<DT><STRONG><TT>counter</TT><A NAME="3149"></A></STRONG></DT> <DD>This specifies which counter to use for the associated number for this glossary entry. (See also <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.) <P> </DD> -<DT><STRONG><TT>hyper</TT><A NAME="2717"></A></STRONG></DT> +<DT><STRONG><TT>hyper</TT><A NAME="3152"></A></STRONG></DT> <DD>This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting <TT>hyper=true</TT> will have no @@ -1240,10 +1510,17 @@ The command: <BR><TT>\gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is the same as <TT>\glslink</TT>, except that the link text<A NAME="2719"></A> -is determined from the values of the <TT>text</TT><A NAME="2721"></A> and -<TT>first</TT><A NAME="2724"></A> keys supplied when the entry was defined using -<TT>\newglossaryentry</TT><A NAME="2727"></A>. There are two uppercase variants: +is the same as <TT>\glslink</TT>, except that the link text<A NAME="3154"></A> +is determined from the values of the <TT>text</TT><A NAME="3156"></A> and +<TT>first</TT><A NAME="3159"></A> keys supplied when the entry was defined using +<TT>\newglossaryentry</TT><A NAME="3162"></A>. If the entry has been marked as having +been used, the value of the <TT>text</TT><A NAME="3165"></A> key will be used, otherwise +the value of the <TT>first</TT><A NAME="3168"></A> key will be used. +On completion, <TT>\gls</TT> will mark the entry given by <I>label</I> as +used. + +<P> +There are two uppercase variants: <BR> <BR> <TT>\Gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> @@ -1261,10 +1538,14 @@ uppercase, respectively. <P> The final optional argument <I>insert</I>, allows you to insert some additional text into the link text. By default, this will -append <I>insert</I> at the end of the link text. The first optional -argument <I>options</I> is the same as the optional argument to -<TT>\glslink</TT><A NAME="2730"></A>. As with <TT>\glslink</TT>, these commands also have -a starred version that disable the hyperlink. +append <I>insert</I> at the end of the link text, but this +can be changed (see +<A HREF="glossaries-manual.html#sec:glsdisplay">later</A>). + +<P> +The first optional argument <I>options</I> is the same as the optional +argument to <TT>\glslink</TT><A NAME="3171"></A>. As with <TT>\glslink</TT>, these commands also +have a starred version that disable the hyperlink. <P> There are also analogous plural forms: @@ -1279,8 +1560,8 @@ There are also analogous plural forms: <TT>\GLSpl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -These determine the link text from the <TT>plural</TT><A NAME="2733"></A> and -<TT>firstplural</TT><A NAME="2736"></A> keys supplied when the entry was first +These determine the link text from the <TT>plural</TT><A NAME="3174"></A> and +<TT>firstplural</TT><A NAME="3177"></A> keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink. @@ -1290,9 +1571,10 @@ The command: <BR><TT>\glstext[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2739"></A> except that it always uses the value -of the <TT>text</TT><A NAME="2742"></A> key and does not mark the entry as -having been used. +is similar to <TT>\gls</TT><A NAME="3180"></A> except that it always uses the value +of the <TT>text</TT><A NAME="3183"></A> key and does not mark the entry as +having been used. Unlike <TT>\gls</TT>, the inserted text <I>insert</I> +is always appended to the link text. <P> There are also analogous commands: @@ -1313,9 +1595,10 @@ The command: <BR><TT>\glsfirst[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2745"></A> except that it always uses the value -of the <TT>first</TT><A NAME="2748"></A> key and does not mark the entry as -having been used. +is similar to <TT>\glstext</TT><A NAME="3186"></A> except that it always uses the value +of the <TT>first</TT><A NAME="3189"></A> key. Again, <I>insert</I> is always appended +to the end of the link text and does not mark the entry as having +been used. <P> There are also analogous commands: @@ -1336,9 +1619,10 @@ The command: <BR><TT>\glsplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2751"></A> except that it always uses the value -of the <TT>plural</TT><A NAME="2754"></A> key and does not mark the entry as -having been used. +is similar to <TT>\glstext</TT><A NAME="3192"></A> except that it always uses the value +of the <TT>plural</TT><A NAME="3195"></A> key. Again, <I>insert</I> is always appended +to the end of the link text and does not mark the entry as having +been used. <P> There are also analogous commands: @@ -1359,8 +1643,9 @@ The command: <BR><TT>\glsfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2757"></A> except that it always uses the value -of the <TT>firstplural</TT><A NAME="2760"></A> key and does not mark the entry as +is similar to <TT>\glstext</TT><A NAME="3198"></A> except that it always uses the value +of the <TT>firstplural</TT><A NAME="3201"></A> key. Again, <I>insert</I> is always +appended to the end of the link text and does not mark the entry as having been used. <P> @@ -1382,12 +1667,13 @@ The command: <BR><TT>\glsname[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2763"></A> except that it always uses the value -of the <TT>name</TT><A NAME="2766"></A> key and does not mark the entry as -having been used. Note: if you want to use this command and the -<TT>name</TT><A NAME="2769"></A> key contains commands, you will have to disable the +is similar to <TT>\glstext</TT><A NAME="3204"></A> except that it always uses the value of the +<TT>name</TT><A NAME="3207"></A> key. Again, <I>insert</I> 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 +<TT>name</TT><A NAME="3210"></A> key contains commands, you will have to disable the <A HREF="glossaries-manual.html#sanitize">sanitization</A> -of the <TT>name</TT><A NAME="2772"></A> key and protect fragile commands. +of the <TT>name</TT><A NAME="3213"></A> key and protect fragile commands. <P> There are also analogous commands: @@ -1408,12 +1694,13 @@ The command: <BR><TT>\glssymbol[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2775"></A> except that it always uses the value -of the <TT>symbol</TT><A NAME="2778"></A> key and does not mark the entry as -having been used. Note: if you want to use this command and the -<TT>symbol</TT><A NAME="2781"></A> key contains commands, you will have to disable the +is similar to <TT>\glstext</TT><A NAME="3216"></A> except that it always uses the value of the +<TT>symbol</TT><A NAME="3219"></A> key. Again, <I>insert</I> 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 +<TT>symbol</TT><A NAME="3222"></A> key contains commands, you will have to disable the <A HREF="glossaries-manual.html#sanitize">sanitization</A> -of the <TT>symbol</TT><A NAME="2784"></A> key and protect fragile commands. +of the <TT>symbol</TT><A NAME="3225"></A> key and protect fragile commands. <P> There are also analogous commands: @@ -1434,12 +1721,14 @@ The command: <BR><TT>\glsdesc[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> <BR> <BR> -is similar to <TT>\gls</TT><A NAME="2787"></A> except that it always uses the value -of the <TT>description</TT><A NAME="2790"></A> key and does not mark the entry as -having been used. Note: if you want to use this command and the -<TT>description</TT><A NAME="2793"></A> key contains commands, you will have to disable the +is similar to <TT>\glstext</TT><A NAME="3228"></A> except that it always uses the value +of the <TT>description</TT><A NAME="3231"></A> key. Again, <I>insert</I> 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 <TT>description</TT><A NAME="3234"></A> key contains commands, you will +have to disable the <A HREF="glossaries-manual.html#sanitize">sanitization</A> -of the <TT>description</TT><A NAME="2796"></A> key and protect fragile commands. +of the <TT>description</TT><A NAME="3237"></A> key and protect fragile commands. <P> There are also analogous commands: @@ -1468,18 +1757,18 @@ Changing the format of the link text </H3> <P> -The format of the link text<A NAME="2801"></A> for <TT>\gls</TT><A NAME="2803"></A>, <TT>\glspl</TT><A NAME="2806"></A> +The format of the link text<A NAME="3242"></A> for <TT>\gls</TT><A NAME="3244"></A>, <TT>\glspl</TT><A NAME="3247"></A> and their uppercase variants is governed by two commands: <TT>\glsdisplayfirst</TT>, which is used the first time a glossary entry is used in the text and <TT>\glsdisplay</TT>, which is used subsequently. Both commands take four arguments: the first is either the singular or -plural form given by the <TT>text</TT><A NAME="2809"></A>, <TT>plural</TT><A NAME="2812"></A>, -<TT>first</TT><A NAME="2815"></A> or <TT>firstplural</TT><A NAME="2818"></A> keys (used when the term was +plural form given by the <TT>text</TT><A NAME="3250"></A>, <TT>plural</TT><A NAME="3253"></A>, +<TT>first</TT><A NAME="3256"></A> or <TT>firstplural</TT><A NAME="3259"></A> keys (used when the term was defined) depending on context; the second argument is the term's -description (as supplied by the <TT>description</TT><A NAME="2821"></A> key); the third +description (as supplied by the <TT>description</TT><A NAME="3262"></A> key); the third argument is the symbol associated with the term (as supplied by the -<TT>symbol</TT><A NAME="2824"></A> key) and the fourth argument is the additional text +<TT>symbol</TT><A NAME="3265"></A> key) and the fourth argument is the additional text supplied in the final optional argument to <TT>\gls</TT> or <TT>\glspl</TT> (or their uppercase variants). The default definitions of <TT>\glsdisplay</TT> and <TT>\glsdisplayfirst</TT> simply @@ -1488,7 +1777,7 @@ The remaining arguments are ignored. <P> For example, suppose you want a glossary of measurements and -units, you can use the <TT>symbol</TT><A NAME="2827"></A> key to store the unit: +units, you can use the <TT>symbol</TT><A NAME="3268"></A> key to store the unit: <PRE> \newglossaryentry{distance}{name=distance, description={The length between two points}, @@ -1508,8 +1797,8 @@ the two points" -- but in this instance it may be better not to use a contraction). <P> -Note also that all of the link text<A NAME="2829"></A> will be formatted according -to <TT>\glstextformat</TT><A NAME="2831"></A> (described earlier). So if you do, say: +Note also that all of the link text<A NAME="3270"></A> will be formatted according +to <TT>\glstextformat</TT><A NAME="3272"></A> (described earlier). So if you do, say: <PRE> \renewcommand{\glstextformat}[1]{\textbf{#1}} \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} @@ -1528,8 +1817,8 @@ of redefining <TT>\glsdisplay</TT> and <TT>\glsdisplayfirst</TT>. <P> Both <TT>\defglsdisplay</TT> and <TT>\defglsdisplayfirst</TT> take two arguments: -the first (which is optional) is the glossary name<A NAME="tex2html6" - HREF="#foot1791"><SUP>3</SUP></A> and the second is how the term should be +the first (which is optional) is the glossary's label<A NAME="tex2html10" + HREF="#foot2102"><SUP>4</SUP></A> and the second is how the term should be displayed when it is invoked using commands <TT>\gls</TT>, <TT>\glspl</TT> and their uppercase variants. This is similar to the way <TT>\glsdisplayfirst</TT> was redefined above. @@ -1547,7 +1836,7 @@ Now suppose you have defined an entry as follows: \newglossaryentry{set}{type=notation, name=set, description={A collection of objects}, -symbol={$S$}, +symbol={$S$} } </PRE> The first time you reference this entry using <TT>\gls</TT> it @@ -1555,10 +1844,10 @@ will be displayed as: "set (denoted <I>S</I>)" (similarly for <TT>\glspl</TT> and the uppercase variants). <P> -Remember that if you use the <TT>symbol</TT><A NAME="2838"></A> key, you need to use a +Remember that if you use the <TT>symbol</TT><A NAME="3279"></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 NAME="2840"></A>, you will have to disable the +in the link text<A NAME="3281"></A>, you will have to disable the <A HREF="glossaries-manual.html#sanitize">sanitization</A> of these keys and protect fragile commands. <P> @@ -1571,10 +1860,10 @@ Enabling and disabling hyperlinks to glossary entries</A> </H3> <P> -If you load the <TT>hyperref</TT><A NAME="2845"></A> or <TT>html</TT><A NAME="2848"></A> packages prior to -loading the <TT>glossaries</TT> package, commands such as <TT>\glslink</TT><A NAME="2852"></A> -and <TT>\gls</TT><A NAME="2855"></A>, described above, will automatically have hyperlinks -to the relevant glossary entry, unless the <TT>hyper</TT><A NAME="2858"></A> +If you load the <TT>hyperref</TT><A NAME="3286"></A> or <TT>html</TT><A NAME="3289"></A> packages prior to +loading the <TT>glossaries</TT> package, commands such as <TT>\glslink</TT><A NAME="3293"></A> +and <TT>\gls</TT><A NAME="3296"></A>, described above, will automatically have hyperlinks +to the relevant glossary entry, unless the <TT>hyper</TT><A NAME="3299"></A> option has been set to <TT>false</TT>. You can disable or enable links using: <BR> <BR><TT>\glsdisablehyper</TT> @@ -1587,8 +1876,8 @@ and <BR> respectively. The effect can be localised by placing the commands within a group. Note that you should only use <TT>\glsenablehyper</TT> -if the commands <TT>\hyperlink</TT><A NAME="2861"></A> and <TT>\hypertarget</TT><A NAME="2864"></A> have been -defined (for example, by the <TT>hyperref</TT><A NAME="2867"></A> package). +if the commands <TT>\hyperlink</TT><A NAME="3302"></A> and <TT>\hypertarget</TT><A NAME="3305"></A> have been +defined (for example, by the <TT>hyperref</TT><A NAME="3308"></A> package). <P> @@ -1605,26 +1894,36 @@ generating any text at that point in the document using: <BR><TT>\glsadd[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}</TT> <BR> <BR> -This is similar to <TT>\glslink</TT><A NAME="2870"></A>, only it doesn't produce -any text (so therefore, there is no <TT>hyper</TT><A NAME="2873"></A> key +This is similar to <TT>\glslink</TT><A NAME="3311"></A>, only it doesn't produce +any text (so therefore, there is no <TT>hyper</TT><A NAME="3314"></A> key available in <I>options</I> but all the other options that can be used with <TT>\glslink</TT> can be passed to <TT>\glsadd</TT>). +For example, to add a page range to the glossary number list for the +entry whose label is given by <TT>set</TT>: +<PRE> +\glsadd[format=(]{set} +Lots of text about sets spanning many pages. +\glsadd[format=)]{set} +</PRE> <P> To add all entries that have been defined, use: <BR> -<BR><TT>\glsaddall[</TT><EM>glossary list</EM><TT>]</TT> +<BR><TT>\glsaddall[</TT><EM>options</EM><TT>]</TT> <BR> <BR> -If there are multiple glossaries, you can specify to add only -those entries which belong to the glossaries listed in -<I>glossary list</I> (which must be a comma separated list of -glossary names). For example: +The optional argument is the same as for <TT>\glsadd</TT>, except +there is also a key <TT>types</TT><A NAME="3317"></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 <TT>\acronymtype</TT>) and a list of +notation (specified by the glossary type <TT>notation</TT>) then you can +do: <PRE> -\glsaddall[notation] +\glsaddall[types={\acronymtype,notation}] </PRE> -will add all the entries that have been defined for the glossary -labelled "notation". + <P> <A HREF="glossaries-manual.html#top">Top</A> @@ -1636,17 +1935,18 @@ Displaying a glossary</A> <P> The command <TT>\printglossaries</TT> will display all the -defined glossaries. Note that no glossaries will appear until -you have either used the Perl script <TT>makeglossaries</TT><A NAME="2879"></A> -or have directly used <TT>makeindex</TT><A NAME="2882"></A> (as described in +glossaries in the order in which they were defined. +Note that no glossaries will appear until +you have either used the Perl script <TT>makeglossaries</TT><A NAME="3323"></A> +or have directly used <TT>makeindex</TT><A NAME="3326"></A> (as described in <A HREF="glossaries-manual.html#sec:makeglossaries">Generating the Associated Glossary Files</A>). If the glossary still does not appear after you re-LaTeX your document, check -the <TT>makeindex</TT><A NAME="2885"></A> log files to see if there is a problem. -Remember that you also need to use the command <TT>\makeglossaries</TT><A NAME="2888"></A> in +the <TT>makeindex</TT><A NAME="3329"></A> log files to see if there is a problem. +Remember that you also need to use the command <TT>\makeglossaries</TT><A NAME="3332"></A> in the preamble to enable the glossaries. <P> -An individual glossary is displayed using: +An individual glossary can be displayed using: <BR> <BR><TT>\printglossary[</TT><EM>options</EM><TT>]</TT> <BR> @@ -1654,7 +1954,7 @@ An individual glossary is displayed using: where <I>options</I> is a <I>key</I>=<I>value</I> list of options. The following keys are available: <DL> -<DT><STRONG><TT>type</TT><A NAME="2891"></A></STRONG></DT> +<DT><STRONG><TT>type</TT><A NAME="3335"></A></STRONG></DT> <DD>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: @@ -1664,24 +1964,24 @@ glossary is assumed. For example, to print the list of acronyms: <P> </DD> -<DT><STRONG><TT>title</TT><A NAME="2894"></A></STRONG></DT> +<DT><STRONG><TT>title</TT><A NAME="3338"></A></STRONG></DT> <DD>This is the glossary's title (overriding the title specified when the glossary was defined). <P> </DD> -<DT><STRONG><TT>toctitle</TT><A NAME="2897"></A></STRONG></DT> +<DT><STRONG><TT>toctitle</TT><A NAME="3341"></A></STRONG></DT> <DD>This is the title -to use for the table of contents (if the <TT>toc</TT><A NAME="2905"></A> package +to use for the table of contents (if the <TT>toc</TT><A NAME="3349"></A> package option has been used). If omitted, the glossary title is used. <P> </DD> -<DT><STRONG><TT>style</TT><A NAME="2909"></A></STRONG></DT> +<DT><STRONG><TT>style</TT><A NAME="3353"></A></STRONG></DT> <DD>This specifies which glossary style to use for this glossary, overriding the effect -of the <TT>style</TT><A NAME="2917"></A> option or <TT>\glossarystyle</TT><A NAME="2921"></A>. +of the <TT>style</TT><A NAME="3361"></A> option or <TT>\glossarystyle</TT><A NAME="3365"></A>. </DD> </DL> @@ -1763,16 +2063,16 @@ A new glossary can be defined using: <BR><TT>\newglossary[</TT><EM>log-ext</EM><TT>]{</TT><EM>name</EM><TT>}{</TT><EM>in-ext</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>title</EM><TT>}[</TT><EM>counter</EM><TT>]</TT> <BR> <BR> -where <I>name</I> is label to assign to this glossary. The arguments +where <I>name</I> is the label to assign to this glossary. The arguments <I>in-ext</I> and <I>out-ext</I> specify the extensions to give to the input and output files for that glossary, <I>title</I> is the default title for this new glossary and the final optional argument <I>counter</I> specifies which counter to use for the associated number -lists<A NAME="2929"></A> (see also <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.) The +lists<A NAME="3373"></A> (see also <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>). The first optional argument specifies the extension for the -<TT>makeindex</TT><A NAME="2931"></A> transcript file (this information is only used by -<TT>makeglossaries</TT><A NAME="2934"></A> which picks up the information from the -auxiliary file.) +<TT>makeindex</TT><A NAME="3375"></A> transcript file (this information is only used by +<TT>makeglossaries</TT><A NAME="3378"></A> which picks up the information from the +auxiliary file). <P> Note that the main (default) glossary is automatically created as: @@ -1780,15 +2080,15 @@ Note that the main (default) glossary is automatically created as: \newglossary{main}{gls}{glo}{\glossaryname} </PRE> so it can be identified by the label <TT>main</TT>. Using the -<TT>acronym</TT><A NAME="2942"></A> package option is equivalent to: +<TT>acronym</TT><A NAME="3386"></A> package option is equivalent to: <PRE> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </PRE> so it can be identified by the label <TT>acronym</TT>. If you are -not sure whether the <TT>acronym</TT><A NAME="2951"></A> option has been used, you +not sure whether the <TT>acronym</TT><A NAME="3395"></A> option has been used, you can identify the list of acronyms by the command <TT>\acronymtype</TT> which is set to -<TT>acronym</TT>, if the <TT>acronym</TT><A NAME="2960"></A> option has been used, +<TT>acronym</TT>, if the <TT>acronym</TT><A NAME="3404"></A> option has been used, otherwise it is set to <TT>main</TT>. <P> <A HREF="glossaries-manual.html#top">Top</A> @@ -1805,13 +2105,13 @@ Acronyms As you may have noticed in <A HREF="glossaries-manual.html#sec:newglosentry">Defining Glossary Entries</A>, when you specify a new entry, you can specify alternate text to use when the term is first used in the document. This provides a useful -means to define acronyms. The <TT>glossaries</TT> package defines -the command: +means to define acronyms. For convenience, the <TT>glossaries</TT> package +defines the command: <BR> <BR><TT>\newacronym[</TT><EM>key-val list</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>abbrv</EM><TT>}{</TT><EM>long</EM><TT>}</TT> <BR> <BR> -This is equivalent to: +By default, this is equivalent to: <P> <TT> <TT>\newglossaryentry</TT></TT> <TT>{</TT><EM>label</EM><TT>}{type=<TT>\acronymtype</TT>, @@ -1824,16 +2124,26 @@ text=</TT> <TT>{</TT><EM>abbrv</EM><TT>}, <BR> first={</TT> <I>long</I><TT> (</TT> <I>abbrv</I><TT>)}, <BR> -plural={</TT> <I>abbrv</I><TT>s}, +plural={</TT> <I>abbrv</I><TT><TT>\glspluralsuffix</TT>}, <BR> -firstplural={</TT> <I>long</I><TT>s (</TT> <I>abbrv</I><TT>s)}, +firstplural={</TT> <I>long</I><TT><TT>\glspluralsuffix\space</TT> +(</TT> <I>abbrv</I><TT><TT>\glspluralsuffix</TT>)}, <BR></TT> <I>key-val list</I><TT>}</TT> <P> As mentioned in the previous section, the command <TT>\acronymtype</TT> is the name of the glossary in which the acronyms should appear. If the -<TT>acronym</TT><A NAME="2973"></A> package option has been used, this will be +<TT>acronym</TT><A NAME="3417"></A> package option has been used, this will be <TT>acronym</TT>, otherwise it will be <TT>main</TT>. The acronyms can then be used in exactly the same way as any other glossary entry. + +<P> +(<B>Note:</B> since <TT>\newacronym</TT> sets <code>type=\acronymtype</code>, +if you want to load a file containing acronym definitions using +<TT>\loadglsentries[</TT><EM>type</EM><TT>]{</TT><EM>filename</EM><TT>}</TT>, the optional argument +<I>type</I> will not have an effect unless you explicitly set the +type as <code>type=\glsdefaulttype</code>. See <A HREF="glossaries-manual.html#sec:loadglsentries">earlier</A> for details.) + +<P> For example, the following defines the acronym IDN: <PRE> \newacronym{idn}{IDN}{identification number} @@ -1852,22 +2162,33 @@ so <code>\gls{idn}</code> will produce "identification number (IDN)" on first use and "IDN" on subsequent uses. <P> -The <TT>glossaries</TT> package has options that change the -definition of <TT>\newacronym</TT><A NAME="2978"></A> for common acronym formats. These -options also change the way the link text is displayed for the -acronyms. - -<P> -Table <A HREF="glossaries-manual.html#tab:acronymsettings">1</A> lists the package options and -how the keys are used to store <I>long</I> (the long form) and -<I>abbrv</I> (the short form). Note that the <TT>smallcaps</TT><A NAME="2986"></A> -option redefines <TT>\acronymfont</TT><A NAME="2990"></A> so that it sets its argument -in small captials otherwise <TT>\acronymfont</TT> simply displays its -argument in the surrounding font. Note also that if none of -the package options <TT>smallcaps</TT><A NAME="2998"></A>, <TT>description</TT><A NAME="3007"></A> -or <TT>footnote</TT><A NAME="3016"></A> are used, <TT>\acronymfont</TT> is not used, so -changing the definition of <TT>\acronymfont</TT> will have no effect -under such circumstances. +This section describes acronyms that have been defined using +<TT>\newacronym</TT>. If you prefer to define all your acronyms using +<TT>\newglossaryentry</TT> explicitly, then you should skip this section +and ignore the package options: <TT>smallcaps</TT><A NAME="3426"></A>, <TT>smaller</TT><A NAME="3435"></A>, +<TT>description</TT><A NAME="3444"></A>, <TT>dua</TT><A NAME="3453"></A>, <TT>footnote</TT><A NAME="3462"></A> and +<TT>shortcuts</TT><A NAME="3471"></A>, as these options change the +definition of <TT>\newacronym</TT><A NAME="3475"></A> for common acronym formats +as well as the way that the link text is displayed (see +<A HREF="glossaries-manual.html#sec:glsdisplay">earlier</A>). +Likewise you should ignore the new commands described in this section, +such as <TT>\acrshort</TT>, as they vary according to the definition of +<TT>\newacronym</TT>. + +<P> +<A HREF="glossaries-manual.html#tab:acronymsettings">Table </A><A HREF="glossaries-manual.html#tab:acronymsettings">2</A> lists the package options and how the +<TT>\newglossaryentry</TT><A NAME="3481"></A> keys are used to store <I>long</I> (the long +form) and <I>abbrv</I> (the short form). Note that the +<TT>smallcaps</TT><A NAME="3489"></A> option redefines <TT>\acronymfont</TT><A NAME="3493"></A> so that it sets +its argument using <TT>\textsc</TT> (so you should use lower case characters +in <I>abbrv</I>) and the <TT>smaller</TT><A NAME="3501"></A> option redefines +<TT>\acronymfont</TT> to use <TT>\smaller</TT><A NAME="tex2html11" + HREF="#foot2130"><SUP>5</SUP></A>, otherwise <TT>\acronymfont</TT> simply +displays its argument in the surrounding font. Note also that if none +of the package options <TT>smallcaps</TT><A NAME="3511"></A>, <TT>smaller</TT><A NAME="3520"></A>, +<TT>dua</TT><A NAME="3529"></A>, <TT>description</TT><A NAME="3538"></A> or <TT>footnote</TT><A NAME="3547"></A> are used, +<TT>\acronymfont</TT> is not used, so changing the definition of +<TT>\acronymfont</TT> will have no effect under such circumstances. <P> <BR><P></P> @@ -1875,48 +2196,54 @@ under such circumstances. <A NAME="tab:acronymsettings"></A> <DIV ALIGN="CENTER"> -<A NAME="1191"></A> +<A NAME="2131"></A> <TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 1:</STRONG> -Package options governing acronyms and how the information -is stored in the glossary keys</CAPTION> +<CAPTION><STRONG>Table 2:</STRONG> +Package options governing <TT>\newacronym</TT> and how the +information is stored in the keys for <TT>\newglossaryentry</TT></CAPTION> <TR><TH ALIGN="LEFT"><B>Package Option </B></TH> -<TD ALIGN="LEFT"><TT>first</TT><A NAME="3020"></A></TD> -<TD ALIGN="LEFT"><TT>text</TT><A NAME="3023"></A></TD> -<TD ALIGN="LEFT"><TT>description</TT><A NAME="3026"></A></TD> -<TD ALIGN="LEFT"><TT>symbol</TT><A NAME="3029"></A></TD> +<TD ALIGN="LEFT"><TT>first</TT><A NAME="3551"></A> key</TD> +<TD ALIGN="LEFT"><TT>text</TT><A NAME="3554"></A> key</TD> +<TD ALIGN="LEFT"><TT>description</TT><A NAME="3557"></A> key</TD> +<TD ALIGN="LEFT"><TT>symbol</TT><A NAME="3560"></A> key</TD> </TR> -<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3037"></A>,<TT>footnote</TT><A NAME="3046"></A></TD> +<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3568"></A>,<TT>footnote</TT><A NAME="3577"></A></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT">user supplied</TD> <TD ALIGN="LEFT"><I>long</I></TD> </TR> -<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3055"></A>,<TT>dua</TT><A NAME="3064"></A></TD> +<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3586"></A>,<TT>dua</TT><A NAME="3595"></A></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT">user supplied</TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> </TR> -<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3073"></A></TD> +<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="3604"></A></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT">user supplied</TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> </TR> -<TR><TD ALIGN="LEFT"><TT>footnote</TT><A NAME="3082"></A></TD> +<TR><TD ALIGN="LEFT"><TT>footnote</TT><A NAME="3613"></A></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"> </TD> </TR> -<TR><TD ALIGN="LEFT"><TT>smallcaps</TT><A NAME="3091"></A></TD> +<TR><TD ALIGN="LEFT"><TT>smallcaps</TT><A NAME="3622"></A></TD> +<TD ALIGN="LEFT"><I>long</I></TD> +<TD ALIGN="LEFT"><I>abbrv</I></TD> +<TD ALIGN="LEFT"><I>long</I></TD> +<TD ALIGN="LEFT"><I>abbrv</I></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>smaller</TT><A NAME="3631"></A></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>abbrv</I></TD> </TR> -<TR><TD ALIGN="LEFT"><TT>dua</TT><A NAME="3100"></A></TD> +<TR><TD ALIGN="LEFT"><TT>dua</TT><A NAME="3640"></A></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>long</I></TD> <TD ALIGN="LEFT"><I>long</I></TD> @@ -1962,16 +2289,17 @@ If the first use uses the plural form, <code>\glspl{dm}</code> will display: diagonal matrices (DMs). <P> -Each of the package options <TT>smallcaps</TT><A NAME="3110"></A>, <TT>footnote</TT><A NAME="3119"></A> -and <TT>description</TT><A NAME="3128"></A> use <TT>\defglsdisplay</TT><A NAME="3132"></A> and -<TT>\defglsdisplayfirst</TT><A NAME="3135"></A> (described <A HREF="glossaries-manual.html#sec:glsdisplay">earlier</A>) +Each of the package options <TT>smallcaps</TT><A NAME="3650"></A>, <TT>smaller</TT><A NAME="3659"></A>, +<TT>footnote</TT><A NAME="3668"></A>, <TT>dua</TT><A NAME="3677"></A> +and <TT>description</TT><A NAME="3686"></A> use <TT>\defglsdisplay</TT><A NAME="3690"></A> and +<TT>\defglsdisplayfirst</TT><A NAME="3693"></A> (described <A HREF="glossaries-manual.html#sec:glsdisplay">earlier</A>) to change the way the link text is displayed. <P> <DL> -<DT><STRONG><TT>description</TT><A NAME="3143"></A>,<TT>footnote</TT><A NAME="3152"></A></STRONG></DT> +<DT><STRONG><TT>description</TT><A NAME="3701"></A>,<TT>footnote</TT><A NAME="3710"></A></STRONG></DT> <DD> -When these two options are used together, the first use displays +When these two package options are used together, the first use displays the entry as: <BR> <BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</EM><TT>}</TT> @@ -1989,32 +2317,32 @@ variants. <P> Note also that when these two package options are used (in the given order), the <TT>glossaries</TT> package additionally implements the -<TT>sanitize</TT><A NAME="3162"></A> option using -<A NAME="3171"></A><A NAME="3178"></A><code>sanitize={description=false,symbol=false}</code>, so +<TT>sanitize</TT><A NAME="3720"></A> option using +<A NAME="3729"></A><A NAME="3736"></A><code>sanitize={description=false,symbol=false}</code>, so remember to protect fragile commands when defining acronyms. <P> </DD> <DT><STRONG>dua</STRONG></DT> <DD> -The <TT>dua</TT><A NAME="3185"></A> package option always displays the expanded -form and so may not be used with <TT>footnote</TT><A NAME="3194"></A> or -<TT>smallcaps</TT><A NAME="3203"></A>. Both first use and subsequent use displays the +The <TT>dua</TT><A NAME="3743"></A> package option always displays the expanded +form and so may not be used with <TT>footnote</TT><A NAME="3752"></A>, <TT>smaller</TT><A NAME="3761"></A> or +<TT>smallcaps</TT><A NAME="3770"></A>. Both first use and subsequent use displays the entry in the form: <BR> <BR><I>long</I><I>insert</I> <BR> <BR> -If the <TT>description</TT><A NAME="3212"></A> option is also used, the <TT>name</TT><A NAME="3216"></A> -key is set to the long form, otherwise the <TT>name</TT><A NAME="3219"></A> key is -set to the short form and the <TT>description</TT><A NAME="3222"></A> key is set to -the long form. +If the <TT>description</TT><A NAME="3779"></A> package option is also used, the +<TT>name</TT><A NAME="3783"></A> key is set to the long form, otherwise the +<TT>name</TT><A NAME="3786"></A> key is set to the short form and the +<TT>description</TT><A NAME="3789"></A> key is set to the long form. <P> </DD> -<DT><STRONG><TT>description</TT><A NAME="3230"></A></STRONG></DT> +<DT><STRONG><TT>description</TT><A NAME="3797"></A></STRONG></DT> <DD> -This option displays the entry on first use as: +This package option displays the entry on first use as: <BR> <BR><I>long</I><I>insert</I> (<TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT>) <BR> @@ -2026,14 +2354,14 @@ while subsequent use displays the entry as: <BR> Note also that if this package option is used, the <TT>glossaries</TT> package additionally implements the option -<A NAME="3240"></A><code>sanitize={symbol=false}</code>, so +<A NAME="3807"></A><code>sanitize={symbol=false}</code>, so remember to protect fragile commands when defining acronyms. <P> </DD> -<DT><STRONG><TT>footnote</TT><A NAME="3247"></A></STRONG></DT> +<DT><STRONG><TT>footnote</TT><A NAME="3814"></A></STRONG></DT> <DD> -This option displays the entry on first use as: +This package option displays the entry on first use as: <BR> <BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</EM><TT>}</TT> <BR> @@ -2045,14 +2373,38 @@ while subsequent use displays the entry as: <P> Note also that if this package option is used, the <TT>glossaries</TT> package additionally implements the option -<A NAME="3257"></A><code>sanitize={description=false}</code>, so +<A NAME="3824"></A><code>sanitize={description=false}</code>, so +remember to protect fragile commands when defining acronyms. + +<P> +</DD> +<DT><STRONG><TT>smallcaps</TT><A NAME="3831"></A></STRONG></DT> +<DD> +If neither the <TT>footnote</TT><A NAME="3840"></A> nor <TT>description</TT><A NAME="3849"></A> options +have been set, this option displays the entry on first use as: +<BR> +<BR><I>long</I><I>insert</I> (<TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT>) +<BR> +<BR> +while subsequent use displays the entry as: +<BR> +<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I> +<BR> +<BR> +where <TT>\acronymfont</TT> is set to <code>\textsc{#1}</code>, so <I>abbrv</I> +should be specified in lower case. + +<P> +Note also that if this package option is used, the <TT>glossaries</TT> +package additionally implements the option +<A NAME="3859"></A><code>sanitize={symbol=false}</code>, so remember to protect fragile commands when defining acronyms. <P> </DD> -<DT><STRONG><TT>smallcaps</TT><A NAME="3264"></A></STRONG></DT> +<DT><STRONG><TT>smaller</TT><A NAME="3866"></A></STRONG></DT> <DD> -If neither the <TT>footnote</TT><A NAME="3273"></A> nor <TT>description</TT><A NAME="3282"></A> options +If neither the <TT>footnote</TT><A NAME="3875"></A> nor <TT>description</TT><A NAME="3884"></A> options have been set, this option displays the entry on first use as: <BR> <BR><I>long</I><I>insert</I> (<TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT>) @@ -2063,21 +2415,21 @@ while subsequent use displays the entry as: <BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I> <BR> <BR> -where <TT>\acronymfont</TT> is set to <TT>\textsc</TT>. +where <TT>\acronymfont</TT> is set to <code>{\smaller #1}</code>. <P> Note also that if this package option is used, the <TT>glossaries</TT> package additionally implements the option -<A NAME="3292"></A><code>sanitize={symbol=false}</code>, so +<A NAME="3894"></A><code>sanitize={symbol=false}</code>, so remember to protect fragile commands when defining acronyms. <P> </DD> <DT><STRONG>None of the above</STRONG></DT> <DD> -If none of the package options <TT>smallcaps</TT><A NAME="3299"></A>, <TT>footnote</TT><A NAME="3308"></A> -or <TT>description</TT><A NAME="3317"></A> are used, then on first use the entry is -displayed as: +If none of the package options <TT>smallcaps</TT><A NAME="3901"></A>, <TT>smaller</TT><A NAME="3910"></A>, +<TT>footnote</TT><A NAME="3919"></A>, <TT>dua</TT><A NAME="3928"></A> or <TT>description</TT><A NAME="3937"></A> are used, +then on first use the entry is displayed as: <BR> <BR><I>long</I> (<I>abbrv</I>)<I>insert</I> <BR> @@ -2093,7 +2445,7 @@ while subsequent use displays the entry as: <P> Recall from <A HREF="glossaries-manual.html#sec:glslink">earlier</A> that you can access the values of individual keys using commands -like <TT>\glstext</TT><A NAME="3321"></A>, so it is possible to use these commands to +like <TT>\glstext</TT><A NAME="3941"></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 @@ -2113,8 +2465,8 @@ as follows: <BR> Print the abbreviated version with a hyperlink (if necessary) to the relevant entry in the glossary. This is usually equivalent to -<TT>\glstext</TT><A NAME="3325"></A> (or its uppercase variants) but may additionally -put the link text within the argument to <TT>\acronymfont</TT><A NAME="3328"></A>. +<TT>\glstext</TT><A NAME="3945"></A> (or its uppercase variants) but may additionally +put the link text within the argument to <TT>\acronymfont</TT><A NAME="3948"></A>. <BR> <BR> <P> @@ -2128,7 +2480,7 @@ put the link text within the argument to <TT>\acronymfont</TT><A NAME="3328" <BR> Print the long version with a hyperlink (if necessary) to the relevant entry in the glossary. This is may be equivalent to -<TT>\glsdesc</TT><A NAME="3331"></A>, <TT>\glssymbol</TT><A NAME="3334"></A> or <TT>\glsfirst</TT><A NAME="3337"></A> (or their uppercase +<TT>\glsdesc</TT><A NAME="3951"></A>, <TT>\glssymbol</TT><A NAME="3954"></A> or <TT>\glsfirst</TT><A NAME="3957"></A> (or their uppercase variants), depending on package options. <BR> <BR> @@ -2146,10 +2498,84 @@ with a hyperlink (if necessary) to the relevant entry in the glossary. <P> -Note that if you change the definition of <TT>\newacronym</TT><A NAME="3340"></A>, you +Note that if you change the definition of <TT>\newacronym</TT><A NAME="3960"></A>, you may additionally need to change the above commands as well as -the changing way the text is displayed using <TT>\defglsdisplay</TT><A NAME="3343"></A> -and <TT>\defglsdisplayfirst</TT><A NAME="3346"></A>. +the changing way the text is displayed using <TT>\defglsdisplay</TT><A NAME="3963"></A> +and <TT>\defglsdisplayfirst</TT><A NAME="3966"></A>. + +<P> +The package option <TT>shortcuts</TT><A NAME="3974"></A> provides the synonyms listed +in <A HREF="glossaries-manual.html#tab:shortcuts">table </A><A HREF="glossaries-manual.html#tab:shortcuts">3</A>. If any of those commands generate +an "undefined control sequence" error message, check that you +have enabled the shortcuts using the <TT>shortcuts</TT><A NAME="3986"></A> package +option. Note that there are no shortcuts for the commands that +produce all upper case text. + +<P> +<BR><P></P> +<DIV ALIGN="CENTER"> + +<A NAME="tab:shortcuts"></A> +<DIV ALIGN="CENTER"> +<A NAME="2143"></A> +<TABLE CELLPADDING=3> +<CAPTION><STRONG>Table 3:</STRONG> +Synonyms provided by the package option <TT>shortcuts</TT><A NAME="3995"></A></CAPTION> +<TR><TH ALIGN="LEFT"><B>Shortcut Command </B></TH> +<TH ALIGN="LEFT"><B>Equivalent Command</B></TH> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acs</TT><A NAME="3999"></A></TD> +<TD ALIGN="LEFT"><TT>\acrshort</TT><A NAME="4002"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acs</TT><A NAME="4005"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrshort</TT><A NAME="4008"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acsp</TT><A NAME="4011"></A></TD> +<TD ALIGN="LEFT"><TT>\acrshortpl</TT><A NAME="4014"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acsp</TT><A NAME="4017"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrshortpl</TT><A NAME="4020"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acl</TT><A NAME="4023"></A></TD> +<TD ALIGN="LEFT"><TT>\acrlong</TT><A NAME="4026"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acl</TT><A NAME="4029"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrlong</TT><A NAME="4032"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\aclp</TT><A NAME="4035"></A></TD> +<TD ALIGN="LEFT"><TT>\acrlongpl</TT><A NAME="4038"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Aclp</TT><A NAME="4041"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrlongpl</TT><A NAME="4044"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acf</TT><A NAME="4047"></A></TD> +<TD ALIGN="LEFT"><TT>\acrfull</TT><A NAME="4050"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acf</TT><A NAME="4053"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrfull</TT><A NAME="4056"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acfp</TT><A NAME="4059"></A></TD> +<TD ALIGN="LEFT"><TT>\acrfullpl</TT><A NAME="4062"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acfp</TT><A NAME="4065"></A></TD> +<TD ALIGN="LEFT"><TT>\Acrfullpl</TT><A NAME="4068"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\ac</TT><A NAME="4071"></A></TD> +<TD ALIGN="LEFT"><TT>\gls</TT><A NAME="4074"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Ac</TT><A NAME="4077"></A></TD> +<TD ALIGN="LEFT"><TT>\Gls</TT><A NAME="4080"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\acp</TT><A NAME="4083"></A></TD> +<TD ALIGN="LEFT"><TT>\glspl</TT><A NAME="4086"></A></TD> +</TR> +<TR><TD ALIGN="LEFT"><TT>\Acp</TT><A NAME="4089"></A></TD> +<TD ALIGN="LEFT"><TT>\Glspl</TT><A NAME="4092"></A></TD> +</TR> +</TABLE> +</DIV> +</DIV> +<BR> <P> @@ -2163,12 +2589,12 @@ Unsetting and resetting entry flags</A> </H2> <P> -When using commands such as <TT>\gls</TT><A NAME="3352"></A> it is possible that you may want -to use the value given by the <TT>first</TT><A NAME="3355"></A> key, even though you have -already used the glossary entry. Conversely, you may want to use the -value given by the <TT>text</TT><A NAME="3358"></A> key, even though you haven't used the -glossary entry. The former can be achieved by one of the following -commands: +When using <TT>\gls</TT><A NAME="4098"></A>, <TT>\glspl</TT><A NAME="4101"></A> and their uppercase variants it is +possible that you may want to use the value given by the +<TT>first</TT><A NAME="4104"></A> key, even though you have already used the glossary +entry. Conversely, you may want to use the value given by the +<TT>text</TT><A NAME="4107"></A> key, even though you haven't used the glossary entry. +The former can be achieved by one of the following commands: <BR> <BR><TT>\glsreset{</TT><EM>label</EM><TT>}</TT> <BR><TT>\glslocalreset{</TT><EM>label</EM><TT>}</TT> @@ -2204,42 +2630,42 @@ The <TT>glossaries</TT> package comes with some pre-defined glossary styles. These are as follows: <DL> <DT><STRONG>list</STRONG></DT> -<DD>The <TT>list</TT><A NAME="3365"></A> style uses the <TT>description</TT> +<DD>The <TT>list</TT><A NAME="4114"></A> style uses the <TT>description</TT> environment. The entry name is placed in the optional argument of the <TT>\item</TT> command (so it will appear in bold by default). The description follows, and then the associated number -list for that entry. +list for that entry. Sub groups are separated using <TT>\indexspace</TT>. <P> </DD> <DT><STRONG>listgroup</STRONG></DT> -<DD>The <TT>listgroup</TT><A NAME="3368"></A> style is like -<TT>list</TT><A NAME="3370"></A> but the glossary groups have headings. +<DD>The <TT>listgroup</TT><A NAME="4117"></A> style is like +<TT>list</TT><A NAME="4119"></A> but the glossary groups have headings. <P> </DD> <DT><STRONG>listhypergroup</STRONG></DT> -<DD>The <TT>listhypergroup</TT><A NAME="3372"></A> style is like -<TT>listgroup</TT><A NAME="3374"></A> but has a set of links to the glossary +<DD>The <TT>listhypergroup</TT><A NAME="4121"></A> style is like +<TT>listgroup</TT><A NAME="4123"></A> but has a set of links to the glossary groups. <P> </DD> <DT><STRONG>altlist</STRONG></DT> -<DD>The <TT>altlist</TT><A NAME="3376"></A> style is like <TT>list</TT><A NAME="3378"></A> +<DD>The <TT>altlist</TT><A NAME="4125"></A> style is like <TT>list</TT><A NAME="4127"></A> but the description is placed on the following line. <P> </DD> <DT><STRONG>altlistgroup</STRONG></DT> -<DD>The <TT>altlistgroup</TT><A NAME="3380"></A> style is like -<TT>altlist</TT><A NAME="3382"></A> but the glossary groups have headings. +<DD>The <TT>altlistgroup</TT><A NAME="4129"></A> style is like +<TT>altlist</TT><A NAME="4131"></A> but the glossary groups have headings. <P> </DD> <DT><STRONG>altlisthypergroup</STRONG></DT> -<DD>The <TT>altlisthypergroup</TT><A NAME="3384"></A> style is like -<TT>altlistgroup</TT><A NAME="3386"></A> but has a set of links to the glossary +<DD>The <TT>altlisthypergroup</TT><A NAME="4133"></A> style is like +<TT>altlistgroup</TT><A NAME="4135"></A> but has a set of links to the glossary groups. <P> @@ -2248,172 +2674,174 @@ groups. <DD>This style uses the <TT>description</TT> environment. Each entry starts with <code>\item[]</code>, followed by the name followed by a dotted line, followed by the description. Note that -this style ignores both the number list<A NAME="3388"></A> and the symbol. The +this style ignores both the number list<A NAME="4137"></A> and the symbol. The length <TT>\glslistdottedwidth</TT> -governs where the description should start.<A NAME="tex2html8" - HREF="#foot1453"><SUP>4</SUP></A> +governs where the description should start.<A NAME="tex2html14" + HREF="#foot1732"><SUP>6</SUP></A> <P> </DD> <DT><STRONG>long</STRONG></DT> -<DD>The <TT>long</TT><A NAME="3390"></A> style uses the <TT>longtable</TT> -environment (defined by the <TT>longtable</TT><A NAME="3393"></A> package). It has two +<DD>The <TT>long</TT><A NAME="4139"></A> style uses the <TT>longtable</TT> +environment (defined by the <TT>longtable</TT><A NAME="4142"></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 NAME="3395"></A>. +column contains the description followed by the number list<A NAME="4144"></A>. +Sub groups are separated with a blank row. <P> </DD> <DT><STRONG>longborder</STRONG></DT> -<DD>The <TT>longborder</TT><A NAME="3397"></A> style is like -<TT>long</TT><A NAME="3399"></A> but has horizontal and vertical lines around it. +<DD>The <TT>longborder</TT><A NAME="4146"></A> style is like +<TT>long</TT><A NAME="4148"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>longheader</STRONG></DT> -<DD>The <TT>longheader</TT><A NAME="3401"></A> style is like -<TT>long</TT><A NAME="3403"></A> but has a header row. +<DD>The <TT>longheader</TT><A NAME="4150"></A> style is like +<TT>long</TT><A NAME="4152"></A> but has a header row. <P> </DD> <DT><STRONG>longheaderborder</STRONG></DT> -<DD>The <TT>longheaderborder</TT><A NAME="3405"></A> style is -like <TT>longheader</TT><A NAME="3407"></A> but has horizontal and vertical lines +<DD>The <TT>longheaderborder</TT><A NAME="4154"></A> style is +like <TT>longheader</TT><A NAME="4156"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>long3col</STRONG></DT> -<DD>The <TT>long3col</TT><A NAME="3409"></A> style is like -<TT>long</TT><A NAME="3411"></A> but has three columns. The first column contains +<DD>The <TT>long3col</TT><A NAME="4158"></A> style is like +<TT>long</TT><A NAME="4160"></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 NAME="3412"></A>. +and the third column contains the number list<A NAME="4161"></A>. <P> </DD> <DT><STRONG>long3colborder</STRONG></DT> -<DD>The <TT>long3colborder</TT><A NAME="3414"></A> style is like -the <TT>long3col</TT><A NAME="3416"></A> style but has horizontal and vertical +<DD>The <TT>long3colborder</TT><A NAME="4163"></A> style is like +the <TT>long3col</TT><A NAME="4165"></A> style but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>long3colheader</STRONG></DT> -<DD>The <TT>long3colheader</TT><A NAME="3418"></A> style is like -<TT>long3col</TT><A NAME="3420"></A> but has a header row. +<DD>The <TT>long3colheader</TT><A NAME="4167"></A> style is like +<TT>long3col</TT><A NAME="4169"></A> but has a header row. <P> </DD> <DT><STRONG>long3colheaderborder</STRONG></DT> -<DD>The <TT>long3colheaderborder</TT><A NAME="3422"></A> style is -like <TT>long3colheader</TT><A NAME="3424"></A> but has horizontal and vertical lines +<DD>The <TT>long3colheaderborder</TT><A NAME="4171"></A> style is +like <TT>long3colheader</TT><A NAME="4173"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>long4col</STRONG></DT> -<DD>The <TT>long4col</TT><A NAME="3426"></A> style is like -<TT>long3col</TT><A NAME="3428"></A> but has an additional column in which the +<DD>The <TT>long4col</TT><A NAME="4175"></A> style is like +<TT>long3col</TT><A NAME="4177"></A> but has an additional column in which the entry's associated symbol appears. <P> </DD> <DT><STRONG>long4colborder</STRONG></DT> -<DD>The <TT>long4colborder</TT><A NAME="3430"></A> style is like -the <TT>long4col</TT><A NAME="3432"></A> style but has horizontal and vertical +<DD>The <TT>long4colborder</TT><A NAME="4179"></A> style is like +the <TT>long4col</TT><A NAME="4181"></A> style but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>long4colheader</STRONG></DT> -<DD>The <TT>long4colheader</TT><A NAME="3434"></A> style is like -<TT>long4col</TT><A NAME="3436"></A> but has a header row. +<DD>The <TT>long4colheader</TT><A NAME="4183"></A> style is like +<TT>long4col</TT><A NAME="4185"></A> but has a header row. <P> </DD> <DT><STRONG>long4colheaderborder</STRONG></DT> -<DD>The <TT>long4colheaderborder</TT><A NAME="3438"></A> style is -like <TT>long4colheader</TT><A NAME="3440"></A> but has horizontal and vertical lines +<DD>The <TT>long4colheaderborder</TT><A NAME="4187"></A> style is +like <TT>long4colheader</TT><A NAME="4189"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>super</STRONG></DT> -<DD>The <TT>super</TT><A NAME="3442"></A> style uses the <TT>supertabular</TT> -environment (defined by the <TT>supertabular</TT><A NAME="3445"></A> package). It has two +<DD>The <TT>super</TT><A NAME="4191"></A> style uses the <TT>supertabular</TT> +environment (defined by the <TT>supertabular</TT><A NAME="4194"></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 NAME="3447"></A>. +column contains the description followed by the number list<A NAME="4196"></A>. +Sub groups are separated with a blank row. <P> </DD> <DT><STRONG>superborder</STRONG></DT> -<DD>The <TT>superborder</TT><A NAME="3449"></A> style is like -<TT>super</TT><A NAME="3451"></A> but has horizontal and vertical lines around it. +<DD>The <TT>superborder</TT><A NAME="4198"></A> style is like +<TT>super</TT><A NAME="4200"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>superheader</STRONG></DT> -<DD>The <TT>superheader</TT><A NAME="3453"></A> style is like -<TT>super</TT><A NAME="3455"></A> but has a header row. +<DD>The <TT>superheader</TT><A NAME="4202"></A> style is like +<TT>super</TT><A NAME="4204"></A> but has a header row. <P> </DD> <DT><STRONG>superheaderborder</STRONG></DT> -<DD>The <TT>superheaderborder</TT><A NAME="3457"></A> style is -like <TT>superheader</TT><A NAME="3459"></A> but has horizontal and vertical lines +<DD>The <TT>superheaderborder</TT><A NAME="4206"></A> style is +like <TT>superheader</TT><A NAME="4208"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>super3col</STRONG></DT> -<DD>The <TT>super3col</TT><A NAME="3461"></A> style is like -<TT>super</TT><A NAME="3463"></A> but has three columns. The first column contains +<DD>The <TT>super3col</TT><A NAME="4210"></A> style is like +<TT>super</TT><A NAME="4212"></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 <A NAME="3464"></A>. +and the third column contains the <A NAME="4213"></A>. <P> </DD> <DT><STRONG>super3colborder</STRONG></DT> -<DD>The <TT>super3colborder</TT><A NAME="3466"></A> style is like -the <TT>super3col</TT><A NAME="3468"></A> style but has horizontal and vertical +<DD>The <TT>super3colborder</TT><A NAME="4215"></A> style is like +the <TT>super3col</TT><A NAME="4217"></A> style but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>super3colheader</STRONG></DT> -<DD>The <TT>super3colheader</TT><A NAME="3470"></A> style is like -<TT>super3col</TT><A NAME="3472"></A> but has a header row. +<DD>The <TT>super3colheader</TT><A NAME="4219"></A> style is like +<TT>super3col</TT><A NAME="4221"></A> but has a header row. <P> </DD> <DT><STRONG>super3colheaderborder</STRONG></DT> -<DD>The <TT>super3colheaderborder</TT><A NAME="3474"></A> style -is like <TT>super3colheader</TT><A NAME="3476"></A> but has horizontal and vertical +<DD>The <TT>super3colheaderborder</TT><A NAME="4223"></A> style +is like <TT>super3colheader</TT><A NAME="4225"></A> but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>super4col</STRONG></DT> -<DD>The <TT>super4col</TT><A NAME="3478"></A> style is like -<TT>super3col</TT><A NAME="3480"></A> but has an additional column in which the +<DD>The <TT>super4col</TT><A NAME="4227"></A> style is like +<TT>super3col</TT><A NAME="4229"></A> but has an additional column in which the entry's associated symbol appears. <P> </DD> <DT><STRONG>super4colborder</STRONG></DT> -<DD>The <TT>super4colborder</TT><A NAME="3482"></A> style is like -the <TT>super4col</TT><A NAME="3484"></A> style but has horizontal and vertical +<DD>The <TT>super4colborder</TT><A NAME="4231"></A> style is like +the <TT>super4col</TT><A NAME="4233"></A> style but has horizontal and vertical lines around it. <P> </DD> <DT><STRONG>super4colheader</STRONG></DT> -<DD>The <TT>super4colheader</TT><A NAME="3486"></A> style is like -<TT>super4col</TT><A NAME="3488"></A> but has a header row. +<DD>The <TT>super4colheader</TT><A NAME="4235"></A> style is like +<TT>super4col</TT><A NAME="4237"></A> but has a header row. <P> </DD> <DT><STRONG>super4colheaderborder</STRONG></DT> -<DD>The <TT>super4colheaderborder</TT><A NAME="3490"></A> style -is like <TT>super4colheader</TT><A NAME="3492"></A> but has horizontal and vertical +<DD>The <TT>super4colheaderborder</TT><A NAME="4239"></A> style +is like <TT>super4colheader</TT><A NAME="4241"></A> but has horizontal and vertical lines around it. <P> @@ -2421,19 +2849,19 @@ lines around it. </DL> <P> -The glossary style can be set using the <TT>style</TT><A NAME="3499"></A> package option -or using the <TT>style</TT><A NAME="3503"></A> key in the optional -argument to <TT>\printglossary</TT><A NAME="3506"></A> or using the command: +The glossary style can be set using the <TT>style</TT><A NAME="4248"></A> package option +or using the <TT>style</TT><A NAME="4252"></A> key in the optional +argument to <TT>\printglossary</TT><A NAME="4255"></A> or using the command: <BR> <BR><TT>\glossarystyle{</TT><EM>style-name</EM><TT>}</TT> <BR> <BR> <P> All the styles except for the three- and four-column styles and the -<TT>listdotted</TT><A NAME="3509"></A> style use the command +<TT>listdotted</TT><A NAME="4258"></A> style use the command <TT>\glspostdescription</TT> 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 +this full stop (or replace it with something else, say a comma) you will need to redefine <TT>\glspostdescription</TT> before the glossary is displayed. <P> @@ -2466,7 +2894,7 @@ 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 <TT>\glossarypreamble</TT>) or the glossary postamble (defined by <TT>\glossarypostamble</TT>.) For example, -the <TT>list</TT><A NAME="3515"></A> style uses the <TT>description</TT> environment, +the <TT>list</TT><A NAME="4264"></A> style uses the <TT>description</TT> environment, so the <TT>theglossary</TT> environment is simply redefined to begin and end the <TT>description</TT> environment. @@ -2479,8 +2907,8 @@ and end the <TT>description</TT> environment. This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as <TT>\glossarypreamble</TT>, which should not be affected by changes in -the glossary style. The <TT>list</TT><A NAME="3520"></A> glossary style redefines -<TT>\glossaryheader</TT> to do nothing, whereas the <TT>longheader</TT><A NAME="3522"></A> +the glossary style. The <TT>list</TT><A NAME="4269"></A> glossary style redefines +<TT>\glossaryheader</TT> to do nothing, whereas the <TT>longheader</TT><A NAME="4271"></A> glossary style redefines <TT>\glossaryheader</TT> to do a header row. <P> @@ -2492,14 +2920,14 @@ glossary style redefines <TT>\glossaryheader</TT> to do a header row. This macro indicates what to do at the start of each logical block within the main body of the glossary. The glossary is sub-divided into twenty-eight logical blocks that are determined by the first character -of the <TT>sort</TT><A NAME="3524"></A> key (or <TT>name</TT><A NAME="3527"></A> key if the <TT>sort</TT><A NAME="3530"></A> +of the <TT>sort</TT><A NAME="4273"></A> key (or <TT>name</TT><A NAME="4276"></A> key if the <TT>sort</TT><A NAME="4279"></A> key is omitted). The sub-divisions are in the following order: symbols, numbers, A, ..., Z. Note that the argument to <TT>\glsgroupheading</TT> is a label <I>not</I> the group title. The group title can be obtained via <TT>\glsgetgrouptitle{</TT><EM>label</EM><TT>}</TT>, and a navigation hypertarget can be created using <TT>\glsnavhypertarget{</TT><EM>label</EM><TT>}</TT>. Most of the predefined glossary styles redefine <TT>\glsgroupheading</TT> to simply -ignore its argument. The <TT>listhypergroup</TT><A NAME="3533"></A> style redefines +ignore its argument. The <TT>listhypergroup</TT><A NAME="4282"></A> style redefines <TT>\glsgroupheading</TT> as follows: <PRE> \renewcommand*{\glsgroupheading}[1]{% @@ -2515,7 +2943,7 @@ See also <TT>\glsgroupskip</TT> below. (Note that command definitions withi <TT>\glsgroupskip</TT> <P> This macro determines what to do after one logical group but before -the header for the next logical group. The <TT>list</TT><A NAME="3535"></A> glossary +the header for the next logical group. The <TT>list</TT><A NAME="4284"></A> glossary style simply redefines <TT>\glsgroupskip</TT> to be <TT>\indexspace</TT>. <P> @@ -2533,15 +2961,15 @@ font for the entry name, regardless of the glossary style used. Note that <I>label</I> is the label used when the glossary entry was defined via either <TT>\newglossaryentry</TT> or <TT>\newacronym</TT>. Each time you use a glossary entry it creates a -link<A NAME="tex2html9" - HREF="#foot1825"><SUP>5</SUP></A> +link<A NAME="tex2html15" + HREF="#foot2144"><SUP>7</SUP></A> using <TT>\@glslink{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> with the label <TT>glo:</TT><I>label</I>. Your new glossary style must therefore redefine <TT>\glossaryentryfield</TT> so that it uses <TT>\@glstarget</TT><code>{</code><TT>glo:</TT><I>label</I><code>}</code><TT>{</TT><EM>text</EM><TT>}</TT> -to ensure the hyperlinks function correctly.<A NAME="tex2html10" - HREF="#foot1826"><SUP>6</SUP></A> For example, the -<TT>list</TT><A NAME="3537"></A> style defines <TT>\glossaryentryfield</TT> as follows: +to ensure the hyperlinks function correctly.<A NAME="tex2html16" + HREF="#foot2145"><SUP>8</SUP></A> For example, the +<TT>list</TT><A NAME="4286"></A> style defines <TT>\glossaryentryfield</TT> as follows: <PRE> \renewcommand*{\glossaryentryfield}[5]{% \item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5} @@ -2560,15 +2988,15 @@ may contain <TT>\delimN</TT> (to delimit individual numbers) and/or multiple occurrences of <TT>\setentrycounter{</TT><EM>counter name</EM><TT>}\glsnumberformat{</TT><EM>number(s)</EM><TT>}</TT>, but note that the entire number list is enclosed within the argument -to <TT>\glossaryentrynumbers</TT><A NAME="3539"></A>. The user can redefine this to change +to <TT>\glossaryentrynumbers</TT><A NAME="4288"></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 <TT>\glossaryentrynumbers</TT> is to provide a means of suppressing the -number list altogether. (In fact, the <TT>nonumberlist</TT><A NAME="3547"></A> option +number list altogether. (In fact, the <TT>nonumberlist</TT><A NAME="4296"></A> option redefines <TT>\glossaryentrynumbers</TT> 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 -<TT>nonumberlist</TT><A NAME="3556"></A> package option. +<TT>nonumberlist</TT><A NAME="4305"></A> package option. </DD> </DL> <P> @@ -2597,7 +3025,7 @@ should do nothing) and suppose you don't want anything to appear immediately after <code>\begin{theglossary}</code> (so <TT>\glossaryheader</TT> 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 NAME="3564"></A> should appear within square brackets +last of all the number list<A NAME="4313"></A> should appear within square brackets at the end. Then you can create this new glossary style, called, say, <TT>mylist</TT>, as follows: <PRE> @@ -2635,7 +3063,7 @@ If you want to define a new style that is a slightly modified version of an existing style, you can use <TT>\glossarystyle</TT> within the second argument of <TT>\newglossarystyle</TT> followed by whatever alterations you require. For example, suppose you want -a style like the <TT>list</TT><A NAME="3569"></A> style but you don't want the extra +a style like the <TT>list</TT><A NAME="4318"></A> style but you don't want the extra vertical space created by <TT>\indexspace</TT> between groups, then you can create a new glossary style called, say, <TT>mylist</TT> as follows: @@ -2659,7 +3087,7 @@ Mfirstuc Package <P> The <TT>glossaries</TT> package is supplied with the package -<TT>mfirstuc</TT><A NAME="3575"></A> which provides the command: +<TT>mfirstuc</TT><A NAME="4324"></A> which provides the command: <BR> <BR> <TT>\makefirstuc{</TT><EM>stuff</EM><TT>}</TT> @@ -2676,7 +3104,7 @@ object in the group is converted to uppercase. Examples: <P> </LI> <LI><code>\makefirstuc{\emph{abc}}</code> produces <I>Abc</I> -(<TT>\MakeUppercase</TT><A NAME="3578"></A> has been applied to the letter "a" rather +(<TT>\MakeUppercase</TT><A NAME="4327"></A> has been applied to the letter "a" rather than <TT>\emph</TT>.) <P> @@ -2699,6 +3127,34 @@ the empty group following <TT>\ae</TT> is considered to be the argument of <TT>\ae</TT> which is in fact not the case. <P> +Note also that +<PRE> +\newcommand{\abc}{abc} +\makefirstuc{\abc} +</PRE> +produces: ABC. This is because the first object in the argument of +<TT>\makefirstuc</TT> is <TT>\abc</TT>, so it does <code>\MakeUppercase{\abc}</code>. +Whereas: +<PRE> +\newcommand{\abc}{abc} +\expandafter\makefirstuc\expandafter{\abc} +</PRE> +produces: Abc. There is a short cut command which will do this: +<BR> +<BR> +<TT>\xmakefirstuc{</TT><EM>stuff</EM><TT>}</TT> +<BR> +<BR> +This is equivalent to <TT>\expandafter\makefirstuc\expandafter{</TT><EM>stuff</EM><TT>}</TT>. So +<PRE> +\newcommand{\abc}{abc} +\xmakefirstuc{\abc} +</PRE> +produces: Abc. + +<P> + +<P> <A HREF="glossaries-manual.html#top">Top</A> <P> @@ -2709,652 +3165,791 @@ of <TT>\ae</TT> which is in fact not the case. <H2><A NAME="SECTION00060000000000000000"> Index</A> </H2><DL COMPACT> +<DT><STRONG><TT>\Ac</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4071">Acronyms</A> + | <A HREF="glossaries-manual.html#4077">Acronyms</A> +<DT><STRONG><TT>\Acf</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4047">Acronyms</A> + | <A HREF="glossaries-manual.html#4053">Acronyms</A> +<DT><STRONG><TT>\Acfp</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4059">Acronyms</A> + | <A HREF="glossaries-manual.html#4065">Acronyms</A> +<DT><STRONG><TT>\Acl</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4023">Acronyms</A> + | <A HREF="glossaries-manual.html#4029">Acronyms</A> +<DT><STRONG><TT>\Aclp</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4035">Acronyms</A> + | <A HREF="glossaries-manual.html#4041">Acronyms</A> +<DT><STRONG><TT>\Acp</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4083">Acronyms</A> + | <A HREF="glossaries-manual.html#4089">Acronyms</A> +<DT><STRONG><TT>\Acrfull</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4050">Acronyms</A> + | <A HREF="glossaries-manual.html#4056">Acronyms</A> +<DT><STRONG><TT>\Acrfullpl</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4062">Acronyms</A> + | <A HREF="glossaries-manual.html#4068">Acronyms</A> +<DT><STRONG><TT>\Acrlong</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4026">Acronyms</A> + | <A HREF="glossaries-manual.html#4032">Acronyms</A> +<DT><STRONG><TT>\Acrlongpl</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4038">Acronyms</A> + | <A HREF="glossaries-manual.html#4044">Acronyms</A> <DT><STRONG><TT>\acronymfont</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2990">Acronyms</A> - | <A HREF="glossaries-manual.html#3328">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3493">Acronyms</A> + | <A HREF="glossaries-manual.html#3948">Acronyms</A> +<DT><STRONG><TT>\acronymname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2237">Multi-Lingual Support</A> <DT><STRONG><TT>\acronymtype</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2052">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2321">Package Options</A> - | <A HREF="glossaries-manual.html#2650">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2429">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2698">Package Options</A> + | <A HREF="glossaries-manual.html#3043">Defining Glossary Entries</A> +<DT><STRONG><TT>\Acrshort</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4002">Acronyms</A> + | <A HREF="glossaries-manual.html#4008">Acronyms</A> +<DT><STRONG><TT>\Acrshortpl</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4014">Acronyms</A> + | <A HREF="glossaries-manual.html#4020">Acronyms</A> +<DT><STRONG><TT>\Acs</TT></STRONG> +<DD><A HREF="glossaries-manual.html#3999">Acronyms</A> + | <A HREF="glossaries-manual.html#4005">Acronyms</A> +<DT><STRONG><TT>\Acsp</TT></STRONG> +<DD><A HREF="glossaries-manual.html#4011">Acronyms</A> + | <A HREF="glossaries-manual.html#4017">Acronyms</A> <DT><STRONG><TT>babel</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1877">Introduction</A> - | <A HREF="glossaries-manual.html#2442">Package Options</A> - | <A HREF="glossaries-manual.html#2454">Package Options</A> +<DD><A HREF="glossaries-manual.html#2203">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2207">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2222">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2267">Multi-Lingual Support</A> <DT><STRONG><TT>\defglsdisplay</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3132">Acronyms</A> - | <A HREF="glossaries-manual.html#3343">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3690">Acronyms</A> + | <A HREF="glossaries-manual.html#3963">Acronyms</A> <DT><STRONG><TT>\defglsdisplayfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3135">Acronyms</A> - | <A HREF="glossaries-manual.html#3346">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3693">Acronyms</A> + | <A HREF="glossaries-manual.html#3966">Acronyms</A> +<DT><STRONG><TT>\descriptionname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2252">Multi-Lingual Support</A> <DT><STRONG><TT>\emph</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2110">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2487">A Quick Guide For</A> +<DT><STRONG><TT>\entryname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2249">Multi-Lingual Support</A> <DT><STRONG>file types</STRONG> <DD><DL COMPACT> <DT><STRONG>.alg</STRONG> -<DD><A HREF="glossaries-manual.html#1938">Generating the associated glossary</A> +<DD><A HREF="glossaries-manual.html#2314">Generating the associated glossary</A> <DT><STRONG>.glg</STRONG> -<DD><A HREF="glossaries-manual.html#1936">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1998">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2312">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2375">A Quick Guide For</A> <DT><STRONG>.glo</STRONG> -<DD><A HREF="glossaries-manual.html#2518">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2881">Defining Glossary Entries</A> <DT><STRONG>.gls</STRONG> -<DD><A HREF="glossaries-manual.html#2520">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2883">Defining Glossary Entries</A> <DT><STRONG>.ist</STRONG> -<DD><A HREF="glossaries-manual.html#1910">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#2534">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2539">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2286">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2897">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2902">Defining Glossary Entries</A> <DT><STRONG>.nlg</STRONG> -<DD><A HREF="glossaries-manual.html#1996">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2373">A Quick Guide For</A> </DL> +<DT><STRONG><TT>german</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2219">Multi-Lingual Support</A> <DT><STRONG><TT>glossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1873">Introduction</A> +<DD><A HREF="glossaries-manual.html#2194">Introduction</A> <DT><STRONG>glossary styles</STRONG> <DD><DL COMPACT> <DT><STRONG>altlist</STRONG> -<DD><A HREF="glossaries-manual.html#3376">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3382">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4125">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4131">Glossary Styles</A> <DT><STRONG>altlistgroup</STRONG> -<DD><A HREF="glossaries-manual.html#3380">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3386">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4129">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4135">Glossary Styles</A> <DT><STRONG>altlisthypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#3384">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4133">Glossary Styles</A> <DT><STRONG>list</STRONG> -<DD><A HREF="glossaries-manual.html#3365">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3370">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3378">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3515">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3520">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3535">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3537">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3569">Example: creating a new</A> +<DD><A HREF="glossaries-manual.html#4114">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4119">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4127">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4264">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4269">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4284">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4286">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4318">Example: creating a new</A> <DT><STRONG>listdotted</STRONG> -<DD><A HREF="glossaries-manual.html#3509">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4258">Glossary Styles</A> <DT><STRONG>listgroup</STRONG> -<DD><A HREF="glossaries-manual.html#3368">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3374">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4117">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4123">Glossary Styles</A> <DT><STRONG>listhypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#3372">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3533">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#4121">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4282">Defining your own glossary</A> <DT><STRONG>long</STRONG> -<DD><A HREF="glossaries-manual.html#3390">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3399">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3403">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3411">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4139">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4148">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4152">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4160">Glossary Styles</A> <DT><STRONG>long3col</STRONG> -<DD><A HREF="glossaries-manual.html#3409">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3416">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3420">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3428">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4158">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4165">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4169">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4177">Glossary Styles</A> <DT><STRONG>long3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#3414">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4163">Glossary Styles</A> <DT><STRONG>long3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#3418">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3424">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4167">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4173">Glossary Styles</A> <DT><STRONG>long3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#3422">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4171">Glossary Styles</A> <DT><STRONG>long4col</STRONG> -<DD><A HREF="glossaries-manual.html#2143">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3426">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3432">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3436">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2520">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4175">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4181">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4185">Glossary Styles</A> <DT><STRONG>long4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#2147">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3430">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2524">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4179">Glossary Styles</A> <DT><STRONG>long4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#2145">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3434">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3440">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2522">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4183">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4189">Glossary Styles</A> <DT><STRONG>long4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#2149">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3438">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2526">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4187">Glossary Styles</A> <DT><STRONG>longborder</STRONG> -<DD><A HREF="glossaries-manual.html#3397">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4146">Glossary Styles</A> <DT><STRONG>longheader</STRONG> -<DD><A HREF="glossaries-manual.html#3401">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3407">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3522">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#4150">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4156">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4271">Defining your own glossary</A> <DT><STRONG>longheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#3405">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4154">Glossary Styles</A> <DT><STRONG>super</STRONG> -<DD><A HREF="glossaries-manual.html#3442">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3451">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3455">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3463">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4191">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4200">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4204">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4212">Glossary Styles</A> <DT><STRONG>super3col</STRONG> -<DD><A HREF="glossaries-manual.html#3461">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3468">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3472">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3480">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4210">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4217">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4221">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4229">Glossary Styles</A> <DT><STRONG>super3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#3466">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4215">Glossary Styles</A> <DT><STRONG>super3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#3470">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3476">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4219">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4225">Glossary Styles</A> <DT><STRONG>super3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#3474">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4223">Glossary Styles</A> <DT><STRONG>super4col</STRONG> -<DD><A HREF="glossaries-manual.html#2151">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3478">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3484">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3488">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2528">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4227">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4233">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4237">Glossary Styles</A> <DT><STRONG>super4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#2155">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3482">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2532">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4231">Glossary Styles</A> <DT><STRONG>super4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#2153">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3486">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3492">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2530">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4235">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4241">Glossary Styles</A> <DT><STRONG>super4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#2157">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#3490">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2534">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#4239">Glossary Styles</A> <DT><STRONG>superborder</STRONG> -<DD><A HREF="glossaries-manual.html#3449">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4198">Glossary Styles</A> <DT><STRONG>superheader</STRONG> -<DD><A HREF="glossaries-manual.html#3453">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3459">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4202">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4208">Glossary Styles</A> <DT><STRONG>superheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#3457">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4206">Glossary Styles</A> </DL> <DT><STRONG><TT>glossary-list</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2070">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2447">A Quick Guide For</A> <DT><STRONG><TT>\glossaryentrynumbers</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3539">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#4288">Defining your own glossary</A> +<DT><STRONG><TT>\glossaryname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2234">Multi-Lingual Support</A> <DT><STRONG><TT>\glossarystyle</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2168">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2921">Displaying a glossary</A> +<DD><A HREF="glossaries-manual.html#2545">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3365">Displaying a glossary</A> <DT><STRONG><TT>\gls</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2034">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2079">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2082">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2085">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2128">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2577">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2586">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2739">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2745">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2751">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2757">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2763">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2775">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2787">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2803">Changing the format of</A> - | <A HREF="glossaries-manual.html#2855">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#3352">Unsetting and resetting entry</A> +<DD><A HREF="glossaries-manual.html#2411">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2456">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2459">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2462">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2505">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2940">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2949">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3180">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3244">Changing the format of</A> + | <A HREF="glossaries-manual.html#3296">Enabling and disabling hyperlinks</A> + | <A HREF="glossaries-manual.html#4074">Acronyms</A> + | <A HREF="glossaries-manual.html#4080">Acronyms</A> + | <A HREF="glossaries-manual.html#4098">Unsetting and resetting entry</A> <DT><STRONG><TT>\glsadd</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2116">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2131">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2493">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2508">A Quick Guide For</A> <DT><STRONG><TT>\glsaddall</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2119">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2134">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2496">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2511">A Quick Guide For</A> +<DT><STRONG><TT>\glsaddall</TT> keys</STRONG> +<DD><DL COMPACT> +<DT><STRONG>types</STRONG> +<DD><A HREF="glossaries-manual.html#3317">Adding an entry to</A> +</DL> <DT><STRONG><TT>\glscompositor</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2010">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2387">A Quick Guide For</A> <DT><STRONG><TT>\glsdesc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3331">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3951">Acronyms</A> <DT><STRONG><TT>\glsdisplay</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2556">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2616">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2919">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3009">Defining Glossary Entries</A> <DT><STRONG><TT>\glsdisplayfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2559">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2619">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2922">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3012">Defining Glossary Entries</A> <DT><STRONG><TT>\glsfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3337">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3957">Acronyms</A> <DT><STRONG><TT>\glslink</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2097">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2125">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2730">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2852">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#2870">Adding an entry to</A> +<DD><A HREF="glossaries-manual.html#2474">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2502">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3171">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3293">Enabling and disabling hyperlinks</A> + | <A HREF="glossaries-manual.html#3311">Adding an entry to</A> <DT><STRONG><TT>\glslink</TT> keys</STRONG> <DD><DL COMPACT> <DT><STRONG>counter</STRONG> -<DD><A HREF="glossaries-manual.html#2714">Links to Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#3149">Links to Glossary Entries</A> <DT><STRONG>format</STRONG> -<DD><A HREF="glossaries-manual.html#2100">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2103">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2113">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2701">Links to Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2477">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2480">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2490">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3136">Links to Glossary Entries</A> <DT><STRONG>hyper</STRONG> -<DD><A HREF="glossaries-manual.html#2717">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2858">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#2873">Adding an entry to</A> +<DD><A HREF="glossaries-manual.html#3152">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3299">Enabling and disabling hyperlinks</A> + | <A HREF="glossaries-manual.html#3314">Adding an entry to</A> </DL> <DT><STRONG><TT>\glsnamefont</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2067">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2076">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2444">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2453">A Quick Guide For</A> +<DT><STRONG><TT>\glsnumbersgroupname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2264">Multi-Lingual Support</A> <DT><STRONG><TT>\glspl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2037">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2088">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2091">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2094">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2562">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2565">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2568">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2595">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2604">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2622">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2625">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2628">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2806">Changing the format of</A> +<DD><A HREF="glossaries-manual.html#2414">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2465">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2468">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2471">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2925">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2928">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2931">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2958">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2970">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3015">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3018">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3021">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3247">Changing the format of</A> + | <A HREF="glossaries-manual.html#4086">Acronyms</A> + | <A HREF="glossaries-manual.html#4092">Acronyms</A> + | <A HREF="glossaries-manual.html#4101">Unsetting and resetting entry</A> +<DT><STRONG><TT>\glspluralsuffix</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2961">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2979">Defining Glossary Entries</A> <DT><STRONG><TT>\glssymbol</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3334">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3954">Acronyms</A> +<DT><STRONG><TT>\glssymbolsgroupname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2261">Multi-Lingual Support</A> <DT><STRONG><TT>\glstext</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3321">Acronyms</A> - | <A HREF="glossaries-manual.html#3325">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3186">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3192">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3198">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3204">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3216">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3228">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3941">Acronyms</A> + | <A HREF="glossaries-manual.html#3945">Acronyms</A> <DT><STRONG><TT>\glstextformat</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2831">Changing the format of</A> +<DD><A HREF="glossaries-manual.html#3272">Changing the format of</A> <DT><STRONG><TT>html</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1951">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2848">Enabling and disabling hyperlinks</A> +<DD><A HREF="glossaries-manual.html#2328">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3289">Enabling and disabling hyperlinks</A> <DT><STRONG><TT>\hyperemph</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2107">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2484">A Quick Guide For</A> <DT><STRONG><TT>\hyperlink</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2861">Enabling and disabling hyperlinks</A> +<DD><A HREF="glossaries-manual.html#3302">Enabling and disabling hyperlinks</A> <DT><STRONG><TT>hyperref</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1948">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2707">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2845">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#2867">Enabling and disabling hyperlinks</A> +<DD><A HREF="glossaries-manual.html#2325">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3142">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3286">Enabling and disabling hyperlinks</A> + | <A HREF="glossaries-manual.html#3308">Enabling and disabling hyperlinks</A> <DT><STRONG><TT>\hypertarget</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2864">Enabling and disabling hyperlinks</A> +<DD><A HREF="glossaries-manual.html#3305">Enabling and disabling hyperlinks</A> <DT><STRONG><TT>\item</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2073">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2450">A Quick Guide For</A> <DT><STRONG>link text</STRONG> -<DD><A HREF="glossaries-manual.html#2697">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2698">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2699">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2719">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2801">Changing the format of</A> - | <A HREF="glossaries-manual.html#2829">Changing the format of</A> - | <A HREF="glossaries-manual.html#2840">Changing the format of</A> +<DD><A HREF="glossaries-manual.html#3132">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3133">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3134">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3154">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3242">Changing the format of</A> + | <A HREF="glossaries-manual.html#3270">Changing the format of</A> + | <A HREF="glossaries-manual.html#3281">Changing the format of</A> <DT><STRONG><TT>longtable</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3393">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4142">Glossary Styles</A> <DT><STRONG><TT>\makefirstuc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2662">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#3055">Defining Glossary Entries</A> <DT><STRONG><TT>makeglossaries</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1901">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1912">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1915">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1930">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1954">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1957">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1963">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1981">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1990">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2013">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2528">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2879">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2888">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2934">Defining New Glossaries</A> +<DD><A HREF="glossaries-manual.html#2277">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2288">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2291">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2306">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2331">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2334">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2340">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2358">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2367">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2390">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2891">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3323">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3332">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3378">Defining New Glossaries</A> <DT><STRONG><TT>makeindex</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1904">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1907">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1918">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1933">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1978">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1984">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1987">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1993">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2122">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2140">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2531">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2536">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2637">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2643">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2704">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2882">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2885">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2931">Defining New Glossaries</A> +<DD><A HREF="glossaries-manual.html#2280">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2283">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2294">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2309">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2355">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2361">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2364">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2370">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2499">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2517">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2894">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2899">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3030">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3036">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3139">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3326">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3329">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3375">Defining New Glossaries</A> <DT><STRONG><TT>\MakeUppercase</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3578">Mfirstuc Package</A> +<DD><A HREF="glossaries-manual.html#4327">Mfirstuc Package</A> <DT><STRONG><TT>mfirstuc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3575">Mfirstuc Package</A> +<DD><A HREF="glossaries-manual.html#4324">Mfirstuc Package</A> <DT><STRONG><TT>\newacronym</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2049">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2476">Package Options</A> - | <A HREF="glossaries-manual.html#2488">Package Options</A> - | <A HREF="glossaries-manual.html#2500">Package Options</A> - | <A HREF="glossaries-manual.html#2512">Package Options</A> - | <A HREF="glossaries-manual.html#2978">Acronyms</A> - | <A HREF="glossaries-manual.html#3340">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2426">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2818">Package Options</A> + | <A HREF="glossaries-manual.html#2830">Package Options</A> + | <A HREF="glossaries-manual.html#2842">Package Options</A> + | <A HREF="glossaries-manual.html#2854">Package Options</A> + | <A HREF="glossaries-manual.html#2866">Package Options</A> + | <A HREF="glossaries-manual.html#3475">Acronyms</A> + | <A HREF="glossaries-manual.html#3960">Acronyms</A> <DT><STRONG><TT>\newglossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1975">A Quick Guide For</A> +<DD><A HREF="glossaries-manual.html#2352">A Quick Guide For</A> <DT><STRONG><TT>\newglossaryentry</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2025">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2064">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2694">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2727">Links to Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2402">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2441">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3129">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3162">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3481">Acronyms</A> <DT><STRONG><TT>\newglossaryentry</TT> keys</STRONG> <DD><DL COMPACT> <DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#2031">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2384">Package Options</A> - | <A HREF="glossaries-manual.html#2399">Package Options</A> - | <A HREF="glossaries-manual.html#2411">Package Options</A> - | <A HREF="glossaries-manual.html#2550">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2544">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2571">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2790">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2793">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2796">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2821">Changing the format of</A> - | <A HREF="glossaries-manual.html#3026">Acronyms</A> - | <A HREF="glossaries-manual.html#3222">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2408">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2761">Package Options</A> + | <A HREF="glossaries-manual.html#2776">Package Options</A> + | <A HREF="glossaries-manual.html#2788">Package Options</A> + | <A HREF="glossaries-manual.html#2913">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2907">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2934">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3231">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3234">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3237">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3262">Changing the format of</A> + | <A HREF="glossaries-manual.html#3557">Acronyms</A> + | <A HREF="glossaries-manual.html#3789">Acronyms</A> <DT><STRONG>descriptionplural</STRONG> -<DD><A HREF="glossaries-manual.html#2553">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2916">Defining Glossary Entries</A> <DT><STRONG>first</STRONG> -<DD><A HREF="glossaries-manual.html#2583">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2607">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2724">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2748">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2815">Changing the format of</A> - | <A HREF="glossaries-manual.html#3020">Acronyms</A> - | <A HREF="glossaries-manual.html#3355">Unsetting and resetting entry</A> +<DD><A HREF="glossaries-manual.html#2946">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2976">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2982">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2985">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2991">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3000">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3159">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3168">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3189">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3256">Changing the format of</A> + | <A HREF="glossaries-manual.html#3551">Acronyms</A> + | <A HREF="glossaries-manual.html#4104">Unsetting and resetting entry</A> <DT><STRONG>firstplural</STRONG> -<DD><A HREF="glossaries-manual.html#2601">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2736">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2760">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2818">Changing the format of</A> +<DD><A HREF="glossaries-manual.html#2967">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2988">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2997">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3067">Plurals</A> + | <A HREF="glossaries-manual.html#3177">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3201">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3259">Changing the format of</A> <DT><STRONG>format</STRONG> -<DD><A HREF="glossaries-manual.html#2711">Links to Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#3146">Links to Glossary Entries</A> <DT><STRONG>name</STRONG> -<DD><A HREF="glossaries-manual.html#2028">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2381">Package Options</A> - | <A HREF="glossaries-manual.html#2402">Package Options</A> - | <A HREF="glossaries-manual.html#2408">Package Options</A> - | <A HREF="glossaries-manual.html#2423">Package Options</A> - | <A HREF="glossaries-manual.html#2426">Package Options</A> - | <A HREF="glossaries-manual.html#2547">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2541">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2580">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2640">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2766">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2769">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2772">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#3216">Acronyms</A> - | <A HREF="glossaries-manual.html#3219">Acronyms</A> - | <A HREF="glossaries-manual.html#3527">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#2405">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2758">Package Options</A> + | <A HREF="glossaries-manual.html#2779">Package Options</A> + | <A HREF="glossaries-manual.html#2785">Package Options</A> + | <A HREF="glossaries-manual.html#2800">Package Options</A> + | <A HREF="glossaries-manual.html#2803">Package Options</A> + | <A HREF="glossaries-manual.html#2910">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2904">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2943">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3033">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3207">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3210">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3213">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3783">Acronyms</A> + | <A HREF="glossaries-manual.html#3786">Acronyms</A> + | <A HREF="glossaries-manual.html#4276">Defining your own glossary</A> <DT><STRONG>plural</STRONG> -<DD><A HREF="glossaries-manual.html#2046">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2592">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2733">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2754">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2812">Changing the format of</A> +<DD><A HREF="glossaries-manual.html#2423">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2955">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2973">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2994">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3061">Plurals</A> + | <A HREF="glossaries-manual.html#3064">Plurals</A> + | <A HREF="glossaries-manual.html#3174">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3195">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3253">Changing the format of</A> <DT><STRONG>sort</STRONG> -<DD><A HREF="glossaries-manual.html#2137">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2417">Package Options</A> - | <A HREF="glossaries-manual.html#2634">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#3524">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3530">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#2514">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2794">Package Options</A> + | <A HREF="glossaries-manual.html#3027">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#4273">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4279">Defining your own glossary</A> <DT><STRONG>symbol</STRONG> -<DD><A HREF="glossaries-manual.html#2387">Package Options</A> - | <A HREF="glossaries-manual.html#2405">Package Options</A> - | <A HREF="glossaries-manual.html#2414">Package Options</A> - | <A HREF="glossaries-manual.html#2610">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2631">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2778">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2781">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2784">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2824">Changing the format of</A> - | <A HREF="glossaries-manual.html#2827">Changing the format of</A> - | <A HREF="glossaries-manual.html#2838">Changing the format of</A> - | <A HREF="glossaries-manual.html#3029">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2764">Package Options</A> + | <A HREF="glossaries-manual.html#2782">Package Options</A> + | <A HREF="glossaries-manual.html#2791">Package Options</A> + | <A HREF="glossaries-manual.html#3003">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3024">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3219">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3222">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3225">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3265">Changing the format of</A> + | <A HREF="glossaries-manual.html#3268">Changing the format of</A> + | <A HREF="glossaries-manual.html#3279">Changing the format of</A> + | <A HREF="glossaries-manual.html#3560">Acronyms</A> <DT><STRONG>symbolplural</STRONG> -<DD><A HREF="glossaries-manual.html#2613">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#3006">Defining Glossary Entries</A> <DT><STRONG>text</STRONG> -<DD><A HREF="glossaries-manual.html#2420">Package Options</A> - | <A HREF="glossaries-manual.html#2429">Package Options</A> - | <A HREF="glossaries-manual.html#2574">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2589">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2598">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2721">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2742">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#2809">Changing the format of</A> - | <A HREF="glossaries-manual.html#3023">Acronyms</A> - | <A HREF="glossaries-manual.html#3358">Unsetting and resetting entry</A> +<DD><A HREF="glossaries-manual.html#2797">Package Options</A> + | <A HREF="glossaries-manual.html#2806">Package Options</A> + | <A HREF="glossaries-manual.html#2937">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2952">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#2964">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3156">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3165">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3183">Links to Glossary Entries</A> + | <A HREF="glossaries-manual.html#3250">Changing the format of</A> + | <A HREF="glossaries-manual.html#3554">Acronyms</A> + | <A HREF="glossaries-manual.html#4107">Unsetting and resetting entry</A> <DT><STRONG>type</STRONG> -<DD><A HREF="glossaries-manual.html#2040">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2043">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2647">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2665">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2417">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2420">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#3040">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3073">Loading Entries From a</A> </DL> +<DT><STRONG><TT>ngerman</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2216">Multi-Lingual Support</A> <DT><STRONG>number list</STRONG> -<DD><A HREF="glossaries-manual.html#2359">Package Options</A> - | <A HREF="glossaries-manual.html#2369">Package Options</A> - | <A HREF="glossaries-manual.html#2671">Number lists</A> - | <A HREF="glossaries-manual.html#2929">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#3388">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3395">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3412">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3447">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3464">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3564">Example: creating a completely</A> +<DD><A HREF="glossaries-manual.html#2736">Package Options</A> + | <A HREF="glossaries-manual.html#2746">Package Options</A> + | <A HREF="glossaries-manual.html#3106">Number lists</A> + | <A HREF="glossaries-manual.html#3373">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#4137">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4144">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4161">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4196">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4213">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4313">Example: creating a completely</A> <DT><STRONG>package options</STRONG> <DD><DL COMPACT> <DT><STRONG>acronym</STRONG> -<DD><A HREF="glossaries-manual.html#1926">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#1928">Generating the associated glossary</A> - | <A HREF="glossaries-manual.html#2005">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2007">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2060">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2062">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2262">Package Options</A> - | <A HREF="glossaries-manual.html#2264">Package Options</A> - | <A HREF="glossaries-manual.html#2316">Package Options</A> - | <A HREF="glossaries-manual.html#2318">Package Options</A> - | <A HREF="glossaries-manual.html#2329">Package Options</A> - | <A HREF="glossaries-manual.html#2331">Package Options</A> - | <A HREF="glossaries-manual.html#2338">Package Options</A> - | <A HREF="glossaries-manual.html#2340">Package Options</A> - | <A HREF="glossaries-manual.html#2658">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2660">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#2942">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2944">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2951">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2953">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2960">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2962">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#2973">Acronyms</A> - | <A HREF="glossaries-manual.html#2975">Acronyms</A> -<DT><STRONG>babel</STRONG> -<DD><A HREF="glossaries-manual.html#2437">Package Options</A> - | <A HREF="glossaries-manual.html#2439">Package Options</A> - | <A HREF="glossaries-manual.html#2450">Package Options</A> - | <A HREF="glossaries-manual.html#2463">Package Options</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#2465">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="glossaries-manual.html#2452">Package Options</A> -</DL> +<DD><A HREF="glossaries-manual.html#2245">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2247">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2302">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2304">Generating the associated glossary</A> + | <A HREF="glossaries-manual.html#2382">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2384">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2437">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2439">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2639">Package Options</A> + | <A HREF="glossaries-manual.html#2641">Package Options</A> + | <A HREF="glossaries-manual.html#2693">Package Options</A> + | <A HREF="glossaries-manual.html#2695">Package Options</A> + | <A HREF="glossaries-manual.html#2706">Package Options</A> + | <A HREF="glossaries-manual.html#2708">Package Options</A> + | <A HREF="glossaries-manual.html#2715">Package Options</A> + | <A HREF="glossaries-manual.html#2717">Package Options</A> + | <A HREF="glossaries-manual.html#3051">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3053">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#3081">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3083">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3090">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3092">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3099">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3101">Loading Entries From a</A> + | <A HREF="glossaries-manual.html#3386">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3388">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3395">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3397">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3404">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3406">Defining New Glossaries</A> + | <A HREF="glossaries-manual.html#3417">Acronyms</A> + | <A HREF="glossaries-manual.html#3419">Acronyms</A> <DT><STRONG>counter</STRONG> -<DD><A HREF="glossaries-manual.html#2366">Package Options</A> - | <A HREF="glossaries-manual.html#2368">Package Options</A> - | <A HREF="glossaries-manual.html#2687">Number lists</A> - | <A HREF="glossaries-manual.html#2689">Number lists</A> +<DD><A HREF="glossaries-manual.html#2743">Package Options</A> + | <A HREF="glossaries-manual.html#2745">Package Options</A> + | <A HREF="glossaries-manual.html#3122">Number lists</A> + | <A HREF="glossaries-manual.html#3124">Number lists</A> <DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#2472">Package Options</A> - | <A HREF="glossaries-manual.html#2474">Package Options</A> - | <A HREF="glossaries-manual.html#3007">Acronyms</A> - | <A HREF="glossaries-manual.html#3009">Acronyms</A> - | <A HREF="glossaries-manual.html#3037">Acronyms</A> - | <A HREF="glossaries-manual.html#3039">Acronyms</A> - | <A HREF="glossaries-manual.html#3055">Acronyms</A> - | <A HREF="glossaries-manual.html#3057">Acronyms</A> - | <A HREF="glossaries-manual.html#3073">Acronyms</A> - | <A HREF="glossaries-manual.html#3075">Acronyms</A> - | <A HREF="glossaries-manual.html#3128">Acronyms</A> - | <A HREF="glossaries-manual.html#3130">Acronyms</A> - | <A HREF="glossaries-manual.html#3143">Acronyms</A> - | <A HREF="glossaries-manual.html#3145">Acronyms</A> - | <A HREF="glossaries-manual.html#3212">Acronyms</A> - | <A HREF="glossaries-manual.html#3214">Acronyms</A> - | <A HREF="glossaries-manual.html#3230">Acronyms</A> - | <A HREF="glossaries-manual.html#3232">Acronyms</A> - | <A HREF="glossaries-manual.html#3282">Acronyms</A> - | <A HREF="glossaries-manual.html#3284">Acronyms</A> - | <A HREF="glossaries-manual.html#3317">Acronyms</A> - | <A HREF="glossaries-manual.html#3319">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2814">Package Options</A> + | <A HREF="glossaries-manual.html#2816">Package Options</A> + | <A HREF="glossaries-manual.html#3444">Acronyms</A> + | <A HREF="glossaries-manual.html#3446">Acronyms</A> + | <A HREF="glossaries-manual.html#3538">Acronyms</A> + | <A HREF="glossaries-manual.html#3540">Acronyms</A> + | <A HREF="glossaries-manual.html#3568">Acronyms</A> + | <A HREF="glossaries-manual.html#3570">Acronyms</A> + | <A HREF="glossaries-manual.html#3586">Acronyms</A> + | <A HREF="glossaries-manual.html#3588">Acronyms</A> + | <A HREF="glossaries-manual.html#3604">Acronyms</A> + | <A HREF="glossaries-manual.html#3606">Acronyms</A> + | <A HREF="glossaries-manual.html#3686">Acronyms</A> + | <A HREF="glossaries-manual.html#3688">Acronyms</A> + | <A HREF="glossaries-manual.html#3701">Acronyms</A> + | <A HREF="glossaries-manual.html#3703">Acronyms</A> + | <A HREF="glossaries-manual.html#3779">Acronyms</A> + | <A HREF="glossaries-manual.html#3781">Acronyms</A> + | <A HREF="glossaries-manual.html#3797">Acronyms</A> + | <A HREF="glossaries-manual.html#3799">Acronyms</A> + | <A HREF="glossaries-manual.html#3849">Acronyms</A> + | <A HREF="glossaries-manual.html#3851">Acronyms</A> + | <A HREF="glossaries-manual.html#3884">Acronyms</A> + | <A HREF="glossaries-manual.html#3886">Acronyms</A> + | <A HREF="glossaries-manual.html#3937">Acronyms</A> + | <A HREF="glossaries-manual.html#3939">Acronyms</A> <DT><STRONG>dua</STRONG> -<DD><A HREF="glossaries-manual.html#2508">Package Options</A> - | <A HREF="glossaries-manual.html#2510">Package Options</A> - | <A HREF="glossaries-manual.html#3064">Acronyms</A> - | <A HREF="glossaries-manual.html#3066">Acronyms</A> - | <A HREF="glossaries-manual.html#3100">Acronyms</A> - | <A HREF="glossaries-manual.html#3102">Acronyms</A> - | <A HREF="glossaries-manual.html#3185">Acronyms</A> - | <A HREF="glossaries-manual.html#3187">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2862">Package Options</A> + | <A HREF="glossaries-manual.html#2864">Package Options</A> + | <A HREF="glossaries-manual.html#3453">Acronyms</A> + | <A HREF="glossaries-manual.html#3455">Acronyms</A> + | <A HREF="glossaries-manual.html#3529">Acronyms</A> + | <A HREF="glossaries-manual.html#3531">Acronyms</A> + | <A HREF="glossaries-manual.html#3595">Acronyms</A> + | <A HREF="glossaries-manual.html#3597">Acronyms</A> + | <A HREF="glossaries-manual.html#3640">Acronyms</A> + | <A HREF="glossaries-manual.html#3642">Acronyms</A> + | <A HREF="glossaries-manual.html#3677">Acronyms</A> + | <A HREF="glossaries-manual.html#3679">Acronyms</A> + | <A HREF="glossaries-manual.html#3743">Acronyms</A> + | <A HREF="glossaries-manual.html#3745">Acronyms</A> + | <A HREF="glossaries-manual.html#3928">Acronyms</A> + | <A HREF="glossaries-manual.html#3930">Acronyms</A> <DT><STRONG>footnote</STRONG> -<DD><A HREF="glossaries-manual.html#2484">Package Options</A> - | <A HREF="glossaries-manual.html#2486">Package Options</A> - | <A HREF="glossaries-manual.html#3016">Acronyms</A> - | <A HREF="glossaries-manual.html#3018">Acronyms</A> - | <A HREF="glossaries-manual.html#3046">Acronyms</A> - | <A HREF="glossaries-manual.html#3048">Acronyms</A> - | <A HREF="glossaries-manual.html#3082">Acronyms</A> - | <A HREF="glossaries-manual.html#3084">Acronyms</A> - | <A HREF="glossaries-manual.html#3119">Acronyms</A> - | <A HREF="glossaries-manual.html#3121">Acronyms</A> - | <A HREF="glossaries-manual.html#3152">Acronyms</A> - | <A HREF="glossaries-manual.html#3154">Acronyms</A> - | <A HREF="glossaries-manual.html#3194">Acronyms</A> - | <A HREF="glossaries-manual.html#3196">Acronyms</A> - | <A HREF="glossaries-manual.html#3247">Acronyms</A> - | <A HREF="glossaries-manual.html#3249">Acronyms</A> - | <A HREF="glossaries-manual.html#3273">Acronyms</A> - | <A HREF="glossaries-manual.html#3275">Acronyms</A> - | <A HREF="glossaries-manual.html#3308">Acronyms</A> - | <A HREF="glossaries-manual.html#3310">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2826">Package Options</A> + | <A HREF="glossaries-manual.html#2828">Package Options</A> + | <A HREF="glossaries-manual.html#3462">Acronyms</A> + | <A HREF="glossaries-manual.html#3464">Acronyms</A> + | <A HREF="glossaries-manual.html#3547">Acronyms</A> + | <A HREF="glossaries-manual.html#3549">Acronyms</A> + | <A HREF="glossaries-manual.html#3577">Acronyms</A> + | <A HREF="glossaries-manual.html#3579">Acronyms</A> + | <A HREF="glossaries-manual.html#3613">Acronyms</A> + | <A HREF="glossaries-manual.html#3615">Acronyms</A> + | <A HREF="glossaries-manual.html#3668">Acronyms</A> + | <A HREF="glossaries-manual.html#3670">Acronyms</A> + | <A HREF="glossaries-manual.html#3710">Acronyms</A> + | <A HREF="glossaries-manual.html#3712">Acronyms</A> + | <A HREF="glossaries-manual.html#3752">Acronyms</A> + | <A HREF="glossaries-manual.html#3754">Acronyms</A> + | <A HREF="glossaries-manual.html#3814">Acronyms</A> + | <A HREF="glossaries-manual.html#3816">Acronyms</A> + | <A HREF="glossaries-manual.html#3840">Acronyms</A> + | <A HREF="glossaries-manual.html#3842">Acronyms</A> + | <A HREF="glossaries-manual.html#3875">Acronyms</A> + | <A HREF="glossaries-manual.html#3877">Acronyms</A> + | <A HREF="glossaries-manual.html#3919">Acronyms</A> + | <A HREF="glossaries-manual.html#3921">Acronyms</A> <DT><STRONG>nonumberlist</STRONG> -<DD><A HREF="glossaries-manual.html#2177">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2179">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2356">Package Options</A> - | <A HREF="glossaries-manual.html#2358">Package Options</A> - | <A HREF="glossaries-manual.html#2678">Number lists</A> - | <A HREF="glossaries-manual.html#2680">Number lists</A> - | <A HREF="glossaries-manual.html#3547">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3549">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3556">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#3558">Defining your own glossary</A> +<DD><A HREF="glossaries-manual.html#2554">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2556">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2733">Package Options</A> + | <A HREF="glossaries-manual.html#2735">Package Options</A> + | <A HREF="glossaries-manual.html#3113">Number lists</A> + | <A HREF="glossaries-manual.html#3115">Number lists</A> + | <A HREF="glossaries-manual.html#4296">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4298">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4305">Defining your own glossary</A> + | <A HREF="glossaries-manual.html#4307">Defining your own glossary</A> <DT><STRONG>numberedsection</STRONG> -<DD><A HREF="glossaries-manual.html#2283">Package Options</A> - | <A HREF="glossaries-manual.html#2285">Package Options</A> - | <A HREF="glossaries-manual.html#2292">Package Options</A> - | <A HREF="glossaries-manual.html#2294">Package Options</A> - | <A HREF="glossaries-manual.html#2307">Package Options</A> +<DD><A HREF="glossaries-manual.html#2660">Package Options</A> + | <A HREF="glossaries-manual.html#2662">Package Options</A> + | <A HREF="glossaries-manual.html#2669">Package Options</A> + | <A HREF="glossaries-manual.html#2671">Package Options</A> + | <A HREF="glossaries-manual.html#2684">Package Options</A> <DD><DL COMPACT> <DT><STRONG>autolabel</STRONG> -<DD><A HREF="glossaries-manual.html#2309">Package Options</A> - | <A HREF="glossaries-manual.html#2300">Package Options</A> +<DD><A HREF="glossaries-manual.html#2686">Package Options</A> + | <A HREF="glossaries-manual.html#2677">Package Options</A> <DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#2296">Package Options</A> +<DD><A HREF="glossaries-manual.html#2673">Package Options</A> <DT><STRONG>nolabel</STRONG> -<DD><A HREF="glossaries-manual.html#2298">Package Options</A> +<DD><A HREF="glossaries-manual.html#2675">Package Options</A> </DL> <DT><STRONG>numberline</STRONG> -<DD><A HREF="glossaries-manual.html#2217">Package Options</A> - | <A HREF="glossaries-manual.html#2219">Package Options</A> - | <A HREF="glossaries-manual.html#2253">Package Options</A> - | <A HREF="glossaries-manual.html#2255">Package Options</A> +<DD><A HREF="glossaries-manual.html#2594">Package Options</A> + | <A HREF="glossaries-manual.html#2596">Package Options</A> + | <A HREF="glossaries-manual.html#2630">Package Options</A> + | <A HREF="glossaries-manual.html#2632">Package Options</A> <DT><STRONG>sanitize</STRONG> -<DD><A HREF="glossaries-manual.html#2376">Package Options</A> - | <A HREF="glossaries-manual.html#2378">Package Options</A> - | <A HREF="glossaries-manual.html#2395">Package Options</A> - | <A HREF="glossaries-manual.html#2397">Package Options</A> - | <A HREF="glossaries-manual.html#3162">Acronyms</A> - | <A HREF="glossaries-manual.html#3164">Acronyms</A> - | <A HREF="glossaries-manual.html#3170">Acronyms</A> - | <A HREF="glossaries-manual.html#3177">Acronyms</A> - | <A HREF="glossaries-manual.html#3239">Acronyms</A> - | <A HREF="glossaries-manual.html#3256">Acronyms</A> - | <A HREF="glossaries-manual.html#3291">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2753">Package Options</A> + | <A HREF="glossaries-manual.html#2755">Package Options</A> + | <A HREF="glossaries-manual.html#2772">Package Options</A> + | <A HREF="glossaries-manual.html#2774">Package Options</A> + | <A HREF="glossaries-manual.html#3720">Acronyms</A> + | <A HREF="glossaries-manual.html#3722">Acronyms</A> + | <A HREF="glossaries-manual.html#3728">Acronyms</A> + | <A HREF="glossaries-manual.html#3735">Acronyms</A> + | <A HREF="glossaries-manual.html#3806">Acronyms</A> + | <A HREF="glossaries-manual.html#3823">Acronyms</A> + | <A HREF="glossaries-manual.html#3858">Acronyms</A> + | <A HREF="glossaries-manual.html#3893">Acronyms</A> <DD><DL COMPACT> <DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#3171">Acronyms</A> - | <A HREF="glossaries-manual.html#3257">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3729">Acronyms</A> + | <A HREF="glossaries-manual.html#3824">Acronyms</A> <DT><STRONG>symbol</STRONG> -<DD><A HREF="glossaries-manual.html#3178">Acronyms</A> - | <A HREF="glossaries-manual.html#3240">Acronyms</A> - | <A HREF="glossaries-manual.html#3292">Acronyms</A> +<DD><A HREF="glossaries-manual.html#3736">Acronyms</A> + | <A HREF="glossaries-manual.html#3807">Acronyms</A> + | <A HREF="glossaries-manual.html#3859">Acronyms</A> + | <A HREF="glossaries-manual.html#3894">Acronyms</A> </DL> <DT><STRONG>section</STRONG> -<DD><A HREF="glossaries-manual.html#2186">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2188">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2195">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2197">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2271">Package Options</A> - | <A HREF="glossaries-manual.html#2273">Package Options</A> +<DD><A HREF="glossaries-manual.html#2563">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2565">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2572">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2574">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2648">Package Options</A> + | <A HREF="glossaries-manual.html#2650">Package Options</A> +<DT><STRONG>shortcuts</STRONG> +<DD><A HREF="glossaries-manual.html#2874">Package Options</A> + | <A HREF="glossaries-manual.html#2876">Package Options</A> + | <A HREF="glossaries-manual.html#3471">Acronyms</A> + | <A HREF="glossaries-manual.html#3473">Acronyms</A> + | <A HREF="glossaries-manual.html#3974">Acronyms</A> + | <A HREF="glossaries-manual.html#3976">Acronyms</A> + | <A HREF="glossaries-manual.html#3986">Acronyms</A> + | <A HREF="glossaries-manual.html#3988">Acronyms</A> + | <A HREF="glossaries-manual.html#3995">Acronyms</A> + | <A HREF="glossaries-manual.html#3997">Acronyms</A> + | <A HREF="glossaries-manual.html#3995">Acronyms</A> + | <A HREF="glossaries-manual.html#3997">Acronyms</A> <DT><STRONG>smallcaps</STRONG> -<DD><A HREF="glossaries-manual.html#2496">Package Options</A> - | <A HREF="glossaries-manual.html#2498">Package Options</A> - | <A HREF="glossaries-manual.html#2986">Acronyms</A> - | <A HREF="glossaries-manual.html#2988">Acronyms</A> - | <A HREF="glossaries-manual.html#2998">Acronyms</A> - | <A HREF="glossaries-manual.html#3000">Acronyms</A> - | <A HREF="glossaries-manual.html#3091">Acronyms</A> - | <A HREF="glossaries-manual.html#3093">Acronyms</A> - | <A HREF="glossaries-manual.html#3110">Acronyms</A> - | <A HREF="glossaries-manual.html#3112">Acronyms</A> - | <A HREF="glossaries-manual.html#3203">Acronyms</A> - | <A HREF="glossaries-manual.html#3205">Acronyms</A> - | <A HREF="glossaries-manual.html#3264">Acronyms</A> - | <A HREF="glossaries-manual.html#3266">Acronyms</A> - | <A HREF="glossaries-manual.html#3299">Acronyms</A> - | <A HREF="glossaries-manual.html#3301">Acronyms</A> +<DD><A HREF="glossaries-manual.html#2838">Package Options</A> + | <A HREF="glossaries-manual.html#2840">Package Options</A> + | <A HREF="glossaries-manual.html#3426">Acronyms</A> + | <A HREF="glossaries-manual.html#3428">Acronyms</A> + | <A HREF="glossaries-manual.html#3489">Acronyms</A> + | <A HREF="glossaries-manual.html#3491">Acronyms</A> + | <A HREF="glossaries-manual.html#3511">Acronyms</A> + | <A HREF="glossaries-manual.html#3513">Acronyms</A> + | <A HREF="glossaries-manual.html#3622">Acronyms</A> + | <A HREF="glossaries-manual.html#3624">Acronyms</A> + | <A HREF="glossaries-manual.html#3650">Acronyms</A> + | <A HREF="glossaries-manual.html#3652">Acronyms</A> + | <A HREF="glossaries-manual.html#3770">Acronyms</A> + | <A HREF="glossaries-manual.html#3772">Acronyms</A> + | <A HREF="glossaries-manual.html#3831">Acronyms</A> + | <A HREF="glossaries-manual.html#3833">Acronyms</A> + | <A HREF="glossaries-manual.html#3901">Acronyms</A> + | <A HREF="glossaries-manual.html#3903">Acronyms</A> +<DT><STRONG>smaller</STRONG> +<DD><A HREF="glossaries-manual.html#2850">Package Options</A> + | <A HREF="glossaries-manual.html#2852">Package Options</A> + | <A HREF="glossaries-manual.html#3435">Acronyms</A> + | <A HREF="glossaries-manual.html#3437">Acronyms</A> + | <A HREF="glossaries-manual.html#3501">Acronyms</A> + | <A HREF="glossaries-manual.html#3503">Acronyms</A> + | <A HREF="glossaries-manual.html#3520">Acronyms</A> + | <A HREF="glossaries-manual.html#3522">Acronyms</A> + | <A HREF="glossaries-manual.html#3631">Acronyms</A> + | <A HREF="glossaries-manual.html#3633">Acronyms</A> + | <A HREF="glossaries-manual.html#3659">Acronyms</A> + | <A HREF="glossaries-manual.html#3661">Acronyms</A> + | <A HREF="glossaries-manual.html#3761">Acronyms</A> + | <A HREF="glossaries-manual.html#3763">Acronyms</A> + | <A HREF="glossaries-manual.html#3866">Acronyms</A> + | <A HREF="glossaries-manual.html#3868">Acronyms</A> + | <A HREF="glossaries-manual.html#3910">Acronyms</A> + | <A HREF="glossaries-manual.html#3912">Acronyms</A> <DT><STRONG>style</STRONG> -<DD><A HREF="glossaries-manual.html#2164">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2166">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2347">Package Options</A> - | <A HREF="glossaries-manual.html#2349">Package Options</A> - | <A HREF="glossaries-manual.html#2917">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2919">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#3499">Glossary Styles</A> - | <A HREF="glossaries-manual.html#3501">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2541">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2543">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2724">Package Options</A> + | <A HREF="glossaries-manual.html#2726">Package Options</A> + | <A HREF="glossaries-manual.html#3361">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3363">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#4248">Glossary Styles</A> + | <A HREF="glossaries-manual.html#4250">Glossary Styles</A> <DT><STRONG>toc</STRONG> -<DD><A HREF="glossaries-manual.html#1971">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#1973">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2021">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2023">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2208">Package Options</A> - | <A HREF="glossaries-manual.html#2210">Package Options</A> - | <A HREF="glossaries-manual.html#2226">Package Options</A> - | <A HREF="glossaries-manual.html#2228">Package Options</A> - | <A HREF="glossaries-manual.html#2235">Package Options</A> - | <A HREF="glossaries-manual.html#2237">Package Options</A> - | <A HREF="glossaries-manual.html#2244">Package Options</A> - | <A HREF="glossaries-manual.html#2246">Package Options</A> - | <A HREF="glossaries-manual.html#2905">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#2907">Displaying a glossary</A> -<DT><STRONG>translate</STRONG> -<DD><A HREF="glossaries-manual.html#1892">Introduction</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#1894">Introduction</A> -</DL> +<DD><A HREF="glossaries-manual.html#2348">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2350">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2398">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2400">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2585">Package Options</A> + | <A HREF="glossaries-manual.html#2587">Package Options</A> + | <A HREF="glossaries-manual.html#2603">Package Options</A> + | <A HREF="glossaries-manual.html#2605">Package Options</A> + | <A HREF="glossaries-manual.html#2612">Package Options</A> + | <A HREF="glossaries-manual.html#2614">Package Options</A> + | <A HREF="glossaries-manual.html#2621">Package Options</A> + | <A HREF="glossaries-manual.html#2623">Package Options</A> + | <A HREF="glossaries-manual.html#3349">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#3351">Displaying a glossary</A> </DL> +<DT><STRONG><TT>\pagelistname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2258">Multi-Lingual Support</A> <DT><STRONG><TT>\printglossaries</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1960">A Quick Guide For</A> - | <A HREF="glossaries-manual.html#2525">Defining Glossary Entries</A> +<DD><A HREF="glossaries-manual.html#2337">A Quick Guide For</A> + | <A HREF="glossaries-manual.html#2888">Defining Glossary Entries</A> <DT><STRONG><TT>\printglossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2522">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#3506">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#2885">Defining Glossary Entries</A> + | <A HREF="glossaries-manual.html#4255">Glossary Styles</A> <DT><STRONG><TT>\printglossary</TT> keys</STRONG> <DD><DL COMPACT> <DT><STRONG>style</STRONG> -<DD><A HREF="glossaries-manual.html#2909">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#3503">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#3353">Displaying a glossary</A> + | <A HREF="glossaries-manual.html#4252">Glossary Styles</A> <DT><STRONG>title</STRONG> -<DD><A HREF="glossaries-manual.html#2894">Displaying a glossary</A> +<DD><A HREF="glossaries-manual.html#3338">Displaying a glossary</A> <DT><STRONG>toctitle</STRONG> -<DD><A HREF="glossaries-manual.html#2897">Displaying a glossary</A> +<DD><A HREF="glossaries-manual.html#3341">Displaying a glossary</A> <DT><STRONG>type</STRONG> -<DD><A HREF="glossaries-manual.html#2891">Displaying a glossary</A> +<DD><A HREF="glossaries-manual.html#3335">Displaying a glossary</A> </DL> <DT><STRONG><TT>\setglossarysection</TT></STRONG> -<DD><A HREF="glossaries-manual.html#2275">Package Options</A> +<DD><A HREF="glossaries-manual.html#2652">Package Options</A> <DT><STRONG><TT>supertabular</TT></STRONG> -<DD><A HREF="glossaries-manual.html#3445">Glossary Styles</A> +<DD><A HREF="glossaries-manual.html#4194">Glossary Styles</A> +<DT><STRONG><TT>\symbolname</TT></STRONG> +<DD><A HREF="glossaries-manual.html#2255">Multi-Lingual Support</A> <DT><STRONG><TT>translator</TT></STRONG> -<DD><A HREF="glossaries-manual.html#1883">Introduction</A> +<DD><A HREF="glossaries-manual.html#2210">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2213">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2225">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2228">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2270">Multi-Lingual Support</A> + | <A HREF="glossaries-manual.html#2273">Multi-Lingual Support</A> </DL> <P> @@ -3363,42 +3958,56 @@ Index</A> <P> <BR><HR><H4>Footnotes</H4> <DL> -<DT><A NAME="foot378">... +<DT><A NAME="foot446">... range</A><A - HREF="glossaries-manual.html#tex2html4"><SUP>1</SUP></A></DT> + HREF="glossaries-manual.html#tex2html7"><SUP>1</SUP></A></DT> <DD>This is new to version 1.01 </DD> -<DT><A NAME="foot1737">...acronym</A><A - HREF="glossaries-manual.html#tex2html5"><SUP>2</SUP></A></DT> +<DT><A NAME="foot2039">...acronym</A><A + HREF="glossaries-manual.html#tex2html8"><SUP>2</SUP></A></DT> <DD>if the -<TT>acronym</TT><A NAME="2316"></A> option is used, otherwise the list of +<TT>acronym</TT><A NAME="2693"></A> option is used, otherwise the list of acronyms is the main glossary </DD> -<DT><A NAME="foot1791">... name</A><A - HREF="glossaries-manual.html#tex2html6"><SUP>3</SUP></A></DT> +<DT><A NAME="foot2059">... this.</A><A + HREF="glossaries-manual.html#tex2html9"><SUP>3</SUP></A></DT> +<DD>The +only preamble restriction on <TT>\newglossaryentry</TT> and <TT>\newacronym</TT> +was removed in version 1.13, but the restriction remains for +<TT>\loadglsentries</TT>. + +</DD> +<DT><A NAME="foot2102">... label</A><A + HREF="glossaries-manual.html#tex2html10"><SUP>4</SUP></A></DT> <DD><TT>main</TT> for the main (default) glossary, <TT>\acronymtype</TT> for the list of acronyms, or the name supplied in the first mandatory argument to <TT>\newglossary</TT> for additional glossaries. </DD> -<DT><A NAME="foot1453">... start.</A><A - HREF="glossaries-manual.html#tex2html8"><SUP>4</SUP></A></DT> +<DT><A NAME="foot2130">...smaller</A><A + HREF="glossaries-manual.html#tex2html11"><SUP>5</SUP></A></DT> +<DD><TT>\smaller</TT> is defined +in the <TT>relsize</TT> package. + +</DD> +<DT><A NAME="foot1732">... start.</A><A + HREF="glossaries-manual.html#tex2html14"><SUP>6</SUP></A></DT> <DD>This style was supplied by Axel Menzel. </DD> -<DT><A NAME="foot1825">... +<DT><A NAME="foot2144">... link</A><A - HREF="glossaries-manual.html#tex2html9"><SUP>5</SUP></A></DT> + HREF="glossaries-manual.html#tex2html15"><SUP>7</SUP></A></DT> <DD>if the document doesn't have hyperlinks enabled <TT>\@glslink</TT> ignores the label and simply typesets the text. </DD> -<DT><A NAME="foot1826">... correctly.</A><A - HREF="glossaries-manual.html#tex2html10"><SUP>6</SUP></A></DT> +<DT><A NAME="foot2145">... correctly.</A><A + HREF="glossaries-manual.html#tex2html16"><SUP>8</SUP></A></DT> <DD>again, if the document doesn't support hyperlinks, <TT>\@glstarget</TT> will ignore the label, and just typeset the text. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex index c46dc8497f7..d46e6e58645 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex @@ -23,12 +23,14 @@ \makeatother \RecordChanges \PageIndex -\CheckSum{4630} +\CheckSum{5110} \CodelineNumbered \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}} \newcommand*{\term}[1]{#1\iterm{#1}} \newcommand*{\iterm}[1]{\index{#1|main}} \newcommand{\dq}[1]{``#1''} +\newcommand*{\tableref}[1]{\hyperref[#1]{table~\ref*{#1}}} +\newcommand*{\Tableref}[1]{\hyperref[#1]{Table~\ref*{#1}}} } { \usepackage{html} @@ -39,6 +41,8 @@ \newcommand*{\term}[1]{#1\index{#1}} \newcommand*{\iterm}[1]{\index{#1}} \newcommand{\dq}[1]{"#1"} +\newcommand*{\tableref}[1]{\htmlref{table~}{#1}\ref{#1}} +\newcommand*{\Tableref}[1]{\htmlref{Table~}{#1}\ref{#1}} } @@ -92,7 +96,7 @@ \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{glossaries.sty v 1.12: \LaTeXe\ Package to Assist Generating Glossaries} + \title{glossaries.sty v 1.13: \LaTeXe\ Package to Assist Generating Glossaries} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -100,7 +104,7 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{8th March 2008} + \date{12th May 2008} \maketitle \tableofcontents @@ -117,19 +121,6 @@ where only those terms used in the text are added to the glossary. This package replaces the \isty{glossary} package which is now obsolete. -As from version 1.08, the \sty{glossaries} package now has -limited multi-lingual support, thanks to all the people who have sent -me the relevant translations either via email or via comp.text.tex. -However you must load \isty{babel} \emph{before} -\sty{glossaries} to enable this. \ifmakedtx{(See \autoref{sec:predefinednames} for the -predefined names used by the \sty{glossaries} package.)}{} -As from version 1.1, the \sty{glossaries} package also supports -Till~Tantau's \isty{translator} package provided it is loaded -before the \sty{glossaries} package. This makes it easier to change -the default translations or add new dictionaries. -If you don't want to use the predefined translations, you can use the -package option \pkgopt[false]{translate} and supply your own translations. - This documentation is structured as follows: \ifmakedtx{\autoref{sec:quick}}{\htmlref{{A Quick Guide For The Impatient}}{sec:quick}} is for people who want a few quick pointers of how to get started, without having to read through lengthy descriptions, @@ -139,10 +130,97 @@ and their syntax\ifmakedtx{, \autoref{sec:mfirstuc}}{ and \sty{mfirstuc} package\ifmakedtx{, \autoref{sec:code} contains the documented source code for those who want to know more about how the -package works and how to do more complicated things, such as -changing the way glossary entries appear}{}. +package works and \autoref{sec:code:mfirstuc} contains the documented +code for the \sty{mfirstuc} package}{}. \ifmakedtx{}{\toTop} +\subsection{Multi-Lingual Support} + +As from version 1.08, the \sty{glossaries} package now has +limited multi-lingual support, thanks to all the people who have sent +me the relevant translations either via email or via +\texttt{comp.text.tex}. +However you must load \isty{babel} \emph{before} +\sty{glossaries} to enable this. Note that if \isty{babel} is loaded +and the \isty{translator} package is detected on \TeX's path, then the +\isty{translator} package will be loaded automatically. + +If you want to use \isty{ngerman} or \isty{german} instead +of \isty{babel}, you will need to include the \isty{translator} package +to provide the translations. For example: +\begin{verbatim} +\documentclass[ngerman]{article} +\usepackage{ngerman} +\usepackage{translator} +\usepackage{glossaries} +\end{verbatim} + +The following languages are currently supported: +\begin{center} +\begin{tabular}{lc} +\bfseries Language & \bfseries As from version\\ +Danish & 1.08\\ +Dutch & 1.08\\ +English & 1.08\\ +French & 1.08\\ +German & 1.08\\ +Irish & 1.08\\ +Italian & 1.08\\ +Hungarian & 1.08\\ +Polish & 1.13\\ +Spanish & 1.08 +\end{tabular} +\end{center} +The language dependent commands and \isty{translator} keys used by the +glossaries package are listed in \tableref{tab:predefinednames}. + +\begin{table}[htbp] +\caption{Customised Text} +\label{tab:predefinednames} +\begin{center} +\begin{tabular}{@{}llp{0.4\linewidth}@{}} +\bfseries Command Name & \bfseries Translator key word & +\bfseries What it's for\\ +\ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\\ +\ics{acronymname} & \texttt{Acronyms} & Title of the list of acronyms +(when used with package option \pkgopt{acronym}).\\ +\ics{entryname} & \texttt{Notation (glossaries)} & +Header for first column in glossary (for 2, 3 or 4 column glossaries +that support headers).\\ +\ics{descriptionname} & \texttt{Description (glossaries)} & +Header for second column in glossary (for 2, 3 or 4 column glossaries +that support headers).\\ +\ics{symbolname} & \texttt{Symbol (glossaries)} & Header for symbol +column in glossary for glossary styles that support this option.\\ +\ics{pagelistname} & \texttt{Page List (glossaries)} & +Header for page list column in glossary for glossaries that support +this option.\\ +\ics{glssymbolsgroupname} & \texttt{Symbols (glossaries)} & +Header for symbols section of the glossary for glossary styles that +support this option.\\ +\ics{glsnumbersgroupname} & \texttt{Numbers (glossaries)} & Header for +numbers section of the glossary for glossary styles that support +this option. +\end{tabular} +\end{center} +\end{table} + +Due to the varied nature of glossaries, it's likely that the +predefined translations may not be appropriate. If you are using +the \isty{babel} package and do not have the \isty{translator} package +installed, you need to be familiar with the +\ifmakedtx{ advice given in +\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}}{advice on \htmladdnormallink{changing the words babel uses}{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}}. + +If you have the \isty{translator} package installed, then it becomes +much easier to change the default translations. For example, if you +are writing in Irish and you want \cs{symbolname} to produce +\dq{Siombail} instead of \dq{Comhartha}, then you can put the following +in your document preamble: +\begin{verbatim} +\deftranslation[to=Irish]{Symbol (glossaries)}{Siombail} +\end{verbatim} + \subsection{Generating the associated glossary files} \label{sec:makeglossaries} @@ -165,7 +243,8 @@ Perl: perl makeglossaries myfile \end{verbatim} There is a batch file called \texttt{makeglossaries.bat} which -does this for Windows users. +does this for Windows users, but you must have Perl installed to +be able to use it. If you don't have Perl installed, you will have to run \appname{makeindex} for each glossary type you have defined. @@ -188,7 +267,7 @@ If any problems occur, remember to check the transcript files \subsection{Troubleshooting} -The glossaries package comes with a minimal file called +The \sty{glossaries} package comes with a minimal file called \texttt{minimalgls.tex} which can be used for testing. This should be located in \texttt{texmf/doc/latex/glossaries/samples/}. Further information on debugging \LaTeX\ code is available at @@ -202,8 +281,9 @@ There is a list of frequently asked questions for the \label{sec:quick} This section is for people who want a few quick pointers -of how to get started, without having to read through -lengthy descriptions. +of how to get started. However it is recommended that you read +\ifmakedtx{\autoref{sec:overview}}{\htmlref{the overview section}{sec:overview}} +for additional commands and advice not listed here. \begin{enumerate} \item Load \sty{glossaries} \emph{after} \isty{hyperref}: @@ -705,14 +785,6 @@ 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. -\item[\pkgopt{babel}] This is a boolean key and is for use when -the \sty{glossaries} package is used in conjunction with the -\isty{babel} package. The default is \pkgopt[true]{babel}, which -adds the glossary translations to \isty{babel}'s captions. If -you don't like the translations provided by the \sty{glossaries} -package, you can set \pkgopt[false]{babel} and provide your own -translations. - \item[\pkgopt{description}] This option changes the definition of \ics{newacronym} to allow a description. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} for further details. @@ -725,18 +797,31 @@ for further details. \ics{newacronym} and the way that acronyms are displayed. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} for further details. +\item[\pkgopt{smaller}] This option changes the definition of +\ics{newacronym} and the way that acronyms are displayed. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} +for further details. + \item[\pkgopt{dua}] This option changes the definition of \ics{newacronym} so that acronyms are always expanded. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} for further details. +\item[\pkgopt{shortcuts}] This option provides shortcut commands +for acronyms. +See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} +for further details. + \end{description}\ifmakedtx{}{\toTop} \subsection{Defining Glossary Entries} \label{sec:newglosentry} -All glossary entries that are used in a document must be defined in -the preamble. Only those entries that occur in the document +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 \ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary Entries}{sec:glslink}} and \ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}}) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary @@ -795,14 +880,20 @@ key is used. \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 an -\dq{s} to the value of the \gloskey{text} field. - -\item[{\gloskey{firstplural}}] How the entry will appear in the document -text the first time it is used with \ics{glspl} (or one of -its uppercase variants). If this field is omitted, the value is -obtained by appending an \dq{s} to the value of the \gloskey{first} -field. +If this field is omitted, the value is obtained by appending +\ics{glspluralsuffix} to the value of the \gloskey{text} field. + +\item[{\gloskey{firstplural}}] How the entry will appear in the +document text the first time it is used 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. +\textbf{Note:} prior to version 1.13, the default value of +\gloskey{firstplural} was always taken by appending \dq{s} to the +\gloskey{first} key, which meant that you had to specify both +\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, but most glossary styles ignore @@ -821,15 +912,15 @@ at-sign @ although the \sty{glossaries} package uses a different symbol). \item[{\gloskey{type}}] This is the glossary type to which this entry -belongs. If omitted, the default glossary is assumed -(\texttt{type=main}). The list of acronyms type is given by +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. \end{description} Note that if the key starts with an accented letter, you must group the accented letter, otherwise it will cause a -problem for \cs{Gls} and \cs{Glspl}. For example: +problem for commands like \cs{Gls} and \cs{Glspl}. For example: \begin{verbatim} \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}} @@ -851,8 +942,55 @@ but don't do \verb|\oe{}sophagus| as it will confuse \ics{makefirstuc} (described \ifmakedtx{in \autoref{sec:mfirstuc}}{\htmlref{later}{sec:mfirstuc}}) and will produce \ifmakedtx{\oe{}}{oe}Sophagus instead of -\ifmakedtx{{\OE}}{OE}sophagus. +\ifmakedtx{{\OE}}{OE}sophagus. +\ifmakedtx{}{\toTop} + + +\subsubsection{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 +\DescribeMacro{\glspluralsuffix}by appending \cs{glspluralsuffix} to +the singular form. This command defaults to \texttt{s}. For example: +\begin{verbatim} +\newglossaryentry{cow}{name=cow,description={a fully grown +female of any bovine animal}} +\end{verbatim} +defines a new entry whose singular form is \dq{cow} and plural form +is \dq{cows}. However, if you are writing in archaic English, you +may want to use \dq{kine} as the plural form, in which case you would +have to do: +\begin{verbatim} +\newglossaryentry{cow}{name=cow,plural=kine, +description={a fully grown female of any bovine animal}} +\end{verbatim} + +If you are writing in a language that supports +multiple plurals (for a given term) then use the \gloskey{plural} key +for one of them (typically the one you are most likely to use) and +for the others you will need to explicitly write the plural form using +\cs{glslink} rather than using \cs{glspl}. Returning to the cow +example above, suppose you will mostly be using \dq{cows} as the +plural, but occasionally you want to use \dq{kine} as the plural, +then define the term as +\begin{verbatim} +\newglossaryentry{cow}{name=cow,description={a fully grown +female of any bovine animal (plural cows, archaic plural kine)}} +\end{verbatim} +and use \verb|\glspl{cow}| to produce \dq{cows} and use +\verb|\glslink{cow}{kine}| to produce \dq{kine}. +If you are using a language that usually forms plurals +by appending a different letter, or sequence of letters, you can +redefine \cs{glspluralsuffix} as required. However, this must be +done \emph{before} 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 \gloskey{plural} key (and the \gloskey{firstplural} +key where necessary). + +\ifmakedtx{}{\toTop} + +\subsubsection{Loading Entries From a File} +\label{sec:loadglsentries} \DescribeMacro{\loadglsentries} You can store all your glossary entry definitions in another @@ -862,8 +1000,64 @@ where \meta{filename} is the name of the file containing all the \cs{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. Note that only those entries that have been used -in the text will appear in the relevant glossaries.\ifmakedtx{}{\toTop} +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 +a file called \texttt{myentries.tex} which contains: +\begin{verbatim} +\newglossaryentry{perl}{type=main, +name={Perl}, +description={A scripting language}} + +\newglossaryentry{tex}{name={\TeX}, +description={A typesetting language}} + +\newglossaryentry{html}{type=\glsdefaulttype, +name={html}, +description={A mark up language}} +\end{verbatim} +and suppose in my document preamble I use the command: +\begin{verbatim} +\loadglsentries[languages]{myentries} +\end{verbatim} +then this will add the entries \texttt{tex} and \texttt{html} +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 \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}}) +the type is set as \verb|type=\acronymtype| +unless you explicitly override it. For example, if my file +\texttt{myacronyms.tex} contains: +\begin{verbatim} +\newacronym{aca}{aca}{a contrived acronym} +\end{verbatim} +then (supposing I have defined a new glossary type called +\texttt{altacronym}) +\begin{verbatim} +\loadglsentries[altacronym]{myacronyms} +\end{verbatim} +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. In this instance, +it is better to change \texttt{myacronyms.tex} to: +\begin{verbatim} +\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} +\end{verbatim} +and now +\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. + +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.\ifmakedtx{}{\toTop} \subsection{Number lists} \label{sec:numberlists} @@ -897,12 +1091,12 @@ font, do: \DescribeMacro{\glslink} The command:\\[10pt] \cs{glslink}\oarg{options}\marg{label}\marg{text}\\[10pt] -will place \meta{text} in the document at that point and add -a line into the associated glossary file for the glossary entry -given by \meta{label}. If hyperlinks are supported, \meta{text} -will be a hyperlink to the relevant line in the glossary. The -optional argument \meta{options} must be a \meta{key}=\meta{value} -list which can take any of the following keys: +will place \cs{glstextformat}\marg{text} in the document at that point +and add a line into the associated glossary file for the glossary entry +given by \meta{label}. If hyperlinks are supported, \meta{text} will be +a hyperlink to the relevant line in the glossary. The optional argument +\meta{options} must be a \meta{key}=\meta{value} list which can take +any of the following keys: \begin{description} \item[{\gloskey[glslink]{format}}] This specifies how to format the @@ -1009,7 +1203,13 @@ The command:\\[10pt] is the same as \cs{glslink}, except that the \term{link text} is determined from the values of the \gloskey{text} and \gloskey{first} keys supplied when the entry was defined using -\ics{newglossaryentry}. There are two uppercase variants:\\[10pt] +\ics{newglossaryentry}. If the entry has been marked as having +been used, 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 given by \meta{label} as +used. + +There are two uppercase variants:\\[10pt] \DescribeMacro{\Gls} \cs{Gls}\oarg{options}\marg{label}\oarg{insert}\\[10pt] and\\[10pt] @@ -1020,10 +1220,14 @@ uppercase, respectively. The final optional argument \meta{insert}, allows you to insert some additional text into the link text. By default, this will -append \meta{insert} at the end of the link text. The first optional -argument \meta{options} is the same as the optional argument to -\ics{glslink}. As with \cs{glslink}, these commands also have -a starred version that disable the hyperlink. +append \meta{insert} at the end of the link text, but this +can be changed (see +\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{later}{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 +have a starred version that disable the hyperlink. There are also analogous plural forms:\\[10pt] \DescribeMacro{\glspl} @@ -1041,7 +1245,8 @@ a starred version that disable the hyperlink. \cs{glstext}\oarg{options}\marg{label}\oarg{insert}\\[10pt] is similar to \ics{gls} except that it always uses the value of the \gloskey{text} key and does not mark the entry as -having been used. +having been used. Unlike \cs{gls}, the inserted text \meta{insert} +is always appended to the link text. There are also analogous commands:\\[10pt] \DescribeMacro{\Glstext} @@ -1053,9 +1258,10 @@ the hyperlink. \DescribeMacro{\glsfirst}The command:\\[10pt] \cs{glsfirst}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{first} key and does not mark the entry as -having been used. +is similar to \ics{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 mark the entry as having +been used. There are also analogous commands:\\[10pt] \DescribeMacro{\Glsfirst} @@ -1067,9 +1273,10 @@ the hyperlink. \DescribeMacro{\glsplural}The command:\\[10pt] \cs{glsplural}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{plural} key and does not mark the entry as -having been used. +is similar to \ics{glstext} except that it always uses the value +of the \gloskey{plural} key. Again, \meta{insert} is always appended +to the end of the link text and does not mark the entry as having +been used. There are also analogous commands:\\[10pt] \DescribeMacro{\Glsplural} @@ -1081,8 +1288,9 @@ the hyperlink. \DescribeMacro{\glsfirstplural}The command:\\[10pt] \cs{glsfirstplural}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{firstplural} key and does not mark the entry as +is similar to \ics{glstext} except that it always uses the value +of the \gloskey{firstplural} key. Again, \meta{insert} is always +appended to the end of the link text and does not mark the entry as having been used. There are also analogous commands:\\[10pt] @@ -1095,9 +1303,10 @@ the hyperlink. \DescribeMacro{\glsname}The command:\\[10pt] \cs{glsname}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{name} key and does not mark the entry as -having been used. Note: if you want to use this command and the +is similar to \ics{glstext} except that it always uses the value of 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 \ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} of the \gloskey{name} key and protect fragile commands. @@ -1112,9 +1321,10 @@ the hyperlink. \DescribeMacro{\glssymbol}The command:\\[10pt] \cs{glssymbol}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{symbol} key and does not mark the entry as -having been used. Note: if you want to use this command and the +is similar to \ics{glstext} except that it always uses the value of 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 \ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} of the \gloskey{symbol} key and protect fragile commands. @@ -1129,10 +1339,12 @@ the hyperlink. \DescribeMacro{\glsdesc}The command:\\[10pt] \cs{glsdesc}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -is similar to \ics{gls} except that it always uses the value -of the \gloskey{description} key 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 +is similar to \ics{glstext} except that it always uses the value +of 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 \ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} of the \gloskey{description} key and protect fragile commands. @@ -1205,7 +1417,7 @@ to use \DescribeMacro{\defglsdisplay}\cs{defglsdisplay} and of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}. Both \cs{defglsdisplay} and \cs{defglsdisplayfirst} take two arguments: -the first (which is optional) is the glossary name\footnote{\texttt{main} for the main +the first (which is optional) is the glossary's label\footnote{\texttt{main} for the main (default) glossary, \cs{acronymtype} for the list of acronyms, or the name supplied in the first mandatory argument to \cs{newglossary} for additional glossaries.} and the second is how the term should be @@ -1225,7 +1437,7 @@ Now suppose you have defined an entry as follows: \newglossaryentry{set}{type=notation, name=set, description={A collection of objects}, -symbol={$S$}, +symbol={$S$} } \end{verbatim} The first time you reference this entry using \cs{gls} it @@ -1265,25 +1477,36 @@ 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}). +For example, to add a page range to the glossary number list for the +entry whose label is given by \texttt{set}: +\begin{verbatim} +\glsadd[format=(]{set} +Lots of text about sets spanning many pages. +\glsadd[format=)]{set} +\end{verbatim} \DescribeMacro{\glsaddall} To add all entries that have been defined, use:\\[10pt] -\cs{glsaddall}\oarg{glossary list}\\[10pt] -If there are multiple glossaries, you can specify to add only -those entries which belong to the glossaries listed in -\meta{glossary list} (which must be a comma separated list of -glossary names). For example: +\cs{glsaddall}\oarg{options}\\[10pt] +The optional argument is the same as for \cs{glsadd}, except +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 +notation (specified by the glossary type \texttt{notation}) then you can +do: \begin{verbatim} -\glsaddall[notation] +\glsaddall[types={\acronymtype,notation}] \end{verbatim} -will add all the entries that have been defined for the glossary -labelled \dq{notation}.\ifmakedtx{}{\toTop} +\ifmakedtx{}{\toTop} \subsection{Displaying a glossary} \DescribeMacro{\printglossaries} The command \cs{printglossaries} will display all the -defined glossaries. Note that no glossaries will appear until +glossaries in the order in which they were defined. +Note that no glossaries will appear until you have either used the Perl script \appname{makeglossaries} or have directly used \appname{makeindex} (as described in \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the Associated Glossary Files}{sec:makeglossaries}}). If the glossary still @@ -1293,7 +1516,7 @@ Remember that you also need to use the command \ics{makeglossaries} in the preamble to enable the glossaries. \DescribeMacro{\printglossary} -An individual glossary is displayed using:\\[10pt] +An individual glossary can be displayed using:\\[10pt] \cs{printglossary}\oarg{options}\\[10pt] where \meta{options} is a \meta{key}=\meta{value} list of options. The following keys are available: @@ -1377,16 +1600,16 @@ medium weight small caps, then you can do: \DescribeMacro{\newglossary} A new glossary can be defined using:\\[10pt] \cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\oarg{counter}\\[10pt] -where \meta{name} is label to assign to this glossary. The arguments +where \meta{name} is the label to assign to this glossary. The 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 \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}.) The +lists\iterm{number list} (see also \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}). The first optional argument specifies the extension for the \appname{makeindex} transcript file (this information is only used by \appname{makeglossaries} which picks up the information from the -auxiliary file.) +auxiliary file). Note that the main (default) glossary is automatically created as: \begin{verbatim} @@ -1411,18 +1634,19 @@ otherwise it is set to \texttt{main}.\ifmakedtx{}{\toTop} As you may have noticed in \ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary Entries}{sec:newglosentry}}, when you specify a new entry, you can specify alternate text to use when the term is first used in the document. This provides a useful -means to define acronyms. The \sty{glossaries} package defines -the command:\\[10pt] +means to define acronyms. For convenience, the \sty{glossaries} package +defines the command:\\[10pt] \cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt] -This is equivalent to:\vskip5pt +By default, this is equivalent to:\vskip5pt \begin{ttfamily}\par\noindent \cs{newglossaryentry}\textrm{\marg{label}}\{type=\cs{acronymtype},\\ name=\textrm{\marg{abbrv}},\\ description=\textrm{\marg{long}},\\ text=\textrm{\marg{abbrv}},\\ first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\},\\ -plural=\{\textrm{\meta{abbrv}}s\},\\ -firstplural=\{\textrm{\meta{long}}s (\textrm{\meta{abbrv}}s)\},\\ +plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\},\\ +firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} +(\textrm{\meta{abbrv}}\cs{glspluralsuffix})\},\\ \textrm{\meta{key-val list}}\}\par \end{ttfamily} \vskip5pt @@ -1431,6 +1655,14 @@ 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}. The acronyms can then be used in exactly the same way as any other glossary entry. + +(\textbf{Note:} 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 +\meta{type} will not have an effect unless you explicitly set the +type as \verb|type=\glsdefaulttype|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.) + + For example, the following defines the acronym IDN: \begin{verbatim} \newacronym{idn}{IDN}{identification number} @@ -1448,33 +1680,45 @@ firstplural={identification numbers (IDNs)}} so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on first use and \dq{IDN} on subsequent uses. -The \sty{glossaries} package has options that change the -definition of \ics{newacronym} for common acronym formats. These -options also change the way the link text is displayed for the -acronyms. - -Table~\ref{tab:acronymsettings} lists the package options and -how the keys are used to store \meta{long} (the long form) and -\meta{abbrv} (the short form). Note that the \pkgopt{smallcaps} -option redefines \ics{acronymfont} so that it sets its argument -in small captials otherwise \cs{acronymfont} simply displays its -argument in the surrounding font. Note also that if none of -the package options \pkgopt{smallcaps}, \pkgopt{description} -or \pkgopt{footnote} are used, \cs{acronymfont} is not used, so -changing the definition of \cs{acronymfont} will have no effect -under such circumstances. +This section describes acronyms that have been defined using +\cs{newacronym}. If you prefer to define all your acronyms using +\cs{newglossaryentry} explicitly, then you should skip this section +and ignore the package options: \pkgopt{smallcaps}, \pkgopt{smaller}, +\pkgopt{description}, \pkgopt{dua}, \pkgopt{footnote} and +\pkgopt{shortcuts}, 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 +\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{earlier}{sec:glsdisplay}}). +Likewise you should ignore the new commands described in this section, +such as \cs{acrshort}, as they vary according to the definition of +\cs{newacronym}. + + +\Tableref{tab:acronymsettings} lists the package options 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 \ics{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{smaller}\footnote{\cs{smaller} is defined +in the \sty{relsize} package.}, otherwise \cs{acronymfont} simply +displays its argument in the surrounding font. Note also that if none +of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +\pkgopt{dua}, \pkgopt{description} or \pkgopt{footnote} are used, +\cs{acronymfont} is not used, so changing the definition of +\cs{acronymfont} will have no effect under such circumstances. \begin{table}[htbp] -\caption{Package options governing acronyms and how the information -is stored in the glossary keys} +\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} & -\gloskey{text} & -\gloskey{description} & -\gloskey{symbol}\\ +\gloskey{first} key & +\gloskey{text} key & +\gloskey{description} key & +\gloskey{symbol} key\\ \pkgopt{description},\pkgopt{footnote} & \meta{abbrv} & \meta{abbrv} & @@ -1500,6 +1744,11 @@ user supplied & \meta{abbrv} & \meta{long} & \meta{abbrv}\\ +\pkgopt{smaller} & +\meta{long} & +\meta{abbrv} & +\meta{long} & +\meta{abbrv}\\ \pkgopt{dua} & \meta{long} & \meta{long} & @@ -1535,7 +1784,8 @@ matrix} If the first use uses the plural form, \verb|\glspl{dm}| will display: diagonal matrices (DMs). -Each of the package options \pkgopt{smallcaps}, \pkgopt{footnote} +Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +\pkgopt{footnote}, \pkgopt{dua} and \pkgopt{description} use \ics{defglsdisplay} and \ics{defglsdisplayfirst} (described \ifmakedtx{in \autoref{sec:glsdisplay}}{\htmlref{earlier}{sec:glsdisplay}}) @@ -1543,7 +1793,7 @@ to change the way the link text is displayed. \begin{description} \item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} -When these two options are used together, the first use displays +When these two package options are used together, the first use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} \\[10pt] @@ -1556,22 +1806,22 @@ variants. Note also that when these two package options are used (in the given order), the \sty{glossaries} package additionally implements the \pkgopt{sanitize} option using -\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so +\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so remember to protect fragile commands when defining acronyms. \item[dua]\ifmakedtx{\mbox{}\par}{} The \pkgopt{dua} package option always displays the expanded -form and so may not be used with \pkgopt{footnote} or +form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or \pkgopt{smallcaps}. Both first use and subsequent use displays the entry in the form:\\[10pt] \meta{long}\meta{insert}\\[10pt] -If the \pkgopt{description} 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. +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. \item[\pkgopt{description}]\ifmakedtx{\mbox{}\par}{} -This option displays the entry on first use as:\\[10pt] +This package option displays the entry on first use as:\\[10pt] \meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] @@ -1581,7 +1831,7 @@ package additionally implements the option remember to protect fragile commands when defining acronyms. \item[\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} -This option displays the entry on first use as:\\[10pt] +This package option displays the entry on first use as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert} @@ -1597,7 +1847,21 @@ have been set, this option displays the entry on first use as:\\[10pt] \meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] -where \cs{acronymfont} is set to \cs{textsc}. +where \cs{acronymfont} is set to \verb|\textsc{#1}|, so \meta{abbrv} +should be specified in lower case. + +Note also that if this package option is used, the \sty{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}]\ifmakedtx{\mbox{}\par}{} +If neither the \pkgopt{footnote} nor \pkgopt{description} options +have been set, this option displays the entry on first use as:\\[10pt] +\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +while subsequent use displays the entry as:\\[10pt] +\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +where \cs{acronymfont} is set to \verb|{\smaller #1}|. Note also that if this package option is used, the \sty{glossaries} package additionally implements the option @@ -1605,9 +1869,9 @@ package additionally implements the option remember to protect fragile commands when defining acronyms. \item[None of the above]\ifmakedtx{\mbox{}\par}{} -If none of the package options \pkgopt{smallcaps}, \pkgopt{footnote} -or \pkgopt{description} are used, then on first use the entry is -displayed as:\\[10pt] +If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +\pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, +then on first use the entry is displayed as:\\[10pt] \meta{long} (\meta{abbrv})\meta{insert}\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] @@ -1661,16 +1925,49 @@ may additionally need to change the above commands as well as the changing way the text is displayed using \ics{defglsdisplay} and \ics{defglsdisplayfirst}. +The package option \pkgopt{shortcuts} provides the synonyms listed +in \tableref{tab:shortcuts}. If any of those commands generate +an \dq{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. + +\begin{table}[htbp] +\caption{Synonyms provided by the package option \pkgopt{shortcuts}} +\label{tab:shortcuts} +\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} +\end{tabular} +\end{center} +\end{table} + \ifmakedtx{}{\toTop} \subsection{Unsetting and resetting entry flags} -When using commands such as \ics{gls} 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. 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:\\[10pt] +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. 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:\\[10pt] \DescribeMacro{\glsreset}\cs{glsreset}\marg{label}\\ \DescribeMacro{\glslocalreset}\cs{glslocalreset}\marg{label}\\[10pt] while the latter can be achieved by one of the following commands:\\[10pt] @@ -1694,7 +1991,7 @@ glossary styles. These are as follows: 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 number -list for that entry. +list for that entry. Sub groups are separated using \cs{indexspace}. \item[listgroup] The \glostyle{listgroup} style is like \glostyle{list} but the glossary groups have headings. @@ -1725,6 +2022,7 @@ supplied by Axel~Menzel.} environment (defined by the \isty{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}. +Sub groups are separated with a blank row. \item[longborder] The \glostyle{longborder} style is like \glostyle{long} but has horizontal and vertical lines around it. @@ -1771,6 +2069,7 @@ around it. environment (defined by the \isty{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}. +Sub groups are separated with a blank row. \item[superborder] The \glostyle{superborder} style is like \glostyle{super} but has horizontal and vertical lines around it. @@ -1825,7 +2124,7 @@ All the styles except for the three- and four-column styles and the \glostyle{listdotted} style use the command \DescribeMacro{\glspostdescription}\cs{glspostdescription} 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 +this full stop (or replace it with something else, say a comma) you will need to redefine \cs{glspostdescription} before the glossary is displayed.\ifmakedtx{}{\toTop} @@ -2026,6 +2325,29 @@ than \cs{emph}.) Note however that \verb|\makefirstuc{\ae{}bc}| produces \ae Bc since the empty group following \cs{ae} is considered to be the argument of \cs{ae} which is in fact not the case. + +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 \verb|\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:\\[10pt] +\DescribeMacro{\xmakefirstuc} +\cs{xmakefirstuc}\marg{stuff}\\[10pt] +This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuff}. So +\begin{verbatim} +\newcommand{\abc}{abc} +\xmakefirstuc{\abc} +\end{verbatim} +produces: Abc. + \ifmakedtx{}{\toTop} \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf Binary files differindex b8489784a93..ef70c06fb7f 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/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf Binary files differindex 87013fafe46..275dcac7391 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/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index b9d3cf6c7e6..eeaf583892d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -32,7 +32,6 @@ description={a sample entry}} \newacronym{aca}{aca}{a contrived acronym} \begin{document} - A \gls{sample} entry and \gls{aca}. \printglossaries diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex index 67b78bc4575..8467841b6e3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex @@ -1,6 +1,6 @@ \documentclass[a4paper]{article} -\usepackage[style=long4colheader]{glossaries} +\usepackage[style=long4colheaderborder]{glossaries} \makeglossaries @@ -12,7 +12,7 @@ symbol=m} \newglossaryentry{M}{name={$M$}, sort=M, description={mass}, -symbol={kg}} +symbol=kg} \begin{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex index 2b26e982be0..02531ff49a0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex @@ -5,8 +5,6 @@ \makeglossaries -\renewcommand*{\glstextformat}[1]{\textsf{#1}} - \newacronym{svm}% label {svm}% abbreviation {support vector machine}% long form diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex index 8014d656b42..e8945a270e3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex @@ -4,31 +4,22 @@ \usepackage[style=altlist, % use altlist style toc, % add the glossary to the table of contents - sanitize={description=false}% don't sanitize description + sanitize={description=false},% want to use description in main document + description% acronyms have a user-supplied description ]{glossaries} \makeglossaries -\newglossaryentry{svm}{ - % how the entry name should appear in the glossary -name={Support vector machine (SVM)}, - % how the description should appear in the glossary - % since I have used sanitize={description=false} - % I have to protect fragile commands -description={Statistical pattern recognition -technique~\protect\cite{svm}}, - % how the entry should appear in the document text -text={svm}, - % how the entry should appear the first time it is - % used in the document text -first={support vector machine (svm)}} - -\newglossaryentry{ksvm}{ -name={Kernel support vector machine (KSVM)}, -description={Statistical pattern recognition technique -using the ``kernel trick'' (see also SVM)}, -text={ksvm}, -first={kernel support vector machine}} +\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 SVM)},% acronym's description +name={Kernel support vector machine (ksvm)}% change the default way of displaying the entry name in the list of acronyms +]{ksvm}{ksvm}{kernel +support vector machine} \begin{document} \tableofcontents @@ -60,6 +51,6 @@ one \gls[format=hyperbf]{svm}. \bibitem{svm} \ldots \end{thebibliography} -\printglossary[title={Acronyms}] +\printglossary \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex new file mode 100644 index 00000000000..47c639cb9c7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex @@ -0,0 +1,66 @@ +% See also sampleAcrDesc.tex +\documentclass[a4paper]{report} + +\usepackage[colorlinks,plainpages=false]{hyperref} + +\usepackage[style=altlist, % use altlist style + toc, % add the glossary to the table of contents + sanitize={description=false}% don't sanitize description + ]{glossaries} + +\makeglossaries + +\newglossaryentry{svm}{ + % how the entry name should appear in the glossary +name={Support vector machine (SVM)}, + % how the description should appear in the glossary + % since I have used sanitize={description=false} + % I have to protect fragile commands +description={Statistical pattern recognition +technique~\protect\cite{svm}}, + % how the entry should appear in the document text +text={svm}, + % how the entry should appear the first time it is + % used in the document text +first={support vector machine (svm)}} + +\newglossaryentry{ksvm}{ +name={Kernel support vector machine (KSVM)}, +description={Statistical pattern recognition technique +using the ``kernel trick'' (see also SVM)}, +text={ksvm}, +first={kernel support vector machine}} + +\begin{document} +\tableofcontents + +\chapter{Support Vector Machines} + +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}. + +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''. + +\glsresetall +Possessive: \gls{ksvm}['s]. +Make the glossary entry number bold for this +one \gls[format=hyperbf]{svm}. + +\begin{thebibliography}{1} +\bibitem{svm} \ldots +\end{thebibliography} + +\printglossary[title={Acronyms}] + +\end{document} |