From 4619c8309b673808e4d13a3202d2c8d9f6374f5e Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 17 Jan 2009 01:07:22 +0000 Subject: glossaries 1.18 git-svn-id: svn://tug.org/texlive/trunk@11899 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 26 + Master/texmf-dist/doc/latex/glossaries/INSTALL | 49 +- Master/texmf-dist/doc/latex/glossaries/README | 20 +- .../doc/latex/glossaries/glossaries-manual.html | 5200 +++++++++++--------- .../doc/latex/glossaries/glossaries-manual.tex | 832 +++- .../texmf-dist/doc/latex/glossaries/glossaries.pdf | Bin 1261508 -> 1347383 bytes .../doc/latex/glossaries/glossary2glossaries.html | 477 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 166931 -> 172086 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 297 +- .../doc/latex/glossaries/samples/sampletree.tex | 2 +- .../source/latex/glossaries/glossaries.dtx | 2642 +++++++--- .../source/latex/glossaries/glossaries.ins | 4 +- .../tex/latex/glossaries/base/glossaries-babel.sty | 6 +- .../tex/latex/glossaries/base/glossaries.sty | 61 +- .../tex/latex/glossaries/base/mfirstuc.sty | 2 +- .../dict/glossaries-dictionary-Brazil.dict | 2 +- .../dict/glossaries-dictionary-Danish.dict | 2 +- .../dict/glossaries-dictionary-Dutch.dict | 2 +- .../dict/glossaries-dictionary-English.dict | 2 +- .../dict/glossaries-dictionary-French.dict | 2 +- .../dict/glossaries-dictionary-German.dict | 2 +- .../dict/glossaries-dictionary-Irish.dict | 2 +- .../dict/glossaries-dictionary-Italian.dict | 2 +- .../dict/glossaries-dictionary-Magyar.dict | 2 +- .../dict/glossaries-dictionary-Polish.dict | 2 +- .../dict/glossaries-dictionary-Spanish.dict | 2 +- .../latex/glossaries/styles/glossary-hypernav.sty | 2 +- .../tex/latex/glossaries/styles/glossary-list.sty | 80 +- .../tex/latex/glossaries/styles/glossary-long.sty | 202 +- .../tex/latex/glossaries/styles/glossary-super.sty | 243 +- .../tex/latex/glossaries/styles/glossary-tree.sty | 325 +- 31 files changed, 6564 insertions(+), 3928 deletions(-) (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index d5e529684af..024f2954406 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,31 @@ glossaries change log: +v1.18: + * fixed missing closing } in glossaries-babel.sty + + * added \glstarget so that glossary styles can be modified + in the document without using internal commands. + + * glossary-super.sty isn't loaded if supertabular.sty isn't + installed. + + * added nolong, nosuper, nolist, notree and nostyles package + options to prevent loading unnecessary packages. + + * added \oldacronym (emulates the old glossary package's + \newacronym command). + + * added sublistdotted style. + + * fixed bug caused by misspelt \glspagewidthlist (should be + \glspagelistwidth). + + * fixed border in super4colheaderborder and + altsuper4colheaderborder styles. + + * fixed sort sanitization when package option sanitize={name=false} + is used. + v1.17: * changed definition of \@glossary to prevent conflict with memoir diff --git a/Master/texmf-dist/doc/latex/glossaries/INSTALL b/Master/texmf-dist/doc/latex/glossaries/INSTALL index e192b2517b7..55ceb4fcac2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/INSTALL +++ b/Master/texmf-dist/doc/latex/glossaries/INSTALL @@ -1,9 +1,10 @@ INSTALLATION -If you have downloaded the glossaries package using the TeX Directory -Structure (TDS), that is you have downloaded an archive containing -doc, tex, scripts and source directories, you need to follow the -"Installing from TDS" instructions below. +If you have downloaded the glossaries package using the TeX +Directory Structure (TDS), that is you have downloaded the archive +glossaries.tds.zip containing doc, tex, scripts and source +directories, you need to follow the "Installing from TDS" +instructions below. If you have downloaded the following files: @@ -22,16 +23,21 @@ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings INSTALLING FROM TDS =================== -Files in tex and doc directories should go in the -corresponding TEXMF directories (for example, /usr/share/texmf-local/ -or C:\localtexmf\). The scripts/glossaries/ directory -contains the Perl script makeglossaries and the batch file -makeglossaries.bat which should go somewhere on your operating system's -PATH. (Both files are required for Windows, but only the Perl script is -required for other operating systems.) +Files in tex and doc directories should go in the corresponding +TEXMF directories (for example, /usr/share/texmf-local/ or +C:\localtexmf\). The scripts/glossaries/ directory contains the Perl +script makeglossaries and the batch file makeglossaries.bat which +should go somewhere on your operating system's PATH. (Both files are +required for Windows, but only the Perl script is required for other +operating systems.) *Remember to refresh TeX's database* +Example (on UNIX like systems): + +unzip glossaries.tds.zip -d ~/texmf/ +texhash ~/texmf/ + A minimal example file called minimalgls.tex is provided for testing and debugging purposes and can be found in the package documentation samples directory (doc/latex/glossaries/samples/). To test your @@ -43,7 +49,7 @@ latex minimalgls The LaTeX2HTML style file, glossaries.perl, is located in source/latex/glossaries and should go in the LaTeX2HTML styles -directory. +directory, if required. INSTALLING FROM DTX AND INS =========================== @@ -76,19 +82,22 @@ Move the sample files (*.tex) to TEXMF/doc/latex/glossaries/sample/ Move the documentation (*.pdf) to TEXMF/doc/latex/glossaries/ -Move glossaries.sty, glossaries-babel.sty and mfirstuc.sty to TEXMF/tex/latex/glossaries/base/ +Move glossaries.sty, glossaries-babel.sty and mfirstuc.sty to +TEXMF/tex/latex/glossaries/base/ -Move the other style files (glossary-*.sty) to TEXMF/tex/latex/glossaries/styles/ +Move the other style files (glossary-*.sty) to +TEXMF/tex/latex/glossaries/styles/ -Move the dictionary files (*.dict) to TEXMF/tex/latex/glossaries/dict/ +Move the dictionary files (*.dict) to +TEXMF/tex/latex/glossaries/dict/ Move makeglossaries to somewhere on your path, e.g. /usr/bin/. -If you are a Windows user, you will also need to move makeglossaries.bat -to the same location as makeglossaries, but you will need to have -Perl installed to be able to use makeglossaries. (It is possible -to use makeindex directly if you don't have Perl installed. See -the manual, glossaries.pdf, for details.) +If you are a Windows user, you will also need to move +makeglossaries.bat to the same location as makeglossaries, but you +will need to have Perl installed to be able to use makeglossaries. +(It is possible to use makeindex or xindy directly if you don't have +Perl installed. See the manual, glossaries.pdf, for details.) *Remember to refresh TeX's database* diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 3d2dbe45aeb..33d1fa9e685 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 1.17 +LaTeX Package : glossaries v 1.18 -Last Modified : 26 December 2008 +Last Modified : 14th January 2009 Author : Nicola Talbot @@ -34,8 +34,20 @@ See INSTALL file for installation instructions. REQUIREMENTS -The glossaries package requires at least version 2.5f (2006/11/18) of -the xkeyval package. +ifthen +xkeyval *at least version 2.5f (2006/11/18)* +xfor +amsgen +longtable (unless you use the nolong or nostyles package options) + +If the supertabular package is installed, it will also be loaded +unless the nosuper or nostyles package options are used. If the +supertabular package isn't installed, you can still use the +glossaries package, but you won't be able to use any of the styles +defined in glossaries-super.sty. + +Note that the current version of the glossaries package doesn't +load xspace. LaTeX2HTML diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html index 12a1968e72c..c6dc5cea7b2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html @@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -glossaries.sty v 1.17: LaTeX2e Package to Assist Generating Glossaries - +glossaries.sty v 1.18: LaTeX2e Package to Assist Generating Glossaries + @@ -27,7 +27,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-

glossaries.sty v 1.17: LaTeX2e Package to Assist Generating Glossaries

+

glossaries.sty v 1.18: LaTeX2e Package to Assist Generating Glossaries

Nicola L.C. Talbot

@@ -40,7 +40,7 @@ Norwich. Norfolk NR4 7TJ. United Kingdom.
http://theoval.cmp.uea.ac.uk/~nlct/

-

26th December 2008

+

14th January 2009


@@ -49,94 +49,108 @@ Contents +
  • Defining your own glossary style
    -
  • Mfirstuc Package -
  • Index @@ -152,26 +166,28 @@ 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 -where only those terms used in the text are added to the glossary. +entries. There is provision for loading a database of glossary terms. +Only those terms used1 in the document will be +added to the glossary.

    -This package replaces the glossary package which is +This package replaces the glossary package which is now obsolete. Please see the file -glossary2glossaries.html for assistance in upgrading.

    The glossaries package comes with a -Perl script -called makeglossaries. This provides a convenient interface -to makeindex or xindy. It is strongly +called makeglossaries. This provides a convenient interface +to makeindex or xindy. It is strongly recommended that you use this script, but it is not essential. If you are reluctant to install Perl, or for any -other reason you don't want to use makeglossaries, you -can called makeindex or xindy explicitly. +other reason you don't want to use makeglossaries, you +can called makeindex or xindy explicitly. See Generating the Associated Glossary Files for further details. @@ -190,8 +206,8 @@ having to read through lengthy descriptions.

  • -
  • Overview -gives an overview of available commands and their syntax. +
  • Overview of User Commands +gives an overview of the main user commands and their syntax.

  • @@ -254,7 +270,7 @@ according to your operating system and TEX distribution. The sample documents are as follows:
    minimalgls.tex
    -
    This document is a minimal working example. +
    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: @@ -270,9 +286,16 @@ latex minimalgls PDFLaTeX you will also get warnings about non-existent references. These warnings may be ignored on the first run. +

    +If you get a Missing \begin{document} error, then + it's most likely that your version of 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 xkeyval + package. +

    -

  • Run makeglossaries on the document. This can +
  • Run makeglossaries on the document. This can be done on a terminal by either typing
     makeglossaries minimalgls
    @@ -283,7 +306,7 @@ perl makeglossaries minimalgls
     
    If your system doesn't recognise the command perl then it's likely you don't have Perl installed. In which case you - will need to use makeindex directly. You can do this + will need to use makeindex directly. You can do this in a terminal by typing (all on one line):
     makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls
    @@ -291,7 +314,7 @@ minimalgls.glo
     
    (See later - for further details on using makeindex explicitly.) + for further details on using makeindex explicitly.)

    Note that if you need to specify the full path and the path @@ -311,7 +334,7 @@ is the page number where the entry was referenced.

  • sample4col.tex
    -
    This document illustrates a four column +
    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: @@ -321,10 +344,10 @@ makeglossaries sample4col latex sample4col As before, if you don't have Perl installed, you will need to -use makeindex directly instead of using -makeglossaries. The vertical gap between entries +use makeindex directly instead of using +makeglossaries. The vertical gap between entries is the gap created at the start of each group. This can be -suppressed by redefining \glsgroupskip after the glossary +suppressed by redefining \glsgroupskip after the glossary style has been set:
     \renewcommand*{\glsgroupskip}{}
    @@ -333,9 +356,9 @@ style has been set:
     

    sampleAcr.tex
    -
    This document has some sample acronyms. It +
    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: +run through LaTeX is required to ensure the document is up to date:
     latex sampleAcr
     makeglossaries sampleAcr
    @@ -346,7 +369,7 @@ latex sampleAcr
     

    sampleAcrDesc.tex
    -
    This is similar to the previous example, +
    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: @@ -360,9 +383,9 @@ latex sampleAcrDesc

    sampleDesc.tex
    -
    This is similar to the previous example, -except that it defines the acronyms using \newglossaryentry -instead of \newacronym. As with +
    This is similar to the previous example, +except that it defines the acronyms using \newglossaryentry +instead of \newacronym. As with the previous example, the glossary is added to the table of contents, so an extra run through LaTeX is required:
    @@ -375,10 +398,10 @@ latex sampleDesc
     

    sampleDB.tex
    -
    This document illustrates how to load -an external files containing the glossary definitions. It also +
    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 suppressed and uses \glsaddall to add +has the number list suppressed and uses \glsaddall to add all the entries to the glossaries without referencing each one explicitly. To create the document do:
    @@ -386,10 +409,11 @@ latex sampleDB
     makeglossaries sampleDB
     latex sampleDB
     
    -The glossary definitions are stored in the files +The glossary definitions are stored in the accompanying files database1.tex and database2.tex. Note that if you don't have Perl installed, you will need to use -makeindex twice instead of using makeglossaries: +makeindex twice instead of a single call to +makeglossaries:
    1. Create the main glossary: @@ -407,7 +431,7 @@ makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn

    sampleEq.tex
    -
    This document illustrates how to change the +
    This document illustrates how to change the location to something other than the page number. In this case, the equation counter is used since all glossary entries appear inside an equation environment. To create the @@ -421,8 +445,8 @@ latex sampleEq

    sampleEqPg.tex
    -
    This is similar to the previous example, -but the number lists are a mixture of page +
    This is similar to the previous example, +but the number lists 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:
    @@ -435,7 +459,7 @@ latex sampleEqPg
     

    sampleSec.tex
    -
    This document also illustrates how to change +
    This document also illustrates how to change the location to something other than the page number. In this case, the section counter is used. This example adds the glossary to the table of contents, so an extra LaTeX run is @@ -450,7 +474,7 @@ latex sampleSec

    sampleNtn.tex
    -
    This document illustrates how to create +
    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:
    @@ -460,7 +484,8 @@ latex sampleNtn
     latex sampleNtn
     
    Note that if you don't have Perl installed, you will need to use -makeindex twice instead of using makeglossaries: +makeindex twice instead of a single call to +makeglossaries:
    1. Create the main glossary: @@ -478,7 +503,7 @@ makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn

    sample.tex
    -
    This document illustrates some of the basics, +
    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: @@ -489,16 +514,16 @@ latex sample latex sample You can see the difference between word and letter ordering -if you substitute order=word with -order=letter. (Note that this will only have an -effect if you use makeglossaries. If you use -makeindex explicitly, you will need to use the +if you substitute order=word with +order=letter. (Note that this will only have an +effect if you use makeglossaries. If you use +makeindex explicitly, you will need to use the -l switch to indicate letter ordering.)

    sampletree.tex
    -
    This document illustrates a hierarchical +
    This document illustrates a hierarchical glossary structure where child entries have different names to their corresponding parent entry. To create the document do:
    @@ -510,12 +535,12 @@ latex sampletree
     

    samplexdy.tex
    -
    This document illustrates how to use the -glossaries package with xindy instead of -makeindex. The document uses UTF8 encoding (with the -inputenc package). The encoding is picked up by -makeglossaries. By default, this document will create -a xindy style file called samplexdy.xdy, but +
    This document illustrates how to use the +glossaries package with xindy instead of +makeindex. The document uses UTF8 encoding (with the +inputenc package). The encoding is picked up by +makeglossaries. By default, this document will create +a xindy style file called samplexdy.xdy, but if you uncomment the lines
     \setStyleFile{samplexdy-mc}
    @@ -524,12 +549,12 @@ if you uncomment the lines
     
    it will set the style file to samplexdy-mc.xdy instead. This provides an additional letter group for entries starting -with "Mc" or "Mac". If you use makeglossaries, +with "Mc" or "Mac". If you use makeglossaries, you don't need to supply any additional information. If you -don't use makeglossaries, you will need to specify the +don't use makeglossaries, you will need to specify the required information. Note that if you set the style file to -samplexdy-mc.xdy you must also specify \noist, -otherwise the glossaries package will overwrite +samplexdy-mc.xdy you must also specify \noist, +otherwise the glossaries package will overwrite samplexdy-mc.xdy and you will lose the "Mc" letter group.

    @@ -540,7 +565,7 @@ makeglossaries samplexdy latex samplexdy If you don't have Perl installed, you will have to call -xindy explicitly instead of using makeglossaries. +xindy explicitly instead of using makeglossaries. If you are using the default style file samplexdy.xdy, then do (no line breaks):

    @@ -557,8 +582,8 @@ samplexdy.glo
     

    sampleutf8.tex
    -
    This is another example that uses -xindy. Unlike makeindex, xindy can +
    This is another example that uses +xindy. Unlike makeindex, xindy can cope with accented or non-Latin characters. This document uses UTF8 encoding. To create the document do:
    @@ -567,7 +592,7 @@ makeglossaries sampleutf8
     latex sampleutf8
     
    If you don't have Perl installed, you will have to call -xindy explicitly instead of using makeglossaries +xindy explicitly instead of using makeglossaries (no line breaks):
     xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg
    @@ -575,7 +600,8 @@ xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg
     

    -If you remove the xindy option and do: +If you remove the xindy option from sampleutf8.tex +and do:

     latex sampleutf8
     makeglossaries sampleutf8
    @@ -584,7 +610,7 @@ latex sampleutf8
     you will see that the entries that start with a non-Latin character
     now appear in the symbols group, and the word "manœuvre" is now 
     after "manor" instead of before it. If you are unable to use
    -makeglossaries, the call to makeindex is as
    +makeglossaries, the call to makeindex is as
     follows (no line breaks):
     
     makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls
    @@ -608,13 +634,13 @@ Multi-Lingual Support
     
     

    As from version 1.17, the glossaries package can now be -used with xindy as well as makeindex. If you +used with xindy as well as makeindex. If you are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use xindy -as makeindex is hard-coded for Latin languages. This +non-Latin characters it is recommended that you use xindy +as makeindex is hard-coded for Latin languages. This means that you are not restricted to the A, ..., Z letter groups. -If you want to use xindy, remember to use the -xindy package option. For example: +If you want to use xindy, remember to use the +xindy package option. For example:

     \documentclass[frenchb]{article}
     \usepackage[utf8]{inputenc}
    @@ -627,18 +653,18 @@ If you want to use xindy, remember to use the
     If you use an accented or non-Latin 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. \Gls) due to expansion issues. For example:
    +(e.g. \Gls) due to expansion issues. For example:
     
     \newglossaryentry{elite}{name={{é}lite},
     description={select group or class}}
     

    -If you use the inputenc package, makeglossaries +If you use the inputenc package, makeglossaries will pick up the encoding from the auxiliary file. If you use -xindy explicitly instead of via makeglossaries, +xindy explicitly instead of via makeglossaries, you may need to specify the encoding using the -C -option. Read the xindy manual for further details. +option. Read the xindy manual for further details.

    @@ -653,13 +679,13 @@ As from version 1.08, the glossaries package now has limited multi-lingual support, thanks to all the people who have sent me the relevant translations either via email or via comp.text.tex. -However you must load babel before -glossaries to enable this. Note that if babel is loaded -and the translator package is detected on TEX's path, then the -translator package will be loaded automatically, however, +However you must load babel before +glossaries to enable this. Note that if babel is loaded +and the translator package is detected on TEX's path, then the +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 -translator package with the required languages. For example: +translator package with the required languages. For example:

     \usepackage[spanish]{babel}
     \usepackage[spanish]{translator}
    @@ -675,8 +701,8 @@ than a package option. For example:
     

    -If you want to use ngerman or german instead -of babel, you will need to include the translator package +If you want to use ngerman or german instead +of babel, you will need to include the translator package to provide the translations. For example:

     \documentclass[ngerman]{article}
    @@ -687,7 +713,7 @@ to provide the translations. For example:
     
     

    The following languages are currently supported by the -glossaries package: +glossaries package:

    @@ -728,7 +754,7 @@ The following languages are currently supported by the
    Language
    -The language dependent commands and translator keys used by the +The language dependent commands and translator keys used by the glossaries package are listed in table 1.

    @@ -737,49 +763,49 @@ glossaries package are listed in

    - + - - + + - + - + +(when used with package option acronym). - + - + - + - + - + - +

    Due to the varied nature of glossaries, it's likely that the predefined translations may not be appropriate. If you are using -the babel package and do not have the translator package +the babel package and do not have the translator package installed, you need to be familiar with the -advice on changing the words babel uses.

    -If you have the translator package installed, then it becomes +If you have the translator package installed, then it becomes much easier to change the default translations. For example, if you are writing in Irish and you want \symbolname to produce "Siombail" instead of "Comhartha", then you can put the following @@ -809,11 +835,11 @@ in your document preamble:

    -Note that xindy provides much better multi-lingual -support than makeindex, so it's recommended that you -use xindy if you have glossary entries that contain +Note that xindy provides much better multi-lingual +support than makeindex, so it's recommended that you +use xindy if you have glossary entries that contain accented characters or non-Roman letters. See -Xindy for further details.

    @@ -834,46 +860,46 @@ 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 makeindex and xindy. As +LaTeX are makeindex and xindy. As from version 1.17, the glossaries package can be used with either of these applications. Previous versions were designed -to be used with makeindex only. Note that -xindy has much better multi-lingual support than -makeindex, so xindy is recommended if you're +to be used with makeindex only. Note that +xindy has much better multi-lingual support than +makeindex, so xindy is recommended if you're not writing in English. Commands that only have an -effect when xindy is used are described +effect when xindy is used are described later.

    The glossaries package comes with the Perl script -makeglossaries which will run makeindex or -xindy on all the glossary files using a customized style -file (which is created by \makeglossaries). See +makeglossaries which will run makeindex or +xindy on all the glossary files using a customized style +file (which is created by \makeglossaries). See Using the makeglossaries Perl script 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 http://www.perl.org/about.html. However, whilst it is strongly recommended that you use the -makeglossaries script, it is possible to use the +makeglossaries script, it is possible to use the glossaries package without having Perl installed. In which -case, if you have used the xindy package option, you will -need to use xindy (see +case, if you have used the xindy package option, you will +need to use xindy (see Using xindy explicitly), otherwise you will need to use -makeindex (see +makeindex (see Using makeindex explicitly). Note that some commands and package options have no effect if you don't use -makeglossaries. These are listed in -Table 2. +makeglossaries. These are listed in +table 2.

    Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to -do an additional makeglossaries, makeindex -or xindy run, as appropriate. For example, +do an additional makeglossaries, makeindex +or xindy run, as appropriate. For example, suppose you have defined the following entries:

     \newglossaryentry{citrusfruit}{name={citrus fruit},
    @@ -887,7 +913,7 @@ and suppose you have \gls{citrusfruit} in your document
     but don't reference the orange entry, then the
     orange entry won't appear in your glossary until
     you first create the glossary and then do another run
    -of makeglossaries, makeindex or xindy.
    +of makeglossaries, makeindex or xindy.
     For example, if the document is called myDoc.tex, then
     you must do:
     
    @@ -899,17 +925,17 @@ latex myDoc
     

    -Likewise, an additional makeglossaries and LaTeX run +Likewise, an additional makeglossaries and LaTeX run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second LaTeX run may push glossary entries across page boundaries, which -means that the number lists in the glossary may +means that the number lists in the glossary may need updating.

    The examples in this document assume that you are accessing -makeglossaries, xindy or makeindex via +makeglossaries, xindy or makeindex via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the Start->All Programs @@ -922,38 +948,38 @@ details.

    If any problems occur, remember to check the transcript files -(e.g. .glg or .alg) for messages. +(e.g. .glg or .alg) for messages.


    - +
    Table 1: Customised Text
     Command Name Translator key word What it's forTranslator Key Word Purpose  
     \glossaryname
     \glossaryname Glossary Title of the main glossary.  
     \acronymname
     \acronymname Acronyms Title of the list of acronyms -(when used with package option acronym).  
     \entryname
     \entryname Notation (glossaries) Header for first column in the glossary (for 2, 3 or 4 column glossaries that support headers).  
     \descriptionname
     \descriptionname Description (glossaries) Header for second column in the glossary (for 2, 3 or 4 column glossaries that support headers).  
     \symbolname
     \symbolname Symbol (glossaries) Header for symbol column in the glossary for glossary styles that support this option.  
     \pagelistname
     \pagelistname Page List (glossaries) Header for page list column in the glossary for glossaries that support this option.  
     \glssymbolsgroupname
     \glssymbolsgroupname Symbols (glossaries) Header for symbols section of the glossary for glossary styles that support this option.  
     \glsnumbersgroupname
     \glsnumbersgroupname Numbers (glossaries) Header for numbers section of the glossary for glossary styles that support @@ -793,13 +819,13 @@ this option.
    - - + + - + - + - + - + - + @@ -976,13 +1002,13 @@ Using the makeglossaries Perl Script

    -The makeglossaries script picks up the relevant -information from the auxiliary (.aux) file and -will either call xindy or makeindex, +The makeglossaries script picks up the relevant +information from the auxiliary (.aux) file and +will either call xindy or makeindex, depending on whether the indexing style file ends with -.xdy or .ist. Therefore, you only need to +.xdy or .ist. Therefore, you only need to pass the document's name without the extension to -makeglossaries. +makeglossaries. For example, if your document is called myDoc.tex, type the following in your terminal:

    @@ -990,7 +1016,7 @@ latex myDoc
     makeglossaries myDoc
     latex myDoc
     
    -You may need to explicitly load makeglossaries into +You may need to explicitly load makeglossaries into Perl:
     perl makeglossaries myDoc
    @@ -1011,19 +1037,20 @@ Using xindy explicitly
     
     
     

    -If you want to use xindy to process the glossary +If you want to use xindy to process the glossary files, you must make sure you have used the -xindy package option: +xindy package option:

     \usepackage[xindy]{glossaries}
     
    -This is required regardless of whether you use xindy -explicitly or via makeglossaries. This causes the glossary -entries to be written in raw xindy format, so you need to +This is required regardless of whether you use xindy +explicitly or whether it's called implicitly via +makeglossaries. This causes the glossary +entries to be written in raw xindy format, so you need to use -I xindy not -I tex.

    -To run xindy type the following in your terminal +To run xindy type the following in your terminal (all on one line):

    xindy -L language -C encoding -I xindy @@ -1033,14 +1060,15 @@ To run xindy type the following in your terminal

    -where language is required language name, encoding is -the encoding, base is the name of the document without -the .tex extension and style is the name of the -xindy style file without the .xdy extension. The -default name for this style file is base.xdy but -can be changed via \setStyleFile{style}. You may need to -specify the full path name. If any of the file names contain spaces, -you must delimit them using double-quotes. +where language is the required language name, encoding +is the encoding, base is the name of the document without the +.tex extension and style is the name of the +xindy style file without the .xdy extension. +The default name for this style file is base.xdy +but can be changed via \setStyleFile{style}. 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.

    For example, if your document is called myDoc.tex and @@ -1053,28 +1081,28 @@ xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo

    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 acronym -package option), substituting .glg, .gls -and .glo with the relevant extensions. For example, -if you have used the acronym package option, then +list of acronyms if you have used the acronym +package option), substituting .glg, .gls +and .glo with the relevant extensions. For example, +if you have used the acronym package option, then you would need to do:

     xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn
     
    For additional glossaries, the extensions are those supplied -when you created the glossary with \newglossary. +when you created the glossary with \newglossary.

    -Note that if you use makeglossaries instead, you can -replace all those calls to xindy with just one call -to makeglossaries: +Note that if you use makeglossaries instead, you can +replace all those calls to xindy with just one call +to makeglossaries:

     makeglossaries myDoc
     
    Note also that some commands and package options have no effect if -you use xindy explicitly instead of using -makeglossaries. These are listed in -Table 2. +you use xindy explicitly instead of using +makeglossaries. These are listed in +table 2.

    Top @@ -1088,10 +1116,10 @@ Using makeindex explicitly

    -If you want to use makeindex explicitly, you must -make sure that you haven't used the xindy package +If you want to use makeindex explicitly, you must +make sure that you haven't used the xindy package option or the glossary entries will be written in the wrong -format. To run makeindex, type the following in +format. To run makeindex, type the following in your terminal:

    makeindex -s style.ist -t base.glg @@ -1100,11 +1128,11 @@ your terminal:

    where base is the name of your document without the -.tex extension and style.ist is the -name of the makeindex style file. By default, this is -base.ist, but may be changed via -\setStyleFile{style}. Note that there are other options, -such as -l (letter ordering). See the makeindex +.tex extension and style.ist is the +name of the makeindex style file. By default, this is +base.ist, but may be changed via +\setStyleFile{style}. Note that there are other options, +such as -l (letter ordering). See the makeindex manual for further details.

    @@ -1115,29 +1143,29 @@ makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo

    Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the -acronym package option) then you must call -makeindex for each glossary, substituting -.glg, .gls and .glo with the +acronym package option) then you must call +makeindex for each glossary, substituting +.glg, .gls and .glo with the relevant extensions. For example, if you have used the -acronym package option, then you need to type the +acronym package option, then you need to type the following in your terminal:
     makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn
     
    For additional glossaries, the extensions are those supplied -when you created the glossary with \newglossary. +when you created the glossary with \newglossary.

    -Note that if you use makeglossaries instead, you can -replace all those calls to makeindex with just one call -to makeglossaries: +Note that if you use makeglossaries instead, you can +replace all those calls to makeindex with just one call +to makeglossaries:

     makeglossaries myDoc
     
    Note also that some commands and package options have no effect if -you use makeindex explicitly instead of using -makeglossaries. These are listed in -Table 2. +you use makeindex explicitly instead of using +makeglossaries. These are listed in +table 2.

    Top @@ -1159,33 +1187,44 @@ varies according to your operating system and TEX installation. For example, on my Linux partition it can be found in /usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/. Further information on debugging LaTeX code is available at -http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/.

    Below is a list of the most frequently asked questions. For other queries, consult the glossaries FAQ at -http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html.

      -
    1. I've used the smallcaps option, but the acronyms +
    2. Q. I get the error message: +
      +Missing \begin{document}
      +
      + +

      +A. Check you are using an up to date version of the xkeyval +package. + +

      +

    3. +
    4. Q. I've used the smallcaps option, but the acronyms are displayed in normal sized upper case letters.

      -The smallcaps package option uses \textsc to typeset +A. The smallcaps package option uses \textsc to typeset the acronyms. This command converts lower case letters to small capitals, while upper case letters remain their usual size. Therefore you need to specify the acronym in lower case letters.

    5. -
    6. How do I change the font that the acronyms are displayed in? +
    7. Q. How do I change the font that the acronyms are displayed in?

      -The easiest way to do this is to specify the smaller package +A. The easiest way to do this is to specify the smaller package option and redefine \acronymfont to use the required typesetting command. For example, suppose you would like the acronyms displayed in a sans-serif font, then you can do: @@ -1196,16 +1235,16 @@ a sans-serif font, then you can do:

    8. -
    9. How do I change the font that the acronyms are displayed in -on first use? +
    10. Q. How do I change the font that the acronyms are displayed in +on first use?

      -The easiest way to do this is to specify the smaller package +A. The easiest way to do this is to specify the smaller package option and redefine \firstacronymfont to use the required command. Note that if you don't want the acronym on subsequent use to use \smaller, you will also need to redefine \acronymfont, -as above. For example to make the acronym emphasized on first use, -but use the surrounding font for subsequent use, you can do: +as above. For example to make the acronym emphasized on +first use, but use the surrounding font for subsequent use, you can do:

       \usepackage[smaller]{glossaries}
       \renewcommand*{\firstacronymfont}[1]{\emph{#1}}
      @@ -1214,24 +1253,27 @@ but use the surrounding font for subsequent use, you can do:
       
       

    11. -
    12. I don't have Perl installed, do I have to use -makeglossaries? +
    13. Q. I don't have Perl installed, do I have to use +makeglossaries?

      -Read Using +A. Although it is strongly recommended that you use +makeglossaries, you don't have to use it. +For further details, read +Using xindy explicitly or Using makeindex explicitly, depending on -whether you want to use xindy or makeindex. +whether you want to use xindy or makeindex.

    14. -
    15. I'm used to using the glossary package: are there any -instructions on migrating from the glossary package to the +
    16. Q. I'm used to using the glossary package: are there any +instructions on migrating from the glossary package to the glossaries package?

      -Read A. Read Upgrading from the glossary package to the glossaries package which should be available from the @@ -1239,11 +1281,11 @@ same location as this document.

    17. -
    18. I'm using babel but the fixed names haven't been +
    19. Q. I'm using babel but the fixed names haven't been translated.

      -The glossaries package currently only supports the following +A. The 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 @@ -1251,7 +1293,7 @@ to the next version.

      If you are using one of the above languages, but the text hasn't been -translated, try adding the translator package with the +translated, try adding the translator package with the required languages explicitly (before you load the glossaries package). For example:

      @@ -1265,18 +1307,18 @@ for further details.
       
       

    20. -
    21. My glossaries haven't appeared. +
    22. Q. My glossaries haven't appeared.

      -Remember to do the following: +A. Remember to do the following:

        -
      • Add \makeglossaries to the document preamble. +
      • Add \makeglossaries to the document preamble.

      • -
      • Use either \printglossary for each glossary that has -been defined or \printglossaries. +
      • Use either \printglossary for each glossary that has +been defined or \printglossaries.

      • @@ -1285,23 +1327,23 @@ been defined or \printglossaries. Entries, Adding an Entry to the Glossary Without Generating Text or -Cross-Referencing +Cross-Referencing Entries for each entry that you want to appear in the glossary.

        -

      • Run LaTeX on your document, then run makeglossaries, +
      • Run LaTeX on your document, then run 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 makeglossaries after the second LaTeX run, followed +run makeglossaries after the second LaTeX run, followed by another LaTeX run.

      -Check the log files (.log, .glg etc) for any +Check the log files (.log, .glg etc) for any warnings.

    @@ -1329,12 +1371,12 @@ Documents.

      -
    1. Load glossaries after hyperref: +
    2. Load glossaries after hyperref:
       \usepackage{hyperref}
       \usepackage{glossaries}
       
      -Similarly for the html package: +Similarly for the html package:
       \usepackage{html}
       \usepackage{glossaries}
      @@ -1342,18 +1384,18 @@ Similarly for the html package:
       
       

    3. -
    4. Always use \makeglossaries if you want the glossary +
    5. Always use \makeglossaries if you want the glossary entries to be written to the glossary file:
       \usepackage{glossaries}
       \makeglossaries
       
      -If you don't use \makeglossaries, your glossaries will +If you don't use \makeglossaries, your glossaries will not appear in the document!

    6. -
    7. Use \printglossaries to make your glossaries appear +
    8. Use \printglossaries to make your glossaries appear in the document at that point. For example:
       \maketitle
      @@ -1366,31 +1408,31 @@ document text will appear in the glossary.
       

    9. When you have created your document, run LaTeX on it, -then the Perl script makeglossaries, then run LaTeX on it again: +then the Perl script makeglossaries, then run LaTeX on it again:
       latex myfile
       makeglossaries myfile
       latex myfile
       
      -(You need to run LaTeX again if you have used the toc -package option. You may also need an extra makeglossaries +(You need to run LaTeX again if you have used the toc +package option. You may also need an extra makeglossaries run and another LaTeX run if an entry is only referenced in the glossary, or if including the glossary has caused the -number lists to change.) +number lists to change.)

      If you use Windows, there is a batch file called makeglossaries.bat which you can use, but you will still need Perl installed. Alternatively, you can call -makeindex directly. See +makeindex directly. See Generating the Associated Glossary Files for further details.

    10. -
    11. If you want to use xindy instead of -makeindex, you must specify it in the package option: +
    12. If you want to use xindy instead of +makeindex, you must specify it in the package option:
       \usepackage[xindy]{glossaries}
       
      @@ -1403,30 +1445,30 @@ further details.
    13. New glossaries can be defined using:

      -\newglossary[log-ext]{label}{in-ext}{out-ext}{title} +\newglossary[log-ext]{label}{in-ext}{out-ext}{title}

      where label is an identifying label, in-ext is the extension of the file to be created -by makeindex or xindy (called by -makeglossaries), +by makeindex or xindy (called by +makeglossaries), out-ext is the extension of the file to be read by -makeindex or xindy and title is the title for this +makeindex or xindy and title is the title for this new glossary. The first optional argument log-ext specifies -the extension of the makeindex or xindy +the extension of the makeindex or xindy transcript file. Example:

       \newglossary[nlg]{notation}{not}{ntn}{Notation}
       
      This glossary's label is notation and its title -will be Notation. If you use makeglossaries, the -makeindex or xindy transcript will be written to a file with the -extension .nlg. If log-ext is omitted, the extension -.glg will be used. +will be Notation. If you use makeglossaries, the +makeindex or xindy transcript will be written to a file with the +extension .nlg. If log-ext is omitted, the extension +.glg will be used.

    14. Any new glossaries must be defined before -\makeglossaries: +\makeglossaries:
       \usepackage{glossaries}
       \newglossary{notation}{not}{ntn}{Notation}
      @@ -1435,7 +1477,7 @@ extension .nlg. If log-ext is omitted, the ex
       
       

    15. -
    16. If you use the acronym package option, the +
    17. If you use the acronym package option, the glossaries package will automatically create a new glossary type labelled acronym: @@ -1446,8 +1488,8 @@ will automatically create a new glossary type labelled

    18. If your pages have a hyphen compositor (i.e. your page -numbers appear in the form 2-1), use \glsSetCompositor -before \makeglossaries: +numbers appear in the form 2-1), use \glsSetCompositor +before \makeglossaries:
       \documentclass{article}
       \usepackage{glossaries}
      @@ -1458,23 +1500,23 @@ numbers appear in the form 2-1), use \glsSetCompositor package option:
      +toc package option:
       
       \usepackage[toc]{glossaries}
       
      This will require an extra LaTeX run. Note that if the table of contents affects the subsequent page numbering (i.e. the page numbers are not reset after the table of contents) then you -may need to rerun makeglossaries and LaTeX. +may need to rerun makeglossaries and LaTeX.

    19. Define a new entry with:

      -\newglossaryentry{label}{key-val list} +\newglossaryentry{label}{key-val list}

      -The key-val list must at least contain a name -key and a description key. +The key-val list must at least contain a name +key and a description key. For example:

       \newglossaryentry{perl}{name=Perl,
      @@ -1486,7 +1528,7 @@ to use to identify it.
       
       

    20. -
    21. To define a sub-entry, use the parent key. For +
    22. To define a sub-entry, use the parent key. For example:
       \newglossaryentry{fruit}{name={fruit}, % parent entry
      @@ -1499,7 +1541,7 @@ parent=fruit}
       
       

    23. -
    24. To change the sorting order, use the sort key. +
    25. To change the sorting order, use the sort key. For example:
       \newglossaryentry{tex}{name={\TeX},
      @@ -1518,9 +1560,9 @@ sort=U}
       

      -Note that if you use xindy instead of makeindex, +Note that if you use xindy instead of makeindex, characters such as a backslash are ignored, so if you have used -the xindy package option, you can just do: +the xindy package option, you can just do:

       \newglossaryentry{tex}{name={\TeX},
       description={A typesetting language},
      @@ -1545,18 +1587,18 @@ description={2) collection of glosses},
       sort={2},
       parent={glossary}}
       
      -Note that in this instance the name key is not -required for the child entries, but the sort key is +Note that in this instance the name key is not +required for the child entries, but the sort key is needed to sort the sub-entries. The parent entry has no description, so the description terminator is suppressed using -\nopostdesc. +\nopostdesc.

    26. If the entry name starts with an accented letter or non-Latin character, you will need to group the first letter -(otherwise it will cause a problem for commands like \Gls and -\Glspl): +(otherwise it will cause a problem for commands like \Gls and +\Glspl):
       \newglossaryentry{elite}{name={{\'e}lite},
       sort=elite,
      @@ -1572,22 +1614,22 @@ description={canal from mouth to stomach}}
       
       

    27. -
    28. If you use xindy, you can specify the accented +
    29. If you use xindy, you can specify the accented or non-Latin character directly (in combination with the -inputenc and fontenc packages) but you still +inputenc and fontenc packages) but you still need to group the first letter (otherwise it will cause a -problem for commands like \Gls and \Glspl due to +problem for commands like \Gls and \Glspl due to expansion issues):
       \newglossaryentry{elite}{name={{é}lite},
       description={select group or class}}
       
      -Note that in this case the sort key is not required -as xindy knows how to sort the letter é. +Note that in this case the sort key is not required +as xindy knows how to sort the letter é.

    30. -
    31. If you have multiple glossaries, use the type +
    32. If you have multiple glossaries, use the type key to specify in which glossary the entry belongs. For example:
       \newglossary{languages}{lan}{lng}{Index of Languages}
      @@ -1598,7 +1640,7 @@ key to specify in which glossary the entry belongs. For example:
       description=A scripting language,
       type=languages}
       
      -If type is omitted, the default glossary is used. +If type is omitted, the default glossary is used.

    33. @@ -1613,7 +1655,7 @@ description={A list of individual pages or page ranges

    34. You can cross-reference an entry using the -see key when you define it. For example, suppose +see key when you define it. For example, suppose you have defined an entry whose label is taylorstheorem, then you can cross-reference it:
      @@ -1621,7 +1663,7 @@ then you can cross-reference it:
       description={Series expansion},
       see={taylorstheorem}}
       
      -Alternatively, you can use \glssee after you have defined +Alternatively, you can use \glssee after you have defined the entry:
       \glssee{maclaurinseries}{taylorstheorem}
      @@ -1631,13 +1673,13 @@ The "see" tag may be overridden for a given entry:
       
       \glssee[see also]{maclaurinseries}{taylorstheorem}
       
      -or it can be changed for all entries by redefining \seename. +or it can be changed for all entries by redefining \seename.

    35. Plural forms are assumed to be the singular form with an "s" appended, unless otherwise specified. To specify an -irregular plural, use the plural key. For example: +irregular plural, use the plural key. For example:
       \newglossaryentry{matrix}{name=matrix,
       description=rectangular array of quantities,
      @@ -1659,7 +1701,7 @@ glossary, and either "matrix" or "matrices" in the text.
       
       

    36. -
    37. The way the term appears on first use can be different +
    38. The way the term appears on first use can be different to the way it appears subsequently:
       \newglossaryentry{singmtx}{name=Singular Matrix,
      @@ -1677,7 +1719,7 @@ and subsequently appears as "SM" or "SMs".
       
    39. The quick and easy way to define an acronym is to use:

      -\newacronym[key-val list]{label}{abbrev}{long} +\newacronym[key-val list]{label}{abbrev}{long}

      For example:

      @@ -1693,30 +1735,30 @@ first={support vector machine (SVM)},
       plural={SVMs},
       firstplural={support vector machines (SVMs)}}
       
      -(The value of \acronymtype varies depending on whether -the acronym package option is used or not. +(The value of \acronymtype varies depending on whether +the acronym package option is used or not. The optional argument key-val list can be used to -override any of the \newglossaryentry keys; for +override any of the \newglossaryentry keys; for example, if the acronym has an irregular plural.)

    40. The font used to display the entry name in the glossary -is governed by \glsnamefont. This can be redefined +is governed by \glsnamefont. This can be redefined as required. For example, to make the entry names appear in a medium sans-serif font do:
       \renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}}
       
      Note that the list-like glossary styles place the entry name in -the optional argument to \item, so they will -appear in bold, unless you redefine \glsnamefont to counteract +the optional argument to \item, so they will +appear in bold, unless you redefine \glsnamefont to counteract the bold font. Similarly, the tree-like styles display the entry name in bold.

    41. -
    42. In the document use \gls{label} +
    43. In the document use \gls{label} to use a predefined term (this will also enter the term into the associated glossary output file). For example:
      @@ -1728,21 +1770,21 @@ A \gls{singmtx} is a matrix with a zero determinant.
       
    44. Other variations:
        -
      • \Gls{label} : like \gls, +
      • \Gls{label} : like \gls, but with first letter in upper case
      • -
      • \GLS{label} : like \gls, +
      • \GLS{label} : like \gls, but all upper case.
      • -
      • \glspl{label} : use plural +
      • \glspl{label} : use plural
      • -
      • \Glspl{label} : use plural with +
      • \Glspl{label} : use plural with first letter in upper case
      • -
      • \GLSpl{label} : use plural but +
      • \GLSpl{label} : use plural but all upper case
      • -
      • \glslink{label}{link text} : +
      • \glslink{label}{link text} : use link text to link to the given entry in the glossary.
      @@ -1763,8 +1805,8 @@ The \gls{singmtx}['s] dimensions \ldots

    45. The format of the associated entry number can be -changed using the format key in the optional argument. -Note that the value of the format key should be the +changed using the format key in the optional argument. +Note that the value of the format key should be the name of a command without the initial backslash. For example:
      @@ -1780,23 +1822,23 @@ it will no longer have a hyperlink (if hyperlinks are enabled).
       change the font whilst ensuring that the number remains a
       hyperlink. These are of the form \hyperxx and
       are equivalent to the standard font changing commands of the
      -form \textxx, as well as \hyperemph
      -(which uses \emph). For example:
      +form \textxx, as well as \hyperemph
      +(which uses \emph). For example:
       
       The primary definition of \glspl[format=hyperbf]{singmtx}.
       

    46. -
    47. Don't use declarations in format (e.g. format=bfseries) as this can cause unpredictable results, +
    48. Don't use declarations in format (e.g. format=bfseries) as this can cause unpredictable results, since there is no guarantee that the effect will be localised to the required text.

    49. Entries can be added to the glossary without producing -any text using \glsadd{label} or -\glsaddall. These commands also take an optional +any text using \glsadd{label} or +\glsaddall. These commands also take an optional argument where you can specify the format. For example
       \glsadd[format=hyperbf]{singmtx}
      @@ -1818,8 +1860,8 @@ range. For example:
       
        \glsadd[format=)]{singmtx}
       
      -This is equivalent to makeindex's |( and |) -formats or xindy's :open-range and +This is equivalent to makeindex's |( and |) +formats or xindy's :open-range and :close-range tags.

      @@ -1841,13 +1883,13 @@ formats or xindy's :open-range and

    50. Only those terms that have actually been used in the document will be placed in the glossary. If you have defined a term that doesn't appear in the document, then it means -you haven't used it in the text (either via \glslink -or \gls and related commands or via \glsadd -or \glsaddall or via \glssee). +you haven't used it in the text (either via \glslink +or \gls and related commands or via \glsadd +or \glsaddall or via \glssee).

    51. -
    52. You don't need to escape makeindex's special characters: +
    53. You don't need to escape makeindex's special characters:
       \newglossaryentry{quote}{name={"},
       description={Double quote character}}
      @@ -1874,12 +1916,12 @@ styles.
       
       

    54. -
    55. Glossary styles can be set using the style +
    56. Glossary styles can be set using the style package option. For example:
       \usepackage[style=long3col]{glossaries}
       
      -or using \glossarystyle{style}. For example: +or using \glossarystyle{style}. For example:
       \glossarystyle{altlist}
       
      @@ -1890,7 +1932,7 @@ Styles.

    57. The list of numbers associated with each glossary entry -can be suppressed using the package option nonumberlist: +can be suppressed using the package option nonumberlist:
       \usepackage[nonumberlist]{glossaries}
       
      @@ -1899,14 +1941,14 @@ can be suppressed using the package option nonumberlist<
    58. By default, the glossary will appear in an unnumbered chapter if chapters are defined, otherwise in an unnumbered -section. This can be changed using the section package +section. This can be changed using the section package option. For example, to make the glossaries appear in an unnumbered section, even if chapters are defined, do:
       \usepackage[section]{glossaries}
       
      Other sectional units can also be specified as -section=value. For example, to make the glossaries +section=value. For example, to make the glossaries appear in unnumbered subsections:
       \usepackage[section=subsection]{glossaries}
      @@ -1922,7 +1964,7 @@ appear in unnumbered subsections:
       
       


      -Overview +Overview of User Commands

      @@ -1936,38 +1978,40 @@ Package Options

      The glossaries package options are as follows:

      -
      toc
      +
      toc
      Add the glossaries to the table of contents. Note that an extra LaTeX run is required with this option.

      -
      numberline
      -
      When used with toc, this will +
      numberline
      +
      When used with toc, this will add \numberline{} in the final argument of \addcontentsline. This will align the table of contents entry with the numbered section titles. Note that this option has no -effect if the toc option is omitted. If toc is -used without numberline, the title will be aligned with +effect if the toc option is omitted. If toc is +used without numberline, the title will be aligned with the section numbers rather than the section titles.

      -
      acronym
      +
      acronym
      This creates a new glossary with the -label acronym: +label acronym. This is equivalent to:
       \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
       
      -If the acronym package option is used, \acronymtype +If the acronym package option is used, \acronymtype is set to acronym otherwise it is set to -main.1Entries that are defined using \newacronym are placed in -the glossary whose label is given by \acronymtype. +main.2 +Entries that are defined using \newacronym are placed in +the glossary whose label is given by \acronymtype, unless +another glossary is explicitly specified.

      -
      section
      +
      section
      This is a key=value option. Its value should be the name of a sectional unit (e.g. chapter). This will make the glossaries appear in the named sectional unit, @@ -1993,18 +2037,18 @@ where name is the sectional unit.

      -
      numberedsection
      +
      numberedsection
      The glossaries are placed in unnumbered sectional units by default, -but this can be changed using numberedsection. This option can take -three possible values: false (no -number, i.e. use starred form), nolabel +but this can be changed using numberedsection. This option can take +three possible values: false (no +number, i.e. use starred form), nolabel (numbered, i.e. unstarred form, but not labelled) and -autolabel (numbered with automatic -labelling). If numberedsection=autolabel is used, each +autolabel (numbered with automatic +labelling). If numberedsection=autolabel is used, each glossary is given a label that matches the glossary type, so the main (default) glossary is labelled main, the list of -acronyms is labelled acronym2 and additional glossaries are labelled +acronyms is labelled acronym3 and additional glossaries are labelled using the value specified in the first mandatory argument to \newglossary. For example, if you load glossaries using: @@ -2019,9 +2063,9 @@ acronyms is in section~\ref{acronym}.
      If you can't decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use -\acronymtype which is set to main if the -acronym option is not used and is set to acronym -if the acronym option is used. For example: +\acronymtype which is set to main if the +acronym option is not used and is set to acronym +if the acronym option is used. For example:
       The list of acronyms is in section~\ref{\acronymtype}.
       
      @@ -2045,93 +2089,146 @@ The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}.

      -

      style
      +
      style
      This is a key=value option. Its value should be the name of the glossary style to use. Predefined glossary styles are listed later.

      -
      nonumberlist
      +
      nolong
      +
      This prevents the glossaries package +from automatically loading glossary-long (which means that +the longtable 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 glossary-long package. + +

      +

      +
      nosuper
      +
      This prevents the glossaries package +from automatically loading glossary-super (which means that +the supertabular 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 glossary-super package. + +

      +

      +
      nolist
      +
      This prevents the glossaries package +from automatically loading glossary-list. 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 glossary-list package. +Note that since the default style is list, you will +also need to use the style option to set the style to +something else. + +

      +

      +
      notree
      +
      This prevents the glossaries package +from automatically loading glossary-tree. 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 glossary-tree package. + +

      +

      +
      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 glossaries package. Note that if you use +this option, you can't use the style package option. Instead +you must either use \glossarystyle{style} or +the style key in the +optional argument to \printglossary. + +

      +

      +
      nonumberlist
      This option will suppress the -associated number lists in the glossaries (see also +associated number lists in the glossaries (see also Number Lists).

      -
      counter
      +
      counter
      This is a key=value option. The value should be the name of the default counter to use in the number -lists. +lists.

      -
      sanitize
      +
      sanitize
      This is a key=value option whose value is also a key=value list. By default, the glossaries package sanitizes the values of the -name, description and symbol keys used +name, description and symbol keys used when defining a new glossary entry. This may lead to unexpected results if you try to display these values within the document text. This -sanitization can be switched off using the sanitize package +sanitization can be switched off using the sanitize package option. For example, to switch off the sanitization for the -description and name keys, but not for the -symbol key, do: +description and name keys, but not for the +symbol key, do:
       \usepackage[sanitize={name=false,description=false,%
       symbol=true}]{glossaries}
       

      -Note: this sanitization only applies to the name, -description and symbol keys. It doesn't apply -to any of the other keys (except the sort key which is +Note: this sanitization only applies to the name, +description and symbol keys. It doesn't apply +to any of the other keys (except the sort key which is always sanitized) so fragile commands contained in the value of the other keys must always be protected using \protect. -Since the value of the text key is obtained from the -name key, you will still need to protect fragile commands -in the name key if you don't use the text key. +Since the value of the text key is obtained from the +name key, you will still need to protect fragile commands +in the name key if you don't use the text key.

      -
      description
      +
      description
      This option changes the definition of -\newacronym to allow a description. See later +\newacronym to allow a description. See later for further details.

      -
      footnote
      +
      footnote
      This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

      -
      smallcaps
      +
      smallcaps
      This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

      -
      smaller
      +
      smaller
      This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

      -
      dua
      +
      dua
      This option changes the definition of -\newacronym so that acronyms are always expanded. +\newacronym so that acronyms are always expanded. See later for further details.

      -
      shortcuts
      +
      shortcuts
      This option provides shortcut commands for acronyms. See later @@ -2139,28 +2236,28 @@ for further details.

      -
      makeindex
      +
      makeindex
      (Default) The glossary information and -indexing style file will be written in makeindex format. If you use -makeglossaries, it will automatically detect that it needs -to call makeindex. If you don't use -makeglossaries, you need to remember to use -makeindex not xindy. The indexing style file -will been given a .ist extension. +indexing style file will be written in makeindex format. If you use +makeglossaries, it will automatically detect that it needs +to call makeindex. If you don't use +makeglossaries, you need to remember to use +makeindex not xindy. The indexing style file +will been given a .ist extension.

      -
      xindy
      +
      xindy
      The glossary information and indexing style file will -be written in xindy format. If you use -makeglossaries, it will automatically detect that it needs -to call xindy. If you don't use makeglossaries, -you need to remember to use xindy not makeindex. -The indexing style file will been given a .xdy extension. +be written in xindy format. If you use +makeglossaries, it will automatically detect that it needs +to call xindy. If you don't use makeglossaries, +you need to remember to use xindy not makeindex. +The indexing style file will been given a .xdy extension.

      -The xindy package option may additionally have a -value that is a key=value comma-separated list to override +The xindy package option may additionally have a +value that is a key=value comma-separated list to override the language and codepage. For example:

       \usepackage[xindy={language=english,codepage=utf8}]{glossaries}
      @@ -2172,16 +2269,16 @@ example:
       \usepackage[xindy={glsnumbers=false}]{glossaries}
       
      See Xindy -for further details on using xindy with the +for further details on using xindy with the glossaries package.

      -
      order
      +
      order
      This may take two values: -word or letter. The default +word or letter. The default is word ordering. Note that this option has no effect if you -don't use makeglossaries. +don't use makeglossaries.

      @@ -2199,17 +2296,19 @@ Defining Glossary Entries

      All glossary entries must be defined before they are used, so it -is better to define them in the preamble to ensure this.3 However +is better to define them in the preamble to ensure this.4 However only those entries that occur in the document -(using any of the commands described in Links to Glossary Entries and -Adding an entry to the glossary without generating text) will appear in the glossary. Each time an entry +(using any of the commands described in Links to Glossary Entries, +Adding an entry to the glossary without generating text or +Cross-Referencing +Entries) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary file -(.glo), which then needs to be converted into a -corresponding .gls file which contains the typeset -glossary which is input by \printglossary or -\printglossaries. The Perl script makeglossaries can -be used to call makeindex or xindy, using a +(.glo), which then needs to be converted into a +corresponding .gls file which contains the typeset +glossary which is input by \printglossary or +\printglossaries. The Perl script makeglossaries can +be used to call makeindex or 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 @@ -2219,8 +2318,8 @@ for further details.

      The command \makeglossaries must be placed in the preamble in -order to create the customised makeindex (.ist) -or xindy (.xdy) +order to create the customised makeindex (.ist) +or xindy (.xdy) style file and to ensure that glossary entries are written to the appropriate output files. If you omit \makeglossaries none of the glossaries will be created. @@ -2233,14 +2332,14 @@ to use those commands after \makeglossaries you will generate an error.

      -You can suppress the creation of the customised xindy -or makeindex style file using \noist. Note that this +You can suppress the creation of the customised xindy +or makeindex style file using \noist. Note that this command must be used before \makeglossaries.

      The default name for the customised style file is given by -\jobname.ist (for makeindex) or -\jobname.xdy (for xindy). This name may be +\jobname.ist (for makeindex) or +\jobname.xdy (for xindy). This name may be changed using:

      @@ -2252,10 +2351,10 @@ extension. Note that this command must be used before \makeglossaries.

      -Each glossary entry is assigned a number list that lists all +Each glossary entry is assigned a number list 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 counter package option. The default form of +using the counter 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 @@ -2270,7 +2369,7 @@ For example: Note that this command must be used before \makeglossaries.

      -If you use xindy, you can have a different compositor +If you use xindy, you can have a different compositor for page numbers starting with an uppercase alphabetical character using:
      @@ -2278,8 +2377,8 @@ character using:

      Note that this command has no effect if you haven't used the -xindy package option. For example, if you want -number lists containing a mixture of A-1 and 2.3 +xindy package option. For example, if you want +number lists containing a mixture of A-1 and 2.3 style formats, then do:

       \glsSetCompositor{.}
      @@ -2287,7 +2386,7 @@ style formats, then do:
       
      See Number lists for -further information about number lists. +further information about number lists.

      New glossary entries are defined using the command: @@ -2299,21 +2398,21 @@ The first argument, label, must be a unique label with which to identify this entry. The second argument, key-val list, is a key=value list that supplies the relevant information -about this entry. There are two required fields: name and -description, except for sub-entries where the -name field may be omitted. Available fields are listed +about this entry. There are two required fields: name and +description, except for sub-entries where the +name field may be omitted. Available fields are listed below:

      -
      name
      +
      name
      The name of the entry (as it will appear in -the glossary). If this key is omitted and the parent +the glossary). If this key is omitted and the parent key is supplied, this value will be the same as the parent's name.

      -
      description
      +
      description
      A brief description of this term (to appear in the glossary). Within this value, you can use \nopostdesc to suppress the @@ -2322,11 +2421,13 @@ entry is a parent entry that doesn't require a description, you can do description={\nopostdesc}. If you want a paragraph break in the description use \glspar. However, note that not all glossary styles support multi-line -descriptions. +descriptions. If you are using one of the tabular-like glossary +styles that permit multi-line descriptions, use \newline +not \\ if you want to force a line break.

      -
      parent
      +
      parent
      The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See Sub-Entries for @@ -2334,55 +2435,57 @@ further details.

      -
      descriptionplural
      +
      descriptionplural
      The plural form of the -description (as passed to \glsdisplay and \glsdisplayfirst -by \glspl, \Glspl and \GLSpl). If omitted, the value -is set to the same as the description key. +description (as passed to \glsdisplay and \glsdisplayfirst +by \glspl, \Glspl and \GLSpl). If omitted, the value +is set to the same as the description key.

      -
      text
      +
      text
      How this entry will appear in the document text -when using \gls (or one of its uppercase variants). If this -field is omitted, the value of the name key is used. +when using \gls (or one of its uppercase variants). If this +field is omitted, the value of the name key is used.

      -
      first
      +
      first
      How the entry will appear in the document text -the first time it is used with \gls (or one of its uppercase -variants). If this field is omitted, the value of the text +the first time it is used with \gls (or one of its uppercase +variants). If this field is omitted, the value of the text key is used.

      -
      plural
      +
      plural
      How the entry will appear in the document text -when using \glspl (or one of its uppercase variants). +when using \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained by appending -\glspluralsuffix to the value of the text field. +\glspluralsuffix to the value of the text field. +The default value of \glspluralsuffix is the letter +"s".

      -
      firstplural
      +
      firstplural
      How the entry will appear in the -document text the first time it is used with \glspl (or one of its +document text the first time it is used with \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained -from the plural key, if the first key is omitted, -or by appending \glspluralsuffix to the value of the -first field, if the first field is present. +from the plural key, if the first key is omitted, +or by appending \glspluralsuffix to the value of the +first field, if the first field is present.

      Note: prior to version 1.13, the default value of -firstplural was always taken by appending "s" to the -first key, which meant that you had to specify both -plural and firstplural, even if you hadn't -used the first key. +firstplural was always taken by appending "s" to the +first key, which meant that you had to specify both +plural and firstplural, even if you hadn't +used the first key.

      -
      symbol
      +
      symbol
      This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to \relax. Note that not all glossary styles display the @@ -2390,40 +2493,40 @@ symbol.

      -
      symbolplural
      +
      symbolplural
      This is the plural form of the -symbol (as passed to \glsdisplay and \glsdisplayfirst -by \glspl, \Glspl and \GLSpl). If omitted, the value -is set to the same as the symbol key. +symbol (as passed to \glsdisplay and \glsdisplayfirst +by \glspl, \Glspl and \GLSpl). If omitted, the value +is set to the same as the symbol key.

      -
      sort
      -
      This value indicates how makeindex -or xindy should sort this entry. If omitted, the value is -given by the name field. +
      sort
      +
      This value indicates how makeindex +or xindy should sort this entry. If omitted, the value is +given by the name field.

      -
      type
      +
      type
      This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is assumed. The list of acronyms type is given by -\acronymtype which will either be main or -acronym, depending on whether the acronym package +\acronymtype which will either be main or +acronym, depending on whether the acronym package option was used.

      -
      nonumberlist
      -
      Suppress the number list for +
      nonumberlist
      +
      Suppress the number list for this entry.

      -
      see
      +
      see
      Cross-reference another entry. Using the -see key will automatically add this entry to the +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 "see" tag, you can supply the new @@ -2442,15 +2545,15 @@ For example: \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}}
    59. -Note that the same applies if you are using the inputenc +Note that the same applies if you are using the inputenc package:
       \newglossaryentry{elite}{name={{é}lite},
       description={select group or class}}
       
      Note that in both of the above examples, you will also need to -supply the sort key if you are using makeindex -whereas xindy is usually able to sort accented letters +supply the sort key if you are using makeindex +whereas xindy is usually able to sort accented letters correctly.

      @@ -2467,7 +2570,8 @@ 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 \glspluralsuffix to -the singular form. This command defaults to "s". For example: +the singular form. This command defaults to the letter "s". +For example:

       \newglossaryentry{cow}{name=cow,description={a fully grown
       female of any bovine animal}}
      @@ -2483,7 +2587,7 @@ description={a fully grown female of any bovine animal}}
       
       

      If you are writing in a language that supports -multiple plurals (for a given term) then use the plural key +multiple plurals (for a given term) then use the plural key for one of them (typically the one you are most likely to use) and for the others you will need to explicitly write the plural form using \glslink rather than using \glspl. Returning to the cow @@ -2503,7 +2607,7 @@ by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done before the entries are defined. For languages that don't form plurals by simply appending a suffix, all the plural forms must be -specified using the plural key (and the firstplural +specified using the plural key (and the firstplural key where necessary).

      @@ -2537,7 +2641,7 @@ 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 number list. +have a number list.

      Top @@ -2549,23 +2653,21 @@ Hierarchical Categories To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the relevant -category entry as the value of the parent key. For +category entry as the value of the parent key. For example, suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. Then I can define the categories as follows:

       \newglossaryentry{greekletter}{name={Greek letters},
      -text={Greek letter},
       description={\nopostdesc}}
       
       \newglossaryentry{romanletter}{name={Roman letters},
      -text={Roman letter},
       description={\nopostdesc}}
       

      Note that in this example, the category entries don't need a -description so I have set the descriptions to \nopostdesc. +description so I have set the descriptions to \nopostdesc. This gives a blank description and suppresses the description terminator. @@ -2589,7 +2691,7 @@ parent=romanletter}

      Homographs

      Sub-entries that have the same name as -the parent entry, don't need to have the name key. +the parent entry, don't need to have the name 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: @@ -2599,7 +2701,7 @@ description={\nopostdesc}, plural={glossaries}}
      Again, the parent entry has no description, so the description -terminator needs to be suppressed using \nopostdesc. +terminator needs to be suppressed using \nopostdesc.

      Now define the two different meanings of the word: @@ -2615,14 +2717,14 @@ sort={2}, parent={glossary}} Note that if I reference the parent entry, the location will be -added to the parent's number list, whereas if I reference +added to the parent's number list, whereas if I reference any of the child entries, the location will be added to the child entry's number list. Note also that since the sub-entries have the -same name, the sort key is required. +same name, the sort key is required.

      In the above example, the plural form for both of the child entries -is the same as the parent entry, so the plural key was +is the same as the parent entry, so the plural key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example:

      @@ -2655,7 +2757,7 @@ Loading Entries From a File
       
       

      You can store all your glossary entry definitions in another -file, and use: +file and use:

      \loadglsentries[type]{filename}
      @@ -2663,7 +2765,7 @@ file, and use: where filename is the name of the file containing all the \newglossaryentry commands. The optional argument type is the name of the glossary to which those entries -should belong, for those entries where the type key has +should belong, for those entries where the type key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what \newglossaryentry uses by default). For example, suppose I have @@ -2704,10 +2806,10 @@ then (supposing I have defined a new glossary type called \loadglsentries[altacronym]{myacronyms}

      will add aca to the glossary type acronym, if the -package option acronym has been specified, or will add +package option acronym has been specified, or will add aca to the glossary type altacronym, if the -package option acronym is not specified.4 In this instance, +package option acronym is not specified.5 In this instance, it is better to change myacronyms.tex to:
       \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym}
      @@ -2717,7 +2819,7 @@ and now
       \loadglsentries[altacronym]{myacronyms}
       
      will add aca to the glossary type altacronym, -regardless of whether or not the package option acronym is +regardless of whether or not the package option acronym is used.

      @@ -2737,31 +2839,31 @@ Number lists

      -Each entry in the glossary has an associated number list. +Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in Links to Glossary Entries and Adding an entry to the glossary without generating text). The number list can be suppressed using -the nonumberlist package option, or an alternative counter -can be set as the default using the counter package option. +the nonumberlist package option, or an alternative counter +can be set as the default using the counter package option. The number list is also referred to as the location -list. +list.

      -Both makeindex and xindy concatenate a +Both makeindex and xindy concatenate a sequence of 3 or more consecutive pages into a range. With -xindy you can vary the minimum sequence length using -\GlsSetXdyMinRangeLength{n} where n is either +xindy you can vary the minimum sequence length using +\GlsSetXdyMinRangeLength{n} where n is either an integer or the keyword none which indicates that there should be no range formation.

      Note that \GlsSetXdyMinRangeLength must be used before -\makeglossaries and has no effect if \noist is used. +\makeglossaries and has no effect if \noist is used.

      -With both makeindex and xindy, you can replace -separator and the closing number in the range using: +With both makeindex and xindy, you can replace +the separator and the closing number in the range using:

      \glsSetSuffixF{suffix}
      \glsSetSuffixFF{suffix} @@ -2774,14 +2876,14 @@ For example: \glsSetSuffixF{f.} \glsSetSuffixFF{ff.} -Note that if you use xindy, you will also need to +Note that if you use xindy, you will also need to set the minimum range length to 1 if you want to change these suffixes:

       \GlsSetXdyMinRangeLength{1}
       
      -Note that if you use the hyperref package, you will need -to use \nohyperpage in the suffix to ensure that the hyperlinks +Note that if you use the hyperref package, you will need +to use \nohyperpage in the suffix to ensure that the hyperlinks work correctly. For example:
       \glsSetSuffixF{\nohyperpage{f.}}
      @@ -2790,7 +2892,7 @@ work correctly. For example:
       
       

      Note that \glsSetSuffixF and \glsSetSuffixFF must be used -before \makeglossaries and have no effect if \noist is +before \makeglossaries and have no effect if \noist is used.

      @@ -2808,15 +2910,15 @@ Links to Glossary Entries

      Once you have defined a glossary entry using -\newglossaryentry, you can refer to that entry in the +\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 -link text (even if there are no hyperlinks). The commands +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 makeindex or xindy to generate the relevant +by makeindex or xindy to generate the relevant entry in the glossary. This information includes an -associated location that is added to the number list for that +associated location that is added to the number list for that entry. By default, the location refers to the page number. For further information on number lists, see Number Lists. @@ -2827,7 +2929,7 @@ commands.

      The above warning is particularly important if you are using the -glossaries package in conjunction with the hyperref package. +glossaries package in conjunction with the hyperref package. Instead, use one of the commands listed in Using Glossary Terms Without Links (such as \glsentrytext) or provide an alternative via @@ -2839,14 +2941,23 @@ Examples:

      -The way the link text is displayed +The way the link text is displayed depends on \glstextformat{text}. -For example, to make all link text appear in a sans-serif +For example, to make all link text appear in a sans-serif font, do:

       \renewcommand*{\glstextformat}[1]{\textsf{#1}}
       
      +

      +Each entry has an associated conditional referred to as the + first use flag. This determines whether \gls, +\glspl (and their uppercase variants) should use the +value of the first or text keys. Note that an +entry can be used without affecting the first use flag (for example, +when used with \glslink). See later for +commands that unset or reset this conditional. +

      The command:
      @@ -2863,10 +2974,10 @@ keys:

      -
      format
      +
      format
      This specifies how to format the associated location number for this entry in the glossary. This -value is equivalent to the makeindex encap value, and (as +value is equivalent to the makeindex encap value, and (as with \index) the value needs to be the name of a command without the initial backslash. As with \index, the characters ( and ) can also be used to specify the @@ -2885,14 +2996,15 @@ and use that command.

      In this document, the standard formats refer to the standard text -block commands such as \textbf or \emph or any of the -commands listed in Table 3. +block commands such as \textbf or \emph or any of the +commands listed in table 3.

      -If you use xindy instead of makeindex, you +If you use xindy instead of makeindex, you must specify any non-standard formats that you want to use -with the format key using -\GlsAddXdyAttribute{name}. For example +with the format key using +\GlsAddXdyAttribute{name}. So if you use +xindy with the above example, you would need to add:

       \GlsAddXdyAttribute{textbfem}
       
      @@ -2901,53 +3013,53 @@ with the format key using Note that unlike \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 see key when you define the entry or use -\glssee (described later). +use the see key when you define the entry or use +\glssee (described later).

      If you are using hyperlinks and you want to change the font of the -hyperlinked location, don't use \hyperpage (provided by the -hyperref package) as the locations may not refer to a page +hyperlinked location, don't use \hyperpage (provided by the +hyperref package) as the locations may not refer to a page number. Instead, the glossaries package provides number -formats listed in Table 3. +formats listed in table 3.


      -
      +
    Table 2: Commands and package options that have no effect when using xindy or makeindex explicity
     Command or Package Option makeindexxindymakeindexxindy  
     order=letter
     order=letter use -l use -M ord/letorder  
     order=word
     order=word default default  
     xindy={language=lang,codename=code}
     xindy={language=lang,codename=code} N/A use -L lang -C code  
     \GlsSetXdyLanguage{lang}
     \GlsSetXdyLanguage{lang} N/A use -L lang  
     \GlsSetXdyCodePage{code}
     \GlsSetXdyCodePage{code} N/A use -C code  
    - + - + - + - + - + - + - + - + - + - +
    Table 3: Predefined Hyperlinked Location Formats
    hyperrm
    hyperrm serif hyperlink
    hypersf
    hypersf sans-serif hyperlink
    hypertt
    hypertt monospaced hyperlink
    hyperbf
    hyperbf bold hyperlink
    hypermd
    hypermd medium weight hyperlink
    hyperit
    hyperit italic hyperlink
    hypersl
    hypersl slanted hyperlink
    hyperup
    hyperup upright hyperlink
    hypersc
    hypersc small caps hyperlink
    hyperemph
    hyperemph emphasized hyperlink
    @@ -2958,7 +3070,7 @@ Predefined Hyperlinked Location Formats

    -Note that if the \hyperlink command hasn't been defined, +Note that if the \hyperlink command hasn't been defined, the hyperxx formats are equivalent to the analogous textxx font commands (and hyperemph is equivalent to emph). If you want to @@ -2969,9 +3081,9 @@ command called, say, \hyperbsf:

     \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
     
    -and then use hyperbsf as the value for the format +and then use hyperbsf as the value for the format key. -Remember that if you use xindy, you will need to add +Remember that if you use xindy, you will need to add this to the list of location attributes:
     \GlsAddXdyAttribute{hyperbsf}
    @@ -2979,7 +3091,7 @@ this to the list of location attributes:
     
     

    -
    counter
    +
    counter
    This specifies which counter to use for this location. This overrides the default counter used by this entry. (See also @@ -2987,7 +3099,7 @@ used by this entry. (See also

    -
    hyper
    +
    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 hyper=true will have no @@ -3012,13 +3124,13 @@ The command:
    \gls[options]{label}[insert]

    -is the same as \glslink, except that the link text -is determined from the values of the text and -first keys supplied when the entry was defined using -\newglossaryentry. If the entry has been marked as having -been used, the value of the text key will be used, otherwise -the value of the first key will be used. -On completion, \gls will mark the entry given by label as +is the same as \glslink, except that the link text +is determined from the values of the text and +first keys supplied when the entry was defined using +\newglossaryentry. If the entry has been marked as having +been used, the value of the text key will be used, otherwise +the value of the first key will be used. +On completion, \gls will mark the entry's first use flag as used.

    @@ -3034,7 +3146,7 @@ and \GLS[options]{label}[insert]

    -which make the first letter of the link or all the link text +which make the first letter of the link text or all the link text uppercase, respectively.

    @@ -3046,7 +3158,7 @@ can be changed (see

    The first optional argument options is the same as the optional -argument to \glslink. As with \glslink, these commands also +argument to \glslink. As with \glslink, these commands also have a starred version that disable the hyperlink.

    @@ -3062,8 +3174,8 @@ There are also analogous plural forms: \GLSpl[options]{label}[insert]

    -These determine the link text from the plural and -firstplural keys supplied when the entry was first +These determine the link text from the plural and +firstplural keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink. @@ -3073,9 +3185,10 @@ The command:
    \glstext[options]{label}[insert]

    -is similar to \gls except that it always uses the value -of the text key and does not mark the entry as -having been used. Unlike \gls, the inserted text insert +is similar to \gls except that it always uses the value +of the text key and does not affect the +first use flag. +Unlike \gls, the inserted text insert is always appended to the link text.

    @@ -3097,10 +3210,10 @@ The command:
    \glsfirst[options]{label}[insert]

    -is similar to \glstext except that it always uses the value -of the first key. Again, insert is always appended -to the end of the link text and does not mark the entry as having -been used. +is similar to \glstext except that it always uses the value +of the first key. Again, insert is always appended +to the end of the link text and does not affect the +first use flag.

    There are also analogous commands: @@ -3121,8 +3234,8 @@ The command:
    \glsplural[options]{label}[insert]

    -is similar to \glstext except that it always uses the value -of the plural key. Again, insert is always appended +is similar to \glstext except that it always uses the value +of the plural key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. @@ -3145,8 +3258,8 @@ The command:
    \glsfirstplural[options]{label}[insert]

    -is similar to \glstext except that it always uses the value -of the firstplural key. Again, insert is always +is similar to \glstext except that it always uses the value +of the firstplural key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. @@ -3169,13 +3282,13 @@ The command:
    \glsname[options]{label}[insert]

    -is similar to \glstext except that it always uses the value of the -name key. Again, insert is always appended to the end +is similar to \glstext except that it always uses the value of the +name key. Again, 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 -name key contains commands, you will have to disable the +name key contains commands, you will have to disable the sanitization -of the name key and protect fragile commands. +of the name key and protect fragile commands.

    There are also analogous commands: @@ -3196,13 +3309,13 @@ The command:
    \glssymbol[options]{label}[insert]

    -is similar to \glstext except that it always uses the value of the -symbol key. Again, insert is always appended to the +is similar to \glstext except that it always uses the value of the +symbol key. Again, 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 -symbol key contains commands, you will have to disable the +symbol key contains commands, you will have to disable the sanitization -of the symbol key and protect fragile commands. +of the symbol key and protect fragile commands.

    There are also analogous commands: @@ -3223,14 +3336,14 @@ The command:
    \glsdesc[options]{label}[insert]

    -is similar to \glstext except that it always uses the value -of the description key. Again, insert is always +is similar to \glstext except that it always uses the value +of the description key. Again, 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 description key contains commands, you will +command and the description key contains commands, you will have to disable the sanitization -of the description key and protect fragile commands. +of the description key and protect fragile commands.

    There are also analogous commands: @@ -3259,18 +3372,19 @@ Changing the format of the link text

    -The format of the link text for \gls, \glspl +The format of the link text for \gls, \glspl and their uppercase variants is governed by two commands: \glsdisplayfirst, which is used the -first time a glossary entry is used in the text and +first time a glossary entry is used in the text and \glsdisplay, which is used subsequently. Both commands take four arguments: the first is either the singular or -plural form given by the text, plural, -first or firstplural keys (used when the term was +plural form given by the text, plural, +first or firstplural keys (set when the term was defined) depending on context; the second argument is the term's -description (as supplied by the description key); the third +description (as supplied by the description or +descriptionplural keys); the third argument is the symbol associated with the term (as supplied by the -symbol key) and the fourth argument is the additional text +symbol or symbolplural keys) and the fourth argument is the additional text supplied in the final optional argument to \gls or \glspl (or their uppercase variants). The default definitions of \glsdisplay and \glsdisplayfirst simply @@ -3278,9 +3392,9 @@ print the first argument immediately followed by the fourth argument. The remaining arguments are ignored.

    -Note that \glslink (which +Note that \glslink (which is used by commands like \gls and \glspl) sets -\glslabel to the label for the given +\glslabel to the label for the given entry (i.e. the label supplied to the mandatory argument to \gls), so it is possible to use this label in the definition of \glsdisplay or \glsdisplayfirst to supply additional @@ -3290,14 +3404,14 @@ Without Links, if required.

    For example, suppose you want a glossary of measurements and -units, you can use the symbol key to store the unit: +units, you can use the symbol key to store the unit:

     \newglossaryentry{distance}{name=distance,
     description={The length between two points},
     symbol={km}}
     
    and now suppose you want \gls{distance} to produce -"distance (km)" on first use, then you can redefine +"distance (km)" on first use, then you can redefine \glsdisplayfirst as follows:
     \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
    @@ -3306,12 +3420,12 @@ Note that the additional text is placed after #1, so
     \gls{distance}['s] 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 may be better not to
    +the two points" -- but in this instance it would be better not to
     use a contraction).
     
     

    -Note also that all of the link text will be formatted according -to \glstextformat (described earlier). So if you do, say: +Note also that all of the link text will be formatted according +to \glstextformat (described earlier). So if you do, say:

     \renewcommand{\glstextformat}[1]{\textbf{#1}}
     \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
    @@ -3324,14 +3438,22 @@ If you have multiple glossaries, changing \glsdisplayfirst and
     glossaries appear when using the commands \gls, \glspl and their
     uppercase variants.  If you only
     want the change to affect entries for a given glossary, then you need
    -to use \defglsdisplay and
    -\defglsdisplayfirst instead
    -of redefining \glsdisplay and \glsdisplayfirst.
    +to use
    +
    +
    \defglsdisplay[type]{definition} +
    +
    +and +
    +
    \defglsdisplayfirst[type]{definition} +
    +
    +instead of redefining \glsdisplay and \glsdisplayfirst.

    Both \defglsdisplay and \defglsdisplayfirst take two arguments: -the first (which is optional) is the glossary's label5 and the second is how the term should be +the first (which is optional) is the glossary's label6 and the second is how the term should be displayed when it is invoked using commands \gls, \glspl and their uppercase variants. This is similar to the way \glsdisplayfirst was redefined above. @@ -3339,7 +3461,7 @@ redefined above.

    For example, suppose you have created a new glossary called notation and you want to change the way the entry is -displayed on first use so that it includes the symbol, you can +displayed on first use so that it includes the symbol, you can do:

     \defglsdisplayfirst[notation]{#1#4 (denoted #3)}
    @@ -3357,10 +3479,10 @@ will be displayed as: "set (denoted S)"
     (similarly for \glspl and the uppercase variants).
     
     

    -Remember that if you use the symbol key, you need to use a +Remember that if you use the 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 link text, you will have to disable the +in the link text, you will have to disable the sanitization of these keys and protect fragile commands.

    @@ -3373,10 +3495,10 @@ Enabling and disabling hyperlinks to glossary entries

    -If you load the hyperref or html packages prior to -loading the glossaries package, commands such as \glslink -and \gls, described above, will automatically have hyperlinks -to the relevant glossary entry, unless the hyper +If you load the hyperref or html packages prior to +loading the glossaries package, commands such as \glslink +and \gls, described above, will automatically have hyperlinks +to the relevant glossary entry, unless the hyper option has been set to false. You can disable or enable links using:

    \glsdisablehyper @@ -3389,8 +3511,8 @@ and
    respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper -if the commands \hyperlink and \hypertarget have been -defined (for example, by the hyperref package). +if the commands \hyperlink and \hypertarget have been +defined (for example, by the hyperref package).

    Top @@ -3409,8 +3531,8 @@ generating any text at that point in the document using:
    \glsadd[options]{label}

    -This is similar to \glslink, only it doesn't produce -any text (so therefore, there is no hyper key +This is similar to \glslink, only it doesn't produce +any text (so therefore, there is no hyper key available in options but all the other options that can be used with \glslink can be passed to \glsadd). For example, to add a page range to the glossary number list for the @@ -3428,7 +3550,7 @@ To add all entries that have been defined, use:

    The optional argument is the same as for \glsadd, except -there is also a key types which can be +there is also a key types which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by @@ -3457,7 +3579,7 @@ glossary:

      -
    1. You can use commands such as \gls in the +
    2. You can use commands such as \gls in the entries description. For example:
       \newglossaryentry{apple}{name=apple,
      @@ -3465,7 +3587,7 @@ description={firm, round fruit. See also \gls{pear}}}
       
      Note that with this method, if you don't use the cross-referenced term in the glossary, you will need two runs of -makeglossaries: +makeglossaries:
       latex filename
       makeglossaries filename
      @@ -3477,14 +3599,14 @@ latex filename
       

    3. As described earlier, -you can use the see key when you define the entry. For +you can use the see key when you define the entry. For example:
       \newglossaryentry{MaclaurinSeries}{name={Maclaurin series},
       description={Series expansion},
       see={TaylorsTheorem}}
       
      -Note that in this case, the entry with the see key will +Note that in this case, the entry with the 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 @@ -3494,7 +3616,7 @@ Without Generating Text.

      You can optionally override the "see" tag using square brackets -at the start of the see value. For example: +at the start of the see value. For example:

       \newglossaryentry{MaclaurinSeries}{name={Maclaurin series},
       description={Series expansion},
      @@ -3523,9 +3645,9 @@ by xr label list) to the glossary.
       
       

      In both cases 2 and 3 above, the cross-referenced information appears -in the number list, whereas in case 1, the cross-referenced +in the number list, 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 \seename. +default text for the "see" tag is given by \seename.

      Top @@ -3542,8 +3664,7 @@ Using Glossary Terms Without Links The commands described in this section display entry details without adding any information to the glossary. They don't use \glstextformat, they don't have any optional arguments, -they don't affect the flag that determines if the term has been -used and, apart from \glshyperlink, they don't produce +they don't affect the first use flag and, apart from \glshyperlink, they don't produce hyperlinks.

      @@ -3552,7 +3673,7 @@ hyperlinks.
      \Glsentryname{label}

      These commands display the name of the glossary entry given by -label, as specified by the name key. +label, as specified by the name key. \Glsentryname makes the first letter uppercase.

      @@ -3561,7 +3682,7 @@ These commands display the name of the glossary entry given by
      \Glsentrytext{label}

      These commands display the subsequent use text for the glossary entry -given by label, as specified by the text key. +given by label, as specified by the text key. \Glsentrytext makes the first letter uppercase.

      @@ -3570,7 +3691,7 @@ given by label, as specified by the text key.
      \Glsentryplural{label}

      These commands display the subsequent use plural text for the glossary -entry given by label, as specified by the plural key. +entry given by label, as specified by the plural key. \Glsentryplural makes the first letter uppercase.

      @@ -3578,8 +3699,8 @@ entry given by label, as specified by the plural< \glsentryfirst{label}
      \Glsentryfirst{label}

      -These commands display the first use text for the glossary entry -given by label, as specified by the first key. +These commands display the first use text for the glossary entry +given by label, as specified by the first key. \Glsentryfirst makes the first letter uppercase.

      @@ -3587,9 +3708,9 @@ given by label, as specified by the first key \glsentryfirstplural{label}
      \Glsentryfirstplural{label}

      -These commands display the plural form of the first use text for the +These commands display the plural form of the first use text for the glossary entry given by label, as specified by the -firstplural key. \Glsentryfirstplural makes the first +firstplural key. \Glsentryfirstplural makes the first letter uppercase.

      @@ -3632,7 +3753,7 @@ These commands display the plural symbol for the glossary entry given by This command provides a hyperlink to the glossary entry given by label but does not add any information to the glossary file. The link text is given by -\glsentryname{label} by default, but can be overridden +\glsentryname{label} by default, but can be overridden using the optional argument. If you use \glshyperlink, you need to ensure that the relevant entry has been added to the glossary using any of the @@ -3644,7 +3765,7 @@ link.

      For further information see the section "Displaying entry details without adding information to -the glossary" in the document glossaries.pdf.

      @@ -3660,15 +3781,15 @@ Displaying a glossary The command \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 makeglossaries -or have directly used makeindex or xindy (as +you have either used the Perl script makeglossaries +or have directly used makeindex or xindy (as described in Generating the Associated Glossary Files). If the glossary still does not appear after you re-LaTeX your document, check the -makeindex/xindy log files to see if there is a +makeindex/xindy log files to see if there is a problem. Remember that you also need to use the command -\makeglossaries in the preamble to enable the glossaries. +\makeglossaries in the preamble to enable the glossaries.

      An individual glossary can be displayed using: @@ -3679,7 +3800,7 @@ An individual glossary can be displayed using: where options is a key=value list of options. The following keys are available:

      -
      type
      +
      type
      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: @@ -3689,37 +3810,37 @@ glossary is assumed. For example, to print the list of acronyms:

      -
      title
      +
      title
      This is the glossary's title (overriding the title specified when the glossary was defined).

      -
      toctitle
      +
      toctitle
      This is the title -to use for the table of contents (if the toc package +to use for the table of contents (if the toc package option has been used). If omitted, the glossary title is used.

      -
      style
      +
      style
      This specifies which glossary style to use for this glossary, overriding the effect -of the style package option or \glossarystyle. +of the style package option or \glossarystyle.

      -
      numberedsection
      +
      numberedsection
      This specifies whether to use a numbered section for this glossary, overriding -the effect of the numberedsection package option. This -key has the same syntax as the numberedsection package +the effect of the numberedsection package option. This +key has the same syntax as the numberedsection package option, described earlier.

      -
      nonumberlist
      +
      nonumberlist
      Unlike the package option of the same name, this key is a boolean key. If true (nonumberlist=true) the numberlist is suppressed for this glossary. If false (nonumberlist=false) the numberlist is @@ -3784,12 +3905,12 @@ the entry name. This command is always used regardless of the glossary style. By default, \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 -glossary-list style file) the name will appear in bold, since +glossary-list style file) the name will appear in bold, since the name is placed in the optional argument of \item, whereas in -the tabular styles (defined in the glossary-long and -glossary-super style files) the name will appear in the +the tabular styles (defined in the glossary-long and +glossary-super style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the -glossary-tree style file) also set the name in bold. +glossary-tree style file) also set the name in bold.

      For example, suppose you want all the entry names to appear in @@ -3810,13 +3931,13 @@ Xindy

      -If you want to use xindy to sort the glossary, you -must use the package option xindy: +If you want to use xindy to sort the glossary, you +must use the package option xindy:

       \usepackage[xindy]{glossaries}
       
      This ensures that the glossary information is written in -xindy syntax. +xindy syntax.

      The section @@ -3824,10 +3945,10 @@ The section Files covers how to use the external indexing application. This section covers the commands provided by the glossaries package that allow you to adjust the -xindy style file (.xdy) and parameters. +xindy style file (.xdy) and parameters.

      -To assist writing information to the xindy style +To assist writing information to the xindy style file, the glossaries package provides the following commands:
      @@ -3841,7 +3962,7 @@ when written to a file.)

      In addition, if you are using a package that makes the double -quote character active (e.g. ngerman) you can use: +quote character active (e.g. ngerman) you can use:

      \glsquote{text}
      @@ -3852,13 +3973,13 @@ This document assumes that the double quote character has not been made active, so the examples just use " for clarity.

      -If you want greater control over the xindy style file than +If you want greater control over the xindy style file than is available through the LaTeX commands provided by the -glossaries package, you will need to edit the xindy +glossaries package, you will need to edit the xindy style file. In -which case, you must use \noist to prevent the style file from +which case, you must use \noist to prevent the style file from being overwritten by the glossaries package. For additional -information about xindy, read the xindy +information about xindy, read the xindy documentation.

      Top @@ -3868,14 +3989,14 @@ documentation.

      Language and Encodings

      -When you use xindy, you need to specify the language +When you use xindy, you need to specify the language and encoding used (unless you have written your own custom -xindy style file that defines the relevant alphabet -and sort rules). If you use makeglossaries, +xindy style file that defines the relevant alphabet +and sort rules). If you use makeglossaries, this information is obtained from the document's auxiliary -(.aux) file. The glossaries package attempts to +(.aux) file. The glossaries package attempts to find the root language, but in the event that it gets it wrong or if -xindy doesn't support that language, then you can +xindy doesn't support that language, then you can specify the language using:

      @@ -3890,8 +4011,8 @@ setting will only be applied to the glossary given by glossary type.

      -If the inputenc package is used, the encoding will be -obtained from the value of \inputencodingname. +If the inputenc package is used, the encoding will be +obtained from the value of \inputencodingname. Alternatively, you can specify the encoding using:

      @@ -3913,19 +4034,19 @@ For example:

      -If you write your own custom xindy style file that +If you write your own custom xindy style file that includes the language settings, you need to set the language to nothing:

       \GlsSetXdyLanguage{}
       
      -(and remember to use \noist to prevent the style file from +(and remember to use \noist to prevent the style file from being overwritten).

      The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage -have no effect if you don't use makeglossaries. If -you call xindy without makeglossaries you +have no effect if you don't use makeglossaries. If +you call xindy without makeglossaries you need to remember to set the language and encoding using the -L and -C switches. @@ -3939,9 +4060,9 @@ Locations and Number lists

      -The most likely attributes used in the format -key (textrm, hyperrm etc) are automatically added -to the xindy style file, but if you want to use another +The most likely attributes used in the format +key (textrm, hyperrm etc) are automatically added +to the xindy style file, but if you want to use another attribute, you need to add it using:

      @@ -3949,24 +4070,24 @@ attribute, you need to add it using:

      where name is the name of the attribute, as used in -the format key. For example, suppose I want a +the format key. For example, suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this:

       \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
       
      -but with xindy, I also need to add this as an allowed +but with xindy, I also need to add this as an allowed attribute:
       \GlsAddXdyAttribute{hyperbfit}
       

      -Note that \GlsAddXdyAttribute has no effect if \noist is -used or if \makeglossaries is omitted. +Note that \GlsAddXdyAttribute has no effect if \noist is +used or if \makeglossaries is omitted.

      -\GlsAddXdyAttribute must be used before \makeglossaries. +\GlsAddXdyAttribute must be used before \makeglossaries.

      If the location numbers don't get expanded to a simple Arabic or @@ -3975,13 +4096,13 @@ 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 fmtcount package to -do this. You can redefine \thepage as follows: +rather than digits and you use the fmtcount package to +do this. You can redefine \thepage as follows:

       \renewcommand*{\thepage}{\Numberstring{page}}
       
      This gets expanded to \protect \Numberstringnum {n} -where n is the page number. This means that you need to +where n is the Arabic page number. This means that you need to define a new location that has that form:
       \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space
      @@ -3990,40 +4111,41 @@ define a new location that has that form:
       
      Note that it's necessary to use \space to indicate that spaces also appear in the format, since, unlike TEX, -xindy doesn't ignore spaces after control sequences. +xindy doesn't ignore spaces after control sequences.

      -Note that \GlsAddXdyLocation has no effect if \noist is -used or if \makeglossaries is omitted. +Note that \GlsAddXdyLocation has no effect if \noist is +used or if \makeglossaries is omitted.

      -\GlsAddXdyLocation must be used before \makeglossaries. +\GlsAddXdyLocation must be used before \makeglossaries.

      -In the number list, the locations are sorted according to +In the number list, the locations are sorted according to type. The default ordering is: roman-page-numbers (e.g. i), arabic-page-numbers (e.g. 1), arabic-section-numbers (e.g. 1.1 if the compositor -is a full stop or 1-1 if the compositor is a hyphen6), +is a full stop or 1-1 if the compositor is a hyphen7), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), Alpha-page-numbers (e.g. A), Appendix-page-numbers (e.g. A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a -hyphen7), +hyphen8), user defined location names (as specified by -\GlsAddXdyLocation in the order in which they were defined), +\GlsAddXdyLocation in the order in which they were defined), see (cross-referenced entries). This ordering can be changed using:

      -\GlsSetXdyLocationClassOrder +\GlsSetXdyLocationClassOrder{location names}

      -where each location name is delimited by double quote marks. +where each location name is delimited by double quote marks and +separated by white space. For example:

       \GlsSetXdyLocationClassOrder{
      @@ -4040,14 +4162,14 @@ For example:
       
       

      Note that \GlsSetXdyLocationClassOrder has no effect if -\noist is used or if \makeglossaries is omitted. +\noist is used or if \makeglossaries is omitted.

      \GlsSetXdyLocationClassOrder must be used before -\makeglossaries. +\makeglossaries.

      -If a number list consists of a sequence of consecutive +If a number list 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: @@ -4061,16 +4183,16 @@ For example: \GlsSetXdyMinRangeLength{3}

      The argument may also be the keyword none, to indicate that -there should be no range formations. See the xindy +there should be no range formations. See the xindy manual for further details on range formations.

      -Note that \GlsSetXdyMinRangeLength has no effect if \noist -is used or if \makeglossaries is omitted. +Note that \GlsSetXdyMinRangeLength has no effect if \noist +is used or if \makeglossaries is omitted.

      \GlsSetXdyMinRangeLength must be used before -\makeglossaries. +\makeglossaries.

      See Number Lists for @@ -4087,7 +4209,7 @@ Glossary Groups The glossary is divided into groups according to the first letter of the sort key. The glossaries package also adds a number group by default, unless you suppress it in the -xindy package option. For example: +xindy package option. For example:

       \usepackage[xindy={glsnumbers=false}]{glossaries}
       
      @@ -4103,11 +4225,11 @@ Roman alphabet, you can change this using

      Note that \GlsSetXdyFirstLetterAfterDigits has no effect if -\noist is used or if \makeglossaries is omitted. +\noist is used or if \makeglossaries is omitted.

      \GlsSetXdyFirstLetterAfterDigits must be used before -\makeglossaries. +\makeglossaries.

      Top @@ -4129,10 +4251,10 @@ where name is the label to assign to this glossary. The arguments input and output files for that glossary, title is the default title for this new glossary and the final optional argument counter specifies which counter to use for the associated number -lists (see also Number Lists). The +lists (see also Number Lists). The first optional argument specifies the extension for the -makeindex or xindy transcript file (this -information is only used by makeglossaries which picks up +makeindex or xindy transcript file (this +information is only used by makeglossaries which picks up the information from the auxiliary file).

      @@ -4141,17 +4263,21 @@ Note that the main (default) glossary is automatically created as: \newglossary{main}{gls}{glo}{\glossaryname}

    so it can be identified by the label main. Using the -acronym package option is equivalent to: +acronym package option is equivalent to:
     \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
     
    so it can be identified by the label acronym. If you are -not sure whether the acronym option has been used, you +not sure whether the acronym option has been used, you can identify the list of acronyms by the command \acronymtype which is set to -acronym, if the acronym option has been used, +acronym, if the acronym option has been used, otherwise it is set to main. +

    +All glossaries must be defined before \makeglossaries to +ensure that the relevant output files are opened. +

    Top @@ -4164,9 +4290,9 @@ Acronyms

    -As you may have noticed in Defining Glossary Entries, when you +You may have noticed in Defining Glossary Entries that when you specify a new entry, you can specify alternate text to use when -the term is first used in the document. This provides a useful +the term is first used in the document. This provides a useful means to define acronyms. For convenience, the glossaries package defines the command:
    @@ -4176,7 +4302,7 @@ defines the command: By default, this is equivalent to:

    -\newglossaryentry {label}{type=\acronymtype, +\newglossaryentry {label}{type=\acronymtype,
    name=
    {abbrv},
    @@ -4192,9 +4318,9 @@ firstplural={
    long\glspluralsuffix\space ( abbrv\glspluralsuffix)},
    key-val list}

    -As mentioned in the previous section, the command \acronymtype +As mentioned in the previous section, the command \acronymtype is the name of the glossary in which the acronyms should appear. If -the acronym package option has been used, this will be +the acronym package option has been used, this will be acronym, otherwise it will be main. The acronyms can then be used in exactly the same way as any other glossary entry. @@ -4205,7 +4331,7 @@ if you want to load a file containing acronym definitions using \loadglsentries[type]{filename}, the optional argument type will not have an effect unless you explicitly set the type as type=\glsdefaulttype in the optional argument to -\newacronym. See earlier for details. +\newacronym. See earlier for details.

    For example, the following defines the acronym IDN: @@ -4223,51 +4349,65 @@ plural={IDNs}, firstplural={identification numbers (IDNs)}}

    so \gls{idn} will produce "identification number (IDN)" on -first use and "IDN" on subsequent uses. +first use and "IDN" on subsequent uses.

    This section describes acronyms that have been defined using \newacronym. If you prefer to define all your acronyms using \newglossaryentry explicitly, then you should skip this section -and ignore the package options: smallcaps, smaller, -description, dua and footnote, as these -options change the definition of \newacronym for common acronym +and ignore the package options: smallcaps, smaller, +description, dua and footnote, as these +options change the definition of \newacronym for common acronym formats as well as the way that the link text is displayed (see earlier). -Likewise you should ignore the package option shortcuts +Likewise you should ignore the package option shortcuts and the new commands described in this section, such as \acrshort, as they vary according to the definition of -\newacronym. - -

    -Table 4 lists the package options and how the -\newglossaryentry keys are used to store long (the long -form) and abbrv (the short form). Note that the -smallcaps option redefines -\acronymfont so that it sets its -argument using \textsc (so you should use lower case characters in -abbrv) and the smaller option redefines -\acronymfont to use \smaller,8 otherwise \acronymfont simply displays its argument -in the surrounding font. Note also that if none of the package options -smallcaps, smaller, dua, -description or footnote are used, \acronymfont is -not used, so changing the definition of \acronymfont will have no -effect under such circumstances. +\newacronym.

    -If you want to display the acronym in another font, for example, -emphasized, then use the smaller package option and -redefine \acronymfont to use the required font. For example: +If you use any of the package options smallcaps, +smaller, description or +footnote, the acronyms will be displayed in the document +using: +
    +
    \acronymfont{text} +
    +
    +and +
    +
    \firstacronymfont{text} +
    +
    +where \firstacronymfont is applied on first use and +\acronymfont is applied on subsequent use. Note that if you +don't use any of the above package options, changing the +definition of \acronymfont or \firstacronymfont will have +no effect. In this case, the recommended route is to use +the smaller package option and redefine \acronymfont +and \firstacronymfont as required. For example, if you want +acronyms in a normal font on first use and emphasized on +subsequent use, do:

     \usepackage[smaller]{glossaries}
    +\renewcommand*{\firstacronymfont}[1]{#1}
     \renewcommand*{\acronymfont}[1]{\emph{#1}}
     
    -Where \acronymfont is available, -\firstacronymfont is also -available. By default, this simply uses \acronymfont, but it -can be redefined to change the way the acronym is displayed on -first use. +(Note that it is for this reason that the relsize package +is not automatically loaded when selecting the +smaller package option.) + +

    +Table 4 lists the package options that govern +the acronym styles and how the \newglossaryentry keys are used +to store long (the long form) and abbrv (the short +form). Note that the smallcaps option redefines +\acronymfont so that it sets its +argument using \textsc (so you should use lower case characters +in abbrv) and the smaller option redefines +\acronymfont to use \smaller,9 otherwise \acronymfont simply displays its +argument in the surrounding font.


    @@ -4275,54 +4415,54 @@ first use.
    - + - - - - + + + + - + - + - + - + - + - + - + @@ -4364,14 +4504,14 @@ to override the defaults. For example: \newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal matrix} -If the first use uses the plural form, \glspl{dm} will +If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs).

    -Each of the package options smallcaps, smaller, -footnote, dua -and description use \defglsdisplay and -\defglsdisplayfirst (described earlier) +Each of the package options smallcaps, smaller, +footnote, dua +and description use \defglsdisplay and +\defglsdisplayfirst (described earlier) to change the way the link text is displayed. This means that these package options only work for the glossary type given by \acronymtype. If you have multiple lists of acronyms, you @@ -4380,9 +4520,9 @@ glossary type.

    -
    description,footnote
    +
    description,footnote
    -When these two package options are used together, the first use displays +When these two package options are used together, the first use displays the entry as:

    \firstacronymfont{abbrv}insert\footnote{long} @@ -4398,50 +4538,50 @@ optional argument to \gls, \glspl or their uppercase variants.

    -In this case, the long form is stored in the symbol key. +In this case, the long form is stored in the symbol key. This means that the long form will not be displayed in the list of acronyms unless you use a glossary style that displays the entry's -symbol (for example, the index style). Entries will +symbol (for example, the 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 glossaries package additionally implements the -sanitize option using -sanitize={description=false,symbol=false}, so +sanitize option using +sanitize={description=false,symbol=false}, so remember to protect fragile commands when defining acronyms.

    -
    dua
    +
    dua
    -The dua package option always displays the expanded -form and so may not be used with footnote, smaller or -smallcaps. Both first use and subsequent use displays the +The dua package option always displays the expanded +form and so may not be used with footnote, smaller or +smallcaps. Both first use and subsequent use displays the entry in the form:

    longinsert

    -If the description package option is also used, the -name key is set to the long form, otherwise the -name key is set to the short form and the -description key is set to the long form. In both -cases the symbol is set to the short form. Therefore, -if you use the description package option and you want +If the description package option is also used, the +name key is set to the long form, otherwise the +name key is set to the short form and the +description key is set to the long form. In both +cases the symbol is set to the short form. Therefore, +if you use the description package option and you want the short form to appear in the list of acronyms, you will need to use a glossary style that displays the entry's symbol (for -example, the index style). Entries will be sorted -according to the long form if the description option +example, the index style). Entries will be sorted +according to the long form if the description option is used, otherwise they will be sorted according to the -short form (unless overridden by the sort key in -the optional argument of \newacronym). +short form (unless overridden by the sort key in +the optional argument of \newacronym).

    -
    description
    +
    description
    -This package option displays the entry on first use as: +This package option displays the entry on first use as:

    longinsert (\firstacronymfont{abbrv})
    @@ -4453,34 +4593,34 @@ while subsequent use displays the entry as:
    Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

    Note that with this option, you need to specify the description -using the description key in the optional argument -of \newacronym. When this option is used without -the footnote or dua options, the name field +using the description key in the optional argument +of \newacronym. When this option is used without +the footnote or dua options, the name field is specified as -\acrnameformat{short}{long}. This -defaults to \acronymfont{short}, which means that the +\acrnameformat{short}{long}. This +defaults to \acronymfont{short}, which means that the long form will not appear in the list of acronyms by default. -To change this, you need to redefine \acrnameformat as +To change this, you need to redefine \acrnameformat as appropriate. For example, to display the long form followed by the short form in parentheses do:

     \renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})}
     
    -Note that even if you redefine \acrnameformat, the +Note that even if you redefine \acrnameformat, the entries will be sorted according to the short form, unless you -override this using the sort key in the optional -argument to \newacronym. +override this using the sort key in the optional +argument to \newacronym.

    -
    footnote
    +
    footnote
    -This package option displays the entry on first use as: +This package option displays the entry on first use as:

    \firstacronymfont{abbrv}insert\footnote{long}
    @@ -4495,19 +4635,19 @@ Acronyms will be sorted according to the short form.

    Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={description=false}, so +sanitize={description=false}, so remember to protect fragile commands when defining acronyms.

    -Note that on first use, it is the long form in the footnote that +Note that on first use, 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 have the hyperlink instead of the footnote, but +on first use 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 to make the +The code required to change the first use to make the acronym a hyperlink is as follows:

      \defglsdisplayfirst[\acronymtype]{%
    @@ -4519,15 +4659,16 @@ acronym a hyperlink is as follows:
     (i.e. commands whose name contains an @ character), so
     if this code is place in a .tex file it needs to be
     placed within a \makeatletter ... \makeatother pair.
    -(See http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsignsfor further details.)
    +(See \@ and @ in macro names 
    +for further details.)
     
     

    -
    smallcaps
    +
    smallcaps
    -If neither the footnote nor description options -have been set, this option displays the entry on first use as: +If neither the footnote nor description options +have been set, this option displays the entry on first use as:

    longinsert (\firstacronymfont{abbrv})
    @@ -4540,22 +4681,22 @@ while subsequent use displays the entry as: where \acronymfont is set to \textsc{#1}.

    -Note that since the acronym is displayed using \textsc, +Note that since the acronym is displayed using \textsc, the short form, abbrv, should be specified in lower case.

    Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

    -
    smaller
    +
    smaller
    -If neither the footnote nor description options -have been set, this option displays the entry on first use as: +If neither the footnote nor description options +have been set, this option displays the entry on first use as:

    longinsert (\firstacronymfont{abbrv})
    @@ -4569,23 +4710,23 @@ where \acronymfont is set to {\smaller #1}. The entries will be sorted according to the short form.

    -Remember to load a package that defines \smaller (such as -relsize) if you want to use this option, unless you want -to redefine \acronymfont to use some other formatting command. +Remember to load a package that defines \smaller (such as +relsize) if you want to use this option, unless you want +to redefine \acronymfont to use some other formatting command.

    Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

    None of the above
    -If none of the package options smallcaps, smaller, -footnote, dua or description are used, -then on first use the entry is displayed as: +If none of the package options smallcaps, smaller, +footnote, dua or description are used, +then on first use the entry is displayed as:

    long (abbrv)insert
    @@ -4602,7 +4743,7 @@ Entries will be sorted according to the short form.

    Recall from earlier that you can access the values of individual keys using commands -like \glstext, so it is possible to use these commands to +like \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 @@ -4620,10 +4761,10 @@ as follows: \ACRshort[options]{label}[insert]

    -Print the abbreviated version with a hyperlink (if necessary) to the +Print the abbreviated version with (if required) a hyperlink to the relevant entry in the glossary. This is usually equivalent to -\glstext (or its uppercase variants) but may additionally -put the link text within the argument to \acronymfont. +\glstext (or its uppercase variants) but may additionally +put the link text within the argument to \acronymfont.

    @@ -4635,9 +4776,9 @@ put the link text within the argument to \acronymfont\ACRlong[options]{label}[insert]

    -Print the long version with a hyperlink (if necessary) to the +Print the long version with (if required) a hyperlink to the relevant entry in the glossary. This is may be equivalent to -\glsdesc
    , \glssymbol or \glsfirst (or their uppercase +\glsdesc, \glssymbol or \glsfirst (or their uppercase variants), depending on package options.

    @@ -4651,20 +4792,20 @@ variants), depending on package options.

    Print the long version followed by the abbreviation in brackets -with a hyperlink (if necessary) to the +with (if required) a hyperlink to the relevant entry in the glossary.

    -Note that if you change the definition of \newacronym, you +Note that if you change the definition of \newacronym, you may additionally need to change the above commands as well as -changing the way the text is displayed using \defglsdisplay -and \defglsdisplayfirst. +changing the way the text is displayed using \defglsdisplay +and \defglsdisplayfirst.

    -The package option shortcuts provides the synonyms listed +The package option shortcuts provides the synonyms listed in table 5. If any of those commands generate an "undefined control sequence" error message, check that you -have enabled the shortcuts using the shortcuts package +have enabled the shortcuts using the shortcuts package option. Note that there are no shortcuts for the commands that produce all upper case text. @@ -4674,60 +4815,60 @@ produce all upper case text.

    - +
    Table 4: Package options governing \newacronym and how the information is stored in the keys for \newglossaryentry
    Package Option first keytext keydescription keysymbol keyfirst keytext keydescription keysymbol key
    description,footnote
    description,footnote abbrv abbrv user supplied long
    description,dua
    description,dua long long user supplied abbrv
    description
    description long abbrv user supplied abbrv
    footnote
    footnote abbrv abbrv long  
    smallcaps
    smallcaps long abbrv long abbrv
    smaller
    smaller long abbrv long abbrv
    dua
    dua long long long
    +Synonyms provided by the package option shortcuts - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    Table 5: -Synonyms provided by the package option shortcuts
    Shortcut Command Equivalent Command
    \acs\acrshort
    \acs\acrshort
    \Acs\Acrshort
    \Acs\Acrshort
    \acsp\acrshortpl
    \acsp\acrshortpl
    \Acsp\Acrshortpl
    \Acsp\Acrshortpl
    \acl\acrlong
    \acl\acrlong
    \Acl\Acrlong
    \Acl\Acrlong
    \aclp\acrlongpl
    \aclp\acrlongpl
    \Aclp\Acrlongpl
    \Aclp\Acrlongpl
    \acf\acrfull
    \acf\acrfull
    \Acf\Acrfull
    \Acf\Acrfull
    \acfp\acrfullpl
    \acfp\acrfullpl
    \Acfp\Acrfullpl
    \Acfp\Acrfullpl
    \ac\gls
    \ac\gls
    \Ac\Gls
    \Ac\Gls
    \acp\glspl
    \acp\glspl
    \Acp\Glspl
    \Acp\Glspl
    @@ -4741,16 +4882,132 @@ Synonyms provided by the package option shortcuts -

    -Unsetting and Resetting Entry Flags +

    +Upgrading From the glossary Package +

    +Users of the obsolete glossary package may recall that +the syntax used to define new acronyms has changed with the +replacement glossaries package. In addition, the old +glossary package created the command +\acr-name when defining the acronym acr-name. + +

    +In order to facilitate migrating from the old package to the new +one, the glossaries package10 +provides the command: +
    +
    \oldacronym[label]{abbrv}{long}{key-val list} +
    +
    +This uses the same syntax as the glossary package's +method of defining acronyms. It is equivalent to: +
    +
    \newacronym[key-val list]{label}{abbrv}{long} +
    +
    +In addition, \oldacronym also defines the commands +\label, which is equivalent to \gls{label}, +and \label*, which is equivalent to +\Gls{label}. If label is omitted, abbrv +is used. Since commands names must consist only of alphabetical +characters, label must also only consist of alphabetical +characters. Note that \label doesn't allow you to use +the first optional argument of \gls or \Gls -- you will +need to explicitly use \gls or \Gls to change the +settings. + +

    +Recall that, in general, LaTeX ignores spaces following command +names consisting of alphabetical characters. This is also true for +\label unless you additionally load the +xspace package. + +

    +The glossaries package doesn't load the xspace package +since there are both advantages and disadvantages to using +\xspace in \label. If you don't use the +xspace package you need to explicitly force a space using +SPMquot " (backslash space) however you can follow \label +with additional text in square brackets (the final optional +argument to \gls). If you use the 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 \gls). + +

    +To illustrate this, suppose I define the acronym "abc" as +follows: +

    +\oldacronym{abc}{example acronym}{}
    +
    +This will create the command \abc and its starred version +\abc*. Table 6 illustrates the effect of +\abc (on subsequent use) according to whether or not the +xspace package has been loaded. As can be seen from the +final row in the table, the xspace package prevents the +optional argument from being recognised. + +

    +

    +
    + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6: +The effect of using +xspace with \oldacronym
    Code With xspace Without xspace
    \abc.abc.abc.
    \abc xyzabc xyzabcxyz
    \abc\ xyzabc xyzabc xyz
    \abc* xyzAbc xyzAbc xyz
    \abc['s] xyzabc ['s] xyzabc's xyz
    +
    +

    +

    +
    +
    + +

    + +

    +Top + +

    + +

    + +
    +Unsetting and Resetting Entry Flags

    -When using \gls, \glspl and their uppercase variants it is +When using \gls, \glspl and their uppercase variants it is possible that you may want to use the value given by the -first key, even though you have already used the glossary -entry. Conversely, you may want to use the value given by the -text key, even though you haven't used the glossary entry. +first key, even though you have already used the glossary +entry. Conversely, you may want to use the value given by the +text key, even though you haven't used the glossary entry. The former can be achieved by one of the following commands:

    \glsreset{label} @@ -4763,7 +5020,25 @@ while the latter can be achieved by one of the following commands:
    \glslocalunset{label}

    -You can determine whether an entry has been used using: +You can also reset or unset all entries for a given glossary or list of +glossaries using: +
    +
    \glsresetall[glossary list] +
    \glslocalresetall[glossary list] +
    \glsunsetall[glossary list] +
    \glslocalunsetall[glossary list] +
    +
    +where glossary list 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: +

    +\glsresetall[main,acronym]
    +
    + +

    +You can determine whether an entry's first use flag is set using:

    \ifglsused{label}{true part}{false part} @@ -4790,16 +5065,207 @@ 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. -The predefined styles are as follows: +that suits your type of glossary. See table 7 for +a summary of the available styles. + +

    +

    +
    + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7: +Glossary Styles. An asterisk in the style +name indicates anything that matches that doesn't match any +previously listed style (e.g. long3col* +matches long3col, long3colheader, +long3colborder and long3colheaderborder). +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 +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.
    Style Maximum Level Homograph Symbol
    listdotted 0  
    sublistdotted 1  
    list* 1X 
    altlist* 1X 
    long3col* 1X 
    long4col* 1XX
    altlong4col* 1XX
    long* 1X 
    super3col* 1X 
    super4col* 1XX
    altsuper4col* 1XX
    super* 1X 
    index* 2 X
    treenoname* --XX
    tree* -- X
    alttree* -- X
    +
    +

    +

    +
    +
    + +

    +The glossary style can be set using the style package option +or using the style key in the optional +argument to \printglossary or using the command: +
    +
    \glossarystyle{style-name} +
    +
    +The tabular-like styles that allow multi-line descriptions and page +lists use the length \glsdescwidth +to set the width of the description column and the length +\glspagelistwidth to set the +width of the page list column.11These will need to be changed using \setlength if the glossary +is too wide. Note that the long4col and +super4col 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 altlong4col +and altsuper4col styles. If you want to +explicitly create a line-break within a multi-line description in +a tabular-like style you should use \newline instead of +\\. + +

    +Note that if you use the style key in the +optional argument to \printglossary, it will override any +previous style settings for the given glossary, so if, for example, +you do +

    +\renewcommand*{\glsgroupskip}{}
    +\printglossary[style=long]
    +
    +then the new definition of \glsgroupskip will not have an affect +for this glossary, as \glsgroupskip is redefined by +style=long. Likewise, \glossarystyle will also +override any previous style definitions, so, again +
    +\renewcommand*{\glsgroupskip}{}
    +\glossarystyle{long}
    +
    +will reset \glsgroupskip back to its default definition for the +named glossary style (long in this case). If you want to +modify the styles, either use \newglossarystyle (described +in the next section) or make the modifications after +\glossarystyle, e.g.: +
    +\glossarystyle{long}
    +\renewcommand*{\glsgroupskip}{}
    +
    + +

    +All the styles except for the three- and four-column styles and the +listdotted style use the command +\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 \glspostdescription before the glossary is +displayed. Alternatively, you can suppress it for a given entry +by placing \nopostdesc in the entry's description. + +

    +Top + +

    + +

    + +
    +List Styles +

    + +

    +The styles described in this section are all defined in the package +glossary-list. Since they all use the 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 not be available if you use either the +nolist or nostyles package options.

    list
    -
    The list style uses the description +
    The list style uses the description environment. The entry name is placed in the optional argument of the \item command (so it will appear in bold by default). The -description follows, and then the associated number list for +description follows, and then the associated number list 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 \indexspace. @@ -4807,17 +5273,17 @@ child entry. Groups are separated using \indexspace.

    listgroup
    -
    The listgroup style is like -list but the glossary groups have headings. +
    The listgroup style is like +list but the glossary groups have headings.

    listhypergroup
    -
    The listhypergroup style is like -listgroup but has a navigation line at the start of +
    The listhypergroup style is like +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 +the group information is up to date. In the navigation line, each group is separated by \glshypernavsep which defaults to a vertical bar with a space on either side. For example, @@ -4830,380 +5296,454 @@ to simply have a space separating each group, do: Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to \item instead of after it to prevent a spurious space at the start. This can be changed -by redefining \glossaryheader, but note that this needs to +by redefining \glossaryheader, but note that this needs to be done after the glossary style has been set.

    altlist
    -
    The altlist style is like list +
    The altlist style is like list but the description starts on the line following the name. (As -with the list style, the symbol is ignored.) Each child -entry starts a new line, but as with the list style, +with the list style, the symbol is ignored.) Each child +entry starts a new line, but as with the list style, the name associated with each child entry is ignored.

    altlistgroup
    -
    The altlistgroup style is like -altlist but the glossary groups have headings. +
    The altlistgroup style is like +altlist but the glossary groups have headings.

    altlisthypergroup
    -
    The altlisthypergroup style is like -altlistgroup but has a set of links to the glossary +
    The altlisthypergroup style is like +altlistgroup but has a set of links to the glossary groups. The navigation line is the same as that for -listhypergroup, described above. +listhypergroup, described above.

    listdotted
    This style uses the description -environment. Each entry starts with \item[], followed by the -name followed by a dotted line, followed by the description. Note that -this style ignores both the number list and the symbol. The -length \glslistdottedwidth -governs where the description should start.9 This is a flat style, so child +environment.12 Each +entry starts with \item[], followed by the name followed by a +dotted line, followed by the description. Note that this style +ignores both the number list and the symbol. The length +\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.

    +
    sublistdotted
    +
    This is a variation on the listdotted +style designed for hierarchical glossaries. The main entries +have just the name displayed. The sub entries are displayed in +the same manner as listdotted. +
    +
    + +

    +Top + +

    + +

    + +
    +Longtable Styles +

    + +

    +The styles described in this section are all defined in the package +glossary-long. Since they all use the longtable +environment, they are governed by the same parameters as that +environment. Note that these styles will not be available if you +use either the nolong or nostyles package options. + +

    +

    long
    -
    The long style uses the longtable -environment (defined by the longtable package). It has two +
    The long style uses the longtable +environment (defined by the longtable 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. +column contains the description followed by the number list. 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 -\glsdescwidth. Child entries have a similar format to the +\glsdescwidth. Child entries have a similar format to the parent entries except that their name is suppressed.

    longborder
    -
    The longborder style is like -long but has horizontal and vertical lines around it. +
    The longborder style is like +long but has horizontal and vertical lines around it.

    longheader
    -
    The longheader style is like -long but has a header row. +
    The longheader style is like +long but has a header row.

    longheaderborder
    -
    The longheaderborder style is -like longheader but has horizontal and vertical lines +
    The longheaderborder style is +like longheader but has horizontal and vertical lines around it.

    long3col
    -
    The long3col style is like -long but has three columns. The first column contains +
    The long3col style is like +long but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the number list. +and the third column contains the number list. 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 -\glsdescwidth, and the width of the third column is governed by the -length \glspagelistwidth. +\glsdescwidth, and the width of the third column is governed by the +length \glspagelistwidth.

    long3colborder
    -
    The long3colborder style is like -the long3col style but has horizontal and vertical +
    The long3colborder style is like +the long3col style but has horizontal and vertical lines around it.

    long3colheader
    -
    The long3colheader style is like -long3col but has a header row. +
    The long3colheader style is like +long3col but has a header row.

    long3colheaderborder
    -
    The long3colheaderborder style is -like long3colheader but has horizontal and vertical lines +
    The long3colheaderborder style is +like long3colheader but has horizontal and vertical lines around it.

    long4col
    -
    The long4col style is like -long3col but has an additional column in which the +
    The long4col style is like +long3col 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 altlong4col for +widest entry in the given column. Use altlong4col for multi-line descriptions.

    long4colborder
    -
    The long4colborder style is like -the long4col style but has horizontal and vertical +
    The long4colborder style is like +the long4col style but has horizontal and vertical lines around it.

    long4colheader
    -
    The long4colheader style is like -long4col but has a header row. +
    The long4colheader style is like +long4col but has a header row.

    long4colheaderborder
    -
    The long4colheaderborder style is -like long4colheader but has horizontal and vertical lines +
    The long4colheaderborder style is +like long4colheader but has horizontal and vertical lines around it.

    altlong4col
    -
    The altlong4col style is like -long4col but allows multi-line descriptions and page +
    The altlong4col style is like +long4col but allows multi-line descriptions and page lists. The width of the description column is governed by the -length \glsdescwidth and the width of the page list column is -governed by the length \glspagelistwidth. The widths of the +length \glsdescwidth and the width of the page list column is +governed by the length \glspagelistwidth. The widths of the name and symbol columns are governed by the widest entry in the given column.

    altlong4colborder
    -
    The altlong4colborder style is like -the long4colborder but allows multi-line descriptions and +
    The altlong4colborder style is like +the long4colborder but allows multi-line descriptions and page lists.

    altlong4colheader
    -
    The altlong4colheader style is like -long4colheader but allows multi-line descriptions and +
    The altlong4colheader style is like +long4colheader but allows multi-line descriptions and page lists.

    altlong4colheaderborder
    -
    The altlong4colheaderborder -style is like long4colheaderborder but allows multi-line +
    The altlong4colheaderborder +style is like long4colheaderborder but allows multi-line descriptions and page lists. +
    +

    - +Top + +

    + +

    + +
    +Supertabular Styles +

    + +

    +The styles described in this section are all defined in the package +glossary-super. Since they all use the supertabular +environment, they are governed by the same parameters as that +environment. Note that these styles will not be available if you +use either the nosuper or nostyles package options. +In general, the longtable environment is better, but there +are some circumstances where it is better to use +supertabular.13 +

    +

    super
    -
    The super style uses the supertabular -environment (defined by the supertabular package). It has two +
    The super style uses the supertabular +environment (defined by the supertabular 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. +column contains the description followed by the number list. 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 -\glsdescwidth. Child entries have a similar format to the +\glsdescwidth. Child entries have a similar format to the parent entries except that their name is suppressed.

    superborder
    -
    The superborder style is like -super but has horizontal and vertical lines around it. +
    The superborder style is like +super but has horizontal and vertical lines around it.

    superheader
    -
    The superheader style is like -super but has a header row. +
    The superheader style is like +super but has a header row.

    superheaderborder
    -
    The superheaderborder style is -like superheader but has horizontal and vertical lines +
    The superheaderborder style is +like superheader but has horizontal and vertical lines around it.

    super3col
    -
    The super3col style is like -super but has three columns. The first column contains +
    The super3col style is like +super but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the number list. The +and the third column contains the number list. 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 -\glsdescwidth. The width of the third column is governed by the -length \glspagelistwidth. +\glsdescwidth. The width of the third column is governed by the +length \glspagelistwidth.

    super3colborder
    -
    The super3colborder style is like -the super3col style but has horizontal and vertical +
    The super3colborder style is like +the super3col style but has horizontal and vertical lines around it.

    super3colheader
    -
    The super3colheader style is like -super3col but has a header row. +
    The super3colheader style is like +super3col but has a header row.

    super3colheaderborder
    -
    The super3colheaderborder style -is like super3colheader but has horizontal and vertical +
    The super3colheaderborder style +is like super3colheader but has horizontal and vertical lines around it.

    super4col
    -
    The super4col style is like -super3col but has an additional column in which the +
    The super4col style is like +super3col 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 altsuper4col +widest entry in the given column. Use altsuper4col for multi-line descriptions.

    super4colborder
    -
    The super4colborder style is like -the super4col style but has horizontal and vertical +
    The super4colborder style is like +the super4col style but has horizontal and vertical lines around it.

    super4colheader
    -
    The super4colheader style is like -super4col but has a header row. +
    The super4colheader style is like +super4col but has a header row.

    super4colheaderborder
    -
    The super4colheaderborder style -is like super4colheader but has horizontal and vertical +
    The super4colheaderborder style +is like super4colheader but has horizontal and vertical lines around it.

    altsuper4col
    -
    The altsuper4col style is like -super4col but allows multi-line descriptions and page +
    The altsuper4col style is like +super4col but allows multi-line descriptions and page lists. The width of the description column is governed by the length -\glsdescwidth and the width of the page list column is -governed by the length \glspagelistwidth. The width of the name +\glsdescwidth and the width of the page list column is +governed by the length \glspagelistwidth. The width of the name and symbol columns is governed by the widest entry in the given column.

    altsuper4colborder
    -
    The altsuper4colborder style is like -the super4colborder style but allows multi-line descriptions +
    The altsuper4colborder style is like +the super4colborder style but allows multi-line descriptions and page lists.

    altsuper4colheader
    -
    The altsuper4colheader style is like -super4colheader but allows multi-line descriptions and +
    The altsuper4colheader style is like +super4colheader but allows multi-line descriptions and page lists.

    altsuper4colheaderborder
    -
    The altsuper4colheaderborder -style is like super4colheaderborder but allows multi-line +
    The altsuper4colheaderborder +style is like super4colheaderborder but allows multi-line descriptions and page lists. +
    +

    - +Top + +

    + +

    + +
    +Tree-Like Styles +

    + +

    +The styles described in this section are all defined in the package +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 not be available if you +use either the notree or nostyles package options. + +

    +

    index
    -
    The index style is similar to the -way indices are usually formatted in that it has a -hierarchical structure up to three 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 (if present) and the description. -Groups are separated using \indexspace. +
    The index 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 \indexspace.

    indexgroup
    -
    The indexgroup style is similar to -the index style except that each group has a heading. +
    The indexgroup style is similar to +the index style except that each group has a heading.

    indexhypergroup
    -
    The indexhypergroup style is like -indexgroup but has a set of links to the glossary +
    The indexhypergroup style is like +indexgroup but has a set of links to the glossary groups. The navigation line is the same as that for -listhypergroup, described above. +listhypergroup, described above.

    tree
    -
    The tree style is similar to the -index style except that it can have arbitrary levels. -(Note that makeindex is limited to three levels, so -you will need to use xindy if you want more than +
    The tree style is similar to the +index style except that it can have arbitrary levels. +(Note that makeindex is limited to three levels, so +you will need to use xindy if you want more than three levels.) Each sub-level is indented by \glstreeindent. 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 alttree style instead. (See below.) +description, use the alttree style instead. (See below.)

    treegroup
    -
    The treegroup style is similar to -the tree style except that each group has a heading. +
    The treegroup style is similar to +the tree style except that each group has a heading.

    treehypergroup
    -
    The treehypergroup style is like -treegroup but has a set of links to the glossary +
    The treehypergroup style is like +treegroup but has a set of links to the glossary groups. The navigation line is the same as that for -listhypergroup, described above. +listhypergroup, described above.

    treenoname
    -
    The treenoname style is like -the tree style except that the name for each sub-entry +
    The treenoname style is like +the tree style except that the name for each sub-entry is ignored.

    treenonamegroup
    -
    The treenonamegroup style is -similar to the treenoname style except that each group +
    The treenonamegroup style is +similar to the treenoname style except that each group has a heading.

    treenonamehypergroup
    -
    The treenonamehypergroup -style is like treenonamegroup but has a set of links to +
    The treenonamehypergroup +style is like treenonamegroup but has a set of links to the glossary groups. The navigation line is the same as that for -listhypergroup, described above. +listhypergroup, described above.

    alttree
    -
    The alttree style is similar to the -tree style except that the indentation for each level +
    The alttree style is similar to the +tree style except that the indentation for each level is determined by the width of the text specified by

    \glssetwidest[level]{text} @@ -5224,80 +5764,21 @@ description.

    alttreegroup
    -
    The alttreegroup is like the -alttree style except that each group has a heading. +
    The alttreegroup is like the +alttree style except that each group has a heading.

    alttreehypergroup
    -
    The alttreehypergroup style is -like alttreegroup but has a set of links to the glossary +
    The alttreehypergroup style is +like alttreegroup but has a set of links to the glossary groups. The navigation line is the same as that for -listhypergroup, described above. +listhypergroup, described above.

    -

    -The glossary style can be set using the style package option -or using the style key in the optional -argument to \printglossary or using the command: -
    -
    \glossarystyle{style-name} -
    -
    -The tabular-like styles that allow multi-line descriptions and page -lists use the length \glsdescwidth to -set the width of the description column and the length -\glspagelistwidth to set the -width of the page list column. These will need to be changed using -\setlength if the glossary is too wide. Note that the -long4col and super4col 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 -altlong4col and altsuper4col styles. -Note that if you want to explicitly create a line-break within -a multi-line description you should use \newline instead -of \\. - -

    -Note that if you use the style key in the -optional argument to \printglossary, it will override any -previous style settings for the given glossary, so if, for example, -you do: -

    -\renewcommand*{\glsgroupskip}{}
    -\printglossary[style=long]
    -
    -The new definition of \glsgroupskip will not have an affect -for this glossary, as \glsgroupskip is redefined by -style=long. Likewise, \glossarystyle will also -override any previous style definitions, so, again: -
    -\renewcommand*{\glsgroupskip}{}
    -\glossarystyle{long}
    -
    -will reset \glsgroupskip back to its default definition for the -named glossary style (long in this case). If you want to -modify the styles, either use \newglossarystyle (described -in the next section) or make the modifications after -\glossarystyle, e.g.: -
    -\glossarystyle{long}
    -\renewcommand*{\glsgroupskip}{}
    -
    - -

    -All the styles except for the three- and four-column styles and the -listdotted style use the command -\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 \glspostdescription before the glossary is -displayed. Alternatively, you can suppress it for a given entry -by placing \nopostdesc in the entry's description. -

    @@ -5332,7 +5813,7 @@ This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreamble) or the glossary postamble (defined by \glossarypostamble). For example, -the list style uses the description environment, +the list style uses the description environment, so the theglossary environment is simply redefined to begin and end the description environment. @@ -5345,8 +5826,8 @@ and end the description environment. This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamble, which should not be affected by changes in -the glossary style. The list glossary style redefines -\glossaryheader to do nothing, whereas the longheader +the glossary style. The list glossary style redefines +\glossaryheader to do nothing, whereas the longheader glossary style redefines \glossaryheader to do a header row.

    @@ -5355,19 +5836,44 @@ glossary style redefines \glossaryheader to do a header row.

    \glsgroupheading{label}

    -This macro indicates what to do at the start of each logical block -within the main body of the glossary. The glossary is sub-divided into -twenty-eight logical blocks that are determined by the first character -of the sort key (or name key if the sort -key is omitted). The sub-divisions are in the following order: symbols, -numbers, A, ..., Z. (This may be different if you use -xindy.) Note that the argument to \glsgroupheading +This macro indicates +what to do at the start of each logical block within the main body +of the glossary. If you use makeindex the glossary is +sub-divided into a maximum of twenty-eight logical blocks that are +determined by the first character of the sort key (or +name key if the sort key is omitted). The +sub-divisions are in the following order: symbols, numbers, A, +..., Z. If you use xindy, the sub-divisions depend on +the language settings. + +

    +Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained -via \glsgetgrouptitle{label}, and a navigation hypertarget can -be created using \glsnavhypertarget{label}. Most of the -predefined glossary styles redefine \glsgroupheading to simply -ignore its argument. The listhypergroup style redefines -\glsgroupheading as follows: +via + +

    +\glsgetgrouptitle{label} + +

    +This obtains the title as follows: if +\labelgroupname exists, this is taken to be the +title, otherwise the title is just label. + +

    +A navigation hypertarget can be created using + +

    +\glsnavhypertarget{label}{text} + +

    +For further details about \glsnavhypertarget, see +the documented code of glossary-hypernav +in glossaries.pdf. + +

    +Most of the predefined glossary styles redefine \glsgroupheading +to simply ignore its argument. The listhypergroup style +redefines \glsgroupheading as follows:

     \renewcommand*{\glsgroupheading}[1]{%
     \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
    @@ -5382,7 +5888,7 @@ See also \glsgroupskip below. (Note that command definitions withi
     \glsgroupskip
     

    This macro determines what to do after one logical group but before -the header for the next logical group. The list glossary +the header for the next logical group. The list glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine \glsgroupskip to produce a blank row. @@ -5401,19 +5907,29 @@ Note that formatted name will always be in the form font for the entry name, regardless of the glossary style used. Note that label is the label used when the glossary entry was defined via either \newglossaryentry or \newacronym. -Each time you use a glossary entry it creates a -link10 -using \@glslink{label}{text} with the label -glo:label. Your -new glossary style must therefore redefine \glossaryentryfield -so that it uses \@glstarget{glo:label}{text} -to ensure the hyperlinks function correctly.11 For example, the -list style defines \glossaryentryfield as follows: + +

    +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 +\glossaryentryfield to set the appropriate target. This +is done using + +

    +\glstarget{label}{text} + +

    +where label is the entry's label. Note that you +don't need to worry about whether the hyperref package has +been loaded, as \glstarget won't create a target if +\hypertarget hasn't been defined. + +

    +For example, the +list style defines \glossaryentryfield as follows:

     \renewcommand*{\glossaryentryfield}[5]{%
    -\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}
    +\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5}
     

    @@ -5429,15 +5945,15 @@ may contain \delimN (to delimit individual numbers) and/or multiple occurrences of \setentrycounter{counter name}\glsnumberformat{number(s)}, but note that the entire number list is enclosed within the argument -to \glossaryentrynumbers. The user can redefine this to change +to \glossaryentrynumbers. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of \glossaryentrynumbers is to provide a means of suppressing the -number list altogether. (In fact, the nonumberlist option +number list altogether. (In fact, the nonumberlist option redefines \glossaryentrynumbers to ignore its argument.) Therefore, when you define a new glossary style, you don't need to worry about whether the user has specified the -nonumberlist package option. +nonumberlist package option.

    @@ -5451,9 +5967,14 @@ This is new to version 1.17, and is used to display sub-entries. The first argument, level, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for -\glossaryentryfield described above. +\glossaryentryfield described above. + +

    +For further details of these commands, see +the documented code in glossaries.pdf. +

    Top @@ -5465,22 +5986,19 @@ Example: creating a completely new style

    If you want a completely new style, you will need to redefine all -of the commands and environment listed above. You also need to -take care when using internal commands (commands whose name -contain the @ symbol). These should either be used in a .sty -file or must be placed within \makeatletter and \makeatother. +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 itemize environment, so theglossary should start and end that environment. Let's also suppose that you don't want anything between -the glossary groups (so \glsgroupheading and \glsgroupskip +the glossary groups (so \glsgroupheading and \glsgroupskip should do nothing) and suppose you don't want anything to appear -immediately after \begin{theglossary} (so \glossaryheader +immediately after \begin{theglossary} (so \glossaryheader should do nothing). In addition, let's suppose the symbol should appear in brackets after the name, followed by the description and -last of all the number list should appear within square brackets +last of all the number list should appear within square brackets at the end. Then you can create this new glossary style, called, say, mylist, as follows:

    @@ -5495,14 +6013,14 @@ at the end. Then you can create this new glossary style, called, say,
      % set how each entry should appear:
      \renewcommand*{\glossaryentryfield}[5]{%
      \item % bullet point
    - \@glstarget{glo:##1}{##2}% the entry name
    + \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}}%
    +   \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}%
      }
     
    Note that this style creates a flat glossary, where sub-entries @@ -5523,7 +6041,7 @@ If you want to define a new style that is a slightly modified version of an existing style, you can use \glossarystyle within the second argument of \newglossarystyle followed by whatever alterations you require. For example, suppose you want -a style like the list style but you don't want the extra +a style like the list style but you don't want the extra vertical space created by \indexspace between groups, then you can create a new glossary style called, say, mylist as follows: @@ -5547,7 +6065,7 @@ Mfirstuc Package

    The glossaries bundle is supplied with the package -mfirstuc which provides the command: +mfirstuc which provides the command:

    \makefirstuc{stuff} @@ -5564,7 +6082,7 @@ object in the group is converted to uppercase. Examples:

  • \makefirstuc{\emph{abc}} produces Abc -(\MakeUppercase has been applied to the letter "a" rather +(\MakeUppercase has been applied to the letter "a" rather than \emph.)

    @@ -5588,7 +6106,7 @@ than \emph.) 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 inputenc package) due to expansion issues. +using the inputenc package) due to expansion issues.

    In version 1.02 of mfirstuc, a bug fix resulted in a change @@ -5625,15 +6143,15 @@ produces: Abc.

    If you want to use an alternative command to convert to uppercase, -for example \MakeTextUppercase,12 you can redefine the internal +for example \MakeTextUppercase,14 you can redefine the internal command \@gls@makefirstuc. For example:

     \renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1}
     
    (Remember that command names that contain the @ character must either be placed in packages or be placed between \makeatletter -\makeatother.) +and \makeatother.)

    @@ -5649,1378 +6167,1527 @@ either be placed in packages or be placed between \makeatletter Index

    \Ac -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acf -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acfp -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acl -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Aclp -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acp -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acrfull -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acrfullpl -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acrlong -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acrlongpl -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \acrnameformat -
    Acronyms - | Acronyms - | Acronyms +
    Acronyms + | Acronyms + | Acronyms
    \acronymfont -
    Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Acronyms + | Acronyms + | Acronyms
    \acronymname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \acronymtype -
    A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Acronyms - | Acronyms +
    A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Acronyms + | Acronyms
    \Acrshort -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acrshortpl -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acs -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \Acsp -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    babel -
    Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Troubleshooting +
    Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Troubleshooting
    \defglsdisplay -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \defglsdisplayfirst -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    \descriptionname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \emph -
    A Quick Guide For - | Links to Glossary Entries +
    A Quick Guide For + | Links to Glossary Entries
    \entryname -
    Changing the Fixed Names +
    Changing the Fixed Names
    file types
    .alg -
    Generating the Associated Glossary +
    Generating the Associated Glossary
    .aux -
    Using the makeglossaries Perl - | Language and Encodings +
    Using the makeglossaries Perl + | Language and Encodings
    .glg -
    Generating the Associated Glossary - | Using xindy explicitly - | Using makeindex explicitly - | Troubleshooting - | A Quick Guide For +
    Generating the Associated Glossary + | Using xindy explicitly + | Using makeindex explicitly + | Troubleshooting + | A Quick Guide For
    .glo -
    Using xindy explicitly - | Using makeindex explicitly - | Defining Glossary Entries +
    Using xindy explicitly + | Using makeindex explicitly + | Defining Glossary Entries
    .gls -
    Using xindy explicitly - | Using makeindex explicitly - | Defining Glossary Entries +
    Using xindy explicitly + | Using makeindex explicitly + | Defining Glossary Entries
    .ist -
    Using the makeglossaries Perl - | Using makeindex explicitly - | Using makeindex explicitly - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries +
    Using the makeglossaries Perl + | Using makeindex explicitly + | Using makeindex explicitly + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries
    .log -
    Troubleshooting +
    Troubleshooting
    .nlg -
    A Quick Guide For +
    A Quick Guide For
    .tex -
    Using xindy explicitly - | Using makeindex explicitly +
    Using xindy explicitly + | Using makeindex explicitly
    .xdy -
    Using the makeglossaries Perl - | Using xindy explicitly - | Using xindy explicitly - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Xindy +
    Using the makeglossaries Perl + | Using xindy explicitly + | Using xindy explicitly + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Xindy +
    +
    first use +
    Troubleshooting + | Troubleshooting + | A Quick Guide For + | Changing the format of + | Changing the format of + | Changing the format of + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Unsetting and Resetting Entry +
    +
    flag +
    Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Using Glossary Terms Without +
    text +
    Defining Glossary Entries + | Defining Glossary Entries + | Using Glossary Terms Without + | Using Glossary Terms Without
    +
    flowfram +
    Supertabular Styles
    fmtcount -
    Locations and Number lists +
    Locations and Number lists
    fontenc -
    A Quick Guide For +
    A Quick Guide For
    german -
    Changing the Fixed Names +
    Changing the Fixed Names
    glossaries -
    Sample Documents - | Changing the Fixed Names +
    Sample Documents + | Changing the Fixed Names + | Upgrading From the glossary + | Upgrading From the glossary
    glossary -
    Introduction - | Troubleshooting +
    Introduction + | Troubleshooting + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary
    glossary styles
    altlist -
    Glossary Styles - | Glossary Styles +
    List Styles + | List Styles
    altlistgroup -
    Glossary Styles - | Glossary Styles +
    List Styles + | List Styles
    altlisthypergroup -
    Glossary Styles +
    List Styles
    altlong4col -
    Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Longtable Styles + | Longtable Styles
    altlong4colborder -
    Glossary Styles +
    Longtable Styles
    altlong4colheader -
    Glossary Styles +
    Longtable Styles
    altlong4colheaderborder -
    Glossary Styles +
    Longtable Styles
    altsuper4col -
    Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Supertabular Styles + | Supertabular Styles
    altsuper4colborder -
    Glossary Styles +
    Supertabular Styles
    altsuper4colheader -
    Glossary Styles +
    Supertabular Styles
    altsuper4colheaderborder -
    Glossary Styles +
    Supertabular Styles
    alttree -
    Glossary Styles - | Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles
    alttreegroup -
    Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles
    alttreehypergroup -
    Glossary Styles +
    Tree-Like Styles
    index -
    Acronyms - | Acronyms - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Acronyms + | Acronyms + | Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles
    indexgroup -
    Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles
    indexhypergroup -
    Glossary Styles +
    Tree-Like Styles
    list -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Example: creating a new +
    Package Options + | List Styles + | List Styles + | List Styles + | List Styles + | List Styles + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Example: creating a new
    listdotted -
    Glossary Styles +
    Glossary Styles + | List Styles + | List Styles
    listgroup -
    Glossary Styles - | Glossary Styles +
    List Styles + | List Styles
    listhypergroup -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Defining your own glossary +
    List Styles + | List Styles + | Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles + | Defining your own glossary
    long -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles
    long3col -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles
    long3colborder -
    Glossary Styles +
    Glossary Styles + | Longtable Styles
    long3colheader -
    Glossary Styles - | Glossary Styles +
    Glossary Styles + | Longtable Styles + | Longtable Styles
    long3colheaderborder -
    Glossary Styles +
    Glossary Styles + | Longtable Styles
    long4col -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles + | Longtable Styles
    long4colborder -
    Glossary Styles - | Glossary Styles +
    Longtable Styles + | Longtable Styles
    long4colheader -
    Glossary Styles - | Glossary Styles - | Glossary Styles +
    Longtable Styles + | Longtable Styles + | Longtable Styles
    long4colheaderborder -
    Glossary Styles - | Glossary Styles +
    Longtable Styles + | Longtable Styles
    longborder -
    Glossary Styles +
    Longtable Styles
    longheader -
    Glossary Styles - | Glossary Styles - | Defining your own glossary +
    Longtable Styles + | Longtable Styles + | Defining your own glossary
    longheaderborder -
    Glossary Styles +
    Longtable Styles
    super -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles + | Supertabular Styles + | Supertabular Styles
    super3col -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles + | Supertabular Styles + | Supertabular Styles
    super3colborder -
    Glossary Styles +
    Supertabular Styles
    super3colheader -
    Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles
    super3colheaderborder -
    Glossary Styles +
    Supertabular Styles
    super4col -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Glossary Styles + | Supertabular Styles + | Supertabular Styles + | Supertabular Styles + | Supertabular Styles
    super4colborder -
    Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles
    super4colheader -
    Glossary Styles - | Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles + | Supertabular Styles
    super4colheaderborder -
    Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles
    superborder -
    Glossary Styles +
    Supertabular Styles
    superheader -
    Glossary Styles - | Glossary Styles +
    Supertabular Styles + | Supertabular Styles
    superheaderborder -
    Glossary Styles +
    Supertabular Styles
    tree -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles + | Tree-Like Styles
    treegroup -
    Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles
    treehypergroup -
    Glossary Styles +
    Tree-Like Styles
    treenoname -
    Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles
    treenonamegroup -
    Glossary Styles - | Glossary Styles +
    Tree-Like Styles + | Tree-Like Styles
    treenonamehypergroup -
    Glossary Styles +
    Tree-Like Styles
    +
    glossary-hypernav +
    Defining your own glossary
    glossary-list -
    Changing the way the +
    Package Options + | Changing the way the + | List Styles
    glossary-long -
    Changing the way the +
    Package Options + | Changing the way the + | Longtable Styles
    glossary-super -
    Changing the way the +
    Package Options + | Changing the way the + | Supertabular Styles
    glossary-tree -
    Changing the way the +
    Package Options + | Changing the way the + | Tree-Like Styles
    \glossaryentryfield -
    Defining your own glossary +
    Defining your own glossary
    \glossaryentrynumbers -
    Defining your own glossary +
    Defining your own glossary
    \glossaryheader -
    Glossary Styles +
    List Styles + | Example: creating a completely
    \glossaryname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \glossarystyle -
    A Quick Guide For - | Displaying a glossary - | Glossary Styles - | Glossary Styles +
    A Quick Guide For + | Package Options + | Displaying a glossary + | Glossary Styles + | Glossary Styles
    \gls -
    Multi-Lingual Support - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Enabling and disabling hyperlinks - | Cross-Referencing Entries - | Acronyms - | Acronyms - | Unsetting and Resetting Entry +
    Multi-Lingual Support + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Enabling and disabling hyperlinks + | Cross-Referencing Entries + | Acronyms + | Acronyms + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Unsetting and Resetting Entry
    \glsadd -
    A Quick Guide For - | A Quick Guide For +
    A Quick Guide For + | A Quick Guide For
    \glsaddall -
    Sample Documents - | A Quick Guide For - | A Quick Guide For +
    Sample Documents + | A Quick Guide For + | A Quick Guide For
    \glsaddall keys
    types -
    Adding an Entry to +
    Adding an Entry to
    \GlsAddXdyAttribute -
    Links to Glossary Entries +
    Links to Glossary Entries
    \GlsAddXdyLocation -
    Locations and Number lists +
    Locations and Number lists
    \glsdefaulttype -
    Package Options - | Package Options +
    Package Options + | Package Options
    \glsdesc -
    Acronyms +
    Acronyms
    \glsdescwidth -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Longtable Styles + | Longtable Styles + | Longtable Styles + | Supertabular Styles + | Supertabular Styles + | Supertabular Styles
    \glsdisplay -
    Defining Glossary Entries - | Defining Glossary Entries +
    Defining Glossary Entries + | Defining Glossary Entries
    \glsdisplayfirst -
    Defining Glossary Entries - | Defining Glossary Entries +
    Defining Glossary Entries + | Defining Glossary Entries
    \glsentryname -
    Using Glossary Terms Without +
    Using Glossary Terms Without
    \glsfirst -
    Acronyms +
    Acronyms +
    \glsgroupheading +
    Example: creating a completely
    \glsgroupskip -
    Sample Documents - | Glossary Styles +
    Sample Documents + | Glossary Styles + | Example: creating a completely
    \glshyperlink -
    Using Glossary Terms Without +
    Using Glossary Terms Without
    \glslabel -
    Changing the format of +
    Changing the format of
    \glslink -
    A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries - | Changing the format of - | Enabling and disabling hyperlinks - | Adding an Entry to +
    A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries + | Changing the format of + | Enabling and disabling hyperlinks + | Adding an Entry to
    \glslink keys
    counter -
    Links to Glossary Entries +
    Links to Glossary Entries
    format -
    A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries - | Links to Glossary Entries - | Locations and Number lists - | Locations and Number lists +
    A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries + | Links to Glossary Entries + | Locations and Number lists + | Locations and Number lists
    hyper -
    Links to Glossary Entries - | Enabling and disabling hyperlinks - | Adding an Entry to +
    Links to Glossary Entries + | Enabling and disabling hyperlinks + | Adding an Entry to
    \glsnamefont -
    A Quick Guide For - | A Quick Guide For +
    A Quick Guide For + | A Quick Guide For
    \glsnumbersgroupname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \glspagelistwidth -
    Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
    Longtable Styles + | Longtable Styles + | Supertabular Styles + | Supertabular Styles
    \glspl -
    A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Changing the format of - | Acronyms - | Acronyms - | Unsetting and Resetting Entry +
    A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Acronyms + | Acronyms + | Unsetting and Resetting Entry
    \glspluralsuffix -
    Defining Glossary Entries - | Defining Glossary Entries +
    Defining Glossary Entries + | Defining Glossary Entries
    \glssee -
    A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries +
    Introduction + | A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries
    \glsSetCompositor -
    A Quick Guide For +
    A Quick Guide For
    \GlsSetXdyCodePage -
    Generating the Associated Glossary +
    Generating the Associated Glossary
    \GlsSetXdyLanguage -
    Generating the Associated Glossary +
    Generating the Associated Glossary
    \GlsSetXdyMinRangeLength -
    Number lists +
    Number lists
    \glssymbol -
    Acronyms +
    Acronyms
    \glssymbolsgroupname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \glstext -
    Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Acronyms - | Acronyms +
    Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Acronyms + | Acronyms
    \glstextformat -
    Changing the format of +
    Changing the format of
    html -
    A Quick Guide For - | Enabling and disabling hyperlinks +
    A Quick Guide For + | Enabling and disabling hyperlinks
    \hyperbf -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hyperemph -
    A Quick Guide For - | Links to Glossary Entries +
    A Quick Guide For + | Links to Glossary Entries
    \hyperit -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hyperlink -
    Links to Glossary Entries - | Enabling and disabling hyperlinks +
    Links to Glossary Entries + | Enabling and disabling hyperlinks
    \hypermd -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hyperpage -
    Links to Glossary Entries +
    Links to Glossary Entries
    hyperref -
    A Quick Guide For - | Number lists - | Links to Glossary Entries - | Links to Glossary Entries - | Enabling and disabling hyperlinks - | Enabling and disabling hyperlinks +
    A Quick Guide For + | Number lists + | Links to Glossary Entries + | Links to Glossary Entries + | Enabling and disabling hyperlinks + | Enabling and disabling hyperlinks + | Defining your own glossary
    \hyperrm -
    Links to Glossary Entries - | Locations and Number lists +
    Links to Glossary Entries + | Locations and Number lists
    \hypersc -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hypersf -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hypersl -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hypertarget -
    Enabling and disabling hyperlinks +
    Enabling and disabling hyperlinks
    \hypertt -
    Links to Glossary Entries +
    Links to Glossary Entries
    \hyperup -
    Links to Glossary Entries +
    Links to Glossary Entries
    \indexspace -
    Glossary Styles +
    Tree-Like Styles
    inputenc -
    Sample Documents - | Multi-Lingual Support - | A Quick Guide For - | Defining Glossary Entries - | Language and Encodings - | Mfirstuc Package +
    Sample Documents + | Multi-Lingual Support + | A Quick Guide For + | Defining Glossary Entries + | Language and Encodings + | Mfirstuc Package
    \inputencodingname -
    Language and Encodings +
    Language and Encodings
    \item -
    A Quick Guide For +
    A Quick Guide For
    \jobname -
    Defining Glossary Entries - | Defining Glossary Entries +
    Defining Glossary Entries + | Defining Glossary Entries
    link text -
    Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Changing the format of - | Changing the format of +
    Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Changing the format of + | Changing the format of
    location list
    see number list
    longtable -
    Glossary Styles -
    makeglossaries -
    Introduction - | Introduction - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Multi-Lingual Support - | Multi-Lingual Support - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Using the makeglossaries Perl - | Using the makeglossaries Perl - | Using the makeglossaries Perl - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Troubleshooting - | Troubleshooting - | Troubleshooting - | Troubleshooting - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Number lists - | Number lists - | Cross-Referencing Entries - | Displaying a glossary - | Displaying a glossary - | Language and Encodings - | Language and Encodings - | Language and Encodings - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Glossary Groups - | Glossary Groups - | Defining New Glossaries +
    Package Options + | Longtable Styles +
    \makeglossaries +
    Introduction + | Introduction + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Multi-Lingual Support + | Multi-Lingual Support + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Using the makeglossaries Perl + | Using the makeglossaries Perl + | Using the makeglossaries Perl + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Number lists + | Number lists + | Cross-Referencing Entries + | Displaying a glossary + | Displaying a glossary + | Language and Encodings + | Language and Encodings + | Language and Encodings + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Glossary Groups + | Glossary Groups + | Defining New Glossaries + | Defining New Glossaries
    makeindex -
    Introduction - | Introduction - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Multi-Lingual Support - | Multi-Lingual Support - | Changing the Fixed Names - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Using the makeglossaries Perl - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Troubleshooting - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Number lists - | Number lists - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Displaying a glossary - | Displaying a glossary - | Defining New Glossaries - | Glossary Styles +
    Introduction + | Introduction + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Multi-Lingual Support + | Multi-Lingual Support + | Changing the Fixed Names + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Using the makeglossaries Perl + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Number lists + | Number lists + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Displaying a glossary + | Displaying a glossary + | Defining New Glossaries + | Glossary Styles + | Tree-Like Styles + | Defining your own glossary
    \MakeUppercase -
    Mfirstuc Package +
    Mfirstuc Package
    mfirstuc -
    Mfirstuc Package +
    Mfirstuc Package
    \newacronym -
    Sample Documents - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Sample Documents + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Upgrading From the glossary
    \newglossary -
    Using xindy explicitly - | Using makeindex explicitly - | A Quick Guide For +
    Using xindy explicitly + | Using makeindex explicitly + | A Quick Guide For
    \newglossaryentry -
    Sample Documents - | A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries - | Links to Glossary Entries - | Acronyms +
    Sample Documents + | A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries + | Links to Glossary Entries + | Acronyms
    \newglossaryentry keys
    description -
    A Quick Guide For - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Acronyms - | Acronyms - | Acronyms +
    A Quick Guide For + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Acronyms + | Acronyms + | Acronyms
    descriptionplural -
    Defining Glossary Entries +
    Defining Glossary Entries + | Changing the format of
    first -
    Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Using Glossary Terms Without - | Acronyms - | Unsetting and Resetting Entry +
    Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Using Glossary Terms Without + | Acronyms + | Unsetting and Resetting Entry
    firstplural -
    Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Plurals - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Using Glossary Terms Without +
    Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Plurals + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Using Glossary Terms Without
    format -
    Links to Glossary Entries +
    Links to Glossary Entries
    name -
    A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Homographs - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Using Glossary Terms Without - | Acronyms - | Acronyms - | Defining your own glossary +
    A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Homographs + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Using Glossary Terms Without + | Acronyms + | Acronyms + | Defining your own glossary
    nonumberlist -
    Defining Glossary Entries +
    Defining Glossary Entries
    parent -
    A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Hierarchical Categories +
    A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Hierarchical Categories
    plural -
    A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Plurals - | Plurals - | Homographs - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Using Glossary Terms Without +
    A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Plurals + | Plurals + | Homographs + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Using Glossary Terms Without
    see -
    A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Cross-Referencing Entries - | Cross-Referencing Entries - | Cross-Referencing Entries +
    Introduction + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Cross-Referencing Entries + | Cross-Referencing Entries + | Cross-Referencing Entries
    sort -
    A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Homographs - | Acronyms - | Acronyms - | Defining your own glossary - | Defining your own glossary +
    A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Homographs + | Acronyms + | Acronyms + | Defining your own glossary + | Defining your own glossary
    symbol -
    Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Changing the format of - | Changing the format of - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Changing the format of + | Changing the format of + | Acronyms + | Acronyms + | Acronyms
    symbolplural -
    Defining Glossary Entries +
    Defining Glossary Entries + | Changing the format of
    text -
    Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Using Glossary Terms Without - | Acronyms - | Unsetting and Resetting Entry +
    Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Using Glossary Terms Without + | Acronyms + | Unsetting and Resetting Entry
    type -
    A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Loading Entries From a +
    A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Loading Entries From a
    \newglossarystyle -
    Glossary Styles +
    Glossary Styles
    \newline -
    Glossary Styles +
    Defining Glossary Entries + | Glossary Styles
    ngerman -
    Changing the Fixed Names - | Xindy +
    Changing the Fixed Names + | Xindy
    \nohyperpage -
    Number lists +
    Number lists
    \noist -
    Sample Documents - | Number lists - | Number lists - | Xindy - | Language and Encodings - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Glossary Groups +
    Sample Documents + | Number lists + | Number lists + | Xindy + | Language and Encodings + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Glossary Groups
    \nopostdesc -
    A Quick Guide For - | Hierarchical Categories - | Homographs - | Glossary Styles +
    A Quick Guide For + | Hierarchical Categories + | Homographs + | Glossary Styles
    number list -
    Sample Documents - | Sample Documents - | Generating the Associated Glossary - | A Quick Guide For - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Sub-Entries - | Homographs - | Number lists - | Links to Glossary Entries - | Cross-Referencing Entries - | Locations and Number lists - | Locations and Number lists - | Defining New Glossaries - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Example: creating a completely +
    Sample Documents + | Sample Documents + | Generating the Associated Glossary + | A Quick Guide For + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Sub-Entries + | Homographs + | Number lists + | Links to Glossary Entries + | Cross-Referencing Entries + | Locations and Number lists + | Locations and Number lists + | Defining New Glossaries + | List Styles + | List Styles + | Longtable Styles + | Longtable Styles + | Supertabular Styles + | Supertabular Styles + | Example: creating a completely +
    \oldacronym +
    Upgrading From the glossary
    package options
    acronym -
    Changing the Fixed Names - | Changing the Fixed Names - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Acronyms - | Acronyms +
    Changing the Fixed Names + | Changing the Fixed Names + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Acronyms + | Acronyms
    counter -
    Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Number lists - | Number lists +
    Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Number lists + | Number lists
    description -
    Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    dua -
    Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    footnote -
    Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    makeindex -
    Package Options - | Package Options +
    Package Options + | Package Options +
    nolist +
    Package Options + | Package Options + | List Styles + | List Styles +
    nolong +
    Package Options + | Package Options + | Glossary Styles + | Glossary Styles + | Longtable Styles + | Longtable Styles
    nonumberlist -
    A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Number lists - | Number lists - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary +
    A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Number lists + | Number lists + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary +
    nostyles +
    Package Options + | Package Options + | Glossary Styles + | Glossary Styles + | List Styles + | List Styles + | Longtable Styles + | Longtable Styles + | Supertabular Styles + | Supertabular Styles + | Tree-Like Styles + | Tree-Like Styles +
    nosuper +
    Package Options + | Package Options + | Glossary Styles + | Glossary Styles + | Supertabular Styles + | Supertabular Styles +
    notree +
    Package Options + | Package Options + | Tree-Like Styles + | Tree-Like Styles
    numberedsection -
    Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Displaying a glossary - | Displaying a glossary - | Displaying a glossary - | Displaying a glossary +
    Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Displaying a glossary + | Displaying a glossary + | Displaying a glossary + | Displaying a glossary
    autolabel -
    Package Options - | Package Options +
    Package Options + | Package Options
    false -
    Package Options +
    Package Options
    nolabel -
    Package Options +
    Package Options
    numberline -
    Package Options - | Package Options - | Package Options - | Package Options -
    order -
    Sample Documents - | Sample Documents - | Generating the Associated Glossary - | Generating the Associated Glossary +
    Package Options + | Package Options + | Package Options | Package Options - | Package Options +
    order +
    Sample Documents + | Sample Documents + | Generating the Associated Glossary + | Generating the Associated Glossary + | Package Options + | Package Options
    letter -
    Sample Documents - | Generating the Associated Glossary - | Package Options +
    Sample Documents + | Generating the Associated Glossary + | Package Options
    word -
    Sample Documents - | Generating the Associated Glossary - | Package Options +
    Sample Documents + | Generating the Associated Glossary + | Package Options
    sanitize -
    Package Options - | Package Options - | Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    description -
    Acronyms - | Acronyms +
    Acronyms + | Acronyms
    symbol -
    Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Acronyms + | Acronyms + | Acronyms + | Acronyms
    section -
    A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options +
    A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options
    shortcuts -
    Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    smallcaps -
    Troubleshooting - | Troubleshooting - | Troubleshooting - | Troubleshooting - | Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    smaller -
    Troubleshooting - | Troubleshooting - | Troubleshooting - | Troubleshooting - | Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
    Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
    style -
    A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Displaying a glossary - | Displaying a glossary - | Glossary Styles - | Glossary Styles +
    A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Displaying a glossary + | Displaying a glossary + | Glossary Styles + | Glossary Styles
    toc -
    A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Displaying a glossary - | Displaying a glossary -
    xindy -
    Sample Documents - | Sample Documents - | Multi-Lingual Support - | Multi-Lingual Support - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Using xindy explicitly - | Using xindy explicitly - | Using makeindex explicitly - | Using makeindex explicitly - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options +
    A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Xindy - | Xindy - | Glossary Groups - | Glossary Groups + | Package Options + | Displaying a glossary + | Displaying a glossary +
    xindy +
    Sample Documents + | Sample Documents + | Multi-Lingual Support + | Multi-Lingual Support + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Using xindy explicitly + | Using xindy explicitly + | Using makeindex explicitly + | Using makeindex explicitly + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Xindy + | Xindy + | Glossary Groups + | Glossary Groups
    \pagelistname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \printglossaries -
    Troubleshooting - | A Quick Guide For - | Defining Glossary Entries +
    Troubleshooting + | A Quick Guide For + | Defining Glossary Entries
    \printglossary -
    Troubleshooting - | Defining Glossary Entries - | Glossary Styles - | Glossary Styles +
    Troubleshooting + | Package Options + | Defining Glossary Entries + | Glossary Styles + | Glossary Styles
    \printglossary keys
    nonumberlist -
    Displaying a glossary +
    Displaying a glossary
    numberedsection -
    Displaying a glossary +
    Displaying a glossary
    style -
    Displaying a glossary - | Glossary Styles - | Glossary Styles +
    Package Options + | Displaying a glossary + | Glossary Styles + | Glossary Styles
    title -
    Displaying a glossary +
    Displaying a glossary
    toctitle -
    Displaying a glossary +
    Displaying a glossary
    type -
    Displaying a glossary +
    Displaying a glossary
    relsize -
    Acronyms +
    Acronyms + | Acronyms
    \seename -
    A Quick Guide For - | Cross-Referencing Entries +
    A Quick Guide For + | Cross-Referencing Entries
    \setAlphaCompositor -
    Locations and Number lists +
    Locations and Number lists
    \setCompositor -
    Locations and Number lists +
    Locations and Number lists
    \setStyleFile -
    Using xindy explicitly - | Using makeindex explicitly +
    Using xindy explicitly + | Using makeindex explicitly
    \smaller -
    Acronyms +
    Acronyms
    supertabular -
    Glossary Styles +
    Package Options + | Supertabular Styles
    \symbolname -
    Changing the Fixed Names +
    Changing the Fixed Names
    \textbf -
    Links to Glossary Entries +
    Links to Glossary Entries
    \textrm -
    Locations and Number lists +
    Locations and Number lists
    \textsc -
    Acronyms +
    Acronyms
    \thepage -
    Locations and Number lists +
    Locations and Number lists
    translator -
    Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Changing the Fixed Names - | Troubleshooting +
    Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Changing the Fixed Names + | Troubleshooting
    xindy -
    Introduction - | Introduction - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Sample Documents - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Changing the Fixed Names - | Changing the Fixed Names - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Generating the Associated Glossary - | Using the makeglossaries Perl - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Using xindy explicitly - | Troubleshooting - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Number lists - | Number lists - | Number lists - | Number lists - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Displaying a glossary - | Displaying a glossary - | Xindy - | Xindy - | Xindy - | Xindy - | Xindy - | Xindy - | Xindy - | Xindy - | Language and Encodings - | Language and Encodings - | Language and Encodings - | Language and Encodings - | Language and Encodings - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Locations and Number lists - | Defining New Glossaries - | Glossary Styles - | Defining your own glossary +
    Introduction + | Introduction + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Sample Documents + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Changing the Fixed Names + | Changing the Fixed Names + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Generating the Associated Glossary + | Using the makeglossaries Perl + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Using xindy explicitly + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Number lists + | Number lists + | Number lists + | Number lists + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Displaying a glossary + | Displaying a glossary + | Xindy + | Xindy + | Xindy + | Xindy + | Xindy + | Xindy + | Xindy + | Xindy + | Language and Encodings + | Language and Encodings + | Language and Encodings + | Language and Encodings + | Language and Encodings + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Locations and Number lists + | Defining New Glossaries + | Tree-Like Styles + | Defining your own glossary +
    xkeyval +
    Sample Documents + | Troubleshooting +
    xspace +
    Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary + | Upgrading From the glossary

    @@ -7029,89 +7696,102 @@ Index



    Footnotes

    -
    ...main.1
    -
    Actually it sets \acronymtype to -\glsdefaulttype if the acronym package option is -not used, but \glsdefaulttype usually has the value -main. +
    ... used1
    +
    that is, if the term has been +referenced using any of the commands described in Links to Glossary Entries, +Adding an Entry to the +Glossary Without Generating Text or +via \glssee (or the see key)
    -
    ...acronym...main.2
    +
    Actually it sets \acronymtype to +\glsdefaulttype if the acronym package option is +not used, but \glsdefaulttype usually has the value +main. + +
    +
    ...acronym3
    if the -acronym option is used, otherwise the list of +acronym option is used, otherwise the list of acronyms is the main glossary
    -
    ... this.3
    +
    ... this.4
    The only preamble restriction on \newglossaryentry and \newacronym was removed in version 1.13, but the restriction remains for \loadglsentries.
    -
    ... specified.4
    +
    ... specified.5
    This is because \acronymtype is set to \glsdefaulttype if -the acronym package option is not used. +the acronym package option is not used.
    -
    ... label5
    +
    ... label6
    main for the main (default) glossary, \acronymtype for the list of acronyms, or the name supplied in the first mandatory argument to \newglossary for additional glossaries.
    -
    ... hyphen6
    +
    ... hyphen7
    see -\setCompositor described in +\setCompositor described in Defining Glossary Entries
    -
    ... +
    ... hyphen7
    -
    see \setAlphaCompositor described in + HREF="glossaries-manual.html#tex2html23">8 +
    see \setAlphaCompositor described in Defining Glossary Entries
    -
    ...smaller,8
    -
    you will need to load a -package, such as relsize, that defines \smaller if you use -this option. +
    ...smaller,9
    +
    you will need to load +a package, such as relsize, that defines \smaller if you +use this option. + +
    +
    ... package10
    +
    as from version 1.18
    -
    ... start.9
    -
    This style was -supplied by Axel Menzel. +
    ... column.11
    +
    these lengths will not be +available if you use both the nolong and nosuper +package options or if you use the nostyles package option.
    -
    ... -link10
    -
    if the document doesn't have hyperlinks enabled -\@glslink ignores the label and simply typesets the text. +
    ... +environment.12
    +
    This style was supplied by Axel Menzel.
    -
    ... correctly.11
    -
    again, if the -document doesn't support hyperlinks, \@glstarget will ignore -the label, and just typeset the text. +
    ...supertabular.13
    +
    e.g. with the flowfram +package.
    -
    ...MakeTextUppercase,12
    +
    ...MakeTextUppercase,14
    defined in the textcase package diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex index 55746a63862..1eb073f2961 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex @@ -1,6 +1,7 @@ \documentclass[a4paper]{ltxdoc} \usepackage{ifthen} \usepackage{alltt} +\usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage[colorlinks, @@ -25,7 +26,7 @@ \makeatother \RecordChanges \PageIndex -\CheckSum{7758} +\CheckSum{7872} \CodelineNumbered \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}} \newcommand*{\term}[1]{#1\iterm{#1}} @@ -45,6 +46,7 @@ }{\end{minipage}\end{lrbox}% \par\vskip10pt\noindent \fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} +\newcommand*{\tick}{\ding{51}} } { \usepackage{html} @@ -58,10 +60,17 @@ \newcommand*{\tableref}[1]{\htmlref{table~}{#1}\ref{#1}} \newcommand*{\Tableref}[1]{\htmlref{Table~}{#1}\ref{#1}} \newenvironment{important}{}{} +\newcommand*{\tick}{X} } +\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*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}} \newcommand*{\ics}[1]{\texttt{\char`\\#1}\SpecialMainIndex{#1}} @@ -88,6 +97,8 @@ \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}}} @@ -119,7 +130,7 @@ \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{glossaries.sty v 1.17: \LaTeXe\ Package to Assist Generating Glossaries} + \title{glossaries.sty v 1.18: \LaTeXe\ Package to Assist Generating Glossaries} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -127,7 +138,7 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{26th December 2008} + \date{14th January 2009} \maketitle \tableofcontents @@ -139,8 +150,14 @@ 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 -where only those terms used in the text are added to the 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 +added to the glossary. \textbf{This package replaces the \isty{glossary} package which is now obsolete. Please see the file @@ -171,8 +188,8 @@ The Impatient}}{sec:quick}} is for people who want a few quick pointers of how to get started creating a basic glossary, without having to read through lengthy descriptions. -\item \ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview}{sec:overview}} -gives an overview of available commands and their syntax. +\item \ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview of 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. @@ -217,7 +234,7 @@ according to your operating system and \TeX\ distribution. The sample documents are as follows: \begin{description} -\item[minimalgls.tex] This document is a minimal working example. +\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} @@ -232,6 +249,12 @@ latex minimalgls PDF\LaTeX\ you will also get warnings about non-existent 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 + 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} + package. + \item Run \appname{makeglossaries} on the document. This can be done on a terminal by either typing \begin{verbatim} @@ -263,7 +286,7 @@ 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] This document illustrates a four column +\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: @@ -282,9 +305,9 @@ style has been set: \renewcommand*{\glsgroupskip}{} \end{verbatim} -\item[sampleAcr.tex] This document has some sample acronyms. It +\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: +run through \LaTeX\ is required to ensure the document is up to date: \begin{verbatim} latex sampleAcr makeglossaries sampleAcr @@ -292,7 +315,7 @@ latex sampleAcr latex sampleAcr \end{verbatim} -\item[sampleAcrDesc.tex] This is similar to the previous example, +\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: @@ -303,7 +326,7 @@ latex sampleAcrDesc latex sampleAcrDesc \end{verbatim} -\item[sampleDesc.tex] This is similar to the previous example, +\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 @@ -315,8 +338,8 @@ latex sampleDesc latex sampleDesc \end{verbatim} -\item[sampleDB.tex] This document illustrates how to load -an external files containing the glossary definitions. It also +\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 @@ -326,10 +349,11 @@ latex sampleDB makeglossaries sampleDB latex sampleDB \end{verbatim} -The glossary definitions are stored in the files +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 using \appname{makeglossaries}: +\appname{makeindex} twice instead of a single call to +\appname{makeglossaries}: \begin{enumerate} \item Create the main glossary: \begin{verbatim} @@ -341,7 +365,7 @@ makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn \end{verbatim} \end{enumerate} -\item[sampleEq.tex] This document illustrates how to change the +\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 @@ -352,7 +376,7 @@ makeglossaries sampleEq latex sampleEq \end{verbatim} -\item[sampleEqPg.tex] This is similar to the previous example, +\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: @@ -363,7 +387,7 @@ latex sampleEqPg latex sampleEqPg \end{verbatim} -\item[sampleSec.tex] This document also illustrates how to change +\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 @@ -375,7 +399,7 @@ latex sampleSec latex sampleSec \end{verbatim} -\item[sampleNtn.tex] This document illustrates how to create +\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} @@ -385,7 +409,8 @@ latex sampleNtn latex sampleNtn \end{verbatim} Note that if you don't have Perl installed, you will need to use -\appname{makeindex} twice instead of using \appname{makeglossaries}: +\appname{makeindex} twice instead of a single call to +\appname{makeglossaries}: \begin{enumerate} \item Create the main glossary: \begin{verbatim} @@ -397,7 +422,7 @@ makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn \end{verbatim} \end{enumerate} -\item[sample.tex] This document illustrates some of the basics, +\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: @@ -414,7 +439,7 @@ 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] This document illustrates a hierarchical +\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} @@ -423,7 +448,7 @@ makeglossaries sampletree latex sampletree \end{verbatim} -\item[samplexdy.tex] This document illustrates how to use the +\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 @@ -466,7 +491,7 @@ xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo \end{verbatim} -\item[sampleutf8.tex] This is another example that uses +\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: @@ -483,7 +508,8 @@ xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo \end{verbatim} -If you remove the \pkgopt{xindy} option and do: +If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} +and do: \begin{verbatim} latex sampleutf8 makeglossaries sampleutf8 @@ -602,8 +628,8 @@ glossaries package are listed in \tableref{tab:predefinednames}. \label{tab:predefinednames} \begin{center} \begin{tabular}{@{}llp{0.4\linewidth}@{}} -\bfseries Command Name & \bfseries Translator key word & -\bfseries What it's for\\ +\bfseries Command Name & \bfseries Translator Key Word & +\bfseries Purpose\\ \ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\\ \ics{acronymname} & \texttt{Acronyms} & Title of the list of acronyms (when used with package option \pkgopt{acronym}).\\ @@ -692,7 +718,7 @@ explicitly}{sec:xindyapp}}), otherwise you will need to use explicitly}{sec:makeindexapp}}). Note that some commands and package options have no effect if you don't use \appname{makeglossaries}. These are listed in -Table~\ref{tab:makeglossariesCmds}. +\tableref{tab:makeglossariesCmds}. Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to @@ -805,7 +831,8 @@ files, you must make sure you have used the \usepackage[xindy]{glossaries} \end{verbatim} This is required regardless of whether you use \appname{xindy} -explicitly or via \appname{makeglossaries}. This causes the glossary +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 use \texttt{-I xindy} \emph{not} \texttt{-I tex}. @@ -817,14 +844,15 @@ xindy -L \textrm{\meta{language}} -C \textrm{\meta{encoding}} -I xindy -o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo \end{ttfamily} \\[10pt] -where \meta{language} is 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. 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. If any of the file names contain spaces, -you must delimit them using double-quotes. +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. +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 +directory. If any of the file names contain spaces, you must delimit +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 @@ -855,7 +883,7 @@ makeglossaries myDoc 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 -Table~\ref{tab:makeglossariesCmds}. +\tableref{tab:makeglossariesCmds}. \ifmakedtx{}{\toTop} \subsubsection{Using makeindex explicitly} @@ -906,7 +934,7 @@ makeglossaries myDoc 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 -Table~\ref{tab:makeglossariesCmds}. +\tableref{tab:makeglossariesCmds}. \ifmakedtx{}{\toTop} \subsection{Troubleshooting} @@ -927,17 +955,25 @@ other queries, consult the \sty{glossaries} FAQ at \url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. \begin{enumerate} -\item I've used the \pkgopt{smallcaps} option, but the acronyms +\item \textbf{Q.} I get the error message: +\begin{verbatim} +Missing \begin{document} +\end{verbatim} + +\textbf{A.} Check you are using an up to date version of the \isty{xkeyval} +package. + +\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms are displayed in normal sized upper case letters. -The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset +\textbf{A.} The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset the acronyms. This command converts lower case letters to small capitals, while upper case letters remain their usual size. Therefore you need to specify the acronym in lower case letters. -\item How do I change the font that the acronyms are displayed in? +\item \textbf{Q.} How do I change the font that the acronyms are displayed in? -The easiest way to do this is to specify the \pkgopt{smaller} package +\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package option and redefine \cs{acronymfont} to use the required typesetting command. For example, suppose you would like the acronyms displayed in a sans-serif font, then you can do: @@ -946,44 +982,47 @@ a sans-serif font, then you can do: \renewcommand*{\acronymfont}[1]{\textsf{#1}} \end{verbatim} -\item How do I change the font that the acronyms are displayed in -on first use? +\item \textbf{Q.} How do I change the font that the acronyms are displayed in +on \firstuse? -The easiest way to do this is to specify the \pkgopt{smaller} package +\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package option and redefine \cs{firstacronymfont} to use the required command. Note that if you don't want the acronym on subsequent use to use \cs{smaller}, you will also need to redefine \cs{acronymfont}, -as above. For example to make the acronym emphasized on first use, -but use the surrounding font for subsequent use, you can do: +as above. For example to make the acronym emphasized on +\firstuse, but use the surrounding font for subsequent use, you can do: \begin{verbatim} \usepackage[smaller]{glossaries} \renewcommand*{\firstacronymfont}[1]{\emph{#1}} \renewcommand*{\acronymfont}[1]{#1} \end{verbatim} -\item I don't have Perl installed, do I have to use +\item \textbf{Q.} I don't have Perl installed, do I have to use \appname{makeglossaries}? -Read \ifmakedtx{\autoref{sec:xindyapp}}{\htmlref{Using +\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}. -\item I'm used to using the \sty{glossary} package: are there any +\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? -Read \ifmakedtx{the file \texttt{glossary2glossaries.pdf}}{\htmladdnormallink{Upgrading +\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 I'm using \isty{babel} but the fixed names haven't been +\item \textbf{Q.} I'm using \isty{babel} but the fixed names haven't been translated. -The \sty{glossaries} package currently only supports the following +\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 @@ -1002,9 +1041,9 @@ Alternatively, you can add the language as a global option to the class file. Check the \sty{translator} package documentation for further details. -\item My glossaries haven't appeared. +\item \textbf{Q.} My glossaries haven't appeared. -Remember to do the following: +\textbf{A.} Remember to do the following: \begin{itemize} \item Add \ics{makeglossaries} to the document preamble. @@ -1016,8 +1055,8 @@ been defined or \ics{printglossaries}. Entries}{sec:glslink}}, \ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an Entry to the Glossary Without Generating Text}{sec:glsadd}} or -\ifmakedtx{\autoref{sec:glssee}}{\htmlref{Cross-Referencing -Entries}{sec:glssee}} for each entry +\ifmakedtx{\autoref{sec:crossref}}{\htmlref{Cross-Referencing +Entries}{sec:crossref}} for each entry that you want to appear in the glossary. \item Run \LaTeX\ on your document, then run \appname{makeglossaries}, @@ -1331,7 +1370,7 @@ plural=matrices} In this example, the entry name appears as \dq{Matrix} in the glossary, and either \dq{matrix} or \dq{matrices} in the text. -\item The way the term appears on first use can be different +\item The way the term appears on \firstuse\ can be different to the way it appears subsequently: \begin{verbatim} \newglossaryentry{singmtx}{name=Singular Matrix, @@ -1546,7 +1585,7 @@ appear in unnumbered subsections: \end{enumerate}\ifmakedtx{}{\toTop} -\section{Overview}\label{sec:overview} +\section{Overview of User Commands}\label{sec:overview} \changes{1.02}{2007 May 25}{added overview section} \subsection{Package Options} @@ -1566,7 +1605,7 @@ used without \pkgopt{numberline}, the title will be aligned with the section numbers rather than the section titles. \item[\pkgopt{acronym}] This creates a new glossary with the -label \texttt{acronym}: +label \texttt{acronym}. This is equivalent to: \begin{verbatim} \newglossary[alg]{acronym}{acr}{acn}{\acronymname} \end{verbatim} @@ -1575,9 +1614,10 @@ is set to \texttt{acronym} otherwise it is set to \texttt{main}.\footnote{Actually it sets \ics{acronymtype} to \ics{glsdefaulttype} if the \pkgopt{acronym} package option is not used, but \ics{glsdefaulttype} usually has the value -\texttt{main}.} +\texttt{main}.} Entries that are defined using \ics{newacronym} are placed in -the glossary whose label is given by \ics{acronymtype}. +the glossary whose label is given by \ics{acronymtype}, unless +another glossary is explicitly specified. \item[\pkgopt{section}] This is a \meta{key}=\meta{value} option. Its value should be the name of a sectional unit (e.g.\ chapter). @@ -1655,6 +1695,44 @@ The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. 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}}. +\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 +you use this option, you won't be able to use any of the +glossary styles defined in the \sty{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 +you use this option, you won't be able to use any of the +glossary styles defined in the \sty{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 +you use this option, you won't be able to use any of the +glossary styles defined in the \sty{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 +you use this option, you won't be able to use any of the +glossary styles defined in the \sty{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 +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 +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}}). @@ -1733,7 +1811,7 @@ 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 key=value comma-separated list to override +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} @@ -1764,8 +1842,10 @@ only preamble restriction on \cs{newglossaryentry} and \cs{newacronym} was removed in version 1.13, but the restriction remains for \cs{loadglsentries}.} However only those entries that occur in the document -(using any of the commands described in \ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary Entries}{sec:glslink}} and -\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}}) will appear in the glossary. Each time an entry +(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 corresponding \filetype{.gls} file which contains the typeset @@ -1864,7 +1944,9 @@ 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}. However, note that not all glossary styles support multi-line -descriptions. +descriptions. If you are using one of the tabular-like glossary +styles that permit multi-line descriptions, use \ics{newline} +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. @@ -1881,7 +1963,7 @@ when using \ics{gls} (or one of its uppercase variants). If this field is omitted, the value of the \gloskey{name} key is used. \item[{\gloskey{first}}] How the entry will appear in the document text -the first time it is used with \ics{gls} (or one of its uppercase +the first time it is used with \ics{gls}\ifirstusetext\ (or one of its uppercase variants). If this field is omitted, the value of the \gloskey{text} key is used. @@ -1889,9 +1971,11 @@ key is used. 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}. \item[{\gloskey{firstplural}}] How the entry will appear in the -document text the first time it is used with \ics{glspl} (or one of its +document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its uppercase variants). If this field is omitted, the value is obtained from the \gloskey{plural} key, if the \gloskey{first} key is omitted, or by appending \ics{glspluralsuffix} to the value of the @@ -1964,7 +2048,8 @@ 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 \dq{s}. For example: +the singular form. This command defaults to the letter \dq{s}. +For example: \begin{verbatim} \newglossaryentry{cow}{name=cow,description={a fully grown female of any bovine animal}} @@ -2034,11 +2119,9 @@ are divided into Greek letters and Roman letters. Then I can define the categories as follows: \begin{verbatim} \newglossaryentry{greekletter}{name={Greek letters}, -text={Greek letter}, description={\nopostdesc}} \newglossaryentry{romanletter}{name={Roman letters}, -text={Roman letter}, description={\nopostdesc}} \end{verbatim} @@ -2117,7 +2200,7 @@ parent=bravo} \DescribeMacro{\loadglsentries} You can store all your glossary entry definitions in another -file, and use:\\[10pt] +file and use:\\[10pt] \cs{loadglsentries}\oarg{type}\marg{filename}\\[10pt] where \meta{filename} is the name of the file containing all the \cs{newglossaryentry} commands. The optional argument @@ -2210,7 +2293,7 @@ Note that \cs{GlsSetXdyMinRangeLength} must be used before \end{important} With both \appname{makeindex} and \appname{xindy}, you can replace -separator and the closing number in the range using:\\[10pt] +the separator and the closing number in the range using:\\[10pt] \DescribeMacro{\glsSetSuffixF}\cs{glsSetSuffixF}\marg{suffix}\\ \DescribeMacro{\glsSetSuffixFF}\cs{glsSetSuffixFF}\marg{suffix}\\[10pt] where the former command specifies the suffix to use for a 2 page @@ -2285,6 +2368,14 @@ font, do: \renewcommand*{\glstextformat}[1]{\textsf{#1}} \end{verbatim} +Each entry has an associated conditional referred to as the +\firstuseflag. This determines whether \ics{gls}, +\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 +commands that unset or reset this conditional. + \DescribeMacro{\glslink} The command:\\[10pt] \cs{glslink}\oarg{options}\marg{label}\marg{text}\\[10pt] @@ -2318,13 +2409,14 @@ and use that command. In this document, the standard formats refer to the standard text block commands such as \ics{textbf} or \ics{emph} or any of the -commands listed in Table~\ref{tab:hyperxx}. +commands listed in \tableref{tab:hyperxx}. \begin{important} If you use \appname{xindy} instead of \appname{makeindex}, you must specify any non-standard formats that you want to use with the \gloskey[glslink]{format} key using -\ics{GlsAddXdyAttribute}\marg{name}. For example +\ics{GlsAddXdyAttribute}\marg{name}. So if you use +\appname{xindy} with the above example, you would need to add: \begin{verbatim} \GlsAddXdyAttribute{textbfem} \end{verbatim} @@ -2341,7 +2433,7 @@ 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 -formats listed in Table~\ref{tab:hyperxx}. +formats listed in \tableref{tab:hyperxx}. \begin{table}[htbp] \caption{Predefined Hyperlinked Location Formats} @@ -2375,7 +2467,7 @@ command called, say, \cs{hyperbsf}: \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:printglos}.)}{} +key.\ifmakedtx{ (See also \autoref{sec:code:printglos}.)}{} Remember that if you use \appname{xindy}, you will need to add this to the list of location attributes: \begin{verbatim} @@ -2407,9 +2499,9 @@ is the same as \cs{glslink}, except that the \term{link text} is determined from the values of the \gloskey{text} and \gloskey{first} keys supplied when the entry was defined using \ics{newglossaryentry}. If the entry has been marked as having -been used, the value of the \gloskey{text} key will be used, otherwise +been used\ifirstuseflag, the value of the \gloskey{text} key will be used, otherwise the value of the \gloskey{first} key will be used. -On completion, \cs{gls} will mark the entry given by \meta{label} as +On completion, \cs{gls} will mark the entry's first use flag\ifirstuseflag\ as used. There are two uppercase variants:\\[10pt] @@ -2418,7 +2510,7 @@ There are two uppercase variants:\\[10pt] and\\[10pt] \DescribeMacro{\GLS} \cs{GLS}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -which make the first letter of the link or all the link text +which make the first letter of the link text or all the link text uppercase, respectively. The final optional argument \meta{insert}, allows you to insert @@ -2447,8 +2539,9 @@ a starred version that disable the hyperlink. \DescribeMacro{\glstext}The command:\\[10pt] \cs{glstext}\oarg{options}\marg{label}\oarg{insert}\\[10pt] is similar to \ics{gls} except that it always uses the value -of the \gloskey{text} key and does not mark the entry as -having been used. Unlike \cs{gls}, the inserted text \meta{insert} +of the \gloskey{text} key and does not affect the +\firstuseflag. +Unlike \cs{gls}, the inserted text \meta{insert} is always appended to the link text. There are also analogous commands:\\[10pt] @@ -2463,8 +2556,8 @@ the hyperlink. \cs{glsfirst}\oarg{options}\marg{label}\oarg{insert}\\[10pt] is similar to \ics{glstext} except that it always uses the value of the \gloskey{first} key. Again, \meta{insert} is always appended -to the end of the link text and does not mark the entry as having -been used. +to the end of the link text and does not affect the +\firstuseflag. There are also analogous commands:\\[10pt] \DescribeMacro{\Glsfirst} @@ -2567,15 +2660,16 @@ the hyperlink. The format of the \term{link text} for \ics{gls}, \ics{glspl} and their uppercase variants is governed by two commands: \DescribeMacro{\glsdisplayfirst}\cs{glsdisplayfirst}, which is used the -first time a glossary entry is used in the text and +first time a glossary entry is used\ifirstuse\ in the text and \DescribeMacro{\glsdisplay}\cs{glsdisplay}, which is used subsequently. Both commands take four arguments: the first is either the singular or plural form given by the \gloskey{text}, \gloskey{plural}, -\gloskey{first} or \gloskey{firstplural} keys (used when the term was +\gloskey{first} or \gloskey{firstplural} keys (set when the term was defined) depending on context; the second argument is the term's -description (as supplied by the \gloskey{description} key); the third +description (as supplied by the \gloskey{description} or +\gloskey{descriptionplural} keys); the third argument is the symbol associated with the term (as supplied by the -\gloskey{symbol} key) and the fourth argument is the additional text +\gloskey{symbol} or \gloskey{symbolplural} keys) and the fourth argument is the additional text supplied in the final optional argument to \cs{gls} or \cs{glspl} (or their uppercase variants). The default definitions of \cs{glsdisplay} and \cs{glsdisplayfirst} simply @@ -2600,7 +2694,7 @@ description={The length between two points}, symbol={km}} \end{verbatim} and now suppose you want \verb|\gls{distance}| to produce -\dq{distance (km)} on first use, then you can redefine +\dq{distance (km)} on \firstuse, then you can redefine \cs{glsdisplayfirst} as follows: \begin{verbatim} \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} @@ -2609,7 +2703,7 @@ 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 -the two points} --- but in this instance it may be better not to +the two points} --- but in this instance it would be better not to use a contraction). Note also that all of the \term{link text} will be formatted according @@ -2625,9 +2719,11 @@ If you have multiple glossaries, changing \cs{glsdisplayfirst} and glossaries appear when using the commands \cs{gls}, \cs{glspl} and their uppercase variants. If you only want the change to affect entries for a given glossary, then you need -to use \DescribeMacro{\defglsdisplay}\cs{defglsdisplay} and -\DescribeMacro{\defglsdisplayfirst}\cs{defglsdisplayfirst} instead -of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}. +to use\\[10pt] +\DescribeMacro{\defglsdisplay}\cs{defglsdisplay}\oarg{type}\marg{definition}\\[10pt] +and\\[10pt] +\DescribeMacro{\defglsdisplayfirst}\cs{defglsdisplayfirst}\oarg{type}\marg{definition}\\[10pt] +instead of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}. Both \cs{defglsdisplay} and \cs{defglsdisplayfirst} take two arguments: the first (which is optional) is the glossary's label\footnote{\texttt{main} for the main @@ -2640,7 +2736,7 @@ 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 first use so that it includes the symbol, you can +displayed on \firstuse\ so that it includes the symbol, you can do: \begin{verbatim} \defglsdisplayfirst[notation]{#1#4 (denoted #3)} @@ -2790,8 +2886,7 @@ default text for the \dq{see} tag is given by \ics{seename}. 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 flag that determines if the term has been -used and, apart from \ics{glshyperlink}, they don't produce +they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce hyperlinks. \par\vskip10pt\noindent \DescribeMacro{\glsentryname}\cs{glsentryname}\marg{label}\\ @@ -2814,13 +2909,13 @@ entry given by \meta{label}, as specified by the \gloskey{plural} key. \par\vskip10pt\noindent \DescribeMacro{\glsentryfirst}\cs{glsentryfirst}\marg{label}\\ \DescribeMacro{\Glsentryfirst}\cs{Glsentryfirst}\marg{label}\par\vskip10pt\noindent -These commands display the first use text for the glossary entry +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. \par\vskip10pt\noindent \DescribeMacro{\glsentryfirstplural}\cs{glsentryfirstplural}\marg{label}\\ \DescribeMacro{\Glsentryfirstplural}\cs{Glsentryfirstplural}\marg{label}\par\vskip10pt\noindent -These commands display the plural form of the first use text for the +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. @@ -3118,7 +3213,7 @@ do this. You can redefine \ics{thepage} as follows: \renewcommand*{\thepage}{\Numberstring{page}} \end{verbatim} This gets expanded to \verb|\protect \Numberstringnum |\marg{n} -where \meta{n} is the page number. This means that you need to +where \meta{n} is the Arabic page number. This means that you need to define a new location that has that form: \begin{verbatim} \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space @@ -3158,8 +3253,9 @@ user defined location names (as specified by \texttt{see} (cross-referenced entries). This ordering can be changed using:\\[10pt] \DescribeMacro{\GlsSetXdyLocationClassOrder} -\cs{GlsSetXdyLocationClassOrder}\\[10pt] -where each location name is delimited by double quote marks. +\cs{GlsSetXdyLocationClassOrder}\marg{location names}\\[10pt] +where each location name is delimited by double quote marks and +separated by white space. For example: \begin{verbatim} \GlsSetXdyLocationClassOrder{ @@ -3264,15 +3360,20 @@ can identify the list of acronyms by the command \DescribeMacro{\acronymtype}\cs{acronymtype} which is set to \texttt{acronym}, if the \pkgopt{acronym} option has been used, otherwise it is set to \texttt{main}. + +\begin{important} +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} \DescribeMacro{\newacronym} -As you may have noticed in \ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary Entries}{sec:newglosentry}}, when you +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 in the document. This provides a useful +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:\\[10pt] \cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt] @@ -3320,7 +3421,7 @@ plural={IDNs}, firstplural={identification numbers (IDNs)}} \end{verbatim} so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on -first use and \dq{IDN} on subsequent uses. +\firstuse\ and \dq{IDN} on subsequent uses. This section describes acronyms that have been defined using \cs{newacronym}. If you prefer to define all your acronyms using @@ -3333,37 +3434,44 @@ formats as well as the way that the link text is displayed (see 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 -\cs{newacronym}. - - -\Tableref{tab:acronymsettings} lists the package options and how the -\ics{newglossaryentry} keys are used to store \meta{long} (the long -form) and \meta{abbrv} (the short form). Note that the -\pkgopt{smallcaps} option redefines -\DescribeMacro{\acronymfont}\cs{acronymfont} so that it sets its -argument using \cs{textsc} (so you should use lower case characters in -\meta{abbrv}) and the \pkgopt{smaller} option redefines -\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load a -package, such as \sty{relsize}, that defines \cs{smaller} if you use -this option.} otherwise \cs{acronymfont} simply displays its argument -in the surrounding font. Note also that if none of the package options -\pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{dua}, -\pkgopt{description} or \pkgopt{footnote} are used, \cs{acronymfont} is -not used, so changing the definition of \cs{acronymfont} will have no -effect under such circumstances. - -If you want to display the acronym in another font, for example, -emphasized, then use the \pkgopt{smaller} package option and -redefine \ics{acronymfont} to use the required font. For example: +\ics{newacronym}. + +If you use any of the package options \pkgopt{smallcaps}, +\pkgopt{smaller}, \pkgopt{description} or +\pkgopt{footnote}, the acronyms will be displayed in the document +using:\\[10pt] +\DescribeMacro{\acronymfont}\cs{acronymfont}\marg{text}\\[10pt] +and\\[10pt] +\DescribeMacro{\firstacronymfont}\cs{firstacronymfont}\marg{text}\\[10pt] +where \cs{firstacronymfont} is applied on \firstuse\ and +\cs{acronymfont} is applied on subsequent use. Note that if you +don't use any of the above package options, changing the +definition of \cs{acronymfont} or \cs{firstacronymfont} will have +no effect. In this case, the recommended route is to use +the \pkgopt{smaller} package option and redefine \cs{acronymfont} +and \cs{firstacronymfont} as required. For example, if you want +acronyms in a normal font on first use and emphasized on +subsequent use, do: \begin{verbatim} \usepackage[smaller]{glossaries} +\renewcommand*{\firstacronymfont}[1]{#1} \renewcommand*{\acronymfont}[1]{\emph{#1}} \end{verbatim} -Where \cs{acronymfont} is available, -\DescribeMacro{\firstacronymfont}\cs{firstacronymfont} is also -available. By default, this simply uses \cs{acronymfont}, but it -can be redefined to change the way the acronym is displayed on -first use. +(Note that it is for this reason that the \isty{relsize} package +is not automatically loaded when selecting the +\pkgopt{smaller} package option.) + +\Tableref{tab:acronymsettings} lists the package options that govern +the acronym styles and how the \ics{newglossaryentry} keys are used +to store \meta{long} (the long form) and \meta{abbrv} (the short +form). Note that the \pkgopt{smallcaps} option redefines +\cs{acronymfont} so that it sets its +argument using \cs{textsc} (so you should use lower case characters +in \meta{abbrv}) and the \pkgopt{smaller} option redefines +\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load +a package, such as \sty{relsize}, that defines \cs{smaller} if you +use this option.} otherwise \cs{acronymfont} simply displays its +argument in the surrounding font. \begin{table}[htbp] \caption{Package options governing \cs{newacronym} and how the @@ -3438,7 +3546,7 @@ to override the defaults. For example: \newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal matrix} \end{verbatim} -If the first use uses the plural form, \verb|\glspl{dm}| will +If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will display: diagonal matrices (DMs). Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, @@ -3454,7 +3562,7 @@ glossary type. \begin{description} \item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} -When these two package options are used together, the first use displays +When these two package options are used together, the \firstuse\ displays the entry as:\\[10pt] \cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} \\[10pt] @@ -3479,7 +3587,7 @@ remember to protect fragile commands when defining acronyms. \item[\pkgopt{dua}]\ifmakedtx{\mbox{}\par}{} 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 first use and subsequent use displays the +\pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the entry in the form:\\[10pt] \meta{long}\meta{insert}\\[10pt] If the \pkgopt{description} package option is also used, the @@ -3497,7 +3605,7 @@ 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 first use as:\\[10pt] +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] @@ -3526,7 +3634,7 @@ 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 first use as:\\[10pt] +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] @@ -3537,15 +3645,15 @@ package additionally implements the option \ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so remember to protect fragile commands when defining acronyms. -Note that on first use, it is the long form in the footnote that +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 first use have the hyperlink instead of the footnote, but +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 first use to make the +The code required to change the \firstuse\ to make the acronym a hyperlink is as follows: \begin{verbatim} \defglsdisplayfirst[\acronymtype]{% @@ -3557,12 +3665,12 @@ acronym a hyperlink is as follows: (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} +(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}{} If neither the \pkgopt{footnote} nor \pkgopt{description} options -have been set, this option displays the entry on first use as:\\[10pt] +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] @@ -3582,7 +3690,7 @@ remember to protect fragile commands when defining acronyms. \item[\pkgopt{smaller}]\ifmakedtx{\mbox{}\par}{} If neither the \pkgopt{footnote} nor \pkgopt{description} options -have been set, this option displays the entry on first use as:\\[10pt] +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] @@ -3603,7 +3711,7 @@ remember to protect fragile commands when defining acronyms. \item[None of the above]\ifmakedtx{\mbox{}\par}{} If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, -then on first use the entry is displayed as:\\[10pt] +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] @@ -3626,7 +3734,7 @@ as follows: \cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\ \DescribeMacro{\ACRshort} \cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -Print the abbreviated version with a hyperlink (if necessary) to the +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}. @@ -3637,7 +3745,7 @@ put the link text within the argument to \ics{acronymfont}. \cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\ \DescribeMacro{\ACRlong} \cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -Print the long version with a hyperlink (if necessary) to the +Print the long version with (if required) a hyperlink to the relevant entry in the glossary. This is may be equivalent to \ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase variants), depending on package options. @@ -3649,7 +3757,7 @@ variants), depending on package options. \DescribeMacro{\ACRfull} \cs{ACRfull}\oarg{options}\marg{label}\oarg{insert}\\[10pt] Print the long version followed by the abbreviation in brackets -with a hyperlink (if necessary) to the +with (if required) a hyperlink to the relevant entry in the glossary. Note that if you change the definition of \ics{newacronym}, you @@ -3692,12 +3800,88 @@ produce all upper case text. \ifmakedtx{}{\toTop} +\subsubsection{Upgrading From the glossary Package} +Users of the obsolete \isty{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 +\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 \isty{glossaries} package\footnote{as from version 1.18} +provides the command:\\[10pt] +\DescribeMacro{\oldacronym}\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list}\\[10pt] +This uses the same syntax as the \isty{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 +\cs{}\meta{label}, which is equivalent to \ics{gls}\marg{label}, +and \cs{}\meta{label}\texttt{*}, which is equivalent to +\ics{Gls}\marg{label}. If \meta{label} is omitted, \meta{abbrv} +is used. Since commands names must consist only of alphabetical +characters, \meta{label} must also only consist of alphabetical +characters. Note that \cs{}\meta{label} doesn't allow you to use +the first optional argument of \ics{gls} or \ics{Gls} --- you will +need to explicitly use \ics{gls} or \ics{Gls} to change the +settings. + +\begin{important} +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. +\end{important} + +The \isty{glossaries} package doesn't load the \isty{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 +\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 +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 +follows: +\begin{verbatim} +\oldacronym{abc}{example acronym}{} +\end{verbatim} +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 +optional argument from being recognised. + +\begin{table}[htbp] +\caption[The effect of using xspace]{The effect of using +\sty{xspace} with \cs{oldacronym}} +\label{tab:xspace} +\vskip\baselineskip +\centering +\begin{tabular}{lll} +\bfseries Code & \bfseries With \sty{xspace} & +\bfseries Without \sty{xspace}\\ +\verb|\abc.| & abc. & abc.\\ +\verb|\abc xyz| & abc xyz & abcxyz\\ +\verb|\abc\ xyz| & abc xyz & abc xyz\\ +\verb|\abc* xyz| & Abc xyz & Abc xyz\\ +\verb|\abc['s] xyz| & abc ['s] xyz & abc's xyz +\end{tabular} +\par +\end{table} + +\ifmakedtx{}{\toTop} + \subsection{Unsetting and Resetting Entry Flags} +\label{sec:glsunset} When using \ics{gls}, \ics{glspl} and their uppercase variants it is possible that you may want to use the value given by the \gloskey{first} key, even though you have already used the glossary -entry. Conversely, you may want to use the value given by the +entry\ifirstuse. Conversely, you may want to use the value given by the \gloskey{text} key, even though you haven't used the glossary entry. The former can be achieved by one of the following commands:\\[10pt] \DescribeMacro{\glsreset}\cs{glsreset}\marg{label}\\ @@ -3706,7 +3890,21 @@ while the latter can be achieved by one of the following commands:\\[10pt] \DescribeMacro{\glsunset}\cs{glsunset}\marg{label}\\ \DescribeMacro{\glslocalunset}\cs{glslocalunset}\marg{label} \\[10pt] -You can determine whether an entry has been used using:\\[10pt] +You can also reset or unset all entries for a given glossary or list of +glossaries using:\\[10pt] +\DescribeMacro{\glsresetall}\cs{glsresetall}\oarg{glossary list}\\ +\DescribeMacro{\glslocalresetall}\cs{glslocalresetall}\oarg{glossary list}\\ +\DescribeMacro{\glsunsetall}\cs{glsunsetall}\oarg{glossary list}\\ +\DescribeMacro{\glslocalunsetall}\cs{glslocalunsetall}\oarg{glossary list}\\[10pt] +where \meta{glossary list} 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: +\begin{verbatim} +\glsresetall[main,acronym] +\end{verbatim} + +You can determine whether an entry's first use flag is set using:\\[10pt] \DescribeMacro{\ifglsused} \cs{ifglsused}\marg{label}\marg{true part}\marg{false part}\\[10pt] where \meta{label} is the label of the required entry. If the @@ -3723,8 +3921,115 @@ 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. -The predefined styles are as follows: +that suits your type of glossary. See \tableref{tab:styles} for +a summary of the available styles. + +\begin{table}[htbp] +\caption[Glossary Styles]{Glossary Styles. An asterisk in the style +name indicates anything that matches that doesn't match any +previously listed style (e.g.\ \texttt{long3col*} +matches \glostyle{long3col}, \glostyle{long3colheader}, +\glostyle{long3colborder} and \glostyle{long3colheaderborder}). +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 +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.} +\label{tab:styles} +\vskip\baselineskip +\centering +\begin{tabular}{lccc} +\bfseries Style & \bfseries Maximum Level & +\bfseries Homograph & \bfseries Symbol\\ +\ttfamily listdotted & 0 & & \\ +\ttfamily sublistdotted & 1 & & \\ +\ttfamily list* & 1 & \tick & \\ +\ttfamily altlist* & 1 & \tick & \\ +\ttfamily long3col* & 1 & \tick & \\ +\ttfamily long4col* & 1 & \tick & \tick \\ +\ttfamily altlong4col* & 1 & \tick & \tick \\ +\ttfamily long* & 1 & \tick & \\ +\ttfamily super3col* & 1 & \tick & \\ +\ttfamily super4col* & 1 & \tick & \tick \\ +\ttfamily altsuper4col* & 1 & \tick & \tick \\ +\ttfamily super* & 1 & \tick & \\ +\ttfamily index* & 2 & & \tick\\ +\ttfamily treenoname* & --- & \tick & \tick\\ +\ttfamily tree* & --- & & \tick\\ +\ttfamily alttree* & --- & & \tick +\end{tabular} +\par +\end{table} + +The glossary style can be set using the \pkgopt{style} package option +or using the \gloskey[printglossary]{style} key in the optional +argument to \ics{printglossary} or using the command:\\[10pt] +\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] +The tabular-like styles that allow multi-line descriptions and page +lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} +to set the width of the description column and the length +\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the +width of the page list column.\footnote{these lengths will not be +available if you use both the \pkgopt{nolong} and \pkgopt{nosuper} +package options or if you use the \pkgopt{nostyles} package option.} +These will need to be changed using \cs{setlength} if the glossary +is too wide. Note that the \glostyle{long4col} and +\glostyle{super4col} 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 \glostyle{altlong4col} +and \glostyle{altsuper4col} styles. If you want to +explicitly create a line-break within a multi-line description in +a tabular-like style you should use \ics{newline} instead of +\verb|\\|. + +Note that if you use the \gloskey[printglossary]{style} key in the +optional argument to \ics{printglossary}, it will override any +previous style settings for the given glossary, so if, for example, +you do +\begin{verbatim} +\renewcommand*{\glsgroupskip}{} +\printglossary[style=long] +\end{verbatim} +then the new definition of \ics{glsgroupskip} will not have an affect +for this glossary, as \cs{glsgroupskip} is redefined by +\verb|style=long|. Likewise, \ics{glossarystyle} will also +override any previous style definitions, so, again +\begin{verbatim} +\renewcommand*{\glsgroupskip}{} +\glossarystyle{long} +\end{verbatim} +will reset \cs{glsgroupskip} back to its default definition for the +named glossary style (\glostyle{long} in this case). If you want to +modify the styles, either use \ics{newglossarystyle} (described +in the next section) or make the modifications after +\ics{glossarystyle}, e.g.: +\begin{verbatim} +\glossarystyle{long} +\renewcommand*{\glsgroupskip}{} +\end{verbatim} + + \changes{1.03}{2007 July 4}{'glspostdescription added} +All the styles except for the three- and four-column styles and the +\glostyle{listdotted} style use the command +\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} + +\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} +environment, they are governed by the same parameters as that +environment. These styles all ignore the entry's symbol. Note that +these styles will not be available if you use either the +\pkgopt{nolist} or \pkgopt{nostyles} package options. \begin{description} \item[list] The \glostyle{list} style uses the \envname{description} @@ -3742,7 +4047,7 @@ child entry. Groups are separated using \cs{indexspace}. \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 +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, @@ -3772,14 +4077,31 @@ groups. The navigation line is the same as that for \glostyle{listhypergroup}, described above. \item[listdotted] This style uses the \envname{description} -environment. 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.\footnote{This style was -supplied by Axel~Menzel.} This is a flat style, so child +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. +\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} +environment, they are governed by the same parameters as that +environment. Note that these styles will not be available if you +use either the \pkgopt{nolong} or \pkgopt{nostyles} package options. + +\begin{description} \item[long] The \glostyle{long} style uses the \envname{longtable} environment (defined by the \isty{longtable} package). It has two columns: the first column contains the entry's name and the second @@ -3859,7 +4181,23 @@ page lists. \item[altlong4colheaderborder] The \glostyle{altlong4colheaderborder} style is like \glostyle{long4colheaderborder} but allows multi-line descriptions and page lists. +\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} +environment, they are governed by the same parameters as that +environment. Note that these styles will not be available if you +use either the \pkgopt{nosuper} or \pkgopt{nostyles} package options. +In general, the \envname{longtable} environment is better, but there +are some circumstances where it is better to use +\envname{supertabular}.\footnote{e.g.\ with the \isty{flowfram} +package.} + +\begin{description} \item[super] The \glostyle{super} style uses the \envname{supertabular} environment (defined by the \isty{supertabular} package). It has two columns: the first column contains the entry's name and the second @@ -3940,14 +4278,28 @@ page lists. \item[altsuper4colheaderborder] The \glostyle{altsuper4colheaderborder} style is like \glostyle{super4colheaderborder} but allows multi-line descriptions and page lists. +\end{description} +\ifmakedtx{}{\toTop} + +\subsubsection{Tree-Like Styles} +\label{sec:treestyles} -\item[index] The \glostyle{index} style is similar to the -way indices are usually formatted in that it has a -hierarchical structure up to three 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 (if present) and the description. -Groups are separated using \ics{indexspace}. +The styles described in this section are all defined in the package +\isty{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 not be available if you +use either the \pkgopt{notree} or \pkgopt{nostyles} package options. + +\begin{description} +\item[index] The \glostyle{index} 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 \ics{indexspace}. \item[indexgroup] The \glostyle{indexgroup} style is similar to the \glostyle{index} style except that each group has a heading. @@ -4013,60 +4365,6 @@ groups. The navigation line is the same as that for \end{description} -The glossary style can be set using the \pkgopt{style} package option -or using the \gloskey[printglossary]{style} key in the optional -argument to \ics{printglossary} or using the command:\\[10pt] -\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] -The tabular-like styles that allow multi-line descriptions and page -lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} to -set the width of the description column and the length -\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the -width of the page list column. These will need to be changed using -\cs{setlength} if the glossary is too wide. Note that the -\glostyle{long4col} and \glostyle{super4col} 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 -\glostyle{altlong4col} and \glostyle{altsuper4col} styles. -Note that if you want to explicitly create a line-break within -a multi-line description you should use \ics{newline} instead -of \verb|\\|. - -Note that if you use the \gloskey[printglossary]{style} key in the -optional argument to \ics{printglossary}, it will override any -previous style settings for the given glossary, so if, for example, -you do: -\begin{verbatim} -\renewcommand*{\glsgroupskip}{} -\printglossary[style=long] -\end{verbatim} -The new definition of \ics{glsgroupskip} will not have an affect -for this glossary, as \cs{glsgroupskip} is redefined by -\verb|style=long|. Likewise, \ics{glossarystyle} will also -override any previous style definitions, so, again: -\begin{verbatim} -\renewcommand*{\glsgroupskip}{} -\glossarystyle{long} -\end{verbatim} -will reset \cs{glsgroupskip} back to its default definition for the -named glossary style (\glostyle{long} in this case). If you want to -modify the styles, either use \ics{newglossarystyle} (described -in the next section) or make the modifications after -\ics{glossarystyle}, e.g.: -\begin{verbatim} -\glossarystyle{long} -\renewcommand*{\glsgroupskip}{} -\end{verbatim} - - \changes{1.03}{2007 July 4}{'glspostdescription added} -All the styles except for the three- and four-column styles and the -\glostyle{listdotted} style use the command -\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} \subsection{Defining your own glossary style} @@ -4103,20 +4401,38 @@ glossary style redefines \cs{glossaryheader} to do a header row. \item \DescribeMacro{\glsgroupheading} -\cs{glsgroupheading}\marg{label}\par\noindent -This macro indicates what to do at the start of each logical block -within the main body of the glossary. The glossary is sub-divided into -twenty-eight logical blocks that are determined by the first character -of the \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\@. (This may be different if you use -\appname{xindy}.) Note that the argument to \cs{glsgroupheading} +\cs{glsgroupheading}\marg{label}\par\noindent 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 +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 +the language settings. + +Note that the argument to \cs{glsgroupheading} is a label \emph{not} the group title. The group title can be obtained -via \cs{glsgetgrouptitle}\marg{label}, and a navigation hypertarget can -be created using \cs{glsnavhypertarget}\marg{label}. Most of the -predefined glossary styles redefine \cs{glsgroupheading} to simply -ignore its argument. The \glostyle{listhypergroup} style redefines -\cs{glsgroupheading} as follows: +via + +\DescribeMacro{\glsgetgrouptitle}\cs{glsgetgrouptitle}\marg{label} + +This obtains the title as follows: if +\cs{}\meta{label}\texttt{groupname} exists, this is taken to be the +title, otherwise the title is just \meta{label}. + +A navigation hypertarget can be created using + +\DescribeMacro{\glsnavhypertarget}\cs{glsnavhypertarget}\marg{label}\marg{text} + +For further details about \cs{glsnavhypertarget}, see +\ifmakedtx{\autoref{sec:code:hypernav}}{the documented code of \isty{glossary-hypernav} +in \texttt{glossaries.pdf}}. + + +Most of the predefined glossary styles redefine \cs{glsgroupheading} +to simply ignore its argument. The \glostyle{listhypergroup} style +redefines \cs{glsgroupheading} as follows: \begin{verbatim} \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} @@ -4144,20 +4460,25 @@ Note that \meta{formatted name} will always be in the form font for the entry name, regardless of the glossary style used. Note that \meta{label} is the label used when the glossary entry was defined via either \cs{newglossaryentry} or \cs{newacronym}. -Each time you use a glossary entry it creates a -link\footnote{if the document doesn't have hyperlinks enabled -\cs{@glslink} ignores the label and simply typesets the text.} -using \cs{@glslink}\marg{label}\marg{text} with the label -\texttt{glo:}\meta{label}. Your -new glossary style must therefore redefine \cs{glossaryentryfield} -so that it uses \cs{@glstarget}\verb|{|\texttt{glo:}\meta{label}\verb|}|\marg{text} -to ensure the hyperlinks function correctly.\footnote{again, if the -document doesn't support hyperlinks, \cs{@glstarget} will ignore -the label, and just typeset the text.} For example, the + +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 +\cs{glossaryentryfield} to set the appropriate target. This +is done using + +\DescribeMacro{\glstarget}\cs{glstarget}\marg{label}\marg{text} + +where \meta{label} is the entry's label. Note that you +don't need to worry about whether the \isty{hyperref} package has +been loaded, as \cs{glstarget} won't create a target if +\cs{hypertarget} hasn't been defined. + +For example, the \glostyle{list} style defines \cs{glossaryentryfield} as follows: \begin{verbatim} \renewcommand*{\glossaryentryfield}[5]{% -\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5} +\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} \end{verbatim} Note also that \meta{number list} will always be of the form\\[10pt] @@ -4189,23 +4510,24 @@ The first argument, \meta{level}, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \ics{glossaryentryfield} described above. -\end{description}\ifmakedtx{}{\toTop} +\end{description} + +For further details of these commands, see +\ifmakedtx{\autoref{sec:code:printglos}}{the documented code in \texttt{glossaries.pdf}}. +\ifmakedtx{}{\toTop} \subsubsection{Example: creating a completely new style} If you want a completely new style, you will need to redefine all -of the commands and environment listed above. You also need to -take care when using internal commands (commands whose name -contain the @ symbol). These should either be used in a \texttt{.sty} -file or must be placed within \cs{makeatletter} and \cs{makeatother}. +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 environment. Let's also suppose that you don't want anything between -the glossary groups (so \cs{glsgroupheading} and \cs{glsgroupskip} +the glossary groups (so \ics{glsgroupheading} and \ics{glsgroupskip} should do nothing) and suppose you don't want anything to appear -immediately after \verb|\begin{theglossary}| (so \cs{glossaryheader} +immediately after \verb|\begin{theglossary}| (so \ics{glossaryheader} should do nothing). In addition, let's suppose the symbol should appear in brackets after the name, followed by the description and last of all the \term{number list} should appear within square brackets @@ -4223,14 +4545,14 @@ at the end. Then you can create this new glossary style, called, say, % set how each entry should appear: \renewcommand*{\glossaryentryfield}[5]{% \item % bullet point - \@glstarget{glo:##1}{##2}% the entry name + \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}}% + \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% } \end{verbatim} Note that this style creates a flat glossary, where sub-entries @@ -4328,7 +4650,7 @@ command \cs{@gls@makefirstuc}. For example: \end{verbatim} (Remember that command names that contain the @ character must either be placed in packages or be placed between \cs{makeatletter} -\cs{makeatother}.) +and \cs{makeatother}.) \ifmakedtx{}{\toTop} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf index 44fe93c7b30..b50f46e8bb4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 77571dcf832..754eec11a3a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -26,7 +26,7 @@ package">

    Upgrading from the glossary package to the glossaries package

    Nicola L.C. Talbot

    -

    17th June 2008

    +

    14th January 2009


    @@ -35,44 +35,46 @@ Contents

    @@ -87,8 +89,92 @@ to convert a LaTeX document from using the obsolete

    -

    -1 Package Options +

    + +
    +1 Why the Need for a New Package? +

    + +

    +The 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 +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 glossaries package: + +

    + +

      +
    • you can define irregular plurals; + +

      +

    • +
    • glossary terms can have an associated symbol in addition +to the name and description; + +

      +

    • +
    • new glossary styles are much easier to design; + +

      +

    • +
    • you can add dictionaries to supply translations for the +fixed names used in headings and by some of the glossary styles; + +

      +

    • +
    • you can choose1 between using +makeindex or xindy to sort the glossary. Using +xindy means that: + +

      + +

        +
      • there is much better support for terms containing accented + or non-Latin characters; + +

        +

      • +
      • there is support for non-standard location numbers; + +
      • +
      + +

      +

    • +
    • you don't need to remember to escape makeindex's +special characters as this is done internally; + +

      +

    • +
    • hierarchical entries and homographs are supported;2 +

      +

    • +
    • there is better support for cross-referencing glossary entries; + +

      +

    • +
    • acronyms are just another glossary term which helps to +maintain consistency; + +

      +

    • +
    • different acronym styles are supported. + +

      +

    • +
    + +

    + +

    +2 Package Options

    @@ -107,7 +193,7 @@ to the glossaries package options.

    - +

    -

    -2 Defining new glossary types +

    +3 Defining new glossary types

    @@ -212,7 +298,7 @@ If you have created new glossary types, you will need to replace all instances of

    -\newglossarytype[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<style list>] +\newglossarytype[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<old style list>]
    \newcommand{\<type>name}{<title>}

    @@ -221,17 +307,18 @@ with

    \newglossary[<log-ext>]{<type>}{<out-ext>}{<in-ext>}{<title>}

    -in the preamble, and +in the preamble, and, if the new glossary requires a different style +to the main (default) glossary, you will also need to put

    \glossarystyle{<new style>}

    -immediately before \printglossary[type=<type>], -if the new glossary requires a different style to the main (default) -glossary. +immediately before the glossary is displayed, or you can specify +the style when you display the glossary using \printglossary +(see below).

    -The <style list> optional argument can be converted to +The <old style list> optional argument can be converted to <new style> using the same mapping given in Table 1. @@ -245,13 +332,11 @@ You will need to replace the above two lines with:

     \newglossary[nlg]{notation}{not}{ntn}{Index of Notation}
     
    -in the preamble, and +in the preamble and
     \glossarystyle{longheader}
     
    -immediately prior to displaying this glossary new type. - -

    +immediately prior to displaying this glossary. Alternatively, you can specify the style using the style key in the optional argument of \printglossary. For example:

    @@ -270,8 +355,8 @@ using the toctitle key in the optional argument to
     
     

    -

    -3 \make<glossary name> +

    +4 \make<glossary name>

    @@ -290,8 +375,8 @@ then you should replace both lines with the single line:

    -

    -4 Storing glossary information +

    +5 Storing glossary information

    @@ -299,15 +384,16 @@ With the old glossary package you could optionally store glossary information for later use, or you could simply use \glossary whenever you wanted to add information to the glossary. With the new glossaries package, the latter option is no longer -available.1 If +available.3 If you have stored all the glossary information using \storeglosentry, then you will need to convert these commands -into the equivalent \newglossaryentry. If you haven't used -\storeglosentry, then you'll have a bit more work to do! +into the equivalent \newglossaryentry. If you have only +used \glossary, then see +later.

    -The former approach requires substituting all instances of +Substitute all instances of

    \storeglosentry{<label>}{<gls-entry>} @@ -357,8 +443,8 @@ The format and number keys available in

    -

    -5 Adding an entry to the glossary +

    +6 Adding an entry to the glossary

    @@ -372,10 +458,10 @@ package.

    -

    +


    -5.1 \useglosentry +6.1 \useglosentry

    @@ -392,14 +478,14 @@ Any occurrences of this command will need to be replaced with \glsadd[<new options>]{<label>}

    The format key in <old options> remains the same -in <new options>, the number=<counter name> -key in <old options> should be replaced with -
    counter=<counter name> in <new options>. +in <new options>. However the number=<counter +name> key in <old options> should be replaced with +counter=<counter name> in <new options>.

    -

    -5.2 \useGlosentry +

    +6.2 \useGlosentry

    @@ -409,7 +495,7 @@ glossary for a predefined term with the given text using

    \useGlosentry[<old options>]{<label>}{<text>}

    -Any occurrences if this command will need to be replaced with +Any occurrences of this command will need to be replaced with

    \glslink[<new options>]{<label>}{<text>} @@ -419,8 +505,8 @@ the same as that given above

    -

    -5.3 \gls +

    +6.3 \gls

    @@ -433,24 +519,25 @@ automatically generated text.

    -

    -5.4 \glossary +

    + +
    +6.4 \glossary

    When using the glossaries package, you should not use -\glossary directly.2 If, with the old -package, you have opted to explicitly use \glossary instead of -storing the glossary information with \storeglosentry, then -converting from glossary to glossaries will be more -time-consuming, although in the end, I hope you will see the -benefits!3 If -you have used \glossary with the old glossary package, you will -instead need to define the relevant glossary terms using -\newglossaryentry and reference the terms using \glslink, -\gls (or \glspl etc). +\glossary directly.4 If, with the old package, you have opted to +explicitly use \glossary instead of storing the glossary +information with \storeglosentry, then converting from +glossary to glossaries will be more time-consuming, +although in the end, I hope you will see the benefits.5 If you have +used \glossary with the old glossary package, you will instead +need to define the relevant glossary terms using +\newglossaryentry and reference the terms using +\glsadd, \glslink, \gls etc.

    If you don't like the idea of continually scrolling back to the @@ -462,8 +549,8 @@ you can tab back and forth between them.

    -

    -6 Acronyms +

    +7 Acronyms

    @@ -513,44 +600,19 @@ and change the acronym definition to: \newacronym[description=Statistical pattern recognition technique]{svm}{SVM}{Support Vector Machine}

    -You will also need to replace all occurrences of \SVM with -\gls{svm}. Alternatively, you can define \SVM: -
    -\newcommand{\SVM}{\gls{svm}}
    -
    -Remember that generally LaTeX ignores all spaces following command -names that consist of a backslash followed by letters! For example, -using the above definition of \SVM, the following will ignore -the space after \SVM: -
    -The \SVM is a statistical pattern recognition technique.
    -
    -Instead, you need to explicitly insert a space: -
    -The \SVM\ is a statistical pattern recognition technique.
    -
    -However, \SVM['s] is equivalent to \gls{svm}['s], -so you can do, for example: -
    -The \SVM['s] parameters are obtained via optimisation techniques.
    -
    +You can then reference the acronym using any of the new referencing +commands, such as \gls or \glsadd.

    -The xspace package provides the command \xspace which can -be used to insert a space after the command name if required. Some -people prefer to use this at the end of the command definition so -that they don't need to remember to insert an explicit space. -For example, if we use the xspace package, we could define -\SVM as follows: -

    -\newcommand{\SVM}{\gls{svm}\xspace}
    -
    -so now the following will have a space before the word "is": -
    -The \SVM is a statistical pattern recognition technique.
    -
    -However, you can no longer do \SVM['s], as the \xspace is -now in the way. +With the old glossary package, when you defined an +acronym, it also defined a command \<acr-name> which +could be used to display the acronym in the text. So the +above SVM example would create the command \SVM with the old +package. In the new glossaries package, the acronyms are just +another type of glossary entry, so they are displayed using +\gls{<label>}. Therefore, in the above example, you will +also need to replace all occurrences of \SVM with +\gls{svm}.

    If you have used \useacronym instead of \<acr-name>, @@ -569,9 +631,42 @@ Note that the starred versions of \useacronym and be replaced with \Gls{<label>}.

    +Alternatively (as from v1.18 of the glossaries package), +you can use \oldacronym which uses the same syntax as +the old glossary package's \newacronym and also +defines \<acr-name>. +For example, if your document originally had the following: -

    -6.1 \acrln and \acrsh +

    +\newacronym{SVM}{Support Vector Machine}{description=Statistical
    +pattern recognition technique}
    +
    +

    +then you can change this to: + +

    +\oldacronym{SVM}{Support Vector Machine}{description=Statistical
    +pattern recognition technique}
    +
    +

    +You can then continue to use \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 \<acr-name>, unless you also load the xspace +package. (See the +Acronyms +section of the glossaries documentation for further +details.) Note that \oldacronym uses its first argument to +define the acronym's label (as used by commands like \gls), so +in the above example, with the new glossaries package, +\SVM becomes a shortcut for \gls{SVM} and \SVM* +becomes a shortcut for \Gls{SVM}. + +

    + +

    +7.1 \acrln and \acrsh

    @@ -579,7 +674,7 @@ In the glossary package, it is possible to produce the long and short forms of an acronym without adding an entry to the glossary using \acrln and \acrsh. With the glossaries package (provided you defined the acronym using -\newacronym and provided you haven't redefined \newacronym) +\newacronym or \oldacronym and provided you haven't redefined \newacronym) you can replace

    @@ -602,18 +697,22 @@ with

    The glossaries package also provides the related commands \acrshortpl (plural short form) and \acrlongpl (plural long -form) as well as upper case variations. +form) as well as upper case variations. If you use the +glossaries "shortcuts" package option, you can use +\acs in place of \acrshort and \acl in place of +\acrlong.

    -See -the section "Using -glossary entries in the text" of the glossaries -manual for further details of how to use these commands. +See the +Acronyms +section of the glossaries manual for further details of +how to use these commands.

    -

    -6.2 \ifacronymfirstuse +

    +7.2 \ifacronymfirstuse

    @@ -633,15 +732,15 @@ have been reversed.

    -

    -6.3 \resetacronym and \unsetacronym +

    +7.3 \resetacronym and \unsetacronym

    The 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 glossaries package also -provides a means to do this on either a local or global level. +provides a means to do this on either a local or a global level. To reset an acronym, you will need to replace:

    @@ -676,9 +775,41 @@ or

    +To reset all acronyms, you will need to replace: -

    -7 Displaying the glossary +

    +\resetallacronyms +

    +with + +

    +\glsresetall[\acronymtype] +

    +or + +

    +\glslocalresetall[\acronymtype] +

    +To unset all acronyms, you will need to replace: + +

    +\unsetallacronyms +

    +with + +

    +\glsunsetall[\acronymtype] +

    +or + +

    +\glslocalunsetall[\acronymtype] +

    + +

    + +

    +8 Displaying the glossary

    @@ -699,7 +830,7 @@ or \printglossary \printacronym -then you will need to either replace this with either +then you will need to replace this with either

     \printglossaries
     
    @@ -731,8 +862,8 @@ as well remove the definition.

    -

    -8 Using makeindex +

    +9 Processing Your Document

    @@ -740,19 +871,33 @@ If you convert your document from using the glossary package to the glossaries package, you will need to delete any of the additional files, such as the .glo file, that were created by the glossary package, as the glossaries -package uses a different makeindex style file. +package uses a different format. Remember also, that if you used the makeglos Perl script, you will need to use the makeglossaries Perl script -instead. +instead. As from v1.17, the glossaries package can be +used with either makeindex or xindy. Since +xindy was designed to be multilingual, the +new glossaries package is a much better option for +non-English documents.

    +For further information on using makeglossaries, +makeindex or xindy to create your glossaries, see +the +Generating the Associated Glossary +Files +section of the +glossaries documentation. -

    -9 Troubleshooting +

    + +

    +10 Troubleshooting

    -Please check the FAQ for the glossaries package if you have any problems. @@ -760,33 +905,45 @@ problems.



    Footnotes

    -
    ... +
    ... choose1
    +
    as from v1.17. Previous versions +were designed to be used with makeindex only + +
    +
    ... supported;2
    +
    as +from v1.17 + +
    +
    ... available.1
    + HREF="glossary2glossaries.html#tex2html4">3
    mainly because having a key value list in \glossary caused problems, but it also helps consistency.
    -
    ... directly.2
    -
    This is because \glossary requires -the argument to be in a specific format and doesn't use the -<key>=<value> format that the old glossary package used. The -new package's internal commands set this format, as well as escaping -any of makeindex's special characters, so although it is -still possible to use \glossary with the new package, it's not -recommended. If you persist in using \glossary with the new -package, don't complain if things go wrong! +
    ... directly.4
    +
    This is because \glossary +requires the argument to be in a specific format and doesn't use the +<key>=<value> format that the old glossary package used. +The new package's internal commands set this format, as well as +escaping any of makeindex's or 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 makeindex or +xindy.
    -
    ... -benefits!3
    -
    From the user's point of view, using \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 makeindex to treat the two entries as -different terms, even though they look the same in the document. +
    ... benefits.5
    +
    From +the user's point of view, using \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 makeindex to treat the two entries as different +terms, even though they look the same in the document.
    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index dacc6f8a24b..3301a664693 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index 12b63f036fc..eae0a6359ad 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -11,12 +11,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{17th June 2008} - -\newcommand*{\meta}[1]{\textnormal{\textless\emph{#1}\textgreater}} -\newcommand*{\marg}[1]{\texttt{\char`\{\meta{#1}\char`\}}} -\newcommand*{\oarg}[1]{\texttt{[\meta{#1}]}} -\newcommand*{\cs}[1]{\texttt{\char`\\#1}} +\date{14th January 2009} %\begin{latexonly} \newcommand*{\sty}[1]{\textsf{#1}} @@ -25,21 +20,22 @@ package} \newcommand*{\dq}[1]{``#1''} \newsavebox\waybox -\newenvironment{oldway}{\begin{lrbox}{\waybox} +\newenvironment{oldway}{\begin{lrbox}{\waybox}% \begin{minipage}{0.98\linewidth}\ttfamily -}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent -\begin{tabular}{r} -\fbox{\usebox\waybox}\\[4pt]\footnotesize\mbox{\sty{glossary}} +\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\ignorespaces} +\vskip\baselineskip\par\noindent\ignorespacesafterend} \newenvironment{newway}{\begin{lrbox}{\waybox} \begin{minipage}{0.98\linewidth}\ttfamily -}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent -\begin{tabular}{r} +\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\ignorespaces} +\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} @@ -49,8 +45,13 @@ package} \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}} + \begin{document} \maketitle \tableofcontents @@ -61,6 +62,57 @@ to convert a \LaTeX\ document from using the obsolete \sty{glossary} package to the replacement \sty{glossaries} package. \end{abstract} +\section{Why the Need for a New Package?} +\label{whyglossaries} + +The \sty{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 +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: + +\begin{itemize} +\item you can define irregular plurals; + +\item glossary terms can have an associated symbol in addition +to the name and description; + +\item new glossary styles are much easier to design; + +\item you can add dictionaries to supply translations for the +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: + + \begin{itemize} + \item there is much better support for terms containing accented + or non-Latin characters; + + \item there is support for non-standard location numbers; + \end{itemize} + +\item you don't need to remember to escape \texttt{makeindex}'s +special characters as this is done internally; + +\item hierarchical entries and homographs are supported;\footnote{as +from v1.17} + +\item there is better support for cross-referencing glossary entries; + +\item acronyms are just another glossary term which helps to +maintain consistency; + +\item different acronym styles are supported. + +\end{itemize} + \section{Package Options} When converting a document that currently uses the obsolete @@ -115,22 +167,23 @@ 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{style list}\newline +\cs{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} \end{newway}% -in the preamble, and +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} \end{newway}% -immediately before \verb|\printglossary[type=|\meta{type}\verb|]|, -if the new glossary requires a different style to the main (default) -glossary. +immediately before the glossary is displayed, or you can specify +the style when you display the glossary using \cs{printglossary} +(see below). -The \meta{style list} optional argument can be converted to +The \meta{old style list} optional argument can be converted to \meta{new style} using the same mapping given in Table~\ref{tab:pkgopt}. @@ -143,12 +196,11 @@ 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 new type. - +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: \begin{verbatim} @@ -189,10 +241,11 @@ available.\footnote{mainly because having a key value list in \cs{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 haven't used -\cs{storeglosentry}, then you'll have a bit more work to do! +into the equivalent \cs{newglossaryentry}. If you have only +used \cs{glossary}, then see +\latexhtml{section~\ref{sec:csglossary}}{\htmlref{later}{sec:csglossary}}. -The former approach requires substituting all instances of +Substitute all instances of \begin{oldway} \cs{storeglosentry}\marg{label}\marg{gls-entry} \end{oldway}% @@ -257,8 +310,8 @@ Any occurrences of this command will need to be replaced with \cs{glsadd}\oarg{new options}\marg{label} \end{newway}% The \key{format} key in \meta{old options} remains the same -in \meta{new options}, the \texttt{number=}\meta{counter name} -key in \meta{old options} should be replaced with\linebreak +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}. \subsection{\cs{useGlosentry}} @@ -268,12 +321,12 @@ glossary for a predefined term with the given text using \begin{oldway} \cs{useGlosentry}\oarg{old options}\marg{label}\marg{text} \end{oldway}% -Any occurrences if this command will need to be replaced with +Any occurrences of this command will need to be replaced with \begin{newway} \cs{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{section~\ref{sec:useglosentry} +the same as that given \latexhtml{in section~\ref{sec:useglosentry} above}{\htmlref{above}{sec:useglosentry}}. \subsection{\cs{gls}} @@ -286,29 +339,30 @@ a final optional argument which can be used to insert text into the automatically generated text. \subsection{\cs{glossary}} +\label{sec:csglossary} When using the \sty{glossaries} package, you should not use -\cs{glossary} directly.\footnote{This is because \cs{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 special characters, so although it is -still possible to use \cs{glossary} with the new package, it's not -recommended. If you persist in using \cs{glossary} with the new -package, don't complain if things go wrong!} 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, although in the end, I hope you will see the -benefits!\footnote{From the user's point of view, using \cs{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 terms, even though they look the same in the document.} If -you have used \cs{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{glslink}, -\cs{gls} (or \cs{glspl} etc). +\cs{glossary} directly.\footnote{This is because \cs{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 +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, +although in the end, I hope you will see the benefits.\footnote{From +the user's point of view, using \cs{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 +terms, even though they look the same in the document.} If you have +used \cs{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. If you don't like the idea of continually scrolling back to the preamble to type all your \cs{newglossaryentry} commands, you may @@ -361,43 +415,18 @@ and change the acronym definition to: \newacronym[description=Statistical pattern recognition technique]{svm}{SVM}{Support Vector Machine} \end{verbatim} -You will also need to replace all occurrences of \cs{SVM} with -\verb|\gls{svm}|. Alternatively, you can define \cs{SVM}: -\begin{verbatim} -\newcommand{\SVM}{\gls{svm}} -\end{verbatim} -Remember that generally \LaTeX\ ignores all spaces following command -names that consist of a backslash followed by letters! For example, -using the above definition of \cs{SVM}, the following will ignore -the space after \cs{SVM}: -\begin{verbatim} -The \SVM is a statistical pattern recognition technique. -\end{verbatim} -Instead, you need to explicitly insert a space: -\begin{verbatim} -The \SVM\ is a statistical pattern recognition technique. -\end{verbatim} -However, \verb|\SVM['s]| is equivalent to \verb|\gls{svm}['s]|, -so you can do, for example: -\begin{verbatim} -The \SVM['s] parameters are obtained via optimisation techniques. -\end{verbatim} - -The \sty{xspace} package provides the command \cs{xspace} which can -be used to insert a space after the command name if required. Some -people prefer to use this at the end of the command definition so -that they don't need to remember to insert an explicit space. -For example, if we use the \sty{xspace} package, we could define -\cs{SVM} as follows: -\begin{verbatim} -\newcommand{\SVM}{\gls{svm}\xspace} -\end{verbatim} -so now the following will have a space before the word \dq{is}: -\begin{verbatim} -The \SVM is a statistical pattern recognition technique. -\end{verbatim} -However, you can no longer do \verb|\SVM['s]|, as the \cs{xspace} is -now in the way. +You can then reference the acronym using any of the new referencing +commands, such as \cs{gls} or \cs{glsadd}. + +With the old \sty{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 +another type of glossary entry, so they are displayed using +\cs{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}, then you will need to replace all occurrences of @@ -412,13 +441,44 @@ Note that the starred versions of \cs{useacronym} and \cs{}\meta{acr-name} (which make the first letter uppercase) should be replaced with \cs{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 +defines \cs{}\meta{acr-name}. +For example, if your document originally had the following: +\begin{oldway} +\begin{verbatim} +\newacronym{SVM}{Support Vector Machine}{description=Statistical +pattern recognition technique} +\end{verbatim} +\end{oldway} +then you can change this to: +\begin{newway} +\begin{verbatim} +\oldacronym{SVM}{Support Vector Machine}{description=Statistical +pattern recognition technique} +\end{verbatim} +\end{newway} +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, +\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}} In the \sty{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} and provided you haven't redefined \cs{newacronym}) +\cs{newacronym} or \cs{oldacronym} and provided you haven't redefined \cs{newacronym}) you can replace \begin{oldway} \cs{acrsh}\marg{acr-name} @@ -437,12 +497,15 @@ with \end{newway}% The \sty{glossaries} package also provides the related commands \cs{acrshortpl} (plural short form) and \cs{acrlongpl} (plural long -form) as well as upper case variations. +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:code:glslink} (}{the section }\dq{Using -glossary entries in the text}\latex{)} of the \sty{glossaries} -manual for further details of how to use these commands. +See \latexhtml{section~\ref*{sec:acronyms}}{the +\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms} +section} of the \sty{glossaries} manual for further details of +how to use these commands. \subsection{\cs{ifacronymfirstuse}} @@ -463,7 +526,7 @@ have been reversed. The \sty{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 -provides a means to do this on either a local or global level. +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} @@ -490,6 +553,31 @@ or \cs{glslocalunset}\marg{label} \end{newway} +To reset all acronyms, you will need to replace: +\begin{oldway} +\cs{resetallacronyms} +\end{oldway} +with +\begin{newway} +\cs{glsresetall}[\cs{acronymtype}] +\end{newway} +or +\begin{newway} +\cs{glslocalresetall}[\cs{acronymtype}] +\end{newway} +To unset all acronyms, you will need to replace: +\begin{oldway} +\cs{unsetallacronyms} +\end{oldway} +with +\begin{newway} +\cs{glsunsetall}[\cs{acronymtype}] +\end{newway} +or +\begin{newway} +\cs{glslocalunsetall}[\cs{acronymtype}] +\end{newway} + \section{Displaying the glossary} The \sty{glossary} package provides the command \cs{printglossary} @@ -509,7 +597,7 @@ or \printglossary \printacronym \end{verbatim} -then you will need to either replace this with either +then you will need to replace this with either \begin{verbatim} \printglossaries \end{verbatim} @@ -538,16 +626,27 @@ 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. -\section{Using makeindex} +\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} -package uses a different \texttt{makeindex} style file. +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. +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 +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. \section{Troubleshooting} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex index 7c6034547f8..529e19baa42 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex @@ -1,7 +1,7 @@ \documentclass{report} \usepackage[colorlinks]{hyperref} -\usepackage[style=alttreehypergroup]{glossaries} +\usepackage[style=alttreehypergroup,nolong,nosuper]{glossaries} % The alttree type of glossary styles need to know the % widest entry name for each level diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 2dcfce07d7d..be27ab049ec 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -25,7 +25,7 @@ % -doc "glossaries-manual.tex" % -codetitle "Documented Code" % glossaries -% Created on 2008/12/26 16:49 +% Created on 2009/1/16 12:27 %\fi %\iffalse %<*package> @@ -48,13 +48,14 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2008 Nicola Talbot, all rights reserved. +% Copyright (C) 2009 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> \documentclass[a4paper]{ltxdoc} \usepackage{ifthen} \usepackage{alltt} +\usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage[colorlinks, @@ -78,7 +79,7 @@ \makeatother \RecordChanges \PageIndex -\CheckSum{7758} +\CheckSum{7872} \CodelineNumbered \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}} \newcommand*{\term}[1]{#1\iterm{#1}} @@ -98,9 +99,16 @@ }{\end{minipage}\end{lrbox}% \par\vskip10pt\noindent \fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} +\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*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}} \newcommand*{\ics}[1]{\texttt{\char`\\#1}\SpecialMainIndex{#1}} @@ -134,7 +142,7 @@ %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{glossaries.sty v 1.17: \LaTeXe\ Package to Assist Generating Glossaries} +% \title{glossaries.sty v 1.18: \LaTeXe\ Package to Assist Generating Glossaries} % \author{Nicola L.C. Talbot\\[10pt] %School of Computing Sciences\\ %University of East Anglia\\ @@ -142,7 +150,7 @@ %NR4 7TJ. United Kingdom.\\ %\url{http://theoval.cmp.uea.ac.uk/~nlct/}} % -% \date{26th December 2008} +% \date{14th January 2009} % \maketitle %\tableofcontents % @@ -154,8 +162,12 @@ %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 -%where only those terms used in the text are added to the 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 +%added to the glossary. % %\textbf{This package replaces the \isty{glossary} package which is %now obsolete. Please see the file @@ -183,7 +195,7 @@ %pointers of how to get started creating a basic glossary, without %having to read through lengthy descriptions. % -%\item \autoref{sec:overview} gives an overview of available commands and their syntax. +%\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. % @@ -221,7 +233,7 @@ % %The sample documents are as follows: %\begin{description} -%\item[minimalgls.tex] This document is a minimal working example. +%\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} @@ -236,6 +248,12 @@ % PDF\LaTeX\ you will also get warnings about non-existent % 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 +% 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} +% package. +% % \item Run \appname{makeglossaries} on the document. This can % be done on a terminal by either typing %\begin{verbatim} @@ -266,7 +284,7 @@ %each entry in the glossary is the location number. By default, this %is the page number where the entry was referenced. % -%\item[sample4col.tex] This document illustrates a four column +%\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: @@ -285,9 +303,9 @@ %\renewcommand*{\glsgroupskip}{} %\end{verbatim} % -%\item[sampleAcr.tex] This document has some sample acronyms. It +%\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: +%run through \LaTeX\ is required to ensure the document is up to date: %\begin{verbatim} %latex sampleAcr %makeglossaries sampleAcr @@ -295,7 +313,7 @@ %latex sampleAcr %\end{verbatim} % -%\item[sampleAcrDesc.tex] This is similar to the previous example, +%\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: @@ -306,7 +324,7 @@ %latex sampleAcrDesc %\end{verbatim} % -%\item[sampleDesc.tex] This is similar to the previous example, +%\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 @@ -318,8 +336,8 @@ %latex sampleDesc %\end{verbatim} % -%\item[sampleDB.tex] This document illustrates how to load -%an external files containing the glossary definitions. It also +%\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 @@ -329,10 +347,11 @@ %makeglossaries sampleDB %latex sampleDB %\end{verbatim} -%The glossary definitions are stored in the files +%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 using \appname{makeglossaries}: +%\appname{makeindex} twice instead of a single call to +%\appname{makeglossaries}: %\begin{enumerate} %\item Create the main glossary: %\begin{verbatim} @@ -344,7 +363,7 @@ %\end{verbatim} %\end{enumerate} % -%\item[sampleEq.tex] This document illustrates how to change the +%\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 @@ -355,7 +374,7 @@ %latex sampleEq %\end{verbatim} % -%\item[sampleEqPg.tex] This is similar to the previous example, +%\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: @@ -366,7 +385,7 @@ %latex sampleEqPg %\end{verbatim} % -%\item[sampleSec.tex] This document also illustrates how to change +%\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 @@ -378,7 +397,7 @@ %latex sampleSec %\end{verbatim} % -%\item[sampleNtn.tex] This document illustrates how to create +%\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} @@ -388,7 +407,8 @@ %latex sampleNtn %\end{verbatim} %Note that if you don't have Perl installed, you will need to use -%\appname{makeindex} twice instead of using \appname{makeglossaries}: +%\appname{makeindex} twice instead of a single call to +%\appname{makeglossaries}: %\begin{enumerate} %\item Create the main glossary: %\begin{verbatim} @@ -400,7 +420,7 @@ %\end{verbatim} %\end{enumerate} % -%\item[sample.tex] This document illustrates some of the basics, +%\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: @@ -417,7 +437,7 @@ %\appname{makeindex} explicitly, you will need to use the %\texttt{-l} switch to indicate letter ordering.) % -%\item[sampletree.tex] This document illustrates a hierarchical +%\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} @@ -426,7 +446,7 @@ %latex sampletree %\end{verbatim} % -%\item[samplexdy.tex] This document illustrates how to use the +%\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 @@ -469,7 +489,7 @@ %samplexdy.glo %\end{verbatim} % -%\item[sampleutf8.tex] This is another example that uses +%\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: @@ -486,7 +506,8 @@ %-o sampleutf8.gls sampleutf8.glo %\end{verbatim} % -%If you remove the \pkgopt{xindy} option and do: +%If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} +%and do: %\begin{verbatim} %latex sampleutf8 %makeglossaries sampleutf8 @@ -604,8 +625,8 @@ %\label{tab:predefinednames} %\begin{center} %\begin{tabular}{@{}llp{0.4\linewidth}@{}} -%\bfseries Command Name & \bfseries Translator key word & -%\bfseries What it's for\\ +%\bfseries Command Name & \bfseries Translator Key Word & +%\bfseries Purpose\\ %\ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\\ %\ics{acronymname} & \texttt{Acronyms} & Title of the list of acronyms %(when used with package option \pkgopt{acronym}).\\ @@ -687,7 +708,7 @@ %\autoref{sec:makeindexapp}). Note that some commands and %package options have no effect if you don't use %\appname{makeglossaries}. These are listed in -%Table~\ref{tab:makeglossariesCmds}. +%\tableref{tab:makeglossariesCmds}. % %Note that if any of your entries use an entry %that is not referenced outside the glossary, you will need to @@ -795,7 +816,8 @@ %\usepackage[xindy]{glossaries} %\end{verbatim} %This is required regardless of whether you use \appname{xindy} -%explicitly or via \appname{makeglossaries}. This causes the glossary +%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 %use \texttt{-I xindy} \emph{not} \texttt{-I tex}. % @@ -807,14 +829,15 @@ %-o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo %\end{ttfamily} %\\[10pt] -%where \meta{language} is 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. 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. If any of the file names contain spaces, -%you must delimit them using double-quotes. +%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. +%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 +%directory. If any of the file names contain spaces, you must delimit +%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 @@ -845,7 +868,7 @@ %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 -%Table~\ref{tab:makeglossariesCmds}. +%\tableref{tab:makeglossariesCmds}. % %\subsubsection{Using makeindex explicitly} %\label{sec:makeindexapp} @@ -895,7 +918,7 @@ %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 -%Table~\ref{tab:makeglossariesCmds}. +%\tableref{tab:makeglossariesCmds}. % %\subsection{Troubleshooting} %\label{sec:trouble} @@ -915,17 +938,25 @@ %\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. % %\begin{enumerate} -%\item I've used the \pkgopt{smallcaps} option, but the acronyms +%\item \textbf{Q.} I get the error message: +%\begin{verbatim} +%Missing \begin{document} +%\end{verbatim} +% +%\textbf{A.} Check you are using an up to date version of the \isty{xkeyval} +%package. +% +%\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms %are displayed in normal sized upper case letters. % -%The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset +%\textbf{A.} The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset %the acronyms. This command converts lower case letters to small %capitals, while upper case letters remain their usual size. Therefore %you need to specify the acronym in lower case letters. % -%\item How do I change the font that the acronyms are displayed in? +%\item \textbf{Q.} How do I change the font that the acronyms are displayed in? % -%The easiest way to do this is to specify the \pkgopt{smaller} package +%\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package %option and redefine \cs{acronymfont} to use the required typesetting %command. For example, suppose you would like the acronyms displayed in %a sans-serif font, then you can do: @@ -934,40 +965,43 @@ %\renewcommand*{\acronymfont}[1]{\textsf{#1}} %\end{verbatim} % -%\item How do I change the font that the acronyms are displayed in -%on first use? +%\item \textbf{Q.} How do I change the font that the acronyms are displayed in +%on \firstuse? % -%The easiest way to do this is to specify the \pkgopt{smaller} package +%\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package %option and redefine \cs{firstacronymfont} to use the required %command. Note that if you don't want the acronym on subsequent use %to use \cs{smaller}, you will also need to redefine \cs{acronymfont}, -%as above. For example to make the acronym emphasized on first use, -%but use the surrounding font for subsequent use, you can do: +%as above. For example to make the acronym emphasized on +%\firstuse, but use the surrounding font for subsequent use, you can do: %\begin{verbatim} %\usepackage[smaller]{glossaries} %\renewcommand*{\firstacronymfont}[1]{\emph{#1}} %\renewcommand*{\acronymfont}[1]{#1} %\end{verbatim} % -%\item I don't have Perl installed, do I have to use +%\item \textbf{Q.} I don't have Perl installed, do I have to use %\appname{makeglossaries}? % -%Read \autoref{sec:xindyapp} or +%\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}. % % -%\item I'm used to using the \sty{glossary} package: are there any +%\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? % -%Read the file \texttt{glossary2glossaries.pdf} which should be available from the +%\textbf{A.} Read the file \texttt{glossary2glossaries.pdf} which should be available from the %same location as this document. % -%\item I'm using \isty{babel} but the fixed names haven't been +%\item \textbf{Q.} I'm using \isty{babel} but the fixed names haven't been %translated. % -%The \sty{glossaries} package currently only supports the following +%\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 @@ -986,9 +1020,9 @@ %to the class file. Check the \sty{translator} package documentation %for further details. % -%\item My glossaries haven't appeared. +%\item \textbf{Q.} My glossaries haven't appeared. % -%Remember to do the following: +%\textbf{A.} Remember to do the following: %\begin{itemize} %\item Add \ics{makeglossaries} to the document preamble. % @@ -998,7 +1032,7 @@ %\item Use the commands listed in %\autoref{sec:glslink}, %\autoref{sec:glsadd} or -%\autoref{sec:glssee} for each entry +%\autoref{sec:crossref} for each entry %that you want to appear in the glossary. % %\item Run \LaTeX\ on your document, then run \appname{makeglossaries}, @@ -1307,7 +1341,7 @@ %In this example, the entry name appears as \dq{Matrix} in the %glossary, and either \dq{matrix} or \dq{matrices} in the text. % -%\item The way the term appears on first use can be different +%\item The way the term appears on \firstuse\ can be different %to the way it appears subsequently: %\begin{verbatim} %\newglossaryentry{singmtx}{name=Singular Matrix, @@ -1519,7 +1553,7 @@ %\end{verbatim} % %\end{enumerate} -%\section{Overview}\label{sec:overview} +%\section{Overview of User Commands}\label{sec:overview} % \changes{1.02}{2007 May 25}{added overview section} % %\subsection{Package Options} @@ -1539,7 +1573,7 @@ %the section numbers rather than the section titles. % %\item[\pkgopt{acronym}] This creates a new glossary with the -%label \texttt{acronym}: +%label \texttt{acronym}. This is equivalent to: %\begin{verbatim} %\newglossary[alg]{acronym}{acr}{acn}{\acronymname} %\end{verbatim} @@ -1548,9 +1582,10 @@ %\texttt{main}.\footnote{Actually it sets \ics{acronymtype} to %\ics{glsdefaulttype} if the \pkgopt{acronym} package option is %not used, but \ics{glsdefaulttype} usually has the value -%\texttt{main}.} +%\texttt{main}.} %Entries that are defined using \ics{newacronym} are placed in -%the glossary whose label is given by \ics{acronymtype}. +%the glossary whose label is given by \ics{acronymtype}, unless +%another glossary is explicitly specified. % %\item[\pkgopt{section}] This is a \meta{key}=\meta{value} option. Its %value should be the name of a sectional unit (e.g.\ chapter). @@ -1627,6 +1662,44 @@ %\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 +%you use this option, you won't be able to use any of the +%glossary styles defined in the \sty{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 +%you use this option, you won't be able to use any of the +%glossary styles defined in the \sty{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 +%you use this option, you won't be able to use any of the +%glossary styles defined in the \sty{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 +%you use this option, you won't be able to use any of the +%glossary styles defined in the \sty{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 +%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 +%optional argument to \ics{printglossary}. +% %\item[\pkgopt{nonumberlist}] This option will suppress the %associated number lists\iterm{number list} in the glossaries (see also %\autoref{sec:numberlists}). @@ -1696,7 +1769,7 @@ %The indexing style file will been given a \filetype{.xdy} extension. % %The \pkgopt{xindy} package option may additionally have a -%value that is a key=value comma-separated list to override +%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} @@ -1725,7 +1798,8 @@ %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} and \autoref{sec:glsadd}) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary file +%(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 %corresponding \filetype{.gls} file which contains the typeset %glossary which is input by \ics{printglossary} or @@ -1821,7 +1895,9 @@ %can do \verb|description={\nopostdesc}|. If you want a paragraph %break in the description use \DescribeMacro{\glspar}\cs{glspar}. %However, note that not all glossary styles support multi-line -%descriptions. +%descriptions. If you are using one of the tabular-like glossary +%styles that permit multi-line descriptions, use \ics{newline} +%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. @@ -1837,7 +1913,7 @@ %field is omitted, the value of the \gloskey{name} key is used. % %\item[{\gloskey{first}}] How the entry will appear in the document text -%the first time it is used with \ics{gls} (or one of its uppercase +%the first time it is used with \ics{gls}\ifirstusetext\ (or one of its uppercase %variants). If this field is omitted, the value of the \gloskey{text} %key is used. % @@ -1845,9 +1921,11 @@ %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}. % %\item[{\gloskey{firstplural}}] How the entry will appear in the -%document text the first time it is used with \ics{glspl} (or one of its +%document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its %uppercase variants). If this field is omitted, the value is obtained %from the \gloskey{plural} key, if the \gloskey{first} key is omitted, %or by appending \ics{glspluralsuffix} to the value of the @@ -1918,7 +1996,8 @@ %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 \dq{s}. For example: +%the singular form. This command defaults to the letter \dq{s}. +%For example: %\begin{verbatim} %\newglossaryentry{cow}{name=cow,description={a fully grown %female of any bovine animal}} @@ -1985,11 +2064,9 @@ %define the categories as follows: %\begin{verbatim} %\newglossaryentry{greekletter}{name={Greek letters}, -%text={Greek letter}, %description={\nopostdesc}} % %\newglossaryentry{romanletter}{name={Roman letters}, -%text={Roman letter}, %description={\nopostdesc}} %\end{verbatim} % @@ -2066,7 +2143,7 @@ % %\DescribeMacro{\loadglsentries} %You can store all your glossary entry definitions in another -%file, and use:\\[10pt] +%file and use:\\[10pt] %\cs{loadglsentries}\oarg{type}\marg{filename}\\[10pt] %where \meta{filename} is the name of the file containing all the %\cs{newglossaryentry} commands. The optional argument @@ -2155,7 +2232,7 @@ %\end{important} % %With both \appname{makeindex} and \appname{xindy}, you can replace -%separator and the closing number in the range using:\\[10pt] +%the separator and the closing number in the range using:\\[10pt] %\DescribeMacro{\glsSetSuffixF}\cs{glsSetSuffixF}\marg{suffix}\\ %\DescribeMacro{\glsSetSuffixFF}\cs{glsSetSuffixFF}\marg{suffix}\\[10pt] %where the former command specifies the suffix to use for a 2 page @@ -2227,6 +2304,13 @@ %\renewcommand*{\glstextformat}[1]{\textsf{#1}} %\end{verbatim} % +%Each entry has an associated conditional referred to as the +%\firstuseflag. This determines whether \ics{gls}, +%\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. +% %\DescribeMacro{\glslink} %The command:\\[10pt] %\cs{glslink}\oarg{options}\marg{label}\marg{text}\\[10pt] @@ -2260,13 +2344,14 @@ % %In this document, the standard formats refer to the standard text %block commands such as \ics{textbf} or \ics{emph} or any of the -%commands listed in Table~\ref{tab:hyperxx}. +%commands listed in \tableref{tab:hyperxx}. % %\begin{important} %If you use \appname{xindy} instead of \appname{makeindex}, you %must specify any non-standard formats that you want to use %with the \gloskey[glslink]{format} key using -%\ics{GlsAddXdyAttribute}\marg{name}. For example +%\ics{GlsAddXdyAttribute}\marg{name}. So if you use +%\appname{xindy} with the above example, you would need to add: %\begin{verbatim} %\GlsAddXdyAttribute{textbfem} %\end{verbatim} @@ -2282,7 +2367,7 @@ %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 -%formats listed in Table~\ref{tab:hyperxx}. +%formats listed in \tableref{tab:hyperxx}. % %\begin{table}[htbp] %\caption{Predefined Hyperlinked Location Formats} @@ -2316,7 +2401,7 @@ %\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:printglos}.) Remember that if you use \appname{xindy}, you will need to add +%key. (See also \autoref{sec:code:printglos}.) Remember that if you use \appname{xindy}, you will need to add %this to the list of location attributes: %\begin{verbatim} %\GlsAddXdyAttribute{hyperbsf} @@ -2346,9 +2431,9 @@ %is determined from the values of the \gloskey{text} and %\gloskey{first} keys supplied when the entry was defined using %\ics{newglossaryentry}. If the entry has been marked as having -%been used, the value of the \gloskey{text} key will be used, otherwise +%been used\ifirstuseflag, the value of the \gloskey{text} key will be used, otherwise %the value of the \gloskey{first} key will be used. -%On completion, \cs{gls} will mark the entry given by \meta{label} as +%On completion, \cs{gls} will mark the entry's first use flag\ifirstuseflag\ as %used. % %There are two uppercase variants:\\[10pt] @@ -2357,7 +2442,7 @@ %and\\[10pt] %\DescribeMacro{\GLS} %\cs{GLS}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -%which make the first letter of the link or all the link text +%which make the first letter of the link text or all the link text %uppercase, respectively. % %The final optional argument \meta{insert}, allows you to insert @@ -2385,8 +2470,9 @@ %\DescribeMacro{\glstext}The command:\\[10pt] %\cs{glstext}\oarg{options}\marg{label}\oarg{insert}\\[10pt] %is similar to \ics{gls} except that it always uses the value -%of the \gloskey{text} key and does not mark the entry as -%having been used. Unlike \cs{gls}, the inserted text \meta{insert} +%of the \gloskey{text} key and does not affect the +%\firstuseflag. +%Unlike \cs{gls}, the inserted text \meta{insert} %is always appended to the link text. % %There are also analogous commands:\\[10pt] @@ -2401,8 +2487,8 @@ %\cs{glsfirst}\oarg{options}\marg{label}\oarg{insert}\\[10pt] %is similar to \ics{glstext} except that it always uses the value %of the \gloskey{first} key. Again, \meta{insert} is always appended -%to the end of the link text and does not mark the entry as having -%been used. +%to the end of the link text and does not affect the +%\firstuseflag. % %There are also analogous commands:\\[10pt] %\DescribeMacro{\Glsfirst} @@ -2501,15 +2587,16 @@ %The format of the \term{link text} for \ics{gls}, \ics{glspl} %and their uppercase variants is governed by two commands: %\DescribeMacro{\glsdisplayfirst}\cs{glsdisplayfirst}, which is used the -%first time a glossary entry is used in the text and +%first time a glossary entry is used\ifirstuse\ in the text and %\DescribeMacro{\glsdisplay}\cs{glsdisplay}, which is used subsequently. %Both commands take four arguments: the first is either the singular or %plural form given by the \gloskey{text}, \gloskey{plural}, -%\gloskey{first} or \gloskey{firstplural} keys (used when the term was +%\gloskey{first} or \gloskey{firstplural} keys (set when the term was %defined) depending on context; the second argument is the term's -%description (as supplied by the \gloskey{description} key); the third +%description (as supplied by the \gloskey{description} or +%\gloskey{descriptionplural} keys); the third %argument is the symbol associated with the term (as supplied by the -%\gloskey{symbol} key) and the fourth argument is the additional text +%\gloskey{symbol} or \gloskey{symbolplural} keys) and the fourth argument is the additional text %supplied in the final optional argument to \cs{gls} or %\cs{glspl} (or their uppercase variants). The default definitions %of \cs{glsdisplay} and \cs{glsdisplayfirst} simply @@ -2533,7 +2620,7 @@ %symbol={km}} %\end{verbatim} %and now suppose you want \verb|\gls{distance}| to produce -%\dq{distance (km)} on first use, then you can redefine +%\dq{distance (km)} on \firstuse, then you can redefine %\cs{glsdisplayfirst} as follows: %\begin{verbatim} %\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)} @@ -2542,7 +2629,7 @@ %\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 -%the two points} --- but in this instance it may be better not to +%the two points} --- but in this instance it would be better not to %use a contraction). % %Note also that all of the \term{link text} will be formatted according @@ -2558,9 +2645,11 @@ %glossaries appear when using the commands \cs{gls}, \cs{glspl} and their %uppercase variants. If you only %want the change to affect entries for a given glossary, then you need -%to use \DescribeMacro{\defglsdisplay}\cs{defglsdisplay} and -%\DescribeMacro{\defglsdisplayfirst}\cs{defglsdisplayfirst} instead -%of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}. +%to use\\[10pt] +%\DescribeMacro{\defglsdisplay}\cs{defglsdisplay}\oarg{type}\marg{definition}\\[10pt] +%and\\[10pt] +%\DescribeMacro{\defglsdisplayfirst}\cs{defglsdisplayfirst}\oarg{type}\marg{definition}\\[10pt] +%instead of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}. % %Both \cs{defglsdisplay} and \cs{defglsdisplayfirst} take two arguments: %the first (which is optional) is the glossary's label\footnote{\texttt{main} for the main @@ -2573,7 +2662,7 @@ % %For example, suppose you have created a new glossary called %\texttt{notation} and you want to change the way the entry is -%displayed on first use so that it includes the symbol, you can +%displayed on \firstuse\ so that it includes the symbol, you can %do: %\begin{verbatim} %\defglsdisplayfirst[notation]{#1#4 (denoted #3)} @@ -2714,8 +2803,7 @@ %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 flag that determines if the term has been -%used and, apart from \ics{glshyperlink}, they don't produce +%they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce %hyperlinks. %\par\vskip10pt\noindent %\DescribeMacro{\glsentryname}\cs{glsentryname}\marg{label}\\ @@ -2738,13 +2826,13 @@ %\par\vskip10pt\noindent %\DescribeMacro{\glsentryfirst}\cs{glsentryfirst}\marg{label}\\ %\DescribeMacro{\Glsentryfirst}\cs{Glsentryfirst}\marg{label}\par\vskip10pt\noindent -%These commands display the first use text for the glossary entry +%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. %\par\vskip10pt\noindent %\DescribeMacro{\glsentryfirstplural}\cs{glsentryfirstplural}\marg{label}\\ %\DescribeMacro{\Glsentryfirstplural}\cs{Glsentryfirstplural}\marg{label}\par\vskip10pt\noindent -%These commands display the plural form of the first use text for the +%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. @@ -3029,7 +3117,7 @@ %\renewcommand*{\thepage}{\Numberstring{page}} %\end{verbatim} %This gets expanded to \verb|\protect \Numberstringnum |\marg{n} -%where \meta{n} is the page number. This means that you need to +%where \meta{n} is the Arabic page number. This means that you need to %define a new location that has that form: %\begin{verbatim} %\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space @@ -3067,8 +3155,9 @@ %\texttt{see} (cross-referenced entries). %This ordering can be changed using:\\[10pt] %\DescribeMacro{\GlsSetXdyLocationClassOrder} -%\cs{GlsSetXdyLocationClassOrder}\\[10pt] -%where each location name is delimited by double quote marks. +%\cs{GlsSetXdyLocationClassOrder}\marg{location names}\\[10pt] +%where each location name is delimited by double quote marks and +%separated by white space. %For example: %\begin{verbatim} %\GlsSetXdyLocationClassOrder{ @@ -3170,12 +3259,17 @@ %\texttt{acronym}, if the \pkgopt{acronym} option has been used, %otherwise it is set to \texttt{main}. % +%\begin{important} +%All glossaries must be defined before \ics{makeglossaries} to +%ensure that the relevant output files are opened. +%\end{important} +% %\subsection{Acronyms} %\label{sec:acronyms} % %\DescribeMacro{\newacronym} -%As you may have noticed in \autoref{sec:newglosentry}, when you specify a new entry, you can specify alternate text to use when -%the term is first used in the document. This provides a useful +%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:\\[10pt] %\cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt] @@ -3222,7 +3316,7 @@ %firstplural={identification numbers (IDNs)}} %\end{verbatim} %so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on -%first use and \dq{IDN} on subsequent uses. +%\firstuse\ and \dq{IDN} on subsequent uses. % %This section describes acronyms that have been defined using %\cs{newacronym}. If you prefer to define all your acronyms using @@ -3234,37 +3328,44 @@ %\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 -%\cs{newacronym}. -% -% -%\Tableref{tab:acronymsettings} lists the package options and how the -%\ics{newglossaryentry} keys are used to store \meta{long} (the long -%form) and \meta{abbrv} (the short form). Note that the -%\pkgopt{smallcaps} option redefines -%\DescribeMacro{\acronymfont}\cs{acronymfont} so that it sets its -%argument using \cs{textsc} (so you should use lower case characters in -%\meta{abbrv}) and the \pkgopt{smaller} option redefines -%\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load a -%package, such as \sty{relsize}, that defines \cs{smaller} if you use -%this option.} otherwise \cs{acronymfont} simply displays its argument -%in the surrounding font. Note also that if none of the package options -%\pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{dua}, -%\pkgopt{description} or \pkgopt{footnote} are used, \cs{acronymfont} is -%not used, so changing the definition of \cs{acronymfont} will have no -%effect under such circumstances. -% -%If you want to display the acronym in another font, for example, -%emphasized, then use the \pkgopt{smaller} package option and -%redefine \ics{acronymfont} to use the required font. For example: +%\ics{newacronym}. +% +%If you use any of the package options \pkgopt{smallcaps}, +%\pkgopt{smaller}, \pkgopt{description} or +%\pkgopt{footnote}, the acronyms will be displayed in the document +%using:\\[10pt] +%\DescribeMacro{\acronymfont}\cs{acronymfont}\marg{text}\\[10pt] +%and\\[10pt] +%\DescribeMacro{\firstacronymfont}\cs{firstacronymfont}\marg{text}\\[10pt] +%where \cs{firstacronymfont} is applied on \firstuse\ and +%\cs{acronymfont} is applied on subsequent use. Note that if you +%don't use any of the above package options, changing the +%definition of \cs{acronymfont} or \cs{firstacronymfont} will have +%no effect. In this case, the recommended route is to use +%the \pkgopt{smaller} package option and redefine \cs{acronymfont} +%and \cs{firstacronymfont} as required. For example, if you want +%acronyms in a normal font on first use and emphasized on +%subsequent use, do: %\begin{verbatim} %\usepackage[smaller]{glossaries} +%\renewcommand*{\firstacronymfont}[1]{#1} %\renewcommand*{\acronymfont}[1]{\emph{#1}} %\end{verbatim} -%Where \cs{acronymfont} is available, -%\DescribeMacro{\firstacronymfont}\cs{firstacronymfont} is also -%available. By default, this simply uses \cs{acronymfont}, but it -%can be redefined to change the way the acronym is displayed on -%first use. +%(Note that it is for this reason that the \isty{relsize} package +%is not automatically loaded when selecting the +%\pkgopt{smaller} package option.) +% +%\Tableref{tab:acronymsettings} lists the package options that govern +%the acronym styles and how the \ics{newglossaryentry} keys are used +%to store \meta{long} (the long form) and \meta{abbrv} (the short +%form). Note that the \pkgopt{smallcaps} option redefines +%\cs{acronymfont} so that it sets its +%argument using \cs{textsc} (so you should use lower case characters +%in \meta{abbrv}) and the \pkgopt{smaller} option redefines +%\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load +%a package, such as \sty{relsize}, that defines \cs{smaller} if you +%use this option.} otherwise \cs{acronymfont} simply displays its +%argument in the surrounding font. % %\begin{table}[htbp] %\caption{Package options governing \cs{newacronym} and how the @@ -3339,7 +3440,7 @@ %\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal %matrix} %\end{verbatim} -%If the first use uses the plural form, \verb|\glspl{dm}| will +%If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will %display: diagonal matrices (DMs). % %Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, @@ -3353,7 +3454,7 @@ %glossary type. % %\begin{description} -%\item[\pkgopt{description},\pkgopt{footnote}]\mbox{}\par When these two package options are used together, the first use displays +%\item[\pkgopt{description},\pkgopt{footnote}]\mbox{}\par When these two package options are used together, the \firstuse\ displays %the entry as:\\[10pt] %\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} %\\[10pt] @@ -3377,7 +3478,7 @@ % %\item[\pkgopt{dua}]\mbox{}\par 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 first use and subsequent use displays the +%\pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the %entry in the form:\\[10pt] %\meta{long}\meta{insert}\\[10pt] %If the \pkgopt{description} package option is also used, the @@ -3394,7 +3495,7 @@ %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 first use as:\\[10pt] +%\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] @@ -3422,7 +3523,7 @@ %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 first use as:\\[10pt] +%\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] @@ -3433,15 +3534,15 @@ %\ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so %remember to protect fragile commands when defining acronyms. % -%Note that on first use, it is the long form in the footnote that +%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 first use have the hyperlink instead of the footnote, but +%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 first use to make the +%The code required to change the \firstuse\ to make the %acronym a hyperlink is as follows: %\begin{verbatim} % \defglsdisplayfirst[\acronymtype]{% @@ -3453,11 +3554,10 @@ %(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.) +%(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 first use as:\\[10pt] +%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] @@ -3475,7 +3575,7 @@ %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 first use as:\\[10pt] +%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] @@ -3495,7 +3595,7 @@ % %\item[None of the above]\mbox{}\par If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, %\pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, -%then on first use the entry is displayed as:\\[10pt] +%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] @@ -3517,7 +3617,7 @@ %\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\ %\DescribeMacro{\ACRshort} %\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -%Print the abbreviated version with a hyperlink (if necessary) to the +%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}. @@ -3528,7 +3628,7 @@ %\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\ %\DescribeMacro{\ACRlong} %\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\[10pt] -%Print the long version with a hyperlink (if necessary) to the +%Print the long version with (if required) a hyperlink to the %relevant entry in the glossary. This is may be equivalent to %\ics{glsdesc}, \ics{glssymbol} or \ics{glsfirst} (or their uppercase %variants), depending on package options. @@ -3540,7 +3640,7 @@ %\DescribeMacro{\ACRfull} %\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert}\\[10pt] %Print the long version followed by the abbreviation in brackets -%with a hyperlink (if necessary) to the +%with (if required) a hyperlink to the %relevant entry in the glossary. % %Note that if you change the definition of \ics{newacronym}, you @@ -3582,12 +3682,87 @@ %\end{table} % % +%\subsubsection{Upgrading From the glossary Package} +%Users of the obsolete \isty{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 +%\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 \isty{glossaries} package\footnote{as from version 1.18} +%provides the command:\\[10pt] +%\DescribeMacro{\oldacronym}\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list}\\[10pt] +%This uses the same syntax as the \isty{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 +%\cs{}\meta{label}, which is equivalent to \ics{gls}\marg{label}, +%and \cs{}\meta{label}\texttt{*}, which is equivalent to +%\ics{Gls}\marg{label}. If \meta{label} is omitted, \meta{abbrv} +%is used. Since commands names must consist only of alphabetical +%characters, \meta{label} must also only consist of alphabetical +%characters. Note that \cs{}\meta{label} doesn't allow you to use +%the first optional argument of \ics{gls} or \ics{Gls} --- you will +%need to explicitly use \ics{gls} or \ics{Gls} to change the +%settings. +% +%\begin{important} +%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. +%\end{important} +% +%The \isty{glossaries} package doesn't load the \isty{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 +%\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 +%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 +%follows: +%\begin{verbatim} +%\oldacronym{abc}{example acronym}{} +%\end{verbatim} +%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 +%optional argument from being recognised. +% +%\begin{table}[htbp] +%\caption[The effect of using xspace]{The effect of using +%\sty{xspace} with \cs{oldacronym}} +%\label{tab:xspace} +%\vskip\baselineskip +%\centering +%\begin{tabular}{lll} +%\bfseries Code & \bfseries With \sty{xspace} & +%\bfseries Without \sty{xspace}\\ +%\verb|\abc.| & abc. & abc.\\ +%\verb|\abc xyz| & abc xyz & abcxyz\\ +%\verb|\abc\ xyz| & abc xyz & abc xyz\\ +%\verb|\abc* xyz| & Abc xyz & Abc xyz\\ +%\verb|\abc['s] xyz| & abc ['s] xyz & abc's xyz +%\end{tabular} +%\par +%\end{table} +% +% %\subsection{Unsetting and Resetting Entry Flags} +%\label{sec:glsunset} % %When using \ics{gls}, \ics{glspl} and their uppercase variants it is %possible that you may want to use the value given by the %\gloskey{first} key, even though you have already used the glossary -%entry. Conversely, you may want to use the value given by the +%entry\ifirstuse. Conversely, you may want to use the value given by the %\gloskey{text} key, even though you haven't used the glossary entry. %The former can be achieved by one of the following commands:\\[10pt] %\DescribeMacro{\glsreset}\cs{glsreset}\marg{label}\\ @@ -3596,7 +3771,21 @@ %\DescribeMacro{\glsunset}\cs{glsunset}\marg{label}\\ %\DescribeMacro{\glslocalunset}\cs{glslocalunset}\marg{label} %\\[10pt] -%You can determine whether an entry has been used using:\\[10pt] +%You can also reset or unset all entries for a given glossary or list of +%glossaries using:\\[10pt] +%\DescribeMacro{\glsresetall}\cs{glsresetall}\oarg{glossary list}\\ +%\DescribeMacro{\glslocalresetall}\cs{glslocalresetall}\oarg{glossary list}\\ +%\DescribeMacro{\glsunsetall}\cs{glsunsetall}\oarg{glossary list}\\ +%\DescribeMacro{\glslocalunsetall}\cs{glslocalunsetall}\oarg{glossary list}\\[10pt] +%where \meta{glossary list} 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: +%\begin{verbatim} +%\glsresetall[main,acronym] +%\end{verbatim} +% +%You can determine whether an entry's first use flag is set using:\\[10pt] %\DescribeMacro{\ifglsused} %\cs{ifglsused}\marg{label}\marg{true part}\marg{false part}\\[10pt] %where \meta{label} is the label of the required entry. If the @@ -3612,8 +3801,114 @@ %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. -%The predefined styles are as follows: +%that suits your type of glossary. See \tableref{tab:styles} for +%a summary of the available styles. +% +%\begin{table}[htbp] +%\caption[Glossary Styles]{Glossary Styles. An asterisk in the style +%name indicates anything that matches that doesn't match any +%previously listed style (e.g.\ \texttt{long3col*} +%matches \glostyle{long3col}, \glostyle{long3colheader}, +%\glostyle{long3colborder} and \glostyle{long3colheaderborder}). +%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 +%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.} +%\label{tab:styles} +%\vskip\baselineskip +%\centering +%\begin{tabular}{lccc} +%\bfseries Style & \bfseries Maximum Level & +%\bfseries Homograph & \bfseries Symbol\\ +%\ttfamily listdotted & 0 & & \\ +%\ttfamily sublistdotted & 1 & & \\ +%\ttfamily list* & 1 & \tick & \\ +%\ttfamily altlist* & 1 & \tick & \\ +%\ttfamily long3col* & 1 & \tick & \\ +%\ttfamily long4col* & 1 & \tick & \tick \\ +%\ttfamily altlong4col* & 1 & \tick & \tick \\ +%\ttfamily long* & 1 & \tick & \\ +%\ttfamily super3col* & 1 & \tick & \\ +%\ttfamily super4col* & 1 & \tick & \tick \\ +%\ttfamily altsuper4col* & 1 & \tick & \tick \\ +%\ttfamily super* & 1 & \tick & \\ +%\ttfamily index* & 2 & & \tick\\ +%\ttfamily treenoname* & --- & \tick & \tick\\ +%\ttfamily tree* & --- & & \tick\\ +%\ttfamily alttree* & --- & & \tick +%\end{tabular} +%\par +%\end{table} +% +%The glossary style can be set using the \pkgopt{style} package option +%or using the \gloskey[printglossary]{style} key in the optional +%argument to \ics{printglossary} or using the command:\\[10pt] +%\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] +%The tabular-like styles that allow multi-line descriptions and page +%lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} +%to set the width of the description column and the length +%\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the +%width of the page list column.\footnote{these lengths will not be +%available if you use both the \pkgopt{nolong} and \pkgopt{nosuper} +%package options or if you use the \pkgopt{nostyles} package option.} +%These will need to be changed using \cs{setlength} if the glossary +%is too wide. Note that the \glostyle{long4col} and +%\glostyle{super4col} 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 \glostyle{altlong4col} +%and \glostyle{altsuper4col} styles. If you want to +%explicitly create a line-break within a multi-line description in +%a tabular-like style you should use \ics{newline} instead of +%\verb|\\|. +% +%Note that if you use the \gloskey[printglossary]{style} key in the +%optional argument to \ics{printglossary}, it will override any +%previous style settings for the given glossary, so if, for example, +%you do +%\begin{verbatim} +%\renewcommand*{\glsgroupskip}{} +%\printglossary[style=long] +%\end{verbatim} +%then the new definition of \ics{glsgroupskip} will not have an affect +%for this glossary, as \cs{glsgroupskip} is redefined by +%\verb|style=long|. Likewise, \ics{glossarystyle} will also +%override any previous style definitions, so, again +%\begin{verbatim} +%\renewcommand*{\glsgroupskip}{} +%\glossarystyle{long} +%\end{verbatim} +%will reset \cs{glsgroupskip} back to its default definition for the +%named glossary style (\glostyle{long} in this case). If you want to +%modify the styles, either use \ics{newglossarystyle} (described +%in the next section) or make the modifications after +%\ics{glossarystyle}, e.g.: +%\begin{verbatim} +%\glossarystyle{long} +%\renewcommand*{\glsgroupskip}{} +%\end{verbatim} +% +% \changes{1.03}{2007 July 4}{'glspostdescription added} +%All the styles except for the three- and four-column styles and the +%\glostyle{listdotted} style use the command +%\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. +% +%\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} +%environment, they are governed by the same parameters as that +%environment. These styles all ignore the entry's symbol. Note that +%these styles will not be available if you use either the +%\pkgopt{nolist} or \pkgopt{nostyles} package options. % %\begin{description} %\item[list] The \glostyle{list} style uses the \envname{description} @@ -3631,7 +3926,7 @@ %\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 +%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, @@ -3661,14 +3956,30 @@ %\glostyle{listhypergroup}, described above. % %\item[listdotted] This style uses the \envname{description} -%environment. 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.\footnote{This style was -%supplied by Axel~Menzel.} This is a flat style, so child +%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. % +%\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} +% +%\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} +%environment, they are governed by the same parameters as that +%environment. Note that these styles will not be available if you +%use either the \pkgopt{nolong} or \pkgopt{nostyles} package options. +% +%\begin{description} %\item[long] The \glostyle{long} style uses the \envname{longtable} %environment (defined by the \isty{longtable} package). It has two %columns: the first column contains the entry's name and the second @@ -3748,7 +4059,22 @@ %\item[altlong4colheaderborder] The \glostyle{altlong4colheaderborder} %style is like \glostyle{long4colheaderborder} but allows multi-line %descriptions and page lists. +%\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} +%environment, they are governed by the same parameters as that +%environment. Note that these styles will not be available if you +%use either the \pkgopt{nosuper} or \pkgopt{nostyles} package options. +%In general, the \envname{longtable} environment is better, but there +%are some circumstances where it is better to use +%\envname{supertabular}.\footnote{e.g.\ with the \isty{flowfram} +%package.} +% +%\begin{description} %\item[super] The \glostyle{super} style uses the \envname{supertabular} %environment (defined by the \isty{supertabular} package). It has two %columns: the first column contains the entry's name and the second @@ -3829,14 +4155,27 @@ %\item[altsuper4colheaderborder] The \glostyle{altsuper4colheaderborder} %style is like \glostyle{super4colheaderborder} but allows multi-line %descriptions and page lists. +%\end{description} +% +%\subsubsection{Tree-Like Styles} +%\label{sec:treestyles} % -%\item[index] The \glostyle{index} style is similar to the -%way indices are usually formatted in that it has a -%hierarchical structure up to three 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 (if present) and the description. -%Groups are separated using \ics{indexspace}. +%The styles described in this section are all defined in the package +%\isty{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 not be available if you +%use either the \pkgopt{notree} or \pkgopt{nostyles} package options. +% +%\begin{description} +%\item[index] The \glostyle{index} 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 \ics{indexspace}. % %\item[indexgroup] The \glostyle{indexgroup} style is similar to %the \glostyle{index} style except that each group has a heading. @@ -3902,60 +4241,6 @@ % %\end{description} % -%The glossary style can be set using the \pkgopt{style} package option -%or using the \gloskey[printglossary]{style} key in the optional -%argument to \ics{printglossary} or using the command:\\[10pt] -%\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] -%The tabular-like styles that allow multi-line descriptions and page -%lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} to -%set the width of the description column and the length -%\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the -%width of the page list column. These will need to be changed using -%\cs{setlength} if the glossary is too wide. Note that the -%\glostyle{long4col} and \glostyle{super4col} 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 -%\glostyle{altlong4col} and \glostyle{altsuper4col} styles. -%Note that if you want to explicitly create a line-break within -%a multi-line description you should use \ics{newline} instead -%of \verb|\\|. -% -%Note that if you use the \gloskey[printglossary]{style} key in the -%optional argument to \ics{printglossary}, it will override any -%previous style settings for the given glossary, so if, for example, -%you do: -%\begin{verbatim} -%\renewcommand*{\glsgroupskip}{} -%\printglossary[style=long] -%\end{verbatim} -%The new definition of \ics{glsgroupskip} will not have an affect -%for this glossary, as \cs{glsgroupskip} is redefined by -%\verb|style=long|. Likewise, \ics{glossarystyle} will also -%override any previous style definitions, so, again: -%\begin{verbatim} -%\renewcommand*{\glsgroupskip}{} -%\glossarystyle{long} -%\end{verbatim} -%will reset \cs{glsgroupskip} back to its default definition for the -%named glossary style (\glostyle{long} in this case). If you want to -%modify the styles, either use \ics{newglossarystyle} (described -%in the next section) or make the modifications after -%\ics{glossarystyle}, e.g.: -%\begin{verbatim} -%\glossarystyle{long} -%\renewcommand*{\glsgroupskip}{} -%\end{verbatim} -% -% \changes{1.03}{2007 July 4}{'glspostdescription added} -%All the styles except for the three- and four-column styles and the -%\glostyle{listdotted} style use the command -%\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. -% % %\subsection{Defining your own glossary style} %\label{sec:newglossarystyle} @@ -3991,20 +4276,37 @@ % %\item %\DescribeMacro{\glsgroupheading} -%\cs{glsgroupheading}\marg{label}\par\noindent -%This macro indicates what to do at the start of each logical block -%within the main body of the glossary. The glossary is sub-divided into -%twenty-eight logical blocks that are determined by the first character -%of the \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\@. (This may be different if you use -%\appname{xindy}.) Note that the argument to \cs{glsgroupheading} +%\cs{glsgroupheading}\marg{label}\par\noindent 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 +%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 +%the language settings. +% +%Note that the argument to \cs{glsgroupheading} %is a label \emph{not} the group title. The group title can be obtained -%via \cs{glsgetgrouptitle}\marg{label}, and a navigation hypertarget can -%be created using \cs{glsnavhypertarget}\marg{label}. Most of the -%predefined glossary styles redefine \cs{glsgroupheading} to simply -%ignore its argument. The \glostyle{listhypergroup} style redefines -%\cs{glsgroupheading} as follows: +%via +% +%\DescribeMacro{\glsgetgrouptitle}\cs{glsgetgrouptitle}\marg{label} +% +%This obtains the title as follows: if +%\cs{}\meta{label}\texttt{groupname} exists, this is taken to be the +%title, otherwise the title is just \meta{label}. +% +%A navigation hypertarget can be created using +% +%\DescribeMacro{\glsnavhypertarget}\cs{glsnavhypertarget}\marg{label}\marg{text} +% +%For further details about \cs{glsnavhypertarget}, see +%\autoref{sec:code:hypernav}. +% +% +%Most of the predefined glossary styles redefine \cs{glsgroupheading} +%to simply ignore its argument. The \glostyle{listhypergroup} style +%redefines \cs{glsgroupheading} as follows: %\begin{verbatim} %\renewcommand*{\glsgroupheading}[1]{% %\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} @@ -4032,20 +4334,25 @@ %font for the entry name, regardless of the glossary style used. %Note that \meta{label} is the label used when the glossary entry %was defined via either \cs{newglossaryentry} or \cs{newacronym}. -%Each time you use a glossary entry it creates a -%link\footnote{if the document doesn't have hyperlinks enabled -%\cs{@glslink} ignores the label and simply typesets the text.} -%using \cs{@glslink}\marg{label}\marg{text} with the label -%\texttt{glo:}\meta{label}. Your -%new glossary style must therefore redefine \cs{glossaryentryfield} -%so that it uses \cs{@glstarget}\verb|{|\texttt{glo:}\meta{label}\verb|}|\marg{text} -%to ensure the hyperlinks function correctly.\footnote{again, if the -%document doesn't support hyperlinks, \cs{@glstarget} will ignore -%the label, and just typeset the text.} For example, the +% +%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 +%\cs{glossaryentryfield} to set the appropriate target. This +%is done using +% +%\DescribeMacro{\glstarget}\cs{glstarget}\marg{label}\marg{text} +% +%where \meta{label} is the entry's label. Note that you +%don't need to worry about whether the \isty{hyperref} package has +%been loaded, as \cs{glstarget} won't create a target if +%\cs{hypertarget} hasn't been defined. +% +%For example, the %\glostyle{list} style defines \cs{glossaryentryfield} as follows: %\begin{verbatim} %\renewcommand*{\glossaryentryfield}[5]{% -%\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5} +%\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5} %\end{verbatim} % %Note also that \meta{number list} will always be of the form\\[10pt] @@ -4078,21 +4385,21 @@ %remaining arguments are analogous to those for %\ics{glossaryentryfield} described above. %\end{description} +% +%For further details of these commands, see +%\autoref{sec:code:printglos}. %\subsubsection{Example: creating a completely new style} % %If you want a completely new style, you will need to redefine all -%of the commands and environment listed above. You also need to -%take care when using internal commands (commands whose name -%contain the @ symbol). These should either be used in a \texttt{.sty} -%file or must be placed within \cs{makeatletter} and \cs{makeatother}. +%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 %environment. Let's also suppose that you don't want anything between -%the glossary groups (so \cs{glsgroupheading} and \cs{glsgroupskip} +%the glossary groups (so \ics{glsgroupheading} and \ics{glsgroupskip} %should do nothing) and suppose you don't want anything to appear -%immediately after \verb|\begin{theglossary}| (so \cs{glossaryheader} +%immediately after \verb|\begin{theglossary}| (so \ics{glossaryheader} %should do nothing). In addition, let's suppose the symbol should %appear in brackets after the name, followed by the description and %last of all the \term{number list} should appear within square brackets @@ -4110,14 +4417,14 @@ % % set how each entry should appear: % \renewcommand*{\glossaryentryfield}[5]{% % \item % bullet point -% \@glstarget{glo:##1}{##2}% the entry name +% \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}}% +% \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}% % } %\end{verbatim} %Note that this style creates a flat glossary, where sub-entries @@ -4210,7 +4517,7 @@ %\end{verbatim} %(Remember that command names that contain the @ character must %either be placed in packages or be placed between \cs{makeatletter} -%\cs{makeatother}.) +%and \cs{makeatother}.) % % % \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} @@ -4229,7 +4536,7 @@ % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2008/12/26 v1.17 (NLCT)] +\ProvidesPackage{glossaries}[2009/01/14 v1.18 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -4381,6 +4688,96 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@loadlong} +%\changes{1.18}{2009 January 14}{new} +% \begin{macrocode} +\newcommand*{\@gls@loadlong}{\RequirePackage{glossary-long}} +% \end{macrocode} +%\end{macro} +%\begin{macro}{nolong} +%\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 +% is provided to reduce overhead caused by loading unrequired +% packages. +% \begin{macrocode} +\DeclareOptionX{nolong}{\renewcommand*{\@gls@loadlong}{}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@gls@loadsuper} +%\changes{1.18}{2009 January 14}{new} +% The \isty{glossary-super} package isn't loaded if +% \isty{supertabular} isn't installed. +% \begin{macrocode} +\IfFileExists{supertabular.sty}{% + \newcommand*{\@gls@loadsuper}{\RequirePackage{glossary-super}}}{% + \newcommand*{\@gls@loadsuper}{}} +% \end{macrocode} +%\end{macro} +%\begin{macro}{nosuper} +%\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 +% is provided to reduce overhead caused by loading unrequired +% packages. +% \begin{macrocode} +\DeclareOptionX{nosuper}{\renewcommand*{\@gls@loadsuper}{}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@gls@loadlist} +%\changes{1.18}{2009 January 14}{new} +% \begin{macrocode} +\newcommand*{\@gls@loadlist}{\RequirePackage{glossary-list}} +% \end{macrocode} +%\end{macro} +%\begin{macro}{nolist} +%\changes{1.18}{2009 January 14}{new} +% This option prevents \isty{glossary-list} from being loaded +% (to reduce overheads if required). Naturally, the styles defined +% in \isty{glossary-list} will not be available if this option +% is used. +% \begin{macrocode} +\DeclareOptionX{nolist}{\renewcommand*{\@gls@loadlist}{}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@gls@loadtree} +%\changes{1.18}{2009 January 14}{new} +% \begin{macrocode} +\newcommand*{\@gls@loadtree}{\RequirePackage{glossary-tree}} +% \end{macrocode} +%\end{macro} +%\begin{macro}{notree} +%\changes{1.18}{2009 January 14}{new} +% This option prevents \isty{glossary-tree} from being loaded +% (to reduce overheads if required). Naturally, the styles defined +% in \isty{glossary-tree} will not be available if this option +% is used. +% \begin{macrocode} +\DeclareOptionX{notree}{\renewcommand*{\@gls@loadtree}{}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{nostyles} +%\changes{1.18}{2009 January 14}{new} +% Provide an option to suppress all the predefined styles (in the +% event that the user has custom styles that are not dependent +% on the predefined styles). +% \begin{macrocode} +\DeclareOptionX{nostyles}{% + \renewcommand*{\@gls@loadlong}{}% + \renewcommand*{\@gls@loadsuper}{}% + \renewcommand*{\@gls@loadlist}{}% + \renewcommand*{\@gls@loadtree}{}% + \let\@glossary@default@style\relax +} +% \end{macrocode} +%\end{macro} +% % Keep track of the default glossary. This is initialised to % the main glossary, but can be changed if for some reason % you want to make a secondary glossary the main glossary. This @@ -5863,6 +6260,7 @@ exists}% % and \gloskey{description} key before they are sanitized). % % +%\begin{macro}{name} %The \gloskey{name} key indicates the name % of the term being defined. This is how the term will appear in % the glossary. The \gloskey{name} key is required when defining @@ -5872,7 +6270,9 @@ exists}% \def\@glo@name{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{description} % The \gloskey{description} key is usually only used in % the glossary, but can be made to appear in the text by redefining % \ics{glsdisplay} and \ics{glsdisplayfirst} (or @@ -5894,24 +6294,30 @@ exists}% \def\@glo@desc{#1}% } % \end{macrocode} -% \changes{1.12}{2008 Mar 8}{descriptionplural key added} +%\end{macro} +%\begin{macro}{descriptionplural} +% \changes{1.12}{2008 Mar 8}{new} % \begin{macrocode} \define@key{glossentry}{descriptionplural}{% \def\@glo@descplural{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{sort} % The \gloskey{sort} key needs to be sanitized here % (the sort key is provided for \appname{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}. +%\changes{1.18}{2009 January 14}{moved sanitization to 'newglossaryentry} % \begin{macrocode} \define@key{glossentry}{sort}{% -\def\@glo@sort{#1}% -\@onelevel@sanitize\@glo@sort} +\def\@glo@sort{#1}} % \end{macrocode} +%\end{macro} % +%\begin{macro}{text} % The \gloskey{text} key determines how the term should appear when % used in the document (i.e.\ outside of the glossary). If omitted, % the value of the \gloskey{name} key is used instead. @@ -5920,7 +6326,9 @@ exists}% \def\@glo@text{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{plural} % The \gloskey{plural} key determines how the plural form of the term % should be displayed in the document. If omitted, the plural is % constructed by appending \ics{glspluralsuffix} to the value of the @@ -5930,7 +6338,9 @@ exists}% \def\@glo@plural{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{first} % The \gloskey{first} key determines how the entry should be displayed % in the document when it is first used. If omitted, it is taken % to be the same as the value of the \gloskey{text} key. @@ -5939,7 +6349,9 @@ exists}% \def\@glo@first{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{firstplural} % The \gloskey{firstplural} key is used to set the plural form for % first use, in the event that the plural is required the first % time the term is used. If omitted, it is constructed by @@ -5949,7 +6361,9 @@ exists}% \def\@glo@firstplural{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{symbol} % The \gloskey{symbol} key is ignored by most of the predefined % glossary styles, and defaults to \cs{relax} if omitted. % It is provided for glossary styles that require an associated @@ -5966,20 +6380,26 @@ exists}% \def\@glo@symbol{#1}% } % \end{macrocode} -% \changes{1.12}{2008 Mar 8}{symbolplural key added} +%\end{macro} +%\begin{macro}{symbolplural} +% \changes{1.12}{2008 Mar 8}{new} % \begin{macrocode} \define@key{glossentry}{symbolplural}{% \def\@glo@symbolplural{#1}% } % \end{macrocode} +%\end{macro} % +%\begin{macro}{type} % The \gloskey{type} key specifies to which glossary this % entry belongs. If omitted, the default glossary is used. % \begin{macrocode} \define@key{glossentry}{type}{% \def\@glo@type{#1}} % \end{macrocode} +%\end{macro} % +%\begin{macro}{counter} % The \gloskey{counter} key specifies the name of the counter % associated with this glossary entry: % \begin{macrocode} @@ -5989,23 +6409,36 @@ called `#1'}{The counter key should have the name of a valid counter as its value}}{% \def\@glo@counter{#1}}} % \end{macrocode} +%\end{macro} +% +%\begin{macro}{see} % The \gloskey{see} key specifies a list of cross-references +% \changes{1.17}{2008 December 26}{new} % \begin{macrocode} \define@key{glossentry}{see}{% \def\@glo@see{#1}} % \end{macrocode} +%\end{macro} +% +%\begin{macro}{parent} % The \gloskey{parent} key specifies the parent entry, if % required. +% \changes{1.17}{2008 December 26}{new} % \begin{macrocode} \define@key{glossentry}{parent}{% \def\@glo@parent{#1}} % \end{macrocode} +%\end{macro} +% +%\begin{macro}{nonumberlist} % The \gloskey{nonumberlist} key suppresses the number list % for the given entry. +% \changes{1.17}{2008 December 26}{new} % \begin{macrocode} \define@key{glossentry}{nonumberlist}[none]{% \def\@glo@prefix{\glsnonextpages}} % \end{macrocode} +%\end{macro} % %\begin{macro}{\@glsnoname} % \changes{1.17}{2008 December 26}{new} @@ -6025,6 +6458,14 @@ counter as its value}}{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\@glsdefaultsort} +% Define command to set default sort. +% \changes{1.17}{2008 December 26}{new} +% \begin{macrocode} +\newcommand*{\@glsdefaultsort}{\@glo@name} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\gls@level} % Register to increment entry levels. % \begin{macrocode} @@ -6092,10 +6533,16 @@ counter as its value}}{% % \begin{macrocode} \let\@glo@firstplural\relax % \end{macrocode} +% Set the default sort: %\changes{1.05}{2007 Aug 10}{Changed the default value of the sort % key to just the value of the name key}% +%\changes{1.18}{2009 January 14}{Changed default value of sort +% to '@glsdefaultsort} +% \begin{macrocode} +\let\@glo@sort\@glsdefaultsort +% \end{macrocode} +% Set the default counter: % \begin{macrocode} -\def\@glo@sort{\@glo@name}% \def\@glo@counter{\@gls@getcounter{\@glo@type}}% % \end{macrocode} %\changes{1.17}{2008 December 26}{added see key} @@ -6236,6 +6683,18 @@ in it}}{% \@gls@sanitizedesc \expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% \expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% +% \end{macrocode} +% Sanitize sort value: +%\changes{1.18}{2009 January 14}{moved sort sanitization to +% 'newglossaryentry} +% \begin{macrocode} +\ifx\@glo@sort\@glsdefaultsort + \let\@glo@sort\@glo@name +\fi +\@onelevel@sanitize\@glo@sort +% \end{macrocode} +% Set the sort key for this entry: +% \begin{macrocode} \expandafter\protected@xdef\csname glo@#1@sort\endcsname{\@glo@sort}% % \end{macrocode} %\changes{1.15}{2008 August 15}{check for '@glo@text in symbol}% @@ -9533,7 +9992,7 @@ using \string\makeglossary}}} % \end{macrocode} %\end{macro} % -% \subsection{Displaying the glossary}\label{sec:printglos} +% \subsection{Displaying the glossary}\label{sec:code:printglos} % An individual glossary is displayed in the text using % \cs{printglossary}\oarg{key-val list}. If the % \gloskey[printglossary]{type} key is omitted, the default glossary is displayed. @@ -9782,7 +10241,17 @@ false,nolabel,autolabel}[nolabel]{% \newcommand*{\glossaryheader}{} % \end{macrocode} %\end{macro} -%\vskip5pt +% +%\begin{macro}{\glstarget} +%\changes{1.18}{2009 January 14}{new} +%\cs{glstarget}\marg{label}\marg{name}\\[10pt] +% Provide user interface to \cs{@glstarget} to make it easier to +% modify the glossary style in the document. +% \begin{macrocode} +\newcommand*{\glstarget}[2]{\@glstarget{glo:#1}{#2}} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glossaryentryfield} % \cs{glossaryentryfield}\marg{label}\marg{name}\marg{description}\marg{symbol}\marg{page-list}\\[10pt] % This command governs how each entry row should be formatted @@ -9790,7 +10259,7 @@ false,nolabel,autolabel}[nolabel]{% % Most of the predefined styles ignore \meta{symbol}. % \begin{macrocode} \newcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:#1}{#2} #4 #3. #5\par} +\noindent\textbf{\glstarget{#1}{#2}} #4 #3. #5\par} % \end{macrocode} %\end{macro} %\begin{macro}{\glossaryentryfield} @@ -9802,14 +10271,17 @@ false,nolabel,autolabel}[nolabel]{% % be greater than or equal to 1.) % \begin{macrocode} \newcommand*{\glossarysubentryfield}[6]{% -\@glstarget{glo:#2}{}#4. #6\par} +\glstarget{#2}{\strut}#4. #6\par} % \end{macrocode} %\end{macro} % -% Within each glossary, the entries form 28 distinct groups +% Within each glossary, the entries form distinct groups % which are determined by the first character of the \gloskey{sort} -% key. There will be a maximum of 28 groups: symbols, numbers, -% and the 26 alphabetical groups A, \ldots, Z\@. +% key. When using \appname{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 +% is used. This is determined by the language or custom +% alphabets can be created in the \appname{xindy} style file. % The command \cs{glsgroupskip} % specifies what to do between glossary groups. Glossary styles % must redefine this command. (Note that \cs{glsgroupskip} @@ -10148,6 +10620,47 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % 'newacronym in the preamble} %\end{macro} % +%\begin{macro}{\oldacronym} +%\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list}\\[10pt] +% This emulates the way the old \isty{glossary} package defined +% acronyms. It is equivalent to \ics{newacronym}\oarg{key-val +% list}\marg{label}\marg{abbrv}\marg{long} and it additionally +% defines the command \cs{}\meta{label} which is equivalent to +% \cs{gls}\marg{label} (thus \meta{label} must only contain +% alphabetical characters). If \meta{label} is omitted, \meta{abbrv} +% is used. This only emulates the syntax of the old \isty{glossary} +% package. The way the acronyms appear in the list of acronyms is +% determined by the definition of \ics{newacronym} and the +% glossary style. +% +% Note that \cs{}\meta{label} can't have an optional +% argument if the \isty{xspace} package is loaded. If +% \isty{xspace} hasn't been loaded then you can do +% \cs{}\meta{label}\oarg{insert} but you can't do +% \cs{}\meta{label}\oarg{key-val list}. For example if you define the +% acronym svm, then you can do "\svm['s]" but you can't do +% "\svm[format=textbf]". If the \isty{xspace} package is loaded, +% "\svm['s]" will appear as "svm ['s]" which is unlikely to be +% the desired result. In this case, you will need to use +% \cs{gls} explicitly, e.g.\ "\gls{svm}['s]". Note that it is +% up to the user to load \isty{xspace} if desired. +%\changes{1.18}{2009 January 14}{new} +% \begin{macrocode} +\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}}% + }% +} +% \end{macrocode} +%\end{macro} +% % Set up some convenient short cuts. These need to be changed if % \cs{newacronym} is changed (or if the \gloskey{description} key % is changed). @@ -11029,19 +11542,43 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} % % \subsection{Predefined Glossary Styles}\label{sec:code:styles} -% The \sty{glossaries} bundle comes with some predefined glossary styles which -% are defined in the following packages: +% The \sty{glossaries} bundle comes with some predefined glossary +% styles. These need to be loaded now for the \pkgopt{style} option +% to use them. +% +% First, the glossary hyper-navigation commands need to be loaded. % \begin{macrocode} \RequirePackage{glossary-hypernav} -\RequirePackage{glossary-list} -\RequirePackage{glossary-long} -\RequirePackage{glossary-super} -\RequirePackage{glossary-tree} +% \end{macrocode} +% The styles that use list-like environments. These are not loaded +% if the \pkgopt{nolist} option is used: +% \begin{macrocode} +\@gls@loadlist +% \end{macrocode} +% The styles that use the \envname{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 +% not loaded if the \pkgopt{nosuper} package option is used or if +% the \isty{supertabular} package isn't installed. +% \begin{macrocode} +\@gls@loadsuper +% \end{macrocode} +% The tree-like styles. These are not loaded if the \pkgopt{notree} +% package option is used. +% \begin{macrocode} +\@gls@loadtree % \end{macrocode} % The default glossary style is set according to the \pkgopt{style} package -% option, but can be overridden by \ics{glossarystyle}. +% option, but can be overridden by \ics{glossarystyle}. The +% style must be defined at this point. % \begin{macrocode} -\glossarystyle{\@glossary@default@style} +\ifx\@glossary@default@style\relax +\else + \glossarystyle{\@glossary@default@style} +\fi % \end{macrocode} %\iffalse % \begin{macrocode} @@ -11150,6 +11687,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} %\fi % \subsection{Glossary hyper-navigation definitions (glossary-hypernav package)} +%\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} \ProvidesPackage{glossary-hypernav}[2007/07/04 v1.01 (NLCT)] @@ -11157,7 +11695,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % % The commands defined in this package are provided to % help navigate around the groups within a glossary -% (see \autoref{sec:printglos}.) +% (see \autoref{sec:code:printglos}.) % \ics{printglossary} (and \ics{printglossaries}) % set \cs{@glo@type} to the label of the current % glossary. This is used to create a unique hypertarget in @@ -11180,7 +11718,9 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \cs{glsnavhypertarget}\oarg{type}\marg{label}\marg{text}\\[10pt] % This command makes \meta{text} a hypertarget for the glossary group % whose label is given by \meta{label} in the glossary given -% by \meta{type}. +% by \meta{type}. If \meta{type} is omitted, \cs{@glo@type} is +% used which is set by \ics{printglossary} to the current +% glossary label. %\begin{macro}{\glsnavhypertarget} %\changes{1.14}{2008 June 17}{added write to aux file} %\changes{1.15}{2008 August 15}{added check if rerun required} @@ -11316,7 +11856,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2008/12/11 v1.04 (NLCT)] +\ProvidesPackage{glossary-list}[2009/01/14 v1.05 (NLCT)] % \end{macrocode} %\begin{macro}{list} % The \glostyle{list} glossary style @@ -11329,39 +11869,74 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % style for the \sty{glossaries} package. % \begin{macrocode} \newglossarystyle{list}{% -\renewenvironment{theglossary}{\begin{description}}{\end{description}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}% -\renewcommand*{\glossarysubentryfield}[6]{% -\@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6.}% -\renewcommand*{\glsgroupskip}{\indexspace}} % \end{macrocode} -%\end{macro} -% -%\begin{macro}{listgroup} -% The \glostyle{listgroup} style is like the \glostyle{list} -% style, but the glossary groups have headings. -%\changes{1.08}{2007 Oct 13}{changed listgroup style to use \cs{glsgetgrouptitle}} +% Use \envname{description} environment: % \begin{macrocode} -\newglossarystyle{listgroup}{% -\glossarystyle{list}% -\renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} + \renewenvironment{theglossary}% + {\begin{description}}{\end{description}}% % \end{macrocode} -%\end{macro} -% +% No header at the start of the environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries start a new item in the list: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5}% +% \end{macrocode} +% Sub-entries continue on the same line: +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + \glstarget{##2}{\strut}##4\glspostdescription\space ##6.}% +% \end{macrocode} +% Add vertical space between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{\indexspace}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{listgroup} +% The \glostyle{listgroup} style is like the \glostyle{list} +% style, but the glossary groups have headings. +%\changes{1.08}{2007 Oct 13}{changed listgroup style to use \cs{glsgetgrouptitle}} +% \begin{macrocode} +\newglossarystyle{listgroup}{% +% \end{macrocode} +% Base it on the \glostyle{list} style: +% \begin{macrocode} + \glossarystyle{list}% +% \end{macrocode} +% Each group has a heading: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{listhypergroup} % The \glostyle{listhypergroup} style is like the \glostyle{listgroup} % style, but has a set of links to the groups at the % start of the glossary. % \begin{macrocode} \newglossarystyle{listhypergroup}{% -\glossarystyle{list}% -\renewcommand*{\glossaryheader}{% -\item[\glsnavigation]}% -\renewcommand*{\glsgroupheading}[1]{% -\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} +% \end{macrocode} +% Base it on the \glostyle{list} style: +% \begin{macrocode} + \glossarystyle{list}% +% \end{macrocode} +% Add navigation links at the start of the environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \item[\glsnavigation]}% +% \end{macrocode} +% Each group has a heading with a hypertarget: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} % \end{macrocode} %\end{macro} % @@ -11372,11 +11947,22 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % style does not use the entry's symbol. % \begin{macrocode} \newglossarystyle{altlist}{% -\glossarystyle{list}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[\@glstarget{glo:##1}{##2}]\mbox{}\newline ##3\glspostdescription\space ##5}% -\renewcommand{\glossarysubentryfield}[6]{% -\par\@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6}% +% \end{macrocode} +% Base it on the \glostyle{list} style: +% \begin{macrocode} + \glossarystyle{list}% +% \end{macrocode} +% Main (level 0) entries start a new item in the list with a +% line break after the entry name: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}]\mbox{}\newline + ##3\glspostdescription\space ##5}% +% \end{macrocode} +% Sub-entries start a new paragraph: +% \begin{macrocode} + \renewcommand{\glossarysubentryfield}[6]{% + \par\glstarget{##2}{\strut}##4\glspostdescription\space ##6}% } % \end{macrocode} %\end{macro} @@ -11386,8 +11972,14 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %\changes{1.08}{2007 Oct 13}{changed altlistgroup style to use \cs{glsgetgrouptitle}} % \begin{macrocode} \newglossarystyle{altlistgroup}{% -\glossarystyle{altlist}% -\renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} +% \end{macrocode} +% Base it on the \glostyle{altlist} style: +% \begin{macrocode} + \glossarystyle{altlist}% +% \end{macrocode} +% Each group has a heading: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} % \end{macrocode} %\end{macro} % @@ -11397,11 +11989,20 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % set of links to the groups at the start of the glossary. % \begin{macrocode} \newglossarystyle{altlisthypergroup}{% -\glossarystyle{altlist}% -\renewcommand*{\glossaryheader}{% -\item[\glsnavigation]}% -\renewcommand*{\glsgroupheading}[1]{% -\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} +% \end{macrocode} +% Base it on the \glostyle{altlist} style: +% \begin{macrocode} + \glossarystyle{altlist}% +% \end{macrocode} +% Add navigation links at the start of the environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \item[\glsnavigation]}% +% \end{macrocode} +% Each group has a heading with a hypertarget: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} % \end{macrocode} %\end{macro} % @@ -11415,13 +12016,22 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % entries. % \begin{macrocode} \newglossarystyle{listdotted}{% -\glossarystyle{list}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[]\makebox[\glslistdottedwidth][l]{\@glstarget{glo:##1}{##2}% -\unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##3}% -\renewcommand*{\glossarysubentryfield}[6]{% -\item[]\makebox[\glslistdottedwidth][l]{\@glstarget{glo:##2}{##3}% -\unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##4}% +% \end{macrocode} +% Base it on the \glostyle{list} style: +% \begin{macrocode} + \glossarystyle{list}% +% \end{macrocode} +% Each main (level 0) entry starts a new item: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \item[]\makebox[\glslistdottedwidth][l]{\glstarget{##1}{##2}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##3}% +% \end{macrocode} +% Sub entries have the same format as main entries: +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + \item[]\makebox[\glslistdottedwidth][l]{\glstarget{##2}{##3}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##4}% } % \end{macrocode} %\end{macro} @@ -11432,6 +12042,23 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} %\end{macro} % +%\begin{macro}{sublistdotted} +% This style is similar to the glostyle{listdotted} style, except +% that the main entries just have the name displayed. +% \begin{macrocode} +\newglossarystyle{sublistdotted}{% +% \end{macrocode} +% Base it on the \glostyle{listdotted} style: +% \begin{macrocode} + \glossarystyle{listdotted}% +% \end{macrocode} +% Main (level 0) entries just display the name: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}]}% +} +% \end{macrocode} +%\end{macro} %\iffalse % \begin{macrocode} % @@ -11447,204 +12074,424 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % The glossary styles defined in the \isty{glossary-long} package % used the \envname{longtable} environment in the glossary. % \begin{macrocode} -\ProvidesPackage{glossary-long}[2008/12/11 v1.02 (NLCT)] +\ProvidesPackage{glossary-long}[2009/01/14 v1.03 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} \RequirePackage{longtable} % \end{macrocode} -% This is a length that governs the width of the description column. %\begin{macro}{\glsdescwidth} +% This is a length that governs the width of the description column. +% (There's a chance that the user may specify \pkgopt{nolong} +% and then load \isty{glossary-long} later, in which case +% \cs{glsdescwidth} may have already been defined by +% \isty{glossary-super}. The same goes for \cs{glspagelistwidth}.) % \begin{macrocode} -\newlength\glsdescwidth +\@ifundefined{glsdescwidth}{% + \newlength\glsdescwidth + \setlength{\glsdescwidth}{0.6\linewidth} +}{} % \end{macrocode} %\end{macro} -% This is a length that governs the width of the page list column. +% %\begin{macro}{\glspagelistwidth} +% This is a length that governs the width of the page list column. % \begin{macrocode} -\newlength\glspagelistwidth +\@ifundefined{glspagelistwidth}{% + \newlength\glspagelistwidth + \setlength{\glspagelistwidth}{0.1\linewidth} +}{} % \end{macrocode} %\end{macro} -% Default values: -% \begin{macrocode} -\setlength{\glsdescwidth}{0.6\linewidth} -\setlength{\glspagelistwidth}{0.1\linewidth} -% \end{macrocode} % +%\begin{macro}{long} % The \glostyle{long} glossary style command which % uses the \envname{longtable} environment: % \begin{macrocode} \newglossarystyle{long}{% -\renewenvironment{theglossary}{\begin{longtable}{lp{\glsdescwidth}}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3\glspostdescription\space ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6\\}% -\renewcommand*{\glsgroupskip}{ & \\}} % \end{macrocode} +% Use \envname{longtable} with two columns: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}}}% + {\end{longtable}}% +% \end{macrocode} +% Do nothing at the start of the environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No heading between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries displayed in a row: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3\glspostdescription\space ##5\\}% +% \end{macrocode} +% Sub entries displayed on the following row without the name: +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4\glspostdescription\space ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & \\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{longborder} % The \glostyle{longborder} style is like the above, but with horizontal and % vertical lines: % \begin{macrocode} \newglossarystyle{longborder}{% -\glossarystyle{long}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|}}{\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% +% \end{macrocode} +% Base it on the glostyle{long} style: +% \begin{macrocode} + \glossarystyle{long}% +% \end{macrocode} +% Use \envname{longtable} with two columns with vertical lines +% between each column: +% \begin{macrocode} + \renewenvironment{theglossary}{% + \begin{longtable}{|l|p{\glsdescwidth}|}}{\end{longtable}}% +% \end{macrocode} +% Place horizontal lines at the head and foot of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{longheader} % The \glostyle{longheader} style is like the % \glostyle{long} style but with a header: % \begin{macrocode} \newglossarystyle{longheader}{% -\glossarystyle{long}% -\renewcommand*{\glossaryheader}{% -\bfseries \entryname & \bfseries \descriptionname\\ -\endhead}} % \end{macrocode} +% Base it on the glostyle{long} style: +% \begin{macrocode} + \glossarystyle{long}% +% \end{macrocode} +% Set the table's header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \bfseries \entryname & \bfseries \descriptionname\\\endhead}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{longheaderborder} % The \glostyle{longheaderborder} style is % like the \glostyle{long} style but with a header and border: % \begin{macrocode} \newglossarystyle{longheaderborder}{% -\glossarystyle{longborder}% -\renewcommand*{\glossaryheader}{% -\hline\bfseries \entryname & \bfseries \descriptionname\\\hline -\endhead -\hline\endfoot}} % \end{macrocode} +% Base it on the glostyle{longborder} style: +% \begin{macrocode} + \glossarystyle{longborder}% +% \end{macrocode} +% Set the table's header and add horizontal line to table's foot: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \hline\bfseries \entryname & \bfseries \descriptionname\\\hline + \endhead + \hline\endfoot}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{long3col} % The \glostyle{long3col} style is like \glostyle{long} but with 3 columns % \begin{macrocode} \newglossarystyle{long3col}{% -\renewenvironment{theglossary}{\begin{longtable}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & &\\}} % \end{macrocode} +% Use a \envname{longtable} with 3 columns: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{longtable}}% +% \end{macrocode} +% No table header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No headings between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries on a row (name in first column, +% description in second column, page list in last column): +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##5\\}% +% \end{macrocode} +% Sub-entries on a separate row (no name, description in +% second column, page list in third column): +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & &\\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{long3colborder} % The \glostyle{long3colborder} style is like the % \glostyle{long3col} style but with a border: % \begin{macrocode} \newglossarystyle{long3colborder}{% -\glossarystyle{long3col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% +% \end{macrocode} +% Base it on the glostyle{long3col} style: +% \begin{macrocode} + \glossarystyle{long3col}% +% \end{macrocode} +% Use a \envname{longtable} with 3 columns with vertical lines +% around them: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{longtable}}% +% \end{macrocode} +% Place horizontal lines at the head and foot of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{long3colheader} % The \glostyle{long3colheader} style is like \glostyle{long3col} but with a header row: % \begin{macrocode} \newglossarystyle{long3colheader}{% -\glossarystyle{long3col}% -\renewcommand*{\glossaryheader}{% -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\endhead}% +% \end{macrocode} +% Base it on the glostyle{long3col} style: +% \begin{macrocode} + \glossarystyle{long3col}% +% \end{macrocode} +% Set the table's header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\endhead}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{long3colheaderborder} % The \glostyle{long3colheaderborder} style is like the above but with a border % \begin{macrocode} \newglossarystyle{long3colheaderborder}{% -\glossarystyle{long3colborder}% -\renewcommand*{\glossaryheader}{% -\hline -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\hline\endhead -\hline\endfoot}% +% \end{macrocode} +% Base it on the glostyle{long3colborder} style: +% \begin{macrocode} + \glossarystyle{long3colborder}% +% \end{macrocode} +% Set the table's header and add horizontal line at table's foot: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \hline + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\hline\endhead + \hline\endfoot}% } % \end{macrocode} -% The \glostyle{long4col} style has four columns where the third column contains the value of the associated \gloskey{symbol} key. +%\end{macro} +% +%\begin{macro}{long4col} +% The \glostyle{long4col} style has four columns where the third +% column contains the value of the associated \gloskey{symbol} key. % \begin{macrocode} \newglossarystyle{long4col}{% -\renewenvironment{theglossary}{% -\begin{longtable}{llll}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##4 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##5 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & & &\\}} % \end{macrocode} -% The \glostyle{long4colheader} style is like \glostyle{long4col} but with a header row. +% Use a \envname{longtable} with 4 columns: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{llll}}% + {\end{longtable}}% +% \end{macrocode} +% No table header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries on a single row (name in first column, +% description in second column, symbol in third column, page list +% in last column): +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##4 & ##5\\}% +% \end{macrocode} +% Sub entries on a single row with no name (description in second +% column, symbol in third column, page list in last column): +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##5 & ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & & &\\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{long4colheader} +% The \glostyle{long4colheader} style is like \glostyle{long4col} +% but with a header row. % \begin{macrocode} \newglossarystyle{long4colheader}{% -\glossarystyle{long4col}% -\renewcommand*{\glossaryheader}{% -\bfseries\entryname&\bfseries\descriptionname& -\bfseries \symbolname& -\bfseries\pagelistname\\\endhead}% +% \end{macrocode} +% Base it on the glostyle{long4col} style: +% \begin{macrocode} + \glossarystyle{long4col}% +% \end{macrocode} +% Table has a header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \bfseries\entryname&\bfseries\descriptionname& + \bfseries \symbolname& + \bfseries\pagelistname\\\endhead}% } % \end{macrocode} -% The \glostyle{long4colborder} style is like \glostyle{long4col} but with a border. +%\end{macro} +% +%\begin{macro}{long4colborder} +% The \glostyle{long4colborder} style is like \glostyle{long4col} +% but with a border. % \begin{macrocode} \newglossarystyle{long4colborder}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|l|l|l|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% +% \end{macrocode} +% Base it on the glostyle{long4col} style: +% \begin{macrocode} + \glossarystyle{long4col}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns surrounded by vertical +% lines: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{|l|l|l|l|}}% + {\end{longtable}}% +% \end{macrocode} +% Add horizontal lines to the head and foot of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } % \end{macrocode} -% The \glostyle{long4colheaderborder} style is like the above but with a border. +%\end{macro} +% +%\begin{macro}{long4colheaderborder} +% The \glostyle{long4colheaderborder} style is like the above but +% with a border. % \begin{macrocode} \newglossarystyle{long4colheaderborder}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|l|l|l|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{% -\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries \symbolname& -\bfseries\pagelistname\\\hline\endhead\hline\endfoot}% +% \end{macrocode} +% Base it on the glostyle{long4col} style: +% \begin{macrocode} + \glossarystyle{long4col}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns surrounded by vertical +% lines: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{|l|l|l|l|}}% + {\end{longtable}}% +% \end{macrocode} +% Add table header and horizontal line at the table's foot: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \hline\bfseries\entryname&\bfseries\descriptionname& + \bfseries \symbolname& + \bfseries\pagelistname\\\hline\endhead\hline\endfoot}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altlong4col} % The \glostyle{altlong4col} style is like the \glostyle{long4col} % style but can have multiline descriptions and page lists. % \begin{macrocode} \newglossarystyle{altlong4col}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{longtable}}% +% \end{macrocode} +% Base it on the glostyle{long4col} style: +% \begin{macrocode} + \glossarystyle{long4col}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns where the second and +% last columns may have multiple lines in each row: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{longtable}}% } % \end{macrocode} -% The \glostyle{altlong4colheader} style is like \glostyle{altlong4col} -% but with a header row. +%\end{macro} +% +%\begin{macro}{altlong4colheader} +% The \glostyle{altlong4colheader} style is like +% \glostyle{altlong4col} but with a header row. % \begin{macrocode} \newglossarystyle{altlong4colheader}{% -\glossarystyle{long4colheader}% -\renewenvironment{theglossary}{% -\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{longtable}}% +% \end{macrocode} +% Base it on the glostyle{long4colheader} style: +% \begin{macrocode} + \glossarystyle{long4colheader}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns where the second and +% last columns may have multiple lines in each row: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{longtable}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altlong4colborder} % The \glostyle{altlong4colborder} style is like % \glostyle{altlong4col} but with a border. % \begin{macrocode} \newglossarystyle{altlong4colborder}{% -\glossarystyle{long4colborder}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagewidthlist}|}}{% -\end{longtable}}% +% \end{macrocode} +% Base it on the glostyle{long4colborder} style: +% \begin{macrocode} + \glossarystyle{long4colborder}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns where the second and +% last columns may have multiple lines in each row: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{longtable}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altlong4colheaderborder} % The \glostyle{altlong4colheaderborder} style is like the above but % with a header as well as a border. % \begin{macrocode} \newglossarystyle{altlong4colheaderborder}{% -\glossarystyle{long4colheaderborder}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagewidthlist}|}}{% -\end{longtable}}% +% \end{macrocode} +% Base it on the glostyle{long4colheaderborder} style: +% \begin{macrocode} + \glossarystyle{long4colheaderborder}% +% \end{macrocode} +% Use a \envname{longtable} with 4 columns where the second and +% last columns may have multiple lines in each row: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{longtable}}% } % \end{macrocode} +%\end{macro} %\iffalse % \begin{macrocode} % @@ -11659,216 +12506,460 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % The glossary styles defined in the \isty{glossary-super} package % use the \envname{supertabular} environment. % \begin{macrocode} -\ProvidesPackage{glossary-super}[2008/12/11 v1.02 (NLCT)] +\ProvidesPackage{glossary-super}[2009/01/14 v1.03 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} \RequirePackage{supertabular} % \end{macrocode} +%\begin{macro}{\glsdescwidth} +% This is a length that governs the width of the description column. +% This may already have been defined if \isty{glossary-long} +% has been loaded. +% \begin{macrocode} +\@ifundefined{glsdescwidth}{% + \newlength\glsdescwidth + \setlength{\glsdescwidth}{0.6\linewidth} +}{} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glspagelistwidth} +% This is a length that governs the width of the page list column. +% This may already have been defined if \isty{glossary-long} +% has been loaded. +% \begin{macrocode} +\@ifundefined{glspagelistwidth}{% + \newlength\glspagelistwidth + \setlength{\glspagelistwidth}{0.1\linewidth} +}{} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{super} % The \glostyle{super} glossary style uses the % \envname{supertabular} environment % (it uses lengths defined in the \isty{glossary-long} package.) % \begin{macrocode} \newglossarystyle{super}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3\glspostdescription\space ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6\\}% -\renewcommand*{\glsgroupskip}{ & \\}} % \end{macrocode} -% The \glostyle{superborder} style is like the above, but with horizontal and -% vertical lines: +% Put the glossary in a \envname{supertabular} environment with +% two columns and no head or tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}}}% + {\end{supertabular}}% +% \end{macrocode} +% Do nothing at the start of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries put in a row (name in first column, +% description and page list in second column): +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3\glspostdescription\space ##5\\}% +% \end{macrocode} +% Sub entries put in a row (no name, description and page list +% in second column): +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4\glspostdescription\space ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & \\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{superborder} +% The \glostyle{superborder} style is like the above, but with +% horizontal and vertical lines: % \begin{macrocode} \newglossarystyle{superborder}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|}}{\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super} style: +% \begin{macrocode} + \glossarystyle{super}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% two columns and a horizontal line in the head and tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{superheader} % The \glostyle{superheader} style is like the % \glostyle{super} style, but with a header: % \begin{macrocode} \newglossarystyle{superheader}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries \entryname & \bfseries \descriptionname\\}% -\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}}}{\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super} style: +% \begin{macrocode} + \glossarystyle{super}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% two columns, a header and no tail: +% \begin{macrocode} +\renewenvironment{theglossary}% + {\tablehead{\bfseries \entryname & \bfseries \descriptionname\\}% + \tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{superheaderborder} % The \glostyle{superheaderborder} style is like % the \glostyle{super} style but with a header and border: % \begin{macrocode} \newglossarystyle{superheaderborder}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries \entryname & \bfseries \descriptionname\\\hline}% -\tabletail{\hline} -\begin{supertabular}{|l|p{\glsdescwidth}|}}{\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super} style: +% \begin{macrocode} + \glossarystyle{super}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% two columns, a header and horizontal lines above and below the +% table: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline\bfseries \entryname & + \bfseries \descriptionname\\\hline}% + \tabletail{\hline} + \begin{supertabular}{|l|p{\glsdescwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} -% The \glostyle{super3col} style is like the \glostyle{super} style, but with 3 columns: +%\end{macro} +% +%\begin{macro}{super3col} +% The \glostyle{super3col} style is like the \glostyle{super} +% style, but with 3 columns: % \begin{macrocode} \newglossarystyle{super3col}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & &\\}} % \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% three columns and no head or tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{supertabular}}% +% \end{macrocode} +% Do nothing at the start of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries on a row (name in first column, +% description in second column, page list in last column): +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##5\\}% +% \end{macrocode} +% Sub entries on a row (no name, description in second column, +% page list in last column): +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & &\\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{super3colborder} % The \glostyle{super3colborder} style is like the % \glostyle{super3col} style, but with a border: % \begin{macrocode} \newglossarystyle{super3colborder}{% -\glossarystyle{super3col}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super3col} style: +% \begin{macrocode} + \glossarystyle{super3col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% three columns and a horizontal line in the head and tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{super3colheader} % The \glostyle{super3colheader} style is like % the \glostyle{super3col} style but with a header row: % \begin{macrocode} \newglossarystyle{super3colheader}{% -\glossarystyle{super3col}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super3col} style: +% \begin{macrocode} + \glossarystyle{super3col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% three columns, a header and no tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{super3colheaderborder} % The \glostyle{super3colheaderborder} style is like % the \glostyle{super3col} style but with a header and border: % \begin{macrocode} \newglossarystyle{super3colheaderborder}{% -\glossarystyle{super3colborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\hline}% -\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super3colborder} style: +% \begin{macrocode} + \glossarystyle{super3colborder}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% three columns, a header with horizontal lines and a horizontal +% line in the tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\hline}% + \tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{super4col} % The \glostyle{super4col} glossary style has four columns, % where the third column contains the value of the % corresponding \gloskey{symbol} key used when that entry % was defined. % \begin{macrocode} \newglossarystyle{super4col}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{llll}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##4 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##5 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & & &\\}} % \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and no head or tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{llll}}{% + \end{supertabular}}% +% \end{macrocode} +% Do nothing at the start of the table: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries on a row with the name in the first +% column, description in second column, symbol in third column +% and page list in last column: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##4 & ##5\\}% +% \end{macrocode} +% Sub entries on a row with no name, the description in the second +% column, symbol in third column and page list in last column: +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##5 & ##6\\}% +% \end{macrocode} +% Blank row between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{ & & &\\}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{super4colheader} % The \glostyle{super4colheader} style is like % the \glostyle{super4col} but with a header row. % \begin{macrocode} \newglossarystyle{super4colheader}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{llll}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4col} style: +% \begin{macrocode} + \glossarystyle{super4col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns, a header and no tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\}% + \tabletail{}% + \begin{supertabular}{llll}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{super4colborder} % The \glostyle{super4colborder} style is like % the \glostyle{super4col} but with a border. % \begin{macrocode} \newglossarystyle{super4colborder}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|l|l|l|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4col} style: +% \begin{macrocode} + \glossarystyle{super4col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and a horizontal line in the head and tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|l|l|l|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{super4colheaderborder} % The \glostyle{super4colheaderborder} style is like % the \glostyle{super4col} but with a header and border. % \begin{macrocode} \newglossarystyle{super4colheaderborder}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{\hline}% -\begin{supertabular}{|l|l|l|l|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4col} style: +% \begin{macrocode} + \glossarystyle{super4col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and a header bordered by horizontal lines and +% a horizontal line in the tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\\hline}\tabletail{\hline}% + \begin{supertabular}{|l|l|l|l|}}% + {\end{supertabular}}% } % \end{macrocode} -% The \glostyle{altsuper4col} glossary style is like \glostyle{super4col} -% but has provision for multiline descriptions. +%\end{macro} +% +%\begin{macro}{altsuper4col} +% The \glostyle{altsuper4col} glossary style is like +% \glostyle{super4col} but has provision for multiline descriptions. % \begin{macrocode} \newglossarystyle{altsuper4col}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4col} style: +% \begin{macrocode} + \glossarystyle{super4col}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and no head or tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altsuper4colheader} % The \glostyle{altsuper4colheader} style is like % the \glostyle{altsuper4col} but with a header row. % \begin{macrocode} \newglossarystyle{altsuper4colheader}{% -\glossarystyle{super4colheader}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4colheader} style: +% \begin{macrocode} + \glossarystyle{super4colheader}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns, a header and no tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altsuper4colborder} % The \glostyle{altsuper4colborder} style is like % the \glostyle{altsuper4col} but with a border. % \begin{macrocode} \newglossarystyle{altsuper4colborder}{% -\glossarystyle{super4colborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4colborder} style: +% \begin{macrocode} + \glossarystyle{super4colborder}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and a horizontal line in the head and tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}% + {|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} +% +%\begin{macro}{altsuper4colheaderborder} % The \glostyle{altsuper4colheaderborder} style is like % the \glostyle{altsuper4col} but with a header and border. % \begin{macrocode} \newglossarystyle{altsuper4colheaderborder}{% -\glossarystyle{super4colheaderborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}{% -\end{supertabular}}% +% \end{macrocode} +% Base it on the glostyle{super4colheaderborder} style: +% \begin{macrocode} + \glossarystyle{super4colheaderborder}% +% \end{macrocode} +% Put the glossary in a \envname{supertabular} environment with +% four columns and a header bordered by horizontal lines and +% a horizontal line in the tail: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\tablehead{\hline + \bfseries\entryname & + \bfseries\descriptionname & + \bfseries\symbolname & + \bfseries\pagelistname\\\hline}% + \tabletail{\hline}% + \begin{supertabular}% + {|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } % \end{macrocode} +%\end{macro} %\iffalse % \begin{macrocode} % @@ -11884,7 +12975,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2008/12/11 v1.0 (NLCT)] +\ProvidesPackage{glossary-tree}[2009/01/14 v1.01 (NLCT)] % \end{macrocode} % %\begin{macro}{index} @@ -11898,34 +12989,64 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % levels. % \begin{macrocode} \newglossarystyle{index}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -\let\item\@idxitem}{}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Set the paragraph indentation and skip and define \ics{item} +% to be the same as that used by \envname{theindex}: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + \let\item\@idxitem}% + {}% +% \end{macrocode} +% Do nothing at the start of the environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headers: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entry starts a new item with the name in bold +% followed by the symbol in brackets (if it exists), the description +% and the page list. +% \begin{macrocode} \renewcommand*{\glossaryentryfield}[5]{% -\item\textbf{\@glstarget{glo:##1}{##2}}% +\item\textbf{\glstarget{##1}{##2}}% \ifx\relax##4\relax \else \space(##4)% \fi \space ##3\glspostdescription \space ##5}% -\renewcommand*{\glossarysubentryfield}[6]{% - \ifcase##1\relax - \item - \or - \subitem - \else - \subsubitem - \fi - \textbf{\@glstarget{glo:##2}{##3}}% - \ifx\relax##5\relax - \else - \space(##5)% - \fi - \space##4\glspostdescription\space ##6}% -\renewcommand*{\glsgroupskip}{\indexspace}} +% \end{macrocode} +% Sub entries: level 1 entries use \ics{subitem}, levels greater +% than~1 use \ics{subsubitem}. The level ("##1") shouldn't be 0, +% as that's catered by \cs{glossaryentryfield}, but for completeness, +% if the level is 0, \ics{item} is used. The name is put in bold, +% followed by the symbol in brackets (if it exists), the description +% and the page list. +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + \ifcase##1\relax + % level 0 + \item + \or + % level 1 + \subitem + \else + % all other levels + \subsubitem + \fi + \textbf{\glstarget{##2}{##3}}% + \ifx\relax##5\relax + \else + \space(##5)% + \fi + \space##4\glspostdescription\space ##6}% +% \end{macrocode} +% Vertical gap between groups is the same as that used by indices: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{\indexspace}} % \end{macrocode} %\end{macro} % @@ -11934,9 +13055,17 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % style but has headings. % \begin{macrocode} \newglossarystyle{indexgroup}{% -\glossarystyle{index}% -\renewcommand*{\glsgroupheading}[1]{% - \item\textbf{\glsgetgrouptitle{##1}}\indexspace}} +% \end{macrocode} +% Base it on the glostyle{index} style: +% \begin{macrocode} + \glossarystyle{index}% +% \end{macrocode} +% Add a heading for each group. This puts the group's title in +% bold followed by a vertical gap. +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsgetgrouptitle{##1}}\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -11945,12 +13074,23 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \glostyle{indexgroup} style but has hyper navigation. % \begin{macrocode} \newglossarystyle{indexhypergroup}{% -\glossarystyle{index}% -\renewcommand*{\glossaryheader}{% -\item\textbf{\glsnavigation}\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% -\indexspace}} +% \end{macrocode} +% Base it on the glostyle{index} style: +% \begin{macrocode} + \glossarystyle{index}% +% \end{macrocode} +% Put navigation links to the groups at the start of the glossary: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \item\textbf{\glsnavigation}\indexspace}% +% \end{macrocode} +% Add a heading for each group (with a target). The group's title is +% in bold followed by a vertical gap. +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% + \indexspace}% +} % \end{macrocode} %\end{macro} % @@ -11960,31 +13100,54 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % can have arbitrary levels. % \begin{macrocode} \newglossarystyle{tree}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -}{}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand{\glossaryentryfield}[5]{% - \hangindent0pt\relax - \parindent0pt\relax - \textbf{\@glstarget{glo:##1}{##2}}% - \ifx\relax##4\relax - \else - \space(##4)% - \fi - \space ##3\glspostdescription \space ##5\par}% -\renewcommand{\glossarysubentryfield}[6]{% - \hangindent##1\glstreeindent\relax - \parindent##1\glstreeindent\relax - \textbf{\@glstarget{glo:##2}{##3}}% - \ifx\relax##5\relax - \else - \space(##5)% - \fi - \space##4\glspostdescription\space ##6\par}% -\renewcommand*{\glsgroupskip}{\indexspace}} +% \end{macrocode} +% Set the paragraph indentation and skip: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}}% + {}% +% \end{macrocode} +% Do nothing at the start of the \envname{theglossary} environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Main (level 0) entries: name in bold, followed by symbol in +% brackets (if it exists), the description and the page list: +% \begin{macrocode} + \renewcommand{\glossaryentryfield}[5]{% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glstarget{##1}{##2}}% + \ifx\relax##4\relax + \else + \space(##4)% + \fi + \space ##3\glspostdescription \space ##5\par}% +% \end{macrocode} +% Sub entries: level \meta{n} is indented by \meta{n} times +% \ics{glstreeindent}. The name is in bold, followed by the +% symbol in brackets (if it exists), the description and the +% page list. +% \begin{macrocode} + \renewcommand{\glossarysubentryfield}[6]{% + \hangindent##1\glstreeindent\relax + \parindent##1\glstreeindent\relax + \textbf{\glstarget{##2}{##3}}% + \ifx\relax##5\relax + \else + \space(##5)% + \fi + \space##4\glspostdescription\space ##6\par}% +% \end{macrocode} +% Vertical gap between groups is the same as that used by +% indices: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{\indexspace}} % \end{macrocode} %\end{macro} % @@ -11993,9 +13156,16 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % headings. % \begin{macrocode} \newglossarystyle{treegroup}{% -\glossarystyle{tree}% -\renewcommand{\glsgroupheading}[1]{\par -\noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} +% \end{macrocode} +% Base it on the glostyle{tree} style: +% \begin{macrocode} + \glossarystyle{tree}% +% \end{macrocode} +% Each group has a heading (in bold) followed by a vertical gap): +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12005,13 +13175,25 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % start of the glossary. % \begin{macrocode} \newglossarystyle{treehypergroup}{% -\glossarystyle{tree}% -\renewcommand*{\glossaryheader}{% -\par\noindent\textbf{\glsnavigation}\par\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\par\noindent -\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par -\indexspace}} +% \end{macrocode} +% Base it on the glostyle{tree} style: +% \begin{macrocode} + \glossarystyle{tree}% +% \end{macrocode} +% Put navigation links to the groups at the start of the +% \envname{theglossary} environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% +% \end{macrocode} +% Each group has a heading (in bold with a target) followed by a +% vertical gap): +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12030,27 +13212,50 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % doesn't print the name or symbol for sub-levels. % \begin{macrocode} \newglossarystyle{treenoname}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -}{}% -\renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% Set the paragraph indentation and skip: +% \begin{macrocode} + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}}% + {}% +% \end{macrocode} +% No header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} \renewcommand*{\glsgroupheading}[1]{}% -\renewcommand{\glossaryentryfield}[5]{% - \hangindent0pt\relax - \parindent0pt\relax - \textbf{\@glstarget{glo:##1}{##2}}% - \ifx\relax##4\relax - \else - \space(##4)% - \fi - \space ##3\glspostdescription \space ##5\par}% -\renewcommand{\glossarysubentryfield}[6]{% - \hangindent##1\glstreeindent\relax - \parindent##1\glstreeindent\relax - \textbf{\@glstarget{glo:##2}{\strut}}% - ##4\glspostdescription\space ##6\par}% -\renewcommand*{\glsgroupskip}{\indexspace}} +% \end{macrocode} +% Main (level 0) entries: the name is in bold, followed by the +% symbol in brackets (if it exists), the description and the +% page list. +% \begin{macrocode} + \renewcommand{\glossaryentryfield}[5]{% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glstarget{##1}{##2}}% + \ifx\relax##4\relax + \else + \space(##4)% + \fi + \space ##3\glspostdescription \space ##5\par}% +% \end{macrocode} +% Sub entries: level \meta{n} is indented by \meta{n} times +% \ics{glstreeindent}. The name and symbol are omitted. The +% description followed by the page list are displayed. +% \begin{macrocode} + \renewcommand{\glossarysubentryfield}[6]{% + \hangindent##1\glstreeindent\relax + \parindent##1\glstreeindent\relax + \glstarget{##2}{\strut}% + ##4\glspostdescription\space ##6\par}% +% \end{macrocode} +% Vertical gap between groups is the same as that used by indices: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12059,9 +13264,16 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % headings. % \begin{macrocode} \newglossarystyle{treenonamegroup}{% -\glossarystyle{treenoname}% -\renewcommand{\glsgroupheading}[1]{\par -\noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} +% \end{macrocode} +% Base it on the glostyle{treenoname} style: +% \begin{macrocode} + \glossarystyle{treenoname}% +% \end{macrocode} +% Give each group a heading: +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12071,13 +13283,25 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % start of the glossary. % \begin{macrocode} \newglossarystyle{treenonamehypergroup}{% -\glossarystyle{treenoname}% -\renewcommand*{\glossaryheader}{% -\par\noindent\textbf{\glsnavigation}\par\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\par\noindent -\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par -\indexspace}} +% \end{macrocode} +% Base it on the glostyle{treenoname} style: +% \begin{macrocode} + \glossarystyle{treenoname}% +% \end{macrocode} +% Put navigation links to the groups at the start of the +% \envname{theglossary} environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% +% \end{macrocode} +% Each group has a heading (in bold with a target) followed by a +% vertical gap): +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12110,135 +13334,141 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} % Redefine \envname{theglossary} environment. % \begin{macrocode} -\renewenvironment{theglossary}{% -\def\@gls@prevlevel{-1}% -\mbox{}\par}{\par}% + \renewenvironment{theglossary}% + {\def\@gls@prevlevel{-1}% + \mbox{}\par}% + {\par}% % \end{macrocode} % Set the header and group headers to nothing. % \begin{macrocode} -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% % \end{macrocode} % Redefine the way that the level~0 entries are displayed. % \begin{macrocode} -\renewcommand{\glossaryentryfield}[5]{% + \renewcommand{\glossaryentryfield}[5]{% % \end{macrocode} % If the level hasn't changed, keep the same settings, otherwise % change \cs{glstreeindent} accordingly. % \begin{macrocode} - \ifnum\@gls@prevlevel=0\relax - \else + \ifnum\@gls@prevlevel=0\relax + \else % \end{macrocode} % Find out how big the indentation should be by measuring the % widest entry. % \begin{macrocode} - \settowidth{\glstreeindent}{\textbf{\@glswidestname\space}}% + \settowidth{\glstreeindent}{\textbf{\@glswidestname\space}}% % \end{macrocode} % Set the hangindent and paragraph indent. % \begin{macrocode} - \hangindent\glstreeindent - \parindent\glstreeindent - \fi + \hangindent\glstreeindent + \parindent\glstreeindent + \fi % \end{macrocode} % Put the name to the left of the paragraph block. % \begin{macrocode} - \makebox[0pt][r]{\makebox[\glstreeindent][l]{% - \textbf{\@glstarget{glo:##1}{##2}}}}% + \makebox[0pt][r]{\makebox[\glstreeindent][l]{% + \textbf{\glstarget{##1}{##2}}}}% % \end{macrocode} % If the symbol is missing, ignore it, otherwise put it in % brackets. % \begin{macrocode} - \ifx\relax##4\relax - \else - (##4)\space - \fi + \ifx\relax##4\relax + \else + (##4)\space + \fi % \end{macrocode} % Do the description followed by the description terminator and % location list. % \begin{macrocode} - ##3\glspostdescription \space ##5\par + ##3\glspostdescription \space ##5\par % \end{macrocode} % Set the previous level to 0. % \begin{macrocode} - \def\@gls@prevlevel{0}% -}% + \def\@gls@prevlevel{0}% + }% % \end{macrocode} % Redefine the way sub-entries are displayed. % \begin{macrocode} -\renewcommand{\glossarysubentryfield}[6]{% + \renewcommand{\glossarysubentryfield}[6]{% % \end{macrocode} % If the level hasn't changed, keep the same settings, otherwise % adjust \cs{glstreeindent} accordingly. % \begin{macrocode} - \ifnum\@gls@prevlevel=##1\relax - \else + \ifnum\@gls@prevlevel=##1\relax + \else % \end{macrocode} % Compute the widest entry for this level, or for level~0 if not % defined for this level. Store in \cs{gls@tmplen} % \begin{macrocode} - \@ifundefined{@glswidestname\romannumeral##1}{% - \settowidth{\gls@tmplen}{\textbf{\@glswidestname\space}}}{% - \settowidth{\gls@tmplen}{\textbf{% - \csname @glswidestname\romannumeral##1\endcsname\space}}}% + \@ifundefined{@glswidestname\romannumeral##1}{% + \settowidth{\gls@tmplen}{\textbf{\@glswidestname\space}}}{% + \settowidth{\gls@tmplen}{\textbf{% + \csname @glswidestname\romannumeral##1\endcsname\space}}}% % \end{macrocode} % Determine if going up or down a level % \begin{macrocode} - \ifnum\@gls@prevlevel<##1\relax + \ifnum\@gls@prevlevel<##1\relax % \end{macrocode} % Depth has increased, so add the width of the widest entry to % \cs{glstreeindent}. % \begin{macrocode} - \setlength\glstreeindent\gls@tmplen - \addtolength\glstreeindent\parindent - \parindent\glstreeindent - \else + \setlength\glstreeindent\gls@tmplen + \addtolength\glstreeindent\parindent + \parindent\glstreeindent + \else % \end{macrocode} % Depth has decreased, so subtract width of the widest entry % from the previous level to \cs{glstreeindent}. First % determine the width of the widest entry for the previous level % and store in \cs{glstreeindent}. % \begin{macrocode} - \@ifundefined{@glswidestname\romannumeral\@gls@prevlevel}{% - \settowidth{\glstreeindent}{\textbf{% - \@glswidestname\space}}}{% - \settowidth{\glstreeindent}{\textbf{% - \csname @glswidestname\romannumeral\@gls@prevlevel - \endcsname\space}}}% + \@ifundefined{@glswidestname\romannumeral\@gls@prevlevel}{% + \settowidth{\glstreeindent}{\textbf{% + \@glswidestname\space}}}{% + \settowidth{\glstreeindent}{\textbf{% + \csname @glswidestname\romannumeral\@gls@prevlevel + \endcsname\space}}}% % \end{macrocode} % Subtract this length from the previous level's paragraph indent % and set to \cs{glstreeindent}. % \begin{macrocode} - \addtolength\parindent{-\glstreeindent}% - \setlength\glstreeindent\parindent + \addtolength\parindent{-\glstreeindent}% + \setlength\glstreeindent\parindent + \fi \fi - \fi % \end{macrocode} % Set the hanging indentation. % \begin{macrocode} - \hangindent\glstreeindent + \hangindent\glstreeindent % \end{macrocode} % Put the name to the left of the paragraph block % \begin{macrocode} - \makebox[0pt][r]{\makebox[\gls@tmplen][l]{% - \textbf{\@glstarget{glo:##2}{##3}}}}% + \makebox[0pt][r]{\makebox[\gls@tmplen][l]{% + \textbf{\glstarget{##2}{##3}}}}% % \end{macrocode} % If the symbol is missing, ignore it, otherwise put it in % brackets. % \begin{macrocode} - \ifx##5\relax\relax - \else - (##5)\space - \fi + \ifx##5\relax\relax + \else + (##5)\space + \fi % \end{macrocode} % Do the description followed by the description terminator and % location list. % \begin{macrocode} - ##4\glspostdescription\space ##6\par + ##4\glspostdescription\space ##6\par % \end{macrocode} % Set the previous level macro to the current level. % \begin{macrocode} - \def\@gls@prevlevel{##1}}% -\renewcommand*{\glsgroupskip}{\indexspace}} + \def\@gls@prevlevel{##1}% + }% +% \end{macrocode} +% Vertical gap between groups is the same as that used by indices: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12247,12 +13477,19 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % headings. % \begin{macrocode} \newglossarystyle{alttreegroup}{% -\glossarystyle{alttree}% -\renewcommand{\glsgroupheading}[1]{\par -\def\@gls@prevlevel{-1}% -\hangindent0pt\relax -\parindent0pt\relax -\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} +% \end{macrocode} +% Base it on the glostyle{alttree} style: +% \begin{macrocode} + \glossarystyle{alttree}% +% \end{macrocode} +% Give each group a heading. +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} % \end{macrocode} %\end{macro} % @@ -12262,7 +13499,10 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % groups at the start of the glossary. % \begin{macrocode} \newglossarystyle{alttreehypergroup}{% -\glossarystyle{alttree}% +% \end{macrocode} +% Base it on the glostyle{alttree} style: +% \begin{macrocode} + \glossarystyle{alttree}% % \end{macrocode} % Put the navigation links in the header % \begin{macrocode} @@ -12303,7 +13543,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % support is required, but the \isty{translator} package is not loaded. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2008/12/11 v1.01 (NLCT)] +\ProvidesPackage{glossaries-babel}[2009/01/14 v1.02 (NLCT)] % \end{macrocode} % English: % \begin{macrocode} @@ -12353,7 +13593,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \renewcommand*{\pagelistname}{Page List}% \renewcommand*{\glssymbolsgroupname}{Symbols}% \renewcommand*{\glsnumbersgroupname}{Numbers}% -}% +}}% \@ifundefined{captionscanadian}{}{% \addto\captionscanadian{% \renewcommand*{\glossaryname}{Glossary}% @@ -14127,7 +15367,7 @@ Another \gls{ident} entry. \documentclass{report} \usepackage[colorlinks]{hyperref} -\usepackage[style=alttreehypergroup]{glossaries} +\usepackage[style=alttreehypergroup,nolong,nosuper]{glossaries} % The alttree type of glossary styles need to know the % widest entry name for each level diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index 681c7730697..1c40b7f2a26 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins @@ -1,10 +1,10 @@ -% glossaries.ins generated using makedtx version 0.94b 2008/12/26 16:49 +% glossaries.ins generated using makedtx version 0.94b 2009/1/16 12:27 \input docstrip \preamble glossaries.dtx - Copyright 2008 Nicola Talbot + Copyright 2009 Nicola Talbot This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 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 774682e3742..413fa26bdd6 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-babel.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2008/12/11 v1.01 (NLCT)] +\ProvidesPackage{glossaries-babel}[2009/01/14 v1.02 (NLCT)] \@ifundefined{captionsenglish}{}{% \addto\captionsenglish{% \renewcommand*{\glossaryname}{Glossary}% @@ -86,7 +86,7 @@ \renewcommand*{\pagelistname}{Page List}% \renewcommand*{\glssymbolsgroupname}{Symbols}% \renewcommand*{\glsnumbersgroupname}{Numbers}% -}% +}}% \@ifundefined{captionscanadian}{}{% \addto\captionscanadian{% \renewcommand*{\glossaryname}{Glossary}% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 9c488642eef..41f8f836944 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2008/12/26 v1.17 (NLCT)] +\ProvidesPackage{glossaries}[2009/01/14 v1.18 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -75,6 +75,23 @@ false,nolabel,autolabel}[nolabel]{% \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{\glsdefaulttype}{main} \newcommand{\acronymtype}{\glsdefaulttype} \define@boolkey{glossaries.sty}[gls]{acronym}[true]{} @@ -555,8 +572,7 @@ exists}% \def\@glo@descplural{#1}% } \define@key{glossentry}{sort}{% -\def\@glo@sort{#1}% -\@onelevel@sanitize\@glo@sort} +\def\@glo@sort{#1}} \define@key{glossentry}{text}{% \def\@glo@text{#1}% } @@ -593,6 +609,7 @@ counter as its value}}{% \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}{% @@ -608,7 +625,7 @@ counter as its value}}{% \let\@glo@plural\@glsdefaultplural \let\@glo@first\relax \let\@glo@firstplural\relax -\def\@glo@sort{\@glo@name}% +\let\@glo@sort\@glsdefaultsort \def\@glo@counter{\@gls@getcounter{\@glo@type}}% \def\@glo@see{}% \def\@glo@parent{}% @@ -679,6 +696,10 @@ in it}}{% \@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 @@ -2073,10 +2094,11 @@ false,nolabel,autolabel}[nolabel]{% \PackageWarning{glossaries}{overriding `theglossary' environment}% \renewenvironment{theglossary}{}{}} \newcommand*{\glossaryheader}{} +\newcommand*{\glstarget}[2]{\@glstarget{glo:#1}{#2}} \newcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:#1}{#2} #4 #3. #5\par} +\noindent\textbf{\glstarget{#1}{#2}} #4 #3. #5\par} \newcommand*{\glossarysubentryfield}[6]{% -\@glstarget{glo:#2}{}#4. #6\par} +\glstarget{#2}{\strut}#4. #6\par} \newcommand*{\glsgroupskip}{} \newcommand*{\glsgroupheading}[1]{} \newcommand*{\glsgetgrouptitle}[1]{% @@ -2169,6 +2191,18 @@ descriptionplural={#4\acrpluralsuffix},% first={#4 (#3)},plural={#3\acrpluralsuffix},% firstplural={\@glo@descplural\space (\@glo@plural)},% #1}} +\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*{\acrpluralsuffix}{\glspluralsuffix} \newcommand*{\glsshortkey}{text} \newcommand*{\glsshortpluralkey}{plural} @@ -2576,11 +2610,14 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \let\Acp\Glspl \fi \RequirePackage{glossary-hypernav} -\RequirePackage{glossary-list} -\RequirePackage{glossary-long} -\RequirePackage{glossary-super} -\RequirePackage{glossary-tree} -\glossarystyle{\@glossary@default@style} +\@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/mfirstuc.sty b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty index 38e43ddcee3..3cbe71fa130 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `mfirstuc.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict index fe9008f5f05..6e0d609df44 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazil.dict @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Brazil.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 af538e6577f..6bdffa81dcb 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Danish.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 4c3abfce2bc..d4ee1d20bb3 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Dutch.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 c593919b6c0..27c6c9cb87f 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-English.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 a80e35203b1..7850ff0abb1 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-French.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 96219d71ce3..71434eecb77 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-German.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 a470d25c4c2..7997961d921 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Irish.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 bfe5ad78d9e..e2ece51f80b 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Italian.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 6790d186312..928348eb24f 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Magyar.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 b7fe8cca758..7f77cb16860 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Polish.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 f529892e63d..ef896af8f21 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 @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Spanish.dict,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 19b3363a804..7d9d7ce3bf6 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-hypernav.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 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 91669b43672..c6c9764ccc9 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-list.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,52 +38,60 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-list}[2008/12/11 v1.04 (NLCT)] +\ProvidesPackage{glossary-list}[2009/01/14 v1.05 (NLCT)] \newglossarystyle{list}{% -\renewenvironment{theglossary}{\begin{description}}{\end{description}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}% -\renewcommand*{\glossarysubentryfield}[6]{% -\@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6.}% -\renewcommand*{\glsgroupskip}{\indexspace}} + \renewenvironment{theglossary}% + {\begin{description}}{\end{description}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5}% + \renewcommand*{\glossarysubentryfield}[6]{% + \glstarget{##2}{\strut}##4\glspostdescription\space ##6.}% + \renewcommand*{\glsgroupskip}{\indexspace}% +} \newglossarystyle{listgroup}{% -\glossarystyle{list}% -\renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} + \glossarystyle{list}% + \renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} \newglossarystyle{listhypergroup}{% -\glossarystyle{list}% -\renewcommand*{\glossaryheader}{% -\item[\glsnavigation]}% -\renewcommand*{\glsgroupheading}[1]{% -\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} + \glossarystyle{list}% + \renewcommand*{\glossaryheader}{% + \item[\glsnavigation]}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} \newglossarystyle{altlist}{% -\glossarystyle{list}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[\@glstarget{glo:##1}{##2}]\mbox{}\newline ##3\glspostdescription\space ##5}% -\renewcommand{\glossarysubentryfield}[6]{% -\par\@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6}% + \glossarystyle{list}% + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}]\mbox{}\newline + ##3\glspostdescription\space ##5}% + \renewcommand{\glossarysubentryfield}[6]{% + \par\glstarget{##2}{\strut}##4\glspostdescription\space ##6}% } \newglossarystyle{altlistgroup}{% -\glossarystyle{altlist}% -\renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} + \glossarystyle{altlist}% + \renewcommand*{\glsgroupheading}[1]{\item[\glsgetgrouptitle{##1}]}} \newglossarystyle{altlisthypergroup}{% -\glossarystyle{altlist}% -\renewcommand*{\glossaryheader}{% -\item[\glsnavigation]}% -\renewcommand*{\glsgroupheading}[1]{% -\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} + \glossarystyle{altlist}% + \renewcommand*{\glossaryheader}{% + \item[\glsnavigation]}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} \newglossarystyle{listdotted}{% -\glossarystyle{list}% -\renewcommand*{\glossaryentryfield}[5]{% -\item[]\makebox[\glslistdottedwidth][l]{\@glstarget{glo:##1}{##2}% -\unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##3}% -\renewcommand*{\glossarysubentryfield}[6]{% -\item[]\makebox[\glslistdottedwidth][l]{\@glstarget{glo:##2}{##3}% -\unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##4}% + \glossarystyle{list}% + \renewcommand*{\glossaryentryfield}[5]{% + \item[]\makebox[\glslistdottedwidth][l]{\glstarget{##1}{##2}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##3}% + \renewcommand*{\glossarysubentryfield}[6]{% + \item[]\makebox[\glslistdottedwidth][l]{\glstarget{##2}{##3}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}##4}% } \newlength\glslistdottedwidth \setlength{\glslistdottedwidth}{.5\linewidth} +\newglossarystyle{sublistdotted}{% + \glossarystyle{listdotted}% + \renewcommand*{\glossaryentryfield}[5]{% + \item[\glstarget{##1}{##2}]}% +} \endinput %% %% End of file `glossary-list.sty'. 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 9cf3a012605..0adfcefdc38 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-long.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,128 +38,138 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-long}[2008/12/11 v1.02 (NLCT)] +\ProvidesPackage{glossary-long}[2009/01/14 v1.03 (NLCT)] \RequirePackage{longtable} -\newlength\glsdescwidth -\newlength\glspagelistwidth -\setlength{\glsdescwidth}{0.6\linewidth} -\setlength{\glspagelistwidth}{0.1\linewidth} +\@ifundefined{glsdescwidth}{% + \newlength\glsdescwidth + \setlength{\glsdescwidth}{0.6\linewidth} +}{} +\@ifundefined{glspagelistwidth}{% + \newlength\glspagelistwidth + \setlength{\glspagelistwidth}{0.1\linewidth} +}{} \newglossarystyle{long}{% -\renewenvironment{theglossary}{\begin{longtable}{lp{\glsdescwidth}}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3\glspostdescription\space ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6\\}% -\renewcommand*{\glsgroupskip}{ & \\}} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3\glspostdescription\space ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4\glspostdescription\space ##6\\}% + \renewcommand*{\glsgroupskip}{ & \\}% +} \newglossarystyle{longborder}{% -\glossarystyle{long}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|}}{\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% + \glossarystyle{long}% + \renewenvironment{theglossary}{% + \begin{longtable}{|l|p{\glsdescwidth}|}}{\end{longtable}}% + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } \newglossarystyle{longheader}{% -\glossarystyle{long}% -\renewcommand*{\glossaryheader}{% -\bfseries \entryname & \bfseries \descriptionname\\ -\endhead}} + \glossarystyle{long}% + \renewcommand*{\glossaryheader}{% + \bfseries \entryname & \bfseries \descriptionname\\\endhead}% +} \newglossarystyle{longheaderborder}{% -\glossarystyle{longborder}% -\renewcommand*{\glossaryheader}{% -\hline\bfseries \entryname & \bfseries \descriptionname\\\hline -\endhead -\hline\endfoot}} + \glossarystyle{longborder}% + \renewcommand*{\glossaryheader}{% + \hline\bfseries \entryname & \bfseries \descriptionname\\\hline + \endhead + \hline\endfoot}% +} \newglossarystyle{long3col}{% -\renewenvironment{theglossary}{\begin{longtable}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & &\\}} + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##6\\}% + \renewcommand*{\glsgroupskip}{ & &\\}% +} \newglossarystyle{long3colborder}{% -\glossarystyle{long3col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% + \glossarystyle{long3col}% + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } \newglossarystyle{long3colheader}{% -\glossarystyle{long3col}% -\renewcommand*{\glossaryheader}{% -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\endhead}% + \glossarystyle{long3col}% + \renewcommand*{\glossaryheader}{% + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\endhead}% } \newglossarystyle{long3colheaderborder}{% -\glossarystyle{long3colborder}% -\renewcommand*{\glossaryheader}{% -\hline -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\hline\endhead -\hline\endfoot}% + \glossarystyle{long3colborder}% + \renewcommand*{\glossaryheader}{% + \hline + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\hline\endhead + \hline\endfoot}% } \newglossarystyle{long4col}{% -\renewenvironment{theglossary}{% -\begin{longtable}{llll}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##4 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##5 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & & &\\}} + \renewenvironment{theglossary}% + {\begin{longtable}{llll}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##4 & ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##5 & ##6\\}% + \renewcommand*{\glsgroupskip}{ & & &\\}% +} \newglossarystyle{long4colheader}{% -\glossarystyle{long4col}% -\renewcommand*{\glossaryheader}{% -\bfseries\entryname&\bfseries\descriptionname& -\bfseries \symbolname& -\bfseries\pagelistname\\\endhead}% + \glossarystyle{long4col}% + \renewcommand*{\glossaryheader}{% + \bfseries\entryname&\bfseries\descriptionname& + \bfseries \symbolname& + \bfseries\pagelistname\\\endhead}% } \newglossarystyle{long4colborder}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|l|l|l|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% + \glossarystyle{long4col}% + \renewenvironment{theglossary}% + {\begin{longtable}{|l|l|l|l|}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{\hline\endhead\hline\endfoot}% } \newglossarystyle{long4colheaderborder}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|l|l|l|}}{% -\end{longtable}}% -\renewcommand*{\glossaryheader}{% -\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries \symbolname& -\bfseries\pagelistname\\\hline\endhead\hline\endfoot}% + \glossarystyle{long4col}% + \renewenvironment{theglossary}% + {\begin{longtable}{|l|l|l|l|}}% + {\end{longtable}}% + \renewcommand*{\glossaryheader}{% + \hline\bfseries\entryname&\bfseries\descriptionname& + \bfseries \symbolname& + \bfseries\pagelistname\\\hline\endhead\hline\endfoot}% } \newglossarystyle{altlong4col}{% -\glossarystyle{long4col}% -\renewenvironment{theglossary}{% -\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{longtable}}% + \glossarystyle{long4col}% + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{longtable}}% } \newglossarystyle{altlong4colheader}{% -\glossarystyle{long4colheader}% -\renewenvironment{theglossary}{% -\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{longtable}}% + \glossarystyle{long4colheader}% + \renewenvironment{theglossary}% + {\begin{longtable}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{longtable}}% } \newglossarystyle{altlong4colborder}{% -\glossarystyle{long4colborder}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagewidthlist}|}}{% -\end{longtable}}% + \glossarystyle{long4colborder}% + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{longtable}}% } \newglossarystyle{altlong4colheaderborder}{% -\glossarystyle{long4colheaderborder}% -\renewenvironment{theglossary}{% -\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagewidthlist}|}}{% -\end{longtable}}% + \glossarystyle{long4colheaderborder}% + \renewenvironment{theglossary}% + {\begin{longtable}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{longtable}}% } \endinput %% 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 cf7e19ccdd9..45c35e0d4c6 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-super.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,145 +38,166 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-super}[2008/12/11 v1.02 (NLCT)] +\ProvidesPackage{glossary-super}[2009/01/14 v1.03 (NLCT)] \RequirePackage{supertabular} +\@ifundefined{glsdescwidth}{% + \newlength\glsdescwidth + \setlength{\glsdescwidth}{0.6\linewidth} +}{} +\@ifundefined{glspagelistwidth}{% + \newlength\glspagelistwidth + \setlength{\glspagelistwidth}{0.1\linewidth} +}{} \newglossarystyle{super}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3\glspostdescription\space ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4\glspostdescription\space ##6\\}% -\renewcommand*{\glsgroupskip}{ & \\}} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}}}% + {\end{supertabular}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3\glspostdescription\space ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4\glspostdescription\space ##6\\}% + \renewcommand*{\glsgroupskip}{ & \\}% +} \newglossarystyle{superborder}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|}}{\end{supertabular}}% + \glossarystyle{super}% + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|}}% + {\end{supertabular}}% } \newglossarystyle{superheader}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries \entryname & \bfseries \descriptionname\\}% -\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}}}{\end{supertabular}}% + \glossarystyle{super}% +\renewenvironment{theglossary}% + {\tablehead{\bfseries \entryname & \bfseries \descriptionname\\}% + \tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}}}% + {\end{supertabular}}% } \newglossarystyle{superheaderborder}{% -\glossarystyle{super}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries \entryname & \bfseries \descriptionname\\\hline}% -\tabletail{\hline} -\begin{supertabular}{|l|p{\glsdescwidth}|}}{\end{supertabular}}% + \glossarystyle{super}% + \renewenvironment{theglossary}% + {\tablehead{\hline\bfseries \entryname & + \bfseries \descriptionname\\\hline}% + \tabletail{\hline} + \begin{supertabular}{|l|p{\glsdescwidth}|}}% + {\end{supertabular}}% } \newglossarystyle{super3col}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & &\\}} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{supertabular}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##6\\}% + \renewcommand*{\glsgroupskip}{ & &\\}% +} \newglossarystyle{super3colborder}{% -\glossarystyle{super3col}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{supertabular}}% + \glossarystyle{super3col}% + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } \newglossarystyle{super3colheader}{% -\glossarystyle{super3col}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}{% -\end{supertabular}}% + \glossarystyle{super3col}% + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}p{\glspagelistwidth}}}% + {\end{supertabular}}% } \newglossarystyle{super3colheaderborder}{% -\glossarystyle{super3colborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline -\bfseries\entryname&\bfseries\descriptionname& -\bfseries\pagelistname\\\hline}% -\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}{% -\end{supertabular}}% + \glossarystyle{super3colborder}% + \renewenvironment{theglossary}% + {\tablehead{\hline + \bfseries\entryname&\bfseries\descriptionname& + \bfseries\pagelistname\\\hline}% + \tabletail{\hline}% + \begin{supertabular}{|l|p{\glsdescwidth}|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } \newglossarystyle{super4col}{% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{llll}}{% -\end{supertabular}}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand*{\glossaryentryfield}[5]{% -\@glstarget{glo:##1}{##2} & ##3 & ##4 & ##5\\}% -\renewcommand*{\glossarysubentryfield}[6]{% - & \@glstarget{glo:##2}{\strut}##4 & ##5 & ##6\\}% -\renewcommand*{\glsgroupskip}{ & & &\\}} + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{llll}}{% + \end{supertabular}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \glstarget{##1}{##2} & ##3 & ##4 & ##5\\}% + \renewcommand*{\glossarysubentryfield}[6]{% + & \glstarget{##2}{\strut}##4 & ##5 & ##6\\}% + \renewcommand*{\glsgroupskip}{ & & &\\}% +} \newglossarystyle{super4colheader}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{llll}}{% -\end{supertabular}}% + \glossarystyle{super4col}% + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\}% + \tabletail{}% + \begin{supertabular}{llll}}% + {\end{supertabular}}% } \newglossarystyle{super4colborder}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|l|l|l|}}{% -\end{supertabular}}% + \glossarystyle{super4col}% + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}{|l|l|l|l|}}% + {\end{supertabular}}% } \newglossarystyle{super4colheaderborder}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{\hline}% -\begin{supertabular}{|l|l|l|l|}}{% -\end{supertabular}}% + \glossarystyle{super4col}% + \renewenvironment{theglossary}% + {\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\\hline}\tabletail{\hline}% + \begin{supertabular}{|l|l|l|l|}}% + {\end{supertabular}}% } \newglossarystyle{altsuper4col}{% -\glossarystyle{super4col}% -\renewenvironment{theglossary}{% -\tablehead{}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{supertabular}}% + \glossarystyle{super4col}% + \renewenvironment{theglossary}% + {\tablehead{}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{supertabular}}% } \newglossarystyle{altsuper4colheader}{% -\glossarystyle{super4colheader}% -\renewenvironment{theglossary}{% -\tablehead{\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{}% -\begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}{% -\end{supertabular}}% + \glossarystyle{super4colheader}% + \renewenvironment{theglossary}% + {\tablehead{\bfseries\entryname&\bfseries\descriptionname& + \bfseries\symbolname & + \bfseries\pagelistname\\}\tabletail{}% + \begin{supertabular}{lp{\glsdescwidth}lp{\glspagelistwidth}}}% + {\end{supertabular}}% } \newglossarystyle{altsuper4colborder}{% -\glossarystyle{super4colborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}{% -\end{supertabular}}% + \glossarystyle{super4colborder}% + \renewenvironment{theglossary}% + {\tablehead{\hline}\tabletail{\hline}% + \begin{supertabular}% + {|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } \newglossarystyle{altsuper4colheaderborder}{% -\glossarystyle{super4colheaderborder}% -\renewenvironment{theglossary}{% -\tablehead{\hline\bfseries\entryname&\bfseries\descriptionname& -\bfseries\symbolname & -\bfseries\pagelistname\\}\tabletail{\hline}% -\begin{supertabular}{|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}{% -\end{supertabular}}% + \glossarystyle{super4colheaderborder}% + \renewenvironment{theglossary}% + {\tablehead{\hline + \bfseries\entryname & + \bfseries\descriptionname & + \bfseries\symbolname & + \bfseries\pagelistname\\\hline}% + \tabletail{\hline}% + \begin{supertabular}% + {|l|p{\glsdescwidth}|l|p{\glspagelistwidth}|}}% + {\end{supertabular}}% } \endinput %% 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 e36055dce24..1bdf157b0c5 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-tree.sty,package') %% %% glossaries.dtx -%% Copyright 2008 Nicola Talbot +%% Copyright 2009 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,189 +38,204 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-tree}[2008/12/11 v1.0 (NLCT)] +\ProvidesPackage{glossary-tree}[2009/01/14 v1.01 (NLCT)] \newglossarystyle{index}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -\let\item\@idxitem}{}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + \let\item\@idxitem}% + {}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% \renewcommand*{\glossaryentryfield}[5]{% -\item\textbf{\@glstarget{glo:##1}{##2}}% +\item\textbf{\glstarget{##1}{##2}}% \ifx\relax##4\relax \else \space(##4)% \fi \space ##3\glspostdescription \space ##5}% -\renewcommand*{\glossarysubentryfield}[6]{% - \ifcase##1\relax - \item - \or - \subitem - \else - \subsubitem - \fi - \textbf{\@glstarget{glo:##2}{##3}}% - \ifx\relax##5\relax - \else - \space(##5)% - \fi - \space##4\glspostdescription\space ##6}% -\renewcommand*{\glsgroupskip}{\indexspace}} + \renewcommand*{\glossarysubentryfield}[6]{% + \ifcase##1\relax + % level 0 + \item + \or + % level 1 + \subitem + \else + % all other levels + \subsubitem + \fi + \textbf{\glstarget{##2}{##3}}% + \ifx\relax##5\relax + \else + \space(##5)% + \fi + \space##4\glspostdescription\space ##6}% + \renewcommand*{\glsgroupskip}{\indexspace}} \newglossarystyle{indexgroup}{% -\glossarystyle{index}% -\renewcommand*{\glsgroupheading}[1]{% - \item\textbf{\glsgetgrouptitle{##1}}\indexspace}} + \glossarystyle{index}% + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsgetgrouptitle{##1}}\indexspace}% +} \newglossarystyle{indexhypergroup}{% -\glossarystyle{index}% -\renewcommand*{\glossaryheader}{% -\item\textbf{\glsnavigation}\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% -\indexspace}} + \glossarystyle{index}% + \renewcommand*{\glossaryheader}{% + \item\textbf{\glsnavigation}\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% + \indexspace}% +} \newglossarystyle{tree}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -}{}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand{\glossaryentryfield}[5]{% - \hangindent0pt\relax - \parindent0pt\relax - \textbf{\@glstarget{glo:##1}{##2}}% - \ifx\relax##4\relax - \else - \space(##4)% - \fi - \space ##3\glspostdescription \space ##5\par}% -\renewcommand{\glossarysubentryfield}[6]{% - \hangindent##1\glstreeindent\relax - \parindent##1\glstreeindent\relax - \textbf{\@glstarget{glo:##2}{##3}}% - \ifx\relax##5\relax - \else - \space(##5)% - \fi - \space##4\glspostdescription\space ##6\par}% -\renewcommand*{\glsgroupskip}{\indexspace}} + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}}% + {}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand{\glossaryentryfield}[5]{% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glstarget{##1}{##2}}% + \ifx\relax##4\relax + \else + \space(##4)% + \fi + \space ##3\glspostdescription \space ##5\par}% + \renewcommand{\glossarysubentryfield}[6]{% + \hangindent##1\glstreeindent\relax + \parindent##1\glstreeindent\relax + \textbf{\glstarget{##2}{##3}}% + \ifx\relax##5\relax + \else + \space(##5)% + \fi + \space##4\glspostdescription\space ##6\par}% + \renewcommand*{\glsgroupskip}{\indexspace}} \newglossarystyle{treegroup}{% -\glossarystyle{tree}% -\renewcommand{\glsgroupheading}[1]{\par -\noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} + \glossarystyle{tree}% + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} \newglossarystyle{treehypergroup}{% -\glossarystyle{tree}% -\renewcommand*{\glossaryheader}{% -\par\noindent\textbf{\glsnavigation}\par\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\par\noindent -\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par -\indexspace}} + \glossarystyle{tree}% + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} \newlength\glstreeindent \setlength{\glstreeindent}{10pt} \newglossarystyle{treenoname}{% -\renewenvironment{theglossary}{% -\setlength{\parindent}{0pt}% -\setlength{\parskip}{0pt plus 0.3pt}% -}{}% -\renewcommand*{\glossaryheader}{}% + \renewenvironment{theglossary}% + {\setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}}% + {}% + \renewcommand*{\glossaryheader}{}% \renewcommand*{\glsgroupheading}[1]{}% -\renewcommand{\glossaryentryfield}[5]{% - \hangindent0pt\relax - \parindent0pt\relax - \textbf{\@glstarget{glo:##1}{##2}}% - \ifx\relax##4\relax - \else - \space(##4)% - \fi - \space ##3\glspostdescription \space ##5\par}% -\renewcommand{\glossarysubentryfield}[6]{% - \hangindent##1\glstreeindent\relax - \parindent##1\glstreeindent\relax - \textbf{\@glstarget{glo:##2}{\strut}}% - ##4\glspostdescription\space ##6\par}% -\renewcommand*{\glsgroupskip}{\indexspace}} + \renewcommand{\glossaryentryfield}[5]{% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glstarget{##1}{##2}}% + \ifx\relax##4\relax + \else + \space(##4)% + \fi + \space ##3\glspostdescription \space ##5\par}% + \renewcommand{\glossarysubentryfield}[6]{% + \hangindent##1\glstreeindent\relax + \parindent##1\glstreeindent\relax + \glstarget{##2}{\strut}% + ##4\glspostdescription\space ##6\par}% + \renewcommand*{\glsgroupskip}{\indexspace}% +} \newglossarystyle{treenonamegroup}{% -\glossarystyle{treenoname}% -\renewcommand{\glsgroupheading}[1]{\par -\noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} + \glossarystyle{treenoname}% + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} \newglossarystyle{treenonamehypergroup}{% -\glossarystyle{treenoname}% -\renewcommand*{\glossaryheader}{% -\par\noindent\textbf{\glsnavigation}\par\indexspace}% -\renewcommand*{\glsgroupheading}[1]{% -\par\noindent -\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par -\indexspace}} + \glossarystyle{treenoname}% + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} \newcommand*{\glssetwidest}[2][0]{% \expandafter\def\csname @glswidestname\romannumeral#1\endcsname{% #2}% } \newcommand*{\@glswidestname}{} \newglossarystyle{alttree}{% -\renewenvironment{theglossary}{% -\def\@gls@prevlevel{-1}% -\mbox{}\par}{\par}% -\renewcommand*{\glossaryheader}{}% -\renewcommand*{\glsgroupheading}[1]{}% -\renewcommand{\glossaryentryfield}[5]{% - \ifnum\@gls@prevlevel=0\relax - \else - \settowidth{\glstreeindent}{\textbf{\@glswidestname\space}}% + \renewenvironment{theglossary}% + {\def\@gls@prevlevel{-1}% + \mbox{}\par}% + {\par}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand{\glossaryentryfield}[5]{% + \ifnum\@gls@prevlevel=0\relax + \else + \settowidth{\glstreeindent}{\textbf{\@glswidestname\space}}% + \hangindent\glstreeindent + \parindent\glstreeindent + \fi + \makebox[0pt][r]{\makebox[\glstreeindent][l]{% + \textbf{\glstarget{##1}{##2}}}}% + \ifx\relax##4\relax + \else + (##4)\space + \fi + ##3\glspostdescription \space ##5\par + \def\@gls@prevlevel{0}% + }% + \renewcommand{\glossarysubentryfield}[6]{% + \ifnum\@gls@prevlevel=##1\relax + \else + \@ifundefined{@glswidestname\romannumeral##1}{% + \settowidth{\gls@tmplen}{\textbf{\@glswidestname\space}}}{% + \settowidth{\gls@tmplen}{\textbf{% + \csname @glswidestname\romannumeral##1\endcsname\space}}}% + \ifnum\@gls@prevlevel<##1\relax + \setlength\glstreeindent\gls@tmplen + \addtolength\glstreeindent\parindent + \parindent\glstreeindent + \else + \@ifundefined{@glswidestname\romannumeral\@gls@prevlevel}{% + \settowidth{\glstreeindent}{\textbf{% + \@glswidestname\space}}}{% + \settowidth{\glstreeindent}{\textbf{% + \csname @glswidestname\romannumeral\@gls@prevlevel + \endcsname\space}}}% + \addtolength\parindent{-\glstreeindent}% + \setlength\glstreeindent\parindent + \fi + \fi \hangindent\glstreeindent - \parindent\glstreeindent - \fi - \makebox[0pt][r]{\makebox[\glstreeindent][l]{% - \textbf{\@glstarget{glo:##1}{##2}}}}% - \ifx\relax##4\relax - \else - (##4)\space - \fi - ##3\glspostdescription \space ##5\par - \def\@gls@prevlevel{0}% -}% -\renewcommand{\glossarysubentryfield}[6]{% - \ifnum\@gls@prevlevel=##1\relax - \else - \@ifundefined{@glswidestname\romannumeral##1}{% - \settowidth{\gls@tmplen}{\textbf{\@glswidestname\space}}}{% - \settowidth{\gls@tmplen}{\textbf{% - \csname @glswidestname\romannumeral##1\endcsname\space}}}% - \ifnum\@gls@prevlevel<##1\relax - \setlength\glstreeindent\gls@tmplen - \addtolength\glstreeindent\parindent - \parindent\glstreeindent + \makebox[0pt][r]{\makebox[\gls@tmplen][l]{% + \textbf{\glstarget{##2}{##3}}}}% + \ifx##5\relax\relax \else - \@ifundefined{@glswidestname\romannumeral\@gls@prevlevel}{% - \settowidth{\glstreeindent}{\textbf{% - \@glswidestname\space}}}{% - \settowidth{\glstreeindent}{\textbf{% - \csname @glswidestname\romannumeral\@gls@prevlevel - \endcsname\space}}}% - \addtolength\parindent{-\glstreeindent}% - \setlength\glstreeindent\parindent + (##5)\space \fi - \fi - \hangindent\glstreeindent - \makebox[0pt][r]{\makebox[\gls@tmplen][l]{% - \textbf{\@glstarget{glo:##2}{##3}}}}% - \ifx##5\relax\relax - \else - (##5)\space - \fi - ##4\glspostdescription\space ##6\par - \def\@gls@prevlevel{##1}}% -\renewcommand*{\glsgroupskip}{\indexspace}} + ##4\glspostdescription\space ##6\par + \def\@gls@prevlevel{##1}% + }% + \renewcommand*{\glsgroupskip}{\indexspace}% +} \newglossarystyle{alttreegroup}{% -\glossarystyle{alttree}% -\renewcommand{\glsgroupheading}[1]{\par -\def\@gls@prevlevel{-1}% -\hangindent0pt\relax -\parindent0pt\relax -\textbf{\glsgetgrouptitle{##1}}\par\indexspace}} + \glossarystyle{alttree}% + \renewcommand{\glsgroupheading}[1]{\par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} \newglossarystyle{alttreehypergroup}{% -\glossarystyle{alttree}% + \glossarystyle{alttree}% \renewcommand*{\glossaryheader}{% \par \def\@gls@prevlevel{-1}% -- cgit v1.2.3
    Table 1: Mappings from glossary to glossaries @@ -203,8 +289,8 @@ package options