diff options
| author | Karl Berry <karl@freefriends.org> | 2010-06-14 22:31:40 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2010-06-14 22:31:40 +0000 |
| commit | b3f1741ccbe6dede2fc5cc309815e40728c0330f (patch) | |
| tree | e9c7d2ffc516d8fff6defbf3b85205078e1701f9 /Master | |
| parent | fa2a29ef6564da92ff9b4caede3dd5456dd48eb6 (diff) | |
glossaries 2.06 (14jun10)
git-svn-id: svn://tug.org/texlive/trunk@18975 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
53 files changed, 24518 insertions, 12885 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 301385bb1df..a87aa331f52 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,18 @@ glossaries change log: +v2.06: + * Added \altnewglossary + + * added facility to customise acronyms if the predefined styles + don't fit the user's requirements. + + * Serbian dictionary added (provided by Zoran Filipovic) + + makeglossaries: + + * Scans aux file for \@input in case \printglossary is in an + imported file. + v2.05: * Fixed error in .ist file and in \glsdisp caused by a misplace brace. (Patch provided by Sergiu Dotenco). diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index dc817265d98..3fa2c7734d7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v 2.05 +LaTeX Package : glossaries v2.06 -Last Modified : 6th Feb 2010 +Last Modified : 2010-06-14 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html index fa720e999b8..6c8abe4af1f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html @@ -1,8359 +1,14573 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with LaTeX2HTML 2002 (1.67) -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>glossaries.sty v 2.05: LaTeX2e Package to Assist Generating Glossaries</TITLE> -<META NAME="description" CONTENT="glossaries.sty v 2.05: LaTeX2e Package to Assist Generating Glossaries"> -<META NAME="keywords" CONTENT="glossaries-manual"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> -<META NAME="Generator" CONTENT="LaTeX2HTML v2002"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > -<A NAME="top"></A> - -<P> - -<P> - - <H1 ALIGN="CENTER">glossaries.sty v 2.05: LaTeX2e Package to Assist Generating Glossaries</H1> -<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot -<BR> -<BR> -School of Computing Sciences -<BR> -University of East Anglia -<BR> -Norwich. Norfolk -<BR> -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>6th Feb 2010</STRONG></P> -<BR> - -<H2><A NAME="SECTION00010000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html91" - HREF="glossaries-manual.html#SECTION00020000000000000000">Introduction</A> -<UL> -<LI><A NAME="tex2html92" - HREF="glossaries-manual.html#SECTION00021000000000000000">Sample Documents</A> -<LI><A NAME="tex2html93" - HREF="glossaries-manual.html#SECTION00022000000000000000">Multi-Lingual Support</A> -<UL> -<LI><A NAME="tex2html94" - HREF="glossaries-manual.html#SECTION00022100000000000000">Changing the Fixed Names</A> -</UL> -<LI><A NAME="tex2html95" - HREF="glossaries-manual.html#SECTION00023000000000000000">Generating the Associated Glossary Files</A> -<UL> -<LI><A NAME="tex2html96" - HREF="glossaries-manual.html#SECTION00023100000000000000">Using the makeglossaries Perl Script</A> -<LI><A NAME="tex2html97" - HREF="glossaries-manual.html#SECTION00023200000000000000">Using xindy explicitly</A> -<LI><A NAME="tex2html98" - HREF="glossaries-manual.html#SECTION00023300000000000000">Using makeindex explicitly</A> -<LI><A NAME="tex2html99" - HREF="glossaries-manual.html#SECTION00023400000000000000">Note to Front-End and Script Developers</A> -</UL> -<LI><A NAME="tex2html100" - HREF="glossaries-manual.html#SECTION00024000000000000000">Troubleshooting</A> -</UL> -<BR> -<LI><A NAME="tex2html101" - HREF="glossaries-manual.html#SECTION00030000000000000000">Overview of Main User Commands</A> -<UL> -<LI><A NAME="tex2html102" - HREF="glossaries-manual.html#SECTION00031000000000000000">Package Options</A> -<LI><A NAME="tex2html103" - HREF="glossaries-manual.html#SECTION00032000000000000000">Defining Glossary Entries</A> -<UL> -<LI><A NAME="tex2html104" - HREF="glossaries-manual.html#SECTION00032100000000000000">Plurals</A> -<LI><A NAME="tex2html105" - HREF="glossaries-manual.html#SECTION00032200000000000000">Sub-Entries</A> -<LI><A NAME="tex2html106" - HREF="glossaries-manual.html#SECTION00032300000000000000">Loading Entries From a File</A> -</UL> -<LI><A NAME="tex2html107" - HREF="glossaries-manual.html#SECTION00033000000000000000">Number lists</A> -<LI><A NAME="tex2html108" - HREF="glossaries-manual.html#SECTION00034000000000000000">Links to Glossary Entries</A> -<UL> -<LI><A NAME="tex2html109" - HREF="glossaries-manual.html#SECTION00034100000000000000">Changing the format of the link text</A> -<LI><A NAME="tex2html110" - HREF="glossaries-manual.html#SECTION00034200000000000000">Enabling and disabling hyperlinks to glossary entries</A> -</UL> -<LI><A NAME="tex2html111" - HREF="glossaries-manual.html#SECTION00035000000000000000">Adding an Entry to the Glossary Without Generating Text</A> -<LI><A NAME="tex2html112" - HREF="glossaries-manual.html#SECTION00036000000000000000">Cross-Referencing Entries</A> -<LI><A NAME="tex2html113" - HREF="glossaries-manual.html#SECTION00037000000000000000">Using Glossary Terms Without Links</A> -<LI><A NAME="tex2html114" - HREF="glossaries-manual.html#SECTION00038000000000000000">Displaying a glossary</A> -<UL> -<LI><A NAME="tex2html115" - HREF="glossaries-manual.html#SECTION00038100000000000000">Changing the way the entry name appears in the glossary</A> -<LI><A NAME="tex2html116" - HREF="glossaries-manual.html#SECTION00038200000000000000">Xindy</A> -</UL> -<LI><A NAME="tex2html117" - HREF="glossaries-manual.html#SECTION00039000000000000000">Defining New Glossaries</A> -<LI><A NAME="tex2html118" - HREF="glossaries-manual.html#SECTION000310000000000000000">Acronyms</A> -<UL> -<LI><A NAME="tex2html119" - HREF="glossaries-manual.html#SECTION000310100000000000000">Upgrading From the glossary Package</A> -</UL> -<LI><A NAME="tex2html120" - HREF="glossaries-manual.html#SECTION000311000000000000000">Unsetting and Resetting Entry Flags</A> -<LI><A NAME="tex2html121" - HREF="glossaries-manual.html#SECTION000312000000000000000">Glossary Styles</A> -<UL> -<LI><A NAME="tex2html122" - HREF="glossaries-manual.html#SECTION000312100000000000000">List Styles</A> -<LI><A NAME="tex2html123" - HREF="glossaries-manual.html#SECTION000312200000000000000">Longtable Styles</A> -<LI><A NAME="tex2html124" - HREF="glossaries-manual.html#SECTION000312300000000000000">Longtable Styles (Ragged Right)</A> -<LI><A NAME="tex2html125" - HREF="glossaries-manual.html#SECTION000312400000000000000">Supertabular Styles</A> -<LI><A NAME="tex2html126" - HREF="glossaries-manual.html#SECTION000312500000000000000">Supertabular Styles (Ragged Right)</A> -<LI><A NAME="tex2html127" - HREF="glossaries-manual.html#SECTION000312600000000000000">Tree-Like Styles</A> -</UL> -<LI><A NAME="tex2html128" - HREF="glossaries-manual.html#SECTION000313000000000000000">Defining your own glossary style</A> -<UL> -<LI><A NAME="tex2html129" - HREF="glossaries-manual.html#SECTION000313100000000000000">Example: creating a completely new style</A> -<LI><A NAME="tex2html130" - HREF="glossaries-manual.html#SECTION000313200000000000000">Example: creating a new glossary style based on an -existing style</A> -<LI><A NAME="tex2html131" - HREF="glossaries-manual.html#SECTION000313300000000000000">Example: creating a glossary style that uses the -user1, ..., user6 keys</A> -</UL> -<LI><A NAME="tex2html132" - HREF="glossaries-manual.html#SECTION000314000000000000000">Accessibility Support</A> -</UL> -<BR> -<LI><A NAME="tex2html133" - HREF="glossaries-manual.html#SECTION00040000000000000000">Mfirstuc Package</A> -<LI><A NAME="tex2html134" - HREF="glossaries-manual.html#SECTION00050000000000000000">Index</A> -</UL> -<!--End of Table of Contents--> -<P> - -<H1><A NAME="SECTION00020000000000000000"> -Introduction</A> -</H1> - -<P> -The <TT>glossaries</TT> package is provided to assist generating -glossaries. It has a certain amount of flexibility, allowing the -user to customize the format of the glossary and define multiple -glossaries. It also supports acronyms and glossary styles that -include symbols (in addition to a name and description) for glossary -entries. There is provision for loading a database of glossary terms. -Only those terms used<A NAME="tex2html2" - HREF="#foot4474"><SUP>1</SUP></A> in the document will be -added to the glossary. - -<P> -<B>This package replaces the <TT>glossary</TT><A NAME="4545"></A> package which is -now obsolete.</B> Please see -<A NAME="tex2html3" - HREF="glossary2glossaries.html">Upgrading from the glossary package -to the glossaries package</A> -for assistance in upgrading. - -<P> -One of the strengths of this package is its flexibility, however -the drawback of this is the necessity of having a large manual -that can cover all the various settings. If you are daunted by the -size of the manual, try starting off with the much shorter -<A NAME="tex2html4" - HREF="glossariesbegin.html">guide for beginners</A>. - -<P> -The <TT>glossaries</TT> package comes with a -<A NAME="tex2html6" - HREF="http://www.perl.org/about.html">Perl</A> -script -called <TT>makeglossaries</TT><A NAME="4549"></A>. This provides a convenient interface -to <TT>makeindex</TT><A NAME="4552"></A> or <TT>xindy</TT><A NAME="4555"></A>. It is strongly -recommended that you use this script, but <I>it is not -essential</I>. If you are reluctant to install Perl, or for any -other reason you don't want to use <TT>makeglossaries</TT><A NAME="4558"></A>, you -can called <TT>makeindex</TT><A NAME="4561"></A> or <TT>xindy</TT><A NAME="4564"></A> explicitly. -See <A HREF="glossaries-manual.html#sec:makeglossaries">Generating the -Associated Glossary Files</A> for -further details. - -<P> -This manual is structured as follows: - -<UL> -<LI><A HREF="glossaries-manual.html#sec:overview">Overview of Main User Commands</A> -gives an overview of the main user commands and their syntax. - -<P> -</LI> -<LI><A HREF="glossaries-manual.html#sec:mfirstuc">Mfirstuc</A> -describes the associated <TT>mfirstuc</TT> package. - -<P> +<a + id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>glossaries.sty v2.06: LaTeX2εPackage to Assist Generating Glossaries</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,fn-in,css-in --> +<meta name="src" content="glossaries-manual.tex" /> +<meta name="date" content="2010-06-14 14:03:00" /> -</LI> -</UL> -The <A NAME="tex2html5" - HREF="glossaries.pdf">PDF version</A> -of -this manual also describes more advanced commands in the documented -code section (such as determining if an entry or a glossary exists -and commands that iterate through defined terms or glossaries). - -<P> -The remainder of this introductory section covers the -following: - -<UL> -<LI><A HREF="glossaries-manual.html#sec:samples">Sample -Documents</A> lists the sample documents provided -with this package. - -<P> -</LI> -<LI><A HREF="glossaries-manual.html#sec:languages">Multi-Lingual -Support</A> provides information for users who -wish to write in a language other than English. - -<P> -</LI> -<LI><A HREF="glossaries-manual.html#sec:makeglossaries">Generating -the Associated Glossary Files</A> -describes how to use a post-processor to create the sorted glossaries -for your document. - -<P> -</LI> -<LI><A HREF="glossaries-manual.html#sec:trouble">Troubleshooting</A> provides some assistance in the event that you -encounter a problem. -</LI> -</UL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00021000000000000000"></A> -<A NAME="sec:samples"></A> -<BR> -Sample Documents -</H2> - -<P> -The <TT>glossaries</TT> package is provided with some sample -documents that illustrate the various functions. These should -be located in the <TT>samples</TT> subdirectory (folder) of the -<TT>glossaries</TT> documentation directory. This location varies -according to your operating system and T<SMALL>E</SMALL>X distribution. You -can use <TT>texdoc</TT> to locate the main glossaries documentation. -For example, in a terminal or command prompt, type: -<PRE> -texdoc -l glossaries -</PRE> -This should display the full pathname of the file -<TT>glossaries.pdf</TT>. View the contents of that directory and -see if it contains the <TT>samples</TT> subdirectory. - -<P> -If you can't find the sample files, they are available in the -subdirectory <TT>doc/latex/glossaries/samples/</TT> in the -<TT>glossaries.tds.zip</TT> archive which can be downloaded from -<A NAME="tex2html7" - HREF="http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/">CTAN</A>. - -<P> -The sample documents are as follows: -<DL> -<DT><STRONG>minimalgls.tex</STRONG></DT> -<DD><A NAME="ex:minimalgls"></A> This document is a minimal working example. -You can test your installation using this file. To create the -complete document you will need to do the following steps: - -<OL> -<LI>Run <TT>minimalgls.tex</TT> through LaTeX either by - typing -<PRE> -latex minimalgls -</PRE> - in a terminal or by using the relevant button or menu item in - your text editor or front-end. This will create the required - associated files but you will not see the glossary. If you use - PDFLaTeX you will also get warnings about non-existent - references. These warnings may be ignored on the first run. - -<P> -If you get a <code>Missing \begin{document}</code> error, then - it's most likely that your version of <TT>xkeyval</TT><A NAME="4574"></A> is - out of date. Check the log file for a warning of that nature. - If this is the case, you will need to update the <TT>xkeyval</TT> - package. - -<P> -</LI> -<LI>Run <TT>makeglossaries</TT><A NAME="4578"></A> on the document. This can - be done on a terminal either by typing -<PRE> -makeglossaries minimalgls -</PRE> - or by typing -<PRE> -perl makeglossaries minimalgls -</PRE> - If your system doesn't recognise the command <TT>perl</TT> then - it's likely you don't have Perl installed. In which case you - will need to use <TT>makeindex</TT><A NAME="4581"></A> directly. You can do this - in a terminal by typing (all on one line): -<PRE> -makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls -minimalgls.glo -</PRE> - (See -<A HREF="glossaries-manual.html#sec:makeindexapp">later</A> - for further details on using <TT>makeindex</TT><A NAME="4584"></A> explicitly.) - -<P> -Note that if you need to specify the full path and the path - contains spaces, you will need to delimit the file names with - the double-quote character. - -<P> -</LI> -<LI>Run <TT>minimalgls.tex</TT> through LaTeX again (as step 1) - -</LI> -</OL> -You should now have a complete document. The number following -each entry in the glossary is the location number. By default, this -is the page number where the entry was referenced. - -<P> -</DD> -<DT><STRONG>sample4col.tex</STRONG></DT> -<DD><A NAME="ex:sample4col"></A> This document illustrates a four column -glossary where the entries have a symbol in addition to the -name and description. To create the complete document, you need -to do: -<PRE> -latex sample4col -makeglossaries sample4col -latex sample4col -</PRE> -As before, if you don't have Perl installed, you will need to -use <TT>makeindex</TT><A NAME="4587"></A> directly instead of using -<TT>makeglossaries</TT><A NAME="4590"></A>. The vertical gap between entries -is the gap created at the start of each group. This can be -suppressed by redefining <TT>\glsgroupskip</TT><A NAME="4593"></A> after the glossary -style has been set: -<PRE> -\renewcommand*{\glsgroupskip}{} -</PRE> - -<P> -</DD> -<DT><STRONG>sampleAcr.tex</STRONG></DT> -<DD><A NAME="ex:sampleAcr"></A> This document has some sample acronyms. It -also adds the glossary to the table of contents, so an extra -run through LaTeX is required to ensure the document is up to date: -<PRE> -latex sampleAcr -makeglossaries sampleAcr -latex sampleAcr -latex sampleAcr -</PRE> - -<P> -</DD> -<DT><STRONG>sampleAcrDesc.tex</STRONG></DT> -<DD><A NAME="ex:sampleAcrDesc"></A> This is similar to the previous example, -except that the acronyms have an associated description. As with -the previous example, the glossary is added to the table of -contents, so an extra run through LaTeX is required: -<PRE> -latex sampleAcrDesc -makeglossaries sampleAcrDesc -latex sampleAcrDesc -latex sampleAcrDesc -</PRE> - -<P> -</DD> -<DT><STRONG>sampleDesc.tex</STRONG></DT> -<DD><A NAME="ex:sampleDesc"></A> This is similar to the previous example, -except that it defines the acronyms using <TT>\newglossaryentry</TT><A NAME="4596"></A> -instead of <TT>\newacronym</TT><A NAME="4599"></A>. As with -the previous example, the glossary is added to the table of -contents, so an extra run through LaTeX is required: -<PRE> -latex sampleDesc -makeglossaries sampleDesc -latex sampleDesc -latex sampleDesc -</PRE> - -<P> -</DD> -<DT><STRONG>sampleDB.tex</STRONG></DT> -<DD><A NAME="ex:sampleDB"></A> This document illustrates how to load -external files containing the glossary definitions. It also -illustrates how to define a new glossary type. This document -has the number list<A NAME="4601"></A> suppressed and uses <TT>\glsaddall</TT><A NAME="4603"></A> to add -all the entries to the glossaries without referencing each one -explicitly. To create the document do: -<PRE> -latex sampleDB -makeglossaries sampleDB -latex sampleDB -</PRE> -The glossary definitions are stored in the accompanying files -<TT>database1.tex</TT> and <TT>database2.tex</TT>. Note that if -you don't have Perl installed, you will need to use -<TT>makeindex</TT><A NAME="4606"></A> twice instead of a single call to -<TT>makeglossaries</TT><A NAME="4609"></A>: - -<OL> -<LI>Create the main glossary: -<PRE> -makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -</PRE> -</LI> -<LI>Create the secondary glossary: -<PRE> -makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn -</PRE> -</LI> -</OL> - -<P> -</DD> -<DT><STRONG>sampleEq.tex</STRONG></DT> -<DD><A NAME="ex:sampleEq"></A> This document illustrates how to change the -location to something other than the page number. In this case, -the <TT>equation</TT> counter is used since all glossary entries -appear inside an <TT>equation</TT> environment. To create the -document do: -<PRE> -latex sampleEq -makeglossaries sampleEq -latex sampleEq -</PRE> - -<P> -</DD> -<DT><STRONG>sampleEqPg.tex</STRONG></DT> -<DD><A NAME="ex:sampleEqPg"></A> This is similar to the previous example, -but the number lists<A NAME="4612"></A> are a mixture of page -numbers and equation numbers. This example adds the glossary to the -table of contents, so an extra LaTeX run is required: -<PRE> -latex sampleEqPg -makeglossaries sampleEqPg -latex sampleEqPg -latex sampleEqPg -</PRE> - -<P> -</DD> -<DT><STRONG>sampleSec.tex</STRONG></DT> -<DD><A NAME="ex:sampleSec"></A> This document also illustrates how to change -the location to something other than the page number. In this case, -the <TT>section</TT> counter is used. This example adds the -glossary to the table of contents, so an extra LaTeX run is -required: -<PRE> -latex sampleSec -makeglossaries sampleSec -latex sampleSec -latex sampleSec -</PRE> - -<P> -</DD> -<DT><STRONG>sampleNtn.tex</STRONG></DT> -<DD><A NAME="ex:sampleNtn"></A> This document illustrates how to create -an additional glossary type. This example adds the glossary to the -table of contents, so an extra LaTeX run is required: -<PRE> -latex sampleNtn -makeglossaries sampleNtn -latex sampleNtn -latex sampleNtn -</PRE> -Note that if you don't have Perl installed, you will need to use -<TT>makeindex</TT><A NAME="4614"></A> twice instead of a single call to -<TT>makeglossaries</TT><A NAME="4617"></A>: - -<OL> -<LI>Create the main glossary: -<PRE> -makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -</PRE> -</LI> -<LI>Create the secondary glossary: -<PRE> -makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn -</PRE> -</LI> -</OL> - -<P> -</DD> -<DT><STRONG>sample.tex</STRONG></DT> -<DD><A NAME="ex:sample"></A> This document illustrates some of the basics, -including how to create child entries that use the same name as the -parent entry. This example adds the glossary to the table of -contents, so an extra LaTeX run is required: -<PRE> -latex sample -makeglossaries sample -latex sample -latex sample -</PRE> -You can see the difference between word and letter ordering -if you substitute <TT>order=word</TT><A NAME="4627"></A> with -<TT>order=letter</TT><A NAME="4636"></A>. (Note that this will only have an -effect if you use <TT>makeglossaries</TT><A NAME="4638"></A>. If you use -<TT>makeindex</TT><A NAME="4641"></A> explicitly, you will need to use the -<TT>-l</TT> switch to indicate letter ordering.) - -<P> -</DD> -<DT><STRONG>sampletree.tex</STRONG></DT> -<DD><A NAME="ex:sampletree"></A> This document illustrates a hierarchical -glossary structure where child entries have different names -to their corresponding parent entry. To create the document do: -<PRE> -latex sampletree -makeglossaries sampletree -latex sampletree -</PRE> - -<P> -</DD> -<DT><STRONG>samplexdy.tex</STRONG></DT> -<DD><A NAME="ex:samplexdy"></A> This document illustrates how to use the -<TT>glossaries</TT> package with <TT>xindy</TT><A NAME="4645"></A> instead of -<TT>makeindex</TT><A NAME="4648"></A>. The document uses UTF8 encoding (with the -<TT>inputenc</TT><A NAME="4651"></A> package). The encoding is picked up by -<TT>makeglossaries</TT><A NAME="4654"></A>. By default, this document will create -a <TT>xindy</TT><A NAME="4657"></A> style file called <TT>samplexdy.xdy</TT>, but -if you uncomment the lines -<PRE> -\setStyleFile{samplexdy-mc} -\noist -\GlsSetXdyLanguage{} -</PRE> -it will set the style file to <TT>samplexdy-mc.xdy</TT> instead. -This provides an additional letter group for entries starting -with "Mc" or "Mac". If you use <TT>makeglossaries</TT><A NAME="4660"></A>, -you don't need to supply any additional information. If you -don't use <TT>makeglossaries</TT><A NAME="4663"></A>, you will need to specify the -required information. Note that if you set the style file to -<TT>samplexdy-mc.xdy</TT> you must also specify <TT>\noist</TT><A NAME="4666"></A>, -otherwise the <TT>glossaries</TT> package will overwrite -<TT>samplexdy-mc.xdy</TT> and you will lose the "Mc" letter group. - -<P> -To create the document do: -<PRE> -latex samplexdy -makeglossaries samplexdy -latex samplexdy -</PRE> -If you don't have Perl installed, you will have to call -<TT>xindy</TT><A NAME="4670"></A> explicitly instead of using <TT>makeglossaries</TT><A NAME="4673"></A>. -If you are using the default style file <TT>samplexdy.xdy</TT>, then -do (no line breaks): -<PRE> -xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg --o samplexdy.gls samplexdy.glo -</PRE> -otherwise, if you are using <TT>samplexdy-mc.xdy</TT>, then do -(no line breaks): -<PRE> -xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls -samplexdy.glo -</PRE> - -<P> -</DD> -<DT><STRONG>sampleutf8.tex</STRONG></DT> -<DD><A NAME="ex:sampleutf8"></A> This is another example that uses -<TT>xindy</TT><A NAME="4676"></A>. Unlike <TT>makeindex</TT><A NAME="4679"></A>, <TT>xindy</TT><A NAME="4682"></A> can -cope with accented or non-Latin characters. This document uses -UTF8 encoding. To create the document do: -<PRE> -latex sampleutf8 -makeglossaries sampleutf8 -latex sampleutf8 -</PRE> -If you don't have Perl installed, you will have to call -<TT>xindy</TT><A NAME="4685"></A> explicitly instead of using <TT>makeglossaries</TT><A NAME="4688"></A> -(no line breaks): -<PRE> -xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg --o sampleutf8.gls sampleutf8.glo -</PRE> - -<P> -If you remove the <TT>xindy</TT><A NAME="4696"></A> option from <TT>sampleutf8.tex</TT> -and do: -<PRE> -latex sampleutf8 -makeglossaries sampleutf8 -latex sampleutf8 -</PRE> -you will see that the entries that start with a non-Latin character -now appear in the symbols group, and the word "manœuvre" is now -after "manor" instead of before it. If you are unable to use -<TT>makeglossaries</TT><A NAME="4700"></A>, the call to <TT>makeindex</TT><A NAME="4703"></A> is as -follows (no line breaks): -<PRE> -makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls -sampleutf8.glo -</PRE> - -<P> -</DD> -<DT><STRONG>sampleaccsupp.tex</STRONG></DT> -<DD><A NAME="ex:sampleaccsupp"></A> This document -uses the experimental <TT>glossaries-accsupp</TT><A NAME="4706"></A> package. The -symbol is set to the replacement text. Note that some PDF -viewers don't use the accessibility support. Information -about the <TT>glossaries-accsupp</TT> package can be found in -<A HREF="glossaries-manual.html#sec:accsupp">"Accessibility Support"</A>. - -<P> -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00022000000000000000"></A> -<A NAME="sec:languages"></A> -<BR> -Multi-Lingual Support -</H2> - -<P> -As from version 1.17, the <TT>glossaries</TT> package can now be -used with <TT>xindy</TT><A NAME="4714"></A> as well as <TT>makeindex</TT><A NAME="4717"></A>. If you -are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use <TT>xindy</TT><A NAME="4720"></A> -as <TT>makeindex</TT><A NAME="4723"></A> is hard-coded for Latin languages. This -means that you are not restricted to the A, ..., Z letter groups. -If you want to use <TT>xindy</TT><A NAME="4726"></A>, remember to use the -<TT>xindy</TT><A NAME="4734"></A> package option. For example: -<PRE> +<style type="text/css"> +<!-- + +/* start css.sty */ +.cmmi-10{font-style: italic;} +.ecrm-1728{font-size:170%;} +.cmmi-12x-x-144{font-size:172%;font-style: italic;} +.ecrm-1200{font-size:120%;} +.ectt-1200{font-size:120%; font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ectt-1200{ font-family: monospace;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ecss-1000{ font-family: sans-serif;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ectt-1000{ font-family: monospace;} +.ecrm-0900{font-size:90%;} +.ecrm-0800{font-size:80%;} +.ectt-0800{font-size:80%; font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ectt-0800{ font-family: monospace;} +.ecss-0800{font-size:80%; font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecss-0800{ font-family: sans-serif;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecbx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecsx-1000{ font-weight: bold;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ecti-1000{ font-style: italic;} +.ectt-0900{font-size:90%; font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +.ectt-0900{ font-family: monospace;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;} +div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;} +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.bar-css {text-decoration:overline;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } +.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } +.abstract p {margin-left:5%; margin-right:5%;} +div.abstract {width:100%;} +table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } +.alltt P { margin-bottom : 0em; margin-top : 0em; } +.alltt { margin-bottom : 1em; margin-top : 1em; } +div.important { background-color:red; } +/* end css.sty */ + + +--> +</style> +</head><body +> + <div class="maketitle"> + + + + + + + +<h2 class="titleHead">glossaries.sty v2.06: <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>2ε Package to Assist +Generating Glossaries</h2> + <div class="author" ><span +class="ecrm-1200">Nicola L.C. Talbot</span> +<br /> <span +class="ecrm-1200">School of Computing Sciences</span> +<br /> <span +class="ecrm-1200">University of East Anglia</span> +<br /> <span +class="ecrm-1200">Norwich. Norfolk</span> +<br /> <span +class="ecrm-1200">NR4 7TJ. United Kingdom.</span> +<br /><a +href="http://theoval.cmp.uea.ac.uk/~nlct/" class="url" ><span +class="ectt-1200">http://theoval.cmp.uea.ac.uk/~nlct/</span></a></div><br /> +<div class="date" ><span +class="ecrm-1200">2010-06-14</span></div> + </div> +<!--l. 58--><p class="indent" > This is the user manual for the <span +class="ecss-1000">glossaries </span>package. Other documents accompanying +this manual: </p> + <ul class="itemize1"> + <li class="itemize"><a +href="glossariesbegin.html" >“The glossaries package: a guide for beginners”</a> + </li> + <li class="itemize"><a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a></li></ul> +<!--l. 65--><p class="noindent" >See the file <span +class="ectt-1000">INSTALL </span>for installation instructions. Related web resources: </p> + <ul class="itemize1"> + <li class="itemize"><a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" >The glossaries FAQ</a> + </li> + <li class="itemize"><a +href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263&Itemid=114" >Glossaries, Nomenclature, Lists of Symbols and Acronyms </a></li></ul> + + + + <h3 class="likesectionHead"><a + id="x1-1000"></a>Contents</h3> + <div class="tableofcontents"> + <span class="sectionToc" >1 <a +href="#x1-20001" id="QQ2-1-2">Introduction</a></span> +<br />  <span class="subsectionToc" >1.1 <a +href="#x1-30001.1" id="QQ2-1-3">Sample Documents</a></span> +<br />  <span class="subsectionToc" >1.2 <a +href="#x1-40001.2" id="QQ2-1-4">Multi-Lingual Support</a></span> +<br />   <span class="subsubsectionToc" >1.2.1 <a +href="#x1-50001.2.1" id="QQ2-1-5">Changing the Fixed Names</a></span> +<br />  <span class="subsectionToc" >1.3 <a +href="#x1-60001.3" id="QQ2-1-8">Generating the Associated Glossary Files</a></span> +<br />   <span class="subsubsectionToc" >1.3.1 <a +href="#x1-70001.3.1" id="QQ2-1-10">Using the makeglossaries Perl Script</a></span> +<br />   <span class="subsubsectionToc" >1.3.2 <a +href="#x1-80001.3.2" id="QQ2-1-11">Using xindy explicitly</a></span> +<br />   <span class="subsubsectionToc" >1.3.3 <a +href="#x1-90001.3.3" id="QQ2-1-12">Using makeindex explicitly</a></span> +<br />   <span class="subsubsectionToc" >1.3.4 <a +href="#x1-100001.3.4" id="QQ2-1-13">Note to Front-End and Script Developers</a></span> +<br />  <span class="subsectionToc" >1.4 <a +href="#x1-110001.4" id="QQ2-1-14">Troubleshooting</a></span> +<br /> <span class="sectionToc" >2 <a +href="#x1-120002" id="QQ2-1-15">Overview of Main User Commands</a></span> +<br />  <span class="subsectionToc" >2.1 <a +href="#x1-130002.1" id="QQ2-1-16">Package Options</a></span> +<br />  <span class="subsectionToc" >2.2 <a +href="#x1-140002.2" id="QQ2-1-17">Defining Glossary Entries</a></span> +<br />   <span class="subsubsectionToc" >2.2.1 <a +href="#x1-150002.2.1" id="QQ2-1-18">Plurals</a></span> +<br />   <span class="subsubsectionToc" >2.2.2 <a +href="#x1-160002.2.2" id="QQ2-1-19">Sub-Entries</a></span> +<br />   <span class="subsubsectionToc" >2.2.3 <a +href="#x1-190002.2.3" id="QQ2-1-22">Loading Entries From a File</a></span> +<br />  <span class="subsectionToc" >2.3 <a +href="#x1-200002.3" id="QQ2-1-23">Number lists</a></span> +<br />  <span class="subsectionToc" >2.4 <a +href="#x1-210002.4" id="QQ2-1-24">Links to Glossary Entries</a></span> +<br />   <span class="subsubsectionToc" >2.4.1 <a +href="#x1-220002.4.1" id="QQ2-1-26">Changing the format of the link text</a></span> +<br />   <span class="subsubsectionToc" >2.4.2 <a +href="#x1-230002.4.2" id="QQ2-1-27">Enabling and disabling hyperlinks to glossary entries</a></span> +<br />  <span class="subsectionToc" >2.5 <a +href="#x1-240002.5" id="QQ2-1-28">Adding an Entry to the Glossary Without Generating Text</a></span> +<br />  <span class="subsectionToc" >2.6 <a +href="#x1-250002.6" id="QQ2-1-29">Cross-Referencing Entries</a></span> +<br />  <span class="subsectionToc" >2.7 <a +href="#x1-260002.7" id="QQ2-1-30">Using Glossary Terms Without Links</a></span> +<br />  <span class="subsectionToc" >2.8 <a +href="#x1-270002.8" id="QQ2-1-31">Displaying a glossary</a></span> +<br />   <span class="subsubsectionToc" >2.8.1 <a +href="#x1-280002.8.1" id="QQ2-1-32">Changing the way the entry name appears in the glossary</a></span> +<br />   <span class="subsubsectionToc" >2.8.2 <a +href="#x1-290002.8.2" id="QQ2-1-33">Xindy</a></span> +<br />  <span class="subsectionToc" >2.9 <a +href="#x1-330002.9" id="QQ2-1-37">Defining New Glossaries</a></span> +<br />  <span class="subsectionToc" >2.10 <a +href="#x1-340002.10" id="QQ2-1-38">Acronyms</a></span> +<br />   <span class="subsubsectionToc" >2.10.1 <a +href="#x1-350002.10.1" id="QQ2-1-41">Defining A Custom Acronym Style</a></span> +<br />   <span class="subsubsectionToc" >2.10.2 <a +href="#x1-360002.10.2" id="QQ2-1-42">Upgrading From the glossary Package</a></span> +<br />  <span class="subsectionToc" >2.11 <a +href="#x1-370002.11" id="QQ2-1-44">Unsetting and Resetting Entry Flags</a></span> +<br />  <span class="subsectionToc" >2.12 <a +href="#x1-380002.12" id="QQ2-1-45">Glossary Styles</a></span> +<br />   <span class="subsubsectionToc" >2.12.1 <a +href="#x1-390002.12.1" id="QQ2-1-47">List Styles</a></span> +<br />   <span class="subsubsectionToc" >2.12.2 <a +href="#x1-400002.12.2" id="QQ2-1-48">Longtable Styles</a></span> +<br />   <span class="subsubsectionToc" >2.12.3 <a +href="#x1-410002.12.3" id="QQ2-1-49">Longtable Styles (Ragged Right)</a></span> +<br />   <span class="subsubsectionToc" >2.12.4 <a +href="#x1-420002.12.4" id="QQ2-1-50">Supertabular Styles</a></span> +<br />   <span class="subsubsectionToc" >2.12.5 <a +href="#x1-430002.12.5" id="QQ2-1-51">Supertabular Styles (Ragged Right)</a></span> +<br />   <span class="subsubsectionToc" >2.12.6 <a +href="#x1-440002.12.6" id="QQ2-1-52">Tree-Like Styles</a></span> +<br />  <span class="subsectionToc" >2.13 <a +href="#x1-450002.13" id="QQ2-1-53">Defining your own glossary style</a></span> +<br />   <span class="subsubsectionToc" >2.13.1 <a +href="#x1-460002.13.1" id="QQ2-1-54">Example: creating a completely new style</a></span> +<br />   <span class="subsubsectionToc" >2.13.2 <a +href="#x1-470002.13.2" id="QQ2-1-55">Example: creating a new glossary style based on an existing style</a></span> +<br />   <span class="subsubsectionToc" >2.13.3 <a +href="#x1-480002.13.3" id="QQ2-1-56">Example: creating a glossary style that uses the <span +class="ecss-1000">user1</span>, …, <span +class="ecss-1000">user6 </span>keys</a></span> +<br />  <span class="subsectionToc" >2.14 <a +href="#x1-490002.14" id="QQ2-1-57">Accessibility Support</a></span> + + + +<br /> <span class="sectionToc" >3 <a +href="#x1-500003" id="QQ2-1-58">Mfirstuc Package</a></span> +<br /> <span class="sectionToc" ><a +href="#Q1-1-59">Index</a></span> + </div> +<!--l. 79--><p class="noindent" > +</p> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-20001"></a>Introduction</h3> +<a + id="dx1-2001"></a> +<!--l. 82--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package is provided to assist generating glossaries. It has a certain +amount of flexibility, allowing the user to customize the format of the glossary and +define multiple glossaries. It also supports acronyms and glossary styles that +include symbols (in addition to a name and description) for glossary entries. +There is provision for loading a database of glossary terms. Only those terms +used<span class="footnote-mark"><a +href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a + id="x1-2002f1"></a> +in the document will be added to the glossary. +</p><!--l. 95--><p class="indent" > <span +class="ecbx-1000">This package replaces the </span><span +class="ecsx-1000">glossary</span><a + id="dx1-2005"></a> <span +class="ecbx-1000">package which is now obsolete. </span>Please +see the document <a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> for +assistance in upgrading. +</p><!--l. 99--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is +the necessity of having a large manual that can cover all the various settings. If you are +daunted by the size of the manual, try starting off with the much shorter <a +href="glossariesbegin.html" >guide for +beginners</a>. +</p><!--l. 105--><p class="indent" > <div class="important" title="Important Note"> The <span +class="ecss-1000">glossaries </span>package comes with a <a +href="http://www.perl.org/about.html" >Perl</a> script called <span +class="ectt-1000">makeglossaries</span><a + id="dx1-2006"></a>. This +provides a convenient interface to <span +class="ectt-1000">makeindex</span><a + id="dx1-2007"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-2008"></a>. It is strongly recommended that +you use this script, but <span +class="ecti-1000">it is not essential</span>. If you are reluctant to install Perl, or for any +other reason you don’t want to use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-2009"></a>, you can called <span +class="ectt-1000">makeindex</span><a + id="dx1-2010"></a> or +<span +class="ectt-1000">xindy</span><a + id="dx1-2011"></a> explicitly. See <a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further details. +</div> +</p><!--l. 115--><p class="noindent" > +</p><!--l. 117--><p class="indent" > This manual is structured as follows: </p> + <ul class="itemize1"> + <li class="itemize"><a +href="#x1-120002">§2 </a><a +href="#x1-120002">Overview of Main User Commands<!--tex4ht:ref: sec:overview --></a> gives an overview of the main user + commands and their syntax. + </li> + <li class="itemize"><a +href="#x1-500003">§3 </a><a +href="#x1-500003">Mfirstuc Package<!--tex4ht:ref: sec:mfirstuc --></a> describes the associated <span +class="ecss-1000">mfirstuc </span>package. + </li></ul> +<!--l. 138--><p class="noindent" >The <a +href="glossaries.pdf" >PDF version</a> of this manual also describes more advanced commands in the +documented code section (such as determining if an entry or a glossary exists and +commands that iterate through defined terms or glossaries). +</p><!--l. 144--><p class="noindent" >The remainder of this introductory section covers the following: </p> + + + + <ul class="itemize1"> + <li class="itemize"><a +href="#x1-30001.1">§1.1 </a><a +href="#x1-30001.1">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this + package. + </li> + <li class="itemize"><a +href="#x1-40001.2">§1.2 </a><a +href="#x1-40001.2">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write + in a language other than English. + </li> + <li class="itemize"><a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use a + post-processor to create the sorted glossaries for your document. + </li> + <li class="itemize"><a +href="#x1-110001.4">§1.4 </a><a +href="#x1-110001.4">Troubleshooting<!--tex4ht:ref: sec:trouble --></a> provides some assistance in the event that you + encounter a problem.</li></ul> +<!--l. 161--><p class="noindent" > +</p> +<!--l. 161--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.1 </span> <a + id="x1-30001.1"></a>Sample Documents</h4> +<!--l. 164--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package is provided with some sample documents that illustrate the +various functions. These should be located in the <span +class="ectt-1000">samples </span>subdirectory (folder) of +the <span +class="ecss-1000">glossaries </span>documentation directory. This location varies according to your +operating system and <span class="TEX">T<span +class="E">E</span>X</span> distribution. You can use <span +class="ectt-1000">texdoc </span>to locate the main +glossaries documentation. For example, in a terminal or command prompt, type: +<spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">texdoc -l glossaries</span></span> +</p><!--l. 173--><p class="indent" > <spacer type=vertical size=10> +This should display the full pathname of the file <span +class="ectt-1000">glossaries.pdf</span>. View the contents of +that directory and see if it contains the <span +class="ectt-1000">samples </span>subdirectory. +</p><!--l. 178--><p class="indent" > If you can’t find the sample files, they are available in the subdirectory +<span +class="ectt-1000">doc/latex/glossaries/samples/ </span>in the <span +class="ectt-1000">glossaries.tds.zip </span>archive which can be +downloaded from <a +href="http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/" >CTAN</a>. +</p><!--l. 184--><p class="indent" > The sample documents are as follows: + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">minimalgls.tex</span> </dt><dd +class="description"> This document is a minimal working example. You can test your + installation using this file. To create the complete document you will need to do + the following steps: + <ol class="enumerate1" > + <li + class="enumerate" id="x1-3002x1">Run <span +class="ectt-1000">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> either by typing <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex minimalgls</span></span> + <!--l. 195--><p class="noindent" ><spacer type=vertical size=10> + in a terminal or by using the relevant button or menu item in your text + editor or front-end. This will create the required associated files but you will + + + + not see the glossary. If you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> you will also get warnings about + non-existent references. These warnings may be ignored on the first + run. + </p><!--l. 202--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">Missing</span><span +class="ectt-1000"> \begin{document}</span></span></span> error, then it’s most likely that + your version of <span +class="ecss-1000">xkeyval</span><a + id="dx1-3003"></a> is out of date. Check the log file for a warning of + that nature. If this is the case, you will need to update the <span +class="ecss-1000">xkeyval</span> + package. + </p></li> + <li + class="enumerate" id="x1-3005x2">Run <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3006"></a> on the document. This can be done on a terminal + either by typing <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeglossaries minimalgls</span></span> + <!--l. 212--><p class="noindent" ><spacer type=vertical size=10> + or by typing <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">perl makeglossaries minimalgls</span></span> + </p><!--l. 216--><p class="noindent" ><spacer type=vertical size=10> + If your system doesn’t recognise the command <span +class="ectt-1000">perl </span>then it’s likely you don’t + have Perl installed. In which case you will need to use <span +class="ectt-1000">makeindex</span><a + id="dx1-3007"></a> + directly. You can do this in a terminal by typing (all on one line): + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls</span> + <span +class="ectt-1000">minimalgls.glo</span></span> + </p><!--l. 223--><p class="noindent" ><spacer type=vertical size=10> + (See <a +href="#x1-90001.3.3">§1.3.3 </a><a +href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span +class="ectt-1000">makeindex</span><a + id="dx1-3008"></a> + explicitly.) + </p><!--l. 227--><p class="noindent" >Note that if you need to specify the full path and the path contains + spaces, you will need to delimit the file names with the double-quote + character. + </p></li> + <li + class="enumerate" id="x1-3010x3">Run <span +class="ectt-1000">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> again (as step 1)</li></ol> + <!--l. 233--><p class="noindent" >You should now have a complete document. The number following each entry in + the glossary is the location number. By default, this is the page number where the + entry was referenced. + </p></dd><dt class="description"> +<span +class="ecbx-1000">sample4col.tex</span> </dt><dd +class="description"> This document illustrates a four column glossary where the entries + have a symbol in addition to the name and description. To create the complete + document, you need to do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sample4col</span> + <br /><span +class="ectt-1000">makeglossaries sample4col</span> + <br /><span +class="ectt-1000">latex sample4col</span></span> + <!--l. 245--><p class="noindent" ><spacer type=vertical size=10> + As before, if you don’t have Perl installed, you will need to use <span +class="ectt-1000">makeindex</span><a + id="dx1-3011"></a> directly + + + + instead of using <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3012"></a>. The vertical gap between entries is the gap + created at the start of each group. This can be suppressed by redefining + <span +class="ectt-1000">\glsgroupskip</span><a + id="dx1-3013"></a> after the glossary style has been set: + + + +</p> + <div class="verbatim" id="verbatim-1"> + \renewcommand*{\glsgroupskip}{} +</div> + <!--l. 253--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleAcr.tex</span> </dt><dd +class="description"> This document has some sample acronyms. It also adds the glossary + to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required to ensure + the document is up to date: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleAcr</span> + <br /><span +class="ectt-1000">makeglossaries sampleAcr</span> + <br /><span +class="ectt-1000">latex sampleAcr</span> + <br /><span +class="ectt-1000">latex sampleAcr</span></span> + <!--l. 264--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleAcrDesc.tex</span> </dt><dd +class="description"> This is similar to the previous example, except that the + acronyms have an associated description. As with the previous example, the + glossary is added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is + required: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleAcrDesc</span> + <br /><span +class="ectt-1000">makeglossaries sampleAcrDesc</span> + <br /><span +class="ectt-1000">latex sampleAcrDesc</span> + <br /><span +class="ectt-1000">latex sampleAcrDesc</span></span> + <!--l. 275--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleDesc.tex</span> </dt><dd +class="description"> This is similar to the previous example, except that it defines the + acronyms using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-3014"></a> instead of <span +class="ectt-1000">\newacronym</span><a + id="dx1-3015"></a>. As with the + previous example, the glossary is added to the table of contents, so an extra run + through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleDesc</span> + <br /><span +class="ectt-1000">makeglossaries sampleDesc</span> + <br /><span +class="ectt-1000">latex sampleDesc</span> + <br /><span +class="ectt-1000">latex sampleDesc</span></span> + <!--l. 287--><p class="noindent" ><spacer type=vertical size=10> + + + + </p></dd><dt class="description"> +<span +class="ecbx-1000">sample-custom-acronym.tex</span> </dt><dd +class="description"> This document illustrates how to define your + own acronym style if the predefined styles don’t suit your requirements. + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sample-custom-acronym</span> + <br /><span +class="ectt-1000">makeglossaries sample-custom-acronym</span> + <br /><span +class="ectt-1000">latex sample-custom-acronym</span></span> + <!--l. 296--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleDB.tex</span> </dt><dd +class="description"> This document illustrates how to load external files containing the + glossary definitions. It also illustrates how to define a new glossary type. This + document has the number list<a + id="dx1-3016"></a> suppressed and uses <span +class="ectt-1000">\glsaddall</span><a + id="dx1-3017"></a> to add all the + entries to the glossaries without referencing each one explicitly. To create the + document do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleDB</span> + <br /><span +class="ectt-1000">makeglossaries sampleDB</span> + <br /><span +class="ectt-1000">latex sampleDB</span></span> + <!--l. 308--><p class="noindent" ><spacer type=vertical size=10> + The glossary definitions are stored in the accompanying files <span +class="ectt-1000">database1.tex </span>and + <span +class="ectt-1000">database2.tex</span>. Note that if you don’t have Perl installed, you will need to use + <span +class="ectt-1000">makeindex</span><a + id="dx1-3018"></a> twice instead of a single call to <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3019"></a>: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-3021x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls</span> + <span +class="ectt-1000">sampleDB.glo</span></span> + <!--l. 317--><p class="noindent" ><spacer type=vertical size=10> + </p></li> + <li + class="enumerate" id="x1-3023x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not</span> + <span +class="ectt-1000">sampleDB.ntn</span></span> + <!--l. 321--><p class="noindent" ><spacer type=vertical size=10> + </p></li></ol> + </dd><dt class="description"> +<span +class="ecbx-1000">sampleEq.tex</span> </dt><dd +class="description"> This document illustrates how to change the location to something + other than the page number. In this case, the <span +class="ectt-1000">equation </span>counter is used since all + glossary entries appear inside an <span +class="ecss-1000">equation</span><a + id="dx1-3024"></a> environment. To create the document + do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleEq</span> + + + + <br /><span +class="ectt-1000">makeglossaries sampleEq</span> + <br /><span +class="ectt-1000">latex sampleEq</span></span> + <!--l. 333--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleEqPg.tex</span> </dt><dd +class="description"> This is similar to the previous example, but the number lists<a + id="dx1-3025"></a> are a + mixture of page numbers and equation numbers. This example adds the + glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleEqPg</span> + <br /><span +class="ectt-1000">makeglossaries sampleEqPg</span> + <br /><span +class="ectt-1000">latex sampleEqPg</span> + <br /><span +class="ectt-1000">latex sampleEqPg</span></span> + <!--l. 345--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleSec.tex</span> </dt><dd +class="description"> This document also illustrates how to change the location to + something other than the page number. In this case, the <span +class="ectt-1000">section </span>counter is used. + This example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run + is required: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleSec</span> + <br /><span +class="ectt-1000">makeglossaries sampleSec</span> + <br /><span +class="ectt-1000">latex sampleSec</span> + <br /><span +class="ectt-1000">latex sampleSec</span></span> + <!--l. 357--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleNtn.tex</span> </dt><dd +class="description"> This document illustrates how to create an additional glossary type. + This example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run + is required: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleNtn</span> + <br /><span +class="ectt-1000">makeglossaries sampleNtn</span> + <br /><span +class="ectt-1000">latex sampleNtn</span> + <br /><span +class="ectt-1000">latex sampleNtn</span></span> + <!--l. 368--><p class="noindent" ><spacer type=vertical size=10> + Note that if you don’t have Perl installed, you will need to use <span +class="ectt-1000">makeindex</span><a + id="dx1-3026"></a> twice + instead of a single call to <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3027"></a>: + + + + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-3029x1">Create the main glossary: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls</span> + <span +class="ectt-1000">sampleNtn.glo</span></span> + <!--l. 376--><p class="noindent" ><spacer type=vertical size=10> + </p></li> + <li + class="enumerate" id="x1-3031x2">Create the secondary glossary: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not</span> + <span +class="ectt-1000">sampleNtn.ntn</span></span> + <!--l. 380--><p class="noindent" ><spacer type=vertical size=10> + </p></li></ol> + </dd><dt class="description"> +<span +class="ecbx-1000">sample.tex</span> </dt><dd +class="description"> This document illustrates some of the basics, including how to create + child entries that use the same name as the parent entry. This example adds the + glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sample</span> + <br /><span +class="ectt-1000">makeglossaries sample</span> + <br /><span +class="ectt-1000">latex sample</span> + <br /><span +class="ectt-1000">latex sample</span></span> + <!--l. 392--><p class="noindent" ><spacer type=vertical size=10> + You can see the difference between word and letter ordering if you substitute + <span +class="ecss-1000">order=word</span><a + id="dx1-3032"></a> with <span +class="ecss-1000">order=letter</span><a + id="dx1-3033"></a>. (Note that this will only have an effect if you use + <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3034"></a>. If you use <span +class="ectt-1000">makeindex</span><a + id="dx1-3035"></a> explicitly, you will need to use the <span +class="ectt-1000">-l</span> + switch to indicate letter ordering.) + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampletree.tex</span> </dt><dd +class="description"> This document illustrates a hierarchical glossary structure where + child entries have different names to their corresponding parent entry. To create + the document do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampletree</span> + <br /><span +class="ectt-1000">makeglossaries sampletree</span> + <br /><span +class="ectt-1000">latex sampletree</span></span> + <!--l. 408--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">samplexdy.tex</span> </dt><dd +class="description"> This document illustrates how to use the <span +class="ecss-1000">glossaries </span>package with + <span +class="ectt-1000">xindy</span><a + id="dx1-3036"></a> instead of <span +class="ectt-1000">makeindex</span><a + id="dx1-3037"></a>. The document uses UTF8 encoding (with the + <span +class="ecss-1000">inputenc</span><a + id="dx1-3038"></a> package). The encoding is picked up by <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3039"></a>. By default, this + document will create a <span +class="ectt-1000">xindy</span><a + id="dx1-3040"></a> style file called <span +class="ectt-1000">samplexdy.xdy</span>, but if you + uncomment the lines + + + + <div class="verbatim" id="verbatim-2"> + \setStyleFile{samplexdy-mc} +  <br />\noist +  <br />\GlsSetXdyLanguage{} +</div> + <!--l. 421--><p class="nopar" > it will set the style file to <span +class="ectt-1000">samplexdy-mc.xdy </span>instead. This provides an additional + letter group for entries starting with “Mc” or “Mac”. If you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3041"></a>, + you don’t need to supply any additional information. If you don’t use + <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3042"></a>, you will need to specify the required information. Note that if + you set the style file to <span +class="ectt-1000">samplexdy-mc.xdy </span>you must also specify <span +class="ectt-1000">\noist</span><a + id="dx1-3043"></a>, + otherwise the <span +class="ecss-1000">glossaries </span>package will overwrite <span +class="ectt-1000">samplexdy-mc.xdy </span>and you will + lose the “Mc” letter group. + </p><!--l. 433--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex samplexdy</span> + <br /><span +class="ectt-1000">makeglossaries samplexdy</span> + <br /><span +class="ectt-1000">latex samplexdy</span></span> + </p><!--l. 438--><p class="noindent" ><spacer type=vertical size=10> + If you don’t have Perl installed, you will have to call <span +class="ectt-1000">xindy</span><a + id="dx1-3044"></a> explicitly instead of + using <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3045"></a>. If you are using the default style file <span +class="ectt-1000">samplexdy.xdy</span>, then + do (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o</span> + <span +class="ectt-1000">samplexdy.gls samplexdy.glo</span></span> + </p><!--l. 445--><p class="noindent" ><spacer type=vertical size=10> + otherwise, if you are using <span +class="ectt-1000">samplexdy-mc.xdy</span>, then do (no line breaks): + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls</span> + <span +class="ectt-1000">samplexdy.glo</span></span> + </p><!--l. 450--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleutf8.tex</span> </dt><dd +class="description"> This is another example that uses <span +class="ectt-1000">xindy</span><a + id="dx1-3046"></a>. Unlike <span +class="ectt-1000">makeindex</span><a + id="dx1-3047"></a>, <span +class="ectt-1000">xindy</span><a + id="dx1-3048"></a> + can cope with accented or non-Latin characters. This document uses UTF8 + encoding. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleutf8</span> + <br /><span +class="ectt-1000">makeglossaries sampleutf8</span> + <br /><span +class="ectt-1000">latex sampleutf8</span></span> + <!--l. 460--><p class="noindent" ><spacer type=vertical size=10> + If you don’t have Perl installed, you will have to call <span +class="ectt-1000">xindy</span><a + id="dx1-3049"></a> explicitly instead of + using <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3050"></a> (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> + + + + <br /><span +class="ectt-1000">xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o</span> + <span +class="ectt-1000">sampleutf8.gls sampleutf8.glo</span></span> + </p><!--l. 466--><p class="noindent" ><spacer type=vertical size=10> + </p><!--l. 468--><p class="noindent" >If you remove the <span +class="ecss-1000">xindy</span><a + id="dx1-3051"></a> option from <span +class="ectt-1000">sampleutf8.tex </span>and do: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex sampleutf8</span> + <br /><span +class="ectt-1000">makeglossaries sampleutf8</span> + <br /><span +class="ectt-1000">latex sampleutf8</span></span> + </p><!--l. 474--><p class="noindent" ><spacer type=vertical size=10> + you will see that the entries that start with a non-Latin character now appear in + the symbols group, and the word “manœuvre” is now after “manor” instead of + before it. If you are unable to use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-3052"></a>, the call to <span +class="ectt-1000">makeindex</span><a + id="dx1-3053"></a> is as + follows (no line breaks): <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls</span> + <span +class="ectt-1000">sampleutf8.glo</span></span> + </p><!--l. 482--><p class="noindent" ><spacer type=vertical size=10> + </p></dd><dt class="description"> +<span +class="ecbx-1000">sampleaccsupp.tex</span> </dt><dd +class="description"> This document uses the experimental <span +class="ecss-1000">glossaries-accsupp</span><a + id="dx1-3054"></a> package. + The symbol is set to the replacement text. Note that some PDF viewers don’t use + the accessibility support. Information about the <span +class="ecss-1000">glossaries-accsupp </span>package can be + found in <a +href="#x1-490002.14">§2.14 </a><a +href="#x1-490002.14">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>. + </dd></dl> +<!--l. 494--><p class="noindent" > +</p> +<!--l. 494--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.2 </span> <a + id="x1-40001.2"></a>Multi-Lingual Support</h4> +<!--l. 497--><p class="noindent" >As from version 1.17, the <span +class="ecss-1000">glossaries </span>package can now be used with <span +class="ectt-1000">xindy</span><a + id="dx1-4001"></a> as well as +<span +class="ectt-1000">makeindex</span><a + id="dx1-4002"></a>. If you are writing in a language that uses accented characters or non-Latin +characters it is recommended that you use <span +class="ectt-1000">xindy</span><a + id="dx1-4003"></a> as <span +class="ectt-1000">makeindex</span><a + id="dx1-4004"></a> is hard-coded for +Latin languages. This means that you are not restricted to the A, …, Z letter +groups. If you want to use <span +class="ectt-1000">xindy</span><a + id="dx1-4005"></a>, remember to use the <span +class="ecss-1000">xindy</span><a + id="dx1-4006"></a> package option. For +example: + + + +</p> + <div class="verbatim" id="verbatim-3"> \documentclass[frenchb]{article} -\usepackage[utf8]{inputenc} -\usepackage[T1]{fontenc} -\usepackage{babel} -\usepackage[xindy]{glossaries} -</PRE> - -<P> -If you use an accented or other expandable character at the start of -an entry name, you must place it in a group, or it will cause -a problem for commands that convert the first letter to uppercase -(e.g. <TT>\Gls</TT><A NAME="4738"></A>) due to expansion issues. For example: -<PRE> -\newglossaryentry{elite}{name={{é}lite}, -description={select group or class}} -</PRE> - -<P> -If you use the <TT>inputenc</TT><A NAME="4741"></A> package, <TT>makeglossaries</TT><A NAME="4744"></A> -will pick up the encoding from the auxiliary file. If you use -<TT>xindy</TT><A NAME="4747"></A> explicitly instead of via <TT>makeglossaries</TT><A NAME="4750"></A>, -you may need to specify the encoding using the <TT>-C</TT> -option. Read the <TT>xindy</TT><A NAME="4753"></A> manual for further details. - -<P> - -<H3><A NAME="SECTION00022100000000000000"></A> -<A NAME="sec:fixednames"></A> -<BR> -Changing the Fixed Names -</H3> - -<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="4757"></A> or <TT>polyglossia</TT><A NAME="4760"></A> <I>before</I> -<TT>glossaries</TT> to enable this. Note that if <TT>babel</TT><A NAME="4764"></A> is loaded -and the <TT>translator</TT><A NAME="4767"></A> package is detected on T<SMALL>E</SMALL>X's path, then the -<TT>translator</TT><A NAME="4770"></A> package will be loaded automatically. However, -it may not pick up on the required languages so, if the predefined -text is not translated, you may need to explicitly load the -<TT>translator</TT><A NAME="4773"></A> package with the required languages. For example: -<PRE> -\usepackage[spanish]{babel} -\usepackage[spanish]{translator} -\usepackage{glossaries} -</PRE> -Alternatively, specify the language as a class option rather -than a package option. For example: -<PRE> -\documentclass[spanish]{report} + <br />\usepackage[utf8]{inputenc} + <br />\usepackage[T1]{fontenc} + <br />\usepackage{babel} + <br />\usepackage[xindy]{glossaries} +</div> +<!--l. 511--><p class="nopar" > +</p><!--l. 513--><p class="indent" > <div class="important" title="Important Note"> If you use an accented or other expandable character at the start of an entry name, +you must place it in a group, or it will cause a problem for commands that +convert the first letter to uppercase (e.g. <span +class="ectt-1000">\Gls</span><a + id="dx1-4007"></a>) due to expansion issues. For +example: + + + +</p> + <div class="verbatim" id="verbatim-4"> +\newglossaryentry{elite}{name={{é}lite}, + <br />description={select group or class}} +</div> +<!--l. 521--><p class="nopar" > </div> +</p><!--l. 522--><p class="noindent" > +</p><!--l. 524--><p class="indent" > If you use the <span +class="ecss-1000">inputenc</span><a + id="dx1-4008"></a> package, <span +class="ectt-1000">makeglossaries</span><a + id="dx1-4009"></a> will pick up the encoding from the +auxiliary file. If you use <span +class="ectt-1000">xindy</span><a + id="dx1-4010"></a> explicitly instead of via <span +class="ectt-1000">makeglossaries</span><a + id="dx1-4011"></a>, you may need +to specify the encoding using the <span +class="ectt-1000">-C </span>option. Read the <span +class="ectt-1000">xindy</span><a + id="dx1-4012"></a> manual for further +details. +</p><!--l. 530--><p class="noindent" > +</p> +<!--l. 530--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.2.1 </span> <a + id="x1-50001.2.1"></a>Changing the Fixed Names</h5> +<!--l. 533--><p class="noindent" >As from version 1.08, the <span +class="ecss-1000">glossaries </span>package now has limited multi-lingual support, +thanks to all the people who have sent me the relevant translations either via email or +via <span +class="ectt-1000">comp.text.tex</span>. However you must load <span +class="ecss-1000">babel</span><a + id="dx1-5001"></a> or <span +class="ecss-1000">polyglossia</span><a + id="dx1-5002"></a> <span +class="ecti-1000">before </span><span +class="ecss-1000">glossaries </span>to +enable this. Note that if <span +class="ecss-1000">babel</span><a + id="dx1-5003"></a> is loaded and the <span +class="ecss-1000">translator</span><a + id="dx1-5004"></a> package is detected on <span class="TEX">T<span +class="E">E</span>X</span>’s +path, then the <span +class="ecss-1000">translator</span><a + id="dx1-5005"></a> package will be loaded automatically. However, it may not pick +up on the required languages so, if the predefined text is not translated, you may +need to explicitly load the <span +class="ecss-1000">translator</span><a + id="dx1-5006"></a> package with the required languages. For +example: + -\usepackage{babel} -\usepackage{glossaries} -</PRE> + +</p> + <div class="verbatim" id="verbatim-5"> +\usepackage[spanish]{babel} + <br />\usepackage[spanish]{translator} + <br />\usepackage{glossaries} +</div> +<!--l. 548--><p class="nopar" > Alternatively, specify the language as a class option rather than a package option. For +example: + -<P> -If you want to use <TT>ngerman</TT><A NAME="4776"></A> or <TT>german</TT><A NAME="4779"></A> instead -of <TT>babel</TT><A NAME="4782"></A>, you will need to include the <TT>translator</TT><A NAME="4785"></A> package -to provide the translations. For example: -<PRE> + +</p> + <div class="verbatim" id="verbatim-6"> +\documentclass[spanish]{report} + <br />\usepackage{babel} + <br />\usepackage{glossaries} +</div> +<!--l. 556--><p class="nopar" > +</p><!--l. 558--><p class="indent" > If you want to use <span +class="ecss-1000">ngerman</span><a + id="dx1-5007"></a> or <span +class="ecss-1000">german</span><a + id="dx1-5008"></a> instead of <span +class="ecss-1000">babel</span><a + id="dx1-5009"></a>, you will need to include the +<span +class="ecss-1000">translator</span><a + id="dx1-5010"></a> package to provide the translations. For example: + + + +</p> + <div class="verbatim" id="verbatim-7"> \documentclass[ngerman]{article} -\usepackage{ngerman} -\usepackage{translator} -\usepackage{glossaries} -</PRE> - -<P> -The following languages are currently supported by the -<TT>glossaries</TT> package: -<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">Brazilian Portuguese</TD> -<TD ALIGN="CENTER">1.17</TD> -</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="4789"></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="553"></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>Purpose</B></TH> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\glossaryname</TT><A NAME="4795"></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="4798"></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="4806"></A>).</TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\entryname</TT><A NAME="4810"></A></TD> -<TD ALIGN="LEFT"><TT>Notation (glossaries)</TT></TD> -<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for first column in the 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="4813"></A></TD> -<TD ALIGN="LEFT"><TT>Description (glossaries)</TT></TD> -<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for second column in the 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="4816"></A></TD> -<TD ALIGN="LEFT"><TT>Symbol (glossaries)</TT></TD> -<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for symbol -column in the 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="4819"></A></TD> -<TD ALIGN="LEFT"><TT>Page List (glossaries)</TT></TD> -<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=200>Header for page list column in the 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="4822"></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="4825"></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="4828"></A> package and do not have the <TT>translator</TT><A NAME="4831"></A> package -installed, you need to be familiar with the -advice on <A NAME="tex2html10" - HREF="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords">changing the words babel uses</A>. -If you have the <TT>translator</TT><A NAME="4834"></A> package installed, then you can -provide your own dictionary with the necessary modifications -(using <TT>\deftranslation</TT>) and load it using -<TT>\usedictionary</TT>. Note that the dictionaries are loaded at the -beginning of the document, so it won't have any effect if you -put <TT>\deftranslation</TT> in the preamble. It should be put in your -personal dictionary instead. See the <TT>translator</TT><A NAME="4837"></A> -documentation for further details. - -<P> -If you are using <TT>babel</TT><A NAME="4840"></A> and don't want to use the -<TT>translator</TT><A NAME="4843"></A> interface, you can suppress it using the package -option <TT>translate=false</TT><A NAME="4853"></A>, and either load -<TT>glossaries-babel</TT><A NAME="4855"></A> after <TT>glossaries</TT> or specify you're own -translations. For example: -<PRE> + <br />\usepackage{ngerman} + <br />\usepackage{translator} + <br />\usepackage{glossaries} +</div> +<!--l. 566--><p class="nopar" > +</p><!--l. 568--><p class="indent" > The languages are currently supported by the <span +class="ecss-1000">glossaries </span>package are listed in +<a +href="#x1-50111">table 1</a>. +</p> + <div class="table"> + + + +<!--l. 572--><p class="indent" > <a + id="x1-50111"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 1: </span><span +class="content">Supported Languages</span></div><!--tex4ht:label?: x1-50111 --> +<div class="center" +> +<!--l. 575--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-2" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-2-1g"><col +id="TBL-2-1" /><col +id="TBL-2-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-1" +class="td11"><span +class="ecbx-1000">Language </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" +class="td11"><span +class="ecbx-1000">As from version</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-1" +class="td11">Brazilian Portuguese</td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" +class="td11"> 1.17 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-1" +class="td11">Danish </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2" +class="td11"> 1.08 </td></tr><tr + style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-1" +class="td11">Dutch </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2" +class="td11"> 1.08</td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-1" +class="td11">English </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-1" +class="td11">French </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-1" +class="td11">German </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-1" +class="td11">Irish </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-1" +class="td11">Italian </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-1" +class="td11">Hungarian </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2" +class="td11"> 1.08 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-1" +class="td11">Polish </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2" +class="td11"> 1.13 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-1" +class="td11">Serbian </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-2" +class="td11"> 2.06 </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-1" +class="td11">Spanish </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-2" +class="td11"> 1.08 </td></tr></table> +</div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 594--><p class="indent" > The language dependent commands and <span +class="ecss-1000">translator</span><a + id="dx1-5012"></a> keys used by the glossaries +package are listed in <a +href="#x1-50132">table 2</a>. +</p> + <div class="table"> + + + +<!--l. 597--><p class="indent" > <a + id="x1-50132"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 2: </span><span +class="content">Customised Text</span></div><!--tex4ht:label?: x1-50132 --> +<div class="center" +> +<!--l. 600--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-3" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-3-1g"><col +id="TBL-3-1" /><col +id="TBL-3-2" /><col +id="TBL-3-3" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-3-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-1-1" +class="td01"><span +class="ecbx-1000">Command Name </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-1-2" +class="td11"><span +class="ecbx-1000">Translator Key Word </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-1-3" +class="td10"><!--l. 603--><p class="noindent" ><span +class="ecbx-1000">Purpose</span> </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-1" +class="td01"><span +class="ectt-1000">\glossaryname</span><a + id="dx1-5014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-2" +class="td11"><span +class="ectt-1000">Glossary </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-2-3" +class="td10"><!--l. 604--><p class="noindent" >Title of the main glossary. </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-1" +class="td01"><span +class="ectt-1000">\acronymname</span><a + id="dx1-5015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-2" +class="td11"><span +class="ectt-1000">Acronyms </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-3-3" +class="td10"><!--l. 605--><p class="noindent" >Title of the list of acronyms +(when used with package option +<span +class="ecss-1000">acronym</span><a + id="dx1-5016"></a>). </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-1" +class="td01"><span +class="ectt-1000">\entryname</span><a + id="dx1-5017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-2" +class="td11"><span +class="ectt-1000">Notation (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-4-3" +class="td10"><!--l. 608--><p class="noindent" >Header for first column in the +glossary (for 2, 3 or 4 column +glossaries that support headers).</p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-1" +class="td01"><span +class="ectt-1000">\descriptionname</span><a + id="dx1-5018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-2" +class="td11"><span +class="ectt-1000">Description (glossaries)</span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-5-3" +class="td10"><!--l. 611--><p class="noindent" >Header for second column in the +glossary (for 2, 3 or 4 column +glossaries that support headers).</p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-1" +class="td01"><span +class="ectt-1000">\symbolname</span><a + id="dx1-5019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-2" +class="td11"><span +class="ectt-1000">Symbol (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-6-3" +class="td10"><!--l. 613--><p class="noindent" >Header for symbol column in the +glossary for glossary styles that +support this option. </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-1" +class="td01"><span +class="ectt-1000">\pagelistname</span><a + id="dx1-5020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-2" +class="td11"><span +class="ectt-1000">Page List (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-7-3" +class="td10"><!--l. 616--><p class="noindent" >Header for page list column in +the glossary for glossaries that +support this option. </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-1" +class="td01"><span +class="ectt-1000">\glssymbolsgroupname</span><a + id="dx1-5021"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-2" +class="td11"><span +class="ectt-1000">Symbols (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-8-3" +class="td10"><!--l. 619--><p class="noindent" >Header for symbols section of the +glossary for glossary styles that +support this option. </p></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-3-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-1" +class="td01"><span +class="ectt-1000">\glsnumbersgroupname</span><a + id="dx1-5022"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-2" +class="td11"><span +class="ectt-1000">Numbers (glossaries) </span></td><td style="white-space:wrap; text-align:left;" id="TBL-3-9-3" +class="td10"><!--l. 621--><p class="noindent" >Header for numbers section of +the glossary for glossary styles +that support this option. </p></td> +</tr></table></div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 628--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations +may not be appropriate. If you are using the <span +class="ecss-1000">babel</span><a + id="dx1-5023"></a> package and do not have the +<span +class="ecss-1000">translator</span><a + id="dx1-5024"></a> package installed, you need to be familiar with the advice given in +<a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words babel uses</a>. If you have the <span +class="ecss-1000">translator</span><a + id="dx1-5025"></a> package installed, +then you can provide your own dictionary with the necessary modifications +(using <span +class="ectt-1000">\deftranslation</span>) and load it using <span +class="ectt-1000">\usedictionary</span>. Note that the +dictionaries are loaded at the beginning of the document, so it won’t have +any effect if you put <span +class="ectt-1000">\deftranslation </span>in the preamble. It should be put in +your personal dictionary instead. See the <span +class="ecss-1000">translator</span><a + id="dx1-5026"></a> documentation for further +details. +</p><!--l. 642--><p class="indent" > If you are using <span +class="ecss-1000">babel</span><a + id="dx1-5027"></a> and don’t want to use the <span +class="ecss-1000">translator</span><a + id="dx1-5028"></a> interface, you can +suppress it using the package option <span +class="ecss-1000">translate=false</span><a + id="dx1-5029"></a>, and either load <span +class="ecss-1000">glossaries-babel</span><a + id="dx1-5030"></a> +after <span +class="ecss-1000">glossaries </span>or specify you’re own translations. For example: + + + +</p> + <div class="verbatim" id="verbatim-8"> \documentclass[british]{article} - -\usepackage{babel} -\usepackage[translate=false]{glossaries} -\usepackage{glossaries-babel} -</PRE> -or: -<PRE> + <br />\usepackage{babel} + <br />\usepackage[translate=false]{glossaries} + <br />\usepackage{glossaries-babel} +</div> +<!--l. 653--><p class="nopar" > or: + + + +</p> + <div class="verbatim" id="verbatim-9"> \documentclass[british]{article} - -\usepackage{babel} -\usepackage[translate=false]{glossaries} - -\addto\captionsbritish{% - \renewcommand*{\glossaryname}{List of Terms}% - \renewcommand*{\acronymname}{List of Acronyms}% - \renewcommand*{\entryname}{Notation}% - \renewcommand*{\descriptionname}{Description}% - \renewcommand*{\symbolname}{Symbol}% - \renewcommand*{\pagelistname}{Page List}% - \renewcommand*{\glssymbolsgroupname}{Symbols}% - \renewcommand*{\glsnumbersgroupname}{Numbers}% -} -</PRE> - -<P> -If you are using <TT>polyglossia</TT><A NAME="4859"></A> instead of <TT>babel</TT><A NAME="4862"></A>, -<TT>glossaries-polyglossia</TT><A NAME="4865"></A> will automatically be loaded unless -you specify the package option <TT>translate=false</TT><A NAME="4875"></A>. - -<P> -Note that <TT>xindy</TT><A NAME="4877"></A> provides much better multi-lingual -support than <TT>makeindex</TT><A NAME="4880"></A>, so it's recommended that you -use <TT>xindy</TT><A NAME="4883"></A> if you have glossary entries that contain -accented characters or non-Roman letters. See -<A NAME="tex2html11" - HREF="sec:xindy">Xindy</A> -for further details. -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00023000000000000000"></A> -<A NAME="sec:makeglossaries"></A> -<BR> -Generating the Associated Glossary Files -</H2> - -<P> -In order to generate a sorted glossary with compact location lists, -it is necessary to use an external indexing application as an -intermediate step. It is this application that creates the file -containing the code that typesets the glossary. If this step -is omitted, the glossaries will not appear in your document. The -two indexing applications that are most commonly used with -LaTeX are <TT>makeindex</TT><A NAME="4889"></A> and <TT>xindy</TT><A NAME="4892"></A>. As -from version 1.17, the <TT>glossaries</TT> package can be used -with either of these applications. Previous versions were designed -to be used with <TT>makeindex</TT><A NAME="4896"></A> only. Note that -<TT>xindy</TT><A NAME="4899"></A> has much better multi-lingual support than -<TT>makeindex</TT><A NAME="4902"></A>, so <TT>xindy</TT><A NAME="4905"></A> is recommended if you're -not writing in English. Commands that only have an -effect when <TT>xindy</TT><A NAME="4908"></A> is used are described -<A HREF="glossaries-manual.html#sec:xindy">later</A>. - -<P> -The <TT>glossaries</TT> package comes with the Perl script -<TT>makeglossaries</TT><A NAME="4912"></A> which will run <TT>makeindex</TT><A NAME="4915"></A> or -<TT>xindy</TT><A NAME="4918"></A> on all the glossary files using a customized style -file (which is created by <TT>\makeglossaries</TT><A NAME="4921"></A>). See -<A HREF="glossaries-manual.html#sec:makeglossariesapp">Using the -makeglossaries Perl script</A> for further -details. Perl is stable, cross-platform, open source software that -is used by a number of T<SMALL>E</SMALL>X-related applications. Further -information is available at <TT><A NAME="tex2html12" - HREF="http://www.perl.org/about.html">http://www.perl.org/about.html</A></TT>. -However, whilst it is strongly recommended that you use the -<TT>makeglossaries</TT><A NAME="4924"></A> script, it is possible to use the -<TT>glossaries</TT> package without having Perl installed. In which -case, if you have used the <TT>xindy</TT><A NAME="4933"></A> package option, you will -need to use <TT>xindy</TT><A NAME="4937"></A> (see -<A HREF="glossaries-manual.html#sec:xindyapp">Using xindy -explicitly</A>), otherwise you will need to use -<TT>makeindex</TT><A NAME="4940"></A> (see -<A HREF="glossaries-manual.html#sec:makeindexapp">Using makeindex -explicitly</A>). Note that some commands and -package options have no effect if you don't use -<TT>makeglossaries</TT><A NAME="4943"></A>. These are listed in -<A HREF="glossaries-manual.html#tab:makeglossariesCmds">table </A><A HREF="glossaries-manual.html#tab:makeglossariesCmds">2</A>. - -<P> -Note that if any of your entries use an entry -that is not referenced outside the glossary, you will need to -do an additional <TT>makeglossaries</TT><A NAME="4949"></A>, <TT>makeindex</TT><A NAME="4952"></A> -or <TT>xindy</TT><A NAME="4955"></A> run, as appropriate. For example, -suppose you have defined the following entries: -<PRE> -\newglossaryentry{citrusfruit}{name={citrus fruit}, -description={fruit of any citrus tree. (See also -\gls{orange})}} - -\newglossaryentry{orange}{name={orange}, -description={an orange coloured fruit.}} -</PRE> -and suppose you have <code>\gls{citrusfruit}</code> in your document -but don't reference the <TT>orange</TT> entry, then the -<TT>orange</TT> entry won't appear in your glossary until -you first create the glossary and then do another run -of <TT>makeglossaries</TT><A NAME="4958"></A>, <TT>makeindex</TT><A NAME="4961"></A> or <TT>xindy</TT><A NAME="4964"></A>. -For example, if the document is called <TT>myDoc.tex</TT>, then -you must do: -<PRE> -latex myDoc -makeglossaries myDoc -latex myDoc -makeglossaries myDoc -latex myDoc -</PRE> - -<P> -Likewise, an additional <TT>makeglossaries</TT><A NAME="4967"></A> and LaTeX run -may be required if the document pages shift with re-runs. For -example, if the page numbering is not reset after the table of -contents, the insertion of the table of contents on the second -LaTeX run may push glossary entries across page boundaries, which -means that the number lists<A NAME="4969"></A> in the glossary may -need updating. - -<P> -The examples in this document assume that you are accessing -<TT>makeglossaries</TT><A NAME="4971"></A>, <TT>xindy</TT><A NAME="4974"></A> or <TT>makeindex</TT><A NAME="4977"></A> via -a terminal. Windows users can use the MSDOS Prompt which -is usually accessed via the -<I>Start</I>-><I>All Programs</I> -menu or -<I>Start</I>-><I>All Programs</I>-><I>Accessories</I> -menu. Alternatively, your text editor may have the -facility to create a function that will call the -required application. See your editor's user manual for further + <br />\usepackage{babel} + <br />\usepackage[translate=false]{glossaries} + <br />\addto\captionsbritish{% + <br />    \renewcommand*{\glossaryname}{List of Terms}% + <br />    \renewcommand*{\acronymname}{List of Acronyms}% + <br />    \renewcommand*{\entryname}{Notation}% + <br />    \renewcommand*{\descriptionname}{Description}% + <br />    \renewcommand*{\symbolname}{Symbol}% + <br />    \renewcommand*{\pagelistname}{Page List}% + <br />    \renewcommand*{\glssymbolsgroupname}{Symbols}% + <br />    \renewcommand*{\glsnumbersgroupname}{Numbers}% + <br />} +</div> +<!--l. 671--><p class="nopar" > +</p><!--l. 673--><p class="indent" > If you are using <span +class="ecss-1000">polyglossia</span><a + id="dx1-5031"></a> instead of <span +class="ecss-1000">babel</span><a + id="dx1-5032"></a>, <span +class="ecss-1000">glossaries-polyglossia</span><a + id="dx1-5033"></a> will automatically +be loaded unless you specify the package option <span +class="ecss-1000">translate=false</span><a + id="dx1-5034"></a>. +</p><!--l. 677--><p class="indent" > Note that <span +class="ectt-1000">xindy</span><a + id="dx1-5035"></a> provides much better multi-lingual support than <span +class="ectt-1000">makeindex</span><a + id="dx1-5036"></a>, so it’s +recommended that you use <span +class="ectt-1000">xindy</span><a + id="dx1-5037"></a> if you have glossary entries that contain diacritics or +non-Roman letters. See <a +href="#x1-290002.8.2">§2.8.2 </a><a +href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details. +</p> +<!--l. 683--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.3 </span> <a + id="x1-60001.3"></a>Generating the Associated Glossary Files</h4> +<!--l. 686--><p class="noindent" >In order to generate a sorted glossary with compact location lists, it is necessary to use +an external indexing application as an intermediate step. It is this application that +creates the file containing the code that typesets the glossary. If this step is omitted, the +glossaries will not appear in your document. The two indexing applications that are +most commonly used with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> are <span +class="ectt-1000">makeindex</span><a + id="dx1-6001"></a> and <span +class="ectt-1000">xindy</span><a + id="dx1-6002"></a>. As from version 1.17, +the <span +class="ecss-1000">glossaries </span>package can be used with either of these applications. Previous versions +were designed to be used with <span +class="ectt-1000">makeindex</span><a + id="dx1-6003"></a> only. Note that <span +class="ectt-1000">xindy</span><a + id="dx1-6004"></a> has much better +multi-lingual support than <span +class="ectt-1000">makeindex</span><a + id="dx1-6005"></a>, so <span +class="ectt-1000">xindy</span><a + id="dx1-6006"></a> is recommended if you’re not writing +in English. Commands that only have an effect when <span +class="ectt-1000">xindy</span><a + id="dx1-6007"></a> is used are described in +<a +href="#x1-290002.8.2">§2.8.2 </a><a +href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a>. +</p><!--l. 702--><p class="indent" > The <span +class="ecss-1000">glossaries </span>package comes with the Perl script <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6008"></a> which will run +<span +class="ectt-1000">makeindex</span><a + id="dx1-6009"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-6010"></a> on all the glossary files using a customized style file (which is +created by <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-6011"></a>). See <a +href="#x1-70001.3.1">§1.3.1 </a><a +href="#x1-70001.3.1">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for +further details. Perl is stable, cross-platform, open source software that is used by +a number of <span class="TEX">T<span +class="E">E</span>X</span>-related applications. Further information is available at +<a +href="http://www.perl.org/about.html" class="url" ><span +class="ectt-1000">http://www.perl.org/about.html</span></a>. However, whilst it is strongly recommended that + + + +you use the <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6012"></a> script, it is possible to use the <span +class="ecss-1000">glossaries </span>package without +having Perl installed. In which case, if you have used the <span +class="ecss-1000">xindy</span><a + id="dx1-6013"></a> package option, you will +need to use <span +class="ectt-1000">xindy</span><a + id="dx1-6014"></a> (see <a +href="#x1-80001.3.2">§1.3.2 </a><a +href="#x1-80001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a>), otherwise you will need to use +<span +class="ectt-1000">makeindex</span><a + id="dx1-6015"></a> (see <a +href="#x1-90001.3.3">§1.3.3 </a><a +href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>). Note that some commands and +package options have no effect if you don’t use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6016"></a>. These are listed in +<a +href="#x1-60303">table 3</a>. +</p><!--l. 720--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside the +glossary, you will need to do an additional <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6017"></a>, <span +class="ectt-1000">makeindex</span><a + id="dx1-6018"></a> or +<span +class="ectt-1000">xindy</span><a + id="dx1-6019"></a> run, as appropriate. For example, suppose you have defined the following +entries: + + + +</p> + <div class="verbatim" id="verbatim-10"> +\newglossaryentry{citrusfruit}{name={citrus fruit}, + <br />description={fruit of any citrus tree. (See also + <br />\gls{orange})}} + <br />\newglossaryentry{orange}{name={orange}, + <br />description={an orange coloured fruit.}} +</div> +<!--l. 732--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{citrusfruit}</span></span></span> in your document but don’t reference the +<span +class="ectt-1000">orange </span>entry, then the <span +class="ectt-1000">orange </span>entry won’t appear in your glossary until you first +create the glossary and then do another run of <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6020"></a>, <span +class="ectt-1000">makeindex</span><a + id="dx1-6021"></a> or +<span +class="ectt-1000">xindy</span><a + id="dx1-6022"></a>. For example, if the document is called <span +class="ectt-1000">myDoc.tex</span>, then you must do: +<spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex myDoc</span> + <br /><span +class="ectt-1000">makeglossaries myDoc</span> + <br /><span +class="ectt-1000">latex myDoc</span> + <br /><span +class="ectt-1000">makeglossaries myDoc</span> + <br /><span +class="ectt-1000">latex myDoc</span></span> +</p><!--l. 746--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 748--><p class="indent" > Likewise, an additional <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6023"></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run may be required if the +document pages shift with re-runs. For example, if the page numbering is not reset after +the table of contents, the insertion of the table of contents on the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run +may push glossary entries across page boundaries, which means that the number lists<a + id="dx1-6024"></a> in +the glossary may need updating. +</p><!--l. 756--><p class="indent" > The examples in this document assume that you are accessing <span +class="ectt-1000">makeglossaries</span><a + id="dx1-6025"></a>, <span +class="ectt-1000">xindy</span><a + id="dx1-6026"></a> +or <span +class="ectt-1000">makeindex</span><a + id="dx1-6027"></a> via a terminal. Windows users can use the MSDOS Prompt which is +usually accessed via the <span +class="ecss-1000">Start->All Programs </span>menu or <span +class="ecss-1000">Start->All Programs->Accessories</span> +menu. +</p><!--l. 762--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will +call the required application. The article <a +href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >“Glossaries, Nomenclature, List of Symbols +and Acronyms”</a> in the <a +href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> Community’s</a> Know How section describes how to +do this for TeXnicCenter, and the thread <a +href="http://groups.google.com/group/comp.text.tex/browse_thread/thread/edd83831b81b0759?hl=en" >“Executing Glossaries’ makeindex +from a WinEdt macro”</a> on the <span +class="ectt-1000">comp.text.tex </span>newsgroup describes how to +do it for WinEdt. For other editors see the editor’s user manual for further details. - -<P> -If any problems occur, remember to check the transcript files -(e.g. <TT>.glg</TT><A NAME="4980"></A> or <TT>.alg</TT><A NAME="4982"></A>) for messages. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:makeglossariesCmds"></A><A NAME="4228"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 2:</STRONG> -Commands and package options that have no effect when -using <TT>xindy</TT> or <TT>makeindex</TT> explicity</CAPTION> -<TR><TD ALIGN="LEFT"> </TD><TH ALIGN="LEFT"><B>Command or Package Option </B></TH> -<TD ALIGN="LEFT"><TT>makeindex</TT><A NAME="4984"></A></TD> -<TD ALIGN="LEFT"><TT>xindy</TT><A NAME="4987"></A></TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>order=letter</TT><A NAME="4997"></A></TD> -<TD ALIGN="LEFT">use <TT>-l</TT></TD> -<TD ALIGN="LEFT">use <TT>-M ord/letorder</TT></TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>order=word</TT><A NAME="5006"></A></TD> -<TD ALIGN="LEFT">default</TD> -<TD ALIGN="LEFT">default</TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>xindy</TT><A NAME="5013"></A>={<TT>language=</TT><I>lang</I><TT>,codename=</TT><I>code</I>}</TD> -<TD ALIGN="LEFT">N/A</TD> -<TD ALIGN="LEFT">use <TT>-L</TT> <I>lang</I> <TT>-C</TT> <I>code</I></TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\GlsSetXdyLanguage</TT><A NAME="5019"></A><TT>{</TT><EM>lang</EM><TT>}</TT></TD> -<TD ALIGN="LEFT">N/A</TD> -<TD ALIGN="LEFT">use <TT>-L</TT> <I>lang</I></TD> -<TD ALIGN="LEFT"> </TD></TR> -<TR><TD ALIGN="LEFT"> </TD><TD ALIGN="LEFT"><TT>\GlsSetXdyCodePage</TT><A NAME="5022"></A><TT>{</TT><EM>code</EM><TT>}</TT></TD> -<TD ALIGN="LEFT">N/A</TD> -<TD ALIGN="LEFT">use <TT>-C</TT> <I>code</I></TD> -<TD ALIGN="LEFT"> </TD></TR> -</TABLE> - -<P> - -</DIV> -<BR> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00023100000000000000"></A> -<A NAME="sec:makeglossariesapp"></A> -<BR> -Using the makeglossaries Perl Script -</H3> - -<P> -The <TT>makeglossaries</TT><A NAME="5028"></A> script picks up the relevant -information from the auxiliary (<TT>.aux</TT><A NAME="5031"></A>) file and -will either call <TT>xindy</TT><A NAME="5033"></A> or <TT>makeindex</TT><A NAME="5036"></A>, -depending on the supplied information. Therefore, you only need to -pass the document's name without the extension to -<TT>makeglossaries</TT><A NAME="5039"></A>. -For example, if your document is called <TT>myDoc.tex</TT>, -type the following in your terminal: -<PRE> -latex myDoc -makeglossaries myDoc -latex myDoc -</PRE> -You may need to explicitly load <TT>makeglossaries</TT><A NAME="5042"></A> into -Perl: -<PRE> -perl makeglossaries myDoc -</PRE> -There is a batch file called <TT>makeglossaries.bat</TT> which -does this for Windows users, but you must have Perl installed to -be able to use it. - -<P> -The <TT>makeglossaries</TT><A NAME="5045"></A> script contains POD (Plain Old -Documentation). If you want, you can create a man page for -<TT>makeglossaries</TT><A NAME="5048"></A> using <TT>pod2man</TT><A NAME="5051"></A> and move the -resulting file onto the man path. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00023200000000000000"></A> -<A NAME="sec:xindyapp"></A> -<BR> -Using xindy explicitly -</H3> - -<P> -If you want to use <TT>xindy</TT><A NAME="5057"></A> to process the glossary -files, you must make sure you have used the -<TT>xindy</TT><A NAME="5065"></A> package option: -<PRE> +</p><!--l. 774--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span +class="ectt-1000">.glg</span><a + id="dx1-6028"></a> or <span +class="ectt-1000">.alg</span><a + id="dx1-6029"></a>) for +messages. +</p> + <div class="table"> + + + +<!--l. 777--><p class="indent" > <a + id="x1-60303"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 3: </span><span +class="content">Commands and package options that have no effect when using <span +class="ectt-1000">xindy</span> +or <span +class="ectt-1000">makeindex </span>explicitly</span></div><!--tex4ht:label?: x1-60303 --> +<div class="tabular"> <table id="TBL-4" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-4-1g"><col +id="TBL-4-1" /><col +id="TBL-4-2" /><col +id="TBL-4-3" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-4-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-1" +class="td01"><span +class="ecbx-1000">Command or Package Option </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-2" +class="td11"><span +class="ectt-1000">makeindex</span><a + id="dx1-6031"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3" +class="td10"><span +class="ectt-1000">xindy</span><a + id="dx1-6032"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-4-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-1" +class="td01"><span +class="ecss-1000">order=letter</span><a + id="dx1-6033"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2" +class="td11">use <span +class="ectt-1000">-l </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3" +class="td10">use <span +class="ectt-1000">-M ord/letorder </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-4-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-1" +class="td01"><span +class="ecss-1000">order=word</span><a + id="dx1-6034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2" +class="td11">default </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-3" +class="td10">default </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-4-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-1" +class="td01"><span +class="ecss-1000">xindy</span><a + id="dx1-6035"></a>={<span +class="ecss-1000">language=</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">lang</span><span +class="cmsy-10">⟩</span><span +class="ecss-1000">,codename=</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span>}</td><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-2" +class="td11">N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-3" +class="td10">use <span +class="ectt-1000">-L </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">lang</span><span +class="cmsy-10">⟩ </span><span +class="ectt-1000">-C </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-4-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-1" +class="td01"><span +class="ectt-1000">\GlsSetXdyLanguage</span><a + id="dx1-6036"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">lang</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-2" +class="td11">N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-3" +class="td10">use <span +class="ectt-1000">-L </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">lang</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-4-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-1" +class="td01"><span +class="ectt-1000">\GlsSetXdyCodePage</span><a + id="dx1-6037"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-2" +class="td11">N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-3" +class="td10">use <span +class="ectt-1000">-C </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩ </span></td></tr></table> +</div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 799--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.1 </span> <a + id="x1-70001.3.1"></a>Using the makeglossaries Perl Script</h5> +<!--l. 802--><p class="noindent" >The <span +class="ectt-1000">makeglossaries</span><a + id="dx1-7001"></a> script picks up the relevant information from the auxiliary (<span +class="ectt-1000">.aux</span><a + id="dx1-7002"></a>) +file and will either call <span +class="ectt-1000">xindy</span><a + id="dx1-7003"></a> or <span +class="ectt-1000">makeindex</span><a + id="dx1-7004"></a>, depending on the supplied information. +Therefore, you only need to pass the document’s name without the extension to +<span +class="ectt-1000">makeglossaries</span><a + id="dx1-7005"></a>. For example, if your document is called <span +class="ectt-1000">myDoc.tex</span>, type the +following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex myDoc</span> + <br /><span +class="ectt-1000">makeglossaries myDoc</span> + <br /><span +class="ectt-1000">latex myDoc</span></span> +</p><!--l. 813--><p class="indent" > <spacer type=vertical size=10> +You may need to explicitly load <span +class="ectt-1000">makeglossaries</span><a + id="dx1-7006"></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">perl makeglossaries myDoc</span></span> +</p><!--l. 817--><p class="indent" > <spacer type=vertical size=10> +There is a batch file called <span +class="ectt-1000">makeglossaries.bat </span>which does this for Windows users, +but you must have Perl installed to be able to use it. +</p><!--l. 822--><p class="indent" > The <span +class="ectt-1000">makeglossaries</span><a + id="dx1-7007"></a> script contains POD (Plain Old Documentation). If you want, +you can create a man page for <span +class="ectt-1000">makeglossaries</span><a + id="dx1-7008"></a> using <span +class="ectt-1000">pod2man</span><a + id="dx1-7009"></a> and move the resulting +file onto the man path. +</p><!--l. 828--><p class="noindent" > +</p> +<!--l. 828--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.2 </span> <a + id="x1-80001.3.2"></a>Using xindy explicitly</h5> +<!--l. 831--><p class="noindent" >If you want to use <span +class="ectt-1000">xindy</span><a + id="dx1-8001"></a> to process the glossary files, you must make sure you have +used the <span +class="ecss-1000">xindy</span><a + id="dx1-8002"></a> package option: + + + +</p> + <div class="verbatim" id="verbatim-11"> \usepackage[xindy]{glossaries} -</PRE> -This is required regardless of whether you use <TT>xindy</TT><A NAME="5069"></A> -explicitly or whether it's called implicitly via -<TT>makeglossaries</TT><A NAME="5072"></A>. This causes the glossary -entries to be written in raw <TT>xindy</TT><A NAME="5075"></A> format, so you need to -use <TT>-I xindy</TT> <I>not</I> <TT>-I tex</TT>. - -<P> -To run <TT>xindy</TT><A NAME="5078"></A> type the following in your terminal -(all on one line): -<BR> -<BR><TT>xindy -L </TT> <I>language</I><TT> -C </TT> <I>encoding</I><TT> -I xindy --M </TT> <I>style</I><TT> -t </TT> <I>base</I><TT>.glg -<BR> --o </TT> <I>base</I><TT>.gls </TT> <I>base</I><TT>.glo -</TT> -<BR> -<BR> -where <I>language</I> is the required language name, <I>encoding</I> -is the encoding, <I>base</I> is the name of the document without the -<TT>.tex</TT><A NAME="5081"></A> extension and <I>style</I> is the name of the -<TT>xindy</TT><A NAME="5083"></A> style file without the <TT>.xdy</TT><A NAME="5086"></A> extension. -The default name for this style file is <I>base</I><TT>.xdy</TT><A NAME="5088"></A> -but can be changed via <TT>\setStyleFile</TT><A NAME="5090"></A><TT>{</TT><EM>style</EM><TT>}</TT>. You may need -to specify the full path name depending on the current working -directory. If any of the file names contain spaces, you must delimit -them using double-quotes. - -<P> -For example, if your document is called <TT>myDoc.tex</TT> and -you are using UTF8 encoding in English, then type the -following in your terminal: -<PRE> -xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo -</PRE> - -<P> -Note that this just creates the main glossary. You need to do -the same for each of the other glossaries (including the -list of acronyms if you have used the <TT>acronym</TT><A NAME="5098"></A> -package option), substituting <TT>.glg</TT><A NAME="5102"></A>, <TT>.gls</TT><A NAME="5104"></A> -and <TT>.glo</TT><A NAME="5106"></A> with the relevant extensions. For example, -if you have used the <TT>acronym</TT><A NAME="5113"></A> package option, then -you would need to do: -<PRE> -xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn -</PRE> -For additional glossaries, the extensions are those supplied -when you created the glossary with <TT>\newglossary</TT><A NAME="5117"></A>. - -<P> -Note that if you use <TT>makeglossaries</TT><A NAME="5120"></A> instead, you can -replace all those calls to <TT>xindy</TT><A NAME="5123"></A> with just one call -to <TT>makeglossaries</TT><A NAME="5126"></A>: -<PRE> -makeglossaries myDoc -</PRE> -Note also that some commands and package options have no effect if -you use <TT>xindy</TT><A NAME="5129"></A> explicitly instead of using -<TT>makeglossaries</TT><A NAME="5132"></A>. These are listed in -<A HREF="glossaries-manual.html#tab:makeglossariesCmds">table </A><A HREF="glossaries-manual.html#tab:makeglossariesCmds">2</A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00023300000000000000"></A> -<A NAME="sec:makeindexapp"></A> -<BR> -Using makeindex explicitly -</H3> - -<P> -If you want to use <TT>makeindex</TT><A NAME="5141"></A> explicitly, you must -make sure that you haven't used the <TT>xindy</TT><A NAME="5149"></A> package -option or the glossary entries will be written in the wrong -format. To run <TT>makeindex</TT><A NAME="5153"></A>, type the following in -your terminal: -<BR> -<BR><TT>makeindex -s </TT> <I>style</I><TT>.ist -t </TT> <I>base</I><TT>.glg --o </TT> <I>base</I><TT>.gls </TT> <I>base</I><TT>.glo -</TT> -<BR> -<BR> -where <I>base</I> is the name of your document without the -<TT>.tex</TT><A NAME="5156"></A> extension and <I>style</I><TT>.ist</TT><A NAME="5158"></A> is the -name of the <TT>makeindex</TT><A NAME="5160"></A> style file. By default, this is -<I>base</I><TT>.ist</TT><A NAME="5163"></A>, but may be changed via -<TT>\setStyleFile</TT><A NAME="5165"></A><TT>{</TT><EM>style</EM><TT>}</TT>. Note that there are other options, -such as <TT>-l</TT> (letter ordering). See the <TT>makeindex</TT><A NAME="5168"></A> -manual for further details. - -<P> -For example, if your document is called <TT>myDoc.tex</TT>, then -type the following at the terminal: -<PRE> -makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo -</PRE> -Note that this only creates the main glossary. If you have -additional glossaries (for example, if you have used the -<TT>acronym</TT><A NAME="5176"></A> package option) then you must call -<TT>makeindex</TT><A NAME="5180"></A> for each glossary, substituting -<TT>.glg</TT><A NAME="5183"></A>, <TT>.gls</TT><A NAME="5185"></A> and <TT>.glo</TT><A NAME="5187"></A> with the -relevant extensions. For example, if you have used the -<TT>acronym</TT><A NAME="5194"></A> package option, then you need to type the -following in your terminal: -<PRE> -makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn -</PRE> -For additional glossaries, the extensions are those supplied -when you created the glossary with <TT>\newglossary</TT><A NAME="5198"></A>. - -<P> -Note that if you use <TT>makeglossaries</TT><A NAME="5201"></A> instead, you can -replace all those calls to <TT>makeindex</TT><A NAME="5204"></A> with just one call -to <TT>makeglossaries</TT><A NAME="5207"></A>: -<PRE> -makeglossaries myDoc -</PRE> -Note also that some commands and package options have no effect if -you use <TT>makeindex</TT><A NAME="5210"></A> explicitly instead of using -<TT>makeglossaries</TT><A NAME="5213"></A>. These are listed in -<A HREF="glossaries-manual.html#tab:makeglossariesCmds">table </A><A HREF="glossaries-manual.html#tab:makeglossariesCmds">2</A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00023400000000000000"> -Note to Front-End and Script Developers</A> -</H3> - -<P> -The information needed to determine whether to use <TT>xindy</TT><A NAME="5222"></A> -or <TT>makeindex</TT><A NAME="5225"></A> and the information needed to call those -applications is stored in the auxiliary file. This information can -be gathered by a front-end, editor or script to make the glossaries -where appropriate. This section describes how the information is -stored in the auxiliary file. - -<P> -The file extensions used by each defined glossary are given by -<BR> -<BR><TT>\@newglossary{</TT><EM>label</EM><TT>}{</TT><EM>log</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>in-ext</EM><TT>}</TT> -<BR> -<BR> -where <I>in-ext</I> is the extension of the <I>indexing -application's</I> input file (the output file from the <TT>glossaries</TT> -package's point of view), <I>out-ext</I> is the extension of the -<I>indexing application's</I> output file (the input file from -the <TT>glossaries</TT> package's point of view) and <I>log</I> is the -extension of the indexing application's transcript file. The label -for the glossary is also given for information purposes only, but -is not required by the indexing applications. For example, the -information for the main glossary is written as: -<PRE> +</div> +<!--l. 836--><p class="nopar" > This is required regardless of whether you use <span +class="ectt-1000">xindy</span><a + id="dx1-8003"></a> explicitly or whether it’s called +implicitly via <span +class="ectt-1000">makeglossaries</span><a + id="dx1-8004"></a>. This causes the glossary entries to be written in raw +<span +class="ectt-1000">xindy</span><a + id="dx1-8005"></a> format, so you need to use <span +class="ectt-1000">-I xindy </span><span +class="ecti-1000">not </span><span +class="ectt-1000">-I tex</span>. +</p><!--l. 843--><p class="indent" > To run <span +class="ectt-1000">xindy</span><a + id="dx1-8006"></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">xindy -L </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩ </span><span +class="ectt-1000">-C </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">encoding</span><span +class="cmsy-10">⟩ </span><span +class="ectt-1000">-I xindy -M </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩ </span><span +class="ectt-1000">-t </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.glg -o</span> +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.gls </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.glo</span></span> +</p><!--l. 847--><p class="indent" > <spacer type=vertical size=10> +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩ </span>is the required language name, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">encoding</span><span +class="cmsy-10">⟩ </span>is the encoding, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩ </span>is +the name of the document without the <span +class="ectt-1000">.tex</span><a + id="dx1-8007"></a> extension and <span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩ </span>is the name of +the <span +class="ectt-1000">xindy</span><a + id="dx1-8008"></a> style file without the <span +class="ectt-1000">.xdy</span><a + id="dx1-8009"></a> extension. The default name for this +style file is <span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.xdy</span><a + id="dx1-8010"></a> but can be changed via <span +class="ectt-1000">\setStyleFile</span><a + id="dx1-8011"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. You +may need to specify the full path name depending on the current working +directory. If any of the file names contain spaces, you must delimit them using +double-quotes. +</p><!--l. 858--><p class="indent" > For example, if your document is called <span +class="ectt-1000">myDoc.tex </span>and you are using UTF8 +encoding in English, then type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls</span> +<span +class="ectt-1000">myDoc.glo</span></span> +</p><!--l. 863--><p class="indent" > <spacer type=vertical size=10> +</p><!--l. 865--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of +the other glossaries (including the list of acronyms if you have used the <span +class="ecss-1000">acronym</span><a + id="dx1-8012"></a> +package option), substituting <span +class="ectt-1000">.glg</span><a + id="dx1-8013"></a>, <span +class="ectt-1000">.gls</span><a + id="dx1-8014"></a> and <span +class="ectt-1000">.glo</span><a + id="dx1-8015"></a> with the relevant extensions. For +example, if you have used the <span +class="ecss-1000">acronym</span><a + id="dx1-8016"></a> package option, then you would need to do: +<spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr</span> +<span +class="ectt-1000">myDoc.acn</span></span> +</p><!--l. 874--><p class="indent" > <spacer type=vertical size=10> +For additional glossaries, the extensions are those supplied when you created the +glossary with <span +class="ectt-1000">\newglossary</span><a + id="dx1-8017"></a>. +</p><!--l. 878--><p class="indent" > Note that if you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-8018"></a> instead, you can replace all those calls to +<span +class="ectt-1000">xindy</span><a + id="dx1-8019"></a> with just one call to <span +class="ectt-1000">makeglossaries</span><a + id="dx1-8020"></a>: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeglossaries myDoc</span></span> +</p><!--l. 883--><p class="indent" > <spacer type=vertical size=10> +Note also that some commands and package options have no effect if you use <span +class="ectt-1000">xindy</span><a + id="dx1-8021"></a> +explicitly instead of using <span +class="ectt-1000">makeglossaries</span><a + id="dx1-8022"></a>. These are listed in <a +href="#x1-60303">table 3</a>. +</p><!--l. 890--><p class="noindent" > + + + +</p> +<!--l. 890--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.3 </span> <a + id="x1-90001.3.3"></a>Using makeindex explicitly</h5> +<!--l. 893--><p class="noindent" >If you want to use <span +class="ectt-1000">makeindex</span><a + id="dx1-9001"></a> explicitly, you must make sure that you haven’t used the +<span +class="ecss-1000">xindy</span><a + id="dx1-9002"></a> package option or the glossary entries will be written in the wrong format. To run +<span +class="ectt-1000">makeindex</span><a + id="dx1-9003"></a>, type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.ist -t </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.glg -o </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.gls </span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.glo</span></span> +</p><!--l. 900--><p class="indent" > <spacer type=vertical size=10> +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩ </span>is the name of your document without the <span +class="ectt-1000">.tex</span><a + id="dx1-9004"></a> extension and +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.ist</span><a + id="dx1-9005"></a> is the name of the <span +class="ectt-1000">makeindex</span><a + id="dx1-9006"></a> style file. By default, this is <span +class="cmsy-10">⟨</span><span +class="ecti-1000">base</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">.ist</span><a + id="dx1-9007"></a>, +but may be changed via <span +class="ectt-1000">\setStyleFile</span><a + id="dx1-9008"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. Note that there are other +options, such as <span +class="ectt-1000">-l </span>(letter ordering). See the <span +class="ectt-1000">makeindex</span><a + id="dx1-9009"></a> manual for further +details. +</p><!--l. 909--><p class="indent" > For example, if your document is called <span +class="ectt-1000">myDoc.tex</span>, then type the following at the +terminal: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo</span></span> +</p><!--l. 913--><p class="indent" > <spacer type=vertical size=10> +Note that this only creates the main glossary. If you have additional glossaries (for +example, if you have used the <span +class="ecss-1000">acronym</span><a + id="dx1-9010"></a> package option) then you must call <span +class="ectt-1000">makeindex</span><a + id="dx1-9011"></a> +for each glossary, substituting <span +class="ectt-1000">.glg</span><a + id="dx1-9012"></a>, <span +class="ectt-1000">.gls</span><a + id="dx1-9013"></a> and <span +class="ectt-1000">.glo</span><a + id="dx1-9014"></a> with the relevant extensions. For +example, if you have used the <span +class="ecss-1000">acronym</span><a + id="dx1-9015"></a> package option, then you need to type the +following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn</span></span> +</p><!--l. 924--><p class="indent" > <spacer type=vertical size=10> +For additional glossaries, the extensions are those supplied when you created the +glossary with <span +class="ectt-1000">\newglossary</span><a + id="dx1-9016"></a>. +</p><!--l. 928--><p class="indent" > Note that if you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-9017"></a> instead, you can replace all those calls to +<span +class="ectt-1000">makeindex</span><a + id="dx1-9018"></a> with just one call to <span +class="ectt-1000">makeglossaries</span><a + id="dx1-9019"></a>: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">makeglossaries myDoc</span></span> +</p><!--l. 933--><p class="indent" > <spacer type=vertical size=10> +Note also that some commands and package options have no effect if you use +<span +class="ectt-1000">makeindex</span><a + id="dx1-9020"></a> explicitly instead of using <span +class="ectt-1000">makeglossaries</span><a + id="dx1-9021"></a>. These are listed in +<a +href="#x1-60303">table 3</a>. +</p><!--l. 940--><p class="noindent" > +</p> +<!--l. 940--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">1.3.4 </span> <a + id="x1-100001.3.4"></a>Note to Front-End and Script Developers</h5> +<!--l. 942--><p class="noindent" >The information needed to determine whether to use <span +class="ectt-1000">xindy</span><a + id="dx1-10001"></a> or <span +class="ectt-1000">makeindex</span><a + id="dx1-10002"></a> and the +information needed to call those applications is stored in the auxiliary file. This +information can be gathered by a front-end, editor or script to make the glossaries +where appropriate. This section describes how the information is stored in the auxiliary +file. +</p><!--l. 949--><p class="indent" > The file extensions used by each defined glossary are given by +</p><!--l. 950--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\@newglossary</span><span +class="ectt-0900"> </span></span><a + id="dx1-10003"></a><span +class="ectt-1000">\@newglossary{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">log</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">out-ext</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">in-ext</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 952--><p class="noindent" > + + + +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">in-ext</span><span +class="cmsy-10">⟩ </span>is the extension of the <span +class="ecti-1000">indexing application’s </span>input file (the output file +from the <span +class="ecss-1000">glossaries </span>package’s point of view), <span +class="cmsy-10">⟨</span><span +class="ecti-1000">out-ext</span><span +class="cmsy-10">⟩ </span>is the extension of the <span +class="ecti-1000">indexing</span> +<span +class="ecti-1000">application’s </span>output file (the input file from the <span +class="ecss-1000">glossaries </span>package’s point of view) and +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">log</span><span +class="cmsy-10">⟩ </span>is the extension of the indexing application’s transcript file. The label for the +glossary is also given for information purposes only, but is not required by the indexing +applications. For example, the information for the main glossary is written +as: + + + +</p> + <div class="verbatim" id="verbatim-12"> \@newglossary{main}{glg}{gls}{glo} -</PRE> - -<P> -The indexing application's style file is specified by -<BR> -<BR><TT>\@istfilename{</TT><EM>filename</EM><TT>}</TT> -<BR> -<BR> -The file extension indicates whether to use <TT>makeindex</TT><A NAME="5230"></A> -(<TT>.ist</TT><A NAME="5233"></A>) or <TT>xindy</TT><A NAME="5235"></A> (<TT>.xdy</TT><A NAME="5238"></A>). Note that -the glossary information is formatted differently depending on -which indexing application is supposed to be used, so it's -important to call the correct one. - -<P> -Word or letter ordering is specified by: -<BR> -<BR><TT>\@glsorder{</TT><EM>order</EM><TT>}</TT> -<BR> -<BR> -where <I>order</I> can be either <TT>word</TT> or <TT>letter</TT>. - -<P> -If <TT>xindy</TT><A NAME="5240"></A> should be used, the language and code page -for each glossary is specified by -<BR> -<BR><TT>\@xdylanguage{</TT><EM>label</EM><TT>}{</TT><EM>language</EM><TT>}</TT> -<BR><TT>\@gls@codepage{</TT><EM>label</EM><TT>}{</TT><EM>code</EM><TT>}</TT> -<BR> -<BR> -where <I>label</I> identifies the glossary, <I>language</I> is -the root language (e.g. <TT>english</TT>) and <I>code</I> -is the encoding (e.g. <TT>utf8</TT>). These commands are omitted -if <TT>makeindex</TT><A NAME="5243"></A> should be used. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00024000000000000000"></A> -<A NAME="sec:trouble"></A> -<BR> -Troubleshooting -</H2> - -<P> -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 the <TT>samples</TT> subdirectory (folder) -of the <TT>glossaries</TT> documentation directory. The location -varies according to your operating system and T<SMALL>E</SMALL>X installation. -For example, on my Linux partition it can be found in -<TT>/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/</TT>. -Further information on debugging LaTeX code is available at -<TT><A NAME="tex2html14" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</A></TT>. - -<P> -Below is a list of the most frequently asked questions. For -other queries, consult the <TT>glossaries</TT> FAQ at -<TT><A NAME="tex2html15" - 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> - -<OL> -<LI><B>Q.</B> I get the error message: -<PRE> -Missing \begin{document} -</PRE> - -<P> -<B>A.</B> Check you are using an up to date version of the <TT>xkeyval</TT><A NAME="5252"></A> -package. - -<P> -</LI> -<LI><B>Q.</B> I've used the <TT>smallcaps</TT><A NAME="5260"></A> option, but the acronyms -are displayed in normal sized upper case letters. - -<P> -<B>A.</B> The <TT>smallcaps</TT><A NAME="5269"></A> package option uses <TT>\textsc</TT> to typeset -the acronyms. This command converts lower case letters to small -capitals, while upper case letters remain their usual size. Therefore -you need to specify the acronym in lower case letters. - -<P> -</LI> -<LI><B>Q.</B> My acronyms won't break across a line when they're -expanded. - -<P> -<B>A.</B> PDFLaTeX can break hyperlinks across a line, but -LaTeX can't. If you can't use PDFLaTeX then disable the first use -links using the package option <TT>hyperfirst=false</TT><A NAME="5280"></A>. - -<P> -</LI> -<LI><B>Q.</B> How do I change the font that the acronyms are displayed in? - -<P> -<B>A.</B> The easiest way to do this is to specify the <TT>smaller</TT><A NAME="5287"></A> package -option and redefine <TT>\acronymfont</TT> to use the required typesetting -command. For example, suppose you would like the acronyms displayed in -a sans-serif font, then you can do: -<PRE> -\usepackage[smaller]{glossaries} -\renewcommand*{\acronymfont}[1]{\textsf{#1}} -</PRE> - -<P> -</LI> -<LI><B>Q.</B> How do I change the font that the acronyms are displayed in -on first use<A NAME="5290"></A>? - -<P> -<B>A.</B> The easiest way to do this is to specify the <TT>smaller</TT><A NAME="5297"></A> package -option and redefine <TT>\firstacronymfont</TT> to use the required -command. Note that if you don't want the acronym on subsequent use -to use <TT>\textsmaller</TT>, you will also need to redefine <TT>\acronymfont</TT>, -as above. For example to make the acronym emphasized on -first use<A NAME="5300"></A>, but use the surrounding font for subsequent use, you can do: -<PRE> -\usepackage[smaller]{glossaries} -\renewcommand*{\firstacronymfont}[1]{\emph{#1}} -\renewcommand*{\acronymfont}[1]{#1} -</PRE> - -<P> -</LI> -<LI><B>Q.</B> I don't have Perl installed, do I have to use -<TT>makeglossaries</TT><A NAME="5302"></A>? - -<P> -<B>A.</B> Although it is strongly recommended that you use -<TT>makeglossaries</TT><A NAME="5305"></A>, you don't have to use it. -For further details, read -<A HREF="glossaries-manual.html#sec:xindyapp">Using -xindy explicitly</A> or -<A HREF="glossaries-manual.html#sec:makeindexapp">Using -makeindex explicitly</A>, depending on -whether you want to use <TT>xindy</TT><A NAME="5308"></A> or <TT>makeindex</TT><A NAME="5311"></A>. - -<P> -</LI> -<LI><B>Q.</B> I'm used to using the <TT>glossary</TT> package: are there any -instructions on migrating from the <TT>glossary</TT><A NAME="5315"></A> package to the -<TT>glossaries</TT> package? - -<P> -<B>A.</B> Read <A NAME="tex2html16" - HREF="glossary2glossaries.html">Upgrading -from the glossary package to the glossaries -package</A> which should be available from the -same location as this document. - -<P> -</LI> -<LI><B>Q.</B> I'm using <TT>babel</TT><A NAME="5319"></A> but the fixed names haven't been -translated. - -<P> -<B>A.</B> The <TT>glossaries</TT> package currently only supports the following -languages: Brazilian Portuguese, Danish, Dutch, English, French, -German, Irish, Italian, Hungarian, Polish and Spanish. If you want -to add another language, send me the translations, and I'll add them -to the next version. - -<P> -If you are using one of the above languages, but the text hasn't been -translated, try adding the <TT>translator</TT><A NAME="5323"></A> package with the -required languages explicitly (before you load the <TT>glossaries</TT> -package). For example: -<PRE> -\usepackage[ngerman]{babel} -\usepackage[ngerman]{translator} -\usepackage{glossaries} -</PRE> -Alternatively, you can add the language as a global option -to the class file. Check the <TT>translator</TT> package documentation -for further details. - -<P> -</LI> -<LI><B>Q.</B> My acronyms contain strange characters when I use commands -like <TT>\acrlong</TT><A NAME="5328"></A>. - -<P> -<B>A.</B> Switch off the sanitization: -<PRE> -\usepackage[sanitize=none]{glossaries} -</PRE> -and protect fragile commands. - -<P> -</LI> -<LI><B>Q.</B> My glossaries haven't appeared. - -<P> -<B>A.</B> Remember to do the following: - -<UL> -<LI>Add <TT>\makeglossaries</TT><A NAME="5331"></A> to the document preamble. - -<P> -</LI> -<LI>Use either <TT>\printglossary</TT><A NAME="5334"></A> for each glossary that has -been defined or <TT>\printglossaries</TT><A NAME="5337"></A>. - -<P> -</LI> -<LI>Use the commands listed in -<A HREF="glossaries-manual.html#sec:glslink">Links to Glossary -Entries</A>, -<A HREF="glossaries-manual.html#sec:glsadd">Adding an Entry to the -Glossary Without Generating Text</A> or -<A HREF="glossaries-manual.html#sec:crossref">Cross-Referencing -Entries</A> for each entry -that you want to appear in the glossary. - -<P> -</LI> -<LI>Run LaTeX on your document, then run <TT>makeglossaries</TT><A NAME="5340"></A>, -then run LaTeX on your document again. If you want the glossaries -to appear in the table of contents, you will need an extra LaTeX run. If any of your entries cross-reference an entry that's not -referenced in the main body of the document, you will need to -<A HREF="glossaries-manual.html#sec:makeglossaries">run <TT>makeglossaries</TT><A NAME="5346"></A></A> -after the second LaTeX run, followed by another LaTeX run. -</LI> -</UL> - -<P> -Check the log files (<TT>.log</TT><A NAME="5349"></A>, <TT>.glg</TT><A NAME="5351"></A> etc) for any -warnings. - -<P> -</LI> -<LI><B>Q.</B> It is possible to change the rules used to sort -the glossary entries? - -<P> -<B>A.</B> If it's for an individual entry, then you can -use the entry's <TT>sort</TT><A NAME="5353"></A> key to sort it according to a -different term. If it's for the entire alphabet, then you will need -to use <TT>xindy</TT><A NAME="5356"></A> (instead of <TT>makeindex</TT><A NAME="5359"></A>) and use an -appropriate <TT>xindy</TT><A NAME="5362"></A> language module. Writing <TT>xindy</TT><A NAME="5365"></A> -modules or styles is beyond the scope of this manual. Further -information about <TT>xindy</TT><A NAME="5368"></A> can be found at the -<A NAME="tex2html18" - HREF="http://xindy.sourceforge.net/">Xindy Web Site</A>. -There is also a link to the <TT>xindy</TT><A NAME="5371"></A> mailing list from that -site. - -<P> -</LI> -</OL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H1><A NAME="SECTION00030000000000000000"></A><A NAME="sec:overview"></A> -<BR> -Overview of Main User Commands -</H1> - -<P> - -<H2><A NAME="SECTION00031000000000000000"></A> -<A NAME="sec:pkgopts"></A> -<BR> -Package Options -</H2> - -<P> -The <TT>glossaries</TT> package options are as follows: -<DL> -<DT><STRONG><TT>nowarn</TT><A NAME="5383"></A></STRONG></DT> -<DD>This suppresses all warnings generated by -the <TT>glossaries</TT> package. - -<P> -</DD> -<DT><STRONG><TT>nomain</TT><A NAME="5393"></A></STRONG></DT> -<DD>This suppresses the creation of the main -glossary. Note that if you use this option, you must create another -glossary in which to put all your entries (either via the -<TT>acronym</TT><A NAME="5402"></A> package option described below or via -<TT>\newglossary</TT><A NAME="5406"></A> described in -<A HREF="glossaries-manual.html#sec:newglossary">Defining New -Glossaries</A>). - -<P> -</DD> -<DT><STRONG><TT>toc</TT><A NAME="5414"></A></STRONG></DT> -<DD>Add the glossaries to the table of contents. -Note that an extra LaTeX run is required with this option. - -<P> -</DD> -<DT><STRONG><TT>numberline</TT><A NAME="5423"></A></STRONG></DT> -<DD>When used with <TT>toc</TT><A NAME="5432"></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="5441"></A> option is omitted. If <TT>toc</TT><A NAME="5450"></A> is -used without <TT>numberline</TT><A NAME="5459"></A>, the title will be aligned with -the section numbers rather than the section titles. - -<P> -</DD> -<DT><STRONG><TT>acronym</TT><A NAME="5468"></A></STRONG></DT> -<DD>This creates a new glossary with the -label <TT>acronym</TT>. This is equivalent to: -<PRE> -\newglossary[alg]{acronym}{acr}{acn}{\acronymname} -</PRE> -If the <TT>acronym</TT><A NAME="5477"></A> package option is used, <TT>\acronymtype</TT><A NAME="5481"></A> -is set to <TT>acronym</TT> otherwise it is set to -<TT>main</TT>.<A NAME="tex2html19" - HREF="#foot4258"><SUP>3</SUP></A> -Entries that are defined using <TT>\newacronym</TT><A NAME="5502"></A> are placed in -the glossary whose label is given by <TT>\acronymtype</TT><A NAME="5505"></A>, unless -another glossary is explicitly specified. - -<P> -</DD> -<DT><STRONG><TT>acronymlists</TT><A NAME="5513"></A></STRONG></DT> -<DD>By default, only the <TT>acronym</TT> -glossary is considered to be a list of acronyms. If you have other -lists of acronyms, you can specify them as a comma-separated list -in the value of <TT>acronymlists</TT><A NAME="5522"></A>. For example, if you want -the <TT>main</TT> glossary to also contain a list of acronyms, you -can do: -<PRE> -\usepackage[acronym,acronymlists={main}]{glossaries} -</PRE> -No check is performed to determine if the listed glossaries exist, -so you can add glossaries you haven't defined yet. For example: -<PRE> -\usepackage[acronym,acronymlists={main,acronym2}]{glossaries} -\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} -</PRE> - -<P> -</DD> -<DT><STRONG><TT>section</TT><A NAME="5531"></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, -otherwise each glossary will appear in a chapter, if chapters -exist, otherwise in a section. Unnumbered sectional units will be used -by default. Example: -<PRE> -\usepackage[section=subsection]{glossaries} -</PRE> -You can omit the value if you want to use sections, i.e. <PRE> -\usepackage[section]{glossaries} -</PRE> -is equivalent to -<PRE> -\usepackage[section=section]{glossaries} -</PRE> -You can change this value later in the document using - -<P> -<TT>\setglossarysection{</TT><EM>name</EM><TT>}</TT> -<P> -where <I>name</I> is the sectional unit. - -<P> -The start of each glossary adds information to the page header via - -<P> -<TT>\glossarymark{</TT><EM>glossary title</EM><TT>}</TT> -<P> -This defaults to <TT>\@mkboth</TT>, but you may need to redefine it. -For example, to only change the right header: -<PRE> -\renewcommand{\glossarymark}[1]{\markright{#1}} -</PRE> -or to prevent it from changing the headers: -<PRE> -\renewcommand{\glossarymark}[1]{} -</PRE> - -<P> -Occasionally you may find that another package defines -<TT>\cleardoublepage</TT> when it is not required. This may cause an -unwanted blank page to appear before each glossary. This can -be fixed by redefining <TT>\glsclearpage</TT><A NAME="5535"></A>: -<PRE> -\renewcommand*{\glsclearpage}{\clearpage} -</PRE> - -<P> -</DD> -<DT><STRONG><TT>numberedsection</TT><A NAME="5543"></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="5552"></A>. This option can take -three possible values: <TT>false</TT><A NAME="5556"></A> (no -number, i.e. use starred form), <TT>nolabel</TT><A NAME="5558"></A> -(numbered, i.e. unstarred form, but not labelled) and -<TT>autolabel</TT><A NAME="5560"></A> (numbered with automatic -labelling). If <TT>numberedsection=autolabel</TT><A NAME="5569"></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="tex2html20" - HREF="#foot4259"><SUP>4</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> +</div> +<!--l. 964--><p class="nopar" > +</p><!--l. 966--><p class="indent" > The indexing application’s style file is specified by +</p><!--l. 967--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\@istfilename</span><span +class="ectt-0900"> </span></span><a + id="dx1-10004"></a><span +class="ectt-1000">\@istfilename{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">filename</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 969--><p class="noindent" > +The file extension indicates whether to use <span +class="ectt-1000">makeindex</span><a + id="dx1-10005"></a> (<span +class="ectt-1000">.ist</span><a + id="dx1-10006"></a>) or <span +class="ectt-1000">xindy</span><a + id="dx1-10007"></a> (<span +class="ectt-1000">.xdy</span><a + id="dx1-10008"></a>). Note +that the glossary information is formatted differently depending on which +indexing application is supposed to be used, so it’s important to call the correct +one. +</p><!--l. 976--><p class="indent" > Word or letter ordering is specified by: +</p><!--l. 977--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\@glsorder</span><span +class="ectt-0900"> </span></span><a + id="dx1-10009"></a><span +class="ectt-1000">\@glsorder{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">order</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 979--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">order</span><span +class="cmsy-10">⟩ </span>can be either <span +class="ectt-1000">word </span>or <span +class="ectt-1000">letter</span>. +</p><!--l. 982--><p class="indent" > If <span +class="ectt-1000">xindy</span><a + id="dx1-10010"></a> should be used, the language and code page for each glossary is specified +by +</p><!--l. 984--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\@xdylanguage</span><span +class="ectt-0900"> </span></span><a + id="dx1-10011"></a><span class="marginpar"><span +class="ectt-0900">\@gls@codepage</span><span +class="ectt-0900"> </span></span><a + id="dx1-10012"></a><span +class="ectt-1000">\@xdylanguage{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><br +class="newline" /><span +class="ectt-1000">\@gls@codepage{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 987--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>identifies the glossary, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩ </span>is the root language (e.g. <span +class="ectt-1000">english</span>) and +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩ </span>is the encoding (e.g. <span +class="ectt-1000">utf8</span>). These commands are omitted if <span +class="ectt-1000">makeindex</span><a + id="dx1-10013"></a> should +be used. +</p><!--l. 994--><p class="noindent" > +</p> +<!--l. 994--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">1.4 </span> <a + id="x1-110001.4"></a>Troubleshooting</h4> +<!--l. 997--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package comes with a minimal file called <span +class="ectt-1000">minimalgls.tex </span>which can be +used for testing. This should be located in the <span +class="ectt-1000">samples </span>subdirectory (folder) of the +<span +class="ecss-1000">glossaries </span>documentation directory. The location varies according to your operating +system and <span class="TEX">T<span +class="E">E</span>X</span> installation. For example, on my Linux partition it can be +found in <span +class="ectt-1000">/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/</span>. +Further information on debugging <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code is available at +<a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/" class="url" ><span +class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</span></a>. +</p><!--l. 1007--><p class="indent" > Below is a list of the most frequently asked questions. For other queries, consult the <span +class="ecss-1000">glossaries</span> +FAQ at <a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" class="url" ><span +class="ectt-1000">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html</span></a>. +</p><!--l. 1011--><p class="indent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-11002x1"><span +class="ecbx-1000">Q. </span>I get the error message: + + + + <div class="verbatim" id="verbatim-13"> + Missing \begin{document} +</div> + <!--l. 1015--><p class="nopar" > + </p><!--l. 1017--><p class="noindent" ><span +class="ecbx-1000">A. </span>Check you are using an up to date version of the <span +class="ecss-1000">xkeyval</span><a + id="dx1-11003"></a> package. + </p></li> + <li + class="enumerate" id="x1-11005x2"><span +class="ecbx-1000">Q. </span>I’ve used the <span +class="ecss-1000">smallcaps</span><a + id="dx1-11006"></a> option, but the acronyms are displayed in normal sized + upper case letters. + <!--l. 1023--><p class="noindent" ><span +class="ecbx-1000">A. </span>The <span +class="ecss-1000">smallcaps</span><a + id="dx1-11007"></a> package option uses <span +class="ectt-1000">\textsc </span>to typeset the acronyms. This + command converts lower case letters to small capitals, while upper case letters + remain their usual size. Therefore you need to specify the acronym in lower case + letters. + </p></li> + <li + class="enumerate" id="x1-11009x3"><span +class="ecbx-1000">Q. </span>My acronyms won’t break across a line when they’re expanded. + <!--l. 1031--><p class="noindent" ><span +class="ecbx-1000">A. </span>PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> can break hyperlinks across a line, but <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> can’t. If you + can’t use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> then disable the first use links using the package option + <span +class="ecss-1000">hyperfirst=false</span><a + id="dx1-11010"></a>. + </p></li> + <li + class="enumerate" id="x1-11012x4"><span +class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in? + <!--l. 1037--><p class="noindent" ><span +class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span +class="ecss-1000">smaller</span><a + id="dx1-11013"></a> package option and redefine + <span +class="ectt-1000">\acronymfont </span>to use the required typesetting command. For example, suppose + you would like the acronyms displayed in a sans-serif font, then you can + do: + + + +</p> + <div class="verbatim" id="verbatim-14"> + \usepackage[smaller]{glossaries} +  <br />\renewcommand*{\acronymfont}[1]{\textsf{#1}} +</div> + <!--l. 1044--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-11015x5"><span +class="ecbx-1000">Q. </span>How do I change the font that the acronyms are displayed in on first + use<a + id="dx1-11016"></a>? + <!--l. 1049--><p class="noindent" ><span +class="ecbx-1000">A. </span>The easiest way to do this is to specify the <span +class="ecss-1000">smaller</span><a + id="dx1-11017"></a> package option and redefine + <span +class="ectt-1000">\firstacronymfont </span>to use the required command. Note that if you don’t want + the acronym on subsequent use to use <span +class="ectt-1000">\textsmaller</span>, you will also need to + redefine <span +class="ectt-1000">\acronymfont</span>, as above. For example to make the acronym emphasized + on first use<a + id="dx1-11018"></a>, but use the surrounding font for subsequent use, you can + do: + + + +</p> + <div class="verbatim" id="verbatim-15"> + \usepackage[smaller]{glossaries} +  <br />\renewcommand*{\firstacronymfont}[1]{\emph{#1}} +  <br />\renewcommand*{\acronymfont}[1]{#1} +</div> + <!--l. 1059--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-11020x6"><span +class="ecbx-1000">Q. </span>I don’t have Perl installed, do I have to use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-11021"></a>? + <!--l. 1064--><p class="noindent" ><span +class="ecbx-1000">A. </span>Although it is strongly recommended that you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-11022"></a>, you don’t + have to use it. For further details, read <a +href="#x1-80001.3.2">§1.3.2 </a><a +href="#x1-80001.3.2">Using xindy explicitly<!--tex4ht:ref: sec:xindyapp --></a> or <a +href="#x1-90001.3.3">§1.3.3 + </a><a +href="#x1-90001.3.3">Using makeindex explicitly<!--tex4ht:ref: sec:makeindexapp --></a>, depending on whether you want to use <span +class="ectt-1000">xindy</span><a + id="dx1-11023"></a> or + <span +class="ectt-1000">makeindex</span><a + id="dx1-11024"></a>. + </p></li> + <li + class="enumerate" id="x1-11026x7"><span +class="ecbx-1000">Q. </span>I’m used to using the <span +class="ecss-1000">glossary </span>package: are there any instructions on migrating + from the <span +class="ecss-1000">glossary</span><a + id="dx1-11027"></a> package to the <span +class="ecss-1000">glossaries </span>package? + <!--l. 1073--><p class="noindent" ><span +class="ecbx-1000">A. </span>Read <a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> which + should be available from the same location as this document. + </p></li> + <li + class="enumerate" id="x1-11029x8"><span +class="ecbx-1000">Q. </span>I’m using <span +class="ecss-1000">babel</span><a + id="dx1-11030"></a> but the fixed names haven’t been translated. + <!--l. 1080--><p class="noindent" ><span +class="ecbx-1000">A. </span>The <span +class="ecss-1000">glossaries </span>package currently only supports the following languages: + Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, Italian, + Hungarian, Polish, Serbian and Spanish. If you want to add another language, + send me the translations, and I’ll add them to the next version. + </p><!--l. 1086--><p class="noindent" >If you are using one of the above languages, but the text hasn’t been translated, + try adding the <span +class="ecss-1000">translator</span><a + id="dx1-11031"></a> package with the required languages explicitly (before + you load the <span +class="ecss-1000">glossaries </span>package). For example: + + + +</p> + <div class="verbatim" id="verbatim-16"> + \usepackage[ngerman]{babel} +  <br />\usepackage[ngerman]{translator} +  <br />\usepackage{glossaries} +</div> + <!--l. 1094--><p class="nopar" > Alternatively, you can add the language as a global option to the class file. Check + the <span +class="ecss-1000">translator </span>package documentation for further details. + </p></li> + <li + class="enumerate" id="x1-11033x9"><span +class="ecbx-1000">Q. </span>My acronyms contain strange characters when I use commands like + <span +class="ectt-1000">\acrlong</span><a + id="dx1-11034"></a>. + <!--l. 1102--><p class="noindent" ><span +class="ecbx-1000">A. </span>Switch off the sanitization: + + + +</p> + <div class="verbatim" id="verbatim-17"> + \usepackage[sanitize=none]{glossaries} +</div> + <!--l. 1105--><p class="nopar" > and protect fragile commands. + </p></li> + <li + class="enumerate" id="x1-11036x10"><span +class="ecbx-1000">Q. </span>My glossaries haven’t appeared. + <!--l. 1110--><p class="noindent" ><span +class="ecbx-1000">A. </span>Remember to do the following: </p> + <ul class="itemize1"> + <li class="itemize">Add <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-11037"></a> to the document preamble. + </li> + <li class="itemize">Use either <span +class="ectt-1000">\printglossary</span><a + id="dx1-11038"></a> for each glossary that has been defined or + <span +class="ectt-1000">\printglossaries</span><a + id="dx1-11039"></a>. + </li> + <li class="itemize">Use the commands listed in <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a +href="#x1-240002.5">§2.5 + </a><a +href="#x1-240002.5">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a +href="#x1-250002.6">§2.6 + </a><a +href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a> for each entry that you want to appear in + the glossary. + </li> + <li class="itemize">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document, then run <span +class="ectt-1000">makeglossaries</span><a + id="dx1-11040"></a>, then run + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document again. If you want the glossaries to appear + in the table of contents, you will need an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. If any + of your entries cross-reference an entry that’s not referenced in the + main body of the document, you will need to run <span +class="ectt-1000">makeglossaries</span><a + id="dx1-11041"></a> + (see <a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>) after the second + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run, followed by another <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run.</li></ul> + <!--l. 1130--><p class="noindent" >Check the log files (<span +class="ectt-1000">.log</span><a + id="dx1-11042"></a>, <span +class="ectt-1000">.glg</span><a + id="dx1-11043"></a> etc) for any warnings. + </p></li> + <li + class="enumerate" id="x1-11045x11"><span +class="ecbx-1000">Q. </span>It is possible to change the rules used to sort the glossary entries? + <!--l. 1136--><p class="noindent" ><span +class="ecbx-1000">A. </span>If it’s for an individual entry, then you can use the entry’s <span +class="ecss-1000">sort</span><a + id="dx1-11046"></a> key to sort it + according to a different term. If it’s for the entire alphabet, then you will + need to use <span +class="ectt-1000">xindy</span><a + id="dx1-11047"></a> (instead of <span +class="ectt-1000">makeindex</span><a + id="dx1-11048"></a>) and use an appropriate <span +class="ectt-1000">xindy</span><a + id="dx1-11049"></a> + language module. Writing <span +class="ectt-1000">xindy</span><a + id="dx1-11050"></a> modules or styles is beyond the scope + of this manual. Further information about <span +class="ectt-1000">xindy</span><a + id="dx1-11051"></a> can be found at the + <a +href="http://xindy.sourceforge.net/" >Xindy Web Site</a>. There is also a link to the <span +class="ectt-1000">xindy</span><a + id="dx1-11052"></a> mailing list from that + site. +</p> + </li></ol> + + + +<!--l. 1149--><p class="noindent" > +</p> +<!--l. 1149--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-120002"></a>Overview of Main User Commands</h3> +<a + id="dx1-12001"></a> +<!--l. 1152--><p class="noindent" >This section is an overview of the main user commands and package options. If you find +this too complicated, try starting out with the <a +href="glossariesbegin.html" >guide for beginners</a>. +</p><!--l. 1156--><p class="noindent" > +</p> +<!--l. 1156--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.1 </span> <a + id="x1-130002.1"></a>Package Options</h4> +<!--l. 1159--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package options are as follows: + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">nowarn</span><a + id="dx1-13001"></a> </dt><dd +class="description">This suppresses all warnings generated by the <span +class="ecss-1000">glossaries </span>package. + </dd><dt class="description"> +<span +class="ecsx-1000">nomain</span><a + id="dx1-13002"></a> </dt><dd +class="description">This suppresses the creation of the main glossary. Note that if you use + this option, you must create another glossary in which to put all your entries + (either via the <span +class="ecss-1000">acronym</span><a + id="dx1-13003"></a> package option described below or via <span +class="ectt-1000">\newglossary</span><a + id="dx1-13004"></a> + described in <a +href="#x1-330002.9">§2.9 </a><a +href="#x1-330002.9">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">toc</span><a + id="dx1-13005"></a> </dt><dd +class="description">Add the glossaries to the table of contents. Note that an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is + required with this option. Alternatively, you can switch this function on and off + using + <!--l. 1173--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glstoctrue</span><span +class="ectt-0900"> </span></span><a + id="dx1-13006"></a><span +class="ectt-1000">\glstoctrue </span></div><hr> + </p><!--l. 1175--><p class="noindent" > + and + </p><!--l. 1177--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glstocfalse</span><span +class="ectt-0900"> </span></span><a + id="dx1-13007"></a><span +class="ectt-1000">\glstocfalse </span></div><hr> + </p><!--l. 1179--><p class="noindent" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">numberline</span><a + id="dx1-13008"></a> </dt><dd +class="description">When used with <span +class="ecss-1000">toc</span><a + id="dx1-13009"></a>, this will add <span +class="ectt-1000">\numberline</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">{}</span></span></span> in the final + argument of <span +class="ectt-1000">\addcontentsline</span>. This will align the table of contents + entry with the numbered section titles. Note that this option has no + effect if the <span +class="ecss-1000">toc</span><a + id="dx1-13010"></a> option is omitted. If <span +class="ecss-1000">toc</span><a + id="dx1-13011"></a> is used without <span +class="ecss-1000">numberline</span><a + id="dx1-13012"></a>, the + title will be aligned with the section numbers rather than the section + titles. + </dd><dt class="description"> +<span +class="ecsx-1000">acronym</span><a + id="dx1-13013"></a> </dt><dd +class="description">This creates a new glossary with the label <span +class="ectt-1000">acronym</span>. This is equivalent + to: + + + + <div class="verbatim" id="verbatim-18"> + \newglossary[alg]{acronym}{acr}{acn}{\acronymname} +</div> + <!--l. 1193--><p class="nopar" > If the <span +class="ecss-1000">acronym</span><a + id="dx1-13014"></a> package option is used, <span +class="ectt-1000">\acronymtype</span><a + id="dx1-13015"></a> is set to <span +class="ectt-1000">acronym </span>otherwise it is set + to <span +class="ectt-1000">main</span>.<span class="footnote-mark"><a +href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a + id="x1-13016f2"></a> + Entries that are defined using <span +class="ectt-1000">\newacronym</span><a + id="dx1-13021"></a> are placed in the glossary whose + label is given by <span +class="ectt-1000">\acronymtype</span><a + id="dx1-13022"></a>, unless another glossary is explicitly + specified. + </p></dd><dt class="description"> +<span +class="ecsx-1000">acronymlists</span><a + id="dx1-13023"></a> </dt><dd +class="description">By default, only the <span +class="ectt-1000">acronym </span>glossary is considered to be a list of + acronyms. If you have other lists of acronyms, you can specify them + as a comma-separated list in the value of <span +class="ecss-1000">acronymlists</span><a + id="dx1-13024"></a>. For example, if + you want the <span +class="ectt-1000">main </span>glossary to also contain a list of acronyms, you can + do: + + + + <div class="verbatim" id="verbatim-19"> + \usepackage[acronym,acronymlists={main}]{glossaries} +</div> + <!--l. 1212--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add + glossaries you haven’t defined yet. For example: + + + +</p> + <div class="verbatim" id="verbatim-20"> + \usepackage[acronym,acronymlists={main,acronym2}]{glossaries} +  <br />\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms} +</div> + <!--l. 1218--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">section</span><a + id="dx1-13025"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option. Its value should be the name of a sectional unit + (e.g. chapter). This will make the glossaries appear in the named sectional + unit, otherwise each glossary will appear in a chapter, if chapters exist, + otherwise in a section. Unnumbered sectional units will be used by default. + Example: + + + + <div class="verbatim" id="verbatim-21"> + \usepackage[section=subsection]{glossaries} +</div> + <!--l. 1228--><p class="nopar" > You can omit the value if you want to use sections, i.e.  + + + +</p> + <div class="verbatim" id="verbatim-22"> + \usepackage[section]{glossaries} +</div> + <!--l. 1232--><p class="nopar" > is equivalent to + + + +</p> + <div class="verbatim" id="verbatim-23"> + \usepackage[section=section]{glossaries} +</div> + <!--l. 1236--><p class="nopar" > You can change this value later in the document using + </p><!--l. 1238--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\setglossarysection</span><span +class="ectt-0900"> </span></span><a + id="dx1-13026"></a><span +class="ectt-1000">\setglossarysection{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 1240--><p class="noindent" > + where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the sectional unit. + </p><!--l. 1243--><p class="noindent" >The start of each glossary adds information to the page header via + </p><!--l. 1244--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossarymark</span><span +class="ectt-0900"> </span></span><a + id="dx1-13027"></a><span +class="ectt-1000">\glossarymark{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary title</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 1246--><p class="noindent" > + This defaults to <span +class="ectt-1000">\@mkboth</span>, but you may need to redefine it. For example, to only + change the right header: + + + +</p> + <div class="verbatim" id="verbatim-24"> + \renewcommand{\glossarymark}[1]{\markright{#1}} +</div> + <!--l. 1251--><p class="nopar" > or to prevent it from changing the headers: + + + +</p> + <div class="verbatim" id="verbatim-25"> + \renewcommand{\glossarymark}[1]{} +</div> + <!--l. 1255--><p class="nopar" > + </p><!--l. 1257--><p class="noindent" >Occasionally you may find that another package defines <span +class="ectt-1000">\cleardoublepage </span>when + it is not required. This may cause an unwanted blank page to appear before each + glossary. This can be fixed by redefining <span +class="ectt-1000">\glsclearpage</span><a + id="dx1-13028"></a>: + + + +</p> + <div class="verbatim" id="verbatim-26"> + \renewcommand*{\glsclearpage}{\clearpage} +</div> + <!--l. 1263--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">numberedsection</span><a + id="dx1-13029"></a> </dt><dd +class="description">The glossaries are placed in unnumbered sectional units by + default, but this can be changed using <span +class="ecss-1000">numberedsection</span><a + id="dx1-13030"></a>. This option + can take three possible values: <span +class="ecss-1000">false</span><a + id="dx1-13031"></a> (no number, i.e. use starred form), + <span +class="ecss-1000">nolabel</span><a + id="dx1-13032"></a> (numbered, i.e. unstarred form, but not labelled) and <span +class="ecss-1000">autolabel</span><a + id="dx1-13033"></a> + (numbered with automatic labelling). If <span +class="ecss-1000">numberedsection=autolabel</span><a + id="dx1-13034"></a> is used, + each glossary is given a label that matches the glossary type, so the + main (default) glossary is labelled <span +class="ectt-1000">main</span>, the list of acronyms is labelled + <span +class="ectt-1000">acronym</span><span class="footnote-mark"><a +href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a + id="x1-13035f3"></a> + and additional glossaries are labelled using the value specified in the first + mandatory argument to <span +class="ectt-1000">\newglossary</span>. For example, if you load <span +class="ecss-1000">glossaries</span> + using: + + + + <div class="verbatim" id="verbatim-27"> + \usepackage[section,numberedsection=autolabel]{glossaries} +</div> + <!--l. 1283--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using + something like: + + + +</p> + <div class="verbatim" id="verbatim-28"> + The main glossary is in section~\ref{main} and the list of +  <br />acronyms is in section~\ref{acronym}. +</div> + <!--l. 1289--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a + separate list of acronyms, you can use <span +class="ectt-1000">\acronymtype</span><a + id="dx1-13037"></a> which is set to <span +class="ectt-1000">main </span>if the + <span +class="ecss-1000">acronym</span><a + id="dx1-13038"></a> option is not used and is set to <span +class="ectt-1000">acronym </span>if the <span +class="ecss-1000">acronym</span><a + id="dx1-13039"></a> option is used. + For example: + + + +</p> + <div class="verbatim" id="verbatim-29"> + The list of acronyms is in section~\ref{\acronymtype}. +</div> + <!--l. 1297--><p class="nopar" > + </p><!--l. 1299--><p class="noindent" >As from version 1.14, you can add a prefix to the label by redefining + </p><!--l. 1301--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsautoprefix</span><span +class="ectt-0900"> </span></span><a + id="dx1-13040"></a><span +class="ectt-1000">\glsautoprefix </span></div><hr> + </p><!--l. 1303--><p class="noindent" > + For example: + + + +</p> + <div class="verbatim" id="verbatim-30"> + \renewcommand*{\glsautoprefix}{glo:} +</div> + <!--l. 1307--><p class="nopar" > will add <span +class="ectt-1000">glo: </span>to the automatically generated label, so you can then, for example, + refer to the list of acronyms as follows: + + + +</p> + <div class="verbatim" id="verbatim-31"> + The list of acronyms is in section~\ref{glo:\acronymtype}. +</div> + <!--l. 1312--><p class="nopar" > Or, if you are undecided on a prefix: + + + +</p> + <div class="verbatim" id="verbatim-32"> + The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. +</div> + <!--l. 1316--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">style</span><a + id="dx1-13041"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option. Its value should be the name of the glossary style + to use. Predefined glossary styles are listed in <a +href="#x1-380002.12">§2.12 </a><a +href="#x1-380002.12">Glossary Styles<!--tex4ht:ref: sec:styles --></a>. + </dd><dt class="description"> +<span +class="ecsx-1000">nolong</span><a + id="dx1-13042"></a> </dt><dd +class="description">This prevents the <span +class="ecss-1000">glossaries </span>package from automatically loading <span +class="ecss-1000">glossary-long</span><a + id="dx1-13043"></a> + (which means that the <span +class="ecss-1000">longtable</span><a + id="dx1-13044"></a> package also won’t be loaded). This reduces + overhead by not defining unwanted styles and commands. Note that if you use + this option, you won’t be able to use any of the glossary styles defined in the + <span +class="ecss-1000">glossary-long </span>package. + </dd><dt class="description"> +<span +class="ecsx-1000">nosuper</span><a + id="dx1-13045"></a> </dt><dd +class="description">This prevents the <span +class="ecss-1000">glossaries </span>package from automatically loading <span +class="ecss-1000">glossary-super</span><a + id="dx1-13046"></a> + (which means that the <span +class="ecss-1000">supertabular</span><a + id="dx1-13047"></a> package also won’t be loaded). This reduces + overhead by not defining unwanted styles and commands. Note that if you use + this option, you won’t be able to use any of the glossary styles defined in the + <span +class="ecss-1000">glossary-super </span>package. + </dd><dt class="description"> +<span +class="ecsx-1000">nolist</span><a + id="dx1-13048"></a> </dt><dd +class="description">This prevents the <span +class="ecss-1000">glossaries </span>package from automatically loading <span +class="ecss-1000">glossary-list</span><a + id="dx1-13049"></a>. + This reduces overhead by not defining unwanted styles. Note that if + you use this option, you won’t be able to use any of the glossary styles + defined in the <span +class="ecss-1000">glossary-list </span>package. Note that since the default style is <span +class="ecss-1000">list</span><a + id="dx1-13050"></a>, + you will also need to use the <span +class="ecss-1000">style</span><a + id="dx1-13051"></a> option to set the style to something + else. + </dd><dt class="description"> +<span +class="ecsx-1000">notree</span><a + id="dx1-13052"></a> </dt><dd +class="description">This prevents the <span +class="ecss-1000">glossaries </span>package from automatically loading <span +class="ecss-1000">glossary-tree</span><a + id="dx1-13053"></a>. + This reduces overhead by not defining unwanted styles. Note that if you use this + option, you won’t be able to use any of the glossary styles defined in the + <span +class="ecss-1000">glossary-tree </span>package. + </dd><dt class="description"> +<span +class="ecsx-1000">nostyles</span><a + id="dx1-13054"></a> </dt><dd +class="description">This prevents all the predefined styles from being loaded. This option is + provided in the event that the user has custom styles that are not dependent on + the styles provided by the <span +class="ecss-1000">glossaries </span>package. Note that if you use this + option, you can’t use the <span +class="ecss-1000">style</span><a + id="dx1-13055"></a> package option. Instead you must either use + <span +class="ectt-1000">\glossarystyle</span><a + id="dx1-13056"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>or the <span +class="ecss-1000">style</span><a + id="dx1-13057"></a> key in the optional argument to + <span +class="ectt-1000">\printglossary</span><a + id="dx1-13058"></a>. + + + + </dd><dt class="description"> +<span +class="ecsx-1000">nonumberlist</span><a + id="dx1-13059"></a> </dt><dd +class="description">This option will suppress the associated number lists<a + id="dx1-13060"></a> in the glossaries + (see also <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>). + </dd><dt class="description"> +<span +class="ecsx-1000">counter</span><a + id="dx1-13061"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option. The value should be the name of the default + counter to use in the number lists<a + id="dx1-13062"></a>. + <!--l. 1369--><p class="noindent" ><a + id="sanitize"></a> + </p></dd><dt class="description"> +<span +class="ecsx-1000">sanitize</span><a + id="dx1-13063"></a> </dt><dd +class="description">This is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>option whose value is also a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>list. By + default, the <span +class="ecss-1000">glossaries </span>package sanitizes the values of the <span +class="ecss-1000">name</span><a + id="dx1-13064"></a>, <span +class="ecss-1000">description</span><a + id="dx1-13065"></a> and + <span +class="ecss-1000">symbol</span><a + id="dx1-13066"></a> keys used when defining a new glossary entry. This means that you can use + fragile commands in those keys, but it may lead to unexpected results if you try + to display these values within the document text. This sanitization can be + switched off using the <span +class="ecss-1000">sanitize</span><a + id="dx1-13067"></a> package option. For example, to switch off the + sanitization for the <span +class="ecss-1000">description</span><a + id="dx1-13068"></a> and <span +class="ecss-1000">name</span><a + id="dx1-13069"></a> keys, but not for the <span +class="ecss-1000">symbol</span><a + id="dx1-13070"></a> key, + do: + + + + <div class="verbatim" id="verbatim-33"> + \usepackage[sanitize={name=false,description=false,% +  <br />symbol=true}]{glossaries} +</div> + <!--l. 1385--><p class="nopar" > You can use <span +class="ecss-1000">sanitize=none</span><a + id="dx1-13071"></a> as a shortcut for<br +class="newline" /><span +class="ecss-1000">sanitize={name=false,description=false,symbol=false}</span>. + </p><!--l. 1389--><p class="noindent" ><div class="important" title="Important Note"><span +class="ecbx-1000">Note</span>: this sanitization only applies to the <span +class="ecss-1000">name</span><a + id="dx1-13072"></a>, <span +class="ecss-1000">description</span><a + id="dx1-13073"></a> and <span +class="ecss-1000">symbol</span><a + id="dx1-13074"></a> keys. It + doesn’t apply to any of the other keys (except the <span +class="ecss-1000">sort</span><a + id="dx1-13075"></a> key which is always + sanitized) so fragile commands contained in the value of the other keys must + always be protected using <span +class="ectt-1000">\protect</span>. Since the value of the <span +class="ecss-1000">text</span><a + id="dx1-13076"></a> key is obtained + from the <span +class="ecss-1000">name</span><a + id="dx1-13077"></a> key, you will still need to protect fragile commands in the <span +class="ecss-1000">name</span><a + id="dx1-13078"></a> key + if you don’t use the <span +class="ecss-1000">text</span><a + id="dx1-13079"></a> key. </div> + </p><!--l. 1398--><p class="noindent" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">description</span><a + id="dx1-13080"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-13081"></a> to allow a description. + See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">footnote</span><a + id="dx1-13082"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-13083"></a> and the way that + acronyms are displayed. See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">smallcaps</span><a + id="dx1-13084"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-13085"></a> and the way that + acronyms are displayed. See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">smaller</span><a + id="dx1-13086"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-13087"></a> and the way that acronyms + are displayed. If you use this option, you will need to include the <span +class="ecss-1000">relsize</span><a + id="dx1-13088"></a> package or + otherwise define <span +class="ectt-1000">\textsmaller</span><a + id="dx1-13089"></a> or redefine <span +class="ectt-1000">\acronymfont</span><a + id="dx1-13090"></a>. See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for + further details. + </dd><dt class="description"> +<span +class="ecsx-1000">dua</span><a + id="dx1-13091"></a> </dt><dd +class="description">This option changes the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-13092"></a> so that acronyms are always + expanded. See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">shortcuts</span><a + id="dx1-13093"></a> </dt><dd +class="description">This option provides shortcut commands for acronyms. See <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a> + for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">makeindex</span><a + id="dx1-13094"></a> </dt><dd +class="description">(Default) The glossary information and indexing style file will be written in + <span +class="ectt-1000">makeindex</span><a + id="dx1-13095"></a> format. If you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-13096"></a>, it will automatically detect that it + + + + needs to call <span +class="ectt-1000">makeindex</span><a + id="dx1-13097"></a>. If you don’t use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-13098"></a>, you need to remember + to use <span +class="ectt-1000">makeindex</span><a + id="dx1-13099"></a> not <span +class="ectt-1000">xindy</span><a + id="dx1-13100"></a>. The indexing style file will been given a <span +class="ectt-1000">.ist</span><a + id="dx1-13101"></a> + extension. + </dd><dt class="description"> +<span +class="ecsx-1000">xindy</span><a + id="dx1-13102"></a> </dt><dd +class="description">The glossary information and indexing style file will be written in <span +class="ectt-1000">xindy</span><a + id="dx1-13103"></a> format. + If you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-13104"></a>, it will automatically detect that it needs to call + <span +class="ectt-1000">xindy</span><a + id="dx1-13105"></a>. If you don’t use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-13106"></a>, you need to remember to use + <span +class="ectt-1000">xindy</span><a + id="dx1-13107"></a> not <span +class="ectt-1000">makeindex</span><a + id="dx1-13108"></a>. The indexing style file will been given a <span +class="ectt-1000">.xdy</span><a + id="dx1-13109"></a> + extension. + <!--l. 1440--><p class="noindent" >The <span +class="ecss-1000">xindy</span><a + id="dx1-13110"></a> package option may additionally have a value that is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩</span> + comma-separated list to override the language and codepage. For example: + + + +</p> + <div class="verbatim" id="verbatim-34"> + \usepackage[xindy={language=english,codepage=utf8}]{glossaries} +</div> + <!--l. 1445--><p class="nopar" > You can also specify whether you want a number group in the glossary. This + defaults to true, but can be suppressed. For example: + + + +</p> + <div class="verbatim" id="verbatim-35"> + \usepackage[xindy={glsnumbers=false}]{glossaries} +</div> + <!--l. 1450--><p class="nopar" > See <a +href="#x1-290002.8.2">§2.8.2 </a><a +href="#x1-290002.8.2">Xindy<!--tex4ht:ref: sec:xindy --></a> for further details on using <span +class="ectt-1000">xindy</span><a + id="dx1-13111"></a> with the <span +class="ecss-1000">glossaries</span> + package. + </p></dd><dt class="description"> +<span +class="ecsx-1000">order</span><a + id="dx1-13112"></a> </dt><dd +class="description">This may take two values: <span +class="ecss-1000">word</span><a + id="dx1-13113"></a> or <span +class="ecss-1000">letter</span><a + id="dx1-13114"></a>. The default is word ordering. Note that + this option has no effect if you don’t use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-13115"></a>. + </dd><dt class="description"> +<span +class="ecsx-1000">translate</span><a + id="dx1-13116"></a> </dt><dd +class="description">This is a boolean option. The default is <span +class="ecss-1000">true</span><a + id="dx1-13117"></a> if <span +class="ecss-1000">babel</span><a + id="dx1-13118"></a>, <span +class="ecss-1000">polyglossia</span><a + id="dx1-13119"></a> or <span +class="ecss-1000">translator</span><a + id="dx1-13120"></a> + have been loaded, otherwise the default value is <span +class="ecss-1000">false</span><a + id="dx1-13121"></a>. + <!--l. 1464--><p class="noindent" > + </p><dl class="description"><dt class="description"> + <span +class="ecsx-1000">translate=true</span><a + id="dx1-13122"></a> </dt><dd +class="description">If <span +class="ecss-1000">babel</span><a + id="dx1-13123"></a> has been loaded and the <span +class="ecss-1000">translator</span><a + id="dx1-13124"></a> package is + installed, <span +class="ecss-1000">translator</span><a + id="dx1-13125"></a> will be loaded and the translations will be provided + by the <span +class="ecss-1000">translator</span><a + id="dx1-13126"></a> package interface. You can modify the translations by + providing your own dictionary. If the <span +class="ecss-1000">translator</span><a + id="dx1-13127"></a> package isn’t installed + and <span +class="ecss-1000">babel</span><a + id="dx1-13128"></a> is loaded, the <span +class="ecss-1000">glossaries-babel</span><a + id="dx1-13129"></a> package will be loaded and the + translations will be provided using <span +class="ecss-1000">babel</span>’s <span +class="ectt-1000">\addto\caption</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩</span> + mechanism. If <span +class="ecss-1000">polyglossia</span><a + id="dx1-13130"></a> has been loaded, <span +class="ecss-1000">glossaries-polyglossia</span><a + id="dx1-13131"></a> will be + loaded. + </dd><dt class="description"> + <span +class="ecsx-1000">translate=false</span><a + id="dx1-13132"></a> </dt><dd +class="description">Don’t provide translations, even if <span +class="ecss-1000">babel</span><a + id="dx1-13133"></a> or <span +class="ecss-1000">polyglossia</span><a + id="dx1-13134"></a> has + been loaded. You can then provide you’re own translations or explicitly + load <span +class="ecss-1000">glossaries-babel</span><a + id="dx1-13135"></a> or <span +class="ecss-1000">glossaries-polyglossia</span><a + id="dx1-13136"></a>.</dd></dl> + <!--l. 1483--><p class="noindent" >See <a +href="#x1-50001.2.1">§1.2.1 </a><a +href="#x1-50001.2.1">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details. + </p></dd><dt class="description"> +<span +class="ecsx-1000">hyperfirst</span><a + id="dx1-13137"></a> </dt><dd +class="description">This is a boolean option that specifies whether each term has a hyperlink on + first use<a + id="dx1-13138"></a>. The default is <span +class="ecss-1000">hyperfirst=true</span><a + id="dx1-13139"></a> (terms on first use have a hyperlink, + unless explicitly suppressed using starred versions of commands such as + <span +class="ectt-1000">\gls*</span>). + </dd></dl> + + + +<!--l. 1493--><p class="noindent" > +</p> +<!--l. 1493--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.2 </span> <a + id="x1-140002.2"></a>Defining Glossary Entries</h4> +<!--l. 1496--><p class="noindent" >All glossary entries must be defined before they are used, so it is better to define them in the preamble +to ensure this.<span class="footnote-mark"><a +href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a + id="x1-14001f4"></a> +However only those entries that occur in the document (using any of the commands +described in <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a +href="#x1-240002.5">§2.5 </a><a +href="#x1-240002.5">Adding an Entry to the Glossary +Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a +href="#x1-250002.6">§2.6 </a><a +href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. +Each time an entry is used in this way, a line is added to an associated glossary file +(<span +class="ectt-1000">.glo</span><a + id="dx1-14002"></a>), which then needs to be converted into a corresponding <span +class="ectt-1000">.gls</span><a + id="dx1-14003"></a> file which contains +the typeset glossary which is input by <span +class="ectt-1000">\printglossary</span><a + id="dx1-14004"></a> or <span +class="ectt-1000">\printglossaries</span><a + id="dx1-14005"></a>. The Perl +script <span +class="ectt-1000">makeglossaries</span><a + id="dx1-14006"></a> can be used to call <span +class="ectt-1000">makeindex</span><a + id="dx1-14007"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-14008"></a>, using a customised +indexing style file, for each of the glossaries that are defined in the document. Note +that there should be no need for you to explicitly edit or input any of these +external files. See <a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> for further +details. +</p><!--l. 1515--><p class="indent" > The command +</p><!--l. 1516--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\makeglossaries</span><span +class="ectt-0900"> </span></span><a + id="dx1-14009"></a><span +class="ectt-1000">\makeglossaries </span></div><hr> +</p><!--l. 1518--><p class="noindent" > +must be placed in the preamble in order to create the customised <span +class="ectt-1000">makeindex</span><a + id="dx1-14010"></a> (<span +class="ectt-1000">.ist</span><a + id="dx1-14011"></a>) or +<span +class="ectt-1000">xindy</span><a + id="dx1-14012"></a> (<span +class="ectt-1000">.xdy</span><a + id="dx1-14013"></a>) style file and to ensure that glossary entries are written to the +appropriate output files. If you omit <span +class="ectt-1000">\makeglossaries </span>none of the glossaries will be +created. +</p><!--l. 1525--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span +class="ecss-1000">glossaries </span>package must be placed +before <span +class="ectt-1000">\makeglossaries </span>as they are required when creating the customised style file. If +you attempt to use those commands after <span +class="ectt-1000">\makeglossaries </span>you will generate an error. +</div> +</p><!--l. 1531--><p class="noindent" > +</p><!--l. 1533--><p class="indent" > You can suppress the creation of the customised <span +class="ectt-1000">xindy</span><a + id="dx1-14014"></a> or <span +class="ectt-1000">makeindex</span><a + id="dx1-14015"></a> style file +using +</p><!--l. 1535--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\noist</span><span +class="ectt-0900"> </span></span><a + id="dx1-14016"></a><span +class="ectt-1000">\noist </span></div><hr> +</p><!--l. 1537--><p class="noindent" > +Note that this command must be used before <span +class="ectt-1000">\makeglossaries</span>. +</p><!--l. 1540--><p class="indent" > The default name for the customised style file is given by <span +class="ectt-1000">\jobname</span><a + id="dx1-14017"></a><span +class="ectt-1000">.ist</span><a + id="dx1-14018"></a> +(for <span +class="ectt-1000">makeindex</span><a + id="dx1-14019"></a>) or <span +class="ectt-1000">\jobname</span><a + id="dx1-14020"></a><span +class="ectt-1000">.xdy</span><a + id="dx1-14021"></a> (for <span +class="ectt-1000">xindy</span><a + id="dx1-14022"></a>). This name may be changed using: -<PRE> -\usepackage[section,numberedsection=autolabel]{glossaries} -</PRE> -then each glossary will appear in a numbered section, and can -be referenced using something like: -<PRE> -The main glossary is in section~\ref{main} and the list of -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="5581"></A> which is set to <TT>main</TT> if the -<TT>acronym</TT><A NAME="5589"></A> option is not used and is set to <TT>acronym</TT> -if the <TT>acronym</TT><A NAME="5598"></A> option is used. For example: -<PRE> -The list of acronyms is in section~\ref{\acronymtype}. -</PRE> - -<P> -As from version 1.14, you can add a prefix to the label by -redefining - -<P> -<TT>\glsautoprefix</TT> -<P> +</p><!--l. 1544--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\setStyleFile</span><span +class="ectt-0900"> </span></span><a + id="dx1-14023"></a><span +class="ectt-1000">\setStyleFile{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1546--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the name of the style file without the extension. Note that this +command must be used before <span +class="ectt-1000">\makeglossaries</span>. +</p><!--l. 1551--><p class="indent" > Each glossary entry is assigned a number list<a + id="dx1-14024"></a> that lists all the locations in the +document where that entry was used. By default, the location refers to the page number +but this may be overridden using the <span +class="ecss-1000">counter</span><a + id="dx1-14025"></a> package option. The default form of +the location number assumes a full stop compositor (e.g. 1.2), but if your +location numbers use a different compositor (e.g. 1-2) you need to set this + + + +using +</p><!--l. 1558--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsSetCompositor</span><span +class="ectt-0900"> </span></span><a + id="dx1-14026"></a><span +class="ectt-1000">\glsSetCompositor{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1560--><p class="noindent" > For example: -<PRE> -\renewcommand*{\glsautoprefix}{glo:} -</PRE> -will add <TT>glo:</TT> to the automatically generated label, so -you can then, for example, refer to the list of acronyms as follows: -<PRE> -The list of acronyms is in section~\ref{glo:\acronymtype}. -</PRE> -Or, if you are undecided on a prefix: -<PRE> -The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. -</PRE> - -<P> -</DD> -<DT><STRONG><TT>style</TT><A NAME="5607"></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>nolong</TT><A NAME="5616"></A></STRONG></DT> -<DD>This prevents the <TT>glossaries</TT> package -from automatically loading <TT>glossary-long</TT><A NAME="5621"></A> (which means that -the <TT>longtable</TT><A NAME="5624"></A> package also won't be loaded). This reduces -overhead by not defining unwanted styles and commands. Not that if -you use this option, you won't be able to use any of the -glossary styles defined in the <TT>glossary-long</TT> package. - -<P> -</DD> -<DT><STRONG><TT>nosuper</TT><A NAME="5633"></A></STRONG></DT> -<DD>This prevents the <TT>glossaries</TT> package -from automatically loading <TT>glossary-super</TT><A NAME="5638"></A> (which means that -the <TT>supertabular</TT><A NAME="5641"></A> package also won't be loaded). This reduces -overhead by not defining unwanted styles and commands. Not that if -you use this option, you won't be able to use any of the -glossary styles defined in the <TT>glossary-super</TT> package. - -<P> -</DD> -<DT><STRONG><TT>nolist</TT><A NAME="5650"></A></STRONG></DT> -<DD>This prevents the <TT>glossaries</TT> package -from automatically loading <TT>glossary-list</TT><A NAME="5655"></A>. This reduces -overhead by not defining unwanted styles. Not that if -you use this option, you won't be able to use any of the -glossary styles defined in the <TT>glossary-list</TT> package. -Note that since the default style is <TT>list</TT><A NAME="5659"></A>, you will -also need to use the <TT>style</TT><A NAME="5666"></A> option to set the style to -something else. - -<P> -</DD> -<DT><STRONG><TT>notree</TT><A NAME="5675"></A></STRONG></DT> -<DD>This prevents the <TT>glossaries</TT> package -from automatically loading <TT>glossary-tree</TT><A NAME="5680"></A>. This reduces -overhead by not defining unwanted styles. Not that if -you use this option, you won't be able to use any of the -glossary styles defined in the <TT>glossary-tree</TT> package. - -<P> -</DD> -<DT><STRONG><TT>nostyles</TT><A NAME="5689"></A></STRONG></DT> -<DD>This prevents all the predefined styles -from being loaded. This option is provided in the event that the -user has custom styles that are not dependent on the styles -provided by the <TT>glossaries</TT> package. Note that if you use -this option, you can't use the <TT>style</TT><A NAME="5699"></A> package option. Instead -you must either use <TT>\glossarystyle</TT><A NAME="5703"></A><TT>{</TT><EM>style</EM><TT>}</TT> or -the <TT>style</TT><A NAME="5706"></A> key in the -optional argument to <TT>\printglossary</TT><A NAME="5709"></A>. - -<P> -</DD> -<DT><STRONG><TT>nonumberlist</TT><A NAME="5717"></A></STRONG></DT> -<DD>This option will suppress the -associated number lists<A NAME="5720"></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="5727"></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="5730"></A>. - -<P> -<A NAME="sanitize"></A> -</DD> -<DT><STRONG><TT>sanitize</TT><A NAME="5737"></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="5742"></A>, <TT>description</TT><A NAME="5745"></A> and <TT>symbol</TT><A NAME="5748"></A> keys used -when defining a new glossary entry. This means that you can use -fragile commands in those keys, but it may lead to unexpected results -if you try to display these values within the document text. This -sanitization can be switched off using the <TT>sanitize</TT><A NAME="5756"></A> package -option. For example, to switch off the sanitization for the -<TT>description</TT><A NAME="5760"></A> and <TT>name</TT><A NAME="5763"></A> keys, but not for the -<TT>symbol</TT><A NAME="5766"></A> key, do: -<PRE> -\usepackage[sanitize={name=false,description=false,% -symbol=true}]{glossaries} -</PRE> -You can use <TT>sanitize=none</TT><A NAME="5776"></A> as a shortcut for -<BR> -<TT>sanitize={name=false,description=false,symbol=false}</TT>. - -<P> -<B>Note</B>: this sanitization only applies to the <TT>name</TT><A NAME="5779"></A>, -<TT>description</TT><A NAME="5782"></A> and <TT>symbol</TT><A NAME="5785"></A> keys. It doesn't apply -to any of the other keys (except the <TT>sort</TT><A NAME="5788"></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="5791"></A> key is obtained from the -<TT>name</TT><A NAME="5794"></A> key, you will still need to protect fragile commands -in the <TT>name</TT><A NAME="5797"></A> key if you don't use the <TT>text</TT><A NAME="5800"></A> key. - -<P> -</DD> -<DT><STRONG><TT>description</TT><A NAME="5808"></A></STRONG></DT> -<DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="5812"></A> to allow a description. See <A HREF="glossaries-manual.html#sec:acronyms">later</A> -for further details. - -<P> -</DD> -<DT><STRONG><TT>footnote</TT><A NAME="5820"></A></STRONG></DT> -<DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="5824"></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="5832"></A></STRONG></DT> -<DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="5836"></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>smaller</TT><A NAME="5844"></A></STRONG></DT> -<DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="5848"></A> and the way that acronyms are displayed. -If you use this option, you will need to include the <TT>relsize</TT><A NAME="5851"></A> -package or otherwise define <TT>\textsmaller</TT><A NAME="5854"></A> or redefine -<TT>\acronymfont</TT><A NAME="5857"></A>. See -<A HREF="glossaries-manual.html#sec:acronyms">later</A> -for further details. - -<P> -</DD> -<DT><STRONG><TT>dua</TT><A NAME="5865"></A></STRONG></DT> -<DD>This option changes the definition of -<TT>\newacronym</TT><A NAME="5869"></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="5877"></A></STRONG></DT> -<DD>This option provides shortcut commands -for acronyms. -See <A HREF="glossaries-manual.html#sec:acronyms">later</A> -for further details. - -<P> -</DD> -<DT><STRONG><TT>makeindex</TT><A NAME="5886"></A></STRONG></DT> -<DD>(Default) The glossary information and -indexing style file will be written in <TT>makeindex</TT><A NAME="5890"></A> format. If you use -<TT>makeglossaries</TT><A NAME="5893"></A>, it will automatically detect that it needs -to call <TT>makeindex</TT><A NAME="5896"></A>. If you don't use -<TT>makeglossaries</TT><A NAME="5899"></A>, you need to remember to use -<TT>makeindex</TT><A NAME="5902"></A> not <TT>xindy</TT><A NAME="5905"></A>. The indexing style file -will been given a <TT>.ist</TT><A NAME="5908"></A> extension. - -<P> -</DD> -<DT><STRONG><TT>xindy</TT><A NAME="5915"></A></STRONG></DT> -<DD>The glossary information and indexing style file will -be written in <TT>xindy</TT><A NAME="5919"></A> format. If you use -<TT>makeglossaries</TT><A NAME="5922"></A>, it will automatically detect that it needs -to call <TT>xindy</TT><A NAME="5925"></A>. If you don't use <TT>makeglossaries</TT><A NAME="5928"></A>, -you need to remember to use <TT>xindy</TT><A NAME="5931"></A> not <TT>makeindex</TT><A NAME="5934"></A>. -The indexing style file will been given a <TT>.xdy</TT><A NAME="5937"></A> extension. - -<P> -The <TT>xindy</TT><A NAME="5944"></A> package option may additionally have a -value that is a <I>key</I>=<I>value</I> comma-separated list to override -the language and codepage. For example: -<PRE> -\usepackage[xindy={language=english,codepage=utf8}]{glossaries} -</PRE> -You can also specify whether you want a number group in -the glossary. This defaults to true, but can be suppressed. For -example: -<PRE> -\usepackage[xindy={glsnumbers=false}]{glossaries} -</PRE> -See <A HREF="glossaries-manual.html#sec:xindy">Xindy</A> -for further details on using <TT>xindy</TT><A NAME="5948"></A> with the -<TT>glossaries</TT> package. - -<P> -</DD> -<DT><STRONG><TT>order</TT><A NAME="5957"></A></STRONG></DT> -<DD>This may take two values: -<TT>word</TT><A NAME="5961"></A> or <TT>letter</TT><A NAME="5963"></A>. The default -is word ordering. Note that this option has no effect if you -don't use <TT>makeglossaries</TT><A NAME="5965"></A>. - -<P> -</DD> -<DT><STRONG><TT>translate</TT><A NAME="5973"></A></STRONG></DT> -<DD>This is a boolean option. The default is -<TT>true</TT><A NAME="5977"></A> if <TT>babel</TT><A NAME="5979"></A>, <TT>polyglossia</TT><A NAME="5982"></A> or -<TT>translator</TT><A NAME="5985"></A> have been loaded, otherwise the default value is -<TT>false</TT><A NAME="5988"></A>. - -<P> -<DL> -<DT><STRONG><TT>translate=true</TT><A NAME="5997"></A></STRONG></DT> -<DD>If <TT>babel</TT><A NAME="5999"></A> has been loaded - and the <TT>translator</TT><A NAME="6002"></A> package is installed, <TT>translator</TT><A NAME="6005"></A> - will be loaded and the translations will be provided by the - <TT>translator</TT><A NAME="6008"></A> package interface. You can modify the - translations by providing your own dictionary. If the - <TT>translator</TT><A NAME="6011"></A> package isn't installed and <TT>babel</TT><A NAME="6014"></A> is - loaded, the <TT>glossaries-babel</TT><A NAME="6017"></A> package will - be loaded and the translations will be provided using <TT>babel</TT>'s - <TT>\addto\caption</TT><I>language</I> mechanism. If - <TT>polyglossia</TT><A NAME="6021"></A> has been loaded, <TT>glossaries-polyglossia</TT><A NAME="6024"></A> - will be loaded. - -<P> -</DD> -<DT><STRONG><TT>translate=false</TT><A NAME="6034"></A></STRONG></DT> -<DD>Don't provide translations, even - if <TT>babel</TT><A NAME="6036"></A> or <TT>polyglossia</TT><A NAME="6039"></A> has been loaded. You can - then provide you're own translations or explicitly load - <TT>glossaries-babel</TT><A NAME="6042"></A> or <TT>glossaries-polyglossia</TT><A NAME="6045"></A>. - -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>hyperfirst</TT><A NAME="6053"></A></STRONG></DT> -<DD>This is a boolean option that specifies -whether each term has a hyperlink on first use<A NAME="6056"></A>. The default is -<TT>hyperfirst=true</TT><A NAME="6065"></A> (terms on first use have a hyperlink, -unless explicitly suppressed using starred versions of commands -such as <TT>\gls*</TT>). - -<P> -</DD> -</DL> -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00032000000000000000"></A> -<A NAME="sec:newglosentry"></A> -<BR> -Defining Glossary Entries -</H2> - -<P> -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="tex2html21" - HREF="#foot4283"><SUP>5</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>, -<A HREF="glossaries-manual.html#sec:glsadd">Adding an entry to the glossary without generating text</A> or -<A HREF="glossaries-manual.html#sec:crossref">Cross-Referencing -Entries</A>) will appear in the glossary. Each time an entry -is used in this way, a line is added to an associated glossary file -(<TT>.glo</TT><A NAME="6070"></A>), which then needs to be converted into a -corresponding <TT>.gls</TT><A NAME="6072"></A> file which contains the typeset -glossary which is input by <TT>\printglossary</TT><A NAME="6074"></A> or -<TT>\printglossaries</TT><A NAME="6077"></A>. The Perl script <TT>makeglossaries</TT><A NAME="6080"></A> can -be used to call <TT>makeindex</TT><A NAME="6083"></A> or <TT>xindy</TT><A NAME="6086"></A>, using a -customised indexing style file, for each of the glossaries that are -defined in the document. Note that there should be no need for you -to explicitly edit or input any of these external files. See -<A HREF="glossaries-manual.html#sec:makeglossaries">Generating the -Associated Glossary Files</A> -for further details. - -<P> -The command <TT>\makeglossaries</TT> must be placed in the preamble in -order to create the customised <TT>makeindex</TT><A NAME="6089"></A> (<TT>.ist</TT><A NAME="6092"></A>) -or <TT>xindy</TT><A NAME="6094"></A> (<TT>.xdy</TT><A NAME="6097"></A>) -style file and to ensure that glossary entries are written to the -appropriate output files. If you omit <TT>\makeglossaries</TT> none of the -glossaries will be created. - -<P> -Note that some of the commands provided by the <TT>glossaries</TT> -package must be placed before <TT>\makeglossaries</TT> as they are -required when creating the customised style file. If you attempt -to use those commands after <TT>\makeglossaries</TT> you will generate -an error. - -<P> -You can suppress the creation of the customised <TT>xindy</TT><A NAME="6100"></A> -or <TT>makeindex</TT><A NAME="6103"></A> style file using <TT>\noist</TT>. Note that this -command must be used before <TT>\makeglossaries</TT>. - -<P> -The default name for the customised style file is given by -<TT>\jobname</TT><A NAME="6106"></A><TT>.ist</TT><A NAME="6109"></A> (for <TT>makeindex</TT><A NAME="6111"></A>) or -<TT>\jobname</TT><A NAME="6114"></A><TT>.xdy</TT><A NAME="6117"></A> (for <TT>xindy</TT><A NAME="6119"></A>). This name may be -changed using: - -<P> -<TT>\setStyleFile{</TT><EM>name</EM><TT>}</TT> -<P> -where <I>name</I> is the name of the style file without the -extension. Note that this command must be used before -<TT>\makeglossaries</TT>. - -<P> -Each glossary entry is assigned a number list<A NAME="6121"></A> that lists all -the locations in the document where that entry was used. By default, -the location refers to the page number but this may be overridden -using the <TT>counter</TT><A NAME="6128"></A> package option. The default form of -the location number assumes a full stop compositor (e.g. 1.2), -but if your location numbers use a different compositor (e.g. 1-2) -you need to set this using - -<P> -<TT>\glsSetCompositor{</TT><EM>symbol</EM><TT>}</TT> -<P> -For example: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-36"> \glsSetCompositor{-} -</PRE> -Note that this command must be used before <TT>\makeglossaries</TT>. - -<P> -If you use <TT>xindy</TT><A NAME="6132"></A>, you can have a different compositor -for page numbers starting with an uppercase alphabetical -character using: - -<P> -<TT>\glsSetAlphaCompositor{</TT><EM>symbol</EM><TT>}</TT> -<P> -Note that this command has no effect if you haven't used the -<TT>xindy</TT><A NAME="6140"></A> package option. For example, if you want -number lists<A NAME="6143"></A> containing a mixture of A-1 and 2.3 -style formats, then do: -<PRE> -\glsSetCompositor{.} -\glsSetAlphaCompositor{-} -</PRE> -See <A HREF="glossaries-manual.html#sec:numberlists">Number -lists</A> for -further information about number lists<A NAME="6144"></A>. - -<P> -New glossary entries are defined using the command: - -<P> -<TT>\newglossaryentry{</TT><EM>label</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT> -<P> -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="6146"></A> and -<TT>description</TT><A NAME="6149"></A>, except for sub-entries where the -<TT>name</TT><A NAME="6152"></A> field may be omitted. Available fields are listed -below: - -<P> -<DL> -<DT><STRONG><TT>name</TT><A NAME="6155"></A></STRONG></DT> -<DD>The name of the entry (as it will appear in -the glossary). If this key is omitted and the <TT>parent</TT><A NAME="6158"></A> -key is supplied, this value will be the same as the parent's name. - -<P> -</DD> -<DT><STRONG><TT>description</TT><A NAME="6161"></A></STRONG></DT> -<DD>A brief description of this term (to -appear in the glossary). Within this value, you can use -<TT>\nopostdesc</TT> to suppress the -description terminator for this entry. For example, if this -entry is a parent entry that doesn't require a description, you -can do <code>description={\nopostdesc}</code>. If you want a paragraph -break in the description use <TT>\glspar</TT>. -However, note that not all glossary styles support multi-line -descriptions. If you are using one of the tabular-like glossary -styles that permit multi-line descriptions, use <TT>\newline</TT><A NAME="6164"></A> -not <code>\\</code> if you want to force a line break. - -<P> -</DD> -<DT><STRONG><TT>parent</TT><A NAME="6167"></A></STRONG></DT> -<DD>The label of the parent entry. Note that -the parent entry must be defined before its sub-entries. -See <A HREF="glossaries-manual.html#sec:subentries">Sub-Entries</A> for -further details. - -<P> -</DD> -<DT><STRONG><TT>descriptionplural</TT><A NAME="6170"></A></STRONG></DT> -<DD>The plural form of the -description (as passed to <TT>\glsdisplay</TT><A NAME="6173"></A> and <TT>\glsdisplayfirst</TT><A NAME="6176"></A> -by <TT>\glspl</TT><A NAME="6179"></A>, <TT>\Glspl</TT><A NAME="6182"></A> and <TT>\GLSpl</TT><A NAME="6185"></A>). If omitted, the value -is set to the same as the <TT>description</TT><A NAME="6188"></A> key. - -<P> -</DD> -<DT><STRONG><TT>text</TT><A NAME="6191"></A></STRONG></DT> -<DD>How this entry will appear in the document text -when using <TT>\gls</TT><A NAME="6194"></A> (or one of its uppercase variants). If this -field is omitted, the value of the <TT>name</TT><A NAME="6197"></A> key is used. - -<P> -</DD> -<DT><STRONG><TT>first</TT><A NAME="6200"></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="6203"></A><A NAME="6205"></A> (or one of its uppercase -variants). If this field is omitted, the value of the <TT>text</TT><A NAME="6207"></A> -key is used. - -<P> -</DD> -<DT><STRONG><TT>plural</TT><A NAME="6210"></A></STRONG></DT> -<DD>How the entry will appear in the document text -when using <TT>\glspl</TT><A NAME="6213"></A> (or one of its uppercase variants). -If this field is omitted, the value is obtained by appending -<TT>\glspluralsuffix</TT><A NAME="6216"></A> to the value of the <TT>text</TT><A NAME="6219"></A> field. -The default value of <TT>\glspluralsuffix</TT> is the letter -"s". - -<P> -</DD> -<DT><STRONG><TT>firstplural</TT><A NAME="6222"></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="6225"></A><A NAME="6227"></A> (or one of its -uppercase variants). If this field is omitted, the value is obtained -from the <TT>plural</TT><A NAME="6229"></A> key, if the <TT>first</TT><A NAME="6232"></A> key is omitted, -or by appending <TT>\glspluralsuffix</TT><A NAME="6235"></A> to the value of the -<TT>first</TT><A NAME="6238"></A> field, if the <TT>first</TT><A NAME="6241"></A> field is present. - -<P> -<B>Note:</B> prior to version 1.13, the default value of -<TT>firstplural</TT><A NAME="6244"></A> was always taken by appending "s" to the -<TT>first</TT><A NAME="6247"></A> key, which meant that you had to specify both -<TT>plural</TT><A NAME="6250"></A> and <TT>firstplural</TT><A NAME="6253"></A>, even if you hadn't -used the <TT>first</TT><A NAME="6256"></A> key. - -<P> -</DD> -<DT><STRONG><TT>symbol</TT><A NAME="6259"></A></STRONG></DT> -<DD>This field is provided to allow the user to -specify an associated symbol. If omitted, the value is set to -<TT>\relax</TT>. Note that not all glossary styles display the -symbol. - -<P> -</DD> -<DT><STRONG><TT>symbolplural</TT><A NAME="6262"></A></STRONG></DT> -<DD>This is the plural form of the -symbol (as passed to <TT>\glsdisplay</TT><A NAME="6265"></A> and <TT>\glsdisplayfirst</TT><A NAME="6268"></A> -by <TT>\glspl</TT><A NAME="6271"></A>, <TT>\Glspl</TT><A NAME="6274"></A> and <TT>\GLSpl</TT><A NAME="6277"></A>). If omitted, the value -is set to the same as the <TT>symbol</TT><A NAME="6280"></A> key. - -<P> -</DD> -<DT><STRONG><TT>sort</TT><A NAME="6283"></A></STRONG></DT> -<DD>This value indicates how <TT>makeindex</TT><A NAME="6286"></A> -or <TT>xindy</TT><A NAME="6289"></A> should sort this entry. If omitted, the value is -given by the <TT>name</TT><A NAME="6292"></A> field. - -<P> -</DD> -<DT><STRONG><TT>type</TT><A NAME="6295"></A></STRONG></DT> -<DD>This specifies the label of the glossary in -which this entry belongs. If omitted, the default glossary is -assumed. The list of acronyms type is given by -<TT>\acronymtype</TT><A NAME="6298"></A> which will either be <TT>main</TT> or -<TT>acronym</TT>, depending on whether the <TT>acronym</TT><A NAME="6306"></A> package -option was used. - -<P> -</DD> -<DT><STRONG><TT>user1</TT><A NAME="6310"></A>, ..., <TT>user6</TT><A NAME="6313"></A></STRONG></DT> -<DD>Six additional -keys provided for any additional information the user may want -to specify. (For example, an associated dimension or an alternative -plural.) - -<P> -</DD> -<DT><STRONG><TT>nonumberlist</TT><A NAME="6316"></A></STRONG></DT> -<DD>Suppress the number list<A NAME="6318"></A> for -this entry. - -<P> -</DD> -<DT><STRONG><TT>see</TT><A NAME="6320"></A></STRONG></DT> -<DD>Cross-reference another entry. Using the -<TT>see</TT><A NAME="6323"></A> key will automatically add this entry to the -glossary, but will not automatically add the cross-referenced entry. -The referenced entry should be supplied as the value to this key. -If you want to override the "see" tag, you can supply the new -tag in square brackets before the label. For example -<code>see=[see also]{anotherlabel}</code>. For further details, -see <A HREF="glossaries-manual.html#sec:crossref">later</A>. - -<P> -</DD> -</DL> -Note that if the name starts with an accented letter or non-Latin -character, you must group the accented letter, otherwise it will -cause a problem for commands like <TT>\Gls</TT> and <TT>\Glspl</TT>. -For example: -<PRE> -\newglossaryentry{elite}{name={{\'e}lite}, -description={select group or class}} -</PRE> -Note that the same applies if you are using the <TT>inputenc</TT><A NAME="6326"></A> -package: -<PRE> -\newglossaryentry{elite}{name={{é}lite}, -description={select group or class}} -</PRE> -Note that in both of the above examples, you will also need to -supply the <TT>sort</TT><A NAME="6329"></A> key if you are using <TT>makeindex</TT><A NAME="6332"></A> -whereas <TT>xindy</TT><A NAME="6335"></A> is usually able to sort accented letters +</div> +<!--l. 1564--><p class="nopar" > Note that this command must be used before <span +class="ectt-1000">\makeglossaries</span>. +</p><!--l. 1567--><p class="indent" > If you use <span +class="ectt-1000">xindy</span><a + id="dx1-14027"></a>, you can have a different compositor for page numbers starting +with an uppercase alphabetical character using: +</p><!--l. 1569--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsSetAlphaCompositor</span><span +class="ectt-0900"> </span></span><a + id="dx1-14028"></a><span +class="ectt-1000">\glsSetAlphaCompositor{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1571--><p class="noindent" > +Note that this command has no effect if you haven’t used the <span +class="ecss-1000">xindy</span><a + id="dx1-14029"></a> package option. For +example, if you want number lists<a + id="dx1-14030"></a> containing a mixture of A-1 and 2.3 style formats, +then do: + + + +</p> + <div class="verbatim" id="verbatim-37"> +\glsSetCompositor{.} \glsSetAlphaCompositor{-} +</div> +<!--l. 1578--><p class="nopar" > See <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about number lists<a + id="dx1-14031"></a>. +</p><!--l. 1582--><p class="indent" > New glossary entries are defined using the command: +</p><!--l. 1583--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\newglossaryentry</span><span +class="ectt-0900"> </span></span><a + id="dx1-14032"></a><span +class="ectt-1000">\newglossaryentry{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1585--><p class="noindent" > +The first argument, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, must be a unique label with which to identify this entry. +The second argument, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span>, is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>list that supplies the relevant +information about this entry. There are two required fields: <span +class="ecss-1000">description</span><a + id="dx1-14033"></a> and either <span +class="ecss-1000">name</span><a + id="dx1-14034"></a> +or <span +class="ecss-1000">parent</span><a + id="dx1-14035"></a>. Available fields are listed below: +</p><!--l. 1593--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">name</span><a + id="dx1-14036"></a> </dt><dd +class="description">The name of the entry (as it will appear in the glossary). If this key is + omitted and the <span +class="ecss-1000">parent</span><a + id="dx1-14037"></a> key is supplied, this value will be the same as the + parent’s name. + </dd><dt class="description"> +<span +class="ecsx-1000">description</span><a + id="dx1-14038"></a> </dt><dd +class="description">A brief description of this term (to appear in the glossary). Within this + value, you can use + <!--l. 1600--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\nopostdesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-14039"></a><span +class="ectt-1000">\nopostdesc </span></div><hr> + </p><!--l. 1602--><p class="noindent" > + to suppress the description terminator for this entry. For example, if this + entry is a parent entry that doesn’t require a description, you can do + <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">description={\nopostdesc}</span></span></span>. If you want a paragraph break in the description + use + </p><!--l. 1608--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glspar</span><span +class="ectt-0900"> </span></span><a + id="dx1-14040"></a><span +class="ectt-1000">\glspar </span></div><hr> + </p><!--l. 1610--><p class="noindent" > + However, note that not all glossary styles support multi-line descriptions. If you + are using one of the tabular-like glossary styles that permit multi-line + descriptions, use <span +class="ectt-1000">\newline</span><a + id="dx1-14041"></a> not <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\\</span></span></span> if you want to force a line break. + </p></dd><dt class="description"> +<span +class="ecsx-1000">parent</span><a + id="dx1-14042"></a> </dt><dd +class="description">The label of the parent entry. Note that the parent entry must be defined before + its sub-entries. See <a +href="#x1-160002.2.2">§2.2.2 </a><a +href="#x1-160002.2.2">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details. + </dd><dt class="description"> +<span +class="ecsx-1000">descriptionplural</span><a + id="dx1-14043"></a> </dt><dd +class="description">The plural form of the description (as passed to <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-14044"></a> and + <span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-14045"></a> by <span +class="ectt-1000">\glspl</span><a + id="dx1-14046"></a>, <span +class="ectt-1000">\Glspl</span><a + id="dx1-14047"></a> and <span +class="ectt-1000">\GLSpl</span><a + id="dx1-14048"></a>). If omitted, the value is set to + the same as the <span +class="ecss-1000">description</span><a + id="dx1-14049"></a> key. + + + + </dd><dt class="description"> +<span +class="ecsx-1000">text</span><a + id="dx1-14050"></a> </dt><dd +class="description">How this entry will appear in the document text when using <span +class="ectt-1000">\gls</span><a + id="dx1-14051"></a> (or one of its + uppercase variants). If this field is omitted, the value of the <span +class="ecss-1000">name</span><a + id="dx1-14052"></a> key is + used. + </dd><dt class="description"> +<span +class="ecsx-1000">first</span><a + id="dx1-14053"></a> </dt><dd +class="description">How the entry will appear in the document text the first time it is used with + <span +class="ectt-1000">\gls</span><a + id="dx1-14054"></a><a + id="dx1-14055"></a> (or one of its uppercase variants). If this field is omitted, the value of the + <span +class="ecss-1000">text</span><a + id="dx1-14056"></a> key is used. + </dd><dt class="description"> +<span +class="ecsx-1000">plural</span><a + id="dx1-14057"></a> </dt><dd +class="description">How the entry will appear in the document text when using <span +class="ectt-1000">\glspl</span><a + id="dx1-14058"></a> (or one of its + uppercase variants). If this field is omitted, the value is obtained by appending + <span +class="ectt-1000">\glspluralsuffix</span><a + id="dx1-14059"></a> to the value of the <span +class="ecss-1000">text</span><a + id="dx1-14060"></a> field. The default value of + <span +class="ectt-1000">\glspluralsuffix </span>is the letter “s”. + </dd><dt class="description"> +<span +class="ecsx-1000">firstplural</span><a + id="dx1-14061"></a> </dt><dd +class="description">How the entry will appear in the document text the first time it is used with + <span +class="ectt-1000">\glspl</span><a + id="dx1-14062"></a><a + id="dx1-14063"></a> (or one of its uppercase variants). If this field is omitted, the + value is obtained from the <span +class="ecss-1000">plural</span><a + id="dx1-14064"></a> key, if the <span +class="ecss-1000">first</span><a + id="dx1-14065"></a> key is omitted, or by + appending <span +class="ectt-1000">\glspluralsuffix</span><a + id="dx1-14066"></a> to the value of the <span +class="ecss-1000">first</span><a + id="dx1-14067"></a> field, if the <span +class="ecss-1000">first</span><a + id="dx1-14068"></a> field is + present. + <!--l. 1648--><p class="noindent" ><span +class="ecbx-1000">Note: </span>prior to version 1.13, the default value of <span +class="ecss-1000">firstplural</span><a + id="dx1-14069"></a> was always taken by + appending “s” to the <span +class="ecss-1000">first</span><a + id="dx1-14070"></a> key, which meant that you had to specify both <span +class="ecss-1000">plural</span><a + id="dx1-14071"></a> and + <span +class="ecss-1000">firstplural</span><a + id="dx1-14072"></a>, even if you hadn’t used the <span +class="ecss-1000">first</span><a + id="dx1-14073"></a> key. + </p></dd><dt class="description"> +<span +class="ecsx-1000">symbol</span><a + id="dx1-14074"></a> </dt><dd +class="description">This field is provided to allow the user to specify an associated symbol. If + omitted, the value is set to <span +class="ectt-1000">\relax</span>. Note that not all glossary styles display the + symbol. + </dd><dt class="description"> +<span +class="ecsx-1000">symbolplural</span><a + id="dx1-14075"></a> </dt><dd +class="description">This is the plural form of the symbol (as passed to <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-14076"></a> and + <span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-14077"></a> by <span +class="ectt-1000">\glspl</span><a + id="dx1-14078"></a>, <span +class="ectt-1000">\Glspl</span><a + id="dx1-14079"></a> and <span +class="ectt-1000">\GLSpl</span><a + id="dx1-14080"></a>). If omitted, the value is set to + the same as the <span +class="ecss-1000">symbol</span><a + id="dx1-14081"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">sort</span><a + id="dx1-14082"></a> </dt><dd +class="description">This value indicates how <span +class="ectt-1000">makeindex</span><a + id="dx1-14083"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-14084"></a> should sort this entry. If omitted, + the value is given by the <span +class="ecss-1000">name</span><a + id="dx1-14085"></a> field. + </dd><dt class="description"> +<span +class="ecsx-1000">type</span><a + id="dx1-14086"></a> </dt><dd +class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the + default glossary is assumed. The list of acronyms type is given by <span +class="ectt-1000">\acronymtype</span><a + id="dx1-14087"></a> + which will either be <span +class="ectt-1000">main </span>or <span +class="ectt-1000">acronym</span>, depending on whether the <span +class="ecss-1000">acronym</span><a + id="dx1-14088"></a> package + option was used. + </dd><dt class="description"> +<span +class="ecsx-1000">user1</span><a + id="dx1-14089"></a><span +class="ecbx-1000">, </span><span +class="ecbx-1000">…, </span><span +class="ecsx-1000">user6</span><a + id="dx1-14090"></a> </dt><dd +class="description">Six additional keys provided for any additional information the user + + + + may want to specify. (For example, an associated dimension or an alternative + plural.) + </dd><dt class="description"> +<span +class="ecsx-1000">nonumberlist</span><a + id="dx1-14091"></a> </dt><dd +class="description">Suppress the number list<a + id="dx1-14092"></a> for this entry. + </dd><dt class="description"> +<span +class="ecsx-1000">see</span><a + id="dx1-14093"></a> </dt><dd +class="description">Cross-reference another entry. Using the <span +class="ecss-1000">see</span><a + id="dx1-14094"></a> key will automatically add this entry + to the glossary, but will not automatically add the cross-referenced entry. The + referenced entry should be supplied as the value to this key. If you want to + override the “see” tag, you can supply the new tag in square brackets before the + label. For example <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">see=[see</span><span +class="ectt-1000"> also]{anotherlabel}</span></span></span>. For further details, see <a +href="#x1-250002.6">§2.6 + </a><a +href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>. + </dd></dl> +<!--l. 1693--><p class="noindent" >Note that if the name starts with an accented letter or non-Latin character, you must +group the accented letter, otherwise it will cause a problem for commands like <span +class="ectt-1000">\Gls </span>and +<span +class="ectt-1000">\Glspl</span>. For example: + + + +</p> + <div class="verbatim" id="verbatim-38"> +\newglossaryentry{elite}{name={{\’e}lite}, + <br />description={select group or class}} +</div> +<!--l. 1700--><p class="nopar" > Note that the same applies if you are using the <span +class="ecss-1000">inputenc</span><a + id="dx1-14095"></a> package: + + + +</p> + <div class="verbatim" id="verbatim-39"> +\newglossaryentry{elite}{name={{é}lite}, + <br />description={select group or class}} +</div> +<!--l. 1706--><p class="nopar" > Note that in both of the above examples, you will also need to supply the <span +class="ecss-1000">sort</span><a + id="dx1-14096"></a> key if +you are using <span +class="ectt-1000">makeindex</span><a + id="dx1-14097"></a> whereas <span +class="ectt-1000">xindy</span><a + id="dx1-14098"></a> is usually able to sort accented letters correctly. - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00032100000000000000"> -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 the letter "s". -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> +</p><!--l. 1714--><p class="noindent" > +</p> +<!--l. 1714--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.1 </span> <a + id="x1-150002.2.1"></a>Plurals</h5> +<!--l. 1715--><p class="noindent" >You may have noticed from above that you can specify the plural form when you define +a term. If you omit this, the plural will be obtained by appending +</p><!--l. 1718--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glspluralsuffix</span><span +class="ectt-0900"> </span></span><a + id="dx1-15001"></a><span +class="ectt-1000">\glspluralsuffix </span></div><hr> +</p><!--l. 1720--><p class="noindent" > +to the singular form. This command defaults to the letter “s”. For example: + + + +</p> + <div class="verbatim" id="verbatim-40"> +\newglossaryentry{cow}{name=cow,description={a fully grown + <br />female of any bovine animal}} +</div> +<!--l. 1726--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if +you are writing in archaic English, you may want to use “kine” as the plural form, in +which case you would have to do: + + + +</p> + <div class="verbatim" id="verbatim-41"> \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="6341"></A> key -for one of them and one of the user keys to specify the -other plural form. For example: -<PRE> -\newglossaryentry{cow}{name=cow,description={a fully grown -female of any bovine animal (plural cows, archaic plural kine)}, -user1={kine}} -</PRE> -You can then use <code>\glspl{cow}</code> to produce "cows" and -<code>\glsuseri{cow}</code> to produce "kine". You can, of course, -define an easy to remember synonym. For example: -<PRE> + <br />description={a fully grown female of any bovine animal}} +</div> +<!--l. 1734--><p class="nopar" > +</p><!--l. 1736--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) +then use the <span +class="ecss-1000">plural</span><a + id="dx1-15002"></a> key for one of them and one of the user keys to specify the other +plural form. For example: + + + +</p> + <div class="verbatim" id="verbatim-42"> +\newglossaryentry{cow}{name=cow,description={a fully grown + <br />female of any bovine animal (plural cows, archaic plural kine)}, + <br />user1={kine}} +</div> +<!--l. 1744--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspl{cow}</span></span></span> to produce “cows” and <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuseri{cow}</span></span></span> to +produce “kine”. You can, of course, define an easy to remember synonym. For +example: + + + +</p> + <div class="verbatim" id="verbatim-43"> \let\glsaltpl\glsuseri -</PRE> -Then you don't have to remember which key you used to store the -alternative plural. - -<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="6344"></A> key (and the <TT>firstplural</TT><A NAME="6347"></A> -key where necessary). - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00032200000000000000"></A> -<A NAME="sec:subentries"></A> -<BR> -Sub-Entries -</H3> - -<P> -As from version 1.17, it is possible to specify sub-entries. These -may be used to order the glossary into categories, in which case -the sub-entry will have a different name to its parent entry, or -it may be used to distinguish different definitions for the same -word, in which case the sub-entries will have the same name as -the parent entry. Note that not all glossary styles support -hierarchical entries and may display all the entries in a flat -format. Of the styles that support sub-entries, some display the -sub-entry's name whilst others don't. Therefore you need to -ensure that you use a suitable style. See <A HREF="glossaries-manual.html#sec:styles">later</A> -for a list of predefined +</div> +<!--l. 1750--><p class="nopar" > Then you don’t have to remember which key you used to store the alternative +plural. +</p><!--l. 1754--><p class="indent" > If you are using a language that usually forms plurals by appending a different +letter, or sequence of letters, you can redefine <span +class="ectt-1000">\glspluralsuffix </span>as required. However, +this must be done <span +class="ecti-1000">before </span>the entries are defined. For languages that don’t form plurals +by simply appending a suffix, all the plural forms must be specified using the <span +class="ecss-1000">plural</span><a + id="dx1-15003"></a> key +(and the <span +class="ecss-1000">firstplural</span><a + id="dx1-15004"></a> key where necessary). +</p><!--l. 1763--><p class="noindent" > +</p> +<!--l. 1763--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.2 </span> <a + id="x1-160002.2.2"></a>Sub-Entries</h5> +<!--l. 1766--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order +the glossary into categories, in which case the sub-entry will have a different name to its +parent entry, or it may be used to distinguish different definitions for the same word, +in which case the sub-entries will have the same name as the parent entry. +Note that not all glossary styles support hierarchical entries and may display +all the entries in a flat format. Of the styles that support sub-entries, some +display the sub-entry’s name whilst others don’t. Therefore you need to ensure +that you use a suitable style. See <a +href="#x1-380002.12">§2.12 </a><a +href="#x1-380002.12">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined styles. - -<P> -Note that the parent entry will automatically be added to the -glossary if any of its child entries are used in the document. -If the parent entry is not referenced in the document, it will not -have a number list<A NAME="6352"></A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H4><A NAME="SECTION00032210000000000000"> -Hierarchical Categories</A> -</H4> To arrange a glossary -with hierarchical categories, you need to first define the -category and then define the sub-entries using the relevant -category entry as the value of the <TT>parent</TT><A NAME="6357"></A> key. For -example, suppose I want a glossary of mathematical symbols that -are divided into Greek letters and Roman letters. Then I can -define the categories as follows: -<PRE> -\newglossaryentry{greekletter}{name={Greek letters}, -description={\nopostdesc}} - -\newglossaryentry{romanletter}{name={Roman letters}, -description={\nopostdesc}} -</PRE> - -<P> -Note that in this example, the category entries don't need a -description so I have set the descriptions to <TT>\nopostdesc</TT><A NAME="6360"></A>. -This gives a blank description and suppresses the +</p><!--l. 1778--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its +child entries are used in the document. If the parent entry is not referenced in the +document, it will not have a number list<a + id="dx1-16001"></a>. +</p> +<!--l. 1784--><p class="noindent" ><a +href="#top">Top</a> +</p><!--l. 1784--><p class="noindent" ><span class="paragraphHead"><a + id="x1-170002.2.2"></a><span +class="ecbx-1000">Hierarchical Categories</span></span> + To arrange a glossary with hierarchical categories, you need to first define the +category and then define the sub-entries using the relevant category entry as the value +of the <span +class="ecss-1000">parent</span><a + id="dx1-17001"></a> key. For example, suppose I want a glossary of mathematical symbols that +are divided into Greek letters and Roman letters. Then I can define the categories as +follows: + + + +</p> + <div class="verbatim" id="verbatim-44"> +\newglossaryentry{greekletter}{name={Greek letters}, + <br />description={\nopostdesc}} + <br />\newglossaryentry{romanletter}{name={Roman letters}, + <br />description={\nopostdesc}} +</div> +<!--l. 1797--><p class="nopar" > +</p><!--l. 1799--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set +the descriptions to <span +class="ectt-1000">\nopostdesc</span><a + id="dx1-17002"></a>. This gives a blank description and suppresses the description terminator. +</p><!--l. 1804--><p class="indent" > I can now define my sub-entries as follows: + -<P> -I can now define my sub-entries as follows: -<PRE> + +</p> + <div class="verbatim" id="verbatim-45"> \newglossaryentry{pi}{name={pi}, -description={ratio of the circumference of a circle to the diameter}, -parent=greekletter} - -\newglossaryentry{C}{name=C, -description={Euler's constant}, -parent=romanletter} -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H4><A NAME="SECTION00032220000000000000"> -Homographs</A> -</H4> Sub-entries that have the same name as -the parent entry, don't need to have the <TT>name</TT><A NAME="6366"></A> key. -For example, the word "glossary" can mean a list of technical -words or a collection of glosses. In both cases the plural is -"glossaries". So first define the parent entry: -<PRE> + <br />description={ratio of the circumference of a circle to the diameter}, + <br />parent=greekletter} + <br />\newglossaryentry{C}{name=C, + <br />description={Euler’s constant}, + <br />parent=romanletter} +</div> +<!--l. 1813--><p class="nopar" > +</p> +<!--l. 1816--><p class="noindent" ><a +href="#top">Top</a> +</p><!--l. 1816--><p class="noindent" ><span class="paragraphHead"><a + id="x1-180002.2.2"></a><span +class="ecbx-1000">Homographs</span></span> + Sub-entries that have the same name as the parent entry, don’t need to have the +<span +class="ecss-1000">name</span><a + id="dx1-18001"></a> key. For example, the word “glossary” can mean a list of technical words or a +collection of glosses. In both cases the plural is “glossaries”. So first define the parent +entry: + + + +</p> + <div class="verbatim" id="verbatim-46"> \newglossaryentry{glossary}{name=glossary, -description={\nopostdesc}, -plural={glossaries}} -</PRE> -Again, the parent entry has no description, so the description -terminator needs to be suppressed using <TT>\nopostdesc</TT><A NAME="6369"></A>. - -<P> -Now define the two different meanings of the word: -<PRE> + <br />description={\nopostdesc}, + <br />plural={glossaries}} +</div> +<!--l. 1825--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be +suppressed using <span +class="ectt-1000">\nopostdesc</span><a + id="dx1-18002"></a>. +</p><!--l. 1829--><p class="indent" > Now define the two different meanings of the word: + + + +</p> + <div class="verbatim" id="verbatim-47"> \newglossaryentry{glossarylist}{ -description={1) list of technical words}, -sort={1}, -parent={glossary}} - -\newglossaryentry{glossarycol}{ -description={2) collection of glosses}, -sort={2}, -parent={glossary}} -</PRE> -Note that if I reference the parent entry, the location will be -added to the parent's number list<A NAME="6371"></A>, whereas if I reference -any of the child entries, the location will be added to the child -entry's number list. Note also that since the sub-entries have the -same name, the <TT>sort</TT><A NAME="6373"></A> key is required. - -<P> -In the above example, the plural form for both of the child entries -is the same as the parent entry, so the <TT>plural</TT><A NAME="6376"></A> key was -not required for the child entries. However, if the sub-entries -have different plurals, they will need to be specified. For example: -<PRE> + <br />description={1) list of technical words}, + <br />sort={1}, + <br />parent={glossary}} + <br />\newglossaryentry{glossarycol}{ + <br />description={2) collection of glosses}, + <br />sort={2}, + <br />parent={glossary}} +</div> +<!--l. 1840--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s +number list<a + id="dx1-18003"></a>, whereas if I reference any of the child entries, the location will be added to +the child entry’s number list. Note also that since the sub-entries have the same name, +the <span +class="ecss-1000">sort</span><a + id="dx1-18004"></a> key is required. +</p><!--l. 1847--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the +parent entry, so the <span +class="ecss-1000">plural</span><a + id="dx1-18005"></a> key was not required for the child entries. However, +if the sub-entries have different plurals, they will need to be specified. For +example: + + + +</p> + <div class="verbatim" id="verbatim-48"> \newglossaryentry{bravo}{name={bravo}, -description={\nopostdesc}} - -\newglossaryentry{bravocry}{description={1) cry of approval (pl.\ bravos)}, -sort={1}, -plural={bravos}, -parent=bravo} - -\newglossaryentry{bravoruffian}{description={2) hired ruffian or -killer (pl.\ bravoes)}, -sort={2}, -plural={bravoes}, -parent=bravo} -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00032300000000000000"></A> -<A NAME="sec:loadglsentries"></A> -<BR> -Loading Entries From a File -</H3> - -<P> -You can store all your glossary entry definitions in another -file and use: - -<P> -<TT>\loadglsentries[</TT><EM>type</EM><TT>]{</TT><EM>filename</EM><TT>}</TT> -<P> -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="6382"></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> + <br />description={\nopostdesc}} + <br />\newglossaryentry{bravocry}{description={1) cry of approval (pl.\ bravos)}, + <br />sort={1}, + <br />plural={bravos}, + <br />parent=bravo} + <br />\newglossaryentry{bravoruffian}{description={2) hired ruffian or + <br />killer (pl.\ bravoes)}, + <br />sort={2}, + <br />plural={bravoes}, + <br />parent=bravo} +</div> +<!--l. 1865--><p class="nopar" > +</p><!--l. 1868--><p class="noindent" > +</p> +<!--l. 1868--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.2.3 </span> <a + id="x1-190002.2.3"></a>Loading Entries From a File</h5> +<!--l. 1871--><p class="noindent" >You can store all your glossary entry definitions in another file and use: +</p><!--l. 1873--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\loadglsentries</span><span +class="ectt-0900"> </span></span><a + id="dx1-19001"></a><span +class="ectt-1000">\loadglsentries[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">filename</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1875--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">filename</span><span +class="cmsy-10">⟩ </span>is the name of the file containing all the <span +class="ectt-1000">\newglossaryentry</span> +commands. The optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩ </span>is the name of the glossary to which those +entries should belong, for those entries where the <span +class="ecss-1000">type</span><a + id="dx1-19002"></a> key has been omitted (or, more +specifically, for those entries whose type has been specified by <span +class="ectt-1000">\glsdefaulttype</span>, which +is what <span +class="ectt-1000">\newglossaryentry </span>uses by default). For example, suppose I have a file called +<span +class="ectt-1000">myentries.tex </span>which contains: + + + +</p> + <div class="verbatim" id="verbatim-49"> \newglossaryentry{perl}{type=main, -name={Perl}, -description={A scripting language}} - -\newglossaryentry{tex}{name={\TeX}, -description={A typesetting language},sort={TeX}} - -\newglossaryentry{html}{type=\glsdefaulttype, -name={html}, -description={A mark up language}} -</PRE> -and suppose in my document preamble I use the command: -<PRE> + <br />name={Perl}, + <br />description={A scripting language}} + <br />\newglossaryentry{tex}{name={\TeX}, + <br />description={A typesetting language},sort={TeX}} + <br />\newglossaryentry{html}{type=\glsdefaulttype, + <br />name={html}, + <br />description={A mark up language}} +</div> +<!--l. 1895--><p class="nopar" > and suppose in my document preamble I use the command: + + + +</p> + <div class="verbatim" id="verbatim-50"> \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> +</div> +<!--l. 1899--><p class="nopar" > then this will add the entries <span +class="ectt-1000">tex </span>and <span +class="ectt-1000">html </span>to the glossary whose type is given by +<span +class="ectt-1000">languages</span>, but the entry <span +class="ectt-1000">perl </span>will be added to the main glossary, since it explicitly +sets the type to <span +class="ectt-1000">main</span>. +</p><!--l. 1905--><p class="indent" > <span +class="ecbx-1000">Note: </span>if you use <span +class="ectt-1000">\newacronym </span>(see <a +href="#x1-340002.10">§2.10 </a><a +href="#x1-340002.10">Acronyms<!--tex4ht:ref: sec:acronyms --></a>) the type is set as +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">type=\acronymtype</span></span></span> unless you explicitly override it. For example, if my file +<span +class="ectt-1000">myacronyms.tex </span>contains: + + + +</p> + <div class="verbatim" id="verbatim-51"> +\newacronym{aca}{aca}{a contrived acronym} +</div> +<!--l. 1911--><p class="nopar" > then (supposing I have defined a new glossary type called <span +class="ectt-1000">altacronym</span>) + + + +</p> + <div class="verbatim" id="verbatim-52"> \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="6390"></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="6399"></A> is not specified.<A NAME="tex2html22" - HREF="#foot4317"><SUP>6</SUP></A> 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> +</div> +<!--l. 1916--><p class="nopar" > will add <span +class="ectt-1000">aca </span>to the glossary type <span +class="ectt-1000">acronym</span>, if the package option <span +class="ecss-1000">acronym</span><a + id="dx1-19003"></a> has been specified, +or will add <span +class="ectt-1000">aca </span>to the glossary type <span +class="ectt-1000">altacronym</span>, if the package option <span +class="ecss-1000">acronym</span><a + id="dx1-19004"></a> is not +specified.<span class="footnote-mark"><a +href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a + id="x1-19005f5"></a> +In this instance, it is better to change <span +class="ectt-1000">myacronyms.tex </span>to: + + + +</p> + <div class="verbatim" id="verbatim-53"> +\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} +</div> +<!--l. 1926--><p class="nopar" > and now + + + +</p> + <div class="verbatim" id="verbatim-54"> \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="6417"></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 +</div> +<!--l. 1930--><p class="nopar" > will add <span +class="ectt-1000">aca </span>to the glossary type <span +class="ectt-1000">altacronym</span>, regardless of whether or not the package +option <span +class="ecss-1000">acronym</span><a + id="dx1-19007"></a> is used. +</p><!--l. 1935--><p class="indent" > Note that only those entries that have been used in the text will appear in the +relevant glossaries. Note also that <span +class="ectt-1000">\loadglsentries </span>may only be used in the preamble. -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00033000000000000000"></A> -<A NAME="sec:numberlists"></A> -<BR> -Number lists -</H2> - -<P> -Each entry in the glossary has an associated <I>number list</I><A NAME="6424"></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="6431"></A> package option, or an alternative counter -can be set as the default using the <TT>counter</TT><A NAME="6440"></A> package option. -The number list is also referred to as the location -list<A NAME="4322"></A>. - -<P> -Both <TT>makeindex</TT><A NAME="6444"></A> and <TT>xindy</TT><A NAME="6447"></A> concatenate a -sequence of 3 or more consecutive pages into a range. With -<TT>xindy</TT><A NAME="6450"></A> you can vary the minimum sequence length using -<TT>\GlsSetXdyMinRangeLength</TT><A NAME="6453"></A><TT>{</TT><EM>n</EM><TT>}</TT> where <I>n</I> is either -an integer or the keyword <TT>none</TT> which indicates that there -should be no range formation. - -<P> -Note that <TT>\GlsSetXdyMinRangeLength</TT> must be used before -<TT>\makeglossaries</TT><A NAME="6456"></A> and has no effect if <TT>\noist</TT><A NAME="6459"></A> is used. - -<P> -With both <TT>makeindex</TT><A NAME="6462"></A> and <TT>xindy</TT><A NAME="6465"></A>, you can replace -the separator and the closing number in the range using: - -<P> -<TT>\glsSetSuffixF{</TT><EM>suffix</EM><TT>}</TT> -<P> - -<P> -<TT>\glsSetSuffixFF{</TT><EM>suffix</EM><TT>}</TT> -<P> -where the former command specifies the suffix to use for a 2 page -list and the latter specifies the suffix to use for longer lists. -For example: -<PRE> +</p><!--l. 1940--><p class="noindent" > +</p> +<!--l. 1940--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.3 </span> <a + id="x1-200002.3"></a>Number lists</h4> +<!--l. 1943--><p class="noindent" >Each entry in the glossary has an associated <span +class="ecti-1000">number list</span><a + id="dx1-20001"></a>. By default, these numbers +refer to the pages on which that entry has been used (using any of the commands +described in <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a +href="#x1-240002.5">§2.5 </a><a +href="#x1-240002.5">Adding an Entry to the Glossary +Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>). The number list can be suppressed using the <span +class="ecss-1000">nonumberlist</span><a + id="dx1-20002"></a> +package option, or an alternative counter can be set as the default using the +<span +class="ecss-1000">counter</span><a + id="dx1-20003"></a> package option. The number list is also referred to as the location +list<a + id="dx1-20004"></a>. +</p><!--l. 1953--><p class="indent" > Both <span +class="ectt-1000">makeindex</span><a + id="dx1-20005"></a> and <span +class="ectt-1000">xindy</span><a + id="dx1-20006"></a> concatenate a sequence of 3 or more consecutive pages +into a range. With <span +class="ectt-1000">xindy</span><a + id="dx1-20007"></a> you can vary the minimum sequence length using +<span +class="ectt-1000">\GlsSetXdyMinRangeLength</span><a + id="dx1-20008"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">n</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">n</span><span +class="cmsy-10">⟩ </span>is either an integer or the keyword <span +class="ectt-1000">none</span> +which indicates that there should be no range formation. +</p><!--l. 1960--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsSetXdyMinRangeLength </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-20009"></a> and +has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-20010"></a> is used. </div> +</p><!--l. 1963--><p class="noindent" > +</p><!--l. 1965--><p class="indent" > With both <span +class="ectt-1000">makeindex</span><a + id="dx1-20011"></a> and <span +class="ectt-1000">xindy</span><a + id="dx1-20012"></a>, you can replace the separator and the closing +number in the range using: +</p><!--l. 1967--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsSetSuffixF</span><span +class="ectt-0900"> </span></span><a + id="dx1-20013"></a><span +class="ectt-1000">\glsSetSuffixF{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">suffix</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1969--><p class="noindent" > +</p><!--l. 1970--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsSetSuffixFF</span><span +class="ectt-0900"> </span></span><a + id="dx1-20014"></a><span +class="ectt-1000">\glsSetSuffixFF{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">suffix</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 1972--><p class="noindent" > +where the former command specifies the suffix to use for a 2 page list and the latter +specifies the suffix to use for longer lists. For example: + + + +</p> + <div class="verbatim" id="verbatim-55"> \glsSetSuffixF{f.} -\glsSetSuffixFF{ff.} -</PRE> -Note that if you use <TT>xindy</TT><A NAME="6468"></A>, you will also need to -set the minimum range length to 1 if you want to change these -suffixes: -<PRE> + <br />\glsSetSuffixFF{ff.} +</div> +<!--l. 1979--><p class="nopar" > Note that if you use <span +class="ectt-1000">xindy</span><a + id="dx1-20015"></a>, you will also need to set the minimum range length to 1 if +you want to change these suffixes: + + + +</p> + <div class="verbatim" id="verbatim-56"> \GlsSetXdyMinRangeLength{1} -</PRE> -Note that if you use the <TT>hyperref</TT><A NAME="6471"></A> package, you will need -to use <TT>\nohyperpage</TT><A NAME="6474"></A> in the suffix to ensure that the hyperlinks -work correctly. For example: -<PRE> +</div> +<!--l. 1985--><p class="nopar" > Note that if you use the <span +class="ecss-1000">hyperref</span><a + id="dx1-20016"></a> package, you will need to use <span +class="ectt-1000">\nohyperpage</span><a + id="dx1-20017"></a> in the +suffix to ensure that the hyperlinks work correctly. For example: + + + +</p> + <div class="verbatim" id="verbatim-57"> \glsSetSuffixF{\nohyperpage{f.}} -\glsSetSuffixFF{\nohyperpage{ff.}} -</PRE> - -<P> -Note that <TT>\glsSetSuffixF</TT> and <TT>\glsSetSuffixFF</TT> must be used -before <TT>\makeglossaries</TT><A NAME="6477"></A> and have no effect if <TT>\noist</TT><A NAME="6480"></A> is -used. - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00034000000000000000"></A> -<A NAME="sec:glslink"></A> -<BR> -Links to Glossary Entries -</H2> - -<P> -Once you have defined a glossary entry using -<TT>\newglossaryentry</TT><A NAME="6486"></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="6489"></A> (even if there are no hyperlinks). The commands -in this section also add a line to an external file that is used -by <TT>makeindex</TT><A NAME="6491"></A> or <TT>xindy</TT><A NAME="6494"></A> to generate the relevant -entry in the glossary. This information includes an -associated location that is added to the number list<A NAME="6496"></A> for that -entry. By default, the location refers to the page number. For -further information on number lists, see <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>. - -<P> -It is strongly recommended that you don't use the commands -defined in this section in the arguments of sectioning or caption -commands. - -<P> -The above warning is particularly important if you are using the -<TT>glossaries</TT> package in conjunction with the <TT>hyperref</TT><A NAME="6499"></A> package. -Instead, use one of the commands listed in -<A HREF="glossaries-manual.html#sec:glsnolink">Using Glossary Terms -Without Links</A> (such as <TT>\glsentrytext</TT>) or provide an alternative via -the optional argument to the sectioning/caption command. + <br />\glsSetSuffixFF{\nohyperpage{ff.}} +</div> +<!--l. 1992--><p class="nopar" > +</p><!--l. 1994--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\glsSetSuffixF </span>and <span +class="ectt-1000">\glsSetSuffixFF </span>must be used before +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-20018"></a> and have no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-20019"></a> is used. </div> +</p><!--l. 1998--><p class="noindent" > +</p><!--l. 2001--><p class="noindent" > +</p> +<!--l. 2001--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.4 </span> <a + id="x1-210002.4"></a>Links to Glossary Entries</h4> +<!--l. 2004--><p class="noindent" >Once you have defined a glossary entry using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-21001"></a>, you can refer to that +entry in the document using one of the commands listed in this section. The text which +appears at that point in the document when using one of these commands is referred to +as the <span +class="ecti-1000">link text</span><a + id="dx1-21002"></a> (even if there are no hyperlinks). The commands in this section also add +a line to an external file that is used by <span +class="ectt-1000">makeindex</span><a + id="dx1-21003"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-21004"></a> to generate the relevant +entry in the glossary. This information includes an associated location that +is added to the number list<a + id="dx1-21005"></a> for that entry. By default, the location refers to +the page number. For further information on number lists, see <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number +lists<!--tex4ht:ref: sec:numberlists --></a>. +</p><!--l. 2016--><p class="indent" > <div class="important" title="Important Note"> It is strongly recommended that you don’t use the commands defined in this section +in the arguments of sectioning or caption commands. </div> +</p><!--l. 2020--><p class="noindent" > +</p><!--l. 2022--><p class="indent" > The above warning is particularly important if you are using the <span +class="ecss-1000">glossaries </span>package +in conjunction with the <span +class="ecss-1000">hyperref</span><a + id="dx1-21006"></a> package. Instead, use one of the commands listed in +<a +href="#x1-260002.7">§2.7 </a><a +href="#x1-260002.7">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> (such as <span +class="ectt-1000">\glsentrytext</span>) or provide an +alternative via the optional argument to the sectioning/caption command. Examples: -<PRE> -\section{An overview of \glsentrytext{perl}} -\section[An overview of Perl]{An overview of \gls{perl}} -</PRE> - -<P> -The way the link text<A NAME="6501"></A> is displayed -depends on - -<P> -<TT>\glstextformat{</TT><EM>text</EM><TT>}</TT> -<P> -For example, to make all link text<A NAME="6502"></A> appear in a sans-serif -font, do: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-58"> +\section{An overview of \glsentrytext{perl}} + <br />\section[An overview of Perl]{An overview of \gls{perl}} +</div> +<!--l. 2031--><p class="nopar" > +</p><!--l. 2033--><p class="indent" > The way the link text<a + id="dx1-21007"></a> is displayed depends on +</p><!--l. 2034--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glstextformat</span><span +class="ectt-0900"> </span></span><a + id="dx1-21008"></a><span +class="ectt-1000">\glstextformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2036--><p class="noindent" > +For example, to make all link text<a + id="dx1-21009"></a> appear in a sans-serif font, do: + + + +</p> + <div class="verbatim" id="verbatim-59"> \renewcommand*{\glstextformat}[1]{\textsf{#1}} -</PRE> - -<P> -Each entry has an associated conditional referred to as the - first use flag<A NAME="6503"></A>. This determines whether <TT>\gls</TT><A NAME="6505"></A>, -<TT>\glspl</TT><A NAME="6508"></A> (and their uppercase variants) should use the -value of the <TT>first</TT><A NAME="6511"></A> or <TT>text</TT><A NAME="6514"></A> keys. Note that an -entry can be used without affecting the first use flag<A NAME="6516"></A> (for example, -when used with <TT>\glslink</TT>). See <A HREF="glossaries-manual.html#sec:glsunset">later</A> for -commands that unset or reset this conditional. - -<P> -The command: - -<P> -<TT>\glslink[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> -<P> -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. (Note that this command doesn't affect the first use flag<A NAME="6517"></A>: -use <TT>\glsdisp</TT><A NAME="6519"></A> instead.) 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="6522"></A></STRONG></DT> -<DD>This specifies how to format the -associated location number for this entry in the glossary. This -value is equivalent to the <TT>makeindex</TT><A NAME="6525"></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 number range. Again as with <TT>\index</TT>, -the command should be the name of a command which takes an argument -(which will be the associated location). Be careful not to use a -declaration (such as <TT>bfseries</TT>) instead of a text block command -(such as <TT>textbf</TT>) as the effect is not guaranteed to be -localised. If you want to apply more than one style to a given entry -(e.g. <B>bold</B> and <I>italic</I>) you will need to create a -command that applies both formats, e.g. -<PRE> -\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}} -</PRE> -and use that command. - -<P> -In this document, the standard formats refer to the standard text -block commands such as <TT>\textbf</TT><A NAME="6528"></A> or <TT>\emph</TT><A NAME="6531"></A> or any of the -commands listed in <A HREF="glossaries-manual.html#tab:hyperxx">table </A><A HREF="glossaries-manual.html#tab:hyperxx">3</A>. - -<P> -If you use <TT>xindy</TT><A NAME="6537"></A> instead of <TT>makeindex</TT><A NAME="6540"></A>, you -must specify any non-standard formats that you want to use -with the <TT>format</TT><A NAME="6543"></A> key using -<TT>\GlsAddXdyAttribute</TT><A NAME="6546"></A><TT>{</TT><EM>name</EM><TT>}</TT>. So if you use -<TT>xindy</TT><A NAME="6549"></A> with the above example, you would need to add: -<PRE> -\GlsAddXdyAttribute{textbfem} -</PRE> - -<P> -Note that unlike <TT>\index</TT>, you can't have -anything following the command name, such as an asterisk or -arguments. If you want to cross-reference another entry, either -use the <TT>see</TT><A NAME="6552"></A> key when you define the entry or use -<TT>\glssee</TT><A NAME="6555"></A> (described <A HREF="glossaries-manual.html#sec:crossref">later</A>). - -<P> -If you are using hyperlinks and you want to change the font of the -hyperlinked location, don't use <TT>\hyperpage</TT><A NAME="6558"></A> (provided by the -<TT>hyperref</TT><A NAME="6561"></A> package) as the locations may not refer to a page -number. Instead, the <TT>glossaries</TT> package provides number -formats listed in <A HREF="glossaries-manual.html#tab:hyperxx">table </A><A HREF="glossaries-manual.html#tab:hyperxx">3</A>. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:hyperxx"></A> -<DIV ALIGN="CENTER"><A NAME="1705"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 3:</STRONG> -Predefined Hyperlinked Location Formats</CAPTION> -<TR><TD ALIGN="LEFT"><TT>hyperrm</TT><A NAME="6568"></A></TD> -<TD ALIGN="LEFT">serif hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypersf</TT><A NAME="6571"></A></TD> -<TD ALIGN="LEFT">sans-serif hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypertt</TT><A NAME="6574"></A></TD> -<TD ALIGN="LEFT">monospaced hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperbf</TT><A NAME="6577"></A></TD> -<TD ALIGN="LEFT">bold hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypermd</TT><A NAME="6580"></A></TD> -<TD ALIGN="LEFT">medium weight hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperit</TT><A NAME="6583"></A></TD> -<TD ALIGN="LEFT">italic hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypersl</TT><A NAME="6586"></A></TD> -<TD ALIGN="LEFT">slanted hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperup</TT><A NAME="6589"></A></TD> -<TD ALIGN="LEFT">upright hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypersc</TT><A NAME="6592"></A></TD> -<TD ALIGN="LEFT">small caps hyperlink</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperemph</TT><A NAME="6595"></A></TD> -<TD ALIGN="LEFT">emphasized hyperlink</TD> -</TR> -</TABLE> -</DIV> -<P> -<DIV ALIGN="CENTER"></DIV> -</DIV> -<BR> - -<P> -Note that if the <TT>\hyperlink</TT><A NAME="6598"></A> command hasn't been defined, -the <TT>hyper</TT><I>xx</I> formats are equivalent to the -analogous <TT>text</TT><I>xx</I> font commands (and <TT>hyperemph</TT> -is equivalent to <TT>emph</TT>). If you want to -make a new format, you will need to define a command which takes -one argument and use that; for example, if you want the location -number to be in a bold sans-serif font, you can define a -command called, say, <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="6601"></A> -key. -Remember that if you use <TT>xindy</TT><A NAME="6604"></A>, you will need to add -this to the list of location attributes: -<PRE> -\GlsAddXdyAttribute{hyperbsf} -</PRE> - -<P> -</DD> -<DT><STRONG><TT>counter</TT><A NAME="6607"></A></STRONG></DT> -<DD>This specifies which counter -to use for this location. This overrides the default counter -used by this entry. (See also -<A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.) - -<P> -</DD> -<DT><STRONG><TT>hyper</TT><A NAME="6610"></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 -effect if <TT>\hyperlink</TT> has not been defined.) The default -value is <TT>hyper=true</TT>. - -<P> -</DD> -</DL> -There is also a starred version: - -<P> -<TT>\glslink*[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> -<P> -which is equivalent to <TT>\glslink</TT>, except it sets -<TT>hyper=false</TT>. Similarly, all the following commands -described in this section also have a starred version that disables -the hyperlink. - -<P> -The command: - -<P> -<TT>\gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is the same as <TT>\glslink</TT>, except that the link text<A NAME="6612"></A> -is determined from the values of the <TT>text</TT><A NAME="6614"></A> and -<TT>first</TT><A NAME="6617"></A> keys supplied when the entry was defined using -<TT>\newglossaryentry</TT><A NAME="6620"></A>. If the entry has been marked as having -been used<A NAME="6622"></A>, the value of the <TT>text</TT><A NAME="6624"></A> key will be used, otherwise -the value of the <TT>first</TT><A NAME="6627"></A> key will be used. -On completion, <TT>\gls</TT> will mark the entry's first use flag<A NAME="6629"></A> as -used. - -<P> -There are two uppercase variants: - -<P> -<TT>\Gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> +</div> +<!--l. 2041--><p class="nopar" > +</p><!--l. 2043--><p class="indent" > Each entry has an associated conditional referred to as the first use flag<a + id="dx1-21010"></a>. This +determines whether <span +class="ectt-1000">\gls</span><a + id="dx1-21011"></a>, <span +class="ectt-1000">\glspl</span><a + id="dx1-21012"></a> (and their uppercase variants) should use +the value of the <span +class="ecss-1000">first</span><a + id="dx1-21013"></a> or <span +class="ecss-1000">text</span><a + id="dx1-21014"></a> keys. Note that an entry can be used without +affecting the first use flag<a + id="dx1-21015"></a> (for example, when used with <span +class="ectt-1000">\glslink</span>). See <a +href="#x1-370002.11">§2.11 +</a><a +href="#x1-370002.11">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for commands that unset or reset this +conditional. +</p><!--l. 2051--><p class="indent" > The command: +</p><!--l. 2052--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslink</span><span +class="ectt-0900"> </span></span><a + id="dx1-21016"></a><span +class="ectt-1000">\glslink[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2054--><p class="noindent" > +will place <span +class="ectt-1000">\glstextformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>in the document at that point and add a line into +the associated glossary file for the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. If hyperlinks are +supported, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩ </span>will be a hyperlink to the relevant line in the glossary. (Note that this +command doesn’t affect the first use flag<a + id="dx1-21017"></a>: use <span +class="ectt-1000">\glsdisp</span><a + id="dx1-21018"></a> instead.) The optional +argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩ </span>must be a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>list which can take any of the following +keys: +</p><!--l. 2064--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">format</span><a + id="dx1-21019"></a> </dt><dd +class="description">This specifies how to format the associated location number for this entry in + the glossary. This value is equivalent to the <span +class="ectt-1000">makeindex</span><a + id="dx1-21020"></a> encap value, + and (as with <span +class="ectt-1000">\index</span>) the value needs to be the name of a command + <span +class="ecti-1000">without </span>the initial backslash. As with <span +class="ectt-1000">\index</span>, the characters <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">(</span></span></span> and <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">)</span></span></span> can + also be used to specify the beginning and ending of a number range. + Again as with <span +class="ectt-1000">\index</span>, the command should be the name of a command + which takes an argument (which will be the associated location). Be + careful not to use a declaration (such as <span +class="ectt-1000">bfseries</span>) instead of a text block + command (such as <span +class="ectt-1000">textbf</span>) as the effect is not guaranteed to be localised. If + you want to apply more than one style to a given entry (e.g. <span +class="ecbx-1000">bold </span>and + <span +class="ecti-1000">italic</span>) you will need to create a command that applies both formats, + e.g.  + + + + <div class="verbatim" id="verbatim-60"> + \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}} +</div> + <!--l. 2081--><p class="nopar" > and use that command. + </p><!--l. 2084--><p class="noindent" >In this document, the standard formats refer to the standard text block + commands such as <span +class="ectt-1000">\textbf</span><a + id="dx1-21021"></a> or <span +class="ectt-1000">\emph</span><a + id="dx1-21022"></a> or any of the commands listed in + <a +href="#x1-210324">table 4</a>. + </p><!--l. 2088--><p class="noindent" ><div class="important" title="Important Note"> If you use <span +class="ectt-1000">xindy</span><a + id="dx1-21023"></a> instead of <span +class="ectt-1000">makeindex</span><a + id="dx1-21024"></a>, you must specify any non-standard formats + that you want to use with the <span +class="ecss-1000">format</span><a + id="dx1-21025"></a> key using <span +class="ectt-1000">\GlsAddXdyAttribute</span><a + id="dx1-21026"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. + So if you use <span +class="ectt-1000">xindy</span><a + id="dx1-21027"></a> with the above example, you would need to add: + + + +</p> + <div class="verbatim" id="verbatim-61"> + \GlsAddXdyAttribute{textbfem} +</div> + <!--l. 2096--><p class="nopar" > </div> + </p><!--l. 2097--><p class="noindent" > + </p><!--l. 2099--><p class="noindent" >Note that unlike <span +class="ectt-1000">\index</span>, you can’t have anything following the command name, + such as an asterisk or arguments. If you want to cross-reference another entry, + either use the <span +class="ecss-1000">see</span><a + id="dx1-21028"></a> key when you define the entry or use <span +class="ectt-1000">\glssee</span><a + id="dx1-21029"></a> (described in <a +href="#x1-250002.6">§2.6 + </a><a +href="#x1-250002.6">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>). + </p><!--l. 2106--><p class="noindent" >If you are using hyperlinks and you want to change the font of the hyperlinked + location, don’t use <span +class="ectt-1000">\hyperpage</span><a + id="dx1-21030"></a> (provided by the <span +class="ecss-1000">hyperref</span><a + id="dx1-21031"></a> package) as the + locations may not refer to a page number. Instead, the <span +class="ecss-1000">glossaries </span>package provides + number formats listed in <a +href="#x1-210324">table 4</a>. +</p> + <div class="table"> + <!--l. 2112--><p class="noindent" ><a + id="x1-210324"></a></p><hr class="float" /><div class="float" +> + <div class="caption" +><span class="id">Table 4: </span><span +class="content">Predefined Hyperlinked Location Formats</span></div><!--tex4ht:label?: x1-210324 --> +<div class="tabular"> <table id="TBL-5" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-5-1g"><col +id="TBL-5-1" /><col +id="TBL-5-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-5-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-1" +class="td11"><span +class="ectt-1000">hyperrm</span><a + id="dx1-21033"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-2" +class="td11">serif hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-1" +class="td11"><span +class="ectt-1000">hypersf</span><a + id="dx1-21034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2" +class="td11">sans-serif hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-1" +class="td11"><span +class="ectt-1000">hypertt</span><a + id="dx1-21035"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2" +class="td11">monospaced hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-1" +class="td11"><span +class="ectt-1000">hyperbf</span><a + id="dx1-21036"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2" +class="td11">bold hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-1" +class="td11"><span +class="ectt-1000">hypermd</span><a + id="dx1-21037"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2" +class="td11">medium weight hyperlink</td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-1" +class="td11"><span +class="ectt-1000">hyperit</span><a + id="dx1-21038"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2" +class="td11">italic hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-1" +class="td11"><span +class="ectt-1000">hypersl</span><a + id="dx1-21039"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2" +class="td11">slanted hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-1" +class="td11"><span +class="ectt-1000">hyperup</span><a + id="dx1-21040"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2" +class="td11">upright hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-1" +class="td11"><span +class="ectt-1000">hypersc</span><a + id="dx1-21041"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2" +class="td11">small caps hyperlink </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-5-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-1" +class="td11"><span +class="ectt-1000">hyperemph</span><a + id="dx1-21042"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2" +class="td11">emphasized hyperlink </td></tr></table> +</div> + </div><hr class="endfloat" /> + </div> + <!--l. 2132--><p class="noindent" >Note that if the <span +class="ectt-1000">\hyperlink</span><a + id="dx1-21043"></a> command hasn’t been defined, the <span +class="ectt-1000">hyper</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">xx</span><span +class="cmsy-10">⟩</span> + formats are equivalent to the analogous <span +class="ectt-1000">text</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">xx</span><span +class="cmsy-10">⟩ </span>font commands (and <span +class="ectt-1000">hyperemph</span> + is equivalent to <span +class="ectt-1000">emph</span>). If you want to make a new format, you will need to define + a command which takes one argument and use that. For example, if you want the + location number to be in a bold sans-serif font, you can define a command called, + say, <span +class="ectt-1000">\hyperbsf</span>: + + + +</p> + <div class="verbatim" id="verbatim-62"> + \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} +</div> + <!--l. 2142--><p class="nopar" > and then use <span +class="ectt-1000">hyperbsf </span>as the value for the <span +class="ecss-1000">format</span><a + id="dx1-21044"></a> key. Remember that if you use + <span +class="ectt-1000">xindy</span><a + id="dx1-21045"></a>, you will need to add this to the list of location attributes: + + + +</p> + <div class="verbatim" id="verbatim-63"> + \GlsAddXdyAttribute{hyperbsf} +</div> + <!--l. 2149--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">counter</span><a + id="dx1-21046"></a> </dt><dd +class="description">This specifies which counter to use for this location. This overrides the default + counter used by this entry. (See also <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) + </dd><dt class="description"> +<span +class="ecsx-1000">hyper</span><a + id="dx1-21047"></a> </dt><dd +class="description">This is a boolean key which can be used to enable/disable the hyperlink to + the relevant entry in the glossary. (Note that setting <span +class="ectt-1000">hyper=true </span>will + have no effect if <span +class="ectt-1000">\hyperlink </span>has not been defined.) The default value is + <span +class="ectt-1000">hyper=true</span>. + </dd></dl> +<!--l. 2162--><p class="noindent" >There is also a starred version: +</p><!--l. 2163--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslink*</span><span +class="ectt-0900"> </span></span><a + id="dx1-21048"></a><span +class="ectt-1000">\glslink*[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2165--><p class="noindent" > +which is equivalent to <span +class="ectt-1000">\glslink</span>, except it sets <span +class="ectt-1000">hyper=false</span>. Similarly, all the following +commands described in this section also have a starred version that disables the +hyperlink. +</p><!--l. 2171--><p class="indent" > The command: +</p><!--l. 2172--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\gls</span><span +class="ectt-0900"> </span></span><a + id="dx1-21049"></a><span +class="ectt-1000">\gls[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2174--><p class="noindent" > +is the same as <span +class="ectt-1000">\glslink</span>, except that the link text<a + id="dx1-21050"></a> is determined from the values of the +<span +class="ecss-1000">text</span><a + id="dx1-21051"></a> and <span +class="ecss-1000">first</span><a + id="dx1-21052"></a> keys supplied when the entry was defined using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-21053"></a>. If +the entry has been marked as having been used<a + id="dx1-21054"></a>, the value of the <span +class="ecss-1000">text</span><a + id="dx1-21055"></a> key will be used, +otherwise the value of the <span +class="ecss-1000">first</span><a + id="dx1-21056"></a> key will be used. On completion, <span +class="ectt-1000">\gls </span>will mark the +entry’s first use flag<a + id="dx1-21057"></a> as used. +</p><!--l. 2184--><p class="indent" > There are two uppercase variants: +</p><!--l. 2185--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Gls</span><span +class="ectt-0900"> </span></span><a + id="dx1-21058"></a><span +class="ectt-1000">\Gls[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2187--><p class="noindent" > and - -<P> -<TT>\GLS[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -which make the first letter of the link text or all the link text -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, 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="6631"></A>. As with <TT>\glslink</TT>, these commands also -have a starred version that disable the hyperlink. - -<P> -There are also analogous plural forms: - -<P> -<TT>\glspl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glspl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSpl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -These determine the link text from the <TT>plural</TT><A NAME="6634"></A> and -<TT>firstplural</TT><A NAME="6637"></A> keys supplied when the entry was first -defined. As before, these commands also have -a starred version that disable the hyperlink. - -<P> -Note that <TT>\glslink</TT> doesn't use or affect the first use flag<A NAME="6639"></A>, -nor does it use <TT>\glsdisplay</TT><A NAME="6641"></A> or <TT>\glsdisplayfirst</TT><A NAME="6644"></A> (see -<A HREF="glossaries-manual.html#sec:glsdisplay">later</A>). -Instead, you can use: - -<P> -<TT>\glsdisp[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>link text</EM><TT>}</TT> -<P> -This behaves in the same way as <TT>\gls</TT>, except that it uses -<I>link text</I> instead of the value of the <TT>first</TT><A NAME="6647"></A> -or <TT>text</TT><A NAME="6650"></A> key. (Note that this command always sets -<I>insert</I> to nothing.) This command affects the first use flag<A NAME="6652"></A>, -and uses <TT>\glsdisplay</TT><A NAME="6654"></A> or <TT>\glsdisplayfirst</TT><A NAME="6657"></A>. - -<P> -The command: - -<P> -<TT>\glstext[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\gls</TT><A NAME="6660"></A> except that it always uses the value -of the <TT>text</TT><A NAME="6663"></A> key and does not affect the -first use flag<A NAME="6665"></A>. -Unlike <TT>\gls</TT>, the inserted text <I>insert</I> -is always appended to the link text since <TT>\glstext</TT> doesn't -use <TT>\glsdisplay</TT><A NAME="6667"></A> or <TT>\glsdisplayfirst</TT><A NAME="6670"></A>. (The same is -true for all the following commands described in this section.) - -<P> -There are also analogous commands: - -<P> -<TT>\Glstext[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLStext[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glsfirst[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6673"></A> except that it always uses the value -of the <TT>first</TT><A NAME="6676"></A> key. Again, <I>insert</I> is always appended -to the end of the link text and does not affect the -first use flag<A NAME="6678"></A>. - -<P> -There are also analogous commands: - -<P> -<TT>\Glsfirst[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSfirst[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glsplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6680"></A> except that it always uses the value -of the <TT>plural</TT><A NAME="6683"></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: - -<P> -<TT>\Glsplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable +</p><!--l. 2189--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLS</span><span +class="ectt-0900"> </span></span><a + id="dx1-21059"></a><span +class="ectt-1000">\GLS[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2191--><p class="noindent" > +which make the first letter of the link text or all the link text uppercase, respectively. +</p><!--l. 2195--><p class="indent" > The final optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span>, allows you to insert some additional +text into the link text. By default, this will append <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>at the end of the +link text, but this can be changed (see <a +href="#x1-220002.4.1">§2.4.1 </a><a +href="#x1-220002.4.1">Changing the format of the link +text<!--tex4ht:ref: sec:glsdisplay --></a>). + + + +</p><!--l. 2201--><p class="indent" > The first optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩ </span>is the same as the optional argument to +<span +class="ectt-1000">\glslink</span><a + id="dx1-21060"></a>. As with <span +class="ectt-1000">\glslink</span>, these commands also have a starred version that disable the hyperlink. - -<P> -The command: - -<P> -<TT>\glsfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6686"></A> except that it always uses the value -of the <TT>firstplural</TT><A NAME="6689"></A> key. Again, <I>insert</I> is always -appended to the end of the link text and does not mark the entry as +</p><!--l. 2205--><p class="indent" > There are also analogous plural forms: +</p><!--l. 2206--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glspl</span><span +class="ectt-0900"> </span></span><a + id="dx1-21061"></a><span +class="ectt-1000">\glspl[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2208--><p class="noindent" > +</p><!--l. 2209--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glspl</span><span +class="ectt-0900"> </span></span><a + id="dx1-21062"></a><span +class="ectt-1000">\Glspl[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2211--><p class="noindent" > +</p><!--l. 2212--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSpl</span><span +class="ectt-0900"> </span></span><a + id="dx1-21063"></a><span +class="ectt-1000">\GLSpl[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2214--><p class="noindent" > +These determine the link text from the <span +class="ecss-1000">plural</span><a + id="dx1-21064"></a> and <span +class="ecss-1000">firstplural</span><a + id="dx1-21065"></a> keys supplied when the +entry was first defined. As before, these commands also have a starred version that +disable the hyperlink. +</p><!--l. 2220--><p class="indent" > Note that <span +class="ectt-1000">\glslink </span>doesn’t use or affect the first use flag<a + id="dx1-21066"></a>, nor does it use +<span +class="ectt-1000">\glsdisplay</span><a + id="dx1-21067"></a> or <span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-21068"></a> (see <a +href="#x1-220002.4.1">§2.4.1 </a><a +href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). +Instead, you can use: +</p><!--l. 2223--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsdisp</span><span +class="ectt-0900"> </span></span><a + id="dx1-21069"></a><span +class="ectt-1000">\glsdisp[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">link text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2225--><p class="noindent" > +This behaves in the same way as <span +class="ectt-1000">\gls</span>, except that it uses <span +class="cmsy-10">⟨</span><span +class="ecti-1000">link text</span><span +class="cmsy-10">⟩ </span>instead of the +value of the <span +class="ecss-1000">first</span><a + id="dx1-21070"></a> or <span +class="ecss-1000">text</span><a + id="dx1-21071"></a> key. (Note that this command always sets <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>to +nothing.) This command affects the first use flag<a + id="dx1-21072"></a>, and uses <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-21073"></a> or +<span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-21074"></a>. +</p><!--l. 2232--><p class="indent" > The command: +</p><!--l. 2233--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glstext</span><span +class="ectt-0900"> </span></span><a + id="dx1-21075"></a><span +class="ectt-1000">\glstext[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2235--><p class="noindent" > +is similar to <span +class="ectt-1000">\gls</span><a + id="dx1-21076"></a> except that it always uses the value of the <span +class="ecss-1000">text</span><a + id="dx1-21077"></a> key and +does not affect the first use flag<a + id="dx1-21078"></a>. Unlike <span +class="ectt-1000">\gls</span>, the inserted text <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is +always appended to the link text since <span +class="ectt-1000">\glstext </span>doesn’t use <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-21079"></a> or +<span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-21080"></a>. (The same is true for all the following commands described in this +section.) +</p><!--l. 2244--><p class="indent" > There are also analogous commands: +</p><!--l. 2245--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glstext</span><span +class="ectt-0900"> </span></span><a + id="dx1-21081"></a><span +class="ectt-1000">\Glstext[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2247--><p class="noindent" > +</p><!--l. 2248--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLStext</span><span +class="ectt-0900"> </span></span><a + id="dx1-21082"></a><span +class="ectt-1000">\GLStext[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2250--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2254--><p class="indent" > The command: +</p><!--l. 2255--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-21083"></a><span +class="ectt-1000">\glsfirst[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2257--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21084"></a> except that it always uses the value of the <span +class="ecss-1000">first</span><a + id="dx1-21085"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not affect the first use +flag<a + id="dx1-21086"></a>. +</p><!--l. 2263--><p class="indent" > There are also analogous commands: + + + +</p><!--l. 2264--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-21087"></a><span +class="ectt-1000">\Glsfirst[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2266--><p class="noindent" > +</p><!--l. 2267--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-21088"></a><span +class="ectt-1000">\GLSfirst[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2269--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2273--><p class="indent" > The command: +</p><!--l. 2274--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21089"></a><span +class="ectt-1000">\glsplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2276--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21090"></a> except that it always uses the value of the <span +class="ecss-1000">plural</span><a + id="dx1-21091"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. - -<P> -There are also analogous commands: - -<P> -<TT>\Glsfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glsname[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6692"></A> except that it always uses the value of the -<TT>name</TT><A NAME="6695"></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="6698"></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="6701"></A> key and protect fragile commands. - -<P> -There are also analogous commands: - -<P> -<TT>\Glsname[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSname[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glssymbol[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6704"></A> except that it always uses the value of the -<TT>symbol</TT><A NAME="6707"></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="6710"></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="6713"></A> key and protect fragile commands. - -<P> -There are also analogous commands: - -<P> -<TT>\Glssymbol[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSsymbol[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glsdesc[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6716"></A> except that it always uses the value -of the <TT>description</TT><A NAME="6719"></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="6722"></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="6725"></A> key and protect fragile commands. - -<P> -There are also analogous commands: - -<P> -<TT>\Glsdesc[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSdesc[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. - -<P> -The command: - -<P> -<TT>\glsuseri[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -is similar to <TT>\glstext</TT><A NAME="6728"></A> except that it always uses the value -of the <TT>user1</TT><A NAME="6731"></A> key. Again, <I>insert</I> is always -appended to the end of the link text and does not mark the entry as +</p><!--l. 2282--><p class="indent" > There are also analogous commands: +</p><!--l. 2283--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21092"></a><span +class="ectt-1000">\Glsplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2285--><p class="noindent" > +</p><!--l. 2286--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21093"></a><span +class="ectt-1000">\GLSplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2288--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2292--><p class="indent" > The command: +</p><!--l. 2293--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsfirstplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21094"></a><span +class="ectt-1000">\glsfirstplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2295--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21095"></a> except that it always uses the value of the <span +class="ecss-1000">firstplural</span><a + id="dx1-21096"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as having been used. - -<P> -There are also analogous commands: - -<P> -<TT>\Glsuseri[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuseri[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -As before, these commands also have a starred version that disable -the hyperlink. Similarly for the other user keys: - -<P> -<TT>\glsuserii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glsuserii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuserii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\glsuseriii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glsuseriii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuseriii[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\glsuseriv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glsuseriv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuseriv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\glsuserv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glsuserv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuserv[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\glsuservi[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\Glsuservi[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\GLSuservi[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00034100000000000000"></A> -<A NAME="sec:glsdisplay"></A> -<BR> -Changing the format of the link text -</H3> - -<P> -The format of the link text<A NAME="6736"></A> for <TT>\gls</TT><A NAME="6738"></A>, <TT>\glspl</TT><A NAME="6741"></A> -and their uppercase variants is governed by two commands: - -<P> -<TT>\glsdisplayfirst</TT> -<P> -which is used the -first time a glossary entry is used<A NAME="6743"></A> in the text and - -<P> -<TT>\glsdisplay</TT> -<P> -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="6745"></A>, <TT>plural</TT><A NAME="6748"></A>, -<TT>first</TT><A NAME="6751"></A> or <TT>firstplural</TT><A NAME="6754"></A> keys (set 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="6757"></A> or -<TT>descriptionplural</TT><A NAME="6760"></A> keys); the third -argument is the symbol associated with the term (as supplied by the -<TT>symbol</TT><A NAME="6763"></A> or <TT>symbolplural</TT><A NAME="6766"></A> keys) 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 -print the first argument immediately followed by the fourth argument. -The remaining arguments are ignored. - -<P> -If required, you can access the label for the given entry via -<TT>\glslabel</TT><A NAME="6769"></A>, so it is possible to use -this label in the definition of <TT>\glsdisplay</TT> or -<TT>\glsdisplayfirst</TT> to supply additional information using any of -the commands described in -<A HREF="glossaries-manual.html#sec:glsnolink">Using Glossary Terms -Without Links</A>, if required. - -<P> -Note that <TT>\glsdisplay</TT> and <TT>\glsdisplayfirst</TT> are not used -by <TT>\glslink</TT><A NAME="6772"></A>. If you want to supply your own link text, you -need to use <TT>\glsdisp</TT><A NAME="6775"></A> instead. - -<P> -For example, suppose you want a glossary of measurements and -units, you can use the <TT>symbol</TT><A NAME="6778"></A> key to store the unit: -<PRE> +</p><!--l. 2301--><p class="indent" > There are also analogous commands: +</p><!--l. 2302--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsfirstplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21097"></a><span +class="ectt-1000">\Glsfirstplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2304--><p class="noindent" > +</p><!--l. 2305--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSfirstplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-21098"></a><span +class="ectt-1000">\GLSfirstplural[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2307--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2311--><p class="indent" > The command: +</p><!--l. 2312--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsname</span><span +class="ectt-0900"> </span></span><a + id="dx1-21099"></a><span +class="ectt-1000">\glsname[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2314--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21100"></a> except that it always uses the value of the <span +class="ecss-1000">name</span><a + id="dx1-21101"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as +having been used. Note: if you want to use this command and the <span +class="ecss-1000">name</span><a + id="dx1-21102"></a> key contains +commands, you will have to disable the <a +href="#sanitize">sanitization</a> of the <span +class="ecss-1000">name</span><a + id="dx1-21103"></a> key and protect fragile +commands. +</p><!--l. 2323--><p class="indent" > There are also analogous commands: +</p><!--l. 2324--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsname</span><span +class="ectt-0900"> </span></span><a + id="dx1-21104"></a><span +class="ectt-1000">\Glsname[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2326--><p class="noindent" > +</p><!--l. 2327--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSname</span><span +class="ectt-0900"> </span></span><a + id="dx1-21105"></a><span +class="ectt-1000">\GLSname[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> + + + +</p><!--l. 2329--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2333--><p class="indent" > The command: +</p><!--l. 2334--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glssymbol</span><span +class="ectt-0900"> </span></span><a + id="dx1-21106"></a><span +class="ectt-1000">\glssymbol[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2336--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21107"></a> except that it always uses the value of the <span +class="ecss-1000">symbol</span><a + id="dx1-21108"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as +having been used. Note: if you want to use this command and the <span +class="ecss-1000">symbol</span><a + id="dx1-21109"></a> key contains +commands, you will have to disable the <a +href="#sanitize">sanitization</a> of the <span +class="ecss-1000">symbol</span><a + id="dx1-21110"></a> key and protect +fragile commands. +</p><!--l. 2345--><p class="indent" > There are also analogous commands: +</p><!--l. 2346--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glssymbol</span><span +class="ectt-0900"> </span></span><a + id="dx1-21111"></a><span +class="ectt-1000">\Glssymbol[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2348--><p class="noindent" > +</p><!--l. 2349--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSsymbol</span><span +class="ectt-0900"> </span></span><a + id="dx1-21112"></a><span +class="ectt-1000">\GLSsymbol[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2351--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2355--><p class="indent" > The command: +</p><!--l. 2356--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsdesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-21113"></a><span +class="ectt-1000">\glsdesc[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2358--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21114"></a> except that it always uses the value of the <span +class="ecss-1000">description</span><a + id="dx1-21115"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as +having been used. Note: if you want to use this command and the <span +class="ecss-1000">description</span><a + id="dx1-21116"></a> key +contains commands, you will have to disable the <a +href="#sanitize">sanitization</a> of the <span +class="ecss-1000">description</span><a + id="dx1-21117"></a> key and +protect fragile commands. +</p><!--l. 2367--><p class="indent" > There are also analogous commands: +</p><!--l. 2368--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsdesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-21118"></a><span +class="ectt-1000">\Glsdesc[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2370--><p class="noindent" > +</p><!--l. 2371--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSdesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-21119"></a><span +class="ectt-1000">\GLSdesc[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2373--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +</p><!--l. 2377--><p class="indent" > The command: +</p><!--l. 2378--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuseri</span><span +class="ectt-0900"> </span></span><a + id="dx1-21120"></a><span +class="ectt-1000">\glsuseri[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2380--><p class="noindent" > +is similar to <span +class="ectt-1000">\glstext</span><a + id="dx1-21121"></a> except that it always uses the value of the <span +class="ecss-1000">user1</span><a + id="dx1-21122"></a> key. Again, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>is always appended to the end of the link text and does not mark the entry as +having been used. +</p><!--l. 2386--><p class="indent" > There are also analogous commands: +</p><!--l. 2387--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuseri</span><span +class="ectt-0900"> </span></span><a + id="dx1-21123"></a><span +class="ectt-1000">\Glsuseri[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2389--><p class="noindent" > +</p><!--l. 2390--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuseri</span><span +class="ectt-0900"> </span></span><a + id="dx1-21124"></a><span +class="ectt-1000">\GLSuseri[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2392--><p class="noindent" > +As before, these commands also have a starred version that disable the hyperlink. +Similarly for the other user keys: + + + +</p><!--l. 2395--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuserii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21125"></a><span +class="ectt-1000">\glsuserii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2397--><p class="noindent" > +</p><!--l. 2398--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuserii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21126"></a><span +class="ectt-1000">\Glsuserii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2400--><p class="noindent" > +</p><!--l. 2401--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuserii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21127"></a><span +class="ectt-1000">\GLSuserii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2403--><p class="noindent" > +</p><!--l. 2404--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuseriii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21128"></a><span +class="ectt-1000">\glsuseriii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2406--><p class="noindent" > +</p><!--l. 2407--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuseriii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21129"></a><span +class="ectt-1000">\Glsuseriii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2409--><p class="noindent" > +</p><!--l. 2410--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuseriii</span><span +class="ectt-0900"> </span></span><a + id="dx1-21130"></a><span +class="ectt-1000">\GLSuseriii[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2412--><p class="noindent" > +</p><!--l. 2413--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuseriv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21131"></a><span +class="ectt-1000">\glsuseriv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2415--><p class="noindent" > +</p><!--l. 2416--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuseriv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21132"></a><span +class="ectt-1000">\Glsuseriv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2418--><p class="noindent" > +</p><!--l. 2419--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuseriv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21133"></a><span +class="ectt-1000">\GLSuseriv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2421--><p class="noindent" > +</p><!--l. 2422--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuserv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21134"></a><span +class="ectt-1000">\glsuserv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2424--><p class="noindent" > +</p><!--l. 2425--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuserv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21135"></a><span +class="ectt-1000">\Glsuserv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2427--><p class="noindent" > +</p><!--l. 2428--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuserv</span><span +class="ectt-0900"> </span></span><a + id="dx1-21136"></a><span +class="ectt-1000">\GLSuserv[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2430--><p class="noindent" > +</p><!--l. 2431--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsuservi</span><span +class="ectt-0900"> </span></span><a + id="dx1-21137"></a><span +class="ectt-1000">\glsuservi[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2433--><p class="noindent" > +</p><!--l. 2434--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsuservi</span><span +class="ectt-0900"> </span></span><a + id="dx1-21138"></a><span +class="ectt-1000">\Glsuservi[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2436--><p class="noindent" > +</p><!--l. 2437--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GLSuservi</span><span +class="ectt-0900"> </span></span><a + id="dx1-21139"></a><span +class="ectt-1000">\GLSuservi[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2439--><p class="noindent" > + + + +</p><!--l. 2443--><p class="noindent" > +</p> +<!--l. 2443--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.4.1 </span> <a + id="x1-220002.4.1"></a>Changing the format of the link text</h5> +<!--l. 2446--><p class="noindent" >The format of the link text<a + id="dx1-22001"></a> for <span +class="ectt-1000">\gls</span><a + id="dx1-22002"></a>, <span +class="ectt-1000">\glspl</span><a + id="dx1-22003"></a> and their uppercase variants is governed +by two commands: +</p><!--l. 2448--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsdisplayfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-22004"></a><span +class="ectt-1000">\glsdisplayfirst{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">first/first plural</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</div><hr> +</p><!--l. 2450--><p class="noindent" > +which is used the first time a glossary entry is used<a + id="dx1-22005"></a> in the text and +</p><!--l. 2453--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsdisplay</span><span +class="ectt-0900"> </span></span><a + id="dx1-22006"></a><span +class="ectt-1000">\glsdisplay{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text/plural</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</div><hr> +</p><!--l. 2455--><p class="noindent" > +which is used subsequently. Both commands take four arguments: the first is either the +singular or plural form given by the <span +class="ecss-1000">text</span><a + id="dx1-22007"></a>, <span +class="ecss-1000">plural</span><a + id="dx1-22008"></a>, <span +class="ecss-1000">first</span><a + id="dx1-22009"></a> or <span +class="ecss-1000">firstplural</span><a + id="dx1-22010"></a> keys (set when the +term was defined) depending on context; the second argument is the term’s +description (as supplied by the <span +class="ecss-1000">description</span><a + id="dx1-22011"></a> or <span +class="ecss-1000">descriptionplural</span><a + id="dx1-22012"></a> keys); the third +argument is the symbol associated with the term (as supplied by the <span +class="ecss-1000">symbol</span><a + id="dx1-22013"></a> or +<span +class="ecss-1000">symbolplural</span><a + id="dx1-22014"></a> keys) and the fourth argument is the additional text supplied in the final +optional argument to <span +class="ectt-1000">\gls </span>or <span +class="ectt-1000">\glspl </span>(or their uppercase variants). The default +definitions of <span +class="ectt-1000">\glsdisplay </span>and <span +class="ectt-1000">\glsdisplayfirst </span>simply print the first argument +immediately followed by the fourth argument. The remaining arguments are +ignored. +</p><!--l. 2471--><p class="indent" > If required, you can access the label for the given entry via +</p><!--l. 2472--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslabel</span><span +class="ectt-0900"> </span></span><a + id="dx1-22015"></a><span +class="ectt-1000">\glslabel </span></div><hr> +</p><!--l. 2474--><p class="noindent" > +so it is possible to use this label in the definition of <span +class="ectt-1000">\glsdisplay </span>or <span +class="ectt-1000">\glsdisplayfirst</span> +to supply additional information using any of the commands described in <a +href="#x1-260002.7">§2.7 </a><a +href="#x1-260002.7">Using +Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>, if required. +</p><!--l. 2480--><p class="indent" > Note that <span +class="ectt-1000">\glsdisplay </span>and <span +class="ectt-1000">\glsdisplayfirst </span>are not used by <span +class="ectt-1000">\glslink</span><a + id="dx1-22016"></a>. If you +want to supply your own link text, you need to use <span +class="ectt-1000">\glsdisp</span><a + id="dx1-22017"></a> instead. +</p><!--l. 2484--><p class="indent" > For example, suppose you want a glossary of measurements and units, you can use +the <span +class="ecss-1000">symbol</span><a + id="dx1-22018"></a> key to store the unit: + + + +</p> + <div class="verbatim" id="verbatim-64"> \newglossaryentry{distance}{name=distance, -description={The length between two points}, -symbol={km}} -</PRE> -and now suppose you want <code>\gls{distance}</code> to produce -"distance (km)" on first use<A NAME="6780"></A>, then you can redefine -<TT>\glsdisplayfirst</TT> as follows: -<PRE> -\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} -</PRE> -Note that the additional text is placed after <code>#1</code>, so -<code>\gls{distance}['s]</code> will produce "distance's (km)" -rather than "distance (km)'s" which looks a bit odd (even though -it may be in the context of "the distance (km) is measured between -the two points" -- but in this instance it would be better not to -use a contraction). - -<P> -Note also that all of the link text<A NAME="6781"></A> will be formatted according -to <TT>\glstextformat</TT><A NAME="6783"></A> (described earlier). So if you do, say: -<PRE> + <br />description={The length between two points}, + <br />symbol={km}} +</div> +<!--l. 2490--><p class="nopar" > and now suppose you want <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{distance}</span></span></span> to produce “distance (km)” on first use<a + id="dx1-22019"></a>, +then you can redefine <span +class="ectt-1000">\glsdisplayfirst </span>as follows: + + + +</p> + <div class="verbatim" id="verbatim-65"> +\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} +</div> +<!--l. 2496--><p class="nopar" > Note that the additional text is placed after <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">#1</span></span></span>, so <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{distance}[’s]</span></span></span> will +produce “distance’s (km)” rather than “distance (km)’s” which looks a bit +odd (even though it may be in the context of “the distance (km) is measured +between the two points” — but in this instance it would be better not to use a +contraction). +</p><!--l. 2504--><p class="indent" > Note also that all of the link text<a + id="dx1-22020"></a> will be formatted according to <span +class="ectt-1000">\glstextformat</span><a + id="dx1-22021"></a> +(described earlier). So if you do, say: + + + +</p> + <div class="verbatim" id="verbatim-66"> \renewcommand{\glstextformat}[1]{\textbf{#1}} -\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} -</PRE> -then <code>\gls{distance}</code> will produce "<B>distance (km)</B>". - -<P> -If you have multiple glossaries, changing <TT>\glsdisplayfirst</TT> and -<TT>\glsdisplay</TT> will change the way entries for all of the -glossaries appear when using the commands <TT>\gls</TT><A NAME="6787"></A>, <TT>\glspl</TT><A NAME="6790"></A>, their -uppercase variants and <TT>\glsdisp</TT><A NAME="6793"></A>. If you only -want the change to affect entries for a given glossary, then you need -to use - -<P> -<TT>\defglsdisplay[</TT><EM>type</EM><TT>]{</TT><EM>definition</EM><TT>}</TT> -<P> + <br />\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} +</div> +<!--l. 2509--><p class="nopar" > then <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{distance}</span></span></span> will produce “<span +class="ecbx-1000">distance (km)</span>”. +</p><!--l. 2512--><p class="indent" > If you have multiple glossaries, changing <span +class="ectt-1000">\glsdisplayfirst </span>and <span +class="ectt-1000">\glsdisplay </span>will +change the way entries for all of the glossaries appear when using the commands <span +class="ectt-1000">\gls</span><a + id="dx1-22022"></a>, +<span +class="ectt-1000">\glspl</span><a + id="dx1-22023"></a>, their uppercase variants and <span +class="ectt-1000">\glsdisp</span><a + id="dx1-22024"></a>. If you only want the change to affect +entries for a given glossary, then you need to use +</p><!--l. 2518--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\defglsdisplay</span><span +class="ectt-0900"> </span></span><a + id="dx1-22025"></a><span +class="ectt-1000">\defglsdisplay[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">definition</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2520--><p class="noindent" > and - -<P> -<TT>\defglsdisplayfirst[</TT><EM>type</EM><TT>]{</TT><EM>definition</EM><TT>}</TT> -<P> -instead 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's label<A NAME="tex2html24" - HREF="#foot4350"><SUP>7</SUP></A> and the second is how the term should be -displayed when it is invoked using commands <TT>\gls</TT>, -<TT>\glspl</TT>, their uppercase variants and <TT>\glsdisp</TT>. This is similar to the way <TT>\glsdisplayfirst</TT> was -redefined above. - -<P> -For example, suppose you have created a new glossary called -<TT>notation</TT> and you want to change the way the entry is -displayed on first use<A NAME="6795"></A> so that it includes the symbol, you can -do: -<PRE> -\defglsdisplayfirst[notation]{#1#4 (denoted #3)} -</PRE> -Now suppose you have defined an entry as follows: -<PRE> +</p><!--l. 2522--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\defglsdisplayfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-22026"></a><span +class="ectt-1000">\defglsdisplayfirst[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">definition</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2524--><p class="noindent" > +instead of redefining <span +class="ectt-1000">\glsdisplay </span>and <span +class="ectt-1000">\glsdisplayfirst</span>. +</p><!--l. 2527--><p class="indent" > Both <span +class="ectt-1000">\defglsdisplay </span>and <span +class="ectt-1000">\defglsdisplayfirst </span>take +two arguments: the first (which is optional) is the glossary’s +label<span class="footnote-mark"><a +href="#fn6x0" id="fn6x0-bk"><sup class="textsuperscript">6</sup></a></span><a + id="x1-22027f6"></a> +and the second is how the term should be displayed when it is invoked using commands +<span +class="ectt-1000">\gls</span>, <span +class="ectt-1000">\glspl</span>, their uppercase variants and <span +class="ectt-1000">\glsdisp</span>. This is similar to the way +<span +class="ectt-1000">\glsdisplayfirst </span>was redefined above. +</p><!--l. 2536--><p class="indent" > For example, suppose you have created a new glossary called <span +class="ectt-1000">notation </span>and you +want to change the way the entry is displayed on first use<a + id="dx1-22028"></a> so that it includes the +symbol, you can do: + + + +</p> + <div class="verbatim" id="verbatim-67"> +\defglsdisplayfirst[notation]{#1#4 (denoted #3)} +</div> +<!--l. 2541--><p class="nopar" > Now suppose you have defined an entry as follows: + + + +</p> + <div class="verbatim" id="verbatim-68"> \newglossaryentry{set}{type=notation, -name=set, -description={A collection of objects}, -symbol={$S$} -} -</PRE> -The first time you reference this entry using <TT>\gls</TT> it -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="6800"></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="6802"></A>, you will have to disable the -<A HREF="glossaries-manual.html#sanitize">sanitization</A> -of these keys and protect fragile commands. -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00034200000000000000"> -Enabling and disabling hyperlinks to glossary entries</A> -</H3> - -<P> -If you load the <TT>hyperref</TT><A NAME="6807"></A> or <TT>html</TT><A NAME="6810"></A> packages prior to -loading the <TT>glossaries</TT> package, commands such as <TT>\glslink</TT><A NAME="6814"></A> -and <TT>\gls</TT><A NAME="6817"></A>, described above, will automatically have hyperlinks -to the relevant glossary entry, unless the <TT>hyper</TT><A NAME="6820"></A> -option has been set to <TT>false</TT>. You can disable or enable links using: - -<P> -<TT>\glsdisablehyper</TT> -<P> + <br />  name=set, + <br />  description={A collection of objects}, + <br />  symbol={$S$} + <br />} +</div> +<!--l. 2549--><p class="nopar" > The first time you reference this entry it will be displayed as: “set (denoted <span +class="cmmi-10">S</span>)” +(assuming <span +class="ectt-1000">\gls</span><a + id="dx1-22029"></a> was used). +</p><!--l. 2553--><p class="indent" > Remember that if you use the <span +class="ecss-1000">symbol</span><a + id="dx1-22030"></a> key, you need to use a glossary style that +displays the symbol, as many of the styles ignore it. In addition, if you want either the +description or symbol to appear in the link text<a + id="dx1-22031"></a>, you will have to disable the +<a +href="#sanitize">sanitization</a> of these keys and protect fragile commands. +</p><!--l. 2560--><p class="noindent" > +</p> +<!--l. 2560--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.4.2 </span> <a + id="x1-230002.4.2"></a>Enabling and disabling hyperlinks to glossary entries</h5> +<!--l. 2562--><p class="noindent" >If you load the <span +class="ecss-1000">hyperref</span><a + id="dx1-23001"></a> or <span +class="ecss-1000">html</span><a + id="dx1-23002"></a> packages prior to loading the <span +class="ecss-1000">glossaries </span>package, +commands such as <span +class="ectt-1000">\glslink</span><a + id="dx1-23003"></a> and <span +class="ectt-1000">\gls</span><a + id="dx1-23004"></a>, described above, will automatically have +hyperlinks to the relevant glossary entry, unless the <span +class="ecss-1000">hyper</span><a + id="dx1-23005"></a> option has been set to <span +class="ectt-1000">false</span>. +You can disable or enable links using: +</p><!--l. 2567--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsdisablehyper</span><span +class="ectt-0900"> </span></span><a + id="dx1-23006"></a><span +class="ectt-1000">\glsdisablehyper </span></div><hr> +</p><!--l. 2569--><p class="noindent" > and - -<P> -<TT>\glsenablehyper</TT> -<P> -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="6823"></A> and <TT>\hypertarget</TT><A NAME="6826"></A> have been -defined (for example, by the <TT>hyperref</TT><A NAME="6829"></A> package). - -<P> -You can disable just the first use links using the package -option <TT>hyperfirst=false</TT><A NAME="6839"></A>. Note that this option only -affects commands that recognise the first use<A NAME="6840"></A> flag, for example -<TT>\gls</TT><A NAME="6842"></A>, <TT>\glspl</TT><A NAME="6845"></A> and <TT>\glsdisp</TT><A NAME="6848"></A> but not <TT>\glslink</TT><A NAME="6851"></A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00035000000000000000"></A> -<A NAME="sec:glsadd"></A> -<BR> -Adding an Entry to the Glossary Without Generating Text -</H2> - -<P> -It is possible to add a line in the glossary file without -generating any text at that point in the document using: - -<P> -<TT>\glsadd[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}</TT> -<P> -This is similar to <TT>\glslink</TT><A NAME="6857"></A>, only it doesn't produce -any text (so therefore, there is no <TT>hyper</TT><A NAME="6860"></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> +</p><!--l. 2571--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsenablehyper</span><span +class="ectt-0900"> </span></span><a + id="dx1-23007"></a><span +class="ectt-1000">\glsenablehyper </span></div><hr> +</p><!--l. 2573--><p class="noindent" > +respectively. The effect can be localised by placing the commands within a group. Note +that you should only use <span +class="ectt-1000">\glsenablehyper </span>if the commands <span +class="ectt-1000">\hyperlink</span><a + id="dx1-23008"></a> and +<span +class="ectt-1000">\hypertarget</span><a + id="dx1-23009"></a> have been defined (for example, by the <span +class="ecss-1000">hyperref</span><a + id="dx1-23010"></a> package). +</p><!--l. 2579--><p class="indent" > You can disable just the first use links using the package option <span +class="ecss-1000">hyperfirst=false</span><a + id="dx1-23011"></a>. +Note that this option only affects commands that recognise the first use<a + id="dx1-23012"></a> flag, for +example <span +class="ectt-1000">\gls</span><a + id="dx1-23013"></a>, <span +class="ectt-1000">\glspl</span><a + id="dx1-23014"></a> and <span +class="ectt-1000">\glsdisp</span><a + id="dx1-23015"></a> but not <span +class="ectt-1000">\glslink</span><a + id="dx1-23016"></a>. +</p><!--l. 2585--><p class="noindent" > +</p> +<!--l. 2585--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.5 </span> <a + id="x1-240002.5"></a>Adding an Entry to the Glossary Without Generating Text</h4> +<!--l. 2588--><p class="noindent" >It is possible to add a line in the glossary file without generating any text at that point +in the document using: +</p><!--l. 2590--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsadd</span><span +class="ectt-0900"> </span></span><a + id="dx1-24001"></a><span +class="ectt-1000">\glsadd[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + + + +</p><!--l. 2592--><p class="noindent" > +This is similar to <span +class="ectt-1000">\glslink</span><a + id="dx1-24002"></a>, only it doesn’t produce any text (so therefore, +there is no <span +class="ecss-1000">hyper</span><a + id="dx1-24003"></a> key available in <span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩ </span>but all the other options that can +be used with <span +class="ectt-1000">\glslink </span>can be passed to <span +class="ectt-1000">\glsadd</span>). For example, to add a +page range to the glossary number list for the entry whose label is given by +<span +class="ectt-1000">set</span>: + + + +</p> + <div class="verbatim" id="verbatim-69"> \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: - -<P> -<TT>\glsaddall[</TT><EM>options</EM><TT>]</TT> -<P> -The optional argument is the same as for <TT>\glsadd</TT>, except -there is also a key <TT>types</TT><A NAME="6863"></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 + <br />Lots of text about sets spanning many pages. + <br />\glsadd[format=)]{set} +</div> +<!--l. 2603--><p class="nopar" > +</p><!--l. 2605--><p class="indent" > To add all entries that have been defined, use: +</p><!--l. 2606--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsaddall</span><span +class="ectt-0900"> </span></span><a + id="dx1-24004"></a><span +class="ectt-1000">\glsaddall[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2608--><p class="noindent" > +The optional argument is the same as for <span +class="ectt-1000">\glsadd</span>, except there is also a key +<span +class="ecss-1000">types</span><a + id="dx1-24005"></a> which can be used to specify which glossaries to use. This should be a +comma separated list. For example, if you only want to add all the entries +belonging to the list of acronyms (specified by the glossary type <span +class="ectt-1000">\acronymtype</span>) +and a list of notation (specified by the glossary type <span +class="ectt-1000">notation</span>) then you can do: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-70"> \glsaddall[types={\acronymtype,notation}] -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00036000000000000000"></A> -<A NAME="sec:crossref"></A> -<BR> -Cross-Referencing Entries -</H2> - -<P> -There are several ways of cross-referencing entries in the -glossary: - -<P> - -<OL> -<LI>You can use commands such as <TT>\gls</TT><A NAME="6869"></A> in the -entries description. For example: -<PRE> -\newglossaryentry{apple}{name=apple, -description={firm, round fruit. See also \gls{pear}}} -</PRE> -Note that with this method, if you don't use the -cross-referenced term in the glossary, you will need two runs of -<TT>makeglossaries</TT><A NAME="6872"></A>: -<PRE> -latex filename -makeglossaries filename -latex filename -makeglossaries filename -latex filename -</PRE> - -<P> -</LI> -<LI>As described <A HREF="glossaries-manual.html#sec:newglosentry">earlier</A>, -you can use the <TT>see</TT><A NAME="6875"></A> key when you define the entry. For -example: -<PRE> -\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -description={Series expansion}, -see={TaylorsTheorem}} -</PRE> -Note that in this case, the entry with the <TT>see</TT><A NAME="6878"></A> key will -automatically be added to the glossary, but the cross-referenced -entry won't. You therefore need to ensure that you use the -cross-referenced term with the commands described in -Links to Glossary Entries or -Adding an Entry to the Glossary -Without Generating Text. - -<P> -You can optionally override the "see" tag using square brackets -at the start of the <TT>see</TT><A NAME="6881"></A> value. For example: -<PRE> -\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -description={Series expansion}, -see=[see also]{TaylorsTheorem}} -</PRE> - -<P> -</LI> -<LI>After you have defined the entry, use - -<P> -<TT>\glssee[</TT><EM>tag</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>xr label list</EM><TT>}</TT> -<P> -where <I>xr label list</I> is a comma-separated list of entry -labels to be cross-referenced, <I>label</I> is the label of the -entry doing the cross-referencing and <I>tag</I> is the "see" tag. -For example: -<PRE> -\glssee[see also]{series}{FourierSeries,TaylorsTheorem} -</PRE> -Note that this automatically adds the entry given by <I>label</I> to -the glossary but doesn't add the cross-referenced entries (specified -by <I>xr label list</I>) to the glossary. -</LI> -</OL> - -<P> -In both cases 2 and 3 above, the cross-referenced information appears -in the number list<A NAME="6883"></A>, whereas in case 1, the cross-referenced -information appears in the description. In cases 2 and 3, the -default text for the "see" tag is given by <TT>\seename</TT><A NAME="6885"></A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00037000000000000000"></A> -<A NAME="sec:glsnolink"></A> -<BR> -Using Glossary Terms Without Links -</H2> - -<P> -The commands described in this section display entry details without -adding any information to the glossary. They don't use -<TT>\glstextformat</TT>, they don't have any optional arguments, -they don't affect the first use flag<A NAME="6890"></A> and, apart from <TT>\glshyperlink</TT><A NAME="6892"></A>, they don't produce -hyperlinks. - -<P> -<TT>\glsentryname{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryname{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the name of the glossary entry given by -<I>label</I>, as specified by the <TT>name</TT><A NAME="6895"></A> key. -<TT>\Glsentryname</TT> makes the first letter uppercase. - -<P> -<TT>\glsentrytext{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentrytext{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the subsequent use text for the glossary entry -given by <I>label</I>, as specified by the <TT>text</TT><A NAME="6898"></A> key. -<TT>\Glsentrytext</TT> makes the first letter uppercase. - -<P> -<TT>\glsentryplural{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryplural{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the subsequent use plural text for the glossary -entry given by <I>label</I>, as specified by the <TT>plural</TT><A NAME="6901"></A> key. -<TT>\Glsentryplural</TT> makes the first letter uppercase. - -<P> -<TT>\glsentryfirst{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryfirst{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the first use text<A NAME="6903"></A> for the glossary entry -given by <I>label</I>, as specified by the <TT>first</TT><A NAME="6905"></A> key. -<TT>\Glsentryfirst</TT> makes the first letter uppercase. - -<P> -<TT>\glsentryfirstplural{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryfirstplural{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the plural form of the first use text<A NAME="6907"></A> for the -glossary entry given by <I>label</I>, as specified by the -<TT>firstplural</TT><A NAME="6909"></A> key. <TT>\Glsentryfirstplural</TT> makes the first -letter uppercase. - -<P> -<TT>\glsentrydesc{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentrydesc{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the description for the glossary entry given by -<I>label</I>. <TT>\Glsentrydesc</TT> makes the first letter uppercase. - -<P> -<TT>\glsentrydescplural{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentrydescplural{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the plural description for the glossary entry -given by <I>label</I>. <TT>\Glsentrydescplural</TT> makes the first letter +</div> +<!--l. 2619--><p class="nopar" > +</p><!--l. 2622--><p class="noindent" > +</p> +<!--l. 2622--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.6 </span> <a + id="x1-250002.6"></a>Cross-Referencing Entries</h4> +<!--l. 2625--><p class="noindent" >There are several ways of cross-referencing entries in the glossary: +</p><!--l. 2628--><p class="indent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-25002x1">You can use commands such as <span +class="ectt-1000">\gls</span><a + id="dx1-25003"></a> in the entries description. For example: + + + + <div class="verbatim" id="verbatim-71"> + \newglossaryentry{apple}{name=apple, +  <br />description={firm, round fruit. See also \gls{pear}}} +</div> + <!--l. 2634--><p class="nopar" > Note that with this method, if you don’t use the cross-referenced term in the + glossary, you will need two runs of <span +class="ectt-1000">makeglossaries</span><a + id="dx1-25004"></a>: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">latex filename</span> + <br /><span +class="ectt-1000">makeglossaries filename</span> + <br /><span +class="ectt-1000">latex filename</span> + <br /><span +class="ectt-1000">makeglossaries filename</span> + <br /><span +class="ectt-1000">latex filename</span></span> + </p><!--l. 2644--><p class="noindent" ><spacer type=vertical size=10> + </p></li> + <li + class="enumerate" id="x1-25006x2">As described in <a +href="#x1-140002.2">§2.2 </a><a +href="#x1-140002.2">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>, you can use the <span +class="ecss-1000">see</span><a + id="dx1-25007"></a> key when you + define the entry. For example: + + + + <div class="verbatim" id="verbatim-72"> + \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, +  <br />description={Series expansion}, see={TaylorsTheorem}} +</div> + <!--l. 2651--><p class="nopar" > Note that in this case, the entry with the <span +class="ecss-1000">see</span><a + id="dx1-25008"></a> key will automatically be added to + the glossary, but the cross-referenced entry won’t. You therefore need to ensure + that you use the cross-referenced term with the commands described in <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links + to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a +href="#x1-240002.5">§2.5 </a><a +href="#x1-240002.5">Adding an Entry to the Glossary Without Generating + Text<!--tex4ht:ref: sec:glsadd --></a>. + </p><!--l. 2658--><p class="noindent" >You can optionally override the “see” tag using square brackets at the start of the + <span +class="ecss-1000">see</span><a + id="dx1-25009"></a> value. For example: + + + +</p> + <div class="verbatim" id="verbatim-73"> + \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, +  <br />description={Series expansion}, +  <br />see=[see also]{TaylorsTheorem}} +</div> + <!--l. 2664--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-25011x3">After you have defined the entry, use + <!--l. 2667--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glssee</span><span +class="ectt-0900"> </span></span><a + id="dx1-25012"></a><span +class="ectt-1000">\glssee[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">tag</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">xr label list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 2669--><p class="noindent" > + where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">xr label list</span><span +class="cmsy-10">⟩ </span>is a comma-separated list of entry labels to be cross-referenced, + <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the label of the entry doing the cross-referencing and <span +class="cmsy-10">⟨</span><span +class="ecti-1000">tag</span><span +class="cmsy-10">⟩ </span>is the “see” + tag. For example: + + + +</p> + <div class="verbatim" id="verbatim-74"> + \glssee[see also]{series}{FourierSeries,TaylorsTheorem} +</div> + <!--l. 2676--><p class="nopar" > Note that this automatically adds the entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>to the glossary but + doesn’t add the cross-referenced entries (specified by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">xr label list</span><span +class="cmsy-10">⟩</span>) to the + glossary.</p></li></ol> +<!--l. 2682--><p class="indent" > In both cases 2 and 3 above, the cross-referenced information appears in the +number list<a + id="dx1-25013"></a>, whereas in case 1, the cross-referenced information appears in the +description. In cases 2 and 3, the default text for the “see” tag is given by +<span +class="ectt-1000">\seename</span><a + id="dx1-25014"></a>. +</p><!--l. 2688--><p class="noindent" > +</p> +<!--l. 2688--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.7 </span> <a + id="x1-260002.7"></a>Using Glossary Terms Without Links</h4> +<!--l. 2691--><p class="noindent" >The commands described in this section display entry details without adding any +information to the glossary. They don’t use <span +class="ectt-1000">\glstextformat</span>, they don’t have any +optional arguments, they don’t affect the first use flag<a + id="dx1-26001"></a> and, apart from <span +class="ectt-1000">\glshyperlink</span><a + id="dx1-26002"></a>, +they don’t produce hyperlinks. +</p><!--l. 2696--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryname</span><span +class="ectt-0900"> </span></span><a + id="dx1-26003"></a><span +class="ectt-1000">\glsentryname{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2698--><p class="noindent" > +</p><!--l. 2699--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryname</span><span +class="ectt-0900"> </span></span><a + id="dx1-26004"></a><span +class="ectt-1000">\Glsentryname{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2701--><p class="noindent" > +These commands display the name of the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, as specified by +the <span +class="ecss-1000">name</span><a + id="dx1-26005"></a> key. <span +class="ectt-1000">\Glsentryname </span>makes the first letter uppercase. +</p><!--l. 2705--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrytext</span><span +class="ectt-0900"> </span></span><a + id="dx1-26006"></a><span +class="ectt-1000">\glsentrytext{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2707--><p class="noindent" > +</p><!--l. 2708--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrytext</span><span +class="ectt-0900"> </span></span><a + id="dx1-26007"></a><span +class="ectt-1000">\Glsentrytext{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2710--><p class="noindent" > +These commands display the subsequent use text for the glossary entry given +by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, as specified by the <span +class="ecss-1000">text</span><a + id="dx1-26008"></a> key. <span +class="ectt-1000">\Glsentrytext </span>makes the first letter uppercase. - -<P> -<TT>\glsentrysymbol{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentrysymbol{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the symbol for the glossary entry given by -<I>label</I>. <TT>\Glsentrysymbol</TT> makes the first letter uppercase. - -<P> -<TT>\glsentrysymbolplural{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentrysymbolplural{</TT><EM>label</EM><TT>}</TT> -<P> -These commands display the plural symbol for the glossary entry given by -<I>label</I>. <TT>\Glsentrysymbolplural</TT> makes the first letter uppercase. - -<P> -<TT>\glsentryuseri{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuseri{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glsentryuserii{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuserii{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glsentryuseriii{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuseriii{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glsentryuseriv{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuseriv{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glsentryuserv{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuserv{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glsentryuservi{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\Glsentryuservi{</TT><EM>label</EM><TT>}</TT> -<P> +</p><!--l. 2714--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26009"></a><span +class="ectt-1000">\glsentryplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2716--><p class="noindent" > +</p><!--l. 2717--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26010"></a><span +class="ectt-1000">\Glsentryplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2719--><p class="noindent" > +These commands display the subsequent use plural text for the glossary entry given by + + + +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, as specified by the <span +class="ecss-1000">plural</span><a + id="dx1-26011"></a> key. <span +class="ectt-1000">\Glsentryplural </span>makes the first letter +uppercase. +</p><!--l. 2724--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-26012"></a><span +class="ectt-1000">\glsentryfirst{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2726--><p class="noindent" > +</p><!--l. 2727--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryfirst</span><span +class="ectt-0900"> </span></span><a + id="dx1-26013"></a><span +class="ectt-1000">\Glsentryfirst{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2729--><p class="noindent" > +These commands display the first use text<a + id="dx1-26014"></a> for the glossary entry given by +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, as specified by the <span +class="ecss-1000">first</span><a + id="dx1-26015"></a> key. <span +class="ectt-1000">\Glsentryfirst </span>makes the first letter +uppercase. +</p><!--l. 2733--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryfirstplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26016"></a><span +class="ectt-1000">\glsentryfirstplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2735--><p class="noindent" > +</p><!--l. 2736--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryfirstplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26017"></a><span +class="ectt-1000">\Glsentryfirstplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2738--><p class="noindent" > +These commands display the plural form of the first use text<a + id="dx1-26018"></a> for the glossary entry +given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, as specified by the <span +class="ecss-1000">firstplural</span><a + id="dx1-26019"></a> key. <span +class="ectt-1000">\Glsentryfirstplural </span>makes the +first letter uppercase. +</p><!--l. 2743--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrydesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-26020"></a><span +class="ectt-1000">\glsentrydesc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2745--><p class="noindent" > +</p><!--l. 2746--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrydesc</span><span +class="ectt-0900"> </span></span><a + id="dx1-26021"></a><span +class="ectt-1000">\Glsentrydesc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2748--><p class="noindent" > +These commands display the description for the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +<span +class="ectt-1000">\Glsentrydesc </span>makes the first letter uppercase. +</p><!--l. 2751--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrydescplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26022"></a><span +class="ectt-1000">\glsentrydescplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2753--><p class="noindent" > +</p><!--l. 2754--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrydescplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26023"></a><span +class="ectt-1000">\Glsentrydescplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2756--><p class="noindent" > +These commands display the plural description for the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +<span +class="ectt-1000">\Glsentrydescplural </span>makes the first letter uppercase. +</p><!--l. 2760--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrysymbol</span><span +class="ectt-0900"> </span></span><a + id="dx1-26024"></a><span +class="ectt-1000">\glsentrysymbol{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2762--><p class="noindent" > +</p><!--l. 2763--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrysymbol</span><span +class="ectt-0900"> </span></span><a + id="dx1-26025"></a><span +class="ectt-1000">\Glsentrysymbol{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2765--><p class="noindent" > +These commands display the symbol for the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +<span +class="ectt-1000">\Glsentrysymbol </span>makes the first letter uppercase. +</p><!--l. 2768--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentrysymbolplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26026"></a><span +class="ectt-1000">\glsentrysymbolplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2770--><p class="noindent" > +</p><!--l. 2771--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentrysymbolplural</span><span +class="ectt-0900"> </span></span><a + id="dx1-26027"></a><span +class="ectt-1000">\Glsentrysymbolplural{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2773--><p class="noindent" > +These commands display the plural symbol for the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +<span +class="ectt-1000">\Glsentrysymbolplural </span>makes the first letter uppercase. + + + +</p><!--l. 2777--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuseri</span><span +class="ectt-0900"> </span></span><a + id="dx1-26028"></a><span +class="ectt-1000">\glsentryuseri{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2779--><p class="noindent" > +</p><!--l. 2780--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuseri</span><span +class="ectt-0900"> </span></span><a + id="dx1-26029"></a><span +class="ectt-1000">\Glsentryuseri{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2782--><p class="noindent" > +</p><!--l. 2783--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuserii</span><span +class="ectt-0900"> </span></span><a + id="dx1-26030"></a><span +class="ectt-1000">\glsentryuserii{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2785--><p class="noindent" > +</p><!--l. 2786--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuserii</span><span +class="ectt-0900"> </span></span><a + id="dx1-26031"></a><span +class="ectt-1000">\Glsentryuserii{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2788--><p class="noindent" > +</p><!--l. 2789--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuseriii</span><span +class="ectt-0900"> </span></span><a + id="dx1-26032"></a><span +class="ectt-1000">\glsentryuseriii{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2791--><p class="noindent" > +</p><!--l. 2792--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuseriii</span><span +class="ectt-0900"> </span></span><a + id="dx1-26033"></a><span +class="ectt-1000">\Glsentryuseriii{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2794--><p class="noindent" > +</p><!--l. 2795--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuseriv</span><span +class="ectt-0900"> </span></span><a + id="dx1-26034"></a><span +class="ectt-1000">\glsentryuseriv{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2797--><p class="noindent" > +</p><!--l. 2798--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuseriv</span><span +class="ectt-0900"> </span></span><a + id="dx1-26035"></a><span +class="ectt-1000">\Glsentryuseriv{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2800--><p class="noindent" > +</p><!--l. 2801--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuserv</span><span +class="ectt-0900"> </span></span><a + id="dx1-26036"></a><span +class="ectt-1000">\glsentryuserv{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2803--><p class="noindent" > +</p><!--l. 2804--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuserv</span><span +class="ectt-0900"> </span></span><a + id="dx1-26037"></a><span +class="ectt-1000">\Glsentryuserv{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2806--><p class="noindent" > +</p><!--l. 2807--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsentryuservi</span><span +class="ectt-0900"> </span></span><a + id="dx1-26038"></a><span +class="ectt-1000">\glsentryuservi{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2809--><p class="noindent" > +</p><!--l. 2810--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Glsentryuservi</span><span +class="ectt-0900"> </span></span><a + id="dx1-26039"></a><span +class="ectt-1000">\Glsentryuservi{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2812--><p class="noindent" > These commands display the value of the user keys for the glossary entry given by -<I>label</I>. - -<P> -<TT>\glshyperlink[</TT><EM>link text</EM><TT>]{</TT><EM>label</EM><TT>}</TT> -<P> -This command provides a hyperlink to the glossary entry given by -<I>label</I> <B>but does not add any information to the -glossary file</B>. The link text is given by -<TT>\glsentryname</TT><A NAME="6912"></A><TT>{</TT><EM>label</EM><TT>}</TT> by default, but can be overridden -using the optional argument. -If you use <TT>\glshyperlink</TT>, you need to ensure that the relevant -entry has been added to the glossary using any of the -commands described in <A HREF="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A> or -<A HREF="glossaries-manual.html#sec:glsadd">Adding an Entry to the Glossary Without Generating -Text</A> otherwise you will end up with a broken -link. - -<P> -For further information see the -section "Displaying entry details without adding information to -the glossary" in the document <TT><A NAME="tex2html25" - HREF="glossaries.pdf">glossaries.pdf</A></TT>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00038000000000000000"></A> -<A NAME="sec:printglossary"></A> -<BR> -Displaying a glossary -</H2> - -<P> -The command <TT>\printglossaries</TT> will display all the -glossaries in the order in which they were defined. -Note that no glossaries will appear until -you have either used the Perl script <TT>makeglossaries</TT><A NAME="6918"></A> -or have directly used <TT>makeindex</TT><A NAME="6921"></A> or <TT>xindy</TT><A NAME="6924"></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="6927"></A>/<TT>xindy</TT><A NAME="6930"></A> log files to see if there is a -problem. Remember that you also need to use the command -<TT>\makeglossaries</TT><A NAME="6933"></A> in the preamble to enable the glossaries. - -<P> -An individual glossary can be displayed using: - -<P> -<TT>\printglossary[</TT><EM>options</EM><TT>]</TT> -<P> -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="6936"></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: -<PRE> -\printglossary[type=\acronymtype] -</PRE> - -<P> -</DD> -<DT><STRONG><TT>title</TT><A NAME="6939"></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="6942"></A></STRONG></DT> -<DD>This is the title -to use for the table of contents (if the <TT>toc</TT><A NAME="6950"></A> package -option has been used). It may also be used for the page header, -depending on the page style. If omitted, the glossary title is used. - -<P> -</DD> -<DT><STRONG><TT>style</TT><A NAME="6954"></A></STRONG></DT> -<DD>This specifies which -glossary style to use for this glossary, overriding the effect -of the <TT>style</TT><A NAME="6962"></A> package option or <TT>\glossarystyle</TT><A NAME="6966"></A>. - -<P> -</DD> -<DT><STRONG><TT>numberedsection</TT><A NAME="6969"></A></STRONG></DT> -<DD>This specifies -whether to use a numbered section for this glossary, overriding -the effect of the <TT>numberedsection</TT><A NAME="6977"></A> package option. This -key has the same syntax as the <TT>numberedsection</TT><A NAME="6986"></A> package -option, described <A HREF="glossaries-manual.html#sec:pkgopts">earlier</A>. - -<P> -</DD> -<DT><STRONG><TT>nonumberlist</TT><A NAME="6990"></A></STRONG></DT> -<DD>Unlike the package option -of the same name, this key is a boolean key. If true (<code>nonumberlist=true</code>) the numberlist -is suppressed for this glossary. If false (<code>nonumberlist=false</code>) the numberlist is -displayed for this glossary. If no value is supplied, true is -assumed. - -<P> -</DD> -</DL> - -<P> -Information can be added to the start of the glossary (after the -title and before the main body of the glossary) by redefining -<TT>\glossarypreamble</TT>. For example: -<PRE> -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.} -</PRE> -This needs to be done before the glossary is displayed using -<TT>\printglossaries</TT> or <TT>\printglossary</TT>. Note that if you -want a different preamble for each glossary, you will need to -use a separate <TT>\printglossary</TT> for each glossary and change -the definition of <TT>\glossarypreamble</TT> between each glossary. +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +</p><!--l. 2815--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glshyperlink</span><span +class="ectt-0900"> </span></span><a + id="dx1-26040"></a><span +class="ectt-1000">\glshyperlink[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">link text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2817--><p class="noindent" > +This command provides a hyperlink to the glossary entry given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span><span +class="ecbx-1000">but does</span> +<span +class="ecbx-1000">not add any information to the glossary file</span>. The link text is given by +<span +class="ectt-1000">\glsentryname</span><a + id="dx1-26041"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>by default, but can be overridden using the optional +argument. +</p><!--l. 2823--><p class="indent" > <div class="important" title="Important Note"> If you use <span +class="ectt-1000">\glshyperlink</span>, you need to ensure that the relevant entry has been +added to the glossary using any of the commands described in <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links to Glossary +Entries<!--tex4ht:ref: sec:glslink --></a> or <a +href="#x1-240002.5">§2.5 </a><a +href="#x1-240002.5">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> otherwise + + + +you will end up with a broken link. </div> +</p><!--l. 2828--><p class="noindent" > +</p><!--l. 2830--><p class="indent" > For further information see the section “Displaying entry details without adding +information to the glossary” in the document <a +href="glossaries.pdf" class="url" ><span +class="ectt-1000">glossaries.pdf</span></a>. +</p><!--l. 2836--><p class="noindent" > +</p> +<!--l. 2836--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.8 </span> <a + id="x1-270002.8"></a>Displaying a glossary</h4> +<!--l. 2839--><p class="noindent" >The command +</p><!--l. 2840--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\printglossaries</span><span +class="ectt-0900"> </span></span><a + id="dx1-27001"></a><span +class="ectt-1000">\printglossaries </span></div><hr> +</p><!--l. 2842--><p class="noindent" > +will display all the glossaries in the order in which they were defined. Note that no +glossaries will appear until you have either used the Perl script <span +class="ectt-1000">makeglossaries</span><a + id="dx1-27002"></a> or have +directly used <span +class="ectt-1000">makeindex</span><a + id="dx1-27003"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-27004"></a> (as described in <a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated +Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>). If the glossary still does not appear after you re-<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> your +document, check the <span +class="ectt-1000">makeindex</span><a + id="dx1-27005"></a>/<span +class="ectt-1000">xindy</span><a + id="dx1-27006"></a> log files to see if there is a problem. Remember +that you also need to use the command <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-27007"></a> in the preamble to enable the +glossaries. +</p><!--l. 2853--><p class="indent" > An individual glossary can be displayed using: +</p><!--l. 2854--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\printglossary</span><span +class="ectt-0900"> </span></span><a + id="dx1-27008"></a><span +class="ectt-1000">\printglossary[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 2856--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩ </span>is a <span +class="cmsy-10">⟨</span><span +class="ecti-1000">key</span><span +class="cmsy-10">⟩</span>=<span +class="cmsy-10">⟨</span><span +class="ecti-1000">value</span><span +class="cmsy-10">⟩ </span>list of options. The following keys are available: + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">type</span><a + id="dx1-27009"></a> </dt><dd +class="description">The value of this key specifies which glossary to print. If omitted, the default + glossary is assumed. For example, to print the list of acronyms: + + + + <div class="verbatim" id="verbatim-75"> + \printglossary[type=\acronymtype] +</div> + <!--l. 2865--><p class="nopar" > + </p></dd><dt class="description"> +<span +class="ecsx-1000">title</span><a + id="dx1-27010"></a> </dt><dd +class="description">This is the glossary’s title (overriding the title specified when the glossary was + defined). + </dd><dt class="description"> +<span +class="ecsx-1000">toctitle</span><a + id="dx1-27011"></a> </dt><dd +class="description">This is the title to use for the table of contents (if the <span +class="ecss-1000">toc</span><a + id="dx1-27012"></a> package option has + been used). It may also be used for the page header, depending on the page style. + If omitted, the glossary title is used. + </dd><dt class="description"> +<span +class="ecsx-1000">style</span><a + id="dx1-27013"></a> </dt><dd +class="description">This specifies which glossary style to use for this glossary, overriding the effect of + the <span +class="ecss-1000">style</span><a + id="dx1-27014"></a> package option or <span +class="ectt-1000">\glossarystyle</span><a + id="dx1-27015"></a>. + </dd><dt class="description"> +<span +class="ecsx-1000">numberedsection</span><a + id="dx1-27016"></a> </dt><dd +class="description">This specifies whether to use a numbered section for this glossary, + overriding the effect of the <span +class="ecss-1000">numberedsection</span><a + id="dx1-27017"></a> package option. This key has the same + syntax as the <span +class="ecss-1000">numberedsection</span><a + id="dx1-27018"></a> package option, described in <a +href="#x1-130002.1">§2.1 </a><a +href="#x1-130002.1">Package + Options<!--tex4ht:ref: sec:pkgopts --></a>. + </dd><dt class="description"> +<span +class="ecsx-1000">nonumberlist</span><a + id="dx1-27019"></a> </dt><dd +class="description">Unlike the package option of the same name, this key is a boolean key. If + true (<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">nonumberlist=true</span></span></span>) the numberlist is suppressed for this glossary. If false + (<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">nonumberlist=false</span></span></span>) the numberlist is displayed for this glossary. If no value is + supplied, true is assumed. + </dd></dl> +<!--l. 2894--><p class="indent" > By default, the glossary is started either by <span +class="ectt-1000">\chapter* </span>or by <span +class="ectt-1000">\section*</span>, depending +on whether or not <span +class="ectt-1000">\chapter </span>is defined. This can be overridden by the <span +class="ecss-1000">section</span><a + id="dx1-27020"></a> package +option or the <span +class="ectt-1000">\setglossarysection </span>command. Numbered sectional units can be +obtained using the <span +class="ecss-1000">numberedsection</span><a + id="dx1-27021"></a> package option. Each glossary sets the page header +via the command <span +class="ectt-1000">\glossarymark</span><a + id="dx1-27022"></a>. If this mechanism is unsuitable for your +chosen class file or page style package, you will need to redefine <span +class="ectt-1000">\glossarymark</span><a + id="dx1-27023"></a>. +Further information about these options and commands is given in <a +href="#x1-130002.1">§2.1 </a><a +href="#x1-130002.1">Package +Options<!--tex4ht:ref: sec:pkgopts --></a>. +</p><!--l. 2905--><p class="indent" > Information can be added to the start of the glossary (after the title and before the +main body of the glossary) by redefining +</p><!--l. 2907--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossarypreamble</span><span +class="ectt-0900"> </span></span><a + id="dx1-27024"></a><span +class="ectt-1000">\glossarypreamble </span></div><hr> +</p><!--l. 2909--><p class="noindent" > For example: -<PRE> -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.} -\printglossary -\renewcommand{\glossarypreamble}{} -\printglossary[type=acronym] -</PRE> -Alternatively, you can do something like: -<PRE> -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.\gdef\glossarypreamble{}} -\printglossaries -</PRE> -which will print the preamble text for the first glossary and -change the preamble to do nothing for subsequent glossaries. -(Note that <TT>\gdef</TT> is required as the glossary is placed within -a group.) - -<P> -There is an analogous command -called <TT>\glossarypostamble</TT> which is placed at the end of each -glossary. -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00038100000000000000"></A> -<A NAME="sec:glsnamefont"></A> -<BR> -Changing the way the entry name appears in the glossary -</H3> - -<P> -Within each glossary, each entry name is -formatted according to <TT>\glsnamefont</TT> which takes one argument: -the entry name. This command is always used regardless of the -glossary style. By default, <TT>\glsnamefont</TT> simply displays its -argument in whatever the surrounding font happens to be. This means -that in the list-like glossary styles (defined in the -<TT>glossary-list</TT><A NAME="6996"></A> style file) the name will appear in bold, since -the name is placed in the optional argument of <TT>\item</TT>, whereas in -the tabular styles (defined in the <TT>glossary-long</TT><A NAME="6999"></A> and -<TT>glossary-super</TT><A NAME="7002"></A> style files) the name will appear in the -normal font. The hierarchical glossary styles (defined in the -<TT>glossary-tree</TT><A NAME="7005"></A> style file) also set the name in bold. - -<P> -For example, suppose you want all the entry names to appear in -medium weight small caps, then you can do: -<PRE> -\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION00038200000000000000"></A> -<A NAME="sec:xindy"></A> -<BR> -Xindy -</H3> - -<P> -If you want to use <TT>xindy</TT><A NAME="7011"></A> to sort the glossary, you -must use the package option <TT>xindy</TT><A NAME="7019"></A>: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-76"> +\renewcommand{\glossarypreamble}{Numbers in italic indicate + <br />primary definitions.} +</div> +<!--l. 2914--><p class="nopar" > This needs to be done before the glossary is displayed using <span +class="ectt-1000">\printglossaries </span>or +<span +class="ectt-1000">\printglossary</span>. Note that if you want a different preamble for each glossary, you will +need to use a separate <span +class="ectt-1000">\printglossary </span>for each glossary and change the definition of +<span +class="ectt-1000">\glossarypreamble </span>between each glossary. For example: + + + +</p> + <div class="verbatim" id="verbatim-77"> +\renewcommand{\glossarypreamble}{Numbers in italic indicate + <br />primary definitions.} + <br />\printglossary + <br />\renewcommand{\glossarypreamble}{} + <br />\printglossary[type=acronym] +</div> +<!--l. 2927--><p class="nopar" > Alternatively, you can do something like: + + + +</p> + <div class="verbatim" id="verbatim-78"> +\renewcommand{\glossarypreamble}{Numbers in italic indicate + <br />primary definitions.\gdef\glossarypreamble{}} + <br />\printglossaries +</div> +<!--l. 2933--><p class="nopar" > which will print the preamble text for the first glossary and change the preamble to do +nothing for subsequent glossaries. (Note that <span +class="ectt-1000">\gdef </span>is required as the glossary is placed +within a group.) +</p><!--l. 2939--><p class="indent" > There is an analogous command called +</p><!--l. 2940--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossarypostamble</span><span +class="ectt-0900"> </span></span><a + id="dx1-27025"></a><span +class="ectt-1000">\glossarypostamble </span></div><hr> +</p><!--l. 2942--><p class="noindent" > +which is placed at the end of each glossary. +</p><!--l. 2945--><p class="noindent" > +</p> +<!--l. 2945--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.8.1 </span> <a + id="x1-280002.8.1"></a>Changing the way the entry name appears in the glossary</h5> +<!--l. 2948--><p class="noindent" >Within each glossary, each entry name is formatted according to +</p><!--l. 2949--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsnamefont</span><span +class="ectt-0900"> </span></span><a + id="dx1-28001"></a><span +class="ectt-1000">\glsnamefont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 2951--><p class="noindent" > +which takes one argument: the entry name. This command is always used regardless of +the glossary style. By default, <span +class="ectt-1000">\glsnamefont </span>simply displays its argument in whatever +the surrounding font happens to be. This means that in the list-like glossary styles +(defined in the <span +class="ecss-1000">glossary-list</span><a + id="dx1-28002"></a> style file) the name will appear in bold, since the name is +placed in the optional argument of <span +class="ectt-1000">\item</span>, whereas in the tabular styles (defined in the +<span +class="ecss-1000">glossary-long</span><a + id="dx1-28003"></a> and <span +class="ecss-1000">glossary-super</span><a + id="dx1-28004"></a> style files) the name will appear in the normal font. The +hierarchical glossary styles (defined in the <span +class="ecss-1000">glossary-tree</span><a + id="dx1-28005"></a> style file) also set the name in +bold. +</p><!--l. 2964--><p class="indent" > For example, suppose you want all the entry names to appear in medium weight +small caps, then you can do: + + + +</p> + <div class="verbatim" id="verbatim-79"> +\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} +</div> +<!--l. 2968--><p class="nopar" > +</p><!--l. 2971--><p class="noindent" > +</p> +<!--l. 2971--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.8.2 </span> <a + id="x1-290002.8.2"></a>Xindy</h5> +<!--l. 2974--><p class="noindent" >If you want to use <span +class="ectt-1000">xindy</span><a + id="dx1-29001"></a> to sort the glossary, you must use the package option +<span +class="ecss-1000">xindy</span><a + id="dx1-29002"></a>: + + + +</p> + <div class="verbatim" id="verbatim-80"> \usepackage[xindy]{glossaries} -</PRE> -This ensures that the glossary information is written in -<TT>xindy</TT><A NAME="7023"></A> syntax. - -<P> -The section -<A HREF="glossaries-manual.html#sec:makeglossaries">Generating the Associated Glossary -Files</A> covers how to use the external -indexing application. This section covers the commands provided -by the <TT>glossaries</TT> package that allow you to adjust the -<TT>xindy</TT><A NAME="7027"></A> style file (<TT>.xdy</TT><A NAME="7030"></A>) and parameters. - -<P> -To assist writing information to the <TT>xindy</TT><A NAME="7032"></A> style -file, the <TT>glossaries</TT> package provides the following -commands: - -<P> -<TT>\glsopenbrace</TT> -<P> - -<P> -<TT>\glsclosebrace</TT> -<P> -which produce an open and closing brace. (This is needed because -<code>\{</code> and <code>\}</code> don't expand to a simple brace character -when written to a file.) - -<P> -In addition, if you are using a package that makes the double -quote character active (e.g. <TT>ngerman</TT><A NAME="7036"></A>) you can use: - -<P> -<TT>\glsquote{</TT><EM>text</EM><TT>}</TT> -<P> -which will produce <code>"</code><I>text</I><code>"</code>. Alternatively, -you can use <code>\string"</code> to write the double-quote character. -This document assumes that the double quote character has not been -made active, so the examples just use <code>"</code> for clarity. - -<P> -If you want greater control over the <TT>xindy</TT><A NAME="7039"></A> style file than -is available through the LaTeX commands provided by the -<TT>glossaries</TT> package, you will need to edit the <TT>xindy</TT><A NAME="7043"></A> -style file. In -which case, you must use <TT>\noist</TT><A NAME="7046"></A> to prevent the style file from -being overwritten by the <TT>glossaries</TT> package. For additional -information about <TT>xindy</TT><A NAME="7050"></A>, read the <TT>xindy</TT><A NAME="7053"></A> -documentation. -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H4><A NAME="SECTION00038210000000000000"> -Language and Encodings</A> -</H4> -When you use <TT>xindy</TT><A NAME="7059"></A>, you need to specify the language -and encoding used (unless you have written your own custom -<TT>xindy</TT><A NAME="7062"></A> style file that defines the relevant alphabet -and sort rules). If you use <TT>makeglossaries</TT><A NAME="7065"></A>, -this information is obtained from the document's auxiliary -(<TT>.aux</TT><A NAME="7068"></A>) file. The <TT>glossaries</TT> package attempts to -find the root language, but in the event that it gets it wrong or if -<TT>xindy</TT><A NAME="7071"></A> doesn't support that language, then you can -specify the language using: - -<P> -<TT>\GlsSetXdyLanguage[</TT><EM>glossary type</EM><TT>]{</TT><EM>language</EM><TT>}</TT> -<P> -where <I>language</I> is the name of the language. The -optional argument can be used if you have multiple glossaries -in different languages. If <I>glossary type</I> is omitted, it -will be applied to all glossaries, otherwise the language -setting will only be applied to the glossary given by -<I>glossary type</I>. - -<P> -If the <TT>inputenc</TT><A NAME="7074"></A> package is used, the encoding will be -obtained from the value of <TT>\inputencodingname</TT><A NAME="7077"></A>. -Alternatively, you can specify the encoding using: - -<P> -<TT>\GlsSetXdyCodePage{</TT><EM>code</EM><TT>}</TT> -<P> -where <I>code</I> is the name of the encoding. For example: -<PRE> +</div> +<!--l. 2978--><p class="nopar" > This ensures that the glossary information is written in <span +class="ectt-1000">xindy</span><a + id="dx1-29003"></a> syntax. +</p><!--l. 2982--><p class="indent" > <a +href="#x1-60001.3">§1.3 </a><a +href="#x1-60001.3">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> covers how to use the external +indexing application. This section covers the commands provided by the <span +class="ecss-1000">glossaries</span> +package that allow you to adjust the <span +class="ectt-1000">xindy</span><a + id="dx1-29004"></a> style file (<span +class="ectt-1000">.xdy</span><a + id="dx1-29005"></a>) and parameters. +</p><!--l. 2987--><p class="indent" > To assist writing information to the <span +class="ectt-1000">xindy</span><a + id="dx1-29006"></a> style file, the <span +class="ecss-1000">glossaries </span>package provides +the following commands: +</p><!--l. 2990--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsopenbrace</span><span +class="ectt-0900"> </span></span><a + id="dx1-29007"></a><span +class="ectt-1000">\glsopenbrace </span></div><hr> +</p><!--l. 2992--><p class="noindent" > +</p><!--l. 2993--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsclosebrace</span><span +class="ectt-0900"> </span></span><a + id="dx1-29008"></a><span +class="ectt-1000">\glsclosebrace </span></div><hr> +</p><!--l. 2995--><p class="noindent" > +which produce an open and closing brace. (This is needed because <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\{</span></span></span> and <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\}</span></span></span> don’t +expand to a simple brace character when written to a file.) +</p><!--l. 3000--><p class="indent" > In addition, if you are using a package that makes the double quote character active +(e.g. <span +class="ecss-1000">ngerman</span><a + id="dx1-29009"></a>) you can use: +</p><!--l. 3002--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsquote</span><span +class="ectt-0900"> </span></span><a + id="dx1-29010"></a><span +class="ectt-1000">\glsquote{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3004--><p class="noindent" > +which will produce <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">"</span></span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">"</span></span></span>. Alternatively, you can use <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\string"</span></span></span> to write the +double-quote character. This document assumes that the double quote character has +not been made active, so the examples just use <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">"</span></span></span> for clarity. +</p><!--l. 3010--><p class="indent" > If you want greater control over the <span +class="ectt-1000">xindy</span><a + id="dx1-29011"></a> style file than is available through the +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> commands provided by the <span +class="ecss-1000">glossaries </span>package, you will need to edit the <span +class="ectt-1000">xindy</span><a + id="dx1-29012"></a> +style file. In which case, you must use <span +class="ectt-1000">\noist</span><a + id="dx1-29013"></a> to prevent the style file from being +overwritten by the <span +class="ecss-1000">glossaries </span>package. For additional information about <span +class="ectt-1000">xindy</span><a + id="dx1-29014"></a>, read the +<span +class="ectt-1000">xindy</span><a + id="dx1-29015"></a> documentation. +</p> +<!--l. 3018--><p class="noindent" ><a +href="#top">Top</a> +</p><!--l. 3018--><p class="noindent" ><span class="paragraphHead"><a + id="x1-300002.8.2"></a><span +class="ecbx-1000">Language and Encodings</span></span> + When you use <span +class="ectt-1000">xindy</span><a + id="dx1-30001"></a>, you need to specify the language and encoding used +(unless you have written your own custom <span +class="ectt-1000">xindy</span><a + id="dx1-30002"></a> style file that defines the +relevant alphabet and sort rules). If you use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-30003"></a>, this information is +obtained from the document’s auxiliary (<span +class="ectt-1000">.aux</span><a + id="dx1-30004"></a>) file. The <span +class="ecss-1000">glossaries </span>package +attempts to find the root language, but in the event that it gets it wrong or +if <span +class="ectt-1000">xindy</span><a + id="dx1-30005"></a> doesn’t support that language, then you can specify the language +using: +</p><!--l. 3028--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsSetXdyLanguage</span><span +class="ectt-0900"> </span></span><a + id="dx1-30006"></a><span +class="ectt-1000">\GlsSetXdyLanguage[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</div><hr> + + + +</p><!--l. 3030--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">language</span><span +class="cmsy-10">⟩ </span>is the name of the language. The optional argument can be used if +you have multiple glossaries in different languages. If <span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary type</span><span +class="cmsy-10">⟩ </span>is omitted, it will +be applied to all glossaries, otherwise the language setting will only be applied to the +glossary given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary type</span><span +class="cmsy-10">⟩</span>. +</p><!--l. 3038--><p class="indent" > If the <span +class="ecss-1000">inputenc</span><a + id="dx1-30007"></a> package is used, the encoding will be obtained from the +value of <span +class="ectt-1000">\inputencodingname</span><a + id="dx1-30008"></a>. Alternatively, you can specify the encoding +using: +</p><!--l. 3041--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsSetXdyCodePage</span><span +class="ectt-0900"> </span></span><a + id="dx1-30009"></a><span +class="ectt-1000">\GlsSetXdyCodePage{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3043--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩ </span>is the name of the encoding. For example: + + + +</p> + <div class="verbatim" id="verbatim-81"> \GlsSetXdyCodePage{utf8} -</PRE> - -<P> -Note that you can also specify the language and encoding using -the package option -<code>xindy={language=</code><I>lang</I><code>,codepage=</code><I>code</I><code>}</code>. -For example: -<PRE> +</div> +<!--l. 3047--><p class="nopar" > +</p><!--l. 3049--><p class="indent" > Note that you can also specify the language and encoding using the package option +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">xindy={language=</span></span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">lang</span><span +class="cmsy-10">⟩</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">,codepage=</span></span></span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">code</span><span +class="cmsy-10">⟩</span><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">}</span></span></span>. For example: + + + +</p> + <div class="verbatim" id="verbatim-82"> \usepackage[xindy={language=english,codepage=utf8}]{glossaries} -</PRE> - -<P> -If you write your own custom <TT>xindy</TT><A NAME="7080"></A> style file that -includes the language settings, you need to set the language -to nothing: -<PRE> +</div> +<!--l. 3055--><p class="nopar" > +</p><!--l. 3057--><p class="indent" > If you write your own custom <span +class="ectt-1000">xindy</span><a + id="dx1-30010"></a> style file that includes the language settings, +you need to set the language to nothing: + + + +</p> + <div class="verbatim" id="verbatim-83"> \GlsSetXdyLanguage{} -</PRE> -(and remember to use <TT>\noist</TT><A NAME="7083"></A> to prevent the style file from -being overwritten). - -<P> -The commands <TT>\GlsSetXdyLanguage</TT> and <TT>\GlsSetXdyCodePage</TT> -have no effect if you don't use <TT>makeglossaries</TT><A NAME="7086"></A>. If -you call <TT>xindy</TT><A NAME="7089"></A> without <TT>makeglossaries</TT><A NAME="7092"></A> you -need to remember to set the language and encoding using the -<TT>-L</TT> and <TT>-C</TT> switches. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H4><A NAME="SECTION00038220000000000000"> -Locations and Number lists</A> -</H4> - -<P> -The most likely attributes used in the <TT>format</TT><A NAME="7098"></A> -key (<TT>textrm</TT><A NAME="7101"></A>, <TT>hyperrm</TT><A NAME="7104"></A> etc) are automatically added -to the <TT>xindy</TT><A NAME="7107"></A> style file, but if you want to use another -attribute, you need to add it using: - -<P> -<TT>\GlsAddXdyAttribute{</TT><EM>name</EM><TT>}</TT> -<P> -where <I>name</I> is the name of the attribute, as used in -the <TT>format</TT><A NAME="7110"></A> key. For example, suppose I want a -bold, italic, hyperlinked location. I first need to define a -command that will do this: -<PRE> +</div> +<!--l. 3062--><p class="nopar" > (and remember to use <span +class="ectt-1000">\noist</span><a + id="dx1-30011"></a> to prevent the style file from being overwritten). +</p><!--l. 3066--><p class="indent" > <div class="important" title="Important Note"> The commands <span +class="ectt-1000">\GlsSetXdyLanguage </span>and <span +class="ectt-1000">\GlsSetXdyCodePage </span>have no effect if +you don’t use <span +class="ectt-1000">makeglossaries</span><a + id="dx1-30012"></a>. If you call <span +class="ectt-1000">xindy</span><a + id="dx1-30013"></a> without <span +class="ectt-1000">makeglossaries</span><a + id="dx1-30014"></a> you need to +remember to set the language and encoding using the <span +class="ectt-1000">-L </span>and <span +class="ectt-1000">-C </span>switches. +</div> +</p><!--l. 3072--><p class="noindent" > +</p> +<!--l. 3075--><p class="noindent" ><a +href="#top">Top</a> +</p><!--l. 3075--><p class="noindent" ><span class="paragraphHead"><a + id="x1-310002.8.2"></a><span +class="ecbx-1000">Locations and Number lists</span></span> + The most likely attributes used in the <span +class="ecss-1000">format</span><a + id="dx1-31001"></a> key (<span +class="ectt-1000">textrm</span><a + id="dx1-31002"></a>, <span +class="ectt-1000">hyperrm</span><a + id="dx1-31003"></a> etc) are +automatically added to the <span +class="ectt-1000">xindy</span><a + id="dx1-31004"></a> style file, but if you want to use another attribute, +you need to add it using: +</p><!--l. 3081--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsAddXdyAttribute</span><span +class="ectt-0900"> </span></span><a + id="dx1-31005"></a><span +class="ectt-1000">\GlsAddXdyAttribute{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3083--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the name of the attribute, as used in the <span +class="ecss-1000">format</span><a + id="dx1-31006"></a> key. For example, +suppose I want a bold, italic, hyperlinked location. I first need to define a command +that will do this: + + + +</p> + <div class="verbatim" id="verbatim-84"> \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} -</PRE> -but with <TT>xindy</TT><A NAME="7113"></A>, I also need to add this as an allowed -attribute: -<PRE> +</div> +<!--l. 3090--><p class="nopar" > but with <span +class="ectt-1000">xindy</span><a + id="dx1-31007"></a>, I also need to add this as an allowed attribute: + + + +</p> + <div class="verbatim" id="verbatim-85"> \GlsAddXdyAttribute{hyperbfit} -</PRE> - -<P> -Note that <TT>\GlsAddXdyAttribute</TT> has no effect if <TT>\noist</TT><A NAME="7116"></A> is -used or if <TT>\makeglossaries</TT><A NAME="7119"></A> is omitted. - -<P> -<TT>\GlsAddXdyAttribute</TT> must be used before <TT>\makeglossaries</TT><A NAME="7122"></A>. - -<P> -If the location numbers don't get expanded to a simple Arabic or -Roman number or a letter from a, ..., z or A, ..., Z, then -you need to add a location style in the appropriate format. +</div> +<!--l. 3095--><p class="nopar" > +</p><!--l. 3097--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsAddXdyAttribute </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-31008"></a> is used or if +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31009"></a> is omitted. +</p><!--l. 3101--><p class="indent" > <span +class="ectt-1000">\GlsAddXdyAttribute </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31010"></a>. </div> +</p><!--l. 3102--><p class="noindent" > +</p><!--l. 3104--><p class="indent" > If the location numbers don’t get expanded to a simple Arabic or Roman number or +a letter from a, …, z or A, …, Z, then you need to add a location style in the appropriate +format. +</p><!--l. 3108--><p class="indent" > For example, suppose you want the page numbers written as words rather than +digits and you use the <span +class="ecss-1000">fmtcount</span><a + id="dx1-31011"></a> package to do this. You can redefine <span +class="ectt-1000">\thepage</span><a + id="dx1-31012"></a> as +follows: + -<P> -For example, suppose you want the page numbers written as words -rather than digits and you use the <TT>fmtcount</TT><A NAME="7125"></A> package to -do this. You can redefine <TT>\thepage</TT><A NAME="7128"></A> as follows: -<PRE> + +</p> + <div class="verbatim" id="verbatim-86"> \renewcommand*{\thepage}{\Numberstring{page}} -</PRE> -This gets expanded to <code>\protect \Numberstringnum </code><TT>{</TT><EM>n</EM><TT>}</TT> -where <I>n</I> is the Arabic page number. This means that you need to -define a new location that has that form: -<PRE> -\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space - \string\Numberstringnum\space\glsopenbrace" - "arabic-numbers" :sep "\glsclosebrace"} -</PRE> -Note that it's necessary to use <TT>\space</TT> to indicate that -spaces also appear in the format, since, unlike T<SMALL>E</SMALL>X, -<TT>xindy</TT><A NAME="7131"></A> doesn't ignore spaces after control sequences. - -<P> -Note that <TT>\GlsAddXdyLocation</TT> has no effect if <TT>\noist</TT><A NAME="7134"></A> is -used or if <TT>\makeglossaries</TT><A NAME="7137"></A> is omitted. - -<P> -<TT>\GlsAddXdyLocation</TT> must be used before <TT>\makeglossaries</TT><A NAME="7140"></A>. - -<P> -In the number list<A NAME="7142"></A>, the locations are sorted according to -type. The default ordering is: -<TT>roman-page-numbers</TT> (e.g. i), -<TT>arabic-page-numbers</TT> (e.g. 1), -<TT>arabic-section-numbers</TT> (e.g. 1.1 if the compositor -is a full stop or 1-1 if the compositor is a hyphen<A NAME="tex2html26" - HREF="#foot4479"><SUP>8</SUP></A>), -<TT>alpha-page-numbers</TT> (e.g. a), -<TT>Roman-page-numbers</TT> (e.g. I), -<TT>Alpha-page-numbers</TT> (e.g. A), -<TT>Appendix-page-numbers</TT> (e.g. A.1 if the Alpha compositor -is a full stop or A-1 if the Alpha compositor is a -hyphen<A NAME="tex2html27" - HREF="#foot4480"><SUP>9</SUP></A>), -user defined location names (as specified by -<TT>\GlsAddXdyLocation</TT><A NAME="7150"></A> in the order in which they were defined), -<TT>see</TT> (cross-referenced entries). -This ordering can be changed using: - -<P> -<TT>\GlsSetXdyLocationClassOrder{</TT><EM>location names</EM><TT>}</TT> -<P> -where each location name is delimited by double quote marks and -separated by white space. -For example: -<PRE> +</div> +<!--l. 3113--><p class="nopar" > This gets expanded to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\protect</span><span +class="ectt-1000"> \Numberstringnum</span><span +class="ectt-1000"> </span></span></span><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">n</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span>where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">n</span><span +class="cmsy-10">⟩ </span>is the Arabic +page number. This means that you need to define a new location that has that +form: + + + +</p> + <div class="verbatim" id="verbatim-87"> +\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space + <br />  \string\Numberstringnum\space\glsopenbrace" + <br />  "arabic-numbers" :sep "\glsclosebrace"} +</div> +<!--l. 3121--><p class="nopar" > Note that it’s necessary to use <span +class="ectt-1000">\space </span>to indicate that spaces also appear +in the format, since, unlike <span class="TEX">T<span +class="E">E</span>X</span>, <span +class="ectt-1000">xindy</span><a + id="dx1-31013"></a> doesn’t ignore spaces after control +sequences. +</p><!--l. 3126--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsAddXdyLocation </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-31014"></a> is used or if <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31015"></a> +is omitted. +</p><!--l. 3130--><p class="indent" > <span +class="ectt-1000">\GlsAddXdyLocation </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31016"></a>. </div> +</p><!--l. 3131--><p class="noindent" > +</p><!--l. 3133--><p class="indent" > In the number list<a + id="dx1-31017"></a>, the locations are sorted according to type. The default ordering is: +<span +class="ectt-1000">roman-page-numbers </span>(e.g. i), <span +class="ectt-1000">arabic-page-numbers </span>(e.g. 1), <span +class="ectt-1000">arabic-section-numbers</span> +(e.g. 1.1 if the compositor is a full stop or 1-1 if the compositor is a +hyphen<span class="footnote-mark"><a +href="#fn7x0" id="fn7x0-bk"><sup class="textsuperscript">7</sup></a></span><a + id="x1-31018f7"></a>), +<span +class="ectt-1000">alpha-page-numbers </span>(e.g. a), <span +class="ectt-1000">Roman-page-numbers </span>(e.g. I), +<span +class="ectt-1000">Alpha-page-numbers </span>(e.g. A), <span +class="ectt-1000">Appendix-page-numbers </span>(e.g. A.1 if +the Alpha compositor is a full stop or A-1 if the Alpha compositor is a +hyphen<span class="footnote-mark"><a +href="#fn8x0" id="fn8x0-bk"><sup class="textsuperscript">8</sup></a></span><a + id="x1-31020f8"></a>), +user defined location names (as specified by <span +class="ectt-1000">\GlsAddXdyLocation</span><a + id="dx1-31022"></a> in the order in which +they were defined), <span +class="ectt-1000">see </span>(cross-referenced entries). This ordering can be changed +using: +</p><!--l. 3148--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsSetXdyLocationClassOrder</span><span +class="ectt-0900"> </span></span><a + id="dx1-31023"></a><span +class="ectt-1000">\GlsSetXdyLocationClassOrder{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">location names</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</div><hr> +</p><!--l. 3150--><p class="noindent" > +where each location name is delimited by double quote marks and separated by white +space. For example: + + + +</p> + <div class="verbatim" id="verbatim-88"> \GlsSetXdyLocationClassOrder{ - "arabic-page-numbers" - "arabic-section-numbers" - "roman-page-numbers" - "Roman-page-numbers" - "alpha-page-numbers" - "Alpha-page-numbers" - "Appendix-page-numbers" - "see" -} -</PRE> - -<P> -Note that <TT>\GlsSetXdyLocationClassOrder</TT> has no effect if -<TT>\noist</TT><A NAME="7153"></A> is used or if <TT>\makeglossaries</TT><A NAME="7156"></A> is omitted. - -<P> -<TT>\GlsSetXdyLocationClassOrder</TT> must be used before -<TT>\makeglossaries</TT><A NAME="7159"></A>. - -<P> -If a number list<A NAME="7161"></A> consists of a sequence of consecutive -numbers, the range will be concatenated. The -number of consecutive locations that causes a range formation + <br />  "arabic-page-numbers" + <br />  "arabic-section-numbers" + <br />  "roman-page-numbers" + <br />  "Roman-page-numbers" + <br />  "alpha-page-numbers" + <br />  "Alpha-page-numbers" + <br />  "Appendix-page-numbers" + <br />  "see" + <br />} +</div> +<!--l. 3164--><p class="nopar" > +</p><!--l. 3166--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsSetXdyLocationClassOrder </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-31024"></a> is used or if +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31025"></a> is omitted. +</p><!--l. 3170--><p class="indent" > <span +class="ectt-1000">\GlsSetXdyLocationClassOrder </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31026"></a>. +</div> +</p><!--l. 3172--><p class="noindent" > +</p><!--l. 3174--><p class="indent" > If a number list<a + id="dx1-31027"></a> consists of a sequence of consecutive numbers, the range will be +concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: - -<P> -<TT>\GlsSetXdyMinRangeLength{</TT><EM>n</EM><TT>}</TT> -<P> +</p><!--l. 3178--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\GlsSetXdyMinRangeLength</span><span +class="ectt-0900"> </span></span><a + id="dx1-31028"></a><span +class="ectt-1000">\GlsSetXdyMinRangeLength{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">n</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3180--><p class="noindent" > For example: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-89"> \GlsSetXdyMinRangeLength{3} -</PRE> -The argument may also be the keyword <TT>none</TT>, to indicate that -there should be no range formations. See the <TT>xindy</TT><A NAME="7163"></A> -manual for further details on range formations. - -<P> -Note that <TT>\GlsSetXdyMinRangeLength</TT> has no effect if <TT>\noist</TT><A NAME="7166"></A> -is used or if <TT>\makeglossaries</TT><A NAME="7169"></A> is omitted. - -<P> -<TT>\GlsSetXdyMinRangeLength</TT> must be used before -<TT>\makeglossaries</TT><A NAME="7172"></A>. - -<P> -See <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A> for -further details. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H4><A NAME="SECTION00038230000000000000"> -Glossary Groups</A> -</H4> -The glossary is divided into groups according to the first -letter of the sort key. The <TT>glossaries</TT> package also adds -a number group by default, unless you suppress it in the -<TT>xindy</TT><A NAME="7184"></A> package option. For example: -<PRE> +</div> +<!--l. 3184--><p class="nopar" > The argument may also be the keyword <span +class="ectt-1000">none</span>, to indicate that there should +be no range formations. See the <span +class="ectt-1000">xindy</span><a + id="dx1-31029"></a> manual for further details on range +formations. +</p><!--l. 3189--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsSetXdyMinRangeLength </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-31030"></a> is used or if +<span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31031"></a> is omitted. +</p><!--l. 3193--><p class="indent" > <span +class="ectt-1000">\GlsSetXdyMinRangeLength </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-31032"></a>. </div> +</p><!--l. 3195--><p class="noindent" > +</p><!--l. 3197--><p class="indent" > See <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further details. +</p> +<!--l. 3200--><p class="noindent" ><a +href="#top">Top</a> +</p><!--l. 3200--><p class="noindent" ><span class="paragraphHead"><a + id="x1-320002.8.2"></a><span +class="ecbx-1000">Glossary Groups</span></span> + The glossary is divided into groups according to the first letter of the sort key. The +<span +class="ecss-1000">glossaries </span>package also adds a number group by default, unless you suppress it in the +<span +class="ecss-1000">xindy</span><a + id="dx1-32001"></a> package option. For example: + + + +</p> + <div class="verbatim" id="verbatim-90"> \usepackage[xindy={glsnumbers=false}]{glossaries} -</PRE> -Any entry that doesn't go in one of the letter groups or the -number group is placed in the default group. - -<P> -If you have a number group, the default behaviour is to locate -it before the "A" letter group. If you are not using a -Roman alphabet, you can change this using -<BR> -<BR><TT>\GlsSetXdyFirstLetterAfterDigits{</TT><EM>letter</EM><TT>}</TT> - -<P> -Note that <TT>\GlsSetXdyFirstLetterAfterDigits</TT> has no effect if -<TT>\noist</TT><A NAME="7188"></A> is used or if <TT>\makeglossaries</TT><A NAME="7191"></A> is omitted. - -<P> -<TT>\GlsSetXdyFirstLetterAfterDigits</TT> must be used before -<TT>\makeglossaries</TT><A NAME="7194"></A>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION00039000000000000000"></A> -<A NAME="sec:newglossary"></A> -<BR> -Defining New Glossaries -</H2> - -<P> -A new glossary can be defined using: - -<P> -<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> -<P> -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="7199"></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="7201"></A> or <TT>xindy</TT><A NAME="7204"></A> transcript file (this -information is only used by <TT>makeglossaries</TT><A NAME="7207"></A> which picks up -the information from the auxiliary file). - -<P> -Note that the main (default) glossary is automatically created as: -<PRE> +</div> +<!--l. 3207--><p class="nopar" > Any entry that doesn’t go in one of the letter groups or the number group is placed in +the default group. +</p><!--l. 3211--><p class="indent" > If you have a number group, the default behaviour is to locate it before the “A” +letter group. If you are not using a Roman alphabet, you can change this +using<br +class="newline" /> <span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">letter</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> +</p><!--l. 3216--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits </span>has no effect if <span +class="ectt-1000">\noist</span><a + id="dx1-32002"></a> is used or +if <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-32003"></a> is omitted. +</p><!--l. 3220--><p class="indent" > <span +class="ectt-1000">\GlsSetXdyFirstLetterAfterDigits </span>must be used before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-32004"></a>. +</div> +</p><!--l. 3222--><p class="noindent" > +</p><!--l. 3225--><p class="noindent" > +</p> +<!--l. 3225--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.9 </span> <a + id="x1-330002.9"></a>Defining New Glossaries</h4> +<!--l. 3228--><p class="noindent" >A new glossary can be defined using: +</p><!--l. 3229--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\newglossary</span><span +class="ectt-0900"> </span></span><a + id="dx1-33001"></a><span +class="ectt-1000">\newglossary[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">log-ext</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">in-ext</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">out-ext</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">title</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]</span> +</div><hr> +</p><!--l. 3231--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the label to assign to this glossary. The arguments <span +class="cmsy-10">⟨</span><span +class="ecti-1000">in-ext</span><span +class="cmsy-10">⟩ </span>and +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">out-ext</span><span +class="cmsy-10">⟩ </span>specify the extensions to give to the input and output files for that +glossary, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">title</span><span +class="cmsy-10">⟩ </span>is the default title for this new glossary and the final optional +argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter</span><span +class="cmsy-10">⟩ </span>specifies which counter to use for the associated number +lists<a + id="dx1-33002"></a> (see also <a +href="#x1-200002.3">§2.3 </a><a +href="#x1-200002.3">Number lists<!--tex4ht:ref: sec:numberlists --></a>). The first optional argument specifies the +extension for the <span +class="ectt-1000">makeindex</span><a + id="dx1-33003"></a> or <span +class="ectt-1000">xindy</span><a + id="dx1-33004"></a> transcript file (this information is only +used by <span +class="ectt-1000">makeglossaries</span><a + id="dx1-33005"></a> which picks up the information from the auxiliary +file). +</p><!--l. 3243--><p class="indent" > Note that the main (default) glossary is automatically created as: + + + +</p> + <div class="verbatim" id="verbatim-91"> \newglossary{main}{gls}{glo}{\glossaryname} -</PRE> -so it can be identified by the label <TT>main</TT> (unless the -<TT>nomain</TT><A NAME="7215"></A> package option is used). Using the -<TT>acronym</TT><A NAME="7224"></A> package option is equivalent to: -<PRE> +</div> +<!--l. 3246--><p class="nopar" > so it can be identified by the label <span +class="ectt-1000">main </span>(unless the <span +class="ecss-1000">nomain</span><a + id="dx1-33006"></a> package option is used). +Using the <span +class="ecss-1000">acronym</span><a + id="dx1-33007"></a> package option is equivalent to: + + + +</p> + <div class="verbatim" id="verbatim-92"> \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="7233"></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="7242"></A> option has been used, -otherwise it is set to <TT>main</TT>. Note that if you are using -the main glossary as your list of acronyms, you need to declare -it as a list of acronyms using the package option -<TT>acronymlists</TT><A NAME="7251"></A>. - -<P> -All glossaries must be defined before <TT>\makeglossaries</TT><A NAME="7255"></A> to -ensure that the relevant output files are opened. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION000310000000000000000"></A> -<A NAME="sec:acronyms"></A> -<BR> -Acronyms -</H2> - -<P> -You may have noticed in <A HREF="glossaries-manual.html#sec:newglosentry">Defining Glossary Entries</A> that when you -specify a new entry, you can specify alternate text to use when -the term is first used<A NAME="7260"></A> in the document. This provides a useful -means to define acronyms. For convenience, the <TT>glossaries</TT> package +</div> +<!--l. 3252--><p class="nopar" > so it can be identified by the label <span +class="ectt-1000">acronym</span>. If you are not sure whether the <span +class="ecss-1000">acronym</span><a + id="dx1-33008"></a> +option has been used, you can identify the list of acronyms by the command +<span class="marginpar"><span +class="ectt-0900">\acronymtype</span><span +class="ectt-0900"> </span></span><a + id="dx1-33009"></a><span +class="ectt-1000">\acronymtype </span>which is set to <span +class="ectt-1000">acronym</span>, if the <span +class="ecss-1000">acronym</span><a + id="dx1-33010"></a> option has been +used, otherwise it is set to <span +class="ectt-1000">main</span>. Note that if you are using the main glossary as your +list of acronyms, you need to declare it as a list of acronyms using the package option +<span +class="ecss-1000">acronymlists</span><a + id="dx1-33011"></a>. +</p><!--l. 3263--><p class="indent" > <div class="important" title="Important Note"> All glossaries must be defined before <span +class="ectt-1000">\makeglossaries</span><a + id="dx1-33012"></a> to ensure that the relevant +output files are opened. </div> +</p><!--l. 3266--><p class="noindent" > +</p><!--l. 3269--><p class="noindent" > +</p> +<!--l. 3269--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.10 </span> <a + id="x1-340002.10"></a>Acronyms</h4> +<!--l. 3272--><p class="noindent" >You may have noticed in <a +href="#x1-140002.2">§2.2 </a><a +href="#x1-140002.2">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that when you specify a new +entry, you can specify alternate text to use when the term is first used<a + id="dx1-34001"></a> in the document. +This provides a useful means to define acronyms. For convenience, the <span +class="ecss-1000">glossaries </span>package defines the command: - -<P> -<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> -<P> -By default, this is equivalent to: -<P> -<TT> -<TT>\newglossaryentry</TT></TT> <TT>{</TT><EM>label</EM><TT>}{type=<TT>\acronymtype</TT><A NAME="7263"></A>, -<BR> -name=</TT> <TT>{</TT><EM>abbrv</EM><TT>}, -<BR> -description=</TT> <TT>{</TT><EM>long</EM><TT>}, -<BR> -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><TT>\glspluralsuffix</TT>}, -<BR> -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><A NAME="7266"></A> -is the name of the glossary in which the acronyms should appear. If -the <TT>acronym</TT><A NAME="7274"></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. If you want more than one list of acronyms, you must -identify the others using the package options <TT>acronymlists</TT><A NAME="7283"></A>. -This ensures that options such as <TT>footnote</TT><A NAME="7292"></A> and -<TT>smallcaps</TT><A NAME="7301"></A> work for the additional lists of acronyms. - -<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> in the optional argument to -<TT>\newacronym</TT><A NAME="7305"></A>. 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} -</PRE> -This is equivalent to: -<PRE> +</p><!--l. 3277--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\newacronym</span><span +class="ectt-0900"> </span></span><a + id="dx1-34002"></a><span +class="ectt-1000">\newacronym[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3280--><p class="noindent" > +By default, this is equivalent to: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\newglossaryentry{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{type=\acronymtype</span><a + id="dx1-34003"></a><span +class="ectt-1000">,</span> + <br /><span +class="ectt-1000">name={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">},</span> + <br /><span +class="ectt-1000">description={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">},</span> + <br /><span +class="ectt-1000">text={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">},</span> + <br /><span +class="ectt-1000">first={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span><span +class="ectt-1000">(</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">)},</span> + <br /><span +class="ectt-1000">plural={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">\glspluralsuffix},</span> + <br /><span +class="ectt-1000">firstplural={</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">\glspluralsuffix\space (</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">\glspluralsuffix)},</span> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> + <br /><spacer type=vertical size=10></span> +As mentioned in the previous section, the command <span +class="ectt-1000">\acronymtype</span><a + id="dx1-34004"></a> is the name of the +glossary in which the acronyms should appear. If the <span +class="ecss-1000">acronym</span><a + id="dx1-34005"></a> package option has been +used, this will be <span +class="ectt-1000">acronym</span>, otherwise it will be <span +class="ectt-1000">main</span>. The acronyms can then be used in +exactly the same way as any other glossary entry. If you want more than one list of +acronyms, you must identify the others using the package options <span +class="ecss-1000">acronymlists</span><a + id="dx1-34006"></a>. This +ensures that options such as <span +class="ecss-1000">footnote</span><a + id="dx1-34007"></a> and <span +class="ecss-1000">smallcaps</span><a + id="dx1-34008"></a> work for the additional lists of +acronyms. + + + +</p><!--l. 3302--><p class="indent" > <div class="important" title="Important Note"><span +class="ecbx-1000">Note: </span>since <span +class="ectt-1000">\newacronym </span>sets <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">type=\acronymtype</span></span></span>, if you want to load a file +containing acronym definitions using <span +class="ectt-1000">\loadglsentries[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">filename</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>, the +optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩ </span>will not have an effect unless you explicitly set the type as +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">type=\glsdefaulttype</span></span></span> in the optional argument to <span +class="ectt-1000">\newacronym</span><a + id="dx1-34009"></a>. See <a +href="#x1-190002.2.3">§2.2.3 </a><a +href="#x1-190002.2.3">Loading +Entries From a File<!--tex4ht:ref: sec:loadglsentries --></a>. </div> +</p><!--l. 3309--><p class="noindent" > +</p><!--l. 3311--><p class="indent" > For example, the following defines the acronym IDN: + + + +</p> + <div class="verbatim" id="verbatim-93"> +\newacronym{idn}{IDN}{identification number} +</div> +<!--l. 3314--><p class="nopar" > This is equivalent to: + + + +</p> + <div class="verbatim" id="verbatim-94"> \newglossaryentry{idn}{type=\acronymtype, -name={IDN}, -description={identification number}, -text={IDN}, -first={identification number (IDN)}, -plural={IDNs}, -firstplural={identification numbers (IDNs)}} -</PRE> -so <code>\gls{idn}</code> will produce "identification number (IDN)" on -first use<A NAME="7307"></A> and "IDN" on subsequent uses. - -<P> -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="7314"></A>, <TT>smaller</TT><A NAME="7323"></A>, -<TT>description</TT><A NAME="7332"></A>, <TT>dua</TT><A NAME="7341"></A> and <TT>footnote</TT><A NAME="7350"></A>, as these -options change the definition of <TT>\newacronym</TT><A NAME="7354"></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 package option <TT>shortcuts</TT><A NAME="7362"></A> -and the new commands described in this section, -such as <TT>\acrshort</TT>, as they vary according to the definition of -<TT>\newacronym</TT><A NAME="7366"></A>. - -<P> -If you use any of the package options <TT>smallcaps</TT><A NAME="7374"></A>, -<TT>smaller</TT><A NAME="7383"></A>, <TT>description</TT><A NAME="7392"></A> or -<TT>footnote</TT><A NAME="7401"></A>, the acronyms will be displayed in the document -using: - -<P> -<TT>\acronymfont{</TT><EM>text</EM><TT>}</TT> -<P> + <br />name={IDN}, + <br />description={identification number}, + <br />text={IDN}, + <br />first={identification number (IDN)}, + <br />plural={IDNs}, + <br />firstplural={identification numbers (IDNs)}} +</div> +<!--l. 3324--><p class="nopar" > so <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{idn}</span></span></span> will produce “identification number (IDN)” on first use<a + id="dx1-34010"></a> and “IDN” on +subsequent uses. +</p><!--l. 3328--><p class="indent" > This section describes acronyms that have been defined using <span +class="ectt-1000">\newacronym</span><a + id="dx1-34011"></a>. +If you prefer to define your acronyms using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-34012"></a> explicitly, +then you should skip this section and ignore the package options: <span +class="ecss-1000">smallcaps</span><a + id="dx1-34013"></a>, +<span +class="ecss-1000">smaller</span><a + id="dx1-34014"></a>, <span +class="ecss-1000">description</span><a + id="dx1-34015"></a>, <span +class="ecss-1000">dua</span><a + id="dx1-34016"></a> and <span +class="ecss-1000">footnote</span><a + id="dx1-34017"></a>, as these options change the definition of +<span +class="ectt-1000">\newacronym</span><a + id="dx1-34018"></a> for common acronym formats as well as the way that the link text +is displayed (see <a +href="#x1-220002.4.1">§2.4.1 </a><a +href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). Likewise you +should ignore the package option <span +class="ecss-1000">shortcuts</span><a + id="dx1-34019"></a> and the new commands described in +this section, such as <span +class="ectt-1000">\acrshort</span><a + id="dx1-34020"></a>, as they vary according to the definition of +<span +class="ectt-1000">\newacronym</span><a + id="dx1-34021"></a>. +</p><!--l. 3340--><p class="indent" > If you want to define your own custom acronym style, see <a +href="#x1-350002.10.1">§2.10.1 </a><a +href="#x1-350002.10.1">Defining A +Custom Acronym Style<!--tex4ht:ref: sec:customacronym --></a>. +</p><!--l. 3343--><p class="indent" > <div class="important" title="Important Note"> If you try using <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-34022"></a> for entries in a designated list of +acronyms in combination with any of the above named package options you are +likely to get unexpected results such as empty brackets or empty footnotes. +</div> +</p><!--l. 3348--><p class="noindent" > +</p><!--l. 3350--><p class="indent" > If you use any of the package options <span +class="ecss-1000">smallcaps</span><a + id="dx1-34023"></a>, <span +class="ecss-1000">smaller</span><a + id="dx1-34024"></a>, <span +class="ecss-1000">description</span><a + id="dx1-34025"></a> or <span +class="ecss-1000">footnote</span><a + id="dx1-34026"></a>, the +acronyms will be displayed in the document using: +</p><!--l. 3354--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acronymfont</span><span +class="ectt-0900"> </span></span><a + id="dx1-34027"></a><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3356--><p class="noindent" > and +</p><!--l. 3358--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\firstacronymfont</span><span +class="ectt-0900"> </span></span><a + id="dx1-34028"></a><span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3360--><p class="noindent" > +where <span +class="ectt-1000">\firstacronymfont </span>is applied on first use<a + id="dx1-34029"></a> and <span +class="ectt-1000">\acronymfont </span>is applied on +subsequent use. Note that if you don’t use any of the above package options, changing +the definition of <span +class="ectt-1000">\acronymfont </span>or <span +class="ectt-1000">\firstacronymfont </span>will have no effect. In this case, +the recommended route is to use either the <span +class="ecss-1000">smaller</span><a + id="dx1-34030"></a> or the <span +class="ecss-1000">smallcaps</span><a + id="dx1-34031"></a> package option and +redefine <span +class="ectt-1000">\acronymfont </span>and <span +class="ectt-1000">\firstacronymfont </span>as required. (The <span +class="ecss-1000">smallcaps</span><a + id="dx1-34032"></a> option sets +the default plural suffix in an upright font to cancel the effect of <span +class="ectt-1000">\textsc</span>, +whereas <span +class="ecss-1000">smaller</span><a + id="dx1-34033"></a> sets the suffix in the surrounding font.) For example, if you want +acronyms in a normal font on first use and emphasized on subsequent use, + + + +do: + -<P> -<TT>\firstacronymfont{</TT><EM>text</EM><TT>}</TT> -<P> -where <TT>\firstacronymfont</TT> is applied on first use<A NAME="7404"></A> and -<TT>\acronymfont</TT> is applied on subsequent use. Note that if you -don't use any of the above package options, changing the definition -of <TT>\acronymfont</TT> or <TT>\firstacronymfont</TT> will have no effect. In -this case, the recommended route is to use either the -<TT>smaller</TT><A NAME="7411"></A> or the <TT>smallcaps</TT><A NAME="7420"></A> package option and -redefine <TT>\acronymfont</TT> and <TT>\firstacronymfont</TT> as required. -(The <TT>smallcaps</TT><A NAME="7429"></A> option sets the default plural suffix in an -upright font to cancel the effect of <TT>\textsc</TT>, whereas -<TT>smaller</TT><A NAME="7438"></A> sets the suffix in the surrounding font.) -For example, if you want acronyms in a normal font on first use and -emphasized on subsequent use, do: -<PRE> + +</p> + <div class="verbatim" id="verbatim-95"> \usepackage[smaller]{glossaries} -\renewcommand*{\firstacronymfont}[1]{#1} -\renewcommand*{\acronymfont}[1]{\emph{#1}} -</PRE> -(Note that it is for this reason that the <TT>relsize</TT><A NAME="7442"></A> package -is not automatically loaded when selecting the -<TT>smaller</TT><A NAME="7450"></A> package option.) - -<P> -<A HREF="glossaries-manual.html#tab:acronymsettings">Table </A><A HREF="glossaries-manual.html#tab:acronymsettings">4</A> lists the package options that govern -the acronym styles and how the <TT>\newglossaryentry</TT><A NAME="7457"></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="7465"></A> option redefines -<TT>\acronymfont</TT> 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="7474"></A> option redefines <TT>\acronymfont</TT> to use -<TT>\textsmaller</TT>,<A NAME="tex2html28" - HREF="#foot4398"><SUP>10</SUP></A> otherwise <TT>\acronymfont</TT> simply displays its argument in -the surrounding font. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:acronymsettings"></A> -<DIV ALIGN="CENTER"> -<A NAME="4399"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 4:</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="7479"></A> key</TD> -<TD ALIGN="LEFT"><TT>text</TT><A NAME="7482"></A> key</TD> -<TD ALIGN="LEFT"><TT>description</TT><A NAME="7485"></A> key</TD> -<TD ALIGN="LEFT"><TT>symbol</TT><A NAME="7488"></A> key</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="7496"></A>,<TT>footnote</TT><A NAME="7505"></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="7514"></A>,<TT>dua</TT><A NAME="7523"></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="7532"></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="7541"></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="7550"></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="7559"></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="7568"></A></TD> -<TD ALIGN="LEFT"><I>long</I></TD> -<TD ALIGN="LEFT"><I>long</I></TD> -<TD ALIGN="LEFT"><I>long</I></TD> -<TD ALIGN="LEFT"><I>abbrv</I></TD> -</TR> -<TR><TD ALIGN="LEFT">None of the above</TD> -<TD ALIGN="LEFT"><I>long</I> (<I>abbrv</I>)</TD> -<TD ALIGN="LEFT"><I>abbrv</I></TD> -<TD ALIGN="LEFT"><I>long</I></TD> -<TD ALIGN="LEFT"> </TD> -</TR> -</TABLE> -</DIV> -</DIV> -<BR> - -<P> -In case you can't remember which key stores the long or short forms -(or their plurals) the <TT>glossaries</TT> package provides the -commands: - -<UL> -<LI><TT>\glsshortkey</TT> -The key used to store the short form. -</LI> -<LI><TT>\glsshortpluralkey</TT> -The key used to store the plural version of the short form. -</LI> -<LI><TT>\glslongkey</TT> -The key used to store the long form. -</LI> -<LI><TT>\glslongpluralkey</TT> -The key used to store the plural version of the long form. -</LI> -</UL> -These can be used in the optional argument of <TT>\newacronym</TT> -to override the defaults. For example: -<PRE> -\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal -matrix} -</PRE> -If the first use<A NAME="7572"></A> uses the plural form, <code>\glspl{dm}</code> will -display: diagonal matrices (DMs). - -<P> -Each of the package options <TT>smallcaps</TT><A NAME="7579"></A>, <TT>smaller</TT><A NAME="7588"></A>, -<TT>footnote</TT><A NAME="7597"></A>, <TT>dua</TT><A NAME="7606"></A> -and <TT>description</TT><A NAME="7615"></A> use <TT>\defglsdisplay</TT><A NAME="7619"></A> and -<TT>\defglsdisplayfirst</TT><A NAME="7622"></A> (described <A HREF="glossaries-manual.html#sec:glsdisplay">earlier</A>) -to change the way the link text is displayed. This means that these -package options only work for the glossary type given by -<TT>\acronymtype</TT>. If you have multiple lists of acronyms, you -will need to make the appropriate changes for each additional -glossary type. - -<P> -<DL> -<DT><STRONG><TT>description</TT><A NAME="7630"></A>,<TT>footnote</TT><A NAME="7639"></A></STRONG></DT> -<DD> -When these two package options are used together, the first use<A NAME="7642"></A> displays -the entry as: -<BR> -<BR><TT>\firstacronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</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 <I>insert</I> indicates the text supplied in the final -optional argument to <TT>\gls</TT>, <TT>\glspl</TT> or their uppercase -variants. - -<P> -In this case, the long form is stored in the <TT>symbol</TT><A NAME="7644"></A> key. -This means that the long form will not be displayed in the list of -acronyms unless you use a glossary style that displays the entry's -symbol (for example, the <TT>index</TT><A NAME="7647"></A> style). Entries will -be sorted according to the short form. - -<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="7655"></A> option using -<A NAME="7664"></A><A NAME="7671"></A><code>sanitize={description=false,symbol=false}</code>, so -remember to protect fragile commands when defining acronyms. - -<P> -</DD> -<DT><STRONG><TT>dua</TT><A NAME="7678"></A></STRONG></DT> -<DD> -The <TT>dua</TT><A NAME="7687"></A> package option always displays the expanded -form and so may not be used with <TT>footnote</TT><A NAME="7696"></A>, <TT>smaller</TT><A NAME="7705"></A> or -<TT>smallcaps</TT><A NAME="7714"></A>. Both first use<A NAME="7717"></A> 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="7724"></A> package option is also used, the -<TT>name</TT><A NAME="7728"></A> key is set to the long form, otherwise the -<TT>name</TT><A NAME="7731"></A> key is set to the short form and the -<TT>description</TT><A NAME="7734"></A> key is set to the long form. In both -cases the <TT>symbol</TT><A NAME="7737"></A> is set to the short form. Therefore, -if you use the <TT>description</TT><A NAME="7745"></A> package option and you want -the short form to appear in the list of acronyms, you will need -to use a glossary style that displays the entry's symbol (for -example, the <TT>index</TT><A NAME="7749"></A> style). Entries will be sorted -according to the long form if the <TT>description</TT><A NAME="7756"></A> option -is used, otherwise they will be sorted according to the -short form (unless overridden by the <TT>sort</TT><A NAME="7760"></A> key in -the optional argument of <TT>\newacronym</TT><A NAME="7763"></A>). - -<P> -</DD> -<DT><STRONG><TT>description</TT><A NAME="7771"></A></STRONG></DT> -<DD> -This package option displays the entry on first use<A NAME="7774"></A> as: -<BR> -<BR><I>long</I><I>insert</I> (<TT>\firstacronymfont{</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> -Note also that if this package option is used, the <TT>glossaries</TT> -package additionally implements the option -<A NAME="7782"></A><code>sanitize={symbol=false}</code>, so -remember to protect fragile commands when defining acronyms. - -<P> -Note that with this option, you need to specify the description -using the <TT>description</TT><A NAME="7784"></A> key in the optional argument -of <TT>\newacronym</TT><A NAME="7787"></A>. When this option is used without -the <TT>footnote</TT><A NAME="7795"></A> or <TT>dua</TT><A NAME="7804"></A> options, the name field -is specified as - -<P> -<TT>\acrnameformat{</TT><EM>short</EM><TT>}{</TT><EM>long</EM><TT>}</TT> -<P> -This defaults to <TT>\acronymfont</TT><A NAME="7808"></A><TT>{</TT><EM>short</EM><TT>}</TT>, which means that the -long form will not appear in the list of acronyms by default. -To change this, you need to redefine <TT>\acrnameformat</TT><A NAME="7811"></A> as -appropriate. For example, to display the long form followed -by the short form in parentheses do: -<PRE> -\renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})} -</PRE> -Note that even if you redefine <TT>\acrnameformat</TT><A NAME="7814"></A>, the -entries will be sorted according to the short form, unless you -override this using the <TT>sort</TT><A NAME="7817"></A> key in the optional -argument to <TT>\newacronym</TT><A NAME="7820"></A>. - -<P> -</DD> -<DT><STRONG><TT>footnote</TT><A NAME="7828"></A></STRONG></DT> -<DD> -This package option displays the entry on first use<A NAME="7831"></A> as: -<BR> -<BR><TT>\firstacronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</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> -Acronyms will be sorted according to the short form. - -<P> -Note also that if this package option is used, the <TT>glossaries</TT> -package additionally implements the option -<A NAME="7839"></A><code>sanitize={description=false}</code>, so -remember to protect fragile commands when defining acronyms. - -<P> -Note that on first use<A NAME="7840"></A>, it is the long form in the footnote that -links to the relevant glossary entry (where hyperlinks are enabled), -whereas on subsequent use, the acronym links to the relevant -glossary entry. It is possible to change this to make the acronym -on first use<A NAME="7841"></A> have the hyperlink instead of the footnote, but -since the footnote marker will also be a hyperlink, you will -have two hyperlinks in immediate succession. This can be -ambiguous where the hyperlinks are coloured rather than boxed. -The code required to change the first use<A NAME="7842"></A> to make the -acronym a hyperlink is as follows: -<PRE> - \defglsdisplayfirst[\acronymtype]{% - \noexpand\protect\noexpand - \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% - \noexpand\protect\noexpand\footnote{#2}}% -</PRE> -<B>Note</B> that this involves using internal commands -(i.e. commands whose name contains an <code>@</code> character), so -if this code is place in a <TT>.tex</TT> file it needs to be -placed within a <TT>\makeatletter</TT> ... <TT>\makeatother</TT> pair. -(See <A NAME="tex2html31" - HREF="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns"><TT>\@</TT> and <TT>@</TT> in macro names</A> -for further details.) - -<P> -</DD> -<DT><STRONG><TT>smallcaps</TT><A NAME="7849"></A></STRONG></DT> -<DD> -If neither the <TT>footnote</TT><A NAME="7858"></A> nor <TT>description</TT><A NAME="7867"></A> options -have been set, this option displays the entry on first use<A NAME="7870"></A> as: -<BR> -<BR><I>long</I><I>insert</I> (<TT>\firstacronymfont{</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>. - -<P> -Note that since the acronym is displayed using <TT>\textsc</TT><A NAME="7872"></A>, -the short form, <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="7881"></A><code>sanitize={symbol=false}</code>, so -remember to protect fragile commands when defining acronyms. - -<P> -</DD> -<DT><STRONG><TT>smaller</TT><A NAME="7888"></A></STRONG></DT> -<DD> -If neither the <TT>footnote</TT><A NAME="7897"></A> nor <TT>description</TT><A NAME="7906"></A> options -have been set, this option displays the entry on first use<A NAME="7909"></A> as: -<BR> -<BR><I>long</I><I>insert</I> (<TT>\firstacronymfont{</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>\textsmaller{#1}</code>.<A NAME="tex2html32" - HREF="#foot4411"><SUP>11</SUP></A>The entries will be sorted according to the short form. - -<P> -Remember to load a package that defines <TT>\textsmaller</TT><A NAME="7920"></A> (such as -<TT>relsize</TT><A NAME="7923"></A>) if you want to use this option, unless you want -to redefine <TT>\acronymfont</TT><A NAME="7926"></A> to use some other formatting command. - -<P> -Note also that if this package option is used, the <TT>glossaries</TT> -package additionally implements the option -<A NAME="7935"></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="7942"></A>, <TT>smaller</TT><A NAME="7951"></A>, -<TT>footnote</TT><A NAME="7960"></A>, <TT>dua</TT><A NAME="7969"></A> or <TT>description</TT><A NAME="7978"></A> are used, -then on first use<A NAME="7981"></A> the entry is displayed as: -<BR> -<BR><I>long</I> (<I>abbrv</I>)<I>insert</I> -<BR> -<BR> -while subsequent use displays the entry as: -<BR> -<BR><I>abbrv</I><I>insert</I> -<BR> -<BR> -Entries will be sorted according to the short form. -Note that if none of the acronym-related package options are used, -the <TT>sanitize</TT><A NAME="7988"></A> option will not be affected. -</DD> -</DL> - -<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="7992"></A>, so it is possible to use these commands to -print just the long form or just the abbreviation without affecting -the flag that determines whether the entry has been used. However -the keys that store the long and short form vary depending on -the acronym style, so the <TT>glossaries</TT> package provides -commands that are set according to the package options. These are -as follows: - -<P> -<TT>\acrshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -Print the abbreviated version with (if required) a hyperlink to the -relevant entry in the glossary. This is usually equivalent to -<TT>\glstext</TT><A NAME="7996"></A> (or its uppercase variants) but may additionally -put the link text within the argument to <TT>\acronymfont</TT><A NAME="7999"></A>. - -<P> -<TT>\acrlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -Print the long version with (if required) a hyperlink to the -relevant entry in the glossary. This is may be equivalent to -<TT>\glsdesc</TT><A NAME="8002"></A>, <TT>\glssymbol</TT><A NAME="8005"></A> or <TT>\glsfirst</TT><A NAME="8008"></A> (or their uppercase -variants), depending on package options. - -<P> -<TT>\acrfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> - -<P> -<TT>\ACRfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT> -<P> -Print the long version followed by the abbreviation in brackets -with (if required) a hyperlink to the -relevant entry in the glossary. - -<P> -Note that if any of the above commands produce unexpected output -and you haven't used any of the acronym-related package options, -you will need to switch off the sanitization<A NAME="8015"></A>. -For example: -<PRE> + <br />\renewcommand*{\firstacronymfont}[1]{#1} + <br />\renewcommand*{\acronymfont}[1]{\emph{#1}} +</div> +<!--l. 3377--><p class="nopar" > (Note that it is for this reason that the <span +class="ecss-1000">relsize</span><a + id="dx1-34034"></a> package is not automatically loaded +when selecting the <span +class="ecss-1000">smaller</span><a + id="dx1-34035"></a> package option.) +</p><!--l. 3382--><p class="indent" > <a +href="#x1-340405">Table 5</a> lists the package options that govern the acronym styles and how +the <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-34036"></a> keys are used to store <span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span>(the long form) and +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span>(the short form). Note that the <span +class="ecss-1000">smallcaps</span><a + id="dx1-34037"></a> option redefines <span +class="ectt-1000">\acronymfont</span> +so that it sets its argument using <span +class="ectt-1000">\textsc </span>(so you should use lower case +characters in <span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span>) and the <span +class="ecss-1000">smaller</span><a + id="dx1-34038"></a> option redefines <span +class="ectt-1000">\acronymfont </span>to use +<span +class="ectt-1000">\textsmaller</span>,<span class="footnote-mark"><a +href="#fn9x0" id="fn9x0-bk"><sup class="textsuperscript">9</sup></a></span><a + id="x1-34039f9"></a> otherwise +<span +class="ectt-1000">\acronymfont </span>simply displays its argument in the surrounding font. +</p> + <div class="table"> + + + +<!--l. 3394--><p class="indent" > <a + id="x1-340405"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 5: </span><span +class="content">Package options governing <span +class="ectt-1000">\newacronym </span>and how the information is +stored in the keys for <span +class="ectt-1000">\newglossaryentry</span></span></div><!--tex4ht:label?: x1-340405 --> +<div class="center" +> +<!--l. 3398--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-6" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-6-1g"><col +id="TBL-6-1" /><col +id="TBL-6-2" /><col +id="TBL-6-3" /><col +id="TBL-6-4" /><col +id="TBL-6-5" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-6-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-1" +class="td11"><span +class="ecbx-1000">Package Option</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-2" +class="td11"><span +class="ecss-1000">first</span><a + id="dx1-34041"></a> key </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-3" +class="td11"><span +class="ecss-1000">text</span><a + id="dx1-34042"></a> key</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-4" +class="td11"><span +class="ecss-1000">description</span><a + id="dx1-34043"></a> key</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-5" +class="td11"><span +class="ecss-1000">symbol</span><a + id="dx1-34044"></a> key</td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-1" +class="td11"><span +class="ecss-1000">description</span><a + id="dx1-34045"></a>,<span +class="ecss-1000">footnote</span><a + id="dx1-34046"></a></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-4" +class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-1" +class="td11"><span +class="ecss-1000">description</span><a + id="dx1-34047"></a>,<span +class="ecss-1000">dua</span><a + id="dx1-34048"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-4" +class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-1" +class="td11"><span +class="ecss-1000">description</span><a + id="dx1-34049"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-4" +class="td11">user supplied </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-1" +class="td11"><span +class="ecss-1000">footnote</span><a + id="dx1-34050"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-4" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-5" +class="td11"> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-1" +class="td11"><span +class="ecss-1000">smallcaps</span><a + id="dx1-34051"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-4" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-1" +class="td11"><span +class="ecss-1000">smaller</span><a + id="dx1-34052"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-4" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-1" +class="td11"><span +class="ecss-1000">dua</span><a + id="dx1-34053"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-4" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-5" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-6-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-1" +class="td11">None of the above </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-2" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span>)</td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-3" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-4" +class="td11"><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-5" +class="td11"> </td></tr></table> +</div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 3448--><p class="indent" > In case you can’t remember which key stores the long or short forms (or their +plurals) the <span +class="ecss-1000">glossaries </span>package provides the commands: </p> + <ul class="itemize1"> + <li class="itemize"><span class="marginpar"><span +class="ectt-0900">\glsshortkey</span><span +class="ectt-0900"> </span></span><a + id="dx1-34054"></a><span +class="ectt-1000">\glsshortkey </span>The key used to store the short form. + </li> + <li class="itemize"><span class="marginpar"><span +class="ectt-0900">\glsshortpluralkey</span><span +class="ectt-0900"> </span></span><a + id="dx1-34055"></a><span +class="ectt-1000">\glsshortpluralkey </span>The key used to store the plural + version of the short form. + </li> + <li class="itemize"><span class="marginpar"><span +class="ectt-0900">\glslongkey</span><span +class="ectt-0900"> </span></span><a + id="dx1-34056"></a><span +class="ectt-1000">\glslongkey </span>The key used to store the long form. + </li> + <li class="itemize"><span class="marginpar"><span +class="ectt-0900">\glslongpluralkey</span><span +class="ectt-0900"> </span></span><a + id="dx1-34057"></a><span +class="ectt-1000">\glslongpluralkey </span>The key used to store the plural + version of the long form.</li></ul> +<!--l. 3461--><p class="noindent" >These can be used in the optional argument of <span +class="ectt-1000">\newacronym </span>to override the defaults. For +example: + + + +</p> + <div class="verbatim" id="verbatim-96"> +\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal + <br />matrix} +</div> +<!--l. 3466--><p class="nopar" > If the first use<a + id="dx1-34058"></a> uses the plural form, <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspl{dm}</span></span></span> will display: diagonal matrices +(DMs). +</p><!--l. 3470--><p class="indent" > Each of the package options <span +class="ecss-1000">smallcaps</span><a + id="dx1-34059"></a>, <span +class="ecss-1000">smaller</span><a + id="dx1-34060"></a>, <span +class="ecss-1000">footnote</span><a + id="dx1-34061"></a>, <span +class="ecss-1000">dua</span><a + id="dx1-34062"></a> and <span +class="ecss-1000">description</span><a + id="dx1-34063"></a> use +<span +class="ectt-1000">\defglsdisplay</span><a + id="dx1-34064"></a> and <span +class="ectt-1000">\defglsdisplayfirst</span><a + id="dx1-34065"></a> (described in <a +href="#x1-220002.4.1">§2.4.1 </a><a +href="#x1-220002.4.1">Changing the format +of the link text<!--tex4ht:ref: sec:glsdisplay --></a>) to change the way the link text is displayed. This means that these +package options only work for the glossary type given by <span +class="ectt-1000">\acronymtype</span>. If you have +multiple lists of acronyms, you will need to make the appropriate changes for each +additional glossary type. + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">description</span><a + id="dx1-34066"></a><span +class="ecbx-1000">,</span><span +class="ecsx-1000">footnote</span><a + id="dx1-34067"></a> </dt><dd +class="description">When these two package options are used together, the first + use<a + id="dx1-34068"></a> displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">\footnote{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>indicates the text supplied in the final optional argument to <span +class="ectt-1000">\gls</span>, + <span +class="ectt-1000">\glspl </span>or their uppercase variants. + <!--l. 3494--><p class="noindent" >In this case, the long form is stored in the <span +class="ecss-1000">symbol</span><a + id="dx1-34069"></a> key. This means that the long + form will not be displayed in the list of acronyms unless you use a glossary style + that displays the entry’s symbol (for example, the <span +class="ecss-1000">index</span><a + id="dx1-34070"></a> style). Entries will be + sorted according to the short form. + </p><!--l. 3500--><p class="noindent" >Note also that when these two package options are used (in the given order), + the <span +class="ecss-1000">glossaries </span>package additionally implements the <span +class="ecss-1000">sanitize</span><a + id="dx1-34071"></a> option using + <a + id="dx1-34072"></a><a + id="dx1-34073"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">sanitize={description=false,symbol=false}</span></span></span>, so remember to protect fragile + commands when defining acronyms. + </p></dd><dt class="description"> +<span +class="ecsx-1000">dua</span><a + id="dx1-34074"></a> </dt><dd +class="description">The <span +class="ecss-1000">dua</span><a + id="dx1-34075"></a> package option always displays the expanded form and so may not be + used with <span +class="ecss-1000">footnote</span><a + id="dx1-34076"></a>, <span +class="ecss-1000">smaller</span><a + id="dx1-34077"></a> or <span +class="ecss-1000">smallcaps</span><a + id="dx1-34078"></a>. Both first use<a + id="dx1-34079"></a> and subsequent use + displays the entry in the form: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + + + + <!--l. 3515--><p class="noindent" >If the <span +class="ecss-1000">description</span><a + id="dx1-34080"></a> package option is also used, the <span +class="ecss-1000">name</span><a + id="dx1-34081"></a> key is set to the long form, + otherwise the <span +class="ecss-1000">name</span><a + id="dx1-34082"></a> key is set to the short form and the <span +class="ecss-1000">description</span><a + id="dx1-34083"></a> key is set to + the long form. In both cases the <span +class="ecss-1000">symbol</span><a + id="dx1-34084"></a> is set to the short form. Therefore, if you + use the <span +class="ecss-1000">description</span><a + id="dx1-34085"></a> package option and you want the short form to appear in the + list of acronyms, you will need to use a glossary style that displays the entry’s + symbol (for example, the <span +class="ecss-1000">index</span><a + id="dx1-34086"></a> style). Entries will be sorted according to the long + form if the <span +class="ecss-1000">description</span><a + id="dx1-34087"></a> option is used, otherwise they will be sorted according to + the short form (unless overridden by the <span +class="ecss-1000">sort</span><a + id="dx1-34088"></a> key in the optional argument of + <span +class="ectt-1000">\newacronym</span><a + id="dx1-34089"></a>). + </p></dd><dt class="description"> +<span +class="ecsx-1000">description</span><a + id="dx1-34090"></a> </dt><dd +class="description">This package option displays the entry on first use<a + id="dx1-34091"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>(<span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>) + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + Note also that if this package option is used, the <span +class="ecss-1000">glossaries </span>package additionally + implements the option <a + id="dx1-34092"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile + commands when defining acronyms. + <!--l. 3543--><p class="noindent" >Note that with this option, you need to specify the description using the + <span +class="ecss-1000">description</span><a + id="dx1-34093"></a> key in the optional argument of <span +class="ectt-1000">\newacronym</span><a + id="dx1-34094"></a>. When this option is + used without the <span +class="ecss-1000">footnote</span><a + id="dx1-34095"></a> or <span +class="ecss-1000">dua</span><a + id="dx1-34096"></a> options, the name field is specified + as + </p><!--l. 3548--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrnameformat</span><span +class="ectt-0900"> </span></span><a + id="dx1-34097"></a><span +class="ectt-1000">\acrnameformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">short</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 3550--><p class="noindent" > + This defaults to <span +class="ectt-1000">\acronymfont</span><a + id="dx1-34098"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">short</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>, which means that the long form will not + appear in the list of acronyms by default. To change this, you need to redefine + <span +class="ectt-1000">\acrnameformat</span><a + id="dx1-34099"></a> as appropriate. For example, to display the long form followed + by the short form in parentheses do: + + + +</p> + <div class="verbatim" id="verbatim-97"> + \renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})} +</div> + <!--l. 3558--><p class="nopar" > Note that even if you redefine <span +class="ectt-1000">\acrnameformat</span><a + id="dx1-34100"></a>, the entries will be sorted + according to the short form, unless you override this using the <span +class="ecss-1000">sort</span><a + id="dx1-34101"></a> key in the + optional argument to <span +class="ectt-1000">\newacronym</span><a + id="dx1-34102"></a>. + </p></dd><dt class="description"> +<span +class="ecsx-1000">footnote</span><a + id="dx1-34103"></a> </dt><dd +class="description">This package option displays the entry on first use<a + id="dx1-34104"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">\footnote{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span> + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + Acronyms will be sorted according to the short form. + <!--l. 3575--><p class="noindent" >Note also that if this package option is used, the <span +class="ecss-1000">glossaries </span>package additionally + implements the option <a + id="dx1-34105"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">sanitize={description=false}</span></span></span>, so remember to protect + fragile commands when defining acronyms. + </p><!--l. 3580--><p class="noindent" >Note that on first use<a + id="dx1-34106"></a>, it is the long form in the footnote that links to + the relevant glossary entry (where hyperlinks are enabled), whereas on + subsequent use, the acronym links to the relevant glossary entry. It is + possible to change this to make the acronym on first use<a + id="dx1-34107"></a> have the hyperlink + instead of the footnote, but since the footnote marker will also be a + hyperlink, you will have two hyperlinks in immediate succession. This can be + ambiguous where the hyperlinks are coloured rather than boxed. The code + required to change the first use<a + id="dx1-34108"></a> to make the acronym a hyperlink is as + follows: + + + +</p> + <div class="verbatim" id="verbatim-98"> +  \defglsdisplayfirst[\acronymtype]{% +  <br /> \noexpand\protect\noexpand +  <br />    \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% +  <br />    \noexpand\protect\noexpand\footnote{#2}}% +</div> + <!--l. 3594--><p class="nopar" > <span +class="ecbx-1000">Note </span>that this involves using internal commands (i.e. commands whose name + contains an <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">@</span></span></span> character), so if this code is place in a <span +class="ectt-1000">.tex </span>file it needs to be placed + within a <span +class="ectt-1000">\makeatletter </span>… <span +class="ectt-1000">\makeatother </span>pair. (See <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns" ><span +class="ectt-1000">\@ </span>and <span +class="ectt-1000">@ </span>in macro names</a> for + further details.) + </p></dd><dt class="description"> +<span +class="ecsx-1000">smallcaps</span><a + id="dx1-34109"></a> </dt><dd +class="description">If neither the <span +class="ecss-1000">footnote</span><a + id="dx1-34110"></a> nor <span +class="ecss-1000">description</span><a + id="dx1-34111"></a> options have been set, this option + displays the entry on first use<a + id="dx1-34112"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>(<span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>) + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + where <span +class="ectt-1000">\acronymfont </span>is set to <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textsc{#1}</span></span></span>. + <!--l. 3614--><p class="noindent" ><div class="important" title="Important Note"> Note that since the acronym is displayed using <span +class="ectt-1000">\textsc</span><a + id="dx1-34113"></a>, the short form, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span>, + should be specified in lower case. </div> + </p><!--l. 3619--><p class="noindent" > + </p><!--l. 3621--><p class="noindent" >Note also that if this package option is used, the <span +class="ecss-1000">glossaries </span>package additionally + implements the option <a + id="dx1-34114"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile + commands when defining acronyms. + </p></dd><dt class="description"> +<span +class="ecsx-1000">smaller</span><a + id="dx1-34115"></a> </dt><dd +class="description">If neither the <span +class="ecss-1000">footnote</span><a + id="dx1-34116"></a> nor <span +class="ecss-1000">description</span><a + id="dx1-34117"></a> options have been set, this option + displays the entry on first use<a + id="dx1-34118"></a> as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩ </span>(<span +class="ectt-1000">\firstacronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>) + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="ectt-1000">\acronymfont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + where <span +class="ectt-1000">\acronymfont </span>is set to + <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textsmaller{#1}</span></span></span>.<span class="footnote-mark"><a +href="#fn10x0" id="fn10x0-bk"><sup class="textsuperscript">10</sup></a></span><a + id="x1-34119f10"></a> + The entries will be sorted according to the short form. + + + + <!--l. 3642--><p class="noindent" ><div class="important" title="Important Note"> Remember to load a package that defines <span +class="ectt-1000">\textsmaller</span><a + id="dx1-34123"></a> (such as <span +class="ecss-1000">relsize</span><a + id="dx1-34124"></a>) if you + want to use this option, unless you want to redefine <span +class="ectt-1000">\acronymfont</span><a + id="dx1-34125"></a> to use some + other formatting command. </div> + </p><!--l. 3646--><p class="noindent" > + </p><!--l. 3648--><p class="noindent" >Note also that if this package option is used, the <span +class="ecss-1000">glossaries </span>package additionally + implements the option <a + id="dx1-34126"></a><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">sanitize={symbol=false}</span></span></span>, so remember to protect fragile + commands when defining acronyms. + </p></dd><dt class="description"> +<span +class="ecbx-1000">None of the above</span> </dt><dd +class="description">If none of the package options <span +class="ecss-1000">smallcaps</span><a + id="dx1-34127"></a>, <span +class="ecss-1000">smaller</span><a + id="dx1-34128"></a>, <span +class="ecss-1000">footnote</span><a + id="dx1-34129"></a>, + <span +class="ecss-1000">dua</span><a + id="dx1-34130"></a> or <span +class="ecss-1000">description</span><a + id="dx1-34131"></a> are used, then on first use<a + id="dx1-34132"></a> the entry is displayed as: + <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span>)<span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + while subsequent use displays the entry as: <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span> + <br /><spacer type=vertical size=10></span> + Entries will be sorted according to the short form. Note that if none of the + acronym-related package options are used, the <span +class="ecss-1000">sanitize</span><a + id="dx1-34133"></a> option will not be + affected.</dd></dl> +<!--l. 3669--><p class="indent" > Recall from <a +href="#x1-210002.4">§2.4 </a><a +href="#x1-210002.4">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> that you can access the values of +individual keys using commands like <span +class="ectt-1000">\glstext</span><a + id="dx1-34134"></a>, so it is possible to use these commands +to print just the long form or just the abbreviation without affecting the flag that +determines whether the entry has been used. However the keys that store the long and +short form vary depending on the acronym style, so the <span +class="ecss-1000">glossaries </span>package +provides commands that are set according to the package options. These are as +follows: +</p><!--l. 3677--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-34135"></a><span +class="ectt-1000">\acrshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3679--><p class="noindent" > +</p><!--l. 3680--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-34136"></a><span +class="ectt-1000">\ACRshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3682--><p class="noindent" > +</p><!--l. 3683--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRshort</span><span +class="ectt-0900"> </span></span><a + id="dx1-34137"></a><span +class="ectt-1000">\ACRshort[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3685--><p class="noindent" > +Print the abbreviated version with (if required) a hyperlink to the relevant entry in the +glossary. This is usually equivalent to <span +class="ectt-1000">\glstext</span><a + id="dx1-34138"></a> (or its uppercase variants) but may +additionally put the link text within the argument to <span +class="ectt-1000">\acronymfont</span><a + id="dx1-34139"></a>. +</p><!--l. 3690--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrlong</span><span +class="ectt-0900"> </span></span><a + id="dx1-34140"></a><span +class="ectt-1000">\acrlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3692--><p class="noindent" > +</p><!--l. 3693--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrlong</span><span +class="ectt-0900"> </span></span><a + id="dx1-34141"></a><span +class="ectt-1000">\ACRlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> + + + +</p><!--l. 3695--><p class="noindent" > +</p><!--l. 3696--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRlong</span><span +class="ectt-0900"> </span></span><a + id="dx1-34142"></a><span +class="ectt-1000">\ACRlong[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3698--><p class="noindent" > +Print the long version with (if required) a hyperlink to the relevant entry in the +glossary. This is may be equivalent to <span +class="ectt-1000">\glsdesc</span><a + id="dx1-34143"></a>, <span +class="ectt-1000">\glssymbol</span><a + id="dx1-34144"></a> or <span +class="ectt-1000">\glsfirst</span><a + id="dx1-34145"></a> (or their +uppercase variants), depending on package options. +</p><!--l. 3703--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\acrfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-34146"></a><span +class="ectt-1000">\acrfull[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3705--><p class="noindent" > +</p><!--l. 3706--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\Acrfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-34147"></a><span +class="ectt-1000">\ACRfull[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3708--><p class="noindent" > +</p><!--l. 3709--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ACRfull</span><span +class="ectt-0900"> </span></span><a + id="dx1-34148"></a><span +class="ectt-1000">\ACRfull[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">options</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">insert</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 3711--><p class="noindent" > +Print the long version followed by the abbreviation in brackets with (if required) a +hyperlink to the relevant entry in the glossary. +</p><!--l. 3715--><p class="indent" > <div class="important" title="Important Note"> Note that if any of the above commands produce unexpected output and you +haven’t used any of the acronym-related package options, you will need to switch off the +sanitization<a + id="dx1-34149"></a>. For example: + + + +</p> + <div class="verbatim" id="verbatim-99"> \usepackage[sanitize=none]{glossaries} -</PRE> -However, if you do this, you must remember to protect fragile -commands when defining acronyms or glossary entries. - -<P> -Note that if you change the definition of <TT>\newacronym</TT><A NAME="8018"></A>, you -may additionally need to change the above commands as well as -changing the way the text is displayed using <TT>\defglsdisplay</TT><A NAME="8021"></A> -and <TT>\defglsdisplayfirst</TT><A NAME="8024"></A>. - -<P> -The package option <TT>shortcuts</TT><A NAME="8032"></A> provides the synonyms listed -in <A HREF="glossaries-manual.html#tab:shortcuts">table </A><A HREF="glossaries-manual.html#tab:shortcuts">5</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="8044"></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="4415"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 5:</STRONG> -Synonyms provided by the package option <TT>shortcuts</TT><A NAME="8053"></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="8057"></A></TD> -<TD ALIGN="LEFT"><TT>\acrshort</TT><A NAME="8060"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acs</TT><A NAME="8063"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrshort</TT><A NAME="8066"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\acsp</TT><A NAME="8069"></A></TD> -<TD ALIGN="LEFT"><TT>\acrshortpl</TT><A NAME="8072"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acsp</TT><A NAME="8075"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrshortpl</TT><A NAME="8078"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\acl</TT><A NAME="8081"></A></TD> -<TD ALIGN="LEFT"><TT>\acrlong</TT><A NAME="8084"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acl</TT><A NAME="8087"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrlong</TT><A NAME="8090"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\aclp</TT><A NAME="8093"></A></TD> -<TD ALIGN="LEFT"><TT>\acrlongpl</TT><A NAME="8096"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Aclp</TT><A NAME="8099"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrlongpl</TT><A NAME="8102"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\acf</TT><A NAME="8105"></A></TD> -<TD ALIGN="LEFT"><TT>\acrfull</TT><A NAME="8108"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acf</TT><A NAME="8111"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrfull</TT><A NAME="8114"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\acfp</TT><A NAME="8117"></A></TD> -<TD ALIGN="LEFT"><TT>\acrfullpl</TT><A NAME="8120"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acfp</TT><A NAME="8123"></A></TD> -<TD ALIGN="LEFT"><TT>\Acrfullpl</TT><A NAME="8126"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\ac</TT><A NAME="8129"></A></TD> -<TD ALIGN="LEFT"><TT>\gls</TT><A NAME="8132"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Ac</TT><A NAME="8135"></A></TD> -<TD ALIGN="LEFT"><TT>\Gls</TT><A NAME="8138"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\acp</TT><A NAME="8141"></A></TD> -<TD ALIGN="LEFT"><TT>\glspl</TT><A NAME="8144"></A></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\Acp</TT><A NAME="8147"></A></TD> -<TD ALIGN="LEFT"><TT>\Glspl</TT><A NAME="8150"></A></TD> -</TR> -</TABLE> -</DIV> -</DIV> -<BR> - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000310100000000000000"></A> -<A NAME="sec:oldacronym"></A> -<BR> -Upgrading From the glossary Package -</H3> -Users of the obsolete <TT>glossary</TT><A NAME="8156"></A> package may recall that -the syntax used to define new acronyms has changed with the -replacement <TT>glossaries</TT> package. In addition, the old -<TT>glossary</TT><A NAME="8160"></A> package created the command -<TT>\</TT><I>acr-name</I> when defining the acronym <I>acr-name</I>. - -<P> -In order to facilitate migrating from the old package to the new -one, the <TT>glossaries</TT> package<A NAME="tex2html34" - HREF="#foot3348"><SUP>12</SUP></A> +</div> +<!--l. 3722--><p class="nopar" > However, if you do this, you must remember to protect fragile commands when defining +acronyms or glossary entries. </div> +</p><!--l. 3725--><p class="noindent" > +</p><!--l. 3727--><p class="indent" > Note that if you change the definition of <span +class="ectt-1000">\newacronym</span><a + id="dx1-34150"></a>, you may additionally need to +change the above commands as well as changing the way the text is displayed using +<span +class="ectt-1000">\defglsdisplay</span><a + id="dx1-34151"></a> and <span +class="ectt-1000">\defglsdisplayfirst</span><a + id="dx1-34152"></a>. +</p><!--l. 3732--><p class="indent" > The package option <span +class="ecss-1000">shortcuts</span><a + id="dx1-34153"></a> provides the synonyms listed in <a +href="#x1-341556">table 6</a>. If any of +those commands generate an “undefined control sequence” error message, check +that you have enabled the shortcuts using the <span +class="ecss-1000">shortcuts</span><a + id="dx1-34154"></a> package option. Note +that there are no shortcuts for the commands that produce all upper case +text. +</p> + <div class="table"> + + + +<!--l. 3739--><p class="indent" > <a + id="x1-341556"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 6: </span><span +class="content">Synonyms provided by the package option <span +class="ecss-1000">shortcuts</span><a + id="dx1-34156"></a></span></div><!--tex4ht:label?: x1-341556 --> +<div class="center" +> +<!--l. 3742--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-7" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-7-1g"><col +id="TBL-7-1" /><col +id="TBL-7-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-7-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-1" +class="td11"><span +class="ecbx-1000">Shortcut Command</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-7-1-2" +class="td11"><span +class="ecbx-1000">Equivalent Command</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-1" +class="td11"><span +class="ectt-1000">\acs</span><a + id="dx1-34157"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-2" +class="td11"><span +class="ectt-1000">\acrshort</span><a + id="dx1-34158"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-1" +class="td11"><span +class="ectt-1000">\Acs</span><a + id="dx1-34159"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-2" +class="td11"><span +class="ectt-1000">\Acrshort</span><a + id="dx1-34160"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-1" +class="td11"><span +class="ectt-1000">\acsp</span><a + id="dx1-34161"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-2" +class="td11"><span +class="ectt-1000">\acrshortpl</span><a + id="dx1-34162"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-1" +class="td11"><span +class="ectt-1000">\Acsp</span><a + id="dx1-34163"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-2" +class="td11"><span +class="ectt-1000">\Acrshortpl</span><a + id="dx1-34164"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-1" +class="td11"><span +class="ectt-1000">\acl</span><a + id="dx1-34165"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-2" +class="td11"><span +class="ectt-1000">\acrlong</span><a + id="dx1-34166"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-1" +class="td11"><span +class="ectt-1000">\Acl</span><a + id="dx1-34167"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-2" +class="td11"><span +class="ectt-1000">\Acrlong</span><a + id="dx1-34168"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-1" +class="td11"><span +class="ectt-1000">\aclp</span><a + id="dx1-34169"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-2" +class="td11"><span +class="ectt-1000">\acrlongpl</span><a + id="dx1-34170"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-1" +class="td11"><span +class="ectt-1000">\Aclp</span><a + id="dx1-34171"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-2" +class="td11"><span +class="ectt-1000">\Acrlongpl</span><a + id="dx1-34172"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-1" +class="td11"><span +class="ectt-1000">\acf</span><a + id="dx1-34173"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-2" +class="td11"><span +class="ectt-1000">\acrfull</span><a + id="dx1-34174"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-1" +class="td11"><span +class="ectt-1000">\Acf</span><a + id="dx1-34175"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-2" +class="td11"><span +class="ectt-1000">\Acrfull</span><a + id="dx1-34176"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-1" +class="td11"><span +class="ectt-1000">\acfp</span><a + id="dx1-34177"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-2" +class="td11"><span +class="ectt-1000">\acrfullpl</span><a + id="dx1-34178"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-1" +class="td11"><span +class="ectt-1000">\Acfp</span><a + id="dx1-34179"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-2" +class="td11"><span +class="ectt-1000">\Acrfullpl</span><a + id="dx1-34180"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-1" +class="td11"><span +class="ectt-1000">\ac</span><a + id="dx1-34181"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-2" +class="td11"><span +class="ectt-1000">\gls</span><a + id="dx1-34182"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-1" +class="td11"><span +class="ectt-1000">\Ac</span><a + id="dx1-34183"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-2" +class="td11"><span +class="ectt-1000">\Gls</span><a + id="dx1-34184"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-1" +class="td11"><span +class="ectt-1000">\acp</span><a + id="dx1-34185"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-2" +class="td11"><span +class="ectt-1000">\glspl</span><a + id="dx1-34186"></a> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-7-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-1" +class="td11"><span +class="ectt-1000">\Acp</span><a + id="dx1-34187"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-2" +class="td11"><span +class="ectt-1000">\Glspl</span><a + id="dx1-34188"></a> </td></tr></table> +</div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 3765--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.10.1 </span> <a + id="x1-350002.10.1"></a>Defining A Custom Acronym Style</h5> +<!--l. 3768--><p class="noindent" >You may find that the predefined acronyms styles that come with the <span +class="ecss-1000">glossaries </span>package +don’t suit your requirements. In this case you can define your own style. This is done by +redefining the following commands: +</p><!--l. 3772--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\CustomAcronymFields</span><span +class="ectt-0900"> </span></span><a + id="dx1-35001"></a><span +class="ectt-1000">\CustomAcronymFields </span></div><hr> +</p><!--l. 3774--><p class="noindent" > +This command sets up the keys for <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-35002"></a> when you define an acronym +using <span +class="ectt-1000">\newacronym</span><a + id="dx1-35003"></a>. Within the definition of <span +class="ectt-1000">\CustomAcronymFields</span>, you may use +<span +class="ectt-1000">\the\glslongtok</span><a + id="dx1-35004"></a> to access the long form, <span +class="ectt-1000">\the\glsshorttok</span><a + id="dx1-35005"></a> to access the short form +and <span +class="ectt-1000">\the\glslabeltok</span><a + id="dx1-35006"></a> to access the label. This command is typically used to set the +<span +class="ecss-1000">name</span><a + id="dx1-35007"></a>, <span +class="ecss-1000">first</span><a + id="dx1-35008"></a>, <span +class="ecss-1000">firstplural</span><a + id="dx1-35009"></a>, <span +class="ecss-1000">text</span><a + id="dx1-35010"></a> and <span +class="ecss-1000">plural</span><a + id="dx1-35011"></a> keys. It may also be used to set the <span +class="ecss-1000">symbol</span><a + id="dx1-35012"></a> or +<span +class="ecss-1000">description</span><a + id="dx1-35013"></a> keys depending on your requirements. +</p><!--l. 3785--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\SetCustomDisplayStyle</span><span +class="ectt-0900"> </span></span><a + id="dx1-35014"></a><span +class="ectt-1000">\SetCustomDisplayStyle{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3787--><p class="noindent" > +This is used to set up the display style for the glossary given by <span +class="cmsy-10">⟨</span><span +class="ecti-1000">type</span><span +class="cmsy-10">⟩</span>. This should +typically just use <span +class="ectt-1000">\defglsdisplayfirst</span><a + id="dx1-35015"></a> and <span +class="ectt-1000">\defglsdisplay</span><a + id="dx1-35016"></a>. +</p><!--l. 3792--><p class="indent" > Once you have redefined <span +class="ectt-1000">\CustomAcronymFields </span>and <span +class="ectt-1000">\SetCustomDisplayStyle</span>, +you must then switch to this style using +</p><!--l. 3794--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\SetCustomStyle</span><span +class="ectt-0900"> </span></span><a + id="dx1-35017"></a><span +class="ectt-1000">\SetCustomStyle </span></div><hr> +</p><!--l. 3796--><p class="noindent" > +Note that you may still use the <span +class="ecss-1000">shortcuts</span><a + id="dx1-35018"></a> package option with your custom +style. +</p><!--l. 3800--><p class="indent" > <div class="important" title="Important Note"> If you omit <span +class="ectt-1000">\SetCustomStyle</span>, or use it before you redefine <span +class="ectt-1000">\CustomAcronymFields</span> +and <span +class="ectt-1000">\SetCustomDisplayStyle</span>, your new style won’t be correctly implemented. You +must set up the custom style before defining new acronyms. The acronyms must be +defined using <span +class="ectt-1000">\newacronym</span><a + id="dx1-35019"></a> not <span +class="ectt-1000">\newglossaryentry</span><a + id="dx1-35020"></a>. </div> +</p><!--l. 3806--><p class="noindent" > +</p><!--l. 3808--><p class="indent" > As an example, suppose I want my acronym on first use to have the short form in +the text and the long form with the description in a footnote. Suppose also that I want +the short form to be put in small caps in the main body of the document, but I want +it in normal capitals in the list of acronyms. In my list of acronyms, I want +the long form as the name with the short form in brackets followed by the +description. +</p><!--l. 3816--><p class="indent" > First, I need to redefine <span +class="ectt-1000">\CustomAcronymFields</span><a + id="dx1-35021"></a> so that <span +class="ectt-1000">\newacronym</span><a + id="dx1-35022"></a> will correctly +set the <span +class="ecss-1000">name</span><a + id="dx1-35023"></a>, <span +class="ecss-1000">text</span><a + id="dx1-35024"></a> and <span +class="ecss-1000">plural</span><a + id="dx1-35025"></a> keys. I want the long form to be stored in the +<span +class="ecss-1000">name</span><a + id="dx1-35026"></a> and the short form to be stored in <span +class="ecss-1000">text</span><a + id="dx1-35027"></a>. In addition, I’m going to set the +<span +class="ecss-1000">symbol</span><a + id="dx1-35028"></a> to the short form in upper case so that it will appear in the list of +acronyms. + + + +</p> + <div class="verbatim" id="verbatim-100"> +\renewcommand*{\CustomAcronymFields}{% + <br />  name={\the\glslongtok},% + <br />  symbol={\MakeUppercase{\the\glsshorttok}},% + <br />  text={\textsc{\the\glsshorttok}},% + <br />  plural={\textsc{\the\glsshorttok}s}% + <br />} +</div> +<!--l. 3831--><p class="nopar" > +</p><!--l. 3833--><p class="indent" > Note that in this case I haven’t bothered with <span +class="ectt-1000">\acrpluralsuffix</span><a + id="dx1-35029"></a> and have just +inserted an “s”. +</p><!--l. 3836--><p class="indent" > When I use the custom acronym style, the short form is stored in <span +class="ecss-1000">user1</span><a + id="dx1-35030"></a>, +the plural short form is stored in <span +class="ecss-1000">user2</span><a + id="dx1-35031"></a>, the long form is stored in <span +class="ecss-1000">user3</span><a + id="dx1-35032"></a> and +the plural long form is stored in <span +class="ecss-1000">user4</span><a + id="dx1-35033"></a>. So when I use <span +class="ectt-1000">\defglsdisplayfirst</span><a + id="dx1-35034"></a> +and <span +class="ectt-1000">\defglsdisplay</span><a + id="dx1-35035"></a>, I can use <span +class="ectt-1000">\glsentryuseriii</span><a + id="dx1-35036"></a> to access the long form. +Recall from <a +href="#x1-220002.4.1">§2.4.1 </a><a +href="#x1-220002.4.1">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>, that the optional +argument to <span +class="ectt-1000">\defglsdisplayfirst</span><a + id="dx1-35037"></a> and <span +class="ectt-1000">\defglsdisplay</span><a + id="dx1-35038"></a> indicates the glossary +type. This is passed to <span +class="ectt-1000">\SetCustomDisplayStyle</span><a + id="dx1-35039"></a>. The mandatory argument +sets up the definition of <span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-35040"></a> and <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-35041"></a> for the given +glossary, where the first argument corresponds to the <span +class="ecss-1000">first</span><a + id="dx1-35042"></a>, <span +class="ecss-1000">firstplural</span><a + id="dx1-35043"></a>, <span +class="ecss-1000">text</span><a + id="dx1-35044"></a> or +<span +class="ecss-1000">plural</span><a + id="dx1-35045"></a>, as appropriate, the second argument corresponds to the <span +class="ecss-1000">description</span><a + id="dx1-35046"></a>, +the third corresponds to the <span +class="ecss-1000">symbol</span><a + id="dx1-35047"></a> and the fourth argument is the inserted +text. + + + +</p> + <div class="verbatim" id="verbatim-101"> +\renewcommand*{\SetCustomDisplayStyle}[1]{% + <br />  \defglsdisplayfirst[#1]{##1##4\protect\footnote{% + <br />    \glsentryuseriii{\glslabel}: ##2% + <br />  }} + <br />  \defglsdisplay[#1]{##1##4}% + <br />} +</div> +<!--l. 3859--><p class="nopar" > +</p><!--l. 3861--><p class="indent" > Since we have a definition inside a definition, <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">#1</span></span></span> refers to the argument of +<span +class="ectt-1000">\SetCustomDisplayStyle</span><a + id="dx1-35048"></a>, and <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">##1</span></span></span>, …, <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">##4</span></span></span>, refer to the arguments of <span +class="ectt-1000">\glsdisplayfirst</span><a + id="dx1-35049"></a> +and <span +class="ectt-1000">\glsdisplay</span><a + id="dx1-35050"></a>. +</p><!--l. 3866--><p class="indent" > Now that I’ve redefined <span +class="ectt-1000">\CustomAcronymFields</span><a + id="dx1-35051"></a> and <span +class="ectt-1000">\SetCustomDisplayStyle</span><a + id="dx1-35052"></a>, I +can set this style using + + + +</p> + <div class="verbatim" id="verbatim-102"> +\SetCustomStyle +</div> +<!--l. 3870--><p class="nopar" > and now I can define my acronyms: + + + +</p> + <div class="verbatim" id="verbatim-103"> +\newacronym[description={set of tags for use in developing hypertext + <br />documents}]{html}{html}{Hyper Text Markup Language} + <br />\newacronym[description={language used to describe the layout of a + <br />document written in a markup language}]{css}{css}{Cascading Style + <br />Sheet} +</div> +<!--l. 3879--><p class="nopar" > +</p><!--l. 3881--><p class="indent" > Note that since I’ve used the description in the main body of the text, I need to +switch off the sanitization otherwise any commands within the description won’t get +interpreted. Also I want to use the <span +class="ecss-1000">hyperref</span><a + id="dx1-35053"></a> package, but this will cause a problem on +first use as I’ll get nested hyperlinks, so I need to switch off the hyperlinks on first use. +In addition, I want to use a glossary style that displays the symbol. Therefore, in my +preamble I have: + + + +</p> + <div class="verbatim" id="verbatim-104"> +\usepackage[colorlinks]{hyperref} + <br />\usepackage[acronym,         % create list of acronyms + <br />            nomain,          % don’t need main glossary for this example + <br />            style=tree,      % need a style that displays the symbol + <br />            hyperfirst=false,% don’t hyperlink first use + <br />            sanitize=none    % switch off sanitization as description + <br />                             % will be used in the main text + <br />            ]{glossaries} +</div> +<!--l. 3898--><p class="nopar" > +</p><!--l. 3900--><p class="indent" > Note that I haven’t used the <span +class="ecss-1000">description</span><a + id="dx1-35054"></a> or <span +class="ecss-1000">footnote</span><a + id="dx1-35055"></a> package options. +</p><!--l. 3903--><p class="noindent" > +</p> +<!--l. 3903--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.10.2 </span> <a + id="x1-360002.10.2"></a>Upgrading From the glossary Package</h5> +<!--l. 3905--><p class="noindent" >Users of the obsolete <span +class="ecss-1000">glossary</span><a + id="dx1-36001"></a> package may recall that the syntax used to define new +acronyms has changed with the replacement <span +class="ecss-1000">glossaries </span>package. In addition, the old +<span +class="ecss-1000">glossary</span><a + id="dx1-36002"></a> package created the command <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">acr-name</span><span +class="cmsy-10">⟩ </span>when defining the acronym +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">acr-name</span><span +class="cmsy-10">⟩</span>. +</p><!--l. 3911--><p class="indent" > In order to facilitate migrating from the old package to the new one, the <span +class="ecss-1000">glossaries</span> +package<span class="footnote-mark"><a +href="#fn11x0" id="fn11x0-bk"><sup class="textsuperscript">11</sup></a></span><a + id="x1-36003f11"></a> provides the command: - -<P> -<TT>\oldacronym[</TT><EM>label</EM><TT>]{</TT><EM>abbrv</EM><TT>}{</TT><EM>long</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT> -<P> -This uses the same syntax as the <TT>glossary</TT><A NAME="8164"></A> package's -method of defining acronyms. It is equivalent to: -<BR> -<BR><TT>\newacronym</TT><A NAME="8167"></A><TT>[</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> -In addition, <TT>\oldacronym</TT><A NAME="8170"></A> also defines the commands -<TT>\</TT><I>label</I>, which is equivalent to <TT>\gls</TT><A NAME="8173"></A><TT>{</TT><EM>label</EM><TT>}</TT>, -and <TT>\</TT><I>label</I><TT>*</TT>, which is equivalent to -<TT>\Gls</TT><A NAME="8176"></A><TT>{</TT><EM>label</EM><TT>}</TT>. If <I>label</I> is omitted, <I>abbrv</I> -is used. Since commands names must consist only of alphabetical -characters, <I>label</I> must also only consist of alphabetical -characters. Note that <TT>\</TT><I>label</I> doesn't allow you to use -the first optional argument of <TT>\gls</TT><A NAME="8179"></A> or <TT>\Gls</TT><A NAME="8182"></A> -- you will -need to explicitly use <TT>\gls</TT><A NAME="8185"></A> or <TT>\Gls</TT><A NAME="8188"></A> to change the -settings. - -<P> -Recall that, in general, LaTeX ignores spaces following command -names consisting of alphabetical characters. This is also true for -<TT>\</TT><I>label</I> unless you additionally load the -<TT>xspace</TT><A NAME="8191"></A> package. - -<P> -The <TT>glossaries</TT> package doesn't load the <TT>xspace</TT><A NAME="8195"></A> package -since there are both advantages and disadvantages to using -<TT>\xspace</TT><A NAME="8198"></A> in <TT>\</TT><I>label</I>. If you don't use the -<TT>xspace</TT><A NAME="8201"></A> package you need to explicitly force a space using -<code>\ </code> (backslash space) however you can follow <TT>\</TT><I>label</I> -with additional text in square brackets (the final optional -argument to <TT>\gls</TT><A NAME="8204"></A>). If you use the <TT>xspace</TT><A NAME="8207"></A> package -you don't need to escape the spaces but you can't use -the optional argument to insert text (you will have to explicitly -use <TT>\gls</TT><A NAME="8210"></A>). - -<P> -To illustrate this, suppose I define the acronym "abc" as -follows: -<PRE> -\oldacronym{abc}{example acronym}{} -</PRE> -This will create the command <TT>\abc</TT> and its starred version -<TT>\abc*</TT>. <A HREF="glossaries-manual.html#tab:xspace">Table </A><A HREF="glossaries-manual.html#tab:xspace">6</A> illustrates the effect of -<TT>\abc</TT> (on subsequent use) according to whether or not the -<TT>xspace</TT><A NAME="8216"></A> package has been loaded. As can be seen from the -final row in the table, the <TT>xspace</TT><A NAME="8219"></A> package prevents the -optional argument from being recognised. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:xspace"></A> -<DIV ALIGN="CENTER"><A NAME="4416"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 6:</STRONG> -The effect of using -<TT>xspace</TT> with <TT>\oldacronym</TT></CAPTION> -<TR><TH ALIGN="LEFT"><B>Code </B></TH> -<TH ALIGN="LEFT"><B>With <TT>xspace</TT> </B></TH> -<TH ALIGN="LEFT"><B>Without <TT>xspace</TT></B></TH> -</TR> -<TR><TD ALIGN="LEFT"><code>\abc.</code></TD> -<TD ALIGN="LEFT">abc.</TD> -<TD ALIGN="LEFT">abc.</TD> -</TR> -<TR><TD ALIGN="LEFT"><code>\abc xyz</code></TD> -<TD ALIGN="LEFT">abc xyz</TD> -<TD ALIGN="LEFT">abcxyz</TD> -</TR> -<TR><TD ALIGN="LEFT"><code>\abc\ xyz</code></TD> -<TD ALIGN="LEFT">abc xyz</TD> -<TD ALIGN="LEFT">abc xyz</TD> -</TR> -<TR><TD ALIGN="LEFT"><code>\abc* xyz</code></TD> -<TD ALIGN="LEFT">Abc xyz</TD> -<TD ALIGN="LEFT">Abc xyz</TD> -</TR> -<TR><TD ALIGN="LEFT"><code>\abc['s] xyz</code></TD> -<TD ALIGN="LEFT">abc ['s] xyz</TD> -<TD ALIGN="LEFT">abc's xyz</TD> -</TR> -</TABLE> -</DIV> -<P> -<DIV ALIGN="CENTER"></DIV> -</DIV> -<BR> - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION000311000000000000000"></A> -<A NAME="sec:glsunset"></A> -<BR> -Unsetting and Resetting Entry Flags -</H2> - -<P> -When using <TT>\gls</TT><A NAME="8228"></A>, <TT>\glspl</TT><A NAME="8231"></A> and their uppercase variants it is -possible that you may want to use the value given by the -<TT>first</TT><A NAME="8234"></A> key, even though you have already used the glossary -entry<A NAME="8236"></A>. Conversely, you may want to use the value given by the -<TT>text</TT><A NAME="8238"></A> key, even though you haven't used the glossary entry. -The former can be achieved by one of the following commands: - -<P> -<TT>\glsreset{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glslocalreset{</TT><EM>label</EM><TT>}</TT> -<P> +</p><!--l. 3914--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\oldacronym</span><span +class="ectt-0900"> </span></span><a + id="dx1-36004"></a><span +class="ectt-1000">\oldacronym[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3916--><p class="noindent" > +This uses the same syntax as the <span +class="ecss-1000">glossary</span><a + id="dx1-36005"></a> package’s method of defining acronyms. It is +equivalent to:<br +class="newline" /> <span +class="ectt-1000">\newacronym</span><a + id="dx1-36006"></a><span +class="ectt-1000">[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">key-val list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">long</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span><br +class="newline" /> In addition, <span +class="ectt-1000">\oldacronym</span><a + id="dx1-36007"></a> also defines the commands <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>, which is equivalent to +<span +class="ectt-1000">\gls</span><a + id="dx1-36008"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>, and <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">*</span>, which is equivalent to <span +class="ectt-1000">\Gls</span><a + id="dx1-36009"></a><span +class="ectt-1000">{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. If <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is omitted, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">abbrv</span><span +class="cmsy-10">⟩ </span>is used. Since commands names must consist only of alphabetical characters, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>must also only consist of alphabetical characters. Note that <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>doesn’t +allow you to use the first optional argument of <span +class="ectt-1000">\gls</span><a + id="dx1-36010"></a> or <span +class="ectt-1000">\Gls</span><a + id="dx1-36011"></a> — you will need to +explicitly use <span +class="ectt-1000">\gls</span><a + id="dx1-36012"></a> or <span +class="ectt-1000">\Gls</span><a + id="dx1-36013"></a> to change the settings. +</p><!--l. 3931--><p class="indent" > <div class="important" title="Important Note"> Recall that, in general, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> ignores spaces following command names +consisting of alphabetical characters. This is also true for <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>unless you +additionally load the <span +class="ecss-1000">xspace</span><a + id="dx1-36014"></a> package. </div> +</p><!--l. 3936--><p class="noindent" > + + + +</p><!--l. 3938--><p class="indent" > The <span +class="ecss-1000">glossaries </span>package doesn’t load the <span +class="ecss-1000">xspace</span><a + id="dx1-36015"></a> package since there are both +advantages and disadvantages to using <span +class="ectt-1000">\xspace</span><a + id="dx1-36016"></a> in <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. If you don’t use the <span +class="ecss-1000">xspace</span><a + id="dx1-36017"></a> +package you need to explicitly force a space using <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\␣</span></span></span> (backslash space) however you can +follow <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>with additional text in square brackets (the final optional argument to +<span +class="ectt-1000">\gls</span><a + id="dx1-36018"></a>). If you use the <span +class="ecss-1000">xspace</span><a + id="dx1-36019"></a> package you don’t need to escape the spaces but you +can’t use the optional argument to insert text (you will have to explicitly use +<span +class="ectt-1000">\gls</span><a + id="dx1-36020"></a>). +</p><!--l. 3949--><p class="indent" > To illustrate this, suppose I define the acronym “abc” as follows: + + + +</p> + <div class="verbatim" id="verbatim-105"> +\oldacronym{abc}{example acronym}{} +</div> +<!--l. 3953--><p class="nopar" > This will create the command <span +class="ectt-1000">\abc </span>and its starred version <span +class="ectt-1000">\abc*</span>. <a +href="#x1-360237">Table 7</a> illustrates +the effect of <span +class="ectt-1000">\abc </span>(on subsequent use) according to whether or not the <span +class="ecss-1000">xspace</span><a + id="dx1-36021"></a> package +has been loaded. As can be seen from the final row in the table, the <span +class="ecss-1000">xspace</span><a + id="dx1-36022"></a> package +prevents the optional argument from being recognised. +</p> + <div class="table"> + + + +<!--l. 3961--><p class="indent" > <a + id="x1-360237"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 7: </span><span +class="content">The effect of using <span +class="ecss-1000">xspace </span>with <span +class="ectt-1000">\oldacronym</span></span></div><!--tex4ht:label?: x1-360237 --> +<div class="tabular"> <table id="TBL-8" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-8-1g"><col +id="TBL-8-1" /><col +id="TBL-8-2" /><col +id="TBL-8-3" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-8-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-1-1" +class="td11"><span +class="ecbx-1000">Code </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-8-1-2" +class="td11"><span +class="ecbx-1000">With </span><span +class="ecsx-1000">xspace</span></td><td style="white-space:nowrap; text-align:left;" id="TBL-8-1-3" +class="td11"><span +class="ecbx-1000">Without </span><span +class="ecsx-1000">xspace</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-8-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-2-1" +class="td11"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\abc.</span></span></span> </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-2-2" +class="td11">abc. </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-2-3" +class="td11">abc. </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-8-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-3-1" +class="td11"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\abc</span><span +class="ectt-1000"> xyz</span></span></span> </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-3-2" +class="td11">abc xyz </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-3-3" +class="td11">abcxyz </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-8-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-4-1" +class="td11"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\abc\</span><span +class="ectt-1000"> xyz</span></span></span> </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-4-2" +class="td11">abc xyz </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-4-3" +class="td11">abc xyz </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-8-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-5-1" +class="td11"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\abc*</span><span +class="ectt-1000"> xyz</span></span></span> </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-5-2" +class="td11">Abc xyz </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-5-3" +class="td11">Abc xyz </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-8-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-8-6-1" +class="td11"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\abc[’s]</span><span +class="ectt-1000"> xyz</span></span></span></td><td style="white-space:nowrap; text-align:left;" id="TBL-8-6-2" +class="td11">abc [’s] xyz </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-6-3" +class="td11">abc’s xyz </td></tr></table> +</div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 3981--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.11 </span> <a + id="x1-370002.11"></a>Unsetting and Resetting Entry Flags</h4> +<!--l. 3984--><p class="noindent" >When using <span +class="ectt-1000">\gls</span><a + id="dx1-37001"></a>, <span +class="ectt-1000">\glspl</span><a + id="dx1-37002"></a> and their uppercase variants it is possible that you may want +to use the value given by the <span +class="ecss-1000">first</span><a + id="dx1-37003"></a> key, even though you have already used the glossary +entry<a + id="dx1-37004"></a>. Conversely, you may want to use the value given by the <span +class="ecss-1000">text</span><a + id="dx1-37005"></a> key, even though you +haven’t used the glossary entry. The former can be achieved by one of the following +commands: +</p><!--l. 3990--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsreset</span><span +class="ectt-0900"> </span></span><a + id="dx1-37006"></a><span +class="ectt-1000">\glsreset{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3992--><p class="noindent" > +</p><!--l. 3993--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslocalreset</span><span +class="ectt-0900"> </span></span><a + id="dx1-37007"></a><span +class="ectt-1000">\glslocalreset{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3995--><p class="noindent" > while the latter can be achieved by one of the following commands: - -<P> -<TT>\glsunset{</TT><EM>label</EM><TT>}</TT> -<P> - -<P> -<TT>\glslocalunset{</TT><EM>label</EM><TT>}</TT> -<P> -You can also reset or unset all entries for a given glossary or list of -glossaries using: - -<P> -<TT>\glsresetall[</TT><EM>glossary list</EM><TT>]</TT> -<P> - -<P> -<TT>\glslocalresetall[</TT><EM>glossary list</EM><TT>]</TT> -<P> - -<P> -<TT>\glsunsetall[</TT><EM>glossary list</EM><TT>]</TT> -<P> - -<P> -<TT>\glslocalunsetall[</TT><EM>glossary list</EM><TT>]</TT> -<P> -where <I>glossary list</I> is a comma-separated list of -glossary labels. If omitted, all defined glossaries are assumed. -For example, to reset all entries in the main glossary and the -list of acronyms: -<PRE> +</p><!--l. 3997--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsunset</span><span +class="ectt-0900"> </span></span><a + id="dx1-37008"></a><span +class="ectt-1000">\glsunset{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 3999--><p class="noindent" > +</p><!--l. 4000--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslocalunset</span><span +class="ectt-0900"> </span></span><a + id="dx1-37009"></a><span +class="ectt-1000">\glslocalunset{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4002--><p class="noindent" > +You can also reset or unset all entries for a given glossary or list of glossaries +using: +</p><!--l. 4005--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsresetall</span><span +class="ectt-0900"> </span></span><a + id="dx1-37010"></a><span +class="ectt-1000">\glsresetall[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4007--><p class="noindent" > +</p><!--l. 4008--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslocalresetall</span><span +class="ectt-0900"> </span></span><a + id="dx1-37011"></a><span +class="ectt-1000">\glslocalresetall[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4010--><p class="noindent" > +</p><!--l. 4011--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsunsetall</span><span +class="ectt-0900"> </span></span><a + id="dx1-37012"></a><span +class="ectt-1000">\glsunsetall[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4013--><p class="noindent" > +</p><!--l. 4014--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslocalunsetall</span><span +class="ectt-0900"> </span></span><a + id="dx1-37013"></a><span +class="ectt-1000">\glslocalunsetall[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">] </span></div><hr> +</p><!--l. 4016--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">glossary list</span><span +class="cmsy-10">⟩ </span>is a comma-separated list of glossary labels. If omitted, all defined +glossaries are assumed. For example, to reset all entries in the main glossary and the list +of acronyms: + + + +</p> + <div class="verbatim" id="verbatim-106"> \glsresetall[main,acronym] -</PRE> - -<P> -You can determine whether an entry's first use flag is set using: - -<P> -<TT>\ifglsused{</TT><EM>label</EM><TT>}{</TT><EM>true part</EM><TT>}{</TT><EM>false part</EM><TT>}</TT> -<P> -where <I>label</I> is the label of the required entry. If the -entry has been used, <I>true part</I> will be done, otherwise -<I>false part</I> will be done. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION000312000000000000000"></A> -<A NAME="sec:styles"></A> -<BR> -Glossary Styles -</H2> -The <TT>glossaries</TT> package comes with some pre-defined -glossary styles. Note that the styles are suited to different -types of glossaries: some styles ignore the associated -symbol; some styles are not designed for hierarchical entries, -so they display sub-entries in the same way as they display top -level entries; some styles are designed for homographs, so they -ignore the name for sub-entries. You should therefore pick a style -that suits your type of glossary. See <A HREF="glossaries-manual.html#tab:styles">table </A><A HREF="glossaries-manual.html#tab:styles">7</A> for -a summary of the available styles. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:styles"></A> -<DIV ALIGN="CENTER"><A NAME="4417"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 7:</STRONG> -Glossary Styles. An asterisk in the style -name indicates anything that matches that doesn't match any -previously listed style (e.g. <TT>long3col*</TT> -matches <TT>long3col</TT><A NAME="8248"></A>, <TT>long3colheader</TT><A NAME="8250"></A>, -<TT>long3colborder</TT><A NAME="8252"></A> and <TT>long3colheaderborder</TT><A NAME="8254"></A>). -A maximum level of 0 indicates a flat glossary (sub-entries -are displayed in the same way as main entries). Where the maximum -level is given as -- there is no limit, but note that -<TT>makeindex</TT><A NAME="8256"></A> imposes a limit of 2 sub-levels. If the -homograph column is checked, then the name is not displayed for -sub-entries. If the symbol column is checked, then the symbol will -be displayed if it has been defined.</CAPTION> -<TR><TH ALIGN="LEFT"><B>Style </B></TH> -<TH ALIGN="CENTER"><B>Maximum Level </B></TH> -<TH ALIGN="CENTER"><B>Homograph </B></TH> -<TH ALIGN="CENTER"><B>Symbol</B></TH> -</TR> -<TR><TD ALIGN="LEFT"><TT>listdotted </TT></TD> -<TD ALIGN="CENTER">0</TD> -<TD ALIGN="CENTER"> </TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>sublistdotted </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER"> </TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>list* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>altlist* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>long*3col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>long4col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>altlong*4col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>long* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>super*3col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>super4col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>altsuper*4col* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>super* </TT></TD> -<TD ALIGN="CENTER">1</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER"> </TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>index* </TT></TD> -<TD ALIGN="CENTER">2</TD> -<TD ALIGN="CENTER"> </TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>treenoname* </TT></TD> -<TD ALIGN="CENTER">--</TD> -<TD ALIGN="CENTER">X</TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>tree* </TT></TD> -<TD ALIGN="CENTER">--</TD> -<TD ALIGN="CENTER"> </TD> -<TD ALIGN="CENTER">X</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>alttree* </TT></TD> -<TD ALIGN="CENTER">--</TD> -<TD ALIGN="CENTER"> </TD> -<TD ALIGN="CENTER">X</TD> -</TR> -</TABLE> -</DIV> -<P> -<DIV ALIGN="CENTER"></DIV> -</DIV> -<BR> - -<P> -The glossary style can be set using the <TT>style</TT><A NAME="8259"></A> key in the optional -argument to <TT>\printglossary</TT><A NAME="8262"></A> or using the command: - -<P> -<TT>\glossarystyle{</TT><EM>style-name</EM><TT>}</TT> -<P> -Some of the glossary styles may also be set using the <TT>style</TT><A NAME="8270"></A> -package option, it depends if the package in which they are defined -is automatically loaded by the <TT>glossaries</TT> package. - -<P> -The tabular-like styles that allow multi-line descriptions and page -lists use the length <TT>\glsdescwidth</TT> -to set the width of the description column and the length -<TT>\glspagelistwidth</TT> to set the -width of the page list column.<A NAME="tex2html37" - HREF="#foot4418"><SUP>13</SUP></A>These will need to be changed using <TT>\setlength</TT> if the glossary -is too wide. Note that the <TT>long4col</TT><A NAME="8302"></A> and -<TT>super4col</TT><A NAME="8304"></A> styles (and their header and border variations) -don't use these lengths as they are designed for single line -entries. Instead you should use the analogous <TT>altlong4col</TT><A NAME="8306"></A> -and <TT>altsuper4col</TT><A NAME="8308"></A> styles. If you want to -explicitly create a line-break within a multi-line description in -a tabular-like style you should use <TT>\newline</TT><A NAME="8310"></A> instead of -<code>\\</code>. - -<P> -Note that if you use the <TT>style</TT><A NAME="8313"></A> key in the -optional argument to <TT>\printglossary</TT><A NAME="8316"></A>, it will override any -previous style settings for the given glossary, so if, for example, -you do -<PRE> +</div> +<!--l. 4023--><p class="nopar" > +</p><!--l. 4025--><p class="indent" > You can determine whether an entry’s first use flag is set using: +</p><!--l. 4026--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\ifglsused</span><span +class="ectt-0900"> </span></span><a + id="dx1-37014"></a><span +class="ectt-1000">\ifglsused{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">true part</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">false part</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4028--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the label of the required entry. If the entry has been used, <span +class="cmsy-10">⟨</span><span +class="ecti-1000">true part</span><span +class="cmsy-10">⟩</span> +will be done, otherwise <span +class="cmsy-10">⟨</span><span +class="ecti-1000">false part</span><span +class="cmsy-10">⟩ </span>will be done. +</p><!--l. 4034--><p class="noindent" > +</p> +<!--l. 4034--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.12 </span> <a + id="x1-380002.12"></a>Glossary Styles</h4> +<!--l. 4036--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>package comes with some pre-defined glossary styles. Note that the styles +are suited to different types of glossaries: some styles ignore the associated symbol; +some styles are not designed for hierarchical entries, so they display sub-entries in +the same way as they display top level entries; some styles are designed for +homographs, so they ignore the name for sub-entries. You should therefore pick a style +that suits your type of glossary. See <a +href="#x1-380018">table 8</a> for a summary of the available +styles. +</p> + <div class="table"> + + + +<!--l. 4046--><p class="indent" > <a + id="x1-380018"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 8: </span><span +class="content">Glossary Styles. An asterisk in the style name indicates anything that +matches that doesn’t match any previously listed style (e.g. <span +class="ectt-1000">long3col* </span>matches +<span +class="ecss-1000">long3col</span><a + id="dx1-38002"></a>, <span +class="ecss-1000">long3colheader</span><a + id="dx1-38003"></a>, <span +class="ecss-1000">long3colborder</span><a + id="dx1-38004"></a> and <span +class="ecss-1000">long3colheaderborder</span><a + id="dx1-38005"></a>). A maximum +level of 0 indicates a flat glossary (sub-entries are displayed in the same way as +main entries). Where the maximum level is given as — there is no limit, but +note that <span +class="ectt-1000">makeindex</span><a + id="dx1-38006"></a> imposes a limit of 2 sub-levels. If the homograph column is +checked, then the name is not displayed for sub-entries. If the symbol column is +checked, then the symbol will be displayed if it has been defined.</span></div><!--tex4ht:label?: x1-380018 --> +<div class="tabular"> <table id="TBL-9" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-9-1g"><col +id="TBL-9-1" /><col +id="TBL-9-2" /><col +id="TBL-9-3" /><col +id="TBL-9-4" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-9-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-1-1" +class="td11"><span +class="ecbx-1000">Style </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-1-2" +class="td11"><span +class="ecbx-1000">Maximum Level</span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-1-3" +class="td11"><span +class="ecbx-1000">Homograph</span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-1-4" +class="td11"><span +class="ecbx-1000">Symbol</span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-2-1" +class="td11"><span +class="ectt-1000">listdotted </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-2-2" +class="td11"> 0 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-2-3" +class="td11"> </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-2-4" +class="td11"> </td></tr><tr + style="vertical-align:baseline;" id="TBL-9-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-3-1" +class="td11"><span +class="ectt-1000">sublistdotted </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-3-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-3-3" +class="td11"> </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-3-4" +class="td11"></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-4-1" +class="td11"><span +class="ectt-1000">list* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-4-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-4-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-4-4" +class="td11"> </td></tr><tr + style="vertical-align:baseline;" id="TBL-9-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-5-1" +class="td11"><span +class="ectt-1000">altlist* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-5-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-5-3" +class="td11"> +<span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-5-4" +class="td11"> </td></tr><tr + style="vertical-align:baseline;" id="TBL-9-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-6-1" +class="td11"><span +class="ectt-1000">long*3col* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-6-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-6-3" +class="td11"> +<span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-6-4" +class="td11"> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-7-1" +class="td11"><span +class="ectt-1000">long4col* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-7-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-7-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-7-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-8-1" +class="td11"><span +class="ectt-1000">altlong*4col* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-8-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-8-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-8-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-9-1" +class="td11"><span +class="ectt-1000">long* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-9-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-9-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-9-4" +class="td11"> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-10-1" +class="td11"><span +class="ectt-1000">super*3col* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-10-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-10-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-10-4" +class="td11"> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-11-1" +class="td11"><span +class="ectt-1000">super4col* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-11-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-11-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-11-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-12-1" +class="td11"><span +class="ectt-1000">altsuper*4col*</span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-12-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-12-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-12-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-13-1" +class="td11"><span +class="ectt-1000">super* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-13-2" +class="td11"> 1 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-13-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-13-4" +class="td11"> </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-14-1" +class="td11"><span +class="ectt-1000">index* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-14-2" +class="td11"> 2 </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-14-3" +class="td11"> </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-14-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-15-1" +class="td11"><span +class="ectt-1000">treenoname* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-15-2" +class="td11"> — </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-15-3" +class="td11"> <span +class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-15-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-16-1" +class="td11"><span +class="ectt-1000">tree* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-16-2" +class="td11"> — </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-16-3" +class="td11"> </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-16-4" +class="td11"> <span +class="pzdr-">✓ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-9-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-9-17-1" +class="td11"><span +class="ectt-1000">alttree* </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-17-2" +class="td11"> — </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-17-3" +class="td11"> </td><td style="white-space:nowrap; text-align:center;" id="TBL-9-17-4" +class="td11"> <span +class="pzdr-">✓ </span></td></tr></table></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 4085--><p class="indent" > The glossary style can be set using the <span +class="ecss-1000">style</span><a + id="dx1-38007"></a> key in the optional argument to +<span +class="ectt-1000">\printglossary</span><a + id="dx1-38008"></a> or using the command: +</p><!--l. 4087--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossarystyle</span><span +class="ectt-0900"> </span></span><a + id="dx1-38009"></a><span +class="ectt-1000">\glossarystyle{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">style-name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4089--><p class="noindent" > +Some of the glossary styles may also be set using the <span +class="ecss-1000">style</span><a + id="dx1-38010"></a> package option, it depends if +the package in which they are defined is automatically loaded by the <span +class="ecss-1000">glossaries</span> +package. +</p><!--l. 4094--><p class="indent" > The tabular-like styles that allow multi-line descriptions and page lists use the +length <span class="marginpar"><span +class="ectt-0900">\glsdescwidth</span><span +class="ectt-0900"> </span></span><a + id="dx1-38011"></a><span +class="ectt-1000">\glsdescwidth </span>to set the width of the description column and +the length <span class="marginpar"><span +class="ectt-0900">\glspagelistwidth</span><span +class="ectt-0900"> </span></span><a + id="dx1-38012"></a><span +class="ectt-1000">\glspagelistwidth </span>to set the width of the page list +column.<span class="footnote-mark"><a +href="#fn12x0" id="fn12x0-bk"><sup class="textsuperscript">12</sup></a></span><a + id="x1-38013f12"></a> +These will need to be changed using <span +class="ectt-1000">\setlength </span>if the glossary is too wide. Note that +the <span +class="ecss-1000">long4col</span><a + id="dx1-38017"></a> and <span +class="ecss-1000">super4col</span><a + id="dx1-38018"></a> styles (and their header and border variations) don’t use +these lengths as they are designed for single line entries. Instead you should use the +analogous <span +class="ecss-1000">altlong4col</span><a + id="dx1-38019"></a> and <span +class="ecss-1000">altsuper4col</span><a + id="dx1-38020"></a> styles. If you want to explicitly create a line-break +within a multi-line description in a tabular-like style you should use <span +class="ectt-1000">\newline</span><a + id="dx1-38021"></a> instead +of <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\\</span></span></span>. +</p><!--l. 4112--><p class="indent" > Note that if you use the <span +class="ecss-1000">style</span><a + id="dx1-38022"></a> key in the optional argument to <span +class="ectt-1000">\printglossary</span><a + id="dx1-38023"></a>, it +will override any previous style settings for the given glossary, so if, for example, you +do + + + +</p> + <div class="verbatim" id="verbatim-107"> \renewcommand*{\glsgroupskip}{} -\printglossary[style=long] -</PRE> -then the new definition of <TT>\glsgroupskip</TT><A NAME="8319"></A> will not have an affect -for this glossary, as <TT>\glsgroupskip</TT> is redefined by -<code>style=long</code>. Likewise, <TT>\glossarystyle</TT><A NAME="8322"></A> will also + <br />\printglossary[style=long] +</div> +<!--l. 4119--><p class="nopar" > then the new definition of <span +class="ectt-1000">\glsgroupskip</span><a + id="dx1-38024"></a> will not have an affect for this glossary, as +<span +class="ectt-1000">\glsgroupskip </span>is redefined by <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">style=long</span></span></span>. Likewise, <span +class="ectt-1000">\glossarystyle</span><a + id="dx1-38025"></a> will also override any previous style definitions, so, again -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-108"> \renewcommand*{\glsgroupskip}{} + <br />\glossarystyle{long} +</div> +<!--l. 4127--><p class="nopar" > will reset <span +class="ectt-1000">\glsgroupskip </span>back to its default definition for the named glossary style +(<span +class="ecss-1000">long</span><a + id="dx1-38026"></a> in this case). If you want to modify the styles, either use <span +class="ectt-1000">\newglossarystyle</span><a + id="dx1-38027"></a> +(described in the next section) or make the modifications after <span +class="ectt-1000">\glossarystyle</span><a + id="dx1-38028"></a>, +e.g.: + + + +</p> + <div class="verbatim" id="verbatim-109"> \glossarystyle{long} -</PRE> -will reset <TT>\glsgroupskip</TT> back to its default definition for the -named glossary style (<TT>long</TT><A NAME="8325"></A> in this case). If you want to -modify the styles, either use <TT>\newglossarystyle</TT><A NAME="8327"></A> (described -in the next section) or make the modifications after -<TT>\glossarystyle</TT><A NAME="8330"></A>, e.g.: -<PRE> -\glossarystyle{long} -\renewcommand*{\glsgroupskip}{} -</PRE> - -<P> -All the styles except for the three- and four-column styles and the -<TT>listdotted</TT><A NAME="8333"></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 -will need to redefine <TT>\glspostdescription</TT> before the glossary is -displayed. Alternatively, you can suppress it for a given entry -by placing <TT>\nopostdesc</TT><A NAME="8335"></A> in the entry's description. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312100000000000000"></A> -<A NAME="sec:liststyles"></A> -<BR> -List Styles -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-list</TT><A NAME="8341"></A>. Since they all use the <TT>description</TT> -environment, they are governed by the same parameters as that -environment. These styles all ignore the entry's symbol. Note that -these styles will automatically be available unless you use the -<TT>nolist</TT><A NAME="8350"></A> or <TT>nostyles</TT><A NAME="8359"></A> package options. - -<P> -<DL> -<DT><STRONG>list</STRONG></DT> -<DD>The <TT>list</TT><A NAME="8363"></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<A NAME="8365"></A> for -that entry. The symbol is ignored. If the entry has child entries, -the description and number list follows (but not the name) for each -child entry. Groups are separated using <TT>\indexspace</TT>. - -<P> -</DD> -<DT><STRONG>listgroup</STRONG></DT> -<DD>The <TT>listgroup</TT><A NAME="8367"></A> style is like -<TT>list</TT><A NAME="8369"></A> but the glossary groups have headings. - -<P> -</DD> -<DT><STRONG>listhypergroup</STRONG></DT> -<DD>The <TT>listhypergroup</TT><A NAME="8371"></A> style is like -<TT>listgroup</TT><A NAME="8373"></A> but has a navigation line at the start of -the glossary with links to each group that is present in the -glossary. This requires an additional run through LaTeX to ensure -the group information is up to date. In the navigation line, each -group is separated -by <TT>\glshypernavsep</TT> which -defaults to a vertical bar with a space on either side. For example, -to simply have a space separating each group, do: -<PRE> -\renewcommand*{\glshypernavsep}{\space} -</PRE> - -<P> -Note that the hyper-navigation line is now (as from version 1.14) -set inside the optional argument to <TT>\item</TT> instead of after it -to prevent a spurious space at the start. This can be changed -by redefining <TT>\glossaryheader</TT><A NAME="8375"></A>, but note that this needs to -be done <I>after</I> the glossary style has been set. - -<P> -</DD> -<DT><STRONG>altlist</STRONG></DT> -<DD>The <TT>altlist</TT><A NAME="8378"></A> style is like <TT>list</TT><A NAME="8380"></A> -but the description starts on the line following the name. (As -with the <TT>list</TT><A NAME="8382"></A> style, the symbol is ignored.) Each child -entry starts a new line, but as with the <TT>list</TT><A NAME="8384"></A> style, -the name associated with each child entry is ignored. - -<P> -</DD> -<DT><STRONG>altlistgroup</STRONG></DT> -<DD>The <TT>altlistgroup</TT><A NAME="8386"></A> style is like -<TT>altlist</TT><A NAME="8388"></A> but the glossary groups have headings. - -<P> -</DD> -<DT><STRONG>altlisthypergroup</STRONG></DT> -<DD>The <TT>altlisthypergroup</TT><A NAME="8390"></A> style is like -<TT>altlistgroup</TT><A NAME="8392"></A> but has a set of links to the glossary -groups. The navigation line is the same as that for -<TT>listhypergroup</TT><A NAME="8394"></A>, described above. - -<P> -</DD> -<DT><STRONG>listdotted</STRONG></DT> -<DD>This style uses the <TT>description</TT> -environment.<A NAME="tex2html38" - HREF="#foot3576"><SUP>14</SUP></A> 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="8396"></A> and the symbol. The length -<TT>\glslistdottedwidth</TT> governs -where the description should start. This is a flat style, so child -entries are formatted in the same way as the parent entries. - -<P> -</DD> -<DT><STRONG>sublistdotted</STRONG></DT> -<DD>This is a variation on the <TT>listdotted</TT><A NAME="8398"></A> -style designed for hierarchical glossaries. The main entries -have just the name displayed. The sub entries are displayed in -the same manner as <TT>listdotted</TT><A NAME="8400"></A>. -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312200000000000000"></A> -<A NAME="sec:longstyles"></A> -<BR> -Longtable Styles -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-long</TT><A NAME="8405"></A>. Since they all use the <TT>longtable</TT> -environment, they are governed by the same parameters as that -environment. Note that these styles will automatically be available -unless you use the <TT>nolong</TT><A NAME="8414"></A> or <TT>nostyles</TT><A NAME="8423"></A> package -options. These styles fully justify the description and page list -columns. If you want ragged right formatting instead, use the -analogous styles described in -<A HREF="glossaries-manual.html#sec:longraggedstyles">Longtable Styles -(Ragged Right)</A>. - -<P> -<DL> -<DT><STRONG>long</STRONG></DT> -<DD>The <TT>long</TT><A NAME="8427"></A> style uses the <TT>longtable</TT> -environment (defined by the <TT>longtable</TT><A NAME="8430"></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="8432"></A>. -The entry's symbol is ignored. -Sub groups are separated with a blank row. The width of the -first column is governed by the widest entry in that column. The -width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8434"></A>. Child entries have a similar format to the -parent entries except that their name is suppressed. - -<P> -</DD> -<DT><STRONG>longborder</STRONG></DT> -<DD>The <TT>longborder</TT><A NAME="8437"></A> style is like -<TT>long</TT><A NAME="8439"></A> but has horizontal and vertical lines around it. - -<P> -</DD> -<DT><STRONG>longheader</STRONG></DT> -<DD>The <TT>longheader</TT><A NAME="8441"></A> style is like -<TT>long</TT><A NAME="8443"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>longheaderborder</STRONG></DT> -<DD>The <TT>longheaderborder</TT><A NAME="8445"></A> style is -like <TT>longheader</TT><A NAME="8447"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>long3col</STRONG></DT> -<DD>The <TT>long3col</TT><A NAME="8449"></A> style is like -<TT>long</TT><A NAME="8451"></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="8452"></A>. -The entry's symbol is ignored. The width of the -first column is governed by the widest entry in that column, the -width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8454"></A>, and the width of the third column is governed by the -length <TT>\glspagelistwidth</TT><A NAME="8457"></A>. - -<P> -</DD> -<DT><STRONG>long3colborder</STRONG></DT> -<DD>The <TT>long3colborder</TT><A NAME="8460"></A> style is like -the <TT>long3col</TT><A NAME="8462"></A> style but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>long3colheader</STRONG></DT> -<DD>The <TT>long3colheader</TT><A NAME="8464"></A> style is like -<TT>long3col</TT><A NAME="8466"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>long3colheaderborder</STRONG></DT> -<DD>The <TT>long3colheaderborder</TT><A NAME="8468"></A> style is -like <TT>long3colheader</TT><A NAME="8470"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>long4col</STRONG></DT> -<DD>The <TT>long4col</TT><A NAME="8472"></A> style is like -<TT>long3col</TT><A NAME="8474"></A> but has an additional column in which the -entry's associated symbol appears. This style is used for brief -single line descriptions. The column widths are governed by the -widest entry in the given column. Use <TT>altlong4col</TT><A NAME="8476"></A> for -multi-line descriptions. - -<P> -</DD> -<DT><STRONG>long4colborder</STRONG></DT> -<DD>The <TT>long4colborder</TT><A NAME="8478"></A> style is like -the <TT>long4col</TT><A NAME="8480"></A> style but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>long4colheader</STRONG></DT> -<DD>The <TT>long4colheader</TT><A NAME="8482"></A> style is like -<TT>long4col</TT><A NAME="8484"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>long4colheaderborder</STRONG></DT> -<DD>The <TT>long4colheaderborder</TT><A NAME="8486"></A> style is -like <TT>long4colheader</TT><A NAME="8488"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>altlong4col</STRONG></DT> -<DD>The <TT>altlong4col</TT><A NAME="8490"></A> style is like -<TT>long4col</TT><A NAME="8492"></A> but allows multi-line descriptions and page -lists. The width of the description column is governed by the -length <TT>\glsdescwidth</TT><A NAME="8494"></A> and the width of the page list column is -governed by the length <TT>\glspagelistwidth</TT><A NAME="8497"></A>. The widths of the -name and symbol columns are governed by the widest entry in the -given column. - -<P> -</DD> -<DT><STRONG>altlong4colborder</STRONG></DT> -<DD>The <TT>altlong4colborder</TT><A NAME="8500"></A> style is like -the <TT>long4colborder</TT><A NAME="8502"></A> but allows multi-line descriptions and -page lists. - -<P> -</DD> -<DT><STRONG>altlong4colheader</STRONG></DT> -<DD>The <TT>altlong4colheader</TT><A NAME="8504"></A> style is like -<TT>long4colheader</TT><A NAME="8506"></A> but allows multi-line descriptions and -page lists. - -<P> -</DD> -<DT><STRONG>altlong4colheaderborder</STRONG></DT> -<DD>The <TT>altlong4colheaderborder</TT><A NAME="8508"></A> -style is like <TT>long4colheaderborder</TT><A NAME="8510"></A> but allows multi-line -descriptions and page lists. -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312300000000000000"></A> -<A NAME="sec:longraggedstyles"></A> -<BR> -Longtable Styles (Ragged Right) -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-longragged</TT><A NAME="8515"></A>. These styles are analogous to those -defined in <TT>glossary-long</TT><A NAME="8518"></A> but the multiline columns are left -justified instead of fully justified. Since these styles all use the -<TT>longtable</TT> environment, they are governed by the same -parameters as that environment. The <TT>glossary-longragged</TT><A NAME="8522"></A> -package additionally requires the <TT>array</TT><A NAME="8525"></A> package. Note that -these styles will only be available if you explicitly load -<TT>glossary-longragged</TT><A NAME="8528"></A>: -<PRE> + <br />\renewcommand*{\glsgroupskip}{} +</div> +<!--l. 4136--><p class="nopar" > +<a + id="dx1-38029"></a> +</p><!--l. 4139--><p class="indent" > All the styles except for the three- and four-column styles and the <span +class="ecss-1000">listdotted</span><a + id="dx1-38030"></a> style use +the command +</p><!--l. 4141--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glspostdescription</span><span +class="ectt-0900"> </span></span><a + id="dx1-38031"></a><span +class="ectt-1000">\glspostdescription </span></div><hr> +</p><!--l. 4143--><p class="noindent" > +after the description. This simply displays a full stop by default. To eliminate this +full stop (or replace it with something else, say, a comma) you will need to +redefine <span +class="ectt-1000">\glspostdescription </span>before the glossary is displayed. Alternatively, +you can suppress it for a given entry by placing <span +class="ectt-1000">\nopostdesc</span><a + id="dx1-38032"></a> in the entry’s +description. +</p> +<!--l. 4150--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.1 </span> <a + id="x1-390002.12.1"></a>List Styles</h5> +<!--l. 4153--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-list</span><a + id="dx1-39001"></a>. Since they +all use the <span +class="ecss-1000">description</span><a + id="dx1-39002"></a> environment, they are governed by the same parameters as that +environment. These styles all ignore the entry’s symbol. Note that these styles +will automatically be available unless you use the <span +class="ecss-1000">nolist</span><a + id="dx1-39003"></a> or <span +class="ecss-1000">nostyles</span><a + id="dx1-39004"></a> package +options. +</p><!--l. 4160--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">list</span> </dt><dd +class="description">The <span +class="ecss-1000">list</span><a + id="dx1-39005"></a> style uses the <span +class="ecss-1000">description</span><a + id="dx1-39006"></a> environment. The entry name is placed in + the optional argument of the <span +class="ectt-1000">\item </span>command (so it will appear in bold by + default). The description follows, and then the associated number list<a + id="dx1-39007"></a> for that + entry. The symbol is ignored. If the entry has child entries, the description + and number list follows (but not the name) for each child entry. Groups are + separated using <span +class="ectt-1000">\indexspace</span>. + </dd><dt class="description"> +<span +class="ecbx-1000">listgroup</span> </dt><dd +class="description">The <span +class="ecss-1000">listgroup</span><a + id="dx1-39008"></a> style is like <span +class="ecss-1000">list</span><a + id="dx1-39009"></a> but the glossary groups have headings. + </dd><dt class="description"> +<span +class="ecbx-1000">listhypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">listhypergroup</span><a + id="dx1-39010"></a> style is like <span +class="ecss-1000">listgroup</span><a + id="dx1-39011"></a> but has a navigation line at + the start of the glossary with links to each group that is present in the glossary. + This requires an additional run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> to ensure the group + information is up to date. In the navigation line, each group is separated + by + + + + <!--l. 4178--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glshypernavsep</span><span +class="ectt-0900"> </span></span><a + id="dx1-39012"></a><span +class="ectt-1000">\glshypernavsep </span></div><hr> + </p><!--l. 4180--><p class="noindent" > + which defaults to a vertical bar with a space on either side. For example, to + simply have a space separating each group, do: + + + +</p> + <div class="verbatim" id="verbatim-110"> + \renewcommand*{\glshypernavsep}{\space} +</div> + <!--l. 4185--><p class="nopar" > + </p><!--l. 4187--><p class="noindent" >Note that the hyper-navigation line is now (as from version 1.14) set inside the + optional argument to <span +class="ectt-1000">\item </span>instead of after it to prevent a spurious + space at the start. This can be changed by redefining <span +class="ectt-1000">\glossaryheader</span><a + id="dx1-39013"></a>, + but note that this needs to be done <span +class="ecti-1000">after </span>the glossary style has been + set. + </p></dd><dt class="description"> +<span +class="ecbx-1000">altlist</span> </dt><dd +class="description">The <span +class="ecss-1000">altlist</span><a + id="dx1-39014"></a> style is like <span +class="ecss-1000">list</span><a + id="dx1-39015"></a> but the description starts on the line following the + name. (As with the <span +class="ecss-1000">list</span><a + id="dx1-39016"></a> style, the symbol is ignored.) Each child entry starts a new + line, but as with the <span +class="ecss-1000">list</span><a + id="dx1-39017"></a> style, the name associated with each child entry is + ignored. + </dd><dt class="description"> +<span +class="ecbx-1000">altlistgroup</span> </dt><dd +class="description">The <span +class="ecss-1000">altlistgroup</span><a + id="dx1-39018"></a> style is like <span +class="ecss-1000">altlist</span><a + id="dx1-39019"></a> but the glossary groups have + headings. + </dd><dt class="description"> +<span +class="ecbx-1000">altlisthypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">altlisthypergroup</span><a + id="dx1-39020"></a> style is like <span +class="ecss-1000">altlistgroup</span><a + id="dx1-39021"></a> but has a set of links + to the glossary groups. The navigation line is the same as that for <span +class="ecss-1000">listhypergroup</span><a + id="dx1-39022"></a>, + described above. + </dd><dt class="description"> +<span +class="ecbx-1000">listdotted</span> </dt><dd +class="description">This style uses the <span +class="ecss-1000">description</span><a + id="dx1-39023"></a> + environment.<span class="footnote-mark"><a +href="#fn13x0" id="fn13x0-bk"><sup class="textsuperscript">13</sup></a></span><a + id="x1-39024f13"></a> + Each entry starts with <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\item[]</span></span></span>, followed by the name followed by a dotted line, + followed by the description. Note that this style ignores both the number list<a + id="dx1-39025"></a> and + the symbol. The length + <!--l. 4212--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glslistdottedwidth</span><span +class="ectt-0900"> </span></span><a + id="dx1-39026"></a><span +class="ectt-1000">\glslistdottedwidth </span></div><hr> + </p><!--l. 4214--><p class="noindent" > + governs where the description should start. This is a flat style, so child entries are + formatted in the same way as the parent entries. + </p></dd><dt class="description"> +<span +class="ecbx-1000">sublistdotted</span> </dt><dd +class="description">This is a variation on the <span +class="ecss-1000">listdotted</span><a + id="dx1-39027"></a> style designed for hierarchical + glossaries. The main entries have just the name displayed. The sub entries are + displayed in the same manner as <span +class="ecss-1000">listdotted</span><a + id="dx1-39028"></a>.</dd></dl> + + + +<!--l. 4225--><p class="noindent" > +</p> +<!--l. 4225--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.2 </span> <a + id="x1-400002.12.2"></a>Longtable Styles</h5> +<!--l. 4228--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-long</span><a + id="dx1-40001"></a>. Since +they all use the <span +class="ecss-1000">longtable</span><a + id="dx1-40002"></a> environment, they are governed by the same parameters +as that environment. Note that these styles will automatically be available +unless you use the <span +class="ecss-1000">nolong</span><a + id="dx1-40003"></a> or <span +class="ecss-1000">nostyles</span><a + id="dx1-40004"></a> package options. These styles fully justify +the description and page list columns. If you want ragged right formatting +instead, use the analogous styles described in <a +href="#x1-410002.12.3">§2.12.3 </a><a +href="#x1-410002.12.3">Longtable Styles (Ragged +Right)<!--tex4ht:ref: sec:longraggedstyles --></a>. +</p><!--l. 4238--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">long</span> </dt><dd +class="description">The <span +class="ecss-1000">long</span><a + id="dx1-40005"></a> style uses the <span +class="ecss-1000">longtable</span><a + id="dx1-40006"></a> environment (defined by the <span +class="ecss-1000">longtable</span><a + id="dx1-40007"></a> + package). It has two columns: the first column contains the entry’s name and + the second column contains the description followed by the number list<a + id="dx1-40008"></a>. The + entry’s symbol is ignored. Sub groups are separated with a blank row. The + width of the first column is governed by the widest entry in that column. + The width of the second column is governed by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-40009"></a>. + Child entries have a similar format to the parent entries except that their + name is suppressed. + </dd><dt class="description"> +<span +class="ecbx-1000">longborder</span> </dt><dd +class="description">The <span +class="ecss-1000">longborder</span><a + id="dx1-40010"></a> style is like <span +class="ecss-1000">long</span><a + id="dx1-40011"></a> but has horizontal and vertical lines + around it. + </dd><dt class="description"> +<span +class="ecbx-1000">longheader</span> </dt><dd +class="description">The <span +class="ecss-1000">longheader</span><a + id="dx1-40012"></a> style is like <span +class="ecss-1000">long</span><a + id="dx1-40013"></a> but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">longheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">longheaderborder</span><a + id="dx1-40014"></a> style is like <span +class="ecss-1000">longheader</span><a + id="dx1-40015"></a> but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">long3col</span> </dt><dd +class="description">The <span +class="ecss-1000">long3col</span><a + id="dx1-40016"></a> style is like <span +class="ecss-1000">long</span><a + id="dx1-40017"></a> but has three columns. The first column + contains the entry’s name, the second column contains the description and + the third column contains the number list<a + id="dx1-40018"></a>. The entry’s symbol is ignored. The + width of the first column is governed by the widest entry in that column, the + width of the second column is governed by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-40019"></a>, and + the width of the third column is governed by the length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-40020"></a>. + </dd><dt class="description"> +<span +class="ecbx-1000">long3colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">long3colborder</span><a + id="dx1-40021"></a> style is like the <span +class="ecss-1000">long3col</span><a + id="dx1-40022"></a> style but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">long3colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">long3colheader</span><a + id="dx1-40023"></a> style is like <span +class="ecss-1000">long3col</span><a + id="dx1-40024"></a> but has a header row. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">long3colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">long3colheaderborder</span><a + id="dx1-40025"></a> style is like <span +class="ecss-1000">long3colheader</span><a + id="dx1-40026"></a> but + has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">long4col</span> </dt><dd +class="description">The <span +class="ecss-1000">long4col</span><a + id="dx1-40027"></a> style is like <span +class="ecss-1000">long3col</span><a + id="dx1-40028"></a> but has an additional column in which + the entry’s associated symbol appears. This style is used for brief single line + descriptions. The column widths are governed by the widest entry in the + given column. Use <span +class="ecss-1000">altlong4col</span><a + id="dx1-40029"></a> for multi-line descriptions. + </dd><dt class="description"> +<span +class="ecbx-1000">long4colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">long4colborder</span><a + id="dx1-40030"></a> style is like the <span +class="ecss-1000">long4col</span><a + id="dx1-40031"></a> style but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">long4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">long4colheader</span><a + id="dx1-40032"></a> style is like <span +class="ecss-1000">long4col</span><a + id="dx1-40033"></a> but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">long4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">long4colheaderborder</span><a + id="dx1-40034"></a> style is like <span +class="ecss-1000">long4colheader</span><a + id="dx1-40035"></a> but + has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altlong4col</span> </dt><dd +class="description">The <span +class="ecss-1000">altlong4col</span><a + id="dx1-40036"></a> style is like <span +class="ecss-1000">long4col</span><a + id="dx1-40037"></a> but allows multi-line descriptions + and page lists. The width of the description column is governed by the length + <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-40038"></a> and the width of the page list column is governed by the + length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-40039"></a>. The widths of the name and symbol columns + are governed by the widest entry in the given column. + </dd><dt class="description"> +<span +class="ecbx-1000">altlong4colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altlong4colborder</span><a + id="dx1-40040"></a> style is like the <span +class="ecss-1000">long4colborder</span><a + id="dx1-40041"></a> but + allows multi-line descriptions and page lists. + </dd><dt class="description"> +<span +class="ecbx-1000">altlong4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">altlong4colheader</span><a + id="dx1-40042"></a> style is like <span +class="ecss-1000">long4colheader</span><a + id="dx1-40043"></a> but allows + multi-line descriptions and page lists. + </dd><dt class="description"> +<span +class="ecbx-1000">altlong4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altlong4colheaderborder</span><a + id="dx1-40044"></a> + style is like <span +class="ecss-1000">long4colheaderborder</span><a + id="dx1-40045"></a> but allows multi-line descriptions and page + lists.</dd></dl> +<!--l. 4321--><p class="noindent" > +</p> +<!--l. 4321--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.3 </span> <a + id="x1-410002.12.3"></a>Longtable Styles (Ragged Right)</h5> +<!--l. 4324--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-longragged</span><a + id="dx1-41001"></a>. +These styles are analogous to those defined in <span +class="ecss-1000">glossary-long</span><a + id="dx1-41002"></a> but the multiline +columns are left justified instead of fully justified. Since these styles all use + + + +the <span +class="ecss-1000">longtable</span><a + id="dx1-41003"></a> environment, they are governed by the same parameters as that +environment. The <span +class="ecss-1000">glossary-longragged</span><a + id="dx1-41004"></a> package additionally requires the <span +class="ecss-1000">array</span><a + id="dx1-41005"></a> +package. Note that these styles will only be available if you explicitly load +<span +class="ecss-1000">glossary-longragged</span><a + id="dx1-41006"></a>: + + + +</p> + <div class="verbatim" id="verbatim-111"> \usepackage{glossaries} -\usepackage{glossary-longragged} -</PRE> -Note that you can't set these styles using the <TT>style</TT><A NAME="8536"></A> -package option since the styles aren't defined until after -the <TT>glossaries</TT> package has been loaded. - -<P> -<DL> -<DT><STRONG>longragged</STRONG></DT> -<DD>The <TT>longragged</TT><A NAME="8541"></A> style has two -columns: the first column contains the entry's name and the second -column contains the (left-justified) description followed by the -number list<A NAME="8542"></A>. The entry's symbol is ignored. -Sub groups are separated with a blank row. The width of the -first column is governed by the widest entry in that column. The -width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8544"></A>. Child entries have a similar format to the -parent entries except that their name is suppressed. - -<P> -</DD> -<DT><STRONG>longraggedborder</STRONG></DT> -<DD>The <TT>longraggedborder</TT><A NAME="8547"></A> style is like -<TT>longragged</TT><A NAME="8549"></A> but has horizontal and vertical lines around it. - -<P> -</DD> -<DT><STRONG>longraggedheader</STRONG></DT> -<DD>The <TT>longraggedheader</TT><A NAME="8551"></A> style is like -<TT>longragged</TT><A NAME="8553"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>longraggedheaderborder</STRONG></DT> -<DD>The <TT>longraggedheaderborder</TT><A NAME="8555"></A> -style is like <TT>longraggedheader</TT><A NAME="8557"></A> but has horizontal and -vertical lines around it. - -<P> -</DD> -<DT><STRONG>longragged3col</STRONG></DT> -<DD>The <TT>longragged3col</TT><A NAME="8559"></A> style is like -<TT>longragged</TT><A NAME="8561"></A> but has three columns. The first column -contains the entry's name, the second column contains the (left -justified) description and the third column contains the (left -justified) number list<A NAME="8562"></A>. The entry's symbol is ignored. The -width of the first column is governed by the widest entry in that -column, the width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8564"></A>, and the width of the third column is governed by -the length <TT>\glspagelistwidth</TT><A NAME="8567"></A>. - -<P> -</DD> -<DT><STRONG>longragged3colborder</STRONG></DT> -<DD>The <TT>longragged3colborder</TT><A NAME="8570"></A> -style is like the <TT>longragged3col</TT><A NAME="8572"></A> style but has horizontal -and vertical lines around it. - -<P> -</DD> -<DT><STRONG>longragged3colheader</STRONG></DT> -<DD>The <TT>longragged3colheader</TT><A NAME="8574"></A> style is like -<TT>longragged3col</TT><A NAME="8576"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>longragged3colheaderborder</STRONG></DT> -<DD>The <TT>longragged3colheaderborder</TT><A NAME="8578"></A> style is -like <TT>longragged3colheader</TT><A NAME="8580"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>altlongragged4col</STRONG></DT> -<DD>The <TT>altlongragged4col</TT><A NAME="8582"></A> style is -like <TT>longragged3col</TT><A NAME="8584"></A> but has an additional column in which -the entry's associated symbol appears. The width of the description -column is governed by the length <TT>\glsdescwidth</TT><A NAME="8586"></A> and the width of -the page list column is governed by the length -<TT>\glspagelistwidth</TT><A NAME="8589"></A>. The widths of the name and symbol columns -are governed by the widest entry in the given column. - -<P> -</DD> -<DT><STRONG>altlongragged4colborder</STRONG></DT> -<DD>The -<TT>altlongragged4colborder</TT><A NAME="8592"></A> style is like the -<TT>altlongragged4col</TT><A NAME="8594"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>altlongragged4colheader</STRONG></DT> -<DD>The -<TT>altlongragged4colheader</TT><A NAME="8596"></A> style is like -<TT>altlongragged4col</TT><A NAME="8598"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>altlongragged4colheaderborder</STRONG></DT> -<DD>The -<TT>altlongragged4colheaderborder</TT><A NAME="8600"></A> style is like -<TT>altlongragged4colheader</TT><A NAME="8602"></A> but has horizontal and vertical -lines around it. - -<P> -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312400000000000000"></A> -<A NAME="sec:superstyles"></A> -<BR> -Supertabular Styles -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-super</TT><A NAME="8607"></A>. Since they all use the <TT>supertabular</TT> -environment, they are governed by the same parameters as that -environment. Note that these styles will automatically be available -unless you use the <TT>nosuper</TT><A NAME="8616"></A> or <TT>nostyles</TT><A NAME="8625"></A> package -options. In general, the <TT>longtable</TT> environment is better, -but there are some circumstances where it is better to use -<TT>supertabular</TT>.<A NAME="tex2html39" - HREF="#foot4421"><SUP>15</SUP></A> These styles fully justify the description and page list -columns. If you want ragged right formatting instead, use the -analogous styles described in -<A HREF="glossaries-manual.html#sec:superraggedstyles">Supertabular -Styles (Ragged Right)</A>. - -<P> -<DL> -<DT><STRONG>super</STRONG></DT> -<DD>The <TT>super</TT><A NAME="8634"></A> style uses the <TT>supertabular</TT> -environment (defined by the <TT>supertabular</TT><A NAME="8637"></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="8639"></A>. -The entry's symbol is ignored. -Sub groups are separated with a blank row. The width of the -first column is governed by the widest entry in that column. The -width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8641"></A>. Child entries have a similar format to the -parent entries except that their name is suppressed. - -<P> -</DD> -<DT><STRONG>superborder</STRONG></DT> -<DD>The <TT>superborder</TT><A NAME="8644"></A> style is like -<TT>super</TT><A NAME="8646"></A> but has horizontal and vertical lines around it. - -<P> -</DD> -<DT><STRONG>superheader</STRONG></DT> -<DD>The <TT>superheader</TT><A NAME="8648"></A> style is like -<TT>super</TT><A NAME="8650"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>superheaderborder</STRONG></DT> -<DD>The <TT>superheaderborder</TT><A NAME="8652"></A> style is -like <TT>superheader</TT><A NAME="8654"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>super3col</STRONG></DT> -<DD>The <TT>super3col</TT><A NAME="8656"></A> style is like -<TT>super</TT><A NAME="8658"></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="8659"></A>. The -entry's symbol is ignored. The width of the -first column is governed by the widest entry in that column. The -width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8661"></A>. The width of the third column is governed by the -length <TT>\glspagelistwidth</TT><A NAME="8664"></A>. - -<P> -</DD> -<DT><STRONG>super3colborder</STRONG></DT> -<DD>The <TT>super3colborder</TT><A NAME="8667"></A> style is like -the <TT>super3col</TT><A NAME="8669"></A> style but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>super3colheader</STRONG></DT> -<DD>The <TT>super3colheader</TT><A NAME="8671"></A> style is like -<TT>super3col</TT><A NAME="8673"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>super3colheaderborder</STRONG></DT> -<DD>The <TT>super3colheaderborder</TT><A NAME="8675"></A> style -is like <TT>super3colheader</TT><A NAME="8677"></A> but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>super4col</STRONG></DT> -<DD>The <TT>super4col</TT><A NAME="8679"></A> style is like -<TT>super3col</TT><A NAME="8681"></A> but has an additional column in which the -entry's associated symbol appears. This style is designed for -entries with brief single line descriptions. The column widths are governed by the -widest entry in the given column. Use <TT>altsuper4col</TT><A NAME="8683"></A> -for multi-line descriptions. - -<P> -</DD> -<DT><STRONG>super4colborder</STRONG></DT> -<DD>The <TT>super4colborder</TT><A NAME="8685"></A> style is like -the <TT>super4col</TT><A NAME="8687"></A> style but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>super4colheader</STRONG></DT> -<DD>The <TT>super4colheader</TT><A NAME="8689"></A> style is like -<TT>super4col</TT><A NAME="8691"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>super4colheaderborder</STRONG></DT> -<DD>The <TT>super4colheaderborder</TT><A NAME="8693"></A> style -is like <TT>super4colheader</TT><A NAME="8695"></A> but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>altsuper4col</STRONG></DT> -<DD>The <TT>altsuper4col</TT><A NAME="8697"></A> style is like -<TT>super4col</TT><A NAME="8699"></A> but allows multi-line descriptions and page -lists. -The width of the description column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8701"></A> and the width of the page list column is -governed by the length <TT>\glspagelistwidth</TT><A NAME="8704"></A>. The width of the name -and symbol columns is governed by the widest entry in the -given column. - -<P> -</DD> -<DT><STRONG>altsuper4colborder</STRONG></DT> -<DD>The <TT>altsuper4colborder</TT><A NAME="8707"></A> style is like -the <TT>super4colborder</TT><A NAME="8709"></A> style but allows multi-line descriptions -and page lists. - -<P> -</DD> -<DT><STRONG>altsuper4colheader</STRONG></DT> -<DD>The <TT>altsuper4colheader</TT><A NAME="8711"></A> style is like -<TT>super4colheader</TT><A NAME="8713"></A> but allows multi-line descriptions and -page lists. - -<P> -</DD> -<DT><STRONG>altsuper4colheaderborder</STRONG></DT> -<DD>The <TT>altsuper4colheaderborder</TT><A NAME="8715"></A> -style is like <TT>super4colheaderborder</TT><A NAME="8717"></A> but allows multi-line -descriptions and page lists. -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312500000000000000"></A> -<A NAME="sec:superraggedstyles"></A> -<BR> -Supertabular Styles (Ragged Right) -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-superragged</TT><A NAME="8722"></A>. These styles are analogous to those -defined in <TT>glossary-super</TT><A NAME="8725"></A> but the multiline columns are left -justified instead of fully justified. Since these styles all use the -<TT>supertabular</TT> environment, they are governed by the same -parameters as that environment. The <TT>glossary-superragged</TT><A NAME="8729"></A> -package additionally requires the <TT>array</TT><A NAME="8732"></A> package. Note that -these styles will only be available if you explicitly load -<TT>glossary-superragged</TT><A NAME="8735"></A>: -<PRE> + <br />\usepackage{glossary-longragged} +</div> +<!--l. 4336--><p class="nopar" > Note that you can’t set these styles using the <span +class="ecss-1000">style</span><a + id="dx1-41007"></a> package option since the styles +aren’t defined until after the <span +class="ecss-1000">glossaries </span>package has been loaded. +</p><!--l. 4341--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">longragged</span> </dt><dd +class="description">The <span +class="ecss-1000">longragged</span><a + id="dx1-41008"></a> style has two columns: the first column contains the + entry’s name and the second column contains the (left-justified) description + followed by the number list<a + id="dx1-41009"></a>. The entry’s symbol is ignored. Sub groups are + separated with a blank row. The width of the first column is governed by the + widest entry in that column. The width of the second column is governed by + the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-41010"></a>. Child entries have a similar format to the parent + entries except that their name is suppressed. + </dd><dt class="description"> +<span +class="ecbx-1000">longraggedborder</span> </dt><dd +class="description">The <span +class="ecss-1000">longraggedborder</span><a + id="dx1-41011"></a> style is like <span +class="ecss-1000">longragged</span><a + id="dx1-41012"></a> but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">longraggedheader</span> </dt><dd +class="description">The <span +class="ecss-1000">longraggedheader</span><a + id="dx1-41013"></a> style is like <span +class="ecss-1000">longragged</span><a + id="dx1-41014"></a> but has a header + row. + </dd><dt class="description"> +<span +class="ecbx-1000">longraggedheaderborder</span> </dt><dd +class="description">The + <span +class="ecss-1000">longraggedheaderborder</span><a + id="dx1-41015"></a> style is like <span +class="ecss-1000">longraggedheader</span><a + id="dx1-41016"></a> but has horizontal and + vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">longragged3col</span> </dt><dd +class="description">The <span +class="ecss-1000">longragged3col</span><a + id="dx1-41017"></a> style is like <span +class="ecss-1000">longragged</span><a + id="dx1-41018"></a> but has three + columns. The first column contains the entry’s name, the second column + contains the (left justified) description and the third column contains the + (left justified) number list<a + id="dx1-41019"></a>. The entry’s symbol is ignored. The width of the + first column is governed by the widest entry in that column, the width of + the second column is governed by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-41020"></a>, and the width + of the third column is governed by the length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-41021"></a>. + </dd><dt class="description"> +<span +class="ecbx-1000">longragged3colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">longragged3colborder</span><a + id="dx1-41022"></a> style is like the <span +class="ecss-1000">longragged3col</span><a + id="dx1-41023"></a> + style but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">longragged3colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">longragged3colheader</span><a + id="dx1-41024"></a> style is like <span +class="ecss-1000">longragged3col</span><a + id="dx1-41025"></a> but + has a header row. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">longragged3colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">longragged3colheaderborder</span><a + id="dx1-41026"></a> style is like + <span +class="ecss-1000">longragged3colheader</span><a + id="dx1-41027"></a> but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altlongragged4col</span> </dt><dd +class="description">The <span +class="ecss-1000">altlongragged4col</span><a + id="dx1-41028"></a> style is like <span +class="ecss-1000">longragged3col</span><a + id="dx1-41029"></a> but has an + additional column in which the entry’s associated symbol appears. The width + of the description column is governed by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-41030"></a> and the + width of the page list column is governed by the length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-41031"></a>. + The widths of the name and symbol columns are governed by the widest + entry in the given column. + </dd><dt class="description"> +<span +class="ecbx-1000">altlongragged4colborder</span> </dt><dd +class="description">The + <span +class="ecss-1000">altlongragged4colborder</span><a + id="dx1-41032"></a> style is like the <span +class="ecss-1000">altlongragged4col</span><a + id="dx1-41033"></a> but has horizontal + and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altlongragged4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">altlongragged4colheader</span><a + id="dx1-41034"></a> style is like + <span +class="ecss-1000">altlongragged4col</span><a + id="dx1-41035"></a> but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">altlongragged4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altlongragged4colheaderborder</span><a + id="dx1-41036"></a> style is like + <span +class="ecss-1000">altlongragged4colheader</span><a + id="dx1-41037"></a> but has horizontal and vertical lines around it. + </dd></dl> +<!--l. 4408--><p class="noindent" > +</p> +<!--l. 4408--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.4 </span> <a + id="x1-420002.12.4"></a>Supertabular Styles</h5> +<!--l. 4411--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-super</span><a + id="dx1-42001"></a>. Since +they all use the <span +class="ecss-1000">supertabular</span><a + id="dx1-42002"></a> environment, they are governed by the same parameters +as that environment. Note that these styles will automatically be available +unless you use the <span +class="ecss-1000">nosuper</span><a + id="dx1-42003"></a> or <span +class="ecss-1000">nostyles</span><a + id="dx1-42004"></a> package options. In general, the <span +class="ecss-1000">longtable</span><a + id="dx1-42005"></a> +environment is better, but there are some circumstances where it is better to use +<span +class="ecss-1000">supertabular</span><a + id="dx1-42006"></a>.<span class="footnote-mark"><a +href="#fn14x0" id="fn14x0-bk"><sup class="textsuperscript">14</sup></a></span><a + id="x1-42007f14"></a> +These styles fully justify the description and page list columns. If you want ragged right +formatting instead, use the analogous styles described in <a +href="#x1-430002.12.5">§2.12.5 </a><a +href="#x1-430002.12.5">Supertabular Styles +(Ragged Right)<!--tex4ht:ref: sec:superraggedstyles --></a>. +</p><!--l. 4423--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">super</span> </dt><dd +class="description">The <span +class="ecss-1000">super</span><a + id="dx1-42009"></a> style uses the <span +class="ecss-1000">supertabular</span><a + id="dx1-42010"></a> environment (defined by the + <span +class="ecss-1000">supertabular</span><a + id="dx1-42011"></a> package). It has two columns: the first column contains the + entry’s name and the second column contains the description followed by the + number list<a + id="dx1-42012"></a>. The entry’s symbol is ignored. Sub groups are separated with + + + + a blank row. The width of the first column is governed by the widest entry + in that column. The width of the second column is governed by the length + <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-42013"></a>. Child entries have a similar format to the parent entries + except that their name is suppressed. + </dd><dt class="description"> +<span +class="ecbx-1000">superborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superborder</span><a + id="dx1-42014"></a> style is like <span +class="ecss-1000">super</span><a + id="dx1-42015"></a> but has horizontal and vertical + lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">superheader</span> </dt><dd +class="description">The <span +class="ecss-1000">superheader</span><a + id="dx1-42016"></a> style is like <span +class="ecss-1000">super</span><a + id="dx1-42017"></a> but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">superheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superheaderborder</span><a + id="dx1-42018"></a> style is like <span +class="ecss-1000">superheader</span><a + id="dx1-42019"></a> but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">super3col</span> </dt><dd +class="description">The <span +class="ecss-1000">super3col</span><a + id="dx1-42020"></a> style is like <span +class="ecss-1000">super</span><a + id="dx1-42021"></a> but has three columns. The + first column contains the entry’s name, the second column contains the + description and the third column contains the number list<a + id="dx1-42022"></a>. The entry’s + symbol is ignored. The width of the first column is governed by the widest + entry in that column. The width of the second column is governed by the + length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-42023"></a>. The width of the third column is governed by the + length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-42024"></a>. + </dd><dt class="description"> +<span +class="ecbx-1000">super3colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">super3colborder</span><a + id="dx1-42025"></a> style is like the <span +class="ecss-1000">super3col</span><a + id="dx1-42026"></a> style but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">super3colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">super3colheader</span><a + id="dx1-42027"></a> style is like <span +class="ecss-1000">super3col</span><a + id="dx1-42028"></a> but has a header + row. + </dd><dt class="description"> +<span +class="ecbx-1000">super3colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">super3colheaderborder</span><a + id="dx1-42029"></a> style is like <span +class="ecss-1000">super3colheader</span><a + id="dx1-42030"></a> + but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">super4col</span> </dt><dd +class="description">The <span +class="ecss-1000">super4col</span><a + id="dx1-42031"></a> style is like <span +class="ecss-1000">super3col</span><a + id="dx1-42032"></a> but has an additional column in + which the entry’s associated symbol appears. This style is designed for entries + with brief single line descriptions. The column widths are governed by the + widest entry in the given column. Use <span +class="ecss-1000">altsuper4col</span><a + id="dx1-42033"></a> for multi-line descriptions. + </dd><dt class="description"> +<span +class="ecbx-1000">super4colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">super4colborder</span><a + id="dx1-42034"></a> style is like the <span +class="ecss-1000">super4col</span><a + id="dx1-42035"></a> style but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">super4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">super4colheader</span><a + id="dx1-42036"></a> style is like <span +class="ecss-1000">super4col</span><a + id="dx1-42037"></a> but has a header + row. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">super4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">super4colheaderborder</span><a + id="dx1-42038"></a> style is like <span +class="ecss-1000">super4colheader</span><a + id="dx1-42039"></a> + but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuper4col</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuper4col</span><a + id="dx1-42040"></a> style is like <span +class="ecss-1000">super4col</span><a + id="dx1-42041"></a> but allows multi-line + descriptions and page lists. The width of the description column is governed + by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-42042"></a> and the width of the page list column is + governed by the length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-42043"></a>. The width of the name and + symbol columns is governed by the widest entry in the given column. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuper4colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuper4colborder</span><a + id="dx1-42044"></a> style is like the <span +class="ecss-1000">super4colborder</span><a + id="dx1-42045"></a> style + but allows multi-line descriptions and page lists. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuper4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuper4colheader</span><a + id="dx1-42046"></a> style is like <span +class="ecss-1000">super4colheader</span><a + id="dx1-42047"></a> but + allows multi-line descriptions and page lists. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuper4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuper4colheaderborder</span><a + id="dx1-42048"></a> style is like + <span +class="ecss-1000">super4colheaderborder</span><a + id="dx1-42049"></a> but allows multi-line descriptions and page lists.</dd></dl> +<!--l. 4507--><p class="noindent" > +</p> +<!--l. 4507--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.5 </span> <a + id="x1-430002.12.5"></a>Supertabular Styles (Ragged Right)</h5> +<!--l. 4510--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-superragged</span><a + id="dx1-43001"></a>. +These styles are analogous to those defined in <span +class="ecss-1000">glossary-super</span><a + id="dx1-43002"></a> but the multiline +columns are left justified instead of fully justified. Since these styles all use the +<span +class="ecss-1000">supertabular</span><a + id="dx1-43003"></a> environment, they are governed by the same parameters as that +environment. The <span +class="ecss-1000">glossary-superragged</span><a + id="dx1-43004"></a> package additionally requires the <span +class="ecss-1000">array</span><a + id="dx1-43005"></a> +package. Note that these styles will only be available if you explicitly load +<span +class="ecss-1000">glossary-superragged</span><a + id="dx1-43006"></a>: + + + +</p> + <div class="verbatim" id="verbatim-112"> \usepackage{glossaries} -\usepackage{glossary-superragged} -</PRE> -Note that you can't set these styles using the <TT>style</TT><A NAME="8743"></A> -package option since the styles aren't defined until after -the <TT>glossaries</TT> package has been loaded. - -<P> -<DL> -<DT><STRONG>superragged</STRONG></DT> -<DD>The <TT>superragged</TT><A NAME="8748"></A> style uses the -<TT>supertabular</TT> environment (defined by the -<TT>supertabular</TT><A NAME="8751"></A> package). It has two columns: the first column -contains the entry's name and the second column contains the (left -justified) description followed by the number list<A NAME="8753"></A>. The -entry's symbol is ignored. Sub groups are separated with a blank -row. The width of the first column is governed by the widest entry -in that column. The width of the second column is governed by the -length <TT>\glsdescwidth</TT><A NAME="8755"></A>. Child entries have a similar format to -the parent entries except that their name is suppressed. - -<P> -</DD> -<DT><STRONG>superraggedborder</STRONG></DT> -<DD>The <TT>superraggedborder</TT><A NAME="8758"></A> style is -like <TT>superragged</TT><A NAME="8760"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>superraggedheader</STRONG></DT> -<DD>The <TT>superraggedheader</TT><A NAME="8762"></A> style is -like <TT>superragged</TT><A NAME="8764"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>superraggedheaderborder</STRONG></DT> -<DD>The -<TT>superraggedheaderborder</TT><A NAME="8766"></A> style is like -<TT>superraggedheader</TT><A NAME="8768"></A> but has horizontal and vertical lines -around it. - -<P> -</DD> -<DT><STRONG>superragged3col</STRONG></DT> -<DD>The <TT>superragged3col</TT><A NAME="8770"></A> style is like -<TT>superragged</TT><A NAME="8772"></A> but has three columns. The first column -contains the entry's name, the second column contains the (left -justified) description and the third column contains the (left -justified) number list<A NAME="8773"></A>. The entry's symbol is ignored. The -width of the first column is governed by the widest entry in that -column. The width of the second column is governed by the length -<TT>\glsdescwidth</TT><A NAME="8775"></A>. The width of the third column is governed by the -length <TT>\glspagelistwidth</TT><A NAME="8778"></A>. - -<P> -</DD> -<DT><STRONG>superragged3colborder</STRONG></DT> -<DD>The <TT>superragged3colborder</TT><A NAME="8781"></A> -style is like the <TT>superragged3col</TT><A NAME="8783"></A> style but has -horizontal and vertical lines around it. - -<P> -</DD> -<DT><STRONG>superragged3colheader</STRONG></DT> -<DD>The <TT>superragged3colheader</TT><A NAME="8785"></A> -style is like <TT>superragged3col</TT><A NAME="8787"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>superragged3colheaderborder</STRONG></DT> -<DD>The -<TT>superragged3colheaderborder</TT><A NAME="8789"></A> style is like -<TT>superragged3colheader</TT><A NAME="8791"></A> but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>altsuperragged4col</STRONG></DT> -<DD>The <TT>altsuperragged4col</TT><A NAME="8793"></A> style is -like <TT>superragged3col</TT><A NAME="8795"></A> but has an additional column in -which the entry's associated symbol appears. The column widths for -the name and symbol column are governed by the widest entry in the -given column. - -<P> -</DD> -<DT><STRONG>altsuperragged4colborder</STRONG></DT> -<DD>The -<TT>altsuperragged4colborder</TT><A NAME="8797"></A> style is like the -<TT>altsuperragged4col</TT><A NAME="8799"></A> style but has horizontal and vertical -lines around it. - -<P> -</DD> -<DT><STRONG>altsuperragged4colheader</STRONG></DT> -<DD>The -<TT>altsuperragged4colheader</TT><A NAME="8801"></A> style is like -<TT>altsuperragged4col</TT><A NAME="8803"></A> but has a header row. - -<P> -</DD> -<DT><STRONG>altsuperragged4colheaderborder</STRONG></DT> -<DD>The -<TT>altsuperragged4colheaderborder</TT><A NAME="8805"></A> style is like -<TT>altsuperragged4colheader</TT><A NAME="8807"></A> but has horizontal and vertical -lines around it. - -<P> -</DD> -</DL> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000312600000000000000"></A> -<A NAME="sec:treestyles"></A> -<BR> -Tree-Like Styles -</H3> - -<P> -The styles described in this section are all defined in the package -<TT>glossary-tree</TT><A NAME="8812"></A>. These styles are designed for hierarchical -glossaries but can also be used with glossaries that don't have -sub-entries. These styles will display the entry's symbol if it -exists. Note that these styles will automatically be available -unless you use the <TT>notree</TT><A NAME="8820"></A> or <TT>nostyles</TT><A NAME="8829"></A> package + <br />\usepackage{glossary-superragged} +</div> +<!--l. 4522--><p class="nopar" > Note that you can’t set these styles using the <span +class="ecss-1000">style</span><a + id="dx1-43007"></a> package option since the styles +aren’t defined until after the <span +class="ecss-1000">glossaries </span>package has been loaded. +</p><!--l. 4527--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">superragged</span> </dt><dd +class="description">The <span +class="ecss-1000">superragged</span><a + id="dx1-43008"></a> style uses the <span +class="ecss-1000">supertabular</span><a + id="dx1-43009"></a> environment (defined by + the <span +class="ecss-1000">supertabular</span><a + id="dx1-43010"></a> package). It has two columns: the first column contains the + entry’s name and the second column contains the (left justified) description + followed by the number list<a + id="dx1-43011"></a>. The entry’s symbol is ignored. Sub groups are + separated with a blank row. The width of the first column is governed by the + widest entry in that column. The width of the second column is governed by + the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-43012"></a>. Child entries have a similar format to the parent + entries except that their name is suppressed. + </dd><dt class="description"> +<span +class="ecbx-1000">superraggedborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superraggedborder</span><a + id="dx1-43013"></a> style is like <span +class="ecss-1000">superragged</span><a + id="dx1-43014"></a> but has + horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">superraggedheader</span> </dt><dd +class="description">The <span +class="ecss-1000">superraggedheader</span><a + id="dx1-43015"></a> style is like <span +class="ecss-1000">superragged</span><a + id="dx1-43016"></a> but has a + header row. + </dd><dt class="description"> +<span +class="ecbx-1000">superraggedheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superraggedheaderborder</span><a + id="dx1-43017"></a> style is like + <span +class="ecss-1000">superraggedheader</span><a + id="dx1-43018"></a> but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">superragged3col</span> </dt><dd +class="description">The <span +class="ecss-1000">superragged3col</span><a + id="dx1-43019"></a> style is like <span +class="ecss-1000">superragged</span><a + id="dx1-43020"></a> but has three + columns. The first column contains the entry’s name, the second column + contains the (left justified) description and the third column contains the + (left justified) number list<a + id="dx1-43021"></a>. The entry’s symbol is ignored. The width of the + first column is governed by the widest entry in that column. The width of + the second column is governed by the length <span +class="ectt-1000">\glsdescwidth</span><a + id="dx1-43022"></a>. The width of + the third column is governed by the length <span +class="ectt-1000">\glspagelistwidth</span><a + id="dx1-43023"></a>. + </dd><dt class="description"> +<span +class="ecbx-1000">superragged3colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superragged3colborder</span><a + id="dx1-43024"></a> style + is like the <span +class="ecss-1000">superragged3col</span><a + id="dx1-43025"></a> style but has horizontal and vertical lines around + it. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">superragged3colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">superragged3colheader</span><a + id="dx1-43026"></a> style is like <span +class="ecss-1000">superragged3col</span><a + id="dx1-43027"></a> + but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">superragged3colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">superragged3colheaderborder</span><a + id="dx1-43028"></a> style is like + <span +class="ecss-1000">superragged3colheader</span><a + id="dx1-43029"></a> but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuperragged4col</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuperragged4col</span><a + id="dx1-43030"></a> style is like <span +class="ecss-1000">superragged3col</span><a + id="dx1-43031"></a> but has + an additional column in which the entry’s associated symbol appears. The + column widths for the name and symbol column are governed by the widest + entry in the given column. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuperragged4colborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuperragged4colborder</span><a + id="dx1-43032"></a> style is like the + <span +class="ecss-1000">altsuperragged4col</span><a + id="dx1-43033"></a> style but has horizontal and vertical lines around it. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuperragged4colheader</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuperragged4colheader</span><a + id="dx1-43034"></a> style is like + <span +class="ecss-1000">altsuperragged4col</span><a + id="dx1-43035"></a> but has a header row. + </dd><dt class="description"> +<span +class="ecbx-1000">altsuperragged4colheaderborder</span> </dt><dd +class="description">The <span +class="ecss-1000">altsuperragged4colheaderborder</span><a + id="dx1-43036"></a> style is + like <span +class="ecss-1000">altsuperragged4colheader</span><a + id="dx1-43037"></a> but has horizontal and vertical lines around it. + </dd></dl> +<!--l. 4596--><p class="noindent" > +</p> +<!--l. 4596--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.12.6 </span> <a + id="x1-440002.12.6"></a>Tree-Like Styles</h5> +<!--l. 4599--><p class="noindent" >The styles described in this section are all defined in the package <span +class="ecss-1000">glossary-tree</span><a + id="dx1-44001"></a>. These +styles are designed for hierarchical glossaries but can also be used with glossaries that +don’t have sub-entries. These styles will display the entry’s symbol if it exists. Note that +these styles will automatically be available unless you use the <span +class="ecss-1000">notree</span><a + id="dx1-44002"></a> or <span +class="ecss-1000">nostyles</span><a + id="dx1-44003"></a> package options. +</p><!--l. 4607--><p class="indent" > + </p><dl class="description"><dt class="description"> +<span +class="ecbx-1000">index</span> </dt><dd +class="description">The <span +class="ecss-1000">index</span><a + id="dx1-44004"></a> style is similar to the way indices are usually formatted in that + it has a hierarchical structure up to three levels (the main level plus two + sub-levels). The name is typeset in bold, and if the symbol is present it is + set in parentheses after the name and before the description. Sub-entries are + indented and also include the name, the symbol in brackets (if present) and + the description. Groups are separated using <span +class="ectt-1000">\indexspace</span><a + id="dx1-44005"></a>. + + + + </dd><dt class="description"> +<span +class="ecbx-1000">indexgroup</span> </dt><dd +class="description">The <span +class="ecss-1000">indexgroup</span><a + id="dx1-44006"></a> style is similar to the <span +class="ecss-1000">index</span><a + id="dx1-44007"></a> style except that each + group has a heading. + </dd><dt class="description"> +<span +class="ecbx-1000">indexhypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">indexhypergroup</span><a + id="dx1-44008"></a> style is like <span +class="ecss-1000">indexgroup</span><a + id="dx1-44009"></a> but has a set of + links to the glossary groups. The navigation line is the same as that for + <span +class="ecss-1000">listhypergroup</span><a + id="dx1-44010"></a>, described above. + </dd><dt class="description"> +<span +class="ecbx-1000">tree</span> </dt><dd +class="description">The <span +class="ecss-1000">tree</span><a + id="dx1-44011"></a> style is similar to the <span +class="ecss-1000">index</span><a + id="dx1-44012"></a> style except that it can have arbitrary + levels. (Note that <span +class="ectt-1000">makeindex</span><a + id="dx1-44013"></a> is limited to three levels, so you will need to + use <span +class="ectt-1000">xindy</span><a + id="dx1-44014"></a> if you want more than three levels.) Each sub-level is indented by + <span class="marginpar"><span +class="ectt-0900">\glstreeindent</span><span +class="ectt-0900"> </span></span><a + id="dx1-44015"></a><span +class="ectt-1000">\glstreeindent</span>. Note that the name, symbol (if present) + and description are placed in the same paragraph block. If you want the + name to be apart from the description, use the <span +class="ecss-1000">alttree</span><a + id="dx1-44016"></a> style instead. (See + below.) + </dd><dt class="description"> +<span +class="ecbx-1000">treegroup</span> </dt><dd +class="description">The <span +class="ecss-1000">treegroup</span><a + id="dx1-44017"></a> style is similar to the <span +class="ecss-1000">tree</span><a + id="dx1-44018"></a> style except that each group + has a heading. + </dd><dt class="description"> +<span +class="ecbx-1000">treehypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">treehypergroup</span><a + id="dx1-44019"></a> style is like <span +class="ecss-1000">treegroup</span><a + id="dx1-44020"></a> but has a set of links to + the glossary groups. The navigation line is the same as that for <span +class="ecss-1000">listhypergroup</span><a + id="dx1-44021"></a>, + described above. + </dd><dt class="description"> +<span +class="ecbx-1000">treenoname</span> </dt><dd +class="description">The <span +class="ecss-1000">treenoname</span><a + id="dx1-44022"></a> style is like the <span +class="ecss-1000">tree</span><a + id="dx1-44023"></a> style except that the name for + each sub-entry is ignored. + </dd><dt class="description"> +<span +class="ecbx-1000">treenonamegroup</span> </dt><dd +class="description">The <span +class="ecss-1000">treenonamegroup</span><a + id="dx1-44024"></a> style is similar to the <span +class="ecss-1000">treenoname</span><a + id="dx1-44025"></a> style + except that each group has a heading. + </dd><dt class="description"> +<span +class="ecbx-1000">treenonamehypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">treenonamehypergroup</span><a + id="dx1-44026"></a> + style is like <span +class="ecss-1000">treenonamegroup</span><a + id="dx1-44027"></a> but has a set of links to the glossary groups. + The navigation line is the same as that for <span +class="ecss-1000">listhypergroup</span><a + id="dx1-44028"></a>, described above. + </dd><dt class="description"> +<span +class="ecbx-1000">alttree</span> </dt><dd +class="description">The <span +class="ecss-1000">alttree</span><a + id="dx1-44029"></a> style is similar to the <span +class="ecss-1000">tree</span><a + id="dx1-44030"></a> style except that the indentation for each + level is determined by the width of the text specified by + <!--l. 4659--><p class="noindent" ><hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glssetwidest</span><span +class="ectt-0900"> </span></span><a + id="dx1-44031"></a><span +class="ectt-1000">\glssetwidest[</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">level</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">]{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> + </p><!--l. 4661--><p class="noindent" > + The optional argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">level</span><span +class="cmsy-10">⟩ </span>indicates the level, where 0 indicates the top-most + level, 1 indicates the first level sub-entries, etc. If <span +class="ectt-1000">\glssetwidest </span>hasn’t been + used for a given sub-level, the level 0 widest text is used instead. If <span +class="cmsy-10">⟨</span><span +class="ecti-1000">level</span><span +class="cmsy-10">⟩ </span>is + omitted, 0 is assumed. + + + + </p><!--l. 4668--><p class="noindent" >For each level, the name is placed to the left of the paragraph block containing the + symbol (optional) and the description. If the symbol is present, it is placed in + parentheses before the description. + </p></dd><dt class="description"> +<span +class="ecbx-1000">alttreegroup</span> </dt><dd +class="description">The <span +class="ecss-1000">alttreegroup</span><a + id="dx1-44032"></a> is like the <span +class="ecss-1000">alttree</span><a + id="dx1-44033"></a> style except that each group has a + heading. + </dd><dt class="description"> +<span +class="ecbx-1000">alttreehypergroup</span> </dt><dd +class="description">The <span +class="ecss-1000">alttreehypergroup</span><a + id="dx1-44034"></a> style is like <span +class="ecss-1000">alttreegroup</span><a + id="dx1-44035"></a> but has a set of + links to the glossary groups. The navigation line is the same as that for + <span +class="ecss-1000">listhypergroup</span><a + id="dx1-44036"></a>, described above. + </dd></dl> +<!--l. 4685--><p class="noindent" > +</p> +<!--l. 4685--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.13 </span> <a + id="x1-450002.13"></a>Defining your own glossary style</h4> +<!--l. 4688--><p class="noindent" >If the predefined styles don’t fit your requirements, you can define your own style +using: +</p><!--l. 4690--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\newglossarystyle</span><span +class="ectt-0900"> </span></span><a + id="dx1-45001"></a><span +class="ectt-1000">\newglossarystyle{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">definitions</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4692--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩ </span>is the name of the new glossary style (to be used in <span +class="ectt-1000">\glossarystyle</span>). +The second argument <span +class="cmsy-10">⟨</span><span +class="ecti-1000">definitions</span><span +class="cmsy-10">⟩ </span>needs to redefine all of the following: +</p><!--l. 4697--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">theglossary</span><span +class="ectt-0900"> </span></span><a + id="dx1-45002"></a><a + id="dx1-45003"></a><span +class="ecss-1000">theglossary</span><a + id="dx1-45004"></a> </div><hr> +</p><!--l. 4699--><p class="noindent" > +This environment defines how the main body of the glossary should be typeset. Note +that this does not include the section heading, the glossary preamble (defined by +<span +class="ectt-1000">\glossarypreamble</span>) or the glossary postamble (defined by <span +class="ectt-1000">\glossarypostamble</span>). For +example, the <span +class="ecss-1000">list</span><a + id="dx1-45005"></a> style uses the <span +class="ecss-1000">description</span><a + id="dx1-45006"></a> environment, so the <span +class="ecss-1000">theglossary</span><a + id="dx1-45007"></a> environment +is simply redefined to begin and end the <span +class="ecss-1000">description</span><a + id="dx1-45008"></a> environment. +</p><!--l. 4708--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossaryheader</span><span +class="ectt-0900"> </span></span><a + id="dx1-45009"></a><span +class="ectt-1000">\glossaryheader </span></div><hr> +</p><!--l. 4710--><p class="noindent" > +This macro indicates what to do at the start of the main body of the glossary. Note +that this is not the same as <span +class="ectt-1000">\glossarypreamble</span>, which should not be affected by +changes in the glossary style. The <span +class="ecss-1000">list</span><a + id="dx1-45010"></a> glossary style redefines <span +class="ectt-1000">\glossaryheader </span>to do +nothing, whereas the <span +class="ecss-1000">longheader</span><a + id="dx1-45011"></a> glossary style redefines <span +class="ectt-1000">\glossaryheader </span>to do a +header row. +</p><!--l. 4718--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsgroupheading</span><span +class="ectt-0900"> </span></span><a + id="dx1-45012"></a><span +class="ectt-1000">\glsgroupheading{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4720--><p class="noindent" > +This macro indicates what to do at the start of each logical block within the main body +of the glossary. If you use <span +class="ectt-1000">makeindex</span><a + id="dx1-45013"></a> the glossary is sub-divided into a maximum of +twenty-eight logical blocks that are determined by the first character of the <span +class="ecss-1000">sort</span><a + id="dx1-45014"></a> key (or +<span +class="ecss-1000">name</span><a + id="dx1-45015"></a> key if the <span +class="ecss-1000">sort</span><a + id="dx1-45016"></a> key is omitted). The sub-divisions are in the following order: +symbols, numbers, A, …, Z. If you use <span +class="ectt-1000">xindy</span><a + id="dx1-45017"></a>, the sub-divisions depend on the language + + + +settings. +</p><!--l. 4731--><p class="indent" > Note that the argument to <span +class="ectt-1000">\glsgroupheading </span>is a label <span +class="ecti-1000">not </span>the group title. The +group title can be obtained via +</p><!--l. 4734--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsgetgrouptitle</span><span +class="ectt-0900"> </span></span><a + id="dx1-45018"></a><span +class="ectt-1000">\glsgetgrouptitle{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4736--><p class="noindent" > +This obtains the title as follows: if <span +class="ectt-1000">\</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">groupname </span>exists, this is taken to be the title, +otherwise the title is just <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span>. +</p><!--l. 4741--><p class="indent" > A navigation hypertarget can be created using +</p><!--l. 4742--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsnavhypertarget</span><span +class="ectt-0900"> </span></span><a + id="dx1-45019"></a><span +class="ectt-1000">\glsnavhypertarget{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4744--><p class="noindent" > +For further details about <span +class="ectt-1000">\glsnavhypertarget</span>, see the documented code of +<span +class="ecss-1000">glossary-hypernav</span><a + id="dx1-45020"></a> in <span +class="ectt-1000">glossaries.pdf</span>. +</p><!--l. 4750--><p class="indent" > Most of the predefined glossary styles redefine <span +class="ectt-1000">\glsgroupheading </span>to simply +ignore its argument. The <span +class="ecss-1000">listhypergroup</span><a + id="dx1-45021"></a> style redefines <span +class="ectt-1000">\glsgroupheading </span>as +follows: + -<P> -<DL> -<DT><STRONG>index</STRONG></DT> -<DD>The <TT>index</TT><A NAME="8833"></A> style is similar to the way -indices are usually formatted in that it has a hierarchical -structure up to three levels (the main level plus two sub-levels). -The name is typeset in bold, and if the symbol is present it is set -in parentheses after the name and before the description. -Sub-entries are indented and also include the name, the symbol -in brackets (if present) and the description. Groups are separated -using <TT>\indexspace</TT><A NAME="8835"></A>. - -<P> -</DD> -<DT><STRONG>indexgroup</STRONG></DT> -<DD>The <TT>indexgroup</TT><A NAME="8838"></A> style is similar to -the <TT>index</TT><A NAME="8840"></A> style except that each group has a heading. - -<P> -</DD> -<DT><STRONG>indexhypergroup</STRONG></DT> -<DD>The <TT>indexhypergroup</TT><A NAME="8842"></A> style is like -<TT>indexgroup</TT><A NAME="8844"></A> but has a set of links to the glossary -groups. The navigation line is the same as that for -<TT>listhypergroup</TT><A NAME="8846"></A>, described above. - -<P> -</DD> -<DT><STRONG>tree</STRONG></DT> -<DD>The <TT>tree</TT><A NAME="8848"></A> style is similar to the -<TT>index</TT><A NAME="8850"></A> style except that it can have arbitrary levels. -(Note that <TT>makeindex</TT><A NAME="8852"></A> is limited to three levels, so -you will need to use <TT>xindy</TT><A NAME="8855"></A> if you want more than -three levels.) Each sub-level is indented by -<TT>\glstreeindent</TT>. Note that the -name, symbol (if present) and description are placed in the -same paragraph block. If you want the name to be apart from the -description, use the <TT>alttree</TT><A NAME="8858"></A> style instead. (See below.) - -<P> -</DD> -<DT><STRONG>treegroup</STRONG></DT> -<DD>The <TT>treegroup</TT><A NAME="8860"></A> style is similar to -the <TT>tree</TT><A NAME="8862"></A> style except that each group has a heading. - -<P> -</DD> -<DT><STRONG>treehypergroup</STRONG></DT> -<DD>The <TT>treehypergroup</TT><A NAME="8864"></A> style is like -<TT>treegroup</TT><A NAME="8866"></A> but has a set of links to the glossary -groups. The navigation line is the same as that for -<TT>listhypergroup</TT><A NAME="8868"></A>, described above. - -<P> -</DD> -<DT><STRONG>treenoname</STRONG></DT> -<DD>The <TT>treenoname</TT><A NAME="8870"></A> style is like -the <TT>tree</TT><A NAME="8872"></A> style except that the name for each sub-entry -is ignored. - -<P> -</DD> -<DT><STRONG>treenonamegroup</STRONG></DT> -<DD>The <TT>treenonamegroup</TT><A NAME="8874"></A> style is -similar to the <TT>treenoname</TT><A NAME="8876"></A> style except that each group -has a heading. - -<P> -</DD> -<DT><STRONG>treenonamehypergroup</STRONG></DT> -<DD>The <TT>treenonamehypergroup</TT><A NAME="8878"></A> -style is like <TT>treenonamegroup</TT><A NAME="8880"></A> but has a set of links to -the glossary groups. The navigation line is the same as that for -<TT>listhypergroup</TT><A NAME="8882"></A>, described above. - -<P> -</DD> -<DT><STRONG>alttree</STRONG></DT> -<DD>The <TT>alttree</TT><A NAME="8884"></A> style is similar to the -<TT>tree</TT><A NAME="8886"></A> style except that the indentation for each level -is determined by the width of the text specified by - -<P> -<TT>\glssetwidest[</TT><EM>level</EM><TT>]{</TT><EM>text</EM><TT>}</TT> -<P> -The optional argument <I>level</I> indicates the level, where -0 indicates the top-most level, 1 indicates the first level -sub-entries, etc. If <TT>\glssetwidest</TT> hasn't been used for a -given sub-level, the level 0 widest text is used instead. If -<I>level</I> is omitted, 0 is assumed. - -<P> -For each level, the name is placed to the left of the paragraph -block containing the symbol (optional) and the description. If the -symbol is present, it is placed in parentheses before the -description. - -<P> -</DD> -<DT><STRONG>alttreegroup</STRONG></DT> -<DD>The <TT>alttreegroup</TT><A NAME="8888"></A> is like the -<TT>alttree</TT><A NAME="8890"></A> style except that each group has a heading. - -<P> -</DD> -<DT><STRONG>alttreehypergroup</STRONG></DT> -<DD>The <TT>alttreehypergroup</TT><A NAME="8892"></A> style is -like <TT>alttreegroup</TT><A NAME="8894"></A> but has a set of links to the glossary -groups. The navigation line is the same as that for -<TT>listhypergroup</TT><A NAME="8896"></A>, described above. - -<P> -</DD> -</DL> - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION000313000000000000000"></A> -<A NAME="sec:newglossarystyle"></A> -<BR> -Defining your own glossary style -</H2> - -<P> -If the predefined styles don't fit your requirements, you can -define your own style using: - -<P> -<TT>\newglossarystyle{</TT><EM>name</EM><TT>}{</TT><EM>definitions</EM><TT>}</TT> -<P> -where <I>name</I> is the name of the new glossary style (to be -used in <TT>\glossarystyle</TT>). The second argument <I>definitions</I> -needs to redefine all of the following: - -<P> - -<P> -<TT>theglossary</TT> -<P> -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="8902"></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. - -<P> - -<P> -<TT>\glossaryheader</TT> -<P> -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="8907"></A> glossary style redefines -<TT>\glossaryheader</TT> to do nothing, whereas the <TT>longheader</TT><A NAME="8909"></A> -glossary style redefines <TT>\glossaryheader</TT> to do a header row. - -<P> - -<P> -<TT>\glsgroupheading{</TT><EM>label</EM><TT>}</TT> -<P> -This macro indicates -what to do at the start of each logical block within the main body -of the glossary. If you use <TT>makeindex</TT><A NAME="8911"></A> the glossary is -sub-divided into a maximum of twenty-eight logical blocks that are -determined by the first character of the <TT>sort</TT><A NAME="8914"></A> key (or -<TT>name</TT><A NAME="8917"></A> key if the <TT>sort</TT><A NAME="8920"></A> key is omitted). The -sub-divisions are in the following order: symbols, numbers, A, -..., Z. If you use <TT>xindy</TT><A NAME="8923"></A>, the sub-divisions depend on -the language settings. - -<P> -Note that the argument to <TT>\glsgroupheading</TT> -is a label <I>not</I> the group title. The group title can be obtained -via - -<P> -<TT>\glsgetgrouptitle{</TT><EM>label</EM><TT>}</TT> -<P> -This obtains the title as follows: if -<TT>\</TT><I>label</I><TT>groupname</TT> exists, this is taken to be the -title, otherwise the title is just <I>label</I>. - -<P> -A navigation hypertarget can be created using - -<P> -<TT>\glsnavhypertarget{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> -<P> -For further details about <TT>\glsnavhypertarget</TT>, see -the documented code of <TT>glossary-hypernav</TT><A NAME="8926"></A> -in <TT>glossaries.pdf</TT>. - -<P> -Most of the predefined glossary styles redefine <TT>\glsgroupheading</TT> -to simply ignore its argument. The <TT>listhypergroup</TT><A NAME="8929"></A> style -redefines <TT>\glsgroupheading</TT> as follows: -<PRE> + +</p> + <div class="verbatim" id="verbatim-113"> \renewcommand*{\glsgroupheading}[1]{% -\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} -</PRE> -See also <TT>\glsgroupskip</TT> below. (Note that command definitions within -<TT>\newglossarystyle</TT> must use <code>##1</code> instead of <code>#1</code> etc.) - -<P> - -<P> -<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="8931"></A> glossary -style simply redefines <TT>\glsgroupskip</TT> to be <TT>\indexspace</TT>, -whereas the tabular-like styles redefine <TT>\glsgroupskip</TT> to -produce a blank row. - -<P> - -<P> -<TT>\glossaryentryfield{</TT><EM>label</EM><TT>}{</TT><EM>formatted -name</EM><TT>}{</TT><EM>description</EM><TT>}{</TT><EM>symbol</EM><TT>}</TT> -<TT>{</TT><EM>number list</EM><TT>}</TT> -<P> -This macro indicates what to do for a given glossary entry. -Note that <I>formatted name</I> will always be in the form -<TT>\glsnamefont{</TT><EM>name</EM><TT>}</TT>. This allows the user to set a given -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>. - -<P> -Each time you use a glossary entry it creates a hyperlink (if -hyperlinks are enabled) to the relevant line in the glossary. -Your new glossary style must therefore redefine -<TT>\glossaryentryfield</TT> to set the appropriate target. This -is done using - -<P> -<TT>\glstarget{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> -<P> -where <I>label</I> is the entry's label. Note that you -don't need to worry about whether the <TT>hyperref</TT><A NAME="8933"></A> package has -been loaded, as <TT>\glstarget</TT> won't create a target if -<TT>\hypertarget</TT> hasn't been defined. - -<P> -For example, the -<TT>list</TT><A NAME="8936"></A> style defines <TT>\glossaryentryfield</TT> as follows: -<PRE> + <br />\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} +</div> +<!--l. 4756--><p class="nopar" > See also <span +class="ectt-1000">\glsgroupskip </span>below. (Note that command definitions within +<span +class="ectt-1000">\newglossarystyle </span>must use <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">##1</span></span></span> instead of <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">#1</span></span></span> etc.) +</p><!--l. 4760--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glsgroupskip</span><span +class="ectt-0900"> </span></span><a + id="dx1-45022"></a><span +class="ectt-1000">\glsgroupskip </span></div><hr> +</p><!--l. 4762--><p class="noindent" > +This macro determines what to do after one logical group but before the header for the +next logical group. The <span +class="ecss-1000">list</span><a + id="dx1-45023"></a> glossary style simply redefines <span +class="ectt-1000">\glsgroupskip </span>to be +<span +class="ectt-1000">\indexspace</span>, whereas the tabular-like styles redefine <span +class="ectt-1000">\glsgroupskip </span>to produce a +blank row. +</p><!--l. 4769--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossaryentryfield</span><span +class="ectt-0900"> </span></span><a + id="dx1-45024"></a><span +class="ectt-1000">\glossaryentryfield{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">formatted</span> +<span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} {</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">number list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4773--><p class="noindent" > +This macro indicates what to do for a given glossary entry. Note that <span +class="cmsy-10">⟨</span><span +class="ecti-1000">formatted name</span><span +class="cmsy-10">⟩</span> +will always be in the form <span +class="ectt-1000">\glsnamefont{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. This allows the user to set a given +font for the entry name, regardless of the glossary style used. Note that <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the +label used when the glossary entry was defined via either <span +class="ectt-1000">\newglossaryentry </span>or +<span +class="ectt-1000">\newacronym</span>. +</p><!--l. 4781--><p class="indent" > Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) +to the relevant line in the glossary. Your new glossary style must therefore +redefine <span +class="ectt-1000">\glossaryentryfield </span>to set the appropriate target. This is done +using +</p><!--l. 4786--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glstarget</span><span +class="ectt-0900"> </span></span><a + id="dx1-45025"></a><span +class="ectt-1000">\glstarget{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">text</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4788--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩ </span>is the entry’s label. Note that you don’t need to worry about whether the +<span +class="ecss-1000">hyperref</span><a + id="dx1-45026"></a> package has been loaded, as <span +class="ectt-1000">\glstarget </span>won’t create a target if <span +class="ectt-1000">\hypertarget</span> +hasn’t been defined. +</p><!--l. 4794--><p class="indent" > For example, the <span +class="ecss-1000">list</span><a + id="dx1-45027"></a> style defines <span +class="ectt-1000">\glossaryentryfield </span>as follows: + + + +</p> + <div class="verbatim" id="verbatim-114"> \renewcommand*{\glossaryentryfield}[5]{% -\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} -</PRE> - -<P> -Note also that <I>number list</I> will always be of the form -<BR> -<BR><TT>\glossaryentrynumbers</TT>{<TT>\relax</TT> -<BR><TT>\setentrycounter{</TT><EM>counter name</EM><TT>}\glsnumberformat{</TT><EM>number(s)</EM><TT>}</TT>} -<BR> -<BR> -where <I>number(s)</I> -may contain <TT>\delimN</TT> (to delimit individual numbers) and/or -<TT>\delimR</TT> (to indicate a range of numbers). There may be -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="8938"></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="8946"></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="8955"></A> package option. - -<P> - -<P> -<TT>\glossarysubentryfield{</TT><EM>level</EM><TT>}{</TT><EM>label</EM><TT>}{</TT><EM>formatted -name</EM><TT>}{</TT><EM>description</EM><TT>}{</TT><EM>symbol</EM><TT>}</TT> -<TT>{</TT><EM>number list</EM><TT>}</TT> -<P> -This is new to version 1.17, and is used to display sub-entries. -The first argument, <I>level</I>, indicates the sub-entry level. -This must be an integer from 1 (first sub-level) onwards. The -remaining arguments are analogous to those for -<TT>\glossaryentryfield</TT><A NAME="8959"></A> described above. - -<P> -For further details of these commands, see -the documented code in <TT>glossaries.pdf</TT>. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000313100000000000000"> -Example: creating a completely new style</A> -</H3> - -<P> -If you want a completely new style, you will need to redefine all -of the commands and the environment listed above. - -<P> -For example, suppose you want each entry to start with a bullet point. -This means that the glossary should be placed in the <TT>itemize</TT> -environment, so <TT>theglossary</TT> should start and end that -environment. Let's also suppose that you don't want anything between -the glossary groups (so <TT>\glsgroupheading</TT><A NAME="8967"></A> and <TT>\glsgroupskip</TT><A NAME="8970"></A> -should do nothing) and suppose you don't want anything to appear -immediately after <code>\begin{theglossary}</code> (so <TT>\glossaryheader</TT><A NAME="8973"></A> -should do nothing). In addition, let's suppose the symbol should -appear in brackets after the name, followed by the description and -last of all the number list<A NAME="8975"></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> - \newglossarystyle{mylist}{% - % put the glossary in the itemize environment: - \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}% - % have nothing after \begin{theglossary}: - \renewcommand*{\glossaryheader}{}% - % have nothing between glossary groups: - \renewcommand*{\glsgroupheading}[1]{}% - \renewcommand*{\glsgroupskip}{}% - % set how each entry should appear: - \renewcommand*{\glossaryentryfield}[5]{% - \item % bullet point - \glstarget{##1}{##2}% the entry name - \space (##4)% the symbol in brackets - \space ##3% the description - \space [##5]% the number list in square brackets - }% - % set how sub-entries appear: - \renewcommand*{\glossarysubentryfield}[6]{% - \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% - } -</PRE> -Note that this style creates a flat glossary, where sub-entries -are displayed in exactly the same way as the top level entries. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000313200000000000000"> -Example: creating a new glossary style based on an -existing style</A> -</H3> - -<P> -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="8980"></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 + <br />\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} +</div> +<!--l. 4799--><p class="nopar" > +</p><!--l. 4801--><p class="indent" > Note also that <span +class="cmsy-10">⟨</span><span +class="ecti-1000">number list</span><span +class="cmsy-10">⟩ </span>will always be of the form<br +class="newline" /> <span +class="ectt-1000">\glossaryentrynumbers</span>{<span +class="ectt-1000">\relax</span><br +class="newline" /><span +class="ectt-1000">\setentrycounter{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}\glsnumberformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">number(s)</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>}<br +class="newline" /> where <span +class="cmsy-10">⟨</span><span +class="ecti-1000">number(s)</span><span +class="cmsy-10">⟩ </span>may contain <span +class="ectt-1000">\delimN </span>(to delimit individual numbers) and/or +<span +class="ectt-1000">\delimR </span>(to indicate a range of numbers). There may be multiple occurrences of +<span +class="ectt-1000">\setentrycounter{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">counter name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}\glsnumberformat{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">number(s)</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>, but note that +the entire number list is enclosed within the argument to <span +class="ectt-1000">\glossaryentrynumbers</span><a + id="dx1-45028"></a>. The +user can redefine this to change the way the entire number list is formatted, regardless +of the glossary style. However the most common use of <span +class="ectt-1000">\glossaryentrynumbers </span>is to +provide a means of suppressing the number list altogether. (In fact, the <span +class="ecss-1000">nonumberlist</span><a + id="dx1-45029"></a> +option redefines <span +class="ectt-1000">\glossaryentrynumbers </span>to ignore its argument.) Therefore, when you +define a new glossary style, you don’t need to worry about whether the user has +specified the <span +class="ecss-1000">nonumberlist</span><a + id="dx1-45030"></a> package option. +</p><!--l. 4820--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\glossarysubentryfield</span><span +class="ectt-0900"> </span></span><a + id="dx1-45031"></a><span +class="ectt-1000">\glossarysubentryfield{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">level</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">label</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">formatted</span> +<span +class="ecti-1000">name</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">description</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">symbol</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} {</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">number list</span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4824--><p class="noindent" > +This is new to version 1.17, and is used to display sub-entries. The first argument, +<span +class="cmsy-10">⟨</span><span +class="ecti-1000">level</span><span +class="cmsy-10">⟩</span>, indicates the sub-entry level. This must be an integer from 1 (first sub-level) +onwards. The remaining arguments are analogous to those for <span +class="ectt-1000">\glossaryentryfield</span><a + id="dx1-45032"></a> +described above. +</p><!--l. 4831--><p class="indent" > For further details of these commands, see the documented code in +<span +class="ectt-1000">glossaries.pdf</span>. +</p><!--l. 4835--><p class="noindent" > +</p> +<!--l. 4835--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.1 </span> <a + id="x1-460002.13.1"></a>Example: creating a completely new style</h5> +<!--l. 4837--><p class="noindent" >If you want a completely new style, you will need to redefine all of the commands and +the environment listed above. +</p><!--l. 4840--><p class="indent" > For example, suppose you want each entry to start with a bullet point. This means +that the glossary should be placed in the <span +class="ecss-1000">itemize</span><a + id="dx1-46001"></a> environment, so <span +class="ecss-1000">theglossary</span><a + id="dx1-46002"></a> should +start and end that environment. Let’s also suppose that you don’t want anything +between the glossary groups (so <span +class="ectt-1000">\glsgroupheading</span><a + id="dx1-46003"></a> and <span +class="ectt-1000">\glsgroupskip</span><a + id="dx1-46004"></a> should do +nothing) and suppose you don’t want anything to appear immediately after + + + +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\begin{theglossary}</span></span></span> (so <span +class="ectt-1000">\glossaryheader</span><a + id="dx1-46005"></a> should do nothing). In addition, let’s +suppose the symbol should appear in brackets after the name, followed by the +description and last of all the number list<a + id="dx1-46006"></a> should appear within square brackets at +the end. Then you can create this new glossary style, called, say, <span +class="ectt-1000">mylist</span>, as +follows: + + + +</p> + <div class="verbatim" id="verbatim-115"> + \newglossarystyle{mylist}{% + <br /> % put the glossary in the itemize environment: + <br /> \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}% + <br /> % have nothing after \begin{theglossary}: + <br /> \renewcommand*{\glossaryheader}{}% + <br /> % have nothing between glossary groups: + <br /> \renewcommand*{\glsgroupheading}[1]{}% + <br /> \renewcommand*{\glsgroupskip}{}% + <br /> % set how each entry should appear: + <br /> \renewcommand*{\glossaryentryfield}[5]{% + <br /> \item % bullet point + <br /> \glstarget{##1}{##2}% the entry name + <br /> \space (##4)% the symbol in brackets + <br /> \space ##3% the description + <br /> \space [##5]% the number list in square brackets + <br /> }% + <br /> % set how sub-entries appear: + <br /> \renewcommand*{\glossarysubentryfield}[6]{% + <br />   \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% + <br /> } +</div> +<!--l. 4873--><p class="nopar" > Note that this style creates a flat glossary, where sub-entries are displayed in exactly +the same way as the top level entries. +</p><!--l. 4879--><p class="noindent" > +</p> +<!--l. 4879--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.2 </span> <a + id="x1-470002.13.2"></a>Example: creating a new glossary style based on an existing style</h5> +<a + id="dx1-47001"></a> +<!--l. 4883--><p class="noindent" >If you want to define a new style that is a slightly modified version of an existing style, +you can use <span +class="ectt-1000">\glossarystyle </span>within the second argument of <span +class="ectt-1000">\newglossarystyle</span> +followed by whatever alterations you require. For example, suppose you want a style like +the <span +class="ecss-1000">list</span><a + id="dx1-47002"></a> style but you don’t want the extra vertical space created by <span +class="ectt-1000">\indexspace</span> +between groups, then you can create a new glossary style called, say, <span +class="ectt-1000">mylist </span>as follows: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-116"> \newglossarystyle{mylist}{% -\glossarystyle{list}% base this style on the list style -\renewcommand{\glsgroupskip}{}% make nothing happen between groups -} -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H3><A NAME="SECTION000313300000000000000"></A><A NAME="8985"></A><A NAME="8988"></A> -<BR> -Example: creating a glossary style that uses the -<TT>user1</TT>, ..., <TT>user6</TT> keys -</H3> - -<P> -Since <TT>\glossaryentryfield</TT><A NAME="8991"></A> and <TT>\glossarysubentryfield</TT><A NAME="8994"></A> -provide the label for the entry, it's also possible to access -the values of the generic user keys, such as <TT>user1</TT><A NAME="8997"></A>. For -example, suppose each entry not only has an associated symbol, -but also units (stored in <TT>user1</TT><A NAME="9000"></A>) and dimension -(stored in <TT>user2</TT><A NAME="9003"></A>). Then you can define a glossary style -that displays each entry in a <TT>longtable</TT> as follows: -<PRE> + <br />\glossarystyle{list}% base this style on the list style + <br />\renewcommand{\glsgroupskip}{}% make nothing happen between groups + <br />} +</div> +<!--l. 4896--><p class="nopar" > +</p><!--l. 4900--><p class="noindent" > +</p> +<!--l. 4900--><p class="noindent" ><a +href="#top">Top</a></p><h5 class="subsubsectionHead"><span class="titlemark">2.13.3 </span> <a + id="x1-480002.13.3"></a>Example: creating a glossary style that uses the <span +class="ecss-1000">user1</span>, …, <span +class="ecss-1000">user6</span> +keys</h5> +<!--l. 4902--><p class="noindent" >Since <span +class="ectt-1000">\glossaryentryfield</span><a + id="dx1-48001"></a> and <span +class="ectt-1000">\glossarysubentryfield</span><a + id="dx1-48002"></a> provide the label for the +entry, it’s also possible to access the values of the generic user keys, such as <span +class="ecss-1000">user1</span><a + id="dx1-48003"></a>. For +example, suppose each entry not only has an associated symbol, but also units (stored +in <span +class="ecss-1000">user1</span><a + id="dx1-48004"></a>) and dimension (stored in <span +class="ecss-1000">user2</span><a + id="dx1-48005"></a>). Then you can define a glossary style that +displays each entry in a <span +class="ecss-1000">longtable</span><a + id="dx1-48006"></a> as follows: + + + +</p> + <div class="verbatim" id="verbatim-117"> \newglossarystyle{long6col}{% - % put the glossary in a longtable environment: - \renewenvironment{theglossary}% - {\begin{longtable}{lp{\glsdescwidth}cccp{\glspagelistwidth}}}% - {\end{longtable}}% - % Set the table's header: - \renewcommand*{\glossaryheader}{% - \bfseries Term & \bfseries Description & \bfseries Symbol & - \bfseries Units & \bfseries Dimensions & \bfseries Page List - \\\endhead}% - % No heading between groups: - \renewcommand*{\glsgroupheading}[1]{}% - % Main (level 0) entries displayed in a row: - \renewcommand*{\glossaryentryfield}[5]{% - \glstarget{##1}{##2}% Name - & ##3% Description - & ##4% Symbol - & \glsentryuseri{##1}% Units - & \glsentryuserii{##1}% Dimensions - & ##5% Page list - \\% end of row - }% - % Sub entries treated the same as level 0 entries: - \renewcommand*{\glossarysubentryfield}[6]{% - \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% - % Nothing between groups: - \renewcommand*{\glsgroupskip}{}% -} -</PRE> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H2><A NAME="SECTION000314000000000000000"></A><A NAME="sec:accsupp"></A> -<BR> -Accessibility Support -</H2> -Limited accessibility support is provided by the accompanying -<TT>glossaries-accsupp</TT><A NAME="9010"></A> package, but note that this package is -experimental and it requires the <TT>accsupp</TT><A NAME="9013"></A> package -which is also listed as experimental. This package defines -additional keys that may be used when defining glossary entries. -The keys are as follows: -<DL> -<DT><STRONG><TT>access</TT><A NAME="9016"></A></STRONG></DT> -<DD>The replacement text corresponding to -the <TT>name</TT><A NAME="9019"></A> key. - -<P> -</DD> -<DT><STRONG><TT>textaccess</TT><A NAME="9022"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>text</TT><A NAME="9025"></A> key. - -<P> -</DD> -<DT><STRONG><TT>firstaccess</TT><A NAME="9028"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>first</TT><A NAME="9031"></A> key. - -<P> -</DD> -<DT><STRONG><TT>pluralaccess</TT><A NAME="9034"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>plural</TT><A NAME="9037"></A> key. - -<P> -</DD> -<DT><STRONG><TT>firstpluralaccess</TT><A NAME="9040"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>firstplural</TT><A NAME="9043"></A> key. - -<P> -</DD> -<DT><STRONG><TT>symbolaccess</TT><A NAME="9046"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>symbol</TT><A NAME="9049"></A> key. - -<P> -</DD> -<DT><STRONG><TT>symbolpluralaccess</TT><A NAME="9052"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>symbolplural</TT><A NAME="9055"></A> key. - -<P> -</DD> -<DT><STRONG><TT>descriptionaccess</TT><A NAME="9058"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>description</TT><A NAME="9061"></A> key. - -<P> -</DD> -<DT><STRONG><TT>descriptionpluralaccess</TT><A NAME="9064"></A></STRONG></DT> -<DD>The replacement text corresponding -to the <TT>descriptionplural</TT><A NAME="9067"></A> key. - -<P> -</DD> -</DL> - -<P> -For example: -<PRE> -\newglossaryentry{tex}{name={\TeX},description={Document preparation -language},access={TeX}} -</PRE> -Now <code>\gls{tex}</code> will be equivalent to -<PRE> + <br /> % put the glossary in a longtable environment: + <br /> \renewenvironment{theglossary}% + <br />  {\begin{longtable}{lp{\glsdescwidth}cccp{\glspagelistwidth}}}% + <br />  {\end{longtable}}% + <br /> % Set the table’s header: + <br /> \renewcommand*{\glossaryheader}{% + <br />  \bfseries Term & \bfseries Description & \bfseries Symbol & + <br />  \bfseries Units & \bfseries Dimensions & \bfseries Page List + <br />  \\\endhead}% + <br /> % No heading between groups: + <br />  \renewcommand*{\glsgroupheading}[1]{}% + <br /> % Main (level 0) entries displayed in a row: + <br />  \renewcommand*{\glossaryentryfield}[5]{% + <br />    \glstarget{##1}{##2}% Name + <br />    & ##3% Description + <br />    & ##4% Symbol + <br />    & \glsentryuseri{##1}% Units + <br />    & \glsentryuserii{##1}% Dimensions + <br />    & ##5% Page list + <br />    \\% end of row + <br />  }% + <br /> % Sub entries treated the same as level 0 entries: + <br /> \renewcommand*{\glossarysubentryfield}[6]{% + <br />  \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% + <br /> % Nothing between groups: + <br /> \renewcommand*{\glsgroupskip}{}% + <br />} +</div> +<!--l. 4938--><p class="nopar" > +</p><!--l. 4941--><p class="noindent" > +</p> +<!--l. 4941--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">2.14 </span> <a + id="x1-490002.14"></a>Accessibility Support</h4> +<!--l. 4942--><p class="noindent" >Limited accessibility support is provided by the accompanying <span +class="ecss-1000">glossaries-accsupp</span><a + id="dx1-49001"></a> +package, but note that this package is experimental and it requires the <span +class="ecss-1000">accsupp</span><a + id="dx1-49002"></a> package +which is also listed as experimental. This package defines additional keys that may be +used when defining glossary entries. The keys are as follows: + </p><dl class="description"><dt class="description"> +<span +class="ecsx-1000">access</span><a + id="dx1-49003"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">name</span><a + id="dx1-49004"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">textaccess</span><a + id="dx1-49005"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">text</span><a + id="dx1-49006"></a> key. + + + + </dd><dt class="description"> +<span +class="ecsx-1000">firstaccess</span><a + id="dx1-49007"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">first</span><a + id="dx1-49008"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">pluralaccess</span><a + id="dx1-49009"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">plural</span><a + id="dx1-49010"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">firstpluralaccess</span><a + id="dx1-49011"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">firstplural</span><a + id="dx1-49012"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">symbolaccess</span><a + id="dx1-49013"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">symbol</span><a + id="dx1-49014"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">symbolpluralaccess</span><a + id="dx1-49015"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">symbolplural</span><a + id="dx1-49016"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">descriptionaccess</span><a + id="dx1-49017"></a> </dt><dd +class="description">The replacement text corresponding to the <span +class="ecss-1000">description</span><a + id="dx1-49018"></a> key. + </dd><dt class="description"> +<span +class="ecsx-1000">descriptionpluralaccess</span><a + id="dx1-49019"></a> </dt><dd +class="description">The replacement text corresponding to the + <span +class="ecss-1000">descriptionplural</span><a + id="dx1-49020"></a> key. + </dd></dl> +<!--l. 4978--><p class="indent" > For example: + + + +</p> + <div class="verbatim" id="verbatim-118"> +\newglossaryentry{tex}{name={\TeX},description={Document preparation + <br />language},access={TeX}} +</div> +<!--l. 4982--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls{tex}</span></span></span> will be equivalent to + + + +</p> + <div class="verbatim" id="verbatim-119"> \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} -</PRE> -See the section -"glossaries-accsupp code" in -the document <TT>glossaries.pdf</TT> for further details. It is -recommended that you also read the <TT>accsupp</TT><A NAME="9070"></A> documentation. - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<H1><A NAME="SECTION00040000000000000000"></A> -<A NAME="sec:mfirstuc"></A> -<BR> -Mfirstuc Package -</H1> - -<P> -The <TT>glossaries</TT> bundle is supplied with the package -<TT>mfirstuc</TT><A NAME="9077"></A> which provides the command: - -<P> -<TT>\makefirstuc{</TT><EM>stuff</EM><TT>}</TT> -<P> -which makes the first object of -<I>stuff</I> uppercase unless <I>stuff</I> starts with a control -sequence followed by a non-empty group, in which case the first -object in the group is converted to uppercase. Examples: - -<UL> -<LI><code>\makefirstuc{abc}</code> produces Abc - -<P> -</LI> -<LI><code>\makefirstuc{\emph{abc}}</code> produces <I>Abc</I> -(<TT>\MakeUppercase</TT><A NAME="9080"></A> has been applied to the letter "a" rather -than <TT>\emph</TT>.) Note however that -<code>\makefirstuc{{\em abc}}</code> produces <I>ABC</I> and -<code>{\makefirstuc{\em abc}}</code> produces abc. - -<P> -</LI> -<LI><code>\makefirstuc{{\'a}bc}</code> produces Ábc - -<P> -</LI> -<LI><code>\makefirstuc{\ae bc}</code> produces Æbc - -<P> -</LI> -<LI><code>\makefirstuc{{\ae}bc}</code> produces Æbc - -<P> -</LI> -<LI><code>\makefirstuc{{ä}bc}</code> produces Äbc - -<P> -</LI> -</UL> -Note that non-Latin or accented characters appearing at the -start of the text must be placed in a group (even if you are -using the <TT>inputenc</TT><A NAME="9083"></A> package) due to expansion issues. - -<P> -In version 1.02 of <TT>mfirstuc</TT>, a bug fix resulted in a change -in output if the first object is a control sequence followed by -an empty group. Prior to version 1.02, <code>\makefirstuc{\ae{}bc}</code> -produced æBc. However as from version 1.02, it now produces -Æbc. - -<P> -Note also that -<PRE> +</div> +<!--l. 4986--><p class="nopar" > See the section “glossaries-accsupp code” in the document <span +class="ectt-1000">glossaries.pdf </span>for further +details. It is recommended that you also read the <span +class="ecss-1000">accsupp</span><a + id="dx1-49021"></a> documentation. +</p><!--l. 4992--><p class="noindent" > +</p> +<!--l. 4992--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-500003"></a>Mfirstuc Package</h3> +<!--l. 4995--><p class="noindent" >The <span +class="ecss-1000">glossaries </span>bundle is supplied with the package <span +class="ecss-1000">mfirstuc</span><a + id="dx1-50001"></a> which provides the +command: +</p><!--l. 4997--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\makefirstuc</span><span +class="ectt-0900"> </span></span><a + id="dx1-50002"></a><span +class="ectt-1000">\makefirstuc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 4999--><p class="noindent" > +which makes the first object of <span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩ </span>uppercase unless <span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩ </span>starts with a control +sequence followed by a non-empty group, in which case the first object in the group is +converted to uppercase. Examples: </p> + <ul class="itemize1"> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{abc}</span></span></span> produces Abc + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\emph{abc}}</span></span></span> produces <span +class="ecti-1000">Abc </span>(<span +class="ectt-1000">\MakeUppercase</span><a + id="dx1-50003"></a> has been + applied to the letter “a” rather than <span +class="ectt-1000">\emph</span>.) Note however that + <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{\em</span><span +class="ectt-1000"> abc}}</span></span></span> produces <span +class="ecti-1000">ABC </span>and <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">{\makefirstuc{\em</span><span +class="ectt-1000"> abc}}</span></span></span> + produces abc. + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{\’a}bc}</span></span></span> produces Ábc + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\ae</span><span +class="ectt-1000"> bc}</span></span></span> produces Æbc + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{\ae}bc}</span></span></span> produces Æbc + </li> + <li class="itemize"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{{</span><span +class="ectt-1000">ä}bc}</span></span></span> produces Äbc + </li></ul> +<!--l. 5022--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be +placed in a group (even if you are using the <span +class="ecss-1000">inputenc</span><a + id="dx1-50004"></a> package) due to expansion +issues. + + + +</p><!--l. 5026--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span +class="ecss-1000">mfirstuc</span>, a bug fix resulted in a change in output if the first +object is a control sequence followed by an empty group. Prior to version 1.02, +<span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc{\ae{}bc}</span></span></span> produced æBc. However as from version 1.02, it now produces +Æbc. </div> +</p><!--l. 5032--><p class="noindent" > +</p><!--l. 5034--><p class="indent" > Note also that + + + +</p> + <div class="verbatim" id="verbatim-120"> \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> + <br />\makefirstuc{\abc} +</div> +<!--l. 5038--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span +class="ectt-1000">\makefirstuc </span>is +<span +class="ectt-1000">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\MakeUppercase\abc</span></span></span>. Whereas: + + + +</p> + <div class="verbatim" id="verbatim-121"> \newcommand{\abc}{abc} -\expandafter\makefirstuc\expandafter{\abc} -</PRE> -produces: Abc. There is a short cut command which will do this: -<BR> -<BR> -<P> -<TT>\xmakefirstuc{</TT><EM>stuff</EM><TT>}</TT> -<P> -This is equivalent to <TT>\expandafter\makefirstuc\expandafter{</TT><EM>stuff</EM><TT>}</TT>. So -<PRE> + <br />\expandafter\makefirstuc\expandafter{\abc} +</div> +<!--l. 5045--><p class="nopar" > produces: Abc. There is a short cut command which will do this:<br +class="newline" /> +</p><!--l. 5047--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="ectt-0900">\xmakefirstuc</span><span +class="ectt-0900"> </span></span><a + id="dx1-50005"></a><span +class="ectt-1000">\xmakefirstuc{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">} </span></div><hr> +</p><!--l. 5049--><p class="noindent" > +This is equivalent to <span +class="ectt-1000">\expandafter\makefirstuc\expandafter{</span><span +class="cmsy-10">⟨</span><span +class="ecti-1000">stuff </span><span +class="cmsy-10">⟩</span><span +class="ectt-1000">}</span>. +So + + + +</p> + <div class="verbatim" id="verbatim-122"> \newcommand{\abc}{abc} -\xmakefirstuc{\abc} -</PRE> -produces: Abc. - -<P> -If you want to use an alternative command to convert to uppercase, -for example <TT>\MakeTextUppercase</TT>,<A NAME="tex2html40" - HREF="#foot4445"><SUP>16</SUP></A> you can redefine the internal -command <TT>\@gls@makefirstuc</TT>. For example: -<PRE> -\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} -</PRE> -(Remember that command names that contain the @ character must -either be placed in packages or be placed between <TT>\makeatletter</TT> -and <TT>\makeatother</TT>.) - -<P> - -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> - -<P> -<BR> - -<H2><A NAME="SECTION00050000000000000000"> -Index</A> -</H2><DL COMPACT> -<DT><STRONG><TT>\Ac</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8129">Acronyms</A> - | <A HREF="glossaries-manual.html#8135">Acronyms</A> -<DT><STRONG><TT>accsupp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#9013">Accessibility Support</A> - | <A HREF="glossaries-manual.html#9070">Accessibility Support</A> -<DT><STRONG><TT>\Acf</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8105">Acronyms</A> - | <A HREF="glossaries-manual.html#8111">Acronyms</A> -<DT><STRONG><TT>\Acfp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8117">Acronyms</A> - | <A HREF="glossaries-manual.html#8123">Acronyms</A> -<DT><STRONG><TT>\Acl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8081">Acronyms</A> - | <A HREF="glossaries-manual.html#8087">Acronyms</A> -<DT><STRONG><TT>\Aclp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8093">Acronyms</A> - | <A HREF="glossaries-manual.html#8099">Acronyms</A> -<DT><STRONG><TT>\Acp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8141">Acronyms</A> - | <A HREF="glossaries-manual.html#8147">Acronyms</A> -<DT><STRONG><TT>\Acrfull</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8108">Acronyms</A> - | <A HREF="glossaries-manual.html#8114">Acronyms</A> -<DT><STRONG><TT>\Acrfullpl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8120">Acronyms</A> - | <A HREF="glossaries-manual.html#8126">Acronyms</A> -<DT><STRONG><TT>\Acrlong</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5328">Troubleshooting</A> - | <A HREF="glossaries-manual.html#8084">Acronyms</A> - | <A HREF="glossaries-manual.html#8090">Acronyms</A> -<DT><STRONG><TT>\Acrlongpl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8096">Acronyms</A> - | <A HREF="glossaries-manual.html#8102">Acronyms</A> -<DT><STRONG><TT>\acrnameformat</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7811">Acronyms</A> - | <A HREF="glossaries-manual.html#7814">Acronyms</A> -<DT><STRONG><TT>\acronymfont</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5857">Package Options</A> - | <A HREF="glossaries-manual.html#7808">Acronyms</A> - | <A HREF="glossaries-manual.html#7926">Acronyms</A> - | <A HREF="glossaries-manual.html#7999">Acronyms</A> -<DT><STRONG><TT>\acronymname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4798">Changing the Fixed Names</A> -<DT><STRONG><TT>\acronymtype</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5484">Package Options</A> - | <A HREF="glossaries-manual.html#5481">Package Options</A> - | <A HREF="glossaries-manual.html#5505">Package Options</A> - | <A HREF="glossaries-manual.html#5581">Package Options</A> - | <A HREF="glossaries-manual.html#6298">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#7263">Acronyms</A> - | <A HREF="glossaries-manual.html#7266">Acronyms</A> -<DT><STRONG><TT>\Acrshort</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8060">Acronyms</A> - | <A HREF="glossaries-manual.html#8066">Acronyms</A> -<DT><STRONG><TT>\Acrshortpl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8072">Acronyms</A> - | <A HREF="glossaries-manual.html#8078">Acronyms</A> -<DT><STRONG><TT>\Acs</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8057">Acronyms</A> - | <A HREF="glossaries-manual.html#8063">Acronyms</A> -<DT><STRONG><TT>\Acsp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8069">Acronyms</A> - | <A HREF="glossaries-manual.html#8075">Acronyms</A> -<DT><STRONG><TT>array</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8525">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8732">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>babel</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4757">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4764">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4782">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4828">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4840">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4862">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#5319">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5979">Package Options</A> - | <A HREF="glossaries-manual.html#5999">Package Options</A> - | <A HREF="glossaries-manual.html#6014">Package Options</A> - | <A HREF="glossaries-manual.html#6036">Package Options</A> -<DT><STRONG><TT>\defglsdisplay</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7619">Acronyms</A> - | <A HREF="glossaries-manual.html#8021">Acronyms</A> -<DT><STRONG><TT>\defglsdisplayfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7622">Acronyms</A> - | <A HREF="glossaries-manual.html#8024">Acronyms</A> -<DT><STRONG><TT>\descriptionname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4813">Changing the Fixed Names</A> -<DT><STRONG><TT>\emph</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6531">Links to Glossary Entries</A> -<DT><STRONG><TT>\entryname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4810">Changing the Fixed Names</A> -<DT><STRONG>file types</STRONG> -<DD><DL COMPACT> -<DT><STRONG>.alg</STRONG> -<DD><A HREF="glossaries-manual.html#4982">Generating the Associated Glossary</A> -<DT><STRONG>.aux</STRONG> -<DD><A HREF="glossaries-manual.html#5031">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#7068">Language and Encodings</A> -<DT><STRONG>.glg</STRONG> -<DD><A HREF="glossaries-manual.html#4980">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5102">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5183">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5351">Troubleshooting</A> -<DT><STRONG>.glo</STRONG> -<DD><A HREF="glossaries-manual.html#5106">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5187">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#6070">Defining Glossary Entries</A> -<DT><STRONG>.gls</STRONG> -<DD><A HREF="glossaries-manual.html#5104">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5185">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#6072">Defining Glossary Entries</A> -<DT><STRONG>.ist</STRONG> -<DD><A HREF="glossaries-manual.html#5158">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5163">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5233">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5908">Package Options</A> - | <A HREF="glossaries-manual.html#6092">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6109">Defining Glossary Entries</A> -<DT><STRONG>.log</STRONG> -<DD><A HREF="glossaries-manual.html#5349">Troubleshooting</A> -<DT><STRONG>.tex</STRONG> -<DD><A HREF="glossaries-manual.html#5081">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5156">Using makeindex explicitly</A> -<DT><STRONG>.xdy</STRONG> -<DD><A HREF="glossaries-manual.html#5086">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5088">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5238">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5937">Package Options</A> - | <A HREF="glossaries-manual.html#6097">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6117">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#7030">Xindy</A> -</DL> -<DT><STRONG>first use</STRONG> -<DD><A HREF="glossaries-manual.html#5290">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5300">Troubleshooting</A> - | <A HREF="glossaries-manual.html#6056">Package Options</A> - | <A HREF="glossaries-manual.html#6743">Changing the format of</A> - | <A HREF="glossaries-manual.html#6780">Changing the format of</A> - | <A HREF="glossaries-manual.html#6795">Changing the format of</A> - | <A HREF="glossaries-manual.html#6840">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#7260">Acronyms</A> - | <A HREF="glossaries-manual.html#7307">Acronyms</A> - | <A HREF="glossaries-manual.html#7404">Acronyms</A> - | <A HREF="glossaries-manual.html#7572">Acronyms</A> - | <A HREF="glossaries-manual.html#7642">Acronyms</A> - | <A HREF="glossaries-manual.html#7717">Acronyms</A> - | <A HREF="glossaries-manual.html#7774">Acronyms</A> - | <A HREF="glossaries-manual.html#7831">Acronyms</A> - | <A HREF="glossaries-manual.html#7840">Acronyms</A> - | <A HREF="glossaries-manual.html#7841">Acronyms</A> - | <A HREF="glossaries-manual.html#7842">Acronyms</A> - | <A HREF="glossaries-manual.html#7870">Acronyms</A> - | <A HREF="glossaries-manual.html#7909">Acronyms</A> - | <A HREF="glossaries-manual.html#7981">Acronyms</A> - | <A HREF="glossaries-manual.html#8236">Unsetting and Resetting Entry</A> -<DL COMPACT> -<DT><STRONG>flag</STRONG> -<DD><A HREF="glossaries-manual.html#6503">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6516">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6517">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6622">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6629">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6639">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6652">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6665">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6678">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6890">Using Glossary Terms Without</A> -<DT><STRONG>text</STRONG> -<DD><A HREF="glossaries-manual.html#6205">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6227">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6903">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#6907">Using Glossary Terms Without</A> -</DL> -<DT><STRONG><TT>flowfram</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8631">Supertabular Styles</A> -<DT><STRONG><TT>fmtcount</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7125">Locations and Number lists</A> -<DT><STRONG><TT>german</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4779">Changing the Fixed Names</A> -<DT><STRONG><TT>glossaries-accsupp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4706">Sample Documents</A> - | <A HREF="glossaries-manual.html#9010">Accessibility Support</A> -<DT><STRONG><TT>glossaries-babel</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4855">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#6017">Package Options</A> - | <A HREF="glossaries-manual.html#6042">Package Options</A> -<DT><STRONG><TT>glossaries-polyglossia</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4865">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#6024">Package Options</A> - | <A HREF="glossaries-manual.html#6045">Package Options</A> -<DT><STRONG><TT>glossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4545">Introduction</A> - | <A HREF="glossaries-manual.html#5315">Troubleshooting</A> - | <A HREF="glossaries-manual.html#8156">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8160">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8164">Upgrading From the glossary</A> -<DT><STRONG>glossary styles</STRONG> -<DD><DL COMPACT> -<DT><STRONG>altlist</STRONG> -<DD><A HREF="glossaries-manual.html#8378">List Styles</A> - | <A HREF="glossaries-manual.html#8388">List Styles</A> -<DT><STRONG>altlistgroup</STRONG> -<DD><A HREF="glossaries-manual.html#8386">List Styles</A> - | <A HREF="glossaries-manual.html#8392">List Styles</A> -<DT><STRONG>altlisthypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8390">List Styles</A> -<DT><STRONG>altlong4col</STRONG> -<DD><A HREF="glossaries-manual.html#8306">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8476">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8490">Longtable Styles</A> -<DT><STRONG>altlong4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8500">Longtable Styles</A> -<DT><STRONG>altlong4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8504">Longtable Styles</A> -<DT><STRONG>altlong4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8508">Longtable Styles</A> -<DT><STRONG>altlongragged4col</STRONG> -<DD><A HREF="glossaries-manual.html#8582">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8594">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8598">Longtable Styles (Ragged Right)</A> -<DT><STRONG>altlongragged4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8592">Longtable Styles (Ragged Right)</A> -<DT><STRONG>altlongragged4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8596">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8602">Longtable Styles (Ragged Right)</A> -<DT><STRONG>altlongragged4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8600">Longtable Styles (Ragged Right)</A> -<DT><STRONG>altsuper4col</STRONG> -<DD><A HREF="glossaries-manual.html#8308">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8683">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8697">Supertabular Styles</A> -<DT><STRONG>altsuper4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8707">Supertabular Styles</A> -<DT><STRONG>altsuper4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8711">Supertabular Styles</A> -<DT><STRONG>altsuper4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8715">Supertabular Styles</A> -<DT><STRONG>altsuperragged4col</STRONG> -<DD><A HREF="glossaries-manual.html#8793">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8799">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8803">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>altsuperragged4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8797">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>altsuperragged4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8801">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8807">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>altsuperragged4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8805">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>alttree</STRONG> -<DD><A HREF="glossaries-manual.html#8858">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8884">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8890">Tree-Like Styles</A> -<DT><STRONG>alttreegroup</STRONG> -<DD><A HREF="glossaries-manual.html#8888">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8894">Tree-Like Styles</A> -<DT><STRONG>alttreehypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8892">Tree-Like Styles</A> -<DT><STRONG>index</STRONG> -<DD><A HREF="glossaries-manual.html#7647">Acronyms</A> - | <A HREF="glossaries-manual.html#7749">Acronyms</A> - | <A HREF="glossaries-manual.html#8833">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8840">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8850">Tree-Like Styles</A> -<DT><STRONG>indexgroup</STRONG> -<DD><A HREF="glossaries-manual.html#8838">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8844">Tree-Like Styles</A> -<DT><STRONG>indexhypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8842">Tree-Like Styles</A> -<DT><STRONG>list</STRONG> -<DD><A HREF="glossaries-manual.html#5659">Package Options</A> - | <A HREF="glossaries-manual.html#8363">List Styles</A> - | <A HREF="glossaries-manual.html#8369">List Styles</A> - | <A HREF="glossaries-manual.html#8380">List Styles</A> - | <A HREF="glossaries-manual.html#8382">List Styles</A> - | <A HREF="glossaries-manual.html#8384">List Styles</A> - | <A HREF="glossaries-manual.html#8902">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8907">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8931">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8936">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8980">Example: creating a new</A> -<DT><STRONG>listdotted</STRONG> -<DD><A HREF="glossaries-manual.html#8333">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8398">List Styles</A> - | <A HREF="glossaries-manual.html#8400">List Styles</A> -<DT><STRONG>listgroup</STRONG> -<DD><A HREF="glossaries-manual.html#8367">List Styles</A> - | <A HREF="glossaries-manual.html#8373">List Styles</A> -<DT><STRONG>listhypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8371">List Styles</A> - | <A HREF="glossaries-manual.html#8394">List Styles</A> - | <A HREF="glossaries-manual.html#8846">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8868">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8882">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8896">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8929">Defining your own glossary</A> -<DT><STRONG>long</STRONG> -<DD><A HREF="glossaries-manual.html#8325">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8427">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8439">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8443">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8451">Longtable Styles</A> -<DT><STRONG>long3col</STRONG> -<DD><A HREF="glossaries-manual.html#8248">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8449">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8462">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8466">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8474">Longtable Styles</A> -<DT><STRONG>long3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8252">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8460">Longtable Styles</A> -<DT><STRONG>long3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8250">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8464">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8470">Longtable Styles</A> -<DT><STRONG>long3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8254">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8468">Longtable Styles</A> -<DT><STRONG>long4col</STRONG> -<DD><A HREF="glossaries-manual.html#8302">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8472">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8480">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8484">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8492">Longtable Styles</A> -<DT><STRONG>long4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8478">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8502">Longtable Styles</A> -<DT><STRONG>long4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8482">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8488">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8506">Longtable Styles</A> -<DT><STRONG>long4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8486">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8510">Longtable Styles</A> -<DT><STRONG>longborder</STRONG> -<DD><A HREF="glossaries-manual.html#8437">Longtable Styles</A> -<DT><STRONG>longheader</STRONG> -<DD><A HREF="glossaries-manual.html#8441">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8447">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8909">Defining your own glossary</A> -<DT><STRONG>longheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8445">Longtable Styles</A> -<DT><STRONG>longragged</STRONG> -<DD><A HREF="glossaries-manual.html#8541">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8549">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8553">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8561">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longragged3col</STRONG> -<DD><A HREF="glossaries-manual.html#8559">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8572">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8576">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8584">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longragged3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8570">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longragged3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8574">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8580">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longragged3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8578">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longraggedborder</STRONG> -<DD><A HREF="glossaries-manual.html#8547">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longraggedheader</STRONG> -<DD><A HREF="glossaries-manual.html#8551">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8557">Longtable Styles (Ragged Right)</A> -<DT><STRONG>longraggedheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8555">Longtable Styles (Ragged Right)</A> -<DT><STRONG>super</STRONG> -<DD><A HREF="glossaries-manual.html#8634">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8646">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8650">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8658">Supertabular Styles</A> -<DT><STRONG>super3col</STRONG> -<DD><A HREF="glossaries-manual.html#8656">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8669">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8673">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8681">Supertabular Styles</A> -<DT><STRONG>super3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8667">Supertabular Styles</A> -<DT><STRONG>super3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8671">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8677">Supertabular Styles</A> -<DT><STRONG>super3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8675">Supertabular Styles</A> -<DT><STRONG>super4col</STRONG> -<DD><A HREF="glossaries-manual.html#8304">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8679">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8687">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8691">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8699">Supertabular Styles</A> -<DT><STRONG>super4colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8685">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8709">Supertabular Styles</A> -<DT><STRONG>super4colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8689">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8695">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8713">Supertabular Styles</A> -<DT><STRONG>super4colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8693">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8717">Supertabular Styles</A> -<DT><STRONG>superborder</STRONG> -<DD><A HREF="glossaries-manual.html#8644">Supertabular Styles</A> -<DT><STRONG>superheader</STRONG> -<DD><A HREF="glossaries-manual.html#8648">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8654">Supertabular Styles</A> -<DT><STRONG>superheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8652">Supertabular Styles</A> -<DT><STRONG>superragged</STRONG> -<DD><A HREF="glossaries-manual.html#8748">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8760">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8764">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8772">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superragged3col</STRONG> -<DD><A HREF="glossaries-manual.html#8770">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8783">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8787">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8795">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superragged3colborder</STRONG> -<DD><A HREF="glossaries-manual.html#8781">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superragged3colheader</STRONG> -<DD><A HREF="glossaries-manual.html#8785">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8791">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superragged3colheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8789">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superraggedborder</STRONG> -<DD><A HREF="glossaries-manual.html#8758">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superraggedheader</STRONG> -<DD><A HREF="glossaries-manual.html#8762">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8768">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>superraggedheaderborder</STRONG> -<DD><A HREF="glossaries-manual.html#8766">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>tree</STRONG> -<DD><A HREF="glossaries-manual.html#8848">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8862">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8872">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8886">Tree-Like Styles</A> -<DT><STRONG>treegroup</STRONG> -<DD><A HREF="glossaries-manual.html#8860">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8866">Tree-Like Styles</A> -<DT><STRONG>treehypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8864">Tree-Like Styles</A> -<DT><STRONG>treenoname</STRONG> -<DD><A HREF="glossaries-manual.html#8870">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8876">Tree-Like Styles</A> -<DT><STRONG>treenonamegroup</STRONG> -<DD><A HREF="glossaries-manual.html#8874">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8880">Tree-Like Styles</A> -<DT><STRONG>treenonamehypergroup</STRONG> -<DD><A HREF="glossaries-manual.html#8878">Tree-Like Styles</A> -</DL> -<DT><STRONG><TT>glossary-hypernav</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8926">Defining your own glossary</A> -<DT><STRONG><TT>glossary-list</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5655">Package Options</A> - | <A HREF="glossaries-manual.html#6996">Changing the way the</A> - | <A HREF="glossaries-manual.html#8341">List Styles</A> -<DT><STRONG><TT>glossary-long</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5621">Package Options</A> - | <A HREF="glossaries-manual.html#6999">Changing the way the</A> - | <A HREF="glossaries-manual.html#8405">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8518">Longtable Styles (Ragged Right)</A> -<DT><STRONG><TT>glossary-longragged</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8515">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8522">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8528">Longtable Styles (Ragged Right)</A> -<DT><STRONG><TT>glossary-super</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5638">Package Options</A> - | <A HREF="glossaries-manual.html#7002">Changing the way the</A> - | <A HREF="glossaries-manual.html#8607">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8725">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>glossary-superragged</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8722">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8729">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8735">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>glossary-tree</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5680">Package Options</A> - | <A HREF="glossaries-manual.html#7005">Changing the way the</A> - | <A HREF="glossaries-manual.html#8812">Tree-Like Styles</A> -<DT><STRONG><TT>\glossaryentryfield</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8959">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8991">Example: creating a glossary</A> -<DT><STRONG><TT>\glossaryentrynumbers</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8938">Defining your own glossary</A> -<DT><STRONG><TT>\glossaryheader</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8375">List Styles</A> - | <A HREF="glossaries-manual.html#8973">Example: creating a completely</A> -<DT><STRONG><TT>\glossaryname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4795">Changing the Fixed Names</A> -<DT><STRONG><TT>\glossarystyle</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5703">Package Options</A> - | <A HREF="glossaries-manual.html#6966">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#8322">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8330">Glossary Styles</A> -<DT><STRONG><TT>\glossarysubentryfield</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8994">Example: creating a glossary</A> -<DT><STRONG><TT>\gls</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4738">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#6194">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6203">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6505">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6660">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6738">Changing the format of</A> - | <A HREF="glossaries-manual.html#6787">Changing the format of</A> - | <A HREF="glossaries-manual.html#6817">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6842">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6869">Cross-Referencing Entries</A> - | <A HREF="glossaries-manual.html#8132">Acronyms</A> - | <A HREF="glossaries-manual.html#8138">Acronyms</A> - | <A HREF="glossaries-manual.html#8173">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8176">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8179">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8182">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8185">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8188">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8204">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8210">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8228">Unsetting and Resetting Entry</A> -<DT><STRONG><TT>\glsaddall</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4603">Sample Documents</A> -<DT><STRONG><TT>\glsaddall</TT> keys</STRONG> -<DD><DL COMPACT> -<DT><STRONG>types</STRONG> -<DD><A HREF="glossaries-manual.html#6863">Adding an Entry to</A> -</DL> -<DT><STRONG><TT>\GlsAddXdyAttribute</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6546">Links to Glossary Entries</A> -<DT><STRONG><TT>\GlsAddXdyLocation</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7150">Locations and Number lists</A> -<DT><STRONG><TT>\glsclearpage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5535">Package Options</A> -<DT><STRONG><TT>\glsdefaulttype</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5487">Package Options</A> - | <A HREF="glossaries-manual.html#5499">Package Options</A> -<DT><STRONG><TT>\glsdesc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8002">Acronyms</A> -<DT><STRONG><TT>\glsdescwidth</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8434">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8454">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8494">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8544">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8564">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8586">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8641">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8661">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8701">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8755">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8775">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>\glsdisp</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6519">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6775">Changing the format of</A> - | <A HREF="glossaries-manual.html#6793">Changing the format of</A> - | <A HREF="glossaries-manual.html#6848">Enabling and disabling hyperlinks</A> -<DT><STRONG><TT>\glsdisplay</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6173">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6265">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6641">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6654">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6667">Links to Glossary Entries</A> -<DT><STRONG><TT>\glsdisplayfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6176">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6268">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6644">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6657">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6670">Links to Glossary Entries</A> -<DT><STRONG><TT>\glsentryname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6912">Using Glossary Terms Without</A> -<DT><STRONG><TT>\glsfirst</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8008">Acronyms</A> -<DT><STRONG><TT>\glsgroupheading</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8967">Example: creating a completely</A> -<DT><STRONG><TT>\glsgroupskip</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4593">Sample Documents</A> - | <A HREF="glossaries-manual.html#8319">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8970">Example: creating a completely</A> -<DT><STRONG><TT>\glshyperlink</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6892">Using Glossary Terms Without</A> -<DT><STRONG><TT>\glslabel</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6769">Changing the format of</A> -<DT><STRONG><TT>\glslink</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6631">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6772">Changing the format of</A> - | <A HREF="glossaries-manual.html#6814">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6851">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6857">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#6607">Links to Glossary Entries</A> -<DT><STRONG>format</STRONG> -<DD><A HREF="glossaries-manual.html#6522">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6543">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#7098">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7110">Locations and Number lists</A> -<DT><STRONG>hyper</STRONG> -<DD><A HREF="glossaries-manual.html#6610">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6820">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6860">Adding an Entry to</A> -</DL> -<DT><STRONG><TT>\glsnumbersgroupname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4825">Changing the Fixed Names</A> -<DT><STRONG><TT>\glspagelistwidth</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8457">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8497">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8567">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8589">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8664">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8704">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8778">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>\glspl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6179">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6182">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6185">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6213">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6225">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6271">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6274">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6277">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6508">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6741">Changing the format of</A> - | <A HREF="glossaries-manual.html#6790">Changing the format of</A> - | <A HREF="glossaries-manual.html#6845">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#8144">Acronyms</A> - | <A HREF="glossaries-manual.html#8150">Acronyms</A> - | <A HREF="glossaries-manual.html#8231">Unsetting and Resetting Entry</A> -<DT><STRONG><TT>\glspluralsuffix</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6216">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6235">Defining Glossary Entries</A> -<DT><STRONG><TT>\glssee</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4539">Introduction</A> - | <A HREF="glossaries-manual.html#6555">Links to Glossary Entries</A> -<DT><STRONG><TT>\GlsSetXdyCodePage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5022">Generating the Associated Glossary</A> -<DT><STRONG><TT>\GlsSetXdyLanguage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5019">Generating the Associated Glossary</A> -<DT><STRONG><TT>\GlsSetXdyMinRangeLength</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6453">Number lists</A> -<DT><STRONG><TT>\glssymbol</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8005">Acronyms</A> -<DT><STRONG><TT>\glssymbolsgroupname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4822">Changing the Fixed Names</A> -<DT><STRONG><TT>\glstext</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6673">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6680">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6686">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6692">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6704">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6716">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6728">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#7992">Acronyms</A> - | <A HREF="glossaries-manual.html#7996">Acronyms</A> -<DT><STRONG><TT>\glstextformat</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6783">Changing the format of</A> -<DT><STRONG><TT>html</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6810">Enabling and disabling hyperlinks</A> -<DT><STRONG><TT>\hyperbf</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6577">Links to Glossary Entries</A> -<DT><STRONG><TT>\hyperemph</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6595">Links to Glossary Entries</A> -<DT><STRONG><TT>\hyperit</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6583">Links to Glossary Entries</A> -<DT><STRONG><TT>\hyperlink</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6598">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6823">Enabling and disabling hyperlinks</A> -<DT><STRONG><TT>\hypermd</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6580">Links to Glossary Entries</A> -<DT><STRONG><TT>\hyperpage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6558">Links to Glossary Entries</A> -<DT><STRONG><TT>hyperref</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6471">Number lists</A> - | <A HREF="glossaries-manual.html#6499">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6561">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6807">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#6829">Enabling and disabling hyperlinks</A> - | <A HREF="glossaries-manual.html#8933">Defining your own glossary</A> -<DT><STRONG><TT>\hyperrm</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6568">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#7104">Locations and Number lists</A> -<DT><STRONG><TT>\hypersc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6592">Links to Glossary Entries</A> -<DT><STRONG><TT>\hypersf</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6571">Links to Glossary Entries</A> -<DT><STRONG><TT>\hypersl</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6586">Links to Glossary Entries</A> -<DT><STRONG><TT>\hypertarget</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6826">Enabling and disabling hyperlinks</A> -<DT><STRONG><TT>\hypertt</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6574">Links to Glossary Entries</A> -<DT><STRONG><TT>\hyperup</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6589">Links to Glossary Entries</A> -<DT><STRONG><TT>\indexspace</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8835">Tree-Like Styles</A> -<DT><STRONG><TT>inputenc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4651">Sample Documents</A> - | <A HREF="glossaries-manual.html#4741">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#6326">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#7074">Language and Encodings</A> - | <A HREF="glossaries-manual.html#9083">Mfirstuc Package</A> -<DT><STRONG><TT>\inputencodingname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7077">Language and Encodings</A> -<DT><STRONG><TT>\jobname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6106">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6114">Defining Glossary Entries</A> -<DT><STRONG>link text</STRONG> -<DD><A HREF="glossaries-manual.html#6489">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6501">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6502">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6612">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6736">Changing the format of</A> - | <A HREF="glossaries-manual.html#6781">Changing the format of</A> - | <A HREF="glossaries-manual.html#6802">Changing the format of</A> -<DT><STRONG>location list</STRONG> -<DD><i>see </i> number list -<DT><STRONG><TT>longtable</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5624">Package Options</A> - | <A HREF="glossaries-manual.html#8430">Longtable Styles</A> -<DT><STRONG><TT>\makefirstuc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7917">Acronyms</A> -<DT><STRONG><TT>\makeglossaries</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4549">Introduction</A> - | <A HREF="glossaries-manual.html#4558">Introduction</A> - | <A HREF="glossaries-manual.html#4578">Sample Documents</A> - | <A HREF="glossaries-manual.html#4590">Sample Documents</A> - | <A HREF="glossaries-manual.html#4609">Sample Documents</A> - | <A HREF="glossaries-manual.html#4617">Sample Documents</A> - | <A HREF="glossaries-manual.html#4638">Sample Documents</A> - | <A HREF="glossaries-manual.html#4654">Sample Documents</A> - | <A HREF="glossaries-manual.html#4660">Sample Documents</A> - | <A HREF="glossaries-manual.html#4663">Sample Documents</A> - | <A HREF="glossaries-manual.html#4673">Sample Documents</A> - | <A HREF="glossaries-manual.html#4688">Sample Documents</A> - | <A HREF="glossaries-manual.html#4700">Sample Documents</A> - | <A HREF="glossaries-manual.html#4744">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4750">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4912">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4921">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4924">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4943">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4949">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4958">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4967">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4971">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5028">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5039">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5042">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5045">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5048">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5072">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5120">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5126">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5132">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5201">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5207">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5213">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5343">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5346">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5302">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5305">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5331">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5340">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5893">Package Options</A> - | <A HREF="glossaries-manual.html#5899">Package Options</A> - | <A HREF="glossaries-manual.html#5922">Package Options</A> - | <A HREF="glossaries-manual.html#5928">Package Options</A> - | <A HREF="glossaries-manual.html#5965">Package Options</A> - | <A HREF="glossaries-manual.html#6080">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6456">Number lists</A> - | <A HREF="glossaries-manual.html#6477">Number lists</A> - | <A HREF="glossaries-manual.html#6872">Cross-Referencing Entries</A> - | <A HREF="glossaries-manual.html#6918">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6933">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#7065">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7086">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7092">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7119">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7122">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7137">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7140">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7156">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7159">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7169">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7172">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7191">Glossary Groups</A> - | <A HREF="glossaries-manual.html#7194">Glossary Groups</A> - | <A HREF="glossaries-manual.html#7207">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7255">Defining New Glossaries</A> -<DT><STRONG><TT>makeindex</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4552">Introduction</A> - | <A HREF="glossaries-manual.html#4561">Introduction</A> - | <A HREF="glossaries-manual.html#4581">Sample Documents</A> - | <A HREF="glossaries-manual.html#4584">Sample Documents</A> - | <A HREF="glossaries-manual.html#4587">Sample Documents</A> - | <A HREF="glossaries-manual.html#4606">Sample Documents</A> - | <A HREF="glossaries-manual.html#4614">Sample Documents</A> - | <A HREF="glossaries-manual.html#4641">Sample Documents</A> - | <A HREF="glossaries-manual.html#4648">Sample Documents</A> - | <A HREF="glossaries-manual.html#4679">Sample Documents</A> - | <A HREF="glossaries-manual.html#4703">Sample Documents</A> - | <A HREF="glossaries-manual.html#4717">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4723">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4880">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4984">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4889">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4896">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4902">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4915">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4940">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4952">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4961">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4977">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5036">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5141">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5153">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5160">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5168">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5180">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5204">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5210">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5225">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5230">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5243">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5311">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5359">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5890">Package Options</A> - | <A HREF="glossaries-manual.html#5896">Package Options</A> - | <A HREF="glossaries-manual.html#5902">Package Options</A> - | <A HREF="glossaries-manual.html#5934">Package Options</A> - | <A HREF="glossaries-manual.html#6083">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6089">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6103">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6111">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6286">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6332">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6444">Number lists</A> - | <A HREF="glossaries-manual.html#6462">Number lists</A> - | <A HREF="glossaries-manual.html#6491">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6525">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6540">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6921">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6927">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#7201">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#8256">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8852">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8911">Defining your own glossary</A> -<DT><STRONG><TT>\MakeUppercase</TT></STRONG> -<DD><A HREF="glossaries-manual.html#9080">Mfirstuc Package</A> -<DT><STRONG><TT>mfirstuc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#9077">Mfirstuc Package</A> -<DT><STRONG><TT>\newacronym</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4599">Sample Documents</A> - | <A HREF="glossaries-manual.html#5502">Package Options</A> - | <A HREF="glossaries-manual.html#5812">Package Options</A> - | <A HREF="glossaries-manual.html#5824">Package Options</A> - | <A HREF="glossaries-manual.html#5836">Package Options</A> - | <A HREF="glossaries-manual.html#5848">Package Options</A> - | <A HREF="glossaries-manual.html#5869">Package Options</A> - | <A HREF="glossaries-manual.html#7305">Acronyms</A> - | <A HREF="glossaries-manual.html#7354">Acronyms</A> - | <A HREF="glossaries-manual.html#7366">Acronyms</A> - | <A HREF="glossaries-manual.html#7763">Acronyms</A> - | <A HREF="glossaries-manual.html#7787">Acronyms</A> - | <A HREF="glossaries-manual.html#7820">Acronyms</A> - | <A HREF="glossaries-manual.html#8018">Acronyms</A> - | <A HREF="glossaries-manual.html#8167">Upgrading From the glossary</A> -<DT><STRONG><TT>\newglossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5117">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5198">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5406">Package Options</A> -<DT><STRONG><TT>\newglossaryentry</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4596">Sample Documents</A> - | <A HREF="glossaries-manual.html#6486">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6620">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#7457">Acronyms</A> -<DT><STRONG><TT>\newglossaryentry</TT> keys</STRONG> -<DD><DL COMPACT> -<DT><STRONG>access</STRONG> -<DD><A HREF="glossaries-manual.html#9016">Accessibility Support</A> -<DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#5745">Package Options</A> - | <A HREF="glossaries-manual.html#5760">Package Options</A> - | <A HREF="glossaries-manual.html#5782">Package Options</A> - | <A HREF="glossaries-manual.html#6161">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6149">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6188">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6719">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6722">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6725">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6757">Changing the format of</A> - | <A HREF="glossaries-manual.html#7485">Acronyms</A> - | <A HREF="glossaries-manual.html#7734">Acronyms</A> - | <A HREF="glossaries-manual.html#7784">Acronyms</A> - | <A HREF="glossaries-manual.html#9061">Accessibility Support</A> -<DT><STRONG>descriptionaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9058">Accessibility Support</A> -<DT><STRONG>descriptionplural</STRONG> -<DD><A HREF="glossaries-manual.html#6170">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6760">Changing the format of</A> - | <A HREF="glossaries-manual.html#9067">Accessibility Support</A> -<DT><STRONG>descriptionpluralaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9064">Accessibility Support</A> -<DT><STRONG>first</STRONG> -<DD><A HREF="glossaries-manual.html#6200">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6232">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6238">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6241">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6247">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6256">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6511">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6617">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6627">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6647">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6676">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6751">Changing the format of</A> - | <A HREF="glossaries-manual.html#6905">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#7479">Acronyms</A> - | <A HREF="glossaries-manual.html#8234">Unsetting and Resetting Entry</A> - | <A HREF="glossaries-manual.html#9031">Accessibility Support</A> -<DT><STRONG>firstaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9028">Accessibility Support</A> -<DT><STRONG>firstplural</STRONG> -<DD><A HREF="glossaries-manual.html#6222">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6244">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6253">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6347">Plurals</A> - | <A HREF="glossaries-manual.html#6637">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6689">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6754">Changing the format of</A> - | <A HREF="glossaries-manual.html#6909">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#9043">Accessibility Support</A> -<DT><STRONG>firstpluralaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9040">Accessibility Support</A> -<DT><STRONG>format</STRONG> -<DD><A HREF="glossaries-manual.html#6601">Links to Glossary Entries</A> -<DT><STRONG>name</STRONG> -<DD><A HREF="glossaries-manual.html#5742">Package Options</A> - | <A HREF="glossaries-manual.html#5763">Package Options</A> - | <A HREF="glossaries-manual.html#5779">Package Options</A> - | <A HREF="glossaries-manual.html#5794">Package Options</A> - | <A HREF="glossaries-manual.html#5797">Package Options</A> - | <A HREF="glossaries-manual.html#6155">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6146">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6152">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6197">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6292">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6366">Homographs</A> - | <A HREF="glossaries-manual.html#6695">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6698">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6701">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6895">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#7728">Acronyms</A> - | <A HREF="glossaries-manual.html#7731">Acronyms</A> - | <A HREF="glossaries-manual.html#8917">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#9019">Accessibility Support</A> -<DT><STRONG>nonumberlist</STRONG> -<DD><A HREF="glossaries-manual.html#6316">Defining Glossary Entries</A> -<DT><STRONG>parent</STRONG> -<DD><A HREF="glossaries-manual.html#6167">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6158">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6357">Hierarchical Categories</A> -<DT><STRONG>plural</STRONG> -<DD><A HREF="glossaries-manual.html#6210">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6229">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6250">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6341">Plurals</A> - | <A HREF="glossaries-manual.html#6344">Plurals</A> - | <A HREF="glossaries-manual.html#6376">Homographs</A> - | <A HREF="glossaries-manual.html#6634">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6683">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6748">Changing the format of</A> - | <A HREF="glossaries-manual.html#6901">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#9037">Accessibility Support</A> -<DT><STRONG>pluralaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9034">Accessibility Support</A> -<DT><STRONG>see</STRONG> -<DD><A HREF="glossaries-manual.html#4542">Introduction</A> - | <A HREF="glossaries-manual.html#6320">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6323">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6552">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6875">Cross-Referencing Entries</A> - | <A HREF="glossaries-manual.html#6878">Cross-Referencing Entries</A> - | <A HREF="glossaries-manual.html#6881">Cross-Referencing Entries</A> -<DT><STRONG>sort</STRONG> -<DD><A HREF="glossaries-manual.html#5353">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5788">Package Options</A> - | <A HREF="glossaries-manual.html#6283">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6329">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6373">Homographs</A> - | <A HREF="glossaries-manual.html#7760">Acronyms</A> - | <A HREF="glossaries-manual.html#7817">Acronyms</A> - | <A HREF="glossaries-manual.html#8914">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8920">Defining your own glossary</A> -<DT><STRONG>symbol</STRONG> -<DD><A HREF="glossaries-manual.html#5748">Package Options</A> - | <A HREF="glossaries-manual.html#5766">Package Options</A> - | <A HREF="glossaries-manual.html#5785">Package Options</A> - | <A HREF="glossaries-manual.html#6259">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6280">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6707">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6710">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6713">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6763">Changing the format of</A> - | <A HREF="glossaries-manual.html#6778">Changing the format of</A> - | <A HREF="glossaries-manual.html#6800">Changing the format of</A> - | <A HREF="glossaries-manual.html#7488">Acronyms</A> - | <A HREF="glossaries-manual.html#7644">Acronyms</A> - | <A HREF="glossaries-manual.html#7737">Acronyms</A> - | <A HREF="glossaries-manual.html#9049">Accessibility Support</A> -<DT><STRONG>symbolaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9046">Accessibility Support</A> -<DT><STRONG>symbolplural</STRONG> -<DD><A HREF="glossaries-manual.html#6262">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6766">Changing the format of</A> - | <A HREF="glossaries-manual.html#9055">Accessibility Support</A> -<DT><STRONG>symbolpluralaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9052">Accessibility Support</A> -<DT><STRONG>text</STRONG> -<DD><A HREF="glossaries-manual.html#5791">Package Options</A> - | <A HREF="glossaries-manual.html#5800">Package Options</A> - | <A HREF="glossaries-manual.html#6191">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6207">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6219">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6514">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6614">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6624">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6650">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6663">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6745">Changing the format of</A> - | <A HREF="glossaries-manual.html#6898">Using Glossary Terms Without</A> - | <A HREF="glossaries-manual.html#7482">Acronyms</A> - | <A HREF="glossaries-manual.html#8238">Unsetting and Resetting Entry</A> - | <A HREF="glossaries-manual.html#9025">Accessibility Support</A> -<DT><STRONG>textaccess</STRONG> -<DD><A HREF="glossaries-manual.html#9022">Accessibility Support</A> -<DT><STRONG>type</STRONG> -<DD><A HREF="glossaries-manual.html#6295">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6382">Loading Entries From a</A> -<DT><STRONG>user1</STRONG> -<DD><A HREF="#13033">no title</A> - | <A HREF="glossaries-manual.html#6310">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6731">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#8985">no title</A> - | <A HREF="glossaries-manual.html#8997">Example: creating a glossary</A> - | <A HREF="glossaries-manual.html#9000">Example: creating a glossary</A> -<DT><STRONG>user2</STRONG> -<DD><A HREF="glossaries-manual.html#9003">Example: creating a glossary</A> -<DT><STRONG>user6</STRONG> -<DD><A HREF="#13039">no title</A> - | <A HREF="glossaries-manual.html#6313">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#8988">no title</A> -</DL> -<DT><STRONG><TT>\newglossarystyle</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8327">Glossary Styles</A> -<DT><STRONG><TT>\newline</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6164">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#8310">Glossary Styles</A> -<DT><STRONG><TT>ngerman</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4776">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#7036">Xindy</A> -<DT><STRONG><TT>\nohyperpage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6474">Number lists</A> -<DT><STRONG><TT>\noist</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4666">Sample Documents</A> - | <A HREF="glossaries-manual.html#6459">Number lists</A> - | <A HREF="glossaries-manual.html#6480">Number lists</A> - | <A HREF="glossaries-manual.html#7046">Xindy</A> - | <A HREF="glossaries-manual.html#7083">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7116">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7134">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7153">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7166">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7188">Glossary Groups</A> -<DT><STRONG><TT>\nopostdesc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6360">Hierarchical Categories</A> - | <A HREF="glossaries-manual.html#6369">Homographs</A> - | <A HREF="glossaries-manual.html#8335">Glossary Styles</A> -<DT><STRONG>number list</STRONG> -<DD><A HREF="glossaries-manual.html#4601">Sample Documents</A> - | <A HREF="glossaries-manual.html#4612">Sample Documents</A> - | <A HREF="glossaries-manual.html#4969">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5720">Package Options</A> - | <A HREF="glossaries-manual.html#5730">Package Options</A> - | <A HREF="glossaries-manual.html#6121">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6143">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6144">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6318">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6352">Sub-Entries</A> - | <A HREF="glossaries-manual.html#6371">Homographs</A> - | <A HREF="glossaries-manual.html#6424">Number lists</A> - | <A HREF="glossaries-manual.html#6496">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6883">Cross-Referencing Entries</A> - | <A HREF="glossaries-manual.html#7142">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7161">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7199">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#8365">List Styles</A> - | <A HREF="glossaries-manual.html#8396">List Styles</A> - | <A HREF="glossaries-manual.html#8432">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8452">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8542">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8562">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8639">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8659">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8753">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8773">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8975">Example: creating a completely</A> -<DT><STRONG><TT>\oldacronym</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8170">Upgrading From the glossary</A> -<DT><STRONG>package options</STRONG> -<DD><DL COMPACT> -<DT><STRONG>acronym</STRONG> -<DD><A HREF="glossaries-manual.html#4806">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4808">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#5098">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5100">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5113">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5115">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5176">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5178">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5194">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5196">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5402">Package Options</A> - | <A HREF="glossaries-manual.html#5404">Package Options</A> - | <A HREF="glossaries-manual.html#5468">Package Options</A> - | <A HREF="glossaries-manual.html#5470">Package Options</A> - | <A HREF="glossaries-manual.html#5477">Package Options</A> - | <A HREF="glossaries-manual.html#5479">Package Options</A> - | <A HREF="glossaries-manual.html#5495">Package Options</A> - | <A HREF="glossaries-manual.html#5497">Package Options</A> - | <A HREF="glossaries-manual.html#5576">Package Options</A> - | <A HREF="glossaries-manual.html#5578">Package Options</A> - | <A HREF="glossaries-manual.html#5589">Package Options</A> - | <A HREF="glossaries-manual.html#5591">Package Options</A> - | <A HREF="glossaries-manual.html#5598">Package Options</A> - | <A HREF="glossaries-manual.html#5600">Package Options</A> - | <A HREF="glossaries-manual.html#6306">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6308">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6390">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6392">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6399">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6401">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6408">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6410">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6417">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#6419">Loading Entries From a</A> - | <A HREF="glossaries-manual.html#7224">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7226">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7233">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7235">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7242">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7244">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7274">Acronyms</A> - | <A HREF="glossaries-manual.html#7276">Acronyms</A> -<DT><STRONG>acronymlists</STRONG> -<DD><A HREF="glossaries-manual.html#5513">Package Options</A> - | <A HREF="glossaries-manual.html#5515">Package Options</A> - | <A HREF="glossaries-manual.html#5522">Package Options</A> - | <A HREF="glossaries-manual.html#5524">Package Options</A> - | <A HREF="glossaries-manual.html#7251">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7253">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7283">Acronyms</A> - | <A HREF="glossaries-manual.html#7285">Acronyms</A> -<DT><STRONG>counter</STRONG> -<DD><A HREF="glossaries-manual.html#5727">Package Options</A> - | <A HREF="glossaries-manual.html#5729">Package Options</A> - | <A HREF="glossaries-manual.html#6128">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6130">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6440">Number lists</A> - | <A HREF="glossaries-manual.html#6442">Number lists</A> -<DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#5808">Package Options</A> - | <A HREF="glossaries-manual.html#5810">Package Options</A> - | <A HREF="glossaries-manual.html#7332">Acronyms</A> - | <A HREF="glossaries-manual.html#7334">Acronyms</A> - | <A HREF="glossaries-manual.html#7392">Acronyms</A> - | <A HREF="glossaries-manual.html#7394">Acronyms</A> - | <A HREF="glossaries-manual.html#7496">Acronyms</A> - | <A HREF="glossaries-manual.html#7498">Acronyms</A> - | <A HREF="glossaries-manual.html#7514">Acronyms</A> - | <A HREF="glossaries-manual.html#7516">Acronyms</A> - | <A HREF="glossaries-manual.html#7532">Acronyms</A> - | <A HREF="glossaries-manual.html#7534">Acronyms</A> - | <A HREF="glossaries-manual.html#7615">Acronyms</A> - | <A HREF="glossaries-manual.html#7617">Acronyms</A> - | <A HREF="glossaries-manual.html#7630">Acronyms</A> - | <A HREF="glossaries-manual.html#7632">Acronyms</A> - | <A HREF="glossaries-manual.html#7724">Acronyms</A> - | <A HREF="glossaries-manual.html#7726">Acronyms</A> - | <A HREF="glossaries-manual.html#7745">Acronyms</A> - | <A HREF="glossaries-manual.html#7747">Acronyms</A> - | <A HREF="glossaries-manual.html#7756">Acronyms</A> - | <A HREF="glossaries-manual.html#7758">Acronyms</A> - | <A HREF="glossaries-manual.html#7771">Acronyms</A> - | <A HREF="glossaries-manual.html#7773">Acronyms</A> - | <A HREF="glossaries-manual.html#7867">Acronyms</A> - | <A HREF="glossaries-manual.html#7869">Acronyms</A> - | <A HREF="glossaries-manual.html#7906">Acronyms</A> - | <A HREF="glossaries-manual.html#7908">Acronyms</A> - | <A HREF="glossaries-manual.html#7978">Acronyms</A> - | <A HREF="glossaries-manual.html#7980">Acronyms</A> -<DT><STRONG>dua</STRONG> -<DD><A HREF="glossaries-manual.html#5865">Package Options</A> - | <A HREF="glossaries-manual.html#5867">Package Options</A> - | <A HREF="glossaries-manual.html#7341">Acronyms</A> - | <A HREF="glossaries-manual.html#7343">Acronyms</A> - | <A HREF="glossaries-manual.html#7523">Acronyms</A> - | <A HREF="glossaries-manual.html#7525">Acronyms</A> - | <A HREF="glossaries-manual.html#7568">Acronyms</A> - | <A HREF="glossaries-manual.html#7570">Acronyms</A> - | <A HREF="glossaries-manual.html#7606">Acronyms</A> - | <A HREF="glossaries-manual.html#7608">Acronyms</A> - | <A HREF="glossaries-manual.html#7678">Acronyms</A> - | <A HREF="glossaries-manual.html#7680">Acronyms</A> - | <A HREF="glossaries-manual.html#7687">Acronyms</A> - | <A HREF="glossaries-manual.html#7689">Acronyms</A> - | <A HREF="glossaries-manual.html#7804">Acronyms</A> - | <A HREF="glossaries-manual.html#7806">Acronyms</A> - | <A HREF="glossaries-manual.html#7969">Acronyms</A> - | <A HREF="glossaries-manual.html#7971">Acronyms</A> -<DT><STRONG>footnote</STRONG> -<DD><A HREF="glossaries-manual.html#5820">Package Options</A> - | <A HREF="glossaries-manual.html#5822">Package Options</A> - | <A HREF="glossaries-manual.html#7292">Acronyms</A> - | <A HREF="glossaries-manual.html#7294">Acronyms</A> - | <A HREF="glossaries-manual.html#7350">Acronyms</A> - | <A HREF="glossaries-manual.html#7352">Acronyms</A> - | <A HREF="glossaries-manual.html#7401">Acronyms</A> - | <A HREF="glossaries-manual.html#7403">Acronyms</A> - | <A HREF="glossaries-manual.html#7505">Acronyms</A> - | <A HREF="glossaries-manual.html#7507">Acronyms</A> - | <A HREF="glossaries-manual.html#7541">Acronyms</A> - | <A HREF="glossaries-manual.html#7543">Acronyms</A> - | <A HREF="glossaries-manual.html#7597">Acronyms</A> - | <A HREF="glossaries-manual.html#7599">Acronyms</A> - | <A HREF="glossaries-manual.html#7639">Acronyms</A> - | <A HREF="glossaries-manual.html#7641">Acronyms</A> - | <A HREF="glossaries-manual.html#7696">Acronyms</A> - | <A HREF="glossaries-manual.html#7698">Acronyms</A> - | <A HREF="glossaries-manual.html#7795">Acronyms</A> - | <A HREF="glossaries-manual.html#7797">Acronyms</A> - | <A HREF="glossaries-manual.html#7828">Acronyms</A> - | <A HREF="glossaries-manual.html#7830">Acronyms</A> - | <A HREF="glossaries-manual.html#7858">Acronyms</A> - | <A HREF="glossaries-manual.html#7860">Acronyms</A> - | <A HREF="glossaries-manual.html#7897">Acronyms</A> - | <A HREF="glossaries-manual.html#7899">Acronyms</A> - | <A HREF="glossaries-manual.html#7960">Acronyms</A> - | <A HREF="glossaries-manual.html#7962">Acronyms</A> -<DT><STRONG>hyperfirst</STRONG> -<DD><A HREF="glossaries-manual.html#5278">Troubleshooting</A> - | <A HREF="glossaries-manual.html#6053">Package Options</A> - | <A HREF="glossaries-manual.html#6055">Package Options</A> - | <A HREF="glossaries-manual.html#6063">Package Options</A> - | <A HREF="glossaries-manual.html#6837">Enabling and disabling hyperlinks</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#5280">Troubleshooting</A> - | <A HREF="glossaries-manual.html#6839">Enabling and disabling hyperlinks</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="glossaries-manual.html#6065">Package Options</A> -</DL> -<DT><STRONG>makeindex</STRONG> -<DD><A HREF="glossaries-manual.html#5886">Package Options</A> - | <A HREF="glossaries-manual.html#5888">Package Options</A> -<DT><STRONG>nolist</STRONG> -<DD><A HREF="glossaries-manual.html#5650">Package Options</A> - | <A HREF="glossaries-manual.html#5652">Package Options</A> - | <A HREF="glossaries-manual.html#8350">List Styles</A> - | <A HREF="glossaries-manual.html#8352">List Styles</A> -<DT><STRONG>nolong</STRONG> -<DD><A HREF="glossaries-manual.html#5616">Package Options</A> - | <A HREF="glossaries-manual.html#5618">Package Options</A> - | <A HREF="glossaries-manual.html#8280">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8282">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8414">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8416">Longtable Styles</A> -<DT><STRONG>nomain</STRONG> -<DD><A HREF="glossaries-manual.html#5393">Package Options</A> - | <A HREF="glossaries-manual.html#5395">Package Options</A> - | <A HREF="glossaries-manual.html#7215">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#7217">Defining New Glossaries</A> -<DT><STRONG>nonumberlist</STRONG> -<DD><A HREF="glossaries-manual.html#5717">Package Options</A> - | <A HREF="glossaries-manual.html#5719">Package Options</A> - | <A HREF="glossaries-manual.html#6431">Number lists</A> - | <A HREF="glossaries-manual.html#6433">Number lists</A> - | <A HREF="glossaries-manual.html#8946">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8948">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8955">Defining your own glossary</A> - | <A HREF="glossaries-manual.html#8957">Defining your own glossary</A> -<DT><STRONG>nostyles</STRONG> -<DD><A HREF="glossaries-manual.html#5689">Package Options</A> - | <A HREF="glossaries-manual.html#5691">Package Options</A> - | <A HREF="glossaries-manual.html#8298">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8300">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8359">List Styles</A> - | <A HREF="glossaries-manual.html#8361">List Styles</A> - | <A HREF="glossaries-manual.html#8423">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8425">Longtable Styles</A> - | <A HREF="glossaries-manual.html#8625">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8627">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8829">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8831">Tree-Like Styles</A> -<DT><STRONG>nosuper</STRONG> -<DD><A HREF="glossaries-manual.html#5633">Package Options</A> - | <A HREF="glossaries-manual.html#5635">Package Options</A> - | <A HREF="glossaries-manual.html#8289">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8291">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8616">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8618">Supertabular Styles</A> -<DT><STRONG>notree</STRONG> -<DD><A HREF="glossaries-manual.html#5675">Package Options</A> - | <A HREF="glossaries-manual.html#5677">Package Options</A> - | <A HREF="glossaries-manual.html#8820">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8822">Tree-Like Styles</A> -<DT><STRONG>nowarn</STRONG> -<DD><A HREF="glossaries-manual.html#5383">Package Options</A> - | <A HREF="glossaries-manual.html#5385">Package Options</A> -<DT><STRONG>numberedsection</STRONG> -<DD><A HREF="glossaries-manual.html#5543">Package Options</A> - | <A HREF="glossaries-manual.html#5545">Package Options</A> - | <A HREF="glossaries-manual.html#5552">Package Options</A> - | <A HREF="glossaries-manual.html#5554">Package Options</A> - | <A HREF="glossaries-manual.html#5567">Package Options</A> - | <A HREF="glossaries-manual.html#6977">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6979">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6986">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6988">Displaying a glossary</A> -<DD><DL COMPACT> -<DT><STRONG>autolabel</STRONG> -<DD><A HREF="glossaries-manual.html#5569">Package Options</A> - | <A HREF="glossaries-manual.html#5560">Package Options</A> -<DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#5556">Package Options</A> -<DT><STRONG>nolabel</STRONG> -<DD><A HREF="glossaries-manual.html#5558">Package Options</A> -</DL> -<DT><STRONG>numberline</STRONG> -<DD><A HREF="glossaries-manual.html#5423">Package Options</A> - | <A HREF="glossaries-manual.html#5425">Package Options</A> - | <A HREF="glossaries-manual.html#5459">Package Options</A> - | <A HREF="glossaries-manual.html#5461">Package Options</A> -<DT><STRONG>order</STRONG> -<DD><A HREF="glossaries-manual.html#4625">Sample Documents</A> - | <A HREF="glossaries-manual.html#4634">Sample Documents</A> - | <A HREF="glossaries-manual.html#4995">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5004">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5957">Package Options</A> - | <A HREF="glossaries-manual.html#5959">Package Options</A> -<DD><DL COMPACT> -<DT><STRONG>letter</STRONG> -<DD><A HREF="glossaries-manual.html#4636">Sample Documents</A> - | <A HREF="glossaries-manual.html#4997">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5963">Package Options</A> -<DT><STRONG>word</STRONG> -<DD><A HREF="glossaries-manual.html#4627">Sample Documents</A> - | <A HREF="glossaries-manual.html#5006">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5961">Package Options</A> -</DL> -<DT><STRONG>sanitize</STRONG> -<DD><A HREF="glossaries-manual.html#5737">Package Options</A> - | <A HREF="glossaries-manual.html#5739">Package Options</A> - | <A HREF="glossaries-manual.html#5756">Package Options</A> - | <A HREF="glossaries-manual.html#5758">Package Options</A> - | <A HREF="glossaries-manual.html#5774">Package Options</A> - | <A HREF="glossaries-manual.html#7655">Acronyms</A> - | <A HREF="glossaries-manual.html#7657">Acronyms</A> - | <A HREF="glossaries-manual.html#7663">Acronyms</A> - | <A HREF="glossaries-manual.html#7670">Acronyms</A> - | <A HREF="glossaries-manual.html#7781">Acronyms</A> - | <A HREF="glossaries-manual.html#7838">Acronyms</A> - | <A HREF="glossaries-manual.html#7880">Acronyms</A> - | <A HREF="glossaries-manual.html#7934">Acronyms</A> - | <A HREF="glossaries-manual.html#7988">Acronyms</A> - | <A HREF="glossaries-manual.html#7990">Acronyms</A> - | <A HREF="glossaries-manual.html#8015">Acronyms</A> - | <A HREF="glossaries-manual.html#8016">Acronyms</A> -<DD><DL COMPACT> -<DT><STRONG>description</STRONG> -<DD><A HREF="glossaries-manual.html#7664">Acronyms</A> - | <A HREF="glossaries-manual.html#7839">Acronyms</A> -<DT><STRONG>none</STRONG> -<DD><A HREF="glossaries-manual.html#5776">Package Options</A> -<DT><STRONG>symbol</STRONG> -<DD><A HREF="glossaries-manual.html#7671">Acronyms</A> - | <A HREF="glossaries-manual.html#7782">Acronyms</A> - | <A HREF="glossaries-manual.html#7881">Acronyms</A> - | <A HREF="glossaries-manual.html#7935">Acronyms</A> -</DL> -<DT><STRONG>section</STRONG> -<DD><A HREF="glossaries-manual.html#5531">Package Options</A> - | <A HREF="glossaries-manual.html#5533">Package Options</A> -<DT><STRONG>shortcuts</STRONG> -<DD><A HREF="glossaries-manual.html#5877">Package Options</A> - | <A HREF="glossaries-manual.html#5879">Package Options</A> - | <A HREF="glossaries-manual.html#7362">Acronyms</A> - | <A HREF="glossaries-manual.html#7364">Acronyms</A> - | <A HREF="glossaries-manual.html#8032">Acronyms</A> - | <A HREF="glossaries-manual.html#8034">Acronyms</A> - | <A HREF="glossaries-manual.html#8044">Acronyms</A> - | <A HREF="glossaries-manual.html#8046">Acronyms</A> - | <A HREF="glossaries-manual.html#8053">Acronyms</A> - | <A HREF="glossaries-manual.html#8055">Acronyms</A> -<DT><STRONG>smallcaps</STRONG> -<DD><A HREF="glossaries-manual.html#5260">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5262">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5269">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5271">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5832">Package Options</A> - | <A HREF="glossaries-manual.html#5834">Package Options</A> - | <A HREF="glossaries-manual.html#7301">Acronyms</A> - | <A HREF="glossaries-manual.html#7303">Acronyms</A> - | <A HREF="glossaries-manual.html#7314">Acronyms</A> - | <A HREF="glossaries-manual.html#7316">Acronyms</A> - | <A HREF="glossaries-manual.html#7374">Acronyms</A> - | <A HREF="glossaries-manual.html#7376">Acronyms</A> - | <A HREF="glossaries-manual.html#7420">Acronyms</A> - | <A HREF="glossaries-manual.html#7422">Acronyms</A> - | <A HREF="glossaries-manual.html#7429">Acronyms</A> - | <A HREF="glossaries-manual.html#7431">Acronyms</A> - | <A HREF="glossaries-manual.html#7465">Acronyms</A> - | <A HREF="glossaries-manual.html#7467">Acronyms</A> - | <A HREF="glossaries-manual.html#7550">Acronyms</A> - | <A HREF="glossaries-manual.html#7552">Acronyms</A> - | <A HREF="glossaries-manual.html#7579">Acronyms</A> - | <A HREF="glossaries-manual.html#7581">Acronyms</A> - | <A HREF="glossaries-manual.html#7714">Acronyms</A> - | <A HREF="glossaries-manual.html#7716">Acronyms</A> - | <A HREF="glossaries-manual.html#7849">Acronyms</A> - | <A HREF="glossaries-manual.html#7851">Acronyms</A> - | <A HREF="glossaries-manual.html#7942">Acronyms</A> - | <A HREF="glossaries-manual.html#7944">Acronyms</A> -<DT><STRONG>smaller</STRONG> -<DD><A HREF="glossaries-manual.html#5287">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5289">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5297">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5299">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5844">Package Options</A> - | <A HREF="glossaries-manual.html#5846">Package Options</A> - | <A HREF="glossaries-manual.html#7323">Acronyms</A> - | <A HREF="glossaries-manual.html#7325">Acronyms</A> - | <A HREF="glossaries-manual.html#7383">Acronyms</A> - | <A HREF="glossaries-manual.html#7385">Acronyms</A> - | <A HREF="glossaries-manual.html#7411">Acronyms</A> - | <A HREF="glossaries-manual.html#7413">Acronyms</A> - | <A HREF="glossaries-manual.html#7438">Acronyms</A> - | <A HREF="glossaries-manual.html#7440">Acronyms</A> - | <A HREF="glossaries-manual.html#7450">Acronyms</A> - | <A HREF="glossaries-manual.html#7452">Acronyms</A> - | <A HREF="glossaries-manual.html#7474">Acronyms</A> - | <A HREF="glossaries-manual.html#7476">Acronyms</A> - | <A HREF="glossaries-manual.html#7559">Acronyms</A> - | <A HREF="glossaries-manual.html#7561">Acronyms</A> - | <A HREF="glossaries-manual.html#7588">Acronyms</A> - | <A HREF="glossaries-manual.html#7590">Acronyms</A> - | <A HREF="glossaries-manual.html#7705">Acronyms</A> - | <A HREF="glossaries-manual.html#7707">Acronyms</A> - | <A HREF="glossaries-manual.html#7888">Acronyms</A> - | <A HREF="glossaries-manual.html#7890">Acronyms</A> - | <A HREF="glossaries-manual.html#7951">Acronyms</A> - | <A HREF="glossaries-manual.html#7953">Acronyms</A> -<DT><STRONG>style</STRONG> -<DD><A HREF="glossaries-manual.html#5607">Package Options</A> - | <A HREF="glossaries-manual.html#5609">Package Options</A> - | <A HREF="glossaries-manual.html#5666">Package Options</A> - | <A HREF="glossaries-manual.html#5668">Package Options</A> - | <A HREF="glossaries-manual.html#5699">Package Options</A> - | <A HREF="glossaries-manual.html#5701">Package Options</A> - | <A HREF="glossaries-manual.html#6962">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6964">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#8270">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8272">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8536">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8538">Longtable Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8743">Supertabular Styles (Ragged Right)</A> - | <A HREF="glossaries-manual.html#8745">Supertabular Styles (Ragged Right)</A> -<DT><STRONG>toc</STRONG> -<DD><A HREF="glossaries-manual.html#5414">Package Options</A> - | <A HREF="glossaries-manual.html#5416">Package Options</A> - | <A HREF="glossaries-manual.html#5432">Package Options</A> - | <A HREF="glossaries-manual.html#5434">Package Options</A> - | <A HREF="glossaries-manual.html#5441">Package Options</A> - | <A HREF="glossaries-manual.html#5443">Package Options</A> - | <A HREF="glossaries-manual.html#5450">Package Options</A> - | <A HREF="glossaries-manual.html#5452">Package Options</A> - | <A HREF="glossaries-manual.html#6950">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6952">Displaying a glossary</A> -<DT><STRONG>translate</STRONG> -<DD><A HREF="glossaries-manual.html#4851">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4873">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#5973">Package Options</A> - | <A HREF="glossaries-manual.html#5975">Package Options</A> - | <A HREF="glossaries-manual.html#5995">Package Options</A> - | <A HREF="glossaries-manual.html#6032">Package Options</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="glossaries-manual.html#4853">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4875">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#6034">Package Options</A> - | <A HREF="glossaries-manual.html#5988">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="glossaries-manual.html#5997">Package Options</A> - | <A HREF="glossaries-manual.html#5977">Package Options</A> -</DL> -<DT><STRONG>xindy</STRONG> -<DD><A HREF="glossaries-manual.html#4696">Sample Documents</A> - | <A HREF="glossaries-manual.html#4698">Sample Documents</A> - | <A HREF="glossaries-manual.html#4734">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4736">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4933">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4935">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5013">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5015">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5065">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5067">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5149">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5151">Using makeindex explicitly</A> - | <A HREF="glossaries-manual.html#5915">Package Options</A> - | <A HREF="glossaries-manual.html#5917">Package Options</A> - | <A HREF="glossaries-manual.html#5944">Package Options</A> - | <A HREF="glossaries-manual.html#5946">Package Options</A> - | <A HREF="glossaries-manual.html#6140">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6142">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#7019">Xindy</A> - | <A HREF="glossaries-manual.html#7021">Xindy</A> - | <A HREF="glossaries-manual.html#7184">Glossary Groups</A> - | <A HREF="glossaries-manual.html#7186">Glossary Groups</A> -</DL> -<DT><STRONG><TT>\pagelistname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4819">Changing the Fixed Names</A> -<DT><STRONG><TT>pod2man</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5051">Using the makeglossaries Perl</A> -<DT><STRONG><TT>polyglossia</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4760">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4859">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#5982">Package Options</A> - | <A HREF="glossaries-manual.html#6021">Package Options</A> - | <A HREF="glossaries-manual.html#6039">Package Options</A> -<DT><STRONG><TT>\printglossaries</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5337">Troubleshooting</A> - | <A HREF="glossaries-manual.html#6077">Defining Glossary Entries</A> -<DT><STRONG><TT>\printglossary</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5334">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5709">Package Options</A> - | <A HREF="glossaries-manual.html#6074">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#8262">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8316">Glossary Styles</A> -<DT><STRONG><TT>\printglossary</TT> keys</STRONG> -<DD><DL COMPACT> -<DT><STRONG>nonumberlist</STRONG> -<DD><A HREF="glossaries-manual.html#6990">Displaying a glossary</A> -<DT><STRONG>numberedsection</STRONG> -<DD><A HREF="glossaries-manual.html#6969">Displaying a glossary</A> -<DT><STRONG>style</STRONG> -<DD><A HREF="glossaries-manual.html#5706">Package Options</A> - | <A HREF="glossaries-manual.html#6954">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#8259">Glossary Styles</A> - | <A HREF="glossaries-manual.html#8313">Glossary Styles</A> -<DT><STRONG>title</STRONG> -<DD><A HREF="glossaries-manual.html#6939">Displaying a glossary</A> -<DT><STRONG>toctitle</STRONG> -<DD><A HREF="glossaries-manual.html#6942">Displaying a glossary</A> -<DT><STRONG>type</STRONG> -<DD><A HREF="glossaries-manual.html#6936">Displaying a glossary</A> -</DL> -<DT><STRONG><TT>relsize</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5851">Package Options</A> - | <A HREF="glossaries-manual.html#7442">Acronyms</A> - | <A HREF="glossaries-manual.html#7923">Acronyms</A> -<DT><STRONG><TT>\seename</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6885">Cross-Referencing Entries</A> -<DT><STRONG><TT>\setAlphaCompositor</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7147">Locations and Number lists</A> -<DT><STRONG><TT>\setCompositor</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7144">Locations and Number lists</A> -<DT><STRONG><TT>\setStyleFile</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5090">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5165">Using makeindex explicitly</A> -<DT><STRONG><TT>\smaller</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7911">Acronyms</A> -<DT><STRONG><TT>supertabular</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5641">Package Options</A> - | <A HREF="glossaries-manual.html#8637">Supertabular Styles</A> - | <A HREF="glossaries-manual.html#8751">Supertabular Styles (Ragged Right)</A> -<DT><STRONG><TT>\symbolname</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4816">Changing the Fixed Names</A> -<DT><STRONG><TT>\textbf</TT></STRONG> -<DD><A HREF="glossaries-manual.html#6528">Links to Glossary Entries</A> -<DT><STRONG><TT>\textrm</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7101">Locations and Number lists</A> -<DT><STRONG><TT>\textsc</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7872">Acronyms</A> -<DT><STRONG><TT>\textsmaller</TT></STRONG> -<DD><A HREF="glossaries-manual.html#5854">Package Options</A> - | <A HREF="glossaries-manual.html#7914">Acronyms</A> - | <A HREF="glossaries-manual.html#7920">Acronyms</A> -<DT><STRONG><TT>\thepage</TT></STRONG> -<DD><A HREF="glossaries-manual.html#7128">Locations and Number lists</A> -<DT><STRONG><TT>translator</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4767">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4770">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4773">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4785">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4789">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4831">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4834">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4837">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4843">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#5323">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5985">Package Options</A> - | <A HREF="glossaries-manual.html#6002">Package Options</A> - | <A HREF="glossaries-manual.html#6005">Package Options</A> - | <A HREF="glossaries-manual.html#6008">Package Options</A> - | <A HREF="glossaries-manual.html#6011">Package Options</A> -<DT><STRONG><TT>xindy</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4555">Introduction</A> - | <A HREF="glossaries-manual.html#4564">Introduction</A> - | <A HREF="glossaries-manual.html#4645">Sample Documents</A> - | <A HREF="glossaries-manual.html#4657">Sample Documents</A> - | <A HREF="glossaries-manual.html#4670">Sample Documents</A> - | <A HREF="glossaries-manual.html#4676">Sample Documents</A> - | <A HREF="glossaries-manual.html#4682">Sample Documents</A> - | <A HREF="glossaries-manual.html#4685">Sample Documents</A> - | <A HREF="glossaries-manual.html#4714">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4720">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4726">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4747">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4753">Multi-Lingual Support</A> - | <A HREF="glossaries-manual.html#4877">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4883">Changing the Fixed Names</A> - | <A HREF="glossaries-manual.html#4987">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4892">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4899">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4905">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4908">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4918">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4937">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4955">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4964">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#4974">Generating the Associated Glossary</A> - | <A HREF="glossaries-manual.html#5033">Using the makeglossaries Perl</A> - | <A HREF="glossaries-manual.html#5057">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5069">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5075">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5078">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5083">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5123">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5129">Using xindy explicitly</A> - | <A HREF="glossaries-manual.html#5222">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5235">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5240">Note to Front-End and</A> - | <A HREF="glossaries-manual.html#5308">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5356">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5362">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5365">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5368">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5371">Troubleshooting</A> - | <A HREF="glossaries-manual.html#5905">Package Options</A> - | <A HREF="glossaries-manual.html#5919">Package Options</A> - | <A HREF="glossaries-manual.html#5925">Package Options</A> - | <A HREF="glossaries-manual.html#5931">Package Options</A> - | <A HREF="glossaries-manual.html#5948">Package Options</A> - | <A HREF="glossaries-manual.html#6086">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6094">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6100">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6119">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6132">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6289">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6335">Defining Glossary Entries</A> - | <A HREF="glossaries-manual.html#6447">Number lists</A> - | <A HREF="glossaries-manual.html#6450">Number lists</A> - | <A HREF="glossaries-manual.html#6465">Number lists</A> - | <A HREF="glossaries-manual.html#6468">Number lists</A> - | <A HREF="glossaries-manual.html#6494">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6537">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6549">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6604">Links to Glossary Entries</A> - | <A HREF="glossaries-manual.html#6924">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#6930">Displaying a glossary</A> - | <A HREF="glossaries-manual.html#7011">Xindy</A> - | <A HREF="glossaries-manual.html#7023">Xindy</A> - | <A HREF="glossaries-manual.html#7027">Xindy</A> - | <A HREF="glossaries-manual.html#7032">Xindy</A> - | <A HREF="glossaries-manual.html#7039">Xindy</A> - | <A HREF="glossaries-manual.html#7043">Xindy</A> - | <A HREF="glossaries-manual.html#7050">Xindy</A> - | <A HREF="glossaries-manual.html#7053">Xindy</A> - | <A HREF="glossaries-manual.html#7059">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7062">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7071">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7080">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7089">Language and Encodings</A> - | <A HREF="glossaries-manual.html#7107">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7113">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7131">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7163">Locations and Number lists</A> - | <A HREF="glossaries-manual.html#7204">Defining New Glossaries</A> - | <A HREF="glossaries-manual.html#8855">Tree-Like Styles</A> - | <A HREF="glossaries-manual.html#8923">Defining your own glossary</A> -<DT><STRONG><TT>xkeyval</TT></STRONG> -<DD><A HREF="glossaries-manual.html#4574">Sample Documents</A> - | <A HREF="glossaries-manual.html#5252">Troubleshooting</A> -<DT><STRONG><TT>xspace</TT></STRONG> -<DD><A HREF="glossaries-manual.html#8191">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8195">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8198">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8201">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8207">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8216">Upgrading From the glossary</A> - | <A HREF="glossaries-manual.html#8219">Upgrading From the glossary</A> - -</DL> -<P> -<A HREF="glossaries-manual.html#top">Top</A> - -<P> -<BR><HR><H4>Footnotes</H4> -<DL> -<DT><A NAME="foot4474">... used</A><A - HREF="glossaries-manual.html#tex2html2"><SUP>1</SUP></A></DT> -<DD>that is, if the term has been -referenced using any of the commands described in <A HREF="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A>, -<A HREF="glossaries-manual.html#sec:glsadd">Adding an Entry to the -Glossary Without Generating Text</A> or -via <TT>\glssee</TT><A NAME="4539"></A> (or the <TT>see</TT><A NAME="4542"></A> key) - -</DD> -<DT><A NAME="foot4254">... -Site.</A><A - HREF="glossaries-manual.html#tex2html17"><SUP>2</SUP></A></DT> -<DD><TT>http://xindy.sourceforge.net/</TT> - -</DD> -<DT><A NAME="foot4258">...main.</A><A - HREF="glossaries-manual.html#tex2html19"><SUP>3</SUP></A></DT> -<DD>Actually it sets <TT>\acronymtype</TT><A NAME="5484"></A> to -<TT>\glsdefaulttype</TT><A NAME="5487"></A> if the <TT>acronym</TT><A NAME="5495"></A> package option is -not used, but <TT>\glsdefaulttype</TT><A NAME="5499"></A> usually has the value -<TT>main</TT>. - -</DD> -<DT><A NAME="foot4259">...acronym</A><A - HREF="glossaries-manual.html#tex2html20"><SUP>4</SUP></A></DT> -<DD>if the -<TT>acronym</TT><A NAME="5576"></A> option is used, otherwise the list of -acronyms is the main glossary - -</DD> -<DT><A NAME="foot4283">... this.</A><A - HREF="glossaries-manual.html#tex2html21"><SUP>5</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="foot4317">... specified.</A><A - HREF="glossaries-manual.html#tex2html22"><SUP>6</SUP></A></DT> -<DD>This -is because <TT>\acronymtype</TT> is set to <TT>\glsdefaulttype</TT> if -the <TT>acronym</TT><A NAME="6408"></A> package option is not used. - -</DD> -<DT><A NAME="foot4350">... label</A><A - HREF="glossaries-manual.html#tex2html24"><SUP>7</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="foot4479">... hyphen</A><A - HREF="glossaries-manual.html#tex2html26"><SUP>8</SUP></A></DT> -<DD>see -<TT>\setCompositor</TT><A NAME="7144"></A> described in -<A HREF="glossaries-manual.html#sec:newglosentry">Defining Glossary -Entries</A> - -</DD> -<DT><A NAME="foot4480">... -hyphen</A><A - HREF="glossaries-manual.html#tex2html27"><SUP>9</SUP></A></DT> -<DD>see <TT>\setAlphaCompositor</TT><A NAME="7147"></A> described in -<A HREF="glossaries-manual.html#sec:newglosentry">Defining Glossary -Entries</A> - -</DD> -<DT><A NAME="foot4398">...textsmaller,</A><A - HREF="glossaries-manual.html#tex2html28"><SUP>10</SUP></A></DT> -<DD>you will need to load a package, such as -<TT>relsize</TT>, that defines <TT>\textsmaller</TT> if you use this -option. - -</DD> -<DT><A NAME="foot4411">... -<code>\textsmaller{#1}</code>.</A><A - HREF="glossaries-manual.html#tex2html32"><SUP>11</SUP></A></DT> -<DD>not that this was change from -using <TT>\smaller</TT><A NAME="7911"></A> to <TT>\textsmaller</TT><A NAME="7914"></A> as declarations -cause a problem for <TT>\makefirstuc</TT><A NAME="7917"></A>. - -</DD> -<DT><A NAME="foot3348">... package</A><A - HREF="glossaries-manual.html#tex2html34"><SUP>12</SUP></A></DT> -<DD>as from version 1.18 - -</DD> -<DT><A NAME="foot4418">... column.</A><A - HREF="glossaries-manual.html#tex2html37"><SUP>13</SUP></A></DT> -<DD>these lengths will not be -available if you use both the <TT>nolong</TT><A NAME="8280"></A> and <TT>nosuper</TT><A NAME="8289"></A> -package options or if you use the <TT>nostyles</TT><A NAME="8298"></A> package option -unless you explicitly load the relevant package. - -</DD> -<DT><A NAME="foot3576">... -environment.</A><A - HREF="glossaries-manual.html#tex2html38"><SUP>14</SUP></A></DT> -<DD>This style was supplied by Axel Menzel. - -</DD> -<DT><A NAME="foot4421">...supertabular.</A><A - HREF="glossaries-manual.html#tex2html39"><SUP>15</SUP></A></DT> -<DD>e.g. with the <TT>flowfram</TT><A NAME="8631"></A> -package. + <br />\xmakefirstuc{\abc} +</div> +<!--l. 5054--><p class="nopar" > produces: Abc. +</p><!--l. 5057--><p class="indent" > If you want to use an alternative command to convert to uppercase, for example +<span +class="ectt-1000">\MakeTextUppercase</span>,<span class="footnote-mark"><a +href="#fn15x0" id="fn15x0-bk"><sup class="textsuperscript">15</sup></a></span><a + id="x1-50006f15"></a> +you can redefine the internal command <span +class="ectt-1000">\@gls@makefirstuc</span>. For example: + + + +</p> + <div class="verbatim" id="verbatim-123"> +\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} +</div> +<!--l. 5063--><p class="nopar" > (Remember that command names that contain the @ character must either be placed +in packages or be placed between <span +class="ectt-1000">\makeatletter </span>and <span +class="ectt-1000">\makeatother</span>.) + + + +</p><!--l. 5074--><p class="indent" > <a + id="likesection.1"></a><a + id="Q1-1-59"></a> +</p> +<!--l. 2--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="likesectionHead"><a + id="x1-510003"></a>Index</h3> +<!--l. 4--><p class="noindent" > <span +class="ecbx-1000">Symbols</span> +</p> + <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\@gls@codepage</span></span></span>  <a +href="glossaries-manual.html#dx1-10012" ><span +class="ecti-1000">1</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\@glsorder</span></span></span>  <a +href="glossaries-manual.html#dx1-10009" ><span +class="ecti-1000">2</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\@istfilename</span></span></span>  <a +href="glossaries-manual.html#dx1-10004" ><span +class="ecti-1000">3</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\@newglossary</span></span></span>  <a +href="glossaries-manual.html#dx1-10003" ><span +class="ecti-1000">4</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\@xdylanguage</span></span></span>  <a +href="glossaries-manual.html#dx1-10011" ><span +class="ecti-1000">5</span></a> <br /></span> +<p class="theindex"> <span +class="ecbx-1000">A</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Ac</span></span></span>  <a +href="glossaries-manual.html#dx1-34183" ><span class="underline">6</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ac</span></span></span>  <a +href="glossaries-manual.html#dx1-34181" ><span class="underline">7</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">accsupp </span>package  <a +href="glossaries-manual.html#dx1-49002" >8</a>, <a +href="glossaries-manual.html#dx1-49021" >9</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acf</span></span></span>  <a +href="glossaries-manual.html#dx1-34175" ><span class="underline">10</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acf</span></span></span>  <a +href="glossaries-manual.html#dx1-34173" ><span class="underline">11</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acfp</span></span></span>  <a +href="glossaries-manual.html#dx1-34179" ><span class="underline">12</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acfp</span></span></span>  <a +href="glossaries-manual.html#dx1-34177" ><span class="underline">13</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acl</span></span></span>  <a +href="glossaries-manual.html#dx1-34167" ><span class="underline">14</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acl</span></span></span>  <a +href="glossaries-manual.html#dx1-34165" ><span class="underline">15</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Aclp</span></span></span>  <a +href="glossaries-manual.html#dx1-34171" ><span class="underline">16</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\aclp</span></span></span>  <a +href="glossaries-manual.html#dx1-34169" ><span class="underline">17</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acp</span></span></span>  <a +href="glossaries-manual.html#dx1-34187" ><span class="underline">18</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acp</span></span></span>  <a +href="glossaries-manual.html#dx1-34185" ><span class="underline">19</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ACRfull</span></span></span>  <a +href="glossaries-manual.html#dx1-34148" ><span +class="ecti-1000">20</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrfull</span></span></span>  <a +href="glossaries-manual.html#dx1-34147" ><span +class="ecti-1000">21</span></a>, <a +href="glossaries-manual.html#dx1-34176" ><span class="underline">22</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrfull</span></span></span>  <a +href="glossaries-manual.html#dx1-34146" ><span +class="ecti-1000">23</span></a>, <a +href="glossaries-manual.html#dx1-34174" ><span class="underline">24</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrfullpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34180" ><span class="underline">25</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrfullpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34178" ><span class="underline">26</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ACRlong</span></span></span>  <a +href="glossaries-manual.html#dx1-34142" ><span +class="ecti-1000">27</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrlong</span></span></span>  <a +href="glossaries-manual.html#dx1-34141" ><span +class="ecti-1000">28</span></a>, <a +href="glossaries-manual.html#dx1-34168" ><span class="underline">29</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrlong</span></span></span>  <a +href="glossaries-manual.html#dx1-11034" ><span class="underline">30</span></a>, <a +href="glossaries-manual.html#dx1-34140" ><span +class="ecti-1000">31</span></a>, <a +href="glossaries-manual.html#dx1-34166" ><span class="underline">32</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrlongpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34172" ><span class="underline">33</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrlongpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34170" ><span class="underline">34</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrnameformat</span></span></span>  <a +href="glossaries-manual.html#dx1-34097" ><span +class="ecti-1000">35</span></a>, <a +href="glossaries-manual.html#dx1-34099" ><span class="underline">36</span></a>, <a +href="glossaries-manual.html#dx1-34100" ><span class="underline">37</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acronymfont</span></span></span>  <a +href="glossaries-manual.html#dx1-13090" ><span class="underline">38</span></a>, <a +href="glossaries-manual.html#dx1-34027" ><span +class="ecti-1000">39</span></a>, <a +href="glossaries-manual.html#dx1-34098" ><span class="underline">40</span></a>, <a +href="glossaries-manual.html#dx1-34125" ><span class="underline">41</span></a>, <a +href="glossaries-manual.html#dx1-34139" ><span class="underline">42</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acronymname</span></span></span>  <a +href="glossaries-manual.html#dx1-5015" ><span class="underline">43</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acronymtype</span></span></span>  <a +href="glossaries-manual.html#dx1-13015" ><span class="underline">44</span></a>, <a +href="glossaries-manual.html#dx1-13022" ><span class="underline">45</span></a>, <a +href="glossaries-manual.html#dx1-13037" ><span class="underline">46</span></a>, <a +href="glossaries-manual.html#dx1-14087" ><span class="underline">47</span></a>, <a +href="glossaries-manual.html#dx1-33009" ><span +class="ecti-1000">48</span></a>, <a +href="glossaries-manual.html#dx1-34003" ><span class="underline">49</span></a>, <a +href="glossaries-manual.html#dx1-34004" ><span class="underline">50</span></a>, <a +href="glossaries-manual.html#dx1-13017" ><span class="underline">51</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrpluralsuffix</span></span></span>  <a +href="glossaries-manual.html#dx1-35029" ><span class="underline">52</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ACRshort</span></span></span>  <a +href="glossaries-manual.html#dx1-34137" ><span +class="ecti-1000">53</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrshort</span></span></span>  <a +href="glossaries-manual.html#dx1-34136" ><span +class="ecti-1000">54</span></a>, <a +href="glossaries-manual.html#dx1-34160" ><span class="underline">55</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrshort</span></span></span>  <a +href="glossaries-manual.html#dx1-34020" ><span class="underline">56</span></a>, <a +href="glossaries-manual.html#dx1-34135" ><span +class="ecti-1000">57</span></a>, <a +href="glossaries-manual.html#dx1-34158" ><span class="underline">58</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acrshortpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34164" ><span class="underline">59</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acrshortpl</span></span></span>  <a +href="glossaries-manual.html#dx1-34162" ><span class="underline">60</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acs</span></span></span>  <a +href="glossaries-manual.html#dx1-34159" ><span class="underline">61</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acs</span></span></span>  <a +href="glossaries-manual.html#dx1-34157" ><span class="underline">62</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Acsp</span></span></span>  <a +href="glossaries-manual.html#dx1-34163" ><span class="underline">63</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\acsp</span></span></span>  <a +href="glossaries-manual.html#dx1-34161" ><span class="underline">64</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">array </span>package  <a +href="glossaries-manual.html#dx1-41005" >65</a>, <a +href="glossaries-manual.html#dx1-43005" >66</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">B</span> +<span class="index-item"><span +class="ecss-1000">babel </span>package  <a +href="glossaries-manual.html#dx1-5001" >67</a>, <a +href="glossaries-manual.html#dx1-5003" >68</a>, <a +href="glossaries-manual.html#dx1-5009" >69</a>, <a +href="glossaries-manual.html#dx1-5023" >70</a>, <a +href="glossaries-manual.html#dx1-5027" >71</a>, <a +href="glossaries-manual.html#dx1-5032" >72</a>, <a +href="glossaries-manual.html#dx1-11030" >73</a>, <a +href="glossaries-manual.html#dx1-13118" >74</a>, <a +href="glossaries-manual.html#dx1-13123" >75</a>, <a +href="glossaries-manual.html#dx1-13128" >76</a>, <a +href="glossaries-manual.html#dx1-13133" >77</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">C</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\CustomAcronymFields</span></span></span>  <a +href="glossaries-manual.html#dx1-35001" ><span +class="ecti-1000">78</span></a>, <a +href="glossaries-manual.html#dx1-35021" ><span class="underline">79</span></a>, <a +href="glossaries-manual.html#dx1-35051" ><span class="underline">80</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">D</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\defglsdisplay</span></span></span>  <a +href="glossaries-manual.html#dx1-22025" ><span +class="ecti-1000">81</span></a>, <a +href="glossaries-manual.html#dx1-34064" ><span class="underline">82</span></a>, <a +href="glossaries-manual.html#dx1-34151" ><span class="underline">83</span></a>, <a +href="glossaries-manual.html#dx1-35016" ><span class="underline">84</span></a>, <a +href="glossaries-manual.html#dx1-35035" ><span class="underline">85</span></a>, <a +href="glossaries-manual.html#dx1-35038" ><span class="underline">86</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\defglsdisplayfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-22026" ><span +class="ecti-1000">87</span></a>, <a +href="glossaries-manual.html#dx1-34065" ><span class="underline">88</span></a>, <a +href="glossaries-manual.html#dx1-34152" ><span class="underline">89</span></a>, <a +href="glossaries-manual.html#dx1-35015" ><span class="underline">90</span></a>, <a +href="glossaries-manual.html#dx1-35034" ><span class="underline">91</span></a>, <a +href="glossaries-manual.html#dx1-35037" ><span class="underline">92</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">description </span>environment  <a +href="glossaries-manual.html#dx1-39002" >93</a>, <a +href="glossaries-manual.html#dx1-39006" >94</a>, <a +href="glossaries-manual.html#dx1-39023" >95</a>, <a +href="glossaries-manual.html#dx1-45006" >96</a>, <a +href="glossaries-manual.html#dx1-45008" >97</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\descriptionname</span></span></span>  <a +href="glossaries-manual.html#dx1-5018" ><span class="underline">98</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">E</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\emph</span></span></span>  <a +href="glossaries-manual.html#dx1-21022" ><span class="underline">99</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\entryname</span></span></span>  <a +href="glossaries-manual.html#dx1-5017" ><span class="underline">100</span></a> <br /></span> +<span class="index-item">environments:<br /></span> +<span class="index-subitem">    <span +class="ectt-1000">theglossary</span>  <a +href="glossaries-manual.html#dx1-45003" ><span +class="ecti-1000">101</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">equation </span>environment  <a +href="glossaries-manual.html#dx1-3024" >102</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">F</span> +<span class="index-item">file types<br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.alg</span>  <a +href="glossaries-manual.html#dx1-6029" >103</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.aux</span>  <a +href="glossaries-manual.html#dx1-7002" >104</a>, <a +href="glossaries-manual.html#dx1-30004" >105</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.glg</span>  <a +href="glossaries-manual.html#dx1-6028" >106</a>, <a +href="glossaries-manual.html#dx1-8013" >107</a>, <a +href="glossaries-manual.html#dx1-9012" >108</a>, <a +href="glossaries-manual.html#dx1-11043" >109</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.glo</span>  <a +href="glossaries-manual.html#dx1-8015" >110</a>, <a +href="glossaries-manual.html#dx1-9014" >111</a>, <a +href="glossaries-manual.html#dx1-14002" >112</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.gls</span>  <a +href="glossaries-manual.html#dx1-8014" >113</a>, <a +href="glossaries-manual.html#dx1-9013" >114</a>, <a +href="glossaries-manual.html#dx1-14003" >115</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.ist</span>  <a +href="glossaries-manual.html#dx1-9005" >116</a>, <a +href="glossaries-manual.html#dx1-9007" >117</a>, <a +href="glossaries-manual.html#dx1-10006" >118</a>, <a +href="glossaries-manual.html#dx1-13101" >119</a>, <a +href="glossaries-manual.html#dx1-14011" >120</a>, <a +href="glossaries-manual.html#dx1-14018" >121</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.log</span>  <a +href="glossaries-manual.html#dx1-11042" >122</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.tex</span>  <a +href="glossaries-manual.html#dx1-8007" >123</a>, <a +href="glossaries-manual.html#dx1-9004" >124</a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">.xdy</span>  <a +href="glossaries-manual.html#dx1-8009" >125</a>, <a +href="glossaries-manual.html#dx1-8010" >126</a>, <a +href="glossaries-manual.html#dx1-10008" >127</a>, <a +href="glossaries-manual.html#dx1-13109" >128</a>, <a +href="glossaries-manual.html#dx1-14013" >129</a>, <a +href="glossaries-manual.html#dx1-14021" >130</a>, <a +href="glossaries-manual.html#dx1-29005" >131</a> <br /></span> +<span class="index-item">first use  <a +href="glossaries-manual.html#dx1-11016" ><span class="underline">132</span></a>, <a +href="glossaries-manual.html#dx1-11018" ><span class="underline">133</span></a>, <a +href="glossaries-manual.html#dx1-13138" ><span class="underline">134</span></a>, <a +href="glossaries-manual.html#dx1-22005" ><span class="underline">135</span></a>, <a +href="glossaries-manual.html#dx1-22019" ><span class="underline">136</span></a>, <a +href="glossaries-manual.html#dx1-22028" ><span class="underline">137</span></a>, <a +href="glossaries-manual.html#dx1-23012" ><span class="underline">138</span></a>, <a +href="glossaries-manual.html#dx1-34001" ><span class="underline">139</span></a>, <a +href="glossaries-manual.html#dx1-34010" ><span class="underline">140</span></a>, <a +href="glossaries-manual.html#dx1-34029" ><span class="underline">141</span></a>, <a +href="glossaries-manual.html#dx1-34058" ><span class="underline">142</span></a>, <a +href="glossaries-manual.html#dx1-34068" ><span class="underline">143</span></a>, <a +href="glossaries-manual.html#dx1-34079" ><span class="underline">144</span></a>, <a +href="glossaries-manual.html#dx1-34091" ><span class="underline">145</span></a>, <a +href="glossaries-manual.html#dx1-34104" ><span class="underline">146</span></a>, <a +href="glossaries-manual.html#dx1-34106" ><span class="underline">147</span></a>, <a +href="glossaries-manual.html#dx1-34107" ><span class="underline">148</span></a>, <a +href="glossaries-manual.html#dx1-34108" ><span class="underline">149</span></a>, <a +href="glossaries-manual.html#dx1-34112" ><span class="underline">150</span></a>, <a +href="glossaries-manual.html#dx1-34118" ><span class="underline">151</span></a>, <a +href="glossaries-manual.html#dx1-34132" ><span class="underline">152</span></a>, <a +href="glossaries-manual.html#dx1-37004" ><span class="underline">153</span></a> <br /></span> + + + +<span class="index-subitem">    flag  <a +href="glossaries-manual.html#dx1-21010" ><span class="underline">154</span></a>, <a +href="glossaries-manual.html#dx1-21015" ><span class="underline">155</span></a>, <a +href="glossaries-manual.html#dx1-21017" ><span class="underline">156</span></a>, <a +href="glossaries-manual.html#dx1-21054" ><span class="underline">157</span></a>, <a +href="glossaries-manual.html#dx1-21057" ><span class="underline">158</span></a>, <a +href="glossaries-manual.html#dx1-21066" ><span class="underline">159</span></a>, <a +href="glossaries-manual.html#dx1-21072" ><span class="underline">160</span></a>, <a +href="glossaries-manual.html#dx1-21078" ><span class="underline">161</span></a>, <a +href="glossaries-manual.html#dx1-21086" ><span class="underline">162</span></a>, <a +href="glossaries-manual.html#dx1-26001" ><span class="underline">163</span></a> <br /></span> +<span class="index-subitem">    text  <a +href="glossaries-manual.html#dx1-14055" ><span class="underline">164</span></a>, <a +href="glossaries-manual.html#dx1-14063" ><span class="underline">165</span></a>, <a +href="glossaries-manual.html#dx1-26014" ><span class="underline">166</span></a>, <a +href="glossaries-manual.html#dx1-26018" ><span class="underline">167</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\firstacronymfont</span></span></span>  <a +href="glossaries-manual.html#dx1-34028" ><span +class="ecti-1000">168</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">flowfram </span>package  <a +href="glossaries-manual.html#dx1-42008" >169</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">fmtcount </span>package  <a +href="glossaries-manual.html#dx1-31011" >170</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">G</span> +<span class="index-item"><span +class="ecss-1000">german </span>package  <a +href="glossaries-manual.html#dx1-5008" >171</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossaries-accsupp </span>package  <a +href="glossaries-manual.html#dx1-3054" >172</a>, <a +href="glossaries-manual.html#dx1-49001" >173</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossaries-babel </span>package  <a +href="glossaries-manual.html#dx1-5030" >174</a>, <a +href="glossaries-manual.html#dx1-13129" >175</a>, <a +href="glossaries-manual.html#dx1-13135" >176</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossaries-polyglossia </span>package  <a +href="glossaries-manual.html#dx1-5033" >177</a>, <a +href="glossaries-manual.html#dx1-13131" >178</a>, <a +href="glossaries-manual.html#dx1-13136" >179</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary </span>package  <a +href="glossaries-manual.html#dx1-2005" >180</a>, <a +href="glossaries-manual.html#dx1-11027" >181</a>, <a +href="glossaries-manual.html#dx1-36001" >182</a>, <a +href="glossaries-manual.html#dx1-36002" >183</a>, <a +href="glossaries-manual.html#dx1-36005" >184</a> <br /></span> +<span class="index-item">glossary styles:<br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlist</span>  <a +href="glossaries-manual.html#dx1-39014" ><span class="underline">185</span></a>, <a +href="glossaries-manual.html#dx1-39019" ><span class="underline">186</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlistgroup</span>  <a +href="glossaries-manual.html#dx1-39018" ><span class="underline">187</span></a>, <a +href="glossaries-manual.html#dx1-39021" ><span class="underline">188</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlisthypergroup</span>  <a +href="glossaries-manual.html#dx1-39020" ><span class="underline">189</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlong4col</span>  <a +href="glossaries-manual.html#dx1-38019" ><span class="underline">190</span></a>, <a +href="glossaries-manual.html#dx1-40029" ><span class="underline">191</span></a>, <a +href="glossaries-manual.html#dx1-40036" ><span class="underline">192</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlong4colborder</span>  <a +href="glossaries-manual.html#dx1-40040" ><span class="underline">193</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlong4colheader</span>  <a +href="glossaries-manual.html#dx1-40042" ><span class="underline">194</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlong4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-40044" ><span class="underline">195</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlongragged4col</span>  <a +href="glossaries-manual.html#dx1-41028" ><span class="underline">196</span></a>, <a +href="glossaries-manual.html#dx1-41033" ><span class="underline">197</span></a>, <a +href="glossaries-manual.html#dx1-41035" ><span class="underline">198</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlongragged4colborder</span>  <a +href="glossaries-manual.html#dx1-41032" ><span class="underline">199</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlongragged4colheader</span>  <a +href="glossaries-manual.html#dx1-41034" ><span class="underline">200</span></a>, <a +href="glossaries-manual.html#dx1-41037" ><span class="underline">201</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altlongragged4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-41036" ><span class="underline">202</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuper4col</span>  <a +href="glossaries-manual.html#dx1-38020" ><span class="underline">203</span></a>, <a +href="glossaries-manual.html#dx1-42033" ><span class="underline">204</span></a>, <a +href="glossaries-manual.html#dx1-42040" ><span class="underline">205</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuper4colborder</span>  <a +href="glossaries-manual.html#dx1-42044" ><span class="underline">206</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuper4colheader</span>  <a +href="glossaries-manual.html#dx1-42046" ><span class="underline">207</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuper4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-42048" ><span class="underline">208</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuperragged4col</span>  <a +href="glossaries-manual.html#dx1-43030" ><span class="underline">209</span></a>, <a +href="glossaries-manual.html#dx1-43033" ><span class="underline">210</span></a>, <a +href="glossaries-manual.html#dx1-43035" ><span class="underline">211</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuperragged4colborder</span>  <a +href="glossaries-manual.html#dx1-43032" ><span class="underline">212</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuperragged4colheader</span>  <a +href="glossaries-manual.html#dx1-43034" ><span class="underline">213</span></a>, <a +href="glossaries-manual.html#dx1-43037" ><span class="underline">214</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">altsuperragged4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-43036" ><span class="underline">215</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">alttree</span>  <a +href="glossaries-manual.html#dx1-44016" ><span class="underline">216</span></a>, <a +href="glossaries-manual.html#dx1-44029" ><span class="underline">217</span></a>, <a +href="glossaries-manual.html#dx1-44033" ><span class="underline">218</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">alttreegroup</span>  <a +href="glossaries-manual.html#dx1-44032" ><span class="underline">219</span></a>, <a +href="glossaries-manual.html#dx1-44035" ><span class="underline">220</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">alttreehypergroup</span>  <a +href="glossaries-manual.html#dx1-44034" ><span class="underline">221</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">index</span>  <a +href="glossaries-manual.html#dx1-34070" ><span class="underline">222</span></a>, <a +href="glossaries-manual.html#dx1-34086" ><span class="underline">223</span></a>, <a +href="glossaries-manual.html#dx1-44004" ><span class="underline">224</span></a>, <a +href="glossaries-manual.html#dx1-44007" ><span class="underline">225</span></a>, <a +href="glossaries-manual.html#dx1-44012" ><span class="underline">226</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">indexgroup</span>  <a +href="glossaries-manual.html#dx1-44006" ><span class="underline">227</span></a>, <a +href="glossaries-manual.html#dx1-44009" ><span class="underline">228</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">indexhypergroup</span>  <a +href="glossaries-manual.html#dx1-44008" ><span class="underline">229</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">list</span>  <a +href="glossaries-manual.html#dx1-13050" ><span class="underline">230</span></a>, <a +href="glossaries-manual.html#dx1-39005" ><span class="underline">231</span></a>, <a +href="glossaries-manual.html#dx1-39009" ><span class="underline">232</span></a>, <a +href="glossaries-manual.html#dx1-39015" ><span class="underline">233</span></a>, <a +href="glossaries-manual.html#dx1-39016" ><span class="underline">234</span></a>, <a +href="glossaries-manual.html#dx1-39017" ><span class="underline">235</span></a>, <a +href="glossaries-manual.html#dx1-45005" ><span class="underline">236</span></a>, <a +href="glossaries-manual.html#dx1-45010" ><span class="underline">237</span></a>, <a +href="glossaries-manual.html#dx1-45023" ><span class="underline">238</span></a>, <a +href="glossaries-manual.html#dx1-45027" ><span class="underline">239</span></a>, <a +href="glossaries-manual.html#dx1-47002" ><span class="underline">240</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">listdotted</span>  <a +href="glossaries-manual.html#dx1-38030" ><span class="underline">241</span></a>, <a +href="glossaries-manual.html#dx1-39027" ><span class="underline">242</span></a>, <a +href="glossaries-manual.html#dx1-39028" ><span class="underline">243</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">listgroup</span>  <a +href="glossaries-manual.html#dx1-39008" ><span class="underline">244</span></a>, <a +href="glossaries-manual.html#dx1-39011" ><span class="underline">245</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">listhypergroup</span>  <a +href="glossaries-manual.html#dx1-39010" ><span class="underline">246</span></a>, <a +href="glossaries-manual.html#dx1-39022" ><span class="underline">247</span></a>, <a +href="glossaries-manual.html#dx1-44010" ><span class="underline">248</span></a>, <a +href="glossaries-manual.html#dx1-44021" ><span class="underline">249</span></a>, <a +href="glossaries-manual.html#dx1-44028" ><span class="underline">250</span></a>, <a +href="glossaries-manual.html#dx1-44036" ><span class="underline">251</span></a>, <a +href="glossaries-manual.html#dx1-45021" ><span class="underline">252</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long</span>  <a +href="glossaries-manual.html#dx1-38026" ><span class="underline">253</span></a>, <a +href="glossaries-manual.html#dx1-40005" ><span class="underline">254</span></a>, <a +href="glossaries-manual.html#dx1-40011" ><span class="underline">255</span></a>, <a +href="glossaries-manual.html#dx1-40013" ><span class="underline">256</span></a>, <a +href="glossaries-manual.html#dx1-40017" ><span class="underline">257</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long3col</span>  <a +href="glossaries-manual.html#dx1-38002" ><span class="underline">258</span></a>, <a +href="glossaries-manual.html#dx1-40016" ><span class="underline">259</span></a>, <a +href="glossaries-manual.html#dx1-40022" ><span class="underline">260</span></a>, <a +href="glossaries-manual.html#dx1-40024" ><span class="underline">261</span></a>, <a +href="glossaries-manual.html#dx1-40028" ><span class="underline">262</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long3colborder</span>  <a +href="glossaries-manual.html#dx1-38004" ><span class="underline">263</span></a>, <a +href="glossaries-manual.html#dx1-40021" ><span class="underline">264</span></a> <br /></span> + + + +<span class="index-subitem">    <span +class="ectt-1000">long3colheader</span>  <a +href="glossaries-manual.html#dx1-38003" ><span class="underline">265</span></a>, <a +href="glossaries-manual.html#dx1-40023" ><span class="underline">266</span></a>, <a +href="glossaries-manual.html#dx1-40026" ><span class="underline">267</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long3colheaderborder</span>  <a +href="glossaries-manual.html#dx1-38005" ><span class="underline">268</span></a>, <a +href="glossaries-manual.html#dx1-40025" ><span class="underline">269</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long4col</span>  <a +href="glossaries-manual.html#dx1-38017" ><span class="underline">270</span></a>, <a +href="glossaries-manual.html#dx1-40027" ><span class="underline">271</span></a>, <a +href="glossaries-manual.html#dx1-40031" ><span class="underline">272</span></a>, <a +href="glossaries-manual.html#dx1-40033" ><span class="underline">273</span></a>, <a +href="glossaries-manual.html#dx1-40037" ><span class="underline">274</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long4colborder</span>  <a +href="glossaries-manual.html#dx1-40030" ><span class="underline">275</span></a>, <a +href="glossaries-manual.html#dx1-40041" ><span class="underline">276</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long4colheader</span>  <a +href="glossaries-manual.html#dx1-40032" ><span class="underline">277</span></a>, <a +href="glossaries-manual.html#dx1-40035" ><span class="underline">278</span></a>, <a +href="glossaries-manual.html#dx1-40043" ><span class="underline">279</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">long4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-40034" ><span class="underline">280</span></a>, <a +href="glossaries-manual.html#dx1-40045" ><span class="underline">281</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longborder</span>  <a +href="glossaries-manual.html#dx1-40010" ><span class="underline">282</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longheader</span>  <a +href="glossaries-manual.html#dx1-40012" ><span class="underline">283</span></a>, <a +href="glossaries-manual.html#dx1-40015" ><span class="underline">284</span></a>, <a +href="glossaries-manual.html#dx1-45011" ><span class="underline">285</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longheaderborder</span>  <a +href="glossaries-manual.html#dx1-40014" ><span class="underline">286</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longragged</span>  <a +href="glossaries-manual.html#dx1-41008" ><span class="underline">287</span></a>, <a +href="glossaries-manual.html#dx1-41012" ><span class="underline">288</span></a>, <a +href="glossaries-manual.html#dx1-41014" ><span class="underline">289</span></a>, <a +href="glossaries-manual.html#dx1-41018" ><span class="underline">290</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longragged3col</span>  <a +href="glossaries-manual.html#dx1-41017" ><span class="underline">291</span></a>, <a +href="glossaries-manual.html#dx1-41023" ><span class="underline">292</span></a>, <a +href="glossaries-manual.html#dx1-41025" ><span class="underline">293</span></a>, <a +href="glossaries-manual.html#dx1-41029" ><span class="underline">294</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longragged3colborder</span>  <a +href="glossaries-manual.html#dx1-41022" ><span class="underline">295</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longragged3colheader</span>  <a +href="glossaries-manual.html#dx1-41024" ><span class="underline">296</span></a>, <a +href="glossaries-manual.html#dx1-41027" ><span class="underline">297</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longragged3colheaderborder</span>  <a +href="glossaries-manual.html#dx1-41026" ><span class="underline">298</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longraggedborder</span>  <a +href="glossaries-manual.html#dx1-41011" ><span class="underline">299</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longraggedheader</span>  <a +href="glossaries-manual.html#dx1-41013" ><span class="underline">300</span></a>, <a +href="glossaries-manual.html#dx1-41016" ><span class="underline">301</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">longraggedheaderborder</span>  <a +href="glossaries-manual.html#dx1-41015" ><span class="underline">302</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super</span>  <a +href="glossaries-manual.html#dx1-42009" ><span class="underline">303</span></a>, <a +href="glossaries-manual.html#dx1-42015" ><span class="underline">304</span></a>, <a +href="glossaries-manual.html#dx1-42017" ><span class="underline">305</span></a>, <a +href="glossaries-manual.html#dx1-42021" ><span class="underline">306</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super3col</span>  <a +href="glossaries-manual.html#dx1-42020" ><span class="underline">307</span></a>, <a +href="glossaries-manual.html#dx1-42026" ><span class="underline">308</span></a>, <a +href="glossaries-manual.html#dx1-42028" ><span class="underline">309</span></a>, <a +href="glossaries-manual.html#dx1-42032" ><span class="underline">310</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super3colborder</span>  <a +href="glossaries-manual.html#dx1-42025" ><span class="underline">311</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super3colheader</span>  <a +href="glossaries-manual.html#dx1-42027" ><span class="underline">312</span></a>, <a +href="glossaries-manual.html#dx1-42030" ><span class="underline">313</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super3colheaderborder</span>  <a +href="glossaries-manual.html#dx1-42029" ><span class="underline">314</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super4col</span>  <a +href="glossaries-manual.html#dx1-38018" ><span class="underline">315</span></a>, <a +href="glossaries-manual.html#dx1-42031" ><span class="underline">316</span></a>, <a +href="glossaries-manual.html#dx1-42035" ><span class="underline">317</span></a>, <a +href="glossaries-manual.html#dx1-42037" ><span class="underline">318</span></a>, <a +href="glossaries-manual.html#dx1-42041" ><span class="underline">319</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super4colborder</span>  <a +href="glossaries-manual.html#dx1-42034" ><span class="underline">320</span></a>, <a +href="glossaries-manual.html#dx1-42045" ><span class="underline">321</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super4colheader</span>  <a +href="glossaries-manual.html#dx1-42036" ><span class="underline">322</span></a>, <a +href="glossaries-manual.html#dx1-42039" ><span class="underline">323</span></a>, <a +href="glossaries-manual.html#dx1-42047" ><span class="underline">324</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">super4colheaderborder</span>  <a +href="glossaries-manual.html#dx1-42038" ><span class="underline">325</span></a>, <a +href="glossaries-manual.html#dx1-42049" ><span class="underline">326</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superborder</span>  <a +href="glossaries-manual.html#dx1-42014" ><span class="underline">327</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superheader</span>  <a +href="glossaries-manual.html#dx1-42016" ><span class="underline">328</span></a>, <a +href="glossaries-manual.html#dx1-42019" ><span class="underline">329</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superheaderborder</span>  <a +href="glossaries-manual.html#dx1-42018" ><span class="underline">330</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superragged</span>  <a +href="glossaries-manual.html#dx1-43008" ><span class="underline">331</span></a>, <a +href="glossaries-manual.html#dx1-43014" ><span class="underline">332</span></a>, <a +href="glossaries-manual.html#dx1-43016" ><span class="underline">333</span></a>, <a +href="glossaries-manual.html#dx1-43020" ><span class="underline">334</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superragged3col</span>  <a +href="glossaries-manual.html#dx1-43019" ><span class="underline">335</span></a>, <a +href="glossaries-manual.html#dx1-43025" ><span class="underline">336</span></a>, <a +href="glossaries-manual.html#dx1-43027" ><span class="underline">337</span></a>, <a +href="glossaries-manual.html#dx1-43031" ><span class="underline">338</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superragged3colborder</span>  <a +href="glossaries-manual.html#dx1-43024" ><span class="underline">339</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superragged3colheader</span>  <a +href="glossaries-manual.html#dx1-43026" ><span class="underline">340</span></a>, <a +href="glossaries-manual.html#dx1-43029" ><span class="underline">341</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superragged3colheaderborder</span>  <a +href="glossaries-manual.html#dx1-43028" ><span class="underline">342</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superraggedborder</span>  <a +href="glossaries-manual.html#dx1-43013" ><span class="underline">343</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superraggedheader</span>  <a +href="glossaries-manual.html#dx1-43015" ><span class="underline">344</span></a>, <a +href="glossaries-manual.html#dx1-43018" ><span class="underline">345</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">superraggedheaderborder</span>  <a +href="glossaries-manual.html#dx1-43017" ><span class="underline">346</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">tree</span>  <a +href="glossaries-manual.html#dx1-44011" ><span class="underline">347</span></a>, <a +href="glossaries-manual.html#dx1-44018" ><span class="underline">348</span></a>, <a +href="glossaries-manual.html#dx1-44023" ><span class="underline">349</span></a>, <a +href="glossaries-manual.html#dx1-44030" ><span class="underline">350</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">treegroup</span>  <a +href="glossaries-manual.html#dx1-44017" ><span class="underline">351</span></a>, <a +href="glossaries-manual.html#dx1-44020" ><span class="underline">352</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">treehypergroup</span>  <a +href="glossaries-manual.html#dx1-44019" ><span class="underline">353</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">treenoname</span>  <a +href="glossaries-manual.html#dx1-44022" ><span class="underline">354</span></a>, <a +href="glossaries-manual.html#dx1-44025" ><span class="underline">355</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">treenonamegroup</span>  <a +href="glossaries-manual.html#dx1-44024" ><span class="underline">356</span></a>, <a +href="glossaries-manual.html#dx1-44027" ><span class="underline">357</span></a> <br /></span> +<span class="index-subitem">    <span +class="ectt-1000">treenonamehypergroup</span>  <a +href="glossaries-manual.html#dx1-44026" ><span class="underline">358</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-hypernav </span>package  <a +href="glossaries-manual.html#dx1-45020" >359</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-list </span>package  <a +href="glossaries-manual.html#dx1-13049" >360</a>, <a +href="glossaries-manual.html#dx1-28002" >361</a>, <a +href="glossaries-manual.html#dx1-39001" >362</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-long </span>package  <a +href="glossaries-manual.html#dx1-13043" >363</a>, <a +href="glossaries-manual.html#dx1-28003" >364</a>, <a +href="glossaries-manual.html#dx1-40001" >365</a>, <a +href="glossaries-manual.html#dx1-41002" >366</a> <br /></span> + + + +<span class="index-item"><span +class="ecss-1000">glossary-longragged </span>package  <a +href="glossaries-manual.html#dx1-41001" >367</a>, <a +href="glossaries-manual.html#dx1-41004" >368</a>, <a +href="glossaries-manual.html#dx1-41006" >369</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-super </span>package  <a +href="glossaries-manual.html#dx1-13046" >370</a>, <a +href="glossaries-manual.html#dx1-28004" >371</a>, <a +href="glossaries-manual.html#dx1-42001" >372</a>, <a +href="glossaries-manual.html#dx1-43002" >373</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-superragged </span>package  <a +href="glossaries-manual.html#dx1-43001" >374</a>, <a +href="glossaries-manual.html#dx1-43004" >375</a>, <a +href="glossaries-manual.html#dx1-43006" >376</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">glossary-tree </span>package  <a +href="glossaries-manual.html#dx1-13053" >377</a>, <a +href="glossaries-manual.html#dx1-28005" >378</a>, <a +href="glossaries-manual.html#dx1-44001" >379</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossaryentryfield</span></span></span>  <a +href="glossaries-manual.html#dx1-45024" ><span +class="ecti-1000">380</span></a>, <a +href="glossaries-manual.html#dx1-45032" ><span class="underline">381</span></a>, <a +href="glossaries-manual.html#dx1-48001" ><span class="underline">382</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossaryentrynumbers</span></span></span>  <a +href="glossaries-manual.html#dx1-45028" ><span class="underline">383</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossaryheader</span></span></span>  <a +href="glossaries-manual.html#dx1-39013" ><span class="underline">384</span></a>, <a +href="glossaries-manual.html#dx1-45009" ><span +class="ecti-1000">385</span></a>, <a +href="glossaries-manual.html#dx1-46005" ><span class="underline">386</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossarymark</span></span></span>  <a +href="glossaries-manual.html#dx1-13027" ><span +class="ecti-1000">387</span></a>, <a +href="glossaries-manual.html#dx1-27022" ><span class="underline">388</span></a>, <a +href="glossaries-manual.html#dx1-27023" ><span class="underline">389</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossaryname</span></span></span>  <a +href="glossaries-manual.html#dx1-5014" ><span class="underline">390</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossarypostamble</span></span></span>  <a +href="glossaries-manual.html#dx1-27025" ><span +class="ecti-1000">391</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossarypreamble</span></span></span>  <a +href="glossaries-manual.html#dx1-27024" ><span +class="ecti-1000">392</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossarystyle</span></span></span>  <a +href="glossaries-manual.html#dx1-13056" ><span class="underline">393</span></a>, <a +href="glossaries-manual.html#dx1-27015" ><span class="underline">394</span></a>, <a +href="glossaries-manual.html#dx1-38009" ><span +class="ecti-1000">395</span></a>, <a +href="glossaries-manual.html#dx1-38025" ><span class="underline">396</span></a>, <a +href="glossaries-manual.html#dx1-38028" ><span class="underline">397</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glossarysubentryfield</span></span></span>  <a +href="glossaries-manual.html#dx1-45031" ><span +class="ecti-1000">398</span></a>, <a +href="glossaries-manual.html#dx1-48002" ><span class="underline">399</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLS</span></span></span>  <a +href="glossaries-manual.html#dx1-21059" ><span +class="ecti-1000">400</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Gls</span></span></span>  <a +href="glossaries-manual.html#dx1-4007" ><span class="underline">401</span></a>, <a +href="glossaries-manual.html#dx1-21058" ><span +class="ecti-1000">402</span></a>, <a +href="glossaries-manual.html#dx1-34184" ><span class="underline">403</span></a>, <a +href="glossaries-manual.html#dx1-36009" ><span class="underline">404</span></a>, <a +href="glossaries-manual.html#dx1-36011" ><span class="underline">405</span></a>, <a +href="glossaries-manual.html#dx1-36013" ><span class="underline">406</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\gls</span></span></span>  <a +href="glossaries-manual.html#dx1-14051" ><span class="underline">407</span></a>, <a +href="glossaries-manual.html#dx1-14054" ><span class="underline">408</span></a>, <a +href="glossaries-manual.html#dx1-21011" ><span class="underline">409</span></a>, <a +href="glossaries-manual.html#dx1-21049" ><span +class="ecti-1000">410</span></a>, <a +href="glossaries-manual.html#dx1-21076" ><span class="underline">411</span></a>, <a +href="glossaries-manual.html#dx1-22002" ><span class="underline">412</span></a>, <a +href="glossaries-manual.html#dx1-22022" ><span class="underline">413</span></a>, <a +href="glossaries-manual.html#dx1-22029" ><span class="underline">414</span></a>, <a +href="glossaries-manual.html#dx1-23004" ><span class="underline">415</span></a>, <a +href="glossaries-manual.html#dx1-23013" ><span class="underline">416</span></a>, <a +href="glossaries-manual.html#dx1-25003" ><span class="underline">417</span></a>, <a +href="glossaries-manual.html#dx1-34182" ><span class="underline">418</span></a>, <a +href="glossaries-manual.html#dx1-36008" ><span class="underline">419</span></a>, <a +href="glossaries-manual.html#dx1-36010" ><span class="underline">420</span></a>, <a +href="glossaries-manual.html#dx1-36012" ><span class="underline">421</span></a>, <a +href="glossaries-manual.html#dx1-36018" ><span class="underline">422</span></a>, <a +href="glossaries-manual.html#dx1-36020" ><span class="underline">423</span></a>, <a +href="glossaries-manual.html#dx1-37001" ><span class="underline">424</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsadd</span></span></span>  <a +href="glossaries-manual.html#dx1-24001" ><span +class="ecti-1000">425</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsaddall</span></span></span>  <a +href="glossaries-manual.html#dx1-3017" ><span class="underline">426</span></a>, <a +href="glossaries-manual.html#dx1-24004" ><span +class="ecti-1000">427</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">\glsaddall </span>options<br /></span> +<span class="index-subitem">    <span +class="ecss-1000">types</span>  <a +href="glossaries-manual.html#dx1-24005" >428</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsAddXdyAttribute</span></span></span>  <a +href="glossaries-manual.html#dx1-21026" ><span class="underline">429</span></a>, <a +href="glossaries-manual.html#dx1-31005" ><span +class="ecti-1000">430</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsAddXdyLocation</span></span></span>  <a +href="glossaries-manual.html#dx1-31022" ><span class="underline">431</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsautoprefix</span></span></span>  <a +href="glossaries-manual.html#dx1-13040" ><span +class="ecti-1000">432</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsclearpage</span></span></span>  <a +href="glossaries-manual.html#dx1-13028" ><span class="underline">433</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsclosebrace</span></span></span>  <a +href="glossaries-manual.html#dx1-29008" ><span +class="ecti-1000">434</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdefaulttype</span></span></span>  <a +href="glossaries-manual.html#dx1-13018" ><span class="underline">435</span></a>, <a +href="glossaries-manual.html#dx1-13020" ><span class="underline">436</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSdesc</span></span></span>  <a +href="glossaries-manual.html#dx1-21119" ><span +class="ecti-1000">437</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsdesc</span></span></span>  <a +href="glossaries-manual.html#dx1-21118" ><span +class="ecti-1000">438</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdesc</span></span></span>  <a +href="glossaries-manual.html#dx1-21113" ><span +class="ecti-1000">439</span></a>, <a +href="glossaries-manual.html#dx1-34143" ><span class="underline">440</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdescwidth</span></span></span>  <a +href="glossaries-manual.html#dx1-38011" ><span +class="ecti-1000">441</span></a>, <a +href="glossaries-manual.html#dx1-40009" ><span class="underline">442</span></a>, <a +href="glossaries-manual.html#dx1-40019" ><span class="underline">443</span></a>, <a +href="glossaries-manual.html#dx1-40038" ><span class="underline">444</span></a>, <a +href="glossaries-manual.html#dx1-41010" ><span class="underline">445</span></a>, <a +href="glossaries-manual.html#dx1-41020" ><span class="underline">446</span></a>, <a +href="glossaries-manual.html#dx1-41030" ><span class="underline">447</span></a>, <a +href="glossaries-manual.html#dx1-42013" ><span class="underline">448</span></a>, <a +href="glossaries-manual.html#dx1-42023" ><span class="underline">449</span></a>, <a +href="glossaries-manual.html#dx1-42042" ><span class="underline">450</span></a>, <a +href="glossaries-manual.html#dx1-43012" ><span class="underline">451</span></a>, <a +href="glossaries-manual.html#dx1-43022" ><span class="underline">452</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdisablehyper</span></span></span>  <a +href="glossaries-manual.html#dx1-23006" ><span +class="ecti-1000">453</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdisp</span></span></span>  <a +href="glossaries-manual.html#dx1-21018" ><span class="underline">454</span></a>, <a +href="glossaries-manual.html#dx1-21069" ><span +class="ecti-1000">455</span></a>, <a +href="glossaries-manual.html#dx1-22017" ><span class="underline">456</span></a>, <a +href="glossaries-manual.html#dx1-22024" ><span class="underline">457</span></a>, <a +href="glossaries-manual.html#dx1-23015" ><span class="underline">458</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdisplay</span></span></span>  <a +href="glossaries-manual.html#dx1-14044" ><span class="underline">459</span></a>, <a +href="glossaries-manual.html#dx1-14076" ><span class="underline">460</span></a>, <a +href="glossaries-manual.html#dx1-21067" ><span class="underline">461</span></a>, <a +href="glossaries-manual.html#dx1-21073" ><span class="underline">462</span></a>, <a +href="glossaries-manual.html#dx1-21079" ><span class="underline">463</span></a>, <a +href="glossaries-manual.html#dx1-22006" ><span +class="ecti-1000">464</span></a>, <a +href="glossaries-manual.html#dx1-35041" ><span class="underline">465</span></a>, <a +href="glossaries-manual.html#dx1-35050" ><span class="underline">466</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsdisplayfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-14045" ><span class="underline">467</span></a>, <a +href="glossaries-manual.html#dx1-14077" ><span class="underline">468</span></a>, <a +href="glossaries-manual.html#dx1-21068" ><span class="underline">469</span></a>, <a +href="glossaries-manual.html#dx1-21074" ><span class="underline">470</span></a>, <a +href="glossaries-manual.html#dx1-21080" ><span class="underline">471</span></a>, <a +href="glossaries-manual.html#dx1-22004" ><span +class="ecti-1000">472</span></a>, <a +href="glossaries-manual.html#dx1-35040" ><span class="underline">473</span></a>, <a +href="glossaries-manual.html#dx1-35049" ><span class="underline">474</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsenablehyper</span></span></span>  <a +href="glossaries-manual.html#dx1-23007" ><span +class="ecti-1000">475</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrydesc</span></span></span>  <a +href="glossaries-manual.html#dx1-26021" ><span +class="ecti-1000">476</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrydesc</span></span></span>  <a +href="glossaries-manual.html#dx1-26020" ><span +class="ecti-1000">477</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrydescplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26023" ><span +class="ecti-1000">478</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrydescplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26022" ><span +class="ecti-1000">479</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-26013" ><span +class="ecti-1000">480</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-26012" ><span +class="ecti-1000">481</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryfirstplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26017" ><span +class="ecti-1000">482</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryfirstplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26016" ><span +class="ecti-1000">483</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryname</span></span></span>  <a +href="glossaries-manual.html#dx1-26004" ><span +class="ecti-1000">484</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryname</span></span></span>  <a +href="glossaries-manual.html#dx1-26003" ><span +class="ecti-1000">485</span></a>, <a +href="glossaries-manual.html#dx1-26041" ><span class="underline">486</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26010" ><span +class="ecti-1000">487</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26009" ><span +class="ecti-1000">488</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrysymbol</span></span></span>  <a +href="glossaries-manual.html#dx1-26025" ><span +class="ecti-1000">489</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrysymbol</span></span></span>  <a +href="glossaries-manual.html#dx1-26024" ><span +class="ecti-1000">490</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrysymbolplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26027" ><span +class="ecti-1000">491</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrysymbolplural</span></span></span>  <a +href="glossaries-manual.html#dx1-26026" ><span +class="ecti-1000">492</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentrytext</span></span></span>  <a +href="glossaries-manual.html#dx1-26007" ><span +class="ecti-1000">493</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentrytext</span></span></span>  <a +href="glossaries-manual.html#dx1-26006" ><span +class="ecti-1000">494</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuseri</span></span></span>  <a +href="glossaries-manual.html#dx1-26029" ><span +class="ecti-1000">495</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuseri</span></span></span>  <a +href="glossaries-manual.html#dx1-26028" ><span +class="ecti-1000">496</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuserii</span></span></span>  <a +href="glossaries-manual.html#dx1-26031" ><span +class="ecti-1000">497</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuserii</span></span></span>  <a +href="glossaries-manual.html#dx1-26030" ><span +class="ecti-1000">498</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuseriii</span></span></span>  <a +href="glossaries-manual.html#dx1-26033" ><span +class="ecti-1000">499</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuseriii</span></span></span>  <a +href="glossaries-manual.html#dx1-26032" ><span +class="ecti-1000">500</span></a>, <a +href="glossaries-manual.html#dx1-35036" ><span class="underline">501</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuseriv</span></span></span>  <a +href="glossaries-manual.html#dx1-26035" ><span +class="ecti-1000">502</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuseriv</span></span></span>  <a +href="glossaries-manual.html#dx1-26034" ><span +class="ecti-1000">503</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuserv</span></span></span>  <a +href="glossaries-manual.html#dx1-26037" ><span +class="ecti-1000">504</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuserv</span></span></span>  <a +href="glossaries-manual.html#dx1-26036" ><span +class="ecti-1000">505</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsentryuservi</span></span></span>  <a +href="glossaries-manual.html#dx1-26039" ><span +class="ecti-1000">506</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsentryuservi</span></span></span>  <a +href="glossaries-manual.html#dx1-26038" ><span +class="ecti-1000">507</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-21088" ><span +class="ecti-1000">508</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-21087" ><span +class="ecti-1000">509</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsfirst</span></span></span>  <a +href="glossaries-manual.html#dx1-21083" ><span +class="ecti-1000">510</span></a>, <a +href="glossaries-manual.html#dx1-34145" ><span class="underline">511</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSfirstplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21098" ><span +class="ecti-1000">512</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsfirstplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21097" ><span +class="ecti-1000">513</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsfirstplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21094" ><span +class="ecti-1000">514</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsgetgrouptitle</span></span></span>  <a +href="glossaries-manual.html#dx1-45018" ><span +class="ecti-1000">515</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsgroupheading</span></span></span>  <a +href="glossaries-manual.html#dx1-45012" ><span +class="ecti-1000">516</span></a>, <a +href="glossaries-manual.html#dx1-46003" ><span class="underline">517</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsgroupskip</span></span></span>  <a +href="glossaries-manual.html#dx1-3013" ><span class="underline">518</span></a>, <a +href="glossaries-manual.html#dx1-38024" ><span class="underline">519</span></a>, <a +href="glossaries-manual.html#dx1-45022" ><span +class="ecti-1000">520</span></a>, <a +href="glossaries-manual.html#dx1-46004" ><span class="underline">521</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glshyperlink</span></span></span>  <a +href="glossaries-manual.html#dx1-26002" ><span class="underline">522</span></a>, <a +href="glossaries-manual.html#dx1-26040" ><span +class="ecti-1000">523</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glshypernavsep</span></span></span>  <a +href="glossaries-manual.html#dx1-39012" ><span +class="ecti-1000">524</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslabel</span></span></span>  <a +href="glossaries-manual.html#dx1-22015" ><span +class="ecti-1000">525</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslabeltok</span></span></span>  <a +href="glossaries-manual.html#dx1-35006" ><span class="underline">526</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslink</span></span></span>  <a +href="glossaries-manual.html#dx1-21016" ><span +class="ecti-1000">527</span></a>, <a +href="glossaries-manual.html#dx1-21060" ><span class="underline">528</span></a>, <a +href="glossaries-manual.html#dx1-22016" ><span class="underline">529</span></a>, <a +href="glossaries-manual.html#dx1-23003" ><span class="underline">530</span></a>, <a +href="glossaries-manual.html#dx1-23016" ><span class="underline">531</span></a>, <a +href="glossaries-manual.html#dx1-24002" ><span class="underline">532</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">\glslink </span>options<br /></span> +<span class="index-subitem">    <span +class="ecss-1000">counter</span>  <a +href="glossaries-manual.html#dx1-21046" >533</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">format</span>  <a +href="glossaries-manual.html#dx1-21019" >534</a>, <a +href="glossaries-manual.html#dx1-21025" >535</a>, <a +href="glossaries-manual.html#dx1-31001" >536</a>, <a +href="glossaries-manual.html#dx1-31006" >537</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">hyper</span>  <a +href="glossaries-manual.html#dx1-21047" >538</a>, <a +href="glossaries-manual.html#dx1-23005" >539</a>, <a +href="glossaries-manual.html#dx1-24003" >540</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslink*</span></span></span>  <a +href="glossaries-manual.html#dx1-21048" ><span +class="ecti-1000">541</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslistdottedwidth</span></span></span>  <a +href="glossaries-manual.html#dx1-39026" ><span +class="ecti-1000">542</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslocalreset</span></span></span>  <a +href="glossaries-manual.html#dx1-37007" ><span +class="ecti-1000">543</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslocalresetall</span></span></span>  <a +href="glossaries-manual.html#dx1-37011" ><span +class="ecti-1000">544</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslocalunset</span></span></span>  <a +href="glossaries-manual.html#dx1-37009" ><span +class="ecti-1000">545</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslocalunsetall</span></span></span>  <a +href="glossaries-manual.html#dx1-37013" ><span +class="ecti-1000">546</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslongkey</span></span></span>  <a +href="glossaries-manual.html#dx1-34056" ><span +class="ecti-1000">547</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslongpluralkey</span></span></span>  <a +href="glossaries-manual.html#dx1-34057" ><span +class="ecti-1000">548</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glslongtok</span></span></span>  <a +href="glossaries-manual.html#dx1-35004" ><span class="underline">549</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSname</span></span></span>  <a +href="glossaries-manual.html#dx1-21105" ><span +class="ecti-1000">550</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsname</span></span></span>  <a +href="glossaries-manual.html#dx1-21104" ><span +class="ecti-1000">551</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsname</span></span></span>  <a +href="glossaries-manual.html#dx1-21099" ><span +class="ecti-1000">552</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsnamefont</span></span></span>  <a +href="glossaries-manual.html#dx1-28001" ><span +class="ecti-1000">553</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsnavhypertarget</span></span></span>  <a +href="glossaries-manual.html#dx1-45019" ><span +class="ecti-1000">554</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsnumbersgroupname</span></span></span>  <a +href="glossaries-manual.html#dx1-5022" ><span class="underline">555</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsopenbrace</span></span></span>  <a +href="glossaries-manual.html#dx1-29007" ><span +class="ecti-1000">556</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspagelistwidth</span></span></span>  <a +href="glossaries-manual.html#dx1-38012" ><span +class="ecti-1000">557</span></a>, <a +href="glossaries-manual.html#dx1-40020" ><span class="underline">558</span></a>, <a +href="glossaries-manual.html#dx1-40039" ><span class="underline">559</span></a>, <a +href="glossaries-manual.html#dx1-41021" ><span class="underline">560</span></a>, <a +href="glossaries-manual.html#dx1-41031" ><span class="underline">561</span></a>, <a +href="glossaries-manual.html#dx1-42024" ><span class="underline">562</span></a>, <a +href="glossaries-manual.html#dx1-42043" ><span class="underline">563</span></a>, <a +href="glossaries-manual.html#dx1-43023" ><span class="underline">564</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspar</span></span></span>  <a +href="glossaries-manual.html#dx1-14040" ><span +class="ecti-1000">565</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSpl</span></span></span>  <a +href="glossaries-manual.html#dx1-14048" ><span class="underline">566</span></a>, <a +href="glossaries-manual.html#dx1-14080" ><span class="underline">567</span></a>, <a +href="glossaries-manual.html#dx1-21063" ><span +class="ecti-1000">568</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glspl</span></span></span>  <a +href="glossaries-manual.html#dx1-14047" ><span class="underline">569</span></a>, <a +href="glossaries-manual.html#dx1-14079" ><span class="underline">570</span></a>, <a +href="glossaries-manual.html#dx1-21062" ><span +class="ecti-1000">571</span></a>, <a +href="glossaries-manual.html#dx1-34188" ><span class="underline">572</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspl</span></span></span>  <a +href="glossaries-manual.html#dx1-14046" ><span class="underline">573</span></a>, <a +href="glossaries-manual.html#dx1-14058" ><span class="underline">574</span></a>, <a +href="glossaries-manual.html#dx1-14062" ><span class="underline">575</span></a>, <a +href="glossaries-manual.html#dx1-14078" ><span class="underline">576</span></a>, <a +href="glossaries-manual.html#dx1-21012" ><span class="underline">577</span></a>, <a +href="glossaries-manual.html#dx1-21061" ><span +class="ecti-1000">578</span></a>, <a +href="glossaries-manual.html#dx1-22003" ><span class="underline">579</span></a>, <a +href="glossaries-manual.html#dx1-22023" ><span class="underline">580</span></a>, <a +href="glossaries-manual.html#dx1-23014" ><span class="underline">581</span></a>, <a +href="glossaries-manual.html#dx1-34186" ><span class="underline">582</span></a>, <a +href="glossaries-manual.html#dx1-37002" ><span class="underline">583</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21093" ><span +class="ecti-1000">584</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21092" ><span +class="ecti-1000">585</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsplural</span></span></span>  <a +href="glossaries-manual.html#dx1-21089" ><span +class="ecti-1000">586</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspluralsuffix</span></span></span>  <a +href="glossaries-manual.html#dx1-14059" ><span class="underline">587</span></a>, <a +href="glossaries-manual.html#dx1-14066" ><span class="underline">588</span></a>, <a +href="glossaries-manual.html#dx1-15001" ><span +class="ecti-1000">589</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glspostdescription</span></span></span>  <a +href="glossaries-manual.html#dx1-38031" ><span +class="ecti-1000">590</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsquote</span></span></span>  <a +href="glossaries-manual.html#dx1-29010" ><span +class="ecti-1000">591</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsreset</span></span></span>  <a +href="glossaries-manual.html#dx1-37006" ><span +class="ecti-1000">592</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsresetall</span></span></span>  <a +href="glossaries-manual.html#dx1-37010" ><span +class="ecti-1000">593</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glssee</span></span></span>  <a +href="glossaries-manual.html#dx1-21029" ><span class="underline">594</span></a>, <a +href="glossaries-manual.html#dx1-25012" ><span +class="ecti-1000">595</span></a>, <a +href="glossaries-manual.html#dx1-2003" ><span class="underline">596</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsSetAlphaCompositor</span></span></span>  <a +href="glossaries-manual.html#dx1-14028" ><span +class="ecti-1000">597</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsSetCompositor</span></span></span>  <a +href="glossaries-manual.html#dx1-14026" ><span +class="ecti-1000">598</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsSetSuffixF</span></span></span>  <a +href="glossaries-manual.html#dx1-20013" ><span +class="ecti-1000">599</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsSetSuffixFF</span></span></span>  <a +href="glossaries-manual.html#dx1-20014" ><span +class="ecti-1000">600</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glssetwidest</span></span></span>  <a +href="glossaries-manual.html#dx1-44031" ><span +class="ecti-1000">601</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsSetXdyCodePage</span></span></span>  <a +href="glossaries-manual.html#dx1-6037" ><span class="underline">602</span></a>, <a +href="glossaries-manual.html#dx1-30009" ><span +class="ecti-1000">603</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsSetXdyLanguage</span></span></span>  <a +href="glossaries-manual.html#dx1-6036" ><span class="underline">604</span></a>, <a +href="glossaries-manual.html#dx1-30006" ><span +class="ecti-1000">605</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsSetXdyLocationClassOrder</span></span></span>  <a +href="glossaries-manual.html#dx1-31023" ><span +class="ecti-1000">606</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GlsSetXdyMinRangeLength</span></span></span>  <a +href="glossaries-manual.html#dx1-20008" ><span class="underline">607</span></a>, <a +href="glossaries-manual.html#dx1-31028" ><span +class="ecti-1000">608</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsshortkey</span></span></span>  <a +href="glossaries-manual.html#dx1-34054" ><span +class="ecti-1000">609</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsshortpluralkey</span></span></span>  <a +href="glossaries-manual.html#dx1-34055" ><span +class="ecti-1000">610</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsshorttok</span></span></span>  <a +href="glossaries-manual.html#dx1-35005" ><span class="underline">611</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSsymbol</span></span></span>  <a +href="glossaries-manual.html#dx1-21112" ><span +class="ecti-1000">612</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glssymbol</span></span></span>  <a +href="glossaries-manual.html#dx1-21111" ><span +class="ecti-1000">613</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glssymbol</span></span></span>  <a +href="glossaries-manual.html#dx1-21106" ><span +class="ecti-1000">614</span></a>, <a +href="glossaries-manual.html#dx1-34144" ><span class="underline">615</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glssymbolsgroupname</span></span></span>  <a +href="glossaries-manual.html#dx1-5021" ><span class="underline">616</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstarget</span></span></span>  <a +href="glossaries-manual.html#dx1-45025" ><span +class="ecti-1000">617</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLStext</span></span></span>  <a +href="glossaries-manual.html#dx1-21082" ><span +class="ecti-1000">618</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glstext</span></span></span>  <a +href="glossaries-manual.html#dx1-21081" ><span +class="ecti-1000">619</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstext</span></span></span>  <a +href="glossaries-manual.html#dx1-21075" ><span +class="ecti-1000">620</span></a>, <a +href="glossaries-manual.html#dx1-21084" ><span class="underline">621</span></a>, <a +href="glossaries-manual.html#dx1-21090" ><span class="underline">622</span></a>, <a +href="glossaries-manual.html#dx1-21095" ><span class="underline">623</span></a>, <a +href="glossaries-manual.html#dx1-21100" ><span class="underline">624</span></a>, <a +href="glossaries-manual.html#dx1-21107" ><span class="underline">625</span></a>, <a +href="glossaries-manual.html#dx1-21114" ><span class="underline">626</span></a>, <a +href="glossaries-manual.html#dx1-21121" ><span class="underline">627</span></a>, <a +href="glossaries-manual.html#dx1-34134" ><span class="underline">628</span></a>, <a +href="glossaries-manual.html#dx1-34138" ><span class="underline">629</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstextformat</span></span></span>  <a +href="glossaries-manual.html#dx1-21008" ><span +class="ecti-1000">630</span></a>, <a +href="glossaries-manual.html#dx1-22021" ><span class="underline">631</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstocfalse</span></span></span>  <a +href="glossaries-manual.html#dx1-13007" ><span +class="ecti-1000">632</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstoctrue</span></span></span>  <a +href="glossaries-manual.html#dx1-13006" ><span +class="ecti-1000">633</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glstreeindent</span></span></span>  <a +href="glossaries-manual.html#dx1-44015" ><span +class="ecti-1000">634</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsunset</span></span></span>  <a +href="glossaries-manual.html#dx1-37008" ><span +class="ecti-1000">635</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsunsetall</span></span></span>  <a +href="glossaries-manual.html#dx1-37012" ><span +class="ecti-1000">636</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuseri</span></span></span>  <a +href="glossaries-manual.html#dx1-21124" ><span +class="ecti-1000">637</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuseri</span></span></span>  <a +href="glossaries-manual.html#dx1-21123" ><span +class="ecti-1000">638</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuseri</span></span></span>  <a +href="glossaries-manual.html#dx1-21120" ><span +class="ecti-1000">639</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuserii</span></span></span>  <a +href="glossaries-manual.html#dx1-21127" ><span +class="ecti-1000">640</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuserii</span></span></span>  <a +href="glossaries-manual.html#dx1-21126" ><span +class="ecti-1000">641</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuserii</span></span></span>  <a +href="glossaries-manual.html#dx1-21125" ><span +class="ecti-1000">642</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuseriii</span></span></span>  <a +href="glossaries-manual.html#dx1-21130" ><span +class="ecti-1000">643</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuseriii</span></span></span>  <a +href="glossaries-manual.html#dx1-21129" ><span +class="ecti-1000">644</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuseriii</span></span></span>  <a +href="glossaries-manual.html#dx1-21128" ><span +class="ecti-1000">645</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuseriv</span></span></span>  <a +href="glossaries-manual.html#dx1-21133" ><span +class="ecti-1000">646</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuseriv</span></span></span>  <a +href="glossaries-manual.html#dx1-21132" ><span +class="ecti-1000">647</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuseriv</span></span></span>  <a +href="glossaries-manual.html#dx1-21131" ><span +class="ecti-1000">648</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuserv</span></span></span>  <a +href="glossaries-manual.html#dx1-21136" ><span +class="ecti-1000">649</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuserv</span></span></span>  <a +href="glossaries-manual.html#dx1-21135" ><span +class="ecti-1000">650</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuserv</span></span></span>  <a +href="glossaries-manual.html#dx1-21134" ><span +class="ecti-1000">651</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\GLSuservi</span></span></span>  <a +href="glossaries-manual.html#dx1-21139" ><span +class="ecti-1000">652</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\Glsuservi</span></span></span>  <a +href="glossaries-manual.html#dx1-21138" ><span +class="ecti-1000">653</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\glsuservi</span></span></span>  <a +href="glossaries-manual.html#dx1-21137" ><span +class="ecti-1000">654</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">H</span> +<span class="index-item"><span +class="ecss-1000">html </span>package  <a +href="glossaries-manual.html#dx1-23002" >655</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperbf</span></span></span>  <a +href="glossaries-manual.html#dx1-21036" ><span class="underline">656</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperemph</span></span></span>  <a +href="glossaries-manual.html#dx1-21042" ><span class="underline">657</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperit</span></span></span>  <a +href="glossaries-manual.html#dx1-21038" ><span class="underline">658</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperlink</span></span></span>  <a +href="glossaries-manual.html#dx1-21043" ><span class="underline">659</span></a>, <a +href="glossaries-manual.html#dx1-23008" ><span class="underline">660</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypermd</span></span></span>  <a +href="glossaries-manual.html#dx1-21037" ><span class="underline">661</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperpage</span></span></span>  <a +href="glossaries-manual.html#dx1-21030" ><span class="underline">662</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">hyperref </span>package  <a +href="glossaries-manual.html#dx1-20016" >663</a>, <a +href="glossaries-manual.html#dx1-21006" >664</a>, <a +href="glossaries-manual.html#dx1-21031" >665</a>, <a +href="glossaries-manual.html#dx1-23001" >666</a>, <a +href="glossaries-manual.html#dx1-23010" >667</a>, <a +href="glossaries-manual.html#dx1-35053" >668</a>, <a +href="glossaries-manual.html#dx1-45026" >669</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperrm</span></span></span>  <a +href="glossaries-manual.html#dx1-21033" ><span class="underline">670</span></a>, <a +href="glossaries-manual.html#dx1-31003" ><span class="underline">671</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypersc</span></span></span>  <a +href="glossaries-manual.html#dx1-21041" ><span class="underline">672</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypersf</span></span></span>  <a +href="glossaries-manual.html#dx1-21034" ><span class="underline">673</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypersl</span></span></span>  <a +href="glossaries-manual.html#dx1-21039" ><span class="underline">674</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypertarget</span></span></span>  <a +href="glossaries-manual.html#dx1-23009" ><span class="underline">675</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hypertt</span></span></span>  <a +href="glossaries-manual.html#dx1-21035" ><span class="underline">676</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\hyperup</span></span></span>  <a +href="glossaries-manual.html#dx1-21040" ><span class="underline">677</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">I</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\ifglsused</span></span></span>  <a +href="glossaries-manual.html#dx1-37014" ><span +class="ecti-1000">678</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\indexspace</span></span></span>  <a +href="glossaries-manual.html#dx1-44005" ><span class="underline">679</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">inputenc </span>package  <a +href="glossaries-manual.html#dx1-3038" >680</a>, <a +href="glossaries-manual.html#dx1-4008" >681</a>, <a +href="glossaries-manual.html#dx1-14095" >682</a>, <a +href="glossaries-manual.html#dx1-30007" >683</a>, <a +href="glossaries-manual.html#dx1-50004" >684</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\inputencodingname</span></span></span>  <a +href="glossaries-manual.html#dx1-30008" ><span class="underline">685</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">itemize </span>environment  <a +href="glossaries-manual.html#dx1-46001" >686</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">J</span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\jobname</span></span></span>  <a +href="glossaries-manual.html#dx1-14017" ><span class="underline">687</span></a>, <a +href="glossaries-manual.html#dx1-14020" ><span class="underline">688</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">L</span> +<span class="index-item">link text  <a +href="glossaries-manual.html#dx1-21002" ><span class="underline">689</span></a>, <a +href="glossaries-manual.html#dx1-21007" ><span class="underline">690</span></a>, <a +href="glossaries-manual.html#dx1-21009" ><span class="underline">691</span></a>, <a +href="glossaries-manual.html#dx1-21050" ><span class="underline">692</span></a>, <a +href="glossaries-manual.html#dx1-22001" ><span class="underline">693</span></a>, <a +href="glossaries-manual.html#dx1-22020" ><span class="underline">694</span></a>, <a +href="glossaries-manual.html#dx1-22031" ><span class="underline">695</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\loadglsentries</span></span></span>  <a +href="glossaries-manual.html#dx1-19001" ><span +class="ecti-1000">696</span></a> <br /></span> +<span class="index-item">location list  <span +class="ecti-1000">see </span><a +href="glossaries-manual.html#dx1-20004" >number list</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">longtable </span>environment  <a +href="glossaries-manual.html#dx1-40002" >698</a>, <a +href="glossaries-manual.html#dx1-40006" >699</a>, <a +href="glossaries-manual.html#dx1-41003" >700</a>, <a +href="glossaries-manual.html#dx1-42005" >701</a>, <a +href="glossaries-manual.html#dx1-48006" >702</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">longtable </span>package  <a +href="glossaries-manual.html#dx1-13044" >703</a>, <a +href="glossaries-manual.html#dx1-40007" >704</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">M</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makefirstuc</span></span></span>  <a +href="glossaries-manual.html#dx1-50002" ><span +class="ecti-1000">705</span></a>, <a +href="glossaries-manual.html#dx1-34122" ><span class="underline">706</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">makeglossaries</span>  <a +href="glossaries-manual.html#dx1-2006" >707</a>, <a +href="glossaries-manual.html#dx1-2009" >708</a>, <a +href="glossaries-manual.html#dx1-3006" >709</a>, <a +href="glossaries-manual.html#dx1-3012" >710</a>, <a +href="glossaries-manual.html#dx1-3019" >711</a>, <a +href="glossaries-manual.html#dx1-3027" >712</a>, <a +href="glossaries-manual.html#dx1-3034" >713</a>, <a +href="glossaries-manual.html#dx1-3039" >714</a>, <a +href="glossaries-manual.html#dx1-3041" >715</a>, <a +href="glossaries-manual.html#dx1-3042" >716</a>, <a +href="glossaries-manual.html#dx1-3045" >717</a>, <a +href="glossaries-manual.html#dx1-3050" >718</a>, <a +href="glossaries-manual.html#dx1-3052" >719</a>, <a +href="glossaries-manual.html#dx1-4009" >720</a>, <a +href="glossaries-manual.html#dx1-4011" >721</a>, <a +href="glossaries-manual.html#dx1-6008" >722</a>, <a +href="glossaries-manual.html#dx1-6012" >723</a>, <a +href="glossaries-manual.html#dx1-6016" >724</a>, <a +href="glossaries-manual.html#dx1-6017" >725</a>, <a +href="glossaries-manual.html#dx1-6020" >726</a>, <a +href="glossaries-manual.html#dx1-6023" >727</a>, <a +href="glossaries-manual.html#dx1-6025" >728</a>, <a +href="glossaries-manual.html#dx1-7001" >729</a>, <a +href="glossaries-manual.html#dx1-7005" >730</a>, <a +href="glossaries-manual.html#dx1-7006" >731</a>, <a +href="glossaries-manual.html#dx1-7007" >732</a>, <a +href="glossaries-manual.html#dx1-7008" >733</a>, <a +href="glossaries-manual.html#dx1-8004" >734</a>, <a +href="glossaries-manual.html#dx1-8018" >735</a>, <a +href="glossaries-manual.html#dx1-8020" >736</a>, <a +href="glossaries-manual.html#dx1-8022" >737</a>, <a +href="glossaries-manual.html#dx1-9017" >738</a>, <a +href="glossaries-manual.html#dx1-9019" >739</a>, <a +href="glossaries-manual.html#dx1-9021" >740</a>, <a +href="glossaries-manual.html#dx1-11021" >741</a>, <a +href="glossaries-manual.html#dx1-11022" >742</a>, <a +href="glossaries-manual.html#dx1-11040" >743</a>, <a +href="glossaries-manual.html#dx1-11041" >744</a>, <a +href="glossaries-manual.html#dx1-13096" >745</a>, <a +href="glossaries-manual.html#dx1-13098" >746</a>, <a +href="glossaries-manual.html#dx1-13104" >747</a>, <a +href="glossaries-manual.html#dx1-13106" >748</a>, <a +href="glossaries-manual.html#dx1-13115" >749</a>, <a +href="glossaries-manual.html#dx1-14006" >750</a>, <a +href="glossaries-manual.html#dx1-25004" >751</a>, <a +href="glossaries-manual.html#dx1-27002" >752</a>, <a +href="glossaries-manual.html#dx1-30003" >753</a>, <a +href="glossaries-manual.html#dx1-30012" >754</a>, <a +href="glossaries-manual.html#dx1-30014" >755</a>, <a +href="glossaries-manual.html#dx1-33005" >756</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\makeglossaries</span></span></span>  <a +href="glossaries-manual.html#dx1-6011" ><span class="underline">757</span></a>, <a +href="glossaries-manual.html#dx1-11037" ><span class="underline">758</span></a>, <a +href="glossaries-manual.html#dx1-14009" ><span +class="ecti-1000">759</span></a>, <a +href="glossaries-manual.html#dx1-20009" ><span class="underline">760</span></a>, <a +href="glossaries-manual.html#dx1-20018" ><span class="underline">761</span></a>, <a +href="glossaries-manual.html#dx1-27007" ><span class="underline">762</span></a>, <a +href="glossaries-manual.html#dx1-31009" ><span class="underline">763</span></a>, <a +href="glossaries-manual.html#dx1-31010" ><span class="underline">764</span></a>, <a +href="glossaries-manual.html#dx1-31015" ><span class="underline">765</span></a>, <a +href="glossaries-manual.html#dx1-31016" ><span class="underline">766</span></a>, <a +href="glossaries-manual.html#dx1-31025" ><span class="underline">767</span></a>, <a +href="glossaries-manual.html#dx1-31026" ><span class="underline">768</span></a>, <a +href="glossaries-manual.html#dx1-31031" ><span class="underline">769</span></a>, <a +href="glossaries-manual.html#dx1-31032" ><span class="underline">770</span></a>, <a +href="glossaries-manual.html#dx1-32003" ><span class="underline">771</span></a>, <a +href="glossaries-manual.html#dx1-32004" ><span class="underline">772</span></a>, <a +href="glossaries-manual.html#dx1-33012" ><span class="underline">773</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">makeindex</span>  <a +href="glossaries-manual.html#dx1-2007" >774</a>, <a +href="glossaries-manual.html#dx1-2010" >775</a>, <a +href="glossaries-manual.html#dx1-3007" >776</a>, <a +href="glossaries-manual.html#dx1-3008" >777</a>, <a +href="glossaries-manual.html#dx1-3011" >778</a>, <a +href="glossaries-manual.html#dx1-3018" >779</a>, <a +href="glossaries-manual.html#dx1-3026" >780</a>, <a +href="glossaries-manual.html#dx1-3035" >781</a>, <a +href="glossaries-manual.html#dx1-3037" >782</a>, <a +href="glossaries-manual.html#dx1-3047" >783</a>, <a +href="glossaries-manual.html#dx1-3053" >784</a>, <a +href="glossaries-manual.html#dx1-4002" >785</a>, <a +href="glossaries-manual.html#dx1-4004" >786</a>, <a +href="glossaries-manual.html#dx1-5036" >787</a>, <a +href="glossaries-manual.html#dx1-6001" >788</a>, <a +href="glossaries-manual.html#dx1-6003" >789</a>, <a +href="glossaries-manual.html#dx1-6005" >790</a>, <a +href="glossaries-manual.html#dx1-6009" >791</a>, <a +href="glossaries-manual.html#dx1-6015" >792</a>, <a +href="glossaries-manual.html#dx1-6018" >793</a>, <a +href="glossaries-manual.html#dx1-6021" >794</a>, <a +href="glossaries-manual.html#dx1-6027" >795</a>, <a +href="glossaries-manual.html#dx1-6031" >796</a>, <a +href="glossaries-manual.html#dx1-7004" >797</a>, <a +href="glossaries-manual.html#dx1-9001" >798</a>, <a +href="glossaries-manual.html#dx1-9003" >799</a>, <a +href="glossaries-manual.html#dx1-9006" >800</a>, <a +href="glossaries-manual.html#dx1-9009" >801</a>, <a +href="glossaries-manual.html#dx1-9011" >802</a>, <a +href="glossaries-manual.html#dx1-9018" >803</a>, <a +href="glossaries-manual.html#dx1-9020" >804</a>, <a +href="glossaries-manual.html#dx1-10002" >805</a>, <a +href="glossaries-manual.html#dx1-10005" >806</a>, <a +href="glossaries-manual.html#dx1-10013" >807</a>, <a +href="glossaries-manual.html#dx1-11024" >808</a>, <a +href="glossaries-manual.html#dx1-11048" >809</a>, <a +href="glossaries-manual.html#dx1-13095" >810</a>, <a +href="glossaries-manual.html#dx1-13097" >811</a>, <a +href="glossaries-manual.html#dx1-13099" >812</a>, <a +href="glossaries-manual.html#dx1-13108" >813</a>, <a +href="glossaries-manual.html#dx1-14007" >814</a>, <a +href="glossaries-manual.html#dx1-14010" >815</a>, <a +href="glossaries-manual.html#dx1-14015" >816</a>, <a +href="glossaries-manual.html#dx1-14019" >817</a>, <a +href="glossaries-manual.html#dx1-14083" >818</a>, <a +href="glossaries-manual.html#dx1-14097" >819</a>, <a +href="glossaries-manual.html#dx1-20005" >820</a>, <a +href="glossaries-manual.html#dx1-20011" >821</a>, <a +href="glossaries-manual.html#dx1-21003" >822</a>, <a +href="glossaries-manual.html#dx1-21020" >823</a>, <a +href="glossaries-manual.html#dx1-21024" >824</a>, <a +href="glossaries-manual.html#dx1-27003" >825</a>, <a +href="glossaries-manual.html#dx1-27005" >826</a>, <a +href="glossaries-manual.html#dx1-33003" >827</a>, <a +href="glossaries-manual.html#dx1-38006" >828</a>, <a +href="glossaries-manual.html#dx1-44013" >829</a>, <a +href="glossaries-manual.html#dx1-45013" >830</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\MakeUppercase</span></span></span>  <a +href="glossaries-manual.html#dx1-50003" ><span class="underline">831</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">mfirstuc </span>package  <a +href="glossaries-manual.html#dx1-50001" >832</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">N</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newacronym</span></span></span>  <a +href="glossaries-manual.html#dx1-3015" ><span class="underline">833</span></a>, <a +href="glossaries-manual.html#dx1-13021" ><span class="underline">834</span></a>, <a +href="glossaries-manual.html#dx1-13081" ><span class="underline">835</span></a>, <a +href="glossaries-manual.html#dx1-13083" ><span class="underline">836</span></a>, <a +href="glossaries-manual.html#dx1-13085" ><span class="underline">837</span></a>, <a +href="glossaries-manual.html#dx1-13087" ><span class="underline">838</span></a>, <a +href="glossaries-manual.html#dx1-13092" ><span class="underline">839</span></a>, <a +href="glossaries-manual.html#dx1-34002" ><span +class="ecti-1000">840</span></a>, <a +href="glossaries-manual.html#dx1-34009" ><span class="underline">841</span></a>, <a +href="glossaries-manual.html#dx1-34011" ><span class="underline">842</span></a>, <a +href="glossaries-manual.html#dx1-34018" ><span class="underline">843</span></a>, <a +href="glossaries-manual.html#dx1-34021" ><span class="underline">844</span></a>, <a +href="glossaries-manual.html#dx1-34089" ><span class="underline">845</span></a>, <a +href="glossaries-manual.html#dx1-34094" ><span class="underline">846</span></a>, <a +href="glossaries-manual.html#dx1-34102" ><span class="underline">847</span></a>, <a +href="glossaries-manual.html#dx1-34150" ><span class="underline">848</span></a>, <a +href="glossaries-manual.html#dx1-35003" ><span class="underline">849</span></a>, <a +href="glossaries-manual.html#dx1-35019" ><span class="underline">850</span></a>, <a +href="glossaries-manual.html#dx1-35022" ><span class="underline">851</span></a>, <a +href="glossaries-manual.html#dx1-36006" ><span class="underline">852</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newglossary</span></span></span>  <a +href="glossaries-manual.html#dx1-8017" ><span class="underline">853</span></a>, <a +href="glossaries-manual.html#dx1-9016" ><span class="underline">854</span></a>, <a +href="glossaries-manual.html#dx1-13004" ><span class="underline">855</span></a>, <a +href="glossaries-manual.html#dx1-33001" ><span +class="ecti-1000">856</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newglossaryentry</span></span></span>  <a +href="glossaries-manual.html#dx1-3014" ><span class="underline">857</span></a>, <a +href="glossaries-manual.html#dx1-14032" ><span +class="ecti-1000">858</span></a>, <a +href="glossaries-manual.html#dx1-21001" ><span class="underline">859</span></a>, <a +href="glossaries-manual.html#dx1-21053" ><span class="underline">860</span></a>, <a +href="glossaries-manual.html#dx1-34012" ><span class="underline">861</span></a>, <a +href="glossaries-manual.html#dx1-34022" ><span class="underline">862</span></a>, <a +href="glossaries-manual.html#dx1-34036" ><span class="underline">863</span></a>, <a +href="glossaries-manual.html#dx1-35002" ><span class="underline">864</span></a>, <a +href="glossaries-manual.html#dx1-35020" ><span class="underline">865</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">\newglossaryentry </span>options<br /></span> +<span class="index-subitem">    <span +class="ecss-1000">access</span>  <a +href="glossaries-manual.html#dx1-49003" >866</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">description</span>  <a +href="glossaries-manual.html#dx1-13065" >867</a>, <a +href="glossaries-manual.html#dx1-13068" >868</a>, <a +href="glossaries-manual.html#dx1-13073" >869</a>, <a +href="glossaries-manual.html#dx1-14033" >870</a>, <a +href="glossaries-manual.html#dx1-14038" >871</a>, <a +href="glossaries-manual.html#dx1-14049" >872</a>, <a +href="glossaries-manual.html#dx1-21115" >873</a>, <a +href="glossaries-manual.html#dx1-21116" >874</a>, <a +href="glossaries-manual.html#dx1-21117" >875</a>, <a +href="glossaries-manual.html#dx1-22011" >876</a>, <a +href="glossaries-manual.html#dx1-34043" >877</a>, <a +href="glossaries-manual.html#dx1-34083" >878</a>, <a +href="glossaries-manual.html#dx1-34093" >879</a>, <a +href="glossaries-manual.html#dx1-35013" >880</a>, <a +href="glossaries-manual.html#dx1-35046" >881</a>, <a +href="glossaries-manual.html#dx1-49018" >882</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">descriptionaccess</span>  <a +href="glossaries-manual.html#dx1-49017" >883</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">descriptionplural</span>  <a +href="glossaries-manual.html#dx1-14043" >884</a>, <a +href="glossaries-manual.html#dx1-22012" >885</a>, <a +href="glossaries-manual.html#dx1-49020" >886</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">descriptionpluralaccess</span>  <a +href="glossaries-manual.html#dx1-49019" >887</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">first</span>  <a +href="glossaries-manual.html#dx1-14053" >888</a>, <a +href="glossaries-manual.html#dx1-14065" >889</a>, <a +href="glossaries-manual.html#dx1-14067" >890</a>, <a +href="glossaries-manual.html#dx1-14068" >891</a>, <a +href="glossaries-manual.html#dx1-14070" >892</a>, <a +href="glossaries-manual.html#dx1-14073" >893</a>, <a +href="glossaries-manual.html#dx1-21013" >894</a>, <a +href="glossaries-manual.html#dx1-21052" >895</a>, <a +href="glossaries-manual.html#dx1-21056" >896</a>, <a +href="glossaries-manual.html#dx1-21070" >897</a>, <a +href="glossaries-manual.html#dx1-21085" >898</a>, <a +href="glossaries-manual.html#dx1-22009" >899</a>, <a +href="glossaries-manual.html#dx1-26015" >900</a>, <a +href="glossaries-manual.html#dx1-34041" >901</a>, <a +href="glossaries-manual.html#dx1-35008" >902</a>, <a +href="glossaries-manual.html#dx1-35042" >903</a>, <a +href="glossaries-manual.html#dx1-37003" >904</a>, <a +href="glossaries-manual.html#dx1-49008" >905</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">firstaccess</span>  <a +href="glossaries-manual.html#dx1-49007" >906</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">firstplural</span>  <a +href="glossaries-manual.html#dx1-14061" >907</a>, <a +href="glossaries-manual.html#dx1-14069" >908</a>, <a +href="glossaries-manual.html#dx1-14072" >909</a>, <a +href="glossaries-manual.html#dx1-15004" >910</a>, <a +href="glossaries-manual.html#dx1-21065" >911</a>, <a +href="glossaries-manual.html#dx1-21096" >912</a>, <a +href="glossaries-manual.html#dx1-22010" >913</a>, <a +href="glossaries-manual.html#dx1-26019" >914</a>, <a +href="glossaries-manual.html#dx1-35009" >915</a>, <a +href="glossaries-manual.html#dx1-35043" >916</a>, <a +href="glossaries-manual.html#dx1-49012" >917</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">firstpluralaccess</span>  <a +href="glossaries-manual.html#dx1-49011" >918</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">format</span>  <a +href="glossaries-manual.html#dx1-21044" >919</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">name</span>  <a +href="glossaries-manual.html#dx1-13064" >920</a>, <a +href="glossaries-manual.html#dx1-13069" >921</a>, <a +href="glossaries-manual.html#dx1-13072" >922</a>, <a +href="glossaries-manual.html#dx1-13077" >923</a>, <a +href="glossaries-manual.html#dx1-13078" >924</a>, <a +href="glossaries-manual.html#dx1-14034" >925</a>, <a +href="glossaries-manual.html#dx1-14036" >926</a>, <a +href="glossaries-manual.html#dx1-14052" >927</a>, <a +href="glossaries-manual.html#dx1-14085" >928</a>, <a +href="glossaries-manual.html#dx1-18001" >929</a>, <a +href="glossaries-manual.html#dx1-21101" >930</a>, <a +href="glossaries-manual.html#dx1-21102" >931</a>, <a +href="glossaries-manual.html#dx1-21103" >932</a>, <a +href="glossaries-manual.html#dx1-26005" >933</a>, <a +href="glossaries-manual.html#dx1-34081" >934</a>, <a +href="glossaries-manual.html#dx1-34082" >935</a>, <a +href="glossaries-manual.html#dx1-35007" >936</a>, <a +href="glossaries-manual.html#dx1-35023" >937</a>, <a +href="glossaries-manual.html#dx1-35026" >938</a>, <a +href="glossaries-manual.html#dx1-45015" >939</a>, <a +href="glossaries-manual.html#dx1-49004" >940</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nonumberlist</span>  <a +href="glossaries-manual.html#dx1-14091" >941</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">parent</span>  <a +href="glossaries-manual.html#dx1-14035" >942</a>, <a +href="glossaries-manual.html#dx1-14037" >943</a>, <a +href="glossaries-manual.html#dx1-14042" >944</a>, <a +href="glossaries-manual.html#dx1-17001" >945</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">plural</span>  <a +href="glossaries-manual.html#dx1-14057" >946</a>, <a +href="glossaries-manual.html#dx1-14064" >947</a>, <a +href="glossaries-manual.html#dx1-14071" >948</a>, <a +href="glossaries-manual.html#dx1-15002" >949</a>, <a +href="glossaries-manual.html#dx1-15003" >950</a>, <a +href="glossaries-manual.html#dx1-18005" >951</a>, <a +href="glossaries-manual.html#dx1-21064" >952</a>, <a +href="glossaries-manual.html#dx1-21091" >953</a>, <a +href="glossaries-manual.html#dx1-22008" >954</a>, <a +href="glossaries-manual.html#dx1-26011" >955</a>, <a +href="glossaries-manual.html#dx1-35011" >956</a>, <a +href="glossaries-manual.html#dx1-35025" >957</a>, <a +href="glossaries-manual.html#dx1-35045" >958</a>, <a +href="glossaries-manual.html#dx1-49010" >959</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">pluralaccess</span>  <a +href="glossaries-manual.html#dx1-49009" >960</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">see</span>  <a +href="glossaries-manual.html#dx1-14093" >961</a>, <a +href="glossaries-manual.html#dx1-14094" >962</a>, <a +href="glossaries-manual.html#dx1-21028" >963</a>, <a +href="glossaries-manual.html#dx1-25007" >964</a>, <a +href="glossaries-manual.html#dx1-25008" >965</a>, <a +href="glossaries-manual.html#dx1-25009" >966</a>, <a +href="glossaries-manual.html#dx1-2004" >967</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">sort</span>  <a +href="glossaries-manual.html#dx1-11046" >968</a>, <a +href="glossaries-manual.html#dx1-13075" >969</a>, <a +href="glossaries-manual.html#dx1-14082" >970</a>, <a +href="glossaries-manual.html#dx1-14096" >971</a>, <a +href="glossaries-manual.html#dx1-18004" >972</a>, <a +href="glossaries-manual.html#dx1-34088" >973</a>, <a +href="glossaries-manual.html#dx1-34101" >974</a>, <a +href="glossaries-manual.html#dx1-45014" >975</a>, <a +href="glossaries-manual.html#dx1-45016" >976</a> <br /></span> + + + +<span class="index-subitem">    <span +class="ecss-1000">symbol</span>  <a +href="glossaries-manual.html#dx1-13066" >977</a>, <a +href="glossaries-manual.html#dx1-13070" >978</a>, <a +href="glossaries-manual.html#dx1-13074" >979</a>, <a +href="glossaries-manual.html#dx1-14074" >980</a>, <a +href="glossaries-manual.html#dx1-14081" >981</a>, <a +href="glossaries-manual.html#dx1-21108" >982</a>, <a +href="glossaries-manual.html#dx1-21109" >983</a>, <a +href="glossaries-manual.html#dx1-21110" >984</a>, <a +href="glossaries-manual.html#dx1-22013" >985</a>, <a +href="glossaries-manual.html#dx1-22018" >986</a>, <a +href="glossaries-manual.html#dx1-22030" >987</a>, <a +href="glossaries-manual.html#dx1-34044" >988</a>, <a +href="glossaries-manual.html#dx1-34069" >989</a>, <a +href="glossaries-manual.html#dx1-34084" >990</a>, <a +href="glossaries-manual.html#dx1-35012" >991</a>, <a +href="glossaries-manual.html#dx1-35028" >992</a>, <a +href="glossaries-manual.html#dx1-35047" >993</a>, <a +href="glossaries-manual.html#dx1-49014" >994</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">symbolaccess</span>  <a +href="glossaries-manual.html#dx1-49013" >995</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">symbolplural</span>  <a +href="glossaries-manual.html#dx1-14075" >996</a>, <a +href="glossaries-manual.html#dx1-22014" >997</a>, <a +href="glossaries-manual.html#dx1-49016" >998</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">symbolpluralaccess</span>  <a +href="glossaries-manual.html#dx1-49015" >999</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">text</span>  <a +href="glossaries-manual.html#dx1-13076" >1000</a>, <a +href="glossaries-manual.html#dx1-13079" >1001</a>, <a +href="glossaries-manual.html#dx1-14050" >1002</a>, <a +href="glossaries-manual.html#dx1-14056" >1003</a>, <a +href="glossaries-manual.html#dx1-14060" >1004</a>, <a +href="glossaries-manual.html#dx1-21014" >1005</a>, <a +href="glossaries-manual.html#dx1-21051" >1006</a>, <a +href="glossaries-manual.html#dx1-21055" >1007</a>, <a +href="glossaries-manual.html#dx1-21071" >1008</a>, <a +href="glossaries-manual.html#dx1-21077" >1009</a>, <a +href="glossaries-manual.html#dx1-22007" >1010</a>, <a +href="glossaries-manual.html#dx1-26008" >1011</a>, <a +href="glossaries-manual.html#dx1-34042" >1012</a>, <a +href="glossaries-manual.html#dx1-35010" >1013</a>, <a +href="glossaries-manual.html#dx1-35024" >1014</a>, <a +href="glossaries-manual.html#dx1-35027" >1015</a>, <a +href="glossaries-manual.html#dx1-35044" >1016</a>, <a +href="glossaries-manual.html#dx1-37005" >1017</a>, <a +href="glossaries-manual.html#dx1-49006" >1018</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">textaccess</span>  <a +href="glossaries-manual.html#dx1-49005" >1019</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">type</span>  <a +href="glossaries-manual.html#dx1-14086" >1020</a>, <a +href="glossaries-manual.html#dx1-19002" >1021</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user1</span>  <a +href="glossaries-manual.html#dx1-1001" >1022</a>, <a +href="glossaries-manual.html#dx1-14089" >1023</a>, <a +href="glossaries-manual.html#dx1-21122" >1024</a>, <a +href="glossaries-manual.html#dx1-35030" >1025</a>, <a +href="glossaries-manual.html#x1-480002.13.3" >1026</a>, <a +href="glossaries-manual.html#dx1-48003" >1027</a>, <a +href="glossaries-manual.html#dx1-48004" >1028</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user2</span>  <a +href="glossaries-manual.html#dx1-35031" >1029</a>, <a +href="glossaries-manual.html#dx1-48005" >1030</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user3</span>  <a +href="glossaries-manual.html#dx1-35032" >1031</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user4</span>  <a +href="glossaries-manual.html#dx1-35033" >1032</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">user6</span>  <a +href="glossaries-manual.html#dx1-1002" >1033</a>, <a +href="glossaries-manual.html#dx1-14090" >1034</a>, <a +href="glossaries-manual.html#x1-480002.13.3" >1035</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newglossarystyle</span></span></span>  <a +href="glossaries-manual.html#dx1-38027" ><span class="underline">1036</span></a>, <a +href="glossaries-manual.html#dx1-45001" ><span +class="ecti-1000">1037</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\newline</span></span></span>  <a +href="glossaries-manual.html#dx1-14041" ><span class="underline">1038</span></a>, <a +href="glossaries-manual.html#dx1-38021" ><span class="underline">1039</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">ngerman </span>package  <a +href="glossaries-manual.html#dx1-5007" >1040</a>, <a +href="glossaries-manual.html#dx1-29009" >1041</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\nohyperpage</span></span></span>  <a +href="glossaries-manual.html#dx1-20017" ><span class="underline">1042</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\noist</span></span></span>  <a +href="glossaries-manual.html#dx1-3043" ><span class="underline">1043</span></a>, <a +href="glossaries-manual.html#dx1-14016" ><span +class="ecti-1000">1044</span></a>, <a +href="glossaries-manual.html#dx1-20010" ><span class="underline">1045</span></a>, <a +href="glossaries-manual.html#dx1-20019" ><span class="underline">1046</span></a>, <a +href="glossaries-manual.html#dx1-29013" ><span class="underline">1047</span></a>, <a +href="glossaries-manual.html#dx1-30011" ><span class="underline">1048</span></a>, <a +href="glossaries-manual.html#dx1-31008" ><span class="underline">1049</span></a>, <a +href="glossaries-manual.html#dx1-31014" ><span class="underline">1050</span></a>, <a +href="glossaries-manual.html#dx1-31024" ><span class="underline">1051</span></a>, <a +href="glossaries-manual.html#dx1-31030" ><span class="underline">1052</span></a>, <a +href="glossaries-manual.html#dx1-32002" ><span class="underline">1053</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\nopostdesc</span></span></span>  <a +href="glossaries-manual.html#dx1-14039" ><span +class="ecti-1000">1054</span></a>, <a +href="glossaries-manual.html#dx1-17002" ><span class="underline">1055</span></a>, <a +href="glossaries-manual.html#dx1-18002" ><span class="underline">1056</span></a>, <a +href="glossaries-manual.html#dx1-38032" ><span class="underline">1057</span></a> <br /></span> +<span class="index-item">number list  <a +href="glossaries-manual.html#dx1-3016" ><span class="underline">1058</span></a>, <a +href="glossaries-manual.html#dx1-3025" ><span class="underline">1059</span></a>, <a +href="glossaries-manual.html#dx1-6024" ><span class="underline">1060</span></a>, <a +href="glossaries-manual.html#dx1-13060" ><span class="underline">1061</span></a>, <a +href="glossaries-manual.html#dx1-13062" ><span class="underline">1062</span></a>, <a +href="glossaries-manual.html#dx1-14024" ><span class="underline">1063</span></a>, <a +href="glossaries-manual.html#dx1-14030" ><span class="underline">1064</span></a>, <a +href="glossaries-manual.html#dx1-14031" ><span class="underline">1065</span></a>, <a +href="glossaries-manual.html#dx1-14092" ><span class="underline">1066</span></a>, <a +href="glossaries-manual.html#dx1-16001" ><span class="underline">1067</span></a>, <a +href="glossaries-manual.html#dx1-18003" ><span class="underline">1068</span></a>, <a +href="glossaries-manual.html#dx1-20001" ><span class="underline">1069</span></a>, <a +href="glossaries-manual.html#dx1-21005" ><span class="underline">1070</span></a>, <a +href="glossaries-manual.html#dx1-25013" ><span class="underline">1071</span></a>, <a +href="glossaries-manual.html#dx1-31017" ><span class="underline">1072</span></a>, <a +href="glossaries-manual.html#dx1-31027" ><span class="underline">1073</span></a>, <a +href="glossaries-manual.html#dx1-33002" ><span class="underline">1074</span></a>, <a +href="glossaries-manual.html#dx1-39007" ><span class="underline">1075</span></a>, <a +href="glossaries-manual.html#dx1-39025" ><span class="underline">1076</span></a>, <a +href="glossaries-manual.html#dx1-40008" ><span class="underline">1077</span></a>, <a +href="glossaries-manual.html#dx1-40018" ><span class="underline">1078</span></a>, <a +href="glossaries-manual.html#dx1-41009" ><span class="underline">1079</span></a>, <a +href="glossaries-manual.html#dx1-41019" ><span class="underline">1080</span></a>, <a +href="glossaries-manual.html#dx1-42012" ><span class="underline">1081</span></a>, <a +href="glossaries-manual.html#dx1-42022" ><span class="underline">1082</span></a>, <a +href="glossaries-manual.html#dx1-43011" ><span class="underline">1083</span></a>, <a +href="glossaries-manual.html#dx1-43021" ><span class="underline">1084</span></a>, <a +href="glossaries-manual.html#dx1-46006" ><span class="underline">1085</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">O</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\oldacronym</span></span></span>  <a +href="glossaries-manual.html#dx1-36004" ><span +class="ecti-1000">1086</span></a>, <a +href="glossaries-manual.html#dx1-36007" ><span class="underline">1087</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">P</span> +<span class="index-item">package options:<br /></span> +<span class="index-subitem">    <span +class="ecss-1000">acronym</span>  <a +href="glossaries-manual.html#dx1-5016" ><span class="underline">1088</span></a>, <a +href="glossaries-manual.html#dx1-8012" ><span class="underline">1089</span></a>, <a +href="glossaries-manual.html#dx1-8016" ><span class="underline">1090</span></a>, <a +href="glossaries-manual.html#dx1-9010" ><span class="underline">1091</span></a>, <a +href="glossaries-manual.html#dx1-9015" ><span class="underline">1092</span></a>, <a +href="glossaries-manual.html#dx1-13003" ><span class="underline">1093</span></a>, <a +href="glossaries-manual.html#dx1-13013" ><span class="underline">1094</span></a>, <a +href="glossaries-manual.html#dx1-13014" ><span class="underline">1095</span></a>, <a +href="glossaries-manual.html#dx1-13038" ><span class="underline">1096</span></a>, <a +href="glossaries-manual.html#dx1-13039" ><span class="underline">1097</span></a>, <a +href="glossaries-manual.html#dx1-14088" ><span class="underline">1098</span></a>, <a +href="glossaries-manual.html#dx1-19003" ><span class="underline">1099</span></a>, <a +href="glossaries-manual.html#dx1-19004" ><span class="underline">1100</span></a>, <a +href="glossaries-manual.html#dx1-19007" ><span class="underline">1101</span></a>, <a +href="glossaries-manual.html#dx1-33007" ><span class="underline">1102</span></a>, <a +href="glossaries-manual.html#dx1-33008" ><span class="underline">1103</span></a>, <a +href="glossaries-manual.html#dx1-33010" ><span class="underline">1104</span></a>, <a +href="glossaries-manual.html#dx1-34005" ><span class="underline">1105</span></a>, <a +href="glossaries-manual.html#dx1-13019" ><span class="underline">1106</span></a>, <a +href="glossaries-manual.html#dx1-13036" ><span class="underline">1107</span></a>, <a +href="glossaries-manual.html#dx1-19006" ><span class="underline">1108</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">acronymlists</span>  <a +href="glossaries-manual.html#dx1-13023" ><span class="underline">1109</span></a>, <a +href="glossaries-manual.html#dx1-13024" ><span class="underline">1110</span></a>, <a +href="glossaries-manual.html#dx1-33011" ><span class="underline">1111</span></a>, <a +href="glossaries-manual.html#dx1-34006" ><span class="underline">1112</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">counter</span>  <a +href="glossaries-manual.html#dx1-13061" ><span class="underline">1113</span></a>, <a +href="glossaries-manual.html#dx1-14025" ><span class="underline">1114</span></a>, <a +href="glossaries-manual.html#dx1-20003" ><span class="underline">1115</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">description</span>  <a +href="glossaries-manual.html#dx1-13080" ><span class="underline">1116</span></a>, <a +href="glossaries-manual.html#dx1-34015" ><span class="underline">1117</span></a>, <a +href="glossaries-manual.html#dx1-34025" ><span class="underline">1118</span></a>, <a +href="glossaries-manual.html#dx1-34045" ><span class="underline">1119</span></a>, <a +href="glossaries-manual.html#dx1-34047" ><span class="underline">1120</span></a>, <a +href="glossaries-manual.html#dx1-34049" ><span class="underline">1121</span></a>, <a +href="glossaries-manual.html#dx1-34063" ><span class="underline">1122</span></a>, <a +href="glossaries-manual.html#dx1-34066" ><span class="underline">1123</span></a>, <a +href="glossaries-manual.html#dx1-34080" ><span class="underline">1124</span></a>, <a +href="glossaries-manual.html#dx1-34085" ><span class="underline">1125</span></a>, <a +href="glossaries-manual.html#dx1-34087" ><span class="underline">1126</span></a>, <a +href="glossaries-manual.html#dx1-34090" ><span class="underline">1127</span></a>, <a +href="glossaries-manual.html#dx1-34111" ><span class="underline">1128</span></a>, <a +href="glossaries-manual.html#dx1-34117" ><span class="underline">1129</span></a>, <a +href="glossaries-manual.html#dx1-34131" ><span class="underline">1130</span></a>, <a +href="glossaries-manual.html#dx1-35054" ><span class="underline">1131</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">dua</span>  <a +href="glossaries-manual.html#dx1-13091" ><span class="underline">1132</span></a>, <a +href="glossaries-manual.html#dx1-34016" ><span class="underline">1133</span></a>, <a +href="glossaries-manual.html#dx1-34048" ><span class="underline">1134</span></a>, <a +href="glossaries-manual.html#dx1-34053" ><span class="underline">1135</span></a>, <a +href="glossaries-manual.html#dx1-34062" ><span class="underline">1136</span></a>, <a +href="glossaries-manual.html#dx1-34074" ><span class="underline">1137</span></a>, <a +href="glossaries-manual.html#dx1-34075" ><span class="underline">1138</span></a>, <a +href="glossaries-manual.html#dx1-34096" ><span class="underline">1139</span></a>, <a +href="glossaries-manual.html#dx1-34130" ><span class="underline">1140</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">footnote</span>  <a +href="glossaries-manual.html#dx1-13082" ><span class="underline">1141</span></a>, <a +href="glossaries-manual.html#dx1-34007" ><span class="underline">1142</span></a>, <a +href="glossaries-manual.html#dx1-34017" ><span class="underline">1143</span></a>, <a +href="glossaries-manual.html#dx1-34026" ><span class="underline">1144</span></a>, <a +href="glossaries-manual.html#dx1-34046" ><span class="underline">1145</span></a>, <a +href="glossaries-manual.html#dx1-34050" ><span class="underline">1146</span></a>, <a +href="glossaries-manual.html#dx1-34061" ><span class="underline">1147</span></a>, <a +href="glossaries-manual.html#dx1-34067" ><span class="underline">1148</span></a>, <a +href="glossaries-manual.html#dx1-34076" ><span class="underline">1149</span></a>, <a +href="glossaries-manual.html#dx1-34095" ><span class="underline">1150</span></a>, <a +href="glossaries-manual.html#dx1-34103" ><span class="underline">1151</span></a>, <a +href="glossaries-manual.html#dx1-34110" ><span class="underline">1152</span></a>, <a +href="glossaries-manual.html#dx1-34116" ><span class="underline">1153</span></a>, <a +href="glossaries-manual.html#dx1-34129" ><span class="underline">1154</span></a>, <a +href="glossaries-manual.html#dx1-35055" ><span class="underline">1155</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">hyperfirst</span>  <a +href="glossaries-manual.html#dx1-13137" ><span class="underline">1156</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">false</span>  <a +href="glossaries-manual.html#dx1-11010" ><span class="underline">1157</span></a>, <a +href="glossaries-manual.html#dx1-23011" ><span class="underline">1158</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">true</span>  <a +href="glossaries-manual.html#dx1-13139" ><span class="underline">1159</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">makeindex</span>  <a +href="glossaries-manual.html#dx1-13094" ><span class="underline">1160</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nolist</span>  <a +href="glossaries-manual.html#dx1-13048" ><span class="underline">1161</span></a>, <a +href="glossaries-manual.html#dx1-39003" ><span class="underline">1162</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nolong</span>  <a +href="glossaries-manual.html#dx1-13042" ><span class="underline">1163</span></a>, <a +href="glossaries-manual.html#dx1-40003" ><span class="underline">1164</span></a>, <a +href="glossaries-manual.html#dx1-38014" ><span class="underline">1165</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nomain</span>  <a +href="glossaries-manual.html#dx1-13002" ><span class="underline">1166</span></a>, <a +href="glossaries-manual.html#dx1-33006" ><span class="underline">1167</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nonumberlist</span>  <a +href="glossaries-manual.html#dx1-13059" ><span class="underline">1168</span></a>, <a +href="glossaries-manual.html#dx1-20002" ><span class="underline">1169</span></a>, <a +href="glossaries-manual.html#dx1-45029" ><span class="underline">1170</span></a>, <a +href="glossaries-manual.html#dx1-45030" ><span class="underline">1171</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nostyles</span>  <a +href="glossaries-manual.html#dx1-13054" ><span class="underline">1172</span></a>, <a +href="glossaries-manual.html#dx1-39004" ><span class="underline">1173</span></a>, <a +href="glossaries-manual.html#dx1-40004" ><span class="underline">1174</span></a>, <a +href="glossaries-manual.html#dx1-42004" ><span class="underline">1175</span></a>, <a +href="glossaries-manual.html#dx1-44003" ><span class="underline">1176</span></a>, <a +href="glossaries-manual.html#dx1-38016" ><span class="underline">1177</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nosuper</span>  <a +href="glossaries-manual.html#dx1-13045" ><span class="underline">1178</span></a>, <a +href="glossaries-manual.html#dx1-42003" ><span class="underline">1179</span></a>, <a +href="glossaries-manual.html#dx1-38015" ><span class="underline">1180</span></a> <br /></span> + + + +<span class="index-subitem">    <span +class="ecss-1000">notree</span>  <a +href="glossaries-manual.html#dx1-13052" ><span class="underline">1181</span></a>, <a +href="glossaries-manual.html#dx1-44002" ><span class="underline">1182</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nowarn</span>  <a +href="glossaries-manual.html#dx1-13001" ><span class="underline">1183</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">numberedsection</span>  <a +href="glossaries-manual.html#dx1-13029" ><span class="underline">1184</span></a>, <a +href="glossaries-manual.html#dx1-13030" ><span class="underline">1185</span></a>, <a +href="glossaries-manual.html#dx1-27017" ><span class="underline">1186</span></a>, <a +href="glossaries-manual.html#dx1-27018" ><span class="underline">1187</span></a>, <a +href="glossaries-manual.html#dx1-27021" ><span class="underline">1188</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">autolabel</span>  <a +href="glossaries-manual.html#dx1-13033" ><span class="underline">1189</span></a>, <a +href="glossaries-manual.html#dx1-13034" ><span class="underline">1190</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">false</span>  <a +href="glossaries-manual.html#dx1-13031" ><span class="underline">1191</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">nolabel</span>  <a +href="glossaries-manual.html#dx1-13032" ><span class="underline">1192</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">numberline</span>  <a +href="glossaries-manual.html#dx1-13008" ><span class="underline">1193</span></a>, <a +href="glossaries-manual.html#dx1-13012" ><span class="underline">1194</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">order</span>  <a +href="glossaries-manual.html#dx1-13112" ><span class="underline">1195</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">letter</span>  <a +href="glossaries-manual.html#dx1-3033" ><span class="underline">1196</span></a>, <a +href="glossaries-manual.html#dx1-6033" ><span class="underline">1197</span></a>, <a +href="glossaries-manual.html#dx1-13114" ><span class="underline">1198</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">word</span>  <a +href="glossaries-manual.html#dx1-3032" ><span class="underline">1199</span></a>, <a +href="glossaries-manual.html#dx1-6034" ><span class="underline">1200</span></a>, <a +href="glossaries-manual.html#dx1-13113" ><span class="underline">1201</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">sanitize</span>  <a +href="glossaries-manual.html#dx1-13063" ><span class="underline">1202</span></a>, <a +href="glossaries-manual.html#dx1-13067" ><span class="underline">1203</span></a>, <a +href="glossaries-manual.html#dx1-34071" ><span class="underline">1204</span></a>, <a +href="glossaries-manual.html#dx1-34133" ><span class="underline">1205</span></a>, <a +href="glossaries-manual.html#dx1-34149" ><span class="underline">1206</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">description</span>  <a +href="glossaries-manual.html#dx1-34072" ><span class="underline">1207</span></a>, <a +href="glossaries-manual.html#dx1-34105" ><span class="underline">1208</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">none</span>  <a +href="glossaries-manual.html#dx1-13071" ><span class="underline">1209</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">symbol</span>  <a +href="glossaries-manual.html#dx1-34073" ><span class="underline">1210</span></a>, <a +href="glossaries-manual.html#dx1-34092" ><span class="underline">1211</span></a>, <a +href="glossaries-manual.html#dx1-34114" ><span class="underline">1212</span></a>, <a +href="glossaries-manual.html#dx1-34126" ><span class="underline">1213</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">section</span>  <a +href="glossaries-manual.html#dx1-13025" ><span class="underline">1214</span></a>, <a +href="glossaries-manual.html#dx1-27020" ><span class="underline">1215</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">shortcuts</span>  <a +href="glossaries-manual.html#dx1-13093" ><span class="underline">1216</span></a>, <a +href="glossaries-manual.html#dx1-34019" ><span class="underline">1217</span></a>, <a +href="glossaries-manual.html#dx1-34153" ><span class="underline">1218</span></a>, <a +href="glossaries-manual.html#dx1-34154" ><span class="underline">1219</span></a>, <a +href="glossaries-manual.html#dx1-34156" ><span class="underline">1220</span></a>, <a +href="glossaries-manual.html#dx1-35018" ><span class="underline">1221</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">smallcaps</span>  <a +href="glossaries-manual.html#dx1-11006" ><span class="underline">1222</span></a>, <a +href="glossaries-manual.html#dx1-11007" ><span class="underline">1223</span></a>, <a +href="glossaries-manual.html#dx1-13084" ><span class="underline">1224</span></a>, <a +href="glossaries-manual.html#dx1-34008" ><span class="underline">1225</span></a>, <a +href="glossaries-manual.html#dx1-34013" ><span class="underline">1226</span></a>, <a +href="glossaries-manual.html#dx1-34023" ><span class="underline">1227</span></a>, <a +href="glossaries-manual.html#dx1-34031" ><span class="underline">1228</span></a>, <a +href="glossaries-manual.html#dx1-34032" ><span class="underline">1229</span></a>, <a +href="glossaries-manual.html#dx1-34037" ><span class="underline">1230</span></a>, <a +href="glossaries-manual.html#dx1-34051" ><span class="underline">1231</span></a>, <a +href="glossaries-manual.html#dx1-34059" ><span class="underline">1232</span></a>, <a +href="glossaries-manual.html#dx1-34078" ><span class="underline">1233</span></a>, <a +href="glossaries-manual.html#dx1-34109" ><span class="underline">1234</span></a>, <a +href="glossaries-manual.html#dx1-34127" ><span class="underline">1235</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">smaller</span>  <a +href="glossaries-manual.html#dx1-11013" ><span class="underline">1236</span></a>, <a +href="glossaries-manual.html#dx1-11017" ><span class="underline">1237</span></a>, <a +href="glossaries-manual.html#dx1-13086" ><span class="underline">1238</span></a>, <a +href="glossaries-manual.html#dx1-34014" ><span class="underline">1239</span></a>, <a +href="glossaries-manual.html#dx1-34024" ><span class="underline">1240</span></a>, <a +href="glossaries-manual.html#dx1-34030" ><span class="underline">1241</span></a>, <a +href="glossaries-manual.html#dx1-34033" ><span class="underline">1242</span></a>, <a +href="glossaries-manual.html#dx1-34035" ><span class="underline">1243</span></a>, <a +href="glossaries-manual.html#dx1-34038" ><span class="underline">1244</span></a>, <a +href="glossaries-manual.html#dx1-34052" ><span class="underline">1245</span></a>, <a +href="glossaries-manual.html#dx1-34060" ><span class="underline">1246</span></a>, <a +href="glossaries-manual.html#dx1-34077" ><span class="underline">1247</span></a>, <a +href="glossaries-manual.html#dx1-34115" ><span class="underline">1248</span></a>, <a +href="glossaries-manual.html#dx1-34128" ><span class="underline">1249</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">style</span>  <a +href="glossaries-manual.html#dx1-13041" ><span class="underline">1250</span></a>, <a +href="glossaries-manual.html#dx1-13051" ><span class="underline">1251</span></a>, <a +href="glossaries-manual.html#dx1-13055" ><span class="underline">1252</span></a>, <a +href="glossaries-manual.html#dx1-27014" ><span class="underline">1253</span></a>, <a +href="glossaries-manual.html#dx1-38010" ><span class="underline">1254</span></a>, <a +href="glossaries-manual.html#dx1-41007" ><span class="underline">1255</span></a>, <a +href="glossaries-manual.html#dx1-43007" ><span class="underline">1256</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">toc</span>  <a +href="glossaries-manual.html#dx1-13005" ><span class="underline">1257</span></a>, <a +href="glossaries-manual.html#dx1-13009" ><span class="underline">1258</span></a>, <a +href="glossaries-manual.html#dx1-13010" ><span class="underline">1259</span></a>, <a +href="glossaries-manual.html#dx1-13011" ><span class="underline">1260</span></a>, <a +href="glossaries-manual.html#dx1-27012" ><span class="underline">1261</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">translate</span>  <a +href="glossaries-manual.html#dx1-13116" ><span class="underline">1262</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">false</span>  <a +href="glossaries-manual.html#dx1-5029" ><span class="underline">1263</span></a>, <a +href="glossaries-manual.html#dx1-5034" ><span class="underline">1264</span></a>, <a +href="glossaries-manual.html#dx1-13121" ><span class="underline">1265</span></a>, <a +href="glossaries-manual.html#dx1-13132" ><span class="underline">1266</span></a> <br /></span> +<span class="index-subsubitem">        <span +class="ecss-1000">true</span>  <a +href="glossaries-manual.html#dx1-13117" ><span class="underline">1267</span></a>, <a +href="glossaries-manual.html#dx1-13122" ><span class="underline">1268</span></a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">xindy</span>  <a +href="glossaries-manual.html#dx1-3051" ><span class="underline">1269</span></a>, <a +href="glossaries-manual.html#dx1-4006" ><span class="underline">1270</span></a>, <a +href="glossaries-manual.html#dx1-6013" ><span class="underline">1271</span></a>, <a +href="glossaries-manual.html#dx1-6035" ><span class="underline">1272</span></a>, <a +href="glossaries-manual.html#dx1-8002" ><span class="underline">1273</span></a>, <a +href="glossaries-manual.html#dx1-9002" ><span class="underline">1274</span></a>, <a +href="glossaries-manual.html#dx1-13102" ><span class="underline">1275</span></a>, <a +href="glossaries-manual.html#dx1-13110" ><span class="underline">1276</span></a>, <a +href="glossaries-manual.html#dx1-14029" ><span class="underline">1277</span></a>, <a +href="glossaries-manual.html#dx1-29002" ><span class="underline">1278</span></a>, <a +href="glossaries-manual.html#dx1-32001" ><span class="underline">1279</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\pagelistname</span></span></span>  <a +href="glossaries-manual.html#dx1-5020" ><span class="underline">1280</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">pod2man</span>  <a +href="glossaries-manual.html#dx1-7009" >1281</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">polyglossia </span>package  <a +href="glossaries-manual.html#dx1-5002" >1282</a>, <a +href="glossaries-manual.html#dx1-5031" >1283</a>, <a +href="glossaries-manual.html#dx1-13119" >1284</a>, <a +href="glossaries-manual.html#dx1-13130" >1285</a>, <a +href="glossaries-manual.html#dx1-13134" >1286</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\printglossaries</span></span></span>  <a +href="glossaries-manual.html#dx1-11039" ><span class="underline">1287</span></a>, <a +href="glossaries-manual.html#dx1-14005" ><span class="underline">1288</span></a>, <a +href="glossaries-manual.html#dx1-27001" ><span +class="ecti-1000">1289</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\printglossary</span></span></span>  <a +href="glossaries-manual.html#dx1-11038" ><span class="underline">1290</span></a>, <a +href="glossaries-manual.html#dx1-13058" ><span class="underline">1291</span></a>, <a +href="glossaries-manual.html#dx1-14004" ><span class="underline">1292</span></a>, <a +href="glossaries-manual.html#dx1-27008" ><span +class="ecti-1000">1293</span></a>, <a +href="glossaries-manual.html#dx1-38008" ><span class="underline">1294</span></a>, <a +href="glossaries-manual.html#dx1-38023" ><span class="underline">1295</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">\printglossary </span>options<br /></span> +<span class="index-subitem">    <span +class="ecss-1000">nonumberlist</span>  <a +href="glossaries-manual.html#dx1-27019" >1296</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">numberedsection</span>  <a +href="glossaries-manual.html#dx1-27016" >1297</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">style</span>  <a +href="glossaries-manual.html#dx1-13057" >1298</a>, <a +href="glossaries-manual.html#dx1-27013" >1299</a>, <a +href="glossaries-manual.html#dx1-38007" >1300</a>, <a +href="glossaries-manual.html#dx1-38022" >1301</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">title</span>  <a +href="glossaries-manual.html#dx1-27010" >1302</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">toctitle</span>  <a +href="glossaries-manual.html#dx1-27011" >1303</a> <br /></span> +<span class="index-subitem">    <span +class="ecss-1000">type</span>  <a +href="glossaries-manual.html#dx1-27009" >1304</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">R</span> +<span class="index-item"><span +class="ecss-1000">relsize </span>package  <a +href="glossaries-manual.html#dx1-13088" >1305</a>, <a +href="glossaries-manual.html#dx1-34034" >1306</a>, <a +href="glossaries-manual.html#dx1-34124" >1307</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">S</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\seename</span></span></span>  <a +href="glossaries-manual.html#dx1-25014" ><span class="underline">1308</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\setAlphaCompositor</span></span></span>  <a +href="glossaries-manual.html#dx1-31021" ><span class="underline">1309</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\setCompositor</span></span></span>  <a +href="glossaries-manual.html#dx1-31019" ><span class="underline">1310</span></a> <br /></span> + + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\SetCustomDisplayStyle</span></span></span>  <a +href="glossaries-manual.html#dx1-35014" ><span +class="ecti-1000">1311</span></a>, <a +href="glossaries-manual.html#dx1-35039" ><span class="underline">1312</span></a>, <a +href="glossaries-manual.html#dx1-35048" ><span class="underline">1313</span></a>, <a +href="glossaries-manual.html#dx1-35052" ><span class="underline">1314</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\SetCustomStyle</span></span></span>  <a +href="glossaries-manual.html#dx1-35017" ><span +class="ecti-1000">1315</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\setglossarysection</span></span></span>  <a +href="glossaries-manual.html#dx1-13026" ><span +class="ecti-1000">1316</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\setStyleFile</span></span></span>  <a +href="glossaries-manual.html#dx1-8011" ><span class="underline">1317</span></a>, <a +href="glossaries-manual.html#dx1-9008" ><span class="underline">1318</span></a>, <a +href="glossaries-manual.html#dx1-14023" ><span +class="ecti-1000">1319</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\smaller</span></span></span>  <a +href="glossaries-manual.html#dx1-34120" ><span class="underline">1320</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">supertabular </span>environment  <a +href="glossaries-manual.html#dx1-42002" >1321</a>, <a +href="glossaries-manual.html#dx1-42006" >1322</a>, <a +href="glossaries-manual.html#dx1-42010" >1323</a>, <a +href="glossaries-manual.html#dx1-43003" >1324</a>, <a +href="glossaries-manual.html#dx1-43009" >1325</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">supertabular </span>package  <a +href="glossaries-manual.html#dx1-13047" >1326</a>, <a +href="glossaries-manual.html#dx1-42011" >1327</a>, <a +href="glossaries-manual.html#dx1-43010" >1328</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\symbolname</span></span></span>  <a +href="glossaries-manual.html#dx1-5019" ><span class="underline">1329</span></a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">T</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textbf</span></span></span>  <a +href="glossaries-manual.html#dx1-21021" ><span class="underline">1330</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textrm</span></span></span>  <a +href="glossaries-manual.html#dx1-31002" ><span class="underline">1331</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textsc</span></span></span>  <a +href="glossaries-manual.html#dx1-34113" ><span class="underline">1332</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\textsmaller</span></span></span>  <a +href="glossaries-manual.html#dx1-13089" ><span class="underline">1333</span></a>, <a +href="glossaries-manual.html#dx1-34123" ><span class="underline">1334</span></a>, <a +href="glossaries-manual.html#dx1-34121" ><span class="underline">1335</span></a> <br /></span> +<span class="index-item"><span +class="ectt-1000">theglossary </span>(environment)  <a +href="glossaries-manual.html#dx1-45002" ><span +class="ecti-1000">1336</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">theglossary </span>environment  <a +href="glossaries-manual.html#dx1-45004" >1337</a>, <a +href="glossaries-manual.html#dx1-45007" >1338</a>, <a +href="glossaries-manual.html#dx1-46002" >1339</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\thepage</span></span></span>  <a +href="glossaries-manual.html#dx1-31012" ><span class="underline">1340</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">translator </span>package  <a +href="glossaries-manual.html#dx1-5004" >1341</a>, <a +href="glossaries-manual.html#dx1-5005" >1342</a>, <a +href="glossaries-manual.html#dx1-5006" >1343</a>, <a +href="glossaries-manual.html#dx1-5010" >1344</a>, <a +href="glossaries-manual.html#dx1-5012" >1345</a>, <a +href="glossaries-manual.html#dx1-5024" >1346</a>, <a +href="glossaries-manual.html#dx1-5025" >1347</a>, <a +href="glossaries-manual.html#dx1-5026" >1348</a>, <a +href="glossaries-manual.html#dx1-5028" >1349</a>, <a +href="glossaries-manual.html#dx1-11031" >1350</a>, <a +href="glossaries-manual.html#dx1-13120" >1351</a>, <a +href="glossaries-manual.html#dx1-13124" >1352</a>, <a +href="glossaries-manual.html#dx1-13125" >1353</a>, <a +href="glossaries-manual.html#dx1-13126" >1354</a>, <a +href="glossaries-manual.html#dx1-13127" >1355</a> <br /></span> +</p><p class="theindex"> <span +class="ecbx-1000">X</span> +<span class="index-item"><span +class="ectt-1000">xindy</span>  <a +href="glossaries-manual.html#dx1-2008" >1356</a>, <a +href="glossaries-manual.html#dx1-2011" >1357</a>, <a +href="glossaries-manual.html#dx1-3036" >1358</a>, <a +href="glossaries-manual.html#dx1-3040" >1359</a>, <a +href="glossaries-manual.html#dx1-3044" >1360</a>, <a +href="glossaries-manual.html#dx1-3046" >1361</a>, <a +href="glossaries-manual.html#dx1-3048" >1362</a>, <a +href="glossaries-manual.html#dx1-3049" >1363</a>, <a +href="glossaries-manual.html#dx1-4001" >1364</a>, <a +href="glossaries-manual.html#dx1-4003" >1365</a>, <a +href="glossaries-manual.html#dx1-4005" >1366</a>, <a +href="glossaries-manual.html#dx1-4010" >1367</a>, <a +href="glossaries-manual.html#dx1-4012" >1368</a>, <a +href="glossaries-manual.html#dx1-5035" >1369</a>, <a +href="glossaries-manual.html#dx1-5037" >1370</a>, <a +href="glossaries-manual.html#dx1-6002" >1371</a>, <a +href="glossaries-manual.html#dx1-6004" >1372</a>, <a +href="glossaries-manual.html#dx1-6006" >1373</a>, <a +href="glossaries-manual.html#dx1-6007" >1374</a>, <a +href="glossaries-manual.html#dx1-6010" >1375</a>, <a +href="glossaries-manual.html#dx1-6014" >1376</a>, <a +href="glossaries-manual.html#dx1-6019" >1377</a>, <a +href="glossaries-manual.html#dx1-6022" >1378</a>, <a +href="glossaries-manual.html#dx1-6026" >1379</a>, <a +href="glossaries-manual.html#dx1-6032" >1380</a>, <a +href="glossaries-manual.html#dx1-7003" >1381</a>, <a +href="glossaries-manual.html#dx1-8001" >1382</a>, <a +href="glossaries-manual.html#dx1-8003" >1383</a>, <a +href="glossaries-manual.html#dx1-8005" >1384</a>, <a +href="glossaries-manual.html#dx1-8006" >1385</a>, <a +href="glossaries-manual.html#dx1-8008" >1386</a>, <a +href="glossaries-manual.html#dx1-8019" >1387</a>, <a +href="glossaries-manual.html#dx1-8021" >1388</a>, <a +href="glossaries-manual.html#dx1-10001" >1389</a>, <a +href="glossaries-manual.html#dx1-10007" >1390</a>, <a +href="glossaries-manual.html#dx1-10010" >1391</a>, <a +href="glossaries-manual.html#dx1-11023" >1392</a>, <a +href="glossaries-manual.html#dx1-11047" >1393</a>, <a +href="glossaries-manual.html#dx1-11049" >1394</a>, <a +href="glossaries-manual.html#dx1-11050" >1395</a>, <a +href="glossaries-manual.html#dx1-11051" >1396</a>, <a +href="glossaries-manual.html#dx1-11052" >1397</a>, <a +href="glossaries-manual.html#dx1-13100" >1398</a>, <a +href="glossaries-manual.html#dx1-13103" >1399</a>, <a +href="glossaries-manual.html#dx1-13105" >1400</a>, <a +href="glossaries-manual.html#dx1-13107" >1401</a>, <a +href="glossaries-manual.html#dx1-13111" >1402</a>, <a +href="glossaries-manual.html#dx1-14008" >1403</a>, <a +href="glossaries-manual.html#dx1-14012" >1404</a>, <a +href="glossaries-manual.html#dx1-14014" >1405</a>, <a +href="glossaries-manual.html#dx1-14022" >1406</a>, <a +href="glossaries-manual.html#dx1-14027" >1407</a>, <a +href="glossaries-manual.html#dx1-14084" >1408</a>, <a +href="glossaries-manual.html#dx1-14098" >1409</a>, <a +href="glossaries-manual.html#dx1-20006" >1410</a>, <a +href="glossaries-manual.html#dx1-20007" >1411</a>, <a +href="glossaries-manual.html#dx1-20012" >1412</a>, <a +href="glossaries-manual.html#dx1-20015" >1413</a>, <a +href="glossaries-manual.html#dx1-21004" >1414</a>, <a +href="glossaries-manual.html#dx1-21023" >1415</a>, <a +href="glossaries-manual.html#dx1-21027" >1416</a>, <a +href="glossaries-manual.html#dx1-21045" >1417</a>, <a +href="glossaries-manual.html#dx1-27004" >1418</a>, <a +href="glossaries-manual.html#dx1-27006" >1419</a>, <a +href="glossaries-manual.html#dx1-29001" >1420</a>, <a +href="glossaries-manual.html#dx1-29003" >1421</a>, <a +href="glossaries-manual.html#dx1-29004" >1422</a>, <a +href="glossaries-manual.html#dx1-29006" >1423</a>, <a +href="glossaries-manual.html#dx1-29011" >1424</a>, <a +href="glossaries-manual.html#dx1-29012" >1425</a>, <a +href="glossaries-manual.html#dx1-29014" >1426</a>, <a +href="glossaries-manual.html#dx1-29015" >1427</a>, <a +href="glossaries-manual.html#dx1-30001" >1428</a>, <a +href="glossaries-manual.html#dx1-30002" >1429</a>, <a +href="glossaries-manual.html#dx1-30005" >1430</a>, <a +href="glossaries-manual.html#dx1-30010" >1431</a>, <a +href="glossaries-manual.html#dx1-30013" >1432</a>, <a +href="glossaries-manual.html#dx1-31004" >1433</a>, <a +href="glossaries-manual.html#dx1-31007" >1434</a>, <a +href="glossaries-manual.html#dx1-31013" >1435</a>, <a +href="glossaries-manual.html#dx1-31029" >1436</a>, <a +href="glossaries-manual.html#dx1-33004" >1437</a>, <a +href="glossaries-manual.html#dx1-44014" >1438</a>, <a +href="glossaries-manual.html#dx1-45017" >1439</a> <br /></span> +<span class="index-item"><span +class="ecss-1000">xkeyval </span>package  <a +href="glossaries-manual.html#dx1-3003" >1440</a>, <a +href="glossaries-manual.html#dx1-11003" >1441</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\xmakefirstuc</span></span></span>  <a +href="glossaries-manual.html#dx1-50005" ><span +class="ecti-1000">1442</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ectt-1000">\xspace</span></span></span>  <a +href="glossaries-manual.html#dx1-36016" ><span class="underline">1443</span></a> <br /></span> +<span class="index-item"><span +class="ecss-1000">xspace </span>package  <a +href="glossaries-manual.html#dx1-36014" >1444</a>, <a +href="glossaries-manual.html#dx1-36015" >1445</a>, <a +href="glossaries-manual.html#dx1-36017" >1446</a>, <a +href="glossaries-manual.html#dx1-36019" >1447</a>, <a +href="glossaries-manual.html#dx1-36021" >1448</a>, <a +href="glossaries-manual.html#dx1-36022" >1449</a> <br /></span> +</p></div> +<!--l. 5074--><p class="noindent" ><a +href="#top">Top</a> +</p> + + + + <div class="footnotes"><!--l. 91--><p class="indent" > <span class="footnote-mark"><a +href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span +class="ecrm-0800">that is, if the term has been referenced using any of the commands described in </span><a +href="#x1-210002.4"><span +class="ecrm-0800">§2.4 </span></a><a +href="#x1-210002.4"><span +class="ecrm-0800">Links to</span> +<span +class="ecrm-0800">Glossary Entries</span><!--tex4ht:ref: sec:glslink --></a><span +class="ecrm-0800">, </span><a +href="#x1-240002.5"><span +class="ecrm-0800">§2.5 </span></a><a +href="#x1-240002.5"><span +class="ecrm-0800">Adding an Entry to the Glossary Without Generating Text</span><!--tex4ht:ref: sec:glsadd --></a> <span +class="ecrm-0800">or via </span><span +class="ectt-0800">\glssee</span><a + id="dx1-2003"></a> <span +class="ecrm-0800">(or</span> +<span +class="ecrm-0800">the </span><span +class="ecss-0800">see</span><a + id="dx1-2004"></a> <span +class="ecrm-0800">key)</span></p> +<!--l. 1199--><p class="noindent" ><span class="footnote-mark"><a +href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span +class="ecrm-0800">Actually it sets </span><span +class="ectt-0800">\acronymtype</span><a + id="dx1-13017"></a> <span +class="ecrm-0800">to </span><span +class="ectt-0800">\glsdefaulttype</span><a + id="dx1-13018"></a> <span +class="ecrm-0800">if the </span><span +class="ecss-0800">acronym</span><a + id="dx1-13019"></a> <span +class="ecrm-0800">package option is not used, but</span> +<span +class="ectt-0800">\glsdefaulttype</span><a + id="dx1-13020"></a> <span +class="ecrm-0800">usually has the value </span><span +class="ectt-0800">main</span><span +class="ecrm-0800">.</span></p> +<!--l. 1277--><p class="noindent" ><span class="footnote-mark"><a +href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span +class="ecrm-0800">if the </span><span +class="ecss-0800">acronym</span><a + id="dx1-13036"></a> <span +class="ecrm-0800">option is used, otherwise the list of acronyms is the main glossary</span></p> +<!--l. 1500--><p class="indent" > <span class="footnote-mark"><a +href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span +class="ecrm-0800">The only preamble restriction on </span><span +class="ectt-0800">\newglossaryentry </span><span +class="ecrm-0800">and </span><span +class="ectt-0800">\newacronym </span><span +class="ecrm-0800">was removed in version</span> +<span +class="ecrm-0800">1.13, but the restriction remains for </span><span +class="ectt-0800">\loadglsentries</span><span +class="ecrm-0800">.</span></p> +<!--l. 1922--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span +class="ecrm-0800">This is because </span><span +class="ectt-0800">\acronymtype </span><span +class="ecrm-0800">is set to </span><span +class="ectt-0800">\glsdefaulttype </span><span +class="ecrm-0800">if the </span><span +class="ecss-0800">acronym</span><a + id="dx1-19006"></a> <span +class="ecrm-0800">package option is not</span> +<span +class="ecrm-0800">used.</span></p> +<!--l. 2531--><p class="indent" > <span class="footnote-mark"><a +href="#fn6x0-bk" id="fn6x0"><sup class="textsuperscript">6</sup></a></span><span +class="ectt-0800">main </span><span +class="ecrm-0800">for the main (default) glossary, </span><span +class="ectt-0800">\acronymtype </span><span +class="ecrm-0800">for the list of acronyms, or the name</span> +<span +class="ecrm-0800">supplied in the first mandatory argument to </span><span +class="ectt-0800">\newglossary </span><span +class="ecrm-0800">for additional glossaries.</span></p> +<!--l. 3138--><p class="indent" > <span class="footnote-mark"><a +href="#fn7x0-bk" id="fn7x0"><sup class="textsuperscript">7</sup></a></span><span +class="ecrm-0800">see </span><span +class="ectt-0800">\setCompositor</span><a + id="dx1-31019"></a> <span +class="ecrm-0800">described in </span><a +href="#x1-140002.2"><span +class="ecrm-0800">§2.2 </span></a><a +href="#x1-140002.2"><span +class="ecrm-0800">Defining Glossary Entries</span><!--tex4ht:ref: sec:newglosentry --></a></p> +<!--l. 3144--><p class="indent" > <span class="footnote-mark"><a +href="#fn8x0-bk" id="fn8x0"><sup class="textsuperscript">8</sup></a></span><span +class="ecrm-0800">see </span><span +class="ectt-0800">\setAlphaCompositor</span><a + id="dx1-31021"></a> <span +class="ecrm-0800">described in </span><a +href="#x1-140002.2"><span +class="ecrm-0800">§2.2 </span></a><a +href="#x1-140002.2"><span +class="ecrm-0800">Defining Glossary Entries</span><!--tex4ht:ref: sec:newglosentry --></a></p> +<!--l. 3391--><p class="indent" > <span class="footnote-mark"><a +href="#fn9x0-bk" id="fn9x0"><sup class="textsuperscript">9</sup></a></span><span +class="ecrm-0800">you will need to load a package, such as </span><span +class="ecss-0800">relsize</span><span +class="ecrm-0800">, that defines </span><span +class="ectt-0800">\textsmaller </span><span +class="ecrm-0800">if you use this</span> +<span +class="ecrm-0800">option.</span></p> +<!--l. 3639--><p class="noindent" ><span class="footnote-mark"><a +href="#fn10x0-bk" id="fn10x0"><sup class="textsuperscript">10</sup></a></span><span +class="ecrm-0800">not that this was change from using </span><span +class="ectt-0800">\smaller</span><a + id="dx1-34120"></a> <span +class="ecrm-0800">to </span><span +class="ectt-0800">\textsmaller</span><a + id="dx1-34121"></a> <span +class="ecrm-0800">as declarations cause a problem for</span> +<span +class="ectt-0800">\makefirstuc</span><a + id="dx1-34122"></a><span +class="ecrm-0800">.</span></p> +<!--l. 3912--><p class="indent" > <span class="footnote-mark"><a +href="#fn11x0-bk" id="fn11x0"><sup class="textsuperscript">11</sup></a></span><span +class="ecrm-0800">as from version 1.18</span></p><!--l. 4101--><p class="indent" > <span class="footnote-mark"><a +href="#fn12x0-bk" id="fn12x0"><sup class="textsuperscript">12</sup></a></span><span +class="ecrm-0800">these lengths will not be available if you use both the </span><span +class="ecss-0800">nolong</span><a + id="dx1-38014"></a> <span +class="ecrm-0800">and </span><span +class="ecss-0800">nosuper</span><a + id="dx1-38015"></a> <span +class="ecrm-0800">package</span> +<span +class="ecrm-0800">options or if you use the </span><span +class="ecss-0800">nostyles</span><a + id="dx1-38016"></a> <span +class="ecrm-0800">package option unless you explicitly load the relevant</span> +<span +class="ecrm-0800">package.</span></p> +<!--l. 4208--><p class="noindent" ><span class="footnote-mark"><a +href="#fn13x0-bk" id="fn13x0"><sup class="textsuperscript">13</sup></a></span><span +class="ecrm-0800">This style was supplied by Axel</span><span +class="ecrm-0800"> Menzel.</span></p> +<!--l. 4419--><p class="indent" > <span class="footnote-mark"><a +href="#fn14x0-bk" id="fn14x0"><sup class="textsuperscript">14</sup></a></span><span +class="ecrm-0800">e.g.</span><span +class="ecrm-0800"> with the </span><span +class="ecss-0800">flowfram</span><a + id="dx1-42008"></a> <span +class="ecrm-0800">package.</span></p> +<!--l. 5059--><p class="indent" > <span class="footnote-mark"><a +href="#fn15x0-bk" id="fn15x0"><sup class="textsuperscript">15</sup></a></span><span +class="ecrm-0800">defined in the </span><span +class="ecss-0800">textcase </span><span +class="ecrm-0800">package</span></p> </div> + +</body></html> -</DD> -<DT><A NAME="foot4445">...MakeTextUppercase,</A><A - HREF="glossaries-manual.html#tex2html40"><SUP>16</SUP></A></DT> -<DD>defined in the -<TT>textcase</TT> package + -</DD> -</DL> -<BR><HR> -</BODY> -</HTML> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex index 1c716a84d86..2bb1db2d7f6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex @@ -1,10 +1,9 @@ -\documentclass[a4paper]{ltxdoc} -\usepackage{ifthen} +\documentclass{nlctdoc} + \usepackage{alltt} \usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} -\usepackage{cmap} \usepackage[colorlinks, bookmarks, hyperindex=false, @@ -12,167 +11,40 @@ pdftitle={glossaries.sty: LaTeX2e Package to Assist Generating Glossaries}, pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} - %hyperindex conflicts with doc - %(end up with |usage|hyperpage in indexentry) - %This unfortunately means that the changes section doesn't - %have active links, but at least it will keep makeindex happy. - -\usepackage{creatdtx} -\ifmakedtx{ -\usepackage{xcolor} -\usepackage{dox} \doxitem{Option}{option}{package options} \doxitem{GlsKey}{key}{glossary keys} \doxitem{Style}{style}{glossary styles} -\renewcommand{\usage}[1]{\textit{\hyperpage{#1}}} -\renewcommand{\main}[1]{\hyperpage{#1}} -\newcommand{\see}[2]{\emph{see} #1} -\makeatletter -\def\index@prologue{\section*{Index}} -\makeatother -\RecordChanges -\PageIndex -\CheckSum{10933} -\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}}} -\newlength\boxlength -\newsavebox\importantbox -\newenvironment{important}{% -\setlength{\fboxrule}{4pt}% -\setlength\boxlength{\linewidth}% -\addtolength\boxlength{-2\fboxsep}% -\addtolength\boxlength{-2\fboxrule}% -\begin{lrbox}{\importantbox}% -\begin{minipage}{\boxlength}% -}{\end{minipage}\end{lrbox}% -\par\vskip10pt\noindent -\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} -\newcommand*{\tick}{\ding{51}} +\setcounter{IndexColumns}{2} -\definecolor{defbackground}{rgb}{0.8,1,1} - -\newsavebox\defsbox -\newlength\defwidth -\newenvironment{definition}[1][]{% -\def\defarg{#1}% -\setlength{\fboxsep}{4pt}\setlength{\fboxrule}{1.25pt}% -\begin{lrbox}{\defsbox}% -\setlength\defwidth\linewidth -\addtolength\defwidth{-2\fboxrule}% -\addtolength\defwidth{-2\fboxsep}% -\begin{minipage}{\defwidth}\flushleft -}{% -\end{minipage} -\end{lrbox}% -\vskip10pt -\noindent -\defarg\fcolorbox{black}{defbackground}{\usebox\defsbox}% -\vskip10pt -\noindent -\ignorespacesafterend -} -} -{ -\usepackage{html} -\usepackage{makeidx} -\renewcommand{\LaTeX}{LaTeX} -\renewcommand{\LaTeXe}{LaTeX2e} -\newcommand*{\termdef}[1]{\emph{#1}\index{#1}} -\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}} -\newenvironment{important}{}{} -\newcommand*{\tick}{X} - -\newcommand{\DescribeOption}[1]{} -\newcommand{\DescribeGlsKey}[1]{} -\newcommand{\DescribeStyle}[1]{} - -\newenvironment{definition}[1][]{\par}{\par} -} +\CheckSum{11106} -\makeatletter -\renewenvironment{theindex}{\twocolumn[\index@prologue] -\let\item\@idxitem -\ignorespaces -}{} -\makeatother +\newcommand*{\tick}{\ding{51}} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{first use\ifirstuse} \newcommand*{\firstuseflag}{first use flag\ifirstuseflag} \newcommand*{\firstusetext}{first use text\ifirstusetext} -\ifmakedtx{ + \newcommand*{\ifirstuseflag}{\iterm{first use>flag}} \newcommand*{\ifirstusetext}{\iterm{first use>text}} -\newcommand*{\istkey}[1]{\texttt{#1}\index{makeindex=\texttt{makeindex}>#1=\texttt{#1}|hyperpage}} + +\newcommand*{\istkey}[1]{\appfmt{#1}\index{makeindex=\appfmt{makeindex}>#1=\texttt{#1}|hyperpage}} \newcommand*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}} -\newcommand*{\ics}[1]{\texttt{\char`\\#1}\SpecialMainIndex{#1}} -\newcommand*{\appname}[1]{\texttt{#1}\index{#1=\texttt{#1}|hyperpage}} -\newcommand*{\mkidxspch}{\index{makeindex=\texttt{makeindex}>special characters|hyperpage}} -\newcommand*{\igloskey}[2][newglossaryentry]{\index{#1 options=\cs{#1} options>#2=\textsf{#2}|hyperpage}} -\newcommand*{\gloskey}[2][newglossaryentry]{\textsf{#2}\igloskey[#1]{#2}} -\newcommand*{\pkgoptni}[1]{\textsf{#1}} -\newcommand*{\ipkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\index{package options:>#2={\protect\ttfamily #2}|main}}{% -\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily #1}|main}}} -\newcommand*{\pkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\pkgoptni{#2}\index{package options:>#2={\protect\ttfamily #2}|main}}{% -\pkgoptni{#2=#1}\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily #1}|main}}} -\newcommand*{\pkgoptval}[2]{\pkgoptni{#1}\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily#1}|main}} +\newcommand*{\mkidxspch}{\index{makeindex=\appfmt{makeindex}>special characters|hyperpage}} + +\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} +\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} + \newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles:>#1={\protect\ttfamily#1}|main}} -\newcommand*{\filetype}[1]{\texttt{#1}\index{file types>#1|hyperpage}} -\newcommand*{\sty}[1]{\textsf{#1}} -\newcommand*{\isty}[1]{\sty{#1}\index{#1 package=\sty{#1} package|hyperpage}} -\newcommand*{\cls}[1]{\textsf{#1}} -\newcommand*{\icls}[1]{\cls{#1}\index{#1 class=\cls{#1} class|hyperpage}} -\newcommand*{\envname}[1]{\textsf{#1}} -} -{ -\newcommand*{\ifirstuseflag}{\iterm{first use!flag}} -\newcommand*{\ifirstusetext}{\iterm{first use!text}} -\newcommand{\istkey}[1]{\texttt{#1}\index{makeindex key!#1}} -\newcommand{\locfmt}[1]{\texttt{#1}\index{#1@\cs{#1}}} -\newcommand{\ics}[1]{\texttt{\char`\\#1}\index{#1@\cs{#1}}} -\html{\newcommand{\SpecialMainIndex}[1]{\index{#1@\cs{#1}}}} -\newcommand{\appname}[1]{\texttt{#1}\index{#1@\texttt{#1}}} -\newcommand*{\mkidxspch}{\index{makeindex@\texttt{makeindex}!special characters|hyperpage}} -\newcommand{\gloskey}[2][newglossaryentry]{\texttt{#2}\index{#1 keys@\cs{#1} keys!#2}} -\newcommand*{\pkgoptni}[1]{\texttt{#1}} -\newcommand{\ipkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\index{package options!#2}}{% -\index{package options!#2!#1}}} -\newcommand{\pkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\pkgoptni{#2}\index{package options!#2}}{% -\pkgoptni{#2=#1}\index{package options!#2!#1}}} -\newcommand{\pkgoptval}[2]{\pkgoptni{#1}\index{package options!#2!#1}} -\newcommand{\glostyle}[1]{\texttt{#1}\index{glossary styles!#1}} -\newcommand{\filetype}[1]{\texttt{#1}\index{file types!#1}} -\newcommand{\sty}[1]{\texttt{#1}} -\newcommand{\isty}[1]{\sty{#1}\index{#1@\sty{#1}}} -\newcommand{\cls}[1]{\texttt{#1}} -\newcommand{\icls}[1]{\cls{#1}\index{#1@\cls{#1}}} -\newcommand{\envname}[1]{\texttt{#1}} -\newcommand{\toTop}{\mbox{}\par\htmlref{Top}{top}} -} -\begin{document}\ifmakedtx{}{\label{top}} + +\begin{document} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{glossaries.sty v 2.05: \LaTeXe\ Package to Assist Generating Glossaries} + \title{glossaries.sty v2.06: + \LaTeXe\ Package to Assist Generating Glossaries} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -180,111 +52,125 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{6th Feb 2010} + \date{2010-06-14} \maketitle + +This is the user manual for the \styfmt{glossaries} package. Other +documents accompanying this manual: +\begin{itemize} +\item \qtdocref{The glossaries package: a guide for beginners}{glossariesbegin} +\item \qtdocref{Upgrading from the glossary package to the +glossaries package}{glossary2glossaries} +\end{itemize} +See the file \texttt{INSTALL} for installation instructions. +Related web resources: +\begin{itemize} +\item +\urlfootref{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}{The glossaries FAQ} + +\item +\urlfootref{http://www.latex-community.org/index.php?option=com_content&view=article&id=263&Itemid=114}{Glossaries, +Nomenclature, Lists of Symbols and Acronyms } +\end{itemize} + +\clearpage \tableofcontents \section{Introduction} \changes{1.0}{2007 May 16}{Initial version} -The \sty{glossaries} package is provided to assist generating -glossaries. It has a certain amount of flexibility, allowing the +The \styfmt{glossaries} package is provided to assist generating +glossaries. It has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple -glossaries. It also supports acronyms and glossary styles that +glossaries. It also supports acronyms and glossary styles that include symbols (in addition to a name and description) for glossary -entries. There is provision for loading a database of glossary terms. -Only those terms used\footnote{that is, if the term has been -referenced using any of the commands described in \ifmakedtx{\autoref{sec:glslink}}{% -\htmlref{Links to Glossary Entries}{sec:glslink}}, -\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an Entry to the -Glossary Without Generating Text}{sec:glsadd}} or -via \ics{glssee} (or the \gloskey{see} key)} in the document will be +entries. There is provision for loading a database of glossary +terms. Only those terms used\footnote{that is, if the term has been +referenced using any of the commands described in +\sectionref{sec:glslink}, \sectionref{sec:glsadd} or via +\ics{glssee} (or the \gloskey{see} key)} in the document will be added to the glossary. -\textbf{This package replaces the \isty{glossary} package which is -now obsolete.} Please see -\ifmakedtx{the document \dq{Upgrading from the glossary package to -the glossaries package} (\href{glossary2glossaries.pdf}{glossary2glossaries.pdf})}{\htmladdnormallink{Upgrading from the glossary package -to the glossaries package}{glossary2glossaries.html}} -for assistance in upgrading. +\textbf{This package replaces the \sty{glossary} package which is +now obsolete.} Please see the document \qtdocref{Upgrading from the +glossary package to the glossaries package}{glossary2glossaries} for +assistance in upgrading. One of the strengths of this package is its flexibility, however the drawback of this is the necessity of having a large manual that can cover all the various settings. If you are daunted by the size of the manual, try starting off with the much shorter -\ifmakedtx{guide for beginners (\href{glossariesbegin.pdf}{glossariesbegin.pdf})}{% -\htmladdnormallink{guide for beginners}{glossariesbegin.html}}. +\docref{guide for beginners}{glossariesbegin}. \begin{important} -The \sty{glossaries} package comes with a -\htmladdnormallink{Perl}{http://www.perl.org/about.html} script -called \appname{makeglossaries}. This provides a convenient interface -to \appname{makeindex} or \appname{xindy}. It is strongly -recommended that you use this script, but \emph{it is not -essential}. If you are reluctant to install Perl, or for any -other reason you don't want to use \appname{makeglossaries}, you -can called \appname{makeindex} or \appname{xindy} explicitly. -See \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the -Associated Glossary Files}{sec:makeglossaries}} for +The \styfmt{glossaries} package comes with a +\href{http://www.perl.org/about.html}{Perl} script called +\app{makeglossaries}. This provides a convenient interface to +\app{makeindex} or \app{xindy}. It is strongly recommended +that you use this script, but \emph{it is not essential}. If you are +reluctant to install Perl, or for any other reason you don't want to +use \app{makeglossaries}, you can called \app{makeindex} or +\app{xindy} explicitly. See \sectionref{sec:makeglossaries} for further details. \end{important} This manual is structured as follows: \begin{itemize} -\item \ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview of Main User Commands}{sec:overview}} -gives an overview of the main user commands and their syntax. - -\item \ifmakedtx{\autoref{sec:mfirstuc}}{\htmlref{Mfirstuc}{sec:mfirstuc}} -describes the associated \sty{mfirstuc} package. - -\ifmakedtx{\item -\autoref{sec:code} contains the documented source code for those who -want to know more about how the package works. This describes more -advanced commands, such as determining if an entry or a glossary -exists and commands that iterate through defined terms or glossaries. - -\item \autoref{sec:code:mfirstuc} contains the documented code for -the \sty{mfirstuc} package.}{} +\item \sectionref{sec:overview} gives an overview of the main user +commands and their syntax. + +\item \sectionref{sec:mfirstuc} describes the associated +\styfmt{mfirstuc} package. + +\ifpdf + \item \sectionref{sec:code} contains the documented source code for + those who want to know more about how the package works. This + describes more advanced commands, such as determining if an entry or + a glossary exists and commands that iterate through defined terms or + glossaries. + + \item \sectionref{sec:code:mfirstuc} contains the documented code for + the \styfmt{mfirstuc} package. +\fi \end{itemize} -\ifmakedtx{}{The \htmladdnormallink{PDF version}{glossaries.pdf} of -this manual also describes more advanced commands in the documented -code section (such as determining if an entry or a glossary exists -and commands that iterate through defined terms or glossaries).} +\ifpdf +\else + The \href{glossaries.pdf}{PDF version} of this manual also describes + more advanced commands in the documented code section (such as + determining if an entry or a glossary exists and commands that + iterate through defined terms or glossaries). +\fi \noindent The remainder of this introductory section covers the following: \begin{itemize} -\item \ifmakedtx{\autoref{sec:samples}}{\htmlref{Sample -Documents}{sec:samples}} lists the sample documents provided +\item \sectionref{sec:samples} lists the sample documents provided with this package. -\item \ifmakedtx{\autoref{sec:languages}}{\htmlref{Multi-Lingual -Support}{sec:languages}} provides information for users who +\item \sectionref{sec:languages} provides information for users who wish to write in a language other than English. -\item \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating -the Associated Glossary Files}{sec:makeglossaries}} -describes how to use a post-processor to create the sorted glossaries -for your document. +\item \sectionref{sec:makeglossaries} describes how to use a +post-processor to create the sorted glossaries for your document. -\item \ifmakedtx{\autoref{sec:trouble}}{\htmlref{Troubleshooting}{sec:trouble}} provides some assistance in the event that you -encounter a problem. +\item \sectionref{sec:trouble} provides some assistance in the event +that you encounter a problem. \end{itemize} -\ifmakedtx{}{\toTop} + \subsection{Sample Documents} \label{sec:samples} -The \sty{glossaries} package is provided with some sample +The \styfmt{glossaries} package is provided with some sample documents that illustrate the various functions. These should be located in the \texttt{samples} subdirectory (folder) of the -\sty{glossaries} documentation directory. This location varies +\styfmt{glossaries} documentation directory. This location varies according to your operating system and \TeX\ distribution. You can use \texttt{texdoc} to locate the main glossaries documentation. For example, in a terminal or command prompt, type: -\begin{verbatim} +\begin{prompt} texdoc -l glossaries -\end{verbatim} +\end{prompt} This should display the full pathname of the file \texttt{glossaries.pdf}. View the contents of that directory and see if it contains the \texttt{samples} subdirectory. @@ -292,20 +178,21 @@ see if it contains the \texttt{samples} subdirectory. If you can't find the sample files, they are available in the subdirectory \texttt{doc/latex/glossaries/samples/} in the \texttt{glossaries.tds.zip} archive which can be downloaded from -\ifmakedtx{\href{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}{CTAN}}{\htmladdnormallink{CTAN}{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}}. +\href{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}{CTAN}. The sample documents are as follows: \begin{description} -\item[minimalgls.tex]\label{ex:minimalgls} This document is a minimal working example. -You can test your installation using this file. To create the -complete document you will need to do the following steps: +\item[minimalgls.tex]\label{ex:minimalgls} This document is a +minimal working example. You can test your installation using this +file. To create the complete document you will need to do the +following steps: \begin{enumerate} \item Run \texttt{minimalgls.tex} through \LaTeX\ either by typing -\begin{verbatim} +\begin{prompt} latex minimalgls -\end{verbatim} +\end{prompt} in a terminal or by using the relevant button or menu item in your text editor or front-end. This will create the required associated files but you will not see the glossary. If you use @@ -313,31 +200,29 @@ latex minimalgls references. These warnings may be ignored on the first run. If you get a \verb"Missing \begin{document}" error, then - it's most likely that your version of \isty{xkeyval} is + it's most likely that your version of \sty{xkeyval} is out of date. Check the log file for a warning of that nature. - If this is the case, you will need to update the \sty{xkeyval} + If this is the case, you will need to update the \styfmt{xkeyval} package. - \item Run \appname{makeglossaries} on the document. This can + \item Run \app{makeglossaries} on the document. This can be done on a terminal either by typing -\begin{verbatim} +\begin{prompt} makeglossaries minimalgls -\end{verbatim} +\end{prompt} or by typing -\begin{verbatim} +\begin{prompt} perl makeglossaries minimalgls -\end{verbatim} +\end{prompt} If your system doesn't recognise the command \texttt{perl} then it's likely you don't have Perl installed. In which case you - will need to use \appname{makeindex} directly. You can do this + will need to use \app{makeindex} directly. You can do this in a terminal by typing (all on one line): -\begin{verbatim} -makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls -minimalgls.glo -\end{verbatim} - (See -\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{later}{sec:makeindexapp}} - for further details on using \appname{makeindex} explicitly.) +\begin{prompt} +makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo +\end{prompt} + (See \sectionref{sec:makeindexapp} for further details on using + \app{makeindex} explicitly.) Note that if you need to specify the full path and the path contains spaces, you will need to delimit the file names with @@ -349,266 +234,273 @@ You should now have a complete document. The number following each entry in the glossary is the location number. By default, this is the page number where the entry was referenced. -\item[sample4col.tex]\label{ex:sample4col} This document illustrates a four column -glossary where the entries have a symbol in addition to the -name and description. To create the complete document, you need -to do: -\begin{verbatim} +\item[sample4col.tex]\label{ex:sample4col} This document illustrates +a four column glossary where the entries have a symbol in addition +to the name and description. To create the complete document, you +need to do: +\begin{prompt} latex sample4col makeglossaries sample4col latex sample4col -\end{verbatim} -As before, if you don't have Perl installed, you will need to -use \appname{makeindex} directly instead of using -\appname{makeglossaries}. The vertical gap between entries -is the gap created at the start of each group. This can be -suppressed by redefining \ics{glsgroupskip} after the glossary -style has been set: +\end{prompt} +As before, if you don't have Perl installed, you will need to use +\app{makeindex} directly instead of using +\app{makeglossaries}. The vertical gap between entries is the +gap created at the start of each group. This can be suppressed by +redefining \ics{glsgroupskip} after the glossary style has been set: \begin{verbatim} \renewcommand*{\glsgroupskip}{} \end{verbatim} -\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some sample acronyms. It -also adds the glossary to the table of contents, so an extra -run through \LaTeX\ is required to ensure the document is up to date: -\begin{verbatim} +\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some +sample acronyms. It also adds the glossary to the table of contents, +so an extra run through \LaTeX\ is required to ensure the document +is up to date: +\begin{prompt} latex sampleAcr makeglossaries sampleAcr latex sampleAcr latex sampleAcr -\end{verbatim} +\end{prompt} -\item[sampleAcrDesc.tex]\label{ex:sampleAcrDesc} This is similar to the previous example, -except that the acronyms have an associated description. As with -the previous example, the glossary is added to the table of -contents, so an extra run through \LaTeX\ is required: -\begin{verbatim} +\item[sampleAcrDesc.tex]\label{ex:sampleAcrDesc} This is similar to +the previous example, except that the acronyms have an associated +description. As with the previous example, the glossary is added to +the table of contents, so an extra run through \LaTeX\ is required: +\begin{prompt} latex sampleAcrDesc makeglossaries sampleAcrDesc latex sampleAcrDesc latex sampleAcrDesc -\end{verbatim} - -\item[sampleDesc.tex]\label{ex:sampleDesc} This is similar to the previous example, -except that it defines the acronyms using \ics{newglossaryentry} -instead of \ics{newacronym}. As with -the previous example, the glossary is added to the table of -contents, so an extra run through \LaTeX\ is required: -\begin{verbatim} +\end{prompt} + +\item[sampleDesc.tex]\label{ex:sampleDesc} This is similar to the +previous example, except that it defines the acronyms using +\ics{newglossaryentry} instead of \ics{newacronym}. As with the +previous example, the glossary is added to the table of contents, so +an extra run through \LaTeX\ is required: +\begin{prompt} latex sampleDesc makeglossaries sampleDesc latex sampleDesc latex sampleDesc -\end{verbatim} - -\item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how to load -external files containing the glossary definitions. It also -illustrates how to define a new glossary type. This document -has the \term{number list} suppressed and uses \ics{glsaddall} to add -all the entries to the glossaries without referencing each one +\end{prompt} + +\item[sample-custom-acronym.tex]\label{ex:sample-custom-acronym} +This document illustrates how to define your own acronym style if +the predefined styles don't suit your requirements. +\begin{prompt} +latex sample-custom-acronym +makeglossaries sample-custom-acronym +latex sample-custom-acronym +\end{prompt} + +\item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how +to load external files containing the glossary definitions. It also +illustrates how to define a new glossary type. This document has the +\term{number list} suppressed and uses \ics{glsaddall} to add all +the entries to the glossaries without referencing each one explicitly. To create the document do: -\begin{verbatim} +\begin{prompt} latex sampleDB makeglossaries sampleDB latex sampleDB -\end{verbatim} -The glossary definitions are stored in the accompanying files -\texttt{database1.tex} and \texttt{database2.tex}. Note that if -you don't have Perl installed, you will need to use -\appname{makeindex} twice instead of a single call to -\appname{makeglossaries}: +\end{prompt} +The glossary definitions are stored in the accompanying files +\texttt{database1.tex} and \texttt{database2.tex}. Note that if you +don't have Perl installed, you will need to use \app{makeindex} +twice instead of a single call to \app{makeglossaries}: \begin{enumerate} \item Create the main glossary: -\begin{verbatim} +\begin{prompt} makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -\end{verbatim} +\end{prompt} \item Create the secondary glossary: -\begin{verbatim} +\begin{prompt} makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn -\end{verbatim} +\end{prompt} \end{enumerate} -\item[sampleEq.tex]\label{ex:sampleEq} This document illustrates how to change the -location to something other than the page number. In this case, -the \texttt{equation} counter is used since all glossary entries -appear inside an \envname{equation} environment. To create the -document do: -\begin{verbatim} +\item[sampleEq.tex]\label{ex:sampleEq} This document illustrates how +to change the location to something other than the page number. In +this case, the \texttt{equation} counter is used since all glossary +entries appear inside an \env{equation} environment. To create +the document do: +\begin{prompt} latex sampleEq makeglossaries sampleEq latex sampleEq -\end{verbatim} +\end{prompt} -\item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the previous example, -but the number lists\iterm{number list} are a mixture of page -numbers and equation numbers. This example adds the glossary to the -table of contents, so an extra \LaTeX\ run is required: -\begin{verbatim} +\item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the +previous example, but the number lists\iterm{number list} are a +mixture of page numbers and equation numbers. This example adds the +glossary to the table of contents, so an extra \LaTeX\ run is +required: +\begin{prompt} latex sampleEqPg makeglossaries sampleEqPg latex sampleEqPg latex sampleEqPg -\end{verbatim} - -\item[sampleSec.tex]\label{ex:sampleSec} This document also illustrates how to change -the location to something other than the page number. In this case, -the \texttt{section} counter is used. This example adds the -glossary to the table of contents, so an extra \LaTeX\ run is -required: -\begin{verbatim} +\end{prompt} + +\item[sampleSec.tex]\label{ex:sampleSec} This document also +illustrates how to change the location to something other than the +page number. In this case, the \texttt{section} counter is used. +This example adds the glossary to the table of contents, so an extra +\LaTeX\ run is required: +\begin{prompt} latex sampleSec makeglossaries sampleSec latex sampleSec latex sampleSec -\end{verbatim} +\end{prompt} -\item[sampleNtn.tex]\label{ex:sampleNtn} This document illustrates how to create -an additional glossary type. This example adds the glossary to the -table of contents, so an extra \LaTeX\ run is required: -\begin{verbatim} +\item[sampleNtn.tex]\label{ex:sampleNtn} This document illustrates +how to create an additional glossary type. This example adds the +glossary to the table of contents, so an extra \LaTeX\ run is +required: +\begin{prompt} latex sampleNtn makeglossaries sampleNtn latex sampleNtn latex sampleNtn -\end{verbatim} +\end{prompt} Note that if you don't have Perl installed, you will need to use -\appname{makeindex} twice instead of a single call to -\appname{makeglossaries}: +\app{makeindex} twice instead of a single call to +\app{makeglossaries}: \begin{enumerate} \item Create the main glossary: -\begin{verbatim} +\begin{prompt} makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -\end{verbatim} +\end{prompt} \item Create the secondary glossary: -\begin{verbatim} +\begin{prompt} makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn -\end{verbatim} +\end{prompt} \end{enumerate} -\item[sample.tex]\label{ex:sample} This document illustrates some of the basics, -including how to create child entries that use the same name as the -parent entry. This example adds the glossary to the table of -contents, so an extra \LaTeX\ run is required: -\begin{verbatim} +\item[sample.tex]\label{ex:sample} This document illustrates some of +the basics, including how to create child entries that use the same +name as the parent entry. This example adds the glossary to the +table of contents, so an extra \LaTeX\ run is required: +\begin{prompt} latex sample makeglossaries sample latex sample latex sample -\end{verbatim} -You can see the difference between word and letter ordering -if you substitute \pkgopt[word]{order} with -\pkgopt[letter]{order}. (Note that this will only have an -effect if you use \appname{makeglossaries}. If you use -\appname{makeindex} explicitly, you will need to use the -\texttt{-l} switch to indicate letter ordering.) - -\item[sampletree.tex]\label{ex:sampletree} This document illustrates a hierarchical -glossary structure where child entries have different names -to their corresponding parent entry. To create the document do: -\begin{verbatim} +\end{prompt} +You can see the difference between word and letter ordering if you +substitute \pkgopt[word]{order} with \pkgopt[letter]{order}. (Note +that this will only have an effect if you use +\app{makeglossaries}. If you use \app{makeindex} explicitly, +you will need to use the \texttt{-l} switch to indicate letter +ordering.) + +\item[sampletree.tex]\label{ex:sampletree} This document illustrates +a hierarchical glossary structure where child entries have different +names to their corresponding parent entry. To create the document +do: +\begin{prompt} latex sampletree makeglossaries sampletree latex sampletree -\end{verbatim} +\end{prompt} -\item[samplexdy.tex]\label{ex:samplexdy} This document illustrates how to use the -\sty{glossaries} package with \appname{xindy} instead of -\appname{makeindex}. The document uses UTF8 encoding (with the -\isty{inputenc} package). The encoding is picked up by -\appname{makeglossaries}. By default, this document will create -a \appname{xindy} style file called \texttt{samplexdy.xdy}, but -if you uncomment the lines +\item[samplexdy.tex]\label{ex:samplexdy} This document illustrates +how to use the \styfmt{glossaries} package with \app{xindy} instead +of \app{makeindex}. The document uses UTF8 encoding (with the +\sty{inputenc} package). The encoding is picked up by +\app{makeglossaries}. By default, this document will create a +\app{xindy} style file called \texttt{samplexdy.xdy}, but if you +uncomment the lines \begin{verbatim} \setStyleFile{samplexdy-mc} \noist \GlsSetXdyLanguage{} \end{verbatim} it will set the style file to \texttt{samplexdy-mc.xdy} instead. -This provides an additional letter group for entries starting -with \dq{Mc} or \dq{Mac}. If you use \appname{makeglossaries}, -you don't need to supply any additional information. If you -don't use \appname{makeglossaries}, you will need to specify the -required information. Note that if you set the style file to -\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, -otherwise the \sty{glossaries} package will overwrite -\texttt{samplexdy-mc.xdy} and you will lose the \dq{Mc} letter group. +This provides an additional letter group for entries starting with +\qt{Mc} or \qt{Mac}. If you use \app{makeglossaries}, you don't +need to supply any additional information. If you don't use +\app{makeglossaries}, you will need to specify the required +information. Note that if you set the style file to +\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, +otherwise the \styfmt{glossaries} package will overwrite +\texttt{samplexdy-mc.xdy} and you will lose the \qt{Mc} letter +group. To create the document do: -\begin{verbatim} +\begin{prompt} latex samplexdy makeglossaries samplexdy latex samplexdy -\end{verbatim} +\end{prompt} If you don't have Perl installed, you will have to call -\appname{xindy} explicitly instead of using \appname{makeglossaries}. +\app{xindy} explicitly instead of using \app{makeglossaries}. If you are using the default style file \texttt{samplexdy.xdy}, then do (no line breaks): -\begin{verbatim} -xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg --o samplexdy.gls samplexdy.glo -\end{verbatim} +\begin{prompt} +xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo +\end{prompt} otherwise, if you are using \texttt{samplexdy-mc.xdy}, then do (no line breaks): -\begin{verbatim} -xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls -samplexdy.glo -\end{verbatim} - -\item[sampleutf8.tex]\label{ex:sampleutf8} This is another example that uses -\appname{xindy}. Unlike \appname{makeindex}, \appname{xindy} can -cope with accented or non-Latin characters. This document uses -UTF8 encoding. To create the document do: -\begin{verbatim} +\begin{prompt} +xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo +\end{prompt} + +\item[sampleutf8.tex]\label{ex:sampleutf8} This is another example +that uses \app{xindy}. Unlike \app{makeindex}, +\app{xindy} can cope with accented or non-Latin characters. This +document uses UTF8 encoding. To create the document do: +\begin{prompt} latex sampleutf8 makeglossaries sampleutf8 latex sampleutf8 -\end{verbatim} -If you don't have Perl installed, you will have to call -\appname{xindy} explicitly instead of using \appname{makeglossaries} +\end{prompt} +If you don't have Perl installed, you will have to call +\app{xindy} explicitly instead of using \app{makeglossaries} (no line breaks): -\begin{verbatim} -xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg --o sampleutf8.gls sampleutf8.glo -\end{verbatim} +\begin{prompt} +xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +\end{prompt} If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} and do: -\begin{verbatim} +\begin{prompt} latex sampleutf8 makeglossaries sampleutf8 latex sampleutf8 -\end{verbatim} +\end{prompt} you will see that the entries that start with a non-Latin character -now appear in the symbols group, and the word \dq{man\oe uvre} is now -after \dq{manor} instead of before it. If you are unable to use -\appname{makeglossaries}, the call to \appname{makeindex} is as +now appear in the symbols group, and the word \qt{man\oe uvre} is now +after \qt{manor} instead of before it. If you are unable to use +\app{makeglossaries}, the call to \app{makeindex} is as follows (no line breaks): -\begin{verbatim} -makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls -sampleutf8.glo -\end{verbatim} +\begin{prompt} +makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +\end{prompt} \item[sampleaccsupp.tex]\label{ex:sampleaccsupp} This document -uses the experimental \isty{glossaries-accsupp} package. The +uses the experimental \sty{glossaries-accsupp} package. The symbol is set to the replacement text. Note that some PDF viewers don't use the accessibility support. Information -about the \sty{glossaries-accsupp} package can be found in -\ifmakedtx{\autoref{sec:accsupp}}{\htmlref{\dq{Accessibility Support}}{sec:accsupp}}. - +about the \styfmt{glossaries-accsupp} package can be found in +\sectionref{sec:accsupp}. \end{description} -\ifmakedtx{}{\toTop} + \subsection{Multi-Lingual Support} \label{sec:languages} -As from version 1.17, the \sty{glossaries} package can now be -used with \appname{xindy} as well as \appname{makeindex}. If you +As from version 1.17, the \styfmt{glossaries} package can now be +used with \app{xindy} as well as \app{makeindex}. If you are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use \appname{xindy} -as \appname{makeindex} is hard-coded for Latin languages. This +non-Latin characters it is recommended that you use \app{xindy} +as \app{makeindex} is hard-coded for Latin languages. This means that you are not restricted to the A, \ldots, Z letter groups. -If you want to use \appname{xindy}, remember to use the +If you want to use \app{xindy}, remember to use the \pkgopt{xindy} package option. For example: \begin{verbatim} \documentclass[frenchb]{article} @@ -629,26 +521,26 @@ description={select group or class}} \end{verbatim} \end{important} -If you use the \isty{inputenc} package, \appname{makeglossaries} +If you use the \sty{inputenc} package, \app{makeglossaries} will pick up the encoding from the auxiliary file. If you use -\appname{xindy} explicitly instead of via \appname{makeglossaries}, +\app{xindy} explicitly instead of via \app{makeglossaries}, you may need to specify the encoding using the \texttt{-C} -option. Read the \appname{xindy} manual for further details. +option. Read the \app{xindy} manual for further details. \subsubsection{Changing the Fixed Names} \label{sec:fixednames} -As from version 1.08, the \sty{glossaries} package now has +As from version 1.08, the \styfmt{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} or \isty{polyglossia} \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. However, +However you must load \sty{babel} or \sty{polyglossia} \emph{before} +\styfmt{glossaries} to enable this. Note that if \sty{babel} is loaded +and the \sty{translator} package is detected on \TeX's path, then the +\sty{translator} package will be loaded automatically. However, it may not pick up on the required languages so, if the predefined text is not translated, you may need to explicitly load the -\isty{translator} package with the required languages. For example: +\sty{translator} package with the required languages. For example: \begin{verbatim} \usepackage[spanish]{babel} \usepackage[spanish]{translator} @@ -663,8 +555,8 @@ than a package option. For example: \usepackage{glossaries} \end{verbatim} -If you want to use \isty{ngerman} or \isty{german} instead -of \isty{babel}, you will need to include the \isty{translator} package +If you want to use \sty{ngerman} or \sty{german} instead +of \sty{babel}, you will need to include the \sty{translator} package to provide the translations. For example: \begin{verbatim} \documentclass[ngerman]{article} @@ -673,8 +565,13 @@ to provide the translations. For example: \usepackage{glossaries} \end{verbatim} -The following languages are currently supported by the -\sty{glossaries} package: +The languages are currently supported by the +\styfmt{glossaries} package are listed in +\tableref{tab:supportedlanguages}. + +\begin{table}[htbp] +\caption{Supported Languages} +\label{tab:supportedlanguages} \begin{center} \begin{tabular}{lc} \bfseries Language & \bfseries As from version\\ @@ -688,10 +585,13 @@ Irish & 1.08\\ Italian & 1.08\\ Hungarian & 1.08\\ Polish & 1.13\\ +Serbian & 2.06\\ Spanish & 1.08 \end{tabular} \end{center} -The language dependent commands and \isty{translator} keys used by the +\end{table} + +The language dependent commands and \sty{translator} keys used by the glossaries package are listed in \tableref{tab:predefinednames}. \begin{table}[htbp] @@ -726,24 +626,23 @@ this option. \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 you can -provide your own dictionary with the necessary modifications -(using \cs{deftranslation}) and load it using -\cs{usedictionary}. Note that the dictionaries are loaded at the -beginning of the document, so it won't have any effect if you +predefined translations may not be appropriate. If you are using the +\sty{babel} package and do not have the \sty{translator} package +installed, you need to be familiar with the advice given in +\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing +the words babel uses}. If you have the \sty{translator} package +installed, then you can provide your own dictionary with the +necessary modifications (using \cs{deftranslation}) and load it +using \cs{usedictionary}. Note that the dictionaries are loaded at +the beginning of the document, so it won't have any effect if you put \cs{deftranslation} in the preamble. It should be put in your -personal dictionary instead. See the \isty{translator} -documentation for further details. +personal dictionary instead. See the \sty{translator} documentation +for further details. -If you are using \isty{babel} and don't want to use the -\isty{translator} interface, you can suppress it using the package +If you are using \sty{babel} and don't want to use the +\sty{translator} interface, you can suppress it using the package option \pkgopt[false]{translate}, and either load -\isty{glossaries-babel} after \sty{glossaries} or specify you're own +\sty{glossaries-babel} after \styfmt{glossaries} or specify you're own translations. For example: \begin{verbatim} \documentclass[british]{article} @@ -771,16 +670,15 @@ or: } \end{verbatim} -If you are using \isty{polyglossia} instead of \isty{babel}, -\isty{glossaries-polyglossia} will automatically be loaded unless +If you are using \sty{polyglossia} instead of \sty{babel}, +\sty{glossaries-polyglossia} will automatically be loaded unless you specify the package option \pkgopt[false]{translate}. -Note that \appname{xindy} provides much better multi-lingual -support than \appname{makeindex}, so it's recommended that you -use \appname{xindy} if you have glossary entries that contain -accented characters or non-Roman letters. See -\ifmakedtx{\autoref{sec:xindy}}{\htmladdnormallink{Xindy}{sec:xindy}} -for further details.\ifmakedtx{}{\toTop} +Note that \app{xindy} provides much better multi-lingual support +than \app{makeindex}, so it's recommended that you use \app{xindy} +if you have glossary entries that contain diacritics or +non-Roman letters. See \sectionref{sec:xindy} for further +details. \subsection{Generating the Associated Glossary Files} \label{sec:makeglossaries} @@ -788,47 +686,41 @@ for further details.\ifmakedtx{}{\toTop} In order to generate a sorted glossary with compact location lists, it is necessary to use an external indexing application as an intermediate step. It is this application that creates the file -containing the code that typesets the glossary. If this step -is omitted, the glossaries will not appear in your document. The -two indexing applications that are most commonly used with -\LaTeX\ are \appname{makeindex} and \appname{xindy}. As -from version 1.17, the \sty{glossaries} package can be used -with either of these applications. Previous versions were designed -to be used with \appname{makeindex} only. Note that -\appname{xindy} has much better multi-lingual support than -\appname{makeindex}, so \appname{xindy} is recommended if you're -not writing in English. Commands that only have an -effect when \appname{xindy} is used are described -\ifmakedtx{in \autoref{sec:xindy}}{\htmlref{later}{sec:xindy}}. - - -The \sty{glossaries} package comes with the Perl script -\appname{makeglossaries} which will run \appname{makeindex} or -\appname{xindy} on all the glossary files using a customized style -file (which is created by \ics{makeglossaries}). See -\ifmakedtx{\autoref{sec:makeglossariesapp}}{\htmlref{Using the -makeglossaries Perl script}{sec:makeglossariesapp}} for further +containing the code that typesets the glossary. If this step is +omitted, the glossaries will not appear in your document. The two +indexing applications that are most commonly used with \LaTeX\ are +\app{makeindex} and \app{xindy}. As from version 1.17, the +\styfmt{glossaries} package can be used with either of these +applications. Previous versions were designed to be used with +\app{makeindex} only. Note that \app{xindy} has much better +multi-lingual support than \app{makeindex}, so \app{xindy} is +recommended if you're not writing in English. Commands that only +have an effect when \app{xindy} is used are described in +\sectionref{sec:xindy}. + + +The \styfmt{glossaries} package comes with the Perl script +\app{makeglossaries} which will run \app{makeindex} or \app{xindy} +on all the glossary files using a customized style file (which is +created by \ics{makeglossaries}). See +\sectionref{sec:makeglossariesapp} for further details. Perl is stable, cross-platform, open source software that is used by a number of \TeX-related applications. Further -information is available at \url{http://www.perl.org/about.html}. +information is available at \url{http://www.perl.org/about.html}. However, whilst it is strongly recommended that you use the -\appname{makeglossaries} script, it is possible to use the -\sty{glossaries} package without having Perl installed. In which +\app{makeglossaries} script, it is possible to use the +\styfmt{glossaries} package without having Perl installed. In which case, if you have used the \pkgopt{xindy} package option, you will -need to use \appname{xindy} (see -\ifmakedtx{\autoref{sec:xindyapp}}{\htmlref{Using xindy -explicitly}{sec:xindyapp}}), otherwise you will need to use -\appname{makeindex} (see -\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{Using makeindex -explicitly}{sec:makeindexapp}}). Note that some commands and -package options have no effect if you don't use -\appname{makeglossaries}. These are listed in -\tableref{tab:makeglossariesCmds}. +need to use \app{xindy} (see \sectionref{sec:xindyapp}), otherwise +you will need to use \app{makeindex} (see +\sectionref{sec:makeindexapp}). Note that some commands and package +options have no effect if you don't use \app{makeglossaries}. These +are listed in \tableref{tab:makeglossariesCmds}. Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to -do an additional \appname{makeglossaries}, \appname{makeindex} -or \appname{xindy} run, as appropriate. For example, +do an additional \app{makeglossaries}, \app{makeindex} +or \app{xindy} run, as appropriate. For example, suppose you have defined the following entries: \begin{verbatim} \newglossaryentry{citrusfruit}{name={citrus fruit}, @@ -842,18 +734,18 @@ and suppose you have \verb|\gls{citrusfruit}| in your document but don't reference the \texttt{orange} entry, then the \texttt{orange} entry won't appear in your glossary until you first create the glossary and then do another run -of \appname{makeglossaries}, \appname{makeindex} or \appname{xindy}. +of \app{makeglossaries}, \app{makeindex} or \app{xindy}. For example, if the document is called \texttt{myDoc.tex}, then you must do: -\begin{verbatim} +\begin{prompt} latex myDoc makeglossaries myDoc latex myDoc makeglossaries myDoc latex myDoc -\end{verbatim} +\end{prompt} -Likewise, an additional \appname{makeglossaries} and \LaTeX\ run +Likewise, an additional \app{makeglossaries} and \LaTeX\ run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second @@ -862,33 +754,38 @@ means that the number lists\iterm{number list} in the glossary may need updating. The examples in this document assume that you are accessing -\appname{makeglossaries}, \appname{xindy} or \appname{makeindex} via -a terminal. Windows users can use the MSDOS Prompt which -is usually accessed via the -\textsf{Start}\ifmakedtx{$\to$}{-\textgreater}\textsf{All Programs} -menu or -\textsf{Start}\ifmakedtx{$\to$}{-\textgreater}\textsf{All Programs}% -\ifmakedtx{$\to$}{-\textgreater}\textsf{Accessories} -menu. Alternatively, your text editor may have the -facility to create a function that will call the -required application. See your editor's user manual for further -details. +\app{makeglossaries}, \app{xindy} or \app{makeindex} via a terminal. +Windows users can use the MSDOS Prompt which is usually accessed via +the \menu{Start}\submenu{All Programs} menu or +\menu{Start}\submenu{All Programs}\submenu{Accessories} menu. + +Alternatively, your text editor may have the facility to create a +function that will call the required application. The article +\href{http://www.latex-community.org/index.php?option=com_content&view=article\&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{\qt{Glossaries, Nomenclature, List of Symbols and +Acronyms}} +in the \urlfootref{http://www.latex-community.org/}{\LaTeX\ +Community's} Know How section +describes how to do this for TeXnicCenter, and the thread +\href{http://groups.google.com/group/comp.text.tex/browse_thread/thread/edd83831b81b0759?hl=en}{\qt{Executing Glossaries' makeindex from a WinEdt +macro}} on the \texttt{comp.text.tex} newsgroup +describes how to do it for WinEdt. For other editors see the editor's +user manual for further details. If any problems occur, remember to check the transcript files (e.g.\ \filetype{.glg} or \filetype{.alg}) for messages. \begin{table}[htbp] \caption{Commands and package options that have no effect when -using \texttt{xindy} or \texttt{makeindex} explicity} +using \texttt{xindy} or \texttt{makeindex} explicitly} \label{tab:makeglossariesCmds} \vskip\baselineskip \begin{tabular}{@{}lll@{}} -\bfseries Command or Package Option & \appname{makeindex} & -\appname{xindy}\\ +\bfseries Command or Package Option & \app{makeindex} & +\app{xindy}\\ \pkgopt[letter]{order} & use \texttt{-l} & use \texttt{-M ord/letorder}\\ \pkgopt[word]{order} & default & default\\ -\pkgopt{xindy}=\{\pkgoptni{language=}\meta{lang}\pkgoptni{,codename=}\meta{code}\} & +\pkgopt{xindy}=\{\pkgoptfmt{language=}\meta{lang}\pkgoptfmt{,codename=}\meta{code}\} & N/A & use \texttt{-L} \meta{lang} \texttt{-C} \meta{code}\\ \ics{GlsSetXdyLanguage}\marg{lang} & N/A & use \texttt{-L} \meta{lang}\\ @@ -897,66 +794,61 @@ use \texttt{-C} \meta{code} \end{tabular} \par \end{table} -\ifmakedtx{}{\toTop} + \subsubsection{Using the makeglossaries Perl Script} \label{sec:makeglossariesapp} -The \appname{makeglossaries} script picks up the relevant -information from the auxiliary (\filetype{.aux}) file and -will either call \appname{xindy} or \appname{makeindex}, -depending on the supplied information. Therefore, you only need to -pass the document's name without the extension to -\appname{makeglossaries}. -For example, if your document is called \texttt{myDoc.tex}, -type the following in your terminal: -\begin{verbatim} +The \app{makeglossaries} script picks up the relevant information +from the auxiliary (\filetype{.aux}) file and will either call +\app{xindy} or \app{makeindex}, depending on the supplied +information. Therefore, you only need to pass the document's name +without the extension to \app{makeglossaries}. For example, if your +document is called \texttt{myDoc.tex}, type the following in your +terminal: +\begin{prompt} latex myDoc makeglossaries myDoc latex myDoc -\end{verbatim} -You may need to explicitly load \appname{makeglossaries} into -Perl: -\begin{verbatim} +\end{prompt} +You may need to explicitly load \app{makeglossaries} into Perl: +\begin{prompt} perl makeglossaries myDoc -\end{verbatim} -There is a batch file called \texttt{makeglossaries.bat} which -does this for Windows users, but you must have Perl installed to -be able to use it. +\end{prompt} +There is a batch file called \texttt{makeglossaries.bat} which does +this for Windows users, but you must have Perl installed to be able +to use it. -The \appname{makeglossaries} script contains POD (Plain Old +The \app{makeglossaries} script contains POD (Plain Old Documentation). If you want, you can create a man page for -\appname{makeglossaries} using \appname{pod2man} and move the +\app{makeglossaries} using \app{pod2man} and move the resulting file onto the man path. -\ifmakedtx{}{\toTop} + \subsubsection{Using xindy explicitly} \label{sec:xindyapp} -If you want to use \appname{xindy} to process the glossary +If you want to use \app{xindy} to process the glossary files, you must make sure you have used the \pkgopt{xindy} package option: \begin{verbatim} \usepackage[xindy]{glossaries} \end{verbatim} -This is required regardless of whether you use \appname{xindy} +This is required regardless of whether you use \app{xindy} explicitly or whether it's called implicitly via -\appname{makeglossaries}. This causes the glossary -entries to be written in raw \appname{xindy} format, so you need to +\app{makeglossaries}. This causes the glossary +entries to be written in raw \app{xindy} format, so you need to use \texttt{-I xindy} \emph{not} \texttt{-I tex}. -To run \appname{xindy} type the following in your terminal -(all on one line):\\[10pt] -\begin{ttfamily} -xindy -L \textrm{\meta{language}} -C \textrm{\meta{encoding}} -I xindy --M \textrm{\meta{style}} -t \textrm{\meta{base}}.glg\newline --o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo -\end{ttfamily} -\\[10pt] +To run \app{xindy} type the following in your terminal +(all on one line): +\begin{prompt} +xindy -L \meta{language} -C \meta{encoding} -I xindy -M \meta{style} -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo +\end{prompt} where \meta{language} is the required language name, \meta{encoding} is the encoding, \meta{base} is the name of the document without the \filetype{.tex} extension and \meta{style} is the name of the -\appname{xindy} style file without the \filetype{.xdy} extension. +\app{xindy} style file without the \filetype{.xdy} extension. The default name for this style file is \meta{base}\filetype{.xdy} but can be changed via \ics{setStyleFile}\marg{style}. You may need to specify the full path name depending on the current working @@ -966,9 +858,9 @@ them using double-quotes. For example, if your document is called \texttt{myDoc.tex} and you are using UTF8 encoding in English, then type the following in your terminal: -\begin{verbatim} +\begin{prompt} xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo -\end{verbatim} +\end{prompt} Note that this just creates the main glossary. You need to do the same for each of the other glossaries (including the @@ -977,91 +869,92 @@ package option), substituting \filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the relevant extensions. For example, if you have used the \pkgopt{acronym} package option, then you would need to do: -\begin{verbatim} +\begin{prompt} xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn -\end{verbatim} +\end{prompt} For additional glossaries, the extensions are those supplied when you created the glossary with \ics{newglossary}. -Note that if you use \appname{makeglossaries} instead, you can -replace all those calls to \appname{xindy} with just one call -to \appname{makeglossaries}: -\begin{verbatim} +Note that if you use \app{makeglossaries} instead, you can +replace all those calls to \app{xindy} with just one call +to \app{makeglossaries}: +\begin{prompt} makeglossaries myDoc -\end{verbatim} +\end{prompt} Note also that some commands and package options have no effect if -you use \appname{xindy} explicitly instead of using -\appname{makeglossaries}. These are listed in +you use \app{xindy} explicitly instead of using +\app{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. -\ifmakedtx{}{\toTop} + \subsubsection{Using makeindex explicitly} \label{sec:makeindexapp} -If you want to use \appname{makeindex} explicitly, you must +If you want to use \app{makeindex} explicitly, you must make sure that you haven't used the \pkgopt{xindy} package option or the glossary entries will be written in the wrong -format. To run \appname{makeindex}, type the following in -your terminal:\\[10pt] -\begin{ttfamily} -makeindex -s \textrm{\meta{style}}.ist -t \textrm{\meta{base}}.glg --o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo -\end{ttfamily}\\[10pt] +format. To run \app{makeindex}, type the following in +your terminal: +\begin{prompt} +makeindex -s \meta{style}.ist -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo +\end{prompt} where \meta{base} is the name of your document without the \filetype{.tex} extension and \meta{style}\filetype{.ist} is the -name of the \appname{makeindex} style file. By default, this is +name of the \app{makeindex} style file. By default, this is \meta{base}\filetype{.ist}, but may be changed via \ics{setStyleFile}\marg{style}. Note that there are other options, -such as \texttt{-l} (letter ordering). See the \appname{makeindex} +such as \texttt{-l} (letter ordering). See the \app{makeindex} manual for further details. For example, if your document is called \texttt{myDoc.tex}, then type the following at the terminal: -\begin{verbatim} +\begin{prompt} makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo -\end{verbatim} +\end{prompt} Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the \pkgopt{acronym} package option) then you must call -\appname{makeindex} for each glossary, substituting +\app{makeindex} for each glossary, substituting \filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the relevant extensions. For example, if you have used the \pkgopt{acronym} package option, then you need to type the following in your terminal: -\begin{verbatim} +\begin{prompt} makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn -\end{verbatim} +\end{prompt} For additional glossaries, the extensions are those supplied when you created the glossary with \ics{newglossary}. -Note that if you use \appname{makeglossaries} instead, you can -replace all those calls to \appname{makeindex} with just one call -to \appname{makeglossaries}: -\begin{verbatim} +Note that if you use \app{makeglossaries} instead, you can +replace all those calls to \app{makeindex} with just one call +to \app{makeglossaries}: +\begin{prompt} makeglossaries myDoc -\end{verbatim} +\end{prompt} Note also that some commands and package options have no effect if -you use \appname{makeindex} explicitly instead of using -\appname{makeglossaries}. These are listed in +you use \app{makeindex} explicitly instead of using +\app{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. -\ifmakedtx{}{\toTop} + \subsubsection{Note to Front-End and Script Developers} -The information needed to determine whether to use \appname{xindy} -or \appname{makeindex} and the information needed to call those +The information needed to determine whether to use \app{xindy} +or \app{makeindex} and the information needed to call those applications is stored in the auxiliary file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is stored in the auxiliary file. -The file extensions used by each defined glossary are given by\\[10pt] -\cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext}\\[10pt] +The file extensions used by each defined glossary are given by +\begin{definition}[\DescribeMacro{\@newglossary}] +\cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext} +\end{definition} where \meta{in-ext} is the extension of the \emph{indexing -application's} input file (the output file from the \sty{glossaries} +application's} input file (the output file from the \styfmt{glossaries} package's point of view), \meta{out-ext} is the extension of the \emph{indexing application's} output file (the input file from -the \sty{glossaries} package's point of view) and \meta{log} is the +the \styfmt{glossaries} package's point of view) and \meta{log} is the extension of the indexing application's transcript file. The label for the glossary is also given for information purposes only, but is not required by the indexing applications. For example, the @@ -1070,35 +963,41 @@ information for the main glossary is written as: \@newglossary{main}{glg}{gls}{glo} \end{verbatim} -The indexing application's style file is specified by\\[10pt] -\cs{@istfilename}\marg{filename}\\[10pt] -The file extension indicates whether to use \appname{makeindex} -(\filetype{.ist}) or \appname{xindy} (\filetype{.xdy}). Note that +The indexing application's style file is specified by +\begin{definition}[\DescribeMacro{\@istfilename}] +\cs{@istfilename}\marg{filename} +\end{definition} +The file extension indicates whether to use \app{makeindex} +(\filetype{.ist}) or \app{xindy} (\filetype{.xdy}). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it's important to call the correct one. -Word or letter ordering is specified by:\\[10pt] -\cs{@glsorder}\marg{order}\\[10pt] +Word or letter ordering is specified by: +\begin{definition}[\DescribeMacro{\@glsorder}] +\cs{@glsorder}\marg{order} +\end{definition} where \meta{order} can be either \texttt{word} or \texttt{letter}. -If \appname{xindy} should be used, the language and code page -for each glossary is specified by\\[10pt] +If \app{xindy} should be used, the language and code page +for each glossary is specified by +\begin{definition}[\DescribeMacro{\@xdylanguage}\DescribeMacro{\@gls@codepage}] \cs{@xdylanguage}\marg{label}\marg{language}\\ -\cs{@gls@codepage}\marg{label}\marg{code}\\[10pt] +\cs{@gls@codepage}\marg{label}\marg{code} +\end{definition} where \meta{label} identifies the glossary, \meta{language} is the root language (e.g.\ \texttt{english}) and \meta{code} is the encoding (e.g.\ \texttt{utf8}). These commands are omitted -if \appname{makeindex} should be used. -\ifmakedtx{}{\toTop} +if \app{makeindex} should be used. + \subsection{Troubleshooting} \label{sec:trouble} -The \sty{glossaries} package comes with a minimal file called +The \styfmt{glossaries} package comes with a minimal file called \texttt{minimalgls.tex} which can be used for testing. This should be located in the \texttt{samples} subdirectory (folder) -of the \sty{glossaries} documentation directory. The location +of the \styfmt{glossaries} documentation directory. The location varies according to your operating system and \TeX\ installation. For example, on my Linux partition it can be found in \texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. @@ -1106,7 +1005,7 @@ Further information on debugging \LaTeX\ code is available at \url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. Below is a list of the most frequently asked questions. For -other queries, consult the \sty{glossaries} FAQ at +other queries, consult the \styfmt{glossaries} FAQ at \url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. \begin{enumerate} @@ -1115,7 +1014,7 @@ other queries, consult the \sty{glossaries} FAQ at Missing \begin{document} \end{verbatim} -\textbf{A.} Check you are using an up to date version of the \isty{xkeyval} +\textbf{A.} Check you are using an up to date version of the \sty{xkeyval} package. \item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms @@ -1160,39 +1059,33 @@ as above. For example to make the acronym emphasized on \end{verbatim} \item \textbf{Q.} I don't have Perl installed, do I have to use -\appname{makeglossaries}? +\app{makeglossaries}? -\textbf{A.} Although it is strongly recommended that you use -\appname{makeglossaries}, you don't have to use it. -For further details, read -\ifmakedtx{\autoref{sec:xindyapp}}{\htmlref{Using -xindy explicitly}{sec:xindyapp}} or -\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{Using -makeindex explicitly}{sec:makeindexapp}}, depending on -whether you want to use \appname{xindy} or \appname{makeindex}. +\textbf{A.} Although it is strongly recommended that you use +\app{makeglossaries}, you don't have to use it. For further details, +read \sectionref{sec:xindyapp} or \sectionref{sec:makeindexapp}, +depending on whether you want to use \app{xindy} or \app{makeindex}. +\item \textbf{Q.} I'm used to using the \styfmt{glossary} package: are there any +instructions on migrating from the \sty{glossary} package to the +\styfmt{glossaries} package? -\item \textbf{Q.} I'm used to using the \sty{glossary} package: are there any -instructions on migrating from the \isty{glossary} package to the -\sty{glossaries} package? +\textbf{A.} Read \qtdocref{Upgrading from the glossary package to +the glossaries package}{glossary2glossaries} which should be +available from the same location as this document. -\textbf{A.} Read \ifmakedtx{the file \texttt{glossary2glossaries.pdf}}{\htmladdnormallink{Upgrading -from the glossary package to the glossaries -package}{glossary2glossaries.html}} which should be available from the -same location as this document. +\item \textbf{Q.} I'm using \sty{babel} but the fixed names haven't +been translated. -\item \textbf{Q.} I'm using \isty{babel} but the fixed names haven't been -translated. - -\textbf{A.} The \sty{glossaries} package currently only supports the following -languages: Brazilian Portuguese, Danish, Dutch, English, French, -German, Irish, Italian, Hungarian, Polish and Spanish. If you want -to add another language, send me the translations, and I'll add them -to the next version. +\textbf{A.} The \styfmt{glossaries} package currently only supports +the following languages: Brazilian Portuguese, Danish, Dutch, +English, French, German, Irish, Italian, Hungarian, Polish, Serbian and +Spanish. If you want to add another language, send me the +translations, and I'll add them to the next version. If you are using one of the above languages, but the text hasn't been -translated, try adding the \isty{translator} package with the -required languages explicitly (before you load the \sty{glossaries} +translated, try adding the \sty{translator} package with the +required languages explicitly (before you load the \styfmt{glossaries} package). For example: \begin{verbatim} \usepackage[ngerman]{babel} @@ -1200,7 +1093,7 @@ package). For example: \usepackage{glossaries} \end{verbatim} Alternatively, you can add the language as a global option -to the class file. Check the \sty{translator} package documentation +to the class file. Check the \styfmt{translator} package documentation for further details. \item \textbf{Q.} My acronyms contain strange characters when I use commands @@ -1221,22 +1114,17 @@ and protect fragile commands. \item Use either \ics{printglossary} for each glossary that has been defined or \ics{printglossaries}. -\item Use the commands listed in -\ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary -Entries}{sec:glslink}}, -\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an Entry to the -Glossary Without Generating Text}{sec:glsadd}} or -\ifmakedtx{\autoref{sec:crossref}}{\htmlref{Cross-Referencing -Entries}{sec:crossref}} for each entry +\item Use the commands listed in \sectionref{sec:glslink}, +\sectionref{sec:glsadd} or \sectionref{sec:crossref} for each entry that you want to appear in the glossary. -\item Run \LaTeX\ on your document, then run \appname{makeglossaries}, +\item Run \LaTeX\ on your document, then run \app{makeglossaries}, then run \LaTeX\ on your document again. If you want the glossaries to appear in the table of contents, you will need an extra \LaTeX\ run. If any of your entries cross-reference an entry that's not -referenced in the main body of the document, you will need to -\ifmakedtx{run \appname{makeglossaries} (see \autoref{sec:makeglossaries})}{\htmlref{run \appname{makeglossaries}}{sec:makeglossaries}} -after the second \LaTeX\ run, followed by another \LaTeX\ run. +referenced in the main body of the document, you will need to run +\app{makeglossaries} (see \sectionref{sec:makeglossaries}) after the +second \LaTeX\ run, followed by another \LaTeX\ run. \end{itemize} Check the log files (\filetype{.log}, \filetype{.glg} etc) for any @@ -1245,42 +1133,50 @@ warnings. \item \textbf{Q.} It is possible to change the rules used to sort the glossary entries? -\textbf{A.} If it's for an individual entry, then you can -use the entry's \gloskey{sort} key to sort it according to a -different term. If it's for the entire alphabet, then you will need -to use \appname{xindy} (instead of \appname{makeindex}) and use an -appropriate \appname{xindy} language module. Writing \appname{xindy} -modules or styles is beyond the scope of this manual. Further -information about \appname{xindy} can be found at the -\ifmakedtx{\href{http://xindy.sourceforge.net/}{Xindy Web -Site}.\footnote{\texttt{http://xindy.sourceforge.net/}}}{\htmladdnormallink{Xindy Web Site}{http://xindy.sourceforge.net/}.} -There is also a link to the \appname{xindy} mailing list from that -site. +\textbf{A.} If it's for an individual entry, then you can use the +entry's \gloskey{sort} key to sort it according to a different term. +If it's for the entire alphabet, then you will need to use +\app{xindy} (instead of \app{makeindex}) and use an appropriate +\app{xindy} language module. Writing \app{xindy} modules or styles +is beyond the scope of this manual. Further information about +\app{xindy} can be found at the +\urlfootref{http://xindy.sourceforge.net/}{Xindy Web Site}. There is +also a link to the \app{xindy} mailing list from that site. \end{enumerate} -\ifmakedtx{}{\toTop} + \section{Overview of Main User Commands}\label{sec:overview} \changes{1.02}{2007 May 25}{added overview section} +This section is an overview of the main user commands and package +options. If you find this too complicated, try starting out with the +\docref{guide for beginners}{glossariesbegin}. + \subsection{Package Options} \label{sec:pkgopts} -The \sty{glossaries} package options are as follows: +The \styfmt{glossaries} package options are as follows: \begin{description} \item[\pkgopt{nowarn}] This suppresses all warnings generated by -the \sty{glossaries} package. +the \styfmt{glossaries} package. \item[\pkgopt{nomain}] This suppresses the creation of the main glossary. Note that if you use this option, you must create another glossary in which to put all your entries (either via the \pkgopt{acronym} package option described below or via -\ics{newglossary} described in -\ifmakedtx{\autoref{sec:newglossary}}{\htmlref{Defining New -Glossaries}{sec:newglossary}}). +\ics{newglossary} described in \sectionref{sec:newglossary}). \item[\pkgopt{toc}] Add the glossaries to the table of contents. Note that an extra \LaTeX\ run is required with this option. +Alternatively, you can switch this function on and off using +\begin{definition}[\DescribeMacro{\glstoctrue}] +\cs{glstoctrue} +\end{definition} +and +\begin{definition}[\DescribeMacro{\glstocfalse}] +\cs{glstocfalse} +\end{definition} \item[\pkgopt{numberline}] When used with \pkgopt{toc}, this will add \cs{numberline}\verb|{}| in the final argument of @@ -1380,7 +1276,7 @@ acronyms is labelled \texttt{acronym}\footnote{if the \pkgopt{acronym} option is used, otherwise the list of acronyms is the main glossary} and additional glossaries are labelled using the value specified in the first mandatory argument to -\cs{newglossary}. For example, if you load \sty{glossaries} +\cs{newglossary}. For example, if you load \styfmt{glossaries} using: \begin{verbatim} \usepackage[section,numberedsection=autolabel]{glossaries} @@ -1422,41 +1318,41 @@ The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. \item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its value should be the name of the glossary style to use. Predefined -glossary styles are listed \ifmakedtx{in \autoref{sec:styles}}{\htmlref{later}{sec:styles}}. +glossary styles are listed in \sectionref{sec:styles}. -\item[\pkgopt{nolong}] This prevents the \sty{glossaries} package -from automatically loading \isty{glossary-long} (which means that -the \isty{longtable} package also won't be loaded). This reduces -overhead by not defining unwanted styles and commands. Not that if +\item[\pkgopt{nolong}] This prevents the \styfmt{glossaries} package +from automatically loading \sty{glossary-long} (which means that +the \sty{longtable} package also won't be loaded). This reduces +overhead by not defining unwanted styles and commands. Note that if you use this option, you won't be able to use any of the -glossary styles defined in the \sty{glossary-long} package. +glossary styles defined in the \styfmt{glossary-long} package. -\item[\pkgopt{nosuper}] This prevents the \sty{glossaries} package -from automatically loading \isty{glossary-super} (which means that -the \isty{supertabular} package also won't be loaded). This reduces -overhead by not defining unwanted styles and commands. Not that if +\item[\pkgopt{nosuper}] This prevents the \styfmt{glossaries} package +from automatically loading \sty{glossary-super} (which means that +the \sty{supertabular} package also won't be loaded). This reduces +overhead by not defining unwanted styles and commands. Note that if you use this option, you won't be able to use any of the -glossary styles defined in the \sty{glossary-super} package. +glossary styles defined in the \styfmt{glossary-super} package. -\item[\pkgopt{nolist}] This prevents the \sty{glossaries} package -from automatically loading \isty{glossary-list}. This reduces -overhead by not defining unwanted styles. Not that if +\item[\pkgopt{nolist}] This prevents the \styfmt{glossaries} package +from automatically loading \sty{glossary-list}. This reduces +overhead by not defining unwanted styles. Note that if you use this option, you won't be able to use any of the -glossary styles defined in the \sty{glossary-list} package. +glossary styles defined in the \styfmt{glossary-list} package. Note that since the default style is \glostyle{list}, you will also need to use the \pkgopt{style} option to set the style to something else. -\item[\pkgopt{notree}] This prevents the \sty{glossaries} package -from automatically loading \isty{glossary-tree}. This reduces -overhead by not defining unwanted styles. Not that if +\item[\pkgopt{notree}] This prevents the \styfmt{glossaries} package +from automatically loading \sty{glossary-tree}. This reduces +overhead by not defining unwanted styles. Note that if you use this option, you won't be able to use any of the -glossary styles defined in the \sty{glossary-tree} package. +glossary styles defined in the \styfmt{glossary-tree} package. \item[\pkgopt{nostyles}] This prevents all the predefined styles from being loaded. This option is provided in the event that the user has custom styles that are not dependent on the styles -provided by the \sty{glossaries} package. Note that if you use +provided by the \styfmt{glossaries} package. Note that if you use this option, you can't use the \pkgopt{style} package option. Instead you must either use \ics{glossarystyle}\marg{style} or the \gloskey[printglossary]{style} key in the @@ -1464,31 +1360,31 @@ optional argument to \ics{printglossary}. \item[\pkgopt{nonumberlist}] This option will suppress the associated number lists\iterm{number list} in the glossaries (see also -\ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}). +\sectionref{sec:numberlists}). \item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option. The value should be the name of the default counter to use in the number lists\iterm{number list}. -\ifmakedtx{\hypertarget{sanitize}{}\relax}{\label{sanitize}} -\item[\pkgopt{sanitize}] This is a \meta{key}=\meta{value} option whose -value is also a \meta{key}=\meta{value} list. By default, the -\sty{glossaries} package sanitizes the values of the -\gloskey{name}, \gloskey{description} and \gloskey{symbol} keys used -when defining a new glossary entry. This means that you can use -fragile commands in those keys, but it may lead to unexpected results -if you try to display these values within the document text. This -sanitization can be switched off using the \pkgopt{sanitize} package -option. \ifmakedtx{(See \autoref{sec:pkgopt} and \autoref{sec:newentry} for -further details.)}{} For example, to switch off the sanitization for the -\gloskey{description} and \gloskey{name} keys, but not for the -\gloskey{symbol} key, do: +\hypertarget{sanitize}{}\relax \item[\pkgopt{sanitize}] This is a +\meta{key}=\meta{value} option whose value is also a +\meta{key}=\meta{value} list. By default, the \styfmt{glossaries} +package sanitizes the values of the \gloskey{name}, +\gloskey{description} and \gloskey{symbol} keys used when defining a +new glossary entry. This means that you can use fragile commands in +those keys, but it may lead to unexpected results if you try to +display these values within the document text. This sanitization can +be switched off using the \pkgopt{sanitize} package option. \ifpdf +(See \sectionref{sec:pkgopt} and \sectionref{sec:newentry} for +further details.) \fi For example, to switch off the sanitization +for the \gloskey{description} and \gloskey{name} keys, but not for +the \gloskey{symbol} key, do: \begin{verbatim} \usepackage[sanitize={name=false,description=false,% symbol=true}]{glossaries} \end{verbatim} You can use \pkgopt[none]{sanitize} as a shortcut for\newline -\pkgoptni{sanitize=\{name=false,description=false,symbol=false\}}. +\pkgoptfmt{sanitize=\{name=false,description=false,symbol=false\}}. \begin{important}% \textbf{Note}: this sanitization only applies to the \gloskey{name}, @@ -1502,153 +1398,148 @@ in the \gloskey{name} key if you don't use the \gloskey{text} key. \end{important} \item[\pkgopt{description}] This option changes the definition of -\ics{newacronym} to allow a description. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} +\ics{newacronym} to allow a description. See \sectionref{sec:acronyms} for further details. \item[\pkgopt{footnote}] 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. +\ics{newacronym} and the way that acronyms are displayed. See +\sectionref{sec:acronyms} for further details. \item[\pkgopt{smallcaps}] 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. +\ics{newacronym} and the way that acronyms are displayed. See +\sectionref{sec:acronyms} for further details. \item[\pkgopt{smaller}] This option changes the definition of \ics{newacronym} and the way that acronyms are displayed. -If you use this option, you will need to include the \isty{relsize} +If you use this option, you will need to include the \sty{relsize} package or otherwise define \ics{textsmaller} or redefine -\ics{acronymfont}. See -\ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} -for further details. +\ics{acronymfont}. See \sectionref{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. +See \sectionref{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. +for acronyms. See \sectionref{sec:acronyms} for further details. \item[\pkgopt{makeindex}] (Default) The glossary information and -indexing style file will be written in \appname{makeindex} format. If you use -\appname{makeglossaries}, it will automatically detect that it needs -to call \appname{makeindex}. If you don't use -\appname{makeglossaries}, you need to remember to use -\appname{makeindex} not \appname{xindy}. The indexing style file -will been given a \filetype{.ist} extension. - -\item[\pkgopt{xindy}] The glossary information and indexing style file will -be written in \appname{xindy} format. If you use -\appname{makeglossaries}, it will automatically detect that it needs -to call \appname{xindy}. If you don't use \appname{makeglossaries}, -you need to remember to use \appname{xindy} not \appname{makeindex}. -The indexing style file will been given a \filetype{.xdy} extension. - -The \pkgopt{xindy} package option may additionally have a -value that is a \meta{key}=\meta{value} comma-separated list to override -the language and codepage. For example: +indexing style file will be written in \app{makeindex} format. If +you use \app{makeglossaries}, it will automatically detect that it +needs to call \app{makeindex}. If you don't use +\app{makeglossaries}, you need to remember to use \app{makeindex} +not \app{xindy}. The indexing style file will been given a +\filetype{.ist} extension. + +\item[\pkgopt{xindy}] The glossary information and indexing style +file will be written in \app{xindy} format. If you use +\app{makeglossaries}, it will automatically detect that it needs to +call \app{xindy}. If you don't use \app{makeglossaries}, you need to +remember to use \app{xindy} not \app{makeindex}. The indexing style +file will been given a \filetype{.xdy} extension. + +The \pkgopt{xindy} package option may additionally have a value that +is a \meta{key}=\meta{value} comma-separated list to override the +language and codepage. For example: \begin{verbatim} \usepackage[xindy={language=english,codepage=utf8}]{glossaries} \end{verbatim} -You can also specify whether you want a number group in -the glossary. This defaults to true, but can be suppressed. For -example: +You can also specify whether you want a number group in the +glossary. This defaults to true, but can be suppressed. For example: \begin{verbatim} \usepackage[xindy={glsnumbers=false}]{glossaries} \end{verbatim} -See \ifmakedtx{\autoref{sec:xindy}}{\htmlref{Xindy}{sec:xindy}} -for further details on using \appname{xindy} with the -\sty{glossaries} package. +See \sectionref{sec:xindy} for further details on using \app{xindy} +with the \styfmt{glossaries} package. \item[\pkgopt{order}] This may take two values: \pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default is word ordering. Note that this option has no effect if you -don't use \appname{makeglossaries}. +don't use \app{makeglossaries}. \item[\pkgopt{translate}] This is a boolean option. The default is -\pkgoptval{true}{translate} if \isty{babel}, \isty{polyglossia} or -\isty{translator} have been loaded, otherwise the default value is +\pkgoptval{true}{translate} if \sty{babel}, \sty{polyglossia} or +\sty{translator} have been loaded, otherwise the default value is \pkgoptval{false}{translate}. \begin{description} - \item[{\pkgopt[true]{translate}}] If \isty{babel} has been loaded - and the \isty{translator} package is installed, \isty{translator} + \item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded + and the \sty{translator} package is installed, \sty{translator} will be loaded and the translations will be provided by the - \isty{translator} package interface. You can modify the + \sty{translator} package interface. You can modify the translations by providing your own dictionary. If the - \isty{translator} package isn't installed and \isty{babel} is - loaded, the \isty{glossaries-babel} package will - be loaded and the translations will be provided using \sty{babel}'s + \sty{translator} package isn't installed and \sty{babel} is + loaded, the \sty{glossaries-babel} package will + be loaded and the translations will be provided using \styfmt{babel}'s \cs{addto}\cs{caption}\meta{language} mechanism. If - \isty{polyglossia} has been loaded, \isty{glossaries-polyglossia} + \sty{polyglossia} has been loaded, \sty{glossaries-polyglossia} will be loaded. \item[{\pkgopt[false]{translate}}] Don't provide translations, even - if \isty{babel} or \isty{polyglossia} has been loaded. You can + if \sty{babel} or \sty{polyglossia} has been loaded. You can then provide you're own translations or explicitly load - \isty{glossaries-babel} or \isty{glossaries-polyglossia}. + \sty{glossaries-babel} or \sty{glossaries-polyglossia}. \end{description} +See \sectionref{sec:fixednames} for further details. + \item[\pkgopt{hyperfirst}] This is a boolean option that specifies whether each term has a hyperlink on \firstuse. The default is \pkgopt[true]{hyperfirst} (terms on first use have a hyperlink, unless explicitly suppressed using starred versions of commands such as \cs{gls*}). -\end{description}\ifmakedtx{}{\toTop} +\end{description} \subsection{Defining Glossary Entries} \label{sec:newglosentry} -All glossary entries must be defined before they are used, so it -is better to define them in the preamble to ensure this.\footnote{The -only preamble restriction on \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}}, -\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}} or -\ifmakedtx{\autoref{sec:crossref}}{\htmlref{Cross-Referencing -Entries}{sec:crossref}}) will appear in the glossary. Each time an entry -is used in this way, a line is added to an associated glossary file -(\filetype{.glo}), which then needs to be converted into a +All glossary entries must be defined before they are used, so it is +better to define them in the preamble to ensure this.\footnote{The +only preamble restriction on \cs{newglossaryentry} and +\cs{newacronym} was removed in version 1.13, but the restriction +remains for \cs{loadglsentries}.} However only those entries that +occur in the document (using any of the commands described in +\sectionref{sec:glslink}, \sectionref{sec:glsadd} or +\sectionref{sec:crossref}) will appear in the glossary. Each time an +entry is used in this way, a line is added to an associated glossary +file (\filetype{.glo}), which then needs to be converted into a corresponding \filetype{.gls} file which contains the typeset glossary which is input by \ics{printglossary} or -\ics{printglossaries}. The Perl script \appname{makeglossaries} can -be used to call \appname{makeindex} or \appname{xindy}, using a -customised indexing style file, for each of the glossaries that are -defined in the document. Note that there should be no need for you -to explicitly edit or input any of these external files. See -\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the -Associated Glossary Files}{sec:makeglossaries}} -for further details. - -\DescribeMacro{\makeglossaries} -The command \cs{makeglossaries} must be placed in the preamble in -order to create the customised \appname{makeindex} (\filetype{.ist}) -or \appname{xindy} (\filetype{.xdy}) +\ics{printglossaries}. The Perl script \app{makeglossaries} can be +used to call \app{makeindex} or \app{xindy}, using a customised +indexing style file, for each of the glossaries that are defined in +the document. Note that there should be no need for you to +explicitly edit or input any of these external files. See +\sectionref{sec:makeglossaries} for further details. + +The command +\begin{definition}[\DescribeMacro{\makeglossaries}] +\cs{makeglossaries} +\end{definition} +must be placed in the preamble in order to create the customised +\app{makeindex} (\filetype{.ist}) or \app{xindy} (\filetype{.xdy}) style file and to ensure that glossary entries are written to the -appropriate output files. If you omit \cs{makeglossaries} none of the -glossaries will be created. +appropriate output files. If you omit \cs{makeglossaries} none of +the glossaries will be created. \begin{important} -Note that some of the commands provided by the \sty{glossaries} +Note that some of the commands provided by the \styfmt{glossaries} package must be placed before \cs{makeglossaries} as they are required when creating the customised style file. If you attempt to use those commands after \cs{makeglossaries} you will generate an error. \end{important} -\DescribeMacro{\noist} -You can suppress the creation of the customised \appname{xindy} -or \appname{makeindex} style file using \cs{noist}. Note that this -command must be used before \cs{makeglossaries}. +You can suppress the creation of the customised \app{xindy} +or \app{makeindex} style file using +\begin{definition}[\DescribeMacro{\noist}] +\cs{noist} +\end{definition} +Note that this command must be used before \cs{makeglossaries}. The default name for the customised style file is given by -\ics{jobname}\filetype{.ist} (for \appname{makeindex}) or -\ics{jobname}\filetype{.xdy} (for \appname{xindy}). This name may be +\ics{jobname}\filetype{.ist} (for \app{makeindex}) or +\ics{jobname}\filetype{.xdy} (for \app{xindy}). This name may be changed using: \begin{definition}[\DescribeMacro{\setStyleFile}] \cs{setStyleFile}\marg{name} @@ -1673,36 +1564,31 @@ For example: \end{verbatim} Note that this command must be used before \cs{makeglossaries}. -If you use \appname{xindy}, you can have a different compositor -for page numbers starting with an uppercase alphabetical -character using: +If you use \app{xindy}, you can have a different compositor for page +numbers starting with an uppercase alphabetical character using: \begin{definition}[\DescribeMacro{\glsSetAlphaCompositor}] \cs{glsSetAlphaCompositor}\marg{symbol} \end{definition} Note that this command has no effect if you haven't used the -\pkgopt{xindy} package option. For example, if you want -number lists\iterm{number list} containing a mixture of A-1 and 2.3 -style formats, then do: +\pkgopt{xindy} package option. For example, if you want number +lists\iterm{number list} containing a mixture of A-1 and 2.3 style +formats, then do: \begin{verbatim} -\glsSetCompositor{.} -\glsSetAlphaCompositor{-} +\glsSetCompositor{.} \glsSetAlphaCompositor{-} \end{verbatim} -See \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number -lists}{sec:numberlists}} for -further information about number lists\iterm{number list}. +See \sectionref{sec:numberlists} for further information about +number lists\iterm{number list}. New glossary entries are defined using the command: \begin{definition}[\DescribeMacro{\newglossaryentry}] \cs{newglossaryentry}\marg{label}\marg{key-val list} \end{definition} -The first -argument, \meta{label}, must be a unique label with which to identify -this entry. The second argument, \meta{key-val list}, is a -\meta{key}=\meta{value} list that supplies the relevant information -about this entry. There are two required fields: \gloskey{name} and -\gloskey{description}, except for sub-entries where the -\gloskey{name} field may be omitted. Available fields are listed -below: +The first argument, \meta{label}, must be a unique label with which +to identify this entry. The second argument, \meta{key-val list}, is +a \meta{key}=\meta{value} list that supplies the relevant +information about this entry. There are two required fields: +\gloskey{description} and either \gloskey{name} or \gloskey{parent}. +Available fields are listed below: \begin{description} \item[{\gloskey{name}}] The name of the entry (as it will appear in @@ -1711,11 +1597,17 @@ key is supplied, this value will be the same as the parent's name. \item[{\gloskey{description}}] A brief description of this term (to appear in the glossary). Within this value, you can use -\DescribeMacro{\nopostdesc}\cs{nopostdesc} to suppress the +\begin{definition}[\DescribeMacro{\nopostdesc}] +\cs{nopostdesc} +\end{definition} +to suppress the description terminator for this entry. For example, if this entry is a parent entry that doesn't require a description, you can do \verb|description={\nopostdesc}|. If you want a paragraph -break in the description use \DescribeMacro{\glspar}\cs{glspar}. +break in the description use +\begin{definition}[\DescribeMacro{\glspar}] +\cs{glspar} +\end{definition} However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use \ics{newline} @@ -1723,8 +1615,7 @@ not \verb"\\" if you want to force a line break. \item[{\gloskey{parent}}] The label of the parent entry. Note that the parent entry must be defined before its sub-entries. -See \ifmakedtx{\autoref{sec:subentries}}{\htmlref{Sub-Entries}{sec:subentries}} for -further details. +See \sectionref{sec:subentries} for further details. \item[{\gloskey{descriptionplural}}] The plural form of the description (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} @@ -1745,7 +1636,7 @@ when using \ics{glspl} (or one of its uppercase variants). If this field is omitted, the value is obtained by appending \ics{glspluralsuffix} to the value of the \gloskey{text} field. The default value of \cs{glspluralsuffix} is the letter -\dq{s}. +\qt{s}. \item[{\gloskey{firstplural}}] How the entry will appear in the document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its @@ -1755,7 +1646,7 @@ 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{firstplural} was always taken by appending \qt{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. @@ -1770,8 +1661,8 @@ symbol (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value is set to the same as the \gloskey{symbol} key. -\item[{\gloskey{sort}}] This value indicates how \appname{makeindex} -or \appname{xindy} should sort this entry. If omitted, the value is +\item[{\gloskey{sort}}] This value indicates how \app{makeindex} +or \app{xindy} should sort this entry. If omitted, the value is given by the \gloskey{name} field. \item[{\gloskey{type}}] This specifies the label of the glossary in @@ -1793,10 +1684,10 @@ this entry. \gloskey{see} key will automatically add this entry to the glossary, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. -If you want to override the \dq{see} tag, you can supply the new +If you want to override the \qt{see} tag, you can supply the new tag in square brackets before the label. For example \verb|see=[see also]{anotherlabel}|. For further details, -see \ifmakedtx{\autoref{sec:crossref}}{\htmlref{later}{sec:crossref}}. +see \sectionref{sec:crossref}. \end{description} Note that if the name starts with an accented letter or non-Latin @@ -1807,34 +1698,35 @@ For example: \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}} \end{verbatim} -Note that the same applies if you are using the \isty{inputenc} +Note that the same applies if you are using the \sty{inputenc} package: \begin{verbatim} \newglossaryentry{elite}{name={{é}lite}, description={select group or class}} \end{verbatim} Note that in both of the above examples, you will also need to -supply the \gloskey{sort} key if you are using \appname{makeindex} -whereas \appname{xindy} is usually able to sort accented letters +supply the \gloskey{sort} key if you are using \app{makeindex} +whereas \app{xindy} is usually able to sort accented letters correctly. -\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 by appending -\DescribeMacro{\glspluralsuffix}\cs{glspluralsuffix} to -the singular form. This command defaults to the letter \dq{s}. +\begin{definition}[\DescribeMacro{\glspluralsuffix}] +\cs{glspluralsuffix} +\end{definition} +to the singular form. This command defaults to the letter \qt{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 +defines a new entry whose singular form is \qt{cow} and plural form +is \qt{cows}. However, if you are writing in archaic English, you +may want to use \qt{kine} as the plural form, in which case you would have to do: \begin{verbatim} \newglossaryentry{cow}{name=cow,plural=kine, @@ -1850,8 +1742,8 @@ other plural form. For example: female of any bovine animal (plural cows, archaic plural kine)}, user1={kine}} \end{verbatim} -You can then use \verb|\glspl{cow}| to produce \dq{cows} and -\verb|\glsuseri{cow}| to produce \dq{kine}. You can, of course, +You can then use \verb|\glspl{cow}| to produce \qt{cows} and +\verb|\glsuseri{cow}| to produce \qt{kine}. You can, of course, define an easy to remember synonym. For example: \begin{verbatim} \let\glsaltpl\glsuseri @@ -1867,7 +1759,6 @@ 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{Sub-Entries} \label{sec:subentries} @@ -1881,15 +1772,14 @@ the parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a flat format. Of the styles that support sub-entries, some display the sub-entry's name whilst others don't. Therefore you need to -ensure that you use a suitable style. See \ifmakedtx{\autoref{sec:styles}}{\htmlref{later}{sec:styles}} -for a list of predefined -styles. +ensure that you use a suitable style. See \sectionref{sec:styles} +for a list of predefined styles. Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a \term{number list}. -\ifmakedtx{}{\toTop} + \paragraph{Hierarchical Categories} To arrange a glossary with hierarchical categories, you need to first define the @@ -1921,13 +1811,13 @@ parent=greekletter} description={Euler's constant}, parent=romanletter} \end{verbatim} -\ifmakedtx{}{\toTop} + \paragraph{Homographs} Sub-entries that have the same name as the parent entry, don't need to have the \gloskey{name} key. -For example, the word \dq{glossary} can mean a list of technical +For example, the word \qt{glossary} can mean a list of technical words or a collection of glosses. In both cases the plural is -\dq{glossaries}. So first define the parent entry: +\qt{glossaries}. So first define the parent entry: \begin{verbatim} \newglossaryentry{glossary}{name=glossary, description={\nopostdesc}, @@ -1973,7 +1863,7 @@ sort={2}, plural={bravoes}, parent=bravo} \end{verbatim} -\ifmakedtx{}{\toTop} + \subsubsection{Loading Entries From a File} \label{sec:loadglsentries} @@ -2012,11 +1902,10 @@ 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: +\textbf{Note:} if you use \cs{newacronym} (see +\sectionref{sec:acronyms}) the type is set as +\verb|type=\acronymtype| unless you explicitly override it. For +example, if my file \texttt{myacronyms.tex} contains: \begin{verbatim} \newacronym{aca}{aca}{a contrived acronym} \end{verbatim} @@ -2028,10 +1917,10 @@ then (supposing I have defined a new glossary type called will add \texttt{aca} to the glossary type \texttt{acronym}, if the package option \pkgopt{acronym} has been specified, or will add \texttt{aca} to the glossary type \texttt{altacronym}, if the -package option \pkgopt{acronym} is not specified.\footnote{This -is because \cs{acronymtype} is set to \cs{glsdefaulttype} if -the \pkgopt{acronym} package option is not used.} In this instance, -it is better to change \texttt{myacronyms.tex} to: +package option \pkgopt{acronym} is not specified.\footnote{This is +because \cs{acronymtype} is set to \cs{glsdefaulttype} if the +\pkgopt{acronym} package option is not used.} In this instance, it +is better to change \texttt{myacronyms.tex} to: \begin{verbatim} \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} \end{verbatim} @@ -2046,7 +1935,7 @@ 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} +preamble. \subsection{Number lists} \label{sec:numberlists} @@ -2054,16 +1943,16 @@ preamble.\ifmakedtx{}{\toTop} Each entry in the glossary has an associated \termdef{number list}. By default, these numbers refer to the pages on which that entry has been used -(using any of the commands described in \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}}). The number list can be suppressed using +(using any of the commands described in \sectionref{sec:glslink} +and \sectionref{sec:glsadd}). The number list can be suppressed using the \pkgopt{nonumberlist} package option, or an alternative counter can be set as the default using the \pkgopt{counter} package option. The number list is also referred to as the location list\index{location list|see{number list}}. -Both \appname{makeindex} and \appname{xindy} concatenate a +Both \app{makeindex} and \app{xindy} concatenate a sequence of 3 or more consecutive pages into a range. With -\appname{xindy} you can vary the minimum sequence length using +\app{xindy} you can vary the minimum sequence length using \ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either an integer or the keyword \texttt{none} which indicates that there should be no range formation. @@ -2073,7 +1962,7 @@ Note that \cs{GlsSetXdyMinRangeLength} must be used before \ics{makeglossaries} and has no effect if \ics{noist} is used. \end{important} -With both \appname{makeindex} and \appname{xindy}, you can replace +With both \app{makeindex} and \app{xindy}, you can replace the separator and the closing number in the range using: \begin{definition}[\DescribeMacro{\glsSetSuffixF}] \cs{glsSetSuffixF}\marg{suffix} @@ -2088,13 +1977,13 @@ For example: \glsSetSuffixF{f.} \glsSetSuffixFF{ff.} \end{verbatim} -Note that if you use \appname{xindy}, you will also need to +Note that if you use \app{xindy}, you will also need to set the minimum range length to 1 if you want to change these suffixes: \begin{verbatim} \GlsSetXdyMinRangeLength{1} \end{verbatim} -Note that if you use the \isty{hyperref} package, you will need +Note that if you use the \sty{hyperref} package, you will need to use \ics{nohyperpage} in the suffix to ensure that the hyperlinks work correctly. For example: \begin{verbatim} @@ -2108,24 +1997,21 @@ before \ics{makeglossaries} and have no effect if \ics{noist} is used. \end{important} -\ifmakedtx{}{\toTop} \subsection{Links to Glossary Entries} \label{sec:glslink} -Once you have defined a glossary entry using -\ics{newglossaryentry}, you can refer to that entry in the -document using one of the commands listed in this section. The -text which appears at that point in the document when using -one of these commands is referred to as the -\termdef{link text} (even if there are no hyperlinks). The commands -in this section also add a line to an external file that is used -by \appname{makeindex} or \appname{xindy} to generate the relevant -entry in the glossary. This information includes an -associated location that is added to the \term{number list} for that -entry. By default, the location refers to the page number. For -further information on number lists, see \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}. - +Once you have defined a glossary entry using \ics{newglossaryentry}, +you can refer to that entry in the document using one of the +commands listed in this section. The text which appears at that +point in the document when using one of these commands is referred +to as the \termdef{link text} (even if there are no hyperlinks). The +commands in this section also add a line to an external file that is +used by \app{makeindex} or \app{xindy} to generate the relevant +entry in the glossary. This information includes an associated +location that is added to the \term{number list} for that entry. By +default, the location refers to the page number. For further +information on number lists, see \sectionref{sec:numberlists}. \begin{important} It is strongly recommended that you don't use the commands @@ -2134,19 +2020,17 @@ commands. \end{important} The above warning is particularly important if you are using the -\sty{glossaries} package in conjunction with the \isty{hyperref} package. -Instead, use one of the commands listed in -\ifmakedtx{\autoref{sec:glsnolink}}{\htmlref{Using Glossary Terms -Without Links}{sec:glsnolink}} (such as \cs{glsentrytext}) or provide an alternative via -the optional argument to the sectioning/caption command. -Examples: +\styfmt{glossaries} package in conjunction with the \sty{hyperref} +package. Instead, use one of the commands listed in +\sectionref{sec:glsnolink} (such as \cs{glsentrytext}) or provide an +alternative via the optional argument to the sectioning/caption +command. Examples: \begin{verbatim} \section{An overview of \glsentrytext{perl}} \section[An overview of Perl]{An overview of \gls{perl}} \end{verbatim} -The way the \term{link text} is displayed -depends on +The way the \term{link text} is displayed depends on \begin{definition}[\DescribeMacro{\glstextformat}] \cs{glstextformat}\marg{text} \end{definition} @@ -2161,7 +2045,7 @@ Each entry has an associated conditional referred to as the \ics{glspl} (and their uppercase variants) should use the value of the \gloskey{first} or \gloskey{text} keys. Note that an entry can be used without affecting the \firstuseflag\ (for example, -when used with \cs{glslink}). See \ifmakedtx{\autoref{sec:glsunset}}{\htmlref{later}{sec:glsunset}} for +when used with \cs{glslink}). See \sectionref{sec:glsunset} for commands that unset or reset this conditional. The command: @@ -2180,7 +2064,7 @@ following keys: \begin{description} \item[{\gloskey[glslink]{format}}] This specifies how to format the associated location number for this entry in the glossary. This -value is equivalent to the \appname{makeindex} encap value, and (as +value is equivalent to the \app{makeindex} encap value, and (as with \cs{index}) the value needs to be the name of a command \emph{without} the initial backslash. As with \cs{index}, the characters \verb"(" and \verb")" can also be used to specify the @@ -2202,27 +2086,27 @@ block commands such as \ics{textbf} or \ics{emph} or any of the commands listed in \tableref{tab:hyperxx}. \begin{important} -If you use \appname{xindy} instead of \appname{makeindex}, you +If you use \app{xindy} instead of \app{makeindex}, you must specify any non-standard formats that you want to use with the \gloskey[glslink]{format} key using \ics{GlsAddXdyAttribute}\marg{name}. So if you use -\appname{xindy} with the above example, you would need to add: +\app{xindy} with the above example, you would need to add: \begin{verbatim} \GlsAddXdyAttribute{textbfem} \end{verbatim} \end{important} -Note that unlike \cs{index}, you can't have -anything following the command name, such as an asterisk or -arguments. If you want to cross-reference another entry, either -use the \gloskey{see} key when you define the entry or use -\ics{glssee} (described \ifmakedtx{in \autoref{sec:crossref}}{\htmlref{later}{sec:crossref}}). +Note that unlike \cs{index}, you can't have anything following the +command name, such as an asterisk or arguments. If you want to +cross-reference another entry, either use the \gloskey{see} key when +you define the entry or use \ics{glssee} (described in +\sectionref{sec:crossref}). If you are using hyperlinks and you want to change the font of the hyperlinked location, don't use \ics{hyperpage} (provided by the -\isty{hyperref} package) as the locations may not refer to a page -number. Instead, the \sty{glossaries} package provides number +\sty{hyperref} package) as the locations may not refer to a page +number. Instead, the \styfmt{glossaries} package provides number formats listed in \tableref{tab:hyperxx}. \begin{table}[htbp] @@ -2250,15 +2134,15 @@ the \texttt{hyper}\meta{xx} formats are equivalent to the analogous \texttt{text}\meta{xx} font commands (and \texttt{hyperemph} is equivalent to \texttt{emph}). If you want to make a new format, you will need to define a command which takes -one argument and use that; for example, if you want the location +one argument and use that. For example, if you want the location number to be in a bold sans-serif font, you can define a command called, say, \cs{hyperbsf}: \begin{verbatim} \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} \end{verbatim} and then use \texttt{hyperbsf} as the value for the \gloskey{format} -key.\ifmakedtx{ (See also \autoref{sec:code:printglos}.)}{} -Remember that if you use \appname{xindy}, you will need to add +key. \ifpdf (See also \sectionref{sec:code:printglos}.) \fi +Remember that if you use \app{xindy}, you will need to add this to the list of location attributes: \begin{verbatim} \GlsAddXdyAttribute{hyperbsf} @@ -2266,8 +2150,7 @@ this to the list of location attributes: \item[{\gloskey[glslink]{counter}}] This specifies which counter to use for this location. This overrides the default counter -used by this entry. (See also -\ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}.) +used by this entry. (See also \sectionref{sec:numberlists}.) \item[{\gloskey[glslink]{hyper}}] This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry @@ -2312,8 +2195,7 @@ 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, but this -can be changed (see -\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{later}{sec:glsdisplay}}). +can be changed (see \sectionref{sec:glsdisplay}). The first optional argument \meta{options} is the same as the optional @@ -2337,8 +2219,7 @@ a starred version that disable the hyperlink. Note that \cs{glslink} doesn't use or affect the \firstuseflag, nor does it use \ics{glsdisplay} or \ics{glsdisplayfirst} (see -\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{later}{sec:glsdisplay}}). -Instead, you can use: +\sectionref{sec:glsdisplay}). Instead, you can use: \begin{definition}[\DescribeMacro{\glsdisp}] \cs{glsdisp}\oarg{options}\marg{label}\marg{link text} \end{definition} @@ -2431,13 +2312,13 @@ The command: \begin{definition}[\DescribeMacro{\glsname}] \cs{glsname}\oarg{options}\marg{label}\oarg{insert} \end{definition} -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. +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 +\hyperlink{sanitize}{sanitization} of the \gloskey{name} key and +protect fragile commands. There are also analogous commands: \begin{definition}[\DescribeMacro{\Glsname}] @@ -2453,13 +2334,13 @@ The command: \begin{definition}[\DescribeMacro{\glssymbol}] \cs{glssymbol}\oarg{options}\marg{label}\oarg{insert} \end{definition} -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. +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 +\hyperlink{sanitize}{sanitization} of the \gloskey{symbol} key and +protect fragile commands. There are also analogous commands: \begin{definition}[\DescribeMacro{\Glssymbol}] @@ -2475,14 +2356,13 @@ The command: \begin{definition}[\DescribeMacro{\glsdesc}] \cs{glsdesc}\oarg{options}\marg{label}\oarg{insert} \end{definition} -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. +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 \hyperlink{sanitize}{sanitization} of the +\gloskey{description} key and protect fragile commands. There are also analogous commands: \begin{definition}[\DescribeMacro{\Glsdesc}] @@ -2558,7 +2438,7 @@ the hyperlink. Similarly for the other user keys: \cs{GLSuservi}\oarg{options}\marg{text}\oarg{insert} \end{definition} -\ifmakedtx{}{\toTop} + \subsubsection{Changing the format of the link text} \label{sec:glsdisplay} @@ -2566,12 +2446,12 @@ the hyperlink. Similarly for the other user keys: The format of the \term{link text} for \ics{gls}, \ics{glspl} and their uppercase variants is governed by two commands: \begin{definition}[\DescribeMacro{\glsdisplayfirst}] -\cs{glsdisplayfirst} +\cs{glsdisplayfirst}\marg{first/first plural}\marg{description}\marg{symbol}\marg{insert} \end{definition} which is used the first time a glossary entry is used\ifirstuse\ in the text and \begin{definition}[\DescribeMacro{\glsdisplay}] -\cs{glsdisplay} +\cs{glsdisplay}\marg{text/plural}\marg{description}\marg{symbol}\marg{insert} \end{definition} which is used subsequently. Both commands take four arguments: the first is either the singular or @@ -2589,12 +2469,13 @@ print the first argument immediately followed by the fourth argument. The remaining arguments are ignored. If required, you can access the label for the given entry via -\DescribeMacro{\glslabel}\ics{glslabel}, so it is possible to use -this label in the definition of \cs{glsdisplay} or -\cs{glsdisplayfirst} to supply additional information using any of -the commands described in -\ifmakedtx{\autoref{sec:glsnolink}}{\htmlref{Using Glossary Terms -Without Links}{sec:glsnolink}}, if required. +\begin{definition}[\DescribeMacro{\glslabel}] +\cs{glslabel} +\end{definition} +so it is possible to use this label in the definition of +\cs{glsdisplay} or \cs{glsdisplayfirst} to supply additional +information using any of the commands described in +\sectionref{sec:glsnolink}, if required. Note that \cs{glsdisplay} and \cs{glsdisplayfirst} are not used by \ics{glslink}. If you want to supply your own link text, you @@ -2608,15 +2489,15 @@ description={The length between two points}, symbol={km}} \end{verbatim} and now suppose you want \verb|\gls{distance}| to produce -\dq{distance (km)} on \firstuse, then you can redefine +\qt{distance (km)} on \firstuse, then you can redefine \cs{glsdisplayfirst} as follows: \begin{verbatim} \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} \end{verbatim} Note that the additional text is placed after \verb|#1|, so -\verb|\gls{distance}['s]| will produce \dq{distance's (km)} -rather than \dq{distance (km)'s} which looks a bit odd (even though -it may be in the context of \dq{the distance (km) is measured between +\verb|\gls{distance}['s]| will produce \qt{distance's (km)} +rather than \qt{distance (km)'s} which looks a bit odd (even though +it may be in the context of \qt{the distance (km) is measured between the two points} --- but in this instance it would be better not to use a contraction). @@ -2626,7 +2507,7 @@ to \ics{glstextformat} (described earlier). So if you do, say: \renewcommand{\glstextformat}[1]{\textbf{#1}} \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} \end{verbatim} -then \verb|\gls{distance}| will produce \dq{\textbf{distance (km)}}. +then \verb|\gls{distance}| will produce \qt{\textbf{distance (km)}}. If you have multiple glossaries, changing \cs{glsdisplayfirst} and \cs{glsdisplay} will change the way entries for all of the @@ -2654,34 +2535,32 @@ redefined above. For example, suppose you have created a new glossary called \texttt{notation} and you want to change the way the entry is -displayed on \firstuse\ so that it includes the symbol, you can -do: +displayed on \firstuse\ so that it includes the symbol, you can do: \begin{verbatim} \defglsdisplayfirst[notation]{#1#4 (denoted #3)} \end{verbatim} Now suppose you have defined an entry as follows: \begin{verbatim} \newglossaryentry{set}{type=notation, -name=set, -description={A collection of objects}, -symbol={$S$} + name=set, + description={A collection of objects}, + symbol={$S$} } \end{verbatim} -The first time you reference this entry using \cs{gls} it -will be displayed as: \dq{set (denoted \ifmakedtx{$S$}{\textit{S}})} -(similarly for \cs{glspl} and the uppercase variants). +The first time you reference this entry it will be displayed as: +\qt{set (denoted $S$)} (assuming \ics{gls} was used). Remember that if you use the \gloskey{symbol} key, you need to use a -glossary style that displays the symbol, as many of the styles ignore -it. In addition, if you want either the description or symbol to appear -in the \term{link text}, you will have to disable the -\ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} -of these keys and protect fragile commands.\ifmakedtx{}{\toTop} +glossary style that displays the symbol, as many of the styles +ignore it. In addition, if you want either the description or symbol +to appear in the \term{link text}, you will have to disable the +\hyperlink{sanitize}{sanitization} of these keys and protect fragile +commands. \subsubsection{Enabling and disabling hyperlinks to glossary entries} -If you load the \isty{hyperref} or \isty{html} packages prior to -loading the \sty{glossaries} package, commands such as \ics{glslink} +If you load the \sty{hyperref} or \sty{html} packages prior to +loading the \styfmt{glossaries} package, commands such as \ics{glslink} and \ics{gls}, described above, will automatically have hyperlinks to the relevant glossary entry, unless the \gloskey[glslink]{hyper} option has been set to \texttt{false}. You can disable or enable links using: @@ -2695,13 +2574,13 @@ and respectively. The effect can be localised by placing the commands within a group. Note that you should only use \cs{glsenablehyper} if the commands \ics{hyperlink} and \ics{hypertarget} have been -defined (for example, by the \isty{hyperref} package). +defined (for example, by the \sty{hyperref} package). You can disable just the first use links using the package option \pkgopt[false]{hyperfirst}. Note that this option only affects commands that recognise the \firstuse\ flag, for example \ics{gls}, \ics{glspl} and \ics{glsdisp} but not \ics{glslink}. -\ifmakedtx{}{\toTop} + \subsection{Adding an Entry to the Glossary Without Generating Text} \label{sec:glsadd} @@ -2738,7 +2617,7 @@ do: \begin{verbatim} \glsaddall[types={\acronymtype,notation}] \end{verbatim} -\ifmakedtx{}{\toTop} + \subsection{Cross-Referencing Entries} \label{sec:crossref} @@ -2755,34 +2634,28 @@ description={firm, round fruit. See also \gls{pear}}} \end{verbatim} Note that with this method, if you don't use the cross-referenced term in the glossary, you will need two runs of -\appname{makeglossaries}: -\begin{verbatim} +\app{makeglossaries}: +\begin{prompt} latex filename makeglossaries filename latex filename makeglossaries filename latex filename -\end{verbatim} +\end{prompt} -\item As described \ifmakedtx{in -\autoref{sec:newglosentry}}{\htmlref{earlier}{sec:newglosentry}}, -you can use the \gloskey{see} key when you define the entry. For -example: +\item As described in \sectionref{sec:newglosentry}, you can use the +\gloskey{see} key when you define the entry. For example: \begin{verbatim} \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -description={Series expansion}, -see={TaylorsTheorem}} +description={Series expansion}, see={TaylorsTheorem}} \end{verbatim} Note that in this case, the entry with the \gloskey{see} key will automatically be added to the glossary, but the cross-referenced entry won't. You therefore need to ensure that you use the -cross-referenced term with the commands described in -\ifmakedtx{\autoref{sec:glslink}}{Links to Glossary Entries} or -\ifmakedtx{\autoref{sec:glsadd}}{Adding an Entry to the Glossary -Without Generating Text}. +cross-referenced term with the commands described in +\sectionref{sec:glslink} or \sectionref{sec:glsadd}. - -You can optionally override the \dq{see} tag using square brackets +You can optionally override the \qt{see} tag using square brackets at the start of the \gloskey{see} value. For example: \begin{verbatim} \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, @@ -2796,7 +2669,7 @@ see=[see also]{TaylorsTheorem}} \end{definition} where \meta{xr label list} is a comma-separated list of entry labels to be cross-referenced, \meta{label} is the label of the -entry doing the cross-referencing and \meta{tag} is the \dq{see} tag. +entry doing the cross-referencing and \meta{tag} is the \qt{see} tag. For example: \begin{verbatim} \glssee[see also]{series}{FourierSeries,TaylorsTheorem} @@ -2809,17 +2682,17 @@ by \meta{xr label list}) to the glossary. In both cases~2 and 3 above, the cross-referenced information appears in the \term{number list}, whereas in case~1, the cross-referenced information appears in the description. In cases~2 and~3, the -default text for the \dq{see} tag is given by \ics{seename}. -\ifmakedtx{}{\toTop} +default text for the \qt{see} tag is given by \ics{seename}. + \subsection{Using Glossary Terms Without Links} \label{sec:glsnolink} The commands described in this section display entry details without -adding any information to the glossary. They don't use -\cs{glstextformat}, they don't have any optional arguments, -they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce -hyperlinks. +adding any information to the glossary. They don't use +\cs{glstextformat}, they don't have any optional arguments, they +don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, +they don't produce hyperlinks. \begin{definition}[\DescribeMacro{\glsentryname}] \cs{glsentryname}\marg{label} \end{definition} @@ -2827,7 +2700,7 @@ hyperlinks. \cs{Glsentryname}\marg{label} \end{definition} These commands display the name of the glossary entry given by -\meta{label}, as specified by the \gloskey{name} key. +\meta{label}, as specified by the \gloskey{name} key. \cs{Glsentryname} makes the first letter uppercase. \begin{definition}[\DescribeMacro{\glsentrytext}] \cs{glsentrytext}\marg{label} @@ -2835,8 +2708,8 @@ These commands display the name of the glossary entry given by \begin{definition}[\DescribeMacro{\Glsentrytext}] \cs{Glsentrytext}\marg{label} \end{definition} -These commands display the subsequent use text for the glossary entry -given by \meta{label}, as specified by the \gloskey{text} key. +These commands display the subsequent use text for the glossary +entry given by \meta{label}, as specified by the \gloskey{text} key. \cs{Glsentrytext} makes the first letter uppercase. \begin{definition}[\DescribeMacro{\glsentryplural}] \cs{glsentryplural}\marg{label} @@ -2844,17 +2717,18 @@ given by \meta{label}, as specified by the \gloskey{text} key. \begin{definition}[\DescribeMacro{\Glsentryplural}] \cs{Glsentryplural}\marg{label} \end{definition} -These commands display the subsequent use plural text for the glossary -entry given by \meta{label}, as specified by the \gloskey{plural} key. -\cs{Glsentryplural} makes the first letter uppercase. +These commands display the subsequent use plural text for the +glossary entry given by \meta{label}, as specified by the +\gloskey{plural} key. \cs{Glsentryplural} makes the first letter +uppercase. \begin{definition}[\DescribeMacro{\glsentryfirst}] \cs{glsentryfirst}\marg{label} \end{definition} \begin{definition}[\DescribeMacro{\Glsentryfirst}] \cs{Glsentryfirst}\marg{label} \end{definition} -These commands display the \firstusetext\ for the glossary entry -given by \meta{label}, as specified by the \gloskey{first} key. +These commands display the \firstusetext\ for the glossary entry +given by \meta{label}, as specified by the \gloskey{first} key. \cs{Glsentryfirst} makes the first letter uppercase. \begin{definition}[\DescribeMacro{\glsentryfirstplural}] \cs{glsentryfirstplural}\marg{label} @@ -2862,9 +2736,9 @@ given by \meta{label}, as specified by the \gloskey{first} key. \begin{definition}[\DescribeMacro{\Glsentryfirstplural}] \cs{Glsentryfirstplural}\marg{label} \end{definition} -These commands display the plural form of the \firstusetext\ for the -glossary entry given by \meta{label}, as specified by the -\gloskey{firstplural} key. \cs{Glsentryfirstplural} makes the first +These commands display the plural form of the \firstusetext\ for the +glossary entry given by \meta{label}, as specified by the +\gloskey{firstplural} key. \cs{Glsentryfirstplural} makes the first letter uppercase. \begin{definition}[\DescribeMacro{\glsentrydesc}] \cs{glsentrydesc}\marg{label} @@ -2872,17 +2746,17 @@ letter uppercase. \begin{definition}[\DescribeMacro{\Glsentrydesc}] \cs{Glsentrydesc}\marg{label} \end{definition} -These commands display the description for the glossary entry given by -\meta{label}. \cs{Glsentrydesc} makes the first letter uppercase. +These commands display the description for the glossary entry given +by \meta{label}. \cs{Glsentrydesc} makes the first letter uppercase. \begin{definition}[\DescribeMacro{\glsentrydescplural}] \cs{glsentrydescplural}\marg{label} \end{definition} \begin{definition}[\DescribeMacro{\Glsentrydescplural}] \cs{Glsentrydescplural}\marg{label} \end{definition} -These commands display the plural description for the glossary entry -given by \meta{label}. \cs{Glsentrydescplural} makes the first letter -uppercase. +These commands display the plural description for the glossary entry +given by \meta{label}. \cs{Glsentrydescplural} makes the first +letter uppercase. \begin{definition}[\DescribeMacro{\glsentrysymbol}] \cs{glsentrysymbol}\marg{label} \end{definition} @@ -2897,8 +2771,9 @@ These commands display the symbol for the glossary entry given by \begin{definition}[\DescribeMacro{\Glsentrysymbolplural}] \cs{Glsentrysymbolplural}\marg{label} \end{definition} -These commands display the plural symbol for the glossary entry given by -\meta{label}. \cs{Glsentrysymbolplural} makes the first letter uppercase. +These commands display the plural symbol for the glossary entry +given by \meta{label}. \cs{Glsentrysymbolplural} makes the first +letter uppercase. \begin{definition}[\DescribeMacro{\glsentryuseri}] \cs{glsentryuseri}\marg{label} \end{definition} @@ -2935,8 +2810,8 @@ These commands display the plural symbol for the glossary entry given by \begin{definition}[\DescribeMacro{\Glsentryuservi}] \cs{Glsentryuservi}\marg{label} \end{definition} -These commands display the value of the user keys for the glossary entry given by -\meta{label}. +These commands display the value of the user keys for the glossary +entry given by \meta{label}. \begin{definition}[\DescribeMacro{\glshyperlink}] \cs{glshyperlink}\oarg{link text}\marg{label} \end{definition} @@ -2947,34 +2822,33 @@ glossary file}. The link text is given by using the optional argument. \begin{important} If you use \cs{glshyperlink}, you need to ensure that the relevant -entry has been added to the glossary using any of the -commands described in \ifmakedtx{\autoref{sec:glslink} or \autoref{sec:glsadd}}{\htmlref{Links to Glossary Entries}{sec:glslink} or -\htmlref{Adding an Entry to the Glossary Without Generating -Text}{sec:glsadd}} otherwise you will end up with a broken -link. +entry has been added to the glossary using any of the commands +described in \sectionref{sec:glslink} or \sectionref{sec:glsadd} +otherwise you will end up with a broken link. \end{important} -For further information see \ifmakedtx{\autoref{sec:code:glsnolink}}{the -section \dq{Displaying entry details without adding information to -the glossary} in the document \url{glossaries.pdf}}. -\ifmakedtx{}{\toTop} +For further information see \ifpdf +\sectionref{sec:code:glsnolink}\else the section \qt{Displaying +entry details without adding information to the glossary} in the +document \url{glossaries.pdf}\fi. + \subsection{Displaying a glossary} \label{sec:printglossary} -\DescribeMacro{\printglossaries} -The command \cs{printglossaries} will display all the -glossaries in the order in which they were defined. -Note that no glossaries will appear until -you have either used the Perl script \appname{makeglossaries} -or have directly used \appname{makeindex} or \appname{xindy} (as -described in -\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the -Associated Glossary Files}{sec:makeglossaries}}). If the glossary +The command +\begin{definition}[\DescribeMacro{\printglossaries}] +\cs{printglossaries} +\end{definition} +will display all the glossaries in the order in which they were +defined. Note that no glossaries will appear until you have either +used the Perl script \app{makeglossaries} or have directly used +\app{makeindex} or \app{xindy} (as described in +\sectionref{sec:makeglossaries}). If the glossary still does not appear after you re-\LaTeX\ your document, check the -\appname{makeindex}/\appname{xindy} log files to see if there is a -problem. Remember that you also need to use the command -\ics{makeglossaries} in the preamble to enable the glossaries. +\app{makeindex}/\app{xindy} log files to see if there is a problem. +Remember that you also need to use the command \ics{makeglossaries} +in the preamble to enable the glossaries. An individual glossary can be displayed using: \begin{definition}[\DescribeMacro{\printglossary}] @@ -3007,7 +2881,7 @@ of the \pkgopt{style} package option or \ics{glossarystyle}. whether to use a numbered section for this glossary, overriding the effect of the \pkgopt{numberedsection} package option. This key has the same syntax as the \pkgopt{numberedsection} package -option, described \ifmakedtx{in \autoref{sec:pkgopts}}{\htmlref{earlier}{sec:pkgopts}}. +option, described in \sectionref{sec:pkgopts}. \item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist @@ -3017,10 +2891,23 @@ assumed. \end{description} -\DescribeMacro{\glossarypreamble} +By default, the glossary is started either by \cs{chapter*} or by +\cs{section*}, depending on whether or not \cs{chapter} is defined. +This can be overridden by the \pkgopt{section} package option or the +\cs{setglossarysection} command. Numbered sectional units can be +obtained using the \pkgopt{numberedsection} package option. Each +glossary sets the page header via the command \ics{glossarymark}. If +this mechanism is unsuitable for your chosen class file or page +style package, you will need to redefine \ics{glossarymark}. Further +information about these options and commands is given in +\sectionref{sec:pkgopts}. + Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -\cs{glossarypreamble}. For example: +\begin{definition}[\DescribeMacro{\glossarypreamble}] +\cs{glossarypreamble} +\end{definition} +For example: \begin{verbatim} \renewcommand{\glossarypreamble}{Numbers in italic indicate primary definitions.} @@ -3049,53 +2936,56 @@ change the preamble to do nothing for subsequent glossaries. (Note that \cs{gdef} is required as the glossary is placed within a group.) -\DescribeMacro{\glossarypostamble}There is an analogous command -called \cs{glossarypostamble} which is placed at the end of each -glossary.\ifmakedtx{}{\toTop} +There is an analogous command called +\begin{definition}[\DescribeMacro{\glossarypostamble}] +\cs{glossarypostamble} +\end{definition} +which is placed at the end of each glossary. \subsubsection{Changing the way the entry name appears in the glossary} \label{sec:glsnamefont} -\DescribeMacro{\glsnamefont}Within each glossary, each entry name is -formatted according to \cs{glsnamefont} which takes one argument: -the entry name. This command is always used regardless of the -glossary style. By default, \cs{glsnamefont} simply displays its -argument in whatever the surrounding font happens to be. This means -that in the list-like glossary styles (defined in the -\isty{glossary-list} style file) the name will appear in bold, since -the name is placed in the optional argument of \cs{item}, whereas in -the tabular styles (defined in the \isty{glossary-long} and -\isty{glossary-super} style files) the name will appear in the -normal font. The hierarchical glossary styles (defined in the -\isty{glossary-tree} style file) also set the name in bold. +Within each glossary, each entry name is formatted according to +\begin{definition}[\DescribeMacro{\glsnamefont}] +\cs{glsnamefont}\marg{name} +\end{definition} +which takes one argument: the entry name. This command is always +used regardless of the glossary style. By default, \cs{glsnamefont} +simply displays its argument in whatever the surrounding font +happens to be. This means that in the list-like glossary styles +(defined in the \sty{glossary-list} style file) the name will appear +in bold, since the name is placed in the optional argument of +\cs{item}, whereas in the tabular styles (defined in the +\sty{glossary-long} and \sty{glossary-super} style files) the name +will appear in the normal font. The hierarchical glossary styles +(defined in the \sty{glossary-tree} style file) also set the name in +bold. For example, suppose you want all the entry names to appear in medium weight small caps, then you can do: \begin{verbatim} \renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} \end{verbatim} -\ifmakedtx{}{\toTop} + \subsubsection{Xindy} \label{sec:xindy} -If you want to use \appname{xindy} to sort the glossary, you +If you want to use \app{xindy} to sort the glossary, you must use the package option \pkgopt{xindy}: \begin{verbatim} \usepackage[xindy]{glossaries} \end{verbatim} This ensures that the glossary information is written in -\appname{xindy} syntax. +\app{xindy} syntax. -\ifmakedtx{Section~\ref{sec:makeglossaries}}{The section -\htmlref{Generating the Associated Glossary -Files}{sec:makeglossaries}} covers how to use the external +\sectionref{sec:makeglossaries} covers how to use the external indexing application. This section covers the commands provided -by the \sty{glossaries} package that allow you to adjust the -\appname{xindy} style file (\filetype{.xdy}) and parameters. +by the \styfmt{glossaries} package that allow you to adjust the +\app{xindy} style file (\filetype{.xdy}) and parameters. -To assist writing information to the \appname{xindy} style -file, the \sty{glossaries} package provides the following +To assist writing information to the \app{xindy} style +file, the \styfmt{glossaries} package provides the following commands: \begin{definition}[\DescribeMacro{\glsopenbrace}] \cs{glsopenbrace} @@ -3108,7 +2998,7 @@ which produce an open and closing brace. (This is needed because when written to a file.) In addition, if you are using a package that makes the double -quote character active (e.g. \isty{ngerman}) you can use: +quote character active (e.g. \sty{ngerman}) you can use: \begin{definition}[\DescribeMacro{\glsquote}] \cs{glsquote}\marg{text} \end{definition} @@ -3117,24 +3007,23 @@ you can use \verb|\string"| to write the double-quote character. This document assumes that the double quote character has not been made active, so the examples just use \verb|"| for clarity. -If you want greater control over the \appname{xindy} style file than -is available through the \LaTeX\ commands provided by the -\sty{glossaries} package, you will need to edit the \appname{xindy} -style file. In -which case, you must use \ics{noist} to prevent the style file from -being overwritten by the \sty{glossaries} package. For additional -information about \appname{xindy}, read the \appname{xindy} -documentation.\ifmakedtx{}{\toTop} +If you want greater control over the \app{xindy} style file than is +available through the \LaTeX\ commands provided by the +\styfmt{glossaries} package, you will need to edit the \app{xindy} +style file. In which case, you must use \ics{noist} to prevent the +style file from being overwritten by the \styfmt{glossaries} +package. For additional information about \app{xindy}, read the +\app{xindy} documentation. \paragraph{Language and Encodings} -When you use \appname{xindy}, you need to specify the language +When you use \app{xindy}, you need to specify the language and encoding used (unless you have written your own custom -\appname{xindy} style file that defines the relevant alphabet -and sort rules). If you use \appname{makeglossaries}, +\app{xindy} style file that defines the relevant alphabet +and sort rules). If you use \app{makeglossaries}, this information is obtained from the document's auxiliary -(\filetype{.aux}) file. The \sty{glossaries} package attempts to +(\filetype{.aux}) file. The \styfmt{glossaries} package attempts to find the root language, but in the event that it gets it wrong or if -\appname{xindy} doesn't support that language, then you can +\app{xindy} doesn't support that language, then you can specify the language using: \begin{definition}[\DescribeMacro{\GlsSetXdyLanguage}] \cs{GlsSetXdyLanguage}\oarg{glossary type}\marg{language} @@ -3146,7 +3035,7 @@ will be applied to all glossaries, otherwise the language setting will only be applied to the glossary given by \meta{glossary type}. -If the \isty{inputenc} package is used, the encoding will be +If the \sty{inputenc} package is used, the encoding will be obtained from the value of \ics{inputencodingname}. Alternatively, you can specify the encoding using: \begin{definition}[\DescribeMacro{\GlsSetXdyCodePage}] @@ -3165,7 +3054,7 @@ For example: \usepackage[xindy={language=english,codepage=utf8}]{glossaries} \end{verbatim} -If you write your own custom \appname{xindy} style file that +If you write your own custom \app{xindy} style file that includes the language settings, you need to set the language to nothing: \begin{verbatim} @@ -3176,18 +3065,18 @@ being overwritten). \begin{important} The commands \cs{GlsSetXdyLanguage} and \cs{GlsSetXdyCodePage} -have no effect if you don't use \appname{makeglossaries}. If -you call \appname{xindy} without \appname{makeglossaries} you +have no effect if you don't use \app{makeglossaries}. If +you call \app{xindy} without \app{makeglossaries} you need to remember to set the language and encoding using the \texttt{-L} and \texttt{-C} switches. \end{important} -\ifmakedtx{}{\toTop} + \paragraph{Locations and Number lists} The most likely attributes used in the \gloskey[glslink]{format} key (\locfmt{textrm}, \locfmt{hyperrm} etc) are automatically added -to the \appname{xindy} style file, but if you want to use another +to the \app{xindy} style file, but if you want to use another attribute, you need to add it using: \begin{definition}[\DescribeMacro{\GlsAddXdyAttribute}] \cs{GlsAddXdyAttribute}\marg{name} @@ -3199,7 +3088,7 @@ command that will do this: \begin{verbatim} \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} \end{verbatim} -but with \appname{xindy}, I also need to add this as an allowed +but with \app{xindy}, I also need to add this as an allowed attribute: \begin{verbatim} \GlsAddXdyAttribute{hyperbfit} @@ -3217,7 +3106,7 @@ Roman number or a letter from a, \ldots, z or A, \ldots, Z, then you need to add a location style in the appropriate format. For example, suppose you want the page numbers written as words -rather than digits and you use the \isty{fmtcount} package to +rather than digits and you use the \sty{fmtcount} package to do this. You can redefine \ics{thepage} as follows: \begin{verbatim} \renewcommand*{\thepage}{\Numberstring{page}} @@ -3232,7 +3121,7 @@ define a new location that has that form: \end{verbatim} Note that it's necessary to use \cs{space} to indicate that spaces also appear in the format, since, unlike \TeX, -\appname{xindy} doesn't ignore spaces after control sequences. +\app{xindy} doesn't ignore spaces after control sequences. \begin{important} Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is @@ -3241,33 +3130,26 @@ used or if \ics{makeglossaries} is omitted. \cs{GlsAddXdyLocation} must be used before \ics{makeglossaries}. \end{important} -In the \term{number list}, the locations are sorted according to -type. The default ordering is: -\texttt{roman-page-numbers} (e.g.\ i), -\texttt{arabic-page-numbers} (e.g.\ 1), -\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor -is a full stop or 1-1 if the compositor is a hyphen\footnote{see -\ics{setCompositor} described in -\ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary -Entries}{sec:newglosentry}}}), -\texttt{alpha-page-numbers} (e.g.\ a), -\texttt{Roman-page-numbers} (e.g.\ I), -\texttt{Alpha-page-numbers} (e.g.\ A), -\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor -is a full stop or A-1 if the Alpha compositor is a -hyphen\footnote{see \ics{setAlphaCompositor} described in -\ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary -Entries}{sec:newglosentry}}}), -user defined location names (as specified by -\ics{GlsAddXdyLocation} in the order in which they were defined), -\texttt{see} (cross-referenced entries). -This ordering can be changed using: +In the \term{number list}, the locations are sorted according to +type. The default ordering is: \texttt{roman-page-numbers} (e.g.\ +i), \texttt{arabic-page-numbers} (e.g.\ 1), +\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor is a +full stop or 1-1 if the compositor is a hyphen\footnote{see +\ics{setCompositor} described in \sectionref{sec:newglosentry}}), +\texttt{alpha-page-numbers} (e.g.\ a), \texttt{Roman-page-numbers} +(e.g.\ I), \texttt{Alpha-page-numbers} (e.g.\ A), +\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor is +a full stop or A-1 if the Alpha compositor is a hyphen\footnote{see +\ics{setAlphaCompositor} described in +\sectionref{sec:newglosentry}}), user defined location names (as +specified by \ics{GlsAddXdyLocation} in the order in which they were +defined), \texttt{see} (cross-referenced entries). This ordering can +be changed using: \begin{definition}[\DescribeMacro{\GlsSetXdyLocationClassOrder}] \cs{GlsSetXdyLocationClassOrder}\marg{location names} \end{definition} where each location name is delimited by double quote marks and -separated by white space. -For example: +separated by white space. For example: \begin{verbatim} \GlsSetXdyLocationClassOrder{ "arabic-page-numbers" @@ -3301,7 +3183,7 @@ For example: \GlsSetXdyMinRangeLength{3} \end{verbatim} The argument may also be the keyword \texttt{none}, to indicate that -there should be no range formations. See the \appname{xindy} +there should be no range formations. See the \app{xindy} manual for further details on range formations. \begin{important} @@ -3312,13 +3194,12 @@ is used or if \ics{makeglossaries} is omitted. \ics{makeglossaries}. \end{important} -See \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}} for -further details. -\ifmakedtx{}{\toTop} +See \sectionref{sec:numberlists} for further details. + \paragraph{Glossary Groups} The glossary is divided into groups according to the first -letter of the sort key. The \sty{glossaries} package also adds +letter of the sort key. The \styfmt{glossaries} package also adds a number group by default, unless you suppress it in the \pkgopt{xindy} package option. For example: \begin{verbatim} @@ -3328,7 +3209,7 @@ Any entry that doesn't go in one of the letter groups or the number group is placed in the default group. If you have a number group, the default behaviour is to locate -it before the \dq{A} letter group. If you are not using a +it before the \qt{A} letter group. If you are not using a Roman alphabet, you can change this using\\[10pt] \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} @@ -3339,7 +3220,7 @@ Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if \cs{GlsSetXdyFirstLetterAfterDigits} must be used before \ics{makeglossaries}. \end{important} -\ifmakedtx{}{\toTop} + \subsection{Defining New Glossaries} \label{sec:newglossary} @@ -3348,16 +3229,16 @@ A new glossary can be defined using: \begin{definition}[\DescribeMacro{\newglossary}] \cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\oarg{counter} \end{definition} -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 -first optional argument specifies the extension for the -\appname{makeindex} or \appname{xindy} transcript file (this -information is only used by \appname{makeglossaries} which picks up -the information from the auxiliary file). +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 +\sectionref{sec:numberlists}). The first optional argument specifies +the extension for the \app{makeindex} or \app{xindy} transcript file +(this information is only used by \app{makeglossaries} which picks +up the information from the auxiliary file). Note that the main (default) glossary is automatically created as: \begin{verbatim} @@ -3383,38 +3264,37 @@ it as a list of acronyms using the package option All glossaries must be defined before \ics{makeglossaries} to ensure that the relevant output files are opened. \end{important} -\ifmakedtx{}{\toTop} + \subsection{Acronyms} \label{sec:acronyms} -You may have noticed in \ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary Entries}{sec:newglosentry}} that when you -specify a new entry, you can specify alternate text to use when -the term is first used\ifirstuse\ in the document. This provides a useful -means to define acronyms. For convenience, the \sty{glossaries} package -defines the command: +You may have noticed in \sectionref{sec:newglosentry} that when you +specify a new entry, you can specify alternate text to use when the +term is first used\ifirstuse\ in the document. This provides a +useful means to define acronyms. For convenience, the +\styfmt{glossaries} package defines the command: \begin{definition}[\DescribeMacro{\newacronym}] -\cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long} -\end{definition} -By default, this is equivalent to:\vskip5pt -\begin{ttfamily}\par\noindent -\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype},\\ -name=\textrm{\marg{abbrv}},\\ -description=\textrm{\marg{long}},\\ -text=\textrm{\marg{abbrv}},\\ -first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\},\\ -plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\},\\ -firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} -(\textrm{\meta{abbrv}}\cs{glspluralsuffix})\},\\ -\textrm{\meta{key-val list}}\}\par -\end{ttfamily} -\vskip5pt -As mentioned in the previous section, the command \ics{acronymtype} -is the name of the glossary in which the acronyms should appear. If -the \pkgopt{acronym} package option has been used, this will be -\texttt{acronym}, otherwise it will be \texttt{main}. The acronyms -can then be used in exactly the same way as any other glossary -entry. If you want more than one list of acronyms, you must +\cs{newacronym}\oarg{key-val +list}\marg{label}\marg{abbrv}\marg{long} +\end{definition} +By default, this is equivalent to: +\begin{display}\ttfamily +\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype}, +name=\textrm{\marg{abbrv}}, +description=\textrm{\marg{long}}, +text=\textrm{\marg{abbrv}}, +first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\}, +plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\}, +firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} (\textrm{\meta{abbrv}}\cs{glspluralsuffix})\}, +\textrm{\meta{key-val list}}\} +\end{display} +As mentioned in the previous section, the command +\ics{acronymtype} is the name of the glossary in which the acronyms +should appear. If the \pkgopt{acronym} package option has been used, +this will be \texttt{acronym}, otherwise it will be \texttt{main}. +The acronyms can then be used in exactly the same way as any other +glossary entry. If you want more than one list of acronyms, you must identify the others using the package options \pkgopt{acronymlists}. This ensures that options such as \pkgopt{footnote} and \pkgopt{smallcaps} work for the additional lists of acronyms. @@ -3422,10 +3302,10 @@ This ensures that options such as \pkgopt{footnote} and \begin{important}% \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 +\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| in the optional argument to -\ics{newacronym}. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}. +\ics{newacronym}. See \sectionref{sec:loadglsentries}. \end{important} For example, the following defines the acronym IDN: @@ -3442,21 +3322,30 @@ first={identification number (IDN)}, plural={IDNs}, firstplural={identification numbers (IDNs)}} \end{verbatim} -so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on -\firstuse\ and \dq{IDN} on subsequent uses. +so \verb|\gls{idn}| will produce \qt{identification number (IDN)} on +\firstuse\ and \qt{IDN} on subsequent uses. This section describes acronyms that have been defined using -\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} and \pkgopt{footnote}, as these -options change the definition of \ics{newacronym} for common acronym -formats as well as the way that the link text is displayed (see -\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{earlier}{sec:glsdisplay}}). -Likewise you should ignore the package option \pkgopt{shortcuts} -and the new commands described in this section, -such as \cs{acrshort}, as they vary according to the definition of -\ics{newacronym}. +\ics{newacronym}. If you prefer to define your acronyms using +\ics{newglossaryentry} explicitly, then you should skip this section +and ignore the package options: \pkgopt{smallcaps}, +\pkgopt{smaller}, \pkgopt{description}, \pkgopt{dua} and +\pkgopt{footnote}, as these options change the definition of +\ics{newacronym} for common acronym formats as well as the way that +the link text is displayed (see \sectionref{sec:glsdisplay}). +Likewise you should ignore the package option \pkgopt{shortcuts} and +the new commands described in this section, such as \ics{acrshort}, +as they vary according to the definition of \ics{newacronym}. + +If you want to define your own custom acronym style, see +\sectionref{sec:customacronym}. + +\begin{important} +If you try using \ics{newglossaryentry} for entries in a designated +list of acronyms in combination with any of the above named package +options you are likely to get unexpected results such as empty +brackets or empty footnotes. +\end{important} If you use any of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{description} or @@ -3486,7 +3375,7 @@ emphasized on subsequent use, do: \renewcommand*{\firstacronymfont}[1]{#1} \renewcommand*{\acronymfont}[1]{\emph{#1}} \end{verbatim} -(Note that it is for this reason that the \isty{relsize} package +(Note that it is for this reason that the \sty{relsize} package is not automatically loaded when selecting the \pkgopt{smaller} package option.) @@ -3498,7 +3387,7 @@ form). Note that the \pkgopt{smallcaps} option redefines you should use lower case characters in \meta{abbrv}) and the \pkgopt{smaller} option redefines \cs{acronymfont} to use \cs{textsmaller},\footnote{you will need to load a package, such as -\sty{relsize}, that defines \cs{textsmaller} if you use this +\styfmt{relsize}, that defines \cs{textsmaller} if you use this option.}\ otherwise \cs{acronymfont} simply displays its argument in the surrounding font. @@ -3557,7 +3446,7 @@ None of the above& \end{table} In case you can't remember which key stores the long or short forms -(or their plurals) the \sty{glossaries} package provides the +(or their plurals) the \styfmt{glossaries} package provides the commands: \begin{itemize} \item\DescribeMacro{\glsshortkey}\cs{glsshortkey} @@ -3578,25 +3467,26 @@ matrix} If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will display: diagonal matrices (DMs). -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}}) -to change the way the link text is displayed. This means that these -package options only work for the glossary type given by -\cs{acronymtype}. If you have multiple lists of acronyms, you -will need to make the appropriate changes for each additional -glossary type. +Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +\pkgopt{footnote}, \pkgopt{dua} and \pkgopt{description} use +\ics{defglsdisplay} and \ics{defglsdisplayfirst} (described in +\sectionref{sec:glsdisplay}) to change the way the link text is +displayed. This means that these package options only work for the +glossary type given by \cs{acronymtype}. If you have multiple lists +of acronyms, you will need to make the appropriate changes for each +additional glossary type. \begin{description} -\item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} +\item[\pkgopt{description},\pkgopt{footnote}]\ifpdf\mbox{}\par\fi When these two package options are used together, the \firstuse\ displays -the entry as:\\[10pt] +the entry as: +\begin{display} \cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} -\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +\end{display} +while subsequent use displays the entry as: +\begin{display} +\cs{acronymfont}\marg{abbrv}\meta{insert} +\end{display} where \meta{insert} indicates the text supplied in the final optional argument to \cs{gls}, \cs{glspl} or their uppercase variants. @@ -3608,17 +3498,20 @@ symbol (for example, the \glostyle{index} style). Entries will be sorted according to the short form. Note also that when these two package options are used (in the -given order), the \sty{glossaries} package additionally implements the +given order), the \styfmt{glossaries} package additionally implements the \pkgopt{sanitize} option using \ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so remember to protect fragile commands when defining acronyms. -\item[\pkgopt{dua}]\ifmakedtx{\mbox{}\par}{} +\item[\pkgopt{dua}]\ifpdf\mbox{}\par\fi The \pkgopt{dua} package option always displays the expanded form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or \pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the -entry in the form:\\[10pt] -\meta{long}\meta{insert}\\[10pt] +entry in the form: +\begin{display} +\meta{long}\meta{insert} +\end{display} + If the \pkgopt{description} package option is also used, the \gloskey{name} key is set to the long form, otherwise the \gloskey{name} key is set to the short form and the @@ -3633,12 +3526,16 @@ is used, otherwise they will be sorted according to the short form (unless overridden by the \gloskey{sort} key in the optional argument of \ics{newacronym}). -\item[\pkgopt{description}]\ifmakedtx{\mbox{}\par}{} -This package option displays the entry on \firstuse\ as:\\[10pt] -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] -Note also that if this package option is used, the \sty{glossaries} +\item[\pkgopt{description}]\ifpdf\mbox{}\par\fi +This package option displays the entry on \firstuse\ as: +\begin{display} +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\end{display} +while subsequent use displays the entry as: +\begin{display} +\cs{acronymfont}\marg{abbrv}\meta{insert} +\end{display} +Note also that if this package option is used, the \styfmt{glossaries} package additionally implements the option \ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so remember to protect fragile commands when defining acronyms. @@ -3664,14 +3561,18 @@ entries will be sorted according to the short form, unless you override this using the \gloskey{sort} key in the optional argument to \ics{newacronym}. -\item[\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} -This package option displays the entry on \firstuse\ as:\\[10pt] -\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +\item[\pkgopt{footnote}]\ifpdf\mbox{}\par\fi +This package option displays the entry on \firstuse\ as: +\begin{display} +\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} +\end{display} +while subsequent use displays the entry as: +\begin{display} +\cs{acronymfont}\marg{abbrv}\meta{insert} +\end{display} Acronyms will be sorted according to the short form. -Note also that if this package option is used, the \sty{glossaries} +Note also that if this package option is used, the \styfmt{glossaries} package additionally implements the option \ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so remember to protect fragile commands when defining acronyms. @@ -3679,52 +3580,59 @@ remember to protect fragile commands when defining acronyms. Note that on \firstuse, it is the long form in the footnote that links to the relevant glossary entry (where hyperlinks are enabled), whereas on subsequent use, the acronym links to the relevant -glossary entry. It is possible to change this to make the acronym -on \firstuse\ have the hyperlink instead of the footnote, but -since the footnote marker will also be a hyperlink, you will -have two hyperlinks in immediate succession. This can be -ambiguous where the hyperlinks are coloured rather than boxed. -The code required to change the \firstuse\ to make the -acronym a hyperlink is as follows: +glossary entry. It is possible to change this to make the acronym on +\firstuse\ have the hyperlink instead of the footnote, but since the +footnote marker will also be a hyperlink, you will have two +hyperlinks in immediate succession. This can be ambiguous where the +hyperlinks are coloured rather than boxed. The code required to +change the \firstuse\ to make the acronym a hyperlink is as follows: \begin{verbatim} \defglsdisplayfirst[\acronymtype]{% \noexpand\protect\noexpand \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% \noexpand\protect\noexpand\footnote{#2}}% \end{verbatim} -\textbf{Note} that this involves using internal commands -(i.e.\ commands whose name contains an \verb|@| character), so -if this code is place in a \texttt{.tex} file it needs to be -placed within a \cs{makeatletter} \ldots\ \cs{makeatother} pair. -(See \ifmakedtx{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}}{\htmladdnormallink{\cs{@} and \texttt{@} in macro names}{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}} -for further details.) - -\item[\pkgopt{smallcaps}]\ifmakedtx{\mbox{}\par}{} +\textbf{Note} that this involves using internal commands (i.e.\ +commands whose name contains an \verb|@| character), so if this code +is place in a \texttt{.tex} file it needs to be placed within a +\cs{makeatletter} \ldots\ \cs{makeatother} pair. (See +\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}{\cs{@} +and \texttt{@} in macro names} for further details.) + +\item[\pkgopt{smallcaps}]\ifpdf\mbox{}\par\fi If neither the \pkgopt{footnote} nor \pkgopt{description} options -have been set, this option displays the entry on \firstuse\ as:\\[10pt] -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +have been set, this option displays the entry on \firstuse\ as: +\begin{display} +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\end{display} +while subsequent use displays the entry as: +\begin{display} +\cs{acronymfont}\marg{abbrv}\meta{insert} +\end{display} where \cs{acronymfont} is set to \verb|\textsc{#1}|. \begin{important} Note that since the acronym is displayed using \ics{textsc}, the short form, \meta{abbrv}, should be specified in lower case. -\ifmakedtx{(Recall that "\textsc{abc}" produces \textsc{abc} whereas -"\textsc{ABC}" produces \textsc{ABC}.)}{} +\ifpdf(Recall that "\textsc{abc}" produces \textsc{abc} whereas +"\textsc{ABC}" produces \textsc{ABC}.)\fi \end{important} -Note also that if this package option is used, the \sty{glossaries} +Note also that if this package option is used, the \styfmt{glossaries} package additionally implements the option \ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so remember to protect fragile commands when defining acronyms. -\item[\pkgopt{smaller}]\ifmakedtx{\mbox{}\par}{} +\item[\pkgopt{smaller}]\ifpdf\mbox{}\par\fi If neither the \pkgopt{footnote} nor \pkgopt{description} options -have been set, this option displays the entry on \firstuse\ as:\\[10pt] -\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +have been set, this option displays the entry on \firstuse\ as: +\begin{display} +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +\end{display} +while subsequent use displays the entry as: +\begin{display} +\cs{acronymfont}\marg{abbrv}\meta{insert} +\end{display} where \cs{acronymfont} is set to \verb|\textsmaller{#1}|.\footnote{not that this was change from using \ics{smaller} to \ics{textsmaller} as declarations @@ -3733,36 +3641,39 @@ The entries will be sorted according to the short form. \begin{important} Remember to load a package that defines \ics{textsmaller} (such as -\isty{relsize}) if you want to use this option, unless you want +\sty{relsize}) if you want to use this option, unless you want to redefine \ics{acronymfont} to use some other formatting command. \end{important} -Note also that if this package option is used, the \sty{glossaries} +Note also that if this package option is used, the \styfmt{glossaries} package additionally implements the option \ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so remember to protect fragile commands when defining acronyms. -\item[None of the above]\ifmakedtx{\mbox{}\par}{} +\item[None of the above]\ifpdf \mbox{}\par\fi If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, -then on \firstuse\ the entry is displayed as:\\[10pt] -\meta{long} (\meta{abbrv})\meta{insert}\\[10pt] -while subsequent use displays the entry as:\\[10pt] -\meta{abbrv}\meta{insert}\\[10pt] +then on \firstuse\ the entry is displayed as: +\begin{display} +\meta{long} (\meta{abbrv})\meta{insert} +\end{display} +while subsequent use displays the entry as: +\begin{display} +\meta{abbrv}\meta{insert} +\end{display} Entries will be sorted according to the short form. Note that if none of the acronym-related package options are used, the \pkgopt{sanitize} option will not be affected. \end{description} -Recall from \ifmakedtx{\autoref{sec:glslink}}{\htmlref{earlier}{sec:glslink}} -that you can access the values of individual keys using commands -like \ics{glstext}, so it is possible to use these commands to -print just the long form or just the abbreviation without affecting -the flag that determines whether the entry has been used. However -the keys that store the long and short form vary depending on -the acronym style, so the \sty{glossaries} package provides -commands that are set according to the package options. These are -as follows: +Recall from \sectionref{sec:glslink} that you can access the values +of individual keys using commands like \ics{glstext}, so it is +possible to use these commands to print just the long form or just +the abbreviation without affecting the flag that determines whether +the entry has been used. However the keys that store the long and +short form vary depending on the acronym style, so the +\styfmt{glossaries} package provides commands that are set according +to the package options. These are as follows: \begin{definition}[\DescribeMacro{\acrshort}] \cs{acrshort}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -3774,8 +3685,8 @@ as follows: \end{definition} Print the abbreviated version with (if required) a hyperlink to the relevant entry in the glossary. This is usually equivalent to -\ics{glstext} (or its uppercase variants) but may additionally -put the link text within the argument to \ics{acronymfont}. +\ics{glstext} (or its uppercase variants) but may additionally put +the link text within the argument to \ics{acronymfont}. \begin{definition}[\DescribeMacro{\acrlong}] \cs{acrlong}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -3787,7 +3698,7 @@ put the link text within the argument to \ics{acronymfont}. \end{definition} Print the long version with (if required) a hyperlink to the relevant entry in the glossary. This is may be equivalent to -\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase +\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase variants), depending on package options. \begin{definition}[\DescribeMacro{\acrfull}] \cs{acrfull}\oarg{options}\marg{label}\oarg{insert} @@ -3798,9 +3709,8 @@ variants), depending on package options. \begin{definition}[\DescribeMacro{\ACRfull}] \cs{ACRfull}\oarg{options}\marg{label}\oarg{insert} \end{definition} -Print the long version followed by the abbreviation in brackets -with (if required) a hyperlink to the -relevant entry in the glossary. +Print the long version followed by the abbreviation in brackets with +(if required) a hyperlink to the relevant entry in the glossary. \begin{important} Note that if any of the above commands produce unexpected output @@ -3821,7 +3731,7 @@ 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 +an \qt{undefined control sequence} error message, check that you have enabled the shortcuts using the \pkgopt{shortcuts} package option. Note that there are no shortcuts for the commands that produce all upper case text. @@ -3852,23 +3762,159 @@ produce all upper case text. \end{center} \end{table} -\ifmakedtx{}{\toTop} +\subsubsection{Defining A Custom Acronym Style} +\label{sec:customacronym} + +You may find that the predefined acronyms styles that come with the +\styfmt{glossaries} package don't suit your requirements. In this +case you can define your own style. This is done by redefining the +following commands: +\begin{definition}[\DescribeMacro{\CustomAcronymFields}] +\cs{CustomAcronymFields} +\end{definition} +This command sets up the keys for \ics{newglossaryentry} when +you define an acronym using \ics{newacronym}. Within the definition +of \cs{CustomAcronymFields}, you may use \cs{the}\ics{glslongtok} to +access the long form, \cs{the}\ics{glsshorttok} to access the short +form and \cs{the}\ics{glslabeltok} to access the label. This command +is typically used to set the \gloskey{name}, \gloskey{first}, +\gloskey{firstplural}, \gloskey{text} and \gloskey{plural} keys. It +may also be used to set the \gloskey{symbol} or +\gloskey{description} keys depending on your requirements. + +\begin{definition}[\DescribeMacro{\SetCustomDisplayStyle}] +\cs{SetCustomDisplayStyle}\marg{type} +\end{definition} +This is used to set up the display style for the glossary given by +\meta{type}. This should typically just use \ics{defglsdisplayfirst} +and \ics{defglsdisplay}. + +Once you have redefined \cs{CustomAcronymFields} and +\cs{SetCustomDisplayStyle}, you must then switch to this style using +\begin{definition}[\DescribeMacro{\SetCustomStyle}] +\cs{SetCustomStyle} +\end{definition} +Note that you may still use the \pkgopt{shortcuts} package option +with your custom style. + +\begin{important} +If you omit \cs{SetCustomStyle}, or use it before you redefine +\cs{CustomAcronymFields} and \cs{SetCustomDisplayStyle}, your new +style won't be correctly implemented. You must set up the custom style +before defining new acronyms. The acronyms must be defined using +\ics{newacronym} not \ics{newglossaryentry}. +\end{important} + +As an example, suppose I want my acronym on first use to have the +short form in the text and the long form with the description in a +footnote. Suppose also that I want the short form to be put in small +caps in the main body of the document, but I want it in normal +capitals in the list of acronyms. In my list of acronyms, I want the +long form as the name with the short form in brackets followed by +the description. + +First, I need to redefine \ics{CustomAcronymFields} so that +\ics{newacronym} will correctly set the \gloskey{name}, +\gloskey{text} and \gloskey{plural} keys. I want the long form to be +stored in the \gloskey{name} and the short form to be stored in +\gloskey{text}. In addition, I'm going to set the \gloskey{symbol} +to the short form in upper case so that it will appear in the list +of acronyms. + +\begin{verbatim} +\renewcommand*{\CustomAcronymFields}{% + name={\the\glslongtok},% + symbol={\MakeUppercase{\the\glsshorttok}},% + text={\textsc{\the\glsshorttok}},% + plural={\textsc{\the\glsshorttok}s}% +} +\end{verbatim} + +Note that in this case I haven't bothered with \ics{acrpluralsuffix} +and have just inserted an \qt{s}. + +When I use the custom acronym style, the short form is stored in +\gloskey{user1}, the plural short form is stored in \gloskey{user2}, +the long form is stored in \gloskey{user3} and the plural long form +is stored in \gloskey{user4}. So when I use \ics{defglsdisplayfirst} +and \ics{defglsdisplay}, I can use \ics{glsentryuseriii} to access +the long form. Recall from \sectionref{sec:glsdisplay}, that the +optional argument to \ics{defglsdisplayfirst} and \ics{defglsdisplay} +indicates the glossary type. This is passed to +\ics{SetCustomDisplayStyle}. The mandatory argument sets up the +definition of \ics{glsdisplayfirst} and \ics{glsdisplay} for the +given glossary, where the first argument corresponds to the +\gloskey{first}, \gloskey{firstplural}, \gloskey{text} or +\gloskey{plural}, as appropriate, the second argument corresponds to +the \gloskey{description}, the third corresponds to the +\gloskey{symbol} and the fourth argument is the inserted text. + +\begin{verbatim} +\renewcommand*{\SetCustomDisplayStyle}[1]{% + \defglsdisplayfirst[#1]{##1##4\protect\footnote{% + \glsentryuseriii{\glslabel}: ##2% + }} + \defglsdisplay[#1]{##1##4}% +} +\end{verbatim} + +Since we have a definition inside a definition, \verb|#1| refers to +the argument of \ics{SetCustomDisplayStyle}, and \verb|##1|, \ldots, +\verb|##4|, refer to the arguments of \ics{glsdisplayfirst} and +\ics{glsdisplay}. + +Now that I've redefined \ics{CustomAcronymFields} and +\ics{SetCustomDisplayStyle}, I can set this style using +\begin{verbatim} +\SetCustomStyle +\end{verbatim} +and now I can define my acronyms: +\begin{verbatim} +\newacronym[description={set of tags for use in developing hypertext +documents}]{html}{html}{Hyper Text Markup Language} + +\newacronym[description={language used to describe the layout of a +document written in a markup language}]{css}{css}{Cascading Style +Sheet} +\end{verbatim} + +Note that since I've used the description in the main body of the +text, I need to switch off the sanitization otherwise any commands +within the description won't get interpreted. Also I want to use the +\sty{hyperref} package, but this will cause a problem on first use +as I'll get nested hyperlinks, so I need to switch off the +hyperlinks on first use. In addition, I want to use a glossary style +that displays the symbol. Therefore, in my preamble I have: + +\begin{verbatim} +\usepackage[colorlinks]{hyperref} +\usepackage[acronym, % create list of acronyms + nomain, % don't need main glossary for this example + style=tree, % need a style that displays the symbol + hyperfirst=false,% don't hyperlink first use + sanitize=none % switch off sanitization as description + % will be used in the main text + ]{glossaries} +\end{verbatim} + +Note that I haven't used the \pkgopt{description} or +\pkgopt{footnote} package options. \subsubsection{Upgrading From the glossary Package} \label{sec:oldacronym} -Users of the obsolete \isty{glossary} package may recall that +Users of the obsolete \sty{glossary} package may recall that the syntax used to define new acronyms has changed with the -replacement \sty{glossaries} package. In addition, the old -\isty{glossary} package created the command +replacement \styfmt{glossaries} package. In addition, the old +\sty{glossary} package created the command \cs{}\meta{acr-name} when defining the acronym \meta{acr-name}. In order to facilitate migrating from the old package to the new -one, the \sty{glossaries} package\footnote{as from version 1.18} +one, the \styfmt{glossaries} package\footnote{as from version 1.18} provides the command: \begin{definition}[\DescribeMacro{\oldacronym}] \cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list} \end{definition} -This uses the same syntax as the \isty{glossary} package's +This uses the same syntax as the \sty{glossary} package's method of defining acronyms. It is equivalent to:\\[10pt] \ics{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt] In addition, \ics{oldacronym} also defines the commands @@ -3886,21 +3932,21 @@ settings. Recall that, in general, \LaTeX\ ignores spaces following command names consisting of alphabetical characters. This is also true for \cs{}\meta{label} unless you additionally load the -\isty{xspace} package. +\sty{xspace} package. \end{important} -The \sty{glossaries} package doesn't load the \isty{xspace} package +The \styfmt{glossaries} package doesn't load the \sty{xspace} package since there are both advantages and disadvantages to using \ics{xspace} in \cs{}\meta{label}. If you don't use the -\isty{xspace} package you need to explicitly force a space using +\sty{xspace} package you need to explicitly force a space using \verb*|\ | (backslash space) however you can follow \cs{}\meta{label} with additional text in square brackets (the final optional -argument to \ics{gls}). If you use the \isty{xspace} package +argument to \ics{gls}). If you use the \sty{xspace} package you don't need to escape the spaces but you can't use the optional argument to insert text (you will have to explicitly use \ics{gls}). -To illustrate this, suppose I define the acronym \dq{abc} as +To illustrate this, suppose I define the acronym \qt{abc} as follows: \begin{verbatim} \oldacronym{abc}{example acronym}{} @@ -3908,19 +3954,19 @@ follows: This will create the command \cs{abc} and its starred version \cs{abc*}. \Tableref{tab:xspace} illustrates the effect of \cs{abc} (on subsequent use) according to whether or not the -\isty{xspace} package has been loaded. As can be seen from the -final row in the table, the \isty{xspace} package prevents the +\sty{xspace} package has been loaded. As can be seen from the +final row in the table, the \sty{xspace} package prevents the optional argument from being recognised. \begin{table}[htbp] \caption[The effect of using xspace]{The effect of using -\sty{xspace} with \cs{oldacronym}} +\styfmt{xspace} with \cs{oldacronym}} \label{tab:xspace} \vskip\baselineskip \centering \begin{tabular}{lll} -\bfseries Code & \bfseries With \sty{xspace} & -\bfseries Without \sty{xspace}\\ +\bfseries Code & \bfseries With \styfmt{xspace} & +\bfseries Without \styfmt{xspace}\\ \verb|\abc.| & abc. & abc.\\ \verb|\abc xyz| & abc xyz & abcxyz\\ \verb|\abc\ xyz| & abc xyz & abc xyz\\ @@ -3930,7 +3976,7 @@ optional argument from being recognised. \par \end{table} -\ifmakedtx{}{\toTop} + \subsection{Unsetting and Resetting Entry Flags} \label{sec:glsunset} @@ -3983,11 +4029,11 @@ You can determine whether an entry's first use flag is set using: where \meta{label} is the label of the required entry. If the entry has been used, \meta{true part} will be done, otherwise \meta{false part} will be done. -\ifmakedtx{}{\toTop} + \subsection{Glossary Styles} \label{sec:styles} -The \sty{glossaries} package comes with some pre-defined +The \styfmt{glossaries} package comes with some pre-defined glossary styles. Note that the styles are suited to different types of glossaries: some styles ignore the associated symbol; some styles are not designed for hierarchical entries, @@ -4006,7 +4052,7 @@ matches \glostyle{long3col}, \glostyle{long3colheader}, A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as --- there is no limit, but note that -\appname{makeindex} imposes a limit of 2 sub-levels. If the +\app{makeindex} imposes a limit of 2 sub-levels. If the homograph column is checked, then the name is not displayed for sub-entries. If the symbol column is checked, then the symbol will be displayed if it has been defined.} @@ -4043,7 +4089,7 @@ argument to \ics{printglossary} or using the command: \end{definition} Some of the glossary styles may also be set using the \pkgopt{style} package option, it depends if the package in which they are defined -is automatically loaded by the \sty{glossaries} package. +is automatically loaded by the \styfmt{glossaries} package. The tabular-like styles that allow multi-line descriptions and page lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} @@ -4092,26 +4138,27 @@ in the next section) or make the modifications after \changes{1.03}{2007 July 4}{'glspostdescription added} All the styles except for the three- and four-column styles and the \glostyle{listdotted} style use the command -\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 -will need to redefine \cs{glspostdescription} before the glossary is -displayed. Alternatively, you can suppress it for a given entry -by placing \ics{nopostdesc} in the entry's description. -\ifmakedtx{}{\toTop} +\begin{definition}[\DescribeMacro{\glspostdescription}] +\cs{glspostdescription} +\end{definition} +after the description. This simply displays a full stop by default. +To eliminate this full stop (or replace it with something else, say, +a comma) you will need to redefine \cs{glspostdescription} before +the glossary is displayed. Alternatively, you can suppress it for a +given entry by placing \ics{nopostdesc} in the entry's description. \subsubsection{List Styles} \label{sec:liststyles} The styles described in this section are all defined in the package -\isty{glossary-list}. Since they all use the \envname{description} +\sty{glossary-list}. Since they all use the \env{description} environment, they are governed by the same parameters as that environment. These styles all ignore the entry's symbol. Note that these styles will automatically be available unless you use the \pkgopt{nolist} or \pkgopt{nostyles} package options. \begin{description} -\item[list] The \glostyle{list} style uses the \envname{description} +\item[list] The \glostyle{list} style uses the \env{description} environment. The entry name is placed in the optional argument of the \cs{item} command (so it will appear in bold by default). The description follows, and then the associated \term{number list} for @@ -4122,15 +4169,17 @@ child entry. Groups are separated using \cs{indexspace}. \item[listgroup] The \glostyle{listgroup} style is like \glostyle{list} but the glossary groups have headings. -\item[listhypergroup] The \glostyle{listhypergroup} style is like -\glostyle{listgroup} but has a navigation line at the start of -the glossary with links to each group that is present in the -glossary. This requires an additional run through \LaTeX\ to ensure -the group information is up to date. In the navigation line, each -group is separated -by \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which -defaults to a vertical bar with a space on either side. For example, -to simply have a space separating each group, do: +\item[listhypergroup] The \glostyle{listhypergroup} style is like +\glostyle{listgroup} but has a navigation line at the start of the +glossary with links to each group that is present in the glossary. +This requires an additional run through \LaTeX\ to ensure the group +information is up to date. In the navigation line, each group is +separated by +\begin{definition}[\DescribeMacro{\glshypernavsep}] +\cs{glshypernavsep} +\end{definition} +which defaults to a vertical bar with a space on either side. For +example, to simply have a space separating each group, do: \begin{verbatim} \renewcommand*{\glshypernavsep}{\space} \end{verbatim} @@ -4155,40 +4204,40 @@ the name associated with each child entry is ignored. groups. The navigation line is the same as that for \glostyle{listhypergroup}, described above. -\item[listdotted] This style uses the \envname{description} -environment.\footnote{This style was supplied by Axel~Menzel.} Each +\item[listdotted] This style uses the \env{description} +environment.\footnote{This style was supplied by Axel~Menzel.} Each entry starts with \verb|\item[]|, followed by the name followed by a dotted line, followed by the description. Note that this style ignores both the \term{number list} and the symbol. The length -\DescribeMacro{\glslistdottedwidth}\cs{glslistdottedwidth} governs -where the description should start. This is a flat style, so child -entries are formatted in the same way as the parent entries. +\begin{definition}[\DescribeMacro{\glslistdottedwidth}] +\cs{glslistdottedwidth} +\end{definition} +governs where the description should start. This is a flat style, so +child entries are formatted in the same way as the parent entries. \item[sublistdotted] This is a variation on the \glostyle{listdotted} style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as \glostyle{listdotted}. \end{description} -\ifmakedtx{}{\toTop} + \subsubsection{Longtable Styles} \label{sec:longstyles} The styles described in this section are all defined in the package -\isty{glossary-long}. Since they all use the \envname{longtable} +\sty{glossary-long}. Since they all use the \env{longtable} environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the \pkgopt{nolong} or \pkgopt{nostyles} package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the -analogous styles described in -\ifmakedtx{\autoref{sec:longraggedstyles}}{\htmlref{Longtable Styles -(Ragged Right)}{sec:longraggedstyles}}. +analogous styles described in \sectionref{sec:longraggedstyles}. \begin{description} -\item[long] The \glostyle{long} style uses the \envname{longtable} -environment (defined by the \isty{longtable} package). It has two +\item[long] The \glostyle{long} style uses the \env{longtable} +environment (defined by the \sty{longtable} package). It has two columns: the first column contains the entry's name and the second column contains the description followed by the \term{number list}. The entry's symbol is ignored. @@ -4267,27 +4316,27 @@ page lists. style is like \glostyle{long4colheaderborder} but allows multi-line descriptions and page lists. \end{description} -\ifmakedtx{}{\toTop} + \subsubsection{Longtable Styles (Ragged Right)} \label{sec:longraggedstyles} The styles described in this section are all defined in the package -\isty{glossary-longragged}. These styles are analogous to those -defined in \isty{glossary-long} but the multiline columns are left +\sty{glossary-longragged}. These styles are analogous to those +defined in \sty{glossary-long} but the multiline columns are left justified instead of fully justified. Since these styles all use the -\envname{longtable} environment, they are governed by the same -parameters as that environment. The \isty{glossary-longragged} -package additionally requires the \isty{array} package. Note that +\env{longtable} environment, they are governed by the same +parameters as that environment. The \sty{glossary-longragged} +package additionally requires the \sty{array} package. Note that these styles will only be available if you explicitly load -\isty{glossary-longragged}: +\sty{glossary-longragged}: \begin{verbatim} \usepackage{glossaries} \usepackage{glossary-longragged} \end{verbatim} Note that you can't set these styles using the \pkgopt{style} package option since the styles aren't defined until after -the \sty{glossaries} package has been loaded. +the \styfmt{glossaries} package has been loaded. \begin{description} \item[longragged] The \glostyle{longragged} style has two @@ -4354,29 +4403,26 @@ around it. lines around it. \end{description} -\ifmakedtx{}{\toTop} + \subsubsection{Supertabular Styles} \label{sec:superstyles} The styles described in this section are all defined in the package -\isty{glossary-super}. Since they all use the \envname{supertabular} +\sty{glossary-super}. Since they all use the \env{supertabular} environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the \pkgopt{nosuper} or \pkgopt{nostyles} package -options. In general, the \envname{longtable} environment is better, +options. In general, the \env{longtable} environment is better, but there are some circumstances where it is better to use -\envname{supertabular}.\footnote{e.g.\ with the \isty{flowfram} +\env{supertabular}.\footnote{e.g.\ with the \sty{flowfram} package.} These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the -analogous styles described in -\ifmakedtx{\autoref{sec:superraggedstyles}}{\htmlref{Supertabular -Styles (Ragged Right)}{sec:superraggedstyles}}. - +analogous styles described in \sectionref{sec:superraggedstyles}. \begin{description} -\item[super] The \glostyle{super} style uses the \envname{supertabular} -environment (defined by the \isty{supertabular} package). It has two +\item[super] The \glostyle{super} style uses the \env{supertabular} +environment (defined by the \sty{supertabular} package). It has two columns: the first column contains the entry's name and the second column contains the description followed by the \term{number list}. The entry's symbol is ignored. @@ -4456,32 +4502,32 @@ page lists. style is like \glostyle{super4colheaderborder} but allows multi-line descriptions and page lists. \end{description} -\ifmakedtx{}{\toTop} + \subsubsection{Supertabular Styles (Ragged Right)} \label{sec:superraggedstyles} The styles described in this section are all defined in the package -\isty{glossary-superragged}. These styles are analogous to those -defined in \isty{glossary-super} but the multiline columns are left +\sty{glossary-superragged}. These styles are analogous to those +defined in \sty{glossary-super} but the multiline columns are left justified instead of fully justified. Since these styles all use the -\envname{supertabular} environment, they are governed by the same -parameters as that environment. The \isty{glossary-superragged} -package additionally requires the \isty{array} package. Note that +\env{supertabular} environment, they are governed by the same +parameters as that environment. The \sty{glossary-superragged} +package additionally requires the \sty{array} package. Note that these styles will only be available if you explicitly load -\isty{glossary-superragged}: +\sty{glossary-superragged}: \begin{verbatim} \usepackage{glossaries} \usepackage{glossary-superragged} \end{verbatim} Note that you can't set these styles using the \pkgopt{style} package option since the styles aren't defined until after -the \sty{glossaries} package has been loaded. +the \styfmt{glossaries} package has been loaded. \begin{description} \item[superragged] The \glostyle{superragged} style uses the -\envname{supertabular} environment (defined by the -\isty{supertabular} package). It has two columns: the first column +\env{supertabular} environment (defined by the +\sty{supertabular} package). It has two columns: the first column contains the entry's name and the second column contains the (left justified) description followed by the \term{number list}. The entry's symbol is ignored. Sub groups are separated with a blank @@ -4545,13 +4591,13 @@ lines around it. lines around it. \end{description} -\ifmakedtx{}{\toTop} + \subsubsection{Tree-Like Styles} \label{sec:treestyles} The styles described in this section are all defined in the package -\isty{glossary-tree}. These styles are designed for hierarchical +\sty{glossary-tree}. These styles are designed for hierarchical glossaries but can also be used with glossaries that don't have sub-entries. These styles will display the entry's symbol if it exists. Note that these styles will automatically be available @@ -4578,8 +4624,8 @@ groups. The navigation line is the same as that for \item[tree] The \glostyle{tree} style is similar to the \glostyle{index} style except that it can have arbitrary levels. -(Note that \appname{makeindex} is limited to three levels, so -you will need to use \appname{xindy} if you want more than +(Note that \app{makeindex} is limited to three levels, so +you will need to use \app{xindy} if you want more than three levels.) Each sub-level is indented by \DescribeMacro{\glstreeindent}\cs{glstreeindent}. Note that the name, symbol (if present) and description are placed in the @@ -4634,7 +4680,7 @@ groups. The navigation line is the same as that for \end{description} -\ifmakedtx{}{\toTop} + \subsection{Defining your own glossary style} \label{sec:newglossarystyle} @@ -4649,15 +4695,15 @@ used in \cs{glossarystyle}). The second argument \meta{definitions} needs to redefine all of the following: \begin{definition}[\DescribeEnv{theglossary}] -\envname{theglossary} +\env{theglossary} \end{definition} This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \cs{glossarypreamble}) or the glossary postamble (defined by \cs{glossarypostamble}). For example, -the \glostyle{list} style uses the \envname{description} environment, -so the \envname{theglossary} environment is simply redefined to begin -and end the \envname{description} environment. +the \glostyle{list} style uses the \env{description} environment, +so the \env{theglossary} environment is simply redefined to begin +and end the \env{description} environment. \begin{definition}[\DescribeMacro{\glossaryheader}] \cs{glossaryheader} @@ -4674,12 +4720,12 @@ glossary style redefines \cs{glossaryheader} to do a header row. \end{definition} This macro indicates what to do at the start of each logical block within the main body -of the glossary. If you use \appname{makeindex} the glossary is +of the glossary. If you use \app{makeindex} the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the \gloskey{sort} key (or \gloskey{name} key if the \gloskey{sort} key is omitted). The sub-divisions are in the following order: symbols, numbers, A, -\ldots, Z\@. If you use \appname{xindy}, the sub-divisions depend on +\ldots, Z\@. If you use \app{xindy}, the sub-divisions depend on the language settings. Note that the argument to \cs{glsgroupheading} @@ -4696,9 +4742,9 @@ A navigation hypertarget can be created using \begin{definition}[\DescribeMacro{\glsnavhypertarget}] \cs{glsnavhypertarget}\marg{label}\marg{text} \end{definition} -For further details about \cs{glsnavhypertarget}, see -\ifmakedtx{\autoref{sec:code:hypernav}}{the documented code of \isty{glossary-hypernav} -in \texttt{glossaries.pdf}}. +For further details about \cs{glsnavhypertarget}, see +\ifpdf\sectionref{sec:code:hypernav}\else the documented code of +\sty{glossary-hypernav} in \texttt{glossaries.pdf}\fi. Most of the predefined glossary styles redefine \cs{glsgroupheading} @@ -4741,7 +4787,7 @@ is done using \cs{glstarget}\marg{label}\marg{text} \end{definition} where \meta{label} is the entry's label. Note that you -don't need to worry about whether the \isty{hyperref} package has +don't need to worry about whether the \sty{hyperref} package has been loaded, as \cs{glstarget} won't create a target if \cs{hypertarget} hasn't been defined. @@ -4783,8 +4829,8 @@ remaining arguments are analogous to those for \ics{glossaryentryfield} described above. For further details of these commands, see -\ifmakedtx{\autoref{sec:code:printglos}}{the documented code in \texttt{glossaries.pdf}}. -\ifmakedtx{}{\toTop} +\ifpdf\sectionref{sec:code:printglos}\else the documented code in +\texttt{glossaries.pdf}\fi. \subsubsection{Example: creating a completely new style} @@ -4792,8 +4838,8 @@ If you want a completely new style, you will need to redefine all of the commands and the environment listed above. For example, suppose you want each entry to start with a bullet point. -This means that the glossary should be placed in the \envname{itemize} -environment, so \envname{theglossary} should start and end that +This means that the glossary should be placed in the \env{itemize} +environment, so \env{theglossary} should start and end that environment. Let's also suppose that you don't want anything between the glossary groups (so \ics{glsgroupheading} and \ics{glsgroupskip} should do nothing) and suppose you don't want anything to appear @@ -4827,7 +4873,7 @@ at the end. Then you can create this new glossary style, called, say, \end{verbatim} Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries. -\ifmakedtx{}{\toTop} + \subsubsection{Example: creating a new glossary style based on an existing style} @@ -4848,7 +4894,7 @@ follows: \renewcommand{\glsgroupskip}{}% make nothing happen between groups } \end{verbatim} -\ifmakedtx{}{\toTop} + \subsubsection{Example: creating a glossary style that uses the \gloskey{user1}, \ldots, \gloskey{user6} keys} @@ -4859,7 +4905,7 @@ the values of the generic user keys, such as \gloskey{user1}. For example, suppose each entry not only has an associated symbol, but also units (stored in \gloskey{user1}) and dimension (stored in \gloskey{user2}). Then you can define a glossary style -that displays each entry in a \envname{longtable} as follows: +that displays each entry in a \env{longtable} as follows: \begin{verbatim} \newglossarystyle{long6col}{% % put the glossary in a longtable environment: @@ -4890,12 +4936,12 @@ that displays each entry in a \envname{longtable} as follows: \renewcommand*{\glsgroupskip}{}% } \end{verbatim} -\ifmakedtx{}{\toTop} + \subsection{Accessibility Support}\label{sec:accsupp} Limited accessibility support is provided by the accompanying -\isty{glossaries-accsupp} package, but note that this package is -experimental and it requires the \isty{accsupp} package +\sty{glossaries-accsupp} package, but note that this package is +experimental and it requires the \sty{accsupp} package which is also listed as experimental. This package defines additional keys that may be used when defining glossary entries. The keys are as follows: @@ -4938,17 +4984,16 @@ Now \verb|\gls{tex}| will be equivalent to \begin{verbatim} \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} \end{verbatim} -See \ifmakedtx{\autoref{sec:code:accsupp}}{the section -\dq{glossaries-accsupp code} in -the document \texttt{glossaries.pdf} } for further details. It is -recommended that you also read the \isty{accsupp} documentation. -\ifmakedtx{}{\toTop} +See \ifpdf \sectionref{sec:code:accsupp} \else the section +\qt{glossaries-accsupp code} in the document \texttt{glossaries.pdf} +\fi for further details. It is recommended that you also read the +\sty{accsupp} documentation. \section{Mfirstuc Package} \label{sec:mfirstuc} -The \sty{glossaries} bundle is supplied with the package -\isty{mfirstuc} which provides the command: +The \styfmt{glossaries} bundle is supplied with the package +\sty{mfirstuc} which provides the command: \begin{definition}[\DescribeMacro{\makefirstuc}] \cs{makefirstuc}\marg{stuff} \end{definition} @@ -4960,26 +5005,26 @@ object in the group is converted to uppercase. Examples: \item \verb|\makefirstuc{abc}| produces Abc \item \verb|\makefirstuc{\emph{abc}}| produces \emph{Abc} -(\ics{MakeUppercase} has been applied to the letter \dq{a} rather +(\ics{MakeUppercase} has been applied to the letter \qt{a} rather than \cs{emph}.) Note however that \verb|\makefirstuc{{\em abc}}| produces \emph{ABC} and \verb|{\makefirstuc{\em abc}}| produces abc. \item \verb|\makefirstuc{{\'a}bc}| produces \MakeUppercase{\'a}bc -\item \verb|\makefirstuc{\ae bc}| produces \ifmakedtx{\MakeUppercase{\ae}bc}{\AE bc} +\item \verb|\makefirstuc{\ae bc}| produces \MakeUppercase{\ae}bc -\item \verb|\makefirstuc{{\ae}bc}| produces \ifmakedtx{\MakeUppercase{\ae}bc}{\AE bc} +\item \verb|\makefirstuc{{\ae}bc}| produces \MakeUppercase{\ae}bc -\item \verb|\makefirstuc{{ä}bc}| produces \ifmakedtx{\MakeUppercase{ä}bc}{\MakeUppercase{\"a}bc} +\item \verb|\makefirstuc{{ä}bc}| produces \MakeUppercase{ä}bc \end{itemize} Note that non-Latin or accented characters appearing at the start of the text must be placed in a group (even if you are -using the \isty{inputenc} package) due to expansion issues. +using the \sty{inputenc} package) due to expansion issues. \begin{important} -In version 1.02 of \sty{mfirstuc}, a bug fix resulted in a change +In version 1.02 of \styfmt{mfirstuc}, a bug fix resulted in a change in output if the first object is a control sequence followed by an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}| produced \ae Bc. However as from version 1.02, it now produces @@ -5011,7 +5056,7 @@ produces: Abc. If you want to use an alternative command to convert to uppercase, for example \cs{MakeTextUppercase},\footnote{defined in the -\sty{textcase} package} you can redefine the internal +\styfmt{textcase} package} you can redefine the internal command \cs{@gls@makefirstuc}. For example: \begin{verbatim} \renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} @@ -5020,10 +5065,12 @@ command \cs{@gls@makefirstuc}. For example: either be placed in packages or be placed between \cs{makeatletter} and \cs{makeatother}.) -\ifmakedtx{}{\toTop} - \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} -\ifmakedtx{}{\printindex\toTop} +\StopEventually{% + \clearpage\phantomsection + \addcontentsline{toc}{section}{Index}\PrintIndex + +} \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf Binary files differindex 8e22a8c9071..8c75872da04 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index ee59a263777..310dbc56ab8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -1,477 +1,787 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with LaTeX2HTML 2002 (1.67) -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>The glossaries package: a guide for beginners</TITLE> -<META NAME="description" CONTENT="The glossaries package: a guide for beginners"> -<META NAME="keywords" CONTENT="glossariesbegin"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> -<META NAME="Generator" CONTENT="LaTeX2HTML v2002"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > -<H1 ALIGN="CENTER">The glossaries package: a guide for beginners</H1> -<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot</STRONG></P> -<P ALIGN="CENTER"><STRONG>24th September 2009</STRONG></P> -<BR> - -<H2><A NAME="SECTION00010000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html22" - HREF="glossariesbegin.html#SECTION00020000000000000000">1 What Do I Need?</A> -<LI><A NAME="tex2html23" - HREF="glossariesbegin.html#SECTION00030000000000000000">2 Getting Started</A> -<LI><A NAME="tex2html24" - HREF="glossariesbegin.html#SECTION00040000000000000000">3 Defining a Term or Symbol</A> -<LI><A NAME="tex2html25" - HREF="glossariesbegin.html#SECTION00050000000000000000">4 Using a Term</A> -<LI><A NAME="tex2html26" - HREF="glossariesbegin.html#SECTION00060000000000000000">5 Acronyms</A> -<LI><A NAME="tex2html27" - HREF="glossariesbegin.html#SECTION00070000000000000000">6 Displaying the Glossary or List of Acronyms</A> -</UL> -<!--End of Table of Contents--> -<P> - -<H3>Abstract:</H3> -<DIV> -This document is a brief guide to the <TT>glossaries</TT> package for -beginners who find the size of the main user manual daunting and, as -such, it only covers the basics. For more advanced topics, see the -<A NAME="tex2html1" - HREF="glossaries-manual.html">main user manual</A>. -</DIV> -<P> - -<P> - -<H1><A NAME="SECTION00020000000000000000"></A> -<A NAME="requirements"></A> -<BR> -1 What Do I Need? -</H1> - -<P> -You need to have the <TT>glossaries</TT> package installed. You also -need to have the following packages installed: <TT>ifthen</TT>, -<TT>xkeyval</TT> (at least version 2.5f), <TT>xfor</TT> and <TT>amsgen</TT>. -You may also need <TT>longtable</TT>, <TT>supertabular</TT> and -<TT>array</TT>, depending on what glossary style you want to use. -All these packages can be downloaded from CTAN if you don't have -them installed. See <A NAME="tex2html2" - HREF="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings">Installing things on a -(La)TeX System</A> -for further assistance. - -<P> -You also need an indexing application. The <TT>glossaries</TT> package -is configured to use either <TT>makeindex</TT> or <TT>xindy</TT>. -<TT>Makeindex</TT> should be available on all TeX systems. It's -possible you may not have <TT>xindy</TT> installed, but it can be -downloaded from the <A NAME="tex2html3" - HREF="http://www.xindy.org/">xindy home -page</A>. -The <TT>glossaries</TT> package provides a helper Perl script called -<TT>makeglossaries</TT> which will act as an interface to -<TT>makeindex</TT> or <TT>xindy</TT>. If you want to use -<TT>makeglossaries</TT>, you need to have Perl installed, but you can -use <TT>makeindex</TT> or <TT>xindy</TT> directly if you prefer. - -<P> - -<H1><A NAME="SECTION00030000000000000000"></A> -<A NAME="start"></A> -<BR> -2 Getting Started -</H1> - -<P> -The most obvious things to do is to remember to load the -<TT>glossaries</TT> package: -<PRE> +<a + id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>The glossaries package: a guide for beginners</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,fn-in,css-in --> +<meta name="src" content="glossariesbegin.tex" /> +<meta name="date" content="2010-06-14 14:03:00" /> + +<style type="text/css"> +<!-- + +/* start css.sty */ +.cmr-17{font-size:170%;} +.cmr-12{font-size:120%;} +.cmr-9{font-size:90%;} +.cmbx-9{font-size:90%; font-weight: bold;} +.cmbx-9{ font-weight: bold;} +.cmss-9{font-size:90%; font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmtt-9{font-size:90%;font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmti-10{ font-style: italic;} +.cmbx-10{ font-weight: bold;} +.cmbx-10{ font-weight: bold;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;} +div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;} +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.bar-css {text-decoration:overline;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } +.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } +.abstract p {margin-left:5%; margin-right:5%;} +div.abstract {width:100%;} +table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } +div.important { background-color:red; } +/* end css.sty */ + + +--> +</style> +</head><body +> + <div class="maketitle"> + + + + + + + +<h2 class="titleHead">The glossaries package: a guide for beginners</h2> +<div class="author" ><span +class="cmr-12">Nicola L.C. Talbot</span></div><br /> +<div class="date" ><span +class="cmr-12">2010-05-28</span></div> + </div> + <div +class="abstract" +> +<div class="center" +> +<!--l. 26--><p class="noindent" > +</p><!--l. 26--><p class="noindent" ><span +class="cmbx-9">Abstract</span></p></div> + <!--l. 27--><p class="indent" > <span +class="cmr-9">This document is a brief guide to the </span><span +class="cmss-9">glossaries </span><span +class="cmr-9">package for beginners who</span> + <span +class="cmr-9">find the size of the main user manual daunting and, as such, it only covers</span> + <span +class="cmr-9">the basics. For more advanced topics, see the </span><a +href="glossaries-manual.html" ><span +class="cmr-9">main user manual</span></a><span +class="cmr-9">.</span> +</p> +</div> + <h3 class="likesectionHead"><a + id="x1-1000"></a>Contents</h3> + <div class="tableofcontents"> + <span class="sectionToc" >1 <a +href="#x1-20001" id="QQ2-1-2">What Do I Need?</a></span> +<br /> <span class="sectionToc" >2 <a +href="#x1-30002" id="QQ2-1-3">Getting Started</a></span> +<br /> <span class="sectionToc" >3 <a +href="#x1-40003" id="QQ2-1-4">Defining a Term or Symbol</a></span> +<br /> <span class="sectionToc" >4 <a +href="#x1-50004" id="QQ2-1-5">Using a Term</a></span> +<br /> <span class="sectionToc" >5 <a +href="#x1-60005" id="QQ2-1-6">Acronyms</a></span> +<br /> <span class="sectionToc" >6 <a +href="#x1-70006" id="QQ2-1-7">Displaying the Glossary or List of Acronyms</a></span> + </div> + + + +<!--l. 35--><p class="noindent" > +</p> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-20001"></a>What Do I Need?</h3> +<!--l. 38--><p class="noindent" >You need to have the <span +class="cmss-10">glossaries </span>package installed. You also need to have the following +packages installed: <span +class="cmss-10">ifthen</span><a + id="dx1-2001"></a>, <span +class="cmss-10">xkeyval</span><a + id="dx1-2002"></a> (at least version 2.5f), <span +class="cmss-10">xfor</span><a + id="dx1-2003"></a> and <span +class="cmss-10">amsgen</span><a + id="dx1-2004"></a>. You may also +need <span +class="cmss-10">longtable</span><a + id="dx1-2005"></a>, <span +class="cmss-10">supertabular</span><a + id="dx1-2006"></a> and <span +class="cmss-10">array</span><a + id="dx1-2007"></a>, depending on what glossary style you +want to use. All these packages can be downloaded from CTAN if you don’t +have them installed. See <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings" >“Installing things on a (La)TeX System”</a> for further +assistance. +</p><!--l. 48--><p class="indent" > In addition, you need an indexing application. The <span +class="cmss-10">glossaries</span><a + id="dx1-2008"></a> package is configured to +use either <span +class="cmtt-10">makeindex</span><a + id="dx1-2009"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-2010"></a>. <span +class="cmtt-10">Makeindex</span><a + id="dx1-2011"></a> should be available on all <span class="TEX">T<span +class="E">E</span>X</span> systems. It’s +possible you may not have <span +class="cmtt-10">xindy</span><a + id="dx1-2012"></a> installed, but it can be downloaded from the +<a +href="http://www.xindy.org/" >xindy home page</a>. The <span +class="cmss-10">glossaries</span><a + id="dx1-2013"></a> package provides a helper Perl script called +<span +class="cmtt-10">makeglossaries</span><a + id="dx1-2014"></a> which will act as an interface to <span +class="cmtt-10">makeindex</span><a + id="dx1-2015"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-2016"></a>. If you want to +use <span +class="cmtt-10">makeglossaries</span><a + id="dx1-2017"></a>, you need to have Perl installed, but you can use <span +class="cmtt-10">makeindex</span><a + id="dx1-2018"></a> or +<span +class="cmtt-10">xindy</span><a + id="dx1-2019"></a> directly if you prefer. +</p><!--l. 59--><p class="noindent" > +</p> +<!--l. 59--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-30002"></a>Getting Started</h3> +<!--l. 62--><p class="noindent" >The most obvious things to do is to remember to load the <span +class="cmss-10">glossaries</span><a + id="dx1-3001"></a> package: + + + +</p> + <div class="verbatim" id="verbatim-1"> \usepackage{glossaries} -</PRE> -Note that the <TT>glossaries</TT> package must be loaded <I>after</I> -the <TT>hyperref</TT> package (contrary to the general advice that -<TT>hyperref</TT> should be loaded last). The <TT>glossaries</TT> package -should also be loaded after <TT>html</TT>, <TT>inputenc</TT>, -<TT>babel</TT> and <TT>ngerman</TT>. - -<P> -If you want to use <TT>xindy</TT> rather than <TT>makeindex</TT> to sort the -glossaries, you need to specify this in the package options: -<PRE> +</div> +<!--l. 66--><p class="nopar" > Note that the <span +class="cmss-10">glossaries </span>package must be loaded <span +class="cmti-10">after </span>the <span +class="cmss-10">hyperref</span><a + id="dx1-3002"></a> package (contrary to +the general advice that <span +class="cmss-10">hyperref</span><a + id="dx1-3003"></a> should be loaded last). The <span +class="cmss-10">glossaries</span><a + id="dx1-3004"></a> package should +also be loaded after <span +class="cmss-10">html</span><a + id="dx1-3005"></a>, <span +class="cmss-10">inputenc</span><a + id="dx1-3006"></a>, <span +class="cmss-10">babel</span><a + id="dx1-3007"></a> and <span +class="cmss-10">ngerman</span><a + id="dx1-3008"></a>. +</p><!--l. 73--><p class="indent" > If you want to use <span +class="cmtt-10">xindy</span><a + id="dx1-3009"></a> rather than <span +class="cmtt-10">makeindex</span><a + id="dx1-3010"></a> to sort the glossaries, you need to +specify this in the package options: + + + +</p> + <div class="verbatim" id="verbatim-2"> \usepackage[xindy]{glossaries} -</PRE> -Other package options are described in -the section -<A NAME="tex2html4" - HREF="glossaries-manual.html#sec:pkgopts">"Package Options"</A> -in the main <TT>glossaries</TT> user manual. - -<P> -Next, you need to enable the creation of the various external -files that are needed to create the glossaries, lists of acronyms -or symbols for your document. This is done using: - -<P> -<TT>\makeglossaries</TT> -<P> - -<P> - -<H1><A NAME="SECTION00040000000000000000"></A> -<A NAME="defterm"></A> -<BR> -3 Defining a Term or Symbol -</H1> - -<P> -You must define terms or symbols before you can use them in the -document. This is best done in the preamble. Each term is defined -using: - -<P> -<TT>\newglossaryentry{<<I>label</I>>}{<<I>settings</I>>}</TT> -<P> -where <<I>label</I>> is a unique label used to identify the term. -The second argument, <<I>settings</I>>, is a key=value comma -separated list that is used to set the required information for -the term. A full list of available keys can be found in -<A NAME="tex2html5" - HREF="glossaries-manual.html#sec:newglosentry">"Defining Glossary Entries"</A> -in the main <TT>glossaries</TT> user manual. The principle keys are -<TT>name</TT> and <TT>description</TT>. - -<P> -For example, to define the term "electrolyte": -<PRE> +</div> +<!--l. 77--><p class="nopar" > Other package options are described in <a +href="glossaries-manual.html#sec:pkgopts" >Package Options</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-3011"></a> user +manual. +</p><!--l. 84--><p class="indent" > Next, you need to enable the creation of the various external files that are required +by the indexing application. This is done using: +</p><!--l. 87--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\makeglossaries </span></div><hr> +</p><!--l. 88--><p class="noindent" > +</p><!--l. 90--><p class="noindent" > +</p> +<!--l. 90--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-40003"></a>Defining a Term or Symbol</h3> +<!--l. 93--><p class="noindent" >You must define terms or symbols before you can use them in the document. This is +best done in the preamble. Each term is defined using: +</p><!--l. 97--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\newglossaryentry{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">settings</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 98--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩ </span>is a unique label used to identify the term. The second argument, +<span +class="cmsy-10">⟨</span><span +class="cmti-10">settings</span><span +class="cmsy-10">⟩</span>, is a key=value comma separated list that is used to set the required +information for the term. A full list of available keys can be found in <a +href="glossaries-manual.html#sec:newglosentry" >Defining Glossary +Entries</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-4001"></a> user manual. The principle keys are <span +class="cmss-10">name</span><a + id="dx1-4002"></a> and +<span +class="cmss-10">description</span><a + id="dx1-4003"></a>. +</p><!--l. 109--><p class="indent" > For example, to define the term “electrolyte”: + + + +</p> + <div class="verbatim" id="verbatim-3"> \newglossaryentry{electrolyte}{name=electrolyte, -description={solution able to conduct electric current}} -</PRE> -In the above example, the label and the name happen to be the same. -In the next example, the name contains a ligature but the label -doesn't: -<PRE> -\newglossaryentry{oesophagus}{name=\oe sophagus, -description={canal from mouth to stomach}, -plural=\oe sophagi} -</PRE> -In this case the label is <TT>oesophagus</TT>. Note that in this -case, the plural has to be specified using the <TT>plural</TT> key -since it isn't formed by simply appending the letter "s". - -<P> -When you define terms, it is important to remember that they will -be sorted by an external application that doesn't interpret LaTeX commands. <TT>Xindy</TT> is a little more TeX-aware than <TT>makeindex</TT>, but -for this example they will both mis-sort <code>\oe sophagus</code>. -Xindy will ignore the <code>\oe </code> part and will sort it according -to <TT>sophagus</TT>, so it will be placed with the terms starting -with an "s". <TT>Makeindex</TT>, on the other hand, will sort it according -to <code>\oe sophagus</code> which starts with a symbol (the backslash), -so it will end up in the symbol group. You therefore need to -specify how to sort the term: -<PRE> -\newglossaryentry{oesophagus}{name=\oe sophagus, -description={canal from mouth to stomach}, -plural=\oe sophagi,sort=oesophagus} -</PRE> -Note, however, that if you use the <TT>inputenc</TT> package and -<TT>xindy</TT>, you can use the encoded character <TT>œ</TT> rather than -<TT>\oe</TT> and <TT>xindy</TT> will sort it correctly: - -<P> -<TT><TT>\newglossaryentry</TT>{oesophagus}{name=œsophagus, -<BR> -description={canal from mouth to stomach}, -<BR> -plural=œsophagi} -</TT> -<P> -If the name starts with an accented character, the first character -must be grouped: -<PRE> -\newglossaryentry{elite}{name={\'e}lite, -description={select group of people}, -sort=elite} -</PRE> -or - -<P> -<TT><TT>\newglossaryentry</TT>{elite}{name={é}lite, -<BR> -description={select group of people}} -</TT> -<P> -The name can also be a symbol, but you will also need to specify -the sort key. For example: -<PRE> + <br />description={solution able to conduct electric current}} +</div> +<!--l. 113--><p class="nopar" > In the above example, the label and the name happen to be the same. In the next +example, the name contains a ligature but the label doesn’t: + + + +</p> + <div class="verbatim" id="verbatim-4"> +\newglossaryentry{oesophagus}{name=\oe sophagus, + <br />description={canal from mouth to stomach}, + <br />plural=\oe sophagi} +</div> +<!--l. 121--><p class="nopar" > In this case the label is <span +class="cmtt-10">oesophagus</span>. Note that in this case, the plural has to be +specified using the <span +class="cmss-10">plural</span><a + id="dx1-4004"></a> key since it isn’t formed by simply appending the letter +“s”. +</p><!--l. 126--><p class="indent" > When you define terms, it is important to remember that they will be sorted by an +external application that doesn’t interpret <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> commands. <span +class="cmtt-10">Xindy</span><a + id="dx1-4005"></a> is a little more +<span class="TEX">T<span +class="E">E</span>X</span>-aware than <span +class="cmtt-10">makeindex</span><a + id="dx1-4006"></a>, but for this example they will both mis-sort +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\oe</span><span +class="cmtt-10"> sophagus</span></span></span>. Xindy will ignore the <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\oe␣</span></span></span> part and will sort it according to <span +class="cmtt-10">sophagus</span>, +so it will be placed with the terms starting with an “s”. <span +class="cmtt-10">Makeindex</span><a + id="dx1-4007"></a>, on the other hand, +will sort it according to <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\oe␣sophagus</span></span></span> which starts with a symbol (the backslash), so it +will end up in the symbol group. You therefore need to specify how to sort the +term: + + + +</p> + <div class="verbatim" id="verbatim-5"> +\newglossaryentry{oesophagus}{name=\oe sophagus, + <br />description={canal from mouth to stomach}, + <br />plural=\oe sophagi,sort=oesophagus} +</div> +<!--l. 140--><p class="nopar" > Note, however, that if you use the <span +class="cmss-10">inputenc</span><a + id="dx1-4008"></a> package and <span +class="cmtt-10">xindy</span><a + id="dx1-4009"></a>, you can use the +encoded character <span +class="cmtt-10">œ </span>rather than <span +class="cmtt-10">\oe </span>and <span +class="cmtt-10">xindy</span><a + id="dx1-4010"></a> will sort it correctly: + + + +</p> + <div class="verbatim" id="verbatim-6"> +\newglossaryentry{oesophagus}{name=œsophagus, + <br />description={canal from mouth to stomach}, + <br />plural=œsophagi} +</div> +<!--l. 148--><p class="nopar" > +</p><!--l. 150--><p class="indent" > If the name starts with an accented character, the first character must be +grouped: + + + +</p> + <div class="verbatim" id="verbatim-7"> +\newglossaryentry{elite}{name={\’e}lite, + <br />description={select group of people}, + <br />sort=elite} +</div> +<!--l. 156--><p class="nopar" > or + + + +</p> + <div class="verbatim" id="verbatim-8"> +\newglossaryentry{elite}{name={é}lite, + <br />description={select group of people}} +</div> +<!--l. 161--><p class="nopar" > +</p><!--l. 163--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For +example: + + + +</p> + <div class="verbatim" id="verbatim-9"> \newglossaryentry{pi}{name={\ensuremath{\pi}}, -description={ratio of circumference of circle to its -diameter},sort=pi} -</PRE> -It's also possible to have a name and a symbol. For example: -<PRE> + <br />description={ratio of circumference of circle to its + <br />diameter},sort=pi} +</div> +<!--l. 169--><p class="nopar" > It’s also possible to have a name and a symbol. For example: + + + +</p> + <div class="verbatim" id="verbatim-10"> \newglossaryentry{set}{name=set, -description={a collection of objects}, -symbol={\ensuremath{\mathcal{S}}}} -</PRE> -Note, however, that not all glossary styles display the symbol -in the glossary. - -<P> - -<H1><A NAME="SECTION00050000000000000000"></A> -<A NAME="usingterm"></A> -<BR> -4 Using a Term -</H1> - -<P> -Once you have defined a term, you can use it in the document. The -<TT>glossaries</TT> package provides a number of commands that are -described in the section -<A NAME="tex2html6" - HREF="glossaries-manual.html#sec:glslink">"Links to Glossary Entries"</A> -in the main <TT>glossaries</TT> user manual. -Here, I shall just cover the main commands: - -<P> -<TT>\gls{<<I>label</I>>}</TT> -<P> -This prints the term associated with <<I>label</I>>. Using the -example in the previous section, <code>\gls{oesophagus}</code> -will display œsophagus. If the <TT>hyperref</TT> package has also -been loaded, the term will also be hyperlinked to the relevant -entry in the glossary. - -<P> -<TT>\glspl{<<I>label</I>>}</TT> -<P> -This prints the plural of the term associated with <<I>label</I>>, -so <code>\glspl{oesophagus}</code> will display œsophagi. Again, the -text will be a hyperlink to the relevant entry in the glossary, if -hyperlinks are defined. - -<P> -There are also versions that convert the first character to upper -case if you need to start a sentence with a term: - -<P> -<TT>\Gls{<<I>label</I>>}</TT> -<P> + <br />description={a collection of objects}, + <br />symbol={\ensuremath{\mathcal{S}}}} +</div> +<!--l. 175--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary. +</p><!--l. 179--><p class="noindent" > +</p> +<!--l. 179--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-50004"></a>Using a Term</h3> +<!--l. 182--><p class="noindent" >Once you have defined a term, you can use it in the document. The <span +class="cmss-10">glossaries</span><a + id="dx1-5001"></a> +package provides a number of commands that are described in <a +href="glossaries-manual.html#sec:glslink" >Links to Glossary +Entries</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-5002"></a> user manual. Here, I shall just cover the main +commands: +</p><!--l. 191--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\gls{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 192--><p class="noindent" > +This prints the term associated with <span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span>. Using the example in the previous section, +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{oesophagus}</span></span></span> will display œsophagus. If the <span +class="cmss-10">hyperref</span><a + id="dx1-5003"></a> package has also +been loaded, the term will also be hyperlinked to the relevant entry in the +glossary. +</p><!--l. 199--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\glspl{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 200--><p class="noindent" > +This prints the plural of the term associated with <span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span>, so <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glspl{oesophagus}</span></span></span> will +display œsophagi. Again, the text will be a hyperlink to the relevant entry in the +glossary, if hyperlinks are defined. +</p><!--l. 206--><p class="indent" > There are also versions that convert the first character to upper case if you need to +start a sentence with a term: +</p><!--l. 209--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\Gls{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 210--><p class="noindent" > and - -<P> -<TT>\Glspl{<<I>label</I>>}</TT> -<P> +</p><!--l. 213--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\Glspl{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 214--><p class="noindent" > For example: -<PRE> -\Glspl{electrolyte} usually exist as solutions of salts, -bases or acids. -</PRE> - -<P> -Note that these commands all have two optional arguments that -aren't discussed here, but they are -described in the section -<A NAME="tex2html7" - HREF="glossaries-manual.html#sec:glslink">"Links to Glossary Entries"</A> -in the main <TT>glossaries</TT> user manual. - -<P> -<B>Caveat:</B> don't use these commands in moving arguments, such -as those used by <TT>\chapter</TT>, <TT>\section</TT> and <TT>\caption</TT>. -You can, instead, use commands such as - -<P> -<TT>\glsentrytext{<<I>label</I>>}</TT> -<P> -See the section -<A NAME="tex2html8" - HREF="glossaries-manual.html#sec:glsnolink">"Using Glossary Terms Without Links"</A> -in the main <TT>glossaries</TT> user manual. - -<P> - -<H1><A NAME="SECTION00060000000000000000"></A> -<A NAME="acronyms"></A> -<BR> -5 Acronyms -</H1> - -<P> -The <TT>glossaries</TT> package also allows you to define acronyms. -By default, acronyms will be added to the main glossary, but if -you use the <TT>acronym</TT> package option, acronyms will be -placed in a separate list of acronyms: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-11"> +\Glspl{electrolyte} usually exist as solutions of salts, + <br />bases or acids. +</div> +<!--l. 219--><p class="nopar" > +</p><!--l. 221--><p class="indent" > Note that these commands all have two optional arguments that aren’t discussed +here, but they are described in <a +href="glossaries-manual.html#sec:glslink" >Links to Glossary Entries</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-5004"></a> user +manual. +</p><!--l. 229--><p class="indent" > <span +class="cmbx-10">Caveat: </span>don’t use these commands in moving arguments, such as those used by +<span +class="cmtt-10">\chapter</span>, <span +class="cmtt-10">\section </span>and <span +class="cmtt-10">\caption</span>. You can, instead, use commands such +as +</p><!--l. 233--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\glsentrytext{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 234--><p class="noindent" > +See <a +href="glossaries-manual.html#sec:glsnolink" >Using Glossary Terms Without Links</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-5005"></a> user manual. +</p><!--l. 241--><p class="noindent" > +</p> +<!--l. 241--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-60005"></a>Acronyms</h3> +<!--l. 244--><p class="noindent" >The <span +class="cmss-10">glossaries</span><a + id="dx1-6001"></a> package also allows you to define acronyms. By default, acronyms will be +added to the main glossary, but if you use the <span +class="cmss-10">acronym</span><a + id="dx1-6002"></a> package option, acronyms will +be placed in a separate list of acronyms: + + + +</p> + <div class="verbatim" id="verbatim-12"> \usepackage[acronym]{glossaries} -</PRE> -There are other options that govern how acronyms appear. For further -details, see the section -<A NAME="tex2html9" - HREF="glossaries-manual.html#sec:acronyms">"Acronyms"</A> -in -the main <TT>glossaries</TT> user manual. - -<P> -Acronyms must be defined before use and are defined using: - -<P> -<TT>\newacronym{<<I>label</I>>}{<<I>abbrv</I>>}{<<I>full</I>>}</TT> -<P> -where <<I>label</I>> is the label identifying the acronym, <<I>abbrv</I>> -is the abbreviated form and <<I>full</I>> is the fully expanded text. -For example: -<PRE> -\newacronym{label}{svm}{support vector machine} -</PRE> - -<P> -Once the acronym is defined, it can be used in the same way as -any other glossary term with commands such as <TT>\gls</TT> and -<TT>\glspl</TT>. On first use, the default will display <<I>full</I>> -(<<I>abbrv</I>>). On subsequent use, only the abbreviation will -appear. For example: -<PRE> -A \gls{svm} was implemented. -</PRE> -If this is the first time this term has been used, the above would -produce: -<P> -A support vector machine (svm) was implemented. -<P> -otherwise it would produce: -<P> -A svm was implemented. -<P> -You can reset an acronym so that the next use fully -expands it again using: - -<P> -<TT>\glsreset{<<I>label</I>>}</TT> -<P> +</div> +<!--l. 250--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see +<a +href="glossaries-manual.html#sec:acronyms" >Acronyms</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-6003"></a> user manual. +</p><!--l. 258--><p class="indent" > Acronyms must be defined before use and are defined using: +</p><!--l. 260--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\newacronym{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">full</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 261--><p class="noindent" > +where <span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩ </span>is the label identifying the acronym, <span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩ </span>is the abbreviated form and +<span +class="cmsy-10">⟨</span><span +class="cmti-10">full</span><span +class="cmsy-10">⟩ </span>is the fully expanded text. For example: + + + +</p> + <div class="verbatim" id="verbatim-13"> +\newacronym{label}{svm}{support vector machine} +</div> +<!--l. 267--><p class="nopar" > +</p><!--l. 269--><p class="indent" > Once the acronym is defined, it can be used in the same way as any other glossary +term with commands such as <span +class="cmtt-10">\gls </span>and <span +class="cmtt-10">\glspl</span>. On first use, the default will display +<span +class="cmsy-10">⟨</span><span +class="cmti-10">full</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span>). On subsequent use, only the abbreviation will appear. For +example: + + + +</p> + <div class="verbatim" id="verbatim-14"> +A \gls{svm} was implemented. +</div> +<!--l. 276--><p class="nopar" > If this is the first time this term has been used, the above would produce: +<spacer type=vertical size=10><span class="obeylines-h"> + <br />A support vector machine (svm) was implemented. + <br /><spacer type=vertical size=10></span> +otherwise it would produce: <spacer type=vertical size=10><span class="obeylines-h"> + <br />A svm was implemented. + <br /><spacer type=vertical size=10></span> +You can reset an acronym so that the next use fully expands it again using: +</p><!--l. 289--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\glsreset{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 290--><p class="noindent" > or you can reset all acronyms using - -<P> -<TT>\glsresetall</TT> -<P> -For further details on resetting and unsetting acronyms, see -the section -<A NAME="tex2html10" - HREF="glossaries-manual.html#sec:glsunset">"Unsetting and Resetting Entry Flags"</A> -in the main <TT>glossaries</TT> user manual. - -<P> - -<H1><A NAME="SECTION00070000000000000000"></A> -<A NAME="printglossaries"></A> -<BR> -6 Displaying the Glossary or List of Acronyms -</H1> - -<P> -In order to display the sorted list of terms, you first need to -use - -<P> -<TT>\printglossaries</TT> -<P> -at the place where you want the glossary and list of acronyms to -appear. Note that <TT>\printglossaries</TT> won't produce any text the -first time you create your document, as an external indexing -application needs to be used to sort and collate the entries. -Creating the completed document is therefore <I>at least</I> a three -step process. - -<P> -Suppose your document is called <TT>myDoc.tex</TT>, then you need -to: - -<OL> -<LI>Build/LaTeX your document, either by clicking on an -appropriate button in your front-end/text editor or by typing the -following at a terminal/command prompt: -<PRE> -latex myDoc -</PRE> - -<P> -</LI> -<LI>Run the indexing application on the external file(s) created -by the <TT>glossaries</TT> package. If you have used the <TT>xindy</TT> -package option, you must use <TT>xindy</TT>, otherwise you must use -<TT>makeindex</TT>. The <TT>glossaries</TT> package comes with a convenient -Perl wrapper that calls the appropriate indexing application the -required number of times with the required options. If you have Perl -installed, all you need to do is type -<PRE> -makeglossaries myDoc -</PRE> -in a terminal or command prompt. If you are using a front-end (such -as WinEdt or TeXnicCenter) and you want it to automatically run -makeglossaries when you build your document, you will need to -consult the front-end's documentation. - -<P> -If you don't have Perl installed, you will need to call <TT>makeindex</TT> -or <TT>xindy</TT> explicitly. This is more complicated and is described in -the section -<A NAME="tex2html11" - HREF="glossaries-manual.html#sec:makeglossaries">"Generating the Associated Glossary Files"</A> -in the -main <TT>glossaries</TT> user manual. - -<P> -</LI> -<LI>Once you have successfully run the indexing application, you -need to build/LaTeX your document again (see step 1). -</LI> -</OL> -Note that sometimes you may have to repeat steps 2 and 3. - -<P> -The appearance of the glossary depends on the glossary style in -use. The default style uses the <TT>description</TT> environment, -but there are many other styles available. These are described -in the section -<A NAME="tex2html12" - HREF="glossaries-manual.html#sec:styles">"Glossary Styles"</A> -in the main <TT>glossaries</TT> user manual. -By default, a number or list of numbers will appear after each entry -in the glossary. This indicates the page (or pages) -on which the term was used. This list can be suppressed using -the <TT>nonumberlist</TT> package option: -<PRE> +</p><!--l. 293--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\glsresetall </span></div><hr> +</p><!--l. 294--><p class="noindent" > +For further details on resetting and unsetting acronyms, see <a +href="glossaries-manual.html#sec:glsunset" >Unsetting and Resetting +Entry Flags</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-6004"></a> user manual. +</p><!--l. 302--><p class="noindent" > +</p> +<!--l. 302--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-70006"></a>Displaying the Glossary or List of Acronyms</h3> +<!--l. 305--><p class="noindent" >In order to display the sorted list of terms, you first need to use +</p><!--l. 308--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\printglossaries </span></div><hr> +</p><!--l. 309--><p class="noindent" > +at the place where you want the glossary and list of acronyms to appear. Note that +<span +class="cmtt-10">\printglossaries </span>won’t produce any text the first time you create your document, +as an external indexing application needs to be used to sort and collate the +entries. Creating the completed document is therefore <span +class="cmti-10">at least </span>a three step +process. +</p><!--l. 317--><p class="indent" > Suppose your document is called <span +class="cmtt-10">myDoc.tex</span>, then you need to: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-7002x1">Build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> your document, either by clicking on an appropriate button in + your front-end/text editor or by typing the following at a terminal/command + prompt: + + + + <div class="verbatim" id="verbatim-15"> + latex myDoc +</div> + <!--l. 325--><p class="nopar" > + </p></li> + <li + class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by the <span +class="cmss-10">glossaries</span><a + id="dx1-7005"></a> + package. If you have used the <span +class="cmss-10">xindy</span><a + id="dx1-7006"></a> package option, you must use <span +class="cmtt-10">xindy</span><a + id="dx1-7007"></a>, + otherwise you must use <span +class="cmtt-10">makeindex</span><a + id="dx1-7008"></a>. The <span +class="cmss-10">glossaries</span><a + id="dx1-7009"></a> package comes with a + convenient Perl wrapper that calls the appropriate indexing application the + required number of times with the required options. If you have Perl installed, all + you need to do is type + + + + <div class="verbatim" id="verbatim-16"> + makeglossaries myDoc +</div> + <!--l. 336--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as WinEdt + or TeXnicCenter) and you want it to automatically run makeglossaries + when you build your document, you will need to consult the front-end’s + documentation. + </p><!--l. 342--><p class="noindent" >If you don’t have Perl installed, you will need to call <span +class="cmtt-10">makeindex</span><a + id="dx1-7010"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-7011"></a> + explicitly. This is more complicated and is described in <a +href="glossaries-manual.html#sec:makeglossaries" >Generating the Associated + Glossary Files</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-7012"></a> user manual. + </p></li> + <li + class="enumerate" id="x1-7014x3">Once you have successfully run the indexing application, you need to + build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> your document again (see step 1).</li></ol> +<!--l. 353--><p class="noindent" >Note that sometimes you may have to repeat steps 2 and 3. +</p><!--l. 355--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default +style uses the <span +class="cmss-10">description</span><a + id="dx1-7015"></a> environment, but there are many other styles available. These +are described in <a +href="glossaries-manual.html#sec:styles" >Glossary Styles</a> in the main <span +class="cmss-10">glossaries</span><a + id="dx1-7016"></a> user manual. By default, a +number or list of numbers will appear after each entry in the glossary. This indicates +the page (or pages) on which the term was used. This list can be suppressed using the +<span +class="cmss-10">nonumberlist</span><a + id="dx1-7017"></a> package option: + + + +</p> + <div class="verbatim" id="verbatim-17"> \usepackage[nonumberlist]{glossaries} -</PRE> +</div> +<!--l. 368--><p class="nopar" > +</p><!--l. 370--><p class="indent" > Further information can be found in the main <span +class="cmss-10">glossaries</span><a + id="dx1-7018"></a> <a +href="glossaries-manual.html" >user manual</a> and there is +also an <a +href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries package</a> on the <a +href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> Community’s</a> Know How +section. +</p><!--l. 378--><p class="noindent" ><a +href="#top">Top</a></p> +</body></html> + + -<P> -Further information can be found in the main <TT>glossaries</TT> -<A NAME="tex2html13" - HREF="glossaries-manual.html">user -manual</A> -and there is also an -<A NAME="tex2html14" - HREF="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114">article on the glossaries package</A> -on the LaTeX Community's Know How section. -<BR><HR> -</BODY> -</HTML> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf Binary files differindex bc6c79cde75..640f624c5d7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 32affd8783e..6c2899afc2f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -1,82 +1,57 @@ -\documentclass[a4paper,12pt]{article} +\documentclass{nlctdoc} -\usepackage[T1]{fontenc} \usepackage[utf8]{inputenc} -\usepackage{cmap} +\ifpdf +\usepackage[T1]{fontenc} \usepackage{mathpazo} \usepackage[scaled=.86]{helvet} \usepackage{courier} \usepackage{xr-hyper} +\fi \usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot}, pdftitle={The glossaries package: a guide for beginners}]{hyperref} -\usepackage{html} \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{24th September 2009} - -%\begin{latexonly} -\newcommand*{\sty}[1]{\textsf{#1}} -\newcommand*{\env}[1]{\textsf{#1}} -\newcommand*{\pkgopt}[1]{\textsf{#1}} -\newcommand*{\dq}[1]{``#1''} -\newcommand*{\gloskey}[1]{\textsf{#1}} - -\newcommand*{\meta}[1]{\textnormal{$\langle$\emph{#1}$\rangle$}} -\newenvironment{definition}{\par\vskip\baselineskip\noindent -\ignorespaces}{\par\vskip\baselineskip\noindent\ignorespacesafterend} -%\end{latexonly} -\begin{htmlonly} -\newcommand{\sty}[1]{\texttt{#1}} -\newcommand{\env}[1]{\texttt{#1}} -\renewcommand{\LaTeX}{LaTeX} -\renewcommand{\TeX}{TeX} -\newcommand*{\pkgopt}[1]{\texttt{#1}} -\newcommand*{\dq}[1]{"#1"} -\newcommand*{\gloskey}[1]{\texttt{#1}} -\newcommand*{\meta}[1]{\textnormal{\textless\emph{#1}\textgreater}} -\newenvironment{definition}{\par}{\par} -\end{htmlonly} - -\newcommand*{\marg}[1]{\texttt{\char`\{\meta{#1}\char`\}}} -\newcommand*{\oarg}[1]{\texttt{[\meta{#1}]}} -\newcommand*{\cs}[1]{\texttt{\char`\\#1}} -\newcommand*{\app}[1]{\texttt{#1}} - -\externaldocument{glossaries} +\date{2010-05-28} + +\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} +\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} + +\ifpdf\externaldocument{glossaries}\fi \begin{document} \maketitle -\tableofcontents \begin{abstract} -This document is a brief guide to the \sty{glossaries} package for +This document is a brief guide to the \styfmt{glossaries} package for beginners who find the size of the main user manual daunting and, as such, it only covers the basics. For more advanced topics, see the -\latexhtml{main user manual (\href{glossaries.pdf}{glossaries.pdf})}{\htmladdnormallink{main user manual}{glossaries-manual.html}}. +\altdocref{main user manual}{glossaries}{glossaries-manual}. \end{abstract} +\tableofcontents + \section{What Do I Need?} \label{requirements} -You need to have the \sty{glossaries} package installed. You also +You need to have the \styfmt{glossaries} package installed. You also need to have the following packages installed: \sty{ifthen}, \sty{xkeyval} (at least version 2.5f), \sty{xfor} and \sty{amsgen}. You may also need \sty{longtable}, \sty{supertabular} and -\sty{array}, depending on what glossary style you want to use. -All these packages can be downloaded from CTAN if you don't have -them installed. See \htmladdnormallink{Installing things on a -(La)TeX System}{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}\latex{\footnote{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}}} -for further assistance. - -You also need an indexing application. The \sty{glossaries} package -is configured to use either \app{makeindex} or \app{xindy}. +\sty{array}, depending on what glossary style you want to use. All +these packages can be downloaded from CTAN if you don't have them +installed. See +\urlfootref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}{\qt{Installing +things on a (La)TeX System}} for further assistance. + +In addition, you need an indexing application. The \sty{glossaries} +package is configured to use either \app{makeindex} or \app{xindy}. \app{Makeindex} should be available on all \TeX\ systems. It's possible you may not have \app{xindy} installed, but it can be -downloaded from the \htmladdnormallink{xindy home -page}{http://www.xindy.org/}.\latex{\footnote{\url{http://www.xindy.org/}}} -The \sty{glossaries} package provides a helper Perl script called -\app{makeglossaries} which will act as an interface to +downloaded from the \urlfootref{http://www.xindy.org/}{xindy home +page}. The \sty{glossaries} package provides a helper Perl script +called \app{makeglossaries} which will act as an interface to \app{makeindex} or \app{xindy}. If you want to use \app{makeglossaries}, you need to have Perl installed, but you can use \app{makeindex} or \app{xindy} directly if you prefer. @@ -89,7 +64,7 @@ The most obvious things to do is to remember to load the \begin{verbatim} \usepackage{glossaries} \end{verbatim} -Note that the \sty{glossaries} package must be loaded \emph{after} +Note that the \styfmt{glossaries} package must be loaded \emph{after} the \sty{hyperref} package (contrary to the general advice that \sty{hyperref} should be loaded last). The \sty{glossaries} package should also be loaded after \sty{html}, \sty{inputenc}, @@ -101,12 +76,13 @@ glossaries, you need to specify this in the package options: \usepackage[xindy]{glossaries} \end{verbatim} Other package options are described in -\latexhtml{section~\ref{sec:pkgopts}}{the section -\htmladdnormallink{\dq{Package Options}}{glossaries-manual.html#sec:pkgopts}} in the main \sty{glossaries} user manual. +%\latexhtml{section~\ref{sec:pkgopts}}{the section +%\htmladdnormallink{\qt{Package Options}}{glossaries-manual.html#sec:pkgopts}} +\xrsectionref{sec:pkgopts}{glossaries-manual}{Package Options} +in the main \sty{glossaries} user manual. Next, you need to enable the creation of the various external -files that are needed to create the glossaries, lists of acronyms -or symbols for your document. This is done using: +files that are required by the indexing application. This is done using: \begin{definition} \cs{makeglossaries} \end{definition} @@ -124,11 +100,13 @@ where \meta{label} is a unique label used to identify the term. The second argument, \meta{settings}, is a key=value comma separated list that is used to set the required information for the term. A full list of available keys can be found in -\latexhtml{section~\ref{sec:newglosentry}}{\htmladdnormallink{\dq{Defining Glossary Entries}}{glossaries-manual.html#sec:newglosentry}} +\xrsectionref{sec:newglosentry}{glossaries-manual}{Defining Glossary +Entries} +%\latexhtml{section~\ref{sec:newglosentry}}{\htmladdnormallink{\qt{Defining Glossary Entries}}{glossaries-manual.html#sec:newglosentry}} in the main \sty{glossaries} user manual. The principle keys are \gloskey{name} and \gloskey{description}. -For example, to define the term \dq{electrolyte}: +For example, to define the term \qt{electrolyte}: \begin{verbatim} \newglossaryentry{electrolyte}{name=electrolyte, description={solution able to conduct electric current}} @@ -143,7 +121,7 @@ plural=\oe sophagi} \end{verbatim} In this case the label is \texttt{oesophagus}. Note that in this case, the plural has to be specified using the \gloskey{plural} key -since it isn't formed by simply appending the letter \dq{s}. +since it isn't formed by simply appending the letter \qt{s}. When you define terms, it is important to remember that they will be sorted by an external application that doesn't interpret \LaTeX\ @@ -151,8 +129,8 @@ commands. \app{Xindy} is a little more \TeX-aware than \app{makeindex}, but for this example they will both mis-sort \verb|\oe sophagus|. Xindy will ignore the \verb*|\oe | part and will sort it according to \texttt{sophagus}, so it will be placed with the terms starting -with an \dq{s}. \app{Makeindex}, on the other hand, will sort it according -to \verb|\oe sophagus| which starts with a symbol (the backslash), +with an \qt{s}. \app{Makeindex}, on the other hand, will sort it according +to \verb*|\oe sophagus| which starts with a symbol (the backslash), so it will end up in the symbol group. You therefore need to specify how to sort the term: \begin{verbatim} @@ -161,22 +139,13 @@ description={canal from mouth to stomach}, plural=\oe sophagi,sort=oesophagus} \end{verbatim} Note, however, that if you use the \sty{inputenc} package and -\app{xindy}, you can use the encoded character \texttt{\oe} rather than +\app{xindy}, you can use the encoded character \texttt{Å“} rather than \cs{oe} and \app{xindy} will sort it correctly: -\begin{latexonly} \begin{verbatim} \newglossaryentry{oesophagus}{name=Å“sophagus, description={canal from mouth to stomach}, plural=Å“sophagi} \end{verbatim} -\end{latexonly} -\begin{htmlonly}\par -\begin{ttfamily} -\cs{newglossaryentry}\{oesophagus\}\{name=\oe sophagus,\newline -description=\{canal from mouth to stomach\},\newline -plural=\oe sophagi\} -\end{ttfamily}\par -\end{htmlonly} If the name starts with an accented character, the first character must be grouped: @@ -186,18 +155,10 @@ description={select group of people}, sort=elite} \end{verbatim} or -\begin{latexonly} \begin{verbatim} \newglossaryentry{elite}{name={é}lite, description={select group of people}} \end{verbatim} -\end{latexonly} -\begin{htmlonly}\par -\begin{ttfamily} -\cs{newglossaryentry}\{elite\}\{name=\{\'e\}lite,\newline -description=\{select group of people\}\} -\end{ttfamily}\par -\end{htmlonly} The name can also be a symbol, but you will also need to specify the sort key. For example: @@ -220,8 +181,11 @@ in the glossary. Once you have defined a term, you can use it in the document. The \sty{glossaries} package provides a number of commands that are -described in \latexhtml{section~\ref{sec:glslink}}{the section -\htmladdnormallink{\dq{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} in the main \sty{glossaries} user manual. +described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to +Glossary Entries} +%\latexhtml{section~\ref{sec:glslink}}{the section +%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} + in the main \sty{glossaries} user manual. Here, I shall just cover the main commands: \begin{definition} \cs{gls}\marg{label} @@ -256,8 +220,11 @@ bases or acids. Note that these commands all have two optional arguments that aren't discussed here, but they are -described in \latexhtml{section~\ref{sec:glslink}}{the section -\htmladdnormallink{\dq{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} in the main \sty{glossaries} user manual. +described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to +Glossary Entries} +%\latexhtml{section~\ref{sec:glslink}}{the section +%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} +in the main \sty{glossaries} user manual. \textbf{Caveat:} don't use these commands in moving arguments, such as those used by \cs{chapter}, \cs{section} and \cs{caption}. @@ -265,8 +232,10 @@ You can, instead, use commands such as \begin{definition} \cs{glsentrytext}\marg{label} \end{definition} -See \latexhtml{section~\ref{sec:glsnolink}}{the section -\htmladdnormallink{\dq{Using Glossary Terms Without Links}}{glossaries-manual.html#sec:glsnolink}} +See \xrsectionref{sec:glsnolink}{glossaries-manual}{Using Glossary +Terms Without Links} +%\latexhtml{section~\ref{sec:glsnolink}}{the section +%\htmladdnormallink{\qt{Using Glossary Terms Without Links}}{glossaries-manual.html#sec:glsnolink}} in the main \sty{glossaries} user manual. \section{Acronyms} @@ -280,8 +249,10 @@ placed in a separate list of acronyms: \usepackage[acronym]{glossaries} \end{verbatim} There are other options that govern how acronyms appear. For further -details, see \latexhtml{section~\ref{sec:acronyms}}{the section -\htmladdnormallink{\dq{Acronyms}}{glossaries-manual.html#sec:acronyms}} in +details, see \xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} +%\latexhtml{section~\ref{sec:acronyms}}{the section +%\htmladdnormallink{\qt{Acronyms}}{glossaries-manual.html#sec:acronyms}} +in the main \sty{glossaries} user manual. Acronyms must be defined before use and are defined using: @@ -304,10 +275,14 @@ appear. For example: A \gls{svm} was implemented. \end{verbatim} If this is the first time this term has been used, the above would -produce:\par\vskip\baselineskip\noindent -A support vector machine (svm) was implemented.\par\vskip\baselineskip\noindent -otherwise it would produce:\par\vskip\baselineskip\noindent -A svm was implemented.\par\vskip\baselineskip\noindent +produce: +\begin{display} +A support vector machine (svm) was implemented. +\end{display} +otherwise it would produce: +\begin{display} +A svm was implemented. +\end{display} You can reset an acronym so that the next use fully expands it again using: \begin{definition} @@ -318,8 +293,10 @@ or you can reset all acronyms using \cs{glsresetall} \end{definition} For further details on resetting and unsetting acronyms, see -\latexhtml{section~\ref{sec:glsunset}}{the section -\htmladdnormallink{\dq{Unsetting and Resetting Entry Flags}}{glossaries-manual.html#sec:glsunset}} +\xrsectionref{sec:glsunset}{glossaries-manual}{Unsetting and +Resetting Entry Flags} +%\latexhtml{section~\ref{sec:glsunset}}{the section +%\htmladdnormallink{\qt{Unsetting and Resetting Entry Flags}}{glossaries-manual.html#sec:glsunset}} in the main \sty{glossaries} user manual. \section{Displaying the Glossary or List of Acronyms} @@ -364,9 +341,11 @@ consult the front-end's documentation. If you don't have Perl installed, you will need to call \app{makeindex} or \app{xindy} explicitly. This is more complicated and is described in -\latexhtml{section~\ref{sec:makeglossaries}}{the section -\htmladdnormallink{\dq{Generating the Associated Glossary Files}}{glossaries-manual.html#sec:makeglossaries}} in the -main \sty{glossaries} user manual. +\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the +Associated Glossary Files} +%\latexhtml{section~\ref{sec:makeglossaries}}{the section +%\htmladdnormallink{\qt{Generating the Associated Glossary Files}}{glossaries-manual.html#sec:makeglossaries}} +in the main \sty{glossaries} user manual. \item Once you have successfully run the indexing application, you need to build/\LaTeX\ your document again (see step~1). @@ -376,8 +355,10 @@ Note that sometimes you may have to repeat steps~2 and~3. The appearance of the glossary depends on the glossary style in use. The default style uses the \env{description} environment, but there are many other styles available. These are described -in \latexhtml{section~\ref{sec:styles}}{the section -\htmladdnormallink{\dq{Glossary Styles}}{glossaries-manual.html#sec:styles}} in the main \sty{glossaries} user manual. +in \xrsectionref{sec:styles}{glossaries-manual}{Glossary Styles} +%\latexhtml{section~\ref{sec:styles}}{the section +%\htmladdnormallink{\qt{Glossary Styles}}{glossaries-manual.html#sec:styles}} +in the main \sty{glossaries} user manual. By default, a number or list of numbers will appear after each entry in the glossary. This indicates the page (or pages) on which the term was used. This list can be suppressed using @@ -387,8 +368,11 @@ the \pkgopt{nonumberlist} package option: \end{verbatim} Further information can be found in the main \sty{glossaries} -\latexhtml{user manual (\href{glossaries.pdf}{glossaries.pdf})}{\htmladdnormallink{user -manual}{glossaries-manual.html}} and there is also an -\htmladdnormallink{article on the glossaries package}{http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114} -on the \LaTeX\ Community's\latex{\footnote{\url{http://www.latex-community.org/}}} Know How section. +\altdocref{user manual}{glossaries}{glossaries-manual} +%\latexhtml{user manual (\href{glossaries.pdf}{glossaries.pdf})}{\htmladdnormallink{user +%manual}{glossaries-manual.html}} +and there is also an +\href{http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{article on the glossaries package} +on the \urlfootref{http://www.latex-community.org/}{\LaTeX\ Community's} +Know How section. \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 754eec11a3a..8f6c7a21e37 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -1,953 +1,2013 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with LaTeX2HTML 2002 (1.67) -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>Upgrading from the glossary package to the glossaries -package</TITLE> -<META NAME="description" CONTENT="Upgrading from the glossary package to the glossaries -package"> -<META NAME="keywords" CONTENT="glossary2glossaries"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> -<META NAME="Generator" CONTENT="LaTeX2HTML v2002"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > -<H1 ALIGN="CENTER">Upgrading from the glossary package to the glossaries -package</H1> -<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot</STRONG></P> -<P ALIGN="CENTER"><STRONG>14th January 2009</STRONG></P> -<BR> - -<H2><A NAME="SECTION00010000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html29" - HREF="glossary2glossaries.html#SECTION00020000000000000000">1 Why the Need for a New Package?</A> -<LI><A NAME="tex2html30" - HREF="glossary2glossaries.html#SECTION00030000000000000000">2 Package Options</A> -<LI><A NAME="tex2html31" - HREF="glossary2glossaries.html#SECTION00040000000000000000">3 Defining new glossary types</A> -<LI><A NAME="tex2html32" - HREF="glossary2glossaries.html#SECTION00050000000000000000">4 \make<glossary name></A> -<LI><A NAME="tex2html33" - HREF="glossary2glossaries.html#SECTION00060000000000000000">5 Storing glossary information</A> -<LI><A NAME="tex2html34" - HREF="glossary2glossaries.html#SECTION00070000000000000000">6 Adding an entry to the glossary</A> -<UL> -<LI><A NAME="tex2html35" - HREF="glossary2glossaries.html#SECTION00071000000000000000">6.1 \useglosentry</A> -<LI><A NAME="tex2html36" - HREF="glossary2glossaries.html#SECTION00072000000000000000">6.2 \useGlosentry</A> -<LI><A NAME="tex2html37" - HREF="glossary2glossaries.html#SECTION00073000000000000000">6.3 \gls</A> -<LI><A NAME="tex2html38" - HREF="glossary2glossaries.html#SECTION00074000000000000000">6.4 \glossary</A> -</UL> -<BR> -<LI><A NAME="tex2html39" - HREF="glossary2glossaries.html#SECTION00080000000000000000">7 Acronyms</A> -<UL> -<LI><A NAME="tex2html40" - HREF="glossary2glossaries.html#SECTION00081000000000000000">7.1 \acrln and \acrsh</A> -<LI><A NAME="tex2html41" - HREF="glossary2glossaries.html#SECTION00082000000000000000">7.2 \ifacronymfirstuse</A> -<LI><A NAME="tex2html42" - HREF="glossary2glossaries.html#SECTION00083000000000000000">7.3 \resetacronym and \unsetacronym</A> -</UL> -<BR> -<LI><A NAME="tex2html43" - HREF="glossary2glossaries.html#SECTION00090000000000000000">8 Displaying the glossary</A> -<LI><A NAME="tex2html44" - HREF="glossary2glossaries.html#SECTION000100000000000000000">9 Processing Your Document</A> -<LI><A NAME="tex2html45" - HREF="glossary2glossaries.html#SECTION000110000000000000000">10 Troubleshooting</A> -</UL> -<!--End of Table of Contents--> -<P> - -<H3>Abstract:</H3> -<DIV> -The purpose of this document is to provide advice if you want -to convert a LaTeX document from using the obsolete -<TT>glossary</TT> package to the replacement <TT>glossaries</TT> package. -</DIV> -<P> - -<P> - -<H1><A NAME="SECTION00020000000000000000"></A> -<A NAME="whyglossaries"></A> -<BR> -1 Why the Need for a New Package? -</H1> - -<P> -The <TT>glossary</TT> package started out as an example in a tutorial, -but I decided that I may as well package it up and upload it to CTAN. -Unfortunately it was fairly rigid and unable to adapt well to the -wide variation in glossary styles. Users began making requests for -enhancements, but with each enhancement the code became more -complicated and bugs crept in. Each fix in one place seemed to cause -another problem elsewhere. In the end, it was taking up too much -of my time to maintain, so I decided to replace it with a much -better designed package. With the new <TT>glossaries</TT> package: - -<P> - -<UL> -<LI>you can define irregular plurals; - -<P> -</LI> -<LI>glossary terms can have an associated symbol in addition -to the name and description; - -<P> -</LI> -<LI>new glossary styles are much easier to design; - -<P> -</LI> -<LI>you can add dictionaries to supply translations for the -fixed names used in headings and by some of the glossary styles; - -<P> -</LI> -<LI>you can choose<A NAME="tex2html1" - HREF="#foot582"><SUP>1</SUP></A> between using -<TT>makeindex</TT> or <TT>xindy</TT> to sort the glossary. Using -<TT>xindy</TT> means that: - -<P> - -<UL> -<LI>there is much better support for terms containing accented - or non-Latin characters; - -<P> -</LI> -<LI>there is support for non-standard location numbers; - -</LI> -</UL> - -<P> -</LI> -<LI>you don't need to remember to escape <TT>makeindex</TT>'s -special characters as this is done internally; - -<P> -</LI> -<LI>hierarchical entries and homographs are supported;<A NAME="tex2html2" - HREF="#foot88"><SUP>2</SUP></A> -<P> -</LI> -<LI>there is better support for cross-referencing glossary entries; - -<P> -</LI> -<LI>acronyms are just another glossary term which helps to -maintain consistency; - -<P> -</LI> -<LI>different acronym styles are supported. - -<P> -</LI> -</UL> - -<P> - -<H1><A NAME="SECTION00030000000000000000"> -2 Package Options</A> -</H1> - -<P> -When converting a document that currently uses the obsolete -<TT>glossary</TT> package to the replacement <TT>glossaries</TT> package, -it should be fairly obvious that the first thing you need to do is -replace <code>\usepackage{glossary}</code> with -<code>\usepackage{glossaries}</code>, however some of the package options -are different, so you may need to change those as well. -Table <A HREF="glossary2glossaries.html#tab:pkgopt">1</A> shows the mappings from the <TT>glossary</TT> -to the <TT>glossaries</TT> package options. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:pkgopt"></A> -<DIV ALIGN="CENTER"> -<A NAME="583"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 1:</STRONG> -Mappings from <TT>glossary</TT> to <TT>glossaries</TT> -package options</CAPTION> -<TR><TH ALIGN="LEFT"><B><TT>glossary</TT> option </B></TH> -<TH ALIGN="LEFT"><B><TT>glossaries</TT> option</B></TH> -</TR> -<TR><TD ALIGN="LEFT">style=list</TD> -<TD ALIGN="LEFT">style=list</TD> -</TR> -<TR><TD ALIGN="LEFT">style=altlist</TD> -<TD ALIGN="LEFT">style=altlist</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=long</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=longheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=longborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=longheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=long3col</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=long3colheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=long3colborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=long3colheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=super</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=superheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=superborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=superheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=super3col</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=super3colheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=super3colborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=super3colheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">number=none</TD> -<TD ALIGN="LEFT">nonumberlist</TD> -</TR> -<TR><TD ALIGN="LEFT">number=<<I>counter name</I>></TD> -<TD ALIGN="LEFT">counter=<<I>counter name</I>></TD> -</TR> -<TR><TD ALIGN="LEFT">toc</TD> -<TD ALIGN="LEFT">toc</TD> -</TR> -<TR><TD ALIGN="LEFT">hypertoc</TD> -<TD ALIGN="LEFT">toc</TD> -</TR> -<TR><TD ALIGN="LEFT">hyper</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -<TR><TD ALIGN="LEFT">section=true</TD> -<TD ALIGN="LEFT">section</TD> -</TR> -<TR><TD ALIGN="LEFT">section=false</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -<TR><TD ALIGN="LEFT">acronym</TD> -<TD ALIGN="LEFT">acronym</TD> -</TR> -<TR><TD ALIGN="LEFT">global</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -</TABLE> -</DIV> -</DIV> -<BR> - -<P> - -<H1><A NAME="SECTION00040000000000000000"> -3 Defining new glossary types</A> -</H1> - -<P> -If you have created new glossary types, you will need to -replace all instances of - -<P> -<TT><TT>\newglossarytype[<<I>log-ext</I>>]{<<I>type</I>>}{<<I>out-ext</I>>}{<<I>in-ext</I>>}[<<I>old style list</I>>]</TT> -<BR> -<TT>\newcommand</TT><code>{\</code><<I>type</I>>name<code>}</code><TT>{<<I>title</I>>}</TT></TT> -<P> +<a + id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>Upgrading from the glossary package to the glossaries package</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,fn-in,css-in --> +<meta name="src" content="glossary2glossaries.tex" /> +<meta name="date" content="2010-06-14 14:03:00" /> + +<style type="text/css"> +<!-- + +/* start css.sty */ +.cmr-17{font-size:170%;} +.cmr-12{font-size:120%;} +.cmr-8{font-size:80%;} +.cmsy-8{font-size:80%;} +.cmr-9{font-size:90%;} +.cmbx-9{font-size:90%; font-weight: bold;} +.cmbx-9{ font-weight: bold;} +.cmss-9{font-size:90%; font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmti-10{ font-style: italic;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmtt-8{font-size:80%;font-family: monospace;} +.cmtt-8{font-family: monospace;} +.cmtt-8{font-family: monospace;} +.cmbx-10{ font-weight: bold;} +.cmbx-10{ font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmtt-9{font-size:90%;font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmti-8{font-size:80%; font-style: italic;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;} +div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;} +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.bar-css {text-decoration:overline;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } +.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } +.abstract p {margin-left:5%; margin-right:5%;} +div.abstract {width:100%;} +table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } +div.important { background-color:red; } +/* end css.sty */ + + +--> +</style> +</head><body +> + <div class="maketitle"> + + + + + + + +<h2 class="titleHead">Upgrading from the glossary package to the +glossaries package</h2> +<div class="author" ><span +class="cmr-12">Nicola L.C. Talbot</span></div><br /> +<div class="date" ><span +class="cmr-12">2010-05-28</span></div> + </div> + <div +class="abstract" +> +<div class="center" +> +<!--l. 35--><p class="noindent" > +</p><!--l. 35--><p class="noindent" ><span +class="cmbx-9">Abstract</span></p></div> + <!--l. 36--><p class="indent" > <span +class="cmr-9">The purpose of this document is to provide advice if you want to</span> + <span +class="cmr-9">convert a </span><span class="LATEX"><span +class="cmr-9">L</span><span class="A"><span +class="cmr-9">A</span></span><span class="TEX"><span +class="cmr-9">T</span><span +class="E"><span +class="cmr-9">E</span></span><span +class="cmr-9">X</span></span></span><span +class="cmr-9"> document from using the obsolete </span><span +class="cmss-9">glossary </span><span +class="cmr-9">package to the</span> + <span +class="cmr-9">replacement </span><span +class="cmss-9">glossaries </span><span +class="cmr-9">package.</span> +</p> +</div> + <h3 class="likesectionHead"><a + id="x1-1000"></a>Contents</h3> + <div class="tableofcontents"> + <span class="sectionToc" >1 <a +href="#x1-20001" id="QQ2-1-2">Why the Need for a New Package?</a></span> +<br /> <span class="sectionToc" >2 <a +href="#x1-30002" id="QQ2-1-3">Package Options</a></span> +<br /> <span class="sectionToc" >3 <a +href="#x1-40003" id="QQ2-1-5">Defining new glossary types</a></span> +<br /> <span class="sectionToc" >4 <a +href="#x1-50004" id="QQ2-1-6"><span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩</span></a></span> +<br /> <span class="sectionToc" >5 <a +href="#x1-60005" id="QQ2-1-7">Storing glossary information</a></span> +<br /> <span class="sectionToc" >6 <a +href="#x1-70006" id="QQ2-1-8">Adding an entry to the glossary</a></span> +<br />  <span class="subsectionToc" >6.1 <a +href="#x1-80006.1" id="QQ2-1-9"><span +class="cmtt-10">\useglosentry</span></a></span> +<br />  <span class="subsectionToc" >6.2 <a +href="#x1-90006.2" id="QQ2-1-10"><span +class="cmtt-10">\useGlosentry</span></a></span> +<br />  <span class="subsectionToc" >6.3 <a +href="#x1-100006.3" id="QQ2-1-11"><span +class="cmtt-10">\gls</span></a></span> +<br />  <span class="subsectionToc" >6.4 <a +href="#x1-110006.4" id="QQ2-1-12"><span +class="cmtt-10">\glossary</span></a></span> + + + +<br /> <span class="sectionToc" >7 <a +href="#x1-120007" id="QQ2-1-13">Acronyms</a></span> +<br />  <span class="subsectionToc" >7.1 <a +href="#x1-130007.1" id="QQ2-1-14"><span +class="cmtt-10">\acrln </span>and <span +class="cmtt-10">\acrsh</span></a></span> +<br />  <span class="subsectionToc" >7.2 <a +href="#x1-140007.2" id="QQ2-1-15"><span +class="cmtt-10">\ifacronymfirstuse</span></a></span> +<br />  <span class="subsectionToc" >7.3 <a +href="#x1-150007.3" id="QQ2-1-16"><span +class="cmtt-10">\resetacronym </span>and <span +class="cmtt-10">\unsetacronym</span></a></span> +<br /> <span class="sectionToc" >8 <a +href="#x1-160008" id="QQ2-1-17">Displaying the glossary</a></span> +<br /> <span class="sectionToc" >9 <a +href="#x1-170009" id="QQ2-1-18">Processing Your Document</a></span> +<br /> <span class="sectionToc" >10 <a +href="#x1-1800010" id="QQ2-1-19">Troubleshooting</a></span> + </div> +<!--l. 43--><p class="noindent" > +</p> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-20001"></a>Why the Need for a New Package?</h3> +<!--l. 46--><p class="noindent" >The <span +class="cmss-10">glossary </span>package started out as an example in a tutorial, but I decided that I may +as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and +unable to adapt well to the wide variation in glossary styles. Users began making +requests for enhancements, but with each enhancement the code became more +complicated and bugs crept in. Each fix in one place seemed to cause another problem +elsewhere. In the end, it was taking up too much of my time to maintain, so I decided +to replace it with a much better designed package. With the new <span +class="cmss-10">glossaries</span> +package: +</p> + <ul class="itemize1"> + <li class="itemize">you can define irregular plurals; + </li> + <li class="itemize">glossary terms can have an associated symbol in addition to the name and + description; + </li> + <li class="itemize">new glossary styles are much easier to design; + </li> + <li class="itemize">you can add dictionaries to supply translations for the fixed names used in + headings and by some of the glossary styles; + </li> + <li class="itemize">you can choose<span class="footnote-mark"><a +href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a + id="x1-2001f1"></a> + between using <span +class="cmtt-10">makeindex</span><a + id="dx1-2003"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-2004"></a> to sort the glossary. Using <span +class="cmtt-10">xindy</span><a + id="dx1-2005"></a> means + that: + + + + <ul class="itemize2"> + <li class="itemize">there is much better support for terms containing accented or non-Latin + characters; + </li> + <li class="itemize">there is support for non-standard location numbers;</li></ul> + </li> + <li class="itemize">you don’t need to remember to escape <span +class="cmtt-10">makeindex</span><a + id="dx1-2006"></a>’s special characters as this is + done internally; + </li> + <li class="itemize">hierarchical entries and homographs are + supported;<span class="footnote-mark"><a +href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a + id="x1-2007f2"></a> + </li> + <li class="itemize">there is better support for cross-referencing glossary entries; + </li> + <li class="itemize">acronyms are just another glossary term which helps to maintain consistency; + </li> + <li class="itemize">different acronym styles are supported. + </li></ul> +<!--l. 94--><p class="noindent" > +</p> +<!--l. 94--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-30002"></a>Package Options</h3> +<!--l. 96--><p class="noindent" >When converting a document that currently uses the obsolete <span +class="cmss-10">glossary </span>package to the +replacement <span +class="cmss-10">glossaries </span>package, it should be fairly obvious that the first thing you need +to do is replace <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\usepackage{glossary}</span></span></span> with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\usepackage{glossaries}</span></span></span>, however +some of the package options are different, so you may need to change those as +well. Table <a +href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a> shows the mappings from the <span +class="cmss-10">glossary </span>to the <span +class="cmss-10">glossaries </span>package +options. +</p> + <div class="table"> + + + +<!--l. 105--><p class="indent" > <a + id="x1-30011"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 1: </span><span +class="content">Mappings from <span +class="cmss-10">glossary </span>to <span +class="cmss-10">glossaries </span>package options</span></div><!--tex4ht:label?: x1-30011 --> +<div class="center" +> +<!--l. 109--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-2" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-2-1g"><col +id="TBL-2-1" /><col +id="TBL-2-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-1" +class="td11"><span +class="cmssbx-10">glossary </span><span +class="cmbx-10">option </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-2" +class="td11"><span +class="cmssbx-10">glossaries </span><span +class="cmbx-10">option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-1" +class="td11">style=list </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-2" +class="td11">style=list </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-1" +class="td11">style=altlist </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-2" +class="td11">style=altlist </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-1" +class="td11">style=long,header=none,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-2" +class="td11">style=long </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-1" +class="td11">style=long,header=plain,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-2" +class="td11">style=longheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-1" +class="td11">style=long,header=none,border=plain,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-2" +class="td11">style=longborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-1" +class="td11">style=long,header=plain,border=plain,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-2" +class="td11">style=longheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-1" +class="td11">style=long,header=none,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-2" +class="td11">style=long3col </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-1" +class="td11">style=long,header=plain,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-2" +class="td11">style=long3colheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-1" +class="td11">style=long,header=none,border=plain,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-2" +class="td11">style=long3colborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-1" +class="td11">style=long,header=plain,border=plain,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-2" +class="td11">style=long3colheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-1" +class="td11">style=super,header=none,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-2" +class="td11">style=super </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-1" +class="td11">style=super,header=plain,border=none,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-2" +class="td11">style=superheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-14-1" +class="td11">style=super,header=none,border=plain,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-14-2" +class="td11">style=superborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-15-1" +class="td11">style=super,header=plain,border=plain,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-15-2" +class="td11">style=superheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-16-1" +class="td11">style=super,header=none,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-16-2" +class="td11">style=super3col </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-17-1" +class="td11">style=super,header=plain,border=none,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-17-2" +class="td11">style=super3colheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-18-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-18-1" +class="td11">style=super,header=none,border=plain,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-18-2" +class="td11">style=super3colborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-19-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-19-1" +class="td11">style=super,header=plain,border=plain,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-19-2" +class="td11">style=super3colheaderborder</td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-20-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-20-1" +class="td11">number=none </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-20-2" +class="td11">nonumberlist </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-21-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-21-1" +class="td11">number=<span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-2-21-2" +class="td11">counter=<span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-22-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-22-1" +class="td11">toc </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-22-2" +class="td11">toc </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-23-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-23-1" +class="td11">hypertoc </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-23-2" +class="td11">toc </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-24-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-24-1" +class="td11">hyper </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-24-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-25-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-25-1" +class="td11">section=true </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-25-2" +class="td11">section </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-26-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-26-1" +class="td11">section=false </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-26-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-27-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-27-1" +class="td11">acronym </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-27-2" +class="td11">acronym </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-28-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-28-1" +class="td11">global </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-28-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td></tr></table> +</div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 143--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-40003"></a>Defining new glossary types</h3> +<!--l. 145--><p class="noindent" >If you have created new glossary types, you will need to replace all instances +of +</p><!--l. 147--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossarytype</span><a + id="dx1-4001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">log-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">out-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">in-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old style list</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]</span><br +class="newline" /> + <br /><span +class="cmtt-10">\newcommand</span><span class="verb"><span +class="cmtt-10">{\</span></span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name</span><span class="verb"><span +class="cmtt-10">}</span></span><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossary[<<I>log-ext</I>>]{<<I>type</I>>}{<<I>out-ext</I>>}{<<I>in-ext</I>>}{<<I>title</I>>}</TT></TT> -<P> -in the preamble, and, if the new glossary requires a different style -to the main (default) glossary, you will also need to put - -<P> -<TT><TT>\glossarystyle{<<I>new style</I>>}</TT></TT> -<P> -immediately before the glossary is displayed, or you can specify -the style when you display the glossary using <TT>\printglossary</TT> -(see below). - -<P> -The <<I>old style list</I>> optional argument can be converted to -<<I>new style</I>> using the same mapping given in -Table <A HREF="glossary2glossaries.html#tab:pkgopt">1</A>. - -<P> -For example, if your document contains the following: -<PRE> +</p><!--l. 152--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossary</span><a + id="dx1-4002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">log-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">out-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">in-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +in the preamble, and, if the new glossary requires a different style to the main (default) +glossary, you will also need to put +</p><!--l. 157--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glossarystyle</span><a + id="dx1-4003"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new style</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +immediately before the glossary is displayed, or you can specify the style when you +display the glossary using <span +class="cmtt-10">\printglossary</span><a + id="dx1-4004"></a> (see below). +</p><!--l. 164--><p class="indent" > The <span +class="cmsy-10">⟨</span><span +class="cmti-10">old style list</span><span +class="cmsy-10">⟩ </span>optional argument can be converted to <span +class="cmsy-10">⟨</span><span +class="cmti-10">new style</span><span +class="cmsy-10">⟩ </span>using the +same mapping given in Table <a +href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. +</p><!--l. 168--><p class="indent" > For example, if your document contains the following: + + + +</p> + <div class="verbatim" id="verbatim-1"> \newglossarytype[nlg]{notation}{not}{ntn}[style=long,header] -\newcommand{\notationname}{Index of Notation} -</PRE> -You will need to replace the above two lines with: -<PRE> -\newglossary[nlg]{notation}{not}{ntn}{Index of Notation} -</PRE> -in the preamble and -<PRE> + <br />\newcommand{\notationname}{Index of Notation} +</div> +<!--l. 172--><p class="nopar" > You will need to replace the above two lines with: + + + +</p> + <div class="verbatim" id="verbatim-2"> +\newglossary[nlg]{notation}{not}{ntn}{Index of Notation} +</div> +<!--l. 176--><p class="nopar" > in the preamble and + + + +</p> + <div class="verbatim" id="verbatim-3"> \glossarystyle{longheader} -</PRE> -immediately prior to displaying this glossary. -Alternatively, you can specify the style using the <TT>style</TT> -key in the optional argument of <TT>\printglossary</TT>. For example: -<PRE> +</div> +<!--l. 180--><p class="nopar" > immediately prior to displaying this glossary. Alternatively, you can specify the +style using the <span +class="cmss-10">style</span><a + id="dx1-4005"></a> key in the optional argument of <span +class="cmtt-10">\printglossary</span><a + id="dx1-4006"></a>. For +example: + + + +</p> + <div class="verbatim" id="verbatim-4"> \printglossary[type=notation,style=longheader] -</PRE> - -<P> -Note that the glossary title is no longer specified using -<TT>\</TT><<I>glossary-type</I>><TT>name</TT> (except for <TT>\glossaryname</TT> -and <TT>\acronymname</TT>) but is instead specified in the <<I>title</I>> -argument of <TT>\newglossary</TT>. The short title which is specified -in the <TT>glossary</TT> package by the command -<TT>\short</TT><<I>glossary-name</I>><TT>name</TT> is now specified -using the <TT>toctitle</TT> key in the optional argument to -<TT>\printglossary</TT>. - -<P> - -<H1><A NAME="SECTION00050000000000000000"> -4 <TT>\make</TT><<I>glossary name</I>></A> -</H1> - -<P> -All instances of <TT>\make</TT><<I>glossary name</I>> (e.g. -<TT>\makeglossary</TT> and <TT>\makeacronym</TT>) should be replaced -by the single command <TT>\makeglossaries</TT>. For example, if -your document contained the following: -<PRE> +</div> +<!--l. 186--><p class="nopar" > +</p><!--l. 188--><p class="indent" > Note that the glossary title is no longer specified using <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name </span>(except +for <span +class="cmtt-10">\glossaryname</span><a + id="dx1-4007"></a> and <span +class="cmtt-10">\acronymname</span><a + id="dx1-4008"></a>) but is instead specified in the <span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩ </span>argument +of <span +class="cmtt-10">\newglossary</span><a + id="dx1-4009"></a>. The short title which is specified in the <span +class="cmss-10">glossary </span>package by the +command <span +class="cmtt-10">\short</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name </span>is now specified using the <span +class="cmss-10">toctitle</span><a + id="dx1-4010"></a> key in the +optional argument to <span +class="cmtt-10">\printglossary</span><a + id="dx1-4011"></a>. +</p><!--l. 198--><p class="noindent" > +</p> +<!--l. 198--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-50004"></a><span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩</span></h3> +<!--l. 200--><p class="noindent" >All instances of <span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩ </span>(e.g. <span +class="cmtt-10">\makeglossary</span><a + id="dx1-5001"></a> and <span +class="cmtt-10">\makeacronym</span><a + id="dx1-5002"></a>) should +be replaced by the single command <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-5003"></a>. For example, if your document +contained the following: + + + +</p> + <div class="verbatim" id="verbatim-5"> \makeglossary -\makeacronym -</PRE> -then you should replace both lines with the single line: -<PRE> + <br />\makeacronym +</div> +<!--l. 207--><p class="nopar" > then you should replace both lines with the single line: + + + +</p> + <div class="verbatim" id="verbatim-6"> \makeglossaries -</PRE> - -<P> - -<H1><A NAME="SECTION00060000000000000000"> -5 Storing glossary information</A> -</H1> - -<P> -With the old <TT>glossary</TT> package you could optionally store -glossary information for later use, or you could simply use -<TT>\glossary</TT> whenever you wanted to add information to the glossary. -With the new <TT>glossaries</TT> package, the latter option is no longer -available.<A NAME="tex2html4" - HREF="#foot585"><SUP>3</SUP></A> If -you have stored all the glossary information using -<TT>\storeglosentry</TT>, then you will need to convert these commands -into the equivalent <TT>\newglossaryentry</TT>. If you have only -used <TT>\glossary</TT>, then see -<A HREF="glossary2glossaries.html#sec:csglossary">later</A>. - -<P> -Substitute all instances of - -<P> -<TT><TT>\storeglosentry{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> +</div> +<!--l. 211--><p class="nopar" > +</p><!--l. 213--><p class="noindent" > +</p> +<!--l. 213--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-60005"></a>Storing glossary information</h3> +<!--l. 215--><p class="noindent" >With the old <span +class="cmss-10">glossary </span>package you could optionally store glossary information for later +use, or you could simply use <span +class="cmtt-10">\glossary</span><a + id="dx1-6001"></a> whenever you wanted to add information to +the glossary. With the new <span +class="cmss-10">glossaries </span>package, the latter option is no longer +available.<span class="footnote-mark"><a +href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a + id="x1-6002f3"></a> +If you have stored all the glossary information using <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6004"></a>, then you will +need to convert these commands into the equivalent <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6005"></a>. If you have +only used <span +class="cmtt-10">\glossary</span><a + id="dx1-6006"></a>, then see <a +href="#x1-110006.4"><span +class="cmsy-10">§</span>6.4 </a><a +href="#x1-110006.4"><span +class="cmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. +</p><!--l. 226--><p class="indent" > Substitute all instances of +</p><!--l. 227--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6007"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> -This should be fairly easy to do using the search and replace -facility in your editor (but see notes below). - -<P> -If you have used the optional argument of <TT>\storeglosentry</TT> -(i.e. you have multiple glossaries) then you will need to -substitute - -<P> -<TT><TT>\storeglosentry[<<I>gls-type</I>>]{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> +</p><!--l. 231--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6008"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +This should be fairly easy to do using the search and replace facility in your editor (but +see notes below). +</p><!--l. 237--><p class="indent" > If you have used the optional argument of <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6009"></a> (i.e. you have multiple +glossaries) then you will need to substitute +</p><!--l. 240--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6010"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}</TT><code>{</code><<I>gls-entry</I>>,type=<<I>gls-type</I>><code>}</code></TT> -<P> - -<P> -The glossary entry information <<I>gls-entry</I>> may also need -changing. If <<I>gls-entry</I>> contains any of <TT>makeindex</TT>'s -special characters (i.e. <TT>@</TT> <TT>!</TT> <code>"</code> or -<code>|</code>) then they should no longer be escaped with <code>"</code> -since the <TT>glossaries</TT> package deals with these characters +</p><!--l. 244--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6011"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span><span class="verb"><span +class="cmtt-10">{</span></span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">,type=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-type</span><span +class="cmsy-10">⟩</span><span class="verb"><span +class="cmtt-10">}</span></span> + <br /></div><hr> + + + + <br /></span> +</p><!--l. 248--><p class="indent" > The glossary entry information <span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩ </span>may also need changing. If <span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span> +contains any of <span +class="cmtt-10">makeindex</span><a + id="dx1-6012"></a>’s special characters (i.e. <span +class="cmtt-10">@ ! </span><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">|</span></span></span>) then they should no +longer be escaped with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> since the <span +class="cmss-10">glossaries </span>package deals with these characters internally. For example, if your document contains the following: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-7"> \storeglosentry{card}{name={$"|\mathcal{S}"|$}, -description={The cardinality of the set $\mathcal{S}$}} -</PRE> -then you will need to replace it with: -<PRE> + <br />description={The cardinality of the set $\mathcal{S}$}} +</div> +<!--l. 257--><p class="nopar" > then you will need to replace it with: + + + +</p> + <div class="verbatim" id="verbatim-8"> \newglossaryentry{card}{name={$|\mathcal{S}|$}, -description={The cardinality of the set $\mathcal{S}$}} -</PRE> - -<P> -The <TT>format</TT> and <TT>number</TT> keys available in -<TT>\storeglosentry</TT> are not available with <TT>\newglossaryentry</TT>. - -<P> - -<H1><A NAME="SECTION00070000000000000000"> -6 Adding an entry to the glossary</A> -</H1> - -<P> -The <TT>glossary</TT> package provided two basic means to add -information to the glossary: firstly, the term was defined -using <TT>\storeglosentry</TT> and the entries for that term were -added using <TT>\useglosentry</TT>, <TT>\useGlosentry</TT> and <TT>\gls</TT>. -Secondly, the term was added to the glossary using <TT>\glossary</TT>. -This second approach is unavailable with the <TT>glossaries</TT> + <br />description={The cardinality of the set $\mathcal{S}$}} +</div> +<!--l. 262--><p class="nopar" > +</p><!--l. 264--><p class="indent" > The <span +class="cmss-10">format</span><a + id="dx1-6013"></a> and <span +class="cmss-10">number</span><a + id="dx1-6014"></a> keys available in <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6015"></a> are not available with +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6016"></a>. +</p><!--l. 268--><p class="noindent" > +</p> +<!--l. 268--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-70006"></a>Adding an entry to the glossary</h3> +<!--l. 270--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provided two basic means to add information to the glossary: +firstly, the term was defined using <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-7001"></a> and the entries for that term were +added using <span +class="cmtt-10">\useglosentry</span><a + id="dx1-7002"></a>, <span +class="cmtt-10">\useGlosentry</span><a + id="dx1-7003"></a> and <span +class="cmtt-10">\gls</span><a + id="dx1-7004"></a>. Secondly, the term was added +to the glossary using <span +class="cmtt-10">\glossary</span><a + id="dx1-7005"></a>. This second approach is unavailable with the <span +class="cmss-10">glossaries</span> package. - -<P> - -<H2><A NAME="SECTION00071000000000000000"></A> -<A NAME="sec:useglosentry"></A> -<BR> -6.1 <TT>\useglosentry</TT> -</H2> - -<P> -The <TT>glossary</TT> package allows you to add information to the -glossary for a predefined term without producing any text -in the document using - -<P> -<TT><TT>\useglosentry[<<I>old options</I>>]{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 279--><p class="noindent" > +</p> +<!--l. 279--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a + id="x1-80006.1"></a><span +class="cmtt-10">\useglosentry</span></h4> +<!--l. 282--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term without producing any text in the document using +</p><!--l. 285--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useglosentry</span><a + id="dx1-8001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with - -<P> -<TT><TT>\glsadd[<<I>new options</I>>]{<<I>label</I>>}</TT></TT> -<P> -The <TT>format</TT> key in <<I>old options</I>> remains the same -in <<I>new options</I>>. However the <TT>number=</TT><<I>counter -name</I>> key in <<I>old options</I>> should be replaced with -<TT>counter=</TT><<I>counter name</I>> in <<I>new options</I>>. - -<P> - -<H2><A NAME="SECTION00072000000000000000"> -6.2 <TT>\useGlosentry</TT></A> -</H2> - -<P> -The <TT>glossary</TT> package allows you to add information to the -glossary for a predefined term with the given text using - -<P> -<TT><TT>\useGlosentry[<<I>old options</I>>]{<<I>label</I>>}{<<I>text</I>>}</TT></TT> -<P> +</p><!--l. 289--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsadd</span><a + id="dx1-8002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The <span +class="cmss-10">format</span><a + id="dx1-8003"></a> key in <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>remains the same in <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span>. However the +<span +class="cmss-10">number</span><a + id="dx1-8004"></a><span +class="cmtt-10">=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span>key in <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>should be replaced with <span +class="cmss-10">counter</span><a + id="dx1-8005"></a><span +class="cmtt-10">=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">counter</span> +<span +class="cmti-10">name</span><span +class="cmsy-10">⟩ </span>in <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span>. + + + +</p><!--l. 300--><p class="noindent" > +</p> +<!--l. 300--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a + id="x1-90006.2"></a><span +class="cmtt-10">\useGlosentry</span></h4> +<!--l. 302--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term with the given text using +</p><!--l. 304--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useGlosentry</span><a + id="dx1-9001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with - -<P> -<TT><TT>\glslink[<<I>new options</I>>]{<<I>label</I>>}{<<I>text</I>>}</TT></TT> -<P> -The mapping from <<I>old options</I>> to <<I>new options</I>> is -the same as that given <A HREF="glossary2glossaries.html#sec:useglosentry">above</A>. - -<P> - -<H2><A NAME="SECTION00073000000000000000"> -6.3 <TT>\gls</TT></A> -</H2> - -<P> -Both the <TT>glossary</TT> and the <TT>glossaries</TT> packages define -the command <TT>\gls</TT>. In this case, the only thing you need to -change is the <TT>number</TT> key in the optional argument -to <TT>counter</TT>. Note that the new form of <TT>\gls</TT> also takes -a final optional argument which can be used to insert text into the -automatically generated text. - -<P> - -<H2><A NAME="SECTION00074000000000000000"></A> -<A NAME="sec:csglossary"></A> -<BR> -6.4 <TT>\glossary</TT> -</H2> - -<P> -When using the <TT>glossaries</TT> package, you should not use -<TT>\glossary</TT> directly.<A NAME="tex2html5" - HREF="#foot594"><SUP>4</SUP></A> If, with the old package, you have opted to -explicitly use <TT>\glossary</TT> instead of storing the glossary -information with <TT>\storeglosentry</TT>, then converting from -<TT>glossary</TT> to <TT>glossaries</TT> will be more time-consuming, -although in the end, I hope you will see the benefits.<A NAME="tex2html6" - HREF="#foot595"><SUP>5</SUP></A> If you have -used <TT>\glossary</TT> with the old glossary package, you will instead -need to define the relevant glossary terms using -<TT>\newglossaryentry</TT> and reference the terms using -<TT>\glsadd</TT>, <TT>\glslink</TT>, <TT>\gls</TT> etc. - -<P> -If you don't like the idea of continually scrolling back to the -preamble to type all your <TT>\newglossaryentry</TT> commands, you may -prefer to create a new file, in which to store all these commands, -and then input that file in your document's preamble. Most text -editors and front-ends allow you to have multiple files open, and -you can tab back and forth between them. - -<P> - -<H1><A NAME="SECTION00080000000000000000"> -7 Acronyms</A> -</H1> - -<P> -In the <TT>glossary</TT> package, acronyms were treated differently -to glossary entries. This resulted in inconsistencies and sprawling -unmaintainable code. The new <TT>glossaries</TT> package treats -acronyms in exactly the same way as normal glossary terms. In fact, -in the <TT>glossaries</TT> package, the default definition of: - -<P> -<TT><TT>\newacronym[<<I>options</I>>]{<<I>label</I>>}{<<I>abbrv</I>>}{<<I>long</I>>}</TT></TT> -<P> +</p><!--l. 308--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslink</span><a + id="dx1-9002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The mapping from <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>to <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩ </span>is the same as that given <a +href="#x1-80006.1"><span +class="cmsy-10">§</span>6.1 +</a><a +href="#x1-80006.1"><span +class="cmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. +</p><!--l. 314--><p class="noindent" > +</p> +<!--l. 314--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a + id="x1-100006.3"></a><span +class="cmtt-10">\gls</span></h4> +<!--l. 316--><p class="noindent" >Both the <span +class="cmss-10">glossary </span>and the <span +class="cmss-10">glossaries </span>packages define the command <span +class="cmtt-10">\gls</span><a + id="dx1-10001"></a>. In this +case, the only thing you need to change is the <span +class="cmss-10">number</span><a + id="dx1-10002"></a> key in the optional +argument to <span +class="cmss-10">counter</span><a + id="dx1-10003"></a>. Note that the new form of <span +class="cmtt-10">\gls</span><a + id="dx1-10004"></a> also takes a final optional +argument which can be used to insert text into the automatically generated +text. +</p><!--l. 323--><p class="noindent" > +</p> +<!--l. 323--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a + id="x1-110006.4"></a><span +class="cmtt-10">\glossary</span></h4> +<!--l. 326--><p class="noindent" >When using the <span +class="cmss-10">glossaries </span>package, you should not use <span +class="cmtt-10">\glossary</span><a + id="dx1-11001"></a> +directly.<span class="footnote-mark"><a +href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a + id="x1-11002f4"></a> +If, with the old package, you have opted to explicitly use <span +class="cmtt-10">\glossary</span><a + id="dx1-11008"></a> instead of storing +the glossary information with <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-11009"></a>, then converting from <span +class="cmss-10">glossary </span>to +<span +class="cmss-10">glossaries </span>will be more time-consuming, although in the end, I hope you will see the +benefits.<span class="footnote-mark"><a +href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a + id="x1-11010f5"></a> +If you have used <span +class="cmtt-10">\glossary</span><a + id="dx1-11013"></a> with the old glossary package, you will instead need to +define the relevant glossary terms using <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11014"></a> and reference the terms +using <span +class="cmtt-10">\glsadd</span><a + id="dx1-11015"></a>, <span +class="cmtt-10">\glslink</span><a + id="dx1-11016"></a>, <span +class="cmtt-10">\gls</span><a + id="dx1-11017"></a> etc. +</p><!--l. 349--><p class="indent" > If you don’t like the idea of continually scrolling back to the preamble to type all +your <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11018"></a> commands, you may prefer to create a new file, in which to +store all these commands, and then input that file in your document’s preamble. Most + + + +text editors and front-ends allow you to have multiple files open, and you can tab back +and forth between them. +</p><!--l. 356--><p class="noindent" > +</p> +<!--l. 356--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="x1-120007"></a>Acronyms</h3> +<!--l. 358--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, acronyms were treated differently to glossary entries. This +resulted in inconsistencies and sprawling unmaintainable code. The new <span +class="cmss-10">glossaries</span> +package treats acronyms in exactly the same way as normal glossary terms. In fact, in +the <span +class="cmss-10">glossaries </span>package, the default definition of: +</p><!--l. 363--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newacronym</span><a + id="dx1-12001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> is a shortcut for: - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}</TT>{type=<TT>\acronymtype</TT>, -name=<TT>{<<I>abbrv</I>>}</TT>, -description=<TT>{<<I>long</I>>}</TT>, -text=<TT>{<<I>abbrv</I>>}</TT>, -first={<<I>long</I>> (<<I>abbrv</I>>)}, -plural={<<I>abbrv</I>>s}, -firstplural={<<I>long</I>>s (<<I>abbrv</I>>s)}, -<<I>options</I>>}</TT> -<P> - -<P> -This is different to the <TT>glossary</TT> package which set the -<TT>name</TT> key to <<I>long</I>> (<<I>abbrv</I>>) and allowed you -to set a description using the <TT>description</TT> key. If you -still want to do this, you can use the <TT>description</TT> package -option, and use the <TT>description</TT> key in the -optional argument of <TT>\newacronym</TT>. - -<P> -For example, if your document originally had the following: -<PRE> -\newacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -Then you would need to load the <TT>glossaries</TT> package using the -<TT>description</TT> package option, for example: -<PRE> +</p><!--l. 367--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-12002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span><span +class="cmsy-10">{</span><span +class="cmtt-10">type=\acronymtype,</span> + <br /><span +class="cmtt-10">name={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">description={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">text={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">first=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩ </span><span +class="cmtt-10">(</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmtt-10">plural=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmtt-10">firstplural=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s (</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 378--><p class="indent" > This is different to the <span +class="cmss-10">glossary </span>package which set the <span +class="cmss-10">name</span><a + id="dx1-12003"></a> key to <span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span>) +and allowed you to set a description using the <span +class="cmss-10">description</span><a + id="dx1-12004"></a> key. If you still want to do +this, you can use the <span +class="cmss-10">description</span><a + id="dx1-12005"></a> package option, and use the <span +class="cmss-10">description</span><a + id="dx1-12006"></a> key in the +optional argument of <span +class="cmtt-10">\newacronym</span><a + id="dx1-12007"></a>. +</p><!--l. 386--><p class="indent" > For example, if your document originally had the following: + + + +</p> + <div class="verbatim" id="verbatim-9"> +\newacronym{SVM}{Support Vector Machine}{description=Statistical + <br />pattern recognition technique} +</div> +<!--l. 390--><p class="nopar" > Then you would need to load the <span +class="cmss-10">glossaries </span>package using the <span +class="cmss-10">description</span><a + id="dx1-12008"></a> package +option, for example: + + + +</p> + <div class="verbatim" id="verbatim-10"> \usepackage[description]{glossaries} -</PRE> -and change the acronym definition to: -<PRE> -\newacronym[description=Statistical pattern recognition -technique]{svm}{SVM}{Support Vector Machine} -</PRE> -You can then reference the acronym using any of the new referencing -commands, such as <TT>\gls</TT> or <TT>\glsadd</TT>. - -<P> -With the old <TT>glossary</TT> package, when you defined an -acronym, it also defined a command <TT>\</TT><<I>acr-name</I>> which -could be used to display the acronym in the text. So the -above SVM example would create the command <TT>\SVM</TT> with the old -package. In the new <TT>glossaries</TT> package, the acronyms are just -another type of glossary entry, so they are displayed using -<TT>\gls{<<I>label</I>>}</TT>. Therefore, in the above example, you will -also need to replace all occurrences of <TT>\SVM</TT> with -<code>\gls{svm}</code>. - -<P> -If you have used <TT>\useacronym</TT> instead of <TT>\</TT><<I>acr-name</I>>, -then you will need to replace all occurrences of - -<P> -<TT><TT>\useacronym[<<I>insert</I>>]{<<I>acr-name</I>>}</TT></TT> -<P> +</div> +<!--l. 395--><p class="nopar" > and change the acronym definition to: + + + +</p> + <div class="verbatim" id="verbatim-11"> +\newacronym[description=Statistical pattern recognition + <br />technique]{svm}{SVM}{Support Vector Machine} +</div> +<!--l. 400--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such +as <span +class="cmtt-10">\gls</span><a + id="dx1-12009"></a> or <span +class="cmtt-10">\glsadd</span><a + id="dx1-12010"></a>. +</p><!--l. 404--><p class="indent" > With the old <span +class="cmss-10">glossary </span>package, when you defined an acronym, it also defined a +command <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩ </span>which could be used to display the acronym in the text. +So the above SVM example would create the command <span +class="cmtt-10">\SVM </span>with the old +package. In the new <span +class="cmss-10">glossaries </span>package, the acronyms are just another type of +glossary entry, so they are displayed using <span +class="cmtt-10">\gls</span><a + id="dx1-12011"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span>. Therefore, in the +above example, you will also need to replace all occurrences of <span +class="cmtt-10">\SVM </span>with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span>. +</p><!--l. 414--><p class="indent" > If you have used <span +class="cmtt-10">\useacronym</span><a + id="dx1-12012"></a> instead of <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>, then you will need to replace +all occurrences of +</p><!--l. 416--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useacronym</span><a + id="dx1-12013"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">insert</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\gls{<<I>label</I>>}[<<I>insert</I>>]</TT></TT> -<P> -Note that the starred versions of <TT>\useacronym</TT> and -<TT>\</TT><<I>acr-name</I>> (which make the first letter uppercase) should -be replaced with <TT>\Gls{<<I>label</I>>}</TT>. - -<P> -Alternatively (as from v1.18 of the <TT>glossaries</TT> package), -you can use <TT>\oldacronym</TT> which uses the same syntax as -the old <TT>glossary</TT> package's <TT>\newacronym</TT> and also -defines <TT>\</TT><<I>acr-name</I>>. -For example, if your document originally had the following: - -<P><PRE> -\newacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -<P> +</p><!--l. 420--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\gls</span><a + id="dx1-12014"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">insert</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> +Note that the starred versions of <span +class="cmtt-10">\useacronym</span><a + id="dx1-12015"></a> and <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩ </span>(which make the first +letter uppercase) should be replaced with <span +class="cmtt-10">\Gls</span><a + id="dx1-12016"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span>. +</p><!--l. 427--><p class="indent" > Alternatively (as from v1.18 of the <span +class="cmss-10">glossaries </span>package), you can use <span +class="cmtt-10">\oldacronym</span><a + id="dx1-12017"></a> +which uses the same syntax as the old <span +class="cmss-10">glossary </span>package’s <span +class="cmtt-10">\newacronym</span><a + id="dx1-12018"></a> and +also defines <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>. For example, if your document originally had the +following: +</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + + + + <div class="verbatim" id="verbatim-12"> +<!--l. 436--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 436--><p class="noindent" >pattern recognition technique} + +</p></div> +<!--l. 436--><p class="nopar" > + </div><hr> +</p><!--l. 437--><p class="noindent" ></p></span> then you can change this to: - -<P><PRE> -\oldacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -<P> -You can then continue to use <TT>\SVM</TT>. However, remember that -LaTeX generally ignores spaces after command names that consist of -alphabetical characters. You will therefore need to force a space -after <TT>\</TT><<I>acr-name</I>>, unless you also load the <TT>xspace</TT> -package. (See the -<A NAME="tex2html7" - HREF="glossaries-manual.html#sec:acronyms">Acronyms</A> -section of the <TT>glossaries</TT> documentation for further -details.) Note that <TT>\oldacronym</TT> uses its first argument to -define the acronym's label (as used by commands like <TT>\gls</TT>), so -in the above example, with the new <TT>glossaries</TT> package, -<TT>\SVM</TT> becomes a shortcut for <code>\gls{SVM}</code> and <TT>\SVM*</TT> -becomes a shortcut for <code>\Gls{SVM}</code>. - -<P> - -<H2><A NAME="SECTION00081000000000000000"> -7.1 <TT>\acrln</TT> and <TT>\acrsh</TT></A> -</H2> - -<P> -In the <TT>glossary</TT> package, it is possible to produce the -long and short forms of an acronym without adding an entry to -the glossary using <TT>\acrln</TT> and <TT>\acrsh</TT>. With the -<TT>glossaries</TT> package (provided you defined the acronym using -<TT>\newacronym</TT> or <TT>\oldacronym</TT> and provided you haven't redefined <TT>\newacronym</TT>) -you can replace - -<P> -<TT><TT>\acrsh{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 439--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + + + + <div class="verbatim" id="verbatim-13"> +<!--l. 443--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 443--><p class="noindent" >pattern recognition technique} + +</p></div> +<!--l. 443--><p class="nopar" > + </div><hr> +</p><!--l. 444--><p class="noindent" ></p></span> +You can then continue to use <span +class="cmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> generally ignores +spaces after command names that consist of alphabetical characters. You will therefore +need to force a space after <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>, unless you also load the <span +class="cmss-10">xspace </span>package. +(See <a +href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +class="cmss-10">glossaries </span>documentation for further details.) Note that +<span +class="cmtt-10">\oldacronym</span><a + id="dx1-12019"></a> uses its first argument to define the acronym’s label (as used by +commands like <span +class="cmtt-10">\gls</span><a + id="dx1-12020"></a>), so in the above example, with the new <span +class="cmss-10">glossaries </span>package, +<span +class="cmtt-10">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{SVM}</span></span></span> and <span +class="cmtt-10">\SVM* </span>becomes a shortcut for +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Gls{SVM}</span></span></span>. +</p><!--l. 462--><p class="noindent" > +</p> +<!--l. 462--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a + id="x1-130007.1"></a><span +class="cmtt-10">\acrln </span>and <span +class="cmtt-10">\acrsh</span></h4> +<!--l. 464--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, it is possible to produce the long and short forms of an +acronym without adding an entry to the glossary using <span +class="cmtt-10">\acrln</span><a + id="dx1-13001"></a> and <span +class="cmtt-10">\acrsh</span><a + id="dx1-13002"></a>. With +the <span +class="cmss-10">glossaries </span>package (provided you defined the acronym using <span +class="cmtt-10">\newacronym</span><a + id="dx1-13003"></a> +or <span +class="cmtt-10">\oldacronym</span><a + id="dx1-13004"></a> and provided you haven’t redefined <span +class="cmtt-10">\newacronym</span><a + id="dx1-13005"></a>) you can +replace +</p><!--l. 471--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrsh</span><a + id="dx1-13006"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\acrshort{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 475--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrshort</span><a + id="dx1-13007"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> and you can replace - -<P> -<TT><TT>\acrln{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 479--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrln</span><a + id="dx1-13008"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + + + + <br /></span> with - -<P> -<TT><TT>\acrlong{<<I>label</I>>}</TT></TT> -<P> -The <TT>glossaries</TT> package also provides the related commands -<TT>\acrshortpl</TT> (plural short form) and <TT>\acrlongpl</TT> (plural long -form) as well as upper case variations. If you use the -<TT>glossaries</TT> "shortcuts" package option, you can use -<TT>\acs</TT> in place of <TT>\acrshort</TT> and <TT>\acl</TT> in place of -<TT>\acrlong</TT>. - -<P> -See the -<A NAME="tex2html8" - HREF="glossaries-manual.html#sec:acronyms">Acronyms</A> -section of the <TT>glossaries</TT> manual for further details of -how to use these commands. - -<P> - -<H2><A NAME="SECTION00082000000000000000"> -7.2 <TT>\ifacronymfirstuse</TT></A> -</H2> - -<P> -The <TT>glossary</TT> package command - -<P> -<TT><TT>\ifacronymfirstuse{<<I>acr-name</I>>}{<<I>text1</I>>}{<<I>text2</I>>}</TT></TT> -<P> -can be replaced by the <TT>glossaries</TT> command: - -<P> -<TT><TT>\ifglsused{<<I>label</I>>}{<<I>text2</I>>}{<<I>text1</I>>}</TT></TT> -<P> -Note that <TT>\ifglsused</TT> evaluates the opposite condition to -that of <TT>\ifacronymfirstuse</TT> which is why the last two arguments -have been reversed. - -<P> - -<H2><A NAME="SECTION00083000000000000000"> -7.3 <TT>\resetacronym</TT> and <TT>\unsetacronym</TT></A> -</H2> - -<P> -The <TT>glossary</TT> package allows you to reset and unset the -acronym flag which is used to determine whether the acronym has -been used in the document. The <TT>glossaries</TT> package also -provides a means to do this on either a local or a global level. -To reset an acronym, you will need to replace: - -<P> -<TT><TT>\resetacronym{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 483--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrlong</span><a + id="dx1-13009"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The <span +class="cmss-10">glossaries </span>package also provides the related commands <span +class="cmtt-10">\acrshortpl</span><a + id="dx1-13010"></a> (plural short +form) and <span +class="cmtt-10">\acrlongpl</span><a + id="dx1-13011"></a> (plural long form) as well as upper case variations. If you use the +<span +class="cmss-10">glossaries </span>“shortcuts” package option, you can use <span +class="cmtt-10">\acs</span><a + id="dx1-13012"></a> in place of <span +class="cmtt-10">\acrshort</span><a + id="dx1-13013"></a> and <span +class="cmtt-10">\acl</span><a + id="dx1-13014"></a> +in place of <span +class="cmtt-10">\acrlong</span><a + id="dx1-13015"></a>. +</p><!--l. 493--><p class="indent" > See <a +href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +class="cmss-10">glossaries </span>manual for further details of how to use these +commands. +</p><!--l. 502--><p class="noindent" > +</p> +<!--l. 502--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a + id="x1-140007.2"></a><span +class="cmtt-10">\ifacronymfirstuse</span></h4> +<!--l. 504--><p class="noindent" >The <span +class="cmss-10">glossary </span>package command +</p><!--l. 505--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\ifacronymfirstuse</span><a + id="dx1-14001"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text1</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text2</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +can be replaced by the <span +class="cmss-10">glossaries </span>command: +</p><!--l. 509--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\ifglsused</span><a + id="dx1-14002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text2</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text1</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +Note that <span +class="cmtt-10">\ifglsused</span><a + id="dx1-14003"></a> evaluates the opposite condition to that of <span +class="cmtt-10">\ifacronymfirstuse</span><a + id="dx1-14004"></a> +which is why the last two arguments have been reversed. +</p><!--l. 518--><p class="noindent" > +</p> +<!--l. 518--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a + id="x1-150007.3"></a><span +class="cmtt-10">\resetacronym </span>and <span +class="cmtt-10">\unsetacronym</span></h4> +<!--l. 520--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to reset and unset the acronym flag which is used to +determine whether the acronym has been used in the document. The <span +class="cmss-10">glossaries </span>package +also provides a means to do this on either a local or a global level. To reset an acronym, +you will need to replace: +</p><!--l. 525--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\resetacronym</span><a + id="dx1-15001"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + + + + <br /></span> with either - -<P> -<TT><TT>\glsreset{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 529--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsreset</span><a + id="dx1-15002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalreset{<<I>label</I>>}</TT></TT> -<P> - -<P> -To unset an acronym, you will need to replace: - -<P> -<TT><TT>\unsetacronym{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 533--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalreset</span><a + id="dx1-15003"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 537--><p class="indent" > To unset an acronym, you will need to replace: +</p><!--l. 538--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\unsetacronym</span><a + id="dx1-15004"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with either - -<P> -<TT><TT>\glsunset{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 542--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsunset</span><a + id="dx1-15005"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalunset{<<I>label</I>>}</TT></TT> -<P> - -<P> -To reset all acronyms, you will need to replace: - -<P> -<TT><TT>\resetallacronyms</TT></TT> -<P> +</p><!--l. 546--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalunset</span><a + id="dx1-15006"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 550--><p class="indent" > To reset all acronyms, you will need to replace: +</p><!--l. 551--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\resetallacronyms</span><a + id="dx1-15007"></a> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\glsresetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 555--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsresetall</span><a + id="dx1-15008"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15009"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> + + + or - -<P> -<TT><TT>\glslocalresetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 559--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalresetall</span><a + id="dx1-15010"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15011"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> To unset all acronyms, you will need to replace: - -<P> -<TT><TT>\unsetallacronyms</TT></TT> -<P> +</p><!--l. 563--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\unsetallacronyms</span><a + id="dx1-15012"></a> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\glsunsetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 567--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsunsetall</span><a + id="dx1-15013"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15014"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalunsetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> - -<P> - -<H1><A NAME="SECTION00090000000000000000"> -8 Displaying the glossary</A> -</H1> - -<P> -The <TT>glossary</TT> package provides the command <TT>\printglossary</TT> -(or <TT>\print</TT><<I>type</I>> for other glossary types) which -can be used to print individual glossaries. The <TT>glossaries</TT> -package provides the command <TT>\printglossaries</TT> which -will print all the glossaries which have been defined, or -<TT>\printglossary[<<I>options</I>>]</TT> to print individual glossaries. -So if you just have <TT>\printglossary</TT>, then you can leave it as -it is, but if you have, say: -<PRE> +</p><!--l. 571--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalunsetall</span><a + id="dx1-15015"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15016"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> +</p><!--l. 575--><p class="noindent" > +</p> +<!--l. 575--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="x1-160008"></a>Displaying the glossary</h3> +<!--l. 577--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provides the command <span +class="cmtt-10">\printglossary</span><a + id="dx1-16001"></a> (or <span +class="cmtt-10">\print</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩ </span>for +other glossary types) which can be used to print individual glossaries. The <span +class="cmss-10">glossaries</span> +package provides the command <span +class="cmtt-10">\printglossaries</span><a + id="dx1-16002"></a> which will print all the glossaries +which have been defined, or <span +class="cmtt-10">\printglossary</span><a + id="dx1-16003"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">] </span>to print individual glossaries. +So if you just have <span +class="cmtt-10">\printglossary</span><a + id="dx1-16004"></a>, then you can leave it as it is, but if you have, +say: + + + +</p> + <div class="verbatim" id="verbatim-14"> \printglossary -\printglossary[acronym] -</PRE> -or -<PRE> + <br />\printglossary[acronym] +</div> +<!--l. 588--><p class="nopar" > or + + + +</p> + <div class="verbatim" id="verbatim-15"> \printglossary -\printacronym -</PRE> -then you will need to replace this with either -<PRE> + <br />\printacronym +</div> +<!--l. 593--><p class="nopar" > then you will need to replace this with either + + + +</p> + <div class="verbatim" id="verbatim-16"> \printglossaries -</PRE> -or -<PRE> +</div> +<!--l. 597--><p class="nopar" > or + + + +</p> + <div class="verbatim" id="verbatim-17"> \printglossary -\printglossary[type=\acronymtype] -</PRE> - -<P> -The <TT>glossary</TT> package allows you to specify a short title -(for the table of contents and page header) by defining a command -of the form <TT>\short</TT><<I>glossary-type</I>><TT>name</TT>. The -<TT>glossaries</TT> package doesn't do this, but instead provides -the <TT>toctitle</TT> key which can be used in the optional -argument to <TT>\printglossary</TT>. For example, if you have created -a new glossary type called <TT>notation</TT>, and you had -defined -<PRE> + <br />\printglossary[type=\acronymtype] +</div> +<!--l. 602--><p class="nopar" > +</p><!--l. 604--><p class="indent" > The <span +class="cmss-10">glossary </span>package allows you to specify a short title (for the table of contents and +page header) by defining a command of the form <span +class="cmtt-10">\short</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name</span>. The +<span +class="cmss-10">glossaries </span>package doesn’t do this, but instead provides the <span +class="cmss-10">toctitle</span><a + id="dx1-16005"></a> key which can be +used in the optional argument to <span +class="cmtt-10">\printglossary</span><a + id="dx1-16006"></a>. For example, if you have created a +new glossary type called <span +class="cmtt-10">notation</span>, and you had defined + + + +</p> + <div class="verbatim" id="verbatim-18"> \newcommand{\shortnotationname}{Notation} -</PRE> -then you would need to use the <TT>toctitle</TT> key: -<PRE> +</div> +<!--l. 614--><p class="nopar" > then you would need to use the <span +class="cmss-10">toctitle</span><a + id="dx1-16007"></a> key: + + + +</p> + <div class="verbatim" id="verbatim-19"> \printglossary[type=notation,toctitle=Notation] -</PRE> -The <TT>glossaries</TT> package will ignore <TT>\shortnotationname</TT>, -so unless you have used it elsewhere in the document, you may -as well remove the definition. - -<P> - -<H1><A NAME="SECTION000100000000000000000"> -9 Processing Your Document</A> -</H1> - -<P> -If you convert your document from using the <TT>glossary</TT> package -to the <TT>glossaries</TT> package, you will need to delete any of -the additional files, such as the <TT>.glo</TT> file, that were -created by the <TT>glossary</TT> package, as the <TT>glossaries</TT> -package uses a different format. -Remember also, that if you used the <TT>makeglos</TT> Perl script, -you will need to use the <TT>makeglossaries</TT> Perl script -instead. As from v1.17, the <TT>glossaries</TT> package can be -used with either <TT>makeindex</TT> or <TT>xindy</TT>. Since -<TT>xindy</TT> was designed to be multilingual, the -new <TT>glossaries</TT> package is a much better option for -non-English documents. - -<P> -For further information on using <TT>makeglossaries</TT>, -<TT>makeindex</TT> or <TT>xindy</TT> to create your glossaries, see -the -<A NAME="tex2html9" - HREF="glossaries-manual.html#sec:makeglossaries">Generating the Associated Glossary -Files</A> -section of the -<TT>glossaries</TT> documentation. - -<P> - -<H1><A NAME="SECTION000110000000000000000"> -10 Troubleshooting</A> -</H1> - -<P> -Please check the <A NAME="tex2html10" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html">FAQ</A> -for the <TT>glossaries</TT> package if you have any -problems. - -<P> -<BR><HR><H4>Footnotes</H4> -<DL> -<DT><A NAME="foot582">... choose</A><A - HREF="glossary2glossaries.html#tex2html1"><SUP>1</SUP></A></DT> -<DD>as from v1.17. Previous versions -were designed to be used with <TT>makeindex</TT> only - -</DD> -<DT><A NAME="foot88">... supported;</A><A - HREF="glossary2glossaries.html#tex2html2"><SUP>2</SUP></A></DT> -<DD>as -from v1.17 - -</DD> -<DT><A NAME="foot585">... -available.</A><A - HREF="glossary2glossaries.html#tex2html4"><SUP>3</SUP></A></DT> -<DD>mainly because having a key value list in -<TT>\glossary</TT> caused problems, but it also helps consistency. - -</DD> -<DT><A NAME="foot594">... directly.</A><A - HREF="glossary2glossaries.html#tex2html5"><SUP>4</SUP></A></DT> -<DD>This is because <TT>\glossary</TT> -requires the argument to be in a specific format and doesn't use the -<<I>key</I>>=<<I>value</I>> format that the old glossary package used. -The new package's internal commands set this format, as well as -escaping any of <TT>makeindex</TT>'s or <TT>xindy</TT>'s special -characters. What's more, the format has changed as from v1.17 to -allow the new package to be used with either <TT>makeindex</TT> or -<TT>xindy</TT>. - -</DD> -<DT><A NAME="foot595">... benefits.</A><A - HREF="glossary2glossaries.html#tex2html6"><SUP>5</SUP></A></DT> -<DD>From -the user's point of view, using <TT>\glossary</TT> throughout the -document is time consuming, and if you use it more than once for the -same term, there's a chance extra spaces may creep in which will -cause <TT>makeindex</TT> to treat the two entries as different -terms, even though they look the same in the document. - -</DD> -</DL> -<BR><HR> - -</BODY> -</HTML> +</div> +<!--l. 618--><p class="nopar" > The <span +class="cmss-10">glossaries </span>package will ignore <span +class="cmtt-10">\shortnotationname</span><a + id="dx1-16008"></a>, so unless you have used it +elsewhere in the document, you may as well remove the definition. +</p><!--l. 623--><p class="noindent" > +</p> +<!--l. 623--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="x1-170009"></a>Processing Your Document</h3> +<!--l. 625--><p class="noindent" >If you convert your document from using the <span +class="cmss-10">glossary </span>package to the <span +class="cmss-10">glossaries </span>package, +you will need to delete any of the additional files, such as the <span +class="cmtt-10">.glo</span><a + id="dx1-17001"></a> file, that were +created by the <span +class="cmss-10">glossary </span>package, as the <span +class="cmss-10">glossaries </span>package uses a different format. +Remember also, that if you used the <span +class="cmtt-10">makeglos</span><a + id="dx1-17002"></a> Perl script, you will need to use the +<span +class="cmtt-10">makeglossaries</span><a + id="dx1-17003"></a> Perl script instead. As from v1.17, the <span +class="cmss-10">glossaries </span>package +can be used with either <span +class="cmtt-10">makeindex</span><a + id="dx1-17004"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-17005"></a>. Since <span +class="cmtt-10">xindy</span><a + id="dx1-17006"></a> was designed to be +multilingual, the new <span +class="cmss-10">glossaries </span>package is a much better option for non-English +documents. +</p><!--l. 638--><p class="indent" > For further information on using <span +class="cmtt-10">makeglossaries</span><a + id="dx1-17007"></a>, <span +class="cmtt-10">makeindex</span><a + id="dx1-17008"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-17009"></a> to create +your glossaries, see <a +href="glossaries-manual.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span +class="cmss-10">glossaries</span> +documentation. +</p><!--l. 647--><p class="noindent" > +</p> +<!--l. 647--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="x1-1800010"></a>Troubleshooting</h3> +<!--l. 649--><p class="noindent" >Please check the <a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" >FAQ</a> for the <span +class="cmss-10">glossaries </span>package if you have any problems. +</p><!--l. 2--><p class="noindent" > +</p> +<!--l. 2--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="likesectionHead"><a + id="x1-1900010"></a>Index</h3> +<!--l. 4--><p class="noindent" > <span +class="cmbx-10">F</span> +</p> + <div class="theindex"><span class="index-item">file types<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">.glo</span>  13 <br /></span> +<p class="theindex"> <span +class="cmbx-10">G</span> +<span class="index-item"><span +class="cmtt-10">\gls </span>options<br /></span> + + + +<span class="index-subitem">    <span +class="cmss-10">counter</span>  7 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  7 <br /></span> +<span class="index-item"><span +class="cmtt-10">\glsadd </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">counter</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">M</span> +<span class="index-item"><span +class="cmtt-10">makeglos</span>  13 <br /></span> +<span class="index-item"><span +class="cmtt-10">makeglossaries</span>  13 <br /></span> +<span class="index-item"><span +class="cmtt-10">makeindex</span>  2, 6, 7, 13 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">N</span> +<span class="index-item"><span +class="cmtt-10">\newglossaryentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">description</span>  8 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">name</span>  8 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">P</span> +<span class="index-item">package options:<br /></span> +<span class="index-subitem">    <span +class="cmss-10">description</span>  <span class="underline">8</span> <br /></span> +<span class="index-item"><span +class="cmtt-10">\printglossary </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">style</span>  4 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">toctitle</span>  4, 12 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">S</span> +<span class="index-item"><span +class="cmtt-10">\storeglosentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">format</span>  6 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">U</span> +<span class="index-item"><span +class="cmtt-10">\useglosentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">format</span>  6 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">X</span> +<span class="index-item"><span +class="cmtt-10">xindy</span>  2, 7, 13 <br /></span> +</p></div> + + + + <div class="footnotes"><!--l. 68--><p class="noindent" ><span class="footnote-mark"><a +href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span +class="cmr-8">as from v1.17. Previous versions were designed to be used with </span><span +class="cmtt-8">makeindex</span><a + id="dx1-2002"></a> <span +class="cmr-8">only</span></p> +<!--l. 83--><p class="noindent" ><span class="footnote-mark"><a +href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span +class="cmr-8">as from v1.17</span></p><!--l. 220--><p class="indent" > <span class="footnote-mark"><a +href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span +class="cmr-8">mainly because having a key value list in </span><span +class="cmtt-8">\glossary</span><a + id="dx1-6003"></a> <span +class="cmr-8">caused problems, but it also helps</span> +<span +class="cmr-8">consistency.</span></p> +<!--l. 334--><p class="indent" > <span class="footnote-mark"><a +href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span +class="cmr-8">This is because </span><span +class="cmtt-8">\glossary</span><a + id="dx1-11003"></a> <span +class="cmr-8">requires the argument to be in a specific format and doesn’t use the</span> +<span +class="cmsy-8">⟨</span><span +class="cmti-8">key</span><span +class="cmsy-8">⟩</span><span +class="cmr-8">=</span><span +class="cmsy-8">⟨</span><span +class="cmti-8">value</span><span +class="cmsy-8">⟩ </span><span +class="cmr-8">format that the old glossary package used. The new package’s internal commands set</span> +<span +class="cmr-8">this format, as well as escaping any of </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11004"></a><span +class="cmr-8">’s or </span><span +class="cmtt-8">xindy</span><a + id="dx1-11005"></a><span +class="cmr-8">’s special characters. What’s more, the</span> +<span +class="cmr-8">format has changed as from v1.17 to allow the new package to be used with either </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11006"></a> <span +class="cmr-8">or</span> +<span +class="cmtt-8">xindy</span><a + id="dx1-11007"></a><span +class="cmr-8">.</span></p> +<!--l. 343--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span +class="cmr-8">From the user’s point of view, using </span><span +class="cmtt-8">\glossary</span><a + id="dx1-11011"></a> <span +class="cmr-8">throughout the document is time consuming,</span> +<span +class="cmr-8">and if you use it more than once for the same term, there’s a chance extra spaces may creep in which</span> +<span +class="cmr-8">will cause </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11012"></a> <span +class="cmr-8">to treat the two entries as different terms, even though they look the same in the</span> +<span +class="cmr-8">document.</span></p> </div> + +</body></html> + + + + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf Binary files differindex ef0c52a898e..74775aaea50 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index eae0a6359ad..384ae3995d6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -1,71 +1,49 @@ -\documentclass[a4paper]{article} +\documentclass{nlctdoc} \usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot}, pdftitle={Upgrading from the glossary package to the glossaries package}]{hyperref} -\usepackage{html} -\usepackage{xr} +\usepackage{xr-hyper} +\ifpdf \externaldocument{glossaries} +\fi + +\IndexPrologue{\section*{Index}} +\setcounter{IndexColumns}{2} \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{14th January 2009} - -%\begin{latexonly} -\newcommand*{\sty}[1]{\textsf{#1}} -\newcommand*{\key}[1]{\textsf{#1}} -\newcommand*{\pkgopt}[1]{\textsf{#1}} -\newcommand*{\dq}[1]{``#1''} - -\newsavebox\waybox -\newenvironment{oldway}{\begin{lrbox}{\waybox}% -\begin{minipage}{0.98\linewidth}\ttfamily -\ignorespaces}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent -\begin{tabular}{@{}r@{}}% -\fbox{\usebox\waybox}\\[4pt]\footnotesize\mbox{\sty{glossary}}% -\end{tabular}% -\vskip\baselineskip\par\noindent\ignorespacesafterend} - -\newenvironment{newway}{\begin{lrbox}{\waybox} -\begin{minipage}{0.98\linewidth}\ttfamily -\ignorespaces}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent -\begin{tabular}{@{}r@{}}% -\fbox{\usebox\waybox}\\[4pt]\footnotesize\mbox{\sty{glossaries}} -\end{tabular}% -\vskip\baselineskip\par\noindent\ignorespacesafterend} -\newcommand*{\meta}[1]{\textnormal{$\langle$\emph{#1}$\rangle$}} -%\end{latexonly} -\begin{htmlonly} -\newenvironment{oldway}{\par\begin{ttfamily}}{\end{ttfamily}\par} -\newenvironment{newway}{\par\begin{ttfamily}}{\end{ttfamily}\par} -\newcommand{\sty}[1]{\texttt{#1}} -\renewcommand{\LaTeX}{LaTeX} -\newcommand*{\key}[1]{\texttt{#1}} -\newcommand*{\pkgopt}[1]{\texttt{#1}} -\newcommand*{\dq}[1]{"#1"} -\newcommand*{\meta}[1]{\textnormal{\textless\emph{#1}\textgreater}} -\end{htmlonly} - -\newcommand*{\marg}[1]{\texttt{\char`\{\meta{#1}\char`\}}} -\newcommand*{\oarg}[1]{\texttt{[\meta{#1}]}} -\newcommand*{\cs}[1]{\texttt{\char`\\#1}} +\date{2010-05-28} + +\newenvironment{oldway}{% + \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines +}{% + \end{labelledbox}% +} + +\newenvironment{newway}{% + \begin{labelledbox}{\styfmt{glossaries}}\ttfamily\obeylines +}{% + \end{labelledbox}% +} \begin{document} \maketitle -\tableofcontents \begin{abstract} -The purpose of this document is to provide advice if you want -to convert a \LaTeX\ document from using the obsolete -\sty{glossary} package to the replacement \sty{glossaries} package. +The purpose of this document is to provide advice if you want to +convert a \LaTeX\ document from using the obsolete \styfmt{glossary} +package to the replacement \styfmt{glossaries} package. \end{abstract} +\tableofcontents + \section{Why the Need for a New Package?} \label{whyglossaries} -The \sty{glossary} package started out as an example in a tutorial, +The \styfmt{glossary} package started out as an example in a tutorial, but I decided that I may as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and unable to adapt well to the wide variation in glossary styles. Users began making requests for @@ -73,7 +51,7 @@ enhancements, but with each enhancement the code became more complicated and bugs crept in. Each fix in one place seemed to cause another problem elsewhere. In the end, it was taking up too much of my time to maintain, so I decided to replace it with a much -better designed package. With the new \sty{glossaries} package: +better designed package. With the new \styfmt{glossaries} package: \begin{itemize} \item you can define irregular plurals; @@ -87,9 +65,9 @@ to the name and description; fixed names used in headings and by some of the glossary styles; \item you can choose\footnote{as from v1.17. Previous versions -were designed to be used with \texttt{makeindex} only} between using -\texttt{makeindex} or \texttt{xindy} to sort the glossary. Using -\texttt{xindy} means that: +were designed to be used with \app{makeindex} only} between using +\app{makeindex} or \app{xindy} to sort the glossary. Using +\app{xindy} means that: \begin{itemize} \item there is much better support for terms containing accented @@ -98,7 +76,7 @@ were designed to be used with \texttt{makeindex} only} between using \item there is support for non-standard location numbers; \end{itemize} -\item you don't need to remember to escape \texttt{makeindex}'s +\item you don't need to remember to escape \app{makeindex}'s special characters as this is done internally; \item hierarchical entries and homographs are supported;\footnote{as @@ -116,21 +94,21 @@ maintain consistency; \section{Package Options} When converting a document that currently uses the obsolete -\sty{glossary} package to the replacement \sty{glossaries} package, +\styfmt{glossary} package to the replacement \styfmt{glossaries} package, it should be fairly obvious that the first thing you need to do is replace \verb|\usepackage{glossary}| with \verb|\usepackage{glossaries}|, however some of the package options are different, so you may need to change those as well. -Table~\ref{tab:pkgopt} shows the mappings from the \sty{glossary} -to the \sty{glossaries} package options. +Table~\ref{tab:pkgopt} shows the mappings from the \styfmt{glossary} +to the \styfmt{glossaries} package options. \begin{table}[htbp] -\caption[Mappings]{Mappings from \sty{glossary} to \sty{glossaries} +\caption[Mappings]{Mappings from \styfmt{glossary} to \styfmt{glossaries} package options} \label{tab:pkgopt} \begin{center} \begin{tabular}{ll} -\bfseries \sty{glossary} option & \bfseries \sty{glossaries} option\\ +\bfseries \styfmt{glossary} option & \bfseries \styfmt{glossaries} option\\ style=list & style=list\\ style=altlist & style=altlist\\ style=long,header=none,border=none,cols=2 & style=long\\ @@ -167,20 +145,20 @@ global & \emph{no corresponding option} If you have created new glossary types, you will need to replace all instances of \begin{oldway} -\cs{newglossarytype}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\oarg{old style list}\newline +\ics{newglossarytype}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\oarg{old style list}\newline \cs{newcommand}\verb|{\|\meta{type}name\verb|}|\marg{title} \end{oldway}% with \begin{newway} -\cs{newglossary}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\marg{title} +\ics{newglossary}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\marg{title} \end{newway}% in the preamble, and, if the new glossary requires a different style to the main (default) glossary, you will also need to put \begin{newway} -\cs{glossarystyle}\marg{new style} +\ics{glossarystyle}\marg{new style} \end{newway}% immediately before the glossary is displayed, or you can specify -the style when you display the glossary using \cs{printglossary} +the style when you display the glossary using \ics{printglossary} (see below). The \meta{old style list} optional argument can be converted to @@ -196,31 +174,32 @@ You will need to replace the above two lines with: \begin{verbatim} \newglossary[nlg]{notation}{not}{ntn}{Index of Notation} \end{verbatim} -in the preamble and +in the preamble and \begin{verbatim} \glossarystyle{longheader} \end{verbatim} -immediately prior to displaying this glossary. -Alternatively, you can specify the style using the \key{style} -key in the optional argument of \cs{printglossary}. For example: +immediately prior to displaying this glossary. Alternatively, you +can specify the style using the \csopt{printglossary}{style} key in +the optional argument of \ics{printglossary}. For example: \begin{verbatim} \printglossary[type=notation,style=longheader] \end{verbatim} -Note that the glossary title is no longer specified using -\cs{}\meta{glossary-type}\texttt{name} (except for \cs{glossaryname} -and \cs{acronymname}) but is instead specified in the \meta{title} -argument of \cs{newglossary}. The short title which is specified -in the \sty{glossary} package by the command -\cs{short}\meta{glossary-name}\texttt{name} is now specified -using the \key{toctitle} key in the optional argument to -\cs{printglossary}. +Note that the glossary title is no longer specified using +\cs{}\meta{glossary-type}\texttt{name} (except for \ics{glossaryname} +and \ics{acronymname}) but is instead specified in the \meta{title} +argument of \ics{newglossary}. The short title which is specified in +the \styfmt{glossary} package by the command +\cs{short}\meta{glossary-name}\texttt{name} is now specified using +the \csopt{printglossary}{toctitle} key in the optional argument to +\ics{printglossary}. -\section{\cs{make}\meta{glossary name}} +\section{\texorpdfstring{\cs{make}\meta{glossary +name}}{\textbackslash make...}} All instances of \cs{make}\meta{glossary name} (e.g.\ -\cs{makeglossary} and \cs{makeacronym}) should be replaced -by the single command \cs{makeglossaries}. For example, if +\ics{makeglossary} and \ics{makeacronym}) should be replaced +by the single command \ics{makeglossaries}. For example, if your document contained the following: \begin{verbatim} \makeglossary @@ -233,45 +212,44 @@ then you should replace both lines with the single line: \section{Storing glossary information} -With the old \sty{glossary} package you could optionally store +With the old \styfmt{glossary} package you could optionally store glossary information for later use, or you could simply use -\cs{glossary} whenever you wanted to add information to the glossary. -With the new \sty{glossaries} package, the latter option is no longer +\ics{glossary} whenever you wanted to add information to the glossary. +With the new \styfmt{glossaries} package, the latter option is no longer available.\footnote{mainly because having a key value list in -\cs{glossary} caused problems, but it also helps consistency.} If +\ics{glossary} caused problems, but it also helps consistency.} If you have stored all the glossary information using -\cs{storeglosentry}, then you will need to convert these commands -into the equivalent \cs{newglossaryentry}. If you have only -used \cs{glossary}, then see -\latexhtml{section~\ref{sec:csglossary}}{\htmlref{later}{sec:csglossary}}. +\ics{storeglosentry}, then you will need to convert these commands +into the equivalent \ics{newglossaryentry}. If you have only +used \ics{glossary}, then see \sectionref{sec:csglossary}. Substitute all instances of \begin{oldway} -\cs{storeglosentry}\marg{label}\marg{gls-entry} +\ics{storeglosentry}\marg{label}\marg{gls-entry} \end{oldway}% with \begin{newway} -\cs{newglossaryentry}\marg{label}\marg{gls-entry} +\ics{newglossaryentry}\marg{label}\marg{gls-entry} \end{newway}% This should be fairly easy to do using the search and replace facility in your editor (but see notes below). -If you have used the optional argument of \cs{storeglosentry} +If you have used the optional argument of \ics{storeglosentry} (i.e.\ you have multiple glossaries) then you will need to substitute \begin{oldway} -\cs{storeglosentry}\oarg{gls-type}\marg{label}\marg{gls-entry} +\ics{storeglosentry}\oarg{gls-type}\marg{label}\marg{gls-entry} \end{oldway}% with \begin{newway} -\cs{newglossaryentry}\marg{label}\verb|{|\meta{gls-entry},type=\meta{gls-type}\verb|}| +\ics{newglossaryentry}\marg{label}\verb|{|\meta{gls-entry},type=\meta{gls-type}\verb|}| \end{newway} The glossary entry information \meta{gls-entry} may also need -changing. If \meta{gls-entry} contains any of \texttt{makeindex}'s +changing. If \meta{gls-entry} contains any of \app{makeindex}'s special characters (i.e.\ \texttt{@} \texttt{!} \verb|"| or \verb"|") then they should no longer be escaped with \verb'"' -since the \sty{glossaries} package deals with these characters +since the \styfmt{glossaries} package deals with these characters internally. For example, if your document contains the following: \begin{verbatim} \storeglosentry{card}{name={$"|\mathcal{S}"|$}, @@ -283,89 +261,93 @@ then you will need to replace it with: description={The cardinality of the set $\mathcal{S}$}} \end{verbatim} -The \key{format} and \key{number} keys available in -\cs{storeglosentry} are not available with \cs{newglossaryentry}. +The \csopt{storeglosentry}{format} and +\csopt{storeglosentry}{number} keys available in \ics{storeglosentry} +are not available with \ics{newglossaryentry}. \section{Adding an entry to the glossary} -The \sty{glossary} package provided two basic means to add +The \styfmt{glossary} package provided two basic means to add information to the glossary: firstly, the term was defined -using \cs{storeglosentry} and the entries for that term were -added using \cs{useglosentry}, \cs{useGlosentry} and \cs{gls}. -Secondly, the term was added to the glossary using \cs{glossary}. -This second approach is unavailable with the \sty{glossaries} +using \ics{storeglosentry} and the entries for that term were +added using \ics{useglosentry}, \ics{useGlosentry} and \ics{gls}. +Secondly, the term was added to the glossary using \ics{glossary}. +This second approach is unavailable with the \styfmt{glossaries} package. -\subsection{\cs{useglosentry}} +\subsection{\texorpdfstring{\cs{useglosentry}}{\textbackslash +useglosentry}} \label{sec:useglosentry} -The \sty{glossary} package allows you to add information to the -glossary for a predefined term without producing any text -in the document using +The \styfmt{glossary} package allows you to add information to the +glossary for a predefined term without producing any text in the +document using \begin{oldway} -\cs{useglosentry}\oarg{old options}\marg{label} +\ics{useglosentry}\oarg{old options}\marg{label} \end{oldway}% Any occurrences of this command will need to be replaced with \begin{newway} -\cs{glsadd}\oarg{new options}\marg{label} +\ics{glsadd}\oarg{new options}\marg{label} \end{newway}% -The \key{format} key in \meta{old options} remains the same -in \meta{new options}. However the \texttt{number=}\meta{counter -name} key in \meta{old options} should be replaced with -\texttt{counter=}\meta{counter name} in \meta{new options}. +The \csopt{useglosentry}{format} key in \meta{old options} remains +the same in \meta{new options}. However the +\csopt{useglosentry}{number}\texttt{=}\meta{counter name} key in +\meta{old options} should be replaced with +\csopt{glsadd}{counter}\texttt{=}\meta{counter name} in \meta{new +options}. -\subsection{\cs{useGlosentry}} +\subsection{\texorpdfstring{\cs{useGlosentry}}{\textbackslash +useGlosentry}} -The \sty{glossary} package allows you to add information to the +The \styfmt{glossary} package allows you to add information to the glossary for a predefined term with the given text using \begin{oldway} -\cs{useGlosentry}\oarg{old options}\marg{label}\marg{text} +\ics{useGlosentry}\oarg{old options}\marg{label}\marg{text} \end{oldway}% Any occurrences of this command will need to be replaced with \begin{newway} -\cs{glslink}\oarg{new options}\marg{label}\marg{text} +\ics{glslink}\oarg{new options}\marg{label}\marg{text} \end{newway}% The mapping from \meta{old options} to \meta{new options} is -the same as that given \latexhtml{in section~\ref{sec:useglosentry} -above}{\htmlref{above}{sec:useglosentry}}. +the same as that given \sectionref{sec:useglosentry}. -\subsection{\cs{gls}} +\subsection{\texorpdfstring{\cs{gls}}{\textbackslash gls}} -Both the \sty{glossary} and the \sty{glossaries} packages define -the command \cs{gls}. In this case, the only thing you need to -change is the \key{number} key in the optional argument -to \key{counter}. Note that the new form of \cs{gls} also takes +Both the \styfmt{glossary} and the \styfmt{glossaries} packages define +the command \ics{gls}. In this case, the only thing you need to +change is the \csopt{gls}{number} key in the optional argument +to \csopt{gls}{counter}. Note that the new form of \ics{gls} also takes a final optional argument which can be used to insert text into the automatically generated text. -\subsection{\cs{glossary}} +\subsection{\texorpdfstring{\cs{glossary}}{\textbackslash glossary}} \label{sec:csglossary} -When using the \sty{glossaries} package, you should not use -\cs{glossary} directly.\footnote{This is because \cs{glossary} +When using the \styfmt{glossaries} package, you should not use +\ics{glossary} directly.\footnote{This is because \ics{glossary} requires the argument to be in a specific format and doesn't use the \meta{key}=\meta{value} format that the old glossary package used. The new package's internal commands set this format, as well as -escaping any of \texttt{makeindex}'s or \texttt{xindy}'s special +escaping any of \app{makeindex}'s or \app{xindy}'s special characters. What's more, the format has changed as from v1.17 to -allow the new package to be used with either \texttt{makeindex} or -\texttt{xindy}.} If, with the old package, you have opted to -explicitly use \cs{glossary} instead of storing the glossary -information with \cs{storeglosentry}, then converting from -\sty{glossary} to \sty{glossaries} will be more time-consuming, +allow the new package to be used with either \app{makeindex} or +\app{xindy}.} If, with the old package, you have opted to +explicitly use \ics{glossary} instead of storing the glossary +information with \ics{storeglosentry}, then converting from +\styfmt{glossary} to \styfmt{glossaries} will be more time-consuming, although in the end, I hope you will see the benefits.\footnote{From -the user's point of view, using \cs{glossary} throughout the +the user's point of view, using \ics{glossary} throughout the document is time consuming, and if you use it more than once for the same term, there's a chance extra spaces may creep in which will -cause \texttt{makeindex} to treat the two entries as different +cause \app{makeindex} to treat the two entries as different terms, even though they look the same in the document.} If you have -used \cs{glossary} with the old glossary package, you will instead +used \ics{glossary} with the old glossary package, you will instead need to define the relevant glossary terms using -\cs{newglossaryentry} and reference the terms using -\cs{glsadd}, \cs{glslink}, \cs{gls} etc. +\ics{newglossaryentry} and reference the terms using +\ics{glsadd}, \ics{glslink}, \ics{gls} etc. If you don't like the idea of continually scrolling back to the -preamble to type all your \cs{newglossaryentry} commands, you may +preamble to type all your \ics{newglossaryentry} commands, you may prefer to create a new file, in which to store all these commands, and then input that file in your document's preamble. Most text editors and front-ends allow you to have multiple files open, and @@ -373,17 +355,17 @@ you can tab back and forth between them. \section{Acronyms} -In the \sty{glossary} package, acronyms were treated differently +In the \styfmt{glossary} package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling -unmaintainable code. The new \sty{glossaries} package treats +unmaintainable code. The new \styfmt{glossaries} package treats acronyms in exactly the same way as normal glossary terms. In fact, -in the \sty{glossaries} package, the default definition of: +in the \styfmt{glossaries} package, the default definition of: \begin{newway} -\cs{newacronym}\oarg{options}\marg{label}\marg{abbrv}\marg{long} +\ics{newacronym}\oarg{options}\marg{label}\marg{abbrv}\marg{long} \end{newway} is a shortcut for: \begin{newway} -\cs{newglossaryentry}\marg{label}\{type=\cs{acronymtype}, +\ics{newglossaryentry}\marg{label}\{type=\cs{acronymtype}, name=\marg{abbrv}, description=\marg{long}, text=\marg{abbrv}, @@ -393,19 +375,20 @@ firstplural=\{\meta{long}s (\meta{abbrv}s)\}, \meta{options}\} \end{newway} -This is different to the \sty{glossary} package which set the -\key{name} key to \meta{long} (\meta{abbrv}) and allowed you -to set a description using the \key{description} key. If you -still want to do this, you can use the \pkgopt{description} package -option, and use the \key{description} key in the -optional argument of \cs{newacronym}. +This is different to the \styfmt{glossary} package which set the +\csopt{newglossaryentry}{name} key to \meta{long} (\meta{abbrv}) and +allowed you to set a description using the +\csopt{newglossaryentry}{description} key. If you still want to do +this, you can use the \pkgopt{description} package option, and use +the \csopt{newglossaryentry}{description} key in the optional +argument of \ics{newacronym}. For example, if your document originally had the following: \begin{verbatim} \newacronym{SVM}{Support Vector Machine}{description=Statistical pattern recognition technique} \end{verbatim} -Then you would need to load the \sty{glossaries} package using the +Then you would need to load the \styfmt{glossaries} package using the \pkgopt{description} package option, for example: \begin{verbatim} \usepackage[description]{glossaries} @@ -416,34 +399,34 @@ and change the acronym definition to: technique]{svm}{SVM}{Support Vector Machine} \end{verbatim} You can then reference the acronym using any of the new referencing -commands, such as \cs{gls} or \cs{glsadd}. +commands, such as \ics{gls} or \ics{glsadd}. -With the old \sty{glossary} package, when you defined an +With the old \styfmt{glossary} package, when you defined an acronym, it also defined a command \cs{}\meta{acr-name} which could be used to display the acronym in the text. So the above SVM example would create the command \cs{SVM} with the old -package. In the new \sty{glossaries} package, the acronyms are just +package. In the new \styfmt{glossaries} package, the acronyms are just another type of glossary entry, so they are displayed using -\cs{gls}\marg{label}. Therefore, in the above example, you will +\ics{gls}\marg{label}. Therefore, in the above example, you will also need to replace all occurrences of \cs{SVM} with \verb|\gls{svm}|. -If you have used \cs{useacronym} instead of \cs{}\meta{acr-name}, +If you have used \ics{useacronym} instead of \cs{}\meta{acr-name}, then you will need to replace all occurrences of \begin{oldway} -\cs{useacronym}\oarg{insert}\marg{acr-name} +\ics{useacronym}\oarg{insert}\marg{acr-name} \end{oldway}% with \begin{newway} -\cs{gls}\marg{label}\oarg{insert} +\ics{gls}\marg{label}\oarg{insert} \end{newway}% -Note that the starred versions of \cs{useacronym} and +Note that the starred versions of \ics{useacronym} and \cs{}\meta{acr-name} (which make the first letter uppercase) should -be replaced with \cs{Gls}\marg{label}. +be replaced with \ics{Gls}\marg{label}. -Alternatively (as from v1.18 of the \sty{glossaries} package), -you can use \cs{oldacronym} which uses the same syntax as -the old \sty{glossary} package's \cs{newacronym} and also +Alternatively (as from v1.18 of the \styfmt{glossaries} package), +you can use \ics{oldacronym} which uses the same syntax as +the old \styfmt{glossary} package's \ics{newacronym} and also defines \cs{}\meta{acr-name}. For example, if your document originally had the following: \begin{oldway} @@ -462,131 +445,142 @@ pattern recognition technique} You can then continue to use \cs{SVM}\@. However, remember that \LaTeX\ generally ignores spaces after command names that consist of alphabetical characters. You will therefore need to force a space -after \cs{}\meta{acr-name}, unless you also load the \sty{xspace} -package. (See \latexhtml{section~\ref*{sec:acronyms}}{the -\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} -section} of the \sty{glossaries} documentation for further -details.) Note that \cs{oldacronym} uses its first argument to -define the acronym's label (as used by commands like \cs{gls}), so -in the above example, with the new \sty{glossaries} package, +after \cs{}\meta{acr-name}, unless you also load the \styfmt{xspace} +package. (See +\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} +%\latexhtml{section~\ref*{sec:acronyms}}{the +%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} +%section} +of the \styfmt{glossaries} documentation for further +details.) Note that \ics{oldacronym} uses its first argument to +define the acronym's label (as used by commands like \ics{gls}), so +in the above example, with the new \styfmt{glossaries} package, \cs{SVM} becomes a shortcut for \verb|\gls{SVM}| and \cs{SVM*} becomes a shortcut for \verb|\Gls{SVM}|. -\subsection{\cs{acrln} and \cs{acrsh}} +\subsection{\texorpdfstring{\cs{acrln} and +\cs{acrsh}}{\textbackslash acrln and \textbackslash acrsh}} -In the \sty{glossary} package, it is possible to produce the +In the \styfmt{glossary} package, it is possible to produce the long and short forms of an acronym without adding an entry to -the glossary using \cs{acrln} and \cs{acrsh}. With the -\sty{glossaries} package (provided you defined the acronym using -\cs{newacronym} or \cs{oldacronym} and provided you haven't redefined \cs{newacronym}) +the glossary using \ics{acrln} and \ics{acrsh}. With the +\styfmt{glossaries} package (provided you defined the acronym using +\ics{newacronym} or \ics{oldacronym} and provided you haven't +redefined \ics{newacronym}) you can replace \begin{oldway} -\cs{acrsh}\marg{acr-name} +\ics{acrsh}\marg{acr-name} \end{oldway}% with \begin{newway} -\cs{acrshort}\marg{label} +\ics{acrshort}\marg{label} \end{newway}% and you can replace \begin{oldway} -\cs{acrln}\marg{acr-name} +\ics{acrln}\marg{acr-name} \end{oldway}% with \begin{newway} -\cs{acrlong}\marg{label} +\ics{acrlong}\marg{label} \end{newway}% -The \sty{glossaries} package also provides the related commands -\cs{acrshortpl} (plural short form) and \cs{acrlongpl} (plural long +The \styfmt{glossaries} package also provides the related commands +\ics{acrshortpl} (plural short form) and \ics{acrlongpl} (plural long form) as well as upper case variations. If you use the -\sty{glossaries} \dq{shortcuts} package option, you can use -\cs{acs} in place of \cs{acrshort} and \cs{acl} in place of -\cs{acrlong}. - -See \latexhtml{section~\ref*{sec:acronyms}}{the -\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} -section} of the \sty{glossaries} manual for further details of +\styfmt{glossaries} \qt{shortcuts} package option, you can use +\ics{acs} in place of \ics{acrshort} and \ics{acl} in place of +\ics{acrlong}. + +See +\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} +%\latexhtml{section~\ref*{sec:acronyms}}{the +%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} +%section} +of the \styfmt{glossaries} manual for further details of how to use these commands. -\subsection{\cs{ifacronymfirstuse}} +\subsection{\texorpdfstring{\cs{ifacronymfirstuse}}{\textbackslash +ifacronymfirstuse}} -The \sty{glossary} package command +The \styfmt{glossary} package command \begin{oldway} -\cs{ifacronymfirstuse}\marg{acr-name}\marg{text1}\marg{text2} +\ics{ifacronymfirstuse}\marg{acr-name}\marg{text1}\marg{text2} \end{oldway}% -can be replaced by the \sty{glossaries} command: +can be replaced by the \styfmt{glossaries} command: \begin{newway} -\cs{ifglsused}\marg{label}\marg{text2}\marg{text1} +\ics{ifglsused}\marg{label}\marg{text2}\marg{text1} \end{newway}% -Note that \cs{ifglsused} evaluates the opposite condition to -that of \cs{ifacronymfirstuse} which is why the last two arguments +Note that \ics{ifglsused} evaluates the opposite condition to +that of \ics{ifacronymfirstuse} which is why the last two arguments have been reversed. -\subsection{\cs{resetacronym} and \cs{unsetacronym}} +\subsection{\texorpdfstring{\cs{resetacronym} and +\cs{unsetacronym}}{\textbackslash resetacronym and \textbackslash +unsetacronym}} -The \sty{glossary} package allows you to reset and unset the +The \styfmt{glossary} package allows you to reset and unset the acronym flag which is used to determine whether the acronym has -been used in the document. The \sty{glossaries} package also +been used in the document. The \styfmt{glossaries} package also provides a means to do this on either a local or a global level. To reset an acronym, you will need to replace: \begin{oldway} -\cs{resetacronym}\marg{acr-name} +\ics{resetacronym}\marg{acr-name} \end{oldway}% with either \begin{newway} -\cs{glsreset}\marg{label} +\ics{glsreset}\marg{label} \end{newway}% or \begin{newway} -\cs{glslocalreset}\marg{label} +\ics{glslocalreset}\marg{label} \end{newway} To unset an acronym, you will need to replace: \begin{oldway} -\cs{unsetacronym}\marg{acr-name} +\ics{unsetacronym}\marg{acr-name} \end{oldway}% with either \begin{newway} -\cs{glsunset}\marg{label} +\ics{glsunset}\marg{label} \end{newway}% or \begin{newway} -\cs{glslocalunset}\marg{label} +\ics{glslocalunset}\marg{label} \end{newway} To reset all acronyms, you will need to replace: \begin{oldway} -\cs{resetallacronyms} +\ics{resetallacronyms} \end{oldway} with \begin{newway} -\cs{glsresetall}[\cs{acronymtype}] +\ics{glsresetall}[\ics{acronymtype}] \end{newway} or \begin{newway} -\cs{glslocalresetall}[\cs{acronymtype}] +\ics{glslocalresetall}[\ics{acronymtype}] \end{newway} To unset all acronyms, you will need to replace: \begin{oldway} -\cs{unsetallacronyms} +\ics{unsetallacronyms} \end{oldway} with \begin{newway} -\cs{glsunsetall}[\cs{acronymtype}] +\ics{glsunsetall}[\ics{acronymtype}] \end{newway} or \begin{newway} -\cs{glslocalunsetall}[\cs{acronymtype}] +\ics{glslocalunsetall}[\ics{acronymtype}] \end{newway} \section{Displaying the glossary} -The \sty{glossary} package provides the command \cs{printglossary} +The \styfmt{glossary} package provides the command \ics{printglossary} (or \cs{print}\meta{type} for other glossary types) which -can be used to print individual glossaries. The \sty{glossaries} -package provides the command \cs{printglossaries} which +can be used to print individual glossaries. The \styfmt{glossaries} +package provides the command \ics{printglossaries} which will print all the glossaries which have been defined, or -\cs{printglossary}\oarg{options} to print individual glossaries. -So if you just have \cs{printglossary}, then you can leave it as +\ics{printglossary}\oarg{options} to print individual glossaries. +So if you just have \ics{printglossary}, then you can leave it as it is, but if you have, say: \begin{verbatim} \printglossary @@ -607,51 +601,55 @@ or \printglossary[type=\acronymtype] \end{verbatim} -The \sty{glossary} package allows you to specify a short title -(for the table of contents and page header) by defining a command -of the form \cs{short}\meta{glossary-type}\texttt{name}. The -\sty{glossaries} package doesn't do this, but instead provides -the \key{toctitle} key which can be used in the optional -argument to \cs{printglossary}. For example, if you have created -a new glossary type called \texttt{notation}, and you had +The \styfmt{glossary} package allows you to specify a short title +(for the table of contents and page header) by defining a command of +the form \cs{short}\meta{glossary-type}\texttt{name}. The +\styfmt{glossaries} package doesn't do this, but instead provides +the \csopt{printglossary}{toctitle} key which can be used in the +optional argument to \ics{printglossary}. For example, if you have +created a new glossary type called \texttt{notation}, and you had defined \begin{verbatim} \newcommand{\shortnotationname}{Notation} \end{verbatim} -then you would need to use the \key{toctitle} key: +then you would need to use the \csopt{printglossary}{toctitle} key: \begin{verbatim} \printglossary[type=notation,toctitle=Notation] \end{verbatim} -The \sty{glossaries} package will ignore \cs{shortnotationname}, -so unless you have used it elsewhere in the document, you may -as well remove the definition. +The \styfmt{glossaries} package will ignore \ics{shortnotationname}, +so unless you have used it elsewhere in the document, you may as +well remove the definition. \section{Processing Your Document} -If you convert your document from using the \sty{glossary} package -to the \sty{glossaries} package, you will need to delete any of -the additional files, such as the \texttt{.glo} file, that were -created by the \sty{glossary} package, as the \sty{glossaries} +If you convert your document from using the \styfmt{glossary} package +to the \styfmt{glossaries} package, you will need to delete any of +the additional files, such as the \filetype{.glo} file, that were +created by the \styfmt{glossary} package, as the \styfmt{glossaries} package uses a different format. -Remember also, that if you used the \texttt{makeglos} Perl script, -you will need to use the \texttt{makeglossaries} Perl script -instead. As from v1.17, the \sty{glossaries} package can be -used with either \texttt{makeindex} or \texttt{xindy}. Since -\texttt{xindy} was designed to be multilingual, the -new \sty{glossaries} package is a much better option for +Remember also, that if you used the \app{makeglos} Perl script, +you will need to use the \app{makeglossaries} Perl script +instead. As from v1.17, the \styfmt{glossaries} package can be +used with either \app{makeindex} or \app{xindy}. Since +\app{xindy} was designed to be multilingual, the +new \styfmt{glossaries} package is a much better option for non-English documents. -For further information on using \texttt{makeglossaries}, -\texttt{makeindex} or \texttt{xindy} to create your glossaries, see -\latexhtml{section~\ref*{sec:makeglossaries}}{the -\htmladdnormallink{Generating the Associated Glossary -Files}{glossaries-manual.html#sec:makeglossaries} section} of the -\sty{glossaries} documentation. +For further information on using \app{makeglossaries}, +\app{makeindex} or \app{xindy} to create your glossaries, see +\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the +Associated Glossary Files} +%\latexhtml{section~\ref*{sec:makeglossaries}}{the +%\htmladdnormallink{Generating the Associated Glossary +%Files}{glossaries-manual.html#sec:makeglossaries} section} +of the \styfmt{glossaries} documentation. \section{Troubleshooting} -Please check the \htmladdnormallinkfoot{FAQ}{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html} -for the \sty{glossaries} package if you have any +Please check the \urlfootref{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}{FAQ} +for the \styfmt{glossaries} package if you have any problems. +\PrintIndex + \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/database1.tex b/Master/texmf-dist/doc/latex/glossaries/samples/database1.tex index ab557f81460..f9ecc9a420f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/database1.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/database1.tex @@ -11,7 +11,7 @@ description={A list of values identified by a numeric value}} description={Pertaining to numbers represented in base 2}} \newglossaryentry{comment}{name=comment, -description={A remark that doesn't affect the meaning of the +description={A remark that doesn't affect the meaning of the code}} \newglossaryentry{global}{name=global, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index f8ba9ff12ae..db5a04d7f77 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -1,5 +1,5 @@ - % This is a minimal file for testing and debugging - % the glossaries package. Change the class file as + % This is a minimal file for testing and debugging + % the glossaries package. Change the class file as % desired, and add the relevant package options to % both the class file and the glossaries package. % Change the sample glossary entry and acronym if @@ -7,7 +7,7 @@ % glossary, add in the relevant \newglossary command % and a sample entry. % - % Only add extra packages or commands if they + % Only add extra packages or commands if they % contribute to whatever problem you are trying to % test. % @@ -32,9 +32,7 @@ \newglossaryentry{sample}{name={sample}, description={a sample entry}} -% This contrived acronym has non-standard plural forms. -% These are specified in the optional argument. -\newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived +\newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived acronyms]{aca}{aca}{a contrived acronym} \begin{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex new file mode 100644 index 00000000000..bd63d817500 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex @@ -0,0 +1,74 @@ +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[acronym, % create list of acronyms + nomain, % don't need main glossary for this example + style=tree, % need a style that displays the symbol + hyperfirst=false,% don't hyperlink first use + sanitize=none % switch off sanitization as description + % will be used in the main text + ]{glossaries} + +\makeglossaries + + % This is a sample file to illustrate how to define a custom + % acronym. This example defines the acronym so that on first use + % it displays the short form in the text and places the long form + % and its description in a footnote. In the main body of the + % document the short form will be displayed in small caps, but in + % the list of acronyms the short form is displayed in normal + % capitals. To ensure this, the short form should be written in + % lower case when the acronym is defined, and \MakeUppercase is + % used when it's displayed in the list of acronyms. + + % In the list of acronyms, the long form is used as the name, the + % short form is used as the symbol and the user supplies the + % description when defining the acronym. + +\renewcommand*{\CustomAcronymFields}{% + name={\the\glslongtok},% + symbol={\MakeUppercase{\the\glsshorttok}},% + text={\textsc{\the\glsshorttok}},% + plural={\textsc{\the\glsshorttok}\noexpand\acrpluralsuffix}% +} + +\renewcommand*{\SetCustomDisplayStyle}[1]{% + % ##1 corresponds to the 'first' key + % ##2 corresponds to the 'description' key + % ##3 corresponds to the 'symbol' key + % ##4 is the inserted text given by the final optional argument to + % commands like \gls + % The short form can be obtained via \glsentryuseri{\glslabel} + % The plural short form can be obtained via + % \glsentryuserii{\glslabel} + % The long form can be obtained via \glsentryuseriii{\glslabel} + % The plural long form can be obtained via + % \glsentryuseriv{\glslabel} + \defglsdisplayfirst[#1]{##1##4\protect\footnote{% + \glsentryuseriii{\glslabel}: ##2}}% + % ##1 corresponds to the 'text' key + % the rest as above + \defglsdisplay[#1]{##1##4}% +} + + % Now set the custom acronym style (to override the default style) +\SetCustomStyle + + % Now define the acronyms (must be done after setting the custom + % style) + +\newacronym[description={set of tags for use in developing hypertext +documents}]{html}{html}{Hyper Text Markup Language} + +\newacronym[description={language used to describe the layout of a +document written in a markup language}]{css}{css}{Cascading Style +Sheet} + +\begin{document} + +\gls{css}. \gls{html}. + +\gls{css}. \gls{html}. + +\printglossaries +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex index 75fa56bf5c3..bfea39f9672 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex @@ -26,7 +26,7 @@ description=A scripting language} \newglossaryentry{pagelist}{name=page list, % description value has to be enclosed in braces % because it contains commas -description={a list of individual pages or page ranges +description={a list of individual pages or page ranges (e.g.\ 1,2,4,7-9)}} \newglossaryentry{mtrx}{name=matrix, @@ -37,10 +37,10 @@ plural=matrices} % entry with a paragraph break in the description \newglossaryentry{par}{name=paragraph, -description={distinct section of piece of +description={distinct section of piece of writing.\glspar Beginning on new, usually indented, line}} - % entry with two types of plural. Set the plural form to the + % entry with two types of plural. Set the plural form to the % form most likely to be used. If you want to use a different % plural, you will need to explicity specify it in \glslink \newglossaryentry{cow}{name=cow, @@ -84,7 +84,7 @@ description={large seal}} \pagenumbering{arabic} A \gls{glossarylist} is a very useful addition to any -technical document, although a \gls{glossarycol} can +technical document, although a \gls{glossarycol} can also simply be a collection of glosses, which is another thing entirely. Some documents have multiple \glspl{glossarylist}. @@ -93,9 +93,9 @@ Once you have run your document through \LaTeX, you will then need to run the \texttt{.glo} file through \texttt{makeindex}. You will need to set the output file so that it creates a \texttt{.gls} file instead -of an \texttt{.ind} file, and change the name of +of an \texttt{.ind} file, and change the name of the log file so that it doesn't overwrite the index -log file (if you have an index for your document). +log file (if you have an index for your document). Rather than having to remember all the command line switches, you can call the \gls{Perl} script \texttt{makeglossaries} which provides a convenient @@ -109,13 +109,13 @@ must be used, e.g.\ in the description of \gls{pagelist}. Plurals are assumed to have the letter s appended, but if this is not the case, as in \glspl{mtrx}, then you need to specify the plural when you define the entry. If a term may have multiple -plurals (for example \glspl{cow}/\glslink{cow}{kine}) then +plurals (for example \glspl{cow}/\glslink{cow}{kine}) then define the entry with the plural form most likely to be used and explicitly specify the alternative form using \verb|\glslink|. \Glspl{seal} and \glspl{sealion} have regular plural forms. \Gls{bravo} is a homograph, but the plural forms are spelt -differently. The plural of \gls{bravo1}, a cry of approval, +differently. The plural of \gls{bravo1}, a cry of approval, is \glspl{bravo1}, whereas the plural of \gls{bravo2}, a hired ruffian or killer, is \glspl{bravo2}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex index 02531ff49a0..3addc9d8a47 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex @@ -34,7 +34,7 @@ the so called ``kernel trick''. Plural: \glspl{ksvm}. \glsresetall Possessive: \gls{ksvm}['s]. -Make the glossary entry number bold for this +Make the glossary entry number bold for this one \gls[format=hyperbf]{svm}. \chapter{Another chapter} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex index 415a58b63e7..3ff8cd0ad83 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex @@ -10,7 +10,7 @@ \makeglossaries -\newacronym[description={Statistical pattern recognition +\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} @@ -18,7 +18,7 @@ name={Support vector machine (svm)}% change the default way of displaying the en \newacronym[description={Statistical pattern recognition technique using the ``kernel trick'' (see also \glshyperlink[SVM]{svm})},% acronym's description name={Kernel support vector machine (ksvm)}% change the default way of displaying the entry name in the list of acronyms -]{ksvm}{ksvm}{kernel +]{ksvm}{ksvm}{kernel support vector machine} \begin{document} @@ -45,7 +45,7 @@ a link: \glsentrydesc{ksvm}. \glsresetall Possessive: \gls{ksvm}['s]. -Make the glossary entry number bold for this +Make the glossary entry number bold for this one \gls[format=hyperbf]{svm}. \begin{thebibliography}{1} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex index 47c639cb9c7..8802d88d1b9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex @@ -1,4 +1,3 @@ -% See also sampleAcrDesc.tex \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} @@ -54,7 +53,7 @@ the so called ``kernel trick''. \glsresetall Possessive: \gls{ksvm}['s]. -Make the glossary entry number bold for this +Make the glossary entry number bold for this one \gls[format=hyperbf]{svm}. \begin{thebibliography}{1} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index e9ebc9cf811..d7f43bc7952 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -91,8 +91,8 @@ description=Catalan's constant,sort=G} This is a sample document illustrating the use of the \textsf{glossaries} package. The functions here have been taken from ``Tables of Integrals, Series, and Products'' by I.S.~Gradshteyn and I.M~Ryzhik. -The glossary is a list of special functions, so -the equation number has been used rather than the page number. This +The glossary is a list of special functions, so +the equation number has been used rather than the page number. This can be done using the \texttt{counter=equation} package option. \end{abstract} @@ -105,7 +105,7 @@ option. \gls{Gamma} = \int_{0}^{\infty}e^{-t}t^{z-1}\,dt \end{equation} -\verb|\ensuremath| is only required here if using +\verb|\ensuremath| is only required here if using hyperlinks. \begin{equation} \glslink{Gamma}{\ensuremath{\Gamma(x+1)}} = x\Gamma(x) @@ -178,7 +178,7 @@ Alternatively: \section{Laguerre polynomials} \begin{equation} -L_n^{\alpha} (x) = \frac{1}{n!}e^x x^{-\alpha} +L_n^{\alpha} (x) = \frac{1}{n!}e^x x^{-\alpha} \frac{d^n}{dx^n}(e^{-x}x^{n+\alpha}) \end{equation} @@ -186,8 +186,8 @@ L_n^{\alpha} (x) = \frac{1}{n!}e^x x^{-\alpha} Bessel functions $Z_\nu$ are solutions of \begin{equation} -\frac{d^2\glslink{Znu}{Z_\nu}}{dz^2} -+ \frac{1}{z}\,\frac{dZ_\nu}{dz} + +\frac{d^2\glslink{Znu}{Z_\nu}}{dz^2} ++ \frac{1}{z}\,\frac{dZ_\nu}{dz} + \left( 1-\frac{\nu^2}{z^2}Z_\nu = 0 \right) \end{equation} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex index 1ec5c196775..c29175f5416 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex @@ -128,15 +128,15 @@ This is a sample document illustrating the use of the \textsf{glossaries} package. The functions here have been taken from ``Tables of Integrals, Series, and Products'' by I.S.~Gradshteyn and I.M~Ryzhik. -The glossary lists both page numbers and equation numbers. +The glossary lists both page numbers and equation numbers. Since the majority of the entries use the equation number, \texttt{counter=equation} was used as a package option. Note that this example will only work where the -page number and equation number compositor is the same. So -it won't work if, say, the page numbers are of the form -2-4 and the equation numbers are of the form 4.6. -As most of the glossary entries should have an italic -format, it is easiest to set the default format to +page number and equation number compositor is the same. So +it won't work if, say, the page numbers are of the form +2-4 and the equation numbers are of the form 4.6. +As most of the glossary entries should have an italic +format, it is easiest to set the default format to italic. \end{abstract} @@ -147,7 +147,7 @@ italic. \chapter{Gamma Functions} -The \glslink[format=hyperbf,counter=page]{Gamma}{gamma function} is +The \glslink[format=hyperbf,counter=page]{Gamma}{gamma function} is defined as \begin{equation} \gls{Gamma} = \int_{0}^{\infty}e^{-t}t^{z-1}\,dt @@ -168,7 +168,7 @@ defined as \newpage \begin{equation} -\glslink{Gamma}{\ensuremath{\Gamma(\alpha)}} = +\glslink{Gamma}{\ensuremath{\Gamma(\alpha)}} = \Gamma(\alpha, x) + \gamma(\alpha, x) \end{equation} @@ -224,7 +224,7 @@ Alternatively: \chapter{Laguerre polynomials} \begin{equation} -\gls{Lna} = \frac{1}{n!}e^x x^{-\alpha} +\gls{Lna} = \frac{1}{n!}e^x x^{-\alpha} \frac{d^n}{dx^n}(e^{-x}x^{n+\alpha}) \end{equation} @@ -232,7 +232,7 @@ Alternatively: Bessel functions $Z_\nu(z)$ are solutions of \begin{equation} -\frac{d^2\glslink{Znu}{Z_\nu}}{dz^2} + \frac{1}{z}\,\frac{dZ_\nu}{dz} + +\frac{d^2\glslink{Znu}{Z_\nu}}{dz^2} + \frac{1}{z}\,\frac{dZ_\nu}{dz} + \left( 1-\frac{\nu^2}{z^2}Z_\nu = 0 \right) @@ -269,7 +269,7 @@ Bessel functions $Z_\nu(z)$ are solutions of \chapter{Elliptical Integral of the First Kind} \begin{equation} -\gls{Fpk} = \int_0^\phi +\gls{Fpk} = \int_0^\phi \frac{d\alpha}{\sqrt{1-k^2\sin^2\alpha}} \end{equation} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex index 63fa4c202bd..9901c7ab61d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex @@ -50,12 +50,11 @@ description={The number of elements in the specified set}} \pagenumbering{Alph} This is a sample document illustrating the use of the \textsf{glossaries} package. In this example, a new glossary type -called \texttt{notation} is defined, so that the document can have a +called \texttt{notation} is defined, so that the document can have a separate glossary of terms and index of notation. The index of notation doesn't have associated numbers. \end{abstract} - \pagenumbering{roman} \tableofcontents @@ -64,13 +63,13 @@ doesn't have associated numbers. \chapter{Introduction} \pagenumbering{arabic} -\glslink{gls:set}{Sets} -are denoted by a caligraphic font +\glslink{gls:set}{Sets} +are denoted by a caligraphic font e.g.\ \gls{not:set}. Let \gls[format=hyperit]{not:U} denote the universal set. -The \gls{gls:card} of a set $\mathcal{S}$ is denoted +The \gls{gls:card} of a set $\mathcal{S}$ is denoted \gls{not:card}. \chapter{Another Chapter} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex index c01c479cc49..bd6219b8519 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex @@ -6,21 +6,18 @@ \makeglossaries -% Main glossary is a list of calculus acronyms \renewcommand{\glossaryname}{Calculus Acronyms} \newacronym[type=main]{vc}{VC}{Vector Calculus} \newacronym[type=main]{ftoc}{FTOC}{Fundamental Theorem of Calculus} -% "acronym" glossary is a list of computer related acronyms \renewcommand{\acronymname}{Computer Acronyms} \newacronym{kb}{kb}{KiloBit} \newacronym{kB}{kB}{KiloByte} -% "acronym2" glossary is a list of statistical acronyms \newacronym[type=acronym2]{svm}{SVM}{Support Vector Machine} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex index a134e1a5162..7f885e678b2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex @@ -6,9 +6,6 @@ \makeglossaries -% Note that because the é is the first letter of the -% name, it needs to be grouped or it will cause a -% problem for \makefirstuc due to expansion issues. \newglossaryentry{elite}{name={{é}lite}, description={select group or class}} @@ -21,8 +18,6 @@ description=large deer} \newglossaryentry{mannerly}{name=mannerly, description=polite} -% The Å“ is not the first letter, so it doesn't need to -% be grouped. \newglossaryentry{manoeuvre}{name={manÅ“uvre}, description=planned and controlled movement} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy index 318205d8ffc..7c8d2b9e484 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy @@ -440,8 +440,6 @@ ; user defined alphabets - - ; location class definitions (define-location-class "roman-page-numbers" @@ -462,7 +460,7 @@ ; user defined location classes (define-location-class "Numberstring" - (:sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}")) + (:sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}")) ; define cross-reference class @@ -478,14 +476,14 @@ "alpha-page-numbers" "Roman-page-numbers" "Alpha-page-numbers" - "Appendix-page-numbers" + "Appendix-page-numbers" "see" )) ; define the glossary markup (markup-index - :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble~n\begin{theglossary}\glossaryheader~n" - :close "~n\end{theglossary}~n\glossarypostamble~n" + :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble~n\begin{theglossary}\glossaryheader~n" + :close "~n\end{theglossary}~n\glossarypostamble~n" :tree) (markup-letter-group-list :sep "\glsgroupskip~n") (markup-indexentry :open "~n" :depth 0) @@ -496,75 +494,74 @@ ; define format to use for locations - -(markup-locref :open "~n\setentrycounter{page}\glsnumberformat{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\glsnumberformat{" + :close "}" :attr "glsnumberformat") -(markup-locref :open "~n\setentrycounter{page}\textrm{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textrm{" + :close "}" :attr "textrm") -(markup-locref :open "~n\setentrycounter{page}\textsf{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textsf{" + :close "}" :attr "textsf") -(markup-locref :open "~n\setentrycounter{page}\texttt{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\texttt{" + :close "}" :attr "texttt") -(markup-locref :open "~n\setentrycounter{page}\textbf{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textbf{" + :close "}" :attr "textbf") -(markup-locref :open "~n\setentrycounter{page}\textmd{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textmd{" + :close "}" :attr "textmd") -(markup-locref :open "~n\setentrycounter{page}\textit{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textit{" + :close "}" :attr "textit") -(markup-locref :open "~n\setentrycounter{page}\textup{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textup{" + :close "}" :attr "textup") -(markup-locref :open "~n\setentrycounter{page}\textsl{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textsl{" + :close "}" :attr "textsl") -(markup-locref :open "~n\setentrycounter{page}\textsc{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\textsc{" + :close "}" :attr "textsc") -(markup-locref :open "~n\setentrycounter{page}\emph{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\emph{" + :close "}" :attr "emph") -(markup-locref :open "~n\setentrycounter{page}\glshypernumber{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\glshypernumber{" + :close "}" :attr "glshypernumber") -(markup-locref :open "~n\setentrycounter{page}\hyperrm{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperrm{" + :close "}" :attr "hyperrm") -(markup-locref :open "~n\setentrycounter{page}\hypersf{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hypersf{" + :close "}" :attr "hypersf") -(markup-locref :open "~n\setentrycounter{page}\hypertt{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hypertt{" + :close "}" :attr "hypertt") -(markup-locref :open "~n\setentrycounter{page}\hyperbf{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperbf{" + :close "}" :attr "hyperbf") -(markup-locref :open "~n\setentrycounter{page}\hypermd{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hypermd{" + :close "}" :attr "hypermd") -(markup-locref :open "~n\setentrycounter{page}\hyperit{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperit{" + :close "}" :attr "hyperit") -(markup-locref :open "~n\setentrycounter{page}\hyperup{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperup{" + :close "}" :attr "hyperup") -(markup-locref :open "~n\setentrycounter{page}\hypersl{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hypersl{" + :close "}" :attr "hypersl") -(markup-locref :open "~n\setentrycounter{page}\hypersc{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hypersc{" + :close "}" :attr "hypersc") -(markup-locref :open "~n\setentrycounter{page}\hyperemph{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperemph{" + :close "}" :attr "hyperemph") -(markup-locref :open "~n\setentrycounter{page}\hyperbfit{" - :close "}" +(markup-locref :open "~n\setentrycounter{page}\hyperbfit{" + :close "}" :attr "hyperbfit") ; define letter group list format @@ -584,11 +581,11 @@ (define-sort-rule-orientations (forward backward forward forward)) (use-rule-set :run 0 - :rule-set ("en-alphabetize" "en-ignore-special")) + :rule-set ("en-alphabetize" "en-ignore-special")) (use-rule-set :run 1 - :rule-set ("en-resolve-diacritics" "en-ignore-special")) + :rule-set ("en-resolve-diacritics" "en-ignore-special")) (use-rule-set :run 2 - :rule-set ("en-resolve-case" "en-ignore-special")) + :rule-set ("en-resolve-case" "en-ignore-special")) (use-rule-set :run 3 - :rule-set ("en-resolve-special")) + :rule-set ("en-resolve-special")) diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex index c66ed0f66d0..548c8021198 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex @@ -15,7 +15,7 @@ % Otherwise do: % % xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo - % + % \documentclass{article} \usepackage[utf8]{inputenc} @@ -52,7 +52,7 @@ % (This command will have no effect if \noist is used) \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space - \string\Numberstringnum\space\glsopenbrace" + \string\Numberstringnum\space\glsopenbrace" "arabic-numbers" :sep "\glsclosebrace"} % To have Mc as a separate group uncomment the following three @@ -64,7 +64,7 @@ % The above three lines specify to use samplexdy-mc.xdy (supplied % with this file) and don't overwrite it. The language is - % unset using \GlsSetXdyLanguage{} as all the language + % unset using \GlsSetXdyLanguage{} as all the language % dependent information is contained in samplexdy-mc.xdy % Note that using \noist means that commands like % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have @@ -78,7 +78,7 @@ % Define glossary entries % \glshyperlink is used instead of \gls to prevent the glossary % page numbers also appear in the locations, however I need - % to ensure that the referenced entries are added to the + % to ensure that the referenced entries are added to the % glossary via commands that use \glslink, \glsadd or \glssee \newglossaryentry{mcadam}{name={McAdam, John Loudon}, @@ -98,7 +98,7 @@ description={Theorem expressing a function $f(x)$ as the sum of a polynomial and a remainder: \[f(x) = f(a)+f'(a)(x-a)+f''(a)(x-a^2)/2!+\cdots+R_n\] If $n\to\infty$ the expansion is a \glshyperlink{taylorseries} -and if $a=0$, the series is called a +and if $a=0$, the series is called a \gls{maclaurinseries}}} \newglossaryentry{taylorseries}{name={Taylor series}, @@ -110,7 +110,7 @@ description={English mathematician}} \newglossaryentry{mcnemar}{name={McNemar, Quinn}, first={Quinn McNemar},text={McNemar}, -description={Mathematician who introduced +description={Mathematician who introduced \gls{mcnemarstest}. This entry has the number list suppressed},nonumberlist} @@ -170,7 +170,7 @@ first={Giuseppe Peano},text={Peano}, description={Italian mathematician}} \newglossaryentry{peanoscurve}{name={Peano's curve}, -description={A space-filling curve discovered by +description={A space-filling curve discovered by \gls{peano}}} \newglossaryentry{pearson}{name={Pearson, Karl}, @@ -194,7 +194,7 @@ several pages. \newpage This page talks about \glspl[format=hyperbfit]{gaussianint}. Since -it's the principle definition, the user-defined hyperbfit format is +it's the principle definition, the user-defined hyperbfit format is used. \newpage @@ -204,7 +204,7 @@ The section on \gls[format=)]{gauss} ends here. \section{Series Expansions} This section is about series expansions. It mentions -\gls{maclaurin} and \gls{taylor}. It also discusses +\gls{maclaurin} and \gls{taylor}. It also discusses \gls{taylorstheorem} which is related to the \gls{taylorseries}. The \gls{maclaurinseries} is a special case of the \gls{taylorseries}. diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries b/Master/texmf-dist/scripts/glossaries/makeglossaries index 58077a46a42..71f3df40d52 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 1.8 (2009/11/03) +# Version : 1.9 (2010/06/14) # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -30,6 +30,8 @@ my $version="1.7 (2009-09-23)"; # History: +# v1.9 (2010-06-14) : +# * Check for \@input # v1.8 (2009-11-03) : # * Create an empty output file if the input file is empty # without calling xindy/makeindex @@ -121,75 +123,7 @@ my $letterordering = defined($opt_l); # check aux file for other glossary types # and for ist file name -if (open AUXFILE, "$name.aux") -{ - while (<AUXFILE>) - { - if (m/\\\@newglossary\s*\{(.*)\}{(.*)}{(.*)}{(.*)}/) - { - $exttype{$1}{'log'} = $2; - $exttype{$1}{'out'} = $3; - $exttype{$1}{'in'} = $4; - - unless ($opt_q) - { - print "added glossary type '$1' ($2,$3,$4)\n"; - } - } - - if (m/\\\@istfilename\s*{([^}]*)}/) - { - $istfile = $1; - - # check if double quotes were added to \jobname - $istfile=~s/^"(.*)"\.ist$/$1.ist/; - } - - # v1.5 added - if (m/\\\@xdylanguage\s*{([^}]+)}{([^}]*)}/) - { - $language{$1} = $2; - } - - # v1.5 added - if (m/\\\@gls\@codepage\s*{([^}]+)}{([^}]*)}/) - { - $codepage{$1} = $2; - } - - # v1.5 added - # Allow -l switch to override specification in aux file - unless (defined($opt_l)) - { - if (m/\\\@glsorder\s*{([^}]+)}/) - { - my $ordering = $1; - - if ($ordering eq "word") - { - $letterordering = 0; - } - elsif ($ordering eq "letter") - { - $letterordering = 1; - } - else - { - print STDERR - "Unknown ordering '$letterordering'\n", - "Assuming word ordering\n"; - $letterordering = 0; - } - } - } - } - - close AUXFILE; -} -else -{ - print STDERR "Unable to open $name.aux: $!\n"; -} +&scan_aux($name); # has the style file been specified? unless ($istfile) @@ -411,6 +345,86 @@ else } } +sub scan_aux{ + my $name = shift; + + if (open AUXFILE, "$name.aux") + { + while (<AUXFILE>) + { + # v1.8 added + if (m/\\\@input{(.+)\.aux}/) + { + &scan_aux($1); + } + + if (m/\\\@newglossary\s*\{(.*)\}{(.*)}{(.*)}{(.*)}/) + { + $exttype{$1}{'log'} = $2; + $exttype{$1}{'out'} = $3; + $exttype{$1}{'in'} = $4; + + unless ($opt_q) + { + print "added glossary type '$1' ($2,$3,$4)\n"; + } + } + + if (m/\\\@istfilename\s*{([^}]*)}/) + { + $istfile = $1; + + # check if double quotes were added to \jobname + $istfile=~s/^"(.*)"\.ist$/$1.ist/; + } + + # v1.5 added + if (m/\\\@xdylanguage\s*{([^}]+)}{([^}]*)}/) + { + $language{$1} = $2; + } + + # v1.5 added + if (m/\\\@gls\@codepage\s*{([^}]+)}{([^}]*)}/) + { + $codepage{$1} = $2; + } + + # v1.5 added + # Allow -l switch to override specification in aux file + unless (defined($opt_l)) + { + if (m/\\\@glsorder\s*{([^}]+)}/) + { + my $ordering = $1; + + if ($ordering eq "word") + { + $letterordering = 0; + } + elsif ($ordering eq "letter") + { + $letterordering = 1; + } + else + { + print STDERR + "Unknown ordering '$letterordering'\n", + "Assuming word ordering\n"; + $letterordering = 0; + } + } + } + } + + close AUXFILE; + } + else + { + print STDERR "Unable to open $name.aux: $!\n"; + } +} + sub makeindex{ my($in,$out,$trans,$ist,$rest,$quiet,$dontexec) = @_; my($name,$cmdstr,$buffer,$n,$i,$j); diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 7ebb84fc52f..4d9e85e4c5a 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -4,6 +4,12 @@ % -macrocode "glossaries\.perl" % -macrocode ".*\.tex" % -macrocode ".*\.xdy" +% -setambles "glossaries\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" +% -setambles ".*\.xdy=>\nopreamble\nopostamble" +% -comment "glossaries\.perl" +% -comment ".*\.tex" +% -comment ".*\.xdy" % -src "glossaries.sty\Z=>glossaries.sty" % -src "mfirstuc.sty\Z=>mfirstuc.sty" % -src "(glossary-.+)\.(sty)\Z=>\1.\2" @@ -16,18 +22,11 @@ % -src "(samplexdy-mc\.xdy)\Z=>\1" % -src "(database.*\.tex)\Z=>\1" % -src "(glossaries\.perl)\Z=>\1" -% -author "Nicola Talbot" -% -dir "source" -% -setambles "glossaries\.perl=>\nopreamble\nopostamble" -% -setambles ".*\.tex=>\nopreamble\nopostamble" -% -setambles ".*\.xdy=>\nopreamble\nopostamble" -% -comment "glossaries\.perl" -% -comment ".*\.tex" -% -comment ".*\.xdy" % -doc "glossaries-manual.tex" +% -author "Nicola Talbot" % -codetitle "Glossaries Documented Code" % glossaries -% Created on 2010/2/6 13:23 +% Created on 2010/6/14 13:44 %\fi %\iffalse %<*package> @@ -54,13 +53,12 @@ % \fi % \iffalse %<*driver> -\documentclass[a4paper]{ltxdoc} -\usepackage{ifthen} +\documentclass{nlctdoc} + \usepackage{alltt} \usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} -\usepackage{cmap} \usepackage[colorlinks, bookmarks, hyperindex=false, @@ -68,119 +66,44 @@ pdftitle={glossaries.sty: LaTeX2e Package to Assist Generating Glossaries}, pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} - %hyperindex conflicts with doc - %(end up with |usage|hyperpage in indexentry) - %This unfortunately means that the changes section doesn't - %have active links, but at least it will keep makeindex happy. - - -\usepackage{xcolor} -\usepackage{dox} \doxitem{Option}{option}{package options} \doxitem{GlsKey}{key}{glossary keys} \doxitem{Style}{style}{glossary styles} -\renewcommand{\usage}[1]{\textit{\hyperpage{#1}}} -\renewcommand{\main}[1]{\hyperpage{#1}} -\newcommand{\see}[2]{\emph{see} #1} -\makeatletter -\def\index@prologue{\section*{Index}} -\makeatother -\RecordChanges -\PageIndex -\CheckSum{10933} -\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}}} -\newlength\boxlength -\newsavebox\importantbox -\newenvironment{important}{% -\setlength{\fboxrule}{4pt}% -\setlength\boxlength{\linewidth}% -\addtolength\boxlength{-2\fboxsep}% -\addtolength\boxlength{-2\fboxrule}% -\begin{lrbox}{\importantbox}% -\begin{minipage}{\boxlength}% -}{\end{minipage}\end{lrbox}% -\par\vskip10pt\noindent -\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} -\newcommand*{\tick}{\ding{51}} - -\definecolor{defbackground}{rgb}{0.8,1,1} - -\newsavebox\defsbox -\newlength\defwidth -\newenvironment{definition}[1][]{% -\def\defarg{#1}% -\setlength{\fboxsep}{4pt}\setlength{\fboxrule}{1.25pt}% -\begin{lrbox}{\defsbox}% -\setlength\defwidth\linewidth -\addtolength\defwidth{-2\fboxrule}% -\addtolength\defwidth{-2\fboxsep}% -\begin{minipage}{\defwidth}\flushleft -}{% -\end{minipage} -\end{lrbox}% -\vskip10pt -\noindent -\defarg\fcolorbox{black}{defbackground}{\usebox\defsbox}% -\vskip10pt -\noindent -\ignorespacesafterend -} +\setcounter{IndexColumns}{2} +\CheckSum{11106} -\makeatletter -\renewenvironment{theindex}{\twocolumn[\index@prologue] -\let\item\@idxitem -\ignorespaces -}{} -\makeatother +\newcommand*{\tick}{\ding{51}} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{first use\ifirstuse} \newcommand*{\firstuseflag}{first use flag\ifirstuseflag} \newcommand*{\firstusetext}{first use text\ifirstusetext} + \newcommand*{\ifirstuseflag}{\iterm{first use>flag}} \newcommand*{\ifirstusetext}{\iterm{first use>text}} -\newcommand*{\istkey}[1]{\texttt{#1}\index{makeindex=\texttt{makeindex}>#1=\texttt{#1}|hyperpage}} + +\newcommand*{\istkey}[1]{\appfmt{#1}\index{makeindex=\appfmt{makeindex}>#1=\texttt{#1}|hyperpage}} \newcommand*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}} -\newcommand*{\ics}[1]{\texttt{\char`\\#1}\SpecialMainIndex{#1}} -\newcommand*{\appname}[1]{\texttt{#1}\index{#1=\texttt{#1}|hyperpage}} -\newcommand*{\mkidxspch}{\index{makeindex=\texttt{makeindex}>special characters|hyperpage}} -\newcommand*{\igloskey}[2][newglossaryentry]{\index{#1 options=\cs{#1} options>#2=\textsf{#2}|hyperpage}} -\newcommand*{\gloskey}[2][newglossaryentry]{\textsf{#2}\igloskey[#1]{#2}} -\newcommand*{\pkgoptni}[1]{\textsf{#1}} -\newcommand*{\ipkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\index{package options:>#2={\protect\ttfamily #2}|main}}{% -\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily #1}|main}}} -\newcommand*{\pkgopt}[2][]{% -\ifthenelse{\equal{#1}{}}{% -\pkgoptni{#2}\index{package options:>#2={\protect\ttfamily #2}|main}}{% -\pkgoptni{#2=#1}\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily #1}|main}}} -\newcommand*{\pkgoptval}[2]{\pkgoptni{#1}\index{package options:>#2={\protect\ttfamily #2}>#1={\protect\ttfamily#1}|main}} +\newcommand*{\mkidxspch}{\index{makeindex=\appfmt{makeindex}>special characters|hyperpage}} + +\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} +\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} + \newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles:>#1={\protect\ttfamily#1}|main}} -\newcommand*{\filetype}[1]{\texttt{#1}\index{file types>#1|hyperpage}} -\newcommand*{\sty}[1]{\textsf{#1}} -\newcommand*{\isty}[1]{\sty{#1}\index{#1 package=\sty{#1} package|hyperpage}} -\newcommand*{\cls}[1]{\textsf{#1}} -\newcommand*{\icls}[1]{\cls{#1}\index{#1 class=\cls{#1} class|hyperpage}} -\newcommand*{\envname}[1]{\textsf{#1}} -\begin{document}\DocInput{glossaries.dtx} +\begin{document} +\DocInput{glossaries.dtx} \end{document} %</driver> %\fi %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{glossaries.sty v 2.05: \LaTeXe\ Package to Assist Generating Glossaries} +% \title{glossaries.sty v2.06: +% \LaTeXe\ Package to Assist Generating Glossaries} % \author{Nicola L.C. Talbot\\[10pt] %School of Computing Sciences\\ %University of East Anglia\\ @@ -188,94 +111,125 @@ %NR4 7TJ. United Kingdom.\\ %\url{http://theoval.cmp.uea.ac.uk/~nlct/}} % -% \date{6th Feb 2010} +% \date{2010-06-14} % \maketitle +% +%This is the user manual for the \styfmt{glossaries} package. Other +%documents accompanying this manual: +%\begin{itemize} +%\item \qtdocref{The glossaries package: a guide for beginners}{glossariesbegin} +%\item \qtdocref{Upgrading from the glossary package to the +%glossaries package}{glossary2glossaries} +%\end{itemize} +%See the file \texttt{INSTALL} for installation instructions. +%Related web resources: +%\begin{itemize} +%\item +%\urlfootref{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}{The glossaries FAQ} +% +%\item +%\urlfootref{http://www.latex-community.org/index.php?option=com_content&view=article&id=263&Itemid=114}{Glossaries, +%Nomenclature, Lists of Symbols and Acronyms } +%\end{itemize} +% +%\clearpage %\tableofcontents % % \section{Introduction} % % \changes{1.0}{2007 May 16}{Initial version} -%The \sty{glossaries} package is provided to assist generating -%glossaries. It has a certain amount of flexibility, allowing the +%The \styfmt{glossaries} package is provided to assist generating +%glossaries. It has a certain amount of flexibility, allowing the %user to customize the format of the glossary and define multiple -%glossaries. It also supports acronyms and glossary styles that +%glossaries. It also supports acronyms and glossary styles that %include symbols (in addition to a name and description) for glossary -%entries. There is provision for loading a database of glossary terms. -%Only those terms used\footnote{that is, if the term has been -%referenced using any of the commands described in \autoref{sec:glslink}, -%\autoref{sec:glsadd} or -%via \ics{glssee} (or the \gloskey{see} key)} in the document will be +%entries. There is provision for loading a database of glossary +%terms. Only those terms used\footnote{that is, if the term has been +%referenced using any of the commands described in +%\sectionref{sec:glslink}, \sectionref{sec:glsadd} or via +%\ics{glssee} (or the \gloskey{see} key)} in the document will be %added to the glossary. % -%\textbf{This package replaces the \isty{glossary} package which is -%now obsolete.} Please see -%the document \dq{Upgrading from the glossary package to the glossaries package} (\href{glossary2glossaries.pdf}{glossary2glossaries.pdf}) -%for assistance in upgrading. +%\textbf{This package replaces the \sty{glossary} package which is +%now obsolete.} Please see the document \qtdocref{Upgrading from the +%glossary package to the glossaries package}{glossary2glossaries} for +%assistance in upgrading. % %One of the strengths of this package is its flexibility, however %the drawback of this is the necessity of having a large manual %that can cover all the various settings. If you are daunted by the %size of the manual, try starting off with the much shorter -%guide for beginners (\href{glossariesbegin.pdf}{glossariesbegin.pdf}). +%\docref{guide for beginners}{glossariesbegin}. % %\begin{important} -%The \sty{glossaries} package comes with a -%\htmladdnormallink{Perl}{http://www.perl.org/about.html} script -%called \appname{makeglossaries}. This provides a convenient interface -%to \appname{makeindex} or \appname{xindy}. It is strongly -%recommended that you use this script, but \emph{it is not -%essential}. If you are reluctant to install Perl, or for any -%other reason you don't want to use \appname{makeglossaries}, you -%can called \appname{makeindex} or \appname{xindy} explicitly. -%See \autoref{sec:makeglossaries} for +%The \styfmt{glossaries} package comes with a +%\href{http://www.perl.org/about.html}{Perl} script called +%\app{makeglossaries}. This provides a convenient interface to +%\app{makeindex} or \app{xindy}. It is strongly recommended +%that you use this script, but \emph{it is not essential}. If you are +%reluctant to install Perl, or for any other reason you don't want to +%use \app{makeglossaries}, you can called \app{makeindex} or +%\app{xindy} explicitly. See \sectionref{sec:makeglossaries} for %further details. %\end{important} % %This manual is structured as follows: %\begin{itemize} -%\item \autoref{sec:overview} gives an overview of the main user commands and their syntax. -% -%\item \autoref{sec:mfirstuc} describes the associated \sty{mfirstuc} package. -% -%\item\autoref{sec:code} contains the documented source code for those who -%want to know more about how the package works. This describes more -%advanced commands, such as determining if an entry or a glossary -%exists and commands that iterate through defined terms or glossaries. -% -%\item \autoref{sec:code:mfirstuc} contains the documented code for -%the \sty{mfirstuc} package. +%\item \sectionref{sec:overview} gives an overview of the main user +%commands and their syntax. +% +%\item \sectionref{sec:mfirstuc} describes the associated +%\styfmt{mfirstuc} package. +% +%\ifpdf +% \item \sectionref{sec:code} contains the documented source code for +% those who want to know more about how the package works. This +% describes more advanced commands, such as determining if an entry or +% a glossary exists and commands that iterate through defined terms or +% glossaries. +% +% \item \sectionref{sec:code:mfirstuc} contains the documented code for +% the \styfmt{mfirstuc} package. +%\fi %\end{itemize} -% +%\ifpdf +%\else +% The \href{glossaries.pdf}{PDF version} of this manual also describes +% more advanced commands in the documented code section (such as +% determining if an entry or a glossary exists and commands that +% iterate through defined terms or glossaries). +%\fi % %\noindent The remainder of this introductory section covers the %following: %\begin{itemize} -%\item \autoref{sec:samples} lists the sample documents provided +%\item \sectionref{sec:samples} lists the sample documents provided %with this package. % -%\item \autoref{sec:languages} provides information for users who +%\item \sectionref{sec:languages} provides information for users who %wish to write in a language other than English. % -%\item \autoref{sec:makeglossaries} -%describes how to use a post-processor to create the sorted glossaries -%for your document. +%\item \sectionref{sec:makeglossaries} describes how to use a +%post-processor to create the sorted glossaries for your document. % -%\item \autoref{sec:trouble} provides some assistance in the event that you encounter a problem. +%\item \sectionref{sec:trouble} provides some assistance in the event +%that you encounter a problem. %\end{itemize} % +% %\subsection{Sample Documents} %\label{sec:samples} % -%The \sty{glossaries} package is provided with some sample +%The \styfmt{glossaries} package is provided with some sample %documents that illustrate the various functions. These should %be located in the \texttt{samples} subdirectory (folder) of the -%\sty{glossaries} documentation directory. This location varies +%\styfmt{glossaries} documentation directory. This location varies %according to your operating system and \TeX\ distribution. You %can use \texttt{texdoc} to locate the main glossaries documentation. %For example, in a terminal or command prompt, type: -%\begin{verbatim} +%\begin{prompt} %texdoc -l glossaries -%\end{verbatim} +%\end{prompt} %This should display the full pathname of the file %\texttt{glossaries.pdf}. View the contents of that directory and %see if it contains the \texttt{samples} subdirectory. @@ -285,17 +239,19 @@ %\texttt{glossaries.tds.zip} archive which can be downloaded from %\href{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}{CTAN}. % +% %The sample documents are as follows: %\begin{description} -%\item[minimalgls.tex]\label{ex:minimalgls} This document is a minimal working example. -%You can test your installation using this file. To create the -%complete document you will need to do the following steps: +%\item[minimalgls.tex]\label{ex:minimalgls} This document is a +%minimal working example. You can test your installation using this +%file. To create the complete document you will need to do the +%following steps: % \begin{enumerate} % \item Run \texttt{minimalgls.tex} through \LaTeX\ either by % typing -%\begin{verbatim} +%\begin{prompt} %latex minimalgls -%\end{verbatim} +%\end{prompt} % in a terminal or by using the relevant button or menu item in % your text editor or front-end. This will create the required % associated files but you will not see the glossary. If you use @@ -303,30 +259,29 @@ % references. These warnings may be ignored on the first run. % % If you get a \verb"Missing \begin{document}" error, then -% it's most likely that your version of \isty{xkeyval} is +% it's most likely that your version of \sty{xkeyval} is % out of date. Check the log file for a warning of that nature. -% If this is the case, you will need to update the \sty{xkeyval} +% If this is the case, you will need to update the \styfmt{xkeyval} % package. % -% \item Run \appname{makeglossaries} on the document. This can +% \item Run \app{makeglossaries} on the document. This can % be done on a terminal either by typing -%\begin{verbatim} +%\begin{prompt} %makeglossaries minimalgls -%\end{verbatim} +%\end{prompt} % or by typing -%\begin{verbatim} +%\begin{prompt} %perl makeglossaries minimalgls -%\end{verbatim} +%\end{prompt} % If your system doesn't recognise the command \texttt{perl} then % it's likely you don't have Perl installed. In which case you -% will need to use \appname{makeindex} directly. You can do this +% will need to use \app{makeindex} directly. You can do this % in a terminal by typing (all on one line): -%\begin{verbatim} -%makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls -%minimalgls.glo -%\end{verbatim} -% (See -%\autoref{sec:makeindexapp} for further details on using \appname{makeindex} explicitly.) +%\begin{prompt} +%makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo +%\end{prompt} +% (See \sectionref{sec:makeindexapp} for further details on using +% \app{makeindex} explicitly.) % % Note that if you need to specify the full path and the path % contains spaces, you will need to delimit the file names with @@ -338,264 +293,273 @@ %each entry in the glossary is the location number. By default, this %is the page number where the entry was referenced. % -%\item[sample4col.tex]\label{ex:sample4col} This document illustrates a four column -%glossary where the entries have a symbol in addition to the -%name and description. To create the complete document, you need -%to do: -%\begin{verbatim} +%\item[sample4col.tex]\label{ex:sample4col} This document illustrates +%a four column glossary where the entries have a symbol in addition +%to the name and description. To create the complete document, you +%need to do: +%\begin{prompt} %latex sample4col %makeglossaries sample4col %latex sample4col -%\end{verbatim} -%As before, if you don't have Perl installed, you will need to -%use \appname{makeindex} directly instead of using -%\appname{makeglossaries}. The vertical gap between entries -%is the gap created at the start of each group. This can be -%suppressed by redefining \ics{glsgroupskip} after the glossary -%style has been set: +%\end{prompt} +%As before, if you don't have Perl installed, you will need to use +%\app{makeindex} directly instead of using +%\app{makeglossaries}. The vertical gap between entries is the +%gap created at the start of each group. This can be suppressed by +%redefining \ics{glsgroupskip} after the glossary style has been set: %\begin{verbatim} %\renewcommand*{\glsgroupskip}{} %\end{verbatim} % -%\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some sample acronyms. It -%also adds the glossary to the table of contents, so an extra -%run through \LaTeX\ is required to ensure the document is up to date: -%\begin{verbatim} +%\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some +%sample acronyms. It also adds the glossary to the table of contents, +%so an extra run through \LaTeX\ is required to ensure the document +%is up to date: +%\begin{prompt} %latex sampleAcr %makeglossaries sampleAcr %latex sampleAcr %latex sampleAcr -%\end{verbatim} +%\end{prompt} % -%\item[sampleAcrDesc.tex]\label{ex:sampleAcrDesc} This is similar to the previous example, -%except that the acronyms have an associated description. As with -%the previous example, the glossary is added to the table of -%contents, so an extra run through \LaTeX\ is required: -%\begin{verbatim} +%\item[sampleAcrDesc.tex]\label{ex:sampleAcrDesc} This is similar to +%the previous example, except that the acronyms have an associated +%description. As with the previous example, the glossary is added to +%the table of contents, so an extra run through \LaTeX\ is required: +%\begin{prompt} %latex sampleAcrDesc %makeglossaries sampleAcrDesc %latex sampleAcrDesc %latex sampleAcrDesc -%\end{verbatim} -% -%\item[sampleDesc.tex]\label{ex:sampleDesc} This is similar to the previous example, -%except that it defines the acronyms using \ics{newglossaryentry} -%instead of \ics{newacronym}. As with -%the previous example, the glossary is added to the table of -%contents, so an extra run through \LaTeX\ is required: -%\begin{verbatim} +%\end{prompt} +% +%\item[sampleDesc.tex]\label{ex:sampleDesc} This is similar to the +%previous example, except that it defines the acronyms using +%\ics{newglossaryentry} instead of \ics{newacronym}. As with the +%previous example, the glossary is added to the table of contents, so +%an extra run through \LaTeX\ is required: +%\begin{prompt} %latex sampleDesc %makeglossaries sampleDesc %latex sampleDesc %latex sampleDesc -%\end{verbatim} -% -%\item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how to load -%external files containing the glossary definitions. It also -%illustrates how to define a new glossary type. This document -%has the \term{number list} suppressed and uses \ics{glsaddall} to add -%all the entries to the glossaries without referencing each one +%\end{prompt} +% +%\item[sample-custom-acronym.tex]\label{ex:sample-custom-acronym} +%This document illustrates how to define your own acronym style if +%the predefined styles don't suit your requirements. +%\begin{prompt} +%latex sample-custom-acronym +%makeglossaries sample-custom-acronym +%latex sample-custom-acronym +%\end{prompt} +% +%\item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how +%to load external files containing the glossary definitions. It also +%illustrates how to define a new glossary type. This document has the +%\term{number list} suppressed and uses \ics{glsaddall} to add all +%the entries to the glossaries without referencing each one %explicitly. To create the document do: -%\begin{verbatim} +%\begin{prompt} %latex sampleDB %makeglossaries sampleDB %latex sampleDB -%\end{verbatim} -%The glossary definitions are stored in the accompanying files -%\texttt{database1.tex} and \texttt{database2.tex}. Note that if -%you don't have Perl installed, you will need to use -%\appname{makeindex} twice instead of a single call to -%\appname{makeglossaries}: +%\end{prompt} +%The glossary definitions are stored in the accompanying files +%\texttt{database1.tex} and \texttt{database2.tex}. Note that if you +%don't have Perl installed, you will need to use \app{makeindex} +%twice instead of a single call to \app{makeglossaries}: %\begin{enumerate} %\item Create the main glossary: -%\begin{verbatim} +%\begin{prompt} %makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -%\end{verbatim} +%\end{prompt} %\item Create the secondary glossary: -%\begin{verbatim} +%\begin{prompt} %makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn -%\end{verbatim} +%\end{prompt} %\end{enumerate} % -%\item[sampleEq.tex]\label{ex:sampleEq} This document illustrates how to change the -%location to something other than the page number. In this case, -%the \texttt{equation} counter is used since all glossary entries -%appear inside an \envname{equation} environment. To create the -%document do: -%\begin{verbatim} +%\item[sampleEq.tex]\label{ex:sampleEq} This document illustrates how +%to change the location to something other than the page number. In +%this case, the \texttt{equation} counter is used since all glossary +%entries appear inside an \env{equation} environment. To create +%the document do: +%\begin{prompt} %latex sampleEq %makeglossaries sampleEq %latex sampleEq -%\end{verbatim} +%\end{prompt} % -%\item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the previous example, -%but the number lists\iterm{number list} are a mixture of page -%numbers and equation numbers. This example adds the glossary to the -%table of contents, so an extra \LaTeX\ run is required: -%\begin{verbatim} +%\item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the +%previous example, but the number lists\iterm{number list} are a +%mixture of page numbers and equation numbers. This example adds the +%glossary to the table of contents, so an extra \LaTeX\ run is +%required: +%\begin{prompt} %latex sampleEqPg %makeglossaries sampleEqPg %latex sampleEqPg %latex sampleEqPg -%\end{verbatim} -% -%\item[sampleSec.tex]\label{ex:sampleSec} This document also illustrates how to change -%the location to something other than the page number. In this case, -%the \texttt{section} counter is used. This example adds the -%glossary to the table of contents, so an extra \LaTeX\ run is -%required: -%\begin{verbatim} +%\end{prompt} +% +%\item[sampleSec.tex]\label{ex:sampleSec} This document also +%illustrates how to change the location to something other than the +%page number. In this case, the \texttt{section} counter is used. +%This example adds the glossary to the table of contents, so an extra +%\LaTeX\ run is required: +%\begin{prompt} %latex sampleSec %makeglossaries sampleSec %latex sampleSec %latex sampleSec -%\end{verbatim} +%\end{prompt} % -%\item[sampleNtn.tex]\label{ex:sampleNtn} This document illustrates how to create -%an additional glossary type. This example adds the glossary to the -%table of contents, so an extra \LaTeX\ run is required: -%\begin{verbatim} +%\item[sampleNtn.tex]\label{ex:sampleNtn} This document illustrates +%how to create an additional glossary type. This example adds the +%glossary to the table of contents, so an extra \LaTeX\ run is +%required: +%\begin{prompt} %latex sampleNtn %makeglossaries sampleNtn %latex sampleNtn %latex sampleNtn -%\end{verbatim} +%\end{prompt} %Note that if you don't have Perl installed, you will need to use -%\appname{makeindex} twice instead of a single call to -%\appname{makeglossaries}: +%\app{makeindex} twice instead of a single call to +%\app{makeglossaries}: %\begin{enumerate} %\item Create the main glossary: -%\begin{verbatim} +%\begin{prompt} %makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -%\end{verbatim} +%\end{prompt} %\item Create the secondary glossary: -%\begin{verbatim} +%\begin{prompt} %makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn -%\end{verbatim} +%\end{prompt} %\end{enumerate} % -%\item[sample.tex]\label{ex:sample} This document illustrates some of the basics, -%including how to create child entries that use the same name as the -%parent entry. This example adds the glossary to the table of -%contents, so an extra \LaTeX\ run is required: -%\begin{verbatim} +%\item[sample.tex]\label{ex:sample} This document illustrates some of +%the basics, including how to create child entries that use the same +%name as the parent entry. This example adds the glossary to the +%table of contents, so an extra \LaTeX\ run is required: +%\begin{prompt} %latex sample %makeglossaries sample %latex sample %latex sample -%\end{verbatim} -%You can see the difference between word and letter ordering -%if you substitute \pkgopt[word]{order} with -%\pkgopt[letter]{order}. (Note that this will only have an -%effect if you use \appname{makeglossaries}. If you use -%\appname{makeindex} explicitly, you will need to use the -%\texttt{-l} switch to indicate letter ordering.) -% -%\item[sampletree.tex]\label{ex:sampletree} This document illustrates a hierarchical -%glossary structure where child entries have different names -%to their corresponding parent entry. To create the document do: -%\begin{verbatim} +%\end{prompt} +%You can see the difference between word and letter ordering if you +%substitute \pkgopt[word]{order} with \pkgopt[letter]{order}. (Note +%that this will only have an effect if you use +%\app{makeglossaries}. If you use \app{makeindex} explicitly, +%you will need to use the \texttt{-l} switch to indicate letter +%ordering.) +% +%\item[sampletree.tex]\label{ex:sampletree} This document illustrates +%a hierarchical glossary structure where child entries have different +%names to their corresponding parent entry. To create the document +%do: +%\begin{prompt} %latex sampletree %makeglossaries sampletree %latex sampletree -%\end{verbatim} -% -%\item[samplexdy.tex]\label{ex:samplexdy} This document illustrates how to use the -%\sty{glossaries} package with \appname{xindy} instead of -%\appname{makeindex}. The document uses UTF8 encoding (with the -%\isty{inputenc} package). The encoding is picked up by -%\appname{makeglossaries}. By default, this document will create -%a \appname{xindy} style file called \texttt{samplexdy.xdy}, but -%if you uncomment the lines +%\end{prompt} +% +%\item[samplexdy.tex]\label{ex:samplexdy} This document illustrates +%how to use the \styfmt{glossaries} package with \app{xindy} instead +%of \app{makeindex}. The document uses UTF8 encoding (with the +%\sty{inputenc} package). The encoding is picked up by +%\app{makeglossaries}. By default, this document will create a +%\app{xindy} style file called \texttt{samplexdy.xdy}, but if you +%uncomment the lines %\begin{verbatim} %\setStyleFile{samplexdy-mc} %\noist %\GlsSetXdyLanguage{} %\end{verbatim} %it will set the style file to \texttt{samplexdy-mc.xdy} instead. -%This provides an additional letter group for entries starting -%with \dq{Mc} or \dq{Mac}. If you use \appname{makeglossaries}, -%you don't need to supply any additional information. If you -%don't use \appname{makeglossaries}, you will need to specify the -%required information. Note that if you set the style file to -%\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, -%otherwise the \sty{glossaries} package will overwrite -%\texttt{samplexdy-mc.xdy} and you will lose the \dq{Mc} letter group. +%This provides an additional letter group for entries starting with +%\qt{Mc} or \qt{Mac}. If you use \app{makeglossaries}, you don't +%need to supply any additional information. If you don't use +%\app{makeglossaries}, you will need to specify the required +%information. Note that if you set the style file to +%\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, +%otherwise the \styfmt{glossaries} package will overwrite +%\texttt{samplexdy-mc.xdy} and you will lose the \qt{Mc} letter +%group. % %To create the document do: -%\begin{verbatim} +%\begin{prompt} %latex samplexdy %makeglossaries samplexdy %latex samplexdy -%\end{verbatim} +%\end{prompt} %If you don't have Perl installed, you will have to call -%\appname{xindy} explicitly instead of using \appname{makeglossaries}. +%\app{xindy} explicitly instead of using \app{makeglossaries}. %If you are using the default style file \texttt{samplexdy.xdy}, then %do (no line breaks): -%\begin{verbatim} -%xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -%-o samplexdy.gls samplexdy.glo -%\end{verbatim} +%\begin{prompt} +%xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo +%\end{prompt} %otherwise, if you are using \texttt{samplexdy-mc.xdy}, then do %(no line breaks): -%\begin{verbatim} -%xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls -%samplexdy.glo -%\end{verbatim} -% -%\item[sampleutf8.tex]\label{ex:sampleutf8} This is another example that uses -%\appname{xindy}. Unlike \appname{makeindex}, \appname{xindy} can -%cope with accented or non-Latin characters. This document uses -%UTF8 encoding. To create the document do: -%\begin{verbatim} +%\begin{prompt} +%xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo +%\end{prompt} +% +%\item[sampleutf8.tex]\label{ex:sampleutf8} This is another example +%that uses \app{xindy}. Unlike \app{makeindex}, +%\app{xindy} can cope with accented or non-Latin characters. This +%document uses UTF8 encoding. To create the document do: +%\begin{prompt} %latex sampleutf8 %makeglossaries sampleutf8 %latex sampleutf8 -%\end{verbatim} -%If you don't have Perl installed, you will have to call -%\appname{xindy} explicitly instead of using \appname{makeglossaries} +%\end{prompt} +%If you don't have Perl installed, you will have to call +%\app{xindy} explicitly instead of using \app{makeglossaries} %(no line breaks): -%\begin{verbatim} -%xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -%-o sampleutf8.gls sampleutf8.glo -%\end{verbatim} +%\begin{prompt} +%xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +%\end{prompt} % %If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} %and do: -%\begin{verbatim} +%\begin{prompt} %latex sampleutf8 %makeglossaries sampleutf8 %latex sampleutf8 -%\end{verbatim} +%\end{prompt} %you will see that the entries that start with a non-Latin character -%now appear in the symbols group, and the word \dq{man\oe uvre} is now -%after \dq{manor} instead of before it. If you are unable to use -%\appname{makeglossaries}, the call to \appname{makeindex} is as +%now appear in the symbols group, and the word \qt{man\oe uvre} is now +%after \qt{manor} instead of before it. If you are unable to use +%\app{makeglossaries}, the call to \app{makeindex} is as %follows (no line breaks): -%\begin{verbatim} -%makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls -%sampleutf8.glo -%\end{verbatim} +%\begin{prompt} +%makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +%\end{prompt} % %\item[sampleaccsupp.tex]\label{ex:sampleaccsupp} This document -%uses the experimental \isty{glossaries-accsupp} package. The +%uses the experimental \sty{glossaries-accsupp} package. The %symbol is set to the replacement text. Note that some PDF %viewers don't use the accessibility support. Information -%about the \sty{glossaries-accsupp} package can be found in -%\autoref{sec:accsupp}. +%about the \styfmt{glossaries-accsupp} package can be found in +%\sectionref{sec:accsupp}. % %\end{description} % +% %\subsection{Multi-Lingual Support} %\label{sec:languages} % -%As from version 1.17, the \sty{glossaries} package can now be -%used with \appname{xindy} as well as \appname{makeindex}. If you +%As from version 1.17, the \styfmt{glossaries} package can now be +%used with \app{xindy} as well as \app{makeindex}. If you %are writing in a language that uses accented characters or -%non-Latin characters it is recommended that you use \appname{xindy} -%as \appname{makeindex} is hard-coded for Latin languages. This +%non-Latin characters it is recommended that you use \app{xindy} +%as \app{makeindex} is hard-coded for Latin languages. This %means that you are not restricted to the A, \ldots, Z letter groups. -%If you want to use \appname{xindy}, remember to use the +%If you want to use \app{xindy}, remember to use the %\pkgopt{xindy} package option. For example: %\begin{verbatim} %\documentclass[frenchb]{article} @@ -616,26 +580,26 @@ %\end{verbatim} %\end{important} % -%If you use the \isty{inputenc} package, \appname{makeglossaries} +%If you use the \sty{inputenc} package, \app{makeglossaries} %will pick up the encoding from the auxiliary file. If you use -%\appname{xindy} explicitly instead of via \appname{makeglossaries}, +%\app{xindy} explicitly instead of via \app{makeglossaries}, %you may need to specify the encoding using the \texttt{-C} -%option. Read the \appname{xindy} manual for further details. +%option. Read the \app{xindy} manual for further details. % %\subsubsection{Changing the Fixed Names} %\label{sec:fixednames} % -%As from version 1.08, the \sty{glossaries} package now has +%As from version 1.08, the \styfmt{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} or \isty{polyglossia} \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. However, +%However you must load \sty{babel} or \sty{polyglossia} \emph{before} +%\styfmt{glossaries} to enable this. Note that if \sty{babel} is loaded +%and the \sty{translator} package is detected on \TeX's path, then the +%\sty{translator} package will be loaded automatically. However, %it may not pick up on the required languages so, if the predefined %text is not translated, you may need to explicitly load the -%\isty{translator} package with the required languages. For example: +%\sty{translator} package with the required languages. For example: %\begin{verbatim} %\usepackage[spanish]{babel} %\usepackage[spanish]{translator} @@ -650,8 +614,8 @@ %\usepackage{glossaries} %\end{verbatim} % -%If you want to use \isty{ngerman} or \isty{german} instead -%of \isty{babel}, you will need to include the \isty{translator} package +%If you want to use \sty{ngerman} or \sty{german} instead +%of \sty{babel}, you will need to include the \sty{translator} package %to provide the translations. For example: %\begin{verbatim} %\documentclass[ngerman]{article} @@ -660,8 +624,13 @@ %\usepackage{glossaries} %\end{verbatim} % -%The following languages are currently supported by the -%\sty{glossaries} package: +%The languages are currently supported by the +%\styfmt{glossaries} package are listed in +%\tableref{tab:supportedlanguages}. +% +%\begin{table}[htbp] +%\caption{Supported Languages} +%\label{tab:supportedlanguages} %\begin{center} %\begin{tabular}{lc} %\bfseries Language & \bfseries As from version\\ @@ -675,10 +644,13 @@ %Italian & 1.08\\ %Hungarian & 1.08\\ %Polish & 1.13\\ +%Serbian & 2.06\\ %Spanish & 1.08 %\end{tabular} %\end{center} -%The language dependent commands and \isty{translator} keys used by the +%\end{table} +% +%The language dependent commands and \sty{translator} keys used by the %glossaries package are listed in \tableref{tab:predefinednames}. % %\begin{table}[htbp] @@ -713,23 +685,23 @@ %\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 -% advice given in \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}. -%If you have the \isty{translator} package installed, then you can -%provide your own dictionary with the necessary modifications -%(using \cs{deftranslation}) and load it using -%\cs{usedictionary}. Note that the dictionaries are loaded at the -%beginning of the document, so it won't have any effect if you +%predefined translations may not be appropriate. If you are using the +%\sty{babel} package and do not have the \sty{translator} package +%installed, you need to be familiar with the advice given in +%\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing +%the words babel uses}. If you have the \sty{translator} package +%installed, then you can provide your own dictionary with the +%necessary modifications (using \cs{deftranslation}) and load it +%using \cs{usedictionary}. Note that the dictionaries are loaded at +%the beginning of the document, so it won't have any effect if you %put \cs{deftranslation} in the preamble. It should be put in your -%personal dictionary instead. See the \isty{translator} -%documentation for further details. +%personal dictionary instead. See the \sty{translator} documentation +%for further details. % -%If you are using \isty{babel} and don't want to use the -%\isty{translator} interface, you can suppress it using the package +%If you are using \sty{babel} and don't want to use the +%\sty{translator} interface, you can suppress it using the package %option \pkgopt[false]{translate}, and either load -%\isty{glossaries-babel} after \sty{glossaries} or specify you're own +%\sty{glossaries-babel} after \styfmt{glossaries} or specify you're own %translations. For example: %\begin{verbatim} %\documentclass[british]{article} @@ -757,58 +729,57 @@ %} %\end{verbatim} % -%If you are using \isty{polyglossia} instead of \isty{babel}, -%\isty{glossaries-polyglossia} will automatically be loaded unless +%If you are using \sty{polyglossia} instead of \sty{babel}, +%\sty{glossaries-polyglossia} will automatically be loaded unless %you specify the package option \pkgopt[false]{translate}. % -%Note that \appname{xindy} provides much better multi-lingual -%support than \appname{makeindex}, so it's recommended that you -%use \appname{xindy} if you have glossary entries that contain -%accented characters or non-Roman letters. See -%\autoref{sec:xindy} for further details. +%Note that \app{xindy} provides much better multi-lingual support +%than \app{makeindex}, so it's recommended that you use \app{xindy} +%if you have glossary entries that contain diacritics or +%non-Roman letters. See \sectionref{sec:xindy} for further +%details. +% %\subsection{Generating the Associated Glossary Files} %\label{sec:makeglossaries} % %In order to generate a sorted glossary with compact location lists, %it is necessary to use an external indexing application as an %intermediate step. It is this application that creates the file -%containing the code that typesets the glossary. If this step -%is omitted, the glossaries will not appear in your document. The -%two indexing applications that are most commonly used with -%\LaTeX\ are \appname{makeindex} and \appname{xindy}. As -%from version 1.17, the \sty{glossaries} package can be used -%with either of these applications. Previous versions were designed -%to be used with \appname{makeindex} only. Note that -%\appname{xindy} has much better multi-lingual support than -%\appname{makeindex}, so \appname{xindy} is recommended if you're -%not writing in English. Commands that only have an -%effect when \appname{xindy} is used are described -%in \autoref{sec:xindy}. -% -%The \sty{glossaries} package comes with the Perl script -%\appname{makeglossaries} which will run \appname{makeindex} or -%\appname{xindy} on all the glossary files using a customized style -%file (which is created by \ics{makeglossaries}). See -%\autoref{sec:makeglossariesapp} for further +%containing the code that typesets the glossary. If this step is +%omitted, the glossaries will not appear in your document. The two +%indexing applications that are most commonly used with \LaTeX\ are +%\app{makeindex} and \app{xindy}. As from version 1.17, the +%\styfmt{glossaries} package can be used with either of these +%applications. Previous versions were designed to be used with +%\app{makeindex} only. Note that \app{xindy} has much better +%multi-lingual support than \app{makeindex}, so \app{xindy} is +%recommended if you're not writing in English. Commands that only +%have an effect when \app{xindy} is used are described in +%\sectionref{sec:xindy}. +% +% +%The \styfmt{glossaries} package comes with the Perl script +%\app{makeglossaries} which will run \app{makeindex} or \app{xindy} +%on all the glossary files using a customized style file (which is +%created by \ics{makeglossaries}). See +%\sectionref{sec:makeglossariesapp} for further %details. Perl is stable, cross-platform, open source software that %is used by a number of \TeX-related applications. Further -%information is available at \url{http://www.perl.org/about.html}. +%information is available at \url{http://www.perl.org/about.html}. %However, whilst it is strongly recommended that you use the -%\appname{makeglossaries} script, it is possible to use the -%\sty{glossaries} package without having Perl installed. In which +%\app{makeglossaries} script, it is possible to use the +%\styfmt{glossaries} package without having Perl installed. In which %case, if you have used the \pkgopt{xindy} package option, you will -%need to use \appname{xindy} (see -%\autoref{sec:xindyapp}), otherwise you will need to use -%\appname{makeindex} (see -%\autoref{sec:makeindexapp}). Note that some commands and -%package options have no effect if you don't use -%\appname{makeglossaries}. These are listed in -%\tableref{tab:makeglossariesCmds}. +%need to use \app{xindy} (see \sectionref{sec:xindyapp}), otherwise +%you will need to use \app{makeindex} (see +%\sectionref{sec:makeindexapp}). Note that some commands and package +%options have no effect if you don't use \app{makeglossaries}. These +%are listed in \tableref{tab:makeglossariesCmds}. % %Note that if any of your entries use an entry %that is not referenced outside the glossary, you will need to -%do an additional \appname{makeglossaries}, \appname{makeindex} -%or \appname{xindy} run, as appropriate. For example, +%do an additional \app{makeglossaries}, \app{makeindex} +%or \app{xindy} run, as appropriate. For example, %suppose you have defined the following entries: %\begin{verbatim} %\newglossaryentry{citrusfruit}{name={citrus fruit}, @@ -822,18 +793,18 @@ %but don't reference the \texttt{orange} entry, then the %\texttt{orange} entry won't appear in your glossary until %you first create the glossary and then do another run -%of \appname{makeglossaries}, \appname{makeindex} or \appname{xindy}. +%of \app{makeglossaries}, \app{makeindex} or \app{xindy}. %For example, if the document is called \texttt{myDoc.tex}, then %you must do: -%\begin{verbatim} +%\begin{prompt} %latex myDoc %makeglossaries myDoc %latex myDoc %makeglossaries myDoc %latex myDoc -%\end{verbatim} +%\end{prompt} % -%Likewise, an additional \appname{makeglossaries} and \LaTeX\ run +%Likewise, an additional \app{makeglossaries} and \LaTeX\ run %may be required if the document pages shift with re-runs. For %example, if the page numbering is not reset after the table of %contents, the insertion of the table of contents on the second @@ -842,30 +813,38 @@ %need updating. % %The examples in this document assume that you are accessing -%\appname{makeglossaries}, \appname{xindy} or \appname{makeindex} via -%a terminal. Windows users can use the MSDOS Prompt which -%is usually accessed via the -%\textsf{Start}$\to$\textsf{All Programs} menu or -%\textsf{Start}$\to$\textsf{All Programs}%$\to$\textsf{Accessories} menu. Alternatively, your text editor may have the -%facility to create a function that will call the -%required application. See your editor's user manual for further -%details. +%\app{makeglossaries}, \app{xindy} or \app{makeindex} via a terminal. +%Windows users can use the MSDOS Prompt which is usually accessed via +%the \menu{Start}\submenu{All Programs} menu or +%\menu{Start}\submenu{All Programs}\submenu{Accessories} menu. +% +%Alternatively, your text editor may have the facility to create a +%function that will call the required application. The article +%\href{http://www.latex-community.org/index.php?option=com_content&view=article\&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{\qt{Glossaries, Nomenclature, List of Symbols and +%Acronyms}} +%in the \urlfootref{http://www.latex-community.org/}{\LaTeX\ +%Community's} Know How section +%describes how to do this for TeXnicCenter, and the thread +%\href{http://groups.google.com/group/comp.text.tex/browse_thread/thread/edd83831b81b0759?hl=en}{\qt{Executing Glossaries' makeindex from a WinEdt +%macro}} on the \texttt{comp.text.tex} newsgroup +%describes how to do it for WinEdt. For other editors see the editor's +%user manual for further details. % %If any problems occur, remember to check the transcript files %(e.g.\ \filetype{.glg} or \filetype{.alg}) for messages. % %\begin{table}[htbp] %\caption{Commands and package options that have no effect when -%using \texttt{xindy} or \texttt{makeindex} explicity} +%using \texttt{xindy} or \texttt{makeindex} explicitly} %\label{tab:makeglossariesCmds} %\vskip\baselineskip %\begin{tabular}{@{}lll@{}} -%\bfseries Command or Package Option & \appname{makeindex} & -%\appname{xindy}\\ +%\bfseries Command or Package Option & \app{makeindex} & +%\app{xindy}\\ %\pkgopt[letter]{order} & use \texttt{-l} & % use \texttt{-M ord/letorder}\\ %\pkgopt[word]{order} & default & default\\ -%\pkgopt{xindy}=\{\pkgoptni{language=}\meta{lang}\pkgoptni{,codename=}\meta{code}\} & +%\pkgopt{xindy}=\{\pkgoptfmt{language=}\meta{lang}\pkgoptfmt{,codename=}\meta{code}\} & %N/A & use \texttt{-L} \meta{lang} \texttt{-C} \meta{code}\\ %\ics{GlsSetXdyLanguage}\marg{lang} & N/A & %use \texttt{-L} \meta{lang}\\ @@ -875,63 +854,60 @@ %\par %\end{table} % +% %\subsubsection{Using the makeglossaries Perl Script} %\label{sec:makeglossariesapp} % -%The \appname{makeglossaries} script picks up the relevant -%information from the auxiliary (\filetype{.aux}) file and -%will either call \appname{xindy} or \appname{makeindex}, -%depending on the supplied information. Therefore, you only need to -%pass the document's name without the extension to -%\appname{makeglossaries}. -%For example, if your document is called \texttt{myDoc.tex}, -%type the following in your terminal: -%\begin{verbatim} +%The \app{makeglossaries} script picks up the relevant information +%from the auxiliary (\filetype{.aux}) file and will either call +%\app{xindy} or \app{makeindex}, depending on the supplied +%information. Therefore, you only need to pass the document's name +%without the extension to \app{makeglossaries}. For example, if your +%document is called \texttt{myDoc.tex}, type the following in your +%terminal: +%\begin{prompt} %latex myDoc %makeglossaries myDoc %latex myDoc -%\end{verbatim} -%You may need to explicitly load \appname{makeglossaries} into -%Perl: -%\begin{verbatim} +%\end{prompt} +%You may need to explicitly load \app{makeglossaries} into Perl: +%\begin{prompt} %perl makeglossaries myDoc -%\end{verbatim} -%There is a batch file called \texttt{makeglossaries.bat} which -%does this for Windows users, but you must have Perl installed to -%be able to use it. +%\end{prompt} +%There is a batch file called \texttt{makeglossaries.bat} which does +%this for Windows users, but you must have Perl installed to be able +%to use it. % -%The \appname{makeglossaries} script contains POD (Plain Old +%The \app{makeglossaries} script contains POD (Plain Old %Documentation). If you want, you can create a man page for -%\appname{makeglossaries} using \appname{pod2man} and move the +%\app{makeglossaries} using \app{pod2man} and move the %resulting file onto the man path. % +% %\subsubsection{Using xindy explicitly} %\label{sec:xindyapp} % -%If you want to use \appname{xindy} to process the glossary +%If you want to use \app{xindy} to process the glossary %files, you must make sure you have used the %\pkgopt{xindy} package option: %\begin{verbatim} %\usepackage[xindy]{glossaries} %\end{verbatim} -%This is required regardless of whether you use \appname{xindy} +%This is required regardless of whether you use \app{xindy} %explicitly or whether it's called implicitly via -%\appname{makeglossaries}. This causes the glossary -%entries to be written in raw \appname{xindy} format, so you need to +%\app{makeglossaries}. This causes the glossary +%entries to be written in raw \app{xindy} format, so you need to %use \texttt{-I xindy} \emph{not} \texttt{-I tex}. % -%To run \appname{xindy} type the following in your terminal -%(all on one line):\\[10pt] -%\begin{ttfamily} -%xindy -L \textrm{\meta{language}} -C \textrm{\meta{encoding}} -I xindy -%-M \textrm{\meta{style}} -t \textrm{\meta{base}}.glg\newline -%-o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo -%\end{ttfamily} -%\\[10pt] +%To run \app{xindy} type the following in your terminal +%(all on one line): +%\begin{prompt} +%xindy -L \meta{language} -C \meta{encoding} -I xindy -M \meta{style} -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo +%\end{prompt} %where \meta{language} is the required language name, \meta{encoding} %is the encoding, \meta{base} is the name of the document without the %\filetype{.tex} extension and \meta{style} is the name of the -%\appname{xindy} style file without the \filetype{.xdy} extension. +%\app{xindy} style file without the \filetype{.xdy} extension. %The default name for this style file is \meta{base}\filetype{.xdy} %but can be changed via \ics{setStyleFile}\marg{style}. You may need %to specify the full path name depending on the current working @@ -941,9 +917,9 @@ %For example, if your document is called \texttt{myDoc.tex} and %you are using UTF8 encoding in English, then type the %following in your terminal: -%\begin{verbatim} +%\begin{prompt} %xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo -%\end{verbatim} +%\end{prompt} % %Note that this just creates the main glossary. You need to do %the same for each of the other glossaries (including the @@ -952,89 +928,92 @@ %and \filetype{.glo} with the relevant extensions. For example, %if you have used the \pkgopt{acronym} package option, then %you would need to do: -%\begin{verbatim} +%\begin{prompt} %xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn -%\end{verbatim} +%\end{prompt} %For additional glossaries, the extensions are those supplied %when you created the glossary with \ics{newglossary}. % -%Note that if you use \appname{makeglossaries} instead, you can -%replace all those calls to \appname{xindy} with just one call -%to \appname{makeglossaries}: -%\begin{verbatim} +%Note that if you use \app{makeglossaries} instead, you can +%replace all those calls to \app{xindy} with just one call +%to \app{makeglossaries}: +%\begin{prompt} %makeglossaries myDoc -%\end{verbatim} +%\end{prompt} %Note also that some commands and package options have no effect if -%you use \appname{xindy} explicitly instead of using -%\appname{makeglossaries}. These are listed in +%you use \app{xindy} explicitly instead of using +%\app{makeglossaries}. These are listed in %\tableref{tab:makeglossariesCmds}. % +% %\subsubsection{Using makeindex explicitly} %\label{sec:makeindexapp} % -%If you want to use \appname{makeindex} explicitly, you must +%If you want to use \app{makeindex} explicitly, you must %make sure that you haven't used the \pkgopt{xindy} package %option or the glossary entries will be written in the wrong -%format. To run \appname{makeindex}, type the following in -%your terminal:\\[10pt] -%\begin{ttfamily} -%makeindex -s \textrm{\meta{style}}.ist -t \textrm{\meta{base}}.glg -%-o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo -%\end{ttfamily}\\[10pt] +%format. To run \app{makeindex}, type the following in +%your terminal: +%\begin{prompt} +%makeindex -s \meta{style}.ist -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo +%\end{prompt} %where \meta{base} is the name of your document without the %\filetype{.tex} extension and \meta{style}\filetype{.ist} is the -%name of the \appname{makeindex} style file. By default, this is +%name of the \app{makeindex} style file. By default, this is %\meta{base}\filetype{.ist}, but may be changed via %\ics{setStyleFile}\marg{style}. Note that there are other options, -%such as \texttt{-l} (letter ordering). See the \appname{makeindex} +%such as \texttt{-l} (letter ordering). See the \app{makeindex} %manual for further details. % %For example, if your document is called \texttt{myDoc.tex}, then %type the following at the terminal: -%\begin{verbatim} +%\begin{prompt} %makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo -%\end{verbatim} +%\end{prompt} %Note that this only creates the main glossary. If you have %additional glossaries (for example, if you have used the %\pkgopt{acronym} package option) then you must call -%\appname{makeindex} for each glossary, substituting +%\app{makeindex} for each glossary, substituting %\filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the %relevant extensions. For example, if you have used the %\pkgopt{acronym} package option, then you need to type the %following in your terminal: -%\begin{verbatim} +%\begin{prompt} %makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn -%\end{verbatim} +%\end{prompt} %For additional glossaries, the extensions are those supplied %when you created the glossary with \ics{newglossary}. % -%Note that if you use \appname{makeglossaries} instead, you can -%replace all those calls to \appname{makeindex} with just one call -%to \appname{makeglossaries}: -%\begin{verbatim} +%Note that if you use \app{makeglossaries} instead, you can +%replace all those calls to \app{makeindex} with just one call +%to \app{makeglossaries}: +%\begin{prompt} %makeglossaries myDoc -%\end{verbatim} +%\end{prompt} %Note also that some commands and package options have no effect if -%you use \appname{makeindex} explicitly instead of using -%\appname{makeglossaries}. These are listed in +%you use \app{makeindex} explicitly instead of using +%\app{makeglossaries}. These are listed in %\tableref{tab:makeglossariesCmds}. % +% %\subsubsection{Note to Front-End and Script Developers} % -%The information needed to determine whether to use \appname{xindy} -%or \appname{makeindex} and the information needed to call those +%The information needed to determine whether to use \app{xindy} +%or \app{makeindex} and the information needed to call those %applications is stored in the auxiliary file. This information can %be gathered by a front-end, editor or script to make the glossaries %where appropriate. This section describes how the information is %stored in the auxiliary file. % -%The file extensions used by each defined glossary are given by\\[10pt] -%\cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext}\\[10pt] +%The file extensions used by each defined glossary are given by +%\begin{definition}[\DescribeMacro{\@newglossary}] +%\cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext} +%\end{definition} %where \meta{in-ext} is the extension of the \emph{indexing -%application's} input file (the output file from the \sty{glossaries} +%application's} input file (the output file from the \styfmt{glossaries} %package's point of view), \meta{out-ext} is the extension of the %\emph{indexing application's} output file (the input file from -%the \sty{glossaries} package's point of view) and \meta{log} is the +%the \styfmt{glossaries} package's point of view) and \meta{log} is the %extension of the indexing application's transcript file. The label %for the glossary is also given for information purposes only, but %is not required by the indexing applications. For example, the @@ -1043,34 +1022,41 @@ %\@newglossary{main}{glg}{gls}{glo} %\end{verbatim} % -%The indexing application's style file is specified by\\[10pt] -%\cs{@istfilename}\marg{filename}\\[10pt] -%The file extension indicates whether to use \appname{makeindex} -%(\filetype{.ist}) or \appname{xindy} (\filetype{.xdy}). Note that +%The indexing application's style file is specified by +%\begin{definition}[\DescribeMacro{\@istfilename}] +%\cs{@istfilename}\marg{filename} +%\end{definition} +%The file extension indicates whether to use \app{makeindex} +%(\filetype{.ist}) or \app{xindy} (\filetype{.xdy}). Note that %the glossary information is formatted differently depending on %which indexing application is supposed to be used, so it's %important to call the correct one. % -%Word or letter ordering is specified by:\\[10pt] -%\cs{@glsorder}\marg{order}\\[10pt] +%Word or letter ordering is specified by: +%\begin{definition}[\DescribeMacro{\@glsorder}] +%\cs{@glsorder}\marg{order} +%\end{definition} %where \meta{order} can be either \texttt{word} or \texttt{letter}. % -%If \appname{xindy} should be used, the language and code page -%for each glossary is specified by\\[10pt] +%If \app{xindy} should be used, the language and code page +%for each glossary is specified by +%\begin{definition}[\DescribeMacro{\@xdylanguage}\DescribeMacro{\@gls@codepage}] %\cs{@xdylanguage}\marg{label}\marg{language}\\ -%\cs{@gls@codepage}\marg{label}\marg{code}\\[10pt] +%\cs{@gls@codepage}\marg{label}\marg{code} +%\end{definition} %where \meta{label} identifies the glossary, \meta{language} is %the root language (e.g.\ \texttt{english}) and \meta{code} %is the encoding (e.g.\ \texttt{utf8}). These commands are omitted -%if \appname{makeindex} should be used. +%if \app{makeindex} should be used. +% % %\subsection{Troubleshooting} %\label{sec:trouble} % -%The \sty{glossaries} package comes with a minimal file called +%The \styfmt{glossaries} package comes with a minimal file called %\texttt{minimalgls.tex} which can be used for testing. This %should be located in the \texttt{samples} subdirectory (folder) -%of the \sty{glossaries} documentation directory. The location +%of the \styfmt{glossaries} documentation directory. The location %varies according to your operating system and \TeX\ installation. %For example, on my Linux partition it can be found in %\texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. @@ -1078,7 +1064,7 @@ %\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. % %Below is a list of the most frequently asked questions. For -%other queries, consult the \sty{glossaries} FAQ at +%other queries, consult the \styfmt{glossaries} FAQ at %\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. % %\begin{enumerate} @@ -1087,7 +1073,7 @@ %Missing \begin{document} %\end{verbatim} % -%\textbf{A.} Check you are using an up to date version of the \isty{xkeyval} +%\textbf{A.} Check you are using an up to date version of the \sty{xkeyval} %package. % %\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms @@ -1132,35 +1118,33 @@ %\end{verbatim} % %\item \textbf{Q.} I don't have Perl installed, do I have to use -%\appname{makeglossaries}? -% -%\textbf{A.} Although it is strongly recommended that you use -%\appname{makeglossaries}, you don't have to use it. -%For further details, read -%\autoref{sec:xindyapp} or -%\autoref{sec:makeindexapp}, depending on -%whether you want to use \appname{xindy} or \appname{makeindex}. +%\app{makeglossaries}? % +%\textbf{A.} Although it is strongly recommended that you use +%\app{makeglossaries}, you don't have to use it. For further details, +%read \sectionref{sec:xindyapp} or \sectionref{sec:makeindexapp}, +%depending on whether you want to use \app{xindy} or \app{makeindex}. % -%\item \textbf{Q.} I'm used to using the \sty{glossary} package: are there any -%instructions on migrating from the \isty{glossary} package to the -%\sty{glossaries} package? +%\item \textbf{Q.} I'm used to using the \styfmt{glossary} package: are there any +%instructions on migrating from the \sty{glossary} package to the +%\styfmt{glossaries} package? % -%\textbf{A.} Read the file \texttt{glossary2glossaries.pdf} which should be available from the -%same location as this document. +%\textbf{A.} Read \qtdocref{Upgrading from the glossary package to +%the glossaries package}{glossary2glossaries} which should be +%available from the same location as this document. % -%\item \textbf{Q.} I'm using \isty{babel} but the fixed names haven't been -%translated. +%\item \textbf{Q.} I'm using \sty{babel} but the fixed names haven't +%been translated. % -%\textbf{A.} The \sty{glossaries} package currently only supports the following -%languages: Brazilian Portuguese, Danish, Dutch, English, French, -%German, Irish, Italian, Hungarian, Polish and Spanish. If you want -%to add another language, send me the translations, and I'll add them -%to the next version. +%\textbf{A.} The \styfmt{glossaries} package currently only supports +%the following languages: Brazilian Portuguese, Danish, Dutch, +%English, French, German, Irish, Italian, Hungarian, Polish, Serbian and +%Spanish. If you want to add another language, send me the +%translations, and I'll add them to the next version. % %If you are using one of the above languages, but the text hasn't been -%translated, try adding the \isty{translator} package with the -%required languages explicitly (before you load the \sty{glossaries} +%translated, try adding the \sty{translator} package with the +%required languages explicitly (before you load the \styfmt{glossaries} %package). For example: %\begin{verbatim} %\usepackage[ngerman]{babel} @@ -1168,7 +1152,7 @@ %\usepackage{glossaries} %\end{verbatim} %Alternatively, you can add the language as a global option -%to the class file. Check the \sty{translator} package documentation +%to the class file. Check the \styfmt{translator} package documentation %for further details. % %\item \textbf{Q.} My acronyms contain strange characters when I use commands @@ -1189,18 +1173,17 @@ %\item Use either \ics{printglossary} for each glossary that has %been defined or \ics{printglossaries}. % -%\item Use the commands listed in -%\autoref{sec:glslink}, -%\autoref{sec:glsadd} or -%\autoref{sec:crossref} for each entry +%\item Use the commands listed in \sectionref{sec:glslink}, +%\sectionref{sec:glsadd} or \sectionref{sec:crossref} for each entry %that you want to appear in the glossary. % -%\item Run \LaTeX\ on your document, then run \appname{makeglossaries}, +%\item Run \LaTeX\ on your document, then run \app{makeglossaries}, %then run \LaTeX\ on your document again. If you want the glossaries %to appear in the table of contents, you will need an extra \LaTeX\ %run. If any of your entries cross-reference an entry that's not -%referenced in the main body of the document, you will need to -%run \appname{makeglossaries} (see \autoref{sec:makeglossaries}) after the second \LaTeX\ run, followed by another \LaTeX\ run. +%referenced in the main body of the document, you will need to run +%\app{makeglossaries} (see \sectionref{sec:makeglossaries}) after the +%second \LaTeX\ run, followed by another \LaTeX\ run. %\end{itemize} % %Check the log files (\filetype{.log}, \filetype{.glg} etc) for any @@ -1209,39 +1192,50 @@ %\item \textbf{Q.} It is possible to change the rules used to sort %the glossary entries? % -%\textbf{A.} If it's for an individual entry, then you can -%use the entry's \gloskey{sort} key to sort it according to a -%different term. If it's for the entire alphabet, then you will need -%to use \appname{xindy} (instead of \appname{makeindex}) and use an -%appropriate \appname{xindy} language module. Writing \appname{xindy} -%modules or styles is beyond the scope of this manual. Further -%information about \appname{xindy} can be found at the -%\href{http://xindy.sourceforge.net/}{Xindy Web Site}.\footnote{\texttt{http://xindy.sourceforge.net/}} -%There is also a link to the \appname{xindy} mailing list from that -%site. +%\textbf{A.} If it's for an individual entry, then you can use the +%entry's \gloskey{sort} key to sort it according to a different term. +%If it's for the entire alphabet, then you will need to use +%\app{xindy} (instead of \app{makeindex}) and use an appropriate +%\app{xindy} language module. Writing \app{xindy} modules or styles +%is beyond the scope of this manual. Further information about +%\app{xindy} can be found at the +%\urlfootref{http://xindy.sourceforge.net/}{Xindy Web Site}. There is +%also a link to the \app{xindy} mailing list from that site. % %\end{enumerate} % +% %\section{Overview of Main User Commands}\label{sec:overview} % \changes{1.02}{2007 May 25}{added overview section} % +%This section is an overview of the main user commands and package +%options. If you find this too complicated, try starting out with the +%\docref{guide for beginners}{glossariesbegin}. +% %\subsection{Package Options} %\label{sec:pkgopts} % -%The \sty{glossaries} package options are as follows: +%The \styfmt{glossaries} package options are as follows: %\begin{description} %\item[\pkgopt{nowarn}] This suppresses all warnings generated by -%the \sty{glossaries} package. +%the \styfmt{glossaries} package. % %\item[\pkgopt{nomain}] This suppresses the creation of the main %glossary. Note that if you use this option, you must create another %glossary in which to put all your entries (either via the %\pkgopt{acronym} package option described below or via -%\ics{newglossary} described in -%\autoref{sec:newglossary}). +%\ics{newglossary} described in \sectionref{sec:newglossary}). % %\item[\pkgopt{toc}] Add the glossaries to the table of contents. %Note that an extra \LaTeX\ run is required with this option. +%Alternatively, you can switch this function on and off using +%\begin{definition}[\DescribeMacro{\glstoctrue}] +%\cs{glstoctrue} +%\end{definition} +%and +%\begin{definition}[\DescribeMacro{\glstocfalse}] +%\cs{glstocfalse} +%\end{definition} % %\item[\pkgopt{numberline}] When used with \pkgopt{toc}, this will %add \cs{numberline}\verb|{}| in the final argument of @@ -1341,7 +1335,7 @@ %\pkgopt{acronym} option is used, otherwise the list of %acronyms is the main glossary} and additional glossaries are labelled %using the value specified in the first mandatory argument to -%\cs{newglossary}. For example, if you load \sty{glossaries} +%\cs{newglossary}. For example, if you load \styfmt{glossaries} %using: %\begin{verbatim} %\usepackage[section,numberedsection=autolabel]{glossaries} @@ -1383,40 +1377,41 @@ % %\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its %value should be the name of the glossary style to use. Predefined -%glossary styles are listed in \autoref{sec:styles}. -%\item[\pkgopt{nolong}] This prevents the \sty{glossaries} package -%from automatically loading \isty{glossary-long} (which means that -%the \isty{longtable} package also won't be loaded). This reduces -%overhead by not defining unwanted styles and commands. Not that if +%glossary styles are listed in \sectionref{sec:styles}. +% +%\item[\pkgopt{nolong}] This prevents the \styfmt{glossaries} package +%from automatically loading \sty{glossary-long} (which means that +%the \sty{longtable} package also won't be loaded). This reduces +%overhead by not defining unwanted styles and commands. Note that if %you use this option, you won't be able to use any of the -%glossary styles defined in the \sty{glossary-long} package. +%glossary styles defined in the \styfmt{glossary-long} package. % -%\item[\pkgopt{nosuper}] This prevents the \sty{glossaries} package -%from automatically loading \isty{glossary-super} (which means that -%the \isty{supertabular} package also won't be loaded). This reduces -%overhead by not defining unwanted styles and commands. Not that if +%\item[\pkgopt{nosuper}] This prevents the \styfmt{glossaries} package +%from automatically loading \sty{glossary-super} (which means that +%the \sty{supertabular} package also won't be loaded). This reduces +%overhead by not defining unwanted styles and commands. Note that if %you use this option, you won't be able to use any of the -%glossary styles defined in the \sty{glossary-super} package. +%glossary styles defined in the \styfmt{glossary-super} package. % -%\item[\pkgopt{nolist}] This prevents the \sty{glossaries} package -%from automatically loading \isty{glossary-list}. This reduces -%overhead by not defining unwanted styles. Not that if +%\item[\pkgopt{nolist}] This prevents the \styfmt{glossaries} package +%from automatically loading \sty{glossary-list}. This reduces +%overhead by not defining unwanted styles. Note that if %you use this option, you won't be able to use any of the -%glossary styles defined in the \sty{glossary-list} package. +%glossary styles defined in the \styfmt{glossary-list} package. %Note that since the default style is \glostyle{list}, you will %also need to use the \pkgopt{style} option to set the style to %something else. % -%\item[\pkgopt{notree}] This prevents the \sty{glossaries} package -%from automatically loading \isty{glossary-tree}. This reduces -%overhead by not defining unwanted styles. Not that if +%\item[\pkgopt{notree}] This prevents the \styfmt{glossaries} package +%from automatically loading \sty{glossary-tree}. This reduces +%overhead by not defining unwanted styles. Note that if %you use this option, you won't be able to use any of the -%glossary styles defined in the \sty{glossary-tree} package. +%glossary styles defined in the \styfmt{glossary-tree} package. % %\item[\pkgopt{nostyles}] This prevents all the predefined styles %from being loaded. This option is provided in the event that the %user has custom styles that are not dependent on the styles -%provided by the \sty{glossaries} package. Note that if you use +%provided by the \styfmt{glossaries} package. Note that if you use %this option, you can't use the \pkgopt{style} package option. Instead %you must either use \ics{glossarystyle}\marg{style} or %the \gloskey[printglossary]{style} key in the @@ -1424,28 +1419,31 @@ % %\item[\pkgopt{nonumberlist}] This option will suppress the %associated number lists\iterm{number list} in the glossaries (see also -%\autoref{sec:numberlists}). +%\sectionref{sec:numberlists}). +% %\item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option. The %value should be the name of the default counter to use in the number %lists\iterm{number list}. % -%\hypertarget{sanitize}{}\relax\item[\pkgopt{sanitize}] This is a \meta{key}=\meta{value} option whose -%value is also a \meta{key}=\meta{value} list. By default, the -%\sty{glossaries} package sanitizes the values of the -%\gloskey{name}, \gloskey{description} and \gloskey{symbol} keys used -%when defining a new glossary entry. This means that you can use -%fragile commands in those keys, but it may lead to unexpected results -%if you try to display these values within the document text. This -%sanitization can be switched off using the \pkgopt{sanitize} package -%option. (See \autoref{sec:pkgopt} and \autoref{sec:newentry} for further details.) For example, to switch off the sanitization for the -%\gloskey{description} and \gloskey{name} keys, but not for the -%\gloskey{symbol} key, do: +%\hypertarget{sanitize}{}\relax \item[\pkgopt{sanitize}] This is a +%\meta{key}=\meta{value} option whose value is also a +%\meta{key}=\meta{value} list. By default, the \styfmt{glossaries} +%package sanitizes the values of the \gloskey{name}, +%\gloskey{description} and \gloskey{symbol} keys used when defining a +%new glossary entry. This means that you can use fragile commands in +%those keys, but it may lead to unexpected results if you try to +%display these values within the document text. This sanitization can +%be switched off using the \pkgopt{sanitize} package option. \ifpdf +%(See \sectionref{sec:pkgopt} and \sectionref{sec:newentry} for +%further details.) \fi For example, to switch off the sanitization +%for the \gloskey{description} and \gloskey{name} keys, but not for +%the \gloskey{symbol} key, do: %\begin{verbatim} %\usepackage[sanitize={name=false,description=false,% %symbol=true}]{glossaries} %\end{verbatim} %You can use \pkgopt[none]{sanitize} as a shortcut for\newline -%\pkgoptni{sanitize=\{name=false,description=false,symbol=false\}}. +%\pkgoptfmt{sanitize=\{name=false,description=false,symbol=false\}}. % %\begin{important}% %\textbf{Note}: this sanitization only applies to the \gloskey{name}, @@ -1459,88 +1457,90 @@ %\end{important} % %\item[\pkgopt{description}] This option changes the definition of -%\ics{newacronym} to allow a description. See \autoref{sec:acronyms} for further details. +%\ics{newacronym} to allow a description. See \sectionref{sec:acronyms} +%for further details. % %\item[\pkgopt{footnote}] This option changes the definition of -%\ics{newacronym} and the way that acronyms are displayed. See \autoref{sec:acronyms} for further details. +%\ics{newacronym} and the way that acronyms are displayed. See +%\sectionref{sec:acronyms} for further details. % %\item[\pkgopt{smallcaps}] This option changes the definition of -%\ics{newacronym} and the way that acronyms are displayed. See \autoref{sec:acronyms} for further details. +%\ics{newacronym} and the way that acronyms are displayed. See +%\sectionref{sec:acronyms} for further details. % %\item[\pkgopt{smaller}] This option changes the definition of %\ics{newacronym} and the way that acronyms are displayed. -%If you use this option, you will need to include the \isty{relsize} +%If you use this option, you will need to include the \sty{relsize} %package or otherwise define \ics{textsmaller} or redefine -%\ics{acronymfont}. See -%\autoref{sec:acronyms} for further details. +%\ics{acronymfont}. See \sectionref{sec:acronyms} for further details. % %\item[\pkgopt{dua}] This option changes the definition of %\ics{newacronym} so that acronyms are always expanded. -%See \autoref{sec:acronyms} for further details. +%See \sectionref{sec:acronyms} for further details. % %\item[\pkgopt{shortcuts}] This option provides shortcut commands -%for acronyms. -%See \autoref{sec:acronyms} for further details. +%for acronyms. See \sectionref{sec:acronyms} for further details. % %\item[\pkgopt{makeindex}] (Default) The glossary information and -%indexing style file will be written in \appname{makeindex} format. If you use -%\appname{makeglossaries}, it will automatically detect that it needs -%to call \appname{makeindex}. If you don't use -%\appname{makeglossaries}, you need to remember to use -%\appname{makeindex} not \appname{xindy}. The indexing style file -%will been given a \filetype{.ist} extension. -% -%\item[\pkgopt{xindy}] The glossary information and indexing style file will -%be written in \appname{xindy} format. If you use -%\appname{makeglossaries}, it will automatically detect that it needs -%to call \appname{xindy}. If you don't use \appname{makeglossaries}, -%you need to remember to use \appname{xindy} not \appname{makeindex}. -%The indexing style file will been given a \filetype{.xdy} extension. -% -%The \pkgopt{xindy} package option may additionally have a -%value that is a \meta{key}=\meta{value} comma-separated list to override -%the language and codepage. For example: +%indexing style file will be written in \app{makeindex} format. If +%you use \app{makeglossaries}, it will automatically detect that it +%needs to call \app{makeindex}. If you don't use +%\app{makeglossaries}, you need to remember to use \app{makeindex} +%not \app{xindy}. The indexing style file will been given a +%\filetype{.ist} extension. +% +%\item[\pkgopt{xindy}] The glossary information and indexing style +%file will be written in \app{xindy} format. If you use +%\app{makeglossaries}, it will automatically detect that it needs to +%call \app{xindy}. If you don't use \app{makeglossaries}, you need to +%remember to use \app{xindy} not \app{makeindex}. The indexing style +%file will been given a \filetype{.xdy} extension. +% +%The \pkgopt{xindy} package option may additionally have a value that +%is a \meta{key}=\meta{value} comma-separated list to override the +%language and codepage. For example: %\begin{verbatim} %\usepackage[xindy={language=english,codepage=utf8}]{glossaries} %\end{verbatim} -%You can also specify whether you want a number group in -%the glossary. This defaults to true, but can be suppressed. For -%example: +%You can also specify whether you want a number group in the +%glossary. This defaults to true, but can be suppressed. For example: %\begin{verbatim} %\usepackage[xindy={glsnumbers=false}]{glossaries} %\end{verbatim} -%See \autoref{sec:xindy} for further details on using \appname{xindy} with the -%\sty{glossaries} package. +%See \sectionref{sec:xindy} for further details on using \app{xindy} +%with the \styfmt{glossaries} package. % %\item[\pkgopt{order}] This may take two values: %\pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default %is word ordering. Note that this option has no effect if you -%don't use \appname{makeglossaries}. +%don't use \app{makeglossaries}. % %\item[\pkgopt{translate}] This is a boolean option. The default is -%\pkgoptval{true}{translate} if \isty{babel}, \isty{polyglossia} or -%\isty{translator} have been loaded, otherwise the default value is +%\pkgoptval{true}{translate} if \sty{babel}, \sty{polyglossia} or +%\sty{translator} have been loaded, otherwise the default value is %\pkgoptval{false}{translate}. % % \begin{description} -% \item[{\pkgopt[true]{translate}}] If \isty{babel} has been loaded -% and the \isty{translator} package is installed, \isty{translator} +% \item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded +% and the \sty{translator} package is installed, \sty{translator} % will be loaded and the translations will be provided by the -% \isty{translator} package interface. You can modify the +% \sty{translator} package interface. You can modify the % translations by providing your own dictionary. If the -% \isty{translator} package isn't installed and \isty{babel} is -% loaded, the \isty{glossaries-babel} package will -% be loaded and the translations will be provided using \sty{babel}'s +% \sty{translator} package isn't installed and \sty{babel} is +% loaded, the \sty{glossaries-babel} package will +% be loaded and the translations will be provided using \styfmt{babel}'s % \cs{addto}\cs{caption}\meta{language} mechanism. If -% \isty{polyglossia} has been loaded, \isty{glossaries-polyglossia} +% \sty{polyglossia} has been loaded, \sty{glossaries-polyglossia} % will be loaded. % % \item[{\pkgopt[false]{translate}}] Don't provide translations, even -% if \isty{babel} or \isty{polyglossia} has been loaded. You can +% if \sty{babel} or \sty{polyglossia} has been loaded. You can % then provide you're own translations or explicitly load -% \isty{glossaries-babel} or \isty{glossaries-polyglossia}. +% \sty{glossaries-babel} or \sty{glossaries-polyglossia}. % \end{description} % +%See \sectionref{sec:fixednames} for further details. +% %\item[\pkgopt{hyperfirst}] This is a boolean option that specifies %whether each term has a hyperlink on \firstuse. The default is %\pkgopt[true]{hyperfirst} (terms on first use have a hyperlink, @@ -1548,52 +1548,57 @@ %such as \cs{gls*}). % %\end{description} +% %\subsection{Defining Glossary Entries} %\label{sec:newglosentry} % -%All glossary entries must be defined before they are used, so it -%is better to define them in the preamble to ensure this.\footnote{The -%only preamble restriction on \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 \autoref{sec:glslink}, \autoref{sec:glsadd} or \autoref{sec:crossref}) will appear in the glossary. Each time an entry -%is used in this way, a line is added to an associated glossary file -%(\filetype{.glo}), which then needs to be converted into a +%All glossary entries must be defined before they are used, so it is +%better to define them in the preamble to ensure this.\footnote{The +%only preamble restriction on \cs{newglossaryentry} and +%\cs{newacronym} was removed in version 1.13, but the restriction +%remains for \cs{loadglsentries}.} However only those entries that +%occur in the document (using any of the commands described in +%\sectionref{sec:glslink}, \sectionref{sec:glsadd} or +%\sectionref{sec:crossref}) will appear in the glossary. Each time an +%entry is used in this way, a line is added to an associated glossary +%file (\filetype{.glo}), which then needs to be converted into a %corresponding \filetype{.gls} file which contains the typeset %glossary which is input by \ics{printglossary} or -%\ics{printglossaries}. The Perl script \appname{makeglossaries} can -%be used to call \appname{makeindex} or \appname{xindy}, using a -%customised indexing style file, for each of the glossaries that are -%defined in the document. Note that there should be no need for you -%to explicitly edit or input any of these external files. See -%\autoref{sec:makeglossaries} -%for further details. -% -%\DescribeMacro{\makeglossaries} -%The command \cs{makeglossaries} must be placed in the preamble in -%order to create the customised \appname{makeindex} (\filetype{.ist}) -%or \appname{xindy} (\filetype{.xdy}) +%\ics{printglossaries}. The Perl script \app{makeglossaries} can be +%used to call \app{makeindex} or \app{xindy}, using a customised +%indexing style file, for each of the glossaries that are defined in +%the document. Note that there should be no need for you to +%explicitly edit or input any of these external files. See +%\sectionref{sec:makeglossaries} for further details. +% +%The command +%\begin{definition}[\DescribeMacro{\makeglossaries}] +%\cs{makeglossaries} +%\end{definition} +%must be placed in the preamble in order to create the customised +%\app{makeindex} (\filetype{.ist}) or \app{xindy} (\filetype{.xdy}) %style file and to ensure that glossary entries are written to the -%appropriate output files. If you omit \cs{makeglossaries} none of the -%glossaries will be created. +%appropriate output files. If you omit \cs{makeglossaries} none of +%the glossaries will be created. % %\begin{important} -%Note that some of the commands provided by the \sty{glossaries} +%Note that some of the commands provided by the \styfmt{glossaries} %package must be placed before \cs{makeglossaries} as they are %required when creating the customised style file. If you attempt %to use those commands after \cs{makeglossaries} you will generate %an error. %\end{important} % -%\DescribeMacro{\noist} -%You can suppress the creation of the customised \appname{xindy} -%or \appname{makeindex} style file using \cs{noist}. Note that this -%command must be used before \cs{makeglossaries}. +%You can suppress the creation of the customised \app{xindy} +%or \app{makeindex} style file using +%\begin{definition}[\DescribeMacro{\noist}] +%\cs{noist} +%\end{definition} +%Note that this command must be used before \cs{makeglossaries}. % %The default name for the customised style file is given by -%\ics{jobname}\filetype{.ist} (for \appname{makeindex}) or -%\ics{jobname}\filetype{.xdy} (for \appname{xindy}). This name may be +%\ics{jobname}\filetype{.ist} (for \app{makeindex}) or +%\ics{jobname}\filetype{.xdy} (for \app{xindy}). This name may be %changed using: %\begin{definition}[\DescribeMacro{\setStyleFile}] %\cs{setStyleFile}\marg{name} @@ -1618,35 +1623,31 @@ %\end{verbatim} %Note that this command must be used before \cs{makeglossaries}. % -%If you use \appname{xindy}, you can have a different compositor -%for page numbers starting with an uppercase alphabetical -%character using: +%If you use \app{xindy}, you can have a different compositor for page +%numbers starting with an uppercase alphabetical character using: %\begin{definition}[\DescribeMacro{\glsSetAlphaCompositor}] %\cs{glsSetAlphaCompositor}\marg{symbol} %\end{definition} %Note that this command has no effect if you haven't used the -%\pkgopt{xindy} package option. For example, if you want -%number lists\iterm{number list} containing a mixture of A-1 and 2.3 -%style formats, then do: +%\pkgopt{xindy} package option. For example, if you want number +%lists\iterm{number list} containing a mixture of A-1 and 2.3 style +%formats, then do: %\begin{verbatim} -%\glsSetCompositor{.} -%\glsSetAlphaCompositor{-} +%\glsSetCompositor{.} \glsSetAlphaCompositor{-} %\end{verbatim} -%See \autoref{sec:numberlists} for -%further information about number lists\iterm{number list}. +%See \sectionref{sec:numberlists} for further information about +%number lists\iterm{number list}. % %New glossary entries are defined using the command: %\begin{definition}[\DescribeMacro{\newglossaryentry}] %\cs{newglossaryentry}\marg{label}\marg{key-val list} %\end{definition} -%The first -%argument, \meta{label}, must be a unique label with which to identify -%this entry. The second argument, \meta{key-val list}, is a -%\meta{key}=\meta{value} list that supplies the relevant information -%about this entry. There are two required fields: \gloskey{name} and -%\gloskey{description}, except for sub-entries where the -%\gloskey{name} field may be omitted. Available fields are listed -%below: +%The first argument, \meta{label}, must be a unique label with which +%to identify this entry. The second argument, \meta{key-val list}, is +%a \meta{key}=\meta{value} list that supplies the relevant +%information about this entry. There are two required fields: +%\gloskey{description} and either \gloskey{name} or \gloskey{parent}. +%Available fields are listed below: % %\begin{description} %\item[{\gloskey{name}}] The name of the entry (as it will appear in @@ -1655,11 +1656,17 @@ % %\item[{\gloskey{description}}] A brief description of this term (to %appear in the glossary). Within this value, you can use -%\DescribeMacro{\nopostdesc}\cs{nopostdesc} to suppress the +%\begin{definition}[\DescribeMacro{\nopostdesc}] +%\cs{nopostdesc} +%\end{definition} +%to suppress the %description terminator for this entry. For example, if this %entry is a parent entry that doesn't require a description, you %can do \verb|description={\nopostdesc}|. If you want a paragraph -%break in the description use \DescribeMacro{\glspar}\cs{glspar}. +%break in the description use +%\begin{definition}[\DescribeMacro{\glspar}] +%\cs{glspar} +%\end{definition} %However, note that not all glossary styles support multi-line %descriptions. If you are using one of the tabular-like glossary %styles that permit multi-line descriptions, use \ics{newline} @@ -1667,7 +1674,7 @@ % %\item[{\gloskey{parent}}] The label of the parent entry. Note that %the parent entry must be defined before its sub-entries. -%See \autoref{sec:subentries} for further details. +%See \sectionref{sec:subentries} for further details. % %\item[{\gloskey{descriptionplural}}] The plural form of the %description (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} @@ -1688,7 +1695,7 @@ %If this field is omitted, the value is obtained by appending %\ics{glspluralsuffix} to the value of the \gloskey{text} field. %The default value of \cs{glspluralsuffix} is the letter -%\dq{s}. +%\qt{s}. % %\item[{\gloskey{firstplural}}] How the entry will appear in the %document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its @@ -1698,7 +1705,7 @@ %\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{firstplural} was always taken by appending \qt{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. @@ -1713,8 +1720,8 @@ %by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value %is set to the same as the \gloskey{symbol} key. % -%\item[{\gloskey{sort}}] This value indicates how \appname{makeindex} -%or \appname{xindy} should sort this entry. If omitted, the value is +%\item[{\gloskey{sort}}] This value indicates how \app{makeindex} +%or \app{xindy} should sort this entry. If omitted, the value is %given by the \gloskey{name} field. % %\item[{\gloskey{type}}] This specifies the label of the glossary in @@ -1736,10 +1743,11 @@ %\gloskey{see} key will automatically add this entry to the %glossary, but will not automatically add the cross-referenced entry. %The referenced entry should be supplied as the value to this key. -%If you want to override the \dq{see} tag, you can supply the new +%If you want to override the \qt{see} tag, you can supply the new %tag in square brackets before the label. For example %\verb|see=[see also]{anotherlabel}|. For further details, -%see \autoref{sec:crossref}. +%see \sectionref{sec:crossref}. +% %\end{description} %Note that if the name starts with an accented letter or non-Latin %character, you must group the accented letter, otherwise it will @@ -1749,15 +1757,15 @@ %\newglossaryentry{elite}{name={{\'e}lite}, %description={select group or class}} %\end{verbatim} -%Note that the same applies if you are using the \isty{inputenc} +%Note that the same applies if you are using the \sty{inputenc} %package: %\begin{verbatim} %\newglossaryentry{elite}{name={{é}lite}, %description={select group or class}} %\end{verbatim} %Note that in both of the above examples, you will also need to -%supply the \gloskey{sort} key if you are using \appname{makeindex} -%whereas \appname{xindy} is usually able to sort accented letters +%supply the \gloskey{sort} key if you are using \app{makeindex} +%whereas \app{xindy} is usually able to sort accented letters %correctly. % % @@ -1766,16 +1774,18 @@ %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 -%\DescribeMacro{\glspluralsuffix}\cs{glspluralsuffix} to -%the singular form. This command defaults to the letter \dq{s}. +%\begin{definition}[\DescribeMacro{\glspluralsuffix}] +%\cs{glspluralsuffix} +%\end{definition} +%to the singular form. This command defaults to the letter \qt{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 +%defines a new entry whose singular form is \qt{cow} and plural form +%is \qt{cows}. However, if you are writing in archaic English, you +%may want to use \qt{kine} as the plural form, in which case you %would have to do: %\begin{verbatim} %\newglossaryentry{cow}{name=cow,plural=kine, @@ -1791,8 +1801,8 @@ %female of any bovine animal (plural cows, archaic plural kine)}, %user1={kine}} %\end{verbatim} -%You can then use \verb|\glspl{cow}| to produce \dq{cows} and -%\verb|\glsuseri{cow}| to produce \dq{kine}. You can, of course, +%You can then use \verb|\glspl{cow}| to produce \qt{cows} and +%\verb|\glsuseri{cow}| to produce \qt{kine}. You can, of course, %define an easy to remember synonym. For example: %\begin{verbatim} %\let\glsaltpl\glsuseri @@ -1821,14 +1831,15 @@ %hierarchical entries and may display all the entries in a flat %format. Of the styles that support sub-entries, some display the %sub-entry's name whilst others don't. Therefore you need to -%ensure that you use a suitable style. See \autoref{sec:styles} for a list of predefined -%styles. +%ensure that you use a suitable style. See \sectionref{sec:styles} +%for a list of predefined styles. % %Note that the parent entry will automatically be added to the %glossary if any of its child entries are used in the document. %If the parent entry is not referenced in the document, it will not %have a \term{number list}. % +% %\paragraph{Hierarchical Categories} To arrange a glossary %with hierarchical categories, you need to first define the %category and then define the sub-entries using the relevant @@ -1860,11 +1871,12 @@ %parent=romanletter} %\end{verbatim} % +% %\paragraph{Homographs} Sub-entries that have the same name as %the parent entry, don't need to have the \gloskey{name} key. -%For example, the word \dq{glossary} can mean a list of technical +%For example, the word \qt{glossary} can mean a list of technical %words or a collection of glosses. In both cases the plural is -%\dq{glossaries}. So first define the parent entry: +%\qt{glossaries}. So first define the parent entry: %\begin{verbatim} %\newglossaryentry{glossary}{name=glossary, %description={\nopostdesc}, @@ -1911,6 +1923,7 @@ %parent=bravo} %\end{verbatim} % +% %\subsubsection{Loading Entries From a File} %\label{sec:loadglsentries} % @@ -1948,10 +1961,10 @@ %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 \autoref{sec:acronyms}) the type is set as \verb|type=\acronymtype| -%unless you explicitly override it. For example, if my file -%\texttt{myacronyms.tex} contains: +%\textbf{Note:} if you use \cs{newacronym} (see +%\sectionref{sec:acronyms}) the type is set as +%\verb|type=\acronymtype| unless you explicitly override it. For +%example, if my file \texttt{myacronyms.tex} contains: %\begin{verbatim} %\newacronym{aca}{aca}{a contrived acronym} %\end{verbatim} @@ -1963,10 +1976,10 @@ %will add \texttt{aca} to the glossary type \texttt{acronym}, if the %package option \pkgopt{acronym} has been specified, or will add %\texttt{aca} to the glossary type \texttt{altacronym}, if the -%package option \pkgopt{acronym} is not specified.\footnote{This -%is because \cs{acronymtype} is set to \cs{glsdefaulttype} if -%the \pkgopt{acronym} package option is not used.} In this instance, -%it is better to change \texttt{myacronyms.tex} to: +%package option \pkgopt{acronym} is not specified.\footnote{This is +%because \cs{acronymtype} is set to \cs{glsdefaulttype} if the +%\pkgopt{acronym} package option is not used.} In this instance, it +%is better to change \texttt{myacronyms.tex} to: %\begin{verbatim} %\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} %\end{verbatim} @@ -1982,20 +1995,23 @@ %in the text will appear in the relevant glossaries. %Note also that \cs{loadglsentries} may only be used in the %preamble. +% %\subsection{Number lists} %\label{sec:numberlists} % %Each entry in the glossary has an associated \termdef{number list}. %By default, %these numbers refer to the pages on which that entry has been used -%(using any of the commands described in \autoref{sec:glslink} and \autoref{sec:glsadd}). The number list can be suppressed using the \pkgopt{nonumberlist} package option, or an alternative counter +%(using any of the commands described in \sectionref{sec:glslink} +%and \sectionref{sec:glsadd}). The number list can be suppressed using +%the \pkgopt{nonumberlist} package option, or an alternative counter %can be set as the default using the \pkgopt{counter} package option. %The number list is also referred to as the location %list\index{location list|see{number list}}. % -%Both \appname{makeindex} and \appname{xindy} concatenate a +%Both \app{makeindex} and \app{xindy} concatenate a %sequence of 3 or more consecutive pages into a range. With -%\appname{xindy} you can vary the minimum sequence length using +%\app{xindy} you can vary the minimum sequence length using %\ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either %an integer or the keyword \texttt{none} which indicates that there %should be no range formation. @@ -2005,7 +2021,7 @@ %\ics{makeglossaries} and has no effect if \ics{noist} is used. %\end{important} % -%With both \appname{makeindex} and \appname{xindy}, you can replace +%With both \app{makeindex} and \app{xindy}, you can replace %the separator and the closing number in the range using: %\begin{definition}[\DescribeMacro{\glsSetSuffixF}] %\cs{glsSetSuffixF}\marg{suffix} @@ -2020,13 +2036,13 @@ %\glsSetSuffixF{f.} %\glsSetSuffixFF{ff.} %\end{verbatim} -%Note that if you use \appname{xindy}, you will also need to +%Note that if you use \app{xindy}, you will also need to %set the minimum range length to 1 if you want to change these %suffixes: %\begin{verbatim} %\GlsSetXdyMinRangeLength{1} %\end{verbatim} -%Note that if you use the \isty{hyperref} package, you will need +%Note that if you use the \sty{hyperref} package, you will need %to use \ics{nohyperpage} in the suffix to ensure that the hyperlinks %work correctly. For example: %\begin{verbatim} @@ -2044,18 +2060,17 @@ %\subsection{Links to Glossary Entries} %\label{sec:glslink} % -%Once you have defined a glossary entry using -%\ics{newglossaryentry}, you can refer to that entry in the -%document using one of the commands listed in this section. The -%text which appears at that point in the document when using -%one of these commands is referred to as the -%\termdef{link text} (even if there are no hyperlinks). The commands -%in this section also add a line to an external file that is used -%by \appname{makeindex} or \appname{xindy} to generate the relevant -%entry in the glossary. This information includes an -%associated location that is added to the \term{number list} for that -%entry. By default, the location refers to the page number. For -%further information on number lists, see \autoref{sec:numberlists}. +%Once you have defined a glossary entry using \ics{newglossaryentry}, +%you can refer to that entry in the document using one of the +%commands listed in this section. The text which appears at that +%point in the document when using one of these commands is referred +%to as the \termdef{link text} (even if there are no hyperlinks). The +%commands in this section also add a line to an external file that is +%used by \app{makeindex} or \app{xindy} to generate the relevant +%entry in the glossary. This information includes an associated +%location that is added to the \term{number list} for that entry. By +%default, the location refers to the page number. For further +%information on number lists, see \sectionref{sec:numberlists}. % %\begin{important} %It is strongly recommended that you don't use the commands @@ -2064,18 +2079,17 @@ %\end{important} % %The above warning is particularly important if you are using the -%\sty{glossaries} package in conjunction with the \isty{hyperref} package. -%Instead, use one of the commands listed in -%\autoref{sec:glsnolink} (such as \cs{glsentrytext}) or provide an alternative via -%the optional argument to the sectioning/caption command. -%Examples: +%\styfmt{glossaries} package in conjunction with the \sty{hyperref} +%package. Instead, use one of the commands listed in +%\sectionref{sec:glsnolink} (such as \cs{glsentrytext}) or provide an +%alternative via the optional argument to the sectioning/caption +%command. Examples: %\begin{verbatim} %\section{An overview of \glsentrytext{perl}} %\section[An overview of Perl]{An overview of \gls{perl}} %\end{verbatim} % -%The way the \term{link text} is displayed -%depends on +%The way the \term{link text} is displayed depends on %\begin{definition}[\DescribeMacro{\glstextformat}] %\cs{glstextformat}\marg{text} %\end{definition} @@ -2090,7 +2104,8 @@ %\ics{glspl} (and their uppercase variants) should use the %value of the \gloskey{first} or \gloskey{text} keys. Note that an %entry can be used without affecting the \firstuseflag\ (for example, -%when used with \cs{glslink}). See \autoref{sec:glsunset} for commands that unset or reset this conditional. +%when used with \cs{glslink}). See \sectionref{sec:glsunset} for +%commands that unset or reset this conditional. % %The command: %\begin{definition}[\DescribeMacro{\glslink}] @@ -2108,7 +2123,7 @@ %\begin{description} %\item[{\gloskey[glslink]{format}}] This specifies how to format the %associated location number for this entry in the glossary. This -%value is equivalent to the \appname{makeindex} encap value, and (as +%value is equivalent to the \app{makeindex} encap value, and (as %with \cs{index}) the value needs to be the name of a command %\emph{without} the initial backslash. As with \cs{index}, the %characters \verb"(" and \verb")" can also be used to specify the @@ -2130,26 +2145,27 @@ %commands listed in \tableref{tab:hyperxx}. % %\begin{important} -%If you use \appname{xindy} instead of \appname{makeindex}, you +%If you use \app{xindy} instead of \app{makeindex}, you %must specify any non-standard formats that you want to use %with the \gloskey[glslink]{format} key using %\ics{GlsAddXdyAttribute}\marg{name}. So if you use -%\appname{xindy} with the above example, you would need to add: +%\app{xindy} with the above example, you would need to add: %\begin{verbatim} %\GlsAddXdyAttribute{textbfem} %\end{verbatim} %\end{important} % -%Note that unlike \cs{index}, you can't have -%anything following the command name, such as an asterisk or -%arguments. If you want to cross-reference another entry, either -%use the \gloskey{see} key when you define the entry or use -%\ics{glssee} (described in \autoref{sec:crossref}). +%Note that unlike \cs{index}, you can't have anything following the +%command name, such as an asterisk or arguments. If you want to +%cross-reference another entry, either use the \gloskey{see} key when +%you define the entry or use \ics{glssee} (described in +%\sectionref{sec:crossref}). +% % %If you are using hyperlinks and you want to change the font of the %hyperlinked location, don't use \ics{hyperpage} (provided by the -%\isty{hyperref} package) as the locations may not refer to a page -%number. Instead, the \sty{glossaries} package provides number +%\sty{hyperref} package) as the locations may not refer to a page +%number. Instead, the \styfmt{glossaries} package provides number %formats listed in \tableref{tab:hyperxx}. % %\begin{table}[htbp] @@ -2177,14 +2193,15 @@ %analogous \texttt{text}\meta{xx} font commands (and \texttt{hyperemph} %is equivalent to \texttt{emph}). If you want to %make a new format, you will need to define a command which takes -%one argument and use that; for example, if you want the location +%one argument and use that. For example, if you want the location %number to be in a bold sans-serif font, you can define a %command called, say, \cs{hyperbsf}: %\begin{verbatim} %\newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} %\end{verbatim} %and then use \texttt{hyperbsf} as the value for the \gloskey{format} -%key. (See also \autoref{sec:code:printglos}.) Remember that if you use \appname{xindy}, you will need to add +%key. \ifpdf (See also \sectionref{sec:code:printglos}.) \fi +%Remember that if you use \app{xindy}, you will need to add %this to the list of location attributes: %\begin{verbatim} %\GlsAddXdyAttribute{hyperbsf} @@ -2192,8 +2209,8 @@ % %\item[{\gloskey[glslink]{counter}}] This specifies which counter %to use for this location. This overrides the default counter -%used by this entry. (See also -%\autoref{sec:numberlists}.) +%used by this entry. (See also \sectionref{sec:numberlists}.) +% %\item[{\gloskey[glslink]{hyper}}] This is a boolean key which can %be used to enable/disable the hyperlink to the relevant entry %in the glossary. (Note that setting \texttt{hyper=true} will have no @@ -2237,8 +2254,8 @@ %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, but this -%can be changed (see -%\autoref{sec:glsdisplay}). +%can be changed (see \sectionref{sec:glsdisplay}). +% % %The first optional argument \meta{options} is the same as the optional %argument to \ics{glslink}. As with \cs{glslink}, these commands also @@ -2261,7 +2278,7 @@ % %Note that \cs{glslink} doesn't use or affect the \firstuseflag, %nor does it use \ics{glsdisplay} or \ics{glsdisplayfirst} (see -%\autoref{sec:glsdisplay}). Instead, you can use: +%\sectionref{sec:glsdisplay}). Instead, you can use: %\begin{definition}[\DescribeMacro{\glsdisp}] %\cs{glsdisp}\oarg{options}\marg{label}\marg{link text} %\end{definition} @@ -2354,12 +2371,13 @@ %\begin{definition}[\DescribeMacro{\glsname}] %\cs{glsname}\oarg{options}\marg{label}\oarg{insert} %\end{definition} -%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 -%\hyperlink{sanitize}{sanitization} of the \gloskey{name} key and protect fragile commands. +%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 +%\hyperlink{sanitize}{sanitization} of the \gloskey{name} key and +%protect fragile commands. % %There are also analogous commands: %\begin{definition}[\DescribeMacro{\Glsname}] @@ -2375,12 +2393,13 @@ %\begin{definition}[\DescribeMacro{\glssymbol}] %\cs{glssymbol}\oarg{options}\marg{label}\oarg{insert} %\end{definition} -%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 -%\hyperlink{sanitize}{sanitization} of the \gloskey{symbol} key and protect fragile commands. +%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 +%\hyperlink{sanitize}{sanitization} of the \gloskey{symbol} key and +%protect fragile commands. % %There are also analogous commands: %\begin{definition}[\DescribeMacro{\Glssymbol}] @@ -2396,13 +2415,13 @@ %\begin{definition}[\DescribeMacro{\glsdesc}] %\cs{glsdesc}\oarg{options}\marg{label}\oarg{insert} %\end{definition} -%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 -%\hyperlink{sanitize}{sanitization} of the \gloskey{description} key and protect fragile commands. +%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 \hyperlink{sanitize}{sanitization} of the +%\gloskey{description} key and protect fragile commands. % %There are also analogous commands: %\begin{definition}[\DescribeMacro{\Glsdesc}] @@ -2479,18 +2498,19 @@ %\end{definition} % % +% %\subsubsection{Changing the format of the link text} %\label{sec:glsdisplay} % %The format of the \term{link text} for \ics{gls}, \ics{glspl} %and their uppercase variants is governed by two commands: %\begin{definition}[\DescribeMacro{\glsdisplayfirst}] -%\cs{glsdisplayfirst} +%\cs{glsdisplayfirst}\marg{first/first plural}\marg{description}\marg{symbol}\marg{insert} %\end{definition} %which is used the %first time a glossary entry is used\ifirstuse\ in the text and %\begin{definition}[\DescribeMacro{\glsdisplay}] -%\cs{glsdisplay} +%\cs{glsdisplay}\marg{text/plural}\marg{description}\marg{symbol}\marg{insert} %\end{definition} %which is used subsequently. %Both commands take four arguments: the first is either the singular or @@ -2508,11 +2528,13 @@ %The remaining arguments are ignored. % %If required, you can access the label for the given entry via -%\DescribeMacro{\glslabel}\ics{glslabel}, so it is possible to use -%this label in the definition of \cs{glsdisplay} or -%\cs{glsdisplayfirst} to supply additional information using any of -%the commands described in -%\autoref{sec:glsnolink}, if required. +%\begin{definition}[\DescribeMacro{\glslabel}] +%\cs{glslabel} +%\end{definition} +%so it is possible to use this label in the definition of +%\cs{glsdisplay} or \cs{glsdisplayfirst} to supply additional +%information using any of the commands described in +%\sectionref{sec:glsnolink}, if required. % %Note that \cs{glsdisplay} and \cs{glsdisplayfirst} are not used %by \ics{glslink}. If you want to supply your own link text, you @@ -2526,15 +2548,15 @@ %symbol={km}} %\end{verbatim} %and now suppose you want \verb|\gls{distance}| to produce -%\dq{distance (km)} on \firstuse, then you can redefine +%\qt{distance (km)} on \firstuse, then you can redefine %\cs{glsdisplayfirst} as follows: %\begin{verbatim} %\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} %\end{verbatim} %Note that the additional text is placed after \verb|#1|, so -%\verb|\gls{distance}['s]| will produce \dq{distance's (km)} -%rather than \dq{distance (km)'s} which looks a bit odd (even though -%it may be in the context of \dq{the distance (km) is measured between +%\verb|\gls{distance}['s]| will produce \qt{distance's (km)} +%rather than \qt{distance (km)'s} which looks a bit odd (even though +%it may be in the context of \qt{the distance (km) is measured between %the two points} --- but in this instance it would be better not to %use a contraction). % @@ -2544,7 +2566,7 @@ %\renewcommand{\glstextformat}[1]{\textbf{#1}} %\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} %\end{verbatim} -%then \verb|\gls{distance}| will produce \dq{\textbf{distance (km)}}. +%then \verb|\gls{distance}| will produce \qt{\textbf{distance (km)}}. % %If you have multiple glossaries, changing \cs{glsdisplayfirst} and %\cs{glsdisplay} will change the way entries for all of the @@ -2572,31 +2594,32 @@ % %For example, suppose you have created a new glossary called %\texttt{notation} and you want to change the way the entry is -%displayed on \firstuse\ so that it includes the symbol, you can -%do: +%displayed on \firstuse\ so that it includes the symbol, you can do: %\begin{verbatim} %\defglsdisplayfirst[notation]{#1#4 (denoted #3)} %\end{verbatim} %Now suppose you have defined an entry as follows: %\begin{verbatim} %\newglossaryentry{set}{type=notation, -%name=set, -%description={A collection of objects}, -%symbol={$S$} +% name=set, +% description={A collection of objects}, +% symbol={$S$} %} %\end{verbatim} -%The first time you reference this entry using \cs{gls} it -%will be displayed as: \dq{set (denoted $S$)} (similarly for \cs{glspl} and the uppercase variants). +%The first time you reference this entry it will be displayed as: +%\qt{set (denoted $S$)} (assuming \ics{gls} was used). % %Remember that if you use the \gloskey{symbol} key, you need to use a -%glossary style that displays the symbol, as many of the styles ignore -%it. In addition, if you want either the description or symbol to appear -%in the \term{link text}, you will have to disable the -%\hyperlink{sanitize}{sanitization} of these keys and protect fragile commands. +%glossary style that displays the symbol, as many of the styles +%ignore it. In addition, if you want either the description or symbol +%to appear in the \term{link text}, you will have to disable the +%\hyperlink{sanitize}{sanitization} of these keys and protect fragile +%commands. +% %\subsubsection{Enabling and disabling hyperlinks to glossary entries} % -%If you load the \isty{hyperref} or \isty{html} packages prior to -%loading the \sty{glossaries} package, commands such as \ics{glslink} +%If you load the \sty{hyperref} or \sty{html} packages prior to +%loading the \styfmt{glossaries} package, commands such as \ics{glslink} %and \ics{gls}, described above, will automatically have hyperlinks %to the relevant glossary entry, unless the \gloskey[glslink]{hyper} %option has been set to \texttt{false}. You can disable or enable links using: @@ -2610,13 +2633,14 @@ %respectively. The effect can be localised by placing the commands %within a group. Note that you should only use \cs{glsenablehyper} %if the commands \ics{hyperlink} and \ics{hypertarget} have been -%defined (for example, by the \isty{hyperref} package). +%defined (for example, by the \sty{hyperref} package). % %You can disable just the first use links using the package %option \pkgopt[false]{hyperfirst}. Note that this option only %affects commands that recognise the \firstuse\ flag, for example %\ics{gls}, \ics{glspl} and \ics{glsdisp} but not \ics{glslink}. % +% %\subsection{Adding an Entry to the Glossary Without Generating Text} %\label{sec:glsadd} % @@ -2653,6 +2677,7 @@ %\glsaddall[types={\acronymtype,notation}] %\end{verbatim} % +% %\subsection{Cross-Referencing Entries} %\label{sec:crossref} % @@ -2668,31 +2693,28 @@ %\end{verbatim} %Note that with this method, if you don't use the %cross-referenced term in the glossary, you will need two runs of -%\appname{makeglossaries}: -%\begin{verbatim} +%\app{makeglossaries}: +%\begin{prompt} %latex filename %makeglossaries filename %latex filename %makeglossaries filename %latex filename -%\end{verbatim} +%\end{prompt} % -%\item As described in \autoref{sec:newglosentry}, -%you can use the \gloskey{see} key when you define the entry. For -%example: +%\item As described in \sectionref{sec:newglosentry}, you can use the +%\gloskey{see} key when you define the entry. For example: %\begin{verbatim} %\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, -%description={Series expansion}, -%see={TaylorsTheorem}} +%description={Series expansion}, see={TaylorsTheorem}} %\end{verbatim} %Note that in this case, the entry with the \gloskey{see} key will %automatically be added to the glossary, but the cross-referenced %entry won't. You therefore need to ensure that you use the -%cross-referenced term with the commands described in -%\autoref{sec:glslink} or \autoref{sec:glsadd}. +%cross-referenced term with the commands described in +%\sectionref{sec:glslink} or \sectionref{sec:glsadd}. % -% -%You can optionally override the \dq{see} tag using square brackets +%You can optionally override the \qt{see} tag using square brackets %at the start of the \gloskey{see} value. For example: %\begin{verbatim} %\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, @@ -2706,7 +2728,7 @@ %\end{definition} %where \meta{xr label list} is a comma-separated list of entry %labels to be cross-referenced, \meta{label} is the label of the -%entry doing the cross-referencing and \meta{tag} is the \dq{see} tag. +%entry doing the cross-referencing and \meta{tag} is the \qt{see} tag. %For example: %\begin{verbatim} %\glssee[see also]{series}{FourierSeries,TaylorsTheorem} @@ -2719,16 +2741,17 @@ %In both cases~2 and 3 above, the cross-referenced information appears %in the \term{number list}, whereas in case~1, the cross-referenced %information appears in the description. In cases~2 and~3, the -%default text for the \dq{see} tag is given by \ics{seename}. +%default text for the \qt{see} tag is given by \ics{seename}. +% % %\subsection{Using Glossary Terms Without Links} %\label{sec:glsnolink} % %The commands described in this section display entry details without -%adding any information to the glossary. They don't use -%\cs{glstextformat}, they don't have any optional arguments, -%they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce -%hyperlinks. +%adding any information to the glossary. They don't use +%\cs{glstextformat}, they don't have any optional arguments, they +%don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, +%they don't produce hyperlinks. %\begin{definition}[\DescribeMacro{\glsentryname}] %\cs{glsentryname}\marg{label} %\end{definition} @@ -2736,7 +2759,7 @@ %\cs{Glsentryname}\marg{label} %\end{definition} %These commands display the name of the glossary entry given by -%\meta{label}, as specified by the \gloskey{name} key. +%\meta{label}, as specified by the \gloskey{name} key. %\cs{Glsentryname} makes the first letter uppercase. %\begin{definition}[\DescribeMacro{\glsentrytext}] %\cs{glsentrytext}\marg{label} @@ -2744,8 +2767,8 @@ %\begin{definition}[\DescribeMacro{\Glsentrytext}] %\cs{Glsentrytext}\marg{label} %\end{definition} -%These commands display the subsequent use text for the glossary entry -%given by \meta{label}, as specified by the \gloskey{text} key. +%These commands display the subsequent use text for the glossary +%entry given by \meta{label}, as specified by the \gloskey{text} key. %\cs{Glsentrytext} makes the first letter uppercase. %\begin{definition}[\DescribeMacro{\glsentryplural}] %\cs{glsentryplural}\marg{label} @@ -2753,17 +2776,18 @@ %\begin{definition}[\DescribeMacro{\Glsentryplural}] %\cs{Glsentryplural}\marg{label} %\end{definition} -%These commands display the subsequent use plural text for the glossary -%entry given by \meta{label}, as specified by the \gloskey{plural} key. -%\cs{Glsentryplural} makes the first letter uppercase. +%These commands display the subsequent use plural text for the +%glossary entry given by \meta{label}, as specified by the +%\gloskey{plural} key. \cs{Glsentryplural} makes the first letter +%uppercase. %\begin{definition}[\DescribeMacro{\glsentryfirst}] %\cs{glsentryfirst}\marg{label} %\end{definition} %\begin{definition}[\DescribeMacro{\Glsentryfirst}] %\cs{Glsentryfirst}\marg{label} %\end{definition} -%These commands display the \firstusetext\ for the glossary entry -%given by \meta{label}, as specified by the \gloskey{first} key. +%These commands display the \firstusetext\ for the glossary entry +%given by \meta{label}, as specified by the \gloskey{first} key. %\cs{Glsentryfirst} makes the first letter uppercase. %\begin{definition}[\DescribeMacro{\glsentryfirstplural}] %\cs{glsentryfirstplural}\marg{label} @@ -2771,9 +2795,9 @@ %\begin{definition}[\DescribeMacro{\Glsentryfirstplural}] %\cs{Glsentryfirstplural}\marg{label} %\end{definition} -%These commands display the plural form of the \firstusetext\ for the -%glossary entry given by \meta{label}, as specified by the -%\gloskey{firstplural} key. \cs{Glsentryfirstplural} makes the first +%These commands display the plural form of the \firstusetext\ for the +%glossary entry given by \meta{label}, as specified by the +%\gloskey{firstplural} key. \cs{Glsentryfirstplural} makes the first %letter uppercase. %\begin{definition}[\DescribeMacro{\glsentrydesc}] %\cs{glsentrydesc}\marg{label} @@ -2781,17 +2805,17 @@ %\begin{definition}[\DescribeMacro{\Glsentrydesc}] %\cs{Glsentrydesc}\marg{label} %\end{definition} -%These commands display the description for the glossary entry given by -%\meta{label}. \cs{Glsentrydesc} makes the first letter uppercase. +%These commands display the description for the glossary entry given +%by \meta{label}. \cs{Glsentrydesc} makes the first letter uppercase. %\begin{definition}[\DescribeMacro{\glsentrydescplural}] %\cs{glsentrydescplural}\marg{label} %\end{definition} %\begin{definition}[\DescribeMacro{\Glsentrydescplural}] %\cs{Glsentrydescplural}\marg{label} %\end{definition} -%These commands display the plural description for the glossary entry -%given by \meta{label}. \cs{Glsentrydescplural} makes the first letter -%uppercase. +%These commands display the plural description for the glossary entry +%given by \meta{label}. \cs{Glsentrydescplural} makes the first +%letter uppercase. %\begin{definition}[\DescribeMacro{\glsentrysymbol}] %\cs{glsentrysymbol}\marg{label} %\end{definition} @@ -2806,8 +2830,9 @@ %\begin{definition}[\DescribeMacro{\Glsentrysymbolplural}] %\cs{Glsentrysymbolplural}\marg{label} %\end{definition} -%These commands display the plural symbol for the glossary entry given by -%\meta{label}. \cs{Glsentrysymbolplural} makes the first letter uppercase. +%These commands display the plural symbol for the glossary entry +%given by \meta{label}. \cs{Glsentrysymbolplural} makes the first +%letter uppercase. %\begin{definition}[\DescribeMacro{\glsentryuseri}] %\cs{glsentryuseri}\marg{label} %\end{definition} @@ -2844,8 +2869,8 @@ %\begin{definition}[\DescribeMacro{\Glsentryuservi}] %\cs{Glsentryuservi}\marg{label} %\end{definition} -%These commands display the value of the user keys for the glossary entry given by -%\meta{label}. +%These commands display the value of the user keys for the glossary +%entry given by \meta{label}. %\begin{definition}[\DescribeMacro{\glshyperlink}] %\cs{glshyperlink}\oarg{link text}\marg{label} %\end{definition} @@ -2856,28 +2881,33 @@ %using the optional argument. %\begin{important} %If you use \cs{glshyperlink}, you need to ensure that the relevant -%entry has been added to the glossary using any of the -%commands described in \autoref{sec:glslink} or \autoref{sec:glsadd} otherwise you will end up with a broken -%link. +%entry has been added to the glossary using any of the commands +%described in \sectionref{sec:glslink} or \sectionref{sec:glsadd} +%otherwise you will end up with a broken link. %\end{important} % -%For further information see \autoref{sec:code:glsnolink}. +%For further information see \ifpdf +%\sectionref{sec:code:glsnolink}\else the section \qt{Displaying +%entry details without adding information to the glossary} in the +%document \url{glossaries.pdf}\fi. +% % %\subsection{Displaying a glossary} %\label{sec:printglossary} % -%\DescribeMacro{\printglossaries} -%The command \cs{printglossaries} will display all the -%glossaries in the order in which they were defined. -%Note that no glossaries will appear until -%you have either used the Perl script \appname{makeglossaries} -%or have directly used \appname{makeindex} or \appname{xindy} (as -%described in -%\autoref{sec:makeglossaries}). If the glossary +%The command +%\begin{definition}[\DescribeMacro{\printglossaries}] +%\cs{printglossaries} +%\end{definition} +%will display all the glossaries in the order in which they were +%defined. Note that no glossaries will appear until you have either +%used the Perl script \app{makeglossaries} or have directly used +%\app{makeindex} or \app{xindy} (as described in +%\sectionref{sec:makeglossaries}). If the glossary %still does not appear after you re-\LaTeX\ your document, check the -%\appname{makeindex}/\appname{xindy} log files to see if there is a -%problem. Remember that you also need to use the command -%\ics{makeglossaries} in the preamble to enable the glossaries. +%\app{makeindex}/\app{xindy} log files to see if there is a problem. +%Remember that you also need to use the command \ics{makeglossaries} +%in the preamble to enable the glossaries. % %An individual glossary can be displayed using: %\begin{definition}[\DescribeMacro{\printglossary}] @@ -2910,7 +2940,8 @@ %whether to use a numbered section for this glossary, overriding %the effect of the \pkgopt{numberedsection} package option. This %key has the same syntax as the \pkgopt{numberedsection} package -%option, described in \autoref{sec:pkgopts}. +%option, described in \sectionref{sec:pkgopts}. +% %\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option %of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist %is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is @@ -2919,10 +2950,23 @@ % %\end{description} % -%\DescribeMacro{\glossarypreamble} +%By default, the glossary is started either by \cs{chapter*} or by +%\cs{section*}, depending on whether or not \cs{chapter} is defined. +%This can be overridden by the \pkgopt{section} package option or the +%\cs{setglossarysection} command. Numbered sectional units can be +%obtained using the \pkgopt{numberedsection} package option. Each +%glossary sets the page header via the command \ics{glossarymark}. If +%this mechanism is unsuitable for your chosen class file or page +%style package, you will need to redefine \ics{glossarymark}. Further +%information about these options and commands is given in +%\sectionref{sec:pkgopts}. +% %Information can be added to the start of the glossary (after the %title and before the main body of the glossary) by redefining -%\cs{glossarypreamble}. For example: +%\begin{definition}[\DescribeMacro{\glossarypreamble}] +%\cs{glossarypreamble} +%\end{definition} +%For example: %\begin{verbatim} %\renewcommand{\glossarypreamble}{Numbers in italic indicate %primary definitions.} @@ -2951,24 +2995,30 @@ %(Note that \cs{gdef} is required as the glossary is placed within %a group.) % -%\DescribeMacro{\glossarypostamble}There is an analogous command -%called \cs{glossarypostamble} which is placed at the end of each -%glossary. +%There is an analogous command called +%\begin{definition}[\DescribeMacro{\glossarypostamble}] +%\cs{glossarypostamble} +%\end{definition} +%which is placed at the end of each glossary. +% %\subsubsection{Changing the way the entry name appears in the glossary} %\label{sec:glsnamefont} % -%\DescribeMacro{\glsnamefont}Within each glossary, each entry name is -%formatted according to \cs{glsnamefont} which takes one argument: -%the entry name. This command is always used regardless of the -%glossary style. By default, \cs{glsnamefont} simply displays its -%argument in whatever the surrounding font happens to be. This means -%that in the list-like glossary styles (defined in the -%\isty{glossary-list} style file) the name will appear in bold, since -%the name is placed in the optional argument of \cs{item}, whereas in -%the tabular styles (defined in the \isty{glossary-long} and -%\isty{glossary-super} style files) the name will appear in the -%normal font. The hierarchical glossary styles (defined in the -%\isty{glossary-tree} style file) also set the name in bold. +%Within each glossary, each entry name is formatted according to +%\begin{definition}[\DescribeMacro{\glsnamefont}] +%\cs{glsnamefont}\marg{name} +%\end{definition} +%which takes one argument: the entry name. This command is always +%used regardless of the glossary style. By default, \cs{glsnamefont} +%simply displays its argument in whatever the surrounding font +%happens to be. This means that in the list-like glossary styles +%(defined in the \sty{glossary-list} style file) the name will appear +%in bold, since the name is placed in the optional argument of +%\cs{item}, whereas in the tabular styles (defined in the +%\sty{glossary-long} and \sty{glossary-super} style files) the name +%will appear in the normal font. The hierarchical glossary styles +%(defined in the \sty{glossary-tree} style file) also set the name in +%bold. % %For example, suppose you want all the entry names to appear in %medium weight small caps, then you can do: @@ -2976,24 +3026,25 @@ %\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} %\end{verbatim} % +% %\subsubsection{Xindy} %\label{sec:xindy} % -%If you want to use \appname{xindy} to sort the glossary, you +%If you want to use \app{xindy} to sort the glossary, you %must use the package option \pkgopt{xindy}: %\begin{verbatim} %\usepackage[xindy]{glossaries} %\end{verbatim} %This ensures that the glossary information is written in -%\appname{xindy} syntax. +%\app{xindy} syntax. % -%Section~\ref{sec:makeglossaries} covers how to use the external +%\sectionref{sec:makeglossaries} covers how to use the external %indexing application. This section covers the commands provided -%by the \sty{glossaries} package that allow you to adjust the -%\appname{xindy} style file (\filetype{.xdy}) and parameters. +%by the \styfmt{glossaries} package that allow you to adjust the +%\app{xindy} style file (\filetype{.xdy}) and parameters. % -%To assist writing information to the \appname{xindy} style -%file, the \sty{glossaries} package provides the following +%To assist writing information to the \app{xindy} style +%file, the \styfmt{glossaries} package provides the following %commands: %\begin{definition}[\DescribeMacro{\glsopenbrace}] %\cs{glsopenbrace} @@ -3006,7 +3057,7 @@ %when written to a file.) % %In addition, if you are using a package that makes the double -%quote character active (e.g. \isty{ngerman}) you can use: +%quote character active (e.g. \sty{ngerman}) you can use: %\begin{definition}[\DescribeMacro{\glsquote}] %\cs{glsquote}\marg{text} %\end{definition} @@ -3015,23 +3066,23 @@ %This document assumes that the double quote character has not been %made active, so the examples just use \verb|"| for clarity. % -%If you want greater control over the \appname{xindy} style file than -%is available through the \LaTeX\ commands provided by the -%\sty{glossaries} package, you will need to edit the \appname{xindy} -%style file. In -%which case, you must use \ics{noist} to prevent the style file from -%being overwritten by the \sty{glossaries} package. For additional -%information about \appname{xindy}, read the \appname{xindy} -%documentation. +%If you want greater control over the \app{xindy} style file than is +%available through the \LaTeX\ commands provided by the +%\styfmt{glossaries} package, you will need to edit the \app{xindy} +%style file. In which case, you must use \ics{noist} to prevent the +%style file from being overwritten by the \styfmt{glossaries} +%package. For additional information about \app{xindy}, read the +%\app{xindy} documentation. +% %\paragraph{Language and Encodings} -%When you use \appname{xindy}, you need to specify the language +%When you use \app{xindy}, you need to specify the language %and encoding used (unless you have written your own custom -%\appname{xindy} style file that defines the relevant alphabet -%and sort rules). If you use \appname{makeglossaries}, +%\app{xindy} style file that defines the relevant alphabet +%and sort rules). If you use \app{makeglossaries}, %this information is obtained from the document's auxiliary -%(\filetype{.aux}) file. The \sty{glossaries} package attempts to +%(\filetype{.aux}) file. The \styfmt{glossaries} package attempts to %find the root language, but in the event that it gets it wrong or if -%\appname{xindy} doesn't support that language, then you can +%\app{xindy} doesn't support that language, then you can %specify the language using: %\begin{definition}[\DescribeMacro{\GlsSetXdyLanguage}] %\cs{GlsSetXdyLanguage}\oarg{glossary type}\marg{language} @@ -3043,7 +3094,7 @@ %setting will only be applied to the glossary given by %\meta{glossary type}. % -%If the \isty{inputenc} package is used, the encoding will be +%If the \sty{inputenc} package is used, the encoding will be %obtained from the value of \ics{inputencodingname}. %Alternatively, you can specify the encoding using: %\begin{definition}[\DescribeMacro{\GlsSetXdyCodePage}] @@ -3062,7 +3113,7 @@ %\usepackage[xindy={language=english,codepage=utf8}]{glossaries} %\end{verbatim} % -%If you write your own custom \appname{xindy} style file that +%If you write your own custom \app{xindy} style file that %includes the language settings, you need to set the language %to nothing: %\begin{verbatim} @@ -3073,17 +3124,18 @@ % %\begin{important} %The commands \cs{GlsSetXdyLanguage} and \cs{GlsSetXdyCodePage} -%have no effect if you don't use \appname{makeglossaries}. If -%you call \appname{xindy} without \appname{makeglossaries} you +%have no effect if you don't use \app{makeglossaries}. If +%you call \app{xindy} without \app{makeglossaries} you %need to remember to set the language and encoding using the %\texttt{-L} and \texttt{-C} switches. %\end{important} % +% %\paragraph{Locations and Number lists} % %The most likely attributes used in the \gloskey[glslink]{format} %key (\locfmt{textrm}, \locfmt{hyperrm} etc) are automatically added -%to the \appname{xindy} style file, but if you want to use another +%to the \app{xindy} style file, but if you want to use another %attribute, you need to add it using: %\begin{definition}[\DescribeMacro{\GlsAddXdyAttribute}] %\cs{GlsAddXdyAttribute}\marg{name} @@ -3095,7 +3147,7 @@ %\begin{verbatim} %\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} %\end{verbatim} -%but with \appname{xindy}, I also need to add this as an allowed +%but with \app{xindy}, I also need to add this as an allowed %attribute: %\begin{verbatim} %\GlsAddXdyAttribute{hyperbfit} @@ -3113,7 +3165,7 @@ %you need to add a location style in the appropriate format. % %For example, suppose you want the page numbers written as words -%rather than digits and you use the \isty{fmtcount} package to +%rather than digits and you use the \sty{fmtcount} package to %do this. You can redefine \ics{thepage} as follows: %\begin{verbatim} %\renewcommand*{\thepage}{\Numberstring{page}} @@ -3128,7 +3180,7 @@ %\end{verbatim} %Note that it's necessary to use \cs{space} to indicate that %spaces also appear in the format, since, unlike \TeX, -%\appname{xindy} doesn't ignore spaces after control sequences. +%\app{xindy} doesn't ignore spaces after control sequences. % %\begin{important} %Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is @@ -3137,31 +3189,26 @@ %\cs{GlsAddXdyLocation} must be used before \ics{makeglossaries}. %\end{important} % -%In the \term{number list}, the locations are sorted according to -%type. The default ordering is: -%\texttt{roman-page-numbers} (e.g.\ i), -%\texttt{arabic-page-numbers} (e.g.\ 1), -%\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor -%is a full stop or 1-1 if the compositor is a hyphen\footnote{see -%\ics{setCompositor} described in -%\autoref{sec:newglosentry}}), -%\texttt{alpha-page-numbers} (e.g.\ a), -%\texttt{Roman-page-numbers} (e.g.\ I), -%\texttt{Alpha-page-numbers} (e.g.\ A), -%\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor -%is a full stop or A-1 if the Alpha compositor is a -%hyphen\footnote{see \ics{setAlphaCompositor} described in -%\autoref{sec:newglosentry}}), -%user defined location names (as specified by -%\ics{GlsAddXdyLocation} in the order in which they were defined), -%\texttt{see} (cross-referenced entries). -%This ordering can be changed using: +%In the \term{number list}, the locations are sorted according to +%type. The default ordering is: \texttt{roman-page-numbers} (e.g.\ +%i), \texttt{arabic-page-numbers} (e.g.\ 1), +%\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor is a +%full stop or 1-1 if the compositor is a hyphen\footnote{see +%\ics{setCompositor} described in \sectionref{sec:newglosentry}}), +%\texttt{alpha-page-numbers} (e.g.\ a), \texttt{Roman-page-numbers} +%(e.g.\ I), \texttt{Alpha-page-numbers} (e.g.\ A), +%\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor is +%a full stop or A-1 if the Alpha compositor is a hyphen\footnote{see +%\ics{setAlphaCompositor} described in +%\sectionref{sec:newglosentry}}), user defined location names (as +%specified by \ics{GlsAddXdyLocation} in the order in which they were +%defined), \texttt{see} (cross-referenced entries). This ordering can +%be changed using: %\begin{definition}[\DescribeMacro{\GlsSetXdyLocationClassOrder}] %\cs{GlsSetXdyLocationClassOrder}\marg{location names} %\end{definition} %where each location name is delimited by double quote marks and -%separated by white space. -%For example: +%separated by white space. For example: %\begin{verbatim} %\GlsSetXdyLocationClassOrder{ % "arabic-page-numbers" @@ -3195,7 +3242,7 @@ %\GlsSetXdyMinRangeLength{3} %\end{verbatim} %The argument may also be the keyword \texttt{none}, to indicate that -%there should be no range formations. See the \appname{xindy} +%there should be no range formations. See the \app{xindy} %manual for further details on range formations. % %\begin{important} @@ -3206,11 +3253,12 @@ %\ics{makeglossaries}. %\end{important} % -%See \autoref{sec:numberlists} for further details. +%See \sectionref{sec:numberlists} for further details. +% % %\paragraph{Glossary Groups} %The glossary is divided into groups according to the first -%letter of the sort key. The \sty{glossaries} package also adds +%letter of the sort key. The \styfmt{glossaries} package also adds %a number group by default, unless you suppress it in the %\pkgopt{xindy} package option. For example: %\begin{verbatim} @@ -3220,7 +3268,7 @@ %number group is placed in the default group. % %If you have a number group, the default behaviour is to locate -%it before the \dq{A} letter group. If you are not using a +%it before the \qt{A} letter group. If you are not using a %Roman alphabet, you can change this using\\[10pt] %\cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} % @@ -3232,6 +3280,7 @@ %\ics{makeglossaries}. %\end{important} % +% %\subsection{Defining New Glossaries} %\label{sec:newglossary} % @@ -3239,15 +3288,16 @@ %\begin{definition}[\DescribeMacro{\newglossary}] %\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\oarg{counter} %\end{definition} -%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 \autoref{sec:numberlists}). The first optional argument specifies the extension for the -%\appname{makeindex} or \appname{xindy} transcript file (this -%information is only used by \appname{makeglossaries} which picks up -%the information from the auxiliary file). +%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 +%\sectionref{sec:numberlists}). The first optional argument specifies +%the extension for the \app{makeindex} or \app{xindy} transcript file +%(this information is only used by \app{makeglossaries} which picks +%up the information from the auxiliary file). % %Note that the main (default) glossary is automatically created as: %\begin{verbatim} @@ -3274,35 +3324,36 @@ %ensure that the relevant output files are opened. %\end{important} % +% %\subsection{Acronyms} %\label{sec:acronyms} % -%You may have noticed in \autoref{sec:newglosentry} that when you specify a new entry, you can specify alternate text to use when -%the term is first used\ifirstuse\ in the document. This provides a useful -%means to define acronyms. For convenience, the \sty{glossaries} package -%defines the command: +%You may have noticed in \sectionref{sec:newglosentry} that when you +%specify a new entry, you can specify alternate text to use when the +%term is first used\ifirstuse\ in the document. This provides a +%useful means to define acronyms. For convenience, the +%\styfmt{glossaries} package defines the command: %\begin{definition}[\DescribeMacro{\newacronym}] -%\cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long} +%\cs{newacronym}\oarg{key-val +%list}\marg{label}\marg{abbrv}\marg{long} %\end{definition} -%By default, this is equivalent to:\vskip5pt -%\begin{ttfamily}\par\noindent -%\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype},\\ -%name=\textrm{\marg{abbrv}},\\ -%description=\textrm{\marg{long}},\\ -%text=\textrm{\marg{abbrv}},\\ -%first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\},\\ -%plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\},\\ -%firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} -%(\textrm{\meta{abbrv}}\cs{glspluralsuffix})\},\\ -%\textrm{\meta{key-val list}}\}\par -%\end{ttfamily} -%\vskip5pt -%As mentioned in the previous section, the command \ics{acronymtype} -%is the name of the glossary in which the acronyms should appear. If -%the \pkgopt{acronym} package option has been used, this will be -%\texttt{acronym}, otherwise it will be \texttt{main}. The acronyms -%can then be used in exactly the same way as any other glossary -%entry. If you want more than one list of acronyms, you must +%By default, this is equivalent to: +%\begin{display}\ttfamily +%\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype}, +%name=\textrm{\marg{abbrv}}, +%description=\textrm{\marg{long}}, +%text=\textrm{\marg{abbrv}}, +%first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\}, +%plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\}, +%firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space} (\textrm{\meta{abbrv}}\cs{glspluralsuffix})\}, +%\textrm{\meta{key-val list}}\} +%\end{display} +%As mentioned in the previous section, the command +%\ics{acronymtype} is the name of the glossary in which the acronyms +%should appear. If the \pkgopt{acronym} package option has been used, +%this will be \texttt{acronym}, otherwise it will be \texttt{main}. +%The acronyms can then be used in exactly the same way as any other +%glossary entry. If you want more than one list of acronyms, you must %identify the others using the package options \pkgopt{acronymlists}. %This ensures that options such as \pkgopt{footnote} and %\pkgopt{smallcaps} work for the additional lists of acronyms. @@ -3310,10 +3361,11 @@ %\begin{important}% %\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 +%\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| in the optional argument to -%\ics{newacronym}. See \autoref{sec:loadglsentries}.\end{important} +%\ics{newacronym}. See \sectionref{sec:loadglsentries}. +%\end{important} % %For example, the following defines the acronym IDN: %\begin{verbatim} @@ -3329,20 +3381,30 @@ %plural={IDNs}, %firstplural={identification numbers (IDNs)}} %\end{verbatim} -%so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on -%\firstuse\ and \dq{IDN} on subsequent uses. +%so \verb|\gls{idn}| will produce \qt{identification number (IDN)} on +%\firstuse\ and \qt{IDN} on subsequent uses. % %This section describes acronyms that have been defined using -%\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} and \pkgopt{footnote}, as these -%options change the definition of \ics{newacronym} for common acronym -%formats as well as the way that the link text is displayed (see -%\autoref{sec:glsdisplay}). Likewise you should ignore the package option \pkgopt{shortcuts} -%and the new commands described in this section, -%such as \cs{acrshort}, as they vary according to the definition of -%\ics{newacronym}. +%\ics{newacronym}. If you prefer to define your acronyms using +%\ics{newglossaryentry} explicitly, then you should skip this section +%and ignore the package options: \pkgopt{smallcaps}, +%\pkgopt{smaller}, \pkgopt{description}, \pkgopt{dua} and +%\pkgopt{footnote}, as these options change the definition of +%\ics{newacronym} for common acronym formats as well as the way that +%the link text is displayed (see \sectionref{sec:glsdisplay}). +%Likewise you should ignore the package option \pkgopt{shortcuts} and +%the new commands described in this section, such as \ics{acrshort}, +%as they vary according to the definition of \ics{newacronym}. +% +%If you want to define your own custom acronym style, see +%\sectionref{sec:customacronym}. +% +%\begin{important} +%If you try using \ics{newglossaryentry} for entries in a designated +%list of acronyms in combination with any of the above named package +%options you are likely to get unexpected results such as empty +%brackets or empty footnotes. +%\end{important} % %If you use any of the package options \pkgopt{smallcaps}, %\pkgopt{smaller}, \pkgopt{description} or @@ -3372,7 +3434,7 @@ %\renewcommand*{\firstacronymfont}[1]{#1} %\renewcommand*{\acronymfont}[1]{\emph{#1}} %\end{verbatim} -%(Note that it is for this reason that the \isty{relsize} package +%(Note that it is for this reason that the \sty{relsize} package %is not automatically loaded when selecting the %\pkgopt{smaller} package option.) % @@ -3384,7 +3446,7 @@ %you should use lower case characters in \meta{abbrv}) and the %\pkgopt{smaller} option redefines \cs{acronymfont} to use %\cs{textsmaller},\footnote{you will need to load a package, such as -%\sty{relsize}, that defines \cs{textsmaller} if you use this +%\styfmt{relsize}, that defines \cs{textsmaller} if you use this %option.}\ otherwise \cs{acronymfont} simply displays its argument in %the surrounding font. % @@ -3443,7 +3505,7 @@ %\end{table} % %In case you can't remember which key stores the long or short forms -%(or their plurals) the \sty{glossaries} package provides the +%(or their plurals) the \styfmt{glossaries} package provides the %commands: %\begin{itemize} %\item\DescribeMacro{\glsshortkey}\cs{glsshortkey} @@ -3464,23 +3526,26 @@ %If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will %display: diagonal matrices (DMs). % -%Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, -%\pkgopt{footnote}, \pkgopt{dua} -%and \pkgopt{description} use \ics{defglsdisplay} and -%\ics{defglsdisplayfirst} (described in \autoref{sec:glsdisplay}) -%to change the way the link text is displayed. This means that these -%package options only work for the glossary type given by -%\cs{acronymtype}. If you have multiple lists of acronyms, you -%will need to make the appropriate changes for each additional -%glossary type. +%Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +%\pkgopt{footnote}, \pkgopt{dua} and \pkgopt{description} use +%\ics{defglsdisplay} and \ics{defglsdisplayfirst} (described in +%\sectionref{sec:glsdisplay}) to change the way the link text is +%displayed. This means that these package options only work for the +%glossary type given by \cs{acronymtype}. If you have multiple lists +%of acronyms, you will need to make the appropriate changes for each +%additional glossary type. % %\begin{description} -%\item[\pkgopt{description},\pkgopt{footnote}]\mbox{}\par When these two package options are used together, the \firstuse\ displays -%the entry as:\\[10pt] +%\item[\pkgopt{description},\pkgopt{footnote}]\ifpdf\mbox{}\par\fi +%When these two package options are used together, the \firstuse\ displays +%the entry as: +%\begin{display} %\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} -%\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\cs{acronymfont}\marg{abbrv}\meta{insert} +%\end{display} %where \meta{insert} indicates the text supplied in the final %optional argument to \cs{gls}, \cs{glspl} or their uppercase %variants. @@ -3492,16 +3557,20 @@ %be sorted according to the short form. % %Note also that when these two package options are used (in the -%given order), the \sty{glossaries} package additionally implements the +%given order), the \styfmt{glossaries} package additionally implements the %\pkgopt{sanitize} option using %\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so %remember to protect fragile commands when defining acronyms. % -%\item[\pkgopt{dua}]\mbox{}\par The \pkgopt{dua} package option always displays the expanded +%\item[\pkgopt{dua}]\ifpdf\mbox{}\par\fi +%The \pkgopt{dua} package option always displays the expanded %form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or %\pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the -%entry in the form:\\[10pt] -%\meta{long}\meta{insert}\\[10pt] +%entry in the form: +%\begin{display} +%\meta{long}\meta{insert} +%\end{display} +% %If the \pkgopt{description} package option is also used, the %\gloskey{name} key is set to the long form, otherwise the %\gloskey{name} key is set to the short form and the @@ -3516,11 +3585,16 @@ %short form (unless overridden by the \gloskey{sort} key in %the optional argument of \ics{newacronym}). % -%\item[\pkgopt{description}]\mbox{}\par This package option displays the entry on \firstuse\ as:\\[10pt] -%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] -%Note also that if this package option is used, the \sty{glossaries} +%\item[\pkgopt{description}]\ifpdf\mbox{}\par\fi +%This package option displays the entry on \firstuse\ as: +%\begin{display} +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\cs{acronymfont}\marg{abbrv}\meta{insert} +%\end{display} +%Note also that if this package option is used, the \styfmt{glossaries} %package additionally implements the option %\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so %remember to protect fragile commands when defining acronyms. @@ -3546,13 +3620,18 @@ %override this using the \gloskey{sort} key in the optional %argument to \ics{newacronym}. % -%\item[\pkgopt{footnote}]\mbox{}\par This package option displays the entry on \firstuse\ as:\\[10pt] -%\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +%\item[\pkgopt{footnote}]\ifpdf\mbox{}\par\fi +%This package option displays the entry on \firstuse\ as: +%\begin{display} +%\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\cs{acronymfont}\marg{abbrv}\meta{insert} +%\end{display} %Acronyms will be sorted according to the short form. % -%Note also that if this package option is used, the \sty{glossaries} +%Note also that if this package option is used, the \styfmt{glossaries} %package additionally implements the option %\ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so %remember to protect fragile commands when defining acronyms. @@ -3560,48 +3639,59 @@ %Note that on \firstuse, it is the long form in the footnote that %links to the relevant glossary entry (where hyperlinks are enabled), %whereas on subsequent use, the acronym links to the relevant -%glossary entry. It is possible to change this to make the acronym -%on \firstuse\ have the hyperlink instead of the footnote, but -%since the footnote marker will also be a hyperlink, you will -%have two hyperlinks in immediate succession. This can be -%ambiguous where the hyperlinks are coloured rather than boxed. -%The code required to change the \firstuse\ to make the -%acronym a hyperlink is as follows: +%glossary entry. It is possible to change this to make the acronym on +%\firstuse\ have the hyperlink instead of the footnote, but since the +%footnote marker will also be a hyperlink, you will have two +%hyperlinks in immediate succession. This can be ambiguous where the +%hyperlinks are coloured rather than boxed. The code required to +%change the \firstuse\ to make the acronym a hyperlink is as follows: %\begin{verbatim} % \defglsdisplayfirst[\acronymtype]{% % \noexpand\protect\noexpand % \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}% % \noexpand\protect\noexpand\footnote{#2}}% %\end{verbatim} -%\textbf{Note} that this involves using internal commands -%(i.e.\ commands whose name contains an \verb|@| character), so -%if this code is place in a \texttt{.tex} file it needs to be -%placed within a \cs{makeatletter} \ldots\ \cs{makeatother} pair. -%(See \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns} for further details.) -% -%\item[\pkgopt{smallcaps}]\mbox{}\par If neither the \pkgopt{footnote} nor \pkgopt{description} options -%have been set, this option displays the entry on \firstuse\ as:\\[10pt] -%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +%\textbf{Note} that this involves using internal commands (i.e.\ +%commands whose name contains an \verb|@| character), so if this code +%is place in a \texttt{.tex} file it needs to be placed within a +%\cs{makeatletter} \ldots\ \cs{makeatother} pair. (See +%\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}{\cs{@} +%and \texttt{@} in macro names} for further details.) +% +%\item[\pkgopt{smallcaps}]\ifpdf\mbox{}\par\fi +%If neither the \pkgopt{footnote} nor \pkgopt{description} options +%have been set, this option displays the entry on \firstuse\ as: +%\begin{display} +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\cs{acronymfont}\marg{abbrv}\meta{insert} +%\end{display} %where \cs{acronymfont} is set to \verb|\textsc{#1}|. % %\begin{important} %Note that since the acronym is displayed using \ics{textsc}, %the short form, \meta{abbrv}, should be specified in lower case. -%(Recall that "\textsc{abc}" produces \textsc{abc} whereas "\textsc{ABC}" produces \textsc{ABC}.) +%\ifpdf(Recall that "\textsc{abc}" produces \textsc{abc} whereas +%"\textsc{ABC}" produces \textsc{ABC}.)\fi %\end{important} % -%Note also that if this package option is used, the \sty{glossaries} +%Note also that if this package option is used, the \styfmt{glossaries} %package additionally implements the option %\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so %remember to protect fragile commands when defining acronyms. % -%\item[\pkgopt{smaller}]\mbox{}\par If neither the \pkgopt{footnote} nor \pkgopt{description} options -%have been set, this option displays the entry on \firstuse\ as:\\[10pt] -%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] +%\item[\pkgopt{smaller}]\ifpdf\mbox{}\par\fi +%If neither the \pkgopt{footnote} nor \pkgopt{description} options +%have been set, this option displays the entry on \firstuse\ as: +%\begin{display} +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv}) +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\cs{acronymfont}\marg{abbrv}\meta{insert} +%\end{display} %where \cs{acronymfont} is set to %\verb|\textsmaller{#1}|.\footnote{not that this was change from %using \ics{smaller} to \ics{textsmaller} as declarations @@ -3610,34 +3700,39 @@ % %\begin{important} %Remember to load a package that defines \ics{textsmaller} (such as -%\isty{relsize}) if you want to use this option, unless you want +%\sty{relsize}) if you want to use this option, unless you want %to redefine \ics{acronymfont} to use some other formatting command. %\end{important} % -%Note also that if this package option is used, the \sty{glossaries} +%Note also that if this package option is used, the \styfmt{glossaries} %package additionally implements the option %\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so %remember to protect fragile commands when defining acronyms. % -%\item[None of the above]\mbox{}\par If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, +%\item[None of the above]\ifpdf \mbox{}\par\fi +%If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, %\pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, -%then on \firstuse\ the entry is displayed as:\\[10pt] -%\meta{long} (\meta{abbrv})\meta{insert}\\[10pt] -%while subsequent use displays the entry as:\\[10pt] -%\meta{abbrv}\meta{insert}\\[10pt] +%then on \firstuse\ the entry is displayed as: +%\begin{display} +%\meta{long} (\meta{abbrv})\meta{insert} +%\end{display} +%while subsequent use displays the entry as: +%\begin{display} +%\meta{abbrv}\meta{insert} +%\end{display} %Entries will be sorted according to the short form. %Note that if none of the acronym-related package options are used, %the \pkgopt{sanitize} option will not be affected. %\end{description} % -%Recall from \autoref{sec:glslink} that you can access the values of individual keys using commands -%like \ics{glstext}, so it is possible to use these commands to -%print just the long form or just the abbreviation without affecting -%the flag that determines whether the entry has been used. However -%the keys that store the long and short form vary depending on -%the acronym style, so the \sty{glossaries} package provides -%commands that are set according to the package options. These are -%as follows: +%Recall from \sectionref{sec:glslink} that you can access the values +%of individual keys using commands like \ics{glstext}, so it is +%possible to use these commands to print just the long form or just +%the abbreviation without affecting the flag that determines whether +%the entry has been used. However the keys that store the long and +%short form vary depending on the acronym style, so the +%\styfmt{glossaries} package provides commands that are set according +%to the package options. These are as follows: %\begin{definition}[\DescribeMacro{\acrshort}] %\cs{acrshort}\oarg{options}\marg{label}\oarg{insert} %\end{definition} @@ -3649,8 +3744,8 @@ %\end{definition} %Print the abbreviated version with (if required) a hyperlink to the %relevant entry in the glossary. This is usually equivalent to -%\ics{glstext} (or its uppercase variants) but may additionally -%put the link text within the argument to \ics{acronymfont}. +%\ics{glstext} (or its uppercase variants) but may additionally put +%the link text within the argument to \ics{acronymfont}. %\begin{definition}[\DescribeMacro{\acrlong}] %\cs{acrlong}\oarg{options}\marg{label}\oarg{insert} %\end{definition} @@ -3662,7 +3757,7 @@ %\end{definition} %Print the long version with (if required) a hyperlink to the %relevant entry in the glossary. This is may be equivalent to -%\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase +%\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase %variants), depending on package options. %\begin{definition}[\DescribeMacro{\acrfull}] %\cs{acrfull}\oarg{options}\marg{label}\oarg{insert} @@ -3673,9 +3768,8 @@ %\begin{definition}[\DescribeMacro{\ACRfull}] %\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert} %\end{definition} -%Print the long version followed by the abbreviation in brackets -%with (if required) a hyperlink to the -%relevant entry in the glossary. +%Print the long version followed by the abbreviation in brackets with +%(if required) a hyperlink to the relevant entry in the glossary. % %\begin{important} %Note that if any of the above commands produce unexpected output @@ -3696,7 +3790,7 @@ % %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 +%an \qt{undefined control sequence} error message, check that you %have enabled the shortcuts using the \pkgopt{shortcuts} package %option. Note that there are no shortcuts for the commands that %produce all upper case text. @@ -3727,22 +3821,159 @@ %\end{center} %\end{table} % +%\subsubsection{Defining A Custom Acronym Style} +%\label{sec:customacronym} +% +%You may find that the predefined acronyms styles that come with the +%\styfmt{glossaries} package don't suit your requirements. In this +%case you can define your own style. This is done by redefining the +%following commands: +%\begin{definition}[\DescribeMacro{\CustomAcronymFields}] +%\cs{CustomAcronymFields} +%\end{definition} +%This command sets up the keys for \ics{newglossaryentry} when +%you define an acronym using \ics{newacronym}. Within the definition +%of \cs{CustomAcronymFields}, you may use \cs{the}\ics{glslongtok} to +%access the long form, \cs{the}\ics{glsshorttok} to access the short +%form and \cs{the}\ics{glslabeltok} to access the label. This command +%is typically used to set the \gloskey{name}, \gloskey{first}, +%\gloskey{firstplural}, \gloskey{text} and \gloskey{plural} keys. It +%may also be used to set the \gloskey{symbol} or +%\gloskey{description} keys depending on your requirements. +% +%\begin{definition}[\DescribeMacro{\SetCustomDisplayStyle}] +%\cs{SetCustomDisplayStyle}\marg{type} +%\end{definition} +%This is used to set up the display style for the glossary given by +%\meta{type}. This should typically just use \ics{defglsdisplayfirst} +%and \ics{defglsdisplay}. +% +%Once you have redefined \cs{CustomAcronymFields} and +%\cs{SetCustomDisplayStyle}, you must then switch to this style using +%\begin{definition}[\DescribeMacro{\SetCustomStyle}] +%\cs{SetCustomStyle} +%\end{definition} +%Note that you may still use the \pkgopt{shortcuts} package option +%with your custom style. +% +%\begin{important} +%If you omit \cs{SetCustomStyle}, or use it before you redefine +%\cs{CustomAcronymFields} and \cs{SetCustomDisplayStyle}, your new +%style won't be correctly implemented. You must set up the custom style +%before defining new acronyms. The acronyms must be defined using +%\ics{newacronym} not \ics{newglossaryentry}. +%\end{important} +% +%As an example, suppose I want my acronym on first use to have the +%short form in the text and the long form with the description in a +%footnote. Suppose also that I want the short form to be put in small +%caps in the main body of the document, but I want it in normal +%capitals in the list of acronyms. In my list of acronyms, I want the +%long form as the name with the short form in brackets followed by +%the description. +% +%First, I need to redefine \ics{CustomAcronymFields} so that +%\ics{newacronym} will correctly set the \gloskey{name}, +%\gloskey{text} and \gloskey{plural} keys. I want the long form to be +%stored in the \gloskey{name} and the short form to be stored in +%\gloskey{text}. In addition, I'm going to set the \gloskey{symbol} +%to the short form in upper case so that it will appear in the list +%of acronyms. +% +%\begin{verbatim} +%\renewcommand*{\CustomAcronymFields}{% +% name={\the\glslongtok},% +% symbol={\MakeUppercase{\the\glsshorttok}},% +% text={\textsc{\the\glsshorttok}},% +% plural={\textsc{\the\glsshorttok}s}% +%} +%\end{verbatim} +% +%Note that in this case I haven't bothered with \ics{acrpluralsuffix} +%and have just inserted an \qt{s}. +% +%When I use the custom acronym style, the short form is stored in +%\gloskey{user1}, the plural short form is stored in \gloskey{user2}, +%the long form is stored in \gloskey{user3} and the plural long form +%is stored in \gloskey{user4}. So when I use \ics{defglsdisplayfirst} +%and \ics{defglsdisplay}, I can use \ics{glsentryuseriii} to access +%the long form. Recall from \sectionref{sec:glsdisplay}, that the +%optional argument to \ics{defglsdisplayfirst} and \ics{defglsdisplay} +%indicates the glossary type. This is passed to +%\ics{SetCustomDisplayStyle}. The mandatory argument sets up the +%definition of \ics{glsdisplayfirst} and \ics{glsdisplay} for the +%given glossary, where the first argument corresponds to the +%\gloskey{first}, \gloskey{firstplural}, \gloskey{text} or +%\gloskey{plural}, as appropriate, the second argument corresponds to +%the \gloskey{description}, the third corresponds to the +%\gloskey{symbol} and the fourth argument is the inserted text. +% +%\begin{verbatim} +%\renewcommand*{\SetCustomDisplayStyle}[1]{% +% \defglsdisplayfirst[#1]{##1##4\protect\footnote{% +% \glsentryuseriii{\glslabel}: ##2% +% }} +% \defglsdisplay[#1]{##1##4}% +%} +%\end{verbatim} +% +%Since we have a definition inside a definition, \verb|#1| refers to +%the argument of \ics{SetCustomDisplayStyle}, and \verb|##1|, \ldots, +%\verb|##4|, refer to the arguments of \ics{glsdisplayfirst} and +%\ics{glsdisplay}. +% +%Now that I've redefined \ics{CustomAcronymFields} and +%\ics{SetCustomDisplayStyle}, I can set this style using +%\begin{verbatim} +%\SetCustomStyle +%\end{verbatim} +%and now I can define my acronyms: +%\begin{verbatim} +%\newacronym[description={set of tags for use in developing hypertext +%documents}]{html}{html}{Hyper Text Markup Language} +% +%\newacronym[description={language used to describe the layout of a +%document written in a markup language}]{css}{css}{Cascading Style +%Sheet} +%\end{verbatim} +% +%Note that since I've used the description in the main body of the +%text, I need to switch off the sanitization otherwise any commands +%within the description won't get interpreted. Also I want to use the +%\sty{hyperref} package, but this will cause a problem on first use +%as I'll get nested hyperlinks, so I need to switch off the +%hyperlinks on first use. In addition, I want to use a glossary style +%that displays the symbol. Therefore, in my preamble I have: +% +%\begin{verbatim} +%\usepackage[colorlinks]{hyperref} +%\usepackage[acronym, % create list of acronyms +% nomain, % don't need main glossary for this example +% style=tree, % need a style that displays the symbol +% hyperfirst=false,% don't hyperlink first use +% sanitize=none % switch off sanitization as description +% % will be used in the main text +% ]{glossaries} +%\end{verbatim} +% +%Note that I haven't used the \pkgopt{description} or +%\pkgopt{footnote} package options. % %\subsubsection{Upgrading From the glossary Package} %\label{sec:oldacronym} -%Users of the obsolete \isty{glossary} package may recall that +%Users of the obsolete \sty{glossary} package may recall that %the syntax used to define new acronyms has changed with the -%replacement \sty{glossaries} package. In addition, the old -%\isty{glossary} package created the command +%replacement \styfmt{glossaries} package. In addition, the old +%\sty{glossary} package created the command %\cs{}\meta{acr-name} when defining the acronym \meta{acr-name}. % %In order to facilitate migrating from the old package to the new -%one, the \sty{glossaries} package\footnote{as from version 1.18} +%one, the \styfmt{glossaries} package\footnote{as from version 1.18} %provides the command: %\begin{definition}[\DescribeMacro{\oldacronym}] %\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list} %\end{definition} -%This uses the same syntax as the \isty{glossary} package's +%This uses the same syntax as the \sty{glossary} package's %method of defining acronyms. It is equivalent to:\\[10pt] %\ics{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt] %In addition, \ics{oldacronym} also defines the commands @@ -3760,21 +3991,21 @@ %Recall that, in general, \LaTeX\ ignores spaces following command %names consisting of alphabetical characters. This is also true for %\cs{}\meta{label} unless you additionally load the -%\isty{xspace} package. +%\sty{xspace} package. %\end{important} % -%The \sty{glossaries} package doesn't load the \isty{xspace} package +%The \styfmt{glossaries} package doesn't load the \sty{xspace} package %since there are both advantages and disadvantages to using %\ics{xspace} in \cs{}\meta{label}. If you don't use the -%\isty{xspace} package you need to explicitly force a space using +%\sty{xspace} package you need to explicitly force a space using %\verb*|\ | (backslash space) however you can follow \cs{}\meta{label} %with additional text in square brackets (the final optional -%argument to \ics{gls}). If you use the \isty{xspace} package +%argument to \ics{gls}). If you use the \sty{xspace} package %you don't need to escape the spaces but you can't use %the optional argument to insert text (you will have to explicitly %use \ics{gls}). % -%To illustrate this, suppose I define the acronym \dq{abc} as +%To illustrate this, suppose I define the acronym \qt{abc} as %follows: %\begin{verbatim} %\oldacronym{abc}{example acronym}{} @@ -3782,19 +4013,19 @@ %This will create the command \cs{abc} and its starred version %\cs{abc*}. \Tableref{tab:xspace} illustrates the effect of %\cs{abc} (on subsequent use) according to whether or not the -%\isty{xspace} package has been loaded. As can be seen from the -%final row in the table, the \isty{xspace} package prevents the +%\sty{xspace} package has been loaded. As can be seen from the +%final row in the table, the \sty{xspace} package prevents the %optional argument from being recognised. % %\begin{table}[htbp] %\caption[The effect of using xspace]{The effect of using -%\sty{xspace} with \cs{oldacronym}} +%\styfmt{xspace} with \cs{oldacronym}} %\label{tab:xspace} %\vskip\baselineskip %\centering %\begin{tabular}{lll} -%\bfseries Code & \bfseries With \sty{xspace} & -%\bfseries Without \sty{xspace}\\ +%\bfseries Code & \bfseries With \styfmt{xspace} & +%\bfseries Without \styfmt{xspace}\\ %\verb|\abc.| & abc. & abc.\\ %\verb|\abc xyz| & abc xyz & abcxyz\\ %\verb|\abc\ xyz| & abc xyz & abc xyz\\ @@ -3805,6 +4036,7 @@ %\end{table} % % +% %\subsection{Unsetting and Resetting Entry Flags} %\label{sec:glsunset} % @@ -3857,9 +4089,10 @@ %entry has been used, \meta{true part} will be done, otherwise %\meta{false part} will be done. % +% %\subsection{Glossary Styles} %\label{sec:styles} -%The \sty{glossaries} package comes with some pre-defined +%The \styfmt{glossaries} package comes with some pre-defined %glossary styles. Note that the styles are suited to different %types of glossaries: some styles ignore the associated %symbol; some styles are not designed for hierarchical entries, @@ -3878,7 +4111,7 @@ %A maximum level of 0 indicates a flat glossary (sub-entries %are displayed in the same way as main entries). Where the maximum %level is given as --- there is no limit, but note that -%\appname{makeindex} imposes a limit of 2 sub-levels. If the +%\app{makeindex} imposes a limit of 2 sub-levels. If the %homograph column is checked, then the name is not displayed for %sub-entries. If the symbol column is checked, then the symbol will %be displayed if it has been defined.} @@ -3915,7 +4148,7 @@ %\end{definition} %Some of the glossary styles may also be set using the \pkgopt{style} %package option, it depends if the package in which they are defined -%is automatically loaded by the \sty{glossaries} package. +%is automatically loaded by the \styfmt{glossaries} package. % %The tabular-like styles that allow multi-line descriptions and page %lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} @@ -3964,25 +4197,27 @@ % \changes{1.03}{2007 July 4}{'glspostdescription added} %All the styles except for the three- and four-column styles and the %\glostyle{listdotted} style use the command -%\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 -%will need to redefine \cs{glspostdescription} before the glossary is -%displayed. Alternatively, you can suppress it for a given entry -%by placing \ics{nopostdesc} in the entry's description. +%\begin{definition}[\DescribeMacro{\glspostdescription}] +%\cs{glspostdescription} +%\end{definition} +%after the description. This simply displays a full stop by default. +%To eliminate this full stop (or replace it with something else, say, +%a comma) you will need to redefine \cs{glspostdescription} before +%the glossary is displayed. Alternatively, you can suppress it for a +%given entry by placing \ics{nopostdesc} in the entry's description. % %\subsubsection{List Styles} %\label{sec:liststyles} % %The styles described in this section are all defined in the package -%\isty{glossary-list}. Since they all use the \envname{description} +%\sty{glossary-list}. Since they all use the \env{description} %environment, they are governed by the same parameters as that %environment. These styles all ignore the entry's symbol. Note that %these styles will automatically be available unless you use the %\pkgopt{nolist} or \pkgopt{nostyles} package options. % %\begin{description} -%\item[list] The \glostyle{list} style uses the \envname{description} +%\item[list] The \glostyle{list} style uses the \env{description} %environment. The entry name is placed in the optional argument of %the \cs{item} command (so it will appear in bold by default). The %description follows, and then the associated \term{number list} for @@ -3993,15 +4228,17 @@ %\item[listgroup] The \glostyle{listgroup} style is like %\glostyle{list} but the glossary groups have headings. % -%\item[listhypergroup] The \glostyle{listhypergroup} style is like -%\glostyle{listgroup} but has a navigation line at the start of -%the glossary with links to each group that is present in the -%glossary. This requires an additional run through \LaTeX\ to ensure -%the group information is up to date. In the navigation line, each -%group is separated -%by \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which -%defaults to a vertical bar with a space on either side. For example, -%to simply have a space separating each group, do: +%\item[listhypergroup] The \glostyle{listhypergroup} style is like +%\glostyle{listgroup} but has a navigation line at the start of the +%glossary with links to each group that is present in the glossary. +%This requires an additional run through \LaTeX\ to ensure the group +%information is up to date. In the navigation line, each group is +%separated by +%\begin{definition}[\DescribeMacro{\glshypernavsep}] +%\cs{glshypernavsep} +%\end{definition} +%which defaults to a vertical bar with a space on either side. For +%example, to simply have a space separating each group, do: %\begin{verbatim} %\renewcommand*{\glshypernavsep}{\space} %\end{verbatim} @@ -4026,14 +4263,16 @@ %groups. The navigation line is the same as that for %\glostyle{listhypergroup}, described above. % -%\item[listdotted] This style uses the \envname{description} -%environment.\footnote{This style was supplied by Axel~Menzel.} Each +%\item[listdotted] This style uses the \env{description} +%environment.\footnote{This style was supplied by Axel~Menzel.} Each %entry starts with \verb|\item[]|, followed by the name followed by a %dotted line, followed by the description. Note that this style %ignores both the \term{number list} and the symbol. The length -%\DescribeMacro{\glslistdottedwidth}\cs{glslistdottedwidth} governs -%where the description should start. This is a flat style, so child -%entries are formatted in the same way as the parent entries. +%\begin{definition}[\DescribeMacro{\glslistdottedwidth}] +%\cs{glslistdottedwidth} +%\end{definition} +%governs where the description should start. This is a flat style, so +%child entries are formatted in the same way as the parent entries. % %\item[sublistdotted] This is a variation on the \glostyle{listdotted} %style designed for hierarchical glossaries. The main entries @@ -4041,23 +4280,23 @@ %the same manner as \glostyle{listdotted}. %\end{description} % +% %\subsubsection{Longtable Styles} %\label{sec:longstyles} % %The styles described in this section are all defined in the package -%\isty{glossary-long}. Since they all use the \envname{longtable} +%\sty{glossary-long}. Since they all use the \env{longtable} %environment, they are governed by the same parameters as that %environment. Note that these styles will automatically be available %unless you use the \pkgopt{nolong} or \pkgopt{nostyles} package %options. These styles fully justify the description and page list %columns. If you want ragged right formatting instead, use the -%analogous styles described in -%\autoref{sec:longraggedstyles}. +%analogous styles described in \sectionref{sec:longraggedstyles}. % % %\begin{description} -%\item[long] The \glostyle{long} style uses the \envname{longtable} -%environment (defined by the \isty{longtable} package). It has two +%\item[long] The \glostyle{long} style uses the \env{longtable} +%environment (defined by the \sty{longtable} package). It has two %columns: the first column contains the entry's name and the second %column contains the description followed by the \term{number list}. %The entry's symbol is ignored. @@ -4137,25 +4376,26 @@ %descriptions and page lists. %\end{description} % +% %\subsubsection{Longtable Styles (Ragged Right)} %\label{sec:longraggedstyles} % %The styles described in this section are all defined in the package -%\isty{glossary-longragged}. These styles are analogous to those -%defined in \isty{glossary-long} but the multiline columns are left +%\sty{glossary-longragged}. These styles are analogous to those +%defined in \sty{glossary-long} but the multiline columns are left %justified instead of fully justified. Since these styles all use the -%\envname{longtable} environment, they are governed by the same -%parameters as that environment. The \isty{glossary-longragged} -%package additionally requires the \isty{array} package. Note that +%\env{longtable} environment, they are governed by the same +%parameters as that environment. The \sty{glossary-longragged} +%package additionally requires the \sty{array} package. Note that %these styles will only be available if you explicitly load -%\isty{glossary-longragged}: +%\sty{glossary-longragged}: %\begin{verbatim} %\usepackage{glossaries} %\usepackage{glossary-longragged} %\end{verbatim} %Note that you can't set these styles using the \pkgopt{style} %package option since the styles aren't defined until after -%the \sty{glossaries} package has been loaded. +%the \styfmt{glossaries} package has been loaded. % %\begin{description} %\item[longragged] The \glostyle{longragged} style has two @@ -4223,26 +4463,25 @@ % %\end{description} % +% %\subsubsection{Supertabular Styles} %\label{sec:superstyles} % %The styles described in this section are all defined in the package -%\isty{glossary-super}. Since they all use the \envname{supertabular} +%\sty{glossary-super}. Since they all use the \env{supertabular} %environment, they are governed by the same parameters as that %environment. Note that these styles will automatically be available %unless you use the \pkgopt{nosuper} or \pkgopt{nostyles} package -%options. In general, the \envname{longtable} environment is better, +%options. In general, the \env{longtable} environment is better, %but there are some circumstances where it is better to use -%\envname{supertabular}.\footnote{e.g.\ with the \isty{flowfram} +%\env{supertabular}.\footnote{e.g.\ with the \sty{flowfram} %package.} These styles fully justify the description and page list %columns. If you want ragged right formatting instead, use the -%analogous styles described in -%\autoref{sec:superraggedstyles}. -% +%analogous styles described in \sectionref{sec:superraggedstyles}. % %\begin{description} -%\item[super] The \glostyle{super} style uses the \envname{supertabular} -%environment (defined by the \isty{supertabular} package). It has two +%\item[super] The \glostyle{super} style uses the \env{supertabular} +%environment (defined by the \sty{supertabular} package). It has two %columns: the first column contains the entry's name and the second %column contains the description followed by the \term{number list}. %The entry's symbol is ignored. @@ -4323,30 +4562,31 @@ %descriptions and page lists. %\end{description} % +% %\subsubsection{Supertabular Styles (Ragged Right)} %\label{sec:superraggedstyles} % %The styles described in this section are all defined in the package -%\isty{glossary-superragged}. These styles are analogous to those -%defined in \isty{glossary-super} but the multiline columns are left +%\sty{glossary-superragged}. These styles are analogous to those +%defined in \sty{glossary-super} but the multiline columns are left %justified instead of fully justified. Since these styles all use the -%\envname{supertabular} environment, they are governed by the same -%parameters as that environment. The \isty{glossary-superragged} -%package additionally requires the \isty{array} package. Note that +%\env{supertabular} environment, they are governed by the same +%parameters as that environment. The \sty{glossary-superragged} +%package additionally requires the \sty{array} package. Note that %these styles will only be available if you explicitly load -%\isty{glossary-superragged}: +%\sty{glossary-superragged}: %\begin{verbatim} %\usepackage{glossaries} %\usepackage{glossary-superragged} %\end{verbatim} %Note that you can't set these styles using the \pkgopt{style} %package option since the styles aren't defined until after -%the \sty{glossaries} package has been loaded. +%the \styfmt{glossaries} package has been loaded. % %\begin{description} %\item[superragged] The \glostyle{superragged} style uses the -%\envname{supertabular} environment (defined by the -%\isty{supertabular} package). It has two columns: the first column +%\env{supertabular} environment (defined by the +%\sty{supertabular} package). It has two columns: the first column %contains the entry's name and the second column contains the (left %justified) description followed by the \term{number list}. The %entry's symbol is ignored. Sub groups are separated with a blank @@ -4411,11 +4651,12 @@ % %\end{description} % +% %\subsubsection{Tree-Like Styles} %\label{sec:treestyles} % %The styles described in this section are all defined in the package -%\isty{glossary-tree}. These styles are designed for hierarchical +%\sty{glossary-tree}. These styles are designed for hierarchical %glossaries but can also be used with glossaries that don't have %sub-entries. These styles will display the entry's symbol if it %exists. Note that these styles will automatically be available @@ -4442,8 +4683,8 @@ % %\item[tree] The \glostyle{tree} style is similar to the %\glostyle{index} style except that it can have arbitrary levels. -%(Note that \appname{makeindex} is limited to three levels, so -%you will need to use \appname{xindy} if you want more than +%(Note that \app{makeindex} is limited to three levels, so +%you will need to use \app{xindy} if you want more than %three levels.) Each sub-level is indented by %\DescribeMacro{\glstreeindent}\cs{glstreeindent}. Note that the %name, symbol (if present) and description are placed in the @@ -4499,6 +4740,7 @@ %\end{description} % % +% %\subsection{Defining your own glossary style} %\label{sec:newglossarystyle} % @@ -4512,15 +4754,15 @@ %needs to redefine all of the following: % %\begin{definition}[\DescribeEnv{theglossary}] -%\envname{theglossary} +%\env{theglossary} %\end{definition} %This environment defines how the main body of the glossary should %be typeset. Note that this does not include the section heading, %the glossary preamble (defined by \cs{glossarypreamble}) or the %glossary postamble (defined by \cs{glossarypostamble}). For example, -%the \glostyle{list} style uses the \envname{description} environment, -%so the \envname{theglossary} environment is simply redefined to begin -%and end the \envname{description} environment. +%the \glostyle{list} style uses the \env{description} environment, +%so the \env{theglossary} environment is simply redefined to begin +%and end the \env{description} environment. % %\begin{definition}[\DescribeMacro{\glossaryheader}] %\cs{glossaryheader} @@ -4537,12 +4779,12 @@ %\end{definition} %This macro indicates %what to do at the start of each logical block within the main body -%of the glossary. If you use \appname{makeindex} the glossary is +%of the glossary. If you use \app{makeindex} the glossary is %sub-divided into a maximum of twenty-eight logical blocks that are %determined by the first character of the \gloskey{sort} key (or %\gloskey{name} key if the \gloskey{sort} key is omitted). The %sub-divisions are in the following order: symbols, numbers, A, -%\ldots, Z\@. If you use \appname{xindy}, the sub-divisions depend on +%\ldots, Z\@. If you use \app{xindy}, the sub-divisions depend on %the language settings. % %Note that the argument to \cs{glsgroupheading} @@ -4559,8 +4801,9 @@ %\begin{definition}[\DescribeMacro{\glsnavhypertarget}] %\cs{glsnavhypertarget}\marg{label}\marg{text} %\end{definition} -%For further details about \cs{glsnavhypertarget}, see -%\autoref{sec:code:hypernav}. +%For further details about \cs{glsnavhypertarget}, see +%\ifpdf\sectionref{sec:code:hypernav}\else the documented code of +%\sty{glossary-hypernav} in \texttt{glossaries.pdf}\fi. % % %Most of the predefined glossary styles redefine \cs{glsgroupheading} @@ -4603,7 +4846,7 @@ %\cs{glstarget}\marg{label}\marg{text} %\end{definition} %where \meta{label} is the entry's label. Note that you -%don't need to worry about whether the \isty{hyperref} package has +%don't need to worry about whether the \sty{hyperref} package has %been loaded, as \cs{glstarget} won't create a target if %\cs{hypertarget} hasn't been defined. % @@ -4645,15 +4888,17 @@ %\ics{glossaryentryfield} described above. % %For further details of these commands, see -%\autoref{sec:code:printglos}. +%\ifpdf\sectionref{sec:code:printglos}\else the documented code in +%\texttt{glossaries.pdf}\fi. +% %\subsubsection{Example: creating a completely new style} % %If you want a completely new style, you will need to redefine all %of the commands and the environment listed above. % %For example, suppose you want each entry to start with a bullet point. -%This means that the glossary should be placed in the \envname{itemize} -%environment, so \envname{theglossary} should start and end that +%This means that the glossary should be placed in the \env{itemize} +%environment, so \env{theglossary} should start and end that %environment. Let's also suppose that you don't want anything between %the glossary groups (so \ics{glsgroupheading} and \ics{glsgroupskip} %should do nothing) and suppose you don't want anything to appear @@ -4688,6 +4933,7 @@ %Note that this style creates a flat glossary, where sub-entries %are displayed in exactly the same way as the top level entries. % +% %\subsubsection{Example: creating a new glossary style based on an %existing style} % @@ -4708,6 +4954,7 @@ %} %\end{verbatim} % +% %\subsubsection{Example: creating a glossary style that uses the %\gloskey{user1}, \ldots, \gloskey{user6} keys} % @@ -4717,7 +4964,7 @@ %example, suppose each entry not only has an associated symbol, %but also units (stored in \gloskey{user1}) and dimension %(stored in \gloskey{user2}). Then you can define a glossary style -%that displays each entry in a \envname{longtable} as follows: +%that displays each entry in a \env{longtable} as follows: %\begin{verbatim} %\newglossarystyle{long6col}{% % % put the glossary in a longtable environment: @@ -4749,10 +4996,11 @@ %} %\end{verbatim} % +% %\subsection{Accessibility Support}\label{sec:accsupp} %Limited accessibility support is provided by the accompanying -%\isty{glossaries-accsupp} package, but note that this package is -%experimental and it requires the \isty{accsupp} package +%\sty{glossaries-accsupp} package, but note that this package is +%experimental and it requires the \sty{accsupp} package %which is also listed as experimental. This package defines %additional keys that may be used when defining glossary entries. %The keys are as follows: @@ -4795,14 +5043,16 @@ %\begin{verbatim} %\BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} %\end{verbatim} -%See \autoref{sec:code:accsupp} for further details. It is -%recommended that you also read the \isty{accsupp} documentation. +%See \ifpdf \sectionref{sec:code:accsupp} \else the section +%\qt{glossaries-accsupp code} in the document \texttt{glossaries.pdf} +%\fi for further details. It is recommended that you also read the +%\sty{accsupp} documentation. % %\section{Mfirstuc Package} %\label{sec:mfirstuc} % -%The \sty{glossaries} bundle is supplied with the package -%\isty{mfirstuc} which provides the command: +%The \styfmt{glossaries} bundle is supplied with the package +%\sty{mfirstuc} which provides the command: %\begin{definition}[\DescribeMacro{\makefirstuc}] %\cs{makefirstuc}\marg{stuff} %\end{definition} @@ -4814,7 +5064,7 @@ %\item \verb|\makefirstuc{abc}| produces Abc % %\item \verb|\makefirstuc{\emph{abc}}| produces \emph{Abc} -%(\ics{MakeUppercase} has been applied to the letter \dq{a} rather +%(\ics{MakeUppercase} has been applied to the letter \qt{a} rather %than \cs{emph}.) Note however that %\verb|\makefirstuc{{\em abc}}| produces \emph{ABC} and %\verb|{\makefirstuc{\em abc}}| produces abc. @@ -4822,15 +5072,18 @@ %\item \verb|\makefirstuc{{\'a}bc}| produces \MakeUppercase{\'a}bc % %\item \verb|\makefirstuc{\ae bc}| produces \MakeUppercase{\ae}bc +% %\item \verb|\makefirstuc{{\ae}bc}| produces \MakeUppercase{\ae}bc +% %\item \verb|\makefirstuc{{ä}bc}| produces \MakeUppercase{ä}bc +% %\end{itemize} %Note that non-Latin or accented characters appearing at the %start of the text must be placed in a group (even if you are -%using the \isty{inputenc} package) due to expansion issues. +%using the \sty{inputenc} package) due to expansion issues. % %\begin{important} -%In version 1.02 of \sty{mfirstuc}, a bug fix resulted in a change +%In version 1.02 of \styfmt{mfirstuc}, a bug fix resulted in a change %in output if the first object is a control sequence followed by %an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}| %produced \ae Bc. However as from version 1.02, it now produces @@ -4862,7 +5115,7 @@ % %If you want to use an alternative command to convert to uppercase, %for example \cs{MakeTextUppercase},\footnote{defined in the -%\sty{textcase} package} you can redefine the internal +%\styfmt{textcase} package} you can redefine the internal %command \cs{@gls@makefirstuc}. For example: %\begin{verbatim} %\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} @@ -4872,8 +5125,12 @@ %and \cs{makeatother}.) % % -% \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} % +%\StopEventually{% +% \clearpage\phantomsection +% \addcontentsline{toc}{section}{Index}\PrintIndex +% +%} % % % @@ -4888,7 +5145,7 @@ % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2010/02/06 v2.05 (NLCT)] +\ProvidesPackage{glossaries}[2010/06/14 v2.06 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -5047,7 +5304,7 @@ false,nolabel,autolabel}[nolabel]{% %\changes{1.18}{2009 January 14}{new} % This option prevents \isty{glossary-long} from being loaded. % This means that the glossary styles that use the -% \envname{longtable} environment will not be available. This option +% \env{longtable} environment will not be available. This option % is provided to reduce overhead caused by loading unrequired % packages. % \begin{macrocode} @@ -5069,7 +5326,7 @@ false,nolabel,autolabel}[nolabel]{% %\changes{1.18}{2009 January 14}{new} % This option prevents \isty{glossary-super} from being loaded. % This means that the glossary styles that use the -% \envname{supertabular} environment will not be available. This option +% \env{supertabular} environment will not be available. This option % is provided to reduce overhead caused by loading unrequired % packages. % \begin{macrocode} @@ -5346,8 +5603,8 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{macro} % (There is no equivalent for the \gloskey{sort} key, since that -% is only provided for the benefit of \appname{makeindex} or -% \appname{xindy}, and so will always be sanitized.) +% is only provided for the benefit of \app{makeindex} or +% \app{xindy}, and so will always be sanitized.) % % Before defining the \pkgopt{sanitize} package option, The % key-value list for the \pkgopt{sanitize} value needs to be defined. @@ -5481,16 +5738,16 @@ name=true]{% %\end{option} % %\begin{macro}{\glsorder} -% Stores the glossary ordering. This may either be \dq{word} -% or \dq{letter}. This passes the relevant information to -% \appname{makeglossaries}. The default is word ordering. +% Stores the glossary ordering. This may either be \qt{word} +% or \qt{letter}. This passes the relevant information to +% \app{makeglossaries}. The default is word ordering. % \begin{macrocode} \newcommand*{\glsorder}{word} % \end{macrocode} %\end{macro} %\begin{macro}{\@glsorder} % The ordering information is written to the auxiliary file -% for \appname{makeglossaries}, so ignore the auxiliary +% for \app{makeglossaries}, so ignore the auxiliary % information. % \begin{macrocode} \newcommand*{\@glsorder}[1]{} @@ -5508,18 +5765,18 @@ name=true]{% %\changes{1.17}{2008 December 26}{added xindy support} %\begin{macro}{\ifglsxindy} %\changes{1.17}{2008 December 26}{new} -% Provide boolean to determine whether \appname{xindy} or -% \appname{makeindex} will be used to sort the glossaries. +% Provide boolean to determine whether \app{xindy} or +% \app{makeindex} will be used to sort the glossaries. % \begin{macrocode} \newif\ifglsxindy % \end{macrocode} %\end{macro} -% The default is \appname{makeindex}: +% The default is \app{makeindex}: % \begin{macrocode} \glsxindyfalse % \end{macrocode} % -% Define package option to specify that \appname{makeindex} will +% Define package option to specify that \app{makeindex} will % be used to sort the glossaries: % \begin{macrocode} \DeclareOptionX{makeindex}{\glsxindyfalse} @@ -5562,7 +5819,7 @@ name=true]{% % \end{macrocode} %\end{macro} % -% Define package option to specify that \appname{xindy} will be +% Define package option to specify that \app{xindy} will be % used to sort the glossaries: % \begin{macrocode} \define@key{glossaries.sty}{xindy}[]{% @@ -5726,7 +5983,7 @@ name=true]{% \providecommand*{\pagelistname}{Page List} % \end{macrocode} %\end{macro} -% Labels for \appname{makeindex}'s symbol and number groups: +% Labels for \app{makeindex}'s symbol and number groups: %\begin{macro}{\glssymbolsgroupname} % \begin{macrocode} \providecommand*{\glssymbolsgroupname}{Symbols} @@ -5897,7 +6154,7 @@ name=true]{% % \end{macrocode} %\end{macro} % -% The name of the \appname{makeindex} or \appname{xindy} style file +% The name of the \app{makeindex} or \app{xindy} style file % is given by \cs{istfilename}. This file is % created by \ics{writeist} (which is used by % \ics{makeglossaries}) so @@ -5914,9 +6171,9 @@ name=true]{% \fi % \end{macrocode} %\end{macro} -% The \appname{makeglossaries} Perl script picks up this name +% The \app{makeglossaries} Perl script picks up this name % from the auxiliary file. If the name ends with \filetype{.xdy} -% it calls \appname{xindy} otherwise it calls \appname{makeindex}. +% it calls \app{xindy} otherwise it calls \app{makeindex}. % Since its not required by % \LaTeX, \cs{@istfilename} ignores its argument. %\begin{macro}{\@istfilename} @@ -5926,7 +6183,7 @@ name=true]{% %\end{macro} % % This command is the value of the \istkey{page\_compositor} -% \appname{makeindex} key. Again, any redefinition of this command +% \app{makeindex} key. Again, any redefinition of this command % must take place \emph{before} \cs{writeist} otherwise it % will have no effect. As from 1.17, use \ics{glsSetCompositor} % instead of directly redefining \cs{glscompositor}. @@ -5948,13 +6205,13 @@ name=true]{% %\end{macro} % % (The page compositor is usually defined as a dash when using -% \appname{makeindex}, but most of the standard counters used +% \app{makeindex}, but most of the standard counters used % by \LaTeX\ use a full stop as the compositor, which is why I -% have used it as the default.) If \appname{xindy} is used +% have used it as the default.) If \app{xindy} is used % \cs{glscompositor} only affects the \texttt{arabic-page-numbers} % location class. %\begin{macro}{\@glsAlphacompositor} -% This is only used by \appname{xindy}. It specifies the +% This is only used by \app{xindy}. It specifies the % compositor to use when location numbers are in the form % \meta{letter}\meta{compositor}\meta{number}. For example, % if \cs{@glsAlphacompositor} is set to ``.'' then it allows @@ -6039,7 +6296,7 @@ name=true]{% % % Individual numbers in an entry's associated number list are % delimited using \cs{delimN} (which corresponds to the -% \istkey{delim\_n} \appname{makeindex} keyword). The default value +% \istkey{delim\_n} \app{makeindex} keyword). The default value % is a comma followed by a space. %\begin{macro}{\delimN} % \begin{macrocode} @@ -6048,7 +6305,7 @@ name=true]{% %\end{macro} % A range of numbers within an entry's associated number list is % delimited using \cs{delimR} (which corresponds to the -% \istkey{delim\_r} \appname{makeindex} keyword). The default is +% \istkey{delim\_r} \app{makeindex} keyword). The default is % an en-dash. %\begin{macro}{\delimR} % \begin{macrocode} @@ -6058,7 +6315,7 @@ name=true]{% % % The glossary preamble is given by \cs{glossarypreamble}. This % will appear after the glossary sectioning command, and before the -% \envname{theglossary} environment. It is designed to allow the +% \env{theglossary} environment. It is designed to allow the % user to add information pertaining to the glossary (e.g.\ ``page % numbers in italic indicate the primary definition'') therefore % \cs{glossarypremable} shouldn't be affected by the glossary @@ -6077,7 +6334,7 @@ name=true]{% % % The glossary postamble is given by \cs{glossarypostamble}. % This is provided to allow the user to -% add something after the end of the \envname{theglossary} +% add something after the end of the \env{theglossary} % environment (again, this shouldn't be affected by the % glossary style). It is, of course, possible to simply add the % text after \ics{printglossary}, but if you only want the @@ -6228,9 +6485,9 @@ name=true]{% % %\subsection{Xindy} % This section defines commands that only have an effect if -% \appname{xindy} is used to sort the glossaries. +% \app{xindy} is used to sort the glossaries. %\begin{macro}{\glsnoxindywarning} -% Issues a warning if \appname{xindy} hasn't been specified. +% Issues a warning if \app{xindy} hasn't been specified. % These warnings can be suppressed by redefining % \cs{glsnoxindywarning} to ignore its argument % \begin{macrocode} @@ -6320,7 +6577,7 @@ name=true]{% %\begin{macro}{\GlsAddXdyAlphabet} % \cs{GlsAddXdyAlphabet}\marg{name}\marg{definition} % adds a new alphabet called \meta{name}. The definition -% must use \appname{xindy} syntax. +% must use \app{xindy} syntax. % \begin{macrocode} \ifglsxindy \newcommand*{\GlsAddXdyAlphabet}[2]{% @@ -6351,9 +6608,9 @@ name=true]{% %\begin{macro}{\GlsAddXdyLocation} % \cs{GlsAddXdyLocation}\marg{name}\marg{definition} % Define a new location called \meta{name}. The definition -% must use \appname{xindy} syntax. (Note that this doesn't +% must use \app{xindy} syntax. (Note that this doesn't % check to see if the location is already defined. That is left -% to \appname{xindy} to complain about.) +% to \app{xindy} to complain about.) % \begin{macrocode} \ifglsxindy \newcommand*{\GlsAddXdyLocation}[2]{% @@ -6434,7 +6691,7 @@ name=true]{% % %\begin{macro}{\@xdyrequiredstyles} % Define list of required styles (this should be a comma-separated -% list of \appname{xindy} styles) +% list of \app{xindy} styles) % \begin{macrocode} \ifglsxindy \def\@xdyrequiredstyles{tex} @@ -6442,7 +6699,7 @@ name=true]{% % \end{macrocode} %\end{macro} %\begin{macro}{\GlsAddXdyStyle} -% Add a \appname{xindy} style to the list of required styles +% Add a \app{xindy} style to the list of required styles % \begin{macrocode} \ifglsxindy \newcommand*\GlsAddXdyStyle[1]{% @@ -6467,9 +6724,9 @@ name=true]{% %\end{macro} % %\begin{macro}{\findrootlanguage} -% The root language name is required by \appname{xindy}. This -% information is for \appname{makeglossaries} to pass to -% \appname{xindy}. Since \ics{languagename} only stores the +% The root language name is required by \app{xindy}. This +% information is for \app{makeglossaries} to pass to +% \app{xindy}. Since \ics{languagename} only stores the % regional dialect rather than the root language name, some % trickery is required to determine the root language. % \begin{macrocode} @@ -6552,9 +6809,9 @@ name=true]{% %\end{macro} % %\begin{macro}{\@xdylanguage} -% The \appname{xindy} language setting is required by -% \appname{makeglossaries}, so provide a command for -% \appname{makeglossaries} to pick up the information +% The \app{xindy} language setting is required by +% \app{makeglossaries}, so provide a command for +% \app{makeglossaries} to pick up the information % from the auxiliary file. This command is not needed by the % \sty{glossaries} package, so define it to ignore its arguments. % \begin{macrocode} @@ -6583,9 +6840,9 @@ name=true]{% %\end{macro} % %\begin{macro}{\@gls@codepage} -% The \appname{xindy} codepage setting is required by -% \appname{makeglossaries}, so provide a command for -% \appname{makeglossaries} to pick up the information +% The \app{xindy} codepage setting is required by +% \app{makeglossaries}, so provide a command for +% \app{makeglossaries} to pick up the information % from the auxiliary file. This command is not needed by the % \sty{glossaries} package, so define it to ignore its arguments. % \begin{macrocode} @@ -6628,7 +6885,7 @@ name=true]{% % %\begin{macro}{\GlsAddLetterGroup} % Add a new letter group. The first argument is the name -% of the letter group. The second argument is the \appname{xindy} +% of the letter group. The second argument is the \app{xindy} % code specifying prefixes and ordering. % \begin{macrocode} \newcommand*\GlsAddLetterGroup[2]{% @@ -6760,19 +7017,19 @@ name=true]{% % A new glossary type is defined using \cs{newglossary}. % Syntax:\\[10pt]\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}% %\marg{title}\oarg{counter}\\[10pt]% -% where \meta{log-ext} is the extension of the \appname{makeindex} +% where \meta{log-ext} is the extension of the \app{makeindex} % transcript file, \meta{in-ext} is the extension of the glossary % input file (read in by \ics{printglossary} and created by -% \appname{makeindex}), \meta{out-ext} is the extension of the -% glossary output file which is read in by \appname{makeindex} +% \app{makeindex}), \meta{out-ext} is the extension of the +% glossary output file which is read in by \app{makeindex} % (lines are written to this file by the \ics{glossary} command), % \meta{title} is the title of the glossary that is used in % \ics{glossarysection} and % \meta{counter} is the default counter to be used by entries -% belonging to this glossary. The \appname{makeglossaries} Perl +% belonging to this glossary. The \app{makeglossaries} Perl % script reads in the relevant extensions from the auxiliary file, % and passes the appropriate file names and switches to -% \appname{makeindex}. +% \app{makeindex}. %\begin{macro}{\newglossary} % \begin{macrocode} \newcommand*{\newglossary}[5][glg]{% @@ -6831,6 +7088,14 @@ name=true]{% {\@gls@setcounter{#2}[\glscounter]}}} % \end{macrocode} %\end{macro} +%\begin{macro}{\altnewglossary} +%\changes{2.06}{2010 June 14}{new} +% \begin{macrocode} +\newcommand*{\altnewglossary}[3]{% + \newglossary[#2-glg]{#1}{#2-gls}{#2-glo}{#3}% +} +% \end{macrocode} +%\end{macro} % Only define new glossaries in the preamble: % \begin{macrocode} \@onlypreamble{\newglossary} @@ -6840,7 +7105,7 @@ name=true]{% \@onlypremakeg\newglossary % \end{macrocode} %\cs{@newglossary} is used to specify the file extensions -% for the \appname{makeindex} input, output and transcript files. +% for the \app{makeindex} input, output and transcript files. % It is written to the auxiliary file by \ics{newglossary}. % Since it is not used by \LaTeX, \cs{@newglossary} simply % ignores its arguments. @@ -6908,7 +7173,7 @@ name=true]{% % "sanitize={description=false}", and protect fragile % commands). The \gloskey{description} key is required when % defining a new glossary entry. (Be careful not to make the -% description too long, because \appname{makeindex} has a limited +% description too long, because \app{makeindex} has a limited % buffer. \cs{@glo@desc} is defined to be a short command % to discourage lengthy descriptions % for this reason. If you do have a very long description, or if @@ -6932,7 +7197,7 @@ name=true]{% % %\begin{key}{sort} % The \gloskey{sort} key needs to be sanitized here -% (the sort key is provided for \appname{makeindex}'s benefit, +% (the sort key is provided for \app{makeindex}'s benefit, % not for use in the document). The \gloskey{sort} key is optional % when defining a new glossary entry. If omitted, the value % is given by \meta{name} \meta{description}. @@ -7517,7 +7782,7 @@ in it}}{% \@gls@checkmkidxchars\@@glo@name % \end{macrocode} % Add the font command. (The backslash needs to be escaped for -% \appname{xindy}.) +% \app{xindy}.) % \begin{macrocode} \ifglsxindy \protected@edef\@glo@name{\string\\glsnamefont{\@@glo@name}}% @@ -7547,7 +7812,7 @@ in it}}{% % \begin{macrocode} \ifglsxindy % \end{macrocode} -% Store using \appname{xindy} syntax. +% Store using \app{xindy} syntax. % \begin{macrocode} \ifx\@glo@parent\@empty % \end{macrocode} @@ -7572,7 +7837,7 @@ in it}}{% \fi \else % \end{macrocode} -% Store using \appname{makeindex} syntax. +% Store using \app{makeindex} syntax. % \begin{macrocode} \ifx\@glo@parent\@empty % \end{macrocode} @@ -7926,7 +8191,7 @@ counter as its value}}{% %\end{macro} %\changes{1.01}{2007 May 17}{Added range facility in format key}% % Set the formatting information in the format required by -% \appname{makeindex}. The first argument is the format specified +% \app{makeindex}. The first argument is the format specified % by the user (via the format key), the second argument is the % name of the counter used to indicate the location and the third % argument is a control sequence which stores the required format. @@ -8092,7 +8357,7 @@ counter as its value}}{% %\end{macro} %\begin{macro}{\@gls@checkescactual} % Similarly for \verb|\?| (which is replaces @ as -% \appname{makeindex}'s special character): +% \app{makeindex}'s special character): % \begin{macrocode} \def\@gls@checkescactual#1\?#2\?#3\null{% \@gls@tmpb=\expandafter{\@gls@checkedmkidx}% @@ -8258,7 +8523,7 @@ counter as its value}}{% %\end{macro} % %\begin{macro}{\@gls@xdycheckquote} -% As before but for use with \appname{xindy} +% As before but for use with \app{xindy} % \begin{macrocode} \def\@gls@xdycheckquote#1"#2"#3\null{% \@gls@tmpb=\expandafter{\@gls@checkedmkidx}% @@ -8287,7 +8552,7 @@ counter as its value}}{% %\end{macro} % %\begin{macro}{\@gls@xdycheckbackslash} -% Need to escape all backslashes for \appname{xindy}. +% Need to escape all backslashes for \app{xindy}. % Define command that will define \cs{@gls@xdycheckbackslash} % \begin{macrocode} \edef\def@gls@xdycheckbackslash{% @@ -8509,6 +8774,7 @@ counter as its value}}{% % \begin{macrocode} \def\@gls@link@opts{#1}% \def\@gls@link@label{#2}% +\def\glslabel{#2}% % \end{macrocode} % Determine what the link text should be (this is stored in % \cs{@glo@text}) @@ -8734,6 +9000,7 @@ counter as its value}}{% % \begin{macrocode} \def\@gls@link@opts{#1}% \def\@gls@link@label{#2}% +\def\glslabel{#2}% % \end{macrocode} % Determine what the link text should be (this is stored in % \cs{@glo@text}). This needs to be expanded so that the @@ -10926,10 +11193,10 @@ counter as its value}}{% % %\subsection{Creating associated files} % The \cs{writeist} command creates the associated -% customized \filetype{.ist} \appname{makeindex} style file. +% customized \filetype{.ist} \app{makeindex} style file. % While defining this command, some characters have their % catcodes temporarily changed to ensure they get written to -% the \filetype{.ist} file correctly. The \appname{makeindex} +% the \filetype{.ist} file correctly. The \app{makeindex} % actual character (usually "@") is redefined to be a "?", to allow % internal commands to be written to the glossary file output file. % @@ -10939,7 +11206,7 @@ counter as its value}}{% % but don't change these values, because the characters are % encoded in the command definitions that are used to escape % the special characters (which means that the user no longer -% needs to worry about \appname{makeindex} special characters). +% needs to worry about \app{makeindex} special characters). % % The symbols and numbers label for group headings are hardwired into % the \filetype{.ist} file as \texttt{glssymbols} and @@ -10976,7 +11243,7 @@ counter as its value}}{% % %\begin{macro}{\@glsfirstletter} % Define the first letter to come after the digits 0,\ldots,9. -% Only required for \appname{xindy}. +% Only required for \app{xindy}. % \begin{macrocode} \ifglsxindy \newcommand*{\@glsfirstletter}{A} @@ -11006,7 +11273,7 @@ counter as its value}}{% %\begin{macro}{\GlsSetXdyMinRangeLength} % Set the minimum range length. The value must either be "none" % or a positive integer. The \sty{glossaries} package doesn't -% check if the argument is valid, that is left to \appname{xindy}. +% check if the argument is valid, that is left to \app{xindy}. % \begin{macrocode} \ifglsxindy \newcommand*{\GlsSetXdyMinRangeLength}[1]{% @@ -11025,7 +11292,7 @@ counter as its value}}{% \newwrite\istfile \ifglsxindy % \end{macrocode} -% Code to use if \appname{xindy} is required. +% Code to use if \app{xindy} is required. % \begin{macrocode} \def\writeist{% % \end{macrocode} @@ -11146,7 +11413,7 @@ counter as its value}}{% % Cross-reference class. (The unverified option is used as the % cross-references are supplied using the list of labels along with % the optional argument for \ics{glsseeformat} which -% \appname{xindy} won't recognise.) +% \app{xindy} won't recognise.) % \begin{macrocode} \write\istfile{^^J; define cross-reference class^^J}% \write\istfile{(define-crossref-class \string"see\string" @@ -11155,7 +11422,7 @@ counter as its value}}{% % Define how cross-references should be displayed. This adds an % empty set of braces after the cross-referencing information % allowing for the final argument of \cs{glsseeformat} which -% gets ignored. (When using \appname{makeindex} this final argument +% gets ignored. (When using \app{makeindex} this final argument % contains the location information which is not required.) % \begin{macrocode} \write\istfile{(markup-crossref-list @@ -11261,7 +11528,7 @@ counter as its value}}{% \noist} \else % \end{macrocode} -% Code to use if \appname{makeindex} is required. +% Code to use if \app{makeindex} is required. %\changes{2.01}{2009 May 30}{removed item\_02 - no such makeindex key} % \begin{macrocode} \edef\@gls@actualchar{\string?} @@ -11351,11 +11618,11 @@ counter as its value}}{% % % \cs{@makeglossary} is an internal command that takes an % argument indicating the glossary type. This command will -% create the glossary file required by \appname{makeindex} for the +% create the glossary file required by \app{makeindex} for the % given glossary type, using the extension supplied by the % \meta{out-ext} parameter used in \ics{newglossary} % (and it will also activate the \ics{glossary} command, -% and create the customized \filetype{.ist} \appname{makeindex} +% and create the customized \filetype{.ist} \app{makeindex} % style file). % % Note that you can't use \cs{@makeglossary} for only some of the @@ -11400,7 +11667,7 @@ using \string\makeglossary}}} % \begin{macrocode} \newcommand*{\makeglossaries}{% % Write the name of the style file to the aux file -% (needed by \appname{makeglossaries}) +% (needed by \app{makeglossaries}) % \begin{macrocode} \protected@write\@auxout{}{\string\@istfilename{\istfilename}}% \protected@write\@auxout{}{\string\@glsorder{\glsorder}} @@ -11476,10 +11743,11 @@ using \string\makeglossary}}} % % Define internal \cs{@glossary} to ignore its argument. % This gets redefined in \cs{@makeglossary}. This is -% defined to just \cs{index} as \icls{memoir} changes the definition of +% defined to just \cs{index} as \cls{memoir} changes the definition of % \cs{@index}. (Thanks to Dan Luecking for pointing this out.) %\begin{macro}{\@glossary} -%\changes{1.17}{2008 December 26}{changed definition to use 'index instead of '@index} +%\changes{1.17}{2008 December 26}{changed definition to use +%\cs{index} instead of \cs{@index}} % \begin{macrocode} \def\@glossary[#1]{\index} % \end{macrocode} @@ -11517,7 +11785,7 @@ using \string\makeglossary}}} % \begin{macrocode} \newcommand{\@do@wrglossary}[1]{% % \end{macrocode} -% Determine whether to use \appname{xindy} or \appname{makeindex} +% Determine whether to use \app{xindy} or \app{makeindex} % syntax % \begin{macrocode} \ifglsxindy @@ -11540,7 +11808,7 @@ using \string\makeglossary}}} \protected@edef\@glslocref{\theglsentrycounter}% \@gls@checkmkidxchars\@glslocref % \end{macrocode} -% Write to the glossary file using \appname{xindy} syntax. +% Write to the glossary file using \app{xindy} syntax. % \begin{macrocode} \glossary[\csname glo@#1@type\endcsname]{% (indexentry :tkey (\csname glo@#1@index\endcsname) @@ -11551,11 +11819,11 @@ using \string\makeglossary}}} \else % \end{macrocode} % Convert the format information into the format required for -% \appname{makeindex} +% \app{makeindex} % \begin{macrocode} \@set@glo@numformat\@glo@numfmt\@gls@counter\@glsnumberformat % \end{macrocode} -% Write to the glossary file using \appname{makeindex} syntax. +% Write to the glossary file using \app{makeindex} syntax. % \begin{macrocode} \glossary[\csname glo@#1@type\endcsname]{% \string\glossaryentry{\csname glo@#1@index\endcsname @@ -11728,8 +11996,8 @@ using \string\makeglossary}}} % \begin{macrocode} \newcommand*{\printglossary}[1][type=\glsdefaulttype]{% % \end{macrocode} -% If \appname{xindy} is being used, need to find the root language -% for \appname{makeglossaries} to pass to \appname{xindy}. +% If \app{xindy} is being used, need to find the root language +% for \app{makeglossaries} to pass to \app{xindy}. % \begin{macrocode} \ifglsxindy\findrootlanguage\fi % \end{macrocode} @@ -11787,9 +12055,9 @@ using \string\makeglossary}}} \IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}{}% {\null}% % \end{macrocode} -% If \appname{xindy} is being used, need to write the language +% If \app{xindy} is being used, need to write the language % dependent information to the \filetype{.aux} file for -% \appname{makeglossaries}. +% \app{makeglossaries}. % \begin{macrocode} \ifglsxindy \@ifundefined{@xdy@\@glo@type @language}{% @@ -11921,7 +12189,7 @@ false,nolabel,autolabel}[nolabel]{% %\end{macro} % %\DescribeEnv{theglossary} -% If the \envname{theglossary} environment has +% If the \env{theglossary} environment has % already been defined, a warning will be issued. % This environment should be redefined by glossary styles. % \begin{macrocode} @@ -11936,7 +12204,7 @@ false,nolabel,autolabel}[nolabel]{% % The glossary header is given by \cs{glossaryheader}. % This forms part of the glossary style, and % must indicate what should appear immediately after the start of the -% \envname{theglossary} environment. (For example, if the glossary +% \env{theglossary} environment. (For example, if the glossary % uses a tabular-like environment, it may be used to set the % header row.) Note that if you don't want a header row, the glossary % style must redefine \cs{glossaryheader} to do nothing. @@ -11981,11 +12249,11 @@ false,nolabel,autolabel}[nolabel]{% % % Within each glossary, the entries form distinct groups % which are determined by the first character of the \gloskey{sort} -% key. When using \appname{makeindex}, there will be a maximum of 28 groups: symbols, numbers, +% key. When using \app{makeindex}, there will be a maximum of 28 groups: symbols, numbers, % and the 26 alphabetical groups A, \ldots, Z\@. If you use -% \appname{xindy} the groups will depend on whatever alphabet +% \app{xindy} the groups will depend on whatever alphabet % is used. This is determined by the language or custom -% alphabets can be created in the \appname{xindy} style file. +% alphabets can be created in the \app{xindy} style file. % The command \cs{glsgroupskip} % specifies what to do between glossary groups. Glossary styles % must redefine this command. (Note that \cs{glsgroupskip} @@ -12010,7 +12278,7 @@ false,nolabel,autolabel}[nolabel]{% \newcommand*{\glsgroupheading}[1]{} % \end{macrocode} %\end{macro} -% It is possible to ``trick'' \appname{makeindex} into +% It is possible to ``trick'' \app{makeindex} into % treating entries as though they belong to the same group, % even if the terms don't start with the same letter, by % modifying the \gloskey{sort} key. For example, all entries @@ -12080,7 +12348,7 @@ style `#1' undefined}{}}{% % New glossary styles can be defined using:\\[10pt] % \cs{newglossarystyle}\marg{name}\marg{definition}\\[10pt] % The \meta{definition} argument should redefine -% \envname{theglossary}, \ics{glossaryheader}, +% \env{theglossary}, \ics{glossaryheader}, % \ics{glsgroupheading}, \ics{glossaryentryfield} and % \ics{glsgroupskip} (see \autoref{sec:code:styles} for the % definitions of predefined styles). Glossary styles should not @@ -13531,6 +13799,134 @@ style `#1' undefined}{}}{% % \end{macrocode} %\end{macro} % +% Allow user to define their own custom acronyms. The short form is +% stored in the user1 key, the plural short form is stored in the +% user2 key, the long form is stored in the user3 key and the +% plural long form is stored in the user4 key. Defaults to +% displaying only the acronym with the long form as the description. +%\begin{macro}{\SetCustomDisplayStyle} +% Sets the acronym display style. +%\changes{2.06}{2010 June 14}{new} +% \begin{macrocode} +\newcommand*{\SetCustomDisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\CustomAcronymFields} +%\changes{2.06}{2010 June 14}{new} +% \begin{macrocode} +\newcommand*{\CustomAcronymFields}{% + name={\the\glsshorttok},% + description={\the\glslongtok},% + first={\the\glslongtok\space(\the\glsshorttok)},% + firstplural={\the\glslongtok\noexpand\acrpluralsuffix\space + (\the\glsshorttok)}% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix}% +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\CustomNewAcronymDef} +%\changes{2.06}{2010 June 14}{new} +% \begin{macrocode} +\newcommand*{\CustomNewAcronymDef}{% + \protected@edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + user1={\the\glsshorttok},% + user2={\the\glsshorttok\noexpand\acrpluralsuffix},% + user3={\the\glslongtok},% + user4={\the\glslongtok\noexpand\acrpluralsuffix},% + \CustomAcronymFields,% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\SetCustomStyle} +%\changes{2.06}{2010 June 14}{new} +% \begin{macrocode} +\newcommand*{\SetCustomStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetCustomDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \CustomNewAcronymDef + }% +% \end{macrocode} +% Set up the commands to make a note of the keys to store the long +% and short forms: +% \begin{macrocode} + \def\glsshortkey{user1}% + \def\glsshortpluralkey{user2}% + \def\glslongkey{user3}% + \def\glslongpluralkey{user4}% +% \end{macrocode} +% Set the display +% \begin{macrocode} + \@for\@gls@type:=\@glsacronymlists\do{% + \SetCustomDisplayStyle{\@gls@type}% + }% +% \end{macrocode} +% Set up short cuts. Short form: +% \begin{macrocode} + \def\@acrshort##1##2[##3]{\@glsuseri@{##1}{##2}[##3]}% + \def\@Acrshort##1##2[##3]{\@Glsuseri@{##1}{##2}[##3]}% + \def\@ACRshort##1##2[##3]{\@GLSuseri@{##1}{##2}[##3]}% +% \end{macrocode} +% Plural short form: +% \begin{macrocode} + \def\@acrshortpl##1##2[##3]{\@glsuserii@{##1}{##2}[##3]}% + \def\@Acrshortpl##1##2[##3]{\@Glsuserii@{##1}{##2}[##3]}% + \def\@ACRshortpl##1##2[##3]{\@GLSuserii@{##1}{##2}[##3]}% +% \end{macrocode} +% Long form: +% \begin{macrocode} + \def\@acrlong##1##2[##3]{\@glsuseriii@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3]}% +% \end{macrocode} +% Plural long form: +% \begin{macrocode} + \def\@acrlongpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3]}% +% \end{macrocode} +% Full form: +% \begin{macrocode} + \def\@acrfull##1##2[##3]{\@glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3] + (\acronymfont{\@GLSuseri@{##1}{##2}[##3]})}% +% \end{macrocode} +% Plural full form: +% \begin{macrocode} + \def\@acrfullpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3] + (\acronymfont{\@GLSuserii@{##1}{##2}[##3]})}% +}% +% \end{macrocode} +%\end{macro} +% +% %\begin{macro}{\DefineAcronymSynonyms} %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} @@ -13657,12 +14053,12 @@ style `#1' undefined}{}}{% % \begin{macrocode} \@gls@loadlist % \end{macrocode} -% The styles that use the \envname{longtable} environment. These are +% The styles that use the \env{longtable} environment. These are % not loaded if the \pkgopt{nolong} package option is used. % \begin{macrocode} \@gls@loadlong % \end{macrocode} -% The styles that use the \envname{supertabular} environment. These are +% The styles that use the \env{supertabular} environment. These are % not loaded if the \pkgopt{nosuper} package option is used or if % the \isty{supertabular} package isn't installed. % \begin{macrocode} @@ -13965,7 +14361,7 @@ style `#1' undefined}{}}{% %\fi % \subsection{List Style (glossary-list.sty)} % The \isty{glossary-list} style file defines glossary styles -% that use the \envname{description} environment. Note that since +% that use the \env{description} environment. Note that since % the entry name is placed in the optional argument to the % \ics{item} command, it will appear in a bold font by % default. @@ -13974,7 +14370,7 @@ style `#1' undefined}{}}{% % \end{macrocode} %\begin{style}{list} % The \glostyle{list} glossary style -% uses the \envname{description} environment. The group separator +% uses the \env{description} environment. The group separator % \ics{glsgroupskip} is redefined as \cs{indexspace} % which produces a gap between groups. The glossary heading % and the group headings do nothing. Sub-entries immediately @@ -13984,7 +14380,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{list}{% % \end{macrocode} -% Use \envname{description} environment: +% Use \env{description} environment: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{description}}{\end{description}}% @@ -14187,7 +14583,7 @@ style `#1' undefined}{}}{% % \subsection{Glossary Styles using longtable (the glossary-long % package)} % The glossary styles defined in the \isty{glossary-long} package -% used the \envname{longtable} environment in the glossary. +% used the \env{longtable} environment in the glossary. % \begin{macrocode} \ProvidesPackage{glossary-long}[2009/05/30 v2.01 (NLCT)] % \end{macrocode} @@ -14223,11 +14619,11 @@ style `#1' undefined}{}}{% % %\begin{style}{long} % The \glostyle{long} glossary style command which -% uses the \envname{longtable} environment: +% uses the \env{longtable} environment: % \begin{macrocode} \newglossarystyle{long}{% % \end{macrocode} -% Use \envname{longtable} with two columns: +% Use \env{longtable} with two columns: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{longtable}{lp{\glsdescwidth}}}% @@ -14268,7 +14664,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long}% % \end{macrocode} -% Use \envname{longtable} with two columns with vertical lines +% Use \env{longtable} with two columns with vertical lines % between each column: % \begin{macrocode} \renewenvironment{theglossary}{% @@ -14324,7 +14720,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{long3col}{% % \end{macrocode} -% Use a \envname{longtable} with 3 columns: +% Use a \env{longtable} with 3 columns: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{longtable}{lp{\glsdescwidth}p{\glspagelistwidth}}}% @@ -14367,7 +14763,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long3col}% % \end{macrocode} -% Use a \envname{longtable} with 3 columns with vertical lines +% Use a \env{longtable} with 3 columns with vertical lines % around them: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14425,7 +14821,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{long4col}{% % \end{macrocode} -% Use a \envname{longtable} with 4 columns: +% Use a \env{longtable} with 4 columns: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{longtable}{llll}}% @@ -14489,7 +14885,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns surrounded by vertical +% Use a \env{longtable} with 4 columns surrounded by vertical % lines: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14513,7 +14909,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns surrounded by vertical +% Use a \env{longtable} with 4 columns surrounded by vertical % lines: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14540,7 +14936,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14560,7 +14956,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4colheader}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14580,7 +14976,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4colborder}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14600,7 +14996,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{long4colheaderborder}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14622,7 +15018,7 @@ style `#1' undefined}{}}{% % \subsection{Glossary Styles using longtable (the glossary-longragged % package)} % The glossary styles defined in the \isty{glossary-longragged} package -% used the \envname{longtable} environment in the glossary and use +% used the \env{longtable} environment in the glossary and use % ragged right formatting for the multiline columns. % \begin{macrocode} \ProvidesPackage{glossary-longragged}[2009/05/30 v2.01 (NLCT)] @@ -14664,7 +15060,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{longragged}{% % \end{macrocode} -% Use \envname{longtable} with two columns: +% Use \env{longtable} with two columns: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{longtable}{l>{\raggedright}p{\glsdescwidth}}}% @@ -14707,7 +15103,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{longragged}% % \end{macrocode} -% Use \envname{longtable} with two columns with vertical lines +% Use \env{longtable} with two columns with vertical lines % between each column: % \begin{macrocode} \renewenvironment{theglossary}{% @@ -14766,7 +15162,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{longragged3col}{% % \end{macrocode} -% Use a \envname{longtable} with 3 columns: +% Use a \env{longtable} with 3 columns: % \begin{macrocode} \renewenvironment{theglossary}% {\begin{longtable}{l>{\raggedright}p{\glsdescwidth}% @@ -14810,7 +15206,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{longragged3col}% % \end{macrocode} -% Use a \envname{longtable} with 3 columns with vertical lines +% Use a \env{longtable} with 3 columns with vertical lines % around them: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14871,7 +15267,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{altlongragged4col}{% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14917,7 +15313,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altlongragged4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14945,7 +15341,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altlongragged4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -14970,7 +15366,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altlongragged4col}% % \end{macrocode} -% Use a \envname{longtable} with 4 columns where the second and +% Use a \env{longtable} with 4 columns where the second and % last columns may have multiple lines in each row: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15000,7 +15396,7 @@ style `#1' undefined}{}}{% %\fi % \subsection{Glossary Styles using supertabular environment (glossary-super package)} % The glossary styles defined in the \isty{glossary-super} package -% use the \envname{supertabular} environment. +% use the \env{supertabular} environment. % \begin{macrocode} \ProvidesPackage{glossary-super}[2009/05/30 v2.01 (NLCT)] % \end{macrocode} @@ -15036,12 +15432,12 @@ style `#1' undefined}{}}{% % %\begin{style}{super} % The \glostyle{super} glossary style uses the -% \envname{supertabular} environment +% \env{supertabular} environment % (it uses lengths defined in the \isty{glossary-long} package.) % \begin{macrocode} \newglossarystyle{super}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15086,7 +15482,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15107,7 +15503,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15129,7 +15525,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns, a header and horizontal lines above and below the % table: % \begin{macrocode} @@ -15149,7 +15545,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{super3col}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15194,7 +15590,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super3col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15215,7 +15611,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super3col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15237,7 +15633,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super3colborder}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns, a header with horizontal lines and a horizontal % line in the tail: % \begin{macrocode} @@ -15260,7 +15656,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{super4col}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15306,7 +15702,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15330,7 +15726,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15351,7 +15747,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a header bordered by horizontal lines and % a horizontal line in the tail: % \begin{macrocode} @@ -15375,7 +15771,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15396,7 +15792,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4colheader}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15419,7 +15815,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4colborder}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15441,7 +15837,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{super4colheaderborder}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a header bordered by horizontal lines and % a horizontal line in the tail: % \begin{macrocode} @@ -15470,7 +15866,7 @@ style `#1' undefined}{}}{% %\fi % \subsection{Glossary Styles using supertabular environment (glossary-superragged package)} % The glossary styles defined in the \isty{glossary-superragged} -% package use the \envname{supertabular} environment. These styles +% package use the \env{supertabular} environment. These styles % are like those provided by the \isty{glossary-super} package, % except that the multiline columns have ragged right justification. % \begin{macrocode} @@ -15508,11 +15904,11 @@ style `#1' undefined}{}}{% % %\begin{style}{superragged} % The \glostyle{superragged} glossary style uses the -% \envname{supertabular} environment. +% \env{supertabular} environment. % \begin{macrocode} \newglossarystyle{superragged}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15559,7 +15955,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15580,7 +15976,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15603,7 +15999,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % two columns, a header and horizontal lines above and below the % table: % \begin{macrocode} @@ -15623,7 +16019,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{superragged3col}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15669,7 +16065,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged3col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15691,7 +16087,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged3col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15714,7 +16110,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{superragged3colborder}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % three columns, a header with horizontal lines and a horizontal % line in the tail: % \begin{macrocode} @@ -15738,7 +16134,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{altsuperragged4col}{% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and no head or tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15784,7 +16180,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altsuperragged4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns, a header and no tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15808,7 +16204,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altsuper4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a horizontal line in the head and tail: % \begin{macrocode} \renewenvironment{theglossary}% @@ -15831,7 +16227,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \glossarystyle{altsuperragged4col}% % \end{macrocode} -% Put the glossary in a \envname{supertabular} environment with +% Put the glossary in a \env{supertabular} environment with % four columns and a header bordered by horizontal lines and % a horizontal line in the tail: % \begin{macrocode} @@ -15880,7 +16276,7 @@ style `#1' undefined}{}}{% \newglossarystyle{index}{% % \end{macrocode} % Set the paragraph indentation and skip and define \ics{item} -% to be the same as that used by \envname{theindex}: +% to be the same as that used by \env{theindex}: % \begin{macrocode} \renewenvironment{theglossary}% {\setlength{\parindent}{0pt}% @@ -15997,7 +16393,7 @@ style `#1' undefined}{}}{% \setlength{\parskip}{0pt plus 0.3pt}}% {}% % \end{macrocode} -% Do nothing at the start of the \envname{theglossary} environment: +% Do nothing at the start of the \env{theglossary} environment: % \begin{macrocode} \renewcommand*{\glossaryheader}{}% % \end{macrocode} @@ -16070,7 +16466,7 @@ style `#1' undefined}{}}{% \glossarystyle{tree}% % \end{macrocode} % Put navigation links to the groups at the start of the -% \envname{theglossary} environment: +% \env{theglossary} environment: % \begin{macrocode} \renewcommand*{\glossaryheader}{% \par\noindent\textbf{\glsnavigation}\par\indexspace}% @@ -16178,7 +16574,7 @@ style `#1' undefined}{}}{% \glossarystyle{treenoname}% % \end{macrocode} % Put navigation links to the groups at the start of the -% \envname{theglossary} environment: +% \env{theglossary} environment: % \begin{macrocode} \renewcommand*{\glossaryheader}{% \par\noindent\textbf{\glsnavigation}\par\indexspace}% @@ -16221,7 +16617,7 @@ style `#1' undefined}{}}{% % \begin{macrocode} \newglossarystyle{alttree}{% % \end{macrocode} -% Redefine \envname{theglossary} environment. +% Redefine \env{theglossary} environment. % \begin{macrocode} \renewenvironment{theglossary}% {\def\@gls@prevlevel{-1}% @@ -18199,6 +18595,29 @@ style `#1' undefined}{}}{% %\fi %\iffalse % \begin{macrocode} +%<*glossaries-dictionary-Serbian.dict> +% \end{macrocode} +%\fi +%\subsection{Serbian Dictionary} +% This dictionary was provided by Zoran Filipovic. +% \begin{macrocode} +\ProvidesDictionary{glossaries-dictionary}{Serbian} +\providetranslation{Glossary}{Mali re\v cnik} +\providetranslation{Acronyms}{Skra\' cenice} +\providetranslation{Notation (glossaries)}{Oznaka} +\providetranslation{Description (glossaries)}{Opis} +\providetranslation{Symbol (glossaries)}{Simbol} +\providetranslation{Page List (glossaries)}{Stranica} +\providetranslation{Symbols (glossaries)}{Simboli} +\providetranslation{Numbers (glossaries)}{Brojevi} +% \end{macrocode} +%\iffalse +% \begin{macrocode} +%</glossaries-dictionary-Serbian.dict> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*glossaries-dictionary-Spanish.dict> % \end{macrocode} %\fi @@ -18287,6 +18706,94 @@ First use: \glspl{aca}. Second use: \glspl{aca}. %\fi %\iffalse % \begin{macrocode} +%<*sample-custom-acronym.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[acronym, % create list of acronyms + nomain, % don't need main glossary for this example + style=tree, % need a style that displays the symbol + hyperfirst=false,% don't hyperlink first use + sanitize=none % switch off sanitization as description + % will be used in the main text + ]{glossaries} + +\makeglossaries + + % This is a sample file to illustrate how to define a custom + % acronym. This example defines the acronym so that on first use + % it displays the short form in the text and places the long form + % and its description in a footnote. In the main body of the + % document the short form will be displayed in small caps, but in + % the list of acronyms the short form is displayed in normal + % capitals. To ensure this, the short form should be written in + % lower case when the acronym is defined, and \MakeUppercase is + % used when it's displayed in the list of acronyms. + + % In the list of acronyms, the long form is used as the name, the + % short form is used as the symbol and the user supplies the + % description when defining the acronym. + +\renewcommand*{\CustomAcronymFields}{% + name={\the\glslongtok},% + symbol={\MakeUppercase{\the\glsshorttok}},% + text={\textsc{\the\glsshorttok}},% + plural={\textsc{\the\glsshorttok}\noexpand\acrpluralsuffix}% +} + +\renewcommand*{\SetCustomDisplayStyle}[1]{% + % ##1 corresponds to the 'first' key + % ##2 corresponds to the 'description' key + % ##3 corresponds to the 'symbol' key + % ##4 is the inserted text given by the final optional argument to + % commands like \gls + % The short form can be obtained via \glsentryuseri{\glslabel} + % The plural short form can be obtained via + % \glsentryuserii{\glslabel} + % The long form can be obtained via \glsentryuseriii{\glslabel} + % The plural long form can be obtained via + % \glsentryuseriv{\glslabel} + \defglsdisplayfirst[#1]{##1##4\protect\footnote{% + \glsentryuseriii{\glslabel}: ##2}}% + % ##1 corresponds to the 'text' key + % the rest as above + \defglsdisplay[#1]{##1##4}% +} + + % Now set the custom acronym style (to override the default style) +\SetCustomStyle + + % Now define the acronyms (must be done after setting the custom + % style) + +\newacronym[description={set of tags for use in developing hypertext +documents}]{html}{html}{Hyper Text Markup Language} + +\newacronym[description={language used to describe the layout of a +document written in a markup language}]{css}{css}{Cascading Style +Sheet} + +\begin{document} + +\gls{css}. \gls{html}. + +\gls{css}. \gls{html}. + +\printglossaries +\end{document} +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +%</sample-custom-acronym.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*sample.tex> % \end{macrocode} %\fi diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins deleted file mode 100644 index b3065eb8c58..00000000000 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ /dev/null @@ -1,95 +0,0 @@ -% glossaries.ins generated using makedtx version 0.94b 2010/2/6 13:23 -\input docstrip - -\preamble - - glossaries.dtx - Copyright 2010 Nicola Talbot - - This work may be distributed and/or modified under the - conditions of the LaTeX Project Public License, either version 1.3 - of this license of (at your option) any later version. - The latest version of this license is in - http://www.latex-project.org/lppl.txt - and version 1.3 or later is part of all distributions of LaTeX - version 2005/12/01 or later. - - This work has the LPPL maintenance status `maintained'. - - The Current Maintainer of this work is Nicola Talbot. - - This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. - -\endpreamble - -\askforoverwritefalse - -\generate{\file{glossaries.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries.sty,package}} -\file{mfirstuc.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{mfirstuc.sty,package}} -\file{glossary-hypernav.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-hypernav.sty,package}} -\file{glossary-list.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-list.sty,package}} -\file{glossary-long.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-long.sty,package}} -\file{glossary-longragged.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-longragged.sty,package}} -\file{glossary-super.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-super.sty,package}} -\file{glossary-superragged.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-superragged.sty,package}} -\file{glossary-tree.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-tree.sty,package}} -\file{glossaries-accsupp.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-accsupp.sty,package}} -\file{glossaries-babel.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-babel.sty,package}} -\file{glossaries-polyglossia.sty}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-polyglossia.sty,package}} -\file{glossaries-dictionary-Brazilian.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Brazilian.dict,package}} -\file{glossaries-dictionary-Danish.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Danish.dict,package}} -\file{glossaries-dictionary-Dutch.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Dutch.dict,package}} -\file{glossaries-dictionary-English.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-English.dict,package}} -\file{glossaries-dictionary-French.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-French.dict,package}} -\file{glossaries-dictionary-German.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-German.dict,package}} -\file{glossaries-dictionary-Irish.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Irish.dict,package}} -\file{glossaries-dictionary-Italian.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Italian.dict,package}} -\file{glossaries-dictionary-Magyar.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Magyar.dict,package}} -\file{glossaries-dictionary-Polish.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Polish.dict,package}} -\file{glossaries-dictionary-Spanish.dict}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Spanish.dict,package}} -\file{minimalgls.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{minimalgls.tex}} -\file{sample.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample.tex}} -\file{sample4col.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample4col.tex}} -\file{sampleaccsupp.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleaccsupp.tex}} -\file{sampleAcr.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleAcr.tex}} -\file{sampleAcrDesc.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleAcrDesc.tex}} -\file{sampleacronyms.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleacronyms.tex}} -\file{sampleDB.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleDB.tex}} -\file{sampleDesc.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleDesc.tex}} -\file{sampleEq.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleEq.tex}} -\file{sampleEqPg.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleEqPg.tex}} -\file{sampleNtn.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleNtn.tex}} -\file{sampleSec.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleSec.tex}} -\file{sampletree.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampletree.tex}} -\file{sampleutf8.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleutf8.tex}} -\file{samplexdy.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{samplexdy.tex}} -\file{samplexdy-mc.xdy}{\nopreamble\nopostamble\from{glossaries.dtx}{samplexdy-mc.xdy}} -\file{database1.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{database1.tex}} -\file{database2.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{database2.tex}} -\file{glossaries.perl}{\nopreamble\nopostamble\from{glossaries.dtx}{glossaries.perl}} -} - -\endbatchfile diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.sty b/Master/texmf-dist/source/latex/glossaries/glossaries.sty new file mode 100644 index 00000000000..b1cfd0b2f65 --- /dev/null +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.sty @@ -0,0 +1,3442 @@ +%% +%% This is file `glossaries.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% glossaries.dtx (with options: `glossaries.sty,package') +%% +%% glossaries.dtx +%% Copyright 2010 Nicola Talbot +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.3 +%% of this license of (at your option) any later version. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of LaTeX +%% version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Nicola Talbot. +%% +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{glossaries}[2010/06/14 v2.06 (NLCT)] +\RequirePackage{ifthen} +\RequirePackage{xkeyval}[2006/11/18] +\RequirePackage{mfirstuc} +\RequirePackage{xfor} +\RequirePackage{amsgen} +\define@boolkey{glossaries.sty}[gls]{toc}[true]{} +\define@boolkey{glossaries.sty}[gls]{numberline}[true]{} +\@ifundefined{chapter}{\newcommand*{\@@glossarysec}{section}}{% + \newcommand*{\@@glossarysec}{chapter}} +\define@choicekey{glossaries.sty}{section}{part,chapter,section,% +subsection,subsubsection,paragraph,subparagraph}[section]{% + \renewcommand*{\@@glossarysec}{#1}} +\newcommand*{\@@glossarysecstar}{*} +\newcommand*{\@@glossaryseclabel}{} +\newcommand*{\glsautoprefix}{} +\define@choicekey{glossaries.sty}{numberedsection}[\val\nr]{% +false,nolabel,autolabel}[nolabel]{% + \ifcase\nr\relax + \renewcommand*{\@@glossarysecstar}{*}% + \renewcommand*{\@@glossaryseclabel}{}% + \or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{}% + \or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{% + \label{\glsautoprefix\@glo@type}}% + \fi +} +\newcommand*{\@glossary@default@style}{list} +\define@key{glossaries.sty}{style}{% +\renewcommand*{\@glossary@default@style}{#1}} +\newcommand*{\glossaryentrynumbers}[1]{#1} +\DeclareOptionX{nonumberlist}{% +\renewcommand*{\glossaryentrynumbers}[1]{}} +\newcommand*{\@gls@loadlong}{\RequirePackage{glossary-long}} +\DeclareOptionX{nolong}{\renewcommand*{\@gls@loadlong}{}} +\IfFileExists{supertabular.sty}{% + \newcommand*{\@gls@loadsuper}{\RequirePackage{glossary-super}}}{% + \newcommand*{\@gls@loadsuper}{}} +\DeclareOptionX{nosuper}{\renewcommand*{\@gls@loadsuper}{}} +\newcommand*{\@gls@loadlist}{\RequirePackage{glossary-list}} +\DeclareOptionX{nolist}{\renewcommand*{\@gls@loadlist}{}} +\newcommand*{\@gls@loadtree}{\RequirePackage{glossary-tree}} +\DeclareOptionX{notree}{\renewcommand*{\@gls@loadtree}{}} +\DeclareOptionX{nostyles}{% + \renewcommand*{\@gls@loadlong}{}% + \renewcommand*{\@gls@loadsuper}{}% + \renewcommand*{\@gls@loadlist}{}% + \renewcommand*{\@gls@loadtree}{}% + \let\@glossary@default@style\relax +} +\newcommand*{\glsdefmain}{% + \newglossary{main}{gls}{glo}{\glossaryname}% +} +\newcommand*{\glsdefaulttype}{main} +\newcommand*{\acronymtype}{\glsdefaulttype} +\DeclareOptionX{nomain}{% + \let\glsdefaulttype\relax + \renewcommand*{\glsdefmain}{}% +} +\define@boolkey{glossaries.sty}[gls]{acronym}[true]{% + \DeclareAcronymList{acronym}% +} +\newcommand*{\@glsacronymlists}{} +\newcommand*{\@addtoacronymlists}[1]{% + \ifx\@glsacronymlists\@empty + \protected@xdef\@glsacronymlists{#1}% + \else + \protected@xdef\@glsacronymlists{\@glsacronymlists,#1}% + \fi +} +\newcommand*{\DeclareAcronymList}[1]{% + \glsIfListOfAcronyms{#1}{}{\@addtoacronymlists{#1}}% +} +\newcommand{\glsIfListOfAcronyms}[1]{% + \edef\@do@gls@islistofacronyms{% + \noexpand\@gls@islistofacronyms{#1}{\@glsacronymlists}}% + \@do@gls@islistofacronyms +} +\newcommand{\@gls@islistofacronyms}[4]{% + \def\gls@islistofacronyms##1,#1,##2\end@gls@islistofacronyms{% + \def\@before{##1}\def\@after{##2}}% + \gls@islistofacronyms,#2,#1,\@nil\end@gls@islistofacronyms + \ifx\@after\@nnil + #4% + \else + #3% + \fi +} +\newif\if@glsisacronymlist +\newcommand*{\gls@checkisacronymlist}[1]{% + \glsIfListOfAcronyms{#1}% + {\@glsisacronymlisttrue}{\@glsisacronymlistfalse}% +} +\newcommand*{\SetAcronymLists}[1]{% + \renewcommand*{\@glsacronymlists}{#1}% +} +\define@key{glossaries.sty}{acronymlists}{% + \@addtoacronymlists{#1}% +} +\newcommand{\glscounter}{page} +\define@key{glossaries.sty}{counter}{% + \renewcommand*{\glscounter}{#1}% +} +\newcommand*{\@gls@sanitizedesc}{\@onelevel@sanitize\@glo@desc} +\newcommand*{\@gls@sanitizename}{\@onelevel@sanitize\@glo@name} +\newcommand*{\@gls@sanitizesymbol}{\@onelevel@sanitize\@glo@symbol} +\define@boolkey[gls]{sanitize}{description}[true]{% +\ifgls@sanitize@description + \renewcommand*{\@gls@sanitizedesc}{\@onelevel@sanitize\@glo@desc}% +\else + \renewcommand*{\@gls@sanitizedesc}{}% +\fi +} +\define@boolkey[gls]{sanitize}{name}[true]{% +\ifgls@sanitize@name + \renewcommand*{\@gls@sanitizename}{\@onelevel@sanitize\@glo@name}% +\else + \renewcommand*{\@gls@sanitizename}{}% +\fi} +\define@boolkey[gls]{sanitize}{symbol}[true]{% +\ifgls@sanitize@symbol + \renewcommand*{\@gls@sanitizesymbol}{% +\@onelevel@sanitize\@glo@symbol}% +\else + \renewcommand*{\@gls@sanitizesymbol}{}% +\fi} +\define@key{glossaries.sty}{sanitize}[description=true,symbol=true, +name=true]{% +\ifthenelse{\equal{#1}{none}}{% +\renewcommand*{\@gls@sanitizedesc}{}% +\renewcommand*{\@gls@sanitizename}{}% +\renewcommand*{\@gls@sanitizesymbol}{}% +}{\setkeys[gls]{sanitize}{#1}}% +} +\define@boolkey{glossaries.sty}[gls]{translate}[true]{} +\glstranslatefalse +\@ifpackageloaded{translator}{\glstranslatetrue}{% +\@ifpackageloaded{babel}{\glstranslatetrue}{% +\@ifpackageloaded{polyglossia}{\glstranslatetrue}{}}} +\define@boolkey{glossaries.sty}[gls]{hyperfirst}[true]{} +\glshyperfirsttrue +\define@boolkey{glossaries.sty}[glsacr]{footnote}[true]{% +\ifthenelse{\boolean{glsacrdescription}}{}% +{\renewcommand*{\@gls@sanitizedesc}{}}% +} +\define@boolkey{glossaries.sty}[glsacr]{description}[true]{% + \renewcommand*{\@gls@sanitizesymbol}{}% +} +\define@boolkey{glossaries.sty}[glsacr]{smallcaps}[true]{% + \renewcommand*{\@gls@sanitizesymbol}{}% +} +\define@boolkey{glossaries.sty}[glsacr]{smaller}[true]{% + \renewcommand*{\@gls@sanitizesymbol}{}% +} +\define@boolkey{glossaries.sty}[glsacr]{dua}[true]{% + \renewcommand*{\@gls@sanitizesymbol}{}% +} +\define@boolkey{glossaries.sty}[glsacr]{shortcuts}[true]{} +\newcommand*{\glsorder}{word} +\newcommand*{\@glsorder}[1]{} +\define@choicekey{glossaries.sty}{order}{word,letter}{% + \def\glsorder{#1}} +\newif\ifglsxindy +\glsxindyfalse +\DeclareOptionX{makeindex}{\glsxindyfalse} +\define@boolkey[gls]{xindy}{glsnumbers}[true]{} +\gls@xindy@glsnumberstrue +\def\@xdy@main@language{\rootlanguagename}% +\define@key[gls]{xindy}{language}{\def\@xdy@main@language{#1}} +\@ifundefined{inputencodingname}{% + \def\gls@codepage{}}{% + \def\gls@codepage{\inputencodingname} +} +\define@key[gls]{xindy}{codepage}{\def\gls@codepage{#1}} +\define@key{glossaries.sty}{xindy}[]{% + \glsxindytrue + \setkeys[gls]{xindy}{#1}% +} +\newcommand*{\GlossariesWarning}[1]{% + \PackageWarning{glossaries}{#1}% +} +\newcommand*{\GlossariesWarningNoLine}[1]{% + \PackageWarningNoLine{glossaries}{#1}% +} +\DeclareOptionX{nowarn}{% + \renewcommand*{\GlossariesWarning}[1]{}% + \renewcommand*{\GlossariesWarningNoLine}[1]{}% +} +\ProcessOptionsX +\ifglstranslate + \@ifpackageloaded{babel}{\IfFileExists{translator.sty}{% + \RequirePackage{translator}}{}}{} +\fi +\ifthenelse{\equal{\glscounter}{section}}{% +\@ifundefined{chapter}{}{% +\let\@gls@old@chapter\@chapter +\def\@chapter[#1]#2{\@gls@old@chapter[{#1}]{#2}% +\@ifundefined{hyperdef}{}{\hyperdef{section}{\thesection}{}}}}}{} +\newcommand*{\@gls@onlypremakeg}{} +\newcommand*{\@onlypremakeg}[1]{% +\ifx\@gls@onlypremakeg\@empty + \def\@gls@onlypremakeg{#1}% +\else + \expandafter\toks@\expandafter{\@gls@onlypremakeg}% + \edef\@gls@onlypremakeg{\the\toks@,\noexpand#1}% +\fi} +\newcommand*{\@disable@onlypremakeg}{% +\@for\@thiscs:=\@gls@onlypremakeg\do{% + \expandafter\@disable@premakecs\@thiscs% +}} +\newcommand*{\@disable@premakecs}[1]{% + \def#1{\PackageError{glossaries}{\string#1\space may only be + used before \string\makeglossaries}{You can't use + \string#1\space after \string\makeglossaries}}% +} +\providecommand*{\glossaryname}{Glossary} +\providecommand*{\acronymname}{Acronyms} +\newcommand*{\glssettoctitle}[1]{% +\def\glossarytoctitle{\csname @glotype@#1@title\endcsname}} +\providecommand*{\entryname}{Notation} +\providecommand*{\descriptionname}{Description} +\providecommand*{\symbolname}{Symbol} +\providecommand*{\pagelistname}{Page List} +\providecommand*{\glssymbolsgroupname}{Symbols} +\providecommand*{\glsnumbersgroupname}{Numbers} +\newcommand*{\glspluralsuffix}{s} +\providecommand*{\seename}{see} +\providecommand*{\andname}{\&} +\newcommand*{\addglossarytocaptions}[1]{% + \@ifundefined{captions#1}{}{% + \expandafter\let\expandafter\@gls@tmp\csname captions#1\endcsname + \expandafter\toks@\expandafter{\@gls@tmp + \renewcommand*{\glossaryname}{\translate{Glossary}}% + }% + \expandafter\edef\csname captions#1\endcsname{\the\toks@}% + }% +} +\ifglstranslate + \@ifpackageloaded{translator}{% + \usedictionary{glossaries-dictionary}% + \addglossarytocaptions{portuges}% + \addglossarytocaptions{portuguese}% + \addglossarytocaptions{brazil}% + \addglossarytocaptions{brazilian}% + \addglossarytocaptions{danish}% + \addglossarytocaptions{dutch}% + \addglossarytocaptions{afrikaans}% + \addglossarytocaptions{english}% + \addglossarytocaptions{UKenglish}% + \addglossarytocaptions{USenglish}% + \addglossarytocaptions{american}% + \addglossarytocaptions{australian}% + \addglossarytocaptions{british}% + \addglossarytocaptions{canadian}% + \addglossarytocaptions{newzealand}% + \addglossarytocaptions{french}% + \addglossarytocaptions{frenchb}% + \addglossarytocaptions{francais}% + \addglossarytocaptions{acadian}% + \addglossarytocaptions{canadien}% + \addglossarytocaptions{german}% + \addglossarytocaptions{germanb}% + \addglossarytocaptions{austrian}% + \addglossarytocaptions{naustrian}% + \addglossarytocaptions{ngerman}% + \addglossarytocaptions{irish}% + \addglossarytocaptions{italian}% + \addglossarytocaptions{magyar}% + \addglossarytocaptions{hungarian}% + \addglossarytocaptions{polish}% + \addglossarytocaptions{spanish}% + \renewcommand*{\glssettoctitle}[1]{% + \ifthenelse{\equal{#1}{main}}{% + \translatelet{\glossarytoctitle}{Glossary}}{% + \ifthenelse{\equal{#1}{acronym}}{% + \translatelet{\glossarytoctitle}{Acronyms}}{% + \def\glossarytoctitle{\csname @glotype@#1@title\endcsname}}}}% + \renewcommand*{\glossaryname}{\translate{Glossary}}% + \renewcommand*{\acronymname}{\translate{Acronyms}}% + \renewcommand*{\entryname}{\translate{Notation (glossaries)}}% + \renewcommand*{\descriptionname}{% + \translate{Description (glossaries)}}% + \renewcommand*{\symbolname}{\translate{Symbol (glossaries)}}% + \renewcommand*{\pagelistname}{% + \translate{Page List (glossaries)}}% + \renewcommand*{\glssymbolsgroupname}{% + \translate{Symbols (glossaries)}}% + \renewcommand*{\glsnumbersgroupname}{% + \translate{Numbers (glossaries)}}% + }{% + \@ifpackageloaded{babel}% + {\RequirePackage{glossaries-babel}}% + {% + \@ifpackageloaded{polyglossia}{% + \RequirePackage{glossaries-polyglossia}}{}% + }} +\fi +\newcommand*{\glspostdescription}{.} +\newcommand*{\nopostdesc}{} +\newcommand*{\@nopostdesc}{% + \let\org@glspostdescription\glspostdescription + \def\glspostdescription{% + \let\glspostdescription\org@glspostdescription}% +} +\newcommand{\glspar}{\par} +\ifglsxindy + \newcommand{\setStyleFile}[1]{% + \renewcommand{\istfilename}{#1.xdy}} +\else + \newcommand{\setStyleFile}[1]{% + \renewcommand{\istfilename}{#1.ist}} +\fi +\@onlypremakeg\setStyleFile +\ifglsxindy + \def\istfilename{\jobname.xdy} +\else + \def\istfilename{\jobname.ist} +\fi +\newcommand*{\@istfilename}[1]{} +\newcommand*{\glscompositor}{.} +\newcommand*{\glsSetCompositor}[1]{% + \renewcommand*{\glscompositor}{#1}} +\@onlypremakeg\glsSetCompositor +\newcommand*{\@glsAlphacompositor}{\glscompositor} +\ifglsxindy + \newcommand*\glsSetAlphaCompositor[1]{% + \renewcommand*\@glsAlphacompositor{#1}} +\else + \newcommand*\glsSetAlphaCompositor[1]{% + \glsnoxindywarning\glsSetAlphaCompositor} +\fi +\@onlypremakeg\glsSetAlphaCompositor +\newcommand*{\gls@suffixF}{} +\newcommand*{\glsSetSuffixF}[1]{% + \renewcommand*{\gls@suffixF}{#1}} +\@onlypremakeg\glsSetSuffixF +\newcommand*{\gls@suffixFF}{} +\newcommand*{\glsSetSuffixFF}[1]{% + \renewcommand*{\gls@suffixFF}{#1}} +\@ifundefined{hyperlink}{% +\newcommand*{\glsnumberformat}[1]{#1}}{% +\newcommand*{\glsnumberformat}[1]{\glshypernumber{#1}}} +\newcommand{\delimN}{, } +\newcommand{\delimR}{--} +\newcommand*{\glossarypreamble}{} +\newcommand*{\glossarypostamble}{} +\newcommand*{\glossarysection}[2][\@gls@title]{% + \def\@gls@title{#2}% + \@ifundefined{phantomsection}{% + \@glossarysection{#1}{#2}}{\@p@glossarysection{#1}{#2}}% + \glossarymark{\glossarytoctitle}% +} +\@ifundefined{glossarymark}{% + \newcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} +}{% + \GlossariesWarning{overriding \string\glossarymark}% + \@ifclassloaded{memoir}% + { + \renewcommand{\glossarymark}[1]{% + \markboth{\memUChead{#1}}{\memUChead{#1}}% + } + } + { + \renewcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + } +} +\newcommand*{\setglossarysection}[1]{% +\setkeys{glossaries.sty}{section=#1}} +\newcommand*{\@glossarysection}[2]{% +\ifx\@@glossarysecstar\@empty + \csname\@@glossarysec\endcsname{#2}% +\else + \csname\@@glossarysec\endcsname*{#2}% + \@gls@toc{#1}{\@@glossarysec}% +\fi +\@@glossaryseclabel} +\newcommand*{\@p@glossarysection}[2]{% +\glsclearpage +\phantomsection +\ifx\@@glossarysecstar\@empty + \csname\@@glossarysec\endcsname{#2}% +\else + \@gls@toc{#1}{\@@glossarysec}% + \csname\@@glossarysec\endcsname*{#2}% +\fi +\@@glossaryseclabel} +\newcommand*{\gls@doclearpage}{% +\ifthenelse{\equal{\@@glossarysec}{chapter}}{% +\@ifundefined{cleardoublepage}{\clearpage}{\cleardoublepage}}{}% +} +\newcommand*{\glsclearpage}{\gls@doclearpage} +\newcommand*{\@gls@toc}[2]{% +\ifglstoc + \ifglsnumberline + \addcontentsline{toc}{#2}{\numberline{}#1}% + \else + \addcontentsline{toc}{#2}{#1}% + \fi +\fi} +\newcommand*{\glsnoxindywarning}[1]{% + \GlossariesWarning{Not in xindy mode --- ignoring \string#1}% +} +\ifglsxindy + \edef\@xdyattributes{\string"default\string"}% +\fi +\ifglsxindy + \def\@xdylocref{} +\fi +\ifglsxindy + \newcommand*\GlsAddXdyAttribute[1]{% + \edef\@xdyattributes{\@xdyattributes ^^J \string"#1\string"}% + \expandafter\toks@\expandafter{\@xdylocref}% + \edef\@xdylocref{\the\toks@ ^^J% + (markup-locref + :open \string"\string~n\string\setentrycounter + {\noexpand\glscounter}% + \expandafter\string\csname#1\endcsname + \expandafter\@gobble\string\{\string" ^^J + :close \string"\expandafter\@gobble\string\}\string" ^^J + :attr \string"#1\string")}} + \@onlypremakeg\GlsAddXdyAttribute +\else + \newcommand*\GlsAddXdyAttribute[1]{% + \glsnoxindywarning\GlsAddXdyAttribute} +\fi +\ifglsxindy + \GlsAddXdyAttribute{glsnumberformat} + \GlsAddXdyAttribute{textrm} + \GlsAddXdyAttribute{textsf} + \GlsAddXdyAttribute{texttt} + \GlsAddXdyAttribute{textbf} + \GlsAddXdyAttribute{textmd} + \GlsAddXdyAttribute{textit} + \GlsAddXdyAttribute{textup} + \GlsAddXdyAttribute{textsl} + \GlsAddXdyAttribute{textsc} + \GlsAddXdyAttribute{emph} + \GlsAddXdyAttribute{glshypernumber} + \GlsAddXdyAttribute{hyperrm} + \GlsAddXdyAttribute{hypersf} + \GlsAddXdyAttribute{hypertt} + \GlsAddXdyAttribute{hyperbf} + \GlsAddXdyAttribute{hypermd} + \GlsAddXdyAttribute{hyperit} + \GlsAddXdyAttribute{hyperup} + \GlsAddXdyAttribute{hypersl} + \GlsAddXdyAttribute{hypersc} + \GlsAddXdyAttribute{hyperemph} +\fi +\def\@xdyuseralphabets{} +\ifglsxindy + \newcommand*{\GlsAddXdyAlphabet}[2]{% + \edef\@xdyuseralphabets{% + \@xdyuseralphabets ^^J + (define-alphabet "#1" (#2))}} +\else + \newcommand*{\GlsAddXdyAlphabet}[2]{% + \glsnoxindywarning\GlsAddXdyAlphabet} +\fi +\def\@xdyuserlocationdefs{} +\def\@xdyuserlocationnames{} +\ifglsxindy + \newcommand*{\GlsAddXdyLocation}[2]{% + \edef\@xdyuserlocationdefs{% + \@xdyuserlocationdefs ^^J% + (define-location-class \string"#1\string"^^J\space\space + \space(#2)) + }% + \edef\@xdyuserlocationnames{% + \@xdyuserlocationnames^^J\space\space\space + \string"#1\string"}% + } + \@onlypremakeg\GlsAddXdyLocation +\else + \newcommand*{\GlsAddXdyLocation}[2]{% + \glsnoxindywarning\GlsAddXdyLocation} +\fi +\ifglsxindy + \edef\@xdylocationclassorder{^^J\space\space\space + \string"roman-page-numbers\string"^^J\space\space\space + \string"arabic-page-numbers\string"^^J\space\space\space + \string"arabic-section-numbers\string"^^J\space\space\space + \string"alpha-page-numbers\string"^^J\space\space\space + \string"Roman-page-numbers\string"^^J\space\space\space + \string"Alpha-page-numbers\string"^^J\space\space\space + \string"Appendix-page-numbers\string" + \@xdyuserlocationnames^^J\space\space\space + \string"see\string" + } +\fi +\ifglsxindy + \newcommand*\GlsSetXdyLocationClassOrder[1]{% + \def\@xdylocationclassorder{#1}} +\else + \newcommand*\GlsSetXdyLocationClassOrder[1]{% + \glsnoxindywarning\GlsSetXdyLocationClassOrder} +\fi +\ifglsxindy + \def\@xdysortrules{} +\fi +\ifglsxindy + \newcommand*\GlsAddSortRule[2]{% + \expandafter\toks@\expandafter{\@xdysortrules}% + \protected@edef\@xdysortrules{\the\toks@ ^^J + (sort-rule \string"#1\string" \string"#2\string")}% + } +\else + \newcommand*\GlsAddSortRule[2]{% + \glsnoxindywarning\GlsAddSortRule} +\fi +\ifglsxindy + \def\@xdyrequiredstyles{tex} +\fi +\ifglsxindy + \newcommand*\GlsAddXdyStyle[1]{% + \edef\@xdyrequiredstyles{\@xdyrequiredstyles,#1}}% +\else + \newcommand*\GlsAddXdyStyle[1]{% + \glsnoxindywarning\GlsAddXdyStyle} +\fi +\ifglsxindy + \newcommand*\GlsSetXdyStyles[1]{% + \edef\@xdyrequiredstyles{#1}} +\else + \newcommand*\GlsSetXdyStyles[1]{% + \glsnoxindywarning\GlsSetXdyStyles} +\fi +\ifglsxindy + \@ifpackageloaded{babel}{% + \def\findrootlanguage{\begingroup + \escapechar=-1\relax + \edef\languagename{% + \expandafter\string\csname\languagename\endcsname}% + \def\NeedsTeXFormat##1[##2]{}% + \def\ProvidesPackage##1[##2]{}% + \let\LdfInit\relax + \def\languageattribute##1##2{}% + \def\DeclareOption##1##2{% + \ifx##1*\expandafter\endinput\else + \edef\testlanguage{\expandafter\string\csname##1\endcsname}% + \ifx\testlanguage\languagename##2\fi + \fi} + \def\input##1{\stripldf##1}% + \def\stripldf##1.ldf{\gdef\rootlanguagename{##1}}% + \@@input babel.sty + \endgroup}% + }{% + \@ifpackageloaded{ngerman}{% + \def\findrootlanguage{% + \def\rootlanguagename{german}}% + }{% + \def\findrootlanguage{% + \def\rootlanguagename{english}}% + }% + }% +\fi +\def\rootlanguagename{english} +\def\@xdylanguage#1#2{} +\ifglsxindy + \newcommand*\GlsSetXdyLanguage[2][\glsdefaulttype]{% + \ifglossaryexists{#1}{% + \expandafter\def\csname @xdy@#1@language\endcsname{#2}% + }{% + \PackageError{glossaries}{Can't set language type for + glossary type `#1' --- no such glossary}{% + You have specified a glossary type that doesn't exist}}} +\else + \newcommand*\GlsSetXdyLanguage[2][]{% + \glsnoxindywarning\GlsSetXdyLanguage} +\fi +\def\@gls@codepage#1#2{} +\ifglsxindy + \newcommand*{\GlsSetXdyCodePage}[1]{% + \renewcommand*{\gls@codepage}{#1}% + } +\else + \newcommand*{\GlsSetXdyCodePage}[1]{% + \glsnoxindywarning\GlsSetXdyCodePage} +\fi +\ifglsxindy + \ifgls@xindy@glsnumbers + \def\@xdylettergroups{(define-letter-group + \string"glsnumbers\string"^^J\space\space\space + :prefixes (\string"0\string" \string"1\string" + \string"2\string" \string"3\string" \string"4\string" + \string"5\string" \string"6\string" \string"7\string" + \string"8\string" \string"9\string")^^J\space\space\space + :before \string"\@glsfirstletter\string")} + \else + \def\@xdylettergroups{} + \fi +\fi + \newcommand*\GlsAddLetterGroup[2]{% + \expandafter\toks@\expandafter{\@xdylettergroups}% + \protected@edef\@xdylettergroups{\the\toks@^^J% + (define-letter-group \string"#1\string"^^J\space\space\space#2)}% + }% +\newcommand*{\forallglossaries}[3][\@glo@types]{% + \@for#2:=#1\do{\ifx#2\@empty\else#3\fi}% +} +\newcommand*{\forglsentries}[3][\glsdefaulttype]{% + \edef\@@glo@list{\csname glolist@#1\endcsname}% + \@for#2:=\@@glo@list\do{\ifx#2\@empty\else#3\fi}% +} +\newcommand*{\forallglsentries}[3][\@glo@types]{% +\expandafter\forallglossaries\expandafter[#1]{\@@this@glo@}{% +\forglsentries[\@@this@glo@]{#2}{#3}}} +\newcommand{\ifglossaryexists}[3]{% + \@ifundefined{@glotype@#1@out}{#3}{#2}% +} +\newcommand{\ifglsentryexists}[3]{% +\@ifundefined{glo@#1@name}{#3}{#2}} +\newcommand*{\ifglsused}[3]{\ifthenelse{\boolean{glo@#1@flag}}{#2}{#3}} +\newcommand{\glsdoifexists}[2]{% + \ifglsentryexists{#1}{#2}{% + \PackageError{glossaries}{Glossary entry `#1' has not been + defined}{You need to define a glossary entry before you + can use it.}}% +} +\newcommand{\glsdoifnoexists}[2]{% + \ifglsentryexists{#1}{% + \PackageError{glossaries}{Glossary entry `#1' has already + been defined}{}}{#2}% +} +\newcommand*{\@glo@types}{,} +\newcommand*{\newglossary}[5][glg]{% +\ifglossaryexists{#2}{% + \PackageError{glossaries}{Glossary type `#2' already exists}{% + You can't define a new glossary called `#2' because it already + exists}% +}{% + \ifx\glsdefaulttype\relax + \gdef\glsdefaulttype{#2}% + \fi + \toks@{#2}\edef\@glo@types{\@glo@types\the\toks@,}% + \expandafter\gdef\csname glolist@#2\endcsname{,}% + \expandafter\def\csname @glotype@#2@in\endcsname{#3}% + \expandafter\def\csname @glotype@#2@out\endcsname{#4}% + \expandafter\def\csname @glotype@#2@title\endcsname{#5}% + \protected@write\@auxout{}{\string\@newglossary{#2}{#1}{#3}{#4}}% + \@ifundefined{gls@#2@display}{% + \expandafter\gdef\csname gls@#2@display\endcsname{% + \glsdisplay}}{}% + \@ifundefined{gls@#2@displayfirst}{% + \expandafter\gdef\csname gls@#2@displayfirst\endcsname{% + \glsdisplayfirst}}{}% + \@ifnextchar[{\@gls@setcounter{#2}}% + {\@gls@setcounter{#2}[\glscounter]}}} +\newcommand*{\altnewglossary}[3]{% + \newglossary[#2-glg]{#1}{#2-gls}{#2-glo}{#3}% +} +\@onlypreamble{\newglossary} +\@onlypremakeg\newglossary +\newcommand*{\@newglossary}[4]{} +\def\@gls@setcounter#1[#2]{% +\expandafter\def\csname @glotype@#1@counter\endcsname{#2}% +} +\newcommand*{\@gls@getcounter}[1]{% +\csname @glotype@#1@counter\endcsname} +\glsdefmain +\define@key{glossentry}{name}{% +\def\@glo@name{#1}% +} +\define@key{glossentry}{description}{% +\def\@glo@desc{#1}% +} +\define@key{glossentry}{descriptionplural}{% +\def\@glo@descplural{#1}% +} +\define@key{glossentry}{sort}{% +\def\@glo@sort{#1}} +\define@key{glossentry}{text}{% +\def\@glo@text{#1}% +} +\define@key{glossentry}{plural}{% +\def\@glo@plural{#1}% +} +\define@key{glossentry}{first}{% +\def\@glo@first{#1}% +} +\define@key{glossentry}{firstplural}{% +\def\@glo@firstplural{#1}% +} +\define@key{glossentry}{symbol}{% +\def\@glo@symbol{#1}% +} +\define@key{glossentry}{symbolplural}{% +\def\@glo@symbolplural{#1}% +} +\define@key{glossentry}{type}{% +\def\@glo@type{#1}} +\define@key{glossentry}{counter}{% +\@ifundefined{c@#1}{\PackageError{glossaries}{There is no counter +called `#1'}{The counter key should have the name of a valid +counter as its value}}{% +\def\@glo@counter{#1}}} +\define@key{glossentry}{see}{% +\def\@glo@see{#1}} +\define@key{glossentry}{parent}{% +\def\@glo@parent{#1}} +\define@key{glossentry}{nonumberlist}[none]{% +\def\@glo@prefix{\glsnonextpages}} +\define@key{glossentry}{user1}{% + \def\@glo@useri{#1}% +} +\define@key{glossentry}{user2}{% + \def\@glo@userii{#1}% +} +\define@key{glossentry}{user3}{% + \def\@glo@useriii{#1}% +} +\define@key{glossentry}{user4}{% + \def\@glo@useriv{#1}% +} +\define@key{glossentry}{user5}{% + \def\@glo@userv{#1}% +} +\define@key{glossentry}{user6}{% + \def\@glo@uservi{#1}% +} +\newcommand*{\@glsnoname}{% + \PackageError{glossaries}{name key required in + \string\newglossaryentry\space for entry `\@glo@label'}{You + haven't specified the entry name}} +\newcommand*{\@glsdefaultplural}{\@glo@text\glspluralsuffix} +\newcommand*{\@glsdefaultsort}{\@glo@name} +\newcount\gls@level +\DeclareRobustCommand{\newglossaryentry}[2]{% +\glsdoifnoexists{#1}{% +\def\@glo@label{#1}% +\let\@glo@name\@glsnoname +\def\@glo@desc{\PackageError{glossaries}{description key required in +\string\newglossaryentry\space for entry `\@glo@label'}{You haven't specified the entry description}}% +\def\@glo@descplural{\@glo@desc}% +\def\@glo@type{\glsdefaulttype}% +\def\@glo@symbol{\relax}% +\def\@glo@symbolplural{\@glo@symbol}% +\def\@glo@text{\@glo@name}% +\let\@glo@plural\@glsdefaultplural +\let\@glo@first\relax +\let\@glo@firstplural\relax +\let\@glo@sort\@glsdefaultsort +\def\@glo@counter{\@gls@getcounter{\@glo@type}}% +\def\@glo@see{}% +\def\@glo@parent{}% +\def\@glo@prefix{}% +\def\@glo@useri{}% +\def\@glo@userii{}% +\def\@glo@useriii{}% +\def\@glo@useriv{}% +\def\@glo@userv{}% +\def\@glo@uservi{}% + \@newglossaryentryprehook +\setkeys{glossentry}{#2}% +\@ifundefined{glolist@\@glo@type}{\PackageError{glossaries}{% +Glossary type '\@glo@type' has not been defined}{% +You need to define a new glossary type, before making entries +in it}}{% +\protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% +\expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% +}% +\gls@level=0\relax +\ifx\@glo@parent\@empty + \expandafter\gdef\csname glo@#1@parent\endcsname{}% +\else + \ifthenelse{\equal{#1}{\@glo@parent}}{% + \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }{% + \ifglsentryexists{\@glo@parent}{% + \expandafter\xdef\csname glo@#1@parent\endcsname{\@glo@parent}% + \gls@level=\csname glo@\@glo@parent @level\endcsname\relax + \advance\gls@level by 1\relax + \ifx\@glo@name\@glsnoname + \expandafter\let\expandafter\@glo@name + \csname glo@\@glo@parent @name\endcsname + \ifx\@glo@plural\@glsdefaultplural + \expandafter\let\expandafter\@glo@plural + \csname glo@\@glo@parent @plural\endcsname + \fi + \fi + }{% + \PackageError{glossaries}{Invalid parent `\@glo@parent' + for entry `#1' - parent doesn't exist}{Parent entries + must be defined before their children}% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }% + }% +\fi +\expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% +\ifx\relax\@glo@firstplural + \ifx\relax\@glo@first + \def\@glo@firstplural{\@glo@plural}% + \def\@glo@first{\@glo@text}% + \else + \def\@glo@firstplural{\@glo@first\glspluralsuffix}% + \fi +\else + \ifx\relax\@glo@first + \def\@glo@first{\@glo@text}% + \fi +\fi +\expandafter + \protected@xdef\csname glo@#1@text\endcsname{\@glo@text}% +\expandafter + \protected@xdef\csname glo@#1@plural\endcsname{\@glo@plural}% +\expandafter + \protected@xdef\csname glo@#1@first\endcsname{\@glo@first}% +\expandafter + \protected@xdef\csname glo@#1@firstpl\endcsname{\@glo@firstplural}% +\expandafter + \protected@xdef\csname glo@#1@type\endcsname{\@glo@type}% +\expandafter + \protected@xdef\csname glo@#1@counter\endcsname{\@glo@counter}% +\expandafter + \protected@xdef\csname glo@#1@useri\endcsname{\@glo@useri}% +\expandafter + \protected@xdef\csname glo@#1@userii\endcsname{\@glo@userii}% +\expandafter + \protected@xdef\csname glo@#1@useriii\endcsname{\@glo@useriii}% +\expandafter + \protected@xdef\csname glo@#1@useriv\endcsname{\@glo@useriv}% +\expandafter + \protected@xdef\csname glo@#1@userv\endcsname{\@glo@userv}% +\expandafter + \protected@xdef\csname glo@#1@uservi\endcsname{\@glo@uservi}% +\@gls@sanitizename +\expandafter\protected@xdef\csname glo@#1@name\endcsname{\@glo@name}% +\def\@glo@@desc{\@glo@first}% +\ifx\@glo@desc\@glo@@desc + \let\@glo@desc\@glo@first +\fi +\@gls@sanitizedesc +\expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% +\expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% +\ifx\@glo@sort\@glsdefaultsort + \let\@glo@sort\@glo@name +\fi +\@onelevel@sanitize\@glo@sort +\expandafter\protected@xdef\csname glo@#1@sort\endcsname{\@glo@sort}% +\def\@glo@@symbol{\@glo@text}% +\ifx\@glo@symbol\@glo@@symbol + \let\@glo@symbol\@glo@text +\fi +\@gls@sanitizesymbol +\expandafter\protected@xdef\csname glo@#1@symbol\endcsname{\@glo@symbol}% +\expandafter\protected@xdef\csname glo@#1@symbolplural\endcsname{\@glo@symbolplural}% +\expandafter\gdef\csname glo@#1@flagfalse\endcsname{% +\expandafter\global\expandafter +\let\csname ifglo@#1@flag\endcsname\iffalse}% +\expandafter\gdef\csname glo@#1@flagtrue\endcsname{% +\expandafter\global\expandafter +\let\csname ifglo@#1@flag\endcsname\iftrue}% +\csname glo@#1@flagfalse\endcsname +\ifx\@glo@see\@empty +\else + \protected@edef\@do@glssee{% + \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see + \noexpand\@nil + \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% + \@do@glssee +\fi +}% + \@glo@storeentry{#1}% + \@newglossaryentryposthook +} +\newcommand*{\@newglossaryentryprehook}{} +\newcommand*{\@newglossaryentryposthook}{} +\ifglsxindy + \newcommand*{\@glossaryentryfield}{\string\\glossaryentryfield} +\else + \newcommand*{\@glossaryentryfield}{\string\glossaryentryfield} +\fi +\ifglsxindy + \newcommand*{\@glossarysubentryfield}{% + \string\\glossarysubentryfield} +\else + \newcommand*{\@glossarysubentryfield}{% + \string\glossarysubentryfield} +\fi +\newcommand{\@glo@storeentry}[1]{% +\protected@edef\@glo@sort{\csname glo@#1@sort\endcsname}% +\@gls@checkmkidxchars\@glo@sort +\protected@edef\@@glo@name{\csname glo@#1@name\endcsname}% +\@gls@checkmkidxchars\@@glo@name +\ifglsxindy + \protected@edef\@glo@name{\string\\glsnamefont{\@@glo@name}}% +\else + \protected@edef\@glo@name{\string\glsnamefont{\@@glo@name}}% +\fi +\protected@edef\@glo@desc{\csname glo@#1@desc\endcsname}% +\@gls@checkmkidxchars\@glo@desc +\protected@edef\@glo@symbol{\csname glo@#1@symbol\endcsname}% +\@gls@checkmkidxchars\@glo@symbol +\@gls@checkmkidxchars\@glo@prefix +\edef\@glo@parent{\csname glo@#1@parent\endcsname}% +\ifglsxindy + \ifx\@glo@parent\@empty + \expandafter\protected@xdef\csname glo@#1@index\endcsname{% + (\string"\@glo@sort\string" % + \string"\@glo@prefix\@glossaryentryfield{#1}{\@glo@name + }{\@glo@desc}{\@glo@symbol}\string") % + }% + \else + \expandafter\protected@xdef\csname glo@#1@index\endcsname{% + \csname glo@\@glo@parent @index\endcsname + (\string"\@glo@sort\string" % + \string"\@glo@prefix\@glossarysubentryfield% + {\csname glo@#1@level\endcsname}{#1}{\@glo@name + }{\@glo@desc}{\@glo@symbol}\string") % + }% + \fi +\else + \ifx\@glo@parent\@empty + \@onelevel@sanitize\@glo@prefix + \expandafter\protected@xdef\csname glo@#1@index\endcsname{% + \@glo@sort\@gls@actualchar\@glo@prefix + \@glossaryentryfield{#1}{\@glo@name}{\@glo@desc + }{\@glo@symbol}% + }% + \else + \expandafter\protected@xdef\csname glo@#1@index\endcsname{% + \csname glo@\@glo@parent @index\endcsname\@gls@levelchar + \@glo@sort\@gls@actualchar\@glo@prefix + \@glossarysubentryfield + {\csname glo@#1@level\endcsname}{#1}{\@glo@name}{\@glo@desc + }{\@glo@symbol}% + }% + \fi +\fi +} +\newcommand*{\glsreset}[1]{% +\glsdoifexists{#1}{% +\expandafter\global\csname glo@#1@flagfalse\endcsname}} +\newcommand*{\glslocalreset}[1]{% +\glsdoifexists{#1}{% +\expandafter\let\csname ifglo@#1@flag\endcsname\iffalse}} +\newcommand*{\glsunset}[1]{% +\glsdoifexists{#1}{% +\expandafter\global\csname glo@#1@flagtrue\endcsname}} +\newcommand*{\glslocalunset}[1]{% +\glsdoifexists{#1}{% +\expandafter\let\csname ifglo@#1@flag\endcsname\iftrue}} +\newcommand*{\glsresetall}[1][\@glo@types]{% +\forallglsentries[#1]{\@glsentry}{% +\glsreset{\@glsentry}}} +\newcommand*{\glslocalresetall}[1][\@glo@types]{% +\forallglsentries[#1]{\@glsentry}{% +\glslocalreset{\@glsentry}}} +\newcommand*{\glsunsetall}[1][\@glo@types]{% +\forallglsentries[#1]{\@glsentry}{% +\glsunset{\@glsentry}}} +\newcommand*{\glslocalunsetall}[1][\@glo@types]{% +\forallglsentries[#1]{\@glsentry}{% +\glslocalunset{\@glsentry}}} +\newcommand*{\loadglsentries}[2][\@gls@default]{% +\let\@gls@default\glsdefaulttype +\def\glsdefaulttype{#1}\input{#2}% +\let\glsdefaulttype\@gls@default} +\@onlypreamble{\loadglsentries} +\newcommand*{\glstextformat}[1]{#1} +\newcommand*{\glsdisplayfirst}[4]{#1#4} +\newcommand*{\glsdisplay}[4]{#1#4} +\newcommand*{\defglsdisplay}[2][\glsdefaulttype]{% +\expandafter\def\csname gls@#1@display\endcsname##1##2##3##4{#2}} +\newcommand*{\defglsdisplayfirst}[2][\glsdefaulttype]{% +\expandafter\def\csname gls@#1@displayfirst\endcsname##1##2##3##4{#2}} +\define@key{glslink}{counter}{% +\@ifundefined{c@#1}{\PackageError{glossaries}{There is no counter +called `#1'}{The counter key should have the name of a valid +counter as its value}}{% +\def\@gls@counter{#1}}} +\define@key{glslink}{format}{% +\def\@glsnumberformat{#1}} +\define@boolkey{glslink}{hyper}[true]{} +\newcommand{\glslink}{% +\@ifstar\@sgls@link\@gls@@link} +\newcommand*{\@sgls@link}[1][]{\@gls@@link[hyper=false,#1]} +\newcommand*{\@gls@@link}[3][]{% + \ifglsentryexists{#2}% + {% + \@gls@link[#1]{#2}{#3}% + }{% + \PackageError{glossaries}{Glossary entry `#2' has not been + defined}{You need to define a glossary entry before you + can use it.}% + \glstextformat{#3}% + }% +} +\def\@gls@link[#1]#2#3{% + \leavevmode + \def\glslabel{#2}% + \def\@glsnumberformat{glsnumberformat}% + \edef\@gls@counter{\csname glo@#2@counter\endcsname}% + \KV@glslink@hypertrue + \setkeys{glslink}{#1}% + \edef\theglsentrycounter{\expandafter\noexpand + \csname the\@gls@counter\endcsname}% + \@do@wrglossary{#2}% + \ifKV@glslink@hyper + \@glslink{glo:#2}{\glstextformat{#3}}% + \else + \glstextformat{#3}\relax + \fi +} +\def\@set@glo@numformat#1#2#3{% +\expandafter\@glo@check@mkidxrangechar#3\@nil +\protected@edef#1{\@glo@prefix setentrycounter{#2}% +\expandafter\string\csname\@glo@suffix\endcsname}% +\@gls@checkmkidxchars#1} +\def\@glo@check@mkidxrangechar#1#2\@nil{% +\if#1(\relax + \def\@glo@prefix{(}% + \if\relax#2\relax + \def\@glo@suffix{glsnumberformat}% + \else + \def\@glo@suffix{#2}% + \fi +\else + \if#1)\relax + \def\@glo@prefix{)}% + \if\relax#2\relax + \def\@glo@suffix{glsnumberformat}% + \else + \def\@glo@suffix{#2}% + \fi + \else + \def\@glo@prefix{}\def\@glo@suffix{#1#2}% + \fi +\fi} +\newcommand*{\@gls@escbsdq}[1]{% + \def\@gls@checkedmkidx{}% + \let\gls@xdystring=#1\relax + \@onelevel@sanitize\gls@xdystring + \edef\do@gls@xdycheckbackslash{% + \noexpand\@gls@xdycheckbackslash\gls@xdystring\noexpand\@nil + \@backslashchar\@backslashchar\noexpand\null}% + \do@gls@xdycheckbackslash + \expandafter\@gls@updatechecked\@gls@checkedmkidx{\gls@xdystring}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@xdycheckquote\gls@xdystring\@nil""\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{\gls@xdystring}% + \let#1=\gls@xdystring +} +\newcommand{\@gls@checkmkidxchars}[1]{% +\ifglsxindy + \@gls@escbsdq{#1}% +\else + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkquote#1\@nil""\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkescquote#1\@nil\"\"\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkescactual#1\@nil\?\?\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkactual#1\@nil??\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkbar#1\@nil||\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checkescbar#1\@nil\|\|\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% + \def\@gls@checkedmkidx{}% + \expandafter\@gls@checklevel#1\@nil!!\null + \expandafter\@gls@updatechecked\@gls@checkedmkidx{#1}% +\fi +} +\def\@gls@updatechecked#1\@nil#2{\def#2{#1}} +\newtoks\@gls@tmpb +\def\@gls@checkquote#1"#2"#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkquote{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@quotechar\@gls@quotechar\@gls@quotechar}% + \def\@@gls@checkquote{\@gls@checkquote#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@quotechar}% + \ifx\null#3\null + \def\@@gls@checkquote{\@gls@checkquote#2""\null}% + \else + \def\@@gls@checkquote{\@gls@checkquote#2"#3\null}% + \fi +\fi +\@@gls@checkquote} +\def\@gls@checkescquote#1\"#2\"#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkescquote{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@quotechar + \@gls@quotechar\string\"\@gls@quotechar}% + \def\@@gls@checkescquote{\@gls@checkescquote#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@quotechar}% + \ifx\null#3\null + \def\@@gls@checkescquote{\@gls@checkescquote#2\"\"\null}% + \else + \def\@@gls@checkescquote{\@gls@checkescquote#2\"#3\null}% + \fi +\fi +\@@gls@checkescquote} +\def\@gls@checkescactual#1\?#2\?#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkescactual{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@actualchar + \@gls@quotechar\string\"\@gls@actualchar}% + \def\@@gls@checkescactual{\@gls@checkescactual#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@actualchar}% + \ifx\null#3\null + \def\@@gls@checkescactual{\@gls@checkescactual#2\?\?\null}% + \else + \def\@@gls@checkescactual{\@gls@checkescactual#2\?#3\null}% + \fi +\fi +\@@gls@checkescactual} +\def\@gls@checkescbar#1\|#2\|#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkescbar{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@encapchar + \@gls@quotechar\string\"\@gls@encapchar}% + \def\@@gls@checkescbar{\@gls@checkescbar#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@encapchar}% + \ifx\null#3\null + \def\@@gls@checkescbar{\@gls@checkescbar#2\|\|\null}% + \else + \def\@@gls@checkescbar{\@gls@checkescbar#2\|#3\null}% + \fi +\fi +\@@gls@checkescbar} +\def\@gls@checkesclevel#1\!#2\!#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkesclevel{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@levelchar + \@gls@quotechar\string\"\@gls@levelchar}% + \def\@@gls@checkesclevel{\@gls@checkesclevel#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\string\"\@gls@levelchar}% + \ifx\null#3\null + \def\@@gls@checkesclevel{\@gls@checkesclevel#2\!\!\null}% + \else + \def\@@gls@checkesclevel{\@gls@checkesclevel#2\!#3\null}% + \fi +\fi +\@@gls@checkesclevel} +\def\@gls@checkbar#1|#2|#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkbar{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@encapchar\@gls@quotechar\@gls@encapchar}% + \def\@@gls@checkbar{\@gls@checkbar#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@encapchar}% + \ifx\null#3\null + \def\@@gls@checkbar{\@gls@checkbar#2||\null}% + \else + \def\@@gls@checkbar{\@gls@checkbar#2|#3\null}% + \fi +\fi +\@@gls@checkbar} +\def\@gls@checklevel#1!#2!#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checklevel{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@levelchar\@gls@quotechar\@gls@levelchar}% + \def\@@gls@checklevel{\@gls@checklevel#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@levelchar}% + \ifx\null#3\null + \def\@@gls@checklevel{\@gls@checklevel#2!!\null}% + \else + \def\@@gls@checklevel{\@gls@checklevel#2!#3\null}% + \fi +\fi +\@@gls@checklevel} +\def\@gls@checkactual#1?#2?#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@checkactual{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@actualchar\@gls@quotechar\@gls@actualchar}% + \def\@@gls@checkactual{\@gls@checkactual#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \@gls@quotechar\@gls@actualchar}% + \ifx\null#3\null + \def\@@gls@checkactual{\@gls@checkactual#2??\null}% + \else + \def\@@gls@checkactual{\@gls@checkactual#2?#3\null}% + \fi +\fi +\@@gls@checkactual} +\def\@gls@xdycheckquote#1"#2"#3\null{% +\@gls@tmpb=\expandafter{\@gls@checkedmkidx}% +\toks@={#1}% +\ifx\null#2\null + \ifx\null#3\null + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@}% + \def\@@gls@xdycheckquote{\relax}% + \else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \string\"\string\"}% + \def\@@gls@xdycheckquote{\@gls@xdycheckquote#3\null}% + \fi +\else + \edef\@gls@checkedmkidx{\the\@gls@tmpb\the\toks@ + \string\"}% + \ifx\null#3\null + \def\@@gls@xdycheckquote{\@gls@xdycheckquote#2""\null}% + \else + \def\@@gls@xdycheckquote{\@gls@xdycheckquote#2"#3\null}% + \fi +\fi +\@@gls@xdycheckquote +} +\edef\def@gls@xdycheckbackslash{% + \noexpand\def\noexpand\@gls@xdycheckbackslash##1\@backslashchar + ##2\@backslashchar##3\noexpand\null{% + \noexpand\@gls@tmpb=\noexpand\expandafter + {\noexpand\@gls@checkedmkidx}% + \noexpand\toks@={##1}% + \noexpand\ifx\noexpand\null##2\noexpand\null + \noexpand\ifx\noexpand\null##3\noexpand\null + \noexpand\edef\noexpand\@gls@checkedmkidx{% + \noexpand\the\noexpand\@gls@tmpb\noexpand\the\noexpand\toks@}% + \noexpand\def\noexpand\@@gls@xdycheckbackslash{\relax}% + \noexpand\else + \noexpand\edef\noexpand\@gls@checkedmkidx{% + \noexpand\the\noexpand\@gls@tmpb\noexpand\the\noexpand\toks@ + \@backslashchar\@backslashchar\@backslashchar\@backslashchar}% + \noexpand\def\noexpand\@@gls@xdycheckbackslash{% + \noexpand\@gls@xdycheckbackslash##3\noexpand\null}% + \noexpand\fi + \noexpand\else + \noexpand\edef\noexpand\@gls@checkedmkidx{% + \noexpand\the\noexpand\@gls@tmpb\noexpand\the\noexpand\toks@ + \@backslashchar\@backslashchar}% + \noexpand\ifx\noexpand\null##3\noexpand\null + \noexpand\def\noexpand\@@gls@xdycheckbackslash{% + \noexpand\@gls@xdycheckbackslash##2\@backslashchar + \@backslashchar\noexpand\null}% + \noexpand\else + \noexpand\def\noexpand\@@gls@xdycheckbackslash{% + \noexpand\@gls@xdycheckbackslash##2\@backslashchar + ##3\noexpand\null}% + \noexpand\fi + \noexpand\fi + \noexpand\@@gls@xdycheckbackslash + }% +} +\def@gls@xdycheckbackslash +\@ifundefined{hyperlink}{% + \gdef\@glslink#1#2{#2}% +}{% + \gdef\@glslink#1#2{\hyperlink{#1}{#2}}% +} +\newlength\gls@tmplen +\@ifundefined{hypertarget}{% + \gdef\@glstarget#1#2{#2}% +}{% + \gdef\@glstarget#1#2{% + \settoheight{\gls@tmplen}{#2}% + \raisebox{\gls@tmplen}{\hypertarget{#1}{}}#2}% +} +\newcommand{\glsdisablehyper}{% +\renewcommand*\@glslink[2]{##2}% +\renewcommand*\@glstarget[2]{##2}} +\newcommand{\glsenablehyper}{% +\renewcommand*\@glslink[2]{\hyperlink{##1}{##2}}% +\renewcommand*\@glstarget[2]{% + \settoheight{\gls@tmplen}{##2}% + \raisebox{\gls@tmplen}{\hypertarget{##1}{}}##2}} +\newcommand*{\gls}{\@ifstar\@sgls\@gls} +\newcommand*{\@sgls}[1][]{\@gls[hyper=false,#1]} +\newcommand*{\@gls}[2][]{% +\new@ifnextchar[{\@gls@{#1}{#2}}{\@gls@{#1}{#2}[]}} +\def\@gls@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\ifglsused{#2}% +{% + \def\@glo@text{% + \csname gls@\@glo@type @display\endcsname + {\glsentrytext{#2}}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{#3}}% +}% +{% + \def\@glo@text{% + \csname gls@\@glo@type @displayfirst\endcsname + {\glsentryfirst{#2}}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{#3}}% +}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{\@glo@text}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{\@glo@text}% + }{% + \@gls@link[#1]{#2}{\@glo@text}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\Gls}{\@ifstar\@sGls\@Gls} +\newcommand*{\@sGls}[1][]{\@Gls[hyper=false,#1]} +\newcommand*{\@Gls}[2][]{% +\new@ifnextchar[{\@Gls@{#1}{#2}}{\@Gls@{#1}{#2}[]}} +\def\@Gls@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\def\glslabel{#2}% +\ifglsused{#2}% +{% + \protected@edef\@glo@text{% + \csname gls@\@glo@type @display\endcsname + {\glsentrytext{#2}}{\glsentrydesc{#2}}% + {\glsentrysymbol{#2}}{#3}}% +}% +{% + \protected@edef\@glo@text{% + \csname gls@\@glo@type @displayfirst\endcsname + {\glsentryfirst{#2}}{\glsentrydesc{#2}}% + {\glsentrysymbol{#2}}{#3}}% +}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% + }{% + \@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\GLS}{\@ifstar\@sGLS\@GLS} +\newcommand*{\@sGLS}[1][]{\@GLS[hyper=false,#1]} +\newcommand*{\@GLS}[2][]{% +\new@ifnextchar[{\@GLS@{#1}{#2}}{\@GLS@{#1}{#2}[]}} +\def\@GLS@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\ifglsused{#2}{\def\@glo@text{% +\csname gls@\@glo@type @display\endcsname +{\glsentrytext{#2}}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{#3}}}{% +\def\@glo@text{% +\csname gls@\@glo@type @displayfirst\endcsname +{\glsentryfirst{#2}}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{#3}}}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{\MakeUppercase{\@glo@text}}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{\MakeUppercase{\@glo@text}}% + }{% + \@gls@link[#1]{#2}{\MakeUppercase{\@glo@text}}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\glspl}{\@ifstar\@sglspl\@glspl} +\newcommand*{\@sglspl}[1][]{\@glspl[hyper=false,#1]} +\newcommand*{\@glspl}[2][]{% +\new@ifnextchar[{\@glspl@{#1}{#2}}{\@glspl@{#1}{#2}[]}} +\def\@glspl@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\ifglsused{#2}% +{% + \def\@glo@text{% + \csname gls@\@glo@type @display\endcsname + {\glsentryplural{#2}}{\glsentrydescplural{#2}}% + {\glsentrysymbolplural{#2}}{#3}}% +}% +{% + \def\@glo@text{% + \csname gls@\@glo@type @displayfirst\endcsname + {\glsentryfirstplural{#2}}{\glsentrydescplural{#2}}% + {\glsentrysymbolplural{#2}}{#3}}% +}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{\@glo@text}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{\@glo@text}% + }{% + \@gls@link[#1]{#2}{\@glo@text}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\Glspl}{\@ifstar\@sGlspl\@Glspl} +\newcommand*{\@sGlspl}[1][]{\@Glspl[hyper=false,#1]} +\newcommand*{\@Glspl}[2][]{% +\new@ifnextchar[{\@Glspl@{#1}{#2}}{\@Glspl@{#1}{#2}[]}} +\def\@Glspl@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\def\glslabel{#2}% +\ifglsused{#2}% +{% + \protected@edef\@glo@text{% + \csname gls@\@glo@type @display\endcsname + {\glsentryplural{#2}}{\glsentrydescplural{#2}}% + {\glsentrysymbolplural{#2}}{#3}}% +}% +{% + \protected@edef\@glo@text{% + \csname gls@\@glo@type @displayfirst\endcsname + {\glsentryfirstplural{#2}}{\glsentrydescplural{#2}}% + {\glsentrysymbolplural{#2}}{#3}}% +}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% + }{% + \@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\GLSpl}{\@ifstar\@sGLSpl\@GLSpl} +\newcommand*{\@sGLSpl}[1][]{\@GLSpl[hyper=false,#1]} +\newcommand*{\@GLSpl}[2][]{% +\new@ifnextchar[{\@GLSpl@{#1}{#2}}{\@GLSpl@{#1}{#2}[]}} +\def\@GLSpl@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\def\@gls@link@opts{#1}% +\def\@gls@link@label{#2}% +\ifglsused{#2}{\def\@glo@text{% +\csname gls@\@glo@type @display\endcsname +{\glsentryplural{#2}}{\glsentrydescplural{#2}}{% +\glsentrysymbolplural{#2}}{#3}}}{% +\def\@glo@text{% +\csname gls@\@glo@type @displayfirst\endcsname +{\glsentryfirstplural{#2}}{\glsentrydescplural{#2}}{% +\glsentrysymbolplural{#2}}{#3}}}% +\ifglsused{#2}{% + \@gls@link[#1]{#2}{\MakeUppercase{\@glo@text}}% +}{% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}{% + \@gls@link[#1,hyper=false]{#2}{\MakeUppercase{\@glo@text}}% + }{% + \@gls@link[#1]{#2}{\MakeUppercase{\@glo@text}}% + }% +}% +\glsunset{#2}}% +} +\newcommand*{\glsdisp}{\@ifstar\@sglsdisp\@glsdisp} +\newcommand*{\@sglsdisp}[1][]{\@glsdisp[hyper=false,#1]} +\newcommand*{\@glsdisp}[3][]{% + \glsdoifexists{#2}{% + \edef\@glo@type{\glsentrytype{#2}}% + \def\@gls@link@opts{#1}% + \def\@gls@link@label{#2}% + \ifglsused{#2}% + {% + \def\@glo@text{% + \csname gls@\@glo@type @display\endcsname + {#3}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{}}% + }% + {% + \def\@glo@text{% + \csname gls@\@glo@type @displayfirst\endcsname + {#3}{\glsentrydesc{#2}}{\glsentrysymbol{#2}}{}}% + }% + \ifglsused{#2}% + {% + \@gls@link[#1]{#2}{\@glo@text}% + }% + {% + \gls@checkisacronymlist\@glo@type + \ifthenelse{\(\boolean{@glsisacronymlist}\AND + \boolean{glsacrfootnote}\) \OR \NOT\boolean{glshyperfirst}}% + {% + \@gls@link[#1,hyper=false]{#2}{\@glo@text}% + }% + {% + \@gls@link[#1]{#2}{\@glo@text}% + }% + }% + \glsunset{#2}% + }% +} +\newcommand*{\glstext}{\@ifstar\@sglstext\@glstext} +\newcommand*{\@sglstext}[1][]{\@glstext[hyper=false,#1]} +\newcommand*{\@glstext}[2][]{% +\new@ifnextchar[{\@glstext@{#1}{#2}}{\@glstext@{#1}{#2}[]}} +\def\@glstext@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrytext{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\GLStext}{\@ifstar\@sGLStext\@GLStext} +\newcommand*{\@sGLStext}[1][]{\@GLStext[hyper=false,#1]} +\newcommand*{\@GLStext}[2][]{% +\new@ifnextchar[{\@GLStext@{#1}{#2}}{\@GLStext@{#1}{#2}[]}} +\def\@GLStext@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrytext{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\Glstext}{\@ifstar\@sGlstext\@Glstext} +\newcommand*{\@sGlstext}[1][]{\@Glstext[hyper=false,#1]} +\newcommand*{\@Glstext}[2][]{% +\new@ifnextchar[{\@Glstext@{#1}{#2}}{\@Glstext@{#1}{#2}[]}} +\def\@Glstext@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrytext{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\glsfirst}{\@ifstar\@sglsfirst\@glsfirst} +\newcommand*{\@sglsfirst}[1][]{\@glsfirst[hyper=false,#1]} +\newcommand*{\@glsfirst}[2][]{% +\new@ifnextchar[{\@glsfirst@{#1}{#2}}{\@glsfirst@{#1}{#2}[]}} +\def\@glsfirst@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirst{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsfirst}{\@ifstar\@sGlsfirst\@Glsfirst} +\newcommand*{\@sGlsfirst}[1][]{\@Glsfirst[hyper=false,#1]} +\newcommand*{\@Glsfirst}[2][]{% +\new@ifnextchar[{\@Glsfirst@{#1}{#2}}{\@Glsfirst@{#1}{#2}[]}} +\def\@Glsfirst@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirst{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSfirst}{\@ifstar\@sGLSfirst\@GLSfirst} +\newcommand*{\@sGLSfirst}[1][]{\@GLSfirst[hyper=false,#1]} +\newcommand*{\@GLSfirst}[2][]{% +\new@ifnextchar[{\@GLSfirst@{#1}{#2}}{\@GLSfirst@{#1}{#2}[]}} +\def\@GLSfirst@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirst{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsplural}{\@ifstar\@sglsplural\@glsplural} +\newcommand*{\@sglsplural}[1][]{\@glsplural[hyper=false,#1]} +\newcommand*{\@glsplural}[2][]{% +\new@ifnextchar[{\@glsplural@{#1}{#2}}{\@glsplural@{#1}{#2}[]}} +\def\@glsplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryplural{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsplural}{\@ifstar\@sGlsplural\@Glsplural} +\newcommand*{\@sGlsplural}[1][]{\@Glsplural[hyper=false,#1]} +\newcommand*{\@Glsplural}[2][]{% +\new@ifnextchar[{\@Glsplural@{#1}{#2}}{\@Glsplural@{#1}{#2}[]}} +\def\@Glsplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryplural{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSplural}{\@ifstar\@sGLSplural\@GLSplural} +\newcommand*{\@sGLSplural}[1][]{\@GLSplural[hyper=false,#1]} +\newcommand*{\@GLSplural}[2][]{% +\new@ifnextchar[{\@GLSplural@{#1}{#2}}{\@GLSplural@{#1}{#2}[]}} +\def\@GLSplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryplural{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsfirstplural}{\@ifstar\@sglsfirstplural\@glsfirstplural} +\newcommand*{\@sglsfirstplural}[1][]{\@glsfirstplural[hyper=false,#1]} +\newcommand*{\@glsfirstplural}[2][]{% +\new@ifnextchar[{\@glsfirstplural@{#1}{#2}}{\@glsfirstplural@{#1}{#2}[]}} +\def\@glsfirstplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirstplural{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsfirstplural}{\@ifstar\@sGlsfirstplural\@Glsfirstplural} +\newcommand*{\@sGlsfirstplural}[1][]{\@Glsfirstplural[hyper=false,#1]} +\newcommand*{\@Glsfirstplural}[2][]{% +\new@ifnextchar[{\@Glsfirstplural@{#1}{#2}}{\@Glsfirstplural@{#1}{#2}[]}} +\def\@Glsfirstplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirstplural{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSfirstplural}{\@ifstar\@sGLSfirstplural\@GLSfirstplural} +\newcommand*{\@sGLSfirstplural}[1][]{\@GLSfirstplural[hyper=false,#1]} +\newcommand*{\@GLSfirstplural}[2][]{% +\new@ifnextchar[{\@GLSfirstplural@{#1}{#2}}{\@GLSfirstplural@{#1}{#2}[]}} +\def\@GLSfirstplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryfirstplural{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsname}{\@ifstar\@sglsname\@glsname} +\newcommand*{\@sglsname}[1][]{\@glsname[hyper=false,#1]} +\newcommand*{\@glsname}[2][]{% +\new@ifnextchar[{\@glsname@{#1}{#2}}{\@glsname@{#1}{#2}[]}} +\def\@glsname@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryname{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsname}{\@ifstar\@sGlsname\@Glsname} +\newcommand*{\@sGlsname}[1][]{\@Glsname[hyper=false,#1]} +\newcommand*{\@Glsname}[2][]{% +\new@ifnextchar[{\@Glsname@{#1}{#2}}{\@Glsname@{#1}{#2}[]}} +\def\@Glsname@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryname{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSname}{\@ifstar\@sGLSname\@GLSname} +\newcommand*{\@sGLSname}[1][]{\@GLSname[hyper=false,#1]} +\newcommand*{\@GLSname}[2][]{% +\new@ifnextchar[{\@GLSname@{#1}{#2}}{\@GLSname@{#1}{#2}[]}} +\def\@GLSname@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryname{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsdesc}{\@ifstar\@sglsdesc\@glsdesc} +\newcommand*{\@sglsdesc}[1][]{\@glsdesc[hyper=false,#1]} +\newcommand*{\@glsdesc}[2][]{% +\new@ifnextchar[{\@glsdesc@{#1}{#2}}{\@glsdesc@{#1}{#2}[]}} +\def\@glsdesc@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydesc{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsdesc}{\@ifstar\@sGlsdesc\@Glsdesc} +\newcommand*{\@sGlsdesc}[1][]{\@Glsdesc[hyper=false,#1]} +\newcommand*{\@Glsdesc}[2][]{% +\new@ifnextchar[{\@Glsdesc@{#1}{#2}}{\@Glsdesc@{#1}{#2}[]}} +\def\@Glsdesc@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydesc{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSdesc}{\@ifstar\@sGLSdesc\@GLSdesc} +\newcommand*{\@sGLSdesc}[1][]{\@GLSdesc[hyper=false,#1]} +\newcommand*{\@GLSdesc}[2][]{% +\new@ifnextchar[{\@GLSdesc@{#1}{#2}}{\@GLSdesc@{#1}{#2}[]}} +\def\@GLSdesc@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydesc{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsdescplural}{\@ifstar\@sglsdescplural\@glsdescplural} +\newcommand*{\@sglsdescplural}[1][]{\@glsdescplural[hyper=false,#1]} +\newcommand*{\@glsdescplural}[2][]{% +\new@ifnextchar[{\@glsdescplural@{#1}{#2}}{\@glsdescplural@{#1}{#2}[]}} +\def\@glsdescplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydescplural{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsdescplural}{\@ifstar\@sGlsdescplural\@Glsdescplural} +\newcommand*{\@sGlsdescplural}[1][]{\@Glsdescplural[hyper=false,#1]} +\newcommand*{\@Glsdescplural}[2][]{% +\new@ifnextchar[{\@Glsdescplural@{#1}{#2}}{\@Glsdescplural@{#1}{#2}[]}} +\def\@Glsdescplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydescplural{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSdescplural}{\@ifstar\@sGLSdescplural\@GLSdescplural} +\newcommand*{\@sGLSdescplural}[1][]{\@GLSdescplural[hyper=false,#1]} +\newcommand*{\@GLSdescplural}[2][]{% +\new@ifnextchar[{\@GLSdescplural@{#1}{#2}}{\@GLSdescplural@{#1}{#2}[]}} +\def\@GLSdescplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrydescplural{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glssymbol}{\@ifstar\@sglssymbol\@glssymbol} +\newcommand*{\@sglssymbol}[1][]{\@glssymbol[hyper=false,#1]} +\newcommand*{\@glssymbol}[2][]{% +\new@ifnextchar[{\@glssymbol@{#1}{#2}}{\@glssymbol@{#1}{#2}[]}} +\def\@glssymbol@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbol{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glssymbol}{\@ifstar\@sGlssymbol\@Glssymbol} +\newcommand*{\@sGlssymbol}[1][]{\@Glssymbol[hyper=false,#1]} +\newcommand*{\@Glssymbol}[2][]{% +\new@ifnextchar[{\@Glssymbol@{#1}{#2}}{\@Glssymbol@{#1}{#2}[]}} +\def\@Glssymbol@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbol{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSsymbol}{\@ifstar\@sGLSsymbol\@GLSsymbol} +\newcommand*{\@sGLSsymbol}[1][]{\@GLSsymbol[hyper=false,#1]} +\newcommand*{\@GLSsymbol}[2][]{% +\new@ifnextchar[{\@GLSsymbol@{#1}{#2}}{\@GLSsymbol@{#1}{#2}[]}} +\def\@GLSsymbol@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbol{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glssymbolplural}{\@ifstar\@sglssymbolplural\@glssymbolplural} +\newcommand*{\@sglssymbolplural}[1][]{\@glssymbolplural[hyper=false,#1]} +\newcommand*{\@glssymbolplural}[2][]{% +\new@ifnextchar[{\@glssymbolplural@{#1}{#2}}{\@glssymbolplural@{#1}{#2}[]}} +\def\@glssymbolplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbolplural{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glssymbolplural}{\@ifstar\@sGlssymbolplural\@Glssymbolplural} +\newcommand*{\@sGlssymbolplural}[1][]{\@Glssymbolplural[hyper=false,#1]} +\newcommand*{\@Glssymbolplural}[2][]{% +\new@ifnextchar[{\@Glssymbolplural@{#1}{#2}}{\@Glssymbolplural@{#1}{#2}[]}} +\def\@Glssymbolplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbolplural{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSsymbolplural}{\@ifstar\@sGLSsymbolplural\@GLSsymbolplural} +\newcommand*{\@sGLSsymbolplural}[1][]{\@GLSsymbolplural[hyper=false,#1]} +\newcommand*{\@GLSsymbolplural}[2][]{% +\new@ifnextchar[{\@GLSsymbolplural@{#1}{#2}}{\@GLSsymbolplural@{#1}{#2}[]}} +\def\@GLSsymbolplural@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentrysymbolplural{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuseri}{\@ifstar\@sglsuseri\@glsuseri} +\newcommand*{\@sglsuseri}[1][]{\@glsuseri[hyper=false,#1]} +\newcommand*{\@glsuseri}[2][]{% +\new@ifnextchar[{\@glsuseri@{#1}{#2}}{\@glsuseri@{#1}{#2}[]}} +\def\@glsuseri@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseri{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuseri}{\@ifstar\@sGlsuseri\@Glsuseri} +\newcommand*{\@sGlsuseri}[1][]{\@Glsuseri[hyper=false,#1]} +\newcommand*{\@Glsuseri}[2][]{% +\new@ifnextchar[{\@Glsuseri@{#1}{#2}}{\@Glsuseri@{#1}{#2}[]}} +\def\@Glsuseri@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseri{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuseri}{\@ifstar\@sGLSuseri\@GLSuseri} +\newcommand*{\@sGLSuseri}[1][]{\@GLSuseri[hyper=false,#1]} +\newcommand*{\@GLSuseri}[2][]{% +\new@ifnextchar[{\@GLSuseri@{#1}{#2}}{\@GLSuseri@{#1}{#2}[]}} +\def\@GLSuseri@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseri{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuserii}{\@ifstar\@sglsuserii\@glsuserii} +\newcommand*{\@sglsuserii}[1][]{\@glsuserii[hyper=false,#1]} +\newcommand*{\@glsuserii}[2][]{% +\new@ifnextchar[{\@glsuserii@{#1}{#2}}{\@glsuserii@{#1}{#2}[]}} +\def\@glsuserii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserii{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuserii}{\@ifstar\@sGlsuserii\@Glsuserii} +\newcommand*{\@sGlsuserii}[1][]{\@Glsuserii[hyper=false,#1]} +\newcommand*{\@Glsuserii}[2][]{% +\new@ifnextchar[{\@Glsuserii@{#1}{#2}}{\@Glsuserii@{#1}{#2}[]}} +\def\@Glsuserii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserii{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuserii}{\@ifstar\@sGLSuserii\@GLSuserii} +\newcommand*{\@sGLSuserii}[1][]{\@GLSuserii[hyper=false,#1]} +\newcommand*{\@GLSuserii}[2][]{% +\new@ifnextchar[{\@GLSuserii@{#1}{#2}}{\@GLSuserii@{#1}{#2}[]}} +\def\@GLSuserii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserii{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuseriii}{\@ifstar\@sglsuseriii\@glsuseriii} +\newcommand*{\@sglsuseriii}[1][]{\@glsuseriii[hyper=false,#1]} +\newcommand*{\@glsuseriii}[2][]{% +\new@ifnextchar[{\@glsuseriii@{#1}{#2}}{\@glsuseriii@{#1}{#2}[]}} +\def\@glsuseriii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriii{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuseriii}{\@ifstar\@sGlsuseriii\@Glsuseriii} +\newcommand*{\@sGlsuseriii}[1][]{\@Glsuseriii[hyper=false,#1]} +\newcommand*{\@Glsuseriii}[2][]{% +\new@ifnextchar[{\@Glsuseriii@{#1}{#2}}{\@Glsuseriii@{#1}{#2}[]}} +\def\@Glsuseriii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriii{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuseriii}{\@ifstar\@sGLSuseriii\@GLSuseriii} +\newcommand*{\@sGLSuseriii}[1][]{\@GLSuseriii[hyper=false,#1]} +\newcommand*{\@GLSuseriii}[2][]{% +\new@ifnextchar[{\@GLSuseriii@{#1}{#2}}{\@GLSuseriii@{#1}{#2}[]}} +\def\@GLSuseriii@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriii{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuseriv}{\@ifstar\@sglsuseriv\@glsuseriv} +\newcommand*{\@sglsuseriv}[1][]{\@glsuseriv[hyper=false,#1]} +\newcommand*{\@glsuseriv}[2][]{% +\new@ifnextchar[{\@glsuseriv@{#1}{#2}}{\@glsuseriv@{#1}{#2}[]}} +\def\@glsuseriv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriv{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuseriv}{\@ifstar\@sGlsuseriv\@Glsuseriv} +\newcommand*{\@sGlsuseriv}[1][]{\@Glsuseriv[hyper=false,#1]} +\newcommand*{\@Glsuseriv}[2][]{% +\new@ifnextchar[{\@Glsuseriv@{#1}{#2}}{\@Glsuseriv@{#1}{#2}[]}} +\def\@Glsuseriv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriv{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuseriv}{\@ifstar\@sGLSuseriv\@GLSuseriv} +\newcommand*{\@sGLSuseriv}[1][]{\@GLSuseriv[hyper=false,#1]} +\newcommand*{\@GLSuseriv}[2][]{% +\new@ifnextchar[{\@GLSuseriv@{#1}{#2}}{\@GLSuseriv@{#1}{#2}[]}} +\def\@GLSuseriv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuseriv{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuserv}{\@ifstar\@sglsuserv\@glsuserv} +\newcommand*{\@sglsuserv}[1][]{\@glsuserv[hyper=false,#1]} +\newcommand*{\@glsuserv}[2][]{% +\new@ifnextchar[{\@glsuserv@{#1}{#2}}{\@glsuserv@{#1}{#2}[]}} +\def\@glsuserv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserv{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuserv}{\@ifstar\@sGlsuserv\@Glsuserv} +\newcommand*{\@sGlsuserv}[1][]{\@Glsuserv[hyper=false,#1]} +\newcommand*{\@Glsuserv}[2][]{% +\new@ifnextchar[{\@Glsuserv@{#1}{#2}}{\@Glsuserv@{#1}{#2}[]}} +\def\@Glsuserv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserv{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuserv}{\@ifstar\@sGLSuserv\@GLSuserv} +\newcommand*{\@sGLSuserv}[1][]{\@GLSuserv[hyper=false,#1]} +\newcommand*{\@GLSuserv}[2][]{% +\new@ifnextchar[{\@GLSuserv@{#1}{#2}}{\@GLSuserv@{#1}{#2}[]}} +\def\@GLSuserv@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuserv{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsuservi}{\@ifstar\@sglsuservi\@glsuservi} +\newcommand*{\@sglsuservi}[1][]{\@glsuservi[hyper=false,#1]} +\newcommand*{\@glsuservi}[2][]{% +\new@ifnextchar[{\@glsuservi@{#1}{#2}}{\@glsuservi@{#1}{#2}[]}} +\def\@glsuservi@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuservi{#2}}% +\@gls@link[#1]{#2}{\@glo@text#3}% +}% +} +\newcommand*{\Glsuservi}{\@ifstar\@sGlsuservi\@Glsuservi} +\newcommand*{\@sGlsuservi}[1][]{\@Glsuservi[hyper=false,#1]} +\newcommand*{\@Glsuservi}[2][]{% +\new@ifnextchar[{\@Glsuservi@{#1}{#2}}{\@Glsuservi@{#1}{#2}[]}} +\def\@Glsuservi@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuservi{#2}}% +\@gls@link[#1]{#2}{% + \expandafter\makefirstuc\expandafter{\@glo@text}#3}% +}% +} +\newcommand*{\GLSuservi}{\@ifstar\@sGLSuservi\@GLSuservi} +\newcommand*{\@sGLSuservi}[1][]{\@GLSuservi[hyper=false,#1]} +\newcommand*{\@GLSuservi}[2][]{% +\new@ifnextchar[{\@GLSuservi@{#1}{#2}}{\@GLSuservi@{#1}{#2}[]}} +\def\@GLSuservi@#1#2[#3]{% +\glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% +\protected@edef\@glo@text{\glsentryuservi{#2}}% +\@gls@link[#1]{#2}{\MakeUppercase{\@glo@text#3}}% +}% +} +\newcommand*{\glsentryname}[1]{\csname glo@#1@name\endcsname} +\newcommand*{\Glsentryname}[1]{% +\protected@edef\@glo@text{\csname glo@#1@name\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrydesc}[1]{\csname glo@#1@desc\endcsname} +\newcommand*{\Glsentrydesc}[1]{% +\protected@edef\@glo@text{\csname glo@#1@desc\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrydescplural}[1]{% +\csname glo@#1@descplural\endcsname} +\newcommand*{\Glsentrydescplural}[1]{% +\protected@edef\@glo@text{\csname glo@#1@descplural\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrytext}[1]{\csname glo@#1@text\endcsname} +\newcommand*{\Glsentrytext}[1]{% +\protected@edef\@glo@text{\csname glo@#1@text\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryplural}[1]{\csname glo@#1@plural\endcsname} +\newcommand*{\Glsentryplural}[1]{% +\protected@edef\@glo@text{\csname glo@#1@plural\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrysymbol}[1]{\csname glo@#1@symbol\endcsname} +\newcommand*{\Glsentrysymbol}[1]{% +\protected@edef\@glo@text{\csname glo@#1@symbol\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrysymbolplural}[1]{% +\csname glo@#1@symbolplural\endcsname} +\newcommand*{\Glsentrysymbolplural}[1]{% +\protected@edef\@glo@text{\csname glo@#1@symbolplural\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryfirst}[1]{\csname glo@#1@first\endcsname} +\newcommand*{\Glsentryfirst}[1]{% +\protected@edef\@glo@text{\csname glo@#1@first\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryfirstplural}[1]{% +\csname glo@#1@firstpl\endcsname} +\newcommand*{\Glsentryfirstplural}[1]{% +\protected@edef\@glo@text{\csname glo@#1@firstpl\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentrytype}[1]{\csname glo@#1@type\endcsname} +\newcommand*{\glsentrysort}[1]{\csname glo@#1@sort\endcsname} +\newcommand*{\glsentryuseri}[1]{\csname glo@#1@useri\endcsname} +\newcommand*{\Glsentryuseri}[1]{% +\protected@edef\@glo@text{\csname glo@#1@useri\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryuserii}[1]{\csname glo@#1@userii\endcsname} +\newcommand*{\Glsentryuserii}[1]{% +\protected@edef\@glo@text{\csname glo@#1@userii\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryuseriii}[1]{\csname glo@#1@useriii\endcsname} +\newcommand*{\Glsentryuseriii}[1]{% +\protected@edef\@glo@text{\csname glo@#1@useriii\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryuseriv}[1]{\csname glo@#1@useriv\endcsname} +\newcommand*{\Glsentryuseriv}[1]{% +\protected@edef\@glo@text{\csname glo@#1@useriv\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryuserv}[1]{\csname glo@#1@userv\endcsname} +\newcommand*{\Glsentryuserv}[1]{% +\protected@edef\@glo@text{\csname glo@#1@userv\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glsentryuservi}[1]{\csname glo@#1@uservi\endcsname} +\newcommand*{\Glsentryuservi}[1]{% +\protected@edef\@glo@text{\csname glo@#1@uservi\endcsname}% +\expandafter\makefirstuc\expandafter{\@glo@text}} +\newcommand*{\glshyperlink}[2][\glsentryname{\@glo@label}]{% +\def\@glo@label{#2}% +\@glslink{glo:#2}{#1}} +\define@key{glossadd}{counter}{\def\@gls@counter{#1}} +\define@key{glossadd}{format}{\def\@glo@format{#1}} +\define@key{glossadd}{types}{\def\@glo@type{#1}} +\newcommand*{\glsadd}[2][]{% +\glsdoifexists{#2}{% +\def\@glsnumberformat{glsnumberformat}% +\edef\@gls@counter{\csname glo@#2@counter\endcsname}% +\setkeys{glossadd}{#1}% +\edef\theglsentrycounter{\expandafter\noexpand + \csname the\@gls@counter\endcsname}% +\@do@wrglossary{#2}% +}} +\newcommand*{\glsaddall}[1][]{% +\edef\@glo@type{\@glo@types}% +\setkeys{glossadd}{#1}% +\forallglsentries[\@glo@type]{\@glo@entry}{% +\glsadd[#1]{\@glo@entry}}% +} +\edef\glsopenbrace{\expandafter\@gobble\string\{} +\edef\glsclosebrace{\expandafter\@gobble\string\}} +\edef\glsquote#1{\string"#1\string"} +\ifglsxindy + \newcommand*{\@glsfirstletter}{A} +\fi +\ifglsxindy + \newcommand*{\GlsSetXdyFirstLetterAfterDigits}[1]{% + \renewcommand*{\@glsfirstletter}{#1}} +\else + \newcommand*{\GlsSetXdyFirstLetterAfterDigits}[1]{% + \glsnoxindywarning\GlsSetXdyFirstLetterAfterDigits} +\fi +\newcommand*{\@glsminrange}{2} +\ifglsxindy + \newcommand*{\GlsSetXdyMinRangeLength}[1]{% + \renewcommand*{\@glsminrange}{#1}} +\else + \newcommand*{\GlsSetXdyMinRangeLength}[1]{% + \glsnoxindywarning\GlsSetXdyMinRangeLength} +\fi +\newwrite\istfile +\ifglsxindy + \def\writeist{% + \openout\istfile=\istfilename + \write\istfile{;; xindy style file created by the glossaries + package}% + \write\istfile{;; for document '\jobname' on + \the\year-\the\month-\the\day}% + \write\istfile{^^J; required styles^^J} + \@for\@xdystyle:=\@xdyrequiredstyles\do{% + \ifx\@xdystyle\@empty + \else + \protected@write\istfile{}{(require + \string"\@xdystyle.xdy\string")}% + \fi + }% + \write\istfile{^^J% + ; list of allowed attributes (number formats)^^J}% + \write\istfile{(define-attributes ((\@xdyattributes)))}% + \write\istfile{^^J; user defined alphabets^^J}% + \write\istfile{\@xdyuseralphabets}% + \write\istfile{^^J; location class definitions^^J}% + \protected@edef\@gls@roman{\@roman{0\string" + \string"roman-numbers-lowercase\string" :sep \string"}}% + \@onelevel@sanitize\@gls@roman + \edef\@tmp{\string" \string"roman-numbers-lowercase\string" + :sep \string"}% + \@onelevel@sanitize\@tmp + \ifx\@tmp\@gls@roman + \write\istfile{(define-location-class + \string"roman-page-numbers\string"^^J\space\space\space + (\string"roman-numbers-lowercase\string") + :min-range-length \@glsminrange)}% + \else + \write\istfile{(define-location-class + \string"roman-page-numbers\string"^^J\space\space\space + (:sep "\@gls@roman") + :min-range-length \@glsminrange)}% + \fi + \write\istfile{(define-location-class + \string"Roman-page-numbers\string"^^J\space\space\space + (\string"roman-numbers-uppercase\string") + :min-range-length \@glsminrange)}% + \write\istfile{(define-location-class + \string"arabic-page-numbers\string"^^J\space\space\space + (\string"arabic-numbers\string") + :min-range-length \@glsminrange)}% + \write\istfile{(define-location-class + \string"alpha-page-numbers\string"^^J\space\space\space + (\string"alpha\string") + :min-range-length \@glsminrange)}% + \write\istfile{(define-location-class + \string"Alpha-page-numbers\string"^^J\space\space\space + (\string"ALPHA\string") + :min-range-length \@glsminrange)}% + \write\istfile{(define-location-class + \string"Appendix-page-numbers\string"^^J\space\space\space + (\string"ALPHA\string" + :sep \string"\@glsAlphacompositor\string" + \string"arabic-numbers\string") + :min-range-length \@glsminrange)}% + \write\istfile{(define-location-class + \string"arabic-section-numbers\string"^^J\space\space\space + (\string"arabic-numbers\string" + :sep \string"\glscompositor\string" + \string"arabic-numbers\string") + :min-range-length \@glsminrange)}% + \write\istfile{^^J; user defined location classes}% + \write\istfile{\@xdyuserlocationdefs}% + \write\istfile{^^J; define cross-reference class^^J}% + \write\istfile{(define-crossref-class \string"see\string" + :unverified )}% + \write\istfile{(markup-crossref-list + :class \string"see\string"^^J\space\space\space + :open \string"\string\glsseeformat\string" + :close \string"{}\string")}% + \write\istfile{^^J; define the order of the location classes}% + \write\istfile{(define-location-class-order + (\@xdylocationclassorder))}% + \write\istfile{^^J; define the glossary markup^^J}% + \write\istfile{(markup-index^^J\space\space\space + :open \string"\string + \glossarysection[\string\glossarytoctitle]{\string + \glossarytitle}\string\glossarypreamble\string~n\string\begin + {theglossary}\string\glossaryheader\string~n\string" ^^J\space + \space\space:close \string"\expandafter\@gobble + \string\%\string~n\string + \end{theglossary}\string\glossarypostamble + \string~n\string" ^^J\space\space\space + :tree)}% + \write\istfile{(markup-letter-group-list + :sep \string"\string\glsgroupskip\string~n\string")}% + \write\istfile{(markup-indexentry + :open \string"\string\relax \string\glsresetentrylist + \string~n\string")}% + \write\istfile{(markup-locclass-list :open + \string"\glsopenbrace\string\glossaryentrynumbers + \glsopenbrace\string\relax\space \string"^^J\space\space\space + :sep \string", \string" + :close \string"\glsclosebrace\glsclosebrace\string")}% + \write\istfile{(markup-locref-list + :sep \string"\string\delimN\space\string")}% + \write\istfile{(markup-range + :sep \string"\string\delimR\space\string")}% + \@onelevel@sanitize\gls@suffixF + \@onelevel@sanitize\gls@suffixFF + \ifx\gls@suffixF\@empty + \else + \write\istfile{(markup-range + :close "\gls@suffixF" :length 1 :ignore-end)}% + \fi + \ifx\gls@suffixFF\@empty + \else + \write\istfile{(markup-range + :close "\gls@suffixFF" :length 2 :ignore-end)}% + \fi + \write\istfile{^^J; define format to use for locations^^J}% + \write\istfile{\@xdylocref}% + \write\istfile{^^J; define letter group list format^^J}% + \write\istfile{(markup-letter-group-list + :sep \string"\string\glsgroupskip\string~n\string")}% + \write\istfile{^^J; letter group headings^^J}% + \write\istfile{(markup-letter-group + :open-head \string"\string\glsgroupheading + \glsopenbrace\string"^^J\space\space\space + :close-head \string"\glsclosebrace\string")}% + \write\istfile{^^J; additional letter groups^^J}% + \write\istfile{\@xdylettergroups}% + \write\istfile{^^J; additional sort rules^^J} + \write\istfile{\@xdysortrules}% + \noist} +\else + \edef\@gls@actualchar{\string?} + \edef\@gls@encapchar{\string|} + \edef\@gls@levelchar{\string!} + \edef\@gls@quotechar{\string"} + \def\writeist{\relax + \openout\istfile=\istfilename + \write\istfile{\expandafter\@gobble\string\% makeindex style file + created by the glossaries package} + \write\istfile{\expandafter\@gobble\string\% for document + '\jobname' on \the\year-\the\month-\the\day} + \write\istfile{actual '\@gls@actualchar'} + \write\istfile{encap '\@gls@encapchar'} + \write\istfile{level '\@gls@levelchar'} + \write\istfile{quote '\@gls@quotechar'} + \write\istfile{keyword \string"\string\\glossaryentry\string"} + \write\istfile{preamble \string"\string\\glossarysection[\string + \\glossarytoctitle]{\string\\glossarytitle}\string + \\glossarypreamble\string\n\string\\begin{theglossary}\string + \\glossaryheader\string\n\string"} + \write\istfile{postamble \string"\string\%\string\n\string + \\end{theglossary}\string\\glossarypostamble\string\n + \string"} + \write\istfile{group_skip \string"\string\\glsgroupskip\string\n + \string"} + \write\istfile{item_0 \string"\string\%\string\n\string"} + \write\istfile{item_1 \string"\string\%\string\n\string"} + \write\istfile{item_2 \string"\string\%\string\n\string"} + \write\istfile{item_01 \string"\string\%\string\n\string"} + \write\istfile{item_x1 + \string"\string\\relax \string\\glsresetentrylist\string\n + \string"} + \write\istfile{item_12 \string"\string\%\string\n\string"} + \write\istfile{item_x2 + \string"\string\\relax \string\\glsresetentrylist\string\n + \string"} + \write\istfile{delim_0 \string"\string\{\string + \\glossaryentrynumbers\string\{\string\\relax \string"} + \write\istfile{delim_1 \string"\string\{\string + \\glossaryentrynumbers\string\{\string\\relax \string"} + \write\istfile{delim_2 \string"\string\{\string + \\glossaryentrynumbers\string\{\string\\relax \string"} + \write\istfile{delim_t \string"\string\}\string\}\string"} + \write\istfile{delim_n \string"\string\\delimN \string"} + \write\istfile{delim_r \string"\string\\delimR \string"} + \write\istfile{headings_flag 1} + \write\istfile{heading_prefix + \string"\string\\glsgroupheading\string\{\string"} + \write\istfile{heading_suffix + \string"\string\}\string\\relax + \string\\glsresetentrylist \string"} + \write\istfile{symhead_positive \string"glssymbols\string"} + \write\istfile{numhead_positive \string"glsnumbers\string"} + \write\istfile{page_compositor \string"\glscompositor\string"} + \@gls@escbsdq\gls@suffixF + \@gls@escbsdq\gls@suffixFF + \ifx\gls@suffixF\@empty + \else + \write\istfile{suffix_2p \string"\gls@suffixF\string"} + \fi + \ifx\gls@suffixFF\@empty + \else + \write\istfile{suffix_3p \string"\gls@suffixFF\string"} + \fi + \noist + } +\fi +\newcommand{\noist}{\let\writeist\relax} +\newcommand*{\@makeglossary}[1]{% +\ifglossaryexists{#1}{% +\edef\glo@out{\csname @glotype@#1@out\endcsname}% +\expandafter\newwrite\csname glo@#1@file\endcsname +\edef\@glo@file{\csname glo@#1@file\endcsname}% +\immediate\openout\@glo@file=\jobname.\glo@out +\@gls@renewglossary +\PackageInfo{glossaries}{Writing glossary file \jobname.\glo@out} +\writeist +}{\PackageError{glossaries}{% +Glossary type `#1' not defined}{New glossaries must be defined before +using \string\makeglossary}}} +\newcommand*{\warn@nomakeglossaries}{% + \GlossariesWarningNoLine{\string\makeglossaries\space + hasn't been used,^^Jthe glossaries will not be updated}% +} +\newcommand*{\makeglossaries}{% + \protected@write\@auxout{}{\string\@istfilename{\istfilename}}% + \protected@write\@auxout{}{\string\@glsorder{\glsorder}} + \@for\@glo@type:=\@glo@types\do{% + \ifthenelse{\equal{\@glo@type}{}}{}{% + \@makeglossary{\@glo@type}}% + }% + \renewcommand*\newglossary[4][]{% + \PackageError{glossaries}{New glossaries + must be created before \string\makeglossaries}{You need + to move \string\makeglossaries\space after all your + \string\newglossary\space commands}}% + \let\@makeglossary\relax + \let\makeglossary\relax + \let\makeglossaries\relax + \@disable@onlypremakeg + \let\warn@nomakeglossaries\relax +} +\let\makeglossary\makeglossaries +\AtEndDocument{% + \warn@nomakeglossaries + \warn@noprintglossary +} +\renewcommand*{\glossary}[1][\glsdefaulttype]{% +\@glossary[#1]} +\def\@glossary[#1]{\index} +\newcommand{\@gls@renewglossary}{% +\gdef\@glossary[##1]{\@bsphack\begingroup\@wrglossary{##1}}% +\let\@gls@renewglossary\@empty +} +\renewcommand*{\@wrglossary}[2]{% + \expandafter\protected@write\csname glo@#1@file\endcsname{}{#2}% + \endgroup\@esphack +} +\newcommand{\@do@wrglossary}[1]{% +\ifglsxindy + \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil + \def\@glo@range{}% + \expandafter\if\@glo@prefix(\relax + \def\@glo@range{:open-range}% + \else + \expandafter\if\@glo@prefix)\relax + \def\@glo@range{:close-range}% + \fi + \fi +\protected@edef\@glslocref{\theglsentrycounter}% +\@gls@checkmkidxchars\@glslocref + \glossary[\csname glo@#1@type\endcsname]{% + (indexentry :tkey (\csname glo@#1@index\endcsname) + :locref \string"\@glslocref\string" % + :attr \string"\@glo@suffix\string" \@glo@range + ) + }% +\else + \@set@glo@numformat\@glo@numfmt\@gls@counter\@glsnumberformat + \glossary[\csname glo@#1@type\endcsname]{% + \string\glossaryentry{\csname glo@#1@index\endcsname + \@gls@encapchar\@glo@numfmt}{\theglsentrycounter}}% +\fi +} +\newcommand{\@do@seeglossary}[2]{% +\ifglsxindy + \glossary[\csname glo@#1@type\endcsname]{% + (indexentry + :tkey (\csname glo@#1@index\endcsname) + :xref (\string"#2\string") + :attr \string"see\string" + ) + }% +\else + \glossary[\csname glo@#1@type\endcsname]{% + \string\glossaryentry{\csname glo@#1@index\endcsname + \@gls@encapchar glsseeformat#2}{Z}}% +\fi +} +\def\@gls@fixbraces#1#2#3\@nil{% + \ifx#2[\relax + \def#1{#2#3}% + \else + \def#1{{#2#3}}% + \fi +} +\newcommand*{\glssee}[3][\seename]{% + \@do@seeglossary{#2}{[#1]{#3}}} +\newcommand*{\@glssee}[3][\seename]{% + \glssee[#1]{#3}{#2}} +\newcommand*{\glsseeformat}[3][\seename]{\emph{#1} \glsseelist{#2}} +\newcommand*{\glsseelist}[1]{% + \let\@gls@dolast\relax + \let\@gls@donext\relax + \@for\@gls@thislabel:=#1\do{% + \ifx\@xfor@nextelement\@nnil + \@gls@dolast + \else + \@gls@donext + \fi + \glsseeitem{\@gls@thislabel}% + \let\@gls@dolast\glsseelastsep + \let\@gls@donext\glsseesep + }% +} +\newcommand*{\glsseelastsep}{\space\andname\space} +\newcommand*{\glsseesep}{, } +\newcommand*{\glsseeitem}[1]{\glshyperlink{#1}} +\def\warn@noprintglossary{\GlossariesWarningNoLine{No + \string\printglossary\space or \string\printglossaries\space + found.^^JThis document will not have a glossary}} +\@ifundefined{printglossary}{}{% + \GlossariesWarning{Overriding \string\printglossary}% + \let\printglossary\undefined +} +\newcommand*{\printglossary}[1][type=\glsdefaulttype]{% + \ifglsxindy\findrootlanguage\fi + \def\@glo@type{\glsdefaulttype}% + \def\glossarytitle{\csname @glotype@\@glo@type @title\endcsname}% + \def\@glossarystyle{}% + \def\gls@dotoctitle{\glssettoctitle{\@glo@type}}% + \let\@org@glossaryentrynumbers\glossaryentrynumbers + \bgroup + \setkeys{printgloss}{#1}% + \let\org@glossaryentrynumbers\glossaryentrynumbers + \let\glsnonextpages\@glsnonextpages + \let\nopostdesc\@nopostdesc + \gls@dotoctitle + \@glossarystyle + \makeatletter + \@input@{\jobname.\csname @glotype@\@glo@type @in\endcsname}% +\IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}{}% +{\null}% + \ifglsxindy + \@ifundefined{@xdy@\@glo@type @language}{% + \protected@write\@auxout{}{% + \string\@xdylanguage{\@glo@type}{\@xdy@main@language}}% + }{% + \protected@write\@auxout{}{% + \string\@xdylanguage{\@glo@type}{\csname @xdy@\@glo@type + @language\endcsname}}% + }% + \protected@write\@auxout{}{% + \string\@gls@codepage{\@glo@type}{\gls@codepage}}% + \fi + \egroup + \global\let\glossaryentrynumbers\@org@glossaryentrynumbers + \global\let\warn@noprintglossary\relax +} +\newcommand*{\printglossaries}{% +\forallglossaries{\@@glo@type}{\printglossary[type=\@@glo@type]}} +\define@key{printgloss}{type}{\def\@glo@type{#1}} +\define@key{printgloss}{title}{\def\glossarytitle{#1}} +\define@key{printgloss}{toctitle}{\def\glossarytoctitle{#1}% +\let\gls@dotoctitle\relax +} +\define@key{printgloss}{style}{% +\@ifundefined{@glsstyle@#1}{\PackageError{glossaries}{Glossary +style `#1' undefined}{}}{% +\def\@glossarystyle{\csname @glsstyle@#1\endcsname}}} +\define@choicekey{printgloss}{numberedsection}[\val\nr]{% +false,nolabel,autolabel}[nolabel]{% +\ifcase\nr\relax + \renewcommand*{\@@glossarysecstar}{*}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{\label{\glsautoprefix\@glo@type}}% +\fi} +\define@boolkey{printgloss}[gls]{nonumberlist}[true]{% +\ifglsnonumberlist + \def\glossaryentrynumbers##1{}% +\else + \def\glossaryentrynumbers##1{##1}% +\fi} +\newcommand*{\@glsnonextpages}{% + \gdef\glossaryentrynumbers##1{% + \glsresetentrylist}} +\newcommand*{\glsresetentrylist}{% + \global\let\glossaryentrynumbers\org@glossaryentrynumbers} +\newcommand*{\glsnonextpages}{} +\@ifundefined{theglossary}{% + \newenvironment{theglossary}{}{}% +}{% + \GlossariesWarning{overriding `theglossary' environment}% + \renewenvironment{theglossary}{}{}% +} +\newcommand*{\glossaryheader}{} +\newcommand*{\glstarget}[2]{\@glstarget{glo:#1}{#2}} +\newcommand*{\glossaryentryfield}[5]{% +\noindent\textbf{\glstarget{#1}{#2}} #4 #3. #5\par} +\newcommand*{\glossarysubentryfield}[6]{% +\glstarget{#2}{\strut}#4. #6\par} +\newcommand*{\glsgroupskip}{} +\newcommand*{\glsgroupheading}[1]{} +\newcommand*{\glsgetgrouptitle}[1]{% +\@ifundefined{#1groupname}{#1}{\csname #1groupname\endcsname}} +\newcommand*{\glsgetgrouplabel}[1]{% +\ifthenelse{\equals{#1}{\glssymbolsgroupname}}{glssymbols}{% +\ifthenelse{\equals{#1}{\glsnumbersgroupname}}{glsnumbers}{#1}}} +\newcommand*{\setentrycounter}[1]{\def\glsentrycounter{#1}} +\newcommand*{\glossarystyle}[1]{% +\@ifundefined{@glsstyle@#1}{\PackageError{glossaries}{Glossary +style `#1' undefined}{}}{% +\csname @glsstyle@#1\endcsname}} +\newcommand{\newglossarystyle}[2]{% +\@ifundefined{@glsstyle@#1}{% +\expandafter\def\csname @glsstyle@#1\endcsname{#2}}{% +\PackageError{glossaries}{Glossary style `#1' is already defined}{}}} +\newcommand*{\glsnamefont}[1]{#1} +\@ifundefined{hyperlink}{% +\def\glshypernumber#1{#1}}{% +\def\glshypernumber#1{% + \@glshypernumber#1\nohyperpage{}\@nil}} +\def\@glshypernumber#1\nohyperpage#2#3\@nil{% + \ifx\\#1\\% + \else + \@delimR#1\delimR\delimR\\% + \fi + \ifx\\#2\\% + \else + #2% + \fi + \ifx\\#3\\% + \else + \@glshypernumber#3\@nil + \fi +} +\def\@delimR#1\delimR #2\delimR #3\\{% +\ifx\\#2\\% + \@delimN{#1}% +\else + \@gls@numberlink{#1}\delimR\@gls@numberlink{#2}% +\fi} +\def\@delimN#1{\@@delimN#1\delimN \delimN\\} +\def\@@delimN#1\delimN #2\delimN#3\\{% +\ifx\\#3\\% + \@gls@numberlink{#1}% +\else + \@gls@numberlink{#1}\delimN\@gls@numberlink{#2}% +\fi +} +\def\@gls@numberlink#1{% +\begingroup + \toks@={}% + \@gls@removespaces#1 \@nil +\endgroup} +\def\@gls@removespaces#1 #2\@nil{% + \toks@=\expandafter{\the\toks@#1}% + \ifx\\#2\\% + \edef\x{\the\toks@}% + \ifx\x\empty + \else + \hyperlink{\glsentrycounter.\the\toks@}{\the\toks@}% + \fi + \else + \@gls@ReturnAfterFi{% + \@gls@removespaces#2\@nil + }% + \fi +} +\long\def\@gls@ReturnAfterFi#1\fi{\fi#1} +\newcommand*{\hyperrm}[1]{\textrm{\glshypernumber{#1}}} +\newcommand*{\hypersf}[1]{\textsf{\glshypernumber{#1}}} +\newcommand*{\hypertt}[1]{\texttt{\glshypernumber{#1}}} +\newcommand*{\hyperbf}[1]{\textbf{\glshypernumber{#1}}} +\newcommand*{\hypermd}[1]{\textmd{\glshypernumber{#1}}} +\newcommand*{\hyperit}[1]{\textit{\glshypernumber{#1}}} +\newcommand*{\hypersl}[1]{\textsl{\glshypernumber{#1}}} +\newcommand*{\hyperup}[1]{\textup{\glshypernumber{#1}}} +\newcommand*{\hypersc}[1]{\textsc{\glshypernumber{#1}}} +\newcommand*{\hyperemph}[1]{\emph{\glshypernumber{#1}}} +\ifglsacronym + \newglossary[alg]{acronym}{acr}{acn}{\acronymname} + \renewcommand*{\acronymtype}{acronym} +\fi +\newcommand{\oldacronym}[4][\gls@label]{% + \def\gls@label{#2}% + \newacronym[#4]{#1}{#2}{#3}% + \@ifundefined{xspace}{% + \expandafter\edef\csname#1\endcsname{% + \noexpand\@ifstar{\noexpand\Gls{#1}}{\noexpand\gls{#1}}}% + }{% + \expandafter\edef\csname#1\endcsname{% + \noexpand\@ifstar{\noexpand\Gls{#1}\noexpand\xspace}{% + \noexpand\gls{#1}\noexpand\xspace}}% + }% +} + \newcommand{\newacronym}[4][]{} +\newcommand*{\acrpluralsuffix}{\glspluralsuffix} +\newcommand*{\glsshortkey}{text} +\newcommand*{\glsshortpluralkey}{plural} +\newcommand*{\glslongkey}{description} +\newcommand*{\glslongpluralkey}{descriptionplural} +\newcommand*{\acrshort}[2][]{% + \new@ifnextchar[{\@acrshort{#1}{#2}}{\@acrshort{#1}{#2}[]}} +\newcommand*{\Acrshort}[2][]{% + \new@ifnextchar[{\@Acrshort{#1}{#2}}{\@Acrshort{#1}{#2}[]}} +\newcommand*{\ACRshort}[2][]{% + \new@ifnextchar[{\@ACRshort{#1}{#2}}{\@ACRshort{#1}{#2}[]}} +\newcommand*{\acrshortpl}[2][]{% + \new@ifnextchar[{\@acrshortpl{#1}{#2}}{\@acrshortpl{#1}{#2}[]}} +\newcommand*{\Acrshortpl}[2][]{% + \new@ifnextchar[{\@Acrshortpl{#1}{#2}}{\@Acrshortpl{#1}{#2}[]}} +\newcommand*{\ACRshortpl}[2][]{% + \new@ifnextchar[{\@ACRshortpl{#1}{#2}}{\@ACRshortpl{#1}{#2}[]}} +\newcommand*{\acrlong}[2][]{% + \new@ifnextchar[{\@acrlong{#1}{#2}}{\@acrlong{#1}{#2}[]}} +\newcommand*{\Acrlong}[2][]{% + \new@ifnextchar[{\@Acrlong{#1}{#2}}{\@Acrlong{#1}{#2}[]}} +\newcommand*{\ACRlong}[2][]{% + \new@ifnextchar[{\@ACRlong{#1}{#2}}{\@ACRlong{#1}{#2}[]}} +\newcommand*{\acrlongpl}[2][]{% + \new@ifnextchar[{\@acrlongpl{#1}{#2}}{\@acrlongpl{#1}{#2}[]}} +\newcommand*{\Acrlongpl}[2][]{% + \new@ifnextchar[{\@Acrlongpl{#1}{#2}}{\@Acrlongpl{#1}{#2}[]}} +\newcommand*{\ACRlongpl}[2][]{% + \new@ifnextchar[{\@ACRlongpl{#1}{#2}}{\@ACRlongpl{#1}{#2}[]}} +\newcommand*{\acrfull}[2][]{% + \new@ifnextchar[{\@acrfull{#1}{#2}}{\@acrfull{#1}{#2}[]}} +\newcommand*{\Acrfull}[2][]{% + \new@ifnextchar[{\@Acrfull{#1}{#2}}{\@Acrfull{#1}{#2}[]}} +\newcommand*{\ACRfull}[2][]{% + \new@ifnextchar[{\@ACRfull{#1}{#2}}{\@ACRfull{#1}{#2}[]}} +\newcommand*{\acrfullpl}[2][]{% + \new@ifnextchar[{\@acrfullpl{#1}{#2}}{\@acrfullpl{#1}{#2}[]}} +\newcommand*{\Acrfullpl}[2][]{% + \new@ifnextchar[{\@Acrfullpl{#1}{#2}}{\@Acrfullpl{#1}{#2}[]}} +\newcommand*{\ACRfullpl}[2][]{% + \new@ifnextchar[{\@ACRfullpl{#1}{#2}}{\@ACRfullpl{#1}{#2}[]}} +\newcommand{\acronymfont}[1]{#1} +\newcommand{\firstacronymfont}[1]{\acronymfont{#1}} +\newcommand*{\acrnameformat}[2]{\acronymfont{#1}} +\newtoks\glskeylisttok +\newtoks\glslabeltok +\newtoks\glsshorttok +\newtoks\glslongtok +\newcommand*{\newacronymhook}{} +\newcommand*{\SetDefaultAcronymDisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +\newcommand*{\DefaultNewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\the\glsshorttok},% + description={\the\glslongtok},% + text={\the\glsshorttok},% + sort={\the\glsshorttok},% + descriptionplural={\the\glslongtok\noexpand\acrpluralsuffix},% + first={\the\glslongtok\space(\the\glsshorttok)},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix},% + firstplural={\noexpand\@glo@descplural\space + (\noexpand\@glo@plural)},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetDefaultAcronymStyle}{% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetDefaultAcronymDisplayStyle{\@gls@type}% + }% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetDefaultAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \DefaultNewAcronymDef + }% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% + \renewcommand*{\glsshortkey}{text}% + \renewcommand*{\glsshortpluralkey}{plural}% + \renewcommand*{\glslongkey}{description}% + \renewcommand*{\glslongpluralkey}{descriptionplural}% + \def\@acrshort##1##2[##3]{\@glstext@{##1}{##2}[##3]}% + \def\@Acrshort##1##2[##3]{\@Glstext@{##1}{##2}[##3]}% + \def\@ACRshort##1##2[##3]{\@GLStext@{##1}{##2}[##3]}% + \def\@acrshortpl##1##2[##3]{\@glsplural@{##1}{##2}[##3]}% + \def\@Acrshortpl##1##2[##3]{\@Glsplural@{##1}{##2}[##3]}% + \def\@ACRshortpl##1##2[##3]{\@GLSplural@{##1}{##2}[##3]}% + \def\@acrlong##1##2[##3]{\@glsdesc@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsdesc@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSdesc@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsdescplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsdescplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSdescplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsfirst@{##1}{##2}[##3]}% + \def\@Acrfull##1##2[##3]{\@Glsfirst@{##1}{##2}[##3]}% + \def\@ACRfull##1##2[##3]{\@GLSfirst@{##1}{##2}[##3]}% + \def\@acrfullpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3]}% + \def\@Acrfullpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3]}% + \def\@ACRfullpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3]}% +} +\newcommand*{\SetDescriptionFootnoteAcronymDisplayStyle}[1]{% + \defglsdisplayfirst[#1]{% + \firstacronymfont{##1}##4% + \protect\footnote{% + \glslink[\@gls@link@opts]{\@gls@link@label}{##3}}}% + \defglsdisplay[#1]{\acronymfont{##1}##4}% +} +\newcommand*{\DescriptionFootnoteNewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\noexpand\acronymfont{\the\glsshorttok}},% + sort={\the\glsshorttok},% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix},% + symbol={\the\glslongtok},% + symbolplural={\the\glslongtok\noexpand\acrpluralsuffix},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetDescriptionFootnoteAcronymStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetDescriptionFootnoteAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \DescriptionFootnoteNewAcronymDef + }% + \def\glsshortkey{text}% + \def\glsshortpluralkey{plural}% + \def\glslongkey{symbol}% + \def\glslongpluralkey{symbolplural}% + \def\@acrshort##1##2[##3]{% + \acronymfont{\@glstext@{##1}{##2}[##3]}}% + \def\@Acrshort##1##2[##3]{% + \acronymfont{\@Glstext@{##1}{##2}[##3]}}% + \def\@ACRshort##1##2[##3]{% + \acronymfont{\@GLStext@{##1}{##2}[##3]}}% + \def\@acrshortpl##1##2[##3]{% + \acronymfont{\@glsplural@{##1}{##2}[##3]}}% + \def\@Acrshortpl##1##2[##3]{% + \acronymfont{\@Glsplural@{##1}{##2}[##3]}}% + \def\@ACRshortpl##1##2[##3]{% + \acronymfont{\@GLSplural@{##1}{##2}[##3]}}% + \def\@acrlong##1##2[##3]{\@glssymbol@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glssymbol@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSsymbol@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glssymbolplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glssymbolplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSsymbolplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glssymbol@{##1}{##2}[##3] + (\acronymfont{\@glstext@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glssymbol@{##1}{##2}[##3] + (\acronymfont{\@glstext@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSsymbol@{##1}{##2}[##3] + (\acronymfont{\@GLStext@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glssymbolplural@{##1}{##2}[##3] + (\acronymfont{\@glsplural@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glssymbolplural@{##1}{##2}[##3] + (\acronymfont{\@glsplural@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSsymbolplural@{##1}{##2}[##3] + (\acronymfont{\@GLSplural@{##1}{##2}[##3]})}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetDescriptionFootnoteAcronymDisplayStyle{\@gls@type}% + }% + \ifglsacrsmallcaps + \renewcommand*{\acronymfont}[1]{\textsc{##1}}% + \renewcommand*{\acrpluralsuffix}{% + \textup{\glspluralsuffix}}% + \else + \ifglsacrsmaller + \renewcommand*{\acronymfont}[1]{\textsmaller{##1}}% + \fi + \fi + \ifglsacrdua + \PackageError{glossaries}{Option clash: `footnote' and `dua' + can't both be set}{}% + \fi +}% +\newcommand*{\SetDescriptionDUAAcronymDisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +\newcommand*{\DescriptionDUANewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\the\glslongtok},% + sort={\the\glslongtok}, + text={\the\glslongtok},% + plural={\the\glslongtok\noexpand\acrpluralsuffix},% + symbol={\the\glsshorttok},% + symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetDescriptionDUAAcronymStyle}{% + \ifglsacrsmallcaps + \PackageError{glossaries}{Option clash: `smallcaps' and `dua' + can't both be set}{}% + \else + \ifglsacrsmaller + \PackageError{glossaries}{Option clash: `smaller' and `dua' + can't both be set}{}% + \fi + \fi + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetDescriptionDUAAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \DescriptionDUANewAcronymDef + }% + \def\glsshortkey{symbol}% + \def\glsshortpluralkey{symbolplural}% + \def\glslongkey{first}% + \def\glslongpluralkey{plural}% + \def\@acrshort##1##2[##3]{% + \acronymfont{\@glssymbol@{##1}{##2}[##3]}}% + \def\@Acrshort##1##2[##3]{% + \acronymfont{\@Glssymbol@{##1}{##2}[##3]}}% + \def\@ACRshort##1##2[##3]{% + \acronymfont{\@GLSsymbol@{##1}{##2}[##3]}}% + \def\@acrshortpl##1##2[##3]{% + \acronymfont{\@glssymbolplural@{##1}{##2}[##3]}}% + \def\@Acrshortpl##1##2[##3]{% + \acronymfont{\@Glssymbolplural@{##1}{##2}[##3]}}% + \def\@ACRshortpl##1##2[##3]{% + \acronymfont{\@GLSsymbolplural@{##1}{##2}[##3]}}% + \def\@acrlong##1##2[##3]{\@glsfirst@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsfirst@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSfirst@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSfirst@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbol@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbolplural@{##1}{##2}[##3]})}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetDescriptionDUAAcronymDisplayStyle{\@gls@type}% + }% +}% +\newcommand*{\SetDescriptionAcronymDisplayStyle}[1]{% + \defglsdisplayfirst[#1]{% + ##1##4 (\firstacronymfont{##3})}% + \defglsdisplay[#1]{\acronymfont{##1}##4}% +} +\newcommand*{\DescriptionNewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\noexpand + \acrnameformat{\the\glsshorttok}{\the\glslongtok}},% + sort={\the\glsshorttok},% + first={\the\glslongtok},% + firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix},% + symbol={\noexpand\@glo@text},% + symbolplural={\noexpand\@glo@plural},% + \the\glskeylisttok}% + }% + \@do@newglossaryentry +} +\newcommand*{\SetDescriptionAcronymStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetDescriptionAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \DescriptionNewAcronymDef + }% + \def\glsshortkey{text}% + \def\glsshortpluralkey{plural}% + \def\glslongkey{first}% + \def\glslongpluralkey{firstplural}% + \def\@acrshort##1##2[##3]{% + \acronymfont{\@glstext@{##1}{##2}[##3]}}% + \def\@Acrshort##1##2[##3]{% + \acronymfont{\@Glstext@{##1}{##2}[##3]}}% + \def\@ACRshort##1##2[##3]{% + \acronymfont{\@GLStext@{##1}{##2}[##3]}}% + \def\@acrshortpl##1##2[##3]{% + \acronymfont{\@glsplural@{##1}{##2}[##3]}}% + \def\@Acrshortpl##1##2[##3]{% + \acronymfont{\@Glsplural@{##1}{##2}[##3]}}% + \def\@ACRshortpl##1##2[##3]{% + \acronymfont{\@GLSplural@{##1}{##2}[##3]}}% + \def\@acrlong##1##2[##3]{\@glsfirst@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsfirst@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSfirst@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSfirst@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbol@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbolplural@{##1}{##2}[##3]})}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetDescriptionAcronymDisplayStyle{\@gls@type}% + }% + \ifglsacrsmallcaps + \renewcommand{\acronymfont}[1]{\textsc{##1}} + \renewcommand*{\acrpluralsuffix}{% + \textup{\glspluralsuffix}}% + \else + \ifglsacrsmaller + \renewcommand*{\acronymfont}[1]{\textsmaller{##1}}% + \fi + \fi +}% +\newcommand*{\SetFootnoteAcronymDisplayStyle}[1]{% + \defglsdisplayfirst[#1]{% + \firstacronymfont{##1}##4\protect\footnote{% + \protect\glslink + [\@gls@link@opts]{\@gls@link@label}{##2}}}% + \defglsdisplay[#1]{\acronymfont{##1}##4}% +} +\newcommand*{\FootnoteNewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\noexpand\acronymfont{\the\glsshorttok}},% + sort={\the\glsshorttok},% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix},% + description={\the\glslongtok},% + descriptionplural={\the\glslongtok\noexpand\acrpluralsuffix},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetFootnoteAcronymStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetFootnoteAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \FootnoteNewAcronymDef + }% + \def\glsshortkey{text}% + \def\glsshortpluralkey{plural}% + \def\glslongkey{description}% + \def\glslongpluralkey{descriptionplural}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetFootnoteAcronymDisplayStyle{\@gls@type}% + }% + \def\@acrshort##1##2[##3]{\acronymfont{\@glstext@{##1}{##2}[##3]}}% + \def\@Acrshort##1##2[##3]{\acronymfont{\@Glstext@{##1}{##2}[##3]}}% + \def\@ACRshort##1##2[##3]{\acronymfont{\@GLStext@{##1}{##2}[##3]}}% + \def\@acrshortpl##1##2[##3]{% + \acronymfont{\@glsplural@{##1}{##2}[##3]}}% + \def\@Acrshortpl##1##2[##3]{% + \acronymfont{\@Glsplural@{##1}{##2}[##3]}}% + \def\@ACRshortpl##1##2[##3]{% + \acronymfont{\@GLSplural@{##1}{##2}[##3]}}% + \def\@acrlong##1##2[##3]{\@glsdesc@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsdesc@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSdesc@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsdescplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsdescplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSdescplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsdesc@{##1}{##2}[##3] + (\@glstext@{##1}{##2}[##3])}% + \def\@Acrfull##1##2[##3]{\@Glsdesc@{##1}{##2}[##3] + (\@glstext@{##1}{##2}[##3])}% + \def\@ACRfull##1##2[##3]{\@GLSdesc@{##1}{##2}[##3] + (\@GLStext@{##1}{##2}[##3])}% + \def\@acrfullpl##1##2[##3]{\@glsdescplural@{##1}{##2}[##3] + (\@glsplural@{##1}{##2}[##3])}% + \def\@Acrfullpl##1##2[##3]{\@Glsdesctext@{##1}{##2}[##3] + (\@glsplural@{##1}{##2}[##3])}% + \def\@ACRfullpl##1##2[##3]{\@GLSdesctext@{##1}{##2}[##3] + (\@GLSplural@{##1}{##2}[##3])}% + \ifglsacrsmallcaps + \renewcommand*{\acronymfont}[1]{\textsc{##1}}% + \renewcommand*{\acrpluralsuffix}{% + \textup{\glspluralsuffix}}% + \else + \ifglsacrsmaller + \renewcommand*{\acronymfont}[1]{\textsmaller{##1}}% + \fi + \fi + \ifglsacrdua + \PackageError{glossaries}{Option clash: `footnote' and `dua' + can't both be set}{}% + \fi +}% +\newcommand*{\SetSmallAcronymDisplayStyle}[1]{% + \defglsdisplayfirst[#1]{##1##4 (\firstacronymfont{##3})} + \defglsdisplay[#1]{\acronymfont{##1}##4}% +} +\newcommand*{\SmallNewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\noexpand\acronymfont{\the\glsshorttok}},% + sort={\the\glsshorttok},% + text={\noexpand\@glo@symbol},% + plural={\noexpand\@glo@symbolplural},% + first={\the\glslongtok},% + firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + description={\noexpand\@glo@first},% + descriptionplural={\noexpand\@glo@firstplural},% + symbol={\the\glsshorttok},% + symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetSmallAcronymStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetSmallAcronymDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \SmallNewAcronymDef + }% + \def\glsshortkey{symbol}% + \def\glsshortpluralkey{symbolplural}% + \def\glslongkey{first}% + \def\glslongpluralkey{firstplural}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetSmallAcronymDisplayStyle{\@gls@type}% + }% + \ifglsacrsmallcaps + \renewcommand*{\acronymfont}[1]{\textsc{##1}} + \renewcommand*{\acrpluralsuffix}{% + \textup{\glspluralsuffix}}% + \else + \renewcommand*{\acronymfont}[1]{\textsmaller{##1}} + \fi + \def\@acrshort##1##2[##3]{% + \acronymfont{\@glstext@{##1}{##2}[##3]}}% + \def\@Acrshort##1##2[##3]{% + \acronymfont{\@Glstext@{##1}{##2}[##3]}}% + \def\@ACRshort##1##2[##3]{% + \acronymfont{\@GLStext@{##1}{##2}[##3]}}% + \def\@acrshortpl##1##2[##3]{% + \acronymfont{\@glsplural@{##1}{##2}[##3]}}% + \def\@Acrshortpl##1##2[##3]{% + \acronymfont{\@Glsplural@{##1}{##2}[##3]}}% + \def\@ACRshortpl##1##2[##3]{% + \acronymfont{\@GLSplural@{##1}{##2}[##3]}}% + \def\@acrlong##1##2[##3]{\@glsfirst@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsfirst@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSfirst@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glstext@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsfirst@{##1}{##2}[##3] + (\acronymfont{\@glstext@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSfirst@{##1}{##2}[##3] + (\acronymfont{\@GLStext@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glsplural@{##1}{##2}[##3]})} + \def\@Acrfullpl##1##2[##3]{\@Glsfirstplural@{##1}{##2}[##3] + (\acronymfont{\@glsplural@{##1}{##2}[##3]})} + \def\@ACRfullpl##1##2[##3]{\@GLSfirstplural@{##1}{##2}[##3] + (\acronymfont{\@GLSplural@{##1}{##2}[##3]})} + \ifglsacrdua + \ifglsacrsmallcaps + \PackageError{glossaries}{Option clash: `smallcaps' and `dua' + can't both be set}{}% + \else + \PackageError{glossaries}{Option clash: `smaller' and `dua' + can't both be set}{}% + \fi + \fi +}% +\newcommand*{\SetDUADisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +\newcommand*{\DUANewAcronymDef}{% + \edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + name={\the\glsshorttok},% + text={\the\glslongtok},% + plural={\the\glslongtok\noexpand\acrpluralsuffix},% + description={\the\glslongtok},% + symbol={\the\glsshorttok},% + symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetDUAStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetDUADisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \DUANewAcronymDef + }% + \def\glsshortkey{symbol}% + \def\glsshortpluralkey{symbolplural}% + \def\glslongkey{text}% + \def\glslongpluralkey{plural}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetDUADisplayStyle{\@gls@type}% + }% + \def\@acrshort##1##2[##3]{\@glssymbol@{##1}{##2}[##3]}% + \def\@Acrshort##1##2[##3]{\@Glssymbol@{##1}{##2}[##3]}% + \def\@ACRshort##1##2[##3]{\@GLSsymbol@{##1}{##2}[##3]}% + \def\@acrshortpl##1##2[##3]{\@glssymbolplural@{##1}{##2}[##3]}% + \def\@Acrshortpl##1##2[##3]{\@Glssymbolplural@{##1}{##2}[##3]}% + \def\@ACRshortpl##1##2[##3]{\@GLSsymbolplural@{##1}{##2}[##3]}% + \def\@acrlong##1##2[##3]{\@glstext@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glstext@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLStext@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsplural@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsplural@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSplural@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glstext@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glstext@{##1}{##2}[##3] + (\acronymfont{\@glssymbol@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLStext@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbol@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsplural@{##1}{##2}[##3] + (\acronymfont{\@glssymbolplural@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSplural@{##1}{##2}[##3] + (\acronymfont{\@GLSsymbolplural@{##1}{##2}[##3]})}% +}% +\newcommand*{\SetAcronymStyle}{% + \SetDefaultAcronymStyle + \ifglsacrdescription + \ifglsacrfootnote + \SetDescriptionFootnoteAcronymStyle + \else + \ifglsacrdua + \SetDescriptionDUAAcronymStyle + \else + \SetDescriptionAcronymStyle + \fi + \fi + \else + \ifglsacrfootnote + \SetFootnoteAcronymStyle + \else + \ifthenelse{\boolean{glsacrsmallcaps}\OR + \boolean{glsacrsmaller}}% + {% + \SetSmallAcronymStyle + }% + {% + \ifglsacrdua + \SetDUAStyle + \fi + }% + \fi + \fi +} +\SetAcronymStyle +\newcommand*{\SetCustomDisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +\newcommand*{\CustomAcronymFields}{% + name={\the\glsshorttok},% + description={\the\glslongtok},% + first={\the\glslongtok\space(\the\glsshorttok)},% + firstplural={\the\glslongtok\noexpand\acrpluralsuffix\space + (\the\glsshorttok)}% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix}% +} +\newcommand*{\CustomNewAcronymDef}{% + \protected@edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + user1={\the\glsshorttok},% + user2={\the\glsshorttok\noexpand\acrpluralsuffix},% + user3={\the\glslongtok},% + user4={\the\glslongtok\noexpand\acrpluralsuffix},% + \CustomAcronymFields,% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetCustomStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetCustomDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \CustomNewAcronymDef + }% + \def\glsshortkey{user1}% + \def\glsshortpluralkey{user2}% + \def\glslongkey{user3}% + \def\glslongpluralkey{user4}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetCustomDisplayStyle{\@gls@type}% + }% + \def\@acrshort##1##2[##3]{\@glsuseri@{##1}{##2}[##3]}% + \def\@Acrshort##1##2[##3]{\@Glsuseri@{##1}{##2}[##3]}% + \def\@ACRshort##1##2[##3]{\@GLSuseri@{##1}{##2}[##3]}% + \def\@acrshortpl##1##2[##3]{\@glsuserii@{##1}{##2}[##3]}% + \def\@Acrshortpl##1##2[##3]{\@Glsuserii@{##1}{##2}[##3]}% + \def\@ACRshortpl##1##2[##3]{\@GLSuserii@{##1}{##2}[##3]}% + \def\@acrlong##1##2[##3]{\@glsuseriii@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3] + (\acronymfont{\@GLSuseri@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3] + (\acronymfont{\@GLSuserii@{##1}{##2}[##3]})}% +}% +\newcommand*{\DefineAcronymSynonyms}{% + \let\acs\acrshort + \let\Acs\Acrshort + \let\acsp\acrshortpl + \let\Acsp\Acrshortpl + \let\acl\acrlong + \let\aclp\acrlongpl + \let\Acl\Acrlong + \let\Aclp\Acrlongpl + \let\acf\acrfull + \let\acfp\acrfullpl + \let\Acf\Acrfull + \let\Acfp\Acrfullpl + \let\ac\gls + \let\Ac\Gls + \let\acp\glspl + \let\Acp\Glspl +} +\ifglsacrshortcuts + \DefineAcronymSynonyms +\fi +\RequirePackage{glossary-hypernav} +\@gls@loadlist +\@gls@loadlong +\@gls@loadsuper +\@gls@loadtree +\ifx\@glossary@default@style\relax +\else + \glossarystyle{\@glossary@default@style} +\fi +\endinput +%% +%% End of file `glossaries.sty'. diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty index e81b2ef813d..291fa313d0e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty index fa2a6e17dc0..370d530b711 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 2fc02b9fa8a..b1cfd0b2f65 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2010/02/06 v2.05 (NLCT)] +\ProvidesPackage{glossaries}[2010/06/14 v2.06 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -690,6 +690,9 @@ name=true]{% \glsdisplayfirst}}{}% \@ifnextchar[{\@gls@setcounter{#2}}% {\@gls@setcounter{#2}[\glscounter]}}} +\newcommand*{\altnewglossary}[3]{% + \newglossary[#2-glg]{#1}{#2-gls}{#2-glo}{#3}% +} \@onlypreamble{\newglossary} \@onlypremakeg\newglossary \newcommand*{\@newglossary}[4]{} @@ -1414,6 +1417,7 @@ counter as its value}}{% \glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% \def\@gls@link@opts{#1}% \def\@gls@link@label{#2}% +\def\glslabel{#2}% \ifglsused{#2}% {% \protected@edef\@glo@text{% @@ -1512,6 +1516,7 @@ counter as its value}}{% \glsdoifexists{#2}{\edef\@glo@type{\glsentrytype{#2}}% \def\@gls@link@opts{#1}% \def\@gls@link@label{#2}% +\def\glslabel{#2}% \ifglsused{#2}% {% \protected@edef\@glo@text{% @@ -3327,6 +3332,81 @@ style `#1' undefined}{}}{% \fi } \SetAcronymStyle +\newcommand*{\SetCustomDisplayStyle}[1]{% + \defglsdisplay[#1]{##1##4}% + \defglsdisplayfirst[#1]{##1##4}% +} +\newcommand*{\CustomAcronymFields}{% + name={\the\glsshorttok},% + description={\the\glslongtok},% + first={\the\glslongtok\space(\the\glsshorttok)},% + firstplural={\the\glslongtok\noexpand\acrpluralsuffix\space + (\the\glsshorttok)}% + text={\the\glsshorttok},% + plural={\the\glsshorttok\noexpand\acrpluralsuffix}% +} +\newcommand*{\CustomNewAcronymDef}{% + \protected@edef\@do@newglossaryentry{% + \noexpand\newglossaryentry{\the\glslabeltok}% + {% + type=\acronymtype,% + user1={\the\glsshorttok},% + user2={\the\glsshorttok\noexpand\acrpluralsuffix},% + user3={\the\glslongtok},% + user4={\the\glslongtok\noexpand\acrpluralsuffix},% + \CustomAcronymFields,% + \the\glskeylisttok + }% + }% + \@do@newglossaryentry +} +\newcommand*{\SetCustomStyle}{% + \renewcommand{\newacronym}[4][]{% + \ifx\@glsacronymlists\@empty + \def\@glo@type{\acronymtype}% + \setkeys{glossentry}{##1}% + \DeclareAcronymList{\@glo@type}% + \SetCustomDisplayStyle{\@glo@type}% + \fi + \glskeylisttok{##1}% + \glslabeltok{##2}% + \glsshorttok{##3}% + \glslongtok{##4}% + \newacronymhook + \CustomNewAcronymDef + }% + \def\glsshortkey{user1}% + \def\glsshortpluralkey{user2}% + \def\glslongkey{user3}% + \def\glslongpluralkey{user4}% + \@for\@gls@type:=\@glsacronymlists\do{% + \SetCustomDisplayStyle{\@gls@type}% + }% + \def\@acrshort##1##2[##3]{\@glsuseri@{##1}{##2}[##3]}% + \def\@Acrshort##1##2[##3]{\@Glsuseri@{##1}{##2}[##3]}% + \def\@ACRshort##1##2[##3]{\@GLSuseri@{##1}{##2}[##3]}% + \def\@acrshortpl##1##2[##3]{\@glsuserii@{##1}{##2}[##3]}% + \def\@Acrshortpl##1##2[##3]{\@Glsuserii@{##1}{##2}[##3]}% + \def\@ACRshortpl##1##2[##3]{\@GLSuserii@{##1}{##2}[##3]}% + \def\@acrlong##1##2[##3]{\@glsuseriii@{##1}{##2}[##3]}% + \def\@Acrlong##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3]}% + \def\@ACRlong##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3]}% + \def\@acrlongpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3]}% + \def\@Acrlongpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3]}% + \def\@ACRlongpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3]}% + \def\@acrfull##1##2[##3]{\@glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@Acrfull##1##2[##3]{\@Glsuseriii@{##1}{##2}[##3] + (\acronymfont{\@glsuseri@{##1}{##2}[##3]})}% + \def\@ACRfull##1##2[##3]{\@GLSuseriii@{##1}{##2}[##3] + (\acronymfont{\@GLSuseri@{##1}{##2}[##3]})}% + \def\@acrfullpl##1##2[##3]{\@glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@Acrfullpl##1##2[##3]{\@Glsuseriv@{##1}{##2}[##3] + (\acronymfont{\@glsuserii@{##1}{##2}[##3]})}% + \def\@ACRfullpl##1##2[##3]{\@GLSuseriv@{##1}{##2}[##3] + (\acronymfont{\@GLSuserii@{##1}{##2}[##3]})}% +}% \newcommand*{\DefineAcronymSynonyms}{% \let\acs\acrshort \let\Acs\Acrshort diff --git a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty index 0ae3809c105..cb10834fddf 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict index 09ef23256d4..f235973c80e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict index e0bcb0339ac..a52b1a4be44 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict index 056e276535e..37011f0f8b3 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict index b0db751de4b..acf518e4b7c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict index c5d3f0d6c9a..4cb2a307b0d 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict index e03f6bd0138..c4fbd3a23bf 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict index eb1415cfb3b..39e898eb5bb 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict index c78c7059b2b..61f224ec245 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict index feeef949fa7..35df501a752 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict index 7cd34f3f5e3..6ca991d0512 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict index 6cc6d78b931..9631befad3c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict @@ -1,13 +1,13 @@ %% -%% This is file `glossaries-dictionary-Brazil.dict', +%% This is file `glossaries-dictionary-Serbian.dict', %% generated with the docstrip utility. %% %% The original source files were: %% -%% glossaries.dtx (with options: `glossaries-dictionary-Brazil.dict,package') +%% glossaries.dtx (with options: `glossaries-dictionary-Serbian.dict,package') %% %% glossaries.dtx -%% Copyright 2009 Nicola Talbot +%% Copyright 2010 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-dictionary-Brazil.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -38,15 +38,15 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesDictionary{glossaries-dictionary}{Brazil} -\providetranslation{Glossary}{Gloss\'ario} -\providetranslation{Acronyms}{Siglas} -\providetranslation{Notation (glossaries)}{Nota\c c\~ao} -\providetranslation{Description (glossaries)}{Descri\c c\~ao} -\providetranslation{Symbol (glossaries)}{S\'imbolo} -\providetranslation{Page List (glossaries)}{Lista de P\'aginas} -\providetranslation{Symbols (glossaries)}{S\'imbolos} -\providetranslation{Numbers (glossaries)}{N\'umeros} +\ProvidesDictionary{glossaries-dictionary}{Serbian} +\providetranslation{Glossary}{Mali re\v cnik} +\providetranslation{Acronyms}{Skra\' cenice} +\providetranslation{Notation (glossaries)}{Oznaka} +\providetranslation{Description (glossaries)}{Opis} +\providetranslation{Symbol (glossaries)}{Simbol} +\providetranslation{Page List (glossaries)}{Stranica} +\providetranslation{Symbols (glossaries)}{Simboli} +\providetranslation{Numbers (glossaries)}{Brojevi} \endinput %% -%% End of file `glossaries-dictionary-Brazil.dict'. +%% End of file `glossaries-dictionary-Serbian.dict'. diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict index 4a26a7eb687..99621ec1e7a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty index eee5c6093d6..4388301741e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty +++ b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty index a9e8cdc48a6..3c5a4d04c98 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty index 00337121c4b..a465d83341a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty index 126516f79d3..f03c7059180 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty index 0d5c80c7a9e..ec9ef91e5f7 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty index ad006d8591d..da1a81fd541 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty index 75e0329320c..0c38554b9ba 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty index d4cb59737d9..ac00ec2bf85 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-custom-acronym.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy.tex, samplexdy-mc.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z |