From b172732c296db880f27bfba6ea750c2f4bffb860 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 20 Jan 2014 23:17:11 +0000 Subject: glossaries (20jan14) git-svn-id: svn://tug.org/texlive/trunk@32735 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 31 + Master/texmf-dist/doc/latex/glossaries/README | 12 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 874535 -> 900568 bytes .../doc/latex/glossaries/glossaries-user.html | 37163 +++++++++---------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 603048 -> 610821 bytes .../doc/latex/glossaries/glossaries-user.tex | 309 +- .../doc/latex/glossaries/glossariesbegin.html | 1047 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 92421 -> 93190 bytes .../doc/latex/glossaries/glossariesbegin.tex | 27 +- .../doc/latex/glossaries/glossary2glossaries.html | 2237 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 140840 -> 140904 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../doc/latex/glossaries/mfirstuc-manual.html | 492 +- .../doc/latex/glossaries/mfirstuc-manual.pdf | Bin 145369 -> 145369 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49935 -> 49406 bytes .../doc/latex/glossaries/samples/minimalgls.tex | 17 +- .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58845 -> 58845 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53480 -> 53480 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82221 -> 82221 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36474 -> 36474 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 34915 -> 34915 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 43398 -> 43398 bytes .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 147346 -> 147250 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 38853 -> 38853 bytes .../latex/glossaries/samples/sample-mfirstuc.pdf | Bin 23740 -> 23740 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 35496 -> 35496 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 40532 -> 40532 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 41998 -> 41998 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 43275 -> 43275 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 21716 -> 21716 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 102972 -> 102883 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43335 -> 43335 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 65684 -> 65684 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 65541 -> 65541 bytes .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 93546 -> 93546 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47058 -> 47058 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48456 -> 48456 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155714 -> 155816 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169293 -> 169306 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91282 -> 91282 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98036 -> 98845 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 47464 -> 47464 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65965 -> 65965 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 95320 -> 95236 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41179 -> 41173 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 64417 -> 64417 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 59840 -> 66946 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44942 -> 44942 bytes .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 178726 -> 178756 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 67872 -> 67872 bytes .../texmf-dist/scripts/glossaries/makeglossaries | 134 +- .../scripts/glossaries/makeglossaries.bat | 6 +- .../source/latex/glossaries/glossaries.dtx | 3037 +- .../source/latex/glossaries/glossaries.ins | 4 +- .../tex/latex/glossaries/base/glossaries-babel.sty | 2 +- .../glossaries/base/glossaries-compatible-207.sty | 2 +- .../glossaries/base/glossaries-compatible-307.sty | 2 +- .../glossaries/base/glossaries-polyglossia.sty | 2 +- .../tex/latex/glossaries/base/glossaries.sty | 874 +- .../tex/latex/glossaries/base/mfirstuc.sty | 2 +- .../dict/glossaries-dictionary-Brazilian.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-Serbian.dict | 2 +- .../dict/glossaries-dictionary-Spanish.dict | 2 +- .../latex/glossaries/expl/glossaries-accsupp.sty | 819 +- .../latex/glossaries/styles/glossary-hypernav.sty | 2 +- .../latex/glossaries/styles/glossary-inline.sty | 2 +- .../tex/latex/glossaries/styles/glossary-list.sty | 2 +- .../tex/latex/glossaries/styles/glossary-long.sty | 2 +- .../glossaries/styles/glossary-longragged.sty | 2 +- .../tex/latex/glossaries/styles/glossary-mcols.sty | 2 +- .../tex/latex/glossaries/styles/glossary-super.sty | 2 +- .../glossaries/styles/glossary-superragged.sty | 2 +- .../tex/latex/glossaries/styles/glossary-tree.sty | 2 +- 82 files changed, 23900 insertions(+), 22363 deletions(-) (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 5b86944f435..bd8dc9e5316 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,36 @@ glossaries change log: +v4.03: + + glossaries.sty: + + * Added \glsifhasfield + + * Changed default definition of \glswritefiles to \@empty + instead of \relax + + * Fixed bug in \ifglsdescsuppressed + + * Added \glsdetoklabel + + * Added \glsdoifexistsorwarn + + * Changed \glossentryname etc to use \glsdoifexistsorwarn + instead of \glsdoifexists + + * Added \renewacronymstyle + + * Fixed bug in dua acronym style + + glossaries-accsupp.sty: + + * Redefined acronym styles to use accessibility support + + makeglossaries v2.12: + + * Added check for backslashes in -x, -m and -d arguments + + v4.02: glossaries.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 9ac6ec74d77..fa376f5bcd1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,9 +1,11 @@ -LaTeX Package : glossaries v4.02 +LaTeX Package : glossaries v4.03 -Last Modified : 2013-12-05 +Last Modified : 2014-01-20 Author : Nicola Talbot +Package FAQ : http://www.dickimaw-books.com/faqs/glossariesfaq.html + This package is provided to assist generating glossaries. The package supports acronyms and multiple glossaries. New entries are defined to have a name and description (and @@ -23,9 +25,9 @@ object in the group is converted to uppercase. Examples: \makefirstuc{abc} -> Abc \makefirstuc{\emph{abc}} -> \emph{Abc} - \makefirstuc{{\'a}bc} -> {\'A}bc + \makefirstuc{{\'a}bc} -> \'Abc \makefirstuc{\ae bc} -> \AE bc - \makefirstuc{{\ae}bc} -> {\AE}bc + \makefirstuc{{\ae}bc} -> \AE bc \makefirstuc{\ae{}bc} -> \AE{}bc glossaries-accsupp.sty is an experimental package that uses the @@ -74,7 +76,7 @@ way. LICENCE This material is subject to the LaTeX Project Public License. -See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html +See http://www.ctan.org/license/lppl1.3 for the details of that license. Author's home page: http://www.dickimaw-books.com/ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf index b2e082fb472..306bb9a781d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index 456b2a06e17..61e8b320194 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -1,84 +1,74 @@ - + -User Manual for glossaries.sty v4.02 +User Manual for glossaries.sty v4.03 - - + + - + -
- - - - - - - +
+ + - -
-
- -

User Manual for glossaries.sty -v4.02

-
Nicola L.C. Talbot +

User Manual for glossaries.sty v4.03

+
Nicola L.C. Talbot
http://www.dickimaw-books.com/

+class="cmtt-12">http://www.dickimaw-_books.com/

2013-12-05
- - - -
-

Documents have various styles when it comes to presenting glossaries or -lists of terms or notation. People have their own preferences and to -a large extent this is determined by the kind of information that -needs to go in the glossary. They may just have symbols with terse -descriptions or they may have long technical words with complicated -descriptions. The glossaries package is flexible enough to accommodate -such varied requirements, but this flexibility comes at a price: a big +class="cmr-12">2014-01-20
+ + +
+
+

+ + +

+
+

+

Abstract

+

The glossaries package provides a means to define terms or acronyms or symbols that can +be referenced within your document. Sorted lists with collated locations can be +generated using a supplementary indexing application. +

+ + +

+
+

Documents have various styles when it comes to presenting glossaries or lists of +terms or notation. People have their own preferences and to a large extent this is +determined by the kind of information that needs to go in the glossary. They may just +have symbols with terse descriptions or they may have long technical words +with complicated descriptions. The glossaries package is flexible enough to +accommodate such varied requirements, but this flexibility comes at a price: a big manual. -

😱 If you’re freaking out at the size of this manual, start with -glossariesbegin.pdf (“The glossaries package: a guide for beginnners”). -You should find it in the same directory as this document or try texdoc -glossariesbegin.pdf. Once you’ve got to grips with the basics, then -come back to this manual to find out how to adjust the settings. -

-

-

The glossaries bundle comes with the following documentation: +

😱 If you’re freaking out at the size of this manual, start with glossariesbegin.pdf +(“The glossaries package: a guide for beginnners”). You should find it in the same +directory as this document or try texdoc glossariesbegin.pdf. Once you’ve got to +grips with the basics, then come back to this manual to find out how to adjust the +settings. +

+

The glossaries bundle comes with the following documentation:

glossariesbegin.pdf
If you are a complete beginner, start with - “The glossaries package: a guide for beginners”. +class="cmtt-10">glossariesbegin.pdf
If you are a complete beginner, start with “The glossaries + package: a guide for beginners”.
glossary2glossaries.pdf
If you are moving over from the obsolete - glossary package, read “Upgrading from the glossary package to - the glossaries package”. +class="cmtt-10">glossary2glossaries.pdf
If you are moving over from the obsolete glossary + package, read “Upgrading from the glossary package to the glossaries + package”.
glossaries-user.pdf
This document is the main user guide for the - glossaries package. +class="cmbx-10">glossaries-user.pdf
This document is the main user guide for the glossaries + package.
mfirstuc-manual.pdf
The commands provided by the mfirstuc - package are briefly described in “mfirstuc.sty: uppercasing first - letter”. +class="cmtt-10">mfirstuc-_manual.pdf
The commands provided by the mfirstuc package are + briefly described in “mfirstuc.sty: uppercasing first letter”.
glossaries-code.pdf
Advanced users wishing to know more about - the inner workings of all the packages provided in the glossaries - bundle should read “Documented Code for glossaries v4.02”. - This includes the documented code for the mfirstuc package. +class="cmtt-10">glossaries-_code.pdf
Advanced users wishing to know more about the inner + workings of all the packages provided in the glossaries bundle should read + “Documented Code for glossaries v4.03”. This includes the documented + code for the mfirstuc package.
INSTALL
INSTALL
Installation instructions. - - -
CHANGES
CHANGES
Change log.
README
README
Package summary.
-

If you use hyperref and glossaries, you must load hyperref first. -Similarly the doc package must also be loaded before glossaries. (If -doc is loaded, the file extensions for the default main glossary are -changed to gls2, glo2 and .glg2 to avoid conflict with doc’s changes -glossary.)

If you use hyperref and glossaries, you must load hyperref first. Similarly the doc +package must also be loaded before glossaries. (If doc is loaded, the file extensions for +the default main glossary are changed to gls2, glo2 and .glg2 to avoid conflict with +doc’s changes glossary.) -

If you are using hyperref, it’s best to use pdflatex rather than latex -(DVI format) as pdflatex deals with hyperlinks much better. If you use -the DVI format, you will encounter problems where you have long -hyperlinks or hyperlinks in subscripts or superscripts. This is an issue with -the DVI format not with glossaries.

-

-

Other documents that describe using the glossaries package include: -Using LaTeX to Write a PhD Thesis and Glossaries, Nomenclature, Lists -of Symbols and Acronyms. - - - - - - -

-

Contents

-
-   

If you are using hyperref, it’s best to use pdflatex rather than latex (DVI +format) as pdflatex deals with hyperlinks much better. If you use the DVI format, +you will encounter problems where you have long hyperlinks or hyperlinks in +subscripts or superscripts. This is an issue with the DVI format not with glossaries. +

+

+

Other documents that describe using the glossaries package include: Using LaTeX +to Write a PhD Thesis and Glossaries, Nomenclature, Lists of Symbols and +Acronyms. + + + + +

+

Contents

+ Glossary -
1   1 Introduction -
 1.1    1.1 Sample Documents -
 1.2    1.2 Multi-Lingual Support -
  1.2.1     1.2.1 Changing the Fixed Names -
 1.3    1.3 Generating the Associated Glossary Files -
  1.3.1     1.3.1 Using the makeglossaries Perl Script -
  1.3.2     1.3.2 Using xindy explicitly -
  1.3.3     1.3.3 Using makeindex explicitly -
  1.3.4     1.3.4 Note to Front-End and Script Developers -
2   2 Package Options -
 2.1    2.1 General Options -
 2.2    2.2 Sectioning, Headings and TOC Options -
 2.3    2.3 Glossary Appearance Options -
 2.4    2.4 Sorting Options -
 2.5    2.5 Acronym Options -
  2.5.1     2.5.1 Deprecated Acronym Style Options -
 2.6    2.6 Other Options -
 2.7    2.7 Setting Options After the Package is Loaded -
3   3 Setting Up -
4   4 Defining Glossary Entries -
 4.1    4.1 Plurals -
 4.2    4.2 Other Grammatical Constructs -
 4.3    4.3 Additional Keys -
 4.4    4.4 Expansion -
 4.5    4.5 Sub-Entries -
  4.5.1     4.5.1 Hierarchical Categories -
  4.5.2     4.5.2 Homographs -
 4.6    4.6 Loading Entries From a File -
 4.7    4.7 Moving Entries to Another Glossary -
 4.8    4.8 Drawbacks With Defining Entries in the Document Environment -
  4.8.1     4.8.1 Technical Issues -
  4.8.2     4.8.2 Good Practice Issues -
5   5 Number lists -
6   6 Links to Glossary Entries - - - -
 6.1    6.1 Changing the format of the link text -
 6.2    6.2 Enabling and disabling hyperlinks to glossary entries -
7   7 Adding an Entry to the Glossary Without Generating Text -
8   8 Cross-Referencing Entries -
 8.1    8.1 Customising Cross-reference Text -
9   9 Using Glossary Terms Without Links -
10   10 Displaying a glossary -
11   11 Xindy -
 11.1    11.1 Language and Encodings -
 11.2    11.2 Locations and Number lists -
 11.3    11.3 Glossary Groups -
12   12 Defining New Glossaries -
13   13 Acronyms -
 13.1    13.1 Changing the Acronym Style -
  13.1.1     13.1.1 Predefined Acronym Styles -
  13.1.2     13.1.2 Defining A Custom Acronym Style -
 13.2    13.2 Displaying the List of Acronyms -
 13.3    13.3 Upgrading From the glossary Package -
14   14 Unsetting and Resetting Entry Flags -
15   15 Glossary Styles -
 15.1  List Styles -
 15.2  Longtable Styles -
 15.3  Longtable Styles (Ragged Right) -
 15.4  Supertabular Styles -
 15.5  Supertabular Styles (Ragged Right) -
 15.6  Tree-Like Styles -
 15.7  Multicols Style -
 15.8  In-Line Style -
16  Defining your own glossary style -
17  Utilities -
18  Prefixes or Determiners -
19  Accessibility Support -
20  Troubleshooting -
    15.1 Predefined Styles +
  15.1.1 List Styles +
  15.1.2 Longtable Styles +
  15.1.3 Longtable Styles (Ragged Right) +
  15.1.4 Supertabular Styles +
  15.1.5 Supertabular Styles (Ragged Right) +
  15.1.6 Tree-Like Styles +
  15.1.7 Multicols Style +
  15.1.8 In-Line Style +
 15.2 Defining your own glossary style +
16 Utilities +
17 Prefixes or Determiners +
18 Accessibility Support +
19 Troubleshooting +
Index -
- - - - - - - - - -

List of Tables

-
1.1  + + + + + + +

List of Tables

1.1 Supported Languages
1.2 Customised Text
1.3 Commands and package -options that have no effect when using xindy or makeindex explicitly
4.1 Key to -Field Mappings
6.1 Predefined Hyperlinked Location Formats
13.1 Synonyms -provided by the package option shortcuts
13.2 The effect of using -xspace
15.1 Glossary Styles
15.2 Multicolumn Styles
-
- - - - - - -

Commands +and package options that have no effect when using xindy or makeindex +explicitly
4.1 Key to Field Mappings
6.1 Predefined Hyperlinked Location +Formats
13.1 Synonyms provided by the package option shortcuts
13.2 The +effect of using xspace
15.1 Glossary Styles
15.2 Multicolumn Styles
+

+ + + + +

- - - + +

-

Glossary

-

This glossary style was setup using:

+

Glossary

This glossary style was setup using:
\usepackage[\usepackage[xindy, +class="cmtt-10">xindy,
-

nonumberlist,
-

nonumberlist,
+

seeautonumberlist,
-

seeautonumberlist,
+

toc,
-

toc,
+

style=altlist,
-

style=altlist,
+

nogroupskip]{glossaries}
+class="cmtt-10">nogroupskip]{glossaries}

\glsnoexpandfields
\glsnoexpandfields
\renewcommand*{\glsseeformat\renewcommand*{\glsseeformat}[3][\seename}[3][\seename]{%
]{%
(\xmakefirstuc(\xmakefirstuc{#1} \glsseelist{#1} \glsseelist{#2}.)} +class="cmsy-10">{#2}.)}

First useCommand Line Interface (CLI)

An application that doesn’t have a graphical user interface. That is, an + application that doesn’t have any windows, buttons or menus and can be + run in a command prompt or terminal.
+
+Entry location

The first time a glossary entry is used (from the start of the - document or after a reset) with one of the following commands: - \gls, \GlsThe location of the entry in the document. This defaults to the page number + on which the entry appears. An entry may have multiple locations.
+
+First use

The first time a glossary entry is used (from the start of the document + or after a reset) with one of the following commands: \gls, \GLS\Gls, \glspl, \Glspl\GLS, + \glspl, \GLSpl or \glsdisp. (See - \Glspl, \GLSpl or \glsdisp. (See first use flag & first use text.)
first use text.) +
First use flag
First use flag

A conditional that determines whether or not the entry has been - used according to the rules of first use. Commands to unset - or reset this conditional are described in A conditional that determines whether or not the entry has been used + according to the rules of first use. Commands to unset or reset this + conditional are described in §14 Unsetting and - Resetting Entry Flags.
§14 Unsetting and Resetting Entry Flags.
First use text
First use text

The text that is displayed on first use, which is governed by - the first and firstplural keys of \newglossaryentry. (May be - overridden by \glsdisp.)
first use, which is governed by the first and + firstplural keys of \newglossaryentry. (May be overridden by \glsdisp.) +
- - -
Indexing application
Indexing application

An application (piece of software) - separate from TAn application (piece of software) separate from TEX/LATEX that collates and sorts information - that has an associated page reference. Generally the information - is an index entry but in this case the information is a glossary - entry. There are two main indexing applications that are used +class="E">EX that + collates and sorts information that has an associated page reference. + Generally the information is an index entry but in this case the information + is a glossary entry. There are two main indexing applications that are used with TEX: makeindex and makeindex and xindy. These are both command line - interface (CLI) applications.
xindy. These are both command line interface + (CLI) applications.
Link text
Link text

The text produced by commands such as \gls. It may or may - not be a hyperlink to the glossary.
\gls. It may or may not be a + hyperlink to the glossary.
Location list
Location list

A list of entry locations. (See number list.)
.)
makeglossaries
makeglossaries

A custom designed Perl script interface to xindy and xindy and makeindex - provided with the glossaries package.
makeindex provided + with the glossaries package.
makeglossariesgui
makeglossariesgui

A Java GUI alternative to makeglossaries that also provides - diagnostic tools. Home page: http://www.dickimaw-books.com/apps/makeglossariesgui/. - Also available on CTAN.
makeglossaries that also provides diagnostic + tools. Available separately on CTAN.
makeindex
makeindex

An indexing application.
+ +
Number list
Number list

A list of entry locations (also called a location list). The number - list can be suppressed using the nonumberlist package option.
entry locations (also called a location list). The number list can + be suppressed using the nonumberlist package option.
- - -
Sanitize
Sanitize

Converts command names into character sequences. That is, a - command called, say, \foo, is converted into the sequence of - characters: \, f, o, o. Depending on the font, the backslash - character may appear as a dash when used in the main document - text, so \foo will appear as: —foo. -

Earlier versions of glossaries used this technique to write - information to the files used by the indexing applications to - prevent problems caused by fragile commands. Now, this is only - used for the sort key.
Converts command names into character sequences. That is, a command + called, say, \foo, is converted into the sequence of characters: \, f, o, o. + Depending on the font, the backslash character may appear as a dash when + used in the main document text, so \foo will appear as: —foo. +

Earlier versions of glossaries used this technique to write information to + the files used by the indexing applications to prevent problems caused by + fragile commands. Now, this is only used for the sort key.

xindy
xindy

A flexible indexing application with multilingual support written - in Perl.
indexing application with multilingual support written in Perl.
- - - -

1  

1. Introduction

-

The glossaries package is provided to assist generating glossaries. It -has a certain amount of flexibility, allowing the user to customize -the format of the glossary and define multiple glossaries. It also -supports acronyms and glossary styles that include symbols (in -addition to a name and description) for glossary entries. There is -provision for loading a database of glossary terms. Only those terms +

The glossaries package is provided to assist generating glossaries. It has a certain +amount of flexibility, allowing the user to customize the format of the glossary and +define multiple glossaries. It also supports acronyms and glossary styles that +include symbols (in addition to a name and description) for glossary entries. +There is provision for loading a database of glossary terms. Only those terms used11.1 in the document will be added to the glossary. -

This package replaces the glossary

This package replaces the glossary package which is now -obsolete. Please see the document “Upgrading from the glossary package -to the glossaries package” for assistance in upgrading. -

One of the strengths of this package is its flexibility, however the -drawback of this is the necessity of having a large manual that can cover -all the various settings. If you are daunted by the size of the manual, try -starting off with the much shorter guide for beginners. -

The glossaries package comes with a package which is now obsolete. Please +see the document “Upgrading from the glossary package to the glossaries package” for +assistance in upgrading. +

One of the strengths of this package is its flexibility, however the drawback of this +is the necessity of having a large manual that can cover all the various settings. If you +are daunted by the size of the manual, try starting off with the much shorter guide for +beginners. +

The glossaries package comes with a Perl script called makeglossaries. -This provides a convenient interface to the makeglossaries. This +provides a convenient interface to the indexing applications -indexing applications makeindexmakeindex 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 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 +makeglossariesmakeglossaries, you can call makeindex or -makeindex or xindyxindy explicitly. See §1.3 Generating the Associated Glossary Files for -further details.
-

+class="cmsy-10">§1.3 Generating the +Associated Glossary Files for further details.

+

This document uses the glossaries package. For example, when viewing the -PDF version of this document in a hyperlinked-enabled PDF viewer (such -as Adobe Reader or Okular) if you click on the word “glossaries package. For example, when viewing the +PDF version of this document in a hyperlinked-enabled PDF viewer (such as +Adobe Reader or Okular) if you click on the word “xindy” you’ll be -taken to the entry in the glossary where there’s a brief description of what -“xindy” you’ll be taken to +the entry in the glossary where there’s a brief description of what “xindy” is. -

The remainder of this introductory section covers the following: -

+class="cmtt-10">xindy” +is. +

The remainder of this introductory section covers the following:

- - - -

1.1  

Top

1.1 Sample Documents

-

The glossaries package is provided with some sample documents -that illustrate the various functions. These should be located in -the samples subdirectory (folder) of the glossaries documentation -directory. This location varies according to your operating system and -T

The glossaries package is provided with some sample documents that illustrate the +various functions. These should be located in the samples subdirectory (folder) of the +glossaries documentation directory. This location varies according to your +operating system and TEX distribution. You can use texdoc to locate the main glossaries -documentation. For example, in a texdoc to locate the main + + +glossaries documentation. For example, in a terminal or command prompt, type: -
texdoc -l glossaries -

-This should display a list of all the files in the glossaries documentation -directory with their full pathnames. -

If you can’t find the sample files on your computer, -they are also available from your nearest CTAN mirror at -texdoc -l glossaries +

+This should display a list of all the files in the glossaries documentation directory with +their full pathnames. +

If you can’t find the sample files on your computer, they are also available from your nearest +CTAN mirror at http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/. -

The sample documents are as +class="cmtt-10">http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/. +

The sample documents are as follows21.2:

minimalgls.tex
minimalgls.tex
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: -
    -
  1. 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: +
      +
    1. Run minimalgls.tex through LATEX either by typing - -
      latex minimalgls       -

      - in a terminal or by using the relevant button or menu item in - your text editor or front-end. This will create the required - associated files but you will not see the glossary. If you use - PDFLATEX you will also get warnings about non-existent - references that look something like: - - - -

      -
      - pdfTeX warning (dest): name{glo:aca} has been -  
      referenced but does not exist, -  
      replaced by a fixed one
      -

      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. -

      2. -
    2. minimalgls.tex through LATEX either by typing +
      latex minimalgls       +

      + in a terminal or by using the relevant button or menu item in your text + editor or front-end. This will create the required associated files but you + will not see the glossary. If you use PDFLATEX you will also + get warnings about non-existent references that look something + like: + + +

      +
      + pdfTeX warning (dest): name{glo:aca} has been +  
      referenced but does not exist, +  
      replaced by a fixed one +
      +

      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. +

      3. +
    3. Run makeglossariesmakeglossaries on the document (§1.3 Generating the - Associated Glossary Files). This can be done on a terminal - either by typing -
      makeglossaries minimalgls       -

      - or by typing -
      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 §1.3 Generating the Associated + Glossary Files). This can be done on a terminal either by typing + +
      makeglossaries minimalgls       +

      + or by typing +
      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 in a terminal by - typing (all on one line): -
      makeindex -s minimalgls.ist -t minimalgls.glg -o - minimalgls.gls minimalgls.glo       -

      - (See 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 + minimalgls.glo       +

      + (See §1.3.3 Using makeindex explicitly for further details on - using §1.3.3 Using makeindex explicitly for further details on using + makeindexmakeindex explicitly.) -

      Note that if you need to specify the full path and the path - contains spaces, you will need to delimit the file names with the - double-quote character. -

      4. -

    4. Note that if you need to specify the full path and the path contains + spaces, you will need to delimit the file names with the double-quote + character. +

      5. +
    5. Run minimalgls.tex through LATminimalgls.tex through LATEX again (as step 1)
    -

    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. - - - +

    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.

sample4col.tex
sample4col.tex
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: - + id="x1-5016r2"> 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: + +
latex sample4col +class="cmtt-10">latex sample4col
makeglossaries sample4col +class="cmtt-10">makeglossaries sample4col
latex sample4col -

- As before, if you don’t have Perl installed, you will need to use - latex sample4col +

+ As before, if you don’t have Perl installed, you will need to use makeindex directly instead of using 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 using the nogroupskip package - option. +class="cmtt-10">makeglossaries. The vertical gap between entries is + the gap created at the start of each group. This can be suppressed using the + nogroupskip package option.

sampleAcr.tex
sampleAcr.tex
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: - + id="x1-5022r3"> 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:
latex sampleAcr +class="cmtt-10">latex sampleAcr
makeglossaries sampleAcr +class="cmtt-10">makeglossaries sampleAcr
latex sampleAcr +class="cmtt-10">latex sampleAcr
latex sampleAcr -

+class="cmtt-10">latex sampleAcr +

sampleAcrDesc.tex
sampleAcrDesc.tex
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: + id="x1-5023r4"> 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:
latex sampleAcrDesc +class="cmtt-10">latex sampleAcrDesc
makeglossaries sampleAcrDesc +class="cmtt-10">makeglossaries sampleAcrDesc
latex sampleAcrDesc +class="cmtt-10">latex sampleAcrDesc
latex sampleAcrDesc -

- - - +class="cmtt-10">latex sampleAcrDesc +

sampleDesc.tex
sampleDesc.tex
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: - + id="x1-5024r5"> 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:
latex sampleDesc +class="cmtt-10">latex sampleDesc
makeglossaries sampleDesc +class="cmtt-10">makeglossaries sampleDesc
latex sampleDesc +class="cmtt-10">latex sampleDesc
latex sampleDesc -

+class="cmtt-10">latex sampleDesc +

+ +

sampleCustomAcr.tex
sampleCustomAcr.tex
This document has some sample acronyms with a - custom acronym style. It also adds the glossary to the table - of contents, so an extra run through LATEX is required: - + id="x1-5027r6"> This document has some sample acronyms with a custom + acronym style. It also adds the glossary to the table of contents, so an extra run + through LATEX is required:
latex sampleCustomAcr +class="cmtt-10">latex sampleCustomAcr
makeglossaries sampleCustomAcr +class="cmtt-10">makeglossaries sampleCustomAcr
latex sampleCustomAcr +class="cmtt-10">latex sampleCustomAcr
latex sampleCustomAcr -

+class="cmtt-10">latex sampleCustomAcr +

sampleFnAcrDesc.tex
sampleFnAcrDesc.tex
This is similar to sampleAcrDesc.tex, except that - it uses the footnote-sc-desc style. As with the previous example, the - glossary is added to the table of contents, so an extra run through - LATEX is required: +class="cmtt-10">sampleAcrDesc.tex, except that it uses the + footnote-sc-desc style. As with the previous example, the glossary is added to + the table of contents, so an extra run through LATEX is required: +
latex sampleFnAcrDesc +class="cmtt-10">latex sampleFnAcrDesc
makeglossaries sampleFnAcrDesc +class="cmtt-10">makeglossaries sampleFnAcrDesc
latex sampleFnAcrDesc +class="cmtt-10">latex sampleFnAcrDesc
latex sampleFnAcrDesc -

+class="cmtt-10">latex sampleFnAcrDesc +

sample-FnDesc.tex
sample-FnDesc.tex
This example defines a custom display format that - puts the description in a footnote on first use. - - - + id="x1-5030r8"> This example defines a custom display format that puts the + description in a footnote on first use.
latex sample-FnDesc +class="cmtt-10">latex sample-FnDesc
makeglossaries sample-FnDesc +class="cmtt-10">makeglossaries sample-FnDesc
latex sample-FnDesc -

+class="cmtt-10">latex sample-FnDesc +

sample-custom-acronym.tex
sample-custom-acronym.tex
This document illustrates how to define - your own acronym style if the predefined styles don’t suit your - requirements. + id="x1-5031r9"> This document illustrates how to define your own + acronym style if the predefined styles don’t suit your requirements. +
latex sample-custom-acronym +class="cmtt-10">latex sample-custom-acronym
makeglossaries sample-custom-acronym +class="cmtt-10">makeglossaries sample-custom-acronym
latex sample-custom-acronym -

+class="cmtt-10">latex sample-custom-acronym +

+ +

sample-crossref.tex
sample-crossref.tex
This document illustrates how to cross-reference - entries in the glossary. + id="x1-5032r10"> This document illustrates how to cross-reference entries in the + glossary.
latex sample-crossref +class="cmtt-10">latex sample-crossref
makeglossaries sample-crossref +class="cmtt-10">makeglossaries sample-crossref
latex sample-crossref -

+class="cmtt-10">latex sample-crossref +

sampleDB.tex
sampleDB.tex
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 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 all the entries to the glossaries without - referencing each one explicitly. To create the document do: - + id="dx1-5035"> suppressed and uses \glsaddall to add all the + entries to the glossaries without referencing each one explicitly. To create the + document do:
latex sampleDB +class="cmtt-10">latex sampleDB
makeglossaries sampleDB +class="cmtt-10">makeglossaries sampleDB
latex sampleDB -

- The glossary definitions are stored in the accompanying files +class="cmtt-10">latex sampleDB +

+ The glossary definitions are stored in the accompanying files database1.tex and database1.tex and database2.tex. Note that if you don’t have Perl - installed, you will need to use database2.tex. Note that if you don’t have Perl installed, you will need to use + makeindex twice instead of a single call - to makeindex twice instead of a single call to makeglossariesmakeglossaries: - - - -

    -
    1. +
    1. Create the main glossary (all on one line): -
      makeindex -s sampleDB.ist -t sampleDB.glg -o - sampleDB.gls sampleDB.glo       -

      -

      2. -
    2. makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls + sampleDB.glo +

      +

      3. +
    3. Create the secondary glossary (all on one line): -
      makeindex -s sampleDB.ist -t sampleDB.nlg -o - sampleDB.not sampleDB.ntn       -

      -

    +
    makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not + sampleDB.ntn +

    +

sampleEq.tex
sampleEq.tex
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 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 document do: - + id="dx1-5047"> environment. To create the document + do:
latex sampleEq +class="cmtt-10">latex sampleEq
makeglossaries sampleEq +class="cmtt-10">makeglossaries sampleEq + +
latex sampleEq -

+class="cmtt-10">latex sampleEq +

sampleEqPg.tex
sampleEqPg.tex
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: +href="#glo:numberlist">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: +
latex sampleEqPg +class="cmtt-10">latex sampleEqPg
makeglossaries sampleEqPg +class="cmtt-10">makeglossaries sampleEqPg
latex sampleEqPg +class="cmtt-10">latex sampleEqPg
latex sampleEqPg -

+class="cmtt-10">latex sampleEqPg +

sampleSec.tex
sampleSec.tex
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 required: - + id="x1-5051r14"> 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 required:
latex sampleSec +class="cmtt-10">latex sampleSec
makeglossaries sampleSec +class="cmtt-10">makeglossaries sampleSec
latex sampleSec +class="cmtt-10">latex sampleSec
latex sampleSec -

+class="cmtt-10">latex sampleSec +

sampleNtn.tex
sampleNtn.tex
This document illustrates how to create an additional - glossary type. This example adds the glossary to the table of - contents, so an extra LAT 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:
latex sampleNtn +class="cmtt-10">latex sampleNtn
makeglossaries sampleNtn +class="cmtt-10">makeglossaries sampleNtn
latex sampleNtn +class="cmtt-10">latex sampleNtn
latex sampleNtn -

- Note that if you don’t have Perl installed, you will need to use - latex sampleNtn +

+ Note that if you don’t have Perl installed, you will need to use makeindex twice instead of a single call to makeindex twice + instead of a single call to makeglossariesmakeglossaries: -

    -
    1. +
    1. Create the main glossary (all on one line): -
      makeindex -s sampleNtn.ist -t sampleNtn.glg -o - sampleNtn.gls sampleNtn.glo       -

      -

      2. -
    2. makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls + sampleNtn.glo +

      +

      3. +
    3. Create the secondary glossary (all on one line): -
      makeindex -s sampleNtn.ist -t sampleNtn.nlg -o - sampleNtn.not sampleNtn.ntn       -

      -

    +
    makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not + sampleNtn.ntn +

    +

sample.tex
sample.tex
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 and it - also uses \glsrefentry, so an extra LATEX run is required: - - - - + id="x1-5061r16"> 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 and it also uses \glsrefentry, so an extra + LATEX run is required:
latex sample +class="cmtt-10">latex sample
makeglossaries sample +class="cmtt-10">makeglossaries sample
latex sample +class="cmtt-10">latex sample
latex sample -

- You can see the difference between word and letter ordering if you - substitute order=wordlatex 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 order=letter. (Note that this will only have an effect if you use + makeglossariesmakeglossaries. If you use makeindex - explicitly, you will need to use the -l switch to indicate letter - ordering.) +class="cmtt-10">makeindex explicitly, you will need to use the -l + switch to indicate letter ordering.)

sample-inline.tex
sample-inline.tex
This document is like sample.tex, above, but uses - the inline glossary style to put the glossary in a footnote. +class="cmtt-10">sample.tex, above, but uses the inline + glossary style to put the glossary in a footnote.
sampletree.tex
sampletree.tex
This document illustrates a hierarchical glossary - structure where child entries have different names to their - corresponding parent entry. To create the document do: + id="x1-5071r18"> This document illustrates a hierarchical glossary structure where + child entries have different names to their corresponding parent entry. To create + the document do:
latex sampletree +class="cmtt-10">latex sampletree
makeglossaries sampletree +class="cmtt-10">makeglossaries sampletree
latex sampletree -

+class="cmtt-10">latex sampletree +

sample-dual.tex
sample-dual.tex
This document illustrates how to define an entry that - both appears in the list of acronyms and in the main glossary. To - create the document do: + id="x1-5072r19"> This document illustrates how to define an entry that both + appears in the list of acronyms and in the main glossary. To create the document + do: + +
latex sample-dual +class="cmtt-10">latex sample-dual
makeglossaries sample-dual +class="cmtt-10">makeglossaries sample-dual
latex sample-dual -

+class="cmtt-10">latex sample-dual +

sample-langdict.tex
sample-langdict.tex
This document illustrates how to use the glossaries - package to create English to French and French to English - dictionaries. To create the document do: + id="x1-5073r20"> This document illustrates how to use the glossaries package + to create English to French and French to English dictionaries. To create the + document do:
latex sample-langdict - - - +class="cmtt-10">latex sample-langdict
makeglossaries sample-langdict +class="cmtt-10">makeglossaries sample-langdict
latex sample-langdict -

+class="cmtt-10">latex sample-langdict +

samplexdy.tex
samplexdy.tex
This document illustrates how to use the glossaries - package with glossaries package with + xindyxindy instead of makeindex. The document uses UTF8 - encoding (with the inputenc package). The encoding is picked up by - makeindex. The document uses UTF8 encoding (with the + inputenc package). The encoding is picked up by makeglossaries. By default, this document will create a makeglossaries. By default, + this document will create a xindy - style file called samplexdy.xdy, but if you uncomment the - lines - - - +class="cmtt-10">xindy style file called samplexdy.xdy, but if you + uncomment the lines + +
\setStyleFile{samplexdy-mc}  
\noist  
\GlsSetXdyLanguage{}
-

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

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, you don’t need to supply any additional - information. If you don’t use makeglossaries, you don’t need to supply any additional information. If you + don’t use makeglossaries, you will need to - specify the required information. Note that if you set the style file to +class="cmtt-10">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 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. -

To create the document do: +class="cmtt-10">\noist, otherwise the glossaries package will overwrite samplexdy-mc.xdy and + you will lose the “Mc” letter group. +

To create the document do:
latex samplexdy +class="cmtt-10">latex samplexdy
makeglossaries samplexdy +class="cmtt-10">makeglossaries samplexdy
latex samplexdy -

+class="cmtt-10">latex samplexdy +

If you don’t have Perl installed, you will have to call xindy - explicitly instead of using xindy explicitly instead of + using makeglossaries. If you are using the - default style file samplexdy.xdy, then do (no line breaks): - +class="cmtt-10">makeglossaries. If you are using the default style file samplexdy.xdy, + then do (no line breaks):
xindy -L english -C utf8 -I xindy -M samplexdy -t +class="cmtt-10">xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.glg -o samplexdy.gls samplexdy.glo -

+class="cmtt-10">samplexdy.gls samplexdy.glo +

otherwise, if you are using samplexdy-mc.xdy, then do (no line - breaks): +class="cmtt-10">samplexdy-mc.xdy, then do (no line breaks): +
xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o +class="cmtt-10">xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.gls samplexdy.glo -

+class="cmtt-10">samplexdy.glo +

samplexdy2.tex
samplexdy2.tex
This document illustrates how to use the glossaries - package where the location numbers don’t follow a standard format. - This example will only work with glossaries package where + the location numbers don’t follow a standard format. This example will only + work with xindy. To create the document do: - +class="cmtt-10">xindy. To create the document do:
pdflatex samplexdy2 - - - +class="cmtt-10">pdflatex samplexdy2
makeglossaries samplexdy2 +class="cmtt-10">makeglossaries samplexdy2
pdflatex samplexdy2 -

+class="cmtt-10">pdflatex samplexdy2 +

If you can’t use makeglossaries then you need to do (all on one - line): +class="cmtt-10">makeglossaries then you need to do (all on one line): + + +
xindy -L english -C utf8 -I xindy -M samplexdy2 -t +class="cmtt-10">xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg samplexdy2.glg -o samplexdy2.gls samplexdy2.glo -

+class="cmtt-10">-o samplexdy2.gls samplexdy2.glo +

See §11.2 §11.2 Locations and Number lists for further details.

sampleutf8.tex
sampleutf8.tex
This is another example that uses xindy. Unlike - xindy. Unlike makeindexmakeindex, xindy can cope with accented or non-Latin characters. - This document uses UTF8 encoding. To create the document do: - +class="cmtt-10">xindy + can cope with accented or non-Latin characters. This document uses UTF8 + encoding. To create the document do:
latex sampleutf8 +class="cmtt-10">latex sampleutf8
makeglossaries sampleutf8 +class="cmtt-10">makeglossaries sampleutf8
latex sampleutf8 -

+class="cmtt-10">latex sampleutf8 +

If you don’t have Perl installed, you will have to call xindy - explicitly instead of using xindy explicitly instead of + using makeglossaries (no line breaks): - +class="cmtt-10">makeglossaries (no line breaks):
xindy -L english -C utf8 -I xindy -M sampleutf8 -t +class="cmtt-10">xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg sampleutf8.glg -o sampleutf8.gls sampleutf8.glo -

-

If you remove the xindy-o sampleutf8.gls sampleutf8.glo +

+

If you remove the xindy option from sampleutf8.tex and do: - +class="cmtt-10">sampleutf8.tex and do:
latex sampleutf8 +class="cmtt-10">latex sampleutf8
makeglossaries sampleutf8 +class="cmtt-10">makeglossaries sampleutf8
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 - 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 makeglossariesmakeglossaries, the call to makeindex is as follows (no line breaks): - +class="cmtt-10">makeindex is as + follows (no line breaks):
makeindex -s sampleutf8.ist -t sampleutf8.glg -o +class="cmtt-10">makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.gls sampleutf8.glo - - - -

+class="cmtt-10">sampleutf8.glo +

sample-index.tex
sample-index.tex
This document uses the glossaries package to create - both a glossary and an index. This requires two glossaries package to create both a + glossary and an index. This requires two makeglossaries - calls to ensure the document is up to date: +class="cmtt-10">makeglossaries calls to ensure the + document is up to date:
latex sample-index +class="cmtt-10">latex sample-index
makeglossaries sample-index +class="cmtt-10">makeglossaries sample-index
latex sample-index +class="cmtt-10">latex sample-index
makeglossaries sample-index +class="cmtt-10">makeglossaries sample-index + +
latex sample-index -

+class="cmtt-10">latex sample-index +

sample-newkeys.tex
sample-newkeys.tex
This document illustrates how add custom - keys. + id="x1-5117r25"> This document illustrates how add custom keys.
sample-numberlist.tex
sample-numberlist.tex
This document illustrates how to reference the - This document illustrates how to reference the number list in the document text. This requires an additional - LATEX run: +href="#glo:numberlist">number + list in the document text. This requires an additional LATEX run: +
latex sample-numberlist +class="cmtt-10">latex sample-numberlist
makeglossaries sample-numberlist +class="cmtt-10">makeglossaries sample-numberlist
latex sample-numberlist +class="cmtt-10">latex sample-numberlist
latex sample-numberlist -

+class="cmtt-10">latex sample-numberlist +

samplePeople.tex
samplePeople.tex
This document illustrates how you can hook into the standard sort mechanism to adjust the way the sort key is set. This - requires an additional run to ensure the table of contents is - up-to-date: + requires an additional run to ensure the table of contents is up-to-date: +
latex samplePeople +class="cmtt-10">latex samplePeople
makeglossaries samplePeople +class="cmtt-10">makeglossaries samplePeople
latex samplePeople +class="cmtt-10">latex samplePeople
latex samplePeople -

- - - +class="cmtt-10">latex samplePeople +

sampleSort.tex
sampleSort.tex
This is another document that illustrates how to hook - into the standard sort mechanism. An additional run is required to - ensure the table of contents is up-to-date: + id="x1-5122r28"> This is another document that illustrates how to hook into the + standard sort mechanism. An additional run is required to ensure the table of + contents is up-to-date:
latex sampleSort +class="cmtt-10">latex sampleSort
makeglossaries sampleSort +class="cmtt-10">makeglossaries sampleSort
latex sampleSort +class="cmtt-10">latex sampleSort
latex sampleSort -

+class="cmtt-10">latex sampleSort +

sample-nomathhyper.tex
sample-nomathhyper.tex
This document illustrates how to selective - enable and disable entry hyperlinks in \glsentryfmt This document illustrates how to selective enable and + disable entry hyperlinks in \glsentryfmt. + +
sample-entryfmt.tex
sample-entryfmt.tex
This document illustrates how to change the way - an entry is displayed in the text. + id="x1-5125r30"> This document illustrates how to change the way an entry is + displayed in the text.
sample-prefix.tex
sample-prefix.tex
This document illustrates the use of the glossaries-prefix - package. An additional run is required to ensure the table of contents - is up-to-date: +class="cmss-10">glossaries-prefix package. + An additional run is required to ensure the table of contents is up-to-date: +
latex sample-prefix +class="cmtt-10">latex sample-prefix
makeglossaries sample-prefix +class="cmtt-10">makeglossaries sample-prefix
latex sample-prefix +class="cmtt-10">latex sample-prefix
latex sample-prefix -

+class="cmtt-10">latex sample-prefix +

sampleaccsupp.tex
sampleaccsupp.tex
This document uses the experimental glossaries-accsupp - package. The symbol is set to the replacement text. Note that some - PDF viewers don’t use the accessibility support. Information about - the glossaries-accsupp package can be found in glossaries-accsupp package. + The symbol is set to the replacement text. Note that some PDF viewers don’t + use the accessibility support. Information about the glossaries-accsupp package + can be found in §19 Accessibility - Support. +class="cmsy-10">§18 Accessibility Support.
- - - -

+

-

Top

1.2  

Top

1.2 Multi-Lingual Support

-

As from version 1.17, the glossaries package can now be used with

As from version 1.17, the glossaries package can now be used with xindy -as well as 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 makeindex. If you are writing in a language that uses accented characters or +non-Latin characters it is recommended that you use xindyxindy 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 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 xindyxindy, remember to use the xindyxindy package option. For example: - - - + +

-
+
\documentclass[frenchb]{article}  
\usepackage[utf8]{inputenc}  
\usepackage[T1]{fontenc}  
\usepackage{babel}  
\usepackage[xindy]{glossaries}
-

-

Note that although an accented character, such as é, looks like a plain -character in your tex file, it’s actually a macro and can therefore cause -expansion problems. You may need to switch off the field expansions with -\glsnoexpandfields. -

If you use an accented (or other expandable) character at the start of an -entry name, you must place it in a group, or it will cause a problem for -commands that convert the first letter to upper case (e.g. \Gls) due to -expansion issues. For example: - - - +

+

Note that although an accented character, such as é, looks like a plain character +in your tex file, it’s actually a macro and can therefore cause expansion problems. You +may need to switch off the field expansions with \glsnoexpandfields. +

If you use an accented (or other expandable) character at the start of an entry +name, you must place it in a group, or it will cause a problem for commands that +convert the first letter to upper case (e.g. \Gls) due to expansion issues. For +example: + +

-
+
\newglossaryentry{elite}{name={{é}lite},  
description={select group or class}}
-

-

-

If you use the inputenc

+

+

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

+class="cmtt-10">xindy manual for further +details. +

-

Top

1.2.1  

Top

1.2.1 Changing the Fixed Names

-

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

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 or polyglossiapolyglossia 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, unless you use the -translate=falsebefore 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, unless you use +the translate=false or translate=babel package options. 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: - - - +class="cmss-10">translate=babel package options. 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: + +

-
+
\usepackage[spanish]{babel}  
\usepackage[spanish]{translator}  
\usepackage{glossaries}
-

Alternatively, specify the language as a class option rather than a package -option. For example: - - - +

Alternatively, specify the language as a class option rather than a package option. For +example: + +

-
+
\documentclass[spanish]{report}  
\usepackage{babel}  
\usepackage{glossaries}
-

-

If you want to use ngerman

+

If you want to use ngerman or germangerman instead of babel, you will need -to include the translator package to provide the translations. For -example: - - - +class="cmss-10">babel, you will need to include the +translator package to provide the translations. For example: + +

-
+
\documentclass[ngerman]{article}  
\usepackage{ngerman}  
\usepackage{translator}  
\usepackage{glossaries}
-

-

The languages are currently supported by the glossaries package are -listed in table 1.1. Please note that (apart from spelling mistakes) I don’t -intend to change the default translations as it will cause compatibility -problems. - - - -

+

The languages are currently supported by the glossaries package are listed in +table 1.1. Please note that (apart from spelling mistakes) I don’t intend to change the +default translations as it will cause compatibility problems. +

+
+ + +

- - - -
Table 1.1: Supported Languages
+ + +
Table 1.1: Supported Languages
-

+

+class="cmbx-10">As from version
Language Language As from version
Brazilian Portuguese French 1.08
German German 1.08
2.06
Spanish 1.08
- - - -
-

The language dependent commands and translator keys used by the -glossaries package are listed in 1.08 +

+ + +
+
+

The language dependent commands and translator keys used by the glossaries +package are listed in table 1.2. - - - -

+

+ + +

- - - -
Table 1.2: Customised Text
- - - + + +
Table 1.2: Customised Text
+ +
+class="cmbx-10">Word

+ glossary.

+class="cmss-10">acronym).

+ headers).

+ headers).

+ option.

+ option.

+ option.

-
Command Name

Translator +class="cmbx-10">Command Name

Translator Key +class="cmbx-10">Key Word

Purpose

Purpose

\glossaryname\glossaryname

Glossary

Title +class="td11">

Glossary

Title of the main - glossary.

\acronymname\acronymname

Acronyms

Title +class="td11">

Acronyms

Title of the list @@ -2193,18 +2128,18 @@ class="td10">

Title package option acronym).

\entryname\entryname

Notation +class="td11">

Notation (glossaries)

Header +class="cmtt-10">(glossaries)

Header for first column @@ -2220,17 +2155,17 @@ class="td10">

Header glossaries that support - headers).

\descriptionname\descriptionname

Description +class="td11">

Description (glossaries)

Header +class="cmtt-10">(glossaries)

Header for second column @@ -2246,17 +2181,17 @@ class="td10">

Header glossaries that support - headers).

\symbolname\symbolname

Symbol +class="td11">

Symbol (glossaries)

Header +class="cmtt-10">(glossaries)

Header for symbol column @@ -2269,19 +2204,19 @@ class="td10">

Header that support this - option.

\pagelistname\pagelistname

Page +class="td11">

Page List +class="cmtt-10">List (glossaries)

Header +class="cmtt-10">(glossaries)

Header for page list @@ -2294,17 +2229,17 @@ class="td10">

Header that support this - option.

\glssymbolsgroupname\glssymbolsgroupname

Symbols +class="td11">

Symbols (glossaries)

Header +class="cmtt-10">(glossaries)

Header for symbols section @@ -2317,17 +2252,17 @@ class="td10">

Header that support this - option.

\glsnumbersgroupname\glsnumbersgroupname

Numbers +class="td11">

Numbers (glossaries)

Header +class="cmtt-10">(glossaries)

Header for numbers section @@ -2340,93 +2275,86 @@ class="td10">

Header that support this - option.

- - + option.

+ +
- - - -
-

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 -the glossaries package option translate=babel, you need to be familiar with -the advice given in changing the words babel uses. If you are using the -translator package, then you can provide your own dictionary with the -necessary modifications (using \deftranslation) and load it using -\usedictionary. -

Note that the dictionaries are loaded at the beginning of the document, -so it won’t have any effect if you put \deftranslation in the preamble. It -should be put in your personal dictionary instead (as in the example -below). See the translator documentation for further details. (Now with -beamer documentation.)
-

-

Your custom dictionary doesn’t have to be just a translation from -English to another language. You may prefer to have a dictionary for a -particular type of document. For example, suppose your institution’s -in-house reports have to have the glossary labelled as “Nomenclature” and -the page list should be labelled “Location”, then you can create a file -called, say, - - - -

-
+ + +
+
+

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 the glossaries package +option translate=babel, you need to be familiar with the advice given in changing the +words babel uses. If you are using the translator package, then you can provide your +own dictionary with the necessary modifications (using \deftranslation) and load it +using \usedictionary. +

Note that the dictionaries are loaded at the beginning of the document, so it +won’t have any effect if you put \deftranslation in the preamble. It should be +put in your personal dictionary instead (as in the example below). See the +translator documentation for further details. (Now with beamer documentation.) +
+

+

Your custom dictionary doesn’t have to be just a translation from English to +another language. You may prefer to have a dictionary for a particular type of +document. For example, suppose your institution’s in-house reports have to have the +glossary labelled as “Nomenclature” and the page list should be labelled “Location”, +then you can create a file called, say, + + +

+
myinstitute-glossaries-dictionary-English.dict
-

that contains the following: - - - +

that contains the following: + +

-
+
\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}  
\deftranslation{Glossary}{Nomenclature}  
\deftranslation{Page List (glossaries)}{Location}
-

You can now load it using: - - - +

You can now load it using: + +

-
+
\usedictionary{myinstitute-glossaries-dictionary}
-

(Make sure that myinstitute-glossaries-dictionary-English.dict -can be found by TEX.) If you want to share your custom dictionary, you -can upload it to

(Make sure that myinstitute-glossaries-dictionary-English.dict can be found +by TEX.) If you want to share your custom dictionary, you can upload it to +CTAN. -

If you are using babel

If you are using babel and don’t want to use the translator interface, you -can use the package option translate=babeltranslator interface, you can use +the package option translate=babel. For example: - - - + +

-
+
\documentclass[british]{article}  
\usepackage{babel}  
\usepackage[translate=babel]{glossaries} @@ -2435,363 +2363,350 @@ class="cmss-10x-x-109">translate=babel    \renewcommand*{\acronymname}{List of Acronyms}%  
}
-

-

If you are using polyglossia

+

If you are using polyglossia instead of babelbabel, glossaries-polyglossia -will automatically be loaded unless you specify the package option -translate=falseglossaries-polyglossia will automatically +be loaded unless you specify the package option translate=false. -

Note that

Note that xindy provides much better multi-lingual support than -xindy provides much better multi-lingual support than makeindex, so it’s recommended that you use makeindex, so +it’s recommended that you use xindy if you have glossary -entries that contain diacritics or non-Roman letters. See xindy if you have glossary entries that contain +diacritics or non-Roman letters. See §11 Xindy for -further details. +class="cmsy-10">§11 Xindy for further details.

-

Top

1.3  

Top

1.3 Generating the Associated Glossary Files

-

In order to generate a sorted glossary with compact

In order to generate a sorted glossary with compact number lists, it is -necessary to use an external s, it is necessary to use +an external indexing application as an intermediate step. -It is this application that creates the file containing the code that typesets -the glossary. If this step is omitted, the glossaries will not appear in your -document. The two indexing applications that are most commonly used -with LATindexing application as an intermediate step. It is this application +that creates the file containing the code that typesets the glossary. If this +step is omitted, the glossaries will not appear in your document. The two +indexing applications that are most commonly used with LATEX are makeindex and 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 +class="cmtt-10">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 xindy has much better multi-lingual support +than makeindex, so -makeindex, so xindy is recommended if you’re not writing in English. Commands -that only have an effect when xindy is recommended if you’re not writing in English. +Commands that only have an effect when xindyxindy is used are described in §11 +class="cmsy-10">§11 Xindy. -

This is a multi-stage process, but there are methods of automating +

This is a multi-stage process, but there are methods of automating document compilation using applications such as latexmklatexmk and araraarara. See http://www.dickimaw-books.com/latex/thesis/html/build.html for -more information.
-

- - - -

The glossaries package comes with the Perl script http://www.dickimaw-_books.com/latex/thesis/html/build.html for more +information.

+

+

The glossaries package comes with the Perl script makeglossaries -which will run makeglossaries which will run +makeindexmakeindex or xindy on all the glossary files using a -customized style file (which is created by \makeglossaries). See -xindy on all the glossary files using a customized style file (which is +created by \makeglossaries). See §1.3.1 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. The advantages of using +class="cmsy-10">§1.3.1 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. The advantages of using makeglossaries:

+class="cmtt-10">makeglossaries: +

  • It automatically detects whether to use makeindexmakeindex or xindy and - sets the relevant application switches. +class="cmtt-10">xindy and sets the + relevant application switches.
  • One call of makeglossariesmakeglossaries will run makeindexmakeindex/xindy for each - glossary type. +class="cmtt-10">xindy for each glossary + type.
  • If things go wrong, makeglossaries will scan the messages from - makeglossaries will scan the messages from makeindex or makeindex + or xindy and attempt to diagnose the problem in - relation to the glossaries package. This will hopefully provide - more helpful messages in some cases. If it can’t diagnose the - problem, you will have to read the relevant transcript file and see - if you can work it out from the xindy and attempt to diagnose the problem in relation to the glossaries + package. This will hopefully provide more helpful messages in some cases. If + it can’t diagnose the problem, you will have to read the relevant transcript + file and see if you can work it out from the makeindexmakeindex or xindyxindy messages.
-

There is also a Java GUI alternative called

There is also a Java GUI alternative called makeglossariesgui, -distributed separately, that has diagnostic tools. -

Whilst it is strongly recommended that you use the makeglossariesgui, distributed +separately, that has diagnostic tools. +

Whilst it is strongly recommended that you use the makeglossaries -script or makeglossaries script or +makeglossariesguimakeglossariesgui, it is possible to use the glossaries package -without using either application. However, note that some commands and -package options have no effect if you don’t use glossaries package without using either +application. However, note that some commands and package options have no effect if +you don’t use makeglossaries or -makeglossaries or makeglossariesgui. These are listed in makeglossariesgui. These are listed in +table 1.3. -

If you are choosing not to use

If you are choosing not to use makeglossaries because you don’t want -to install Perl, you will only be able to use makeglossaries because you don’t want to install +Perl, you will only be able to use makeindexmakeindex as xindy also -requires Perl.
-

-

Note that if any of your entries use an entry that is not referenced outside -the glossary, you will need to do an additional xindy also requires Perl. +

+

+

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

-
+
\newglossaryentry{citrusfruit}{name={citrus fruit},  
description={fruit of any citrus tree. (See also  
\gls{orange})}}  
\newglossaryentry{orange}{name={orange},  
description={an orange coloured fruit.}}
-

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 -

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 makeglossariesmakeglossaries, makeindex or makeindex or +xindy. For example, if the document is -called myDoc.tex, then you must do: -
latex myDoc -
makeglossaries myDoc -
latex myDoc -
makeglossaries myDoc -
latex myDoc -

-

Likewise, an additional xindy. For example, if the document is called myDoc.tex, then you must do: + +
latex myDoc +
makeglossaries myDoc +
latex myDoc +
makeglossaries myDoc +
latex myDoc +

+

Likewise, an additional makeglossariesmakeglossaries 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 EX 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 -need updating. -

The examples in this document assume that you are accessing -s in the glossary may need updating. +

The examples in this document assume that you are accessing makeglossaries, makeglossaries, +xindyxindy or makeindex via a terminal. Windows -users can use the MSDOS Prompt which is usually accessed via -the Start->All Programs menu or Start->All Programs->Accessories -menu. -

Alternatively, your text editor may have the facility to create -a function that will call the required application. The article -“Glossaries, Nomenclature, List of Symbols and Acronyms” in the -makeindex via a terminal. Windows users can use the MSDOS Prompt +which is usually accessed via the Start->All Programs menu or Start->All +Programs->Accessories menu. +

Alternatively, your text editor may have the facility to create a function that will +call the required application. The article “Glossaries, Nomenclature, List of Symbols +and Acronyms” in the LATEX Community’s Know How section describes how to do this for -TeXnicCenter, and the thread “Executing Glossaries’ makeindex -from a WinEdt macro” on the comp.text.tex newsgroup describes -how to do it for WinEdt. Section 1.1 (Building Your Document) of +class="E">EX Community’s Know How section describes how to do +this for TeXnicCenter, and the thread “Executing Glossaries’ makeindex from a +WinEdt macro” on the comp.text.tex newsgroup describes how to do it for WinEdt. Section 1.1 (Building Your Document) of “Using LATEX to Write a PhD Thesis” describes how to do it for -TeXWorks. For other editors see the editor’s user manual for further -details. - - - -

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

EX to Write a PhD Thesis” +describes how to do it for TeXWorks. For other editors see the editor’s user manual for +further details. +

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

+
+ + +

- - - -
Table 1.3: Commands and package options that have no effect when -using xindy or makeindex explicitly
+ + +
Table 1.3: Commands and package options that have no effect when using xindy +or makeindex explicitly
+class="cmtt-10">-M ord/letorder +class="cmtt-10">-L <lang> -C <code> +class="cmtt-10">-L <lang>
Command or Package Option Command or Package Option makeindexmakeindex xindyxindy
order=letterorder=letter use -l -l use -M ord/letorder
order=wordorder=word default default
xindyxindy={language=<lang>,codename=<code>} {language=<lang>,codename=<code>} N/A use -L <lang> -C <code>
\GlsSetXdyLanguage\GlsSetXdyLanguage{<lang>} {<lang>} N/A use -L <lang>
\GlsSetXdyCodePage\GlsSetXdyCodePage{<code>} {<code>} N/A use -C <code>
+class="cmtt-10">-C <code>
- - - -
-

Top

1.3.1  
+

+

Top

1.3.1 Using the makeglossaries Perl Script

-

The

The makeglossaries script picks up the relevant information from the -auxiliary (.auxmakeglossaries script picks up the relevant information from the auxiliary +(.aux) file and will either call xindyxindy or makeindex, depending on -the supplied information. Therefore, you only need to pass the document’s -name without the extension to makeindex, depending on the supplied +information. Therefore, you only need to pass the document’s name without the +extension to makeglossaries. For example, if your -document is called myDoc.tex, type the following in your terminal: - -
latex myDoc -
makeglossaries myDoc -
latex myDoc -

+class="cmtt-10">makeglossaries. For example, if your document is called myDoc.tex, +type the following in your terminal: +
latex myDoc +
makeglossaries myDoc +
latex myDoc +

You may need to explicitly load makeglossariesmakeglossaries into Perl: -
perl makeglossaries myDoc -

+
perl makeglossaries myDoc +

There is a batch file called makeglossaries.bat which does this for +class="cmtt-10">makeglossaries.bat which does this for Windows users, but you must have Perl installed to be able to use it.41.4 You can specify in which directory the .aux.aux, .glo etc files are located -using the -d switch. For example: -
pdflatex -output-directory myTmpDir myDoc -
makeglossaries -d myTmpDir myDoc -

+class="cmtt-10">.glo etc files are located using the -d +switch. For example: +
pdflatex -output-directory myTmpDir myDoc +
makeglossaries -d myTmpDir myDoc +

Note that makeglossariesmakeglossaries assumes by default that makeindexmakeindex/xindy is -on your operating system’s path. If this isn’t the case, you can specify the -full pathname using -m <path/to/makeindex> for xindy is on your +operating system’s path. If this isn’t the case, you can specify the full pathname +using -m <path/to/makeindex> for makeindexmakeindex or -x -<path/to/xindy> for -x <path/to/xindy> for +xindyxindy. -

The

The makeglossaries script contains POD (Plain Old Documentation). -If you want, you can create a man page for makeglossaries script contains POD (Plain Old Documentation). If you +want, you can create a man page for makeglossariesmakeglossaries using pod2man -and move the resulting file onto the man path. Alternatively do -makeglossaries --help for a list of all options or makeglossaries ---version for the version number. -

When upgrading the glossaries package, make sure you also upgrade -your version of pod2man and +move the resulting file onto the man path. Alternatively do makeglossaries +--help for a list of all options or makeglossaries --version for the version +number. +

When upgrading the glossaries package, make sure you also upgrade your version +of makeglossaries. The current version is 2.10.
-

-

+class="cmtt-10">makeglossaries. The current version is 2.12.

+

+

- - - -

Top

1.3.2  

Top

1.3.2 Using xindy explicitly

-

Xindy comes with TeXLive, but not with MiKTeX. However MikTeX -users can install it. See Xindy comes with TeXLive, but not with MiKTeX. However MikTeX users can install +it. See How to use Xindy with MikTeX on TEX on -StackExchange. -

If you want to use EX on StackExchange. + + +

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

-
+
\usepackage[xindy]{glossaries}
-

This is required regardless of whether you use

This is required regardless of whether you use xindy explicitly or whether -it’s called implicitly via applications such as xindy explicitly or whether it’s called +implicitly via applications such as makeglossaries or -makeglossaries or makeglossariesgui. This causes the glossary entries to be written in raw -makeglossariesgui. This +causes the glossary entries to be written in raw xindyxindy format, so you need to use -I xindy not -I tex. -

To run -I +xindy not -I tex. +

To run xindy type the following in your terminal (all on one line): - -
xindy -L <language> -C <encoding> -I xindy -M <style> -t -<base>.glg -o <base>.gls <base>.glo -

+class="cmtt-10">xindy type the following in your terminal (all on one line): +
xindy -L <language> -C <encoding> -I xindy -M <style> -t +<base>.glg -o <base>.gls <base>.glo +

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 <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 xindyxindy style file without the .xdy -extension. The default name for this style file is <base>.xdy but can be -changed via \setStyleFile.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 +class="cmtt-10">{<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 you are using -UTF8 encoding in English, then type the following in your terminal: - -
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

For example, if your document is called myDoc.tex and you are using UTF8 +encoding in English, then type the following in your terminal: +
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.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 \newglossaryxindy -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. -

Note that if you use

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

+
makeglossaries myDoc +

Note also that some commands and package options have no effect if you use xindyxindy explicitly instead of using makeglossariesmakeglossaries. These are listed in table 1.3. -

+ + +

-

Top

1.3.3  

Top

1.3.3 Using makeindex explicitly

-

If you want to use

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 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 your -terminal: -
makeindex -s <style>.ist -t <base>.glg -o <base>.gls -<base>.glo -

+class="cmtt-10">makeindex, type the following in your terminal: +
makeindex -s <style>.ist -t <base>.glg -o <base>.gls <base>.glo +

where <base> is the name of your document without the .tex extension -and <style>.ist<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 \setStyleFilemakeindex 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 {<style>}. Note that there are other +options, such as -l (letter ordering). See the makeindex -manual for further details. -

For example, if your document is called myDoc.tex, then type the -following at the terminal: -
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 manual for further +details. +

For example, if your document is called myDoc.tex, then type the following at the +terminal: +
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 .glgmakeindex +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 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.gls and .glo with the relevant extensions. For +example, if you have used 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. -

Note that if you use

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

-Note also that some commands and package options have no effect if you - - - -use makeglossaries: +
makeglossaries myDoc +

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

+

-

Top

1.3.4  

Top

1.3.4 Note to Front-End and Script Developers

-

The information needed to determine whether to use

The information needed to determine whether to use xindyxindy or makeindex -and the information needed to call those applications is stored in the -auxiliary file. This information can be gathered by a front-end, editor or -script to make the glossaries where appropriate. This section describes how -the information is stored in the auxiliary file. -

The file extensions used by each defined glossary are given by -

\@newglossary makeindex and the +information needed to call those applications is stored in the auxiliary file. This +information can be gathered by a front-end, editor or script to make the glossaries +where appropriate. This section describes how the information is stored in the +auxiliary file. +

The file extensions used by each defined glossary are given by +

\@newglossary  \@newglossary{<label>}{<log>}{<out-ext>}{<in-ext>} +class="cmtt-10">\@newglossary{<label>}{<log>}{<out-ext>}{<in-ext>}
-

+ + +

where <in-ext> is the extension of the <in-ext> is the extension of the indexing application’s input file (the -output file from the glossaries package’s point of view), <out-ext> is the -extension of the indexing application’s input file (the output file +from the glossaries package’s point of view), <out-ext> is the extension of the indexing application’s output file (the input file from the +class="cmti-10">indexing glossaries package’s point of view) and <log> is the extension of the +class="cmti-10">application’s output file (the input file from the glossaries package’s point of view) and +<log> is the extension of the indexing application’s transcript file. The label for the +glossary is also given for information purposes only, but is not required by the indexing application’s transcript file. The label for the glossary is also given -for information purposes only, but is not required by the indexing -applications. For example, the information for the default main glossary is + id="dx1-12009">indexing applications. For example, the information for the default main glossary is written as: - - - + +

-
+
\@newglossary{main}{glg}{gls}{glo}
-

-

The

+

The indexing application’s style file is specified by -

\@istfilename 

\@istfilename  \@istfilename{<filename>}
-

+class="cmtt-10">\@istfilename{<filename>}

+

The file extension indicates whether to use makeindexmakeindex (.ist.ist) or xindy -(.xdy). Note that the glossary information is formatted differently -depending on which indexing application is supposed to be used, so it’s -important to call the correct one. -

Word or letter ordering is specified by: -

\@glsorder xindy (.xdy). Note +that the glossary information is formatted differently depending on which +indexing application is supposed to be used, so it’s important to call the correct +one. +

Word or letter ordering is specified by: +

\@glsorder  \@glsorder{<order>}
-

+class="cmtt-10">\@glsorder{<order>}

+

where <order> can be either word or letter. -

If <order> can be either word or letter. +

If xindy should be used, the language and code page for each glossary is -specified by -

\@xdylanguage xindy should be used, the language and code page for each glossary is specified +by +

\@xdylanguage \@gls@codepage \@gls@codepage  \@xdylanguage{<label>}{<language>}
\@xdylanguage{<label>}{<language>}
\@gls@codepage{<label>}{<code>}
-

+class="cmtt-10">\@gls@codepage{<label>}{<code>}

+

where <label> identifies the glossary, <language> is the root language -(e.g. english) and <code> is the encoding (e.g. utf8). These commands -are omitted if <label> identifies the glossary, <language> is the root language (e.g. english) +and <code> is the encoding (e.g. utf8). These commands are omitted if makeindex should be used. - - - -

-

Top

2  makeindex +should be used. + + +

+

+

Top

2. Package Options

- This section describes the available glossaries package options. You may +

This section describes the available glossaries package options. You may omit the =true for boolean options. (For example, acronym=true for boolean options. (For example, acronym is equivalent to acronym=trueacronym=true). -

Note that <key>=<value> package options can’t be passed via the -document class options. (This includes options where the <value> part -may be omitted, such as acronym.) This is a general limitation not -restricted to the glossaries package. Options that aren’t <key>=<value> -(such as makeindex) may be passed via the document class options. -
-

-

-

2.1  

Note that <key>=<value> package options can’t be passed via the document +class options. (This includes options where the <value> part may be omitted, such as +acronym.) This is a general limitation not restricted to the glossaries package. Options +that aren’t <key>=<value> (such as makeindex) may be passed via the document +class options.
+

+

+

Top

2.1 General Options

nowarnnowarn
This suppresses all warnings generated by the glossaries - package. +class="description">This suppresses all warnings generated by the glossaries package. Don’t + use this option if you’re new to using glossaries as the warnings are + designed to help detect common mistakes (such as forgetting to use + \makeglossaries).
nomain
This suppresses the creation of the main glossary and - associated .glo file, if unrequired. Note that if you use this - option, you must create another glossary in which to put all - your entries (either via the acronym (or acronyms) package - option described in nomain
This suppresses the creation of the main glossary and associated .glo + file, if unrequired. Note that if you use this option, you must create + another glossary in which to put all your entries (either via the acronym + (or acronyms) package option described in §2.5 Acronym Options or via the symbols, +class="cmsy-10">§2.5 Acronym Options or via the numbers or index options described in symbols, numbers or index options described in §2.6 §2.6 Other Options or via \newglossary described in \newglossary described in §12 §12 Defining New Glossaries). -

If you don’t use the main glossary and you don’t use this - option,

If you don’t use the main glossary and you don’t use this option, makeglossaries will produce the following warning: -

+class="cmtt-10">makeglossaries + will produce the following warning:

Warning: File ’filename.glo’ is empty. +class="cmtt-10">Warning: File ’filename.glo’ is empty.
Have you used any entries defined in glossary +class="cmtt-10">Have you used any entries defined in glossary
’main’? +class="cmtt-10">’main’?
Remember to use package option ’nomain’ if +class="cmtt-10">Remember to use package option ’nomain’ if
you don’t want to use the main glossary. - - - -
-
If you did actually want to use the main glossary and you see this - warning, check that you have referenced the entries in that glossary - via commands such as \gls.
-

+class="cmtt-10">you don’t want to use the main glossary. +

+
If you did actually want to use the main glossary and you see this warning, + check that you have referenced the entries in that glossary via commands such as + \gls.
+ + +

sanitizesort
This is a boolean option that determines whether or - not to sanitizesort
This is a boolean option that determines whether or not to sanitize the sort value when writing to the external - glossary file. For example, suppose you define an entry as - follows: - - - + id="dx1-14015"> the + sort value when writing to the external glossary file. For example, suppose you + define an entry as follows: + +
\newglossaryentry{hash}{name={\#},sort={#},  
 description={hash symbol}}
-

The sort value (#) must be sanitized before writing it to the glossary - file, otherwise LATEX will try to interpret it as a parameter - reference. If, on the other hand, you want the sort value expanded, - you need to switch off the sanitization. For example, suppose you - do: - - - +

The sort value (#) must be sanitized before writing it to the glossary file, + otherwise LATEX will try to interpret it as a parameter reference. If, on the + other hand, you want the sort value expanded, you need to switch off the + sanitization. For example, suppose you do: + +

\newcommand{\mysortvalue}{AAA} @@ -3681,73 +3580,70 @@ class="E">EX will try to interpret it as a parameter  
  sort={\mysortvalue},  
  description={an example}}
-

and you actually want \mysortvalue expanded, so that the - entry is sorted according to AAA, then use the package option +

and you actually want \mysortvalue expanded, so that the entry is sorted + according to AAA, then use the package option sanitizesort=false. (The default is sanitizesort=false. (The default is sanitizesort=true.) +class="cmss-10">sanitizesort=true.)

savewrites
This is a boolean option to minimise the number of write - registers used by the glossaries package. (Default is savewrites=false.) - There are only a limited number of write registers, and if you have a - large number of glossaries or if you are using a class or other - packages that create a lot of external files, you may exceed the - maximum number of available registers. If savewrites is set, the - glossary information will be stored in token registers until - the end of the document when they will be written to the - external files. If you run out of token registers, you can use +class="cmssbx-10">savewrites
This is a boolean option to minimise the number of write registers used by + the glossaries package. (Default is savewrites=false.) There are only a + limited number of write registers, and if you have a large number of + glossaries or if you are using a class or other packages that create a lot + of external files, you may exceed the maximum number of available + registers. If savewrites is set, the glossary information will be stored + in token registers until the end of the document when they will be + written to the external files. If you run out of token registers, you can use etex. -

This option can significantly slow document compilation. As - an alternative, you can use the scrwfile package (part of the - KOMA-Script bundle) and not use this option.
-

-

If you want to use Tetex. +

This option can significantly slow document compilation. As an alternative, you + can use the scrwfile package (part of the KOMA-Script bundle) and not use this + option.
+

+

If you want to use TEX’s \write18 mechanism to call \write18 mechanism to call makeindex - or makeindex or xindy from your document and use savewrites, you must - create the external files with \glswritefiles before you call - makeindex/xindy. Also set \glswritefiles to nothing or \relax - before the end of the document to avoid rewriting the files. For - example: - - - +class="cmtt-10">xindy + from your document and use savewrites, you must create the external files with + \glswritefiles before you call makeindex/xindy. Also set \glswritefiles to + nothing or \relax before the end of the document to avoid rewriting the files. + For example: + +

\glswritefiles @@ -3755,422 +3651,402 @@ class="cmtt-10x-x-109">\relax  
-t \jobname.glg -o \jobname.gls \jobname}  
\let\glswritefiles\relax
-

-

+

+

translate
translate
This can take the following values: -
+
translate=true
translate=true
If babel has been loaded and the translator - package is installed, translator will be loaded and the - translations will be provided by the translator package - interface. You can modify the translations by providing - your own dictionary. If the translator package isn’t installed - and babel is loaded, the glossaries-babel package will be - loaded and the translations will be provided using babel’s - \addto\caption<language> mechanism. If polyglossia has - been loaded, glossaries-polyglossia will be loaded. -
- translate=false
Don’t provide translations, even if babel or - polyglossia has been loaded. (Note that babel provides the - command \glossaryname so that will still be translated if - you have loaded babel.) -
+class="cmss-10">babel has been loaded and the translator package is + installed, translator will be loaded and the translations will be + provided by the translator package interface. You can modify the + translations by providing your own dictionary. If the translator + package isn’t installed and babel is loaded, the glossaries-babel + package will be loaded and the translations will be provided using + babel’s \addto\caption<language> mechanism. If polyglossia has + been loaded, glossaries-polyglossia will be loaded. +
translate=babel
Don’t load the translator package. Instead load - glossaries-babel. -

I recommend you use translate=babel if you have any problems - with the translations or with PDF bookmarks, but to maintain - backward compatibility, if babel has been loaded the default is - translate=true.
-

- - - -

-
-

If translate is specified without a value, translate=true is assumed. If +class="cmssbx-10">translate=false

Don’t provide translations, even if babel or polyglossia has + been loaded. (Note that babel provides the command \glossaryname + so that will still be translated if you have loaded babel.) +
translate isn’t specified, translate=true is assumed if babel, polyglossia - or translator have been loaded. Otherwise translate=false is - assumed. -

See translate=babel

Don’t load the translator package. Instead load + glossaries-babel. +

I recommend you use translate=babel if you have any problems with the + translations or with PDF bookmarks, but to maintain backward + compatibility, if babel has been loaded the default is translate=true. +
+

+

+
+

If translate is specified without a value, translate=true is assumed. If translate + isn’t specified, translate=true is assumed if babel, polyglossia or translator have + been loaded. Otherwise translate=false is assumed. + + +

See §1.2.1 §1.2.1 Changing the Fixed Names for further details.

notranslate
notranslate
This is equivalent to translate=false and may be passed via the - document class options. +class="cmss-10">translate=false and may be passed via the document + class options.
hyperfirst
This is a boolean option that specifies whether each term - has a hyperlink on hyperfirst
This is a boolean option that specifies whether each term has a hyperlink + on first use. The default is hyperfirst=true - (terms on first use have a hyperlink, unless explicitly suppressed - using starred versions of commands such as \gls*). Note that - this applies to all glossary types. It may be that you only - want to apply this to just the acronyms (where the first use - explains the meaning of the acronym) but not for ordinary - glossary entries (where the first use is identical to subsequent - uses). In this case, you can use hyperfirst=false and apply - \glsunsetall to all the regular (non-acronym) glossaries. For +class="cmss-10">hyperfirst=true (terms on first use have a hyperlink, + unless explicitly suppressed using starred versions of commands such as \gls*). + Note that this applies to all glossary types. It may be that you only want to + apply this to just the acronyms (where the first use explains the meaning of the + acronym) but not for ordinary glossary entries (where the first use is + identical to subsequent uses). In this case, you can use hyperfirst=false and + apply \glsunsetall to all the regular (non-acronym) glossaries. For example: - - - + +
 \usepackage[acronym,hyperfirst=false]{glossaries}  
 % acronym and glossary entry definitions  
 % at the end of the preamble  
 \glsunsetall[main]
-

+

nohypertypes
Use this option if you have multiple glossaries and you want - to suppress the entry hyperlinks for a particular glossary or - glossaries. The value of this option should be a comma-separated list - of glossary types where \gls etc shouldn’t have hyperlinks by - default. Make sure you enclose the value in braces if it contains any - commas. Example: - - - +class="cmssbx-10">nohypertypes
Use this option if you have multiple glossaries and you want to + suppress the entry hyperlinks for a particular glossary or glossaries. The value of + this option should be a comma-separated list of glossary types where \gls etc + shouldn’t have hyperlinks by default. Make sure you enclose the value in braces + if it contains any commas. Example: + +
\usepackage[acronym,nohypertypes={acronym,notation}]  
  {glossaries}  
\newglossary[nlg]{notation}{not}{ntn}{Notation}
-

The values must be fully expanded, so don’t try - nohypertypes=\acronymtype. You may also use -

\GlsDeclareNoHyperList{<list>}
-

+

The values must be fully expanded, so don’t try nohypertypes=\acronymtype. + You may also use +

\GlsDeclareNoHyperList{<list>}
+

instead or additionally. See §6 §6 Links to Glossary Entries for further details.

savenumberlist
This is a boolean option that specifies whether or - not to gather and store the savenumberlist
This is a boolean option that specifies whether or not to gather and + store the number list for each entry. The - default is savenumberlist=false. (See \glsentrynumberlist and + id="dx1-14078"> for each entry. The default is savenumberlist=false. (See \glsdisplaynumberlist in \glsentrynumberlist and \glsdisplaynumberlist in §9 Using Glossary Terms Without - Links.) +class="cmsy-10">§9 Using Glossary + Terms Without Links.)
-

+

-

Top

2.2  

Top

2.2 Sectioning, Headings and TOC Options

toctoc
Add the glossaries to the table of contents. Note that an extra - LATEX run is required with this option. Alternatively, you can - switch this function on and off using -

+

and -

\glstocfalse 

\glstocfalse  \glstocfalse
-

- - - +class="cmtt-10">\glstocfalse

+

numberlinenumberline
When used with toctoc, this will add \numberline\numberline{} in the final +class="cmtt-10">{} in the final argument of \addcontentsline\addcontentsline. This will align the table of contents entry with the numbered section titles. Note that this option has no effect if the toctoc option is omitted. If toctoc is used without numberline, - the title will be aligned with the section numbers rather than the - section titles. +class="cmss-10">numberline, the + title will be aligned with the section numbers rather than the section + titles. + +
sectionsection
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, otherwise each - glossary will appear in a chapter, if chapters exist, otherwise in a - section. Unnumbered sectional units will be used by default. +class="cmmi-10"><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, otherwise each glossary will appear in a chapter, if chapters exist, + otherwise in a section. Unnumbered sectional units will be used by default. Example: - - - + +
\usepackage[section=subsection]{glossaries}
-

You can omit the value if you want to use sections, i.e.  - - - +

You can omit the value if you want to use sections, i.e.  + +

\usepackage[section]{glossaries}
-

is equivalent to - - - +

is equivalent to + +

\usepackage[section=section]{glossaries}
-

You can change this value later in the document using -

\setglossarysection 

You can change this value later in the document using +

\setglossarysection  \setglossarysection{<name>}
-

+class="cmtt-10">\setglossarysection{<name>}

+

where <name> is the sectional unit. -

The start of each glossary adds information to the page header - via -

\glsglossarymark <name> is the sectional unit. +

The start of each glossary adds information to the page header via +

\glsglossarymark  \glsglossarymark{<glossary title>} -
-

- This defaults to \@mkboth, but you may need to redefine it. For - example, to only change the right header: - - - +class="cmtt-10">\glsglossarymark{<glossary title>}

+

+ By default this uses \@mkboth2.1 + but you may need to redefine it. For example, to only change the right + header: + +

\renewcommand{\glsglossarymark}[1]{\markright{#1}}
-

or to prevent it from changing the headers: - - - +

or to prevent it from changing the headers: + +

\renewcommand{\glsglossarymark}[1]{}
-

If you want \glsglossarymark to use \MakeUppercase in the - header, use the ucmark option described below. -

Occasionally you may find that another package defines +

If you want \glsglossarymark to use \MakeUppercase in the header, use the \cleardoublepage when it is not required. This may cause an - unwanted blank page to appear before each glossary. This can be - fixed by redefining \glsclearpage \glsclearpage: - - - +class="cmss-10">ucmark option described below. +

Occasionally you may find that another package defines + \cleardoublepage when it is not required. This may cause an unwanted blank + page to appear before each glossary. This can be fixed by redefining + \glsclearpage \glsclearpage: + +

\renewcommand*{\glsclearpage}{\clearpage}
-

+

ucmark
ucmark
This is a boolean option (default: ucmark=false, - unless memoir has been loaded, in which case it defaults - to ucmark=true). If set, \glsglossarymark uses +class="cmss-10">ucmark=false, unless memoir has been + loaded, in which case it defaults to ucmark=true). If set, \glsglossarymark uses \MakeTextUppercase1. +class="cmtt-10">\MakeTextUppercase2.2. You can test whether this option has been set or not using -

\ifglsucmark  \ifglsucmark <true part>\else <false - part>\fi
-

+

\ifglsucmark  \ifglsucmark <true part>\else <false part>\fi +
+

For example: - - - + +

\renewcommand{\glsglossarymark}[1]{% @@ -4180,278 +4056,270 @@ class="cmtt-10x-x-109">\fi
 
    \markright{#1}%  
  \fi}
-

If memoir has been loaded and ucfirst is set, then memoir’s - \memUChead is used. +

If memoir has been loaded and ucfirst is set, then memoir’s \memUChead is + used.

numberedsection
The glossaries are placed in unnumbered sectional units - by default, but this can be changed using numberedsection. This - option can take one of the following values: -
    -
  • false: no number, i.e. use starred form of sectioning - command (e.g. \chapter* or \section*); -
    • -
  • nolabel: use a numbered section, i.e. the unstarred form of - sectioning command (e.g. \chapter or \section), but the - section not labelled; -
    • -
  • autolabel: numbered with automatic labelling. Each glossary uses - the unstarred form of a sectioning command (e.g. \chapter or - \section) and is assigned a label (via \label). The label is - formed from -

    \glsautoprefix  \glsautoprefix <type>
    -

    - where <type> is the label identifying that glossary. The default - value of \glsautoprefix is empty. For example, if you load - glossaries using: - - - -

    -
    - \usepackage[section,numberedsection=autolabel] -  
      {glossaries}
    -

    then each glossary will appear in a numbered section, and can - be referenced using something like: - - - -

    -
    - The main glossary is in section~\ref{main} and -  
    the list of 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: - - - +class="cmssbx-10">numberedsection

    The glossaries are placed in unnumbered sectional units by default, + but this can be changed using numberedsection. This option can take one of the + following values: +
      +
    • false: no number, i.e. use starred form of sectioning command + (e.g. \chapter* or \section*); +
      • +
    • nolabel: use a numbered section, i.e. the unstarred form of sectioning + command (e.g. \chapter or \section), but the section not labelled; +
      • +
    • autolabel: numbered with automatic labelling. Each glossary uses + the unstarred form of a sectioning command (e.g. \chapter or + \section) and is assigned a label (via \label). The label is formed + from +

      \glsautoprefix  \glsautoprefix <type>
      +

      + where <type> is the label identifying that glossary. The default value + of \glsautoprefix is empty. For example, if you load glossaries + using: + + +

      +
      + \usepackage[section,numberedsection=autolabel] +  
        {glossaries} +
      +

      then each glossary will appear in a numbered section, and can be + referenced using something like: + + +

      +
      + The main glossary is in section~\ref{main} and +  
      the list of 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: + + +

      +
      + The list of acronyms is in section~\ref{\acronymtype}. +
      +

      You can redefine the prefix if the default label clashes with another label in + your document. For example: + +

      -
      - The list of acronyms is in section~\ref{\acronymtype}.
      -

      You can redefine the prefix if the default label clashes with - another label in your document. For example: - - - -

      -
      - \renewcommand*{\glsautoprefix}{glo:}
      -

      will add glo: to the automatically generated label, so you - can then, for example, refer to the list of acronyms as - follows: - - - +

      + \renewcommand*{\glsautoprefix}{glo:} +
      +

      will add glo: to the automatically generated label, so you can then, for + example, refer to the list of acronyms as follows: + + +

      +
      + The list of acronyms is in +  
      section~\ref{glo:\acronymtype}. +
      +

      Or, if you are undecided on a prefix: + +

      -
      - The list of acronyms is in -  
      section~\ref{glo:\acronymtype}.
      -

      Or, if you are undecided on a prefix: - - - -

      -
      - The list of acronyms is in -  
      section~\ref{\glsautoprefix\acronymtype}.
      -

      -

      • -
    • nameref: this is like autolabel but uses an unnumbered sectioning - command (e.g. \chapter* or \section*). It’s designed for use - with the nameref package. For example: - - - -
      - \usepackage{nameref} -  
      \usepackage[numberedsection=nameref]{glossaries}
      -

      Now \nameref{main} will display the (TOC) section - title associated with the main glossary. As above, you - can redefine \glsautoprefix to provide a prefix for the - label.

    +
    + The list of acronyms is in +  
    section~\ref{\glsautoprefix\acronymtype}. +
    +

    +

    • +
  • nameref: this is like autolabel but uses an unnumbered sectioning command + (e.g. \chapter* or \section*). It’s designed for use with the nameref + package. For example: + + +
    + \usepackage{nameref} +  
    \usepackage[numberedsection=nameref]{glossaries} +
    +

    Now \nameref{main} will display the (TOC) section title associated with + the main glossary. As above, you can redefine \glsautoprefix to provide a + prefix for the label.

-

+

-

Top

2.3  

Top

2.3 Glossary Appearance Options

entrycounterentrycounter
This is a boolean option. (Default is entrycounter=falseThis is a boolean option. (Default is entrycounter=false.) - If set, each main (level 0) glossary entry will be numbered - when using the standard glossary styles. This option creates the - counter glossaryentry glossaryentry glossaryentry. -

If you use this option, you can reference the entry number within the - document using -

+

where <label> is the label associated with that glossary entry. -

If you use \glsrefentry, you must run LATEX twice after creating - the glossary files using <label> is the label associated with that glossary entry. +

If you use \glsrefentry, you must run LATEX twice after creating the + glossary files using makeglossariesmakeglossaries, makeindexmakeindex or xindy to - ensure the cross-references are up-to-date.
-

+class="cmtt-10">xindy to ensure the + cross-references are up-to-date.

+

counterwithincounterwithin
This is a <key>=<value> option where <value> is the - name of a counter. If used, this option will automatically set +class="cmmi-10"><key>=<value> option where <value> is the name of a + counter. If used, this option will automatically set entrycounter=true and the entrycounter=true and the glossaryentry counter will be reset every - time <value> is incremented. - - - -

The glossaryentry counter isn’t automatically reset at the start of - each glossary, except when glossary section numbering is on and the - counter used by counterwithin is the same as the counter used in the - glossary’s sectioning command.
-

-

If you want the counter reset at the start of each glossary, you can - redefine \glossarypreambleglossaryentry counter will be reset every time <value> is incremented. +

The glossaryentry counter isn’t automatically reset at the start of each glossary, + except when glossary section numbering is on and the counter used by + counterwithin is the same as the counter used in the glossary’s sectioning + command.
+

+ + +

If you want the counter reset at the start of each glossary, you can redefine + \glossarypreamble to use -

\glsresetentrycounter 

\glsresetentrycounter  \glsresetentrycounter
-

+class="cmtt-10">\glsresetentrycounter

+

which sets glossaryentryglossaryentry to zero: - - - + +

\renewcommand{\glossarypreamble}{%  
  \glsresetentrycounter  
}
-

or if you are using \setglossarypreamble, add it to each glossary - preamble, as required. For example: - - - +

or if you are using \setglossarypreamble, add it to each glossary preamble, as + required. For example: + +

\setglossarypreamble[acronym]{% @@ -4463,488 +4331,467 @@ class="cmtt-10x-x-109">\setglossarypreamble  The preamble text here for the main glossary.  
}
-

+

subentrycountersubentrycounter
This is a boolean option. (Default is subentrycounter=false.) - If set, each level 1 glossary entry will be numbered when using - the standard glossary styles. This option creates the counter - glossarysubentry subentrycounter=false.) If set, + each level 1 glossary entry will be numbered when using the standard glossary + styles. This option creates the counter glossarysubentry glossarysubentry. The counter is reset with each - main (level 0) entry. Note that this package option is independent of - entrycounterglossarysubentry. The + counter is reset with each main (level 0) entry. Note that this package option is + independent of entrycounter. You can reference the number within the document using \glsrefentry\glsrefentry{<label>} where <label> is the label associated - with the sub-entry. +class="cmtt-10">{<label>} where <label> is the label associated with the + sub-entry.
stylestyle
This is a <key>=<value> option. (Default is style=list.) Its value - should be the name of the glossary style to use. This key may - only be used for styles defined in glossary-list, glossary-long, +class="cmmi-10"><key>=<value> option. (Default is style=list.) Its value should be the + name of the glossary style to use. This key may only be used for styles defined in glossary-superglossary-list, glossary-long, glossary-super or glossary-tree. Alternatively, you can set the style - using -

\setglossarystyle{<style name>}
-

+class="cmss-10">glossary-tree. Alternatively, you can + set the style using +

\setglossarystyle{<style name>}
+

(See §15 §15 Glossary Styles for further details.)

nolongnolong
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. Note that if you use this - option, you won’t be able to use any of the glossary styles - defined in the glossary-long package (unless you explicitly load +class="cmss-10">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. Note that + if you use this option, you won’t be able to use any of the glossary + styles defined in the glossary-long package (unless you explicitly load glossary-longglossary-long). - - -
nosupernosuper
This prevents the glossaries package from automatically loading +class="cmss-10">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. Note that + if you use this option, you won’t be able to use any of the glossary + styles defined in the glossary-super package (unless you explicitly load glossary-super (which means that the supertabular package - also won’t be loaded). This reduces overhead by not defining - unwanted styles and commands. Note that if you use this - option, you won’t be able to use any of the glossary styles - defined in the glossary-super package (unless you explicitly load - glossary-superglossary-super). + +
nolistnolist
This prevents the glossaries package from automatically loading +class="cmss-10">glossaries package from automatically loading glossary-list. + This reduces overhead by not defining unwanted styles. Note that if you use this + option, you won’t be able to use any of the glossary styles defined in the glossary-list. This reduces overhead by not defining unwanted styles. - Note that if you use this option, you won’t be able to use any of the - glossary styles defined in the glossary-list package (unless you - explicitly load glossary-list). Note that since the default style is list, - you will also need to use the style option to set the style to something - else. +class="cmss-10">glossary-list package (unless you explicitly load glossary-list). Note that since the + default style is list, you will also need to use the style option to set the style to + something else.
notreenotree
This prevents the glossaries package from automatically loading +class="cmss-10">glossaries package from automatically loading glossary-tree. + This reduces overhead by not defining unwanted styles. Note that if you use this + option, you won’t be able to use any of the glossary styles defined in the glossary-tree. This reduces overhead by not defining unwanted styles. - Note that if you use this option, you won’t be able to use any of the - glossary styles defined in the glossary-tree package (unless you - explicitly load glossary-treeglossary-tree package (unless you explicitly load glossary-tree).
nostylesnostyles
This prevents all the predefined styles from being loaded. If you - use this option, you need to load a glossary style package - (such as glossary-mcols). Also if you use this option, you can’t - use the style package option. Instead you must either use - \setglossarystyleThis prevents all the predefined styles from being loaded. If you use this + option, you need to load a glossary style package (such as glossary-mcols). Also if + you use this option, you can’t use the style package option. Instead you must + either use \setglossarystyle{<style>} or the style{<style>} or the style key in the optional argument to \printglossary\printglossary. Example: - - - + +
\usepackage[nostyles]{glossaries}  
\usepackage{glossary-mcols}  
\setglossarystyle{mcoltree}
-

+

nonumberlistnonumberlist
This option will suppress the associated number lists in the - glossaries (see also s in the glossaries + (see also §5 §5 Number lists).
seeautonumberlistseeautonumberlist
If you suppress the number lists with nonumberlist, - described above, this will also suppress any cross-referencing - information supplied by the see key in \newglossaryentry or +class="cmss-10">nonumberlist, described + above, this will also suppress any cross-referencing information supplied by the \glsseesee key in \newglossaryentry or \glssee. If you use seeautonumberlistseeautonumberlist, the see key will automatically - implement nonumberlist=false for that entry. (Note this doesn’t - affect \glssee.) For further details see see + key will automatically implement nonumberlist=false for that entry. (Note this + doesn’t affect \glssee.) For further details see §8 §8 Cross-Referencing Entries.
countercounter
This is a <key>=<value> option. (Default is counter=page.) The - value should be the name of the default counter to use in the <key>=<value> option. (Default is counter=page.) The value + should be the name of the default counter to use in the number - listnumber lists (see §5 §5 + Number lists).
nopostdotnopostdot
This is a boolean option. If no value is specified, true is - assumed. When set to true, this option suppresses the default post - description dot used by some of the predefined styles. The default - setting is nopostdot=falsetrue is assumed. When + set to true, this option suppresses the default post description dot used by some + of the predefined styles. The default setting is nopostdot=false.
nogroupskipnogroupskip
This is a boolean option. If no value is specified, true is - assumed. When set to true, this option suppresses the default - vertical gap between groups used by some of the predefined styles. - The default setting is nogroupskip=falsetrue is assumed. When + set to true, this option suppresses the default vertical gap between + groups used by some of the predefined styles. The default setting is + nogroupskip=false.
- - - -

+

-

Top

2.4  

Top

2.4 Sorting Options

+ +
sortsort
This is a <key>=<value> option where the option can only have - one of the following values: -
    -
  • standard<key>=<value> option where the option can only have one of + the following values: +
      +
    • standard : entries are sorted according to the value of the sort - key used in \newglossaryentrysort key + used in \newglossaryentry (if present) or the name - key (if sort key is missing); -
      • -
    • def : entries are sorted in the order in which they were - defined (the sortname key (if sort key + is missing); +
      • +
    • def : entries are sorted in the order in which they were defined (the + sort key in \newglossaryentry is ignored); -
      • -
    • use : entries are sorted according to the order in - which they are used in the document (the sort key in - \newglossaryentry is ignored). -

      Both sort=def\newglossaryentry is ignored); +

      • +
    • use : entries are sorted according to the order in which they are used + in the document (the sort key in \newglossaryentry is ignored). +

      Both sort=def and sort=use set the sort key to a six digit - number via -

      \glssortnumberfmt sort=use set the sort key to a six digit number + via +

      \glssortnumberfmt  \glssortnumberfmt{<number>} -
      -

      - (padded with leading zeros, where necessary). This can be - redefined, if required, before the entries are defined (in the case - of sort=def) or before the entries are used (in the case of - sort=use\glssortnumberfmt{<number>}

      +

      + (padded with leading zeros, where necessary). This can be redefined, if + required, before the entries are defined (in the case of sort=def) or before + the entries are used (in the case of sort=use).

    -

    The default is sort=standard. When the standard sort option is in use, - you can hook into the sort mechanism by redefining: -

    \glsprestandardsort 

    The default is sort=standard. When the standard sort option is in use, you can + hook into the sort mechanism by redefining: +

    \glsprestandardsort  \glsprestandardsort{<sort - cs>}{<type>}{<label>}
    -

    +class="cmtt-10">\glsprestandardsort{<sort cs>}{<type>}{<label>} +

    +

    where <sort cs> is a temporary control sequence that stores the sort - value (which was either explicitly set via the sort key or implicitly set - via the name key) before any escaping of the <sort cs> is a temporary control sequence that stores the sort value + (which was either explicitly set via the sort key or implicitly set via the name + key) before any escaping of the makeindexmakeindex/xindy - special characters is performed. By default \glsprestandardsort - just does: - - - -

    \glsdosanitizesort xindy special characters is + performed. By default \glsprestandardsort just does: +

    \glsdosanitizesort  \glsdosanitizesort
    -

    +class="cmtt-10">\glsdosanitizesort

    +

    which sanitizes <sort cs> if the sanitizesort package option is set - (or does nothing if the package option sanitizesort=false is - used). -

    The other arguments, <type> and <label>, are the glossary type and - the entry label for the current entry. Note that <type> will always be - a control sequence, but <label> will be in the form used in the first - argument of \newglossaryentry. -

    Redefining \glsprestandardsort won’t affect any entries that have - already been defined and will have no effect at all if you are using +class="cmmi-10"><sort cs> if the sanitizesort package option is set (or does + nothing if the package option sanitizesort=false is used). +

    The other arguments, <type> and <label>, are the glossary type and the entry + label for the current entry. Note that <type> will always be a control + sequence, but <label> will be in the form used in the first argument of sort=def\newglossaryentry. +

    Redefining \glsprestandardsort won’t affect any entries that have already + been defined and will have no effect at all if you are using sort=def or sort=use.
    -

    +class="cmss-10">sort=use. +

    + + +

    -

    Example 1 (Mixing Alphabetical and Order of +class="cmbx-12"> (Mixing Alphabetical and Order of Definition Definition Sorting)Sorting) -

    Suppose I have three glossaries: main, acronym and notation, and - let’s suppose I want the main and acronym glossaries to be sorted - alphabetically, but the notation type should be sorted in - order of definition. I can set the sort to standard (which is - the default, but can be explicitly set via the package option +

    Suppose I have three glossaries: main, acronym and notation, and let’s suppose + I want the main and acronym glossaries to be sorted alphabetically, + but the notation type should be sorted in order of definition. I can + set the sort to standard (which is the default, but can be explicitly + set via the package option sort=standard), and I can either define all + my main and acronym entries, then redefine \glsprestandardsort + to set <sort cs> to an incremented integer, and then define all my sort=standard), and I can either define all my main and acronym - entries, then redefine \glsprestandardsort to set <sort cs> to an - incremented integer, and then define all my notation entries. - Alternatively, I can redefine \glsprestandardsort to check for - the glossary type and only modify <sort cs> if <type> is +class="cmtt-10">notation entries. Alternatively, I can redefine \glsprestandardsort to + check for the glossary type and only modify <sort cs> if <type> is notation. -

    The first option can be achieved as follows: - - - +class="cmtt-10">notation. +

    The first option can be achieved as follows: + +

    \newcounter{sortcount} @@ -4953,10 +4800,9 @@ class="cmtt-10x-x-109">notation.  
      \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%  
    }
    -

    The second option can be achieved as follows: - - - +

    The second option can be achieved as follows: + +

    \newcounter{sortcount} @@ -4971,90 +4817,86 @@ class="cmtt-10x-x-109">notation.  
      }%  
    }
    -

    (\ifdefstring is defined by the etoolbox package.) For a complete - document, see the sample file

    (\ifdefstring is defined by the etoolbox package.) For a complete document, + see the sample file sampleSort.tex.

    +class="cmtt-10">sampleSort.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

-

Example 2 (Customizing Standard Sort) -

Suppose you want a glossary of people and you want the names listed - as <first-name> <surname> in the glossary, but you want the names - sorted by <surname>, <first-name>. You can do this by defining a - command called, say, \name{<first-name>}{<surname>} that you - can use in the name key when you define the entry, but hook into the - standard sort mechanism to temporarily redefine \name while the - sort value is being set. -

First, define two commands to set the person’s name: - - - +

Suppose you want a glossary of people and you want the names listed as + <first-name> <surname> in the glossary, but you want the names sorted by + <surname>, <first-name>. You can do this by defining a command + called, say, \name{<first-name>}{<surname>} that you can use in the + name key when you define the entry, but hook into the standard sort + mechanism to temporarily redefine \name while the sort value is being + set. +

First, define two commands to set the person’s name: + +

\newcommand{\sortname}[2]{#2, #1}  
\newcommand{\textname}[2]{#1 #2}
-

and \name needs to be initialised to \textname: - - - +

and \name needs to be initialised to \textname: + +

\let\name\textname
-

Now redefine \glsprestandardsort so that it temporarily sets - \name to \sortname and expands the sort value, then sets \name to +

Now redefine \glsprestandardsort so that it temporarily sets \name to \textname so that the person’s name appears as <first-name> - <surname> in the text: - - - +class="cmtt-10">\sortname and expands the sort value, then sets \name to \textname so + that the person’s name appears as <first-name> <surname> in the + text: + +

\renewcommand{\glsprestandardsort}[3]{% @@ -5064,13 +4906,12 @@ class="cmmi-10x-x-109">> in the text:  
 \glsdosanitizesort  
}
-

(The somewhat complicate use of \expandafter etc helps to protect - fragile commands, but care is still needed.) -

Now the entries can be defined: - - - +

(The somewhat complicate use of \expandafter etc helps to protect fragile + commands, but care is still needed.) +

Now the entries can be defined: + +

\newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}}, @@ -5078,269 +4919,256 @@ class="cmtt-10x-x-109">\expandafter etc helps to protect  
\newglossaryentry{johnsmith}{name={\name{John}{Smith}},  
  description={some information about John Smith}}
-

For a complete document, see the sample file

For a complete document, see the sample file samplePeople.tex. -

+class="cmtt-10">samplePeople.tex.

-

-

____________________________

+

+

____________________________

orderorder
This may take two values: wordword or letter. The default is word - ordering. -

Note that the order option has no effect if you don’t use - letter. The default is word ordering. +

Note that the order option has no effect if you don’t use makeglossaries.
-

+class="cmtt-10">makeglossaries. +

+

makeindexmakeindex
(Default) The glossary information and indexing style file will - be written in (Default) The glossary information and indexing style file will be written + in makeindexmakeindex format. If you use makeglossaries, it - will automatically detect that it needs to call makeglossaries, it will automatically detect + that it needs to call makeindex. If - you don’t use makeindex. If you don’t use makeglossaries, you need to remember to use - makeglossaries, you need to + remember to use makeindexmakeindex not xindy. The indexing style file will been given a .ist - extension. +class="cmtt-10">xindy. The indexing style file will been given a + .ist extension.
xindyxindy
The glossary information and indexing style file will be written in - The glossary information and indexing style file will be written in xindy format. If you use xindy + format. If you use makeglossaries, it will automatically - detect that it needs to call makeglossaries, it will automatically detect that it needs to + call xindyxindy. If you don’t use makeglossaries, - you need to remember to use makeglossaries, you need to remember to use + xindyxindy not makeindex. The indexing - style file will been given a .xdy extension. -

This package option may additionally have a value that is a - <key>=<value> comma-separated list to override the language and - codepage. For example: - - - +class="cmtt-10">makeindex. The indexing style file will been given a .xdy + extension. +

This 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}
-

You can also specify whether you want a number group in the - glossary. This defaults to true, but can be suppressed. For - example: - - - +

You can also specify whether you want a number group in the glossary. This + defaults to true, but can be suppressed. For example: + +

\usepackage[xindy={glsnumbers=false}]{glossaries}
-

If no value is supplied to this package option (either simply writing - xindy or writing xindy={}) then the language, codepage and number - group settings are unchanged. See

If no value is supplied to this package option (either simply writing xindy or + writing xindy={}) then the language, codepage and number group settings are + unchanged. See §11 Xindy for further details on - using §11 Xindy for further details on using xindyxindy with the glossaries package. +class="cmss-10">glossaries + package.

xindyglossxindygloss
This is equivalent to xindy={} (that is, the xindy option - without any value supplied) and may be used as a document - class option. The language and code page can be set via - \GlsSetXdyLanguagexindy={} (that is, the xindy option without any value + supplied) and may be used as a document class option. The language and code + page can be set via \GlsSetXdyLanguage and \GlsSetXdyCodePage\GlsSetXdyCodePage (see §11.1 Language - and Encodings.) +class="cmsy-10">§11.1 + Language and Encodings.)
xindynoglsnumbersxindynoglsnumbers
This is equivalent to xindy={glsnumbers=false} and - may be used as a document class option. +class="cmtt-10">xindy={glsnumbers=false} and may be + used as a document class option.
-

+

-

Top

2.5  

Top

2.5 Acronym Options

acronymacronym
This creates a new glossary with the label acronym. This is - equivalent to: - - - +class="cmtt-10">acronym. This is equivalent + to: + +
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-

It will also define -

\printacronyms 

It will also define +

\printacronyms  \printacronyms[<options>]
-

+class="cmtt-10">\printacronyms[<options>]

+

that’s equivalent to

\printglossary\printglossary[type=acronym,<options>] -
-
(unless that command is already defined before the beginning of the - document or the package option compatible-3.07[type=acronym,<options>] +
+
(unless that command is already defined before the beginning of the document + or the package option compatible-3.07 is used). -

If the acronym

If the acronym package option is used, \acronymtype\acronymtype is set to acronym otherwise it is - set to main.2 +class="cmtt-10">acronym otherwise it is set to + main.2.3 Entries that are defined using \newacronym are placed in the glossary - whose label is given by \acronymtype, unless another glossary is - explicitly specified. -

Remember to use the nomain package option if you’re only interested - in using this acronym glossary.
-

+class="cmtt-10">\newacronym are placed in the glossary whose + label is given by \acronymtype, unless another glossary is explicitly + specified. +

Remember to use the nomain package option if you’re only interested in using + this acronym glossary.
+

acronymsacronyms
This is equivalent to acronym=true and may be used in the - document class option list. +class="cmss-10">acronym=true and may be used in the document class + option list.
acronymlistsacronymlists
By default, only the \acronymtype glossary is considered to - be a list of acronyms. If you have other lists of acronyms, you can - specify them as a comma-separated list in the value of acronymlists. - For example, if you use the acronym package option but you also - want the main glossary to also contain a list of acronyms, you can - do: - - - +class="cmtt-10">\acronymtype glossary is considered to be a list of + acronyms. If you have other lists of acronyms, you can specify them as a + comma-separated list in the value of acronymlists. For example, if you use the + acronym package option but you also want the main glossary to also contain a + list of acronyms, you can do: + +
\usepackage[acronym,acronymlists={main}]{glossaries}
-

No check is performed to determine if the listed glossaries - exist, so you can add glossaries you haven’t defined yet. For - example: - - - +

No check is performed to determine if the listed glossaries exist, so you can add + glossaries you haven’t defined yet. For example: + +

\usepackage[acronym,acronymlists={main,acronym2}] @@ -5348,1538 +5176,1469 @@ class="cmtt-10x-x-109">main glossary to also contain a list of acronyms,  
\newglossary[alg2]{acronym2}{acr2}{acn2}%  
  {Statistical Acronyms}
-

You can use -

\DeclareAcronymList 

You can use +

\DeclareAcronymList  \DeclareAcronymList{<list>}
-

+class="cmtt-10">\DeclareAcronymList{<list>}

+

instead of or in addition to the acronymlistsacronymlists option. This will add the glossaries given in <list> to the list of glossaries that are identified as +class="cmmi-10"><list> to the list of glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list use: -

\SetAcronymLists 

\SetAcronymLists  \SetAcronymLists{<list>}
-

-

You can determine if a glossary has been identified as being a list of - acronyms using: -

\glsIfListOfAcronyms \SetAcronymLists{<list>}
+

+

You can determine if a glossary has been identified as being a list of acronyms + using: +

\glsIfListOfAcronyms  \glsIfListOfAcronyms{<label>}{<true +class="cmtt-10">\glsIfListOfAcronyms{<label>}{<true part>}{<false part>}
-

+class="cmitt-10">part>}{<false part>}

+

shortcutsshortcuts
This option provides shortcut commands for acronyms. - See This option provides shortcut commands for acronyms. See §13 Acronyms for further details. Alternatively you can - use: -

\DefineAcronymShortcuts Â§13 Acronyms + for further details. Alternatively you can use: +

\DefineAcronymShortcuts  \DefineAcronymShortcuts
-

+class="cmtt-10">\DefineAcronymShortcuts

+

-

+

-

Top

2.5.1  

Top

2.5.1 Deprecated Acronym Style Options

- - - -

The package options listed in this section are now deprecated but are kept -for backward-compatibility. Use \setacronymstyle

The package options listed in this section are now deprecated but are kept for +backward-compatibility. Use \setacronymstyle instead. See §13 -Acronyms for further details. +class="cmsy-10">§13 Acronyms for further +details. + +

descriptiondescription
This option changes the definition of \newacronym to allow a - description. This option may be replaced by - - - +class="cmtt-10">\newacronym to allow a description. + This option may be replaced by + +
\setacronymstyle{long-short-desc}
-

or (with smallcaps

or (with smallcaps) - - - + +

\setacronymstyle{long-sc-short-desc}
-

or (with smaller

or (with smaller) - - - + +

\setacronymstyle{long-sm-short-desc}
-

or (with footnote

or (with footnote) - - - + +

\setacronymstyle{footnote-desc}
-

or (with footnote

or (with footnote and smallcapssmallcaps) - - - + +

\setacronymstyle{footnote-sc-desc}
-

or (with footnote

or (with footnote and smallersmaller) - - - + +

\setacronymstyle{footnote-sm-desc}
-

or (with dua

or (with dua) - - - + +

\setacronymstyle{dua-desc}
-

+

smallcapssmallcaps
This option changes the definition of \newacronym and the way - that acronyms are displayed. This option may be replaced - by: - - - +class="cmtt-10">\newacronym and the way that + acronyms are displayed. This option may be replaced by: + +
\setacronymstyle{long-sc-short}
-

or (with description

or (with description) - - - + +

\setacronymstyle{long-sc-short-desc}
-

or (with description

or (with description and footnotefootnote) - - - + +

\setacronymstyle{footnote-sc-desc}
-

+

smallersmaller
This option changes the definition of \newacronym and the way - that acronyms are displayed. -

If you use this option, you will need to include the relsize package or - otherwise define \textsmaller\newacronym and the way that + acronyms are displayed. +

If you use this option, you will need to include the relsize package or otherwise + define \textsmaller or redefine \acronymfont. -
-

+class="cmtt-10">\acronymfont.

+

This option may be replaced by: - - - + +

\setacronymstyle{long-sm-short}
-

or (with description

or (with description) - - - + +

\setacronymstyle{long-sm-short-desc}
-

or (with description

or (with description and footnotefootnote) - - - + +

\setacronymstyle{footnote-sm-desc}
-

+

footnotefootnote
This option changes the definition of \newacronym and the way - that acronyms are displayed. This option may be replaced - by: - - - +class="cmtt-10">\newacronym and the way that + acronyms are displayed. This option may be replaced by: + +
\setacronymstyle{footnote}
-

or (with smallcaps

or (with smallcaps) - - - + +

\setacronymstyle{footnote-sc}
-

or (with smaller

or (with smaller) - - - + +

\setacronymstyle{footnote-sm}
-

or (with description

or (with description) - - - + +

\setacronymstyle{footnote-desc}
-

or (with smallcaps

or (with smallcaps and descriptiondescription) - - - + +

\setacronymstyle{footnote-sc-desc}
-

or (with smaller

or (with smaller and descriptiondescription) - - - + +

\setacronymstyle{footnote-sm-desc}
-

+

duadua
This option changes the definition of \newacronym so that - acronyms are always expanded. This option may be replaced - by: - - - +class="cmtt-10">\newacronym so that acronyms are always + expanded. This option may be replaced by: + +
\setacronymstyle{dua}
-

or (with description

or (with description) - - - + +

\setacronymstyle{dua-desc}
-

+

-

+

-

Top

2.6  

Top

2.6 Other Options

-

Other available options that don’t fit any of the above categories -are: +

Other available options that don’t fit any of the above categories are:

symbolssymbols
This option defines a new glossary type with the label symbols +class="cmtt-10">symbols via - - - + +
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-

It also defines -

\printsymbols 

It also defines +

\printsymbols  \printsymbols[<options>]
-

+class="cmtt-10">\printsymbols[<options>]

+

which is a synonym for \printglossary\printglossary[type=symbols,<options>]. -

Remember to use the nomain package option if you’re only interested - in using this symbols glossary.
-

+class="cmtt-10">[type=symbols,<options>]. +

Remember to use the nomain package option if you’re only interested in using + this symbols glossary.
+

numbersnumbers
This option defines a new glossary type with the label numbers +class="cmtt-10">numbers via - - - + +
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
-

It also defines -

\printnumbers 

It also defines +

\printnumbers  \printnumbers[<options>]
-

+class="cmtt-10">\printnumbers[<options>]

+

which is a synonym for \printglossary\printglossary[type=numbers,<options>]. -

Remember to use the nomain package option if you’re only interested - in using this numbers glossary.
-

+class="cmtt-10">[type=numbers,<options>]. +

Remember to use the nomain package option if you’re only interested in using + this numbers glossary.
+

indexindex
This option defines a new glossary type with the label index - via - - - +class="cmtt-10">index via + +
\newglossary[ilg]{index}{ind}{idx}{\indexname}%
-

It also defines -

\printindex 

It also defines +

\printindex  \printindex[<options>]
-

+class="cmtt-10">\printindex[<options>]

+

which is a synonym for \printglossary\printglossary[type=index,<options>] +class="cmtt-10">[type=index,<options>] and -

\newterm 

\newterm  \newterm[<options>]{<term>}
-

+class="cmtt-10">\newterm[<options>]{<term>}

+

which is a synonym for

\newglossaryentry\newglossaryentry{<term>}[type=index,name={<term>},% +class="cmtt-10">{<term>}[type=index,name={<term>},%
description=\nopostdescdescription=\nopostdesc,<options>] +class="cmtt-10">,<options>]
-

Remember to use the nomain package option if you’re only interested - in using this index glossary. Note that you can’t mix this option with - \index. Either use glossaries for the indexing or use a custom - indexing package, such as makeidx

Remember to use the nomain package option if you’re only interested in using + this index glossary. Note that you can’t mix this option with \index. + Either use glossaries for the indexing or use a custom indexing package, + such as makeidx, indexindex or imakeidx. (You can, of - course, load one of those packages and load glossaries without the +class="cmss-10">imakeidx. (You can, of course, load one of + those packages and load glossaries without the index package option.) +
+

+

Since the index isn’t designed for terms with descriptions, you might also want + to disable the hyperlinks for this glossary using the package option index package option.)

-

-

Since the index isn’t designed for terms with descriptions, you - might also want to disable the hyperlinks for this glossary - using the package option nohypertypes=index or the command - +class="cmss-10">nohypertypes=index or the command
\GlsDeclareNoHyperList\GlsDeclareNoHyperList{index} +class="cmtt-10">{index}
-

The example file

The example file sample-index.tex illustrates the use of the index - package option. - - - +class="cmtt-10">sample-index.tex illustrates the use of the index package + option.

compatible-2.07compatible-2.07
Compatibility mode for old documents created using - version 2.07 or below. +class="description">Compatibility mode for old documents created using version 2.07 or + below. + +
compatible-3.07compatible-3.07
Compatibility mode for old documents created using - version 3.07 or below. +class="description">Compatibility mode for old documents created using version 3.07 or + below.
-

+

-

Top

2.7  

Top

2.7 Setting Options After the Package is Loaded

-

Some of the options described above may also be set after the glossaries -package has been loaded using -

\setupglossaries 

Some of the options described above may also be set after the glossaries package has +been loaded using +

\setupglossaries  \setupglossaries{<key-val list>}
-

+class="cmtt-10">\setupglossaries{<key-val list>}

+

The following package options can’t be used in \setupglossaries: xindy, -xindygloss, xindynoglsnumberscan’t be used in \setupglossaries: xindy, xindygloss, +xindynoglsnumbers, makeindexmakeindex, nolongnolong, nosupernosuper, nolistnolist, notree, -nostylesnotree, nostyles, nomain, compatible-2.07nomain, +compatible-2.07, translatetranslate, notranslatenotranslate, acronym. These -options have to be set while the package is loading, except for the xindy -sub-options which can be set using commands like \GlsSetXdyLanguage -(see acronym. These options have to be set +while the package is loading, except for the xindy sub-options which can be +set using commands like \GlsSetXdyLanguage (see §11 Xindy for further details). -

I recommend you use this command as soon as possible after loading -glossaries otherwise you might end up using it too late for the change to -take effect. For example, if you try changing the acronym styles (such as -smallcaps) after you have started defining your acronyms, you are likely to -get unexpected results. If you try changing the sort option after -you have started to define entries, you may get unexpected results. -
-

- - - +class="cmsy-10">§11 Xindy for further +details). +

I recommend you use this command as soon as possible after loading glossaries +otherwise you might end up using it too late for the change to take effect. For +example, if you try changing the acronym styles (such as smallcaps) after you have +started defining your acronyms, you are likely to get unexpected results. If you try +changing the sort option after you have started to define entries, you may get +unexpected results.
+

+ +

-

Top

3  

+

Top

3. Setting Up

- The command -

\makeglossaries 

The command +

\makeglossaries  \makeglossaries
-

-must be placed in the preamble in order to create the customised -\makeglossaries

+

+must be placed in the preamble in order to create the customised makeindexmakeindex (.ist) or .ist) or +xindyxindy (.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. -

Note that some of the commands provided by the glossaries package -must be placed before \makeglossaries as they are required when -creating the customised style file. If you attempt to use those commands -after \makeglossaries you will generate an error. -

Similarly, there are some commands that must be used after -\makeglossaries.

-

-

You can suppress the creation of the customised .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. +

Note that some of the commands provided by the glossaries package must be +placed before \makeglossaries as they are required when creating the customised +style file. If you attempt to use those commands after \makeglossaries you will +generate an error. +

Similarly, there are some commands that must be used after \makeglossaries. +

+

+

You can suppress the creation of the customised xindyxindy or makeindex -style file using -

\noist makeindex style file +using +

\noist  \noist
-

+class="cmtt-10">\noist

+

Note that this command must be used before \makeglossaries. -

Note that if you have a custom .xdy\makeglossaries. +

Note that if you have a custom .xdy file created when using glossaries -version 2.07 or below, you will need to use the compatible-2.07 package -option with it.
-

-

The default name for the customised style file is given by \jobnameglossaries version 2.07 +or below, you will need to use the compatible-2.07 package option with it. +

+

+

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

\setStyleFile 

\setStyleFile  \setStyleFile{<name>}
-

+class="cmtt-10">\setStyleFile{<name>}

+

where <name> is the name of the style file without the extension. Note -that this command must be used before \makeglossaries. -

Each glossary entry is assigned a <name> is the name of the style file without the extension. Note that this +command must be used before \makeglossaries. +

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 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 + id="dx1-22025"> 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 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 -

\glsSetCompositor 

\glsSetCompositor  \glsSetCompositor{<symbol>}
-

- - - +class="cmtt-10">\glsSetCompositor{<symbol>}

+

For example: - - - + +

-
+
\glsSetCompositor{-}
-

Note that this command must be used before \makeglossaries. -

If you use

Note that this command must be used before \makeglossaries. +

If you use xindy, you can have a different compositor for page numbers -starting with an upper case alphabetical character using: -

\glsSetAlphaCompositor xindy, you can have a different compositor for page numbers starting +with an upper case alphabetical character using: +

\glsSetAlphaCompositor  \glsSetAlphaCompositor{<symbol>} -
-

+class="cmtt-10">\glsSetAlphaCompositor{<symbol>}

+

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

-
+
\glsSetCompositor{.}\glsSetAlphaCompositor{-}
-

See

See §5 §5 Number lists for further information about number lists. - - - + +

-

4  

+

Top

4. Defining Glossary Entries

-

All glossary entries must be defined before they are used, +

All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this.14.1 -However only those entries that occur in the document (using any of the -commands described in §6 §6 Links to Glossary Entries, §7 Adding an Entry -to the Glossary Without Generating Text or §7 Adding an Entry to the Glossary +Without Generating Text or §8 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 §8 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 makeglossaries can be used to call +makeindexmakeindex 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 +class="cmtt-10">xindy, using a customised indexing style file, for each of the +glossaries that are defined in the document. Note that there should be for you to explicitly edit or input any of these external +class="cmbx-10">no need for you to explicitly edit or input any of these external files.2files.4.2 See §1.3 §1.3 Generating the Associated Glossary Files for further details. -

New glossary entries are defined using the command: -

\newglossaryentry 

New glossary entries are defined using the command: +

\newglossaryentry  \newglossaryentry{<label>}{<key=value -list>}
-

+class="cmtt-10">\newglossaryentry{<label>}{<key=value list>} +

+

This is a short command, so values in <key-val list> can’t contain any -paragraph breaks. If you have a long description that needs to span -multiple paragraphs, use -

\longnewglossaryentry <key-val list> can’t contain any paragraph +breaks. If you have a long description that needs to span multiple paragraphs, +use +

\longnewglossaryentry  \longnewglossaryentry{<label>}{<key=value -list>}{<long description>}
-

+class="cmtt-10">\longnewglossaryentry{<label>}{<key=value +list>}{<long description>}

+

instead. Note that, unlike \newglossaryentry, the command -\longnewglossaryentry may only be used in the preamble. Be -careful of unwanted spaces. \longnewglossaryentry will remove -trailing spaces in the description (via \unskip) but won’t remove -leading spaces (otherwise it would interfere with commands like -\Glsentrydesc). -

There are also commands that will only define the entry if it hasn’t -already been defined: -

+

and -

\longprovideglossaryentry 

\longprovideglossaryentry  -

\longprovideglossaryentry{<label>}{<key=value list>}{<long -description>}
- - - -

+

\longprovideglossaryentry{<label>}{<key=value list>}{<long +description>}
+

(These are both preamble-only commands.) -

For all the above commands, the first argument, <label>, must be -a unique label with which to identify this entry. This can’t contain any -non-expandable commands or active characters. -

Note that although an accented character or other non-Latin -character, such as é or ß, looks like a plain character in your .tex file, -it’s actually a macro (an active character) and therefore can’t be -used in the label. Also be careful of babel’s options that change -certain punctuation characters (such as : or -) to active characters. -
-

-

The second argument, <key=value list>, is a <key>=<value> list that -supplies the relevant information about this entry. There are two required -fields: description and either name

For all the above commands, the first argument, <label>, must be a unique label +with which to identify this entry. This can’t contain any non-expandable commands or +active characters. + + +

Note that although an accented character or other non-Latin character, such as é +or ß, looks like a plain character in your .tex file, it’s actually a macro (an active +character) and therefore can’t be used in the label. Also be careful of babel’s options +that change certain punctuation characters (such as : or -) to active characters. +
+

+

The second argument, <key=value list>, is a <key>=<value> list that supplies +the relevant information about this entry. There are two required fields: description +and either name or parent. Available fields are listed -below: +class="cmss-10">parent. Available fields are listed below:

namename
The name of the entry (as it will appear in the glossary). If this - key is omitted and the parent key is supplied, this value will be - the same as the parent’s name. +class="description">The name of the entry (as it will appear in the glossary). If this key is + omitted and the parent key is supplied, this value will be the same as the + parent’s name.
descriptiondescription
A brief description of this term (to appear in the glossary). - Within this value, you can use -

\nopostdesc A brief description of this term (to appear in the glossary). Within this + value, you can use +

\nopostdesc  \nopostdesc
-

- to suppress the description terminator for this entry. For example, if - this entry is a parent entry that doesn’t require a description, you - can do description={\nopostdesc}. If you want a paragraph break - in the description use -

\glspar  \glspar
+class="cmtt-10">\nopostdesc

+ to suppress the description terminator for this entry. For example, if this + entry is a parent entry that doesn’t require a description, you can do + description={\nopostdesc}. If you want a paragraph break in the description + use +

\glspar  \glspar
+

or, better, use \longnewglossaryentry. However, note that not all - glossary styles support multi-line descriptions. If you are using - one of the tabular-like glossary styles that permit multi-line - descriptions, use \newline\longnewglossaryentry. However, note that not all glossary + styles support multi-line descriptions. If you are using one of the tabular-like + glossary styles that permit multi-line descriptions, use \newline not \\ if you want to force a line - break. +class="cmtt-10">\\ if you + want to force a line break.

parentparent
The label of the parent entry. Note that the parent entry must be - defined before its sub-entries. See The label of the parent entry. Note that the parent entry must be defined + before its sub-entries. See §4.5 Sub-Entries for further - details. - - - +class="cmsy-10">§4.5 Sub-Entries for further details.
descriptionpluraldescriptionplural
The plural form of the description, if required. If - omitted, the value is set to the same as the descriptionThe plural form of the description, if required. If omitted, the value + is set to the same as the description key.
texttext
How this entry will appear in the document text when using \gls (or - one of its upper case variants). If this field is omitted, the value of the - name key is used. +class="cmtt-10">\gls (or one of its + upper case variants). If this field is omitted, the value of the name key is + used.
firstfirst
How the entry will appear in the document text on first use with - \gls (or one of its upper case variants). If this field is omitted, the - value of the textfirst use with \gls (or + one of its upper case variants). If this field is omitted, the value of + + + the text key is used. Note that if you use \glspl\glspl, \Glspl, +class="cmtt-10">\Glspl, \GLSpl, \GLSpl, \glsdisp\glsdisp before using \gls\gls, the firstplural value won’t be - used with \glsfirstplural value won’t be used with + \gls.
pluralplural
How the entry will appear in the document text when using \glspl - (or one of its upper case variants). If this field is omitted, the value is - obtained by appending \glspluralsuffix\glspl (or one of + its upper case variants). If this field is omitted, the value is obtained by + appending \glspluralsuffix to the value of the text - field. The default value of \glspluralsuffix is the letter - “s”. +class="cmss-10">text field. The default value of + \glspluralsuffix is the letter “s”.
firstpluralfirstplural
How the entry will appear in the document text on first - use with \glspl (or one of its upper case variants). If this field is - omitted, the value is obtained from the pluralfirst use with \glspl + (or one of its upper case variants). If this field is omitted, the value is + obtained from the plural key, if the first key is - omitted, or by appending \glspluralsuffixfirst key is omitted, or by appending + \glspluralsuffix to the value of the first - field, if the first field is present. Note that if you use \glsfirst field, if the first field is present. Note + that if you use \gls, \Gls, - \GLS\Gls, \GLS, \glsdisp before using \glspl\glsdisp before using \glspl, the firstplural value won’t be - used with \glsplfirstplural + value won’t be used with \glspl. -

Note: prior to version 1.13, the default value of firstplural

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 pluralfirst key, which meant that you had + to specify both plural and firstpluralfirstplural, even if you hadn’t used the firstfirst key.

symbolsymbol
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 symbol. +class="description">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 + symbol.
symbolpluralsymbolplural
This is the plural form of the symbol (as passed to +class="description">This is the plural form of the symbol (as passed to \glsdisplay and \glsdisplay and \glsdisplayfirst\glsdisplayfirst by \glspl\glspl, \Glspl and - \GLSpl). If omitted, the value is set to the same as the symbol - key. - - - +class="cmtt-10">\Glspl and \GLSpl). If omitted, the value is set + to the same as the symbol key.
sortsort
This value indicates how makeindexmakeindex or xindy should sort this entry. If - omitted, the value is given by the name field unless one of the - package options sort=def and sort=use have been used. In general, - it’s best to use the sort key if the name contains commands - (e.g. \ensuremath{\alpha}). You can also override the sort - key by redefining \glsprestandardsortxindy should sort this entry. If omitted, + the value is given by the name field unless one of the package options sort=def + and sort=use have been used. In general, it’s best to use the sort key if the + name contains commands (e.g. \ensuremath{\alpha}). You can also + override the sort key by redefining \glsprestandardsort (see §2.4 §2.4 Sorting Options).
typetype
This specifies the label of the glossary in which this entry belongs. If - omitted, the default glossary is assumed unless \newacronym is used - (see This specifies the label of the glossary in which this entry belongs. If omitted, + the default glossary is assumed unless \newacronym is used (see §13 §13 + Acronyms).
user1user1, …, user6, …, user6
Six keys provided for any additional information the user - may want to specify. (For example, an associated dimension or - an alternative plural or some other grammatical construct.) - Alternatively, you can add new keys using \glsaddkeySix keys provided for any additional information the user may want + to specify. (For example, an associated dimension or an alternative plural or + + + some other grammatical construct.) Alternatively, you can add new keys using + \glsaddkey (see §4.3 - Additional Keys). Other keys are also provided by the glossaries-prefix - (§4.3 Additional Keys). Other keys are also provided by the + glossaries-prefix (§18 §17 Prefixes or Determiners) and glossaries-accsuppglossaries-accsupp (§19 Accessibility - Support) packages. +class="cmsy-10">§18 + Accessibility Support) packages.
nonumberlistnonumberlist
A boolean key. If the value is missing or is true, this will - suppress the true, this will suppress the + number list just for this entry. Conversely, if you have - used the package option nonumberlist just for this entry. Conversely, if you have used the package option + nonumberlist, you can activate the number - list just for this entry with nonumberlist=falsenumber list just for this entry with + nonumberlist=false. (See §5 Number - lists.) +class="cmsy-10">§5 Number lists.)
seesee
Cross-reference another entry. Using 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 tag in square brackets before the label. For - example see=[see also]{anotherlabel}. Note that if you +class="cmss-10">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 tag in square brackets before the + label. For example see=[see also]{anotherlabel}. Note that if have suppressed the you have suppressed the number listnumber list, the cross-referencing +class="cmbx-10">, the cross-referencing information won’t appear in the glossary, as it forms part of +class="cmbx-10">information won’t appear in the glossary, as it forms part of the the number listnumber list. You can override this for individual glossary - entries using nonumberlist=false (see above). Alternatively, you can - use the seeautonumberlist. You can override this for individual glossary entries + using nonumberlist=false (see above). Alternatively, you can use the + seeautonumberlist package option. For further details, see §8 - Cross-Referencing Entries. -

\makeglossaries must be used before any occurrence of - \newglossaryentry that contains the see§8 Cross-Referencing + Entries. +

\makeglossaries must be used before any occurrence of \newglossaryentry + that contains the see key.
- - - -

+

-

The following keys are reserved for \newacronym

The following keys are reserved for \newacronym (see §13 Acronyms): +class="cmsy-10">§13 Acronyms): long, long, longplurallongplural, shortshort and shortplural. Additional keys are provided by the -glossaries-prefix (shortplural. Additional keys are provided by the glossaries-prefix +(§18 §17 Prefixes or Determiners) and the glossaries-accsupp -(glossaries-accsupp (§19 Accessibility Support) packages. You can also define your own custom -keys (see §18 Accessibility Support) +packages. You can also define your own custom keys (see §4.3 Additional Keys). -

Note that if the name starts with an accented letter or other non-Latin -character, you must group the character, otherwise it will cause a problem -for commands like \Gls§4.3 Additional +Keys). +

Note that if the name starts with an accented letter or other non-Latin character, +you must group the character, otherwise it will cause a problem for commands like +\Gls and \Glspl\Glspl. For example: - - - + +

-
+
\newglossaryentry{elite}{name={{\’e}lite},  
description={select group or class}}
-

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

Note that in both of the above examples, you will also need to supply the sort key if +you are using makeindexmakeindex whereas xindy is usually able to sort -accented letters correctly. +class="cmtt-10">xindy is usually able to sort accented letters +correctly.

-

4.1  

Top

4.1 Plurals

-

You may have noticed from above that you can specify the plural form -when you define a term. If you omit this, the plural will be obtained by -appending -

\glspluralsuffix 

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  \glspluralsuffix
-

-to the singular form. This command defaults to the letter “s”. For -example: - - - +class="cmtt-10">\glspluralsuffix

+

+to 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}}
-

defines a new entry whose singular form is “cow” and plural form is -“cows”. However, if you are writing in archaic English, you may want to -use “kine” as the plural form, in which case you would have to -do: - - - +

defines a new entry whose singular form is “cow” and plural form is “cows”. However, +if you are writing in archaic English, you may want to use “kine” as the plural form, +in which case you would have to do: + +

-
+
\newglossaryentry{cow}{name=cow,plural=kine,  
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 for one of them and one of the user keys -to specify the other plural form. For example: - - - -

-
+

+

If you are writing in a language that supports multiple plurals (for a given term) +then use the plural key for one of them and one of the user keys to specify the other +plural form. For example: + + +

+
\newglossaryentry{cow}{%  
  name=cow,%  
  description={a fully grown female of any bovine animal  
               (plural cows, archaic plural kine)},%  
  user1={kine}}
-

You can then use \glspl{cow} to produce “cows” and \glsuseri{cow} -to produce “kine”. You can, of course, define an easy to remember -synonym. For example: - - - +

You can then use \glspl{cow} to produce “cows” and \glsuseri{cow} to +produce “kine”. You can, of course, define an easy to remember synonym. For +example: + +

-
+
\let\glsaltpl\glsuseri
-

Then you don’t have to remember which key you used to store the second -plural. Alternatively, you can define your own keys using \glsaddkey, -described in

Then you don’t have to remember which key you used to store the second plural. +Alternatively, you can define your own keys using \glsaddkey, described in §4.3 §4.3 +Additional Keys. -

If you are using a language that usually forms plurals by appending a +

If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix +class="cmtt-10">\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 pluralbefore 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 key -where necessary). -

+class="cmss-10">firstplural key where +necessary). +

-

Top

4.2  

Top

4.2 Other Grammatical Constructs

-

You can use the six user keys to provide alternatives, such as participles. -For example: - - - +

You can use the six user keys to provide alternatives, such as participles. For +example: + +

-
+
\let\glsing\glsuseri  
\let\glsd\glsuserii  
\newcommand*{\ingkey}{user1} @@ -6893,170 +6652,162 @@ For example:  
  }%  
}
-

With the above definitions, I can now define terms like this: - - - +

With the above definitions, I can now define terms like this: + +

-
+
\newword{play}{to take part in activities for enjoyment}  
\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using  
the legs}
-

and use them in the text: - - - +

and use them in the text: + +

-
+
Peter is \glsing{play} in the park today.  
Jane \glsd{play} in the park yesterday.  
Peter and Jane \glsd{run} in the park last week.
-

-

Alternatively, you can define your own keys using \glsaddkey, described -below in

+

Alternatively, you can define your own keys using \glsaddkey, described below in +§4.3 §4.3 Additional Keys. -

+

-

Top

4.3  

Top

4.3 Additional Keys

-

You can now also define your own custom keys using: -

\glsaddkey 

You can now also define your own custom keys using: +

\glsaddkey  \glsaddkey{<key>}{<default value>}{<no link -cs>}{<no link ucfirst cs>}{<link cs>}{<link ucfirst -cs>}{<link allcaps cs>}
-

+class="cmtt-10">\glsaddkey{<key>}{<default value>}{<no link cs>}{<no +link ucfirst cs>}{<link cs>}{<link ucfirst cs>}{<link allcaps cs>} +

+

where:

<key>
is the new key to use in \newglossaryentry (or similar - commands such as \longnewglossaryentry<key>
is the new key to use in \newglossaryentry (or similar commands such + as \longnewglossaryentry);
<default value>
is the default value to use if this key isn’t used in - an entry definition (this may reference the current entry label - via \glslabel, but you will have to switch on expansion via the - starred version of \glsaddkey and protect fragile commands); +class="cmmib-10"><default value>
is the default value to use if this key isn’t used in an entry + definition (this may reference the current entry label via \glslabel, but + you will have to switch on expansion via the starred version of \glsaddkey + and protect fragile commands);
<no link cs>
is the control sequence to use analogous to commands - like \glsentrytext<no link cs>
is the control sequence to use analogous to commands like + \glsentrytext;
<no link ucfirst cs>
is the control sequence to use analogous to - commands like \Glsentrytext<no link ucfirst cs>
is the control sequence to use analogous to commands + like \Glsentrytext; - - -
<link cs>
is the control sequence to use analogous to commands like - \glstext<link cs>
is the control sequence to use analogous to commands like \glstext;
<link ucfirst cs>
is the control sequence to use analogous to - commands like \Glstext<link ucfirst cs>
is the control sequence to use analogous to commands like + \Glstext; + +
<link allcaps cs>
is the control sequence to use analogous to - commands like \GLStext<link allcaps cs>
is the control sequence to use analogous to commands like + \GLStext.
-

The starred version of \glsaddkey switches on expansion for this -key. The unstarred version doesn’t override the current expansion -setting. +

The starred version of \glsaddkey switches on expansion for this key. The unstarred +version doesn’t override the current expansion setting. -

Example 3 (Defining Custom Keys) -

Suppose I want to define two new keys, ed and ing, that default to the -entry text followed by “ed” and “ing”, respectively. The default -value will need expanding in both cases, so I need to use the starred -form: - - - -

-
+

Suppose I want to define two new keys, ed and ing, that default to the entry text +followed by “ed” and “ing”, respectively. The default value will need expanding in +both cases, so I need to use the starred form: + + +

+
 % Define "ed" key:  
 \glsaddkey*  
  {ed}% key @@ -7076,12 +6827,11 @@ form:  
  {\Glsing}% command analogous to \Glstext  
  {\GLSing}% command analogous to \GLStext
-

Now I can define some entries: - - - +

Now I can define some entries: + +

-
+
 % No need to override defaults for this entry:  
 \newglossaryentry{jump}{name={jump},description={}}  
 % Need to override defaults on these entries: @@ -7094,88 +6844,84 @@ form:  
   ing={waddling},%  
   description={}}
-

-

These entries can later be used in the document: - - - +

+

These entries can later be used in the document: + +

-
+
The dog \glsed{jump} over the duck.  
The duck was \glsing{waddle} round the dog.  
The dog \glsed{run} away from the duck.
-

For a complete document, see the sample file

For a complete document, see the sample file sample-newkeys.tex. -

+class="cmtt-10">sample-newkeys.tex.

-

-

____________________________

-

+

+

____________________________

+

-

Top

4.4  

Top

4.4 Expansion

-

When you define new glossary entries expansion is performed by -default, except for the name

When you define new glossary entries expansion is performed by default, except for +the name, descriptiondescription, descriptionpluraldescriptionplural, symbol, -symbolpluralsymbol, symbolplural and sort keys (these keys all have expansion suppressed via -\glssetnoexpandfield). -

You can switch expansion on or off for individual keys using -

\glssetexpandfield sort keys (these keys +all have expansion suppressed via \glssetnoexpandfield). +

You can switch expansion on or off for individual keys using +

\glssetexpandfield  \glssetexpandfield{<field>}
-

+class="cmtt-10">\glssetexpandfield{<field>}

+

or -

\glssetnoexpandfield 

\glssetnoexpandfield  \glssetnoexpandfield{<field>}
-

+class="cmtt-10">\glssetnoexpandfield{<field>}

+

respectively, where <field> is the field tag corresponding to the key. In -most cases, this is the same as the name of the key except for those listed -in table 4.1. - - - -

<field> is the field tag corresponding to the key. In most cases, +this is the same as the name of the key except for those listed in table 4.1. +

+
+ + +

- - - -
Table 4.1: Key to Field Mappings
+ + +
Table 4.1: Key to Field Mappings
+class="cmbx-10">Field sortvalue +class="cmtt-10">firstpl +class="cmtt-10">desc +class="cmtt-10">descplural +class="cmtt-10">useri +class="cmtt-10">userii +class="cmtt-10">useriii +class="cmtt-10">useriv +class="cmtt-10">userv +class="cmtt-10">uservi +class="cmtt-10">longpl
Key Key Field
sort sort sortvalue
firstpluralfirstplural firstpl
descriptiondescription desc
descriptionpluraldescriptionplural descplural
user1user1 useri
user2user2 userii
user3user3 useriii
user4user4 useriv
user5user5 userv
user6user6 uservi
longplurallongplural longpl
shortpluralshortplural shortpl
+class="cmtt-10">shortpl
- - - -
-

Any keys that haven’t had the expansion explicitly set using -\glssetexpandfield or \glssetnoexpandfield are governed by -

\glsexpandfields 
+
+

Any keys that haven’t had the expansion explicitly set using \glssetexpandfield +or \glssetnoexpandfield are governed by +

\glsexpandfields  \glsexpandfields
-

+class="cmtt-10">\glsexpandfields

+

and -

\glsnoexpandfields 

\glsnoexpandfields  \glsnoexpandfields
-

-

If your entries contain any fragile commands, I recommend you switch -off expansion via \glsnoexpandfields. (This should be used before you -define the entries.) -

-

Top

4.5  \glsnoexpandfields

+

+

If your entries contain any fragile commands, I recommend you switch off +expansion via \glsnoexpandfields. (This should be used before you define the +entries.) +

+

Top

4.5 Sub-Entries

-

As from version 1.17, it is possible to specify sub-entries. These may be -used to order the glossary into categories, in which case the sub-entry will -have a different name to its parent entry, or it may be used to distinguish -different definitions for the same word, in which case the sub-entries will -have the same name as the parent entry. Note that not all glossary styles -support hierarchical entries and may display all the entries in a flat format. -Of the styles that support sub-entries, some display the sub-entry’s -name whilst others don’t. Therefore you need to ensure that you use -a suitable style. (See

As from version 1.17, it is possible to specify sub-entries. These may be used to +order the glossary into categories, in which case the sub-entry will have a +different name to its parent entry, or it may be used to distinguish different +definitions for the same word, in which case the sub-entries will have the +same name as the parent entry. Note that not all glossary styles support +hierarchical entries and may display all the entries in a flat format. Of the styles +that support sub-entries, some display the sub-entry’s name whilst others +don’t. Therefore you need to ensure that you use a suitable style. (See §15 Glossary Styles for a list of predefined -styles.) As from version 3.0, level 1 sub-entries are automatically -numbered in the predefined styles if you use the subentrycounter -package option (see §15 +Glossary Styles for a list of predefined styles.) As from version 3.0, level 1 +sub-entries are automatically numbered in the predefined styles if you use the +subentrycounter package option (see §2.3 §2.3 Glossary Appearance Options for further details). -

Note that the parent entry will automatically be added to the glossary if -any of its child entries are used in the document. If the parent entry is not -referenced in the document, it will not have a

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. Note -also that . Note also that makeindex has a restriction on the maximum sub-entry -depth. -

+class="cmtt-10">makeindex has a restriction +on the maximum sub-entry depth. +

-

Top

4.5.1  

Top

4.5.1 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

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. - - - -

Example 4 (Hierarchical Categories—Greek and Roman + + Mathematical Symbols) -

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: - - - +

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},  
description={\nopostdesc}}  
\newglossaryentry{romanletter}{name={Roman letters},  
description={\nopostdesc}}
-

-

Note that in this example, the category entries don’t need a description -so I have set the descriptions to \nopostdesc. This gives a blank -description and suppresses the description terminator. -

I can now define my sub-entries as follows: - - - -

-
+

+

Note that in this example, the category entries don’t need a description so I have +set the descriptions to \nopostdesc. This gives a blank description and suppresses the +description terminator. +

I can now define my sub-entries as follows: + + +

+
\newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},  
description={ratio of the circumference of a circle to  
the diameter}, @@ -7386,44 +7126,41 @@ description and suppresses the description terminator.  
description={Euler’s constant},  
parent=romanletter}
-

For a complete document, see the sample file

For a complete document, see the sample file sampletree.tex. -

+class="cmtt-10">sampletree.tex.

-

-

____________________________

-

+

+

____________________________

+

-

Top

4.5.2  

Top

4.5.2 Homographs

-

Sub-entries that have the same name as 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: - - - +

Sub-entries that have the same name as 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: + +

-
+
\newglossaryentry{glossary}{name=glossary,  
description={\nopostdesc},  
plural={glossaries}}
-

Again, the parent entry has no description, so the description terminator -needs to be suppressed using \nopostdesc

Again, the parent entry has no description, so the description terminator needs to be +suppressed using \nopostdesc. -

Now define the two different meanings of the word: - - - +

Now define the two different meanings of the word: + +

-
+
\newglossaryentry{glossarylist}{  
description={list of technical words},  
sort={1}, @@ -7433,42 +7170,40 @@ class="cmtt-10x-x-109">\nopostdescsort={2},  
parent={glossary}}
-

Note that if I reference the parent entry, the location will be added to the -parent’s

Note that if I reference the parent entry, the location will be 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 unless you are -using the sort=use, 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 unless you are using the sort=use or sort=def package options (see sort=def package +options (see §2.4 Sorting Options). -You can use the subentrycounter package option to automatically number -the first-level child entries. See §2.4 Sorting Options). You can use the subentrycounter package option to +automatically number the first-level child entries. See §2.3 Glossary Appearance Options for -further details. -

In the above example, the plural form for both of the child entries is the -same as the parent entry, so the 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: - - - +class="cmsy-10">§2.3 Glossary Appearance +Options for further details. +

In the above example, the plural form for both of the child entries is the same as +the parent entry, so the 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: + +

-
+
\newglossaryentry{bravo}{name={bravo},  
description={\nopostdesc}}  
\newglossaryentry{bravocry}{description={cry of approval @@ -7482,65 +7217,61 @@ be specified. For example:  
plural={bravoes},  
parent=bravo}
-

-

+

+

-

Top

4.6  

Top

4.6 Loading Entries From a File

-

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

\loadglsentries 

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

\loadglsentries  \loadglsentries[<type>]{<filename>} -
-

+class="cmtt-10">\loadglsentries[<type>]{<filename>}

+

where <filename> is the name of the file containing all the \newglossaryentry -or \longnewglossaryentry 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 been omitted (or, -more specifically, for those entries whose type has been specified -by \glsdefaulttype<filename> is the name of the file containing all the \newglossaryentry or +\longnewglossaryentry 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 been omitted (or, more specifically, for those entries whose type has been +specified by \glsdefaulttype, which is what \newglossaryentry\newglossaryentry uses by default). -

Example 5 (Loading Entries from Another File) -

Suppose I have a file called myentries.tex which contains: - - - +

Suppose I have a file called myentries.tex which contains: + +

-
+
\newglossaryentry{perl}{type=main,  
name={Perl},  
description={A scripting language}} @@ -7550,814 +7281,816 @@ class="cmtt-10x-x-109">myentries.tex which contains:  
name={html},  
description={A mark up language}}
-

and suppose in my document preamble I use the command: - - - +

and suppose in my document preamble I use the command: + +

-
+
\loadglsentries[languages]{myentries}
-

then this will add the entries tex and html to the glossary whose type is -given by languages, but the entry perl will be added to the main -glossary, since it explicitly sets the type to main.

+

then this will add the entries tex and html to the glossary whose type is given by +languages, but the entry perl will be added to the main glossary, since it explicitly +sets the type to main.

-

-

____________________________

-

Note: if you use \newacronym

+

____________________________

+

Note: if you use \newacronym (see §13 §13 Acronyms) the type is set as type=\acronymtype unless you explicitly override it. For example, if my -file myacronyms.tex contains: - - - +class="cmtt-10">type=\acronymtype unless you explicitly override it. For example, if my file +myacronyms.tex contains: + +

-
+
\newacronym{aca}{aca}{a contrived acronym}
-

then (supposing I have defined a new glossary type called altacronym) - - - +

then (supposing I have defined a new glossary type called altacronym) + +

-
+
\loadglsentries[altacronym]{myacronyms}
-

will add aca to the glossary type acronym, if the package -option acronym has been specified, or will add aca to the -glossary type altacronym, if the package option acronym

will add aca to the glossary type acronym, if the package option acronym has been specified, +or will add aca to the glossary type altacronym, if the package option acronym is not specified.34.3 -

If you have used the acronym package option, there are two possible -solutions to this problem: +

If you have used the acronym package option, there are two possible solutions to +this problem:

  1. Change myacronyms.tex so that entries are defined in the - form: - - - +class="cmtt-10">myacronyms.tex so that entries are defined in the form: + +
    \newacronym[type=\glsdefaulttype]{aca}{aca}{a  
    contrived acronym}
    -

    and do: - - - +

    and do: + +

    \loadglsentries[altacronym]{myacronyms}
    -

    +

  2. Temporarily change \acronymtype to the target glossary: - - - +class="cmtt-10">\acronymtype to the target glossary: + +
    \let\orgacronymtype\acronymtype  
    \renewcommand{\acronymtype}{altacronym}  
    \loadglsentries{myacronyms}  
    \let\acronymtype\orgacronymtype
    -

-

Note that only those entries that have been used in the text will appear -in the relevant glossaries. Note also that \loadglsentries may only be -used in the preamble. -

+

+

Note that only those entries that have been used in the text will appear in the +relevant glossaries. Note also that \loadglsentries may only be used in the +preamble. +

Remember that you can use \provideglossaryentry rather than +\newglossaryentry. Suppose you want to maintain a large database of acronyms or +terms that you’re likely to use in your documents, but you may want to use a modified +version of some of those entries. (Suppose, for example, one document may +require a more detailed description.) Then if you define the entries using +\provideglossaryentry in your database file, you can override the definition by +simply using \newglossaryentry before loading the file. For example, suppose your +file (called, say, terms.tex) contains: + + +

+
+\provideglossaryentry{mallard}{name=mallard, + 
 description={a type of duck}} +
+

but suppose your document requires a more detailed description, you can +do: + + +

+
+\usepackage{glossaries} + 
\makeglossaries + 
\newglossaryentry{mallard}{name=mallard, + 
 description={a dabbling duck where the male has a green head}} + 
\loadglsentries{terms} +
+

Now the mallard definition in the terms.tex file will be ignored. +

-

Top

4.7  

Top

4.7 Moving Entries to Another Glossary

-

As from version 3.02, you can move an entry from one glossary to another +

As from version 3.02, you can move an entry from one glossary to another using: -

\glsmoveentry 

\glsmoveentry  \glsmoveentry{<label>}{<target glossary -label>}
-

+class="cmtt-10">\glsmoveentry{<label>}{<target glossary label>} +

+

where <label> is the unique label identifying the required entry and -<target glossary label> is the unique label identifying the glossary in which -to put the entry. -

Note that no check is performed to determine the existence of the target -glossary. This means that you can, for example, move an entry to an -undefined glossary so you can use the entry in the document text but not -have it listed in any of the glossaries. (Maybe you have an acronym that is -so common it doesn’t need listing.) -

If you move an entry to an undefined glossary and you have -hyperlinked entries, the link will point to an undefined target. (Unless you -identify that glossary using nohypertypes<label> is the unique label identifying the required entry and <target +glossary label> is the unique label identifying the glossary in which to put the +entry. +

Note that no check is performed to determine the existence of the target glossary. +This means that you can, for example, move an entry to an undefined glossary so you +can use the entry in the document text but not have it listed in any of the +glossaries. (Maybe you have an acronym that is so common it doesn’t need +listing.) +

If you move an entry to an undefined glossary and you have hyperlinked entries, +the link will point to an undefined target. (Unless you identify that glossary +using nohypertypes or \GlsDeclareNoHyperList, -as described in \GlsDeclareNoHyperList, as described in §6 Links to Glossary Entries.) Also, you will get -warnings about no file defined for that glossary (unless you use the -nowarn package option). Unpredictable results may occur if you -move an entry to a different glossary from its parent or children. +class="cmsy-10">§6 Links to +Glossary Entries.) Also, you will get warnings about no file defined for that +glossary (unless you use the nowarn package option). Unpredictable results may +occur if you move an entry to a different glossary from its parent or children.
-

- - - -

+

+

-

Top

4.8  

Top

4.8 Drawbacks With Defining Entries in the Document Environment

-

Originally, \newglossaryentry

Originally, \newglossaryentry (and \newacronym) could only be used in -the preamble. I reluctantly removed this restriction in version 1.13, but -there are issues with defining commands in the document\newacronym) could only be used in the +preamble. I reluctantly removed this restriction in version 1.13, but there are +issues with defining commands in the document environment -instead of the preamble. -

+ id="dx1-33004"> environment instead of the +preamble. +

-

Top

4.8.1  

Top

4.8.1 Technical Issues

-

+

  1. If you define an entry mid-way through your document, but - subsequently shuffle sections around, you could end up using an - entry before it has been defined. + class="enumerate" id="x1-34002x1">If you define an entry mid-way through your document, but subsequently + shuffle sections around, you could end up using an entry before it has been + defined.
  2. Entry information is required when the glossary is displayed - using \printglossaryEntry information is required when the glossary is displayed using + \printglossary or \printglossaries. When either of - these commands occur at the start of the document, the entry - details are being looked up before the entry has been defined.
-

To overcome these problems, as from version 4.0 the glossaries package -modifies the definition of \newglossaryentry at the beginning of the -document\printglossaries. When either of these commands + occur at the start of the document, the entry details are being looked up + before the entry has been defined. +

To overcome these problems, as from version 4.0 the glossaries package modifies the +definition of \newglossaryentry at the beginning of the document environment so that the definitions are written to an external file -(\jobname.glsdefs) which is then read in at the start of the document -on the next run. The entry will then only be defined if it doesn’t -already exist. This means that the entry can now be looked up in -the glossary, even if the glossary occurs at the beginning of the + id="dx1-34008"> environment so +that the definitions are written to an external file (\jobname.glsdefs) which is then +read in at the start of the document on the next run. The entry will then only be +defined if it doesn’t already exist. This means that the entry can now be +looked up in the glossary, even if the glossary occurs at the beginning of the document. -

There are drawbacks to this mechanism: if you modify an entry -definition, you need a second run to see the effect of your modification; this -method requires an extra \newwrite, which may exceed TEX’s maximum -allocation; if you have very long entries, you could find unexpected line -breaks have been written to the temporary file. -

The last reason is why \longnewglossaryentry has the preamble-only -restriction, which I don’t intend to lift. - - - -

-

-

Top

4.8.2  

There are drawbacks to this mechanism: if you modify an entry definition, you +need a second run to see the effect of your modification; this method requires an extra +\newwrite, which may exceed TEX’s maximum allocation; if you have very long +entries, you could find unexpected line breaks have been written to the temporary +file. +

The last reason is why \longnewglossaryentry has the preamble-only restriction, +which I don’t intend to lift. +

+

+

Top

4.8.2 Good Practice Issues

-

The above section covers technical issues that can cause your document to -have compilation errors or produce incorrect output. This section focuses -on good writing practice. The main reason cited by users wanting to define -entries within the document

The above section covers technical issues that can cause your document to have +compilation errors or produce incorrect output. This section focuses on good writing +practice. The main reason cited by users wanting to define entries within the document environment rather than in the preamble is -that they want to write the definition as they type in their document text. -This suggests a “stream of consciousness” style of writing that may be -acceptable in certain literary genres but is inappropriate for factual -documents. -

When you write technical documents, regardless of whether it’s a PhD -thesis or an article for a journal or proceedings, you must plan what you -write in advance. If you plan in advance, you should have a fairly good idea -of the type of terminology that your document will contain, so while you -are planning, create a new file with all your entry definitions. If, while -you’re writing your document, you remember another term you need, -then you can switch over to your definition file and add it. Most -text editors have the ability to have more than one file open at a + id="dx1-35002"> +environment rather than in the preamble is that they want to write the definition as +they type in their document text. This suggests a “stream of consciousness” style of +writing that may be acceptable in certain literary genres but is inappropriate for + + +factual documents. +

When you write technical documents, regardless of whether it’s a PhD thesis or an +article for a journal or proceedings, you must plan what you write in advance. If you +plan in advance, you should have a fairly good idea of the type of terminology that +your document will contain, so while you are planning, create a new file with all +your entry definitions. If, while you’re writing your document, you remember +another term you need, then you can switch over to your definition file and add +it. Most text editors have the ability to have more than one file open at a time. - - - + +

-

Top

5  

+

Top

5. Number lists

- Each entry in the glossary has an associated

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 . By default, these +numbers refer to the pages on which that entry has been used (using any of the +commands described in §6 §6 Links to Glossary Entries and §7 -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 number list is also referred to as the location +class="cmsy-10">§7 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 number list is also referred to as the location list. -

Both

Both makeindexmakeindex and xindy concatenate a sequence of 3 or more -consecutive pages into a range. With xindy concatenate a sequence of 3 or more consecutive pages +into a range. With xindy you can vary the minimum -sequence length using \GlsSetXdyMinRangeLengthxindy 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{<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.
-

-

With both

+

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

\glsSetSuffixF xindy, you can replace the separator and the closing +number in the range using: +

\glsSetSuffixF  \glsSetSuffixF{<suffix>}
-

-

\glsSetSuffixFF \glsSetSuffixF{<suffix>}
+

+

\glsSetSuffixFF  \glsSetSuffixFF{<suffix>}
-

-where the former command specifies the suffix to use for a 2 page -list and the latter specifies the suffix to use for longer lists. For -example: - - - -

-
+class="cmtt-10">\glsSetSuffixFF{<suffix>}
+

+where the former command specifies the suffix to use for a 2 page list and the latter +specifies the suffix to use for longer lists. For example: + + +

+
\glsSetSuffixF{f.}  
\glsSetSuffixFF{ff.}
-

Note that if you use

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: - - - +class="cmtt-10">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 work correctly. -For example: - - - -

-
+

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.}}  
\glsSetSuffixFF{\nohyperpage{ff.}}
-

-

Note that \glsSetSuffixF and \glsSetSuffixFF must be used before +

+

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

- - - +

+ +

-

6  

+

Top

6. Links to Glossary Entries

-

Once you have defined a glossary entry using \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

Once you have defined a glossary entry using \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 in this section also add a line to an -external file that is used by (even if there are no hyperlinks). The commands in this +section also add a line to an external file that is used by makeindexmakeindex or xindy to generate the relevant -entry in the glossary. This information includes an associated location that -is added to the xindy to +generate the relevant entry in the glossary. This information includes an 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 for that entry. By default, the location refers +to the page number. For further information on number lists, see §5 §5 Number lists. -

It is strongly recommended that you don’t use the commands -defined in this section in the arguments of sectioning or caption -commands or any other command that has a moving argument. -
-

-

The above warning is particularly important if you are using the -glossaries package in conjunction with the hyperref package. Instead, use -one of the commands listed in

It is strongly recommended that you don’t use the commands defined in this +section in the arguments of sectioning or caption commands or any other command +that has a moving argument.
+

+

The above warning is particularly important if you are using the glossaries package +in conjunction with the hyperref package. Instead, use one of the expandable +commands listed in §9 Using Glossary Terms Without Links -(such as \glsentrytext) or provide an alternative via the optional -argument to the sectioning/caption command. Examples: - - - -

-
+class="cmsy-10">§9 Using Glossary Terms Without Links (such as \glsentrytext +but not the non-expandable case changing versions like \Glsentrytext) or provide an +alternative via the optional argument to the sectioning/caption command. +Examples: + + +

+
\chapter{An overview of \glsentrytext{perl}}  
\chapter[An overview of Perl]{An overview of \gls{perl}}
-

-

If you want the link text to produce a hyperlink to the corresponding -entry details in the glossary, you should load the hyperref package before -the glossaries package. That’s what I’ve done in this document, so if you see -a hyperlinked term, such as

+

If you want the link text, you can click on the word or -phrase and it will take you to a brief description in this document’s -glossary. -

If you use the hyperref package, I strongly recommend you use pdflatex -rather than latex to compile your document, if possible. The DVI format -of LATEX has limitations with the hyperlinks that can cause a problem -when used with the glossaries package. Firstly, the DVI format can’t break -a hyperlink across a line whereas PDFLATEX can. This means that long -glossary entries (for example, the full form of an acronym) won’t be able to -break across a line with the DVI format. Secondly, the DVI format -doesn’t correctly size hyperlinks in subscripts or superscripts. This -means that if you define a term that may be used as a subscript or + id="dx1-37014"> to produce a hyperlink to the corresponding entry details +in the glossary, you should load the hyperref package before the glossaries package. +That’s what I’ve done in this document, so if you see a hyperlinked term, such as link +text, you can click on the word or phrase and it will take you to a brief description in +this document’s glossary. +

If you use the hyperref package, I strongly recommend you use pdflatex rather +than latex to compile your document, if possible. The DVI format of LATEX has +limitations with the hyperlinks that can cause a problem when used with the glossaries +package. Firstly, the DVI format can’t break a hyperlink across a line whereas +PDFLATEX can. This means that long glossary entries (for example, the full form of +an acronym) won’t be able to break across a line with the DVI format. Secondly, the +DVI format doesn’t correctly size hyperlinks in subscripts or superscripts. +This means that if you define a term that may be used as a subscript or superscript, if you use the DVI format, it won’t come out the correct size.
-

-

It may be that you only want terms in a certain glossary to have links, +

+

It may be that you only want terms in a certain glossary to have links, but not for another glossary. In which case, you can use the package option nohypertypes to identify the glossary lists that shouldn’t have hyperlinked -nohypertypes to identify the glossary lists that shouldn’t have hyperlinked link text. For example, suppose your document contains lots of -technical acronyms that the reader might not know, but it also contains -some very common acronyms that most readers will recognise. So -you might want two acronym lists, but only the technical list will -get displayed in your document. The technical acronyms can be -hyperlinked to that list, but common acronyms shouldn’t have hyperlinks -as there’s no target for them. In this case, identify the common -acronym list as having non-hyperlinked entries using nohypertypes. + id="dx1-37023">. +For example, suppose your document contains lots of technical acronyms +that the reader might not know, but it also contains some very common +acronyms that most readers will recognise. So you might want two acronym +lists, but only the technical list will get displayed in your document. The +technical acronyms can be hyperlinked to that list, but common acronyms +shouldn’t have hyperlinks as there’s no target for them. In this case, identify the +common acronym list as having non-hyperlinked entries using nohypertypes. Example: - - - + +

-
+
\usepackage[acronym,nohypertypes={common}]{glossaries}  
\newglossary{common}{cacr}{cacn}{Common Acronyms}
-

Alternatively, you can use -

\GlsDeclareNoHyperList  \GlsDeclareNoHyperList{<type>} -
-

+

Alternatively, you can use +

\GlsDeclareNoHyperList  \GlsDeclareNoHyperList{<type>}
+

For example: - - - + +

-
+
\usepackage[acronym]{glossaries}  
\newglossary{common}{cacr}{cacn}{Common Acronyms}  
\GlsDeclareNoHyperList{common}
-

Note that no check is performed to see if the glossary types listed in -nohypertypes or \GlsDeclareNoHyperList have been defined. -

The values must be fully expanded, so don’t try nohypertypes=\acronymtype -or \GlsDeclareNoHyperList{\acronymtype}. Also, avoid unnecessary -braces. For example, \GlsDeclareNoHyperList{{acronym},{common}} -won’t work. You do however need an enclosing brace for the whole list -when using the package option. So - - - -

-
+

Note that no check is performed to see if the glossary types listed in nohypertypes or +\GlsDeclareNoHyperList have been defined. +

The values must be fully expanded, so don’t try nohypertypes=\acronymtype or +\GlsDeclareNoHyperList{\acronymtype}. Also, avoid unnecessary braces. For +example, \GlsDeclareNoHyperList{{acronym},{common}} won’t work. You do +however need an enclosing brace for the whole list when using the package option. +So + + +

+
\usepackage[nohypertypes={acronym,common}]{glossaries}
-

is correct, but nohypertypes={{acronym},{common}} won’t work. -

-

-

You can override the effect of nohypertypes or \GlsDeclareNoHyperList -by explicitly setting the hyper option in commands such as \glslink or -\gls. -

The way the

is correct, but nohypertypes={{acronym},{common}} won’t work.

+

+

You can override the effect of nohypertypes or \GlsDeclareNoHyperList by +explicitly setting the hyper option in commands such as \glslink or \gls. +

The way the link text is displayed depends on -

\glstextformat  \glstextformat{<text>}
-

+ id="dx1-37030"> is displayed depends on +

\glstextformat  \glstextformat{<text>}
+

For example, to make all link text appear in a sans-serif font, do: - - - + id="dx1-37033"> appear in a sans-serif font, do: + +

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

Further customisation can be done via \defglsentryfmt or by redefining +

Further customisation can be done via \defglsentryfmt or by redefining \glsentryfmt. See \glsentryfmt. See §6.1 §6.1 Changing the format of the link text for further details. -

Each entry has an associated conditional referred to as the first use -flag. This determines whether \gls or \glspl (or their upper case -variants) should use the value of the first/firstplural or text/plural -keys. Note that an entry can be used without affecting the first use -flag (for example, when used with \glslink). See

Each entry has an associated conditional referred to as the first use flag. This +determines whether \gls or \glspl (or their upper case variants) should use the value +of the first/firstplural or text/plural keys. Note that an entry can be used without +affecting the first use flag (for example, when used with \glslink). See §14 Unsetting -and Resetting Entry Flags for commands that unset or reset this +class="cmsy-10">§14 +Unsetting and Resetting Entry Flags for commands that unset or reset this conditional. -

The command: -

\glslink  \glslink[<options>]{<label>}{<text>}
-

+

The command: +

\glslink  \glslink[<options>]{<label>}{<text>}
+

will place \glstextformat{<text>} in the document at that point and -add a line into the associated glossary file for the glossary entry given by -<label>. If hyperlinks are supported, <text> will be a hyperlink to the -relevant line in the glossary. (Note that this command doesn’t affect the -\glstextformat{<text>} in the document at that point and add a line into +the associated glossary file for the glossary entry given by <label>. If hyperlinks are +supported, <text> will be a hyperlink to the relevant line in the glossary. (Note that +this command doesn’t affect the first use flag: use \glsdisp instead.) The optional argument <options> -must be a <key>=<value> list which can take any of the following -keys: +class="cmtt-10">\glsdisp instead.) The optional +argument <options> must be a <key>=<value> list which can take any of the +following keys:

format
This specifies how to format the associated location number for - this entry in the glossary. This value is equivalent to the 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 with \index) the value needs to be the - name of a command without the initial backslash. As with +class="cmtt-10">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 beginning and ending of a number range. Again as with \index, the characters ( and ) can also be used to specify - the beginning and ending of a number range. Again as with +class="cmtt-10">\index, the command should be the name of a command which takes an + argument (which will be the associated location). Be careful not to use + a declaration (such as bfseries) instead of a text block command + (such as textbf) as the effect is not guaranteed to be localised. If you + want to apply more than one style to a given entry (e.g. bold and \index, the command should be the name of a command which - takes an argument (which will be the associated location). Be - careful not to use a declaration (such as bfseries) instead - of a text block command (such as textbf) as the effect is - not guaranteed to be localised. If you want to apply more - than one style to a given entry (e.g. bold and italic) you - will need to create a command that applies both formats, +class="cmti-10">italic) you will need to create a command that applies both formats, e.g.  - - - -
+ + +
\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
-

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 6.1. -

If you use

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 6.1. +

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

-
+
\GlsAddXdyAttribute{textbfem}
-

See

See §11 §11 Xindy for further details.

-

-

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 in

+

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 in §8 Cross-Referencing - Entries). -

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 number. - Instead, the glossaries package provides number formats listed in - table 6.1. -

§8 + Cross-Referencing Entries). +

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 number. Instead, the glossaries package + provides number formats listed in table 6.1. +

+
+

-
Table 6.1: Predefined Hyperlinked Location Formats
+
Table 6.1: Predefined Hyperlinked Location Formats
+class="cmtt-10">hypersl
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 slanted hyperlink slanted hyperlink
hyperup hyperup upright hyperlink
hypersc hypersc small caps hyperlink
hyperemph hyperemph emphasized hyperlink
-

Note that if the \hyperlink command hasn’t been defined, the +

+

Note that if the \hyperlink command hasn’t been defined, the hyper<xx> + formats are equivalent to the analogous text<xx> font commands (and hyper<xx> formats are equivalent to the analogous text<xx> font - commands (and hyperemph is equivalent to emph). If you want to - make a new format, you will need to define a command which takes - one argument and use that. For example, if you want the location - number to be in a bold sans-serif font, you can define a command - called, say, \hyperbsf: - - - +class="cmtt-10">hyperemph is equivalent to emph). If you want to make a new format, you will + need to define a command which takes one argument and use that. For example, + if you want the location number to be in a bold sans-serif font, you can define a + command called, say, \hyperbsf: + +

-
+
\newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
-

and then use hyperbsf as the value for the format key. (See - also “Displaying the glossary” in the documented code, - glossaries-code.pdf.) Remember that if you use

and then use hyperbsf as the value for the format key. (See also “Displaying + the glossary” in the documented code, glossaries-code.pdf.) Remember + that if you use xindy, you will - need to add this to the list of location attributes: - - - +class="cmtt-10">xindy, you will need to add this to the list of location + attributes: + +

-
+
\GlsAddXdyAttribute{hyperbsf}
-

+

counter
This specifies which counter to use for this location. This - overrides the default counter used by this entry. (See also counter
This specifies which counter to use for this location. This overrides the + default counter used by this entry. (See also §5 Number - lists.) +class="cmsy-10">§5 Number lists.)
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 +class="cmssbx-10">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 effect + if \hyperlink has not been defined.) The default value is hyper=true, unless + the entry belongs to a glossary that either has been listed in the package option hyper=true will have no effect if \hyperlink has not been defined.) - The default value is hyper=true, unless the entry belongs to - a glossary that either has been listed in the package option - nohypertypes or has been identified using \GlsDeclareNoHyperList - in which case the default is hyper=false. +class="cmss-10">nohypertypes or has been identified using \GlsDeclareNoHyperList in which + case the default is hyper=false.
local
This is a boolean key that only makes a different when used with - commands that change the entry’s local
This is a boolean key that only makes a different when used with commands + that change the entry’s first use flag (such as \gls). If +class="cmtt-10">\gls). If local=true, the change + to the first use flag will be localised to the current scope. The default is local=true, the change to the first use flag will be localised to the - current scope. The default is local=false. +class="cmtt-10">local=false.
-

There is also a starred version: -

\glslink*  \glslink*[<options>]{<label>}{<text>}
-

-which is equivalent to \glslink, except it sets hyper=false. Similarly, all -the following commands described in this section also have a starred -version that disables the hyperlink. -

Don’t use commands like \glslink or \gls in the <text> argument of -\glslink.
-

-

The command: -

\gls 

There is also a starred version: +

\glslink*  \gls[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\glslink*[<options>]{<label>}{<text>}

+

+which is equivalent to \glslink, except it sets hyper=false. Similarly, all the +following commands described in this section also have a starred version that disables +the hyperlink. +

Don’t use commands like \glslink or \gls in the <text> argument of \glslink. +
+

+

The command: +

\gls  \gls[<options>]{<label>}[<insert>]
+

is the same as \glslink, except that the \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. -

There are two upper case variants: -

\Gls  \Gls[<options>]{<label>}[<insert>]
-

-and -

\GLS  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. +

There are two upper case variants: + + +

\Gls  \GLS[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\Gls[<options>]{<label>}[<insert>]

+

+and +

\GLS  \GLS[<options>]{<label>}[<insert>]
+

which make the first letter of the link text or all the link text upper case, respectively. -

The final optional argument <insert>, allows you to insert some -additional text into the link text. By default, this will append <insert> at -the end of the link text, but this can be changed (see

The final optional argument <insert>, allows you to insert some additional text +into the link text. By default, this will append <insert> at the end of the +link text, but this can be changed (see §6.1 Changing the -format of the link text). -

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

Don’t use commands like \glslink or \gls in the <insert> argument -of \gls and its variants.
-

-

There are also analogous plural forms: -

\glspl  \glspl[<options>]{<label>}[<insert>]
-

-

\Glspl Â§6.1 Changing the format of the link +text). +

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

Don’t use commands like \glslink or \gls in the <insert> argument of \gls +and its variants.
+

+

There are also analogous plural forms: +

\glspl  \Glspl[<options>]{<label>}[<insert>]
-

-

+

+

\Glspl  \GLSpl[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\Glspl[<options>]{<label>}[<insert>]

+

+

\GLSpl  \GLSpl[<options>]{<label>}[<insert>]
+

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. -

Be careful when you use glossary entries in math mode especially if you -are using hyperref as it can affect the spacing of subscripts and -superscripts. For example, suppose you have defined the following -entry: - - - -

-
+class="cmss-10">plural and firstplural keys supplied when the +entry was first defined. As before, these commands also have a starred version that +disable the hyperlink. +

Be careful when you use glossary entries in math mode especially if you are using +hyperref as it can affect the spacing of subscripts and superscripts. For example, +suppose you have defined the following entry: + + +

+
\newglossaryentry{Falpha}{name={F_\alpha},  
description=sample}
-

and later you use it in math mode: - - - +

and later you use it in math mode: + +

-
+
$\gls{Falpha}^2$
-

This will result in Fα2 instead of Fα2. In this situation it’s best to bring -the superscript into the hyperlink using the final <insert> optional -argument: - - - -

-
+

This will result in Fα2 instead of Fα2. In this situation it’s best to bring the +superscript into the hyperlink using the final <insert> optional argument: + + +

+
$\gls{Falpha}[^2]$
-

-

-

Note that \glslink doesn’t use or affect the first use flag, nor -does it use \glsentryfmt or the equivalent definition provided by -\defglsentryfmt (see

+

+

Note that \glslink doesn’t use or affect the first use flag, nor does it use +\glsentryfmt or the equivalent definition provided by \defglsentryfmt (see §6.1 Changing the format of the link text). Instead, -you can use: -

\glsdisp  \glsdisp[<options>]{<label>}{<link text>} -
-

+class="cmsy-10">§6.1 +Changing the format of the link text). Instead, you can use: +

\glsdisp  \glsdisp[<options>]{<label>}{<link text>}
+

This behaves in the same way as \gls, except that it uses <link text> -instead of the value of the first or text key. (Note that this command always -sets <insert> to nothing.) This command affects the first use flag, -and uses \glsentryfmt or the equivalent definition provided by -\defglsentryfmt. -

The command: -

\glstext  \glstext[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\gls, except that it uses <link text> instead of the +value of the first or text key. (Note that this command always sets <insert> to +nothing.) This command affects the first use flag, and uses \glsentryfmt or the +equivalent definition provided by \defglsentryfmt. +

The command: +

\glstext  \glstext[<options>]{<label>}[<insert>]
+

is similar to \gls except that it always uses the value of the text key and -does not affect the \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 since \glstext doesn’t use -\glsentryfmt or the equivalent definition provided by \defglsentryfmt. -(The same is true for all the following commands described in the rest of -this section.) -

There are also analogous commands: -

\Glstext  \Glstext[<options>]{<text>}[<insert>]
-

-

\GLStext \gls, the inserted text <insert> is always appended to +the link text since \glstext doesn’t use \glsentryfmt or the equivalent definition +provided by \defglsentryfmt. (The same is true for all the following commands +described in the rest of this section.) +

There are also analogous commands: +

\Glstext  \GLStext[<options>]{<text>}[<insert>]
-

-As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLStext  \glsfirst[<options>]{<label>}[<insert>] -
-

+class="cmtt-10">\GLStext[<options>]{<text>}[<insert>]

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glsfirst  \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 affect the first use flag. -

There are also analogous commands: -

\Glsfirst  \Glsfirst[<options>]{<text>}[<insert>]
-

-

\GLSfirst \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: +

\Glsfirst  \GLSfirst[<options>]{<text>}[<insert>]
-

-As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLSfirst  \glsplural[<options>]{<label>}[<insert>] -
-

+class="cmtt-10">\GLSfirst[<options>]{<text>}[<insert>]

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: + + +

\glsplural  \glsplural[<options>]{<label>}[<insert>]
+

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. -

There are also analogous commands: -

\Glsplural  \Glsplural[<options>]{<text>}[<insert>] -
-

-

\GLSplural \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. +

There are also analogous commands: +

\Glsplural  \GLSplural[<options>]{<text>}[<insert>] -
-

-As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLSplural  \glsfirstplural[<options>]{<label>}[<insert>] +class="cmtt-10">\GLSplural[<options>]{<text>}[<insert>]
+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glsfirstplural  \glsfirstplural[<options>]{<label>}[<insert>]
-

+

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. -

There are also analogous commands: -

\Glsfirstplural  \Glsfirstplural[<options>]{<text>}[<insert>] +class="cmtt-10">\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. +

There are also analogous commands: +

\Glsfirstplural  \Glsfirstplural[<options>]{<text>}[<insert>]
-

-

\GLSfirstplural  \GLSfirstplural[<options>]{<text>}[<insert>] -
-

-As before, these commands also have a starred version that disable the -hyperlink. - - - -

The command: -

\glsname 

+

\GLSfirstplural  \glsname[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\GLSfirstplural[<options>]{<text>}[<insert>] +

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glsname  \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 of the link text and does -not mark the entry as having been used. -

There are also analogous commands: -

\Glsname  \Glsname[<options>]{<text>}[<insert>]
-

-

\GLSname \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. +

There are also analogous commands: +

\Glsname  \GLSname[<options>]{<text>}[<insert>]
-

-As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLSname  \glssymbol[<options>]{<label>}[<insert>] -
-

+class="cmtt-10">\GLSname[<options>]{<text>}[<insert>]

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glssymbol  \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 end of the link text and -does not mark the entry as having been used. -

There are also analogous commands: -

\Glssymbol  \Glssymbol[<options>]{<text>}[<insert>] -
-

-

\GLSsymbol \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. +

There are also analogous commands: +

\Glssymbol  \GLSsymbol[<options>]{<text>}[<insert>] -
-

-As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLSsymbol  \glsdesc[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\GLSsymbol[<options>]{<text>}[<insert>]

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glsdesc  \glsdesc[<options>]{<label>}[<insert>]
+

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. -

There are also analogous commands: -

\Glsdesc  \Glsdesc[<options>]{<text>}[<insert>]
-

-

\GLSdesc \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. +

There are also analogous commands: +

\Glsdesc  \GLSdesc[<options>]{<text>}[<insert>]
-

- - - -As before, these commands also have a starred version that disable the -hyperlink. -

The command: -

+

+

\GLSdesc  \glsuseri[<options>]{<label>}[<insert>] -
-

+class="cmtt-10">\GLSdesc[<options>]{<text>}[<insert>]

+

+As before, these commands also have a starred version that disable the hyperlink. +

The command: +

\glsuseri  \glsuseri[<options>]{<label>}[<insert>]
+

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

There are also analogous commands: -

\Glsuseri  \Glsuseri[<options>]{<text>}[<insert>]
-

-

\GLSuseri \glstext except that it always uses the value of the user1 key. Again, +<insert> is always appended to the end of the link text and does not mark the entry +as having been used. +

There are also analogous commands: +

\Glsuseri  \GLSuseri[<options>]{<text>}[<insert>]
-

-As before, these commands also have a starred version that disable the -hyperlink. Similarly for the other user keys: -

+

+

\GLSuseri  \glsuserii[<options>]{<text>}[<insert>] -
-

-

+

+As before, these commands also have a starred version that disable the hyperlink. +Similarly for the other user keys: +

\glsuserii  \Glsuserii[<options>]{<text>}[<insert>] -
-

-

+

+

\Glsuserii  \GLSuserii[<options>]{<text>}[<insert>] -
-

-

+

+

\GLSuserii  \glsuseriii[<options>]{<text>}[<insert>] -
-

-

+

+

\glsuseriii  \Glsuseriii[<options>]{<text>}[<insert>] -
-

-

+ + +

+

\Glsuseriii  \GLSuseriii[<options>]{<text>}[<insert>] -
-

-

+

+

\GLSuseriii  \glsuseriv[<options>]{<text>}[<insert>] -
- - - -

-

+

+

\glsuseriv  \Glsuseriv[<options>]{<text>}[<insert>] -
-

-

+

+

\Glsuseriv  \GLSuseriv[<options>]{<text>}[<insert>] -
-

-

+

+

\GLSuseriv  \glsuserv[<options>]{<text>}[<insert>]
-

-

+

+

\glsuserv  \Glsuserv[<options>]{<text>}[<insert>]
-

-

+

+

\Glsuserv  \GLSuserv[<options>]{<text>}[<insert>]
-

-

+

+

\GLSuserv  \glsuservi[<options>]{<text>}[<insert>] -
-

-

+

+

\glsuservi  \Glsuservi[<options>]{<text>}[<insert>] -
-

-

+

+

\Glsuservi  \GLSuservi[<options>]{<text>}[<insert>] -
-

-

-

6.1  \Glsuservi[<options>]{<text>}[<insert>]

+

+

\GLSuservi  \GLSuservi[<options>]{<text>}[<insert>]
+

+

+

Top

6.1 Changing the format of the link text

-

The format of the

The default format of the link text for \gls\gls, \glspl and their -upper case variants and also for \glsdisp\glspl and +their upper case variants and also for \glsdisp is governed by16.1: -

\glsentryfmt 

\glsentryfmt  \glsentryfmt
-

-If you want to redefine this command, you may use the following -commands within its definition: -

\glslabel \glsentryfmt
+

+This may be redefined but if you only want the change the display style for a given +glossary, then you need to use +

-

- - - -This is the label of the entry being referenced. -

\glscustomtext  \glscustomtext
-

-This is the custom text supplied in \glsdisp. It’s always empty for \gls\defglsentryfmt[<type>]{<definition>}

+ + +

+instead of redefining \glsentryfmt. The optional first argument <type> is the +glossary type. This defaults to \glsdefaulttype if omitted. The second argument is +the entry format definition. +

Note that \glsentryfmt is the default display format for entries. Once the display +format has been changed for an individual glossary using \defglsentryfmt, -\glspl and their upper case variants. (You can use etoolbox’s \ifdefempty -to determine if \glscustomtext is empty.) -

+

+

Within the <definition> argument of \defglsentryfmt, or if you want to redefine +\glsentryfmt, you may use the following commands: +

\glslabel  \glsinsert
-

-The custom text supplied in the final optional argument to \gls, \glspl -and their upper case variants. -

\glsifplural \glslabel
+

+This is the label of the entry being referenced. +

\glscustomtext  \glsifplural{<true text>}{<false text>} -
-

-If \glspl, \Glspl or \GLSpl was used, this command does <true text> -otherwise it does <false text>. -

\glscapscase  \glscapscase{<no case>}{<first uc>}{<all -caps>}
-

+class="cmtt-10">\glscustomtext

+

+This is the custom text supplied in \glsdisp. It’s always empty for \gls, \glspl and +their upper case variants. (You can use etoolbox’s \ifdefempty to determine if +\glscustomtext is empty.) +

\glsinsert  \glsinsert
+

+The custom text supplied in the final optional argument to \gls, \glspl and their +upper case variants. +

\glsifplural  \glsifplural{<true text>}{<false text>}
+

If \gls, \glspl or \glsdisp were used, this does <no case>. If \Gls or -\Glspl were used, this does <first uc>. If \GLS or \GLSpl were used, this +class="cmtt-10">\glspl, \Glspl or \GLSpl was used, this command does <true text> otherwise it does <all caps>. -

Note that you can also use commands such as \ifglsused within the -definition of \glsentryfmt (see <false text>. +

\glscapscase  \glscapscase{<no case>}{<first uc>}{<all caps>} +
+

+If \gls, \glspl or \glsdisp were used, this does <no case>. If \Gls or \Glspl +were used, this does <first uc>. If \GLS or \GLSpl were used, this does <all +caps>. +

Note that you can also use commands such as \ifglsused within the definition of +\glsentryfmt (see §14 Unsetting and Resetting Entry -Flags). -

If you only want to make minor modifications to \glsentryfmt, you can +class="cmsy-10">§14 Unsetting and Resetting Entry Flags). +

If you only want to make minor modifications to \glsentryfmt, you can use -

\glsgenentryfmt  \glsgenentryfmt
-

+

\glsgenentryfmt  \glsgenentryfmt
+

This uses the above commands to display just the first, text, plural or -firstplural keys (or the custom text) with the insert text appended. -

Alternatively, if want to change the entry format for acronyms (defined -via \newacronym) you can use: -

\glsgenacfmt  \glsgenacfmt
-

-This uses the values from the longfirst, text, short, longplural and shortplural keys, -rather than using the text, pluralplural or firstplural keys +(or the custom text) with the insert text appended. +

Alternatively, if want to change the entry format for acronyms (defined via + + +\newacronym) you can use: +

\glsgenacfmt  \glsgenacfmt
+

+This uses the values from the long, first and firstplural keys. The first use -singular text is obtained via: -

\genacrfullformat  \genacrfullformat{<label>}{<insert>} -
-

-instead of from the first key, and the first use plural text is obtained +class="cmss-10">short, longplural and shortplural keys, rather than +using the text, plural, first and firstplural keys. The first use singular text is obtained via: -

\genplacrfullformat  \genplacrfullformat{<label>}{<insert>} - - - -
-

+

\genacrfullformat  \genacrfullformat{<label>}{<insert>}
+

instead of from the firstplural key. In both cases, <label> is the entry’s label -and <insert> is the insert text provided in the final optional argument of -commands like \gls. The default behaviour is to do the long form (or -plural long form) followed by <insert> and a space and the short form (or -plural short form) in parentheses, where the short form is in the -argument of \firstacronymfont. There are also first letter upper case -versions: -

\Genacrfullformat  \Genacrfullformat{<label>}{<insert>} +class="cmss-10">first key, and the first use plural text is obtained via: +

\genplacrfullformat  \genplacrfullformat{<label>}{<insert>}
-

+

+instead of from the firstplural key. In both cases, <label> is the entry’s label and +<insert> is the insert text provided in the final optional argument of commands like +\gls. The default behaviour is to do the long form (or plural long form) followed by +<insert> and a space and the short form (or plural short form) in parentheses, where +the short form is in the argument of \firstacronymfont. There are also first letter +upper case versions: +

\Genacrfullformat  \Genacrfullformat{<label>}{<insert>}
+

and -

\Genplacrfullformat  \Genplacrfullformat{<label>}{<insert>} +

\Genplacrfullformat  \Genplacrfullformat{<label>}{<insert>}
-

-By default these perform a protected expansion on their no-case-change -equivalents and then use \makefirstuc to convert the first character to -upper case. If there are issues caused by this expansion, you will need to -redefine those commands to explicitly use commands like \Glsentrylong -(which is what the predefined acronym styles, such as long-short, -do). Otherwise, you only need to redefine \genacrfullformat and -\genplacrfullformat to change the behaviour of \glsgenacfmt. See

+By default these perform a protected expansion on their no-case-change equivalents +and then use \makefirstuc to convert the first character to upper case. If there are +issues caused by this expansion, you will need to redefine those commands to +explicitly use commands like \Glsentrylong (which is what the predefined +acronym styles, such as long-short, do). Otherwise, you only need to redefine +\genacrfullformat and \genplacrfullformat to change the behaviour of +\glsgenacfmt. See §13 -Acronyms for further details on changing the style of acronyms. -

Note that \glsentryfmt is not used by \glslink or any of the other -commands, such as \glstext.
-

+class="cmsy-10">§13 Acronyms for further details on changing the style of +acronyms. +

Note that \glsentryfmt is not used by \glslink or any of the other commands, +such as \glstext.
+

-

+

Example 6 (Custom Entry Display in Text) -

Suppose you want a glossary of measurements and units, you can use the -symbol key to store the unit: - - - -

-
+ id="x1-38057"> +

Suppose you want a glossary of measurements and 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 \glsentryfmt as follows: - - - -

-
+

and now suppose you want \gls{distance} to produce “distance (km)” on first use, +then you can redefine \glsentryfmt as follows: + + +

+
\renewcommand*{\glsentryfmt}{%  
  \glsgenentryfmt  
  \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%  
}
-

-

(Note that I’ve used \glsentrysymbol rather than \glssymbol to avoid -nested hyperlinks.) -

Note also that all of the

+

(Note that I’ve used \glsentrysymbol rather than \glssymbol to avoid nested +hyperlinks.) +

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

-
+ id="dx1-38064"> will be formatted according to \glstextformat +(described earlier). So if you do, say: + + +

+
\renewcommand{\glstextformat}[1]{\textbf{#1}}  
\renewcommand*{\glsentryfmt}{%  
  \glsgenentryfmt  
  \ifglsused{\glslabel}{}{\space(\glsentrysymbol{\glslabel})}%  
}
-

then \gls{distance} will produce “distance (km)”. -

For a complete document, see the sample file

then \gls{distance} will produce “distance (km)”. +

For a complete document, see the sample file sample-entryfmt.tex. +class="cmtt-10">sample-entryfmt.tex.

-

-

____________________________

-

If you have multiple glossaries, changing \glsentryfmt will change the -way entries for all of the glossaries appear when using the commands \gls, -\glspl, their upper case variants and \glsdisp. If you only want -the change to affect entries for a given glossary, then you need to -use -

\defglsentryfmt  \defglsentryfmt[<type>]{<definition>} -
-

-instead of redefining \glsentryfmt. The optional first argument <type> is -the glossary type. This defaults to \glsdefaulttype if omitted. The -second argument is the entry format definition. +

+

____________________________

-

Example 7 (Custom Format for Particular Glossary) -

Suppose you have created a new glossary called notation and you want -to change the way the entry is displayed on

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 do: - - - +href="#glo:firstuse">first use so that it includes the symbol, you can +do: + +

-
+
\defglsentryfmt[notation]{\glsgenentryfmt  
 \ifglsused{\glslabel}{}{\space  
   (denoted \glsentrysymbol{\glslabel})}}
-

Now suppose you have defined an entry as follows: - - - +

Now suppose you have defined an entry as follows: + +

-
+
\newglossaryentry{set}{type=notation,  
  name=set,  
  description={A collection of objects},  
  symbol={$S$}  
}
-

The

The first time you reference this entry it will be displayed as: “set -(denoted S)” (assuming \glsfirst time you reference this entry it will be displayed as: “set (denoted S)” +(assuming \gls was used). -

Alternatively, if you expect all the symbols to be set in math mode, you -can do: - - - +

Alternatively, if you expect all the symbols to be set in math mode, you can +do: + +

-
+
\defglsentryfmt[notation]{\glsgenentryfmt  
 \ifglsused{\glslabel}{}{\space  
   (denoted $\glsentrysymbol{\glslabel}$)}}
-

and define entries like this: - - - +

and define entries like this: + +

-
+
\newglossaryentry{set}{type=notation,  
  name=set,  
  description={A collection of objects},  
  symbol={S}  
}
-

+

-

-

____________________________

-

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. -

-

-

Top

6.2  

+

____________________________

+

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. +

+

+

Top

6.2 Enabling and disabling hyperlinks to glossary entries

-

If you load the hyperref

If you load the hyperref or htmlhtml packages prior to loading the glossaries -package, commands such as \glslinkglossaries 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 \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  \glsdisablehyper
-

+class="cmtt-10">\glsdisablehyper

+

and -

\glsenablehyper 

\glsenablehyper  \glsenablehyper
-

+class="cmtt-10">\glsenablehyper

+

respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper if the commands +class="cmtt-10">\glsenablehyper if the commands \hyperlink\hyperlink and \hypertarget have been defined (for example, by the -hyperref package). -

You can disable just the \hypertarget have been defined (for example, by the hyperref +package). +

You can disable just the first use links using the package option -hyperfirst=false. Note that this option only affects commands that recognise -the first use links using the package option hyperfirst=false. +Note that this option only affects commands that recognise the first use flag, for example \glsfirst use flag, for +example \gls, \glspl\glspl and \glsdisp but not -\glslink\glsdisp but not \glslink. - - - -

Example 8 (First Use With Hyperlinked Footnote -Description) (First Use With Hyperlinked Footnote Description) -

Suppose I want the first use to have a hyperlink to the description in a -footnote instead of hyperlinking to the relevant place in the glossary. First -I need to disable the hyperlinks on first use via the package option -hyperfirst=false

Suppose I want the first use to have a hyperlink to the description in a footnote +instead of hyperlinking to the relevant place in the glossary. First I need to disable the +hyperlinks on first use via the package option hyperfirst=false: - - - + +

-
+
\usepackage[hyperfirst=false]{glossaries}
-

Now I need to redefine \glsentryfmt

Now I need to redefine \glsentryfmt (see §6.1 Changing the format of -the link text): - - - +class="cmsy-10">§6.1 Changing the format of the link +text): + +

-
+
\renewcommand*{\glsentryfmt}{%  
  \glsgenentryfmt  
  \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%  
}
-

-

Now the first use won’t have hyperlinked text, but will be followed by a +

+

Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file sample-FnDesc.tex for a complete document. +class="cmtt-10">sample-FnDesc.tex for a complete document.

-

-

____________________________

-

Note that the hyperfirst option applies to all defined glossaries. It may be -that you only want to disable the hyperlinks on

+

____________________________

+

Note that the hyperfirst option applies to all defined glossaries. It may be that you +only want to disable the hyperlinks on first use for glossaries that -have a different form on first use. This can be achieved by noting that since -the entries that require hyperlinking for all instances have identical first -and subsequent text, they can be unset via \glsunsetallfirst use for glossaries that have a different form +on first use. This can be achieved by noting that since the entries that require +hyperlinking for all instances have identical first and subsequent text, they can be +unset via \glsunsetall (see §14 -Unsetting and Resetting Entry Flags) so that the hyperfirst option doesn’t -get applied. +class="cmsy-10">§14 Unsetting and Resetting Entry Flags) so that the +hyperfirst option doesn’t get applied. -

Example 9 (Suppressing Hyperlinks on First Use Just For Acronyms) -

Suppose I want to suppress the hyperlink on

Suppose I want to suppress the hyperlink on first use for acronyms but -not for entries in the main glossary. I can load the glossaries package -using: - - - +href="#glo:firstuse">first use for acronyms but not for +entries in the main glossary. I can load the glossaries package using: + +

-
+
\usepackage[hyperfirst=false,acronym]{glossaries}
-

Once all glossary entries have been defined I then do: - - - +

Once all glossary entries have been defined I then do: + +

-
+
\glsunsetall[main]
-

+

-

-

____________________________

-

For more complex requirements, you might find it easier to switch off all -hyperlinks via \glsdisablehyper and put the hyperlinks (where required) -within the definition of \glsentryfmt

+

____________________________

+

For more complex requirements, you might find it easier to switch off all hyperlinks +via \glsdisablehyper and put the hyperlinks (where required) within the definition +of \glsentryfmt (see §6.1 Changing the format of the -link text) via \glshyperlink (see §6.1 Changing the format of the link text) via \glshyperlink +(see §9 Using Glossary Terms Without -Links). +class="cmsy-10">§9 Using Glossary Terms Without Links). -

Example 10 (Only Hyperlink in Text Mode Not Math Mode) -

This is a bit of a contrived example, but suppose, for some reason, I only -want commands like \gls

This is a bit of a contrived example, but suppose, for some reason, I only want +commands like \gls and \glsdisp to have hyperlinks when used in -text mode, but not in math mode. I can do this by disabling all hyperlinks -and redefining \glsentryfmt\glsdisp to have hyperlinks when used in text mode, but +not in math mode. I can do this by disabling all hyperlinks and redefining +\glsentryfmt: - - - + +

-
+
\glsdisablehyper  
\renewcommand*{\glsentryfmt}{%  
  \ifmmode @@ -10401,174 +10071,166 @@ class="cmtt-10x-x-109">\glsentryfmt  \fi  
}
-

To ensure the target exists, the hyperlinks must be enabled again when -the glossary is displayed: - - - +

To ensure the target exists, the hyperlinks must be enabled again when the glossary +is displayed: + +

-
+
\renewcommand{\glossarypreamble}{\glsenablehyper}  
\renewcommand{\glossarypostamble}{\glsdisablehyper}
-

(The redefinition of \glossarypostamble is only necessary if the glossary -is displayed at the start of the document instead of at the end.) See the -sample file

(The redefinition of \glossarypostamble is only necessary if the glossary is +displayed at the start of the document instead of at the end.) See the sample file +sample-nomathhyper.tex for a complete document. -

+class="cmtt-10">sample-nomathhyper.tex for a complete document.

-

-

____________________________

- - - -

Top

7  

+

____________________________

+ + +

+

Top

7. Adding an Entry to the Glossary Without Generating Text

- It is possible to add a line in the glossary file without generating any -text at that point in the document using: -

+

This is similar to \glslink, only it doesn’t produce any text (so therefore, -there is no hyper\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<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 entry whose label is -given by set: - - - +class="cmtt-10">\glsadd). For example, to add a +page range to the glossary number list for the entry whose label is given by +set: + +

-
+
\glsadd[format=(]{set}  
Lots of text about sets spanning many pages.  
\glsadd[format=)]{set}
-

-

To add all entries that have been defined, use: -

\glsaddall 

+

To add all entries that have been defined, use: +

\glsaddall  \glsaddall[<options>]
-

+class="cmtt-10">\glsaddall[<options>]

+

The optional argument is the same as for \glsadd, except 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 the glossary type -\acronymtype) and a list of notation (specified by the glossary type -notation) then you can do: - - - +class="cmtt-10">\glsadd, except 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 the glossary type \acronymtype) and +a list of notation (specified by the glossary type notation) then you can +do: + +

-
+
\glsaddall[types={\acronymtype,notation}]
-

-

Note that \glsadd and \glsaddall add the current location to the -

+

Note that \glsadd and \glsaddall add the current location to the number list. In the case of \glsaddall, all entries in the glossary will have -the same location in the number list. If you want to use \glsaddall, it’s -best to suppress the number list with the nonumberlist package option. (See -sections . +In the case of \glsaddall, all entries in the glossary will have the same location in +the number list. If you want to use \glsaddall, it’s best to suppress the +number list with the nonumberlist package option. (See sections 2.3 and 5.)
-

-

There is now a variation of \glsaddall that skips any entries that have -already been used: -

\glsaddallunused 5.) +
+

+

There is now a variation of \glsaddall that skips any entries that have already +been used: +

\glsaddallunused  \glsaddallunused[<list>]
-

+class="cmtt-10">\glsaddallunused[<list>]

+

This command uses \glsadd[format=@gobble] which will ignore -this location in the number list. The optional argument <list> is a -comma-separated list of glossary types. If omitted, it defaults to the list of -all defined glossaries. +class="cmtt-10">\glsadd[format=@gobble] which will ignore this location in the +number list. The optional argument <list> is a comma-separated list of glossary +types. If omitted, it defaults to the list of all defined glossaries. -

Example 11 (Dual Entries) -

The example file

The example file sample-dual.tex makes use of \glsadd to allow for an -entry that should appear both in the main glossary and in the list of +class="cmtt-10">sample-dual.tex makes use of \glsadd to allow for +an entry that should appear both in the main glossary and in the list of acronyms. This example sets up the list of acronyms using the acronym -package option: - - - +class="cmss-10">acronym package +option: + +

-
+
\usepackage[acronym]{glossaries}
-

A new command is then defined to make it easier to define dual -entries: - - - +

A new command is then defined to make it easier to define dual entries: + +

-
+
\newcommand*{\newdualentry}[5][]{%  
  \newglossaryentry{main-#2}{name={#4},%  
  text={#3\glsadd{#2}},% @@ -10578,1363 +10240,1318 @@ entries:  
  \newacronym{#2}{#3\glsadd{main-#2}}{#4}%  
}
-

This has the following syntax:

+

This has the following syntax:

\newdualentry\newdualentry[<options>]{<label>}{<abbrv>}{<long>}{<description>} +class="cmtt-10">[<options>]{<label>}{<abbrv>}{<long>}{<description>}
You can then define a new dual entry: - - - -
+ + +
\newdualentry{svm}% label  
  {SVM}% abbreviation  
  {support vector machine}% long form  
  {Statistical pattern recognition technique}% description
-

Now you can reference the acronym with \gls{svm} or you can -reference the entry in the main glossary with \gls{main-svm}. -

+

Now you can reference the acronym with \gls{svm} or you can reference the entry in +the main glossary with \gls{main-svm}.

-

-

____________________________

- - - -

8  

+

____________________________

+ + +

+

Top

8. Cross-Referencing Entries

-

You must use \makeglossaries

You must use \makeglossaries before defining any cross-referenced -entries. If any of the terms that you have cross-referenced don’t appear in -the glossary, check that you have put \makeglossaries before all entry -definitions.
-

-

There are several ways of cross-referencing entries in the glossary: +class="cmti-10">before defining any cross-referenced +entries. If any of the terms that you have cross-referenced don’t appear in the +glossary, check that you have put \makeglossaries before all entry definitions. +

+

+

There are several ways of cross-referencing entries in the glossary:

  1. You can use commands such as \gls\gls in the entries description. For example: - - - -
    + + +
    \newglossaryentry{apple}{name=apple,  
    description={firm, round fruit. See also \gls{pear}}}
    -

    Note that with this method, if you don’t use the cross-referenced - term in the main part of the document, you will need two runs of -

    Note that with this method, if you don’t use the cross-referenced term in the + main part of the document, you will need two runs of makeglossariesmakeglossaries: - - - + +

    -
    +
    latex filename  
    makeglossaries filename  
    latex filename  
    makeglossaries filename  
    latex filename
    -

    +

  2. As described in §4 §4 Defining Glossary Entries, you can use the see key - when you define the entry. For example: - - - -
    +class="cmss-10">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 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

    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 §6 Links to Glossary Entries - or §6 Links + to Glossary Entries or §7 §7 Adding an Entry to the Glossary Without Generating Text. -

    The “see” tag is produce using \seename

    The “see” tag is produce using \seename, but can be overridden in specific instances using square brackets at the start of the see value. - For example: - - - +class="cmss-10">see value. For + example: + +

    -
    +
    \newglossaryentry{MaclaurinSeries}{name={Maclaurin  
    series},  
    description={Series expansion},  
    see=[see also]{TaylorsTheorem}}
    -

    +

  3. After you have defined the entry, use -

    \glssee 

    \glssee  \glssee[<tag>]{<label>}{<xr label list>} -
    -

    +class="cmtt-10">\glssee[<tag>]{<label>}{<xr label list>}

    +

    where <xr label list> is a comma-separated list of entry labels to be +class="cmmi-10"><xr label list> is a comma-separated list of entry labels to be cross-referenced, <label> is the label of the entry doing the - cross-referencing and <tag> is the “see” tag. (The default value of +class="cmmi-10"><label> is the label of the entry doing the cross-referencing and <tag> is \seename.) For example: - - - +class="cmmi-10"><tag> is the “see” tag. (The default value of <tag> is \seename.) For + example: + +

    -
    +
    \glssee[see also]{series}{FourierSeries,TaylorsTheorem}
    -

    Note that this automatically adds the entry given by <label> to the - glossary but doesn’t add the cross-referenced entries (specified by - <xr label list>) to the glossary.

-

In both cases 2 and 3 above, the cross-referenced information -appears in the

Note that this automatically adds the entry given by <label> to the glossary + but doesn’t add the cross-referenced entries (specified 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 -information appears in the description. (See the , whereas in case 1, the cross-referenced information appears +in the description. (See the sample-crossref.tex -example file that comes with this package.) This means that in -cases 2 and 3, the cross-referencing information won’t appear if -you have suppressed the sample-crossref.tex example file that comes +with this package.) This means that in cases 2 and 3, the cross-referencing +information won’t appear if you have suppressed the number list. In this case, you will need to -activate the . In this +case, you will need to activate the number list for the given entries using nonumberlist=false. -Alternatively, if you just use the see for the given entries using +nonumberlist=false. Alternatively, if you just use the see key instead of \glssee, you can -automatically activate the \glssee, you +can automatically activate the number list using the seeautonumberlistseeautonumberlist package option. -

You must use \makeglossaries

You must use \makeglossaries before the entry definitions containing -the see key and before any instances of \glssee or the entry won’t be -automatically added to the glossary.
-

-

-

8.1  before the entry definitions containing the see key +and before any instances of \glssee or the entry won’t be automatically added to the +glossary.

+

+

+

Top

8.1 Customising Cross-reference Text

-

When you use either the see

When you use either the see key or the command \glssee, the -cross-referencing information will be typeset in the glossary according -to: -

\glsseeformat \glssee, the cross-referencing +information will be typeset in the glossary according to: +

\glsseeformat  \glsseeformat[<tag>]{<label-list>}{<location>} +class="cmtt-10">\glsseeformat[<tag>]{<label-list>}{<location>}
-

+

The default definition of \glsseeformat is: -
\emph{<tag>} \glsseelist{<label-list>} -
+class="cmtt-10">\glsseeformat is: +
\emph{<tag>} \glsseelist{<label-list>} +
Note that the location is always ignored.18.1 For example, if you want the tag to appear in bold, you can do:28.2 - - - + +

-
+
\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1}  
 \glsseelist{#2}}
-

-

The list of labels is dealt with by \glsseelist, which iterates through -the list and typesets each entry in the label. The entries are separated -by -

+

or (for the last pair) -

\glsseelastsep 

\glsseelastsep  \glsseelastsep
-

+class="cmtt-10">\glsseelastsep

+

These default to “,\space” and “\space\andname,\space” and “\space\andname\space” respectively. -The list entry text is displayed using: -

\glsseeitemformat \space” respectively. The list entry +text is displayed using: +

\glsseeitemformat  \glsseeitemformat{<label>}
-

+class="cmtt-10">\glsseeitemformat{<label>}

+

This defaults to \glsentrytext\glsentrytext{<label>}.3{<label>}.8.3 For example, to make the cross-referenced list use small caps: - - - + +

-
+
\renewcommand{\glsseeitemformat}[1]{%  
  \textsc{\glsentrytext{#1}}}
-

-

You can use \glsseeformat

+

You can use \glsseeformat and \glsseelist in the main body of the -text, but they won’t automatically add the cross-referenced entries to -the glossary. If you want them added with that location, you can -do: - - - -

-
+class="cmtt-10">\glsseelist in the main body of the text, but +they won’t automatically add the cross-referenced entries to the glossary. If you want +them added with that location, you can do: + + +

+
Some information (see also  
\glsseelist{FourierSeries,TaylorsTheorem}%  
\glsadd{FourierSeries}\glsadd{TaylorsTheorem}).
-

-

- - - +

+

+ +

-

Top

9  

+

Top

9. 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

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 first use flag and, apart from \glshyperlink, they don’t -produce hyperlinks. -

Commands that aren’t expandable will be ignored by PDF bookmarks, -so you will need to provide an alternative via hyperreffirst use flag and, apart from +\glshyperlink, they don’t produce hyperlinks. +

Commands that aren’t expandable will be ignored by PDF bookmarks, so +you will need to provide an alternative via hyperref’s \texorpdfstring -if you want to use them in sectioning commands. (This isn’t specific to the +class="cmtt-10">\texorpdfstring if +you want to use them in sectioning commands. (This isn’t specific to the glossaries package.) See the hyperrefglossaries package.) See the hyperref documentation for further details. All the commands that convert the first letter to upper case aren’t expandable.
-

-

\glsentryname 

+

\glsentryname  \glsentryname{<label>}
-

-

+

+

\Glsentryname  \Glsentryname{<label>}
-

+class="cmtt-10">\Glsentryname{<label>}

+

These commands display the name of the glossary entry given by <label>, +class="cmmi-10"><label>, as specified by the namename key. \Glsentryname makes the first letter upper +class="cmtt-10">\Glsentryname makes the first letter upper case. Neither of these commands check for the existence of <label>. The -first form \glsentryname is expandable (unless the name contains -unexpandable commands). -

\glossentryname <label>. The first +form \glsentryname is expandable (unless the name contains unexpandable +commands). +

\glossentryname  \glossentryname{<label>}
-

+class="cmtt-10">\glossentryname{<label>}

+

This is like \glsnamefont{\glsentryname{<label>}} but also checks for -the existence of <label>. This command is not expandable. It’s used in the -predefined glossary styles, so if you want to change the way the name is -formatted in the glossary, you can redefine \glsnamefont to use the -required fonts. For example: - - - +class="cmtt-10">\glsnamefont{\glsentryname{<label>}} but also checks for the +existence of <label>. This command is not expandable. It’s used in the predefined +glossary styles, so if you want to change the way the name is formatted in +the glossary, you can redefine \glsnamefont to use the required fonts. For +example: + +

-
+
\renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}}
-

-

\Glossentryname 

+

\Glossentryname  \Glossentryname{<label>}
-

+class="cmtt-10">\Glossentryname{<label>}

+

This is like \glossentryname but makes the first letter of the name upper +class="cmtt-10">\glossentryname but makes the first letter of the name upper case. -

\glsentrytext 

\glsentrytext  \glsentrytext{<label>}
-

-

+

+

\Glsentrytext  \Glsentrytext{<label>}
-

-These commands display the subsequent use text for the glossary entry -given by <label>, as specified by the text\Glsentrytext{<label>}

+

+These commands display the subsequent use text for the glossary entry given by +<label>, as specified by the text key. \Glsentrytext makes the -first letter upper case. The first form is expandable (unless the text -contains unexpandable commands). The second form is not expandable. -Neither checks for the existence of <label>. -

\glsentryplural \Glsentrytext makes the first letter upper +case. The first form is expandable (unless the text contains unexpandable +commands). The second form is not expandable. Neither checks for the existence of +<label>. +

\glsentryplural  \glsentryplural{<label>}
-

-

\Glsentryplural \glsentryplural{<label>}
+

+

\Glsentryplural  \Glsentryplural{<label>}
-

-These commands display the subsequent use plural text for the glossary -entry given by <label>, as specified by the plural\Glsentryplural{<label>}

+

+These commands display the subsequent use plural text for the glossary entry given by +<label>, as specified by the plural key. \Glsentryplural -makes the first letter upper case. The first form is expandable (unless the -value of that key contains unexpandable commands). The second form is -not expandable. Neither checks for the existence of <label>. -

+

These commands display the first use text for the glossary entry given by -<label>, as specified by the firstfirst use text for the glossary entry given by <label>, as +specified by the first key. \Glsentryfirst makes the first letter -upper case. The first form is expandable (unless the value of that key -contains unexpandable commands). The second form is not expandable. -Neither checks for the existence of <label>. -

+

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 letter upper case. The first form is -expandable (unless the value of that key contains unexpandable -commands). The second form is not expandable. Neither checks for the -existence of <label>. -

\glsentrydesc first use text for the glossary entry + + +given by <label>, as specified by the firstplural key. \Glsentryfirstplural makes the +first letter upper case. The first form is expandable (unless the value of that key +contains unexpandable commands). The second form is not expandable. Neither +checks for the existence of <label>. +

\glsentrydesc  \glsentrydesc{<label>}
-

-

+

+

\Glsentrydesc  \Glsentrydesc{<label>}
-

-These commands display the description for the glossary entry given by -<label>. \Glsentrydesc makes the first letter upper case. The first form is -expandable (unless the value of that key contains unexpandable -commands). The second form is not expandable. Neither checks for the -existence of <label>. -

\glossentrydesc \Glsentrydesc{<label>}
+

+These commands display the description for the glossary entry given by <label>. +\Glsentrydesc makes the first letter upper case. The first form is expandable (unless +the value of that key contains unexpandable commands). The second form is not +expandable. Neither checks for the existence of <label>. +

\glossentrydesc  \glossentrydesc{<label>}
-

+class="cmtt-10">\glossentrydesc{<label>}

+

This is like \glsentrydesc{<label>} but also checks for the existence of -<label>. This command is not expandable. It’s used in the predefined -glossary styles to display the description. -

+

This is like \glossentrydesc but converts the first letter to upper case. -This command is not expandable. -

\glsentrydescplural \glossentrydesc but converts the first letter to upper case. This +command is not expandable. +

\glsentrydescplural  \glsentrydescplural{<label>}
-

-

\Glsentrydescplural \glsentrydescplural{<label>}
+

+

\Glsentrydescplural  \Glsentrydescplural{<label>}
-

+class="cmtt-10">\Glsentrydescplural{<label>}

+

These commands display the plural description for the glossary entry given by <label>. \Glsentrydescplural makes the first letter upper case. -The first form is expandable (unless the value of that key contains -unexpandable commands). The second form is not expandable. Neither -checks for the existence of <label>. -

\glsentrysymbol <label>. \Glsentrydescplural makes the first letter upper case. The +first form is expandable (unless the value of that key contains unexpandable +commands). The second form is not expandable. Neither checks for the existence of +<label>. +

\glsentrysymbol  \glsentrysymbol{<label>}
-

-

\Glsentrysymbol \glsentrysymbol{<label>}
+

+

\Glsentrysymbol  \Glsentrysymbol{<label>}
-

-These commands display the symbol for the glossary entry given by - - - -<label>. \Glsentrysymbol makes the first letter upper case. The first form -is expandable (unless the value of that key contains unexpandable -commands). The second form is not expandable. Neither checks for the -existence of <label>. -

\glossentrysymbol \Glsentrysymbol{<label>}
+

+These commands display the symbol for the glossary entry given by <label>. +\Glsentrysymbol makes the first letter upper case. The first form is expandable +(unless the value of that key contains unexpandable commands). The second form is +not expandable. Neither checks for the existence of <label>. +

\glossentrysymbol  \glossentrysymbol{<label>}
-

+class="cmtt-10">\glossentrysymbol{<label>}

+

This is like \glsentrysymbol{<label>} but also checks for the existence of -<label>. This command is not expandable. It’s used in the predefined -glossary styles to display the symbol. -

+

This is like \glossentrysymbol but converts the first letter to upper case. -This command is not expandable. -

\glsentrysymbolplural \glossentrysymbol but converts the first letter to upper case. This +command is not expandable. +

\glsentrysymbolplural  \glsentrysymbolplural{<label>} -
-

-

\Glsentrysymbolplural \glsentrysymbolplural{<label>}
+

+

\Glsentrysymbolplural  \Glsentrysymbolplural{<label>} -
-

+class="cmtt-10">\Glsentrysymbolplural{<label>}

+

These commands display the plural symbol for the glossary entry given by <label>. \Glsentrysymbolplural makes the first letter upper case. -The first form is expandable (unless the value of that key contains -unexpandable commands). The second form is not expandable. Neither -checks for the existence of <label>. -

\glsentryuseri <label>. \Glsentrysymbolplural makes the first letter upper case. The +first form is expandable (unless the value of that key contains unexpandable +commands). The second form is not expandable. Neither checks for the existence of +<label>. +

\glsentryuseri  \glsentryuseri{<label>}
-

-

\Glsentryuseri \glsentryuseri{<label>}
+

+

\Glsentryuseri  \Glsentryuseri{<label>}
-

-

\glsentryuserii \Glsentryuseri{<label>}
+

+

\glsentryuserii  \glsentryuserii{<label>}
-

-

\Glsentryuserii \glsentryuserii{<label>}
+

+

\Glsentryuserii  \Glsentryuserii{<label>}
-

-

\glsentryuseriii \Glsentryuserii{<label>}
+

+

\glsentryuseriii  \glsentryuseriii{<label>}
-

-

\Glsentryuseriii \glsentryuseriii{<label>}
+

+

\Glsentryuseriii  \Glsentryuseriii{<label>}
-

- - - -

+

+

\glsentryuseriv  \glsentryuseriv{<label>}
-

-

\Glsentryuseriv \glsentryuseriv{<label>}
+

+

\Glsentryuseriv  \Glsentryuseriv{<label>}
-

-

+

+

\glsentryuserv  \glsentryuserv{<label>}
-

-

\Glsentryuserv \glsentryuserv{<label>}
+

+

\Glsentryuserv  \Glsentryuserv{<label>}
-

-

\glsentryuservi \Glsentryuserv{<label>}
+

+

\glsentryuservi  \glsentryuservi{<label>}
-

-

\Glsentryuservi \glsentryuservi{<label>}
+ + +

+

\Glsentryuservi  \Glsentryuservi{<label>}
-

-These commands display the value of the user keys for the glossary entry -given by <label>. The lower case forms are expandable (unless the value of -the key contains unexpandable commands). The commands beginning with -an upper case letter convert the first letter of the required value to upper -case and are not expandable. None of these commands check for the -existence of <label>. -

+

+These commands display the value of the user keys for the glossary entry given +by <label>. The lower case forms are expandable (unless the value of the +key contains unexpandable commands). The commands beginning with an +upper case letter convert the first letter of the required value to upper case +and are not expandable. None of these commands check for the existence of +<label>. +

\glshyperlink  \glshyperlink[<link text>]{<label>}
-

-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 \glsentrytext\glshyperlink[<link text>]{<label>}

+

+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 \glsentrytext{<label>} by -default1{<label>} +by default9.1, 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 commands described in

If you use \glshyperlink, you need to ensure that the relevant entry has been +added to the glossary using any of the commands described in §6 -Links to Glossary Entries or §6 Links to Glossary +Entries or §7 Adding an Entry to the Glossary Without -Generating Text otherwise you will end up with an undefined link. -
-

-

The next two commands are only available with the savenumberlist -package option: -

\glsentrynumberlist Â§7 Adding an Entry to the Glossary Without Generating Text otherwise +you will end up with an undefined link.
+

+

The next two commands are only available with the savenumberlist package +option: +

\glsentrynumberlist  \glsentrynumberlist{<label>}
-

-

\glsdisplaynumberlist \glsentrynumberlist{<label>}
+

+

\glsdisplaynumberlist  \glsdisplaynumberlist{<label>} - - - -
-

+class="cmtt-10">\glsdisplaynumberlist{<label>}

+

Both display the number list for the entry given by <label> and require a -run of <label> and require a run of +makeglossariesmakeglossaries (or xindyxindy or makeindex) followed by one or -two runs of LATEX. The first command, \glsentrynumberlist, -simply displays the number list as is. The second command, -\glsdisplaynumberlist, formats the list using: -

\glsnumlistsep makeindex) followed by one or two runs of LATEX. The first +command, \glsentrynumberlist, simply displays the number list as is. The second command, +\glsdisplaynumberlist, formats the list using: +

\glsnumlistsep  \glsnumlistsep
-

+class="cmtt-10">\glsnumlistsep

+

as the separator between all but the last two elements and -

\glsnumlistlastsep 

\glsnumlistlastsep  \glsnumlistlastsep
-

+class="cmtt-10">\glsnumlistlastsep

+

between the final two elements. The defaults are ,␣ and ␣\&␣, respectively. -

\glsdisplaynumberlist is fairly experimental. It only works when the -default counter format is used (that is, when the format key is set to -glsnumberformat). This command also doesn’t work with hyperref. If you -try using it with that package, \glsentrynumberlist will be used instead. -
-

-

For further information see “Displaying entry details without -adding information to the glossary” in the documented code -(glossaries-code.pdf). - - - -

-

10  ,␣ and ␣\&␣, respectively. +

\glsdisplaynumberlist is fairly experimental. It only works when the default +counter format is used (that is, when the format key is set to glsnumberformat). This +command also doesn’t work with hyperref. If you try using it with that package, +\glsentrynumberlist will be used instead.
+

+

For further information see “Displaying entry details without adding information + + +to the glossary” in the documented code (glossaries-code.pdf). + + +

+

+

Top

10. Displaying a glossary

-

The command -

\printglossaries 

The command +

\printglossaries  \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 -\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 makeglossaries or +have directly used makeindexmakeindex or xindy (as described -in xindy (as described in §1.3 Generating the Associated Glossary Files). If the glossary still -does not appear after you re-LATEX your document, check the -§1.3 Generating the +Associated Glossary Files). If the glossary still does not appear after you +re-LATEX your document, check the makeindexmakeindex/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. -

An individual glossary can be displayed using: -

\printglossary 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. +

An individual glossary can be displayed using: +

\printglossary  \printglossary[<options>]
-

+class="cmtt-10">\printglossary[<options>]

+

where <options> is a <key>=<value> list of options. The following keys -are available: +class="cmmi-10"><options> is a <key>=<value> list of options. The following keys are +available:

typetype
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: - - - -
+class="description">The value of this key specifies which glossary to print. If omitted, the default + glossary is assumed. For example, to print the list of acronyms: + + +
\printglossary[type=\acronymtype]
-

+

titletitle
This is the glossary’s title (overriding the title specified when the - glossary was defined). +class="description">This is the glossary’s title (overriding the title specified when the glossary was + defined).
toctitletoctitle
This is the title to use for the table of contents (if the toc package - option has been used). It may also be used for the page header, - depending on the page style. If omitted, the value of title is - used. +class="cmss-10">toc package option has + been used). It may also be used for the page header, depending on the page + style. If omitted, the value of title is used.
stylestyle
This specifies which glossary style to use for this glossary, overriding - the effect of the styleThis specifies which glossary style to use for this glossary, overriding the effect of + the style package option or \glossarystyle\glossarystyle.
numberedsectionnumberedsection
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 option, described in 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 option, described in §2.2 Sectioning, Headings and TOC - Options. +class="cmsy-10">§2.2 Sectioning, + Headings and TOC Options.
nonumberlistnonumberlist
This is a boolean key. If true (nonumberlist=true) +class="cmtt-10">nonumberlist=true) the numberlist is suppressed for this glossary. If false (nonumberlist=false) the numberlist is displayed for this glossary. - If no value is supplied, true is assumed. +class="cmtt-10">nonumberlist=false) the numberlist is displayed for this glossary. If no value + is supplied, true is assumed.
-

By default, the glossary is started either by \chapter* or by -\section*, depending on whether or not \chapter is defined. -This can be overridden by the section

By default, the glossary is started either by \chapter* or by \section*, depending on +whether or not \chapter is defined. This can be overridden by the section package option or the \setglossarysection command. Numbered sectional units can be -obtained using the numberedsection package option. Each glossary sets the -page header via the command -

\glsglossarymark \setglossarysection command. Numbered sectional units can be obtained using the +numberedsection package option. Each glossary sets the page header via the +command +

\glsglossarymark  \glsglossarymark\glsglossarymark{<title>}
-

-If this mechanism is unsuitable for your chosen class file or page style -package, you will need to redefine \glsglossarymark. Further information - - - -about these options and commands is given in {<title>}

+

+If this mechanism is unsuitable for your chosen class file or page style package, you +will need to redefine \glsglossarymark. Further information about these options and +commands is given in §2.2 Sectioning, Headings -and TOC Options. -

Information can be added to the start of the glossary (after the title and -before the main body of the glossary) by redefining -

\glossarypreamble Â§2.2 Sectioning, Headings and TOC Options. +

Information can be added to the start of the glossary (after the title and before the +main body of the glossary) by redefining +

\glossarypreamble  \glossarypreamble
-

+class="cmtt-10">\glossarypreamble

+

For example: - - - + +

-
+
\renewcommand{\glossarypreamble}{Numbers in italic  
indicate primary definitions.}
-

This needs to be done before the glossary is displayed using -\printglossaries or \printglossary. -

If you want a different preamble per glossary you can use -

\setglossarypreamble 

This needs to be done before the glossary is displayed using +\printglossaries or \printglossary. +

If you want a different preamble per glossary you can use +

\setglossarypreamble  \setglossarypreamble[<type>]{<preamble -text>}
-

+class="cmtt-10">\setglossarypreamble[<type>]{<preamble text>} +

+

If <type> is omitted, \glsdefaulttype is used. -

For example: - - - -

-
+class="cmmi-10"><type> is omitted, \glsdefaulttype is used. +

For example: + + +

+
\setglossarypreamble{Numbers in italic  
indicate primary definitions.}
-

This will print the given preamble text for the main glossary, but not have -any preamble text for any other glossaries. -

There is an analogous command to \glossarypreamble called -

+

which is placed at the end of each glossary. -

Example 12 (Switch to Two Column Mode for Glossary) -

Suppose you are using the superheaderborder

Suppose you are using the superheaderborder style110.1, -and you want the glossary to be in two columns, but after the glossary you -want to switch back to one column mode, you could do: - - - +and you want the glossary to be in two columns, but after the glossary you want to +switch back to one column mode, you could do: + +

-
+
\renewcommand*{\glossarysection}[2][]{%  
  \twocolumn[{\chapter*{#2}}]%  
  \setlength\glsdescwidth{0.6\linewidth}% @@ -11942,771 +11559,729 @@ want to switch back to one column mode, you could do:  
}  
\renewcommand*{\glossarypostamble}{\onecolumn}
-

+

-

-

____________________________

-

Within each glossary, each entry name is formatted according -to -

+

Within each glossary, each entry name is formatted according to +

\glsnamefont  \glsnamefont{<name>}
-

-which takes one argument: 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\glsnamefont{<name>}

+

+which takes one argument: 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 the name is placed in the optional argument of \item, whereas in the tabular -styles (defined in the glossary-long\item, whereas in 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. +class="cmss-10">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. -

Example 13 (Changing the Font Used to Display Entry +class="cmbx-12"> (Changing the Font Used to Display Entry Names Names in the Glossary)in the Glossary) -

Suppose you want all the entry names to appear in medium weight small -caps in your glossaries, then you can do: - - - +

Suppose you want all the entry names to appear in medium weight small caps in +your glossaries, then you can do: + +

-
+
\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
-

+

-

-

____________________________

- - - -

11  

+

____________________________

+ + +

+

Top

11. Xindy

-

If you want to use

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

-
+
\usepackage[xindy]{glossaries}
-

This ensures that the glossary information is written in

This ensures that the glossary information is written in xindy -syntax. -

xindy syntax. +

§1.3 Generating the Associated Glossary Files covers how to use the -external §1.3 Generating the Associated Glossary 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 indexing application. This section covers the commands provided by the glossaries +package that allow you to adjust the xindy style file -(.xdyxindy style file (.xdy) and parameters. -

To assist writing information to the

To assist writing information to the xindyxindy style file, the glossaries -package provides the following commands: -

\glsopenbrace glossaries package provides +the following commands: +

\glsopenbrace  \glsopenbrace
-

-

\glsclosebrace \glsopenbrace
+

+

\glsclosebrace  \glsclosebrace
-

+class="cmtt-10">\glsclosebrace

+

which produce an open and closing brace. (This is needed because \{ and -\} don’t expand to a simple brace character when written to a -file.) -

In addition, if you are using a package that makes the double quote -character active (e.g. ngerman\{ and \} don’t +expand to a simple brace character 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: -

\glsquote 

\glsquote  \glsquote{<text>}
-

+class="cmtt-10">\glsquote{<text>}

+

which will produce "<text>". Alternatively, you can use \string" to write -the double-quote character. This document assumes that the double quote -character has not been made active, so the examples just use " for -clarity. -

If you want greater control over the "<text>". Alternatively, you can use \string" to write the +double-quote character. This document assumes that the double quote character has +not been made active, so the examples just use " for clarity. +

If you want greater control over the xindy style file than is available -through the LATxindy style file than is available through the +LATEX commands provided by the glossaries package, you -will need to edit the glossaries package, you will need to edit the xindy style file. In which case, you must use \noist -to prevent the style file from being overwritten by the glossaries package. -For additional information about xindy +style file. In 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, read +the xindy documentation. -I’m sorry I can’t provide any assistance with writing xindy documentation. I’m sorry I can’t provide any assistance with writing xindy style files. -If you need help, I recommend you ask on the xindy +style files. If you need help, I recommend you ask on the xindyxindy mailing list (http://xindy.sourceforge.net/mailing-list.html). +class="cmtt-10">http://xindy.sourceforge.net/mailing-_list.html).

-

11.1  

Top

11.1 Language and Encodings

-

When you use

When you use xindy, you need to specify the language and encoding used -(unless you have written your own custom 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 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 -makeglossaries, this information is obtained from the +document’s auxiliary (.aux) file. The makeglossaries script attempts to find the root language given your -document settings, but in the event that it gets it wrong or if makeglossaries script attempts to find the root +language given your document settings, but in the event that it gets it wrong or if +xindy -doesn’t support that language, then you can specify the required language +class="cmtt-10">xindy doesn’t support that language, then you can specify the required language using: -

\GlsSetXdyLanguage 

\GlsSetXdyLanguage  \GlsSetXdyLanguage[<glossary -type>]{<language>}
-

+class="cmtt-10">\GlsSetXdyLanguage[<glossary type>]{<language>} +

+

+ + where <language> is the name of the language. The optional argument can -be used if you have multiple glossaries in different languages. If <glossary -type> is omitted, it will be applied to all glossaries, otherwise the -language setting will only be applied to the glossary given by <glossary -type>. -

If the inputenc<language> is the name of the language. The optional argument can be used if +you have multiple glossaries in different languages. If <glossary type> is omitted, it +will be applied to all glossaries, otherwise the language 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\inputencodingname. Alternatively, you can specify the encoding using: -

\GlsSetXdyCodePage 

\GlsSetXdyCodePage  \GlsSetXdyCodePage{<code>}
-

+class="cmtt-10">\GlsSetXdyCodePage{<code>}

+

where <code> is the name of the encoding. For example: - - - +class="cmmi-10"><code> is the name of the encoding. For example: + +

-
+
\GlsSetXdyCodePage{utf8}
-

-

Note that you can also specify the language and encoding using the -package option xindy={language=<lang>,codepage=<code>}. For -example: - - - -

-
+

+

Note that you can also specify the language and encoding using the package option +xindy={language=<lang>,codepage=<code>}. For example: + + +

+
\usepackage[xindy={language=english,codepage=utf8}]{glossaries}
-

-

If you write your own custom

+

If you write your own custom xindy style file that includes the language -settings, you need to set the language to nothing: - - - +class="cmtt-10">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 being -overwritten). -

The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have -no effect if you don’t use

(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 makeglossariesmakeglossaries. If you call xindy without -xindy without makeglossaries you need to remember to set the language and encoding -using the -L and -C switches.
-

-

+class="cmtt-10">makeglossaries you need +to remember to set the language and encoding using the -L and -C switches. +

+

+

-

Top

11.2  

Top

11.2 Locations and Number lists

-

If you use xindy

If you use xindy, the glossaries package needs to know which counters you -will be using in the glossaries package needs to know which counters you will be using +in the number list in order to correctly format the xindy style -file. Counters specified using the counterxindy style file. Counters specified +using the counter package option or the <counter> -option of \newglossary are automatically taken care of, but if you plan to -use a different counter in the counter key for commands like \glslink, -then you need to identify these counters before \makeglossaries -using: -

\GlsAddXdyCounters <counter> option of \newglossary are +automatically taken care of, but if you plan to use a different counter in the counter +key for commands like \glslink, then you need to identify these counters before +\makeglossaries using: +

\GlsAddXdyCounters  \GlsAddXdyCounters{<counter list>} -
-

+class="cmtt-10">\GlsAddXdyCounters{<counter list>}

+

where <counter list> is a comma-separated list of counter names. -

The most likely attributes used in the format<counter list> is a comma-separated list of counter names. +

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

\GlsAddXdyAttribute xindy style file, but if you want to use another attribute, +you need to add it using: +

\GlsAddXdyAttribute  \GlsAddXdyAttribute{<name>}
-

+class="cmtt-10">\GlsAddXdyAttribute{<name>}

+

where <name> is the name of the attribute, as used in the format -key. +class="cmmi-10"><name> is the name of the attribute, as used in the format key. -

Example 14 (Custom Font for Displaying a Location) -

Suppose I want a bold, italic, hyperlinked location. I first need to define - - - -a command that will do this: - - - +

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

but with xindyxindy, I also need to add this as an allowed attribute: - - - + +

-
+
\GlsAddXdyAttribute{hyperbfit}
-

Now I can use it in the optional argument of commands like \gls

Now I can use it in the optional argument of commands like \gls: - - - + +

-
+
Here is a \gls[format=hyperbfit]{sample} entry.
-

(where sample is the label of the required entry).

+

(where sample is the label of the required entry).

-

-

____________________________

-

Note that \GlsAddXdyAttribute has no effect if \noist

+

____________________________

+

Note that \GlsAddXdyAttribute has no effect if \noist is used or if \makeglossaries\makeglossaries is omitted. \GlsAddXdyAttribute must be used before +class="cmtt-10">\GlsAddXdyAttribute must be used before \makeglossaries\makeglossaries. Additionally, \GlsAddXdyCounters must come before -\GlsAddXdyAttribute.
-

-

If the location numbers don’t get expanded to a simple Arabic or Roman -number or a letter from a, …, z or A, …, Z, then you need to add a location -style in the appropriate format using -

+

+

If the location numbers don’t get expanded to a simple Arabic or Roman number +or a letter from a, …, z or A, …, Z, then you need to add a location style in the +appropriate format using +

\GlsAddXdyLocation  \GlsAddXdyLocation[<prefix-location>]{<name>}{<definition>} +class="cmtt-10">\GlsAddXdyLocation[<prefix-location>]{<name>}{<definition>}
-

+

where <name> is the name of the format and <definition> is the <name> is the name of the format and <definition> is the +xindy -definition. The optional argument <prefix-location> is needed if -\theH<counter> either isn’t defined or is different from \the<counter>. -

Note that \GlsAddXdyLocation has no effect if \noistxindy definition. The optional argument <prefix-location> is needed if +\theH<counter> either isn’t defined or is different from \the<counter>. +

Note that \GlsAddXdyLocation has no effect if \noist is used or if \makeglossaries\makeglossaries is omitted. \GlsAddXdyLocation must be used before +class="cmtt-10">\GlsAddXdyLocation must be used before \makeglossaries\makeglossaries.
-

+

-

Example 15 (Custom Numbering System for Locations) -

Suppose I decide to use a somewhat eccentric numbering system for -sections where I redefine \thesection as follows: - - - +

Suppose I decide to use a somewhat eccentric numbering system for sections where +I redefine \thesection as follows: + +

-
+
\renewcommand*{\thesection}{[\thechapter]\arabic{section}}
-

If I haven’t done counter=section in the package option, I need to -specify that the counter will be used as a location number: - - - +

If I haven’t done counter=section in the package option, I need to specify that the +counter will be used as a location number: + +

-
+
\GlsAddXdyCounters{section}
-

Next I need to add the location style (\thechapter is assumed to be the -standard \arabic{chapter}): - - - +

Next I need to add the location style (\thechapter is assumed to be the standard +\arabic{chapter}): + +

-
+
\GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]"  
  "arabic-numbers"  
}
-

Note that if I have further decided to use the hyperref package and want to -redefine \theHsection as: - - - +

Note that if I have further decided to use the hyperref package and want to redefine +\theHsection as: + +

-
+
\renewcommand*{\theHsection}{\thepart.\thesection}  
\renewcommand*{\thepart}{\Roman{part}}
-

then I need to modify the \GlsAddXdyLocation code above to: - - - +

then I need to modify the \GlsAddXdyLocation code above to: + +

-
+
\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["  
  "arabic-numbers" :sep "]" "arabic-numbers"  
}
-

Since \Roman will result in an empty string if the counter is zero, it’s a -good idea to add an extra location to catch this: - - - -

-
+

Since \Roman will result in an empty string if the counter is zero, it’s a good idea to +add an extra location to catch this: + + +

+
\GlsAddXdyLocation{zero.section}{:sep "["  
  "arabic-numbers" :sep "]" "arabic-numbers"  
}
-

This example is illustrated in the sample file

This example is illustrated in the sample file samplexdy2.tex. -

+class="cmtt-10">samplexdy2.tex.

-

-

____________________________

+

+

____________________________

-

Example 16 (Locations as Words not Digits) -

Suppose I want the page numbers written as words rather than digits -and I use the fmtcount

Suppose I want the page numbers written as words rather than digits and I use +the fmtcount package to do this. I can redefine \thepage as -follows: - - - +class="cmtt-10">\thepage as follows: + +

-
+
\renewcommand*{\thepage}{\Numberstring{page}}
-

This gets expanded to \protect \Numberstringnum {<n>} where <n> -is the Arabic page number. This means that I need to define a new -location that has that form: - - - +

This gets expanded to \protect \Numberstringnum {<n>} where <n> is the +Arabic page number. This means that I need to define a new location that has that +form: + +

-
+
\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space  
  \string\Numberstringnum\space\glsopenbrace"  
  "arabic-numbers" :sep "\glsclosebrace"}
-

Note that it’s necessary to use \space to indicate that spaces also appear +

Note that it’s necessary to use \space to indicate that spaces also appear in the format, since, unlike TEX, xindyxindy doesn’t ignore spaces after control sequences. -

Note that \GlsAddXdyLocation{<name>}{<definition>} will define -commands in the form: -

\glsX<counter>X<name>{<Hprefix>}{<location>}
-

+

Note that \GlsAddXdyLocation{<name>}{<definition>} will define commands +in the form: +

\glsX<counter>X<name>{<Hprefix>}{<location>}
+

for each counter that has been identified either by the counter package -option, the <counter> option for \newglossary or in the argument of -\GlsAddXdyCounterscounter package option, the +<counter> option for \newglossary or in the argument of \GlsAddXdyCounters. -

The first argument <Hprefix> is only relevant when used with the -hyperref package and indicates that \the<Hcounter> is given by -\Hprefix.\the<counter>. The sample file

The first argument <Hprefix> is only relevant when used with the hyperref +package and indicates that \the<Hcounter> is given by \Hprefix.\the<counter>. +The sample file samplexdy.tex, which comes -with the glossaries package, uses the default page counter for locations, and -it uses the default \glsnumberformat and a custom \hyperbfit -format. A new samplexdy.tex, which comes with the glossaries package, uses the +default page counter for locations, and it uses the default \glsnumberformat and a +custom \hyperbfit format. A new xindyxindy location called Numberstring, as illustrated -above, is defined to make the page numbers appear as “One”, “Two”, -etc. In order for the location numbers to hyperlink to the relevant -pages, I need to redefine the necessary \glsX<counter>X<format> -commands: - - - -

-
+class="cmtt-10">Numberstring, as illustrated +above, is defined to make the page numbers appear as “One”, “Two”, etc. In order for +the location numbers to hyperlink to the relevant pages, I need to redefine the +necessary \glsX<counter>X<format> commands: + + +

+
\renewcommand{\glsXpageXglsnumberformat}[2]{%  
 \linkpagenumber#2%  
} @@ -12715,58 +12290,56 @@ commands:  
}  
\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}
-

+

-

-

____________________________

-

In the

+

____________________________

+

In the number list, the locations are sorted according to -type. The default ordering is: roman-page-numbers (e.g. i), + id="dx1-47052">, the locations are sorted according to type. The default ordering is: 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 +class="cmtt-10">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 hyphen111.1), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), +class="cmtt-10">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 +class="cmtt-10">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 hyphen211.2), user defined location names (as specified by \GlsAddXdyLocation in the -order in which they were defined), see (cross-referenced entries). This -ordering can be changed using: -

\GlsSetXdyLocationClassOrder \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 and -separated by white space. For example: - - - -

-
+

\GlsSetXdyLocationClassOrder{<location names>}
+

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

+
\GlsSetXdyLocationClassOrder{  
  "arabic-page-numbers"  
  "arabic-section-numbers" @@ -12778,995 +12351,1081 @@ separated by white space. For example:  
  "see"  
}
-

-

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

+

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

-

If a

+

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: - - - -

\GlsSetXdyMinRangeLength  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: + + +

\GlsSetXdyMinRangeLength  -

\GlsSetXdyMinRangeLength{<n>}
-

+

\GlsSetXdyMinRangeLength{<n>}
+

For example: - - - + +

-
+
\GlsSetXdyMinRangeLength{3}
-

The argument may also be the keyword none, to indicate that there -should be no range formations. See the

The argument may also be the keyword none, to indicate that 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 \makeglossariesxindy manual for further details on range +formations. +

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

-

See

+

See §5 §5 Number lists for further details.

-

Top

11.3  

Top

11.3 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: - - - +

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: + +

-
+
\usepackage[xindy={glsnumbers=false}]{glossaries}
-

Any entry that doesn’t go in one of the letter groups or the number group -is placed in the default group. -

If you have a number group, the default behaviour is to locate it before -the “A” letter group. If you are not using a Roman alphabet, you can -change this using: -

\GlsSetXdyFirstLetterAfterDigits 

Any entry that doesn’t go in one of the letter groups or the number group is placed in +the default group. +

If you have a number group, the default behaviour is to locate it before the “A” +letter group. If you are not using a Roman alphabet, you can change this +using: +

\GlsSetXdyFirstLetterAfterDigits  -

\GlsSetXdyFirstLetterAfterDigits{<letter>}
-

-

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

\GlsSetXdyFirstLetterAfterDigits{<letter>}
+

+

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

- - - -

-

Top

12   +

+ + +

+

+

Top

12. Defining New Glossaries

- A new glossary can be defined using: -

\newglossary 

A new glossary can be defined using: +

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

+class="cmtt-10">\newglossary[<log-ext>]{<name>}{<in-ext>}{<out-ext>}{<title>} +[<counter>]

+

where <name> is the label to assign to this glossary. The arguments -<in-ext> and <out-ext> specify the extensions to give to the 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 <name> is the label to assign to this glossary. The arguments <in-ext> and +<out-ext> specify the extensions to give to the 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 listnumber +lists (see also §5 Number -lists). The first optional argument specifies the extension for the -§5 Number lists). The first optional argument specifies the +extension for the makeindexmakeindex or xindy transcript file (this information is only used by -xindy transcript file (this information is only +used by makeglossariesmakeglossaries which picks up the information from the auxiliary file). -

Note that the main (default) glossary is automatically created -as: - - - +

The glossary label <name> must not contain any active characters. It’s generally +best to stick with just characters that have category code 11 (typically a, …, z and A, +…, Z).
+

+

You can also use: +

\altnewglossary  \altnewglossary{<name>}{<tag>}{<title>}[<counter>] +
+

+This is equivalent to

+
+\newglossary[<tag>-glg]{<name>}{<tag>-gls}{<tag>-glo}{<title>}[<counter>] +
+
+

Note that the main (default) glossary is automatically created as: + +

-
+
\newglossary{main}{gls}{glo}{\glossaryname}
-

so it can be identified by the label main (unless the nomain package -option is used). Using the acronym package option is equivalent -to: - - - -

-
+

so it can be identified by the label main (unless the nomain package option is used). +Using the 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 can identify the list of acronyms by -the command \acronymtype \acronymtype which is set to acronym, if the -acronym option has been used, otherwise it is set to main. Note that -if you are using the main glossary as your list of acronyms, you -need to declare it as a list of acronyms using the package option -acronymlists. -

The symbols package option creates a new glossary with the label -symbols using: - - - +

so it can be identified by the label acronym. If you are not sure whether the acronym +option has been used, you can identify the list of acronyms by the command +\acronymtype \acronymtype which is set to acronym, if the acronym option has been +used, otherwise it is set to main. Note that if you are using the main glossary as your +list of acronyms, you need to declare it as a list of acronyms using the package option +acronymlists. +

The symbols package option creates a new glossary with the label symbols +using: + +

-
+
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-

and the numbers package option creates a new glossary with the label -numbers using: - - - +

and the numbers package option creates a new glossary with the label numbers +using: + +

-
+
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
-

-

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

See

+

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

See §1.2.1 Changing the Fixed Names if you want to redefine -\glossaryname, especially if you are using babel or translator. (Similarly -for \glssymbolsgroupname and \glsnumbersgroupname.)

-

- - - -

-

13  Â§1.2.1 Changing the Fixed Names if you want to redefine \glossaryname, +especially if you are using babel or translator. (Similarly for \glssymbolsgroupname +and \glsnumbersgroupname.)

+

+ + +

+

+

Top

13. Acronyms

-

You may have noticed in

You may have noticed in §4 Defining Glossary Entries that when you -specify a new entry, you can specify alternate text to use when the -term is §4 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 means to -define acronyms. For convenience, the glossaries package defines the -command: -

\newacronym first used in the +document. This provides a useful means to define acronyms. For convenience, the +glossaries package defines the command: +

\newacronym  \newacronym[<key-val list>]{<label>}{<abbrv>}{<long>} +class="cmtt-10">\newacronym[<key-val list>]{<label>}{<abbrv>}{<long>}
-

-

This uses \newglossaryentry to create an entry with the given label in -the glossary given by \acronymtype. It also uses the long, longplural, short -and shortplural keys to store the long and abbreviated forms and their -plurals. -

The optional argument {<key-val list>} allows you to specify keys such +

+

This uses \newglossaryentry to create an entry with the given label in the +glossary given by \acronymtype. You can specify a different glossary using the type +key within the optional argument. The \newacronym command also uses the long, +longplural, short and shortplural keys in \newglossaryentry to store the long and +abbreviated forms and their plurals. +

If you haven’t identified the specified glossary type as a list of acronyms (via the +package option acronymlists or the command \DeclareAcronymList, see §2.5 Acronym +Options) \newacronym will add it to the list and reset the display style for that +glossary via \defglsentryfmt. If you have a mixture of acronyms and regular entries +within the same glossary, care is needed if you want to change the display +style: you must first identify that glossary as a list of acronyms and then use +\defglsentryfmt (not redefine \glsentryfmt) before defining your entries. +
+

+

The optional argument {<key-val list>} allows you to specify keys such as description (when used with one of the styles that require a description, +class="cmss-10">description (when used with one of the styles that require a description, described in §13.1 §13.1 Changing the Acronym Style) or you can override plural forms of <abbrv> or <long> using the shortplural or longplural keys. For +class="cmmi-10"><abbrv> or <long> using the shortplural or longplural keys. For example: - - - + +

-
+
\newacronym[longplural={diagonal matrices}]%  
  {dm}{DM}{diagonal matrix}
-

If the

If the first use uses the plural form, \glspl{dm} will display: diagonal -matrices (DMs). -

Since \newacronym uses \newglossaryentry, you can use commands -like \gls and \glsreset as with any other glossary entry. -

Since \newacronym sets type=\acronymtype, 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 \glspl{dm} will display: diagonal matrices +(DMs). If you want to use the longplural or shortplural keys, I recommend you use +\setacronymstyle to set the display style rather than using one of the pre-version +4.02 acronym styles. +

Since \newacronym uses \newglossaryentry, you can use commands like \gls +and \glsreset as with any other glossary entry. +

Since \newacronym sets type=\acronymtype, 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 §4.6 Loading Entries From a File. -
-

+class="cmsy-10">§4.6 Loading +Entries From a File.

+

-

+

Example 17 (Defining an Acronym) -

The following defines the acronym IDN: - - - + id="x1-50029"> +

The following defines the acronym IDN: + +

-
+
\newacronym{idn}{IDN}{identification number}
-

\gls{idn} will produce “identification number (IDN)” on first use and -“IDN” on subsequent uses. If you want to use one of the smallcaps -acronym styles, described in

\gls{idn} will produce “identification number (IDN)” on first use and “IDN” on +subsequent uses. If you want to use one of the smallcaps acronym styles, described in +§13.1 Changing the Acronym Style, you need -to use lower case characters for the shortened form: - - - +class="cmsy-10">§13.1 Changing the Acronym Style, you need to use lower case characters for the +shortened form: + +

-
+
\newacronym{idn}{idn}{identification number}
-

Now \gls{idn} will produce “identification number (

Now \gls{idn} will produce “identification number (idn)” on first -use and “first use and “idn” on subsequent uses.

+class="small-caps">n” on +subsequent uses.

-

-

____________________________

-

There are commands analogous to \glstext (described in

+

____________________________

+

There are commands similar to \glstext (described in §6 Links to -Glossary Entries) that allow you to access just the short form, just the long -form or the full form, without affecting the first use flag. (Note that the -full form isn’t necessarily the same as the text produced on first -use.) -

\acrshort  \acrshort[<options>]{<label>}[<insert>] -
-

-This displays the short form for the entry given by <label>. The optional -arguments are the same as those for \glstext. There is also a starred -version to suppress the hyperlink. There are also analogous upper case -variants: -

\Acrshort  \Acrshort[<options>]{<label>}[<insert>] -
-

-

\ACRshort  \ACRshort[<options>]{<label>}[<insert>] -
-

-There are also plural versions: -

\acrshortpl  \acrshortpl[<options>]{<label>}[<insert>] -
-

-

\Acrshortpl  \Acrshortpl[<options>]{<label>}[<insert>] -
-

-

\ACRshortpl  \ACRshortpl[<options>]{<label>}[<insert>] -
-

- - - -

Similarly for the long form: -

\acrlong  \acrlong[<options>]{<label>}[<insert>]
-

-This displays the long form for the entry given by <label>. The -optional arguments are the same as before. There is also a starred -version to suppress the hyperlink. There are also analogous upper case +class="cmsy-10">§6 Links to Glossary +Entries) that allow you to access just the short form, just the long form or the full +form, without affecting the first use flag. (Note that the full form isn’t necessarily the +same as the text produced on first use.) +

Although these commands are similar to commands such as \glstext, they +behave more like \glsdisp (except for the first use behaviour) in that the +display is governed by \defentryfmt with \glscustomtext set as appropriate. +
+

+

\acrshort  \acrshort[<options>]{<label>}[<insert>]
+

+This displays the short form (within the argument of \acronymfont) for the entry +given by <label>. The optional arguments are the same as those for \glstext. There +is also a starred version to suppress the hyperlink. There are also analogous upper case variants: -

\Acrlong  \Acrlong[<options>]{<label>}[<insert>]
-

-

\ACRlong  \ACRlong[<options>]{<label>}[<insert>]
-

-Again there are also plural versions: -

\acrlongpl  \acrlongpl[<options>]{<label>}[<insert>] -
-

-

\Acrlongpl  \Acrlongpl[<options>]{<label>}[<insert>] -
-

-

\ACRlongpl  \ACRlongpl[<options>]{<label>}[<insert>] -
-

-

And for the full form: -

\acrfull  \acrfull[<options>]{<label>}[<insert>]
-

-This defaults to <long> (\acronymfont{<short>}). The format (including -hyperlinks) can be modified by redefining: -

\acrfullfmt  \acrfullfmt{<options>}{<label>}{<insert>} -
-

-

There are also analogous upper case variants: -

\Acrfull  \Acrfull[<options>]{<label>}[<insert>]
-

-

\ACRfull 

\Acrshort  \ACRfull[<options>]{<label>}[<insert>]
-

-The formats (including hyperlinks) can be modified by redefining: -

+

+

\ACRshort  \Acrfullfmt{<options>}{<label>}{<insert>} -
- - - -

-

+

+There are also plural versions: +

\acrshortpl  \ACRfullfmt{<options>}{<label>}{<insert>} -
-

-

As before there are also plural versions: -

+

+

\Acrshortpl  \acrfullpl[<options>]{<label>}[<insert>] -
-

-

+

+

\ACRshortpl  \Acrfullpl[<options>]{<label>}[<insert>] -
-

-

+

+

Similarly for the long form: +

\acrlong  \ACRfullpl[<options>]{<label>}[<insert>] -
-

-The formats (including hyperlinks) can be modified by redefining: -

+ + +

+This displays the long form for the entry given by <label>. The optional arguments +are the same as before. There is also a starred version to suppress the hyperlink. +There are also analogous upper case variants: +

\Acrlong  \acrfullplfmt{<options>}{<label>}{<insert>} -
-

-

+

+

\ACRlong  \Acrfullplfmt{<options>}{<label>}{<insert>} -
-

-

+

+Again there are also plural versions: +

\acrlongpl  \ACRfullplfmt{<options>}{<label>}{<insert>} +class="cmtt-10">\acrlongpl[<options>]{<label>}[<insert>]
+

+

\Acrlongpl  \Acrlongpl[<options>]{<label>}[<insert>]
+

+

\ACRlongpl  \ACRlongpl[<options>]{<label>}[<insert>]
+

+

And for the full form: +

\acrfull  \acrfull[<options>]{<label>}[<insert>]
+

+This defaults to <long> (\acronymfont{<short>}). The format (including +hyperlinks) can be modified by redefining: +

\acrfullfmt  \acrfullfmt{<options>}{<label>}{<insert>}
+

+

There are also analogous upper case variants: +

\Acrfull  \Acrfull[<options>]{<label>}[<insert>]
+

+

\ACRfull  \ACRfull[<options>]{<label>}[<insert>]
+

+The formats (including hyperlinks) can be modified by redefining: +

\Acrfullfmt  \Acrfullfmt{<options>}{<label>}{<insert>}
+

+

\ACRfullfmt  \ACRfullfmt{<options>}{<label>}{<insert>}
+

+

As before there are also plural versions: +

\acrfullpl  \acrfullpl[<options>]{<label>}[<insert>]
+

+

\Acrfullpl  \Acrfullpl[<options>]{<label>}[<insert>]
+ + +

+

\ACRfullpl  \ACRfullpl[<options>]{<label>}[<insert>]
+

+The formats (including hyperlinks) can be modified by redefining: +

\acrfullplfmt  \acrfullplfmt{<options>}{<label>}{<insert>}
-

-

If you find the above commands too cumbersome to write, you can use -the shortcuts package option to activate the shorter command names listed -in table 13.1. - - - -

+

\Acrfullplfmt  \Acrfullplfmt{<options>}{<label>}{<insert>} +
+

+

\ACRfullplfmt  \ACRfullplfmt{<options>}{<label>}{<insert>} +
+

+

If you find the above commands too cumbersome to write, you can use the +shortcuts package option to activate the shorter command names listed in +table 13.1. +

+
+ + +

- - - -
Table 13.1: Table 13.1: Synonyms provided by the package option shortcuts
+class="cmss-10">shortcuts
+class="cmbx-10">Equivalent Command +class="cmtt-10">\acrshort +class="cmtt-10">\Acrshort +class="cmtt-10">\acrshortpl +class="cmtt-10">\Acrshortpl +class="cmtt-10">\acrlong +class="cmtt-10">\Acrlong +class="cmtt-10">\acrlongpl +class="cmtt-10">\Acrlongpl +class="cmtt-10">\acrfull +class="cmtt-10">\Acrfull +class="cmtt-10">\acrfullpl +class="cmtt-10">\Acrfullpl +class="cmtt-10">\gls +class="cmtt-10">\Gls +class="cmtt-10">\glspl
Shortcut Command Shortcut Command Equivalent Command
\acs \acs \acrshort
\Acs \Acs \Acrshort
\acsp \acsp \acrshortpl
\Acsp \Acsp \Acrshortpl
\acl \acl \acrlong
\Acl \Acl \Acrlong
\aclp \aclp \acrlongpl
\Aclp \Aclp \Acrlongpl
\acf \acf \acrfull
\Acf \Acf \Acrfull
\acfp \acfp \acrfullpl
\Acfp \Acfp \Acrfullpl
\ac \ac \gls
\Ac \Ac \Gls
\acp \acp \glspl
\Acp \Acp \Glspl
+class="cmtt-10">\Glspl
- - - -
-

It is also possible to access the long and short forms without -adding information to the glossary using commands analogous to -\glsentrytext (described in

+
+

It is also possible to access the long and short forms without adding information to +the glossary using commands analogous to \glsentrytext (described in §9 Using +Glossary Terms Without Links). +

The commands that convert the first letter to upper case come with the same +caveats as those for analogous commands like \Glsentrytext (non-expandable, +can’t be used in PDF bookmarks, care needs to be taken if the first letter is +an accented character etc). See §9 Using Glossary Terms Without -Links). -

The long form can be accessed using: -

\glsentrylong  \glsentrylong{<label>}
-

+class="cmsy-10">§9 Using Glossary Terms Without Links. +

+

+

The long form can be accessed using: +

\glsentrylong  \glsentrylong{<label>}
+

or, with the first letter converted to upper case: -

\Glsentrylong  \Glsentrylong{<label>}
-

+

\Glsentrylong  \Glsentrylong{<label>}
+

Plural forms: -

\glsentrylongpl  \glsentrylongpl{<label>}
-

-

\Glsentrylongpl  \Glsentrylongpl{<label>}
-

-

Similarly, to access the short form: -

\glsentryshort  \glsentryshort{<label>}
-

+

\glsentrylongpl  \glsentrylongpl{<label>}
+

+

\Glsentrylongpl  \Glsentrylongpl{<label>}
+

+

Similarly, to access the short form: +

\glsentryshort  \glsentryshort{<label>}
+

or, with the first letter converted to upper case: -

\Glsentryshort  \Glsentryshort{<label>}
-

+

\Glsentryshort  \Glsentryshort{<label>}
+

Plural forms: -

\glsentryshortpl  \glsentryshortpl{<label>}
-

-

\Glsentryshortpl  \Glsentryshortpl{<label>}
-

-

And the full form, <long> (<short>), can be obtained using: -

\glsentryfull  \glsentryfull{<label>}
-

-

\Glsentryfull  \Glsentryfull{<label>}
-

-

\glsentryfullpl  \glsentryfullpl{<label>}
-

-

\Glsentryfullpl  \Glsentryfullpl{<label>}
-

- - - +

\glsentryshortpl  \glsentryshortpl{<label>}
+

+

\Glsentryshortpl  \Glsentryshortpl{<label>}
+

+

And the full form, <long> (<short>), can be obtained using: +

\glsentryfull  \glsentryfull{<label>}
+

+

\Glsentryfull  \Glsentryfull{<label>}
+

+

\glsentryfullpl  \glsentryfullpl{<label>}
+ + +

+

\Glsentryfullpl  \Glsentryfullpl{<label>}
+

(These may be redefined by the acronym style.)

-

13.1  

Top

13.1 Changing the Acronym Style

-

It may be that the default style doesn’t suit your requirements in which -case you can switch to another styles via -

\setacronymstyle 

It may be that the default style doesn’t suit your requirements in which case you can +switch to another styles via +

\setacronymstyle  \setacronymstyle{<style name>}
-

+class="cmtt-10">\setacronymstyle{<style name>}

+

where <style name> is the name of the required style. -

You must use \setacronymstyle before you define the acronyms with -\newacronym. If you have multiple glossaries representing lists of acronyms, -you must use \setacronymstyle after using \DeclareAcronymList. -
-

-

Note that unlike the default behaviour of \newacronym, the styles used +class="cmmi-10"><style name> is the name of the required style. +

You must use \setacronymstyle before you define the acronyms with +\newacronym. If you have multiple glossaries representing lists of acronyms, you must +use \setacronymstyle after using \DeclareAcronymList.
+

+

Note that unlike the default behaviour of \newacronym, the styles used via \setacronymstyle don’t use the first\setacronymstyle don’t use the first or texttext keys, but instead they use \defglsentryfmt\defglsentryfmt to set a custom format that uses the longlong and short -keys (or their plural equivalents). This means that these styles cope -better with plurals that aren’t formed by simply appending the -singular form with the letter “s”. In fact, most of the predefined styles -use \glsgenacfmtshort keys (or their +plural equivalents). This means that these styles cope better with plurals that aren’t +formed by simply appending the singular form with the letter “s”. In fact, most of the +predefined styles use \glsgenacfmt and modify the definitions of commands like \genacrfullformat\genacrfullformat. -

Note that when you use \setacronymstyle the name key is set -to -

\acronymentry 

Note that when you use \setacronymstyle the name key is set to +

\acronymentry  \acronymentry{<label>}
-

+class="cmtt-10">\acronymentry{<label>}

+

and the sortsort key is set to -

\acronymsort 

\acronymsort  \acronymsort{<short>}{<long>}
-

-These commands are redefined by the acronym styles. However, you can -redefine them again after the style has been set but before you use -\newacronym. Protected expansion is performed on \acronymsort when -the entry is defined. -

-

-

Top

13.1.1  \acronymsort{<short>}{<long>}

+

+These commands are redefined by the acronym styles. However, you can redefine them +again after the style has been set but before you use \newacronym. Protected +expansion is performed on \acronymsort when the entry is defined. +

+

+

Top

13.1.1 Predefined Acronym Styles

-

The glossaries package provides a number of predefined styles. These styles +

The glossaries package provides a number of predefined styles. These styles apply - - - -

\firstacronymfont 

\firstacronymfont  \firstacronymfont{<text>}
-

+class="cmtt-10">\firstacronymfont{<text>}

+

to the short form on first use and -

\acronymfont 

\acronymfont  \acronymfont{<text>}
-

+class="cmtt-10">\acronymfont{<text>}

+

on subsequent use. The styles modify the definition of \acronymfont as -required, but \firstacronymfont is only set once by the package when it’s -loaded. By default \firstacronymfont{<text>} is the same as +class="cmtt-10">\acronymfont as required, but +\firstacronymfont is only set once by the package when it’s loaded. By default \acronymfont\firstacronymfont{<text>} is the same as \acronymfont{<text>}. If you want the short form displayed differently -on first use, you can redefine \firstacronymfont independently of the -acronym style. -

The predefined styles that contain sc in their name (for example -long-sc-short) redefine \acronymfont to use \textsc (so the short form -needs to be specified in lower case). -

{<text>}. If you want the +short form displayed differently on first use, you can redefine \firstacronymfont +independently of the acronym style. +

The predefined styles that contain sc in their name (for example long-sc-short) +redefine \acronymfont to use \textsc (so the short form needs to be specified in +lower case). +

-

Some fonts don’t support bold smallcaps, so you may need to redefine +

Some fonts don’t support bold smallcaps, so you may need to redefine \glsnamefont\glsnamefont (see §10 Displaying a glossary) to switch to medium -weight if you are using a glossary style that displays entry names in -bold and you have chosen an acronym style that uses \textsc. -
-

-

The predefined styles that contain sm in their name (for example -long-sm-short) redefine \acronymfont to use \textsmaller§10 Displaying a glossary) to switch to medium weight if you are +using a glossary style that displays entry names in bold and you have chosen an +acronym style that uses \textsc.

+

+

The predefined styles that contain sm in their name (for example long-sm-short) +redefine \acronymfont to use \textsmaller. -

-

Note that the glossaries package doesn’t define or load any package that -defines \textsmaller. If you use one of the acronym styles that set -\acronymfont to \textsmaller you must explicitly load the relsize -package or otherwise define \textsmaller.
-

-

The remaining predefined styles redefine \acronymfont{<text>} to -simply do its argument <text>. -

In most cases, the predefined styles adjust \acrfull

Note that the glossaries package doesn’t define or load any package that defines +\textsmaller. If you use one of the acronym styles that set \acronymfont to +\textsmaller you must explicitly load the relsize package or otherwise define +\textsmaller.
+

+

The remaining predefined styles redefine \acronymfont{<text>} to simply do its +argument <text>. +

In most cases, the predefined styles adjust \acrfull and \glsentryfull -(and their plural and upper case variants) to reflect the style. The only -exceptions to this are the dua\glsentryfull (and +their plural and upper case variants) to reflect the style. The only exceptions to this +are the dua and footnote styles (and their variants). -
-

-

The following styles are supplied by the glossaries package:

+class="cmss-10">footnote styles (and their variants).
+

+

The following styles are supplied by the glossaries package:

  • long-shortlong-short, long-sc-shortlong-sc-short, long-sm-shortlong-sm-short: -

    With these three styles, acronyms are displayed in the form - - - -

    <long> (\firstacronymfont

    With these three styles, acronyms are displayed in the form +

    -

    +class="cmtt-10">{<short>})

    +

    on first use and -

    \acronymfont

    \acronymfont{<short>}
    -

    +class="cmtt-10">{<short>}

    +

    on subsequent use. They also set \acronymsort{<short>}{<long>} - to just <short>. This means that the acronyms are sorted according - to their short form. In addition, \acronymentry{<label>} is set to - just the short form (enclosed in \acronymfont) and the description - key is set to the long form. +class="cmtt-10">\acronymsort{<short>}{<long>} to just + <short>. This means that the acronyms are sorted according to their short + + + form. In addition, \acronymentry{<label>} is set to just the short form + (enclosed in \acronymfont) and the description key is set to the long + form.

  • short-longshort-long, sc-short-longsc-short-long, sm-short-longsm-short-long: -

    These three styles are analogous to the above three styles, except the - display order is swapped to -

    +

    on first use. -

    Note, however, that \acronymsort

    Note, however, that \acronymsort and \acronymentry are the same - as for the <long> (<short>) styles above, so the acronyms are still - sorted according to the short form. +class="cmtt-10">\acronymentry are the same as for the + <long> (<short>) styles above, so the acronyms are still sorted according to the + short form.

  • long-short-desclong-short-desc, long-sc-short-desclong-sc-short-desc, long-sm-short-desclong-sm-short-desc: -

    These are like the long-short

    These are like the long-short, long-sc-shortlong-sc-short and long-sm-short styles - described above, except that the description key must be supplied in - the optional argument of \newacronym. They also redefine - \acronymentrylong-sm-short styles described + above, except that the description key must be supplied in the optional + argument of \newacronym. They also redefine \acronymentry to {<long>} (\acronymfont{<short>}) and - redefine \acronymsort{<long>} + (\acronymfont{<short>}) and redefine \acronymsort{<short>}{<long>} to just <long>. This - means that the acronyms are sorted according to the long form, and - in the list of acronyms the name field has the long form followed by +class="cmtt-10">{<short>}{<long>} to + just <long>. This means that the acronyms are sorted according to the long + form, and in the list of acronyms the name field has the long form followed by the short form in parentheses. I recommend you use a glossary style such as altlistaltlist with these acronym styles to allow for the long name field.

  • short-long-descshort-long-desc, sc-short-long-descsc-short-long-desc, sm-short-long-descsm-short-long-desc: -

    These styles are analogous to the above three styles, but the first use - display style is: -

    \firstacronymfont{<short>} (<long>)
    - - - -

    +

    These styles are analogous to the above three styles, but the first use display + style is: +

    \firstacronymfont{<short>} (<long>)
    +

    The definitions of \acronymsort and \acronymentry are the same as - those for long-short-desc\acronymsort and \acronymentry are the same as those for + long-short-desc etc.

  • duadua, dua-descdua-desc: -

    These styles always display (via \gls) the long form regardless of - whether the entry has been used or not. However, \acrfull and +

    These styles always display (via \gls) the long form regardless of whether the + entry has been used or not. However, \acrfull and \glsentryfull will display \glsentryfull will display <long> (\acronymfont{<short>}). In - the case of dua<long> (\acronymfont{<short>}). In the case of dua, the namename and sort keys are set to the short - form and the description is set to the long form. In the case - of dua-descsort + keys are set to the short form and the description is set to the long + form. In the case of dua-desc, the namename and sort keys are set to the long form - and the description is supplied in the optional argument of +class="cmss-10">sort keys are set to the + long form and the description is supplied in the optional argument of \newacronym\newacronym. + +

  • footnotefootnote, footnote-scfootnote-sc, footnote-smfootnote-sm: -

    These three styles set the first use display to: -

    \firstacronymfont{<short>}\footnote

    These three styles set the first use display to: +

    -

    +class="cmtt-10">{<long>}

    +

    However, \acrfull\acrfull and \glsentryfull\glsentryfull are set to \acronymfont{<short>} +class="cmtt-10">\acronymfont{<short>} (<long>). (And similarly for plural and upper case forms.) On - subsequent use the display is: -

    \acronymfont{<short>}
    -

    +class="cmmi-10"><long>). (And similarly for plural and upper case forms.) On subsequent use + the display is: +

    \acronymfont{<short>}
    +

    The sortsort and namename keys are set to the short form, and the description - is set to the long form. -

    In order to avoid nested hyperlinks on description is set to the + long form. +

    In order to avoid nested hyperlinks on first use the footnote styles automatically implement hyperfirst=falsehyperfirst=false.
    -

    +

  • footnote-descfootnote-desc, footnote-sc-descfootnote-sc-desc, footnote-sm-descfootnote-sm-desc: -

    These three styles are similar to the previous three styles, but the - description has to be supplied in the optional argument of - \newacronym

    These three styles are similar to the previous three styles, but the description + has to be supplied in the optional argument of \newacronym. The name key is set to the long form followed by the - short form in parentheses and the sort key is set to the long form. - This means that the acronyms will be sorted according to the long - form. In addition, since the name will typically be quite wide it’s best - to choose a glossary style that can accommodate this, such as +class="cmss-10">name key is + set to the long form followed by the short form in parentheses and the sort key is + set to the long form. This means that the acronyms will be sorted according to + the long form. In addition, since the name will typically be quite wide it’s + best to choose a glossary style that can accommodate this, such as altlistaltlist. - - -

-

Example 18 (Adapting a Predefined Acronym Style) -

Suppose I want to use the footnote-sc-desc

Suppose I want to use the footnote-sc-desc style, but I want the namename key set to the short form followed by the long form in parentheses and the sortsort key set to the short form. Then I need to specify the footnote-sc-descfootnote-sc-desc style: - - - + +

-
+
\setacronymstyle{footnote-sc-desc}
-

and then redefine \acronymsort

and then redefine \acronymsort and \acronymentry\acronymentry: - - - + +

-
+
\renewcommand*{\acronymsort}[2]{#1}% sort by short form  
\renewcommand*{\acronymentry}[1]{%  
  \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%
-

(I’ve used \space for extra clarity, but you can just use an actual space +

(I’ve used \space for extra clarity, but you can just use an actual space instead.) -

Since the default Computer Modern fonts don’t support bold smallcaps, -I’m also going to redefine \acronymfont so that it always switches to -medium weight to ensure the smallcaps setting is used: - - - -

-
+

Since the default Computer Modern fonts don’t support bold smallcaps, I’m also +going to redefine \acronymfont so that it always switches to medium weight to ensure +the smallcaps setting is used: + + +

+
\renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}}
-

This isn’t necessary if you use a font that supports bold smallcaps. -

The sample file

This isn’t necessary if you use a font that supports bold smallcaps. +

The sample file sampleFnAcrDesc.tex illustrates this example. -

+class="cmtt-10">sampleFnAcrDesc.tex illustrates this example.

-

-

____________________________

-

+

+

____________________________

+

-

Top

13.1.2  

Top

13.1.2 Defining A Custom Acronym Style

-

You may find that the predefined acronyms styles that come with the -glossaries package don’t suit your requirements. In this case you can define -your own style using: -

\newacronymstyle 

You may find that the predefined acronyms styles that come with the glossaries +package don’t suit your requirements. In this case you can define your own style +using: +

\newacronymstyle  \newacronymstyle{<style -name>}{<display>}{<definitions>}
-

+class="cmtt-10">\newacronymstyle{<style name>}{<display>}{<definitions>} +

+

where <style name> is the name of the new style (avoid active characters). -The second argument, <display>, is equivalent to the mandatory -argument of \defglsentryfmt<style name> is the name of the new style (avoid active characters). The +second argument, <display>, is equivalent to the mandatory argument of +\defglsentryfmt. You can simply use \glsgenacfmt or -you can customize the display using commands like \ifglsused, -\glsifplural\glsgenacfmt or you can customize the +display using commands like \ifglsused, \glsifplural and \glscapscase\glscapscase. (See §6.1 Changing the format of -the link text for further details.) If the style is likely to be used -with a mixed glossary (that is entries in that glossary are defined -both with \newacronym§6.1 +Changing the format of the link text for further details.) If the style is likely to be +used with a mixed glossary (that is entries in that glossary are defined both with +\newacronym and \newglossaryentry) then you can -test if the entry is an acronym and use \glsgenacfmt if it is or -\glsgenentryfmt if it isn’t. For example, the long-short style sets -<display> as - - - -

-
+class="cmtt-10">\newglossaryentry) then you can test if the entry is an acronym +and use \glsgenacfmt if it is or \glsgenentryfmt if it isn’t. For example, the +long-short style sets <display> as + + +

+
\ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
-

(You can use \ifglshasshort

(You can use \ifglshasshort instead of \ifglshaslong to test if the -entry is an acronym if you prefer.) -

The third argument, <definitions>, can be used to redefine the -commands that affect the display style, such as \acronymfont or, if -<display> uses \glsgenacfmt, \genacrfullformat\ifglshaslong to test if the entry is an +acronym if you prefer.) +

The third argument, <definitions>, can be used to redefine the commands that +affect the display style, such as \acronymfont or, if <display> uses \glsgenacfmt, +\genacrfullformat and its variants. -

Note that \setacronymstyle

Note that \setacronymstyle redefines \glsentryfull\glsentryfull and \acrfullfmt -to use \genacrfullformat (and similarly for the plural and upper case -variants). If this isn’t appropriate for the style (as in the case of styles like -footnote\acrfullfmt to use +\genacrfullformat (and similarly for the plural and upper case variants). If this +isn’t appropriate for the style (as in the case of styles like footnote and dua) \newacronymstyle should redefine these commands -within <definitions>. -

Within \newacronymstyle’s <definitions> argument you can also -redefine -

\GenericAcronymFields dua) +\newacronymstyle should redefine these commands within <definitions>. +

Within \newacronymstyle’s <definitions> argument you can also redefine +

\GenericAcronymFields  \GenericAcronymFields
-

+class="cmtt-10">\GenericAcronymFields

+

This is a list of additional fields to be set in \newacronym\newacronym. You can use the -following token registers to access the entry label, long form and short -form: \glslabeltok \glslabeltok \glslabeltok, \glslongtok \glslabeltok, \glslongtok \glslongtok and -\glsshorttok \glslongtok and \glsshorttok \glsshorttok. As with all TEX registers, you can access -their values by preceding the register with \the. For example, the +class="cmtt-10">\glsshorttok. +As with all TEX registers, you can access their values by preceding the register with long-short\the. For example, the long-short style does: - - - + +

-
+
\renewcommand*{\GenericAcronymFields}{%  
   description={\the\glslongtok}}%
-

which sets the description field to the long form of the acronym whereas -the long-short-desc

which sets the description field to the long form of the acronym whereas the +long-short-desc style does: - - - + +

-
+
\renewcommand*{\GenericAcronymFields}{}%
-

since the description needs to be specified by the user. -

It may be that you want to define a new acronym style that’s based on -an existing style. Within <display> you can use -

\GlsUseAcrEntryDispStyle 

since the description needs to be specified by the user. +

It may be that you want to define a new acronym style that’s based on an existing +style. Within <display> you can use +

\GlsUseAcrEntryDispStyle  -

\GlsUseAcrEntryDispStyle{<style name>}
-

+

\GlsUseAcrEntryDispStyle{<style name>}
+

to use the <display> definition from the style given by <style name>. -Within <definitions> you can use -

\GlsUseAcrStyleDefs <display> definition from the style given by <style name>. Within +<definitions> you can use +

\GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs{<style name>} -
-

+class="cmtt-10">\GlsUseAcrStyleDefs{<style name>}

+

to use the <definitions> from the style given by <style name>. For -example, the long-sc-short<definitions> from the style given by <style name>. For example, the +long-sc-short acronym style is based on the long-short style -with minor modifications (remember to use ## instead of # within -<definitions>): - - - -

-
+class="cmss-10">long-short style with minor modifications +(remember to use ## instead of # within <definitions>): + + +

+
\newacronymstyle{long-sc-short}%  
{% use the same display as "long-short"  
  \GlsUseAcrEntryDispStyle{long-short}% @@ -14907,129 +14544,124 @@ class="cmmi-10x-x-109">>):  
  \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
}
-

(\glstextup 

(\glstextup \glstextup is used to cancel the effect of \textsc. This -defaults to \textulc\glstextup is used to cancel the effect of \textsc. This defaults to +\textulc, if defined, otherwise \textup. For example, the -plural of \textup. For example, the plural of svm should be rendered as m should be +rendered as svms rather than svms.) -

Example 19 (Defining a Custom Acronym Style) -

Suppose I want my acronym on

Suppose I want my acronym on first use to have the short form -in the text and the long form with the description in a footnote. -Suppose also that I want the short form to be put in small caps in -the main body of the document, but I want it in normal capitals -in the list of acronyms. In my list of acronyms, I want the long -form as the name with the short form in brackets followed by the -description. That is, in the text I want \glsfirst use to have the short form in the text and the +long form with the description in a footnote. Suppose also that I want the +short form to be put in small caps in the main body of the document, but I +want it in normal capitals in the list of acronyms. In my list of acronyms, I +want the long form as the name with the short form in brackets followed +by the description. That is, in the text I want \gls on first use to display: -
\textsc\textsc{<abbrv>}\footnote{<long>: <description>} -
+class="cmtt-10">{<abbrv>}\footnote{<long>: <description>} +
on subsequent use: -
\textsc\textsc{<abbrv>} -
-and in the list of acronyms, each entry will be displayed in the form: - -
<long> (<short>) <description> -
-

Let’s suppose it’s possible that I may have a mixed glossary. I can check -this in the second argument of \newacronymstyle{<abbrv>} +
+and in the list of acronyms, each entry will be displayed in the form: +
<long> (<short>) <description> +
+

Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the +second argument of \newacronymstyle using: - - - + +

-
+
\ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
-

This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise -it will use \glsgenacfmt

This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use +\glsgenacfmt. The third argument (<definitions>) of -\newacronymstyle needs to redefine \genacrfullformat etc so that the -<definitions>) of \newacronymstyle needs to +redefine \genacrfullformat etc so that the first use displays the short form in the text with the long form in a -footnote followed by the description. This is done as follows (remember to -use ## instead of #): - - - -

-
+href="#glo:firstuse">first use displays the short form in the +text with the long form in a footnote followed by the description. This is done as +follows (remember to use ## instead of #): + + +

+
 % No case change, singular first use:  
  \renewcommand*{\genacrfullformat}[2]{%  
   \firstacronymfont{\glsentryshort{##1}}##2% @@ -15051,13 +14683,12 @@ class="cmtt-10x-x-109">#):  
   \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%  
  }%
-

If you think it inappropriate for the short form to be capitalised at the -start of a sentence you can change the above to: - - - +

If you think it inappropriate for the short form to be capitalised at the start of a +sentence you can change the above to: + +

-
+
 % No case change, singular first use:  
  \renewcommand*{\genacrfullformat}[2]{%  
   \firstacronymfont{\glsentryshort{##1}}##2% @@ -15071,39 +14702,38 @@ start of a sentence you can change the above to:  
 \let\Genacrfullformat\genacrfullformat  
 \let\Genplacrfullformat\genplacrfullformat
-

Another variation is to use \Glsentrylong

Another variation is to use \Glsentrylong and \Glsentrylongpl in the -footnote instead of \glsentrylong\Glsentrylongpl in the footnote +instead of \glsentrylong and \glsentrylongpl\glsentrylongpl. -

Now let’s suppose that commands such as \glsentryfull

Now let’s suppose that commands such as \glsentryfull and \acrfull -shouldn’t use a footnote, but instead use the format: <long> (<short>). -This means that the style needs to redefine \glsentryfull, \acrfullfmt -and their plural and upper case variants. -

First, the non-linking commands: - - - -

-
+class="cmtt-10">\acrfull shouldn’t +use a footnote, but instead use the format: <long> (<short>). This means that the +style needs to redefine \glsentryfull, \acrfullfmt and their plural and upper case +variants. +

First, the non-linking commands: + + +

+
  \renewcommand*{\glsentryfull}[1]{%  
    \glsentrylong{##1}\space  
      (\acronymfont{\glsentryshort{##1}})% @@ -15121,12 +14751,11 @@ and their plural and upper case variants.  
      (\acronymfont{\glsentryshortpl{##1}})%  
  }%
-

Now for the linking commands: - - - +

Now for the linking commands: + +

-
+
  \renewcommand*{\acrfullfmt}[3]{%  
    \glslink[##1]{##2}{%  
     \glsentrylong{##2}##3\space @@ -15168,117 +14797,105 @@ and their plural and upper case variants.  
    }%  
  }%
-

(This may cause problems with long hyperlinks, in which case adjust the -definitions so that, for example, only the short form is inside the argument -of \glslink

(This may cause problems with long hyperlinks, in which case adjust the +definitions so that, for example, only the short form is inside the argument of +\glslink.) - - - -

The style also needs to redefine \acronymsort so that the acronyms are -sorted according to the long form: - - - -

-
+

The style also needs to redefine \acronymsort so that the acronyms are sorted +according to the long form: + + +

+
  \renewcommand*{\acronymsort}[2]{##2}%
-

If you prefer them to be sorted according to the short form you can -change the above to: - - - +

If you prefer them to be sorted according to the short form you can change the above +to: + +

-
+
  \renewcommand*{\acronymsort}[2]{##1}%
-

The acronym font needs to be set to \textsc and the plural suffix -adjusted so that the “s” suffix in the plural short form doesn’t get -converted to smallcaps: - - - -

-
+

The acronym font needs to be set to \textsc and the plural suffix adjusted so that +the “s” suffix in the plural short form doesn’t get converted to smallcaps: + + +

+
  \renewcommand*{\acronymfont}[1]{\textsc{##1}}%  
  \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%
-

There are a number of ways of dealing with the format in the list of -acronyms. The simplest way is to redefine \acronymentry to the long form -followed by the upper case short form in parentheses: - - - -

-
+

There are a number of ways of dealing with the format in the list of acronyms. The +simplest way is to redefine \acronymentry to the long form followed by the upper case +short form in parentheses: + + +

+
 \renewcommand*{\acronymentry}[1]{%  
   \Glsentrylong{##1}\space  
     (\MakeTextUppercase{\glsentryshort{##1}})}%
-

(I’ve used \Glsentrylong

(I’ve used \Glsentrylong instead of \glsentrylong to capitalise the -name in the glossary.) -

An alternative approach is to set \acronymentry to just the long form -and redefine \GenericAcronymFields\glsentrylong to capitalise the name in the +glossary.) +

An alternative approach is to set \acronymentry to just the long form and +redefine \GenericAcronymFields to set the symbol key to the short -form and use a glossary style that displays the symbol in parentheses after -the namesymbol key to the short form and use a +glossary style that displays the symbol in parentheses after the name (such as the tree style) like this: - - - +class="cmss-10">tree +style) like this: + +

-
+
 \renewcommand*{\acronymentry}[1]{\Glsentrylong{##1}}%  
 \renewcommand*{\GenericAcronymFields}{%  
    symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}%
-

I’m going to use the first approach and set \GenericAcronymFields

I’m going to use the first approach and set \GenericAcronymFields to do nothing: - - - + +

-
+
 \renewcommand*{\GenericAcronymFields}{}%
-

-

Finally, this style needs to switch off hyperlinks on first use to avoid -nested links: - - - +

+

Finally, this style needs to switch off hyperlinks on first use to avoid nested +links: + +

-
+
 \glshyperfirstfalse
-

Putting this all together: - - - +

Putting this all together: + +

-
+
\newacronymstyle{custom-fn}% new style name  
{%  
  \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% @@ -15323,11 +14940,10 @@ nested links:  
     \glsentrylong{##2}##3\space  
      (\acronymfont{\glsentryshort{##2}})%  
    }% - - -  
  }%  
  \renewcommand*{\Acrfullfmt}[3]{% + +  
    \glslink[##1]{##2}{%  
     \Glsentrylong{##2}##3\space  
      (\acronymfont{\glsentryshort{##2}})% @@ -15369,33 +14985,30 @@ nested links:  
     (\MakeTextUppercase{\glsentryshort{##1}})}%  
}
-

-

Now I need to specify that I want to use this new style: - - - +

+

Now I need to specify that I want to use this new style: + +

-
+
\setacronymstyle{custom-fn}
-

I also need to use a glossary style that suits this acronym style, for -example altlist

I also need to use a glossary style that suits this acronym style, for example +altlist: - - - + +

-
+
\setglossarystyle{altlist}
-

-

Once the acronym style has been set, I can define my acronyms: - - - +

+

Once the acronym style has been set, I can define my acronyms: + +

-
+
\newacronym[description={set of tags for use in  
developing hypertext documents}]{html}{html}{Hyper  
Text Markup Language} @@ -15403,288 +15016,279 @@ class="cmss-10x-x-109">altlistlayout of a document written in a markup language}]{css}  
{css}{Cascading Style Sheet}
-

-

The sample file

+

The sample file sample-custom-acronym.tex illustrates this example. +class="cmtt-10">sample-custom-acronym.tex illustrates this example.

-

-

____________________________

-

+

+

____________________________

+

-

Top

13.2  

Top

13.2 Displaying the List of Acronyms

-

The list of acronyms is just like any other type of glossary and can be -displayed on its own using

+

The list of acronyms is just like any other type of glossary and can be displayed on its +own using

\printglossary\printglossary[type=\acronymtype[type=\acronymtype] +class="cmtt-10">]
or with all the other glossaries using \printglossaries. (If you use the -acronym package option you can also use
+class="cmtt-10">\printglossaries. (If you use the acronym +package option you can also use
\printacronyms\printacronyms[<options>] +class="cmtt-10">[<options>]
as a synonym for
- - -
\printglossary\printglossary[type=\acronymtype[type=\acronymtype,<options>] +class="cmtt-10">,<options>] + +
See §2.5 §2.5 Acronym Options.) -

However, care must be taken to choose a glossary style that’s -appropriate to your acronym style. Alternatively, you can define your own -custom style (see

However, care must be taken to choose a glossary style that’s appropriate to your +acronym style. Alternatively, you can define your own custom style (see §16 Defining your own glossary style for further -details). -

+class="cmsy-10">§15.2 Defining +your own glossary style for further details). +

-

Top

13.3  

Top

13.3 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

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 +class="cmtt-10">\<acr-name> when defining the acronym +<acr-name>. +

In order to facilitate migrating from the old package to the new one, the glossaries package113.1 provides the command: -

\oldacronym 

\oldacronym  \oldacronym[<label>]{<abbrv>}{<long>}{<key-val -list>}
-

+class="cmtt-10">\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: -
\newacronymglossary package’s method of defining acronyms. It is +equivalent to: +
\newacronym[<key-val list>]{<label>}{<abbrv>}{<long>} -
+class="cmtt-10">[<key-val list>]{<label>}{<abbrv>}{<long>} +
In addition, \oldacronym\oldacronym also defines the commands \<label>, which is -equivalent to \gls\<label>, which is equivalent to +\gls{<label>}, and \<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{<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\gls or \Gls\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, but be aware that there -are some issues with using xspace

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, but be aware that there are some issues with +using xspace.2
- - - -

+href="#fn2x14" id="fn2x14-bk">13.2

+

-

The glossaries package doesn’t load the xspace package since there are -both advantages and disadvantages to using \xspace

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\<label>. If you don’t use the +xspace package you need to explicitly force a space using \␣ -(backslash space) however you can follow \<label> with additional text in -square brackets (the final optional argument to \gls\␣ (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 +class="cmss-10">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\gls). -

To illustrate this, suppose I define the acronym “abc” as follows: - - - +

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 13.2 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. - - - -

This will create the command \abc and its starred version \abc*. Table 13.2 +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 13.2: Table 13.2: The effect of using xspace with \oldacronym
+class="cmss-10">xspace with \oldacronym
+class="cmbx-10">Without xspace
Code Code With xspace With xspace Without xspace
\abc. \abc. abc. abc.
\abc xyz \abc xyz abc xyz abcxyz
\abc\ xyz \abc\ xyz abc xyz abc xyz
\abc* xyz \abc* xyz Abc xyz Abc xyz
\abc[’s] xyz \abc[’s] xyz abc [’s] xyz abc’s xyz
+class="td11"> abc’s xyz
- - - -
- - - -

Top

14  
+

+ + +

+

Top

14. Unsetting and Resetting Entry Flags

- When using \gls

When using \gls, \glspl and their upper case variants it is possible -that you may want to use the value given by the first key, even though you -have already \glspl and their upper case 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. The former can be achieved by one of the following -commands: -

\glsreset 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  \glsreset{<label>}
-

-

\glslocalreset \glsreset{<label>}
+

+

\glslocalreset  \glslocalreset{<label>}
-

+class="cmtt-10">\glslocalreset{<label>}

+

while the latter can be achieved by one of the following commands: -

\glsunset 

\glsunset  \glsunset{<label>}
-

-

\glslocalunset \glsunset{<label>}
+

+

\glslocalunset  \glslocalunset{<label>}
-

-You can also reset or unset all entries for a given glossary or list of -glossaries using: -

+

+You can also reset or unset all entries for a given glossary or list of glossaries +using: +

\glsresetall  \glsresetall[<glossary list>]
-

-

+

+

\glslocalresetall  \glslocalresetall[<glossary list>] -
-

-

+

+

\glsunsetall  \glsunsetall[<glossary list>]
-

-

+

+

\glslocalunsetall  \glslocalunsetall[<glossary list>] -
-

+class="cmtt-10">\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: - - - -

-
+class="cmmi-10"><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

+

You can determine whether an entry’s first use flag is set using: -

\ifglsused 

\ifglsused  \ifglsused{<label>}{<true part>}{<false part>} +class="cmtt-10">\ifglsused{<label>}{<true part>}{<false part>}
-

+

where <label> is the label of the required entry. If the entry has -been used, <true part> will be done, otherwise <false part> will be -done. -

Be careful when using commands such as \gls within an environment -or command argument that gets processed multiple times as it can cause -unwanted side-effects when the first use displayed text is different from -subsequent use.
-

-

For example, the frame<label> is the label of the required entry. If the entry has been used, <true +part> will be done, otherwise <false part> will be done. +

Be careful when using commands such as \gls within an environment or +command argument that gets processed multiple times as it can cause unwanted +side-effects when the first use displayed text is different from subsequent use. +
+

+

For example, the frame environment in beamer processes its argument for -each overlay. This means that the beamer processes its argument for each +overlay. This means that the first use flag will be unset on -the first overlay and subsequent overlays will use the non-first use -form. -

Consider the following example: - - - +href="#glo:firstuseflag">first use flag will be unset on the first overlay and +subsequent overlays will use the non-first use form. +

Consider the following example: + +

-
+
\documentclass{beamer}  
\usepackage{glossaries}  
\newacronym{svm}{SVM}{support vector machine} @@ -15931,22 +15529,20 @@ form.  
\end{frame}  
\end{document}
-

-

On the first overlay, \gls{svm} produces “support vector machine -(SVM)” and then unsets the

+

On the first overlay, \gls{svm} produces “support vector machine (SVM)” and +then unsets the first use flag. When the second overlay is -processed, \gls{svm} now produces “SVM”, which is unlikely to be -the desired effect. I don’t know anyway around this and the only -suggestion I can give is to explicitly reset each acronym on first -use: - - - -

-
+href="#glo:firstuseflag">first use flag. When the second overlay is processed, \gls{svm} now +produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway +around this and the only suggestion I can give is to explicitly reset each acronym on +first use: + + +

+
\begin{frame}  
 \frametitle{Frame 1}  
 \begin{itemize} @@ -15955,84 +15551,113 @@ use:  
 \end{itemize}  
\end{frame}
-

This is non-optimal, but the beamer class is too complex for me to suggest -an alternative solution. -

The amsmath

This is non-optimal, but the beamer class is too complex for me to suggest an +alternative solution. +

The amsmath environments, such as alignalign, also process their contents -multiple times, but the glossaries package now checks for this. - - - -

-

15  , also process their contents multiple +times, but the glossaries package now checks for this. + + +

+

+

Top

15. Glossary Styles

-

Glossaries vary from lists that simply contain a symbol with a terse -description to lists of terms or phrases with lengthy descriptions. -Some glossaries may have terms with associated symbols. Some -may have hierarchical entries. There is therefore no single style -that fits every type of glossary. The glossaries package comes with -a number of pre-defined glossary styles, and you need to choose -one that best suits your type of glossary. There is a summary of -available styles in table 15.1. If none of them suit your document, you -can defined your own style (see

Glossaries vary from lists that simply contain a symbol with a terse description to +lists of terms or phrases with lengthy descriptions. Some glossaries may have terms +with associated symbols. Some may have hierarchical entries. There is therefore no +single style that fits every type of glossary. The glossaries package comes with a +number of pre-defined glossary styles, described in §15.1 Predefined Styles. You can +choose one of these that best suits your type of glossary or, if none of them suit your +document, you can defined your own style (see §16 §15.2 Defining your own glossary style). -

The predefined styles can accommodate numbered level 0 (main) and -level 1 entries. See the package options entrycounter, counterwithin and -subentrycounter described in

The glossary style can be set using the style key in the optional argument to +\printglossary or using the command: +

\setglossarystyle  \setglossarystyle{<style-name>}
+

+(before the glossary is displayed). +

Some of the predefined glossary styles may also be set using the style package +option, it depends if the package in which they are defined is automatically loaded by +the glossaries package. +

+

Top

15.1 Predefined Styles

+

The predefined styles can accommodate numbered level 0 (main) and level 1 entries. +See the package options entrycounter, counterwithin and subentrycounter described in +§2.3 Glossary Appearance Options. - - - -

§2.3 Glossary Appearance Options. There is a summary of available styles in +table 15.1. +

+
+ + +

- - - -
Table 15.1: 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 Table 15.1: 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.
+class="cmtt-10">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.
+class="cmbx-10">Symbol +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓ +class="pzdr-">✓
Style Style Maximum Level Maximum Level Homograph Homograph Symbol
listdotted listdotted 0
sublistdotted sublistdotted 1
list* list* 1 ✓ ✓
altlist* altlist* 1 ✓ ✓
long*3col* long*3col* 1 ✓ ✓
long4col* long4col* 1 ✓ ✓ ✓
altlong*4col* altlong*4col* 1 ✓ ✓ ✓
long* long* 1 ✓ ✓
super*3col* super*3col* 1 ✓ ✓
super4col* super4col* 1 ✓ ✓ ✓
altsuper*4col* altsuper*4col* 1 ✓ ✓ ✓
super* super* 1 ✓ ✓
*index* *index* 2 ✓
treenoname* treenoname* — ✓ ✓ ✓
*tree* *tree* — ✓
*alttree* *alttree* — ✓
inline inline 1 ✓ ✓
- - - -
-

The glossary style can be set using the style key in the optional argument -to \printglossary or using the command: -

\setglossarystyle  \setglossarystyle{<style-name>}
-

-Some of the glossary styles may also be set using the style package option, -it depends if the package in which they are defined is automatically loaded -by the glossaries package. -

The tabular-like styles that allow multi-line descriptions -and page lists use the length \glsdescwidth \glsdescwidth -to set the width of the description column and the length -\glspagelistwidth \glspagelistwidth to set the width of the page list + + +

+
+

The tabular-like styles that allow multi-line descriptions and page lists use the +length \glsdescwidth \glsdescwidth to set the width of the description column and +the length \glspagelistwidth \glspagelistwidth to set the width of the page list column.1 +href="#fn1x16" id="fn1x16-bk">15.1 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. If you want to explicitly create a line-break within a -multi-line description in a tabular-like style it’s better to 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 - - - -

-
+class="cmtt-10">\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 it’s better to 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, -\setglossarystyle will also override any previous style definitions, so, -again - - - -

-
+

then the new definition of \glsgroupskip will not have an affect for this glossary, as +\glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also +override any previous style definitions, so, again + + +

+
\renewcommand*{\glsgroupskip}{}  
\setglossarystyle{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 \setglossarystyle, e.g.: - - - -

-
+

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 \setglossarystyle, +e.g.: + + +

+
\setglossarystyle{long}  
\renewcommand*{\glsgroupskip}{}
-

As from version 3.03, you can now use the package option nogroupskip to +

As from version 3.03, you can now use the package option nogroupskip to suppress the gap between groups for the default styles instead of redefining \glsgroupskip. -

All the styles except for the three- and four-column styles and the -listdotted style use the command -

\glspostdescription  \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. -

As from version 3.03 you can now use the package option nopostdot to -suppress this full stop. -

-

15.1  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 automatically be -available unless you use the nolist or nostyles package options. +class="cmtt-10">\glsgroupskip. +

All the styles except for the three- and four-column styles and the listdotted style +use the command +

\glspostdescription  \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. +

As from version 3.03 you can now use the package option nopostdot to suppress +this full stop. +

+

Top

15.1.1 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 automatically be available unless you use the nolist or nostyles package +options.

list
list
The list style uses the description environment. The entry name is - placed in the optional argument of the \item command (so it - will usually appear in bold by default). The 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. +class="cmss-10">list style uses the description environment. The entry name is placed in + the optional argument of the \item command (so it will usually appear in + bold by default). The 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.
listgroup
listgroup
The listgroup style is like list but the glossary groups have - headings. - - - +class="cmss-10">listgroup style is like list but the glossary groups have headings.
listhypergroup
listhypergroup
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 group is separated +class="cmss-10">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 group is separated by -

\glshypernavsep  \glshypernavsep
-

- which defaults to a vertical bar with a space on either side. - For example, to simply have a space separating each group, - do: - - - -

-
+

\glshypernavsep  \glshypernavsep
+

+ which defaults to a vertical bar with a space on either side. For example, to + simply have a space separating each group, do: + + +

+
\renewcommand*{\glshypernavsep}{\space}
-

-

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 be done after the - glossary style has been set. +

+

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 be done after the glossary style has been + set.

altlist
altlist
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, the name associated with each child entry is +class="cmss-10">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, the name associated with each child entry is ignored.
altlistgroup
altlistgroup
The altlistgroup style is like altlist but the glossary groups have +class="cmss-10">altlistgroup style is like altlist but the glossary groups have headings.
altlisthypergroup
altlisthypergroup
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. +class="cmss-10">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.
listdotted
listdotted
This style uses the description +class="cmss-10">description environment.2 +href="#fn2x16" id="fn2x16-bk">15.2 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 \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  \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. - - - + id="dx1-59033"> + and the symbol. The length +

\glslistdottedwidth  \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
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

15.2  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 automatically be available unless you use the nolong or -nostyles package options. These styles fully justify the description and -page list columns. If you want ragged right formatting instead, use -the analogous styles described in 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

15.1.2 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 automatically be available +unless you use the nolong or nostyles package options. These styles fully justify +the description and page list columns. If you want ragged right formatting +instead, use the analogous styles described in §15.3 §15.1.3 Longtable Styles (Ragged Right).

long
long
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. 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 +class="cmss-10">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. 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 parent - entries except that their name is suppressed. +class="cmtt-10">\glsdescwidth. Child entries have a similar format to the parent entries + except that their name is suppressed.
longborder
longborder
The longborder style is like long but has horizontal and - vertical lines around it. +class="cmss-10">longborder style is like long but has horizontal and vertical lines + around it.
longheader
longheader
The longheader style is like long but has a header row. +class="cmss-10">longheader style is like long but has a header row.
longheaderborder
The longheaderborder style is like longheader but - has horizontal and vertical lines around it. - - - +class="cmbx-10">longheaderborder
The longheaderborder style is like longheader but has + horizontal and vertical lines around it.
long3col
long3col
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. - 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 +class="cmss-10">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. 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 \glspagelistwidth. +class="cmtt-10">\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 lines around it.
long3colborder
long3colheader
The long3colborder style is like the long3col style but - has horizontal and vertical lines around it. +class="cmss-10">long3colheader style is like long3col but has a header row. + +
long3colheader
long3colheaderborder
The long3colheader style is like long3col but has a - header row. +class="cmss-10">long3colheaderborder style is like long3colheader + but has horizontal and vertical lines around it.
long3colheaderborder
The long3colheaderborder style is like - long3colheader but has horizontal and vertical lines around it. +class="cmbx-10">long4col
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 multi-line descriptions.
long4col
long4colborder
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 multi-line descriptions. +class="cmss-10">long4colborder style is like the long4col style but has + horizontal and vertical lines around it.
long4colborder
long4colheader
The long4colborder style is like the long4col style but - has horizontal and vertical lines around it. +class="cmss-10">long4colheader style is like long4col but has a header row.
long4colheader
long4colheaderborder
The long4colheader style is like long4col but has a - header row. +class="cmss-10">long4colheaderborder style is like long4colheader + but has horizontal and vertical lines around it.
long4colheaderborder
The long4colheaderborder style is like +class="cmbx-10">altlong4col
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 long4colheader but has horizontal and vertical lines around it. +class="cmtt-10">\glspagelistwidth. The widths of the name and symbol columns are + governed by the widest entry in the given column.
altlong4col
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 name and symbol - columns are governed by the widest entry in the given column. +class="cmbx-10">altlong4colborder
The altlong4colborder style is like the long4colborder but + allows multi-line descriptions and page lists.
altlong4colborder
altlong4colheader
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 page lists. +class="cmss-10">altlong4colheader style is like long4colheader but allows + multi-line descriptions and page lists.
altlong4colheaderborder
The altlong4colheaderborder style is like +class="cmbx-10">altlong4colheaderborder
The altlong4colheaderborder style is like long4colheaderborder but allows multi-line descriptions and page - lists.
-

-

-

Top

15.3  Longtable Styles (Ragged Right)

-

The styles described in this section are all defined in the package -glossary-longragged. These styles are analogous to those defined in -glossary-long but the multiline columns are left justified instead of fully -justified. Since these styles all use the longtable environment, they -are governed by the same parameters as that environment. The -glossary-longragged package additionally requires the array package. -Note that these styles will only be available if you explicitly load -glossary-longragged: - - - -

-
+class="cmss-10">long4colheaderborder but allows multi-line descriptions and page lists. +

+

+

Top

15.1.3 Longtable Styles (Ragged Right)

+

The styles described in this section are all defined in the package glossary-longragged. +These styles are analogous to those defined in glossary-long but the multiline +columns are left justified instead of fully justified. Since these styles all use the + + +longtable environment, they are governed by the same parameters as that +environment. The glossary-longragged package additionally requires the array +package. Note that these styles will only be available if you explicitly load +glossary-longragged: + + +

+
\usepackage{glossaries}  
\usepackage{glossary-longragged}
-

Note that you can’t set these styles using the style package option since -the styles aren’t defined until after the glossaries package has been -loaded. +

Note that you can’t set these styles using the style package option since the styles +aren’t defined until after the glossaries package has been loaded.

longragged
longragged
The longragged style has two columns: the first column - contains the entry’s name and the second column contains - the (left-justified) description followed by the longragged style has two columns: the first column contains the + entry’s name and the second column contains the (left-justified) description + followed by the 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 + id="dx1-61011">. 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 parent entries except that their name is suppressed.
longraggedborder
The longraggedborder style is like longragged but - has horizontal and vertical lines around it. -
-longraggedheader
The longraggedheader style is like longragged but - has a header row. +class="cmbx-10">longraggedborder
The longraggedborder style is like longragged but has + horizontal and vertical lines around it.
longraggedheaderborder
longraggedheader
The longraggedheaderborder style is like - longraggedheader but has horizontal and vertical lines around it. +class="cmss-10">longraggedheader style is like longragged but has a + header row.
longragged3col
The longragged3col style is like longragged but has - three columns. The first column contains the entry’s name, the - second column contains the (left justified) description and the - third column contains the (left justified) 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. - - - +class="cmbx-10">longraggedheaderborder
The longraggedheaderborder style is like + longraggedheader but has horizontal and vertical lines around it.
longragged3colborder
longragged3col
The longragged3colborder style is like the - longragged3col style but has horizontal and vertical lines around - it. +class="cmss-10">longragged3col style is like longragged but has three + columns. The first column contains the entry’s name, the second column + contains the (left justified) description and the third column contains the + (left justified) 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.
longragged3colheader
longragged3colborder
The longragged3colheader style is like +class="cmss-10">longragged3colborder style is like the longragged3col but has a header row. +class="cmss-10">longragged3col style but has horizontal and vertical lines around it.
longragged3colheaderborder
longragged3colheader
The longragged3colheaderborder style is - like longragged3colheader but has horizontal and vertical lines - around it. +class="cmss-10">longragged3colheader style is like longragged3col + but has a header row. + +
altlongragged4col
The altlongragged4col style is like longragged3col - but has an additional column in which the entry’s associated - symbol appears. 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 name and symbol columns are governed by the - widest entry in the given column. +class="cmbx-10">longragged3colheaderborder
The longragged3colheaderborder style is like + longragged3colheader but has horizontal and vertical lines around it.
altlongragged4colborder
altlongragged4col
The altlongragged4colborder style is like the +class="cmss-10">altlongragged4col style is like longragged3col but has + an additional column in which the entry’s associated symbol appears. 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 altlongragged4col but has horizontal and vertical lines around it. +class="cmtt-10">\glspagelistwidth. The widths of the name and symbol columns are + governed by the widest entry in the given column.
altlongragged4colheader
The altlongragged4colheader style is like +class="cmbx-10">altlongragged4colborder
The altlongragged4colborder style is like the altlongragged4col but has a header row. +class="cmss-10">altlongragged4col but has horizontal and vertical lines around it.
altlongragged4colheaderborder
The +class="cmbx-10">altlongragged4colheader
The altlongragged4colheader style is like altlongragged4colheaderborder style is like altlongragged4colheader - but has horizontal and vertical lines around it. +class="cmss-10">altlongragged4col but has a header row. +
+altlongragged4colheaderborder
The altlongragged4colheaderborder style is + like altlongragged4colheader but has horizontal and vertical lines around it.
-

-

-

Top

15.4  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 automatically be available unless you use 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.3 -These styles fully justify the description and page list columns. If you want -ragged right formatting instead, use the analogous styles described in

+

+

Top

15.1.4 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 automatically be available unless +you use 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.15.3 +These styles fully justify the description and page list columns. If you want ragged +right formatting instead, use the analogous styles described in §15.5 -Supertabular Styles (Ragged Right). +class="cmsy-10">§15.1.5 Supertabular +Styles (Ragged Right).

super
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 super
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. 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 + id="dx1-62017">. 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 parent entries except that their name is suppressed. +class="cmtt-10">\glsdescwidth. Child entries have a similar format to the parent + entries except that their name is suppressed.
superborder
superborder
The superborder style is like super but has horizontal and - vertical lines around it. +class="cmss-10">superborder style is like super but has horizontal and vertical + lines around it.
superheader
superheader
The superheader style is like super but has a header row. +class="cmss-10">superheader style is like super but has a header row.
superheaderborder
superheaderborder
The superheaderborder style is like superheader but - has horizontal and vertical lines around it. +class="cmss-10">superheaderborder style is like superheader but has + horizontal and vertical lines around it.
super3col
super3col
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 - 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 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. + id="dx1-62028">. 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.
super3colborder
super3colborder
The super3colborder style is like the super3col style - - - - but has horizontal and vertical lines around it. +class="cmss-10">super3colborder style is like the super3col style but has + horizontal and vertical lines around it.
super3colheader
super3colheader
The super3colheader style is like super3col but has a - header row. +class="cmss-10">super3colheader style is like super3col but has a header + row.
super3colheaderborder
The super3colheaderborder style is like the +class="cmbx-10">super3colheaderborder
The super3colheaderborder style is like the super3colheader style but has horizontal and vertical lines around - it. +class="cmss-10">super3colheader style but has horizontal and vertical lines around it.
super4col
super4col
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 for multi-line descriptions. +class="cmss-10">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 for multi-line + descriptions.
super4colborder
super4colborder
The super4colborder style is like the super4col style - but has horizontal and vertical lines around it. +class="cmss-10">super4colborder style is like the super4col style but has + horizontal and vertical lines around it.
super4colheader
super4colheader
The super4colheader style is like super4col but has a - header row. +class="cmss-10">super4colheader style is like super4col but has a header + row. + +
super4colheaderborder
The super4colheaderborder style is like the +class="cmbx-10">super4colheaderborder
The super4colheaderborder style is like the super4colheader style but has horizontal and vertical lines around - it. +class="cmss-10">super4colheader style but has horizontal and vertical lines around it.
altsuper4col
altsuper4col
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 and symbol - columns is governed by the widest entry in the given column. +class="cmss-10">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 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 and page lists. +class="cmbx-10">altsuper4colborder
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 page - lists. - - - +class="cmbx-10">altsuper4colheader
The altsuper4colheader style is like super4colheader but + allows multi-line descriptions and page lists.
altsuper4colheaderborder
The altsuper4colheaderborder style is like +class="cmbx-10">altsuper4colheaderborder
The altsuper4colheaderborder style is like super4colheaderborder but allows multi-line descriptions and page - lists.
-

-

-

Top

15.5  Supertabular Styles (Ragged Right)

-

The styles described in this section are all defined in the package -glossary-superragged. These styles are analogous to those defined in -glossary-super but the multiline columns are left justified instead of fully -justified. Since these styles all use the supertabular environment, they -are governed by the same parameters as that environment. The -glossary-superragged package additionally requires the array package. -Note that these styles will only be available if you explicitly load -glossary-superragged: - - - -

-
+class="cmss-10">super4colheaderborder but allows multi-line descriptions and page lists. +

+

+

Top

15.1.5 Supertabular Styles (Ragged Right)

+

The styles described in this section are all defined in the package glossary-superragged. +These styles are analogous to those defined in glossary-super but the multiline +columns are left justified instead of fully justified. Since these styles all use the +supertabular environment, they are governed by the same parameters as that +environment. The glossary-superragged package additionally requires the array +package. Note that these styles will only be available if you explicitly load +glossary-superragged: + + +

+
\usepackage{glossaries}  
\usepackage{glossary-superragged}
-

Note that you can’t set these styles using the style package option since -the styles aren’t defined until after the glossaries package has been -loaded. +

Note that you can’t set these styles using the style package option since the styles +aren’t defined until after the glossaries package has been loaded.

superragged
superragged
The superragged 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 (left justified) 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 parent entries except that their name is - suppressed. +class="cmss-10">superragged 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 (left justified) + 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 parent entries except that their name is suppressed.
superraggedborder
superraggedborder
The superraggedborder style is like superragged but - has horizontal and vertical lines around it. +class="cmss-10">superraggedborder style is like superragged but has + horizontal and vertical lines around it.
superraggedheader
The superraggedheader style is like superragged - but has a header row. +class="cmbx-10">superraggedheader
The superraggedheader style is like superragged but has a + header row.
superraggedheaderborder
The superraggedheaderborder style is like - superraggedheader but has horizontal and vertical lines around +class="cmbx-10">superraggedheaderborder
The superraggedheaderborder + style is like superraggedheader but has horizontal and vertical lines around it.
superragged3col
superragged3col
The superragged3col style is like superragged but has - three columns. The first column contains the entry’s name, the - second column contains the (left justified) description and the - third column contains the (left justified) superragged3col style is like superragged but has three + columns. The first column contains the entry’s name, the second column + contains the (left justified) description and the third column contains the + (left justified) 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. - - - + id="dx1-63025">. 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.
superragged3colborder
The superragged3colborder style is like the +class="cmbx-10">superragged3colborder
The superragged3colborder style is like the superragged3col style but has horizontal and vertical lines around - it. +class="cmss-10">superragged3col style but has horizontal and vertical lines around it.
superragged3colheader
The superragged3colheader style is like +class="cmbx-10">superragged3colheader
The superragged3colheader style is like superragged3col but has a header row. +class="cmss-10">superragged3col but has a header row. + +
superragged3colheaderborder
superragged3colheaderborder
The superragged3colheaderborder style - is like superragged3colheader but has horizontal and vertical lines - around it. +class="cmss-10">superragged3colheaderborder style is like + superragged3colheader but has horizontal and vertical lines around it.
altsuperragged4col
The altsuperragged4col style is - like superragged3col but has an additional column in which the - entry’s associated symbol appears. The column widths for the - name and symbol column are governed by the widest entry in - the given column. +class="cmbx-10">altsuperragged4col
The altsuperragged4col style is like superragged3col but has + an additional column in which the entry’s associated symbol appears. The + column widths for the name and symbol column are governed by the widest + entry in the given column.
altsuperragged4colborder
altsuperragged4colborder
The altsuperragged4colborder style is like - the altsuperragged4col style but has horizontal and vertical lines - around it. +class="cmss-10">altsuperragged4colborder style is like the + altsuperragged4col style but has horizontal and vertical lines around it.
altsuperragged4colheader
The altsuperragged4colheader style is like +class="cmbx-10">altsuperragged4colheader
The altsuperragged4colheader style is like altsuperragged4col but has a header row. +class="cmss-10">altsuperragged4col but has a header row.
altsuperragged4colheaderborder
The altsuperragged4colheaderborder - style is like altsuperragged4colheader but has horizontal and - vertical lines around it. +class="cmbx-10">altsuperragged4colheaderborder
The altsuperragged4colheaderborder style + is like altsuperragged4colheader but has horizontal and vertical lines around + it.
-

-

-

Top

15.6  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 -automatically be available unless you use the notree or nostyles package -options. +

+

+

Top

15.1.6 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 automatically be available unless you use 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 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. +class="cmbx-10">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 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
indexgroup
The indexgroup style is similar to the index style except - that each group has a heading. +class="cmss-10">indexgroup style is similar to the index style except that each + group has a heading. + +
indexhypergroup
indexhypergroup
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. +class="cmss-10">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.
tree
tree
The tree style is similar to the index style except that it can have - arbitrary levels. (Note that 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 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 \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 +class="cmtt-10">xindy if you want more than three levels.) Each sub-level is indented by + \glstreeindent \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.)
treegroup
treegroup
The treegroup style is similar to the tree style except that - each group has a heading. +class="cmss-10">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 groups. The navigation line is the - same as that for listhypergroup, described above. +class="cmbx-10">treehypergroup
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.
treenoname
treenoname
The treenoname style is like the tree style except that the - name for each sub-entry is ignored. - - - +class="cmss-10">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 has a heading. +class="cmbx-10">treenonamegroup
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 glossary groups. The +class="cmbx-10">treenonamehypergroup
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. +class="cmss-10">listhypergroup, described above.
alttree
alttree
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  \glssetwidest[<level>]{<text>}
-

+class="cmss-10">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  \glssetwidest[<level>]{<text>}
+

The optional argument <level> indicates the level, where 0 indicates - the top-most level, 1 indicates the first level sub-entries, etc. If +class="cmmi-10"><level> indicates the level, where 0 indicates the + top-most level, 1 indicates the first level sub-entries, etc. If \glssetwidest + hasn’t been used for a given sub-level, the level 0 widest text is used instead. If \glssetwidest hasn’t been used for a given sub-level, the - level 0 widest text is used instead. If <level> is omitted, 0 is - assumed. -

For each level, the name is placed to the left of the paragraph - block containing the symbol (optional) and the description. If - the symbol is present, it is placed in parentheses before the - description. +class="cmmi-10"><level> is omitted, 0 is assumed. +

For each level, the name is placed to the left of the paragraph block containing + the symbol (optional) and the description. If the symbol is present, it is placed + in parentheses before the description. + +

alttreegroup
alttreegroup
The alttreegroup is like the alttree style except that each - group has a heading. +class="cmss-10">alttreegroup is like the alttree style except that each group has a + heading.
alttreehypergroup
alttreehypergroup
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. +class="cmss-10">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.
-

-

-

Top

15.7  Multicols Style

- - - -

The glossary-mcols package provides tree-like styles that are in the multicols +

+

+

Top

15.1.7 Multicols Style

+

The glossary-mcols package provides tree-like styles that are in the multicols environment (defined by the multicol package). The style names are as their -analogous tree styles (as defined in multicol package). The style names are as their analogous +tree styles (as defined in §15.6 Tree-Like Styles) but are prefixed -with “mcol”. For example, the mcolindex style is essentially the index -style but put in a multicols environment. For the complete list, see -table 15.2. -

Note that glossary-mcols is not loaded by glossaries. If you want to -use any of the multicol styles in that package you need to load it -explicitly with \usepackage and set the required glossary style using -\setglossarystyle.
-

-

The default number of columns is 2, but can be changed by redefining -

\glsmcols  \glsmcols
-

+class="cmsy-10">§15.1.6 Tree-Like Styles) but are prefixed with “mcol”. For +example, the mcolindex style is essentially the index style but put in a multicols +environment. For the complete list, see table 15.2. +

Note that glossary-mcols is not loaded by glossaries. If you want to use +any of the multicol styles in that package you need to load it explicitly with +\usepackage and set the required glossary style using \setglossarystyle. +
+

+

The default number of columns is 2, but can be changed by redefining +

\glsmcols  \glsmcols
+

to the required number. For example, for a three column glossary: - - - + +

-
+
\usepackage{glossary-mcols}  
\renewcommand*{\glsmcols}{3}  
\setglossarystyle{mcolindex}
-

- - - -

+

+
+ + +

- - - -
Table 15.2: Multicolumn Styles
+ + +
Table 15.2: Multicolumn Styles
+class="cmbx-10">Analogous Tree Style index +class="cmss-10">indexgroup +class="cmss-10">indexhypergrouptree +class="cmss-10">treegroup +class="cmss-10">treehypergroup +class="cmss-10">treenoname +class="cmss-10">treenonamegroup +class="cmss-10">treenonamehypergroup +class="cmss-10">alttree +class="cmss-10">alttreegroup
glossary-mcols Style glossary-mcols Style Analogous Tree Style
mcolindex mcolindex index
mcolindexgroup mcolindexgroup indexgroup
mcolindexhypergroup mcolindexhypergroup indexhypergroup
mcoltree mcoltree tree
mcoltreegroup mcoltreegroup treegroup
mcoltreehypergroup mcoltreehypergroup treehypergroup
mcoltreenoname mcoltreenoname treenoname
mcoltreenonamegroup mcoltreenonamegroup treenonamegroup
mcoltreenonamehypergroup mcoltreenonamehypergroup treenonamehypergroup
mcolalttree mcolalttree alttree
mcolalttreegroup mcolalttreegroup alttreegroup
mcolalttreehypergroup mcolalttreehypergroup alttreehypergroup
- - - -
-

Top

15.8  In-Line Style

-

This section covers the glossary-inline package that supplies the inline style. -This is a style that is designed for in-line use (as opposed to block -styles, such as lists or tables). This style doesn’t display the number -list. -

You will most likely need to redefine \glossarysection with this style. -For example, suppose you are required to have your glossaries and list of -acronyms in a footnote, you can do: - - - -

-
+class="cmss-10">alttreehypergroup
+ + +
+
+

Top

15.1.8 In-Line Style

+

This section covers the glossary-inline package that supplies the inline style. This is a +style that is designed for in-line use (as opposed to block styles, such as lists or +tables). This style doesn’t display the number list. +

You will most likely need to redefine \glossarysection with this style. For +example, suppose you are required to have your glossaries and list of acronyms in a +footnote, you can do: + + +

+
 \usepackage{glossary-inline}  
 \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }  
 \setglossarystyle{inline}
-

-

Note that you need to include glossary-inline with \usepackage as it’s -not automatically included by the glossaries package and then set the style -using \setglossarystyle.
-

-

Where you need to include your glossaries as a footnote you can -do: - - - -

-
+

+

Note that you need to include glossary-inline with \usepackage as it’s not +automatically included by the glossaries package and then set the style using +\setglossarystyle.
+

+

Where you need to include your glossaries as a footnote you can do: + + +

+
\footnote{\printglossaries}
-

-

The inline style is governed by the following: -

\glsinlineseparator  \glsinlineseparator
-

+

+

The inline style is governed by the following: +

\glsinlineseparator  \glsinlineseparator
+

This defaults to “; ” and is used between main (i.e. level 0) entries. -

\glsinlinesubseparator  \glsinlinesubseparator
-

+class="cmtt-10">; ” and is used between main (i.e. level 0) entries. +

\glsinlinesubseparator  \glsinlinesubseparator
+

This defaults to “, ” and is used between sub-entries. -

\glsinlineparentchildseparator  \glsinlineparentchildseparator +class="cmtt-10">, ” and is used between sub-entries. +

\glsinlineparentchildseparator  \glsinlineparentchildseparator
-

+

This defaults to “: ” and is used between a parent main entry and its first +class="cmtt-10">: ” and is used between a parent main entry and its first sub-entry. -

\glspostinline  \glspostinline
-

+

\glspostinline  \glspostinline
+

This defaults to “; ” and is used at the end of the glossary. - - - -

-

Top

16  Defining your own glossary style

- If the predefined styles don’t fit your requirements, you can define your -own style using: -

\newglossarystyle  \newglossarystyle{<name>}{<definitions>} +class="cmtt-10">; ” and is used at the end of the glossary. +

+

+

Top

15.2 Defining your own glossary style

+

If the predefined styles don’t fit your requirements, you can define your own style +using: +

\newglossarystyle  \newglossarystyle{<name>}{<definitions>}
-

+

where <name> is the name of the new glossary style (to be used in -\setglossarystyle). The second argument <definitions> needs to -redefine all of the following: -

theglossary  theglossary
-

-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, so the theglossary environment is simply redefined -to begin and end the description environment. -

\glossaryheader  \glossaryheader
-

-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 glossary style redefines \glossaryheader to do a header -row. -

\glsgroupheading  \glsgroupheading{<label>}
-

-This macro indicates what to do at the start of each logical block within -the main body of the glossary. If you use <name> is the name of the new glossary style (to be used in \setglossarystyle). +The second argument <definitions> needs to redefine all of the following: +

theglossary  theglossary
+

+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, so the theglossary +environment is simply redefined to begin and end the description environment. +

\glossaryheader  \glossaryheader
+

+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 glossary style redefines \glossaryheader to do a +header row. +

\glsgroupheading  \glsgroupheading{<label>}
+

+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 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  \glsgetgrouptitle{<label>}
-

+class="cmtt-10">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  \glsgetgrouptitle{<label>}
+

This obtains the title as follows: if <label> consists of a single non-active -character or <label> is equal to glssymbols or glsnumbers and -\<label>groupname exists, this is taken to be the title, otherwise the title -is just <label>. (The “symbols” group has the label glssymbols, so the - - - -command \glssymbolsgroupname is used, and the “numbers” group has -the label glsnumbers, so the command \glsnumbersgrouptitle is -used.) If you are using <label> consists of a single non-active character or +<label> is equal to glssymbols or glsnumbers and \<label>groupname exists, this is +taken to be the title, otherwise the title is just <label>. (The “symbols” +group has the label glssymbols, so the command \glssymbolsgroupname is +used, and the “numbers” group has the label glsnumbers, so the command +\glsnumbersgrouptitle is used.) If you are using xindy, <label> may be an active character -(for example ø), in which case the title will be set to just <label>. -You can redefine \glsgetgrouptitle if this is unsuitable for your +class="cmtt-10">xindy, <label> may be an +active character (for example ø), in which case the title will be set to just +<label>. You can redefine \glsgetgrouptitle if this is unsuitable for your document. -

A navigation hypertarget can be created using -

\glsnavhypertarget  \glsnavhypertarget{<label>}{<text>} -
-

+

A navigation hypertarget can be created using +

\glsnavhypertarget  \glsnavhypertarget{<label>}{<text>}
+

For further details about \glsnavhypertarget, see the documented code +class="cmtt-10">\glsnavhypertarget, see the documented code (glossaries-code.pdf). -

Most of the predefined glossary styles redefine \glsgroupheading -to simply ignore its argument. The listhypergroup style redefines -\glsgroupheading as follows: - - - +class="cmtt-10">glossaries-code.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}}]}
-

See also \glsgroupskip below. (Note that command definitions within -\newglossarystyle must use ##1 instead of #1 etc.) -

\glsgroupskip  \glsgroupskip
-

-This macro determines what to do after one logical group but before 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. -

As from version 3.03, the package option nogroupskip can be used to -suppress this default gap for the predefined styles. -

\glossentry  \glossentry{<label>}{<number list>}
-

-This macro indicates what to do for each level 0 glossary entry. The entry -label is given by <label> and the associated

See also \glsgroupskip below. (Note that command definitions within +\newglossarystyle must use ##1 instead of #1 etc.) +

\glsgroupskip  \glsgroupskip
+

+This macro determines what to do after one logical group but before 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. +

As from version 3.03, the package option nogroupskip can be used to suppress this +default gap for the predefined styles. +

\glossentry  \glossentry{<label>}{<number list>}
+

+This macro indicates what to do for each level 0 glossary entry. The entry label is +given by <label> and the associated number list is given by -<number list>. You can redefine \glossentry to use commands -like \glossentryname{<label>}, \glossentrydesc{<label>} and -\glossentrysymbol{<label>} to display the name, description -and symbol fields, or to access other fields, use commands like -\glsentryuseri{<label>}. (See is given by <number list>. You can +redefine \glossentry to use commands like \glossentryname{<label>}, +\glossentrydesc{<label>} and \glossentrysymbol{<label>} to display the name, +description and symbol fields, or to access other fields, use commands like +\glsentryuseri{<label>}. (See §9 Using Glossary Terms Without Links -for further details.) You can also use the following commands: -

\glsentryitem  \glsentryitem{<label>}
-

-This macro will increment and display the associated counter for the main -(level 0) entries if the entrycounter or counterwithin package options -have been used. This macro is typically called by \glossentry -before \glstarget. The format of the counter is controlled by the -macro -

\glsentrycounterlabel  \glsentrycounterlabel
-

-

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

\glstarget  \glstarget{<label>}{<text>}
-

+class="cmsy-10">§9 Using Glossary Terms Without Links for further +details.) You can also use the following commands: +

\glsentryitem  \glsentryitem{<label>}
+

+This macro will increment and display the associated counter for the main (level 0) +entries if the entrycounter or counterwithin package options have been used. This macro +is typically called by \glossentry before \glstarget. The format of the counter is +controlled by the macro +

\glsentrycounterlabel  \glsentrycounterlabel
+

+

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

\glstarget  \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 \glossentry as follows: - - - -

-
+class="cmmi-10"><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 \glossentry as follows: + + +

+
  \renewcommand*{\glossentry}[2]{%  
    \item[\glsentryitem{##1}%  
          \glstarget{##1}{\glossentryname{##1}}]  
       \glossentrydesc{##1}\glspostdescription\space ##2}
-

-

Note also that <number list> will always be of the form -

\glossaryentrynumbers{\relax

+

Note also that <number list> will always be of the form +

\glossaryentrynumbers{\relax
\setentrycounter[<Hprefix>]{<counter name>}<format -cmd>{<number(s)>}}
-

+class="cmtt-10">\setentrycounter[<Hprefix>]{<counter name>}<format cmd>{<number(s)>}} +

+

where <number(s)> may contain \delimN (to delimit individual numbers) -and/or \delimR (to indicate a range of numbers). There may be -multiple occurrences of \setentrycounter[<Hprefix>]{<counter -name>}<format cmd>{<number(s)>}, but note that -the entire number list is enclosed within the argument of -\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 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 +class="cmmi-10"><number(s)> may contain \delimN (to delimit individual numbers) and/or +\delimR (to indicate a range of numbers). There may be multiple occurrences of +\setentrycounter[<Hprefix>]{<counter name>}<format cmd>{<number(s)>}, +but note that the entire number list is enclosed within the argument of +\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 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. -

\subglossentry  \subglossentry{<level>}{<label>}{<number -list>}
-

+

\subglossentry  \subglossentry{<level>}{<label>}{<number list>} +
+

This 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 -\glossentry described above. -

\glssubentryitem  \glssubentryitem{<label>}
-

-This macro will increment and display the associated counter for the -level 1 entries if the subentrycounter package option has been used. This -macro is typically called by \subglossentry before \glstarget. The -format of the counter is controlled by the macro -

\glssubentrycounterlabel  \glssubentrycounterlabel
-

- - - -

Note that \printglossary (which \printglossaries calls) sets -

\currentglossary  \currentglossary
-

-to the current glossary label, so it’s possible to create a glossary style that -varies according to the glossary type. -

For further details of these commands, see “Displaying the glossary” in -the documented code (glossaries-code.pdf). +class="cmmi-10"><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 \glossentry described +above. +

\glssubentryitem  \glssubentryitem{<label>}
+

+This macro will increment and display the associated counter for the level 1 entries if +the subentrycounter package option has been used. This macro is typically called by +\subglossentry before \glstarget. The format of the counter is controlled by the +macro +

\glssubentrycounterlabel  \glssubentrycounterlabel
+

+

Note that \printglossary (which \printglossaries calls) sets +

\currentglossary  \currentglossary
+

+to the current glossary label, so it’s possible to create a glossary style that varies +according to the glossary type. + + +

For further details of these commands, see “Displaying the glossary” in the +documented code (glossaries-code.pdf). -

+

Example 20 (Creating a completely new style) -

If you want a completely new style, you will need to redefine all of the -commands and the environment listed above. -

For example, suppose you want each entry to start with a bullet point. -This means that the glossary should be placed in the 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 should do nothing) -and suppose you don’t want anything to appear immediately after + id="x1-67075"> +

If you want a completely new style, you will need to redefine all of the commands +and the environment listed above. +

For example, suppose you want each entry to start with a bullet point. This means +that the glossary should be placed in the 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 should do +nothing) and suppose you don’t want anything to appear 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 \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 at the end. Then you can create this new -glossary style, called, say, mylist, as follows: - - - + id="dx1-67084"> should appear within square brackets at the +end. Then you can create this new glossary style, called, say, mylist, as +follows: + +

-
+
 \newglossarystyle{mylist}{%  
 % put the glossary in the itemize environment:  
 \renewenvironment{theglossary}% @@ -18389,42 +17891,40 @@ class="cmtt-10x-x-109">mylist, as follows:  
   \glossentry{##2}{##3}}%  
 }
-

Note that this style creates a flat glossary, where sub-entries are -displayed in exactly the same way as the top level entries. It also -hasn’t used \glsentryitem or \glssubentryitem so it won’t be -affected by the entrycounter, counterwithin or subentrycounter package -options. -

Variations:

+

Note that this style creates a flat glossary, where sub-entries are displayed in exactly +the same way as the top level entries. It also hasn’t used \glsentryitem or +\glssubentryitem so it won’t be affected by the entrycounter, counterwithin or +subentrycounter package options. +

Variations:

    -
  • You might want the entry name to be capitalised, in which case - use \Glossentryname instead of \glossentryname. -
    • -
  • You might want to check if the symbol hasn’t been set and omit the - parentheses if the symbol is absent. In this case you can use +
  • You might want the entry name to be capitalised, in which case use \ifglshassymbol (see \Glossentryname instead of \glossentryname. +
    • +
  • You might want to check if the symbol hasn’t been set and omit the parentheses + if the symbol is absent. In this case you can use \ifglshassymbol (see §17 §16 + Utilities): - - - -
    + + +
     \renewcommand*{\glossentry}[2]{%  
     \item % bullet point  
     \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -18437,87 +17937,82 @@ href="#sec:utilities">Utilities):  
     \space [##2]% the number list in square brackets  
     }%
    -

+

-

-

____________________________

+

+

____________________________

-

+

Example 21 (Creating a new glossary style based on an +class="cmbx-12"> (Creating a new glossary style based on an existing existing style) -

If you want to define a new style that is a slightly modified version of an +class="cmbx-12">style) +

If you want to define a new style that is a slightly modified version of an existing style, you can use \setglossarystyle 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 vertical space created by \indexspace between -groups, then you can create a new glossary style called, say, mylist as -follows: - - - -

-
+class="cmtt-10">\setglossarystyle 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 vertical space +created by \indexspace between groups, then you can create a new glossary style +called, say, mylist as follows: + + +

+
\newglossarystyle{mylist}{%  
\setglossarystyle{list}% base this style on the list style  
\renewcommand{\glsgroupskip}{}% make nothing happen  
                              % between groups  
}
-

(In this case, you can actually achieve the same effect using the list style in +

(In this case, you can actually achieve the same effect using the list style in combination with the package option nogroupskip.)

+class="cmss-10">nogroupskip.)

-

-

____________________________

+

+

____________________________

-

+

Example 22 (Example: creating a glossary style that uses +class="cmbx-12"> (Example: creating a glossary style that uses the the user1, …, user6 keys) -

Suppose each entry not only has an associated symbol, but also units -(stored in user1) and dimension (stored in user2). Then you can -define a glossary style that displays each entry in a longtable as -follows: - - - -

-
+ id="x1-67104"> +

Suppose each entry not only has an associated symbol, but also units (stored in +user1) and dimension (stored in user2). Then you can define a glossary style that +displays each entry in a longtable as follows: + + +

+
\newglossarystyle{long6col}{%  
 % put the glossary in a longtable environment:  
 \renewenvironment{theglossary}% @@ -18556,1170 +18051,1215 @@ follows:  
 \renewcommand*{\glsgroupskip}{}%  
}
-

+

-

-

____________________________

- - - -

17  

+

____________________________

+ + +

+

Top

16. Utilities

-

This section describes some utility commands. Additional commands can -be found in the documented code (glossaries-code.pdf). -

\forallglossaries  \forallglossaries[<glossary -list>]{<cs>}{<body>}
-

+

This section describes some utility commands. Additional commands can be found +in the documented code (glossaries-code.pdf). +

Some of the commands described here take a comma-separated list as an +argument. As with LATEX’s \@for command, make sure your list doesn’t have an +unwanted spaces in it as they don’t get stripped.
+

+

\forallglossaries  \forallglossaries[<glossary list>]{<cs>}{<body>} +
+

This iterates through <glossary list>, a comma-separated list of glossary -labels (as supplied when the glossary was defined). At each iteration <cs> -(which must be a control sequence) is set to the glossary label for the -current iteration and <body> is performed. If <glossary list> is omitted, -the default is to iterate over all glossaries. -

\forglsentries  \forglsentries[<glossary label>]{<cs>}{<body>} +class="cmmi-10"><glossary list>, a comma-separated list of glossary labels (as +supplied when the glossary was defined). At each iteration <cs> (which must be a +control sequence) is set to the glossary label for the current iteration and <body> is +performed. If <glossary list> is omitted, the default is to iterate over all +glossaries. +

\forglsentries  \forglsentries[<glossary label>]{<cs>}{<body>}
-

+

This iterates through all entries in the glossary given by <glossary label>. -At each iteration <cs> (which must be a control sequence) is set to the -entry label for the current iteration and <body> is performed. If <glossary -label> is omitted, \glsdefaulttype (usually the main glossary) is -used. -

\forallglsentries  \forallglsentries[<glossary -list>]{<cs>}{<body>}
-

+class="cmmi-10"><glossary label>. At each +iteration <cs> (which must be a control sequence) is set to the entry label for the +current iteration and <body> is performed. If <glossary label> is omitted, +\glsdefaulttype (usually the main glossary) is used. +

\forallglsentries  \forallglsentries[<glossary list>]{<cs>}{<body>} +
+

This is like \forglsentries but for each glossary in <glossary list> (a -comma-separated list of glossary labels). If <glossary list> is omitted, the -default is the list of all defined glossaries. At each iteration <cs> -is set to the entry label and <body> is performed. (The current -glossary label can be obtained using \glsentrytype{<cs>} within -<body>.) -

\forglsentries but for each glossary in <glossary list> (a comma-separated +list of glossary labels). If <glossary list> is omitted, the default is the list of all +defined glossaries. At each iteration <cs> is set to the entry label and <body> is +performed. (The current glossary label can be obtained using \glsentrytype{<cs>} +within <body>.) +

\ifglossaryexists  \ifglossaryexists  \ifglossaryexists<label><true part><false -part>
-

+class="cmmi-10"><label><true part><false part> +

+

This checks if the glossary given by <label> exists. If it does <true part> -is performed, otherwise <false part>. -

<label> exists. If it does <true part> is +performed, otherwise <false part>. +

\ifglsentryexists  \ifglsentryexists  \ifglsentryexists<label><true part><false -part>
-

+class="cmmi-10"><label><true part><false part> +

+

This checks if the glossary entry given by <label> exists. If it does <true -part> is performed, otherwise <false part>. (Note that \ifglsentryexists -will always be true after the containing glossary has been displayed via -\printglossary or \printglossaries even if the entry is explicitly -defined later in the document. This is because the entry has to be defined -before it can be displayed in the glossary, see <label> exists. If it does <true part> is +performed, otherwise <false part>. (Note that \ifglsentryexists will always be +true after the containing glossary has been displayed via \printglossary or +\printglossaries even if the entry is explicitly defined later in the document. This is +because the entry has to be defined before it can be displayed in the glossary, see +§4.8.1 Technical Issues for -further details.) - - - -

\glsdoifexists  \glsdoifexists{<label>}{<code>}
-

+class="cmsy-10">§4.8.1 Technical Issues for further details.) + + +

\glsdoifexists  \glsdoifexists{<label>}{<code>}
+

Does <code> if the entry given by <label> exists. If it doesn’t exist, an -error is generated. (This command uses \ifglsentryexists.) -

\glsdoifnoexists  \glsdoifnoexists{<label>}{<code>} -
-

+class="cmmi-10"><code> if the entry given by <label> exists. If it doesn’t exist, an error is +generated. (This command uses \ifglsentryexists.) +

\glsdoifnoexists  \glsdoifnoexists{<label>}{<code>}
+

Does the reverse of \glsdoifexists. (This command uses -\ifglsentryexists.) -

\ifglsused  \ifglsused<label><true part><false part> +class="cmtt-10">\glsdoifexists. (This command uses \ifglsentryexists.) +

\glsdoifexistsorwarn  \glsdoifexistsorwanr{<label>}{<code>}
-

+

+As \glsdoifexists but issues a warning rather than an error if the entry doesn’t +exist. +

\ifglsused  \ifglsused<label><true part><false part>
+

See §14 §14 Unsetting and Resetting Entry Flags. -

\ifglshaschildren  \ifglshaschildren  \ifglshaschildren<label><true part><false -part>
-

+class="cmmi-10"><label><true part><false part> +

+

This checks if the glossary entry given by <label> has any sub-entries. If it -does, <true part> is performed, otherwise <false part>. -

<label> has any sub-entries. If it does, +<true part> is performed, otherwise <false part>. +

\ifglshasparent  \ifglshasparent  \ifglshasparent<label><true part><false -part>
-

+class="cmmi-10"><label><true part><false part> +

+

This checks if the glossary entry given by <label> has a parent entry. If it -does, <true part> is performed, otherwise <false part>. -

\ifglshassymbol  \ifglshassymbol{<label>}{<true part>}{<false -part>}
-

+class="cmmi-10"><label> has a parent entry. If it does, <true +part> is performed, otherwise <false part>. +

\ifglshassymbol  \ifglshassymbol{<label>}{<true part>}{<false part>} +
+

This checks if the glossary entry given by <label> has had the symbol field -set. If it has, <true part> is performed, otherwise <false part>. -

\ifglshaslong  \ifglshaslong{<label>}{<true part>}{<false -part>}
-

+class="cmmi-10"><label> has had the symbol field set. If it +has, <true part> is performed, otherwise <false part>. +

\ifglshaslong  \ifglshaslong{<label>}{<true part>}{<false part>} +
+

This checks if the glossary entry given by <label> has had the long field -set. If it has, <true part> is performed, otherwise <false part>. This -should be true for any entry that has been defined via \newacronym. -

\ifglshasshort  \ifglshasshort{<label>}{<true part>}{<false -part>}
-

+class="cmmi-10"><label> has had the long field set. If it has, +<true part> is performed, otherwise <false part>. This should be true for any entry +that has been defined via \newacronym. There is no check for the existance of +<label>. +

\ifglshasshort  \ifglshasshort{<label>}{<true part>}{<false part>} +
+

This checks if the glossary entry given by <label> has had the short field -set. If it has, <true part> is performed, otherwise <false part>. This -should be true for any entry that has been defined via \newacronym. -

\ifglshasdesc  \ifglshasdesc{<label>}{<true part>}{<false -part>}
-

- - - +class="cmmi-10"><label> has had the short field set. If it has, +<true part> is performed, otherwise <false part>. This should be true for any entry +that has been defined via \newacronym. There is no check for the existance of +<label>. +

\ifglshasdesc  \ifglshasdesc{<label>}{<true part>}{<false part>} +
+ + +

This checks if the description field is non-empty for the entry given by -<label>. If it has, <true part> is performed, otherwise <false part>. -Compare with: -

\ifglsdescsuppressed  \ifglsdescsuppressed{<label>}{<true -part>}{<false part>}
-

+class="cmss-10">description field is non-empty for the entry given by <label>. If it +has, <true part> is performed, otherwise <false part>. Compare with: +

\ifglsdescsuppressed  \ifglsdescsuppressed{<label>}{<true part>}{<false +part>}
+

This checks if the description field has been set to just \nopostdesc for the -entry given by <label>. If it has, <true part> is performed, otherwise -<false part>. - - - -

-

18  description field has been set to just \nopostdesc for the entry given +by <label>. If it has, <true part> is performed, otherwise <false part>. There is no +check for the existance of <label>. +

For all other fields you can use: +

\ifglshasfield{<field>}{<label>}{<true part>}{<false part>} +
+

+This checks if the field given by <field> for the entry identified by <label> is empty. If +it is, <true part> is performed, otherwise <false part>. If the field supplied is +unrecognised <false part> is performed and a warning is issued. Unlike the +above commands, such as \ifglshasshort, an error occurs if the entry is +undefined. + + +

+

+

Top

17. Prefixes or Determiners

-

The glossaries-prefix package provides additional keys that can be used as -prefixes. For example, if you want to specify determiners (such as “a”, “an” -or “the”). The glossaries-prefix package automatically loads the glossaries -package and has the same package options. -

The extra keys for \newglossaryentry are as follows: +

The glossaries-prefix package provides additional keys that can be used as prefixes. +For example, if you want to specify determiners (such as “a”, “an” or “the”). The +glossaries-prefix package automatically loads the glossaries package and has the same +package options. +

The extra keys for \newglossaryentry are as follows:

prefix
prefix
The prefix associated with the text key. This defaults to nothing. +class="cmss-10">text key. This defaults to nothing.
prefixplural
prefixplural
The prefix associated with the plural key. This defaults to - nothing. +class="cmss-10">plural key. This defaults to nothing.
prefixfirst
prefixfirst
The prefix associated with the first key. If omitted, this - defaults to the value of the prefix key. +class="cmss-10">first key. If omitted, this defaults to + the value of the prefix key.
prefixfirstplural
The prefix associated with the firstplural key. If - omitted, this defaults to the value of the prefixplural key.
+class="cmssbx-10">prefixfirstplural
The prefix associated with the firstplural key. If omitted, this + defaults to the value of the prefixplural key.
-

+

Example 23 (Defining Determiners) -

Here’s the start of my example document: - - - + id="x1-69014"> +

Here’s the start of my example document: + +

-
+
documentclass{article}  
\usepackage[colorlinks]{hyperref}  
\usepackage[toc,acronym]{glossaries-prefix}
-

Note that I’ve simply replaced glossaries from previous +

Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample +class="cmss-10">glossaries-prefix. Now for a sample definition1: - - - +href="#fn1x18" id="fn1x18-bk">17.1: + +

-
+
\newglossaryentry{sample}{name={sample},%  
  description={an example},%  
  prefix={a~},%  
  prefixplural={the\space}%  
}
-

Note that I’ve had to explicitly insert a space after the prefix. This allows -for the possibility of prefixes that shouldn’t have a space, such -as: - - - +

Note that I’ve had to explicitly insert a space after the prefix. This allows for the +possibility of prefixes that shouldn’t have a space, such as: + +

-
+
\newglossaryentry{oeil}{name={oeil},  
  plural={yeux},  
  description={eye},  
  prefix={l’},  
  prefixplural={les\space}}
-

Where a space is required at the end of the prefix, you must use -a spacing command, such as \space, \␣ (backslash space) or ~ due to -the automatic spacing trimming performed in <key>=<value> -options. -

The prefixes can also be used with acronyms. For example: - - - -

-
+

Where a space is required at the end of the prefix, you must use a spacing command, +such as \space, \␣ (backslash space) or ~ due to the automatic spacing trimming +performed in <key>=<value> options. +

The prefixes can also be used with acronyms. For example: + + +

+
\newacronym  
 [%  
   prefix={an\space},prefixfirst={a~}%  
 ]{svm}{SVM}{support vector machine}
-

+

-

-

____________________________

-

The glossaries-prefix package provides convenient commands to use these -prefixes with commands such as \gls. Note that the prefix is not -considered part of the

+

____________________________

+

The glossaries-prefix package provides convenient commands to use these prefixes +with commands such as \gls. Note that the prefix is not considered part +of the link text, so it’s not included in the hyperlink (where -hyperlinks are enabled). -

\pgls  \pgls[<options>]{<label>}[<insert>]
-

+ id="dx1-69020">, so it’s not included in the hyperlink (where hyperlinks are +enabled). +

\pgls  \pgls[<options>]{<label>}[<insert>]
+

This is prepends the value of the prefix key (or prefixfirst key, on first use) -in front of \gls[<options>]{<label>}[<insert>]. -

\Pgls  \Pgls[<options>]{<label>}[<insert>]
-

+class="cmss-10">prefix key (or prefixfirst key, on first use) in front of +\gls[<options>]{<label>}[<insert>]. +

\Pgls  \Pgls[<options>]{<label>}[<insert>]
+

If the prefix key (or prefixfirst, on first use) has been set, this displays the +class="cmss-10">prefix key (or prefixfirst, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \gls[<options>]{<label>}[<insert>]. If that key hasn’t been set, this is -equivalent to \Gls[<options>]{<label>}[<insert>]. -

\PGLS  \PGLS[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\gls[<options>]{<label>}[<insert>]. If that key hasn’t been set, this is equivalent +to \Gls[<options>]{<label>}[<insert>]. +

\PGLS  \PGLS[<options>]{<label>}[<insert>]
+

As \pgls but converts the prefix to upper case and uses \GLS instead of -\gls. -

\pglspl  \pglspl[<options>]{<label>}[<insert>]
-

+class="cmtt-10">\pgls but converts the prefix to upper case and uses \GLS instead of +\gls. +

\pglspl  \pglspl[<options>]{<label>}[<insert>]
+

This is prepends the value of the prefixplural key (or prefixfirstplural key, on -first use) in front of \glspl[<options>]{<label>}[<insert>]. -

\Pglspl  \Pglspl[<options>]{<label>}[<insert>]
-

+class="cmss-10">prefixplural key (or prefixfirstplural key, on first use) in +front of \glspl[<options>]{<label>}[<insert>]. +

\Pglspl  \Pglspl[<options>]{<label>}[<insert>]
+

If the prefixplural key (or prefixfirstplural, on first use) has been set, this -displays the value of that key with the first letter converted to upper case -followed by \glspl[<options>]{<label>}[<insert>]. If that key hasn’t -been set, this is equivalent to \Glspl[<options>]{<label>}[<insert>]. -

\PGLSpl  \PGLSpl[<options>]{<label>}[<insert>]
- - - -

+class="cmss-10">prefixplural key (or prefixfirstplural, on first use) has been set, this displays the +value of that key with the first letter converted to upper case followed by +\glspl[<options>]{<label>}[<insert>]. If that key hasn’t been set, this is +equivalent to \Glspl[<options>]{<label>}[<insert>]. +

\PGLSpl  \PGLSpl[<options>]{<label>}[<insert>]
+

As \pglspl but converts the prefix to upper case and uses \GLSpl instead -of \glspl. +class="cmtt-10">\pglspl but converts the prefix to upper case and uses \GLSpl instead of +\glspl. + + -

+

Example 24 (Using Prefixes) -

Continuing from Example 23, now that I’ve defined my entries, I can -use them in the text via the above commands: - - - -

-
+ id="x1-69044"> +

Continuing from Example 23, now that I’ve defined my entries, I can use them in +the text via the above commands: + + +

+
First use: \pgls{svm}. Next use: \pgls{svm}.  
Singular: \pgls{sample}, \pgls{oeil}.  
Plural: \pglspl{sample}, \pglspl{oeil}.
-

which produces: +

which produces:

-

First use: a support vector machine (SVM). Next use: an - SVM. Singular: a sample, l’oeil. Plural: the samples, les - yeux.

-

For a complete document, see

First use: a support vector machine (SVM). Next use: an SVM. + Singular: a sample, l’oeil. Plural: the samples, les yeux.

+

For a complete document, see sample-prefix.tex.

+class="cmtt-10">sample-prefix.tex.

-

-

____________________________

-

This package also provides the following commands: -

\ifglshasprefix  \ifglshasprefix{<label>}{<true part>}{<false -part>}
-

+

+

____________________________

+

This package also provides the following commands: +

\ifglshasprefix  \ifglshasprefix{<label>}{<true part>}{<false part>} +
+

Does <true part> if the entry identified by <label> has a non-empty value -for the prefix key. -

This package also provides the following commands: -

\ifglshasprefixplural  \ifglshasprefixplural{<label>}{<true -part>}{<false part>}
-

+class="cmmi-10"><true part> if the entry identified by <label> has a non-empty value for the +prefix key. +

This package also provides the following commands: +

\ifglshasprefixplural  \ifglshasprefixplural{<label>}{<true +part>}{<false part>}
+

Does <true part> if the entry identified by <label> has a non-empty value -for the prefixplural key. -

\ifglshasprefixfirst  \ifglshasprefixfirst{<label>}{<true -part>}{<false part>}
-

+class="cmmi-10"><true part> if the entry identified by <label> has a non-empty value for the +prefixplural key. +

\ifglshasprefixfirst  \ifglshasprefixfirst{<label>}{<true part>}{<false +part>}
+

Does <true part> if the entry identified by <label> has a non-empty value -for the prefixfirst key. -

\ifglshasprefixfirstplural  -

\ifglshasprefixfirstplural{<label>}{<true part>}{<false -part>}
-

+class="cmmi-10"><true part> if the entry identified by <label> has a non-empty value for the +prefixfirst key. +

\ifglshasprefixfirstplural  +

\ifglshasprefixfirstplural{<label>}{<true part>}{<false part>} +
+

Does <true part> if the entry identified by <label> has a non-empty value -for the prefixfirstplural key. -

\glsentryprefix  \glsentryprefix{<label>}
- - - -

+class="cmmi-10"><true part> if the entry identified by <label> has a non-empty value for the +prefixfirstplural key. +

\glsentryprefix  \glsentryprefix{<label>}
+

Displays the value of the prefix key for the entry given by <label>. (No -check is performed to determine if the entry exists.) -

\glsentryprefixfirst  \glsentryprefixfirst{<label>}
-

+class="cmss-10">prefix key for the entry given by <label>. (No check is +performed to determine if the entry exists.) + + +

\glsentryprefixfirst  \glsentryprefixfirst{<label>}
+

Displays the value of the prefixfirst key for the entry given by <label>. (No -check is performed to determine if the entry exists.) -

\glsentryprefixplural  \glsentryprefixplural{<label>} -
-

+class="cmss-10">prefixfirst key for the entry given by <label>. (No check is +performed to determine if the entry exists.) +

\glsentryprefixplural  \glsentryprefixplural{<label>}
+

Displays the value of the prefixplural key for the entry given by <label>. -(No check is performed to determine if the entry exists.) -

\glsentryprefixfirstplural  -

\glsentryprefixfirstplural{<label>}
-

+class="cmss-10">prefixplural key for the entry given by <label>. (No check is +performed to determine if the entry exists.) +

\glsentryprefixfirstplural  +

\glsentryprefixfirstplural{<label>}
+

Displays the value of the prefixfirstplural key for the entry given by <label>. -(No check is performed to determine if the entry exists.) -

There are also variants that convert the first letter to upper +class="cmss-10">prefixfirstplural key for the entry given by <label>. (No check +is performed to determine if the entry exists.) +

There are also variants that convert the first letter to upper case2: -

\Glsentryprefix  \Glsentryprefix{<label>}
-

-

\Glsentryprefixfirst  \Glsentryprefixfirst{<label>}
-

-

\Glsentryprefixplural  \Glsentryprefixplural{<label>} -
-

- - - -

\Glsentryprefixfirstplural  -

\Glsentryprefixfirstplural{<label>}
-

+href="#fn2x18" id="fn2x18-bk">17.2: +

\Glsentryprefix  \Glsentryprefix{<label>}
+

+

\Glsentryprefixfirst  \Glsentryprefixfirst{<label>}
+

+

\Glsentryprefixplural  \Glsentryprefixplural{<label>}
+

+

\Glsentryprefixfirstplural  +

\Glsentryprefixfirstplural{<label>}
+

+

As with analoguous commands such as \Glsentrytext, these commands aren’t +expandable so can’t be used in PDF bookmarks.
+

-

+

Example 25 (Adding Determiner to Glossary Style) -

You can use the above commands to define a new glossary style that uses -the determiner. For example, the following style is a slight modification of -the list style that inserts the prefix before the name: - - - -

-
+ id="x1-69068"> +

You can use the above commands to define a new glossary style that uses the +determiner. For example, the following style is a slight modification of the list style +that inserts the prefix before the name: + + +

+
\newglossarystyle{plist}{%  
  \setglossarystyle{list}%  
  \renewcommand*{\glossentry}[2]{% @@ -19729,5103 +19269,5054 @@ class="cmss-10x-x-109">list       \glossentrydesc{##1}\glspostdescription\space ##2}%  
}
-

+

-

-

____________________________

- - - -

19  

+

____________________________

+ + +

+

Top

18. Accessibility Support

-

Limited accessibility support is provided by the accompanying -glossaries-accsupp package, but note that this package is experimental and -it requires the accsupp package which is also listed as experimental. This -package defines additional keys that may be used when defining glossary -entries. The keys are as follows: +

Limited accessibility support is provided by the accompanying glossaries-accsupp +package, but note that this package is experimental and it requires the accsupp +package which is also listed as experimental. This package defines additional keys that +may be used when defining glossary entries. The keys are as follows:

access
access
The replacement text corresponding to the name key. +class="cmss-10">name key.
textaccess
textaccess
The replacement text corresponding to the text key. +class="cmss-10">text key.
firstaccess
firstaccess
The replacement text corresponding to the first key. +class="cmss-10">first key.
pluralaccess
pluralaccess
The replacement text corresponding to the plural key. +class="cmss-10">plural key.
firstpluralaccess
firstpluralaccess
The replacement text corresponding to the firstplural - key. +class="cmss-10">firstplural key.
symbolaccess
symbolaccess
The replacement text corresponding to the symbol key. +class="cmss-10">symbol key.
symbolpluralaccess
The replacement text corresponding to the - symbolplural key. +class="cmssbx-10">symbolpluralaccess
The replacement text corresponding to the symbolplural key.
descriptionaccess
The replacement text corresponding to the - description key. +class="cmssbx-10">descriptionaccess
The replacement text corresponding to the description key.
descriptionpluralaccess
The replacement text corresponding to the +class="cmssbx-10">descriptionpluralaccess
The replacement text corresponding to the descriptionplural key. +class="cmss-10">descriptionplural key.
longaccess
The replacement text corresponding to the long key (used - by \newacronym). +class="cmssbx-10">longaccess
The replacement text corresponding to the long key (used by + \newacronym).
shortaccess
The replacement text corresponding to the short key (used - by \newacronym). +class="cmssbx-10">shortaccess
The replacement text corresponding to the short key (used by + \newacronym).
longpluralaccess
longpluralaccess
The replacement text corresponding to the longplural - key (used by \newacronym). - - - +class="cmss-10">longplural key (used + by \newacronym).
shortpluralaccess
The replacement text corresponding to the - shortplural key (used by \newacronym). +class="cmssbx-10">shortpluralaccess
The replacement text corresponding to the shortplural key + (used by \newacronym).
-

For example: - - - +

For example: + +

-
+
\newglossaryentry{tex}{name={\TeX},description={Document  
preparation language},access={TeX}}
-

Now \gls{tex} will be equivalent to - - - +

Now \gls{tex} will be equivalent to + +

-
+
\BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{}
-

The sample file

The sample file sampleaccsupp.tex illustrates the glossaries-accsupp -package. -

See the documented code (glossaries-code.pdf) for further details. It -is recommended that you also read the accsupp documentation. - - - -

-

20  Troubleshooting

-

The glossaries package comes with a minimal file called minimalgls.tex -which can be used for testing. This should be located in the -samples subdirectory (folder) of the glossaries documentation -directory. The location varies according to your operating system and -TEX installation. For example, on my Linux partition it can be found in -/usr/local/texlive/2013/texmf-dist/doc/latex/glossaries/. +class="cmtt-10">sampleaccsupp.tex illustrates the glossaries-accsupp package. +

See the documented code (glossaries-code.pdf) for further details. It is +recommended that you also read the accsupp documentation. + + +

+

+

Top

19. Troubleshooting

+

The glossaries package comes with a minimal file called minimalgls.tex which can +be used for testing. This should be located in the samples subdirectory (folder) of the +glossaries documentation directory. The location varies according to your operating +system and TEX installation. For example, on my Linux partition it can be +found in /usr/local/texlive/2013/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://www.dickimaw-books.com/faqs/glossariesfaq.html. -If that doesn’t help, try posting your query to somewhere like -the comp.text.tex newsgroup, the LATEX Community Forum -(http://www.latex-community.org/) or TEX on StackExchange -(http://tex.stackexchange.com/). Bug reports can be submitted at -http://www.dickimaw-books.com/bug-report.html. +href="http://www.dickimaw-books.com/latex/minexample/" class="url" >http://www.dickimaw-_books.com/latex/minexample/. +

Below is a list of the most frequently asked questions. For other queries, consult +the glossaries FAQ. If that doesn’t help, try posting your query to somewhere like +the comp.text.tex newsgroup, the LATEX Community Forum or TEX on +StackExchange. Bug reports can be submitted via my package bug report +form.

  1. Q. I get the error message: - - - -
    + class="enumerate" id="x1-71002x1">Q. I get the error message: + + +
    ! Undefined control sequence.  
    \in@ #1#2->\begingroup \def \in@@
    -

    -

    A. This error can occur if you have a fragile command in one of your - entry definitions. In most cases using \glsnoexpandfields before - defining your entry should fix this, but there are still a few - fragile commands that will still cause this error even with - \glsnoexpandfields. If this is the case put \protect in front of the - fragile command. +

    +

    A. This error can occur if you have a fragile command in one of your entry + definitions. In most cases using \glsnoexpandfields before defining your entry + should fix this, but there are still a few fragile commands that will still cause + this error even with \glsnoexpandfields. If this is the case put \protect in + front of the fragile command.

  2. Q. I get the error message: - - - -
    + class="enumerate" id="x1-71004x2">Q. I get the error message: + + +
    Missing \begin{document}
    -

    -

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

    +

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

  3. Q. When I use Q. When I use xindy, I get the following error message: - - - -
    +class="cmtt-10">xindy, I get the following error message: + + +
    ERROR: CHAR: index 0 should be less than the length of  
    the string
    -

    -

    A.

    +

    A. xindy discards all commands and braces from the sort string. If - your sort string (either specified by the sort key or the name key) - only consists of commands, this will be treated by xindy as an - empty sort string, which produces an error message in newer - versions of xindy. For example, the following will cause a - problem: - - - +class="cmtt-10">xindy discards all commands and braces from the sort string. If your sort + string (either specified by the sort key or the name key) only consists of + commands, this will be treated by xindy as an empty sort string, which + produces an error message in newer versions of xindy. For example, the + following will cause a problem: + +

    -
    +
    \newglossaryentry{alpha}{name={\ensuremath{\alpha}},  
      description=alpha}
    -

    Either use a different sort key for the entry, for example: - - - +

    Either use a different sort key for the entry, for example: + +

    -
    +
    \newglossaryentry{alpha}{sort=alpha,  
      name={\ensuremath{\alpha}},  
      description=alpha}
    -

    or, if all entries are like this, you may prefer to use the sort=use or - sort=def package options. See

    or, if all entries are like this, you may prefer to use the sort=use or sort=def + package options. See §2.4 Sorting Options for further details - of the sort option. +class="cmsy-10">§2.4 Sorting Options for further details of the sort + option.

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

    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 + class="enumerate" id="x1-71022x4">Q. I’ve used the smallcaps option, but the acronyms are displayed in normal + sized upper case letters. +

    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. Q. My acronyms won’t break across a line when they’re expanded. -

    A. PDFLATQ. My acronyms won’t break across a line when they’re expanded. +

    A. PDFLATEX can break hyperlinks across a line, but LATEX can’t. - If you can’t use PDFLATEX can’t. If you + can’t use PDFLATEX then disable the first use links using - the package option hyperfirst=false. + id="dx1-71028">first use links using the package option + hyperfirst=false.

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

    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: - - - + class="enumerate" id="x1-71031x6">Q. How do I change the font that the acronyms are displayed in? +

    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: + +

    -
    +
    \usepackage[smaller]{glossaries}  
    \renewcommand*{\acronymfont}[1]{\textsf{#1}}
    -

    +

  7. Q. How do I change the font that the acronyms are displayed in on - first use? -

    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 - \textsmaller, you will also need to redefine \acronymfont, as - above. For example to make the acronym emphasized on Q. How do I change the font that the acronyms are displayed in on first - use, but use the surrounding font for subsequent use, you can - do: - - - + use? +

    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 \textsmaller, 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: + +

    -
    +
    \usepackage[smaller]{glossaries}  
    \renewcommand*{\firstacronymfont}[1]{\emph{#1}}  
    \renewcommand*{\acronymfont}[1]{#1}
    -

    +

  8. Q. I don’t have Perl installed, do I have to use Q. I don’t have Perl installed, do I have to use makeglossaries? -

    A. No. Although it is strongly recommended, you don’t have to use +class="cmtt-10">makeglossaries? +

    A. No. Although it is strongly recommended, you don’t have to use makeglossaries. If you prefer a GUI application and have Java - installed, you can use makeglossaries. If you prefer a GUI application and have Java installed, you + can use makeglossariesgui instead. Otherwise you - can just call makeglossariesgui instead. Otherwise you can just call makeindex explicitly (see makeindex + explicitly (see §1.3.3 Using makeindex - explicitly). Note that you can’t use §1.3.3 Using makeindex explicitly). Note that you can’t use xindy if you don’t have Perl - installed. +class="cmtt-10">xindy + if you don’t have Perl installed.

  9. Q. I’m used to using the glossary package: are there any instructions - on migrating from the glossary package to the glossaries package? -

    A. Read “Upgrading from the glossary package to the glossaries - package” which should be available from the same location as this - document. + class="enumerate" id="x1-71055x9">Q. I’m used to using the glossary package: are there any instructions on + migrating from the glossary package to the glossaries package? +

    A. Read “Upgrading from the glossary package to the glossaries package” which + should be available from the same location as this document.

  10. Q. I’m using babel but the fixed names haven’t been translated. -

    A. The glossaries package currently only supports the following - languages: Brazilian Portuguese, Danish, Dutch, English, French, - German, Irish, Italian, Hungarian, Polish, Serbian and Spanish. If - you want to add another language, send me the translations, and I’ll - add them to the next version. -

    If you are using one of the above languages, but the text hasn’t been - translated, try using the glossaries package option translate=babel. - Also, try adding the language as a global option to the class - file. + class="enumerate" id="x1-71058x10">Q. I’m using babel but the fixed names haven’t been translated. +

    A. The glossaries package currently only supports the following languages: + Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, + Italian, Hungarian, Polish, Serbian and Spanish. If you want to add + another language, send me the translations, and I’ll add them to the next + version. +

    If you are using one of the above languages, but the text hasn’t been translated, + try using the glossaries package option translate=babel. Also, try adding the + language as a global option to the class file.

  11. Q. My glossaries haven’t appeared. -

    A. Remember to do the following:

    -
      -
    • Add \makeglossaries to the document preamble. - - - -
      • -
    • Use either \printglossary for each glossary that has been - defined or \printglossaries. -
      • -
    • Use the commands listed in Q. My glossaries haven’t appeared. +

      A. Remember to do the following:

      +       -

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

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

    • Q. Why is glossaries creating an empty .glo file? -

      A. Because you haven’t used any entries in the main glossary - via commands such as \gls. If you don’t want to use this - glossary, you can suppress its creation via the package option - nomain. + class="enumerate" id="x1-71073x12">Q. Why is glossaries creating an empty .glo file? +

      A. Because you haven’t used any entries in the main glossary via commands + such as \gls. If you don’t want to use this glossary, you can suppress its + creation via the package option nomain.

    • Q. It is possible to change the rules used to sort the glossary - entries? -

      A. If it’s for an individual entry, then you can use the entry’s sort key - to sort it according to a different term. If it’s for the entire alphabet, - then you will need to use Q. It is possible to change the rules used to sort the glossary entries? +

      A. If it’s for an individual entry, then you can use the entry’s sort key to sort it + according to a different term. If it’s for the entire alphabet, then you will need + to use xindy (instead of xindy (instead of makeindex) and - use an appropriate xindy language module. Writing xindy - modules or styles is beyond the scope of this manual. Further - information about xindy can be found at the Xindy Web - Site. There is also a link to the xindy mailing list from that +class="cmtt-10">makeindex) and use an appropriate xindy + language module. Writing xindy modules or styles is beyond the scope of + this manual. Further information about xindy can be found at the + Xindy Web Site. There is also a link to the xindy mailing list from that site. -

      If you want to sort according to order of definition or order - of use, use the sort package option described in

      If you want to sort according to order of definition or order of use, use the sort + package option described in §2.4 Sorting - Options. +class="cmsy-10">§2.4 Sorting Options.

      • - - -
    • Q. I get an error when using TeX4HT with glossaries. -

      A. TeX4HT seems to have a problem with the glossary styles that + class="enumerate" id="x1-71094x14">Q. I get an error when using TeX4HT with glossaries. +

      A. TeX4HT seems to have a problem with the glossary styles that use \indexspace. I don’t know enough about TeX4HT to find out - why. Either use a different glossary style or redefine the style - command that uses \indexspace. For example, if you are using the - list style, try: - - - -

      -
      +class="cmtt-10">\indexspace. I don’t know enough about TeX4HT to find out + why. Either use a different glossary style or redefine the style command + that uses \indexspace. For example, if you are using the list style, + try: + + +

      +
      \renewcommand*{\glsgroupskip}{}
      -

      or - - - +

      or + +

      -
      +
      \renewcommand*{\glsgroupskip}{\item[]}
      -

      +

- - - -

- - - -

-

Index

-

Symbols -

-
\@gls@codepage   +

+

Top

Index

Symbols +
\@gls@codepage  1
+class="cmti-10">1
\@glsorder  \@glsorder  2
+class="cmti-10">2
\@istfilename  \@istfilename  3
+class="cmti-10">3
\@newglossary  \@newglossary  4
+class="cmti-10">4
\@xdylanguage  \@xdylanguage  5
-Xindy  6
-

A +class="cmti-10">5
+

A \Ac  7
+class="cmtt-10">\Ac  6
\ac  8
+class="cmtt-10">\ac  7
accsupp package  9, 10
+class="cmss-10">accsupp package  8, 9
\Acf  11
+class="cmtt-10">\Acf  10
\acf  12
+class="cmtt-10">\acf  11
\Acfp  13
+class="cmtt-10">\Acfp  12
\acfp  14
+class="cmtt-10">\acfp  13
\Acl  15
+class="cmtt-10">\Acl  14
\acl  16
+class="cmtt-10">\acl  15
\Aclp  17
+class="cmtt-10">\Aclp  16
\aclp  18
+class="cmtt-10">\aclp  17
\Acp  19
+class="cmtt-10">\Acp  18
\acp  20
+class="cmtt-10">\acp  19
\ACRfull  21
-\Acrfull  22, 23
-\acrfull  24, 25, 26, 27, 28, 29
-\ACRfullfmt  30
+class="cmtt-10">\ACRfull  20
\Acrfullfmt  31
+class="cmtt-10">\Acrfull  21, 22
\acrfullfmt  32, 33, 34
+class="cmtt-10">\acrfull  23, 24, 25, 26, 27, 28
\ACRfullpl  35
+class="cmtt-10">\ACRfullfmt  29
\Acrfullpl  36, 37
+class="cmtt-10">\Acrfullfmt  30
\acrfullpl  38, 39
+class="cmtt-10">\acrfullfmt  31, 32, 33
\ACRfullplfmt  40
+class="cmtt-10">\ACRfullpl  34
+\Acrfullpl  35, 36
\Acrfullplfmt  \acrfullpl  37, 38
+\ACRfullplfmt  39
+\Acrfullplfmt  40
+\acrfullplfmt  41
+\ACRlong  41
- - - +class="cmti-10">42
+ + \acrfullplfmt  \Acrlong  42
-\ACRlong  43
-\Acrlong  44, 45
-\acrlong  46, 47
-\ACRlongpl  48
-\Acrlongpl  49, 50
-\acrlongpl  51, 52
+class="cmti-10">43, 44
+\acrlong  45, 46
+\ACRlongpl  47
+\Acrlongpl  48, 49
+\acrlongpl  50, 51
acronym styles:
     dua  53, 54, 55, 56
+class="cmtt-10">dua  52, 53, 54, 55
    dua-desc  57, 58
+class="cmtt-10">dua-desc  56, 57
    footnote  59, 60, 61
+class="cmtt-10">footnote  58, 59, 60
    footnote-desc  62
+class="cmtt-10">footnote-desc  61
    footnote-sc  63
+class="cmtt-10">footnote-sc  62
    footnote-sc-desc  64, 65, 66, 67
+class="cmtt-10">footnote-sc-desc  63, 64, 65, 66
    footnote-sm  68
+class="cmtt-10">footnote-sm  67
    footnote-sm-desc  69
+class="cmtt-10">footnote-sm-desc  68
    long-sc-short  70, 71, 72, 73
+class="cmtt-10">long-sc-short  69, 70, 71, 72
    long-sc-short-desc  74
+class="cmtt-10">long-sc-short-desc  73
    long-short  75, 76, 77, 78, 79, 80
+class="cmtt-10">long-short  74, 75, 76, 77, 78, 79
    long-short-desc  81, 82, 83
+class="cmtt-10">long-short-desc  80, 81, 82
    long-sm-short  84, 85, 86
+class="cmtt-10">long-sm-short  83, 84, 85
    long-sm-short-desc  87
+class="cmtt-10">long-sm-short-desc  86
    sc-short-long  88
+class="cmtt-10">sc-short-long  87
    sc-short-long-desc  89
+class="cmtt-10">sc-short-long-desc  88
    short-long  90
+class="cmtt-10">short-long  89
    short-long-desc  91
+class="cmtt-10">short-long-desc  90
    sm-short-long  92
+class="cmtt-10">sm-short-long  91
    sm-short-long-desc  93
+class="cmtt-10">sm-short-long-desc  92
\acronymentry  \acronymentry  94, 95, 96, 97, 98, 99
-\acronymfont  100, 101, 93, 94, 95, 96, 97, 98
+\acronymfont  99, 100, 101, 102, 102, 103, 104, 105, 106, 107, 108, 109
+href="glossaries-user.html#dx1-71033" >108, 109
\acronymname  \acronymname  110
\acronymsort  \acronymsort  111, 111, 112, 113, 114, 115
\acronymtype  116, 117, \acronymtype  116, 117, 118, 119, 120, 121, 121, 122, 123, 124, 125, 126
\ACRshort  127
+class="cmtt-10">\ACRshort  127
\Acrshort  128, 129
+class="cmtt-10">\Acrshort  128, 129
\acrshort  130, 131, \acrshort  130, 131, 132
\ACRshortpl  133
+class="cmtt-10">\ACRshortpl  133
\Acrshortpl  134, 135
+class="cmtt-10">\Acrshortpl  134, 135
\acrshortpl  136, 137
+class="cmtt-10">\acrshortpl  136, 137
\Acs  138
+class="cmtt-10">\Acs  138
\acs  139
+class="cmtt-10">\acs  139
\Acsp  140
+class="cmtt-10">\Acsp  140
\acsp  141
- - - +class="cmtt-10">\acsp  141
\addcontentsline  \addcontentsline  142
align (environment)  align (environment)  143
+\altnewglossary  144
amsmath package  144
+class="cmss-10">amsmath package  145
\andname  145
+class="cmtt-10">\andname  146
+ + arara  146
+class="cmtt-10">arara  147
array package  147, 148
-

B +class="cmss-10">array package  148, 149
+

B babel package  149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164
+class="cmss-10">babel package  150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165
beamer class  165, 166
+class="cmss-10">beamer class  166, 167
beamer package  167
-

C +class="cmss-10">beamer package  168
+

C \chapter  168
+class="cmtt-10">\chapter  169
\chapter*  169, 170
+class="cmtt-10">\chapter*  170, 171
\currentglossary  171
-

D +class="cmtt-10">\currentglossary  172
+

D \DeclareAcronymList  \DeclareAcronymList  172
-\defglsentryfmt  173, 174, 175, 176, 177, 178, 179
-\DefineAcronymShortcuts  173, 174, 175
+\defentryfmt  176
+\defglsentryfmt  177, 178, 179, 180, 181, 182, 183, 184, 185, 186
+\DefineAcronymShortcuts  180
+class="cmti-10">187
\delimN  181
+class="cmtt-10">\delimN  188
\delimR  182
+class="cmtt-10">\delimR  189
description (environment)  183, 184, 185, 186, 187
-\descriptionname  188
+class="cmtt-10">description (environment)  190, 191, 192, 193, 194
+\descriptionname  195
doc package  189, 190, 191
+class="cmss-10">doc package  196, 197, 198
document (environment)  192, 193, 194
-

E -\emph  195
-\entryname  196
+class="cmtt-10">document (environment)  199, 200, 201
+

E +\emph  202
+entry location  203
+\entryname  204
environments:
     align  197
+class="cmtt-10">align  205
    description  198, 199, 200, 201, 202
+class="cmtt-10">description  206, 207, 208, 209, 210
    document  203, 204, 205
+class="cmtt-10">document  211, 212, 213
    equation  206
+class="cmtt-10">equation  214
    frame  207
+class="cmtt-10">frame  215
    itemize  208
+class="cmtt-10">itemize  216
    longtable  209, 210, 211, 212, 213, 214
- - - +class="cmtt-10">longtable  217, 218, 219, 220, 221, 222
    multicols  215, 216
+class="cmtt-10">multicols  223, 224
    supertabular  217, 218, 219, 220, 221
+class="cmtt-10">supertabular  225, 226, 227, 228, 229
    theglossary  222, 223, 224, 225
+class="cmtt-10">theglossary  230, 231, 232, 233
equation (environment)  226
+class="cmtt-10">equation (environment)  234
etex package  227
+class="cmss-10">etex package  235
+ + etoolbox package  228, 229
-

F +class="cmss-10">etoolbox package  236, 237
+

F file types
     .alg  230
+class="cmtt-10">.alg  238
    .aux  231, 232, 233
+class="cmtt-10">.aux  239, 240, 241
    .glg  234, 235, 236, 237
+class="cmtt-10">.glg  242, 243, 244, 245
    .glg2  238
+class="cmtt-10">.glg2  246
    .glo  239, 240, 241, 242, 243
+class="cmtt-10">.glo  247, 248, 249, 250, 251
    .gls  244, 245, 246
+class="cmtt-10">.gls  252, 253, 254
    .glsdefs  247
+class="cmtt-10">.glsdefs  255
    .ist  248, 249, 250, 251, 252, 253
+class="cmtt-10">.ist  256, 257, 258, 259, 260, 261
    .log  254
+class="cmtt-10">.log  262
    .tex  255, 256
+class="cmtt-10">.tex  263, 264
    .xdy  257, 258, 259, 260, 261, 262, 263, 264
+class="cmtt-10">.xdy  265, 266, 267, 268, 269, 270, 271, 272
    glo2  265
+class="cmtt-10">glo2  273
    gls2  266
+class="cmtt-10">gls2  274
first use  267
+href="glossaries-user.html#dx1-3006" >275
    flag  268, 269
+href="glossaries-user.html#dx1-3014" >276, 277
    text  270
+href="glossaries-user.html#dx1-3016" >278
\firstacronymfont  271, \firstacronymfont  279, 272, 273, 274, 275, 276, 277, 278
+class="cmti-10">280, 281, 282, 283, 284, 285, 286
flowfram package  279
+class="cmss-10">flowfram package  287
fmtcount package  280
+class="cmss-10">fmtcount package  288
\footnote  281
+class="cmtt-10">\footnote  289
\forallglossaries  282
+class="cmtt-10">\forallglossaries  290
\forallglsentries  283
+class="cmtt-10">\forallglsentries  291
\forglsentries  284
+class="cmtt-10">\forglsentries  292
frame (environment)  285
-

G -\Genacrfullformat  286
-\genacrfullformat  287, 288, 289, 290, 291, 292
-\GenericAcronymFields  frame (environment)  293
+

G +\Genacrfullformat  294
+\genacrfullformat  295, 296, 297, 298, 299, 300
+\GenericAcronymFields  293, 294, 295
+class="cmti-10">301, 302, 303
\Genplacrfullformat  296
+class="cmtt-10">\Genplacrfullformat  304
\genplacrfullformat  297, 298
+class="cmtt-10">\genplacrfullformat  305, 306
german package  299
- - - +class="cmss-10">german package  307
glossaries-accsupp package  300, 301, 302, 303, 304
+class="cmss-10">glossaries-accsupp package  308, 309, 310, 311, 312
glossaries-babel package  305, 306
+class="cmss-10">glossaries-babel package  313, 314
glossaries-polyglossia package  307, 308
+class="cmss-10">glossaries-polyglossia package  315, 316
glossaries-prefix package  309, 310, 311, 312, 313
+class="cmss-10">glossaries-prefix package  317, 318, 319, 320, 321
glossary counters:
     glossaryentry  glossaryentry  314
+class="cmti-10">322
    glossarysubentry  glossarysubentry  315
+class="cmti-10">323
glossary package  316, 317, 318, 319, 320, 321
+class="cmss-10">glossary package  324, 325, 326, 327, 328, 329
+ + glossary styles:
     altlist  322, 323, 324, 325, 326
+class="cmtt-10">altlist  330, 331, 332, 333, 334
    altlistgroup  327, 328
+class="cmtt-10">altlistgroup  335, 336
    altlisthypergroup  329
+class="cmtt-10">altlisthypergroup  337
    altlong4col  330, 331, 332
+class="cmtt-10">altlong4col  338, 339, 340
    altlong4colborder  333
+class="cmtt-10">altlong4colborder  341
    altlong4colheader  334
+class="cmtt-10">altlong4colheader  342
    altlong4colheaderborder  335
+class="cmtt-10">altlong4colheaderborder  343
    altlongragged4col  336, 337, 338
+class="cmtt-10">altlongragged4col  344, 345, 346
    altlongragged4colborder  339
+class="cmtt-10">altlongragged4colborder  347
    altlongragged4colheader  340, 341
+class="cmtt-10">altlongragged4colheader  348, 349
    altlongragged4colheaderborder  342
+class="cmtt-10">altlongragged4colheaderborder  350
    altsuper4col  343, 344, 345
+class="cmtt-10">altsuper4col  351, 352, 353
    altsuper4colborder  346
+class="cmtt-10">altsuper4colborder  354
    altsuper4colheader  347
+class="cmtt-10">altsuper4colheader  355
    altsuper4colheaderborder  348
+class="cmtt-10">altsuper4colheaderborder  356
    altsuperragged4col  349, 350, 351
+class="cmtt-10">altsuperragged4col  357, 358, 359
    altsuperragged4colborder  352
+class="cmtt-10">altsuperragged4colborder  360
    altsuperragged4colheader  353, 354
+class="cmtt-10">altsuperragged4colheader  361, 362
    altsuperragged4colheaderborder  355
+class="cmtt-10">altsuperragged4colheaderborder  363
    alttree  356, 357, 358, 359
+class="cmtt-10">alttree  364, 365, 366, 367
    alttreegroup  360, 361, 362
+class="cmtt-10">alttreegroup  368, 369, 370
    alttreehypergroup  363, 364
+class="cmtt-10">alttreehypergroup  371, 372
    index  365, 366, 367, 368, 369
+class="cmtt-10">index  373, 374, 375, 376, 377
    indexgroup  370, 371, 372
+class="cmtt-10">indexgroup  378, 379, 380
    indexhypergroup  373, 374
+class="cmtt-10">indexhypergroup  381, 382
    inline  375, 376, 377
+class="cmtt-10">inline  383, 384, 385
    list  378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391
+class="cmtt-10">list  386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399
    listdotted  392, 393, 394
+class="cmtt-10">listdotted  400, 401, 402
    listgroup  395, 396
+class="cmtt-10">listgroup  403, 404
    listhypergroup  397, 398, 399, 400, 401, 402, 403
+class="cmtt-10">listhypergroup  405, 406, 407, 408, 409, 410, 411
    long  404, 405, 406, 407, 408
+class="cmtt-10">long  412, 413, 414, 415, 416
    long3col  409, 410, 411, 412, 413
+class="cmtt-10">long3col  417, 418, 419, 420, 421
    long3colborder  414, 415
+class="cmtt-10">long3colborder  422, 423
    long3colheader  416, 417, 418
- - - +class="cmtt-10">long3colheader  424, 425, 426
    long3colheaderborder  419, 420
+class="cmtt-10">long3colheaderborder  427, 428
    long4col  421, 422, 423, 424, 425
+class="cmtt-10">long4col  429, 430, 431, 432, 433
    long4colborder  426, 427
+class="cmtt-10">long4colborder  434, 435
    long4colheader  428, 429, 430
+class="cmtt-10">long4colheader  436, 437, 438
    long4colheaderborder  431, 432
+class="cmtt-10">long4colheaderborder  439, 440
    longborder  433
+class="cmtt-10">longborder  441
    longheader  434, 435, 436
+class="cmtt-10">longheader  442, 443, 444
    longheaderborder  437, 438
+class="cmtt-10">longheaderborder  445, 446
    longragged  439, 440, 441, 442
+class="cmtt-10">longragged  447, 448, 449, 450
    longragged3col  443, 444, 445, 446
+class="cmtt-10">longragged3col  451, 452, 453, 454
    longragged3colborder  447
+class="cmtt-10">longragged3colborder  455
+ +     longragged3colheader  448, 449
+class="cmtt-10">longragged3colheader  456, 457
    longragged3colheaderborder  450
+class="cmtt-10">longragged3colheaderborder  458
    longraggedborder  451
+class="cmtt-10">longraggedborder  459
    longraggedheader  452, 453
+class="cmtt-10">longraggedheader  460, 461
    longraggedheaderborder  454
+class="cmtt-10">longraggedheaderborder  462
    mcolalttree  455
+class="cmtt-10">mcolalttree  463
    mcolalttreegroup  456
+class="cmtt-10">mcolalttreegroup  464
    mcolalttreehypergroup  457
+class="cmtt-10">mcolalttreehypergroup  465
    mcolindex  458, 459
+class="cmtt-10">mcolindex  466, 467
    mcolindexgroup  460
+class="cmtt-10">mcolindexgroup  468
    mcolindexhypergroup  461
+class="cmtt-10">mcolindexhypergroup  469
    mcoltree  462
+class="cmtt-10">mcoltree  470
    mcoltreegroup  463
+class="cmtt-10">mcoltreegroup  471
    mcoltreehypergroup  464
+class="cmtt-10">mcoltreehypergroup  472
    mcoltreenoname  465
+class="cmtt-10">mcoltreenoname  473
    mcoltreenonamegroup  466
+class="cmtt-10">mcoltreenonamegroup  474
    mcoltreenonamehypergroup  467
+class="cmtt-10">mcoltreenonamehypergroup  475
    super  468, 469, 470, 471
+class="cmtt-10">super  476, 477, 478, 479
    super3col  472, 473, 474, 475
+class="cmtt-10">super3col  480, 481, 482, 483
    super3colborder  476
+class="cmtt-10">super3colborder  484
    super3colheader  477, 478
+class="cmtt-10">super3colheader  485, 486
    super3colheaderborder  479
+class="cmtt-10">super3colheaderborder  487
    super4col  480, 481, 482, 483, 484
+class="cmtt-10">super4col  488, 489, 490, 491, 492
    super4colborder  485, 486
+class="cmtt-10">super4colborder  493, 494
    super4colheader  487, 488, 489
+class="cmtt-10">super4colheader  495, 496, 497
    super4colheaderborder  490, 491
+class="cmtt-10">super4colheaderborder  498, 499
    superborder  492
+class="cmtt-10">superborder  500
    superheader  493, 494
+class="cmtt-10">superheader  501, 502
    superheaderborder  495, 496
+class="cmtt-10">superheaderborder  503, 504
    superragged  497, 498, 499, 500
+class="cmtt-10">superragged  505, 506, 507, 508
    superragged3col  501, 502, 503, 504
+class="cmtt-10">superragged3col  509, 510, 511, 512
    superragged3colborder  505
- - - +class="cmtt-10">superragged3colborder  513
    superragged3colheader  506, 507
+class="cmtt-10">superragged3colheader  514, 515
    superragged3colheaderborder  508
+class="cmtt-10">superragged3colheaderborder  516
    superraggedborder  509
+class="cmtt-10">superraggedborder  517
    superraggedheader  510, 511
+class="cmtt-10">superraggedheader  518, 519
    superraggedheaderborder  512
+class="cmtt-10">superraggedheaderborder  520
    tree  513, 514, 515, 516, 517, 518
+class="cmtt-10">tree  521, 522, 523, 524, 525, 526
    treegroup  519, 520, 521
+class="cmtt-10">treegroup  527, 528, 529
    treehypergroup  522, 523
+class="cmtt-10">treehypergroup  530, 531
    treenoname  524, 525, 526
+class="cmtt-10">treenoname  532, 533, 534
    treenonamegroup  527, 528, 529
+class="cmtt-10">treenonamegroup  535, 536, 537
    treenonamehypergroup  530, 531
+class="cmtt-10">treenonamehypergroup  538, 539
glossary-inline package  532, 533
+class="cmss-10">glossary-inline package  540, 541
glossary-list package  534, 535, 536, 537, 538
+class="cmss-10">glossary-list package  542, 543, 544, 545, 546
glossary-long package  539, 540, 541, 542, 543, 544
+class="cmss-10">glossary-long package  547, 548, 549, 550, 551, 552
+ + glossary-longragged package  545, 546, 547
+class="cmss-10">glossary-longragged package  553, 554, 555
glossary-mcols package  548, 549, 550, 551
+class="cmss-10">glossary-mcols package  556, 557, 558, 559
glossary-super package  552, 553, 554, 555, 556, 557
+class="cmss-10">glossary-super package  560, 561, 562, 563, 564, 565
glossary-superragged package  558, 559, 560
+class="cmss-10">glossary-superragged package  566, 567, 568
glossary-tree package  561, 562, 563, 564, 565
+class="cmss-10">glossary-tree package  569, 570, 571, 572, 573
glossaryentry (counter)  glossaryentry (counter)  566
-glossaryentry counter  567, 568, 569
-\glossaryentrynumbers  570, 571, 572, 573
-\glossaryheader  574, 575, 576, 577
-\glossaryname  578, 579
-\glossarypostamble  580, 574, 575, 576, 577
+\glossaryentrynumbers  578, 579, 580, 581
+\glossaryheader  582, 583, 584, 585
+\glossaryname  586, 587
+\glossarypostamble  588, 581, 582
+class="cmti-10">589, 590
\glossarypreamble  583, \glossarypreamble  591, 584, 585, 586
+class="cmti-10">592, 593, 594
\glossarysection  587
+class="cmtt-10">\glossarysection  595
\glossarystyle  588
+class="cmtt-10">\glossarystyle  596
glossarysubentry (counter)  glossarysubentry (counter)  589
+class="cmti-10">597
\glossentry  590, 591, 592
+class="cmtt-10">\glossentry  598, 599, 600
\Glossentrydesc  \Glossentrydesc  593
+class="cmti-10">601
\glossentrydesc  \glossentrydesc  594, 595
+class="cmti-10">602, 603
\Glossentryname  \Glossentryname  596, 597
+class="cmti-10">604, 605
\glossentryname  \glossentryname  598, 599, 600
+class="cmti-10">606, 607, 608
\Glossentrysymbol  \Glossentrysymbol  601
+class="cmti-10">609
\glossentrysymbol  \glossentrysymbol  602, 603
-\GLS  604, 605, 610, 611
+\GLS  612, 613, 614, 615
+\Gls  616, 617, 618, 619, 606, 607
-\Gls  608, 609, 610, 611, 612, 613, 614, 615, 616, 617
-\gls  618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655
-\gls*  656
-\glsadd  620, 621, 622, 623, 624, 625
+\gls  626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662
+\gls*  663
+\glsadd  657
+class="cmti-10">664
\glsaddall  658, \glsaddall  665, 659
- - - +class="cmti-10">666
\glsaddall options
 +class="cmtt-10">\glsaddall options
    types  660
+class="cmss-10">types  667
\glsaddallunused  \glsaddallunused  661
+class="cmti-10">668
\glsaddkey  662, 663, 664, \glsaddkey  669, 670, 671, 665
+class="cmti-10">672
\GlsAddXdyAttribute  666, \GlsAddXdyAttribute  673, 667
+class="cmti-10">674
\GlsAddXdyCounters  \GlsAddXdyCounters  668, 669
+class="cmti-10">675, 676
\GlsAddXdyLocation  \GlsAddXdyLocation  670, 671
+class="cmti-10">677, 678
\glsautoprefix  672
+class="cmtt-10">\glsautoprefix  679
\glscapscase  673, 674
+class="cmtt-10">\glscapscase  680, 681
\glsclearpage  675
+class="cmtt-10">\glsclearpage  682
\glsclosebrace  \glsclosebrace  676
-\glscustomtext  677
-\GlsDeclareNoHyperList  678, 679, 680, 681, 682
-\glsdefaulttype  683, 684, 685, 686, 687, 688
-\GLSdesc  689
+class="cmti-10">683
\Glsdesc  690
+class="cmtt-10">\glscustomtext  684, 685
+\GlsDeclareNoHyperList  686, 687, 688, 689, 690
+\glsdefaulttype  691, 692, 693, 694, 695, 696
+\GLSdesc  697
\glsdesc  691
-\glsdescwidth  692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703
-\glsdisablehyper  \Glsdesc  698
+\glsdesc  699
+\glsdescwidth  700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711
+ + +\glsdisablehyper  704, 705
-\glsdisp  706, 707, 708, 709, 710, 711, 712, 713, 714
-\glsdisplay  715, 716
-\glsdisplayfirst  717, 718
-\glsdisplaynumberlist  719, 712, 713
+\glsdisp  714, 715, 716, 717, 718, 719, 720, 721, 722
+\glsdisplay  723, 724
+\glsdisplayfirst  725, 726
+\glsdisplaynumberlist  727, 720
+class="cmti-10">728
+\glsdoifexists  729
\glsdoifexists  721
+class="cmtt-10">\glsdoifexistsorwarn  730
\glsdoifnoexists  722
+class="cmtt-10">\glsdoifnoexists  731
\glsdosanitizesort  \glsdosanitizesort  723
+class="cmti-10">732
\glsenablehyper  \glsenablehyper  724
+class="cmti-10">733
\glsentrycounterlabel  725
+class="cmtt-10">\glsentrycounterlabel  734
\Glsentrydesc  \Glsentrydesc  726
+class="cmti-10">735
\glsentrydesc  \glsentrydesc  727
+class="cmti-10">736
\Glsentrydescplural  \Glsentrydescplural  728
+class="cmti-10">737
\glsentrydescplural  \glsentrydescplural  729
+class="cmti-10">738
\Glsentryfirst  \Glsentryfirst  730
+class="cmti-10">739
\glsentryfirst  \glsentryfirst  731
+class="cmti-10">740
\Glsentryfirstplural  \Glsentryfirstplural  732
+class="cmti-10">741
\glsentryfirstplural  \glsentryfirstplural  733
-\glsentryfmt  734, 735, 736, 737, 738, 742
+\glsentryfmt  743, 744, 745, 746, 747, 739, 740, 741, 742, 743
-\Glsentryfull  744
-\glsentryfull  745, 746, 747, 748, 749, 750
-\Glsentryfullpl  751
-\glsentryfullpl  752
-\glsentryitem  753, 754
-\Glsentrylong  755, 756, 757, 758
- - - -\glsentrylong  759, 760, 761
-\Glsentrylongpl  762, 763
-\glsentrylongpl  764, 765
-\Glsentryname  748, 749, 750, 751, 752, 753
+\Glsentryfull  754
+\glsentryfull  755, 756, 757, 758, 759, 760
+\Glsentryfullpl  761
+\glsentryfullpl  762
+\glsentryitem  763, 764
+\Glsentrylong  765, 766, 767, 768
+\glsentrylong  769, 770, 771
+\Glsentrylongpl  772, 773
+\glsentrylongpl  774, 775
+\Glsentryname  766
+class="cmti-10">776
\glsentryname  \glsentryname  767, 768
+class="cmti-10">777, 778
\glsentrynumberlist  769, \glsentrynumberlist  779, 770
+class="cmti-10">780
\Glsentryplural  \Glsentryplural  771
+class="cmti-10">781
\glsentryplural  \glsentryplural  772
+class="cmti-10">782
\Glsentryprefix  773
+class="cmtt-10">\Glsentryprefix  783
\glsentryprefix  774
+class="cmtt-10">\glsentryprefix  784
\Glsentryprefixfirst  775
+class="cmtt-10">\Glsentryprefixfirst  785
\glsentryprefixfirst  776
+class="cmtt-10">\glsentryprefixfirst  786
\Glsentryprefixfirstplural  777
+class="cmtt-10">\Glsentryprefixfirstplural  787
\glsentryprefixfirstplural  778
+class="cmtt-10">\glsentryprefixfirstplural  788
\Glsentryprefixplural  779
+class="cmtt-10">\Glsentryprefixplural  789
\glsentryprefixplural  780
+class="cmtt-10">\glsentryprefixplural  790
\Glsentryshort  781
+class="cmtt-10">\Glsentryshort  791
\glsentryshort  782
+class="cmtt-10">\glsentryshort  792
\Glsentryshortpl  783
+class="cmtt-10">\Glsentryshortpl  793
\glsentryshortpl  784
+class="cmtt-10">\glsentryshortpl  794
+ + \Glsentrysymbol  \Glsentrysymbol  785
+class="cmti-10">795
\glsentrysymbol  786, \glsentrysymbol  796, 787
+class="cmti-10">797
\Glsentrysymbolplural  \Glsentrysymbolplural  788
+class="cmti-10">798
\glsentrysymbolplural  \glsentrysymbolplural  789
+class="cmti-10">799
\Glsentrytext  790, \Glsentrytext  800, 801, 791
-\glsentrytext  792, 793, 794, 802, 803, 804
+\glsentrytext  805, 806, 807, 795, 796, 797
+class="cmti-10">808, 809, 810
\Glsentryuseri  \Glsentryuseri  798
+class="cmti-10">811
\glsentryuseri  \glsentryuseri  799, 800
+class="cmti-10">812, 813
\Glsentryuserii  \Glsentryuserii  801
+class="cmti-10">814
\glsentryuserii  \glsentryuserii  802
+class="cmti-10">815
\Glsentryuseriii  \Glsentryuseriii  803
+class="cmti-10">816
\glsentryuseriii  \glsentryuseriii  804
+class="cmti-10">817
\Glsentryuseriv  \Glsentryuseriv  805
+class="cmti-10">818
\glsentryuseriv  \glsentryuseriv  806
+class="cmti-10">819
\Glsentryuserv  \Glsentryuserv  807
+class="cmti-10">820
\glsentryuserv  \glsentryuserv  808
+class="cmti-10">821
\Glsentryuservi  \Glsentryuservi  809
+class="cmti-10">822
\glsentryuservi  \glsentryuservi  810
+class="cmti-10">823
\glsexpandfields  \glsexpandfields  811
+class="cmti-10">824
+\GLSfirst  825
\GLSfirst  \Glsfirst  812
+class="cmti-10">826
\Glsfirst  813
+class="cmtt-10">\glsfirst  827
\glsfirst  814
+class="cmtt-10">\GLSfirstplural  828
\GLSfirstplural  \Glsfirstplural  815
- - - -\Glsfirstplural  816
-\glsfirstplural  817
-\glsgenacfmt  818, 819, 820, 821, 822, 823
-\glsgenentryfmt  824, 825, 826
-\glsgetgrouptitle  827
-\glsglossarymark  829
+\glsfirstplural  830
+\glsgenacfmt  831, 832, 833, 834, 835, 836
+\glsgenentryfmt  837, 838, 839
+\glsgetgrouptitle  840
+\glsglossarymark  828, 829, 841, 842, 830, 831, 832
-\glsgroupheading  833, 834
-\glsgroupskip  835, 836, 837
-\glshyperlink  838, 839, 843, 844, 845
+\glsgroupheading  846, 847
+\glsgroupskip  848, 849, 850
+\glshyperlink  851, 852, 840
+class="cmti-10">853
\glshypernavsep  841
+class="cmtt-10">\glshypernavsep  854
\glsIfListOfAcronyms  \glsIfListOfAcronyms  842
+class="cmti-10">855
\glsifplural  843, 844
+class="cmtt-10">\glsifplural  856, 857
\glsinlineparentchildseparator  845, 846
+class="cmtt-10">\glsinlineparentchildseparator  858, 859
\glsinlineseparator  847, 848
+class="cmtt-10">\glsinlineseparator  860, 861
\glsinlinesubseparator  849, 850
+class="cmtt-10">\glsinlinesubseparator  862, 863
\glsinsert  851
+class="cmtt-10">\glsinsert  864
\glslabel  852
+class="cmtt-10">\glslabel  865
\glslabeltok  \glslabeltok  853
-\glslink  854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864
+class="cmti-10">866
+\glslink  867, 868, 869, 870, 871, 872, 873, 874, 875, 876, 877
\glslink options
 +class="cmtt-10">\glslink options
    counter  865, 866
+class="cmss-10">counter  878, 879
    format  867, 868, 869, 870, 871
+class="cmss-10">format  880, 881, 882, 883, 884
    hyper  872, 873, 874, 875
+class="cmss-10">hyper  885, 886, 887, 888
+ +     local  876
+class="cmss-10">local  889
\glslink*  877
+class="cmtt-10">\glslink*  890
\glslistdottedwidth  878
+class="cmtt-10">\glslistdottedwidth  891
\glslocalreset  \glslocalreset  879
+class="cmti-10">892
\glslocalresetall  \glslocalresetall  880
+class="cmti-10">893
\glslocalunset  \glslocalunset  881
+class="cmti-10">894
\glslocalunsetall  \glslocalunsetall  882
+class="cmti-10">895
\glslongtok  \glslongtok  883
+class="cmti-10">896
\glsmcols  884
+class="cmtt-10">\glsmcols  897
\glsmoveentry  \glsmoveentry  885
+class="cmti-10">898
\GLSname  886
+class="cmtt-10">\GLSname  899
\Glsname  887
+class="cmtt-10">\Glsname  900
\glsname  888
+class="cmtt-10">\glsname  901
\glsnamefont  \glsnamefont  889, 890
+class="cmti-10">902, 903
\glsnavhypertarget  891
+class="cmtt-10">\glsnavhypertarget  904
\glsnoexpandfields  \glsnoexpandfields  892
+class="cmti-10">905
\glsnumberformat  893
+class="cmtt-10">\glsnumberformat  906
\glsnumbersgroupname  894
+class="cmtt-10">\glsnumbersgroupname  907
\glsnumbersgrouptitle  895
+class="cmtt-10">\glsnumbersgrouptitle  908
\glsnumlistlastsep  \glsnumlistlastsep  896
- - - +class="cmti-10">909
\glsnumlistsep  \glsnumlistsep  897
+class="cmti-10">910
\glsopenbrace  \glsopenbrace  898
-\glspagelistwidth  899, 900, 901, 902, 903, 904, 905, 906
-\glspar  911
+\glspagelistwidth  912, 913, 914, 915, 916, 917, 918, 919
+\glspar  907
-\GLSpl  908, 909, 910, 920
+\GLSpl  921, 922, 923, 924, 925
+\Glspl  926, 927, 928, 929, 911, 912
-\Glspl  913, 914, 915, 916, 930, 931, 932
+\glspl  933, 934, 935, 936, 937, 938, 939, 940, 917, 918, 919
-\glspl  920, 921, 922, 923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933, 934
-\GLSplural  935
+class="cmti-10">941, 942, 943, 944, 945, 946
+\GLSplural  947
\Glsplural  936
+class="cmtt-10">\Glsplural  948
\glsplural  937
+class="cmtt-10">\glsplural  949
\glspluralsuffix  938, 939, 940, \glspluralsuffix  950, 951, 952, 941
+class="cmti-10">953
\glspostdescription  942
+class="cmtt-10">\glspostdescription  954
\glspostinline  943, 944
+class="cmtt-10">\glspostinline  955, 956
\glsprestandardsort  \glsprestandardsort  945, 946
+class="cmti-10">957, 958
\glsquote  \glsquote  947
+class="cmti-10">959
\glsrefentry  948, \glsrefentry  960, 949, 950
+class="cmti-10">961, 962
\glsreset  951, \glsreset  963, 952
+class="cmti-10">964
\glsresetall  \glsresetall  953
+class="cmti-10">965
\glsresetentrycounter  \glsresetentrycounter  954
+class="cmti-10">966
\glssee  955, 956, \glssee  967, 968, 957, 958, 959, 960
+class="cmti-10">969, 970, 971, 972
\glsseeformat  961, \glsseeformat  973, 962, 963
+class="cmti-10">974, 975
\glsseeitemformat  \glsseeitemformat  964
+class="cmti-10">976
\glsseelastsep  \glsseelastsep  965
+class="cmti-10">977
\glsseelist  966, 967
+class="cmtt-10">\glsseelist  978, 979
\glsseesep  \glsseesep  968
+class="cmti-10">980
\glsSetAlphaCompositor  \glsSetAlphaCompositor  969
+class="cmti-10">981
+ + \glsSetCompositor  \glsSetCompositor  970
+class="cmti-10">982
\glssetexpandfield  \glssetexpandfield  971
+class="cmti-10">983
\glssetnoexpandfield  \glssetnoexpandfield  972
+class="cmti-10">984
\glsSetSuffixF  \glsSetSuffixF  973
+class="cmti-10">985
\glsSetSuffixFF  \glsSetSuffixFF  974
+class="cmti-10">986
\glssetwidest  975
+class="cmtt-10">\glssetwidest  987
\GlsSetXdyCodePage  976, 977, \GlsSetXdyCodePage  988, 989, 978
+class="cmti-10">990
\GlsSetXdyFirstLetterAfterDigits  \GlsSetXdyFirstLetterAfterDigits  979
+class="cmti-10">991
\GlsSetXdyLanguage  980, 981, 982, \GlsSetXdyLanguage  992, 993, 994, 983
+class="cmti-10">995
\GlsSetXdyLocationClassOrder  \GlsSetXdyLocationClassOrder  984
+class="cmti-10">996
\GlsSetXdyMinRangeLength  985, \GlsSetXdyMinRangeLength  997, 986
+class="cmti-10">998
\glsshorttok  \glsshorttok  987
+class="cmti-10">999
\glssortnumberfmt  \glssortnumberfmt  988
+class="cmti-10">1000
\glssubentrycounterlabel  989
+class="cmtt-10">\glssubentrycounterlabel  1001
\glssubentryitem  990, 991
+class="cmtt-10">\glssubentryitem  1002, 1003
\GLSsymbol  \GLSsymbol  1004
+\Glssymbol  992
+class="cmti-10">1005
\Glssymbol  993
- - - +class="cmtt-10">\glssymbol  1006, 1007
\glssymbol  994, 995
+class="cmtt-10">\glssymbolsgroupname  1008, 1009
\glssymbolsgroupname  996, 997
+class="cmtt-10">\glstarget  1010, 1011
\glstarget  998, 999
+class="cmtt-10">\GLStext  1012, 1013
\GLStext  1000, \Glstext  1014, 1001
-\Glstext  1002, 1003
-\glstext  1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
-\glstextformat  1015, 1016, 1017
-\glstextup  1015
+\glstext  1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027
+\glstextformat  1028, 1029, 1030
+\glstextup  1018
+class="cmti-10">1031
\glstocfalse  \glstocfalse  1019
+class="cmti-10">1032
\glstoctrue  \glstoctrue  1020
+class="cmti-10">1033
\glstreeindent  1021
+class="cmtt-10">\glstreeindent  1034
\glsunset  \glsunset  1022
+class="cmti-10">1035
\glsunsetall  1023, \glsunsetall  1036, 1024
+class="cmti-10">1037
\GlsUseAcrEntryDispStyle  \GlsUseAcrEntryDispStyle  1025
+class="cmti-10">1038
\GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs  1026
+class="cmti-10">1039
+\GLSuseri  1040
\GLSuseri  \Glsuseri  1027
+class="cmti-10">1041
\Glsuseri  1028
+class="cmtt-10">\glsuseri  1042
\glsuseri  1029
+class="cmtt-10">\GLSuserii  1043
\GLSuserii  \Glsuserii  1030
+class="cmti-10">1044
\Glsuserii  \glsuserii  1031
+class="cmti-10">1045
\glsuserii  1032
+class="cmtt-10">\GLSuseriii  1046
\GLSuseriii  \Glsuseriii  1033
+class="cmti-10">1047
\Glsuseriii  \glsuseriii  1034
+class="cmti-10">1048
\glsuseriii  1035
+class="cmtt-10">\GLSuseriv  1049
\GLSuseriv  \Glsuseriv  1036
+class="cmti-10">1050
\Glsuseriv  \glsuseriv  1037
+class="cmti-10">1051
\glsuseriv  1038
+class="cmtt-10">\GLSuserv  1052
\GLSuserv  \Glsuserv  1039
+class="cmti-10">1053
+ + \Glsuserv  \glsuserv  1040
+class="cmti-10">1054
\glsuserv  1041
+class="cmtt-10">\GLSuservi  1055
\GLSuservi  \Glsuservi  1042
+class="cmti-10">1056
\Glsuservi  \glsuservi  1043
-\glsuservi  1044
-

H +class="cmti-10">1057
+

H html package  1045
+class="cmss-10">html package  1058
\hyperbf  1046
+class="cmtt-10">\hyperbf  1059
\hyperbsf  1047
+class="cmtt-10">\hyperbsf  1060
\hyperemph  1048
+class="cmtt-10">\hyperemph  1061
\hyperit  1049
+class="cmtt-10">\hyperit  1062
\hyperlink  1050, 1051, 1052
+class="cmtt-10">\hyperlink  1063, 1064, 1065
\hypermd  1053
- - - +class="cmtt-10">\hypermd  1066
\hyperpage  1054
+class="cmtt-10">\hyperpage  1067
hyperref package  1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071
-\hyperrm  1072, 1073
-\hypersc  1074
-\hypersf  1075
-\hypersl  1076
-\hypertarget  1077
-\hypertt  1078
-\hyperup  1079
-

I -\ifglossaryexists  1080
-\ifglsdescsuppressed  1081
-\ifglsentryexists  1082
-\ifglshaschildren  1083
-\ifglshasdesc  1084
-\ifglshaslong  1085, 1086
-\ifglshasparent  1087
-\ifglshasprefix  1088
-\ifglshasprefixfirst  1089
-\ifglshasprefixfirstplural  1090
-\ifglshasprefixplural  1091
-\ifglshasshort  1092, 1093
-\ifglshassymbol  1094, 1095
-\ifglsucmark  1096
-\ifglsused  1097, 1098, hyperref package  1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084
+\hyperrm  1085, 1086
+\hypersc  1087
+\hypersf  1088
+\hypersl  1089
+\hypertarget  1090
+\hypertt  1091
+\hyperup  1092
+

I +\ifglossaryexists  1093
+\ifglsdescsuppressed  1094
+\ifglsentryexists  1095
+\ifglshaschildren  1096
+\ifglshasdesc  1097
+\ifglshaslong  1098, 1099
+\ifglshasparent  1100
+\ifglshasprefix  1101
+\ifglshasprefixfirst  1102
+\ifglshasprefixfirstplural  1103
+\ifglshasprefixplural  1104
+\ifglshasshort  1105, 1106
+\ifglshassymbol  1107, 1108
+\ifglsucmark  1109
+\ifglsused  1110, 1111, 1099, 1100
+class="cmti-10">1112, 1113
imakeidx package  1101
-\index  1102, 1103, 1104, 1105, 1106
+class="cmss-10">imakeidx package  1114
+\index  1115, 1116, 1117, 1118, 1119
index package  1107
-\indexspace  1108, 1109, 1110, 1111, 1112
+class="cmss-10">index package  1120
+\indexspace  1121, 1122, 1123, 1124, 1125
+ + inputenc package  1113, 1114, 1115, 1116
-\inputencodingname  1117
-\item  1118, 1119
+class="cmss-10">inputenc package  1126, 1127, 1128, 1129
+\inputencodingname  1130
+\item  1131, 1132
itemize (environment)  1120
-

J -\jobname  1121, 1122
-

L -\label  1123
- - - +class="cmtt-10">itemize (environment)  1133
+

J +\jobname  1134, 1135
+

L +\label  1136
latex  1124, 1125
+class="cmtt-10">latex  1137, 1138
latexmk  1126
+class="cmtt-10">latexmk  1139
link text  1127, 1128, 1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137
-\loadglsentries  1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150
+\loadglsentries  1138, 1139, 1140
+class="cmti-10">1151, 1152, 1153
location list  see see number list
\longnewglossaryentry  \longnewglossaryentry  1142, 1143, 1144, 1145
+class="cmti-10">1155, 1156, 1157, 1158
\longprovideglossaryentry  \longprovideglossaryentry  1146
+class="cmti-10">1159
longtable (environment)  1147, 1148, 1149, 1150, 1151, 1152
+class="cmtt-10">longtable (environment)  1160, 1161, 1162, 1163, 1164, 1165
longtable package  1153, 1154
-

M -\makefirstuc  1155, 1156
-makeglossaries  1157
+class="cmss-10">longtable package  1166, 1167
+

M +\makefirstuc  1168, 1169
makeglossaries  1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220
-\makeglossaries  1221, makeglossaries  1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233
+\makeglossaries  1234, 1235, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241
-makeglossariesgui  1242
+class="cmti-10">1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254, 1255
makeglossariesgui  1243, 1244, 1245, 1246, 1247
+class="cmtt-10">makeglossariesgui  1256, 1257, 1258, 1259, 1260, 1261
makeidx package  1248
-makeindex  1249
+class="cmss-10">makeidx package  1262
makeindex  1250, 1251, 1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321
-\MakeTextUppercase  1322
+class="cmtt-10">makeindex  1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335
+\MakeTextUppercase  1336
+\markboth  1337
memoir class  1323, 1324, 1325
-\memUChead  1326
+class="cmss-10">memoir class  1338, 1339, 1340, 1341
+\memUChead  1342
mfirstuc package  1327, 1328
+class="cmss-10">mfirstuc package  1343, 1344
\mfirstucMakeUppercase  1329
+class="cmtt-10">\mfirstucMakeUppercase  1345
multicol package  1330
+class="cmss-10">multicol package  1346
multicols (environment)  1331, 1332
-

N +class="cmtt-10">multicols (environment)  1347, 1348
+

N nameref package  1333
-\newacronym  1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, nameref package  1349
+\newacronym  1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361
-\newacronymstyle  1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377
+ + +\newacronymstyle  1362, 1363, 1364
-\newdualentry  1365
-\newglossary  1366, 1367, 1368, 1369, 1370, 1378, 1379, 1380
+\newdualentry  1381
+\newglossary  1382, 1383, 1384, 1385, 1386, 1371
-\newglossaryentry  1372, 1373, 1374, 1375, 1376, 1377, 1387
+\newglossaryentry  1388, 1389, 1390, 1391, 1392, 1393, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390
- - - +class="cmti-10">1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407
\newglossaryentry options
 +class="cmtt-10">\newglossaryentry options
    access  1391
+class="cmss-10">access  1408
    description  1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405
+class="cmss-10">description  1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422
    descriptionaccess  1406
+class="cmss-10">descriptionaccess  1423
    descriptionplural  1407, 1408, 1409, 1410
+class="cmss-10">descriptionplural  1424, 1425, 1426, 1427
    descriptionpluralaccess  1411
+class="cmss-10">descriptionpluralaccess  1428
    first  1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431
+class="cmss-10">first  1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448
    firstaccess  1432
+class="cmss-10">firstaccess  1449
    firstplural  1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449
+class="cmss-10">firstplural  1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466
    firstpluralaccess  1450
+class="cmss-10">firstpluralaccess  1467
    format  1451
+class="cmss-10">format  1468
    long  1452, 1453, 1454, 1455, 1456, 1457
+class="cmss-10">long  1469, 1470, 1471, 1472, 1473, 1474
    longaccess  1458
+class="cmss-10">longaccess  1475
    longplural  1459, 1460, 1461, 1462, 1463, 1464
+class="cmss-10">longplural  1476, 1477, 1478, 1479, 1480, 1481, 1482
    longpluralaccess  1465
+class="cmss-10">longpluralaccess  1483
    name  1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490
+class="cmss-10">name  1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508
    nonumberlist  1491
+class="cmss-10">nonumberlist  1509
    parent  1492, 1493, 1494, 1495
+class="cmss-10">parent  1510, 1511, 1512, 1513
    plural  1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509
+class="cmss-10">plural  1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526, 1527
    pluralaccess  1510
+class="cmss-10">pluralaccess  1528
    prefix  1511, 1512, 1513, 1514, 1515, 1516, 1517
+class="cmss-10">prefix  1529, 1530, 1531, 1532, 1533, 1534, 1535
    prefixfirst  1518, 1519, 1520, 1521, 1522
+class="cmss-10">prefixfirst  1536, 1537, 1538, 1539, 1540
    prefixfirstplural  1523, 1524, 1525, 1526, 1527
+class="cmss-10">prefixfirstplural  1541, 1542, 1543, 1544, 1545
    prefixplural  1528, 1529, 1530, 1531, 1532, 1533
+class="cmss-10">prefixplural  1546, 1547, 1548, 1549, 1550, 1551
    see  1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547
+class="cmss-10">see  1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565
    short  1548, 1549, 1550, 1551, 1552, 1553
+class="cmss-10">short  1566, 1567, 1568, 1569, 1570, 1571
    shortaccess  1554
+class="cmss-10">shortaccess  1572
    shortplural  1555, 1556, 1557, 1558, 1559, 1560
+class="cmss-10">shortplural  1573, 1574, 1575, 1576, 1577, 1578, 1579
    shortpluralaccess  1561
+class="cmss-10">shortpluralaccess  1580
    sort  1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584
+class="cmss-10">sort  1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603
    symbol  1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593
+class="cmss-10">symbol  1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612
    symbolaccess  1594
+class="cmss-10">symbolaccess  1613
    symbolplural  1595, 1596, 1597
+class="cmss-10">symbolplural  1614, 1615, 1616
    symbolpluralaccess  1598
+class="cmss-10">symbolpluralaccess  1617
    text  1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612, 1613
+class="cmss-10">text  1618, 1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630, 1631, 1632
    textaccess  1614
+class="cmss-10">textaccess  1633
    type  1615, 1616
+class="cmss-10">type  1634, 1635, 1636
+ +     user1  1617, 1618, 1619, 1620, 1621
+class="cmss-10">user1  1637, 1638, 1639, 1640, 1641
    user2  1622, 1623, 1624
- - - +class="cmss-10">user2  1642, 1643, 1644
    user3  1625, 1626
+class="cmss-10">user3  1645, 1646
    user4  1627, 1628
+class="cmss-10">user4  1647, 1648
    user5  1629, 1630
+class="cmss-10">user5  1649, 1650
    user6  1631, 1632, 1633
-\newglossarystyle  1634, 1635, 1636, 1637
-\newline  1638, 1639
-\newterm  user6  1651, 1652, 1653
+\newglossarystyle  1654, 1655, 1656, 1657
+\newline  1658, 1659
+\newterm  1640
+class="cmti-10">1660
ngerman package  1641, 1642
+class="cmss-10">ngerman package  1661, 1662
\nohyperpage  1643
+class="cmtt-10">\nohyperpage  1663
\noist  1644, \noist  1664, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655
-\nopostdesc  1656, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675
+\nopostdesc  1676, 1657, 1658, 1659, 1660, 1661
+class="cmti-10">1677, 1678, 1679, 1680, 1681
number list  1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706
-\numberline  1707
-

O -\oldacronym  1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726
+\numberline  1727
+

O +\oldacronym  1708, 1709
-

P +class="cmti-10">1728, 1729
+

P package options:
     acronym  1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729, 1730, 1731, 1732, 1733
+class="cmss-10">acronym  1730, 1731, 1732, 1733, 1734, 1735, 1736, 1737, 1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752, 1753
        true  1734, 1735
+class="cmss-10">true  1754, 1755
    acronymlists  1736, 1737, 1738, 1739
+class="cmss-10">acronymlists  1756, 1757, 1758, 1759, 1760, 1761
    acronyms  1740, 1741
+class="cmss-10">acronyms  1762, 1763
    compatible-2.07  1742, 1743, 1744
+class="cmss-10">compatible-2.07  1764, 1765, 1766
    compatible-3.07  1745, 1746, 1747
+class="cmss-10">compatible-3.07  1767, 1768, 1769
    counter  1748, 1749, 1750, 1751, 1752
+class="cmss-10">counter  1770, 1771, 1772, 1773, 1774
        page  1753
+class="cmss-10">page  1775
    counterwithin  1754, 1755, 1756, 1757, 1758
+class="cmss-10">counterwithin  1776, 1777, 1778, 1779, 1780
    description  1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767
+class="cmss-10">description  1781, 1782, 1783, 1784, 1785, 1786, 1787, 1788, 1789
    dua  1768, 1769
+class="cmss-10">dua  1790, 1791
    entrycounter  1770, 1771, 1772, 1773, 1774
+class="cmss-10">entrycounter  1792, 1793, 1794, 1795, 1796
        false  1775
+class="cmss-10">false  1797
        true  1776
+class="cmss-10">true  1798
    footnote  1777, 1778, 1779, 1780, 1781, 1782
+class="cmss-10">footnote  1799, 1800, 1801, 1802, 1803, 1804
    hyperfirst  1783, 1784, 1785
+class="cmss-10">hyperfirst  1805, 1806, 1807
        false  1786, 1787, 1788, 1789, 1790
+class="cmss-10">false  1808, 1809, 1810, 1811, 1812
        true  1791
+class="cmss-10">true  1813
    index  1792, 1793, 1794, 1795
+class="cmss-10">index  1814, 1815, 1816, 1817
    makeindex  1796, 1797, 1798
- - - +class="cmss-10">makeindex  1818, 1819, 1820
    nogroupskip  1799, 1800, 1801, 1802, 1803
+class="cmss-10">nogroupskip  1821, 1822, 1823, 1824, 1825
+ +         false  1804
+class="cmss-10">false  1826
    nohypertypes  1805, 1806, 1807, 1808, 1809, 1810, 1811
+class="cmss-10">nohypertypes  1827, 1828, 1829, 1830, 1831, 1832, 1833
        index  1812
+class="cmss-10">index  1834
    nolist  1813, 1814, 1815
+class="cmss-10">nolist  1835, 1836, 1837
    nolong  1816, 1817, 1818, 1819
+class="cmss-10">nolong  1838, 1839, 1840, 1841
    nomain  1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827, 1828
+class="cmss-10">nomain  1842, 1843, 1844, 1845, 1846, 1847, 1848, 1849, 1850
    nonumberlist  1829, 1830, 1831, 1832, 1833, 1834, 1835, 1836
+class="cmss-10">nonumberlist  1851, 1852, 1853, 1854, 1855, 1856, 1857, 1858
    nopostdot  1837, 1838
+class="cmss-10">nopostdot  1859, 1860
        false  1839
+class="cmss-10">false  1861
    nostyles  1840, 1841, 1842, 1843, 1844, 1845, 1846
+class="cmss-10">nostyles  1862, 1863, 1864, 1865, 1866, 1867, 1868
    nosuper  1847, 1848, 1849, 1850
+class="cmss-10">nosuper  1869, 1870, 1871, 1872
    notranslate  1851, 1852
+class="cmss-10">notranslate  1873, 1874
    notree  1853, 1854, 1855
+class="cmss-10">notree  1875, 1876, 1877
    nowarn  1856, 1857
+class="cmss-10">nowarn  1878, 1879
    numberedsection  1858, 1859, 1860, 1861, 1862
+class="cmss-10">numberedsection  1880, 1881, 1882, 1883, 1884
        autolabel  1863, 1864
+class="cmss-10">autolabel  1885, 1886
        false  1865
+class="cmss-10">false  1887
        nameref  1866
+class="cmss-10">nameref  1888
        nolabel  1867
+class="cmss-10">nolabel  1889
    numberline  1868, 1869
+class="cmss-10">numberline  1890, 1891
    numbers  1870, 1871, 1872
+class="cmss-10">numbers  1892, 1893, 1894
    order  1873, 1874
+class="cmss-10">order  1895, 1896
        letter  1875, 1876, 1877
+class="cmss-10">letter  1897, 1898, 1899
        word  1878, 1879, 1880
+class="cmss-10">word  1900, 1901, 1902
    sanitizesort  1881, 1882
+class="cmss-10">sanitizesort  1903, 1904
        false  1883, 1884
+class="cmss-10">false  1905, 1906
        true  1885
+class="cmss-10">true  1907
    savenumberlist  1886, 1887
+class="cmss-10">savenumberlist  1908, 1909
        false  1888
+class="cmss-10">false  1910
    savewrites  1889, 1890, 1891
+class="cmss-10">savewrites  1911, 1912, 1913
        false  1892
+class="cmss-10">false  1914
    section  1893, 1894
+class="cmss-10">section  1915, 1916
    seeautonumberlist  1895, 1896, 1897, 1898
+class="cmss-10">seeautonumberlist  1917, 1918, 1919, 1920
    shortcuts  1899, 1900, 1901
+class="cmss-10">shortcuts  1921, 1922, 1923
    smallcaps  1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909
+class="cmss-10">smallcaps  1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931
    smaller  1910, 1911, 1912, 1913, 1914, 1915, 1916
+class="cmss-10">smaller  1932, 1933, 1934, 1935, 1936, 1937, 1938
    sort  1917, 1918, 1919
+class="cmss-10">sort  1939, 1940, 1941
        def  1920, 1921, 1922, 1923, 1924, 1925, 1926
+class="cmss-10">def  1942, 1943, 1944, 1945, 1946, 1947, 1948
        standard  1927, 1928, 1929
+class="cmss-10">standard  1949, 1950, 1951
        use  1930, 1931, 1932, 1933, 1934, 1935, 1936
+class="cmss-10">use  1952, 1953, 1954, 1955, 1956, 1957, 1958
    style  1937, 1938, 1939, 1940, 1941, 1942, 1943
+class="cmss-10">style  1959, 1960, 1961, 1962, 1963, 1964, 1965
        list  1944
- - - +class="cmss-10">list  1966
    subentrycounter  1945, 1946, 1947, 1948, 1949, 1950
+class="cmss-10">subentrycounter  1967, 1968, 1969, 1970, 1971, 1972
        false  1951
+class="cmss-10">false  1973
    symbols  1952, 1953, 1954
+class="cmss-10">symbols  1974, 1975, 1976
    toc  1955, 1956, 1957, 1958, 1959
+class="cmss-10">toc  1977, 1978, 1979, 1980, 1981
+ +     translate  1960, 1961, 1962, 1963
+class="cmss-10">translate  1982, 1983, 1984, 1985
        babel  1964, 1965, 1966, 1967, 1968, 1969
+class="cmss-10">babel  1986, 1987, 1988, 1989, 1990, 1991
        false  1970, 1971, 1972, 1973, 1974
+class="cmss-10">false  1992, 1993, 1994, 1995, 1996
        true  1975, 1976, 1977, 1978
+class="cmss-10">true  1997, 1998, 1999, 2000
    ucfirst  1979
+class="cmss-10">ucfirst  2001
    ucmark  1980, 1981
+class="cmss-10">ucmark  2002, 2003
        false  1982
+class="cmss-10">false  2004
        true  1983
+class="cmss-10">true  2005
    xindy  1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996
+class="cmss-10">xindy  2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018
    xindygloss  1997, 1998
+class="cmss-10">xindygloss  2019, 2020
    xindynoglsnumbers  1999, 2000
+class="cmss-10">xindynoglsnumbers  2021, 2022
page counter  2001
+class="cmtt-10">page (counter)  2023
\pagelistname  2002
+class="cmtt-10">\pagelistname  2024
pdflatex  2003, 2004
+class="cmtt-10">pdflatex  2025, 2026
\PGLS  2005
+class="cmtt-10">\PGLS  2027
\Pgls  2006
+class="cmtt-10">\Pgls  2028
\pgls  2007
+class="cmtt-10">\pgls  2029
\PGLSpl  2008
+class="cmtt-10">\PGLSpl  2030
\Pglspl  2009
+class="cmtt-10">\Pglspl  2031
\pglspl  2010
+class="cmtt-10">\pglspl  2032
pod2man  2011
+class="cmtt-10">pod2man  2033
polyglossia package  2012, 2013, 2014, 2015, 2016
-\printacronyms  polyglossia package  2034, 2035, 2036, 2037, 2038
+\printacronyms  2017, 2018
+class="cmti-10">2039, 2040
\printglossaries  2019, 2020, \printglossaries  2041, 2042, 2021, 2022, 2023, 2024, 2025
-\printglossary  2026, 2027, 2028, 2029, 2030, 2031, 2032, 2043, 2044, 2045, 2046, 2047
+\printglossary  2048, 2049, 2050, 2051, 2052, 2053, 2054, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040
+class="cmti-10">2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062
\printglossary options
 +class="cmtt-10">\printglossary options
    nonumberlist  2041
+class="cmss-10">nonumberlist  2063
    numberedsection  2042
+class="cmss-10">numberedsection  2064
    style  2043, 2044, 2045, 2046
+class="cmss-10">style  2065, 2066, 2067, 2068
    title  2047, 2048
+class="cmss-10">title  2069, 2070
    toctitle  2049
+class="cmss-10">toctitle  2071
    type  2050
+class="cmss-10">type  2072
\printindex  \printindex  2051
+class="cmti-10">2073
\printnumbers  \printnumbers  2052
+class="cmti-10">2074
\printsymbols  \printsymbols  2053
+class="cmti-10">2075
\provideglossaryentry  \provideglossaryentry  2054
-

R - - - +class="cmti-10">2076, 2077
+

R relsize package  2055, 2056
-\Roman  2057
-

S +class="cmss-10">relsize package  2078, 2079
+\Roman  2080
+

S sanitize  2058, 2059, 2060, 2061
+href="glossaries-user.html#dx1-3044" >2081, 2082, 2083, 2084
scrwfile package  2062
-\section*  2063, 2064
-\seename  2065, 2066, 2067, 2068
-\SetAcronymLists  scrwfile package  2085
+ + +\section*  2086, 2087
+\seename  2088, 2089, 2090, 2091
+\SetAcronymLists  2069
+class="cmti-10">2092
\setacronymstyle  2070, \setacronymstyle  2093, 2094, 2071, 2072
+class="cmti-10">2095, 2096
\setAlphaCompositor  2073
+class="cmtt-10">\setAlphaCompositor  2097
\setCompositor  2074
+class="cmtt-10">\setCompositor  2098
\setentrycounter  2075, 2076
+class="cmtt-10">\setentrycounter  2099, 2100
\setglossarypreamble  2077, \setglossarypreamble  2101, 2078
+class="cmti-10">2102
\setglossarysection  \setglossarysection  2079, 2080
-\setglossarystyle  2081, 2082, 2083, 2084, 2085, 2086, 2087
-\setStyleFile  2088, 2089, 2103, 2104
+\setglossarystyle  2105, 2106, 2107, 2108, 2109, 2110, 2111
+\setStyleFile  2112, 2113, 2090
+class="cmti-10">2114
\setupglossaries  \setupglossaries  2091
+class="cmti-10">2115
\subglossentry  2092
+class="cmtt-10">\subglossentry  2116
supertabular (environment)  2093, 2094, 2095, 2096, 2097
+class="cmtt-10">supertabular (environment)  2117, 2118, 2119, 2120, 2121
supertabular package  2098, 2099, 2100
-\symbolname  2101
-

T +class="cmss-10">supertabular package  2122, 2123, 2124
+\symbolname  2125
+

T TeX4HT  2102
+href="glossaries-user.html#dx1-71095" >2126
\textbf  2103
+class="cmtt-10">\textbf  2127
textcase package  2104, 2105
-\textrm  2106
-\textsc  2107, 2108, 2109, 2110, 2111, 2112, 2113
-\textsmaller  2114, 2115, 2116, 2117
-\textulc  2118
-\textup  2119
-\the  2120
+class="cmss-10">textcase package  2128, 2129
+\textrm  2130
+\textsc  2131, 2132, 2133, 2134, 2135, 2136, 2137
+\textsmaller  2138, 2139, 2140, 2141
+\textulc  2142
+\textup  2143
+\the  2144
theglossary (environment)  2121, 2122, 2123, 2124
-\thepage  2125
+class="cmtt-10">theglossary (environment)  2145, 2146, 2147, 2148
+\thepage  2149
translator package  2126, 2127, 2128, 2129, 2130, 2131, 2132, 2133, 2134, 2135, 2136, 2137, 2138, 2139, 2140
-

W - - - -\write18  2141
-

X -xindy  2142
+class="cmss-10">translator package  2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164
+

W +\write18  2165
+

X xindy  2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164, 2165, 2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252
+class="cmtt-10">xindy  2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277
xkeyval package  2253, 2254
+class="cmss-10">xkeyval package  2278, 2279
\xmakefirstuc  2255
+class="cmtt-10">\xmakefirstuc  2280
\xspace  2256
+class="cmtt-10">\xspace  2281
xspace package  2257, 2258, 2259, 2260, 2261, 2262, 2263
+class="cmss-10">xspace package  2282, 2283, 2284, 2285, 2286, 2287, 2288

- - - -

-1That is, if the term has been referenced using any of the commands described - in

1.1That is, if the term has been referenced using any of the commands described in §6 §6 Links to Glossary Entries and Links to +Glossary Entries and §7 §7 Adding an Entry to the Glossary - Without Generating Text or via \glssee (or the seeAdding an Entry to the Glossary Without Generating Text or via \glssee +(or the see key) or commands such as - \acrshortkey) or commands such as \acrshort.

-2Note that although I’ve written latex in this section, it’s better to use pdflatex, - where possible, for the reasons given .

+

1.2Note that although I’ve written latex in this section, it’s better to use pdflatex, where +possible, for the reasons given earlier.

-3As from v3.01 \glsearlier.

+

1.3As from v3.01 \gls is no longer fragile and doesn’t need protecting.

-4Apparently MiKTeX has an alternative makeglossaries.exe but I don’t know how - using this differs from using makeglossaries.bat.

-1Actually it uses \mfirstucMakeUppercase which is set to textcase’s - \MakeTextUppercase by the glossaries package. This makes it consistent with - \makefirstuc. (The textcaseis no longer fragile and doesn’t need protecting.

+

1.4Apparently MiKTeX has an alternative makeglossaries.exe but I don’t know how using this +differs from using makeglossaries.bat.

+

2.1unless memoir is loaded, which case it uses \markboth

+

2.2Actually it uses \mfirstucMakeUppercase package is automatically loaded by glossaries.)

-

-2Actually it sets \acronymtypewhich is set to textcase’s \MakeTextUppercase by the +glossaries package. This makes it consistent with \makefirstuc. (The textcase package is +automatically loaded by glossaries.)

+

2.3Actually it sets \acronymtype to \glsdefaulttypeto \glsdefaulttype if the acronymif the acronym package option is - not used, but \glsdefaulttypepackage option is not +used, but \glsdefaulttype usually has the value main unless the nomainusually has the value main unless the nomain option - has been used.

-1The only preamble restriction on \newglossaryentryoption has been +used.

4.1The only preamble restriction on \newglossaryentry and \newacronymand \newacronym was - removed in version 1.13, but the restriction remains for \loadglsentrieswas removed in +version 1.13, but the restriction remains for \loadglsentries. See . See §4.8 - §4.8 Drawbacks With Defining Entries in the Document Environment for a discussion of - the problems with defining entries within the document instead of in the - preamble.

-2Except possibly the style file but then you’ll need to use \noistDrawbacks With Defining +Entries in the Document Environment for a discussion of the problems with defining entries within +the document instead of in the preamble.

+

4.2Except possibly the style file but then you’ll need to use \noist to prevent your - changes from being overwritten.

-3This is because \acronymtypeto prevent your changes from +being overwritten.

+

4.3This is because \acronymtype is set to \glsdefaulttypeis set to \glsdefaulttype if the acronymif the acronym package - option is not used.

-1\glsdisplayfirstpackage option is not +used.

6.1\glsdisplayfirst and \glsdisplayand \glsdisplay are now deprecated. Backwards compatibility - should be preserved but you may need to use the compatible-3.07are now deprecated. Backwards compatibility should be +preserved but you may need to use the compatible-3.07 option

-1option

+

8.1makeindexmakeindex will always assign a location number, even if it’s not needed, so it needs - to be discarded.

-2If you redefine \glsseeformat, keep the default value of the optional argument as - \seename as both seewill always assign a location number, even if it’s not needed, so it needs to be +discarded.

8.2Ifyou redefine \glsseeformat, keep the default value of the optional argument as \seename +as both see and \glssee explicitly write [\seename] in the output file if no - optional argument is given.

-3In versions before 3.0, \glsentryname was used, but this could cause problems - when the name key was and \glssee explicitly write [\seename] in the output file if no optional argument is +given.

+

8.3In versions before 3.0, \glsentryname was used, but this could cause problems when the name +key was sanitizedsanitized.

-1versions before 3.0 used \glsentryname.

+

9.1versions before 3.0 used \glsentryname as the default, but this could cause - problems when nameas the default, but this could cause problems when +name had been had been sanitizedsanitized.

-1you can’t use the longheaderborder.

10.1you can’t use the longheaderborder style for this example as you can’t use the - longtablestyle for this example as you can’t use the longtable environment in two column mode.

-1see \setCompositor +environment in two column mode.

11.1see \setCompositor described in described in §3 §3 Setting Up

-2see \setAlphaCompositorSetting Up

+

11.2see \setAlphaCompositor described in described in §3 §3 Setting Up

-1as from version 1.18

-2See David Carlisle’s explanation in Setting Up

+

13.1as from version 1.18

13.2See David Carlisle’sexplanation in http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace

-1These lengths will not be available if you use both the nolong and nosuper package - options or if you use the nostyles package option unless you explicitly load the - relevant package.

-2This style was supplied by Axel Menzel.

-3e.g. with the flowfram package.

-1Single letter words, such as “a” and “I” should typically not appear at the end of a - line, hence the non-breakable space after “a” in the prefix field.

-2The earlier caveats about initial non-Latin characters apply.

- - - +class="cmtt-8">http://tex.stackexchange.com/questions/86565/drawbacks-_of-_xspace

+

15.1These lengths will not be available if you use both the nolong and nosuper package +options or if you use the nostyles package option unless you explicitly load the relevant +package.

+

15.2This style was supplied by Axel Menzel.

+

15.3e.g. with the flowfram package.

+

17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, +hence the non-breakable space after “a” in the prefix field.

+

17.2The earlier caveats about initial non-Latin characters apply.

- + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index 707162a1ac7..a89c532e549 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 3cb0f0ab9b9..dbc79467c05 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -1,4 +1,4 @@ -\documentclass[report]{nlctdoc} +\documentclass[report,inlinetitle]{nlctdoc} \usepackage[inner=0.5in,includemp]{geometry} @@ -90,15 +90,15 @@ {% An application that doesn't have a graphical user interface. That is, an application that doesn't have any windows, - buttons or menus and can be run in a command - prompt or terminal (see - \url{http://www.dickimaw-books.com/latex/novices/html/terminal.html}). + buttons or menus and can be run in + \href{http://www.dickimaw-books.com/latex/novices/html/terminal.html}{a command + prompt or terminal}. } \longnewglossaryentry{xindy}{% - name={\appfmt{xindy}\index{xindy|htextbf}}, + name={\appfmt{xindy}\index{xindy=\appfmt{xindy}|htextbf}}, sort={xindy}, - text={\protect\app{xindy}} + text={\appfmt{xindy}\iapp{xindy}} }% {% A flexible \gls{indexingapp} with multilingual @@ -106,37 +106,35 @@ } \newglossaryentry{makeindex}{% -name={\appfmt{makeindex}\index{makeindex|htextbf}},% +name={\appfmt{makeindex}\index{makeindex=\appfmt{makeindex}|htextbf}},% sort={makeindex},% -text={\protect\app{makeindex}},% +text={\appfmt{makeindex}\iapp{makeindex}},% description={An \gls{indexingapp}}, } \newglossaryentry{makeglossaries}{% -name={\appfmt{makeglossaries}\index{makeglossaries|htextbf}},% +name={\appfmt{makeglossaries}\index{makeglossaries=\appfmt{makeglossaries}|htextbf}},% sort={makeglossaries},% -text={\protect\app{makeglossaries}},% +text={\appfmt{makeglossaries}\iapp{makeglossaries}},% description={A custom designed Perl script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} package} } \longnewglossaryentry{makeglossariesgui}{% -name={\appfmt{makeglossariesgui}\index{makeglossariesgui|htextbf}},% +name={\appfmt{makeglossariesgui}\index{makeglossariesgui=\appfmt{makeglossariesgui}|htextbf}},% sort={makeglossariesgui},% -text={\protect\app{makeglossariesgui}}% +text={\appfmt{makeglossariesgui}\iapp{makeglossariesgui}}% }% {% A Java GUI alternative to \gls{makeglossaries} that - also provides diagnostic tools. Home page: - \url{http://www.dickimaw-books.com/apps/makeglossariesgui/}. Also - available on CTAN. + also provides diagnostic tools. Available separately on CTAN. } \newglossaryentry{numberlist}{% name={Number list\itermdef{number list}},% sort={number list},% -text={\protect\term{number list}},% +text={number list\iterm{number list}},% description={A list of \glslink{entrylocation}{entry locations} (also called a location list). The number list can be suppressed using the \pkgopt{nonumberlist} package option} @@ -145,7 +143,7 @@ called a location list). The number list can be suppressed using the \newglossaryentry{entrylocation}{% name={Entry location\itermdef{entry location}},% sort={entry location},% -text={\protect\term{entry location}},% +text={entry location\iterm{entry location}},% description={The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple locations} @@ -162,7 +160,7 @@ see={numberlist} \newglossaryentry{linktext}{% name={Link text\itermdef{link text}}, sort={link text},% -text={\protect\term{link text}}, +text={link text\iterm{link text}}, description={The text produced by commands such as \ics{gls}. It may or may not be a hyperlink to the glossary} } @@ -208,7 +206,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \longnewglossaryentry{sanitize}{% name={Sanitize\itermdef{sanitize}},% sort={sanitize}, -text={\protect\term{sanitize}},% +text={sanitize\iterm{sanitize}},% user1={sanitized\protect\iterm{sanitize}},% user2={sanitization\protect\iterm{sanitize}}% }% @@ -280,13 +278,20 @@ user2={sanitization\protect\iterm{sanitize}}% \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.02} + \title{User Manual for glossaries.sty v4.03} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2013-12-05} + \date{2014-01-20} \maketitle +\begin{abstract} +The \styfmt{glossaries} package provides a means to define terms or +acronyms or symbols that can be referenced within your document. +Sorted lists with collated \glslink{entrylocation}{locations} can be +generated using a supplementary \gls{indexingapp}. +\end{abstract} + \begin{important} Documents have various styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and @@ -297,7 +302,7 @@ complicated descriptions. The \styfmt{glossaries} package is flexible enough to accommodate such varied requirements, but this flexibility comes at a price: a~big manual. -\grimace\ If you're freaking out at the size of this manual, start with +\aargh\ If you're freaking out at the size of this manual, start with \texttt{glossariesbegin.pdf} (\qt{The glossaries package: a guide for beginnners}). You should find it in the same directory as this document or try \texttt{texdoc glossariesbegin.pdf}. Once you've got @@ -330,7 +335,7 @@ letter}{mfirstuc-manual}. \item[\url{glossaries-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v4.02}. +\qt{Documented Code for glossaries v4.03}. This includes the documented code for the \sty{mfirstuc} package. \item[INSTALL] Installation instructions. @@ -1319,7 +1324,7 @@ resulting file onto the man path. Alternatively do \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -2.10. +2.12. \end{important} \subsection{Using xindy explicitly} @@ -1517,7 +1522,9 @@ package. Options that aren't \meta{key}=\meta{value} (such as \begin{description} \item[\pkgopt{nowarn}] This suppresses all warnings generated by -the \styfmt{glossaries} package. +the \styfmt{glossaries} package. Don't use this option if you're new to using +\styfmt{glossaries} as the warnings are designed to help detect +common mistakes (such as forgetting to use \ics{makeglossaries}). \item[\pkgopt{nomain}] This suppresses the creation of the main glossary and associated \texttt{.glo} file, if unrequired. Note that @@ -1741,7 +1748,8 @@ The start of each glossary adds information to the page header via \begin{definition}[\DescribeMacro{\glsglossarymark}] \cs{glsglossarymark}\marg{glossary title} \end{definition} -This defaults to \cs{@mkboth}, but you may +By default this uses \cs{@mkboth}\footnote{unless \cls{memoir} is +loaded, which case it uses \ics{markboth}} but you may need to redefine it. For example, to only change the right header: \begin{verbatim} @@ -3303,6 +3311,34 @@ in the text will appear in the relevant glossaries. Note also that \cs{loadglsentries} may only be used in the preamble. +Remember that you can use \ics{provideglossaryentry} rather than +\ics{newglossaryentry}. Suppose you want to maintain a large database +of acronyms or terms that you're likely to use in your documents, +but you may want to use a modified version of some of those entries. +(Suppose, for example, one document may require a more detailed +description.) Then if you define the entries using +\cs{provideglossaryentry} in your database file, you can override +the definition by simply using \cs{newglossaryentry} before loading +the file. For example, suppose your file (called, say, +\texttt{terms.tex}) contains: +\begin{verbatim} +\provideglossaryentry{mallard}{name=mallard, + description={a type of duck}} +\end{verbatim} +but suppose your document requires a more detailed description, you +can do: +\begin{verbatim} +\usepackage{glossaries} +\makeglossaries + +\newglossaryentry{mallard}{name=mallard, + description={a dabbling duck where the male has a green head}} + +\loadglsentries{terms} +\end{verbatim} +Now the \texttt{mallard} definition in the \texttt{terms.tex} file +will be ignored. + \section{Moving Entries to Another Glossary} \label{sec:moveentry} @@ -3478,8 +3514,10 @@ commands or any other command that has a moving argument. The above warning is particularly important if you are using the \styfmt{glossaries} package in conjunction with the \sty{hyperref} -package. Instead, use one of the commands listed in -\sectionref{sec:glsnolink} (such as \ics{glsentrytext}) or provide an +package. Instead, use one of the \emph{expandable} commands listed in +\sectionref{sec:glsnolink} (such as \ics{glsentrytext} \emph{but +not} the non-expandable +case changing versions like \ics{Glsentrytext}) or provide an alternative via the optional argument to the sectioning\slash caption command. Examples: \begin{verbatim} @@ -4008,7 +4046,7 @@ the hyperlink. Similarly for the other user keys: \section{Changing the format of the link text} \label{sec:glsdisplay} -The format of the \gls{linktext} for \ics{gls}, \ics{glspl} +The default format of the \gls{linktext} for \ics{gls}, \ics{glspl} and their upper case variants and also for \ics{glsdisp} is governed by\footnote{\ics{glsdisplayfirst} and \ics{glsdisplay} are now deprecated. Backwards compatibility should be preserved but @@ -4016,8 +4054,31 @@ you may need to use the \pkgopt{compatible-3.07} option}: \begin{definition}[\DescribeMacro{\glsentryfmt}] \cs{glsentryfmt} \end{definition} -If you want to redefine this command, you may use the following -commands within its definition: +This may be redefined but if you only want the change the display style +for a given glossary, then you need to use +\begin{definition}[\DescribeMacro{\defglsentryfmt}] +\cs{defglsentryfmt}\oarg{type}\marg{definition} +\end{definition} +instead of redefining \cs{glsentryfmt}. The optional first argument +\meta{type} is the glossary type. This defaults to +\ics{glsdefaulttype} if omitted. The second argument is the +entry format definition. + +\begin{important} +Note that \cs{glsentryfmt} is the default display format for +entries. Once the display format has been changed for an individual +glossary using \ics{defglsentryfmt}, redefining \cs{glsentryfmt} +won't have an effect on that glossary, you must instead us +\cs{defglsentryfmt} again. Note that glossaries that have +been identified as lists of acronyms (via the package option +\pkgopt{acronymlists} or the command \ics{DeclareAcronymList}, +see \sectionref{sec:pkgopts-acronym}) use +\cs{defglsentryfmt} to set their display style. +\end{important} + +Within the \meta{definition} argument of \cs{defglsentryfmt}, or if you +want to redefine \cs{glsentryfmt}, you may use the following +commands: \begin{definition}[\DescribeMacro{\glslabel}] \cs{glslabel} @@ -4146,20 +4207,6 @@ then \verb|\gls{distance}| will produce \qt{\textbf{distance (km)}}. For a complete document, see the sample file \samplefile{-entryfmt}. \end{example} -If you have multiple glossaries, changing \cs{glsentryfmt} will change the -way entries for all of the glossaries appear when using the commands -\ics{gls}, \ics{glspl}, their upper case variants and \ics{glsdisp}. -If you only -want the change to affect entries for a given glossary, then you need -to use -\begin{definition}[\DescribeMacro{\defglsentryfmt}] -\cs{defglsentryfmt}\oarg{type}\marg{definition} -\end{definition} -instead of redefining \cs{glsentryfmt}. The optional first argument -\meta{type} is the glossary type. This defaults to -\ics{glsdefaulttype} if omitted. The second argument is the -entry format definition. - \begin{example}{Custom Format for Particular Glossary}{ex:defglsentryfmt} Suppose you have created a new glossary called \texttt{notation} and you want to change the way the entry is @@ -5372,6 +5419,22 @@ the extension for the \gls{makeindex} or \gls{xindy} transcript file (this information is only used by \gls{makeglossaries} which picks up the information from the auxiliary file). +\begin{important} +The glossary label \meta{name} must not contain any active +characters. It's generally best to stick with just characters that +have category code~11 (typically \texttt{a}, \ldots, \texttt{z} +and \texttt{A}, \ldots, \texttt{Z}). +\end{important} + +You can also use: +\begin{definition}[\DescribeMacro{\altnewglossary}] +\cs{altnewglossary}\marg{name}\marg{tag}\marg{title}\oarg{counter} +\end{definition} +This is equivalent to +\begin{alltt} +\cs{newglossary}[\meta{tag}-glg]\marg{name}\{\meta{tag}-gls\}\{\meta{tag}-glo\}\marg{title}\oarg{counter} +\end{alltt} + Note that the main (default) glossary is automatically created as: \begin{verbatim} \newglossary{main}{gls}{glo}{\glossaryname} @@ -5426,10 +5489,25 @@ useful means to define acronyms. For convenience, the \end{definition} This uses \ics{newglossaryentry} to create an entry with the given -label in the glossary given by \ics{acronymtype}. It also uses the -\gloskey{long}, \gloskey{longplural}, \gloskey{short} and -\gloskey{shortplural} keys to store the long and abbreviated forms -and their plurals. +label in the glossary given by \ics{acronymtype}. You can specify a +different glossary using the \gloskey{type} key within the optional +argument. The \cs{newacronym} command also uses the \gloskey{long}, +\gloskey{longplural}, \gloskey{short} and \gloskey{shortplural} keys +in \cs{newglossaryentry} to store the long and abbreviated forms and +their plurals. + +\begin{important} +If you haven't identified the specified glossary type as a list of +acronyms (via the package option +\pkgopt{acronymlists} or the command \ics{DeclareAcronymList}, +see \sectionref{sec:pkgopts-acronym}) \cs{newacronym} will add it to +the list and \emph{reset the display style} for that glossary via +\ics{defglsentryfmt}. If you have a mixture of acronyms and regular +entries within the same glossary, care is needed if you want to +change the display style: you must first identify that glossary as a +list of acronyms and then use \ics{defglsentryfmt} (not redefine +\ics{glsentryfmt}) before defining your entries. +\end{important} The optional argument \marg{key-val list} allows you to specify keys such as \gloskey{description} (when used with one of the styles that @@ -5443,7 +5521,10 @@ For example: {dm}{DM}{diagonal matrix} \end{verbatim} If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will -display: diagonal matrices (DMs). +display: diagonal matrices (DMs). If you want to use +the \gloskey{longplural} or \gloskey{shortplural} keys, I recommend +you use \ics{setacronymstyle} to set the display style rather than +using one of the pre-version 4.02 acronym styles. Since \ics{newacronym} uses \ics{newglossaryentry}, you can use commands like \ics{gls} and \ics{glsreset} as with any other @@ -5476,16 +5557,24 @@ Now \verb|\gls{idn}| will produce \qt{identification number uses. \end{example} -There are commands analogous to \ics{glstext} (described in +There are commands similar to \ics{glstext} (described in \sectionref{sec:glslink}) that allow you to access just the short form, just the long form or the full form, without affecting the \gls{firstuseflag}. (Note that the full form isn't necessarily the same as the text produced on \firstuse.) +\begin{important} +Although these commands are +similar to commands such as \ics{glstext}, they behave more like +\ics{glsdisp} (except for the \gls*{firstuse} behaviour) in that +the display is governed by \ics{defentryfmt} with +\ics{glscustomtext} set as appropriate. +\end{important} + \begin{definition}[\DescribeMacro{\acrshort}] \cs{acrshort}\oarg{options}\marg{label}\oarg{insert} \end{definition} -This displays the short form for the entry given by \meta{label}. +This displays the short form (within the argument of \ics{acronymfont}) for the entry given by \meta{label}. The optional arguments are the same as those for \ics{glstext}. There is also a starred version to suppress the hyperlink. There are also analogous upper case variants: @@ -5611,6 +5700,14 @@ It is also possible to access the long and short forms without adding information to the glossary using commands analogous to \ics{glsentrytext} (described in \sectionref{sec:glsnolink}). +\begin{important} +The commands that convert the first letter to upper case come with +the same caveats as those for analogous commands like +\ics{Glsentrytext} (non-expandable, can't be used in PDF bookmarks, +care needs to be taken if the first letter is an accented character +etc). See \sectionref{sec:glsnolink}. +\end{important} + The long form can be accessed using: \begin{definition}[\DescribeMacro{\glsentrylong}] \cs{glsentrylong}\marg{label} @@ -6528,19 +6625,34 @@ checks for this. Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may -have hierarchical entries. There is therefore no single style -that fits every type of glossary. The \styfmt{glossaries} package -comes with a number of pre-defined glossary styles, and you need to -choose one that best suits your type of glossary. There is a summary -of available styles in \tableref{tab:styles}. If none of them suit -your document, you can defined your own style -(see \sectionref{sec:newglossarystyle}). +have hierarchical entries. There is therefore no single style that +fits every type of glossary. The \styfmt{glossaries} package comes +with a number of pre-defined glossary styles, described in +\sectionref{sec:predefinedstyles}. You can choose one of these that +best suits your type of glossary or, if none of them suit your +document, you can defined your own style (see +\sectionref{sec:newglossarystyle}). + +The glossary style can be set using the \gloskey[printglossary]{style} key in the optional +argument to \ics{printglossary} or using the command: +\begin{definition}[\DescribeMacro{\setglossarystyle}] +\cs{setglossarystyle}\marg{style-name} +\end{definition} +(before the glossary is displayed). + +Some of the predefined glossary styles may also be set using the \pkgopt{style} +package option, it depends if the package in which they are defined +is automatically loaded by the \styfmt{glossaries} package. + +\section{Predefined Styles} +\label{sec:predefinedstyles} The predefined styles can accommodate numbered level~0 (main) and level~1 entries. See the package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and \pkgopt{subentrycounter} described in -\sectionref{sec:pkgopts-printglos}. +\sectionref{sec:pkgopts-printglos}. There is a summary +of available styles in \tableref{tab:styles}. \begin{table}[htbp] \caption[Glossary Styles]{Glossary Styles. An asterisk in the style @@ -6582,15 +6694,6 @@ be displayed.} \par \end{table} -The glossary style can be set using the \gloskey[printglossary]{style} key in the optional -argument to \ics{printglossary} or using the command: -\begin{definition}[\DescribeMacro{\setglossarystyle}] -\cs{setglossarystyle}\marg{style-name} -\end{definition} -Some of the glossary styles may also be set using the \pkgopt{style} -package option, it depends if the package in which they are defined -is automatically loaded by the \styfmt{glossaries} package. - 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 @@ -6652,7 +6755,7 @@ given entry by placing \ics{nopostdesc} in the entry's description. As from version 3.03 you can now use the package option \pkgopt{nopostdot} to suppress this full stop. -\section{List Styles} +\subsection{List Styles} \label{sec:liststyles} The styles described in this section are all defined in the package @@ -6727,7 +6830,7 @@ the same manner as \glostyle{listdotted}. \end{description} -\section{Longtable Styles} +\subsection{Longtable Styles} \label{sec:longstyles} The styles described in this section are all defined in the package @@ -6823,7 +6926,7 @@ descriptions and page lists. \end{description} -\section{Longtable Styles (Ragged Right)} +\subsection{Longtable Styles (Ragged Right)} \label{sec:longraggedstyles} The styles described in this section are all defined in the package @@ -6910,7 +7013,7 @@ lines around it. \end{description} -\section{Supertabular Styles} +\subsection{Supertabular Styles} \label{sec:superstyles} The styles described in this section are all defined in the package @@ -7009,7 +7112,7 @@ descriptions and page lists. \end{description} -\section{Supertabular Styles (Ragged Right)} +\subsection{Supertabular Styles (Ragged Right)} \label{sec:superraggedstyles} The styles described in this section are all defined in the package @@ -7097,7 +7200,7 @@ lines around it. \end{description} -\section{Tree-Like Styles} +\subsection{Tree-Like Styles} \label{sec:treestyles} The styles described in this section are all defined in the package @@ -7184,7 +7287,7 @@ groups. The navigation line is the same as that for \end{description} -\section{Multicols Style} +\subsection{Multicols Style} \label{sec:mcolstyles} The \sty{glossary-mcols} package provides tree-like styles that are @@ -7237,7 +7340,7 @@ Analogous Tree Style\\ \end{tabular} \end{table} -\section{In-Line Style} +\subsection{In-Line Style} \label{sec:inline} This section covers the \sty{glossary-inline} package that supplies @@ -7289,7 +7392,7 @@ a parent main entry and its first sub-entry. This defaults to ``\texttt{\glsinlineseparator}'' and is used at the end of the glossary. -\chapter{Defining your own glossary style} +\section{Defining your own glossary style} \label{sec:newglossarystyle} If the predefined styles don't fit your requirements, you can @@ -7632,6 +7735,12 @@ that displays each entry in a \env{longtable} as follows: This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf). +\begin{important} +Some of the commands described here take a comma-separated list as +an argument. As with \LaTeX's \cs{@for} command, make sure your list +doesn't have an unwanted spaces in it as they don't get stripped. +\end{important} + \begin{definition}[\DescribeMacro{\forallglossaries}] \cs{forallglossaries}\oarg{glossary list}\marg{cs}\marg{body} \end{definition} @@ -7694,6 +7803,12 @@ doesn't exist, an error is generated. (This command uses Does the reverse of \cs{glsdoifexists}. (This command uses \cs{ifglsentryexists}.) +\begin{definition}[\DescribeMacro{\glsdoifexistsorwarn}] +\cs{glsdoifexistsorwanr}\marg{label}\marg{code} +\end{definition} +As \cs{glsdoifexists} but issues a warning rather than an error if +the entry doesn't exist. + \begin{definition}[\DescribeMacro{\ifglsused}] \cs{ifglsused}{\meta{label}}{\meta{true part}}{\meta{false part}} @@ -7730,6 +7845,7 @@ This checks if the glossary entry given by \meta{label} has had the \gloskey{long} field set. If it has, \meta{true part} is performed, otherwise \meta{false part}. This should be true for any entry that has been defined via \ics{newacronym}. +There is no check for the existance of \meta{label}. \begin{definition}[\DescribeMacro{\ifglshasshort}] \cs{ifglshasshort}\marg{label}\marg{true part}\marg{false part} @@ -7738,6 +7854,7 @@ This checks if the glossary entry given by \meta{label} has had the \gloskey{short} field set. If it has, \meta{true part} is performed, otherwise \meta{false part}. This should be true for any entry that has been defined via \ics{newacronym}. +There is no check for the existance of \meta{label}. \begin{definition}[\DescribeMacro{\ifglshasdesc}] \cs{ifglshasdesc}\marg{label}\marg{true part}\marg{false part} @@ -7751,6 +7868,20 @@ performed, otherwise \meta{false part}. Compare with: This checks if the \gloskey{description} field has been set to just \ics{nopostdesc} for the entry given by \meta{label}. If it has, \meta{true part} is performed, otherwise \meta{false part}. +There is no check for the existance of \meta{label}. + +For all other fields you can use: +\begin{definition} +\cs{ifglshasfield}\marg{field}\marg{label}\marg{true part}\marg{false +part} +\end{definition} +This checks if the field given by \meta{field} for the entry +identified by \meta{label} is empty. If it is, \meta{true part} is +performed, otherwise \meta{false part}. If the field supplied is unrecognised \meta{false part} +is performed and a warning is issued. Unlike the above commands, +such as \cs{ifglshasshort}, an error occurs if the entry is +undefined. + \chapter{Prefixes or Determiners}\label{sec:prefix} @@ -7958,12 +8089,16 @@ apply.}: \cs{Glsentryprefixplural}\marg{label} \end{definition} -\pagebreak \DescribeMacro\Glsentryprefixfirstplural \begin{definition} \cs{Glsentryprefixfirstplural}\marg{label} \end{definition} +\begin{important} +As with analoguous commands such as \ics{Glsentrytext}, these +commands aren't expandable so can't be used in PDF bookmarks. +\end{important} + \begin{example}{Adding Determiner to Glossary Style}{ex:plist} You can use the above commands to define a new glossary style that uses the determiner. For example, the following style is a slight @@ -8058,17 +8193,17 @@ For example, on my Linux partition it can be found in \texttt{\slash usr\slash local\slash texlive\slash 2013\slash texmf-dist\slash doc\slash latex\slash glossaries/}. Further information on debugging \LaTeX\ code is available at -\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. +\url{http://www.dickimaw-books.com/latex/minexample/}. Below is a list of the most frequently asked questions. For other -queries, consult the \styfmt{glossaries} FAQ at -\url{http://www.dickimaw-books.com/faqs/glossariesfaq.html}. If that +queries, consult the +\urlfootref{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{\styfmt{glossaries} FAQ}. If that doesn't help, try posting your query to somewhere like the -comp.text.tex newsgroup, the \LaTeX\ Community Forum -(\url{http://www.latex-community.org/}) or \TeX\ on StackExchange -(\url{http://tex.stackexchange.com/}). -Bug reports can be submitted at -\url{http://www.dickimaw-books.com/bug-report.html}. +comp.text.tex newsgroup, the +\urlfootref{http://www.latex-community.org/}{\LaTeX\ Community Forum} or +\urlfootref{http://tex.stackexchange.com/}{\TeX\ on StackExchange}. +Bug reports can be submitted via +\urlfootref{http://www.dickimaw-books.com/bug-report.html}{my package bug report form}. \begin{enumerate} \item \textbf{Q.} I get the error message: diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index c82c1dc600d..6bc51a6a310 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -1,4 +1,5 @@ - + @@ -6,664 +7,804 @@ > The glossaries package: a guide for beginners - - + + - + + + -
+
+ + -
-
-

The glossaries package: a guide for -beginners

+

The glossaries package: a guide for beginners

Nicola L.C. Talbot

+class="cmr-12">Nicola L.C. Talbot

2013-12-05
-
-
2014-01-20
+
+
-

This document is a brief guide to the glossaries package for - beginners who find the size of the main user manual daunting - and, as such, it only covers the basics. For more advanced topics, - see the main user manual. +

+

+

Abstract

+

This document is a brief guide to the glossaries package for beginners who + find the size of the main user manual daunting and, as such, it only covers + the basics. For more advanced topics, see the main user manual.

-

Contents

-
- 1 + 1 What Do I Need? -
2 2 Getting Started -
3 3 Defining a Term or Symbol -
4 4 Using a Term -
5 5 Acronyms -
6 6 Displaying the Glossary or List of Acronyms -
+
+

-

1

Top

1 What Do I Need?

You need to have the glossaries package installed. You also need to have the -following packages installed: datatool, ifthen, xkeyval (at least version 2.5f), -xfor, amsgen and etoolbox. You may also need longtable, supertabular, -array or multicol, depending on what glossary style you want to use. -All these packages can be downloaded from CTAN if you don’t have -them installed. See “Installing things on a (La)TeX System” for further -assistance. -

In addition, you need an indexing application. The glossaries package is -configured to use either makeindex or xindy. Makeindex should be available on -all TEX systems. It’s possible you may not have xindy installed, but -it can be downloaded from the xindy home page. MiKTeX users may -find the Xindy for MiKTeX thread on the LaTeX Community Forum -helpful. -

The glossaries package provides a helper Perl script called makeglossaries -which will act as an interface to makeindex or xindy. If you want to use +class="cmss-10">glossaries package installed. This and all dependent packages are +contained in both the TeX Live and MikTeX distributions. Use your distribution’s +update manager to ensure you have an up-to-date version. These packages can also be +downloaded from CTAN if you don’t have them installed. See “Installing things on a +(La)TeX System” for further assistance. +

In addition, you need an indexing application. The glossaries package is configured to +use either makeindex or xindy. Makeindex should be available on all TEX systems. It’s +possible you may not have xindy installed, but it can be downloaded from the xindy +home page. MiKTeX users may find the Xindy for MiKTeX thread on the LaTeX +Community Forum helpful. +

The glossaries package provides a helper Perl script called makeglossaries which +will act as an interface to makeindex or xindy. If you want to use makeglossaries or makeglossaries or xindy, you need to have Perl installed. If you don’t have -Perl installed, you can still use glossaries but you can only use it with +class="cmtt-10">xindy, you need to have Perl installed. If you don’t have Perl installed, you can still use makeindex. -

+class="cmss-10">glossaries but you can only use it with makeindex. +

-

Top

2

Top

2 Getting Started

-

The most obvious things to do is to remember to load the glossaries -package: +

The most obvious things to do is to remember to load the glossaries package: +

-
+
\usepackage{glossaries}
-

-

Note that the glossaries package must be loaded after the hyperref

+

Note that the glossaries package must be loaded after the hyperref package (contrary to the general advice that hyperref should be loaded last). The -glossaries package should also be loaded after htmlhyperref should be loaded last). The glossaries +package should also be loaded after html, inputencinputenc, babelbabel and ngerman. -If you are using babel I recommend you use the glossaries package option +class="cmss-10">ngerman. If you are using translate=babelbabel I recommend you use the glossaries package option translate=babel: +

-
+
\usepackage{babel}  
\usepackage[translate=babel]{glossaries}
-

-

-

If you want to use xindy

+

+

If you want to use xindy rather than makeindex to sort the glossaries, you -need to specify this in the package options: +class="cmtt-10">makeindex to sort the glossaries, you need to +specify this in the package options: +

-
+
\usepackage[xindy]{glossaries}
-

Other package options are described in

Other package options are described in Package Options in the main glossaries -user manual. -

Next, you need to enable the creation of the various external files that are -required by the indexing application. This is done using: -

\makeglossaries
-

-

+class="cmss-10">glossaries user +manual. +

Next, you need to enable the creation of the various external files that are required +by the indexing application. This is done using: +

\makeglossaries
+

+

Don’t attempt to input any of these external files in your document.
+

+

-

Top

3

Top

3 Defining a Term or Symbol

-

You must define terms or symbols before you can use them in the document. -This is best done in the preamble. Each term is defined using: -

\newglossaryentry{<label>}{<settings>}
-

+

You must define terms or symbols before you can use them in the document. This is +best done in the preamble. Each term is defined using: +

\newglossaryentry{<label>}{<settings>}
+

where <label> is a unique label used to identify the term. The second argument, +class="cmmi-10"><label> is a unique label used to identify the term. The second argument, <settings>, is a key=value comma separated list that is used to set the required +class="cmmi-10"><settings>, is a key=value comma separated list that is used to set the required information for the term. A full list of available keys can be found in Defining -Glossary Entries in the main glossariesDefining Glossary +Entries in the main glossaries user manual. The principle keys are name -and descriptionname and +description. -

For example, to define the term “electrolyte”: +

For example, to define the term “electrolyte”: +

-
+
\newglossaryentry{electrolyte}{name=electrolyte,  
description={solution able to conduct electric current}}
-

In the above example, the label and the name happen to be the same. In the -next example, the name contains a ligature but the label doesn’t: +

In the above example, the label and the name happen to be the same. In the next +example, the name contains a ligature but the label doesn’t: +

-
+
\newglossaryentry{oesophagus}{name=\oe sophagus,  
description={canal from mouth to stomach},  
plural=\oe sophagi}
-

In this case the label is oesophagus. Note that in this case, the plural has to be +

In this case the label is oesophagus. Note that in this case, the plural has to be specified using the pluralplural key since it isn’t formed by simply appending the letter “s”. -

When you define terms, it is important to remember that they will be sorted -by an external application that doesn’t interpret LAT

If you want to define all your terms in a separate file don’t use \include to input +the file. You can use \input but it’s better to use \loadglsentries. (See Loading +Entries From a File.)
+

+

When you define terms, it is important to remember that they will be sorted by an +external application that doesn’t interpret LATEX commands. xindy is a -little more Txindy is a little more +TEX-aware than makeindex, but for this example they will both -mis-sort \oe sophagus. Xindy will ignore the \oe␣ part and will sort -it according to sophagus, so it will be placed with the terms starting -with an “s”. makeindex, on the other hand, will sort it according to +class="cmtt-10">makeindex, but for this example they will both mis-sort \oe␣sophagus which starts with a symbol (the backslash), so it will end -up in the symbol group. You therefore need to specify how to sort the +class="cmtt-10">\oe sophagus. Xindy will ignore the \oe␣ part and will sort it according to sophagus, +so it will be placed with the terms starting with an “s”. makeindex, on the other hand, +will sort it according to \oe␣sophagus which starts with a symbol (the backslash), so it +will end up in the symbol group. You therefore need to specify how to sort the term: +

-
+
\newglossaryentry{oesophagus}{name=\oe sophagus,  
description={canal from mouth to stomach},  
plural=\oe sophagi,  
sort=oesophagus}
-

Note, however, that if you use the inputenc package and xindy, you -can use the encoded character œ rather than \oe and xindy will sort it -correctly: +

Note, however, that if you use the inputenc package and xindy, you can use the +encoded character œ rather than \oe and xindy will sort it correctly: +

-
+
\newglossaryentry{oesophagus}{name=œsophagus,  
description={canal from mouth to stomach},  
plural=œsophagi}
-

-

If the name starts with an accented character, the first character must be +

+

If the name starts with an accented character, the first character must be grouped: +

-
+
\newglossaryentry{elite}{name={\’e}lite,  
description={select group of people},  
sort=elite}
-

or +

or +

-
-\newglossaryentry{elite}{name={é}lite, +
+\newglossaryentry{elite}{name={é}lite,  
description={select group of people}}
-

-

The name can also be a symbol, but you will also need to specify the sort key. -For example: +

+

The name can also be a symbol, but you will also need to specify the sort key. For +example: +

-
+
\newglossaryentry{pi}{name={\ensuremath{\pi}},  
description={ratio of circumference of circle to its  
diameter},sort=pi}
-

It’s also possible to have a name and a symbol. For example: +

It’s also possible to have a name and a symbol. For example: +

-
+
\newglossaryentry{set}{name=set,  
description={a collection of objects},  
symbol={\ensuremath{\mathcal{S}}}}
-

Note, however, that not all glossary styles display the symbol in the -glossary. -

+

Note, however, that not all glossary styles display the symbol in the glossary. +

-

Top

4

Top

4 Using a Term

-

Once you have defined a term, you can use it in the document. The glossaries

Once you have defined a term, you can use it in the document. The glossaries package provides a number of commands that are described in Links to Glossary Entries in the main glossariesglossaries user manual. Here, I shall just cover the main commands: -

\gls{<label>}
-

+

\gls{<label>}
+

This prints the term associated with <label>. Using the example in the previous +class="cmmi-10"><label>. Using the example in the previous section, \gls{oesophagus} will display œsophagus. If the hyperref package has -also been loaded, the term will also be hyperlinked to the relevant entry in the +class="cmtt-10">\gls{oesophagus} will display œsophagus. If the hyperref package has also +been loaded, the term will also be hyperlinked to the relevant entry in the glossary. -

\glspl{<label>}
-

+

\glspl{<label>}
+

This prints the plural of the term associated with <label>, so \glspl{oesophagus} -will display œsophagi. Again, the text will be a hyperlink to the relevant entry -in the glossary, if hyperlinks are defined. -

There are also versions that convert the first character to upper case if you -need to start a sentence with a term: -

\Gls{<label>}
-

+class="cmmi-10"><label>, so \glspl{oesophagus} will +display œsophagi. Again, the text will be a hyperlink to the relevant entry in the +glossary, if hyperlinks are defined. +

There are also versions that convert the first character to upper case if you need to +start a sentence with a term: +

\Gls{<label>}
+

and -

\Glspl{<label>}
-

+

\Glspl{<label>}
+

For example: +

-
+
\Glspl{electrolyte} usually exist as solutions of salts,  
bases or acids.
-

-

Note that these commands all have two optional arguments that aren’t -discussed here, but they are described in Links to Glossary Entries in the main -glossaries user manual. -

Don’t use these commands in moving arguments, such as those used by +

+

Note that these commands all have two optional arguments that aren’t discussed +here, but they are described in Links to Glossary Entries in the main glossaries user +manual. +

Don’t use these commands in moving arguments, such as those used by \chapter, \chapter, \section and \caption.
-

+class="cmtt-10">\section and \caption.

+

You can, instead, use commands such as -

\glsentrytext{<label>}
-

+

\glsentrytext{<label>}
+

See Using Glossary Terms Without Links in the main glossaries user -manual. -

+class="cmss-10">glossaries user manual. +

-

Top

5

Top

5 Acronyms

-

The glossaries package also allows you to define acronyms. By default, acronyms -will be added to the main glossary, but if you use the acronym package option, -acronyms will be placed in a separate list of acronyms: +

The glossaries package also allows you to define acronyms. By default, acronyms will be +added to the main glossary, but if you use the acronym package option, acronyms will +be placed in a separate list of acronyms: +

-
+
\usepackage[acronym]{glossaries}
-

-

Acronyms must be defined before use and are defined using: -

\newacronym{<label>}{<abbrv>}{<full>}
-

+

+

Acronyms must be defined before use and are defined using: +

\newacronym{<label>}{<abbrv>}{<full>}
+

where <label> is the label identifying the acronym, <abbrv> is the abbreviated -form and <full> is the fully expanded text. For example: +class="cmmi-10"><label> is the label identifying the acronym, <abbrv> is the abbreviated form +and <full> is the fully expanded text. For example: +

-
+
\newacronym{label}{svm}{support vector machine}
-

-

Once the acronym is defined, it can be used in the same way as any other -glossary term with commands such as \gls and \glspl. On first use, the -default will display <full> (<abbrv>). On subsequent use, only the abbreviation -will appear. For example: +

+

Once the acronym is defined, it can be used in the same way as any other glossary +term with commands such as \gls and \glspl. On first use, the default will display +<full> (<abbrv>). On subsequent use, only the abbreviation will appear. For +example: +

-
+
A \gls{svm} was implemented.
-

If this is the first time this term has been used, the above would produce: +

If this is the first time this term has been used, the above would produce: -
A support vector machine (svm) was implemented. -
+
A support vector machine (svm) was implemented. +
otherwise it would produce: -
A svm was implemented. -
-If you prefer a different way of displaying the acronyms (for example, -putting the long form in a footnote on first use) it’s possible to change the -acronym style. For further details, see A svm was implemented. +
+If you prefer a different way of displaying the acronyms (for example, putting the long +form in a footnote on first use) it’s possible to change the acronym style. For further +details, see Acronyms in the main glossaries user -manual. -

You can reset an acronym so that the next use fully expands it again -using: -

\glsreset{<label>}
-

+class="cmss-10">glossaries user manual. +

You can reset an acronym so that the next use fully expands it again using: +

\glsreset{<label>}
+

or you can reset all acronyms using -

\glsresetall
-

+

\glsresetall
+

For further details on resetting and unsetting acronyms, see Unsetting and -Resetting Entry Flags in the main glossariesUnsetting and Resetting +Entry Flags in the main glossaries user manual. -

+

-

Top

6

Top

6 Displaying the Glossary or List of Acronyms

-

In order to display the sorted list of terms, you first need to use -

\printglossaries
-

-at the place where you want the glossary and list of acronyms to appear. Note -that \printglossaries won’t produce any text the first time you create your -document, as an external indexing application needs to be used to sort and -collate the entries. Creating the completed document is therefore at least a three -step process. -

Suppose your document is called myDoc.tex, then you need to: - - +

In order to display the sorted list of terms, you first need to use +

\printglossaries
+

+at the place where you want the glossary and list of acronyms to appear. Note that +\printglossaries won’t produce any text the first time you create your document, +as an external indexing application needs to be used to sort and collate the +entries. Creating the completed document is therefore at least a three step +process. +

Suppose your document is called myDoc.tex, then you need to:

  1. Build/LATEX your document, either by clicking on an appropriate - button in your front-end/text editor or by typing the following at a - terminal/command prompt: +class="E">EX your document, either by clicking on an appropriate button in + your front-end/text editor or by typing the following at a terminal/command + prompt: +
    latex myDoc
    -

    +

  2. Run the indexing application on the external file(s) created by - the glossaries package. If you have used the xindy package option, - you must use xindy, otherwise you must use makeindex. The - glossaries package comes with a convenient Perl wrapper that calls the - appropriate indexing application the required number of times with the - required options. If you have Perl installed, all you need to do is - type + class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by the glossaries + package. If you have used the xindy package option, you must use xindy, + otherwise you must use makeindex. The glossaries package comes with a + convenient Perl wrapper that calls the appropriate indexing application the + required number of times with the required options. If you have Perl installed, all + you need to do is type +
    makeglossaries myDoc
    -

    in a terminal or command prompt. If you are using a front-end (such as - WinEdt or TeXnicCenter) and you want it to automatically run - makeglossaries when you build your document, you will need to consult - the front-end’s documentation. -

    If you don’t have Perl installed, you will need to call makeindex or - xindy explicitly. This is more complicated and is described in - Generating the Associated Glossary Files in the main glossaries user - manual. +

    in a terminal or command prompt. If you are using a front-end (such as WinEdt + or TeXnicCenter) and you want it to automatically run makeglossaries + when you build your document, you will need to consult the front-end’s + documentation. +

    If you don’t have Perl installed, you will need to call makeindex or xindy + explicitly. This is more complicated and is described in Generating the Associated + Glossary Files in the main glossaries user manual.

  3. Once you have successfully run the indexing application, you need to build/LATEX your document again (see step 1).
-

Note that sometimes you may have to repeat steps 2 and 3. -

The appearance of the glossary depends on the glossary style in use. The -default style uses the description

Note that sometimes you may have to repeat steps 2 and 3. +

The appearance of the glossary depends on the glossary style in use. The default +style uses the description environment, but there are many other styles -available. These are described in environment, but there are many other styles available. These +are described in Glossary Styles in the main glossaries user -manual. By default, a number or list of numbers will appear after each entry -in the glossary. This indicates the page (or pages) on which the term -was used. This list can be suppressed using the nonumberlist package -option: +class="cmss-10">glossaries user manual. By default, a +number or list of numbers will appear after each entry in the glossary. This indicates +the page (or pages) on which the term was used. This list can be suppressed using the +nonumberlist package option: +

-
+
\usepackage[nonumberlist]{glossaries}
-

-

Further information can be found in the main glossaries

+

Further information can be found in the main glossaries user manual and -there is also an user manual and there is +also an article on the glossaries package on the LATEX Community’s -Know How section. -

Top

+class="E">EX Community’s Know How +section.

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 1354a0ad489..6b7eeb0c8af 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 7c13c105bd2..3c1aed60ecf 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -13,7 +13,7 @@ \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2013-12-05} +\date{2014-01-20} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} @@ -35,14 +35,11 @@ such, it only covers the basics. For more advanced topics, see the \section{What Do I Need?} \label{requirements} -You need to have the \styfmt{glossaries} package installed. You also -need to have the following packages installed: \sty{datatool}, \sty{ifthen}, -\sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and -\sty{etoolbox}. -You may also need \sty{longtable}, \sty{supertabular}, -\sty{array} or \sty{multicol}, depending on what glossary style you want to use. All -these packages can be downloaded from CTAN if you don't have them -installed. See +You need to have the \styfmt{glossaries} package installed. This and +all dependent packages are contained in both the TeX~Live and MikTeX +distributions. Use your distribution's update manager to ensure you +have an up-to-date version. These packages can also be downloaded +from CTAN if you don't have them installed. See \urlfootref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}{\qt{Installing things on a (La)TeX System}} for further assistance. @@ -98,6 +95,10 @@ files that are required by the indexing application. This is done using: \cs{makeglossaries} \end{definition} +\begin{important} +\emph{Don't} attempt to input any of these external files in your document. +\end{important} + \section{Defining a Term or Symbol} \label{defterm} @@ -133,6 +134,14 @@ In this case the label is \texttt{oesophagus}. Note that in this case, the plural has to be specified using the \gloskey{plural} key since it isn't formed by simply appending the letter \qt{s}. +\begin{important} +If you want to define all your terms in a separate file \emph{don't} +use \ics{include} to input the file. You can use \ics{input} but +it's better to use \ics{loadglsentries}. (See +\xrsectionref{sec:loadglsentries}{glossaries-user}{Loading Entries +From a File}.) +\end{important} + When you define terms, it is important to remember that they will be sorted by an external application that doesn't interpret \LaTeX\ commands. \app{xindy} is a little more \TeX-aware than \app{makeindex}, but diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 53d2c08b8b3..8d06788c037 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -1,4 +1,5 @@ - + @@ -6,72 +7,71 @@ > Upgrading from the glossary package to the glossaries package - - + + - + -
+
+ + -
-
-

Upgrading from the glossary package -to the glossaries package

+

Upgrading from the glossary package to the +glossaries package

Nicola L.C. Talbot

+class="futr8t-x-x-120">Nicola L.C. Talbot

2013-12-05
-
-
2014-01-20
+
+
-

The purpose of this document is to provide advice if you want - to convert a LATEX document from using the obsolete glossary - package to the replacement glossaries package. +

+

+

Abstract

+

The purpose of this document is to provide advice if you want to convert a + LATEX document from using the obsolete glossary package to the replacement + glossaries package.

-

Contents

-
- 1 + 1 Why the Need for a New Package? -
2 2 Package Options -
3 3 Dening new glossary types -
4 4 \make -
5 \make +
5 Storing glossary information -
6 6 Adding an entry to the glossary -
 6.1  6.1 \useglosentry -
 6.2 \useglosentry +
 6.2 \useGlosentry -
 6.3 \useGlosentry +
 6.3 \gls - - -
 6.4 \gls +
 6.4 \glossary -
7 \glossary +
7 Acronyms -
 7.1  7.1 \acrln and \acrsh -
 7.2 \acrln and \acrsh +
 7.2 \ifacronymfirstuse -
 7.3 \ifacronymfirstuse +
 7.3 \resetacronym and \unsetacronym -
8 \resetacronym and \unsetacronym +
8 Displaying the glossary -
9 9 Processing Your Document -
10 10 Troubleshooting -
Index -
+

-

1

Top

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 x 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: +class="ec-lmss-10">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 x +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 dene irregular plurals;
    • -
  • glossary terms can have an associated symbol in addition to the name - and description; +
  • 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 xed names used - in headings and by some of the glossary styles; +
  • you can add dictionaries to supply translations for the xed names used in + headings and by some of the glossary styles;
  • you can choose1 between using makeindexmakeindex or xindyxindy to sort the glossary. Using xindy +class="ec-lmtt-10">xindy means + that: +
      +
    • there is much better support for terms containing accented or non-Latin + characters; + - means that: -
        -
      • there is much better support for terms containing accented or - non-Latin characters; -
        • -
      • there is support for non-standard location numbers;
      +
      • +
    • 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; +class="ec-lmtt-10">makeindex's special characters as this is done + internally;
    • -
  • hierarchical entries and homographs are +
  • hierarchical entries and homographs are supported;2 @@ -334,35 +347,37 @@ href="#fn2x0" id="fn2x0-bk">2

    Top

    2 Top

    2 Package Options

    When converting a document that currently uses the obsolete glossary package to the +class="ec-lmss-10">glossary package to the replacement glossaries package, it should be fairly obvious that the rst thing you +class="ec-lmss-10">glossaries package, it should be fairly obvious that the rst thing you need to do is replace \usepackage{glossary} with \usepackage{glossaries}, +class="ec-lmtt-10">\usepackage{glossary} with \usepackage{glossaries}, however some of the package options are dierent, so you may need to change those as well. Table 1 shows the mappings from the glossary to the glossaries package +class="ec-lmss-10">glossary to the glossaries package options.

    -
    +
    + -

    +
    Table 1: Mappings from glossary to glossaries package options
    +class="ec-lmss-10">glossary to glossaries package options

    @@ -374,11 +389,11 @@ id="TBL-2-1" />glossary option glossary option glossaries option +class="ec-lmssbx-10">glossaries option style=list nonumberlist number= counter= +class="futri8t-"> toc toc style="vertical-align:baseline;" id="TBL-2-24-">hyper no corresponding option +class="futri8t-">no corresponding option section=true section style="vertical-align:baseline;" id="TBL-2-26-">section=false no corresponding option +class="futri8t-">no corresponding option acronym acronym style="vertical-align:baseline;" id="TBL-2-28-">global no corresponding option +class="futri8t-">no corresponding option

    + -
    -
+
+

Top

3 Top

3 Dening new glossary types

-

If you have created new glossary types, you will need to replace all instances -of -

glossary - \newglossarytype

If you have created new glossary types, you will need to replace all instances of +

glossary + \newglossarytype[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<old +class="ec-lmtt-10">[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<old style style list>]
list>]
-
\newcommand{\<type>name}{<title>} -
-
+
\newcommand{\<type>name}{<title>} +
+
with -

glossaries - \newglossary

glossaries + \newglossary[<log-ext>]{<type>}{<out-ext>}{<in-ext>}{<title>} -
-
-in the preamble, and, if the new glossary requires a dierent style to the main -(default) glossary, you will also need to put -

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

-
-immediately before the glossary is displayed, or you can specify the style when you -display the glossary using \printglossary{<new style>} +
+
+immediately before the glossary is displayed, or you can specify the style when you display +the glossary using \printglossary (see below). -

The optional argument can be converted to using the -same mapping given in Table 

The optional argument can be converted to using the same +mapping given in Table 1. -

For example, if your document contains the following: +

For example, if your document contains the following: +

-
+
\newglossarytype[nlg]{notation}{not}{ntn}[style=long,header]  
\newcommand{\notationname}{Index of Notation}

You will need to replace the above two lines with: +

-
+
\newglossary[nlg]{notation}{not}{ntn}{Index of Notation}

in the preamble and +

-
+
\glossarystyle{longheader}
-

immediately prior to displaying this glossary. Alternatively, you can specify the -style using the style

immediately prior to displaying this glossary. Alternatively, you can specify the style using +the style key in the optional argument of \printglossary. For -example: +class="ec-lmtt-10">\printglossary. For example: +

-
+
\printglossary[type=notation,style=longheader]

-

Note that the glossary title is no longer specied using \name -(except for \glossaryname

Note that the glossary title is no longer specied using \name (except for +\glossaryname and \acronymname\acronymname) but is instead specied in the </span> -argument of <span -class="ec-lmtt-10x-x-109">\newglossary</span><a +class="futri8t-"><title> </span>argument of +<span +class="ec-lmtt-10">\newglossary</span><a id="dx1-4009"></a>. The short title which is speci�ed in the <span -class="ec-lmss-10x-x-109">glossary </span>package -by the command <span -class="ec-lmtt-10x-x-109">\short</span><span -class="futri8t-x-x-109"><glossary-name></span><span -class="ec-lmtt-10x-x-109">name </span>is now speci�ed using the <span -class="ec-lmss-10x-x-109">toctitle</span><a - id="dx1-4010"></a> key -in the optional argument to <span -class="ec-lmtt-10x-x-109">\printglossary</span><a +class="ec-lmss-10">glossary </span>package by the command +<span +class="ec-lmtt-10">\short</span><span +class="futri8t-"><glossary-name></span><span +class="ec-lmtt-10">name </span>is now speci�ed using the <span +class="ec-lmss-10">toctitle</span><a + id="dx1-4010"></a> key in the optional argument +to <span +class="ec-lmtt-10">\printglossary</span><a id="dx1-4011"></a>. </p><!--l. 214--><p class="noindent" > </p> <!--l. 214--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="x1-50004"></a><span -class="ec-lmtt-10x-x-109">\make</span><span -class="futri8t-x-x-109"><glossary name></span></h3> +class="ec-lmtt-10">\make</span><span +class="futri8t-"><glossary name></span></h3> <!--l. 216--><p class="noindent" >All instances of <span -class="ec-lmtt-10x-x-109">\make</span><span -class="futri8t-x-x-109"><glossary name> </span>(e.g. <span -class="ec-lmtt-10x-x-109">\makeglossary</span><a +class="ec-lmtt-10">\make</span><span +class="futri8t-"><glossary name> </span>(e.g. <span +class="ec-lmtt-10">\makeglossary</span><a id="dx1-5001"></a> and <span -class="ec-lmtt-10x-x-109">\makeacronym</span><a - id="dx1-5002"></a>) -should be replaced by the single command <span -class="ec-lmtt-10x-x-109">\makeglossaries</span><a - id="dx1-5003"></a>. For example, if your -document contained the following: +class="ec-lmtt-10">\makeacronym</span><a + id="dx1-5002"></a>) should be +replaced by the single command <span +class="ec-lmtt-10">\makeglossaries</span><a + id="dx1-5003"></a>. For example, if your document +contained the following: + </p> - <div class="verbatim" id="verbatim-5"> + <div class="verbatim" id="verbatim-5"> \makeglossary  <br />\makeacronym </div> <!--l. 223--><p class="nopar" > then you should replace both lines with the single line: + </p> - <div class="verbatim" id="verbatim-6"> + <div class="verbatim" id="verbatim-6"> \makeglossaries </div> <!--l. 227--><p class="nopar" > </p><!--l. 229--><p class="noindent" > </p> <!--l. 229--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a id="x1-60005"></a>Storing glossary information</h3> <!--l. 231--><p class="noindent" >With the old <span -class="ec-lmss-10x-x-109">glossary </span>package you could optionally store glossary information for later -use, or you could simply use <span -class="ec-lmtt-10x-x-109">\glossary</span><a +class="ec-lmss-10">glossary </span>package you could optionally store glossary information for later use, +or you could simply use <span +class="ec-lmtt-10">\glossary</span><a id="dx1-6001"></a> whenever you wanted to add information to the glossary. With the new <span -class="ec-lmss-10x-x-109">glossaries </span>package, the latter option is no longer +class="ec-lmss-10">glossaries </span>package, the latter option is no longer available.<span class="footnote-mark"><a href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a id="x1-6002f3"></a> If you have stored all the glossary information using <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a - id="dx1-6004"></a>, then you -will need to convert these commands into the equivalent <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a - id="dx1-6005"></a>. If -you have only used <span -class="ec-lmtt-10x-x-109">\glossary</span><a +class="ec-lmtt-10">\storeglosentry</span><a + id="dx1-6004"></a>, then you will need to +convert these commands into the equivalent <span +class="ec-lmtt-10">\newglossaryentry</span><a + id="dx1-6005"></a>. If you have only used +<span +class="ec-lmtt-10">\glossary</span><a id="dx1-6006"></a>, then see <a href="#x1-110006.4">�6.4 </a><a href="#x1-110006.4"><span -class="ec-lmtt-10x-x-109">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. -</p><!--l. 242--><p class="indent" > Substitute all instances of -</p><!--l. 243--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a +class="ec-lmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. +</p><!--l. 242--><p class="indent" > Substitute all instances of +</p><!--l. 243--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\storeglosentry</span><a id="dx1-6007"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><gls-entry></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><gls-entry></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with -</p><!--l. 247--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a +</p><!--l. 247--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\newglossaryentry</span><a id="dx1-6008"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><gls-entry></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> -This should be fairly easy to do using the search and replace facility in your editor -(but see notes below). -</p><!--l. 253--><p class="indent" > If you have used the optional argument of <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a - id="dx1-6009"></a> (i.e. you have -multiple glossaries) then you will need to substitute -</p><!--l. 256--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><gls-entry></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> +This should be fairly easy to do using the search and replace facility in your editor (but see +notes below). +</p><!--l. 253--><p class="indent" > If you have used the optional argument of <span +class="ec-lmtt-10">\storeglosentry</span><a + id="dx1-6009"></a> (i.e. you have multiple +glossaries) then you will need to substitute +</p><!--l. 256--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\storeglosentry</span><a id="dx1-6010"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><gls-type></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><gls-entry></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><gls-type></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><gls-entry></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with -</p><!--l. 260--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 260--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\newglossaryentry</span><a + id="dx1-6011"></a><span +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span><span class="verb"><span +class="ec-lmtt-10">{</span></span><span +class="ec-lmtti-10"><gls-entry></span><span +class="ec-lmtt-10">,type=</span><span +class="ec-lmtti-10"><gls-type></span><span class="verb"><span +class="ec-lmtt-10">}</span></span> + <br /></div><hr> + - <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a - id="dx1-6011"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span><span class="verb"><span -class="ec-lmtt-10x-x-109">{</span></span><span -class="ec-lmtti-10x-x-109"><gls-entry></span><span -class="ec-lmtt-10x-x-109">,type=</span><span -class="ec-lmtti-10x-x-109"><gls-type></span><span class="verb"><span -class="ec-lmtt-10x-x-109">}</span></span> - <br /></div><hr> - <br /></span> -</p><!--l. 264--><p class="indent" > The glossary entry information <span -class="futri8t-x-x-109"><gls-entry> </span>may also need changing. If <span -class="futri8t-x-x-109"><gls-entry></span> + <br /></span> +</p><!--l. 264--><p class="indent" > The glossary entry information <span +class="futri8t-"><gls-entry> </span>may also need changing. If <span +class="futri8t-"><gls-entry></span> contains any of <span -class="ec-lmtt-10x-x-109">makeindex</span><a +class="ec-lmtt-10">makeindex</span><a id="dx1-6012"></a>'s special characters (i.e. <span -class="ec-lmtt-10x-x-109">@!</span><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">|</span></span></span>) then they -should no longer be escaped with <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">"</span></span></span> since the <span -class="ec-lmss-10x-x-109">glossaries </span>package deals with -these characters internally. For example, if your document contains the -following: +class="ec-lmtt-10">@!</span><span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">|</span></span></span>) then they should no longer be +escaped with <span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">"</span></span></span> since the <span +class="ec-lmss-10">glossaries </span>package deals with these characters internally. For +example, if your document contains the following: + </p> - <div class="verbatim" id="verbatim-7"> + <div class="verbatim" id="verbatim-7"> \storeglosentry{card}{name={$"|\mathcal{S}"|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> <!--l. 273--><p class="nopar" > then you will need to replace it with: + </p> - <div class="verbatim" id="verbatim-8"> + <div class="verbatim" id="verbatim-8"> \newglossaryentry{card}{name={$|\mathcal{S}|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> <!--l. 278--><p class="nopar" > -</p><!--l. 280--><p class="indent" > The <span -class="ec-lmss-10x-x-109">format</span><a +</p><!--l. 280--><p class="indent" > The <span +class="ec-lmss-10">format</span><a id="dx1-6013"></a> and <span -class="ec-lmss-10x-x-109">number</span><a +class="ec-lmss-10">number</span><a id="dx1-6014"></a> keys available in <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a +class="ec-lmtt-10">\storeglosentry</span><a id="dx1-6015"></a> are not available with <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a +class="ec-lmtt-10">\newglossaryentry</span><a id="dx1-6016"></a>. </p><!--l. 284--><p class="noindent" > </p> <!--l. 284--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a id="x1-70006"></a>Adding an entry to the glossary</h3> <!--l. 286--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package provided two basic means to add information to the glossary: -�rstly, the term was de�ned using <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a - id="dx1-7001"></a> and the entries for that term -were added using <span -class="ec-lmtt-10x-x-109">\useglosentry</span><a +class="ec-lmss-10">glossary </span>package provided two basic means to add information to the glossary: �rstly, the +term was de�ned using <span +class="ec-lmtt-10">\storeglosentry</span><a + id="dx1-7001"></a> and the entries for that term were added using +<span +class="ec-lmtt-10">\useglosentry</span><a id="dx1-7002"></a>, <span -class="ec-lmtt-10x-x-109">\useGlosentry</span><a +class="ec-lmtt-10">\useGlosentry</span><a id="dx1-7003"></a> and <span -class="ec-lmtt-10x-x-109">\gls</span><a - id="dx1-7004"></a>. Secondly, the term -was added to the glossary using <span -class="ec-lmtt-10x-x-109">\glossary</span><a - id="dx1-7005"></a>. This second approach is unavailable -with the <span -class="ec-lmss-10x-x-109">glossaries </span>package. +class="ec-lmtt-10">\gls</span><a + id="dx1-7004"></a>. Secondly, the term was added to the +glossary using <span +class="ec-lmtt-10">\glossary</span><a + id="dx1-7005"></a>. This second approach is unavailable with the <span +class="ec-lmss-10">glossaries</span> +package. </p><!--l. 295--><p class="noindent" > </p> <!--l. 295--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a id="x1-80006.1"></a><span -class="ec-lmtt-10x-x-109">\useglosentry</span></h4> +class="ec-lmtt-10">\useglosentry</span></h4> <!--l. 298--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package allows you to add information to the glossary for a prede�ned -term without producing any text in the document using -</p><!--l. 301--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\useglosentry</span><a +class="ec-lmss-10">glossary </span>package allows you to add information to the glossary for a prede�ned term +without producing any text in the document using +</p><!--l. 301--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\useglosentry</span><a id="dx1-8001"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><old options></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><old options></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 305--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glsadd</span><a +</p><!--l. 305--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glsadd</span><a id="dx1-8002"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><new options></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><new options></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> The <span -class="ec-lmss-10x-x-109">format</span><a +class="ec-lmss-10">format</span><a id="dx1-8003"></a> key in <span -class="futri8t-x-x-109"><old options> </span>remains the same in <span -class="futri8t-x-x-109"><new options></span>. However -the <span -class="ec-lmss-10x-x-109">number</span><a - id="dx1-8004"></a><span -class="ec-lmtt-10x-x-109">=</span><span -class="futri8t-x-x-109"><counter name> </span>key in <span -class="futri8t-x-x-109"><old options> </span>should be replaced with +class="futri8t-"><old options> </span>remains the same in <span +class="futri8t-"><new options></span>. However the <span -class="ec-lmss-10x-x-109">counter</span><a +class="ec-lmss-10">number</span><a + id="dx1-8004"></a><span +class="ec-lmtt-10">=</span><span +class="futri8t-"><counter name> </span>key in <span +class="futri8t-"><old options> </span>should be replaced with <span +class="ec-lmss-10">counter</span><a id="dx1-8005"></a><span -class="ec-lmtt-10x-x-109">=</span><span -class="futri8t-x-x-109"><counter name> </span>in <span -class="futri8t-x-x-109"><new options></span>. +class="ec-lmtt-10">=</span><span +class="futri8t-"><counter</span> +<span +class="futri8t-">name> </span>in <span +class="futri8t-"><new options></span>. + </p><!--l. 316--><p class="noindent" > </p> <!--l. 316--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a id="x1-90006.2"></a><span -class="ec-lmtt-10x-x-109">\useGlosentry</span></h4> +class="ec-lmtt-10">\useGlosentry</span></h4> <!--l. 318--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package allows you to add information to the glossary for a prede�ned -term with the given text using -</p><!--l. 320--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\useGlosentry</span><a +class="ec-lmss-10">glossary </span>package allows you to add information to the glossary for a prede�ned term with +the given text using +</p><!--l. 320--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\useGlosentry</span><a id="dx1-9001"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><old options></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><old options></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 324--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glslink</span><a +</p><!--l. 324--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glslink</span><a id="dx1-9002"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><new options></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><new options></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> The mapping from <span -class="futri8t-x-x-109"><old options> </span>to <span -class="futri8t-x-x-109"><new options> </span>is the same as that given <a +class="futri8t-"><old options> </span>to <span +class="futri8t-"><new options> </span>is the same as that given <a href="#x1-80006.1">�6.1 </a><a href="#x1-80006.1"><span -class="ec-lmtt-10x-x-109">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. +class="ec-lmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. </p><!--l. 330--><p class="noindent" > </p> <!--l. 330--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a id="x1-100006.3"></a><span -class="ec-lmtt-10x-x-109">\gls</span></h4> +class="ec-lmtt-10">\gls</span></h4> <!--l. 332--><p class="noindent" >Both the <span -class="ec-lmss-10x-x-109">glossary </span>and the <span -class="ec-lmss-10x-x-109">glossaries </span>packages de�ne the command <span -class="ec-lmtt-10x-x-109">\gls</span><a - id="dx1-10001"></a>. In this -case, the only thing you need to change is the <span -class="ec-lmss-10x-x-109">number</span><a - id="dx1-10002"></a> key in the optional -argument to <span -class="ec-lmss-10x-x-109">counter</span><a - id="dx1-10003"></a>. Note that the new form of <span -class="ec-lmtt-10x-x-109">\gls</span><a - id="dx1-10004"></a> also takes a �nal optional -argument which can be used to insert text into the automatically generated -text. +class="ec-lmss-10">glossary </span>and the <span +class="ec-lmss-10">glossaries </span>packages de�ne the command <span +class="ec-lmtt-10">\gls</span><a + id="dx1-10001"></a>. In this case, the only +thing you need to change is the <span +class="ec-lmss-10">number</span><a + id="dx1-10002"></a> key in the optional argument to <span +class="ec-lmss-10">counter</span><a + id="dx1-10003"></a>. Note that +the new form of <span +class="ec-lmtt-10">\gls</span><a + id="dx1-10004"></a> also takes a �nal optional argument which can be used to insert text +into the automatically generated text. </p><!--l. 339--><p class="noindent" > </p> <!--l. 339--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a id="x1-110006.4"></a><span -class="ec-lmtt-10x-x-109">\glossary</span></h4> +class="ec-lmtt-10">\glossary</span></h4> <!--l. 342--><p class="noindent" >When using the <span -class="ec-lmss-10x-x-109">glossaries </span>package, you should not use <span -class="ec-lmtt-10x-x-109">\glossary</span><a +class="ec-lmss-10">glossaries </span>package, you should not use <span +class="ec-lmtt-10">\glossary</span><a id="dx1-11001"></a> directly.<span class="footnote-mark"><a href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a id="x1-11002f4"></a> If, with the old package, you have opted to explicitly use <span -class="ec-lmtt-10x-x-109">\glossary</span><a - id="dx1-11008"></a> instead of storing -the glossary information with <span -class="ec-lmtt-10x-x-109">\storeglosentry</span><a +class="ec-lmtt-10">\glossary</span><a + id="dx1-11008"></a> instead of storing the +glossary information with <span +class="ec-lmtt-10">\storeglosentry</span><a id="dx1-11009"></a>, then converting from <span -class="ec-lmss-10x-x-109">glossary </span>to +class="ec-lmss-10">glossary </span>to <span -class="ec-lmss-10x-x-109">glossaries </span>will be more time-consuming, although in the end, I hope you will see the - - +class="ec-lmss-10">glossaries </span>will be more time-consuming, although in the end, I hope you will see the bene�ts.<span class="footnote-mark"><a href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a id="x1-11010f5"></a> If you have used <span -class="ec-lmtt-10x-x-109">\glossary</span><a - id="dx1-11013"></a> with the old glossary package, you will instead need to -de�ne the relevant glossary terms using <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a - id="dx1-11014"></a> and reference the -terms using <span -class="ec-lmtt-10x-x-109">\glsadd</span><a +class="ec-lmtt-10">\glossary</span><a + id="dx1-11013"></a> with the old glossary package, you will instead need to de�ne +the relevant glossary terms using <span +class="ec-lmtt-10">\newglossaryentry</span><a + id="dx1-11014"></a> and reference the terms using +<span +class="ec-lmtt-10">\glsadd</span><a id="dx1-11015"></a>, <span -class="ec-lmtt-10x-x-109">\glslink</span><a +class="ec-lmtt-10">\glslink</span><a id="dx1-11016"></a>, <span -class="ec-lmtt-10x-x-109">\gls</span><a +class="ec-lmtt-10">\gls</span><a id="dx1-11017"></a> etc. -</p><!--l. 365--><p class="indent" > If you don't like the idea of continually scrolling back to the preamble to type all -your <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a - id="dx1-11018"></a> commands, you may prefer to create a new �le, in which -to store all these commands, and then input that �le in your document's preamble. -Most text editors and front-ends allow you to have multiple �les open, and you can -tab back and forth between them. +</p><!--l. 365--><p class="indent" > If you don't like the idea of continually scrolling back to the preamble to type all your +<span +class="ec-lmtt-10">\newglossaryentry</span><a + id="dx1-11018"></a> commands, you may prefer to create a new �le, in which to store all +these commands, and then input that �le in your document's preamble. Most text editors +and front-ends allow you to have multiple �les open, and you can tab back and forth + + + +between them. </p><!--l. 372--><p class="noindent" > </p> <!--l. 372--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a id="x1-120007"></a>Acronyms</h3> <!--l. 374--><p class="noindent" >In the <span -class="ec-lmss-10x-x-109">glossary </span>package, acronyms were treated di�erently to glossary entries. This -resulted in inconsistencies and sprawling unmaintainable code. The new <span -class="ec-lmss-10x-x-109">glossaries</span> -package treats acronyms in exactly the same way as normal glossary terms. In fact, in -the <span -class="ec-lmss-10x-x-109">glossaries </span>package, the default de�nition of: -</p><!--l. 379--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\newacronym</span><a +class="ec-lmss-10">glossary </span>package, acronyms were treated di�erently to glossary entries. This resulted in +inconsistencies and sprawling unmaintainable code. The new <span +class="ec-lmss-10">glossaries </span>package treats +acronyms in exactly the same way as normal glossary terms. In fact, in the <span +class="ec-lmss-10">glossaries </span>package, +the default de�nition of: +</p><!--l. 379--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\newacronym</span><a id="dx1-12001"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><options></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><long></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><options></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><long></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> is a shortcut for: -</p><!--l. 383--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\newglossaryentry</span><a +</p><!--l. 383--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\newglossaryentry</span><a id="dx1-12002"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{type=\acronymtype,</span> - <br /><span -class="ec-lmtt-10x-x-109">name={</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">},</span> - <br /><span -class="ec-lmtt-10x-x-109">description={</span><span -class="ec-lmtti-10x-x-109"><long></span><span -class="ec-lmtt-10x-x-109">},</span> - <br /><span -class="ec-lmtt-10x-x-109">text={</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">},</span> - <br /><span -class="ec-lmtt-10x-x-109">first={</span><span -class="ec-lmtti-10x-x-109"><long> </span><span -class="ec-lmtt-10x-x-109">(</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">)},</span> - <br /><span -class="ec-lmtt-10x-x-109">plural={</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">s},</span> - <br /><span -class="ec-lmtt-10x-x-109">firstplural={</span><span -class="ec-lmtti-10x-x-109"><long></span><span -class="ec-lmtt-10x-x-109">s (</span><span -class="ec-lmtti-10x-x-109"><abbrv></span><span -class="ec-lmtt-10x-x-109">s)},</span> - <br /><span -class="ec-lmtti-10x-x-109"><options></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> -</p><!--l. 394--><p class="indent" > This is di�erent to the <span -class="ec-lmss-10x-x-109">glossary </span>package which set the <span -class="ec-lmss-10x-x-109">name</span><a +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{type=\acronymtype,</span> + <br /><span +class="ec-lmtt-10">name={</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">},</span> + <br /><span +class="ec-lmtt-10">description={</span><span +class="ec-lmtti-10"><long></span><span +class="ec-lmtt-10">},</span> + <br /><span +class="ec-lmtt-10">text={</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">},</span> + <br /><span +class="ec-lmtt-10">first={</span><span +class="ec-lmtti-10"><long> </span><span +class="ec-lmtt-10">(</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">)},</span> + <br /><span +class="ec-lmtt-10">plural={</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">s},</span> + <br /><span +class="ec-lmtt-10">firstplural={</span><span +class="ec-lmtti-10"><long></span><span +class="ec-lmtt-10">s (</span><span +class="ec-lmtti-10"><abbrv></span><span +class="ec-lmtt-10">s)},</span> + <br /><span +class="ec-lmtti-10"><options></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 394--><p class="indent" > This is di�erent to the <span +class="ec-lmss-10">glossary </span>package which set the <span +class="ec-lmss-10">name</span><a id="dx1-12003"></a> key to <span -class="futri8t-x-x-109"><long></span> -(<span -class="futri8t-x-x-109"><abbrv></span>) and allowed you to set a description using the <span -class="ec-lmss-10x-x-109">description</span><a - id="dx1-12004"></a> key. If you still -want to do this, you can use the <span -class="ec-lmss-10x-x-109">description</span><a +class="futri8t-"><long> </span>(<span +class="futri8t-"><abbrv></span>) and +allowed you to set a description using the <span +class="ec-lmss-10">description</span><a + id="dx1-12004"></a> key. If you still want to do this, you can +use the <span +class="ec-lmss-10">description</span><a id="dx1-12005"></a> package option, and use the <span -class="ec-lmss-10x-x-109">description</span><a - id="dx1-12006"></a> -key in the optional argument of <span -class="ec-lmtt-10x-x-109">\newacronym</span><a +class="ec-lmss-10">description</span><a + id="dx1-12006"></a> key in the optional argument of +<span +class="ec-lmtt-10">\newacronym</span><a id="dx1-12007"></a>. -</p><!--l. 402--><p class="indent" > For example, if your document originally had the following: +</p><!--l. 402--><p class="indent" > For example, if your document originally had the following: + </p> - <div class="verbatim" id="verbatim-9"> + <div class="verbatim" id="verbatim-9"> \newacronym{SVM}{Support Vector Machine}{description=Statistical  <br />pattern recognition technique} </div> <!--l. 406--><p class="nopar" > Then you would need to load the <span -class="ec-lmss-10x-x-109">glossaries </span>package using the <span -class="ec-lmss-10x-x-109">description</span><a - id="dx1-12008"></a> package -option, for example: +class="ec-lmss-10">glossaries </span>package using the <span +class="ec-lmss-10">description</span><a + id="dx1-12008"></a> package option, for +example: + </p> - <div class="verbatim" id="verbatim-10"> + <div class="verbatim" id="verbatim-10"> \usepackage[description]{glossaries} </div> <!--l. 411--><p class="nopar" > and change the acronym de�nition to: + </p> - <div class="verbatim" id="verbatim-11"> + <div class="verbatim" id="verbatim-11"> \newacronym[description=Statistical pattern recognition  <br />technique]{svm}{SVM}{Support Vector Machine} </div> -<!--l. 416--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, -such as <span -class="ec-lmtt-10x-x-109">\gls</span><a +<!--l. 416--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such as +<span +class="ec-lmtt-10">\gls</span><a id="dx1-12009"></a> or <span -class="ec-lmtt-10x-x-109">\glsadd</span><a +class="ec-lmtt-10">\glsadd</span><a id="dx1-12010"></a>. -</p><!--l. 420--><p class="indent" > With the old <span -class="ec-lmss-10x-x-109">glossary </span>package, when you de�ned an acronym, it also de�ned a -command <span -class="ec-lmtt-10x-x-109">\</span><span -class="futri8t-x-x-109"><acr-name> </span>which could be used to display the acronym in the text. -So the above SVM example would create the command <span -class="ec-lmtt-10x-x-109">\SVM </span>with the old -package. In the new <span -class="ec-lmss-10x-x-109">glossaries </span>package, the acronyms are just another type of -glossary entry, so they are displayed using <span -class="ec-lmtt-10x-x-109">\gls</span><a +</p><!--l. 420--><p class="indent" > With the old <span +class="ec-lmss-10">glossary </span>package, when you de�ned an acronym, it also de�ned a command +<span +class="ec-lmtt-10">\</span><span +class="futri8t-"><acr-name> </span>which could be used to display the acronym in the text. So the above SVM +example would create the command <span +class="ec-lmtt-10">\SVM </span>with the old package. In the new <span +class="ec-lmss-10">glossaries</span> +package, the acronyms are just another type of glossary entry, so they are displayed using +<span +class="ec-lmtt-10">\gls</span><a id="dx1-12011"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="futri8t-x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span>. Therefore, in the -above example, you will also need to replace all occurrences of <span -class="ec-lmtt-10x-x-109">\SVM </span>with -<span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\gls{svm}</span></span></span>. -</p><!--l. 430--><p class="indent" > If you have used <span -class="ec-lmtt-10x-x-109">\useacronym</span><a +class="ec-lmtt-10">{</span><span +class="futri8t-"><label></span><span +class="ec-lmtt-10">}</span>. Therefore, in the above example, you will also need to replace all occurrences +of <span +class="ec-lmtt-10">\SVM </span>with <span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">\gls{svm}</span></span></span>. +</p><!--l. 430--><p class="indent" > If you have used <span +class="ec-lmtt-10">\useacronym</span><a id="dx1-12012"></a> instead of <span -class="ec-lmtt-10x-x-109">\</span><span -class="futri8t-x-x-109"><acr-name></span>, then you will need to -replace all occurrences of -</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\useacronym</span><a +class="ec-lmtt-10">\</span><span +class="futri8t-"><acr-name></span>, then you will need to replace all +occurrences of +</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\useacronym</span><a id="dx1-12013"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="ec-lmtti-10x-x-109"><insert></span><span -class="ec-lmtt-10x-x-109">]{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">[</span><span +class="ec-lmtti-10"><insert></span><span +class="ec-lmtt-10">]{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with -</p><!--l. 436--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\gls</span><a +</p><!--l. 436--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\gls</span><a id="dx1-12014"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}[</span><span -class="ec-lmtti-10x-x-109"><insert></span><span -class="ec-lmtt-10x-x-109">]</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}[</span><span +class="ec-lmtti-10"><insert></span><span +class="ec-lmtt-10">]</span> + <br /></div><hr> + <br /></span> Note that the starred versions of <span -class="ec-lmtt-10x-x-109">\useacronym</span><a +class="ec-lmtt-10">\useacronym</span><a id="dx1-12015"></a> and <span -class="ec-lmtt-10x-x-109">\</span><span -class="futri8t-x-x-109"><acr-name> </span>(which make the -�rst letter uppercase) should be replaced with <span -class="ec-lmtt-10x-x-109">\Gls</span><a +class="ec-lmtt-10">\</span><span +class="futri8t-"><acr-name> </span>(which make the �rst letter +uppercase) should be replaced with <span +class="ec-lmtt-10">\Gls</span><a id="dx1-12016"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="futri8t-x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span>. -</p><!--l. 443--><p class="indent" > Alternatively (as from v1.18 of the <span -class="ec-lmss-10x-x-109">glossaries </span>package), you can use <span -class="ec-lmtt-10x-x-109">\oldacronym</span><a - id="dx1-12017"></a> -which uses the same syntax as the old <span -class="ec-lmss-10x-x-109">glossary </span>package's <span -class="ec-lmtt-10x-x-109">\newacronym</span><a - id="dx1-12018"></a> and also -de�nes <span -class="ec-lmtt-10x-x-109">\</span><span -class="futri8t-x-x-109"><acr-name></span>. For example, if your document originally had the -following: -</p><!--l. 448--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> +class="ec-lmtt-10">{</span><span +class="futri8t-"><label></span><span +class="ec-lmtt-10">}</span>. +</p><!--l. 443--><p class="indent" > Alternatively (as from v1.18 of the <span +class="ec-lmss-10">glossaries </span>package), you can use <span +class="ec-lmtt-10">\oldacronym</span><a + id="dx1-12017"></a> which +uses the same syntax as the old <span +class="ec-lmss-10">glossary </span>package's <span +class="ec-lmtt-10">\newacronym</span><a + id="dx1-12018"></a> and also de�nes +<span +class="ec-lmtt-10">\</span><span +class="futri8t-"><acr-name></span>. For example, if your document originally had the following: +</p><!--l. 448--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + - <div class="verbatim" id="verbatim-12"> + <div class="verbatim" id="verbatim-12"> <!--l. 452--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical </p><!--l. 452--><p class="noindent" >pattern recognition technique} </p></div> <!--l. 452--><p class="nopar" > - </div><hr> + </div><hr> </p><!--l. 453--><p class="noindent" ></p></span> then you can change this to: -</p><!--l. 455--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 455--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + - <div class="verbatim" id="verbatim-13"> + <div class="verbatim" id="verbatim-13"> <!--l. 459--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical </p><!--l. 459--><p class="noindent" >pattern recognition technique} </p></div> <!--l. 459--><p class="nopar" > - </div><hr> + </div><hr> </p><!--l. 460--><p class="noindent" ></p></span> You can then continue to use <span -class="ec-lmtt-10x-x-109">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="ec-lmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> generally -ignores spaces after command names that consist of alphabetical characters. You will -therefore need to force a space after <span -class="ec-lmtt-10x-x-109">\</span><span -class="futri8t-x-x-109"><acr-name></span>, unless you also load the <span -class="ec-lmss-10x-x-109">xspace</span> -package. (See <a +ignores spaces after command names that consist of alphabetical characters. You +will therefore need to force a space after <span +class="ec-lmtt-10">\</span><span +class="futri8t-"><acr-name></span>, unless you also load the +<span +class="ec-lmss-10">xspace </span>package. (See <a href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span -class="ec-lmss-10x-x-109">glossaries </span>documentation for further details.) Note -that <span -class="ec-lmtt-10x-x-109">\oldacronym</span><a - id="dx1-12019"></a> uses its �rst argument to de�ne the acronym's label (as used by -commands like <span -class="ec-lmtt-10x-x-109">\gls</span><a +class="ec-lmss-10">glossaries </span>documentation for further details.) +Note that <span +class="ec-lmtt-10">\oldacronym</span><a + id="dx1-12019"></a> uses its �rst argument to de�ne the acronym's label (as +used by commands like <span +class="ec-lmtt-10">\gls</span><a id="dx1-12020"></a>), so in the above example, with the new <span -class="ec-lmss-10x-x-109">glossaries </span>package, -<span -class="ec-lmtt-10x-x-109">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\gls{SVM}</span></span></span> and <span -class="ec-lmtt-10x-x-109">\SVM* </span>becomes a shortcut for +class="ec-lmss-10">glossaries</span> +package, <span +class="ec-lmtt-10">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">\gls{SVM}</span></span></span> and <span +class="ec-lmtt-10">\SVM* </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\Gls{SVM}</span></span></span>. +class="ec-lmtt-10">\Gls{SVM}</span></span></span>. </p><!--l. 475--><p class="noindent" > </p> <!--l. 475--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a id="x1-130007.1"></a><span -class="ec-lmtt-10x-x-109">\acrln </span>and <span -class="ec-lmtt-10x-x-109">\acrsh</span></h4> +class="ec-lmtt-10">\acrln </span>and <span +class="ec-lmtt-10">\acrsh</span></h4> <!--l. 477--><p class="noindent" >In the <span -class="ec-lmss-10x-x-109">glossary </span>package, it is possible to produce the long and short forms of an -acronym without adding an entry to the glossary using <span -class="ec-lmtt-10x-x-109">\acrln</span><a +class="ec-lmss-10">glossary </span>package, it is possible to produce the long and short forms of an acronym +without adding an entry to the glossary using <span +class="ec-lmtt-10">\acrln</span><a id="dx1-13001"></a> and <span -class="ec-lmtt-10x-x-109">\acrsh</span><a - id="dx1-13002"></a>. With the -<span -class="ec-lmss-10x-x-109">glossaries </span>package (provided you de�ned the acronym using <span -class="ec-lmtt-10x-x-109">\newacronym</span><a - id="dx1-13003"></a> or -<span -class="ec-lmtt-10x-x-109">\oldacronym</span><a - id="dx1-13004"></a> and provided you haven't rede�ned <span -class="ec-lmtt-10x-x-109">\newacronym</span><a - id="dx1-13005"></a>) you can -replace -</p><!--l. 484--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\acrsh</span><a +class="ec-lmtt-10">\acrsh</span><a + id="dx1-13002"></a>. With the <span +class="ec-lmss-10">glossaries</span> +package (provided you de�ned the acronym using <span +class="ec-lmtt-10">\newacronym</span><a + id="dx1-13003"></a> or <span +class="ec-lmtt-10">\oldacronym</span><a + id="dx1-13004"></a> and +provided you haven't rede�ned <span +class="ec-lmtt-10">\newacronym</span><a + id="dx1-13005"></a>) you can replace +</p><!--l. 484--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\acrsh</span><a id="dx1-13006"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with -</p><!--l. 488--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\acrshort</span><a +</p><!--l. 488--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\acrshort</span><a id="dx1-13007"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> and you can replace -</p><!--l. 492--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - - - <span -class="ec-lmtt-10x-x-109">\acrln</span><a +</p><!--l. 492--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\acrln</span><a id="dx1-13008"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with -</p><!--l. 496--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\acrlong</span><a + + + +</p><!--l. 496--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\acrlong</span><a id="dx1-13009"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> The <span -class="ec-lmss-10x-x-109">glossaries </span>package also provides the related commands <span -class="ec-lmtt-10x-x-109">\acrshortpl</span><a - id="dx1-13010"></a> (plural -short form) and <span -class="ec-lmtt-10x-x-109">\acrlongpl</span><a - id="dx1-13011"></a> (plural long form) as well as upper case variations. If -you use the <span -class="ec-lmss-10x-x-109">glossaries </span>�shortcuts� package option, you can use <span -class="ec-lmtt-10x-x-109">\acs</span><a - id="dx1-13012"></a> in place of -<span -class="ec-lmtt-10x-x-109">\acrshort</span><a +class="ec-lmss-10">glossaries </span>package also provides the related commands <span +class="ec-lmtt-10">\acrshortpl</span><a + id="dx1-13010"></a> (plural short form) +and <span +class="ec-lmtt-10">\acrlongpl</span><a + id="dx1-13011"></a> (plural long form) as well as upper case variations. If you use the <span +class="ec-lmss-10">glossaries</span> +�shortcuts� package option, you can use <span +class="ec-lmtt-10">\acs</span><a + id="dx1-13012"></a> in place of <span +class="ec-lmtt-10">\acrshort</span><a id="dx1-13013"></a> and <span -class="ec-lmtt-10x-x-109">\acl</span><a - id="dx1-13014"></a> in place of <span -class="ec-lmtt-10x-x-109">\acrlong</span><a +class="ec-lmtt-10">\acl</span><a + id="dx1-13014"></a> in place of +<span +class="ec-lmtt-10">\acrlong</span><a id="dx1-13015"></a>. -</p><!--l. 506--><p class="indent" > See <a +</p><!--l. 506--><p class="indent" > See <a href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span -class="ec-lmss-10x-x-109">glossaries </span>manual for further details of how to use these +class="ec-lmss-10">glossaries </span>manual for further details of how to use these commands. </p><!--l. 512--><p class="noindent" > </p> <!--l. 512--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a id="x1-140007.2"></a><span -class="ec-lmtt-10x-x-109">\ifacronymfirstuse</span></h4> +class="ec-lmtt-10">\ifacronymfirstuse</span></h4> <!--l. 514--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package command -</p><!--l. 515--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\ifacronymfirstuse</span><a +class="ec-lmss-10">glossary </span>package command +</p><!--l. 515--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\ifacronymfirstuse</span><a id="dx1-14001"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text1></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text2></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text1></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text2></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> can be replaced by the <span -class="ec-lmss-10x-x-109">glossaries </span>command: -</p><!--l. 519--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\ifglsused</span><a +class="ec-lmss-10">glossaries </span>command: +</p><!--l. 519--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\ifglsused</span><a id="dx1-14002"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text2></span><span -class="ec-lmtt-10x-x-109">}{</span><span -class="ec-lmtti-10x-x-109"><text1></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text2></span><span +class="ec-lmtt-10">}{</span><span +class="ec-lmtti-10"><text1></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> Note that <span -class="ec-lmtt-10x-x-109">\ifglsused</span><a +class="ec-lmtt-10">\ifglsused</span><a id="dx1-14003"></a> evaluates the opposite condition to that of <span -class="ec-lmtt-10x-x-109">\ifacronymfirstuse</span><a +class="ec-lmtt-10">\ifacronymfirstuse</span><a id="dx1-14004"></a> which is why the last two arguments have been reversed. </p><!--l. 528--><p class="noindent" > </p> <!--l. 528--><p class="noindent" ><a -href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a id="x1-150007.3"></a><span -class="ec-lmtt-10x-x-109">\resetacronym </span>and <span -class="ec-lmtt-10x-x-109">\unsetacronym</span></h4> - - +class="ec-lmtt-10">\resetacronym </span>and <span +class="ec-lmtt-10">\unsetacronym</span></h4> <!--l. 530--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package allows you to reset and unset the acronym �ag which is used to +class="ec-lmss-10">glossary </span>package allows you to reset and unset the acronym �ag which is used to determine whether the acronym has been used in the document. The <span -class="ec-lmss-10x-x-109">glossaries</span> -package also provides a means to do this on either a local or a global level. To reset an -acronym, you will need to replace: -</p><!--l. 535--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\resetacronym</span><a +class="ec-lmss-10">glossaries </span>package also +provides a means to do this on either a local or a global level. To reset an acronym, you will +need to replace: +</p><!--l. 535--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\resetacronym</span><a id="dx1-15001"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with either -</p><!--l. 539--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glsreset</span><a + + + +</p><!--l. 539--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glsreset</span><a id="dx1-15002"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> or -</p><!--l. 543--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glslocalreset</span><a +</p><!--l. 543--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glslocalreset</span><a id="dx1-15003"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> -</p><!--l. 547--><p class="indent" > To unset an acronym, you will need to replace: -</p><!--l. 548--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\unsetacronym</span><a +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 547--><p class="indent" > To unset an acronym, you will need to replace: +</p><!--l. 548--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\unsetacronym</span><a id="dx1-15004"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><acr-name></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><acr-name></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> with either -</p><!--l. 552--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glsunset</span><a +</p><!--l. 552--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glsunset</span><a id="dx1-15005"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> or -</p><!--l. 556--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glslocalunset</span><a +</p><!--l. 556--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glslocalunset</span><a id="dx1-15006"></a><span -class="ec-lmtt-10x-x-109">{</span><span -class="ec-lmtti-10x-x-109"><label></span><span -class="ec-lmtt-10x-x-109">}</span> - <br /></div><hr> - <br /></span> -</p><!--l. 560--><p class="indent" > To reset all acronyms, you will need to replace: -</p><!--l. 561--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\resetallacronyms</span><a +class="ec-lmtt-10">{</span><span +class="ec-lmtti-10"><label></span><span +class="ec-lmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 560--><p class="indent" > To reset all acronyms, you will need to replace: +</p><!--l. 561--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\resetallacronyms</span><a id="dx1-15007"></a> - - - <br /></div><hr> - <br /></span> + <br /></div><hr> + <br /></span> with -</p><!--l. 565--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glsresetall</span><a +</p><!--l. 565--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glsresetall</span><a id="dx1-15008"></a><span -class="ec-lmtt-10x-x-109">[\acronymtype</span><a +class="ec-lmtt-10">[\acronymtype</span><a id="dx1-15009"></a><span -class="ec-lmtt-10x-x-109">]</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">]</span> + <br /></div><hr> + <br /></span> or -</p><!--l. 569--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glslocalresetall</span><a +</p><!--l. 569--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glslocalresetall</span><a id="dx1-15010"></a><span -class="ec-lmtt-10x-x-109">[\acronymtype</span><a +class="ec-lmtt-10">[\acronymtype</span><a id="dx1-15011"></a><span -class="ec-lmtt-10x-x-109">]</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">]</span> + + + + <br /></div><hr> + <br /></span> To unset all acronyms, you will need to replace: -</p><!--l. 573--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossary</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\unsetallacronyms</span><a +</p><!--l. 573--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\unsetallacronyms</span><a id="dx1-15012"></a> - <br /></div><hr> - <br /></span> + <br /></div><hr> + <br /></span> with -</p><!--l. 577--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glsunsetall</span><a +</p><!--l. 577--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glsunsetall</span><a id="dx1-15013"></a><span -class="ec-lmtt-10x-x-109">[\acronymtype</span><a +class="ec-lmtt-10">[\acronymtype</span><a id="dx1-15014"></a><span -class="ec-lmtt-10x-x-109">]</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">]</span> + <br /></div><hr> + <br /></span> or -</p><!--l. 581--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10x-x-109">glossaries</span></span><span class="obeylines-h"> - <span -class="ec-lmtt-10x-x-109">\glslocalunsetall</span><a +</p><!--l. 581--><p class="indent" > <hr><div><span class="marginpar"><span +class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="ec-lmtt-10">\glslocalunsetall</span><a id="dx1-15015"></a><span -class="ec-lmtt-10x-x-109">[\acronymtype</span><a +class="ec-lmtt-10">[\acronymtype</span><a id="dx1-15016"></a><span -class="ec-lmtt-10x-x-109">]</span> - <br /></div><hr> - <br /></span> +class="ec-lmtt-10">]</span> + <br /></div><hr> + <br /></span> </p><!--l. 585--><p class="noindent" > </p> <!--l. 585--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a id="x1-160008"></a>Displaying the glossary</h3> <!--l. 587--><p class="noindent" >The <span -class="ec-lmss-10x-x-109">glossary </span>package provides the command <span -class="ec-lmtt-10x-x-109">\printglossary</span><a +class="ec-lmss-10">glossary </span>package provides the command <span +class="ec-lmtt-10">\printglossary</span><a id="dx1-16001"></a> (or <span -class="ec-lmtt-10x-x-109">\print</span><span -class="futri8t-x-x-109"><type> </span>for -other glossary types) which can be used to print individual glossaries. The <span -class="ec-lmss-10x-x-109">glossaries</span> -package provides the command <span -class="ec-lmtt-10x-x-109">\printglossaries</span><a - id="dx1-16002"></a> which will print all the - - -glossaries which have been de�ned, or <span -class="ec-lmtt-10x-x-109">\printglossary</span><a +class="ec-lmtt-10">\print</span><span +class="futri8t-"><type> </span>for other +glossary types) which can be used to print individual glossaries. The <span +class="ec-lmss-10">glossaries </span>package +provides the command <span +class="ec-lmtt-10">\printglossaries</span><a + id="dx1-16002"></a> which will print all the glossaries which have +been de�ned, or <span +class="ec-lmtt-10">\printglossary</span><a id="dx1-16003"></a><span -class="ec-lmtt-10x-x-109">[</span><span -class="futri8t-x-x-109"><options></span><span -class="ec-lmtt-10x-x-109">] </span>to print -individual glossaries. So if you just have <span -class="ec-lmtt-10x-x-109">\printglossary</span><a - id="dx1-16004"></a>, then you can leave it as it -is, but if you have, say: +class="ec-lmtt-10">[</span><span +class="futri8t-"><options></span><span +class="ec-lmtt-10">] </span>to print individual glossaries. So +if you just have <span +class="ec-lmtt-10">\printglossary</span><a + id="dx1-16004"></a>, then you can leave it as it is, but if you have, +say: + </p> - <div class="verbatim" id="verbatim-14"> + <div class="verbatim" id="verbatim-14"> \printglossary  <br />\printglossary[acronym] </div> <!--l. 598--><p class="nopar" > or + </p> - <div class="verbatim" id="verbatim-15"> + <div class="verbatim" id="verbatim-15"> \printglossary  <br />\printacronym </div> <!--l. 603--><p class="nopar" > then you will need to replace this with either + </p> - <div class="verbatim" id="verbatim-16"> + <div class="verbatim" id="verbatim-16"> \printglossaries </div> <!--l. 607--><p class="nopar" > or + </p> - <div class="verbatim" id="verbatim-17"> + <div class="verbatim" id="verbatim-17"> \printglossary  <br />\printglossary[type=\acronymtype] </div> <!--l. 612--><p class="nopar" > -</p><!--l. 614--><p class="indent" > The <span -class="ec-lmss-10x-x-109">glossary </span>package allows you to specify a short title (for the table of contents -and page header) by de�ning a command of the form <span -class="ec-lmtt-10x-x-109">\short</span><span -class="futri8t-x-x-109"><glossary-type></span><span -class="ec-lmtt-10x-x-109">name</span>. -The <span -class="ec-lmss-10x-x-109">glossaries </span>package doesn't do this, but instead provides the <span -class="ec-lmss-10x-x-109">toctitle</span><a - id="dx1-16005"></a> key which can -be used in the optional argument to <span -class="ec-lmtt-10x-x-109">\printglossary</span><a - id="dx1-16006"></a>. For example, if you have -created a new glossary type called <span -class="ec-lmtt-10x-x-109">notation</span>, and you had de�ned +</p><!--l. 614--><p class="indent" > The <span +class="ec-lmss-10">glossary </span>package allows you to specify a short title (for the table of contents and page +header) by de�ning a command of the form <span +class="ec-lmtt-10">\short</span><span +class="futri8t-"><glossary-type></span><span +class="ec-lmtt-10">name</span>. The <span +class="ec-lmss-10">glossaries</span> +package doesn't do this, but instead provides the <span +class="ec-lmss-10">toctitle</span><a + id="dx1-16005"></a> key which can be used in the +optional argument to <span +class="ec-lmtt-10">\printglossary</span><a + id="dx1-16006"></a>. For example, if you have created a new glossary type +called <span +class="ec-lmtt-10">notation</span>, and you had de�ned + </p> - <div class="verbatim" id="verbatim-18"> + <div class="verbatim" id="verbatim-18"> \newcommand{\shortnotationname}{Notation} </div> <!--l. 624--><p class="nopar" > then you would need to use the <span -class="ec-lmss-10x-x-109">toctitle</span><a +class="ec-lmss-10">toctitle</span><a id="dx1-16007"></a> key: + </p> - <div class="verbatim" id="verbatim-19"> + <div class="verbatim" id="verbatim-19"> \printglossary[type=notation,toctitle=Notation] </div> <!--l. 628--><p class="nopar" > The <span -class="ec-lmss-10x-x-109">glossaries </span>package will ignore <span -class="ec-lmtt-10x-x-109">\shortnotationname</span><a +class="ec-lmss-10">glossaries </span>package will ignore <span +class="ec-lmtt-10">\shortnotationname</span><a id="dx1-16008"></a>, so unless you have used it elsewhere in the document, you may as well remove the de�nition. </p><!--l. 633--><p class="noindent" > </p> <!--l. 633--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a id="x1-170009"></a>Processing Your Document</h3> <!--l. 635--><p class="noindent" >If you convert your document from using the <span -class="ec-lmss-10x-x-109">glossary </span>package to the <span -class="ec-lmss-10x-x-109">glossaries</span> -package, you will need to delete any of the additional �les, such as the <span -class="ec-lmtt-10x-x-109">.glo</span><a - id="dx1-17001"></a> �le, that -were created by the <span -class="ec-lmss-10x-x-109">glossary </span>package, as the <span -class="ec-lmss-10x-x-109">glossaries </span>package uses a di�erent -format. Remember also, that if you used the <span -class="ec-lmtt-10x-x-109">makeglos</span><a - id="dx1-17002"></a> Perl script, you will need to -use the <span -class="ec-lmtt-10x-x-109">makeglossaries</span><a - id="dx1-17003"></a> Perl script instead. As from v1.17, the <span -class="ec-lmss-10x-x-109">glossaries </span>package -can be used with either <span -class="ec-lmtt-10x-x-109">makeindex</span><a +class="ec-lmss-10">glossary </span>package to the <span +class="ec-lmss-10">glossaries </span>package, you +will need to delete any of the additional �les, such as the <span +class="ec-lmtt-10">.glo</span><a + id="dx1-17001"></a> �le, that were created by the +<span +class="ec-lmss-10">glossary </span>package, as the <span +class="ec-lmss-10">glossaries </span>package uses a di�erent format. Remember also, that if you +used the <span +class="ec-lmtt-10">makeglos</span><a + id="dx1-17002"></a> Perl script, you will need to use the <span +class="ec-lmtt-10">makeglossaries</span><a + id="dx1-17003"></a> Perl script instead. +As from v1.17, the <span +class="ec-lmss-10">glossaries </span>package can be used with either <span +class="ec-lmtt-10">makeindex</span><a id="dx1-17004"></a> or <span -class="ec-lmtt-10x-x-109">xindy</span><a - id="dx1-17005"></a>. Since <span -class="ec-lmtt-10x-x-109">xindy</span><a - id="dx1-17006"></a> was designed to be -multilingual, the new <span -class="ec-lmss-10x-x-109">glossaries </span>package is a much better option for non-English -documents. -</p><!--l. 648--><p class="indent" > For further information on using <span -class="ec-lmtt-10x-x-109">makeglossaries</span><a +class="ec-lmtt-10">xindy</span><a + id="dx1-17005"></a>. Since +<span +class="ec-lmtt-10">xindy</span><a + id="dx1-17006"></a> was designed to be multilingual, the new <span +class="ec-lmss-10">glossaries </span>package is a much better option +for non-English documents. +</p><!--l. 648--><p class="indent" > For further information on using <span +class="ec-lmtt-10">makeglossaries</span><a id="dx1-17007"></a>, <span -class="ec-lmtt-10x-x-109">makeindex</span><a +class="ec-lmtt-10">makeindex</span><a id="dx1-17008"></a> or <span -class="ec-lmtt-10x-x-109">xindy</span><a - id="dx1-17009"></a> to create -your glossaries, see <a +class="ec-lmtt-10">xindy</span><a + id="dx1-17009"></a> to +create your glossaries, see <a href="glossaries-user.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span -class="ec-lmss-10x-x-109">glossaries</span> +class="ec-lmss-10">glossaries</span> documentation. </p><!--l. 654--><p class="noindent" > </p> <!--l. 654--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a id="x1-1800010"></a>Troubleshooting</h3> <!--l. 656--><p class="noindent" >Please check the <a href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >FAQ</a> for the <span -class="ec-lmss-10x-x-109">glossaries </span>package if you have any problems. +class="ec-lmss-10">glossaries </span>package if you have any problems. + -</p><!--l. 660--><p class="indent" > <a +</p><!--l. 660--><p class="indent" > <a id="likesection.1"></a><a id="Q1-1-20"></a> </p> -<!--l. 2--><p class="noindent" ><a -href="#top">Top</a></p><h3 class="likesectionHead"><a + <h3 class="likesectionHead"><a id="x1-1900010"></a>Index</h3> <!--l. 4--><p class="noindent" > <span -class="futb8t-x-x-109">A</span> +class="futb8t-">A</span> </p> - <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acl</span></span></span>  <a + <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="ec-lmtt-10">\acl</span></span></span>  <a href="glossary2glossaries.html#dx1-13014" ><span class="underline">1</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrln</span></span></span>  <a +class="ec-lmtt-10">\acrln</span></span></span>  <a href="glossary2glossaries.html#dx1-13001" ><span class="underline">2</span></a>, <a href="glossary2glossaries.html#dx1-13008" ><span class="underline">3</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrlong</span></span></span>  <a +class="ec-lmtt-10">\acrlong</span></span></span>  <a href="glossary2glossaries.html#dx1-13009" ><span class="underline">4</span></a>, <a href="glossary2glossaries.html#dx1-13015" ><span class="underline">5</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrlongpl</span></span></span>  <a +class="ec-lmtt-10">\acrlongpl</span></span></span>  <a href="glossary2glossaries.html#dx1-13011" ><span class="underline">6</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acronymname</span></span></span>  <a +class="ec-lmtt-10">\acronymname</span></span></span>  <a href="glossary2glossaries.html#dx1-4008" ><span class="underline">7</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acronymtype</span></span></span>  <a +class="ec-lmtt-10">\acronymtype</span></span></span>  <a href="glossary2glossaries.html#dx1-15009" ><span class="underline">8</span></a>, <a href="glossary2glossaries.html#dx1-15011" ><span class="underline">9</span></a>, <a href="glossary2glossaries.html#dx1-15014" ><span class="underline">10</span></a>, <a href="glossary2glossaries.html#dx1-15016" ><span class="underline">11</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrsh</span></span></span>  <a +class="ec-lmtt-10">\acrsh</span></span></span>  <a href="glossary2glossaries.html#dx1-13002" ><span class="underline">12</span></a>, <a href="glossary2glossaries.html#dx1-13006" ><span class="underline">13</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrshort</span></span></span>  <a +class="ec-lmtt-10">\acrshort</span></span></span>  <a href="glossary2glossaries.html#dx1-13007" ><span class="underline">14</span></a>, <a href="glossary2glossaries.html#dx1-13013" ><span class="underline">15</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acrshortpl</span></span></span>  <a +class="ec-lmtt-10">\acrshortpl</span></span></span>  <a href="glossary2glossaries.html#dx1-13010" ><span class="underline">16</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\acs</span></span></span>  <a +class="ec-lmtt-10">\acs</span></span></span>  <a href="glossary2glossaries.html#dx1-13012" ><span class="underline">17</span></a> <br /></span> -<p class="theindex"> <span -class="futb8t-x-x-109">F</span> +<p class="theindex"> <span +class="futb8t-">F</span> <span class="index-item">�le types<br /></span> <span class="index-subitem">    <span -class="ec-lmtt-10x-x-109">.glo</span>  <a +class="ec-lmtt-10">.glo</span>  <a href="glossary2glossaries.html#dx1-17001" >18</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">G</span> +class="futb8t-">G</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glossary</span></span></span>  <a +class="ec-lmtt-10">\glossary</span></span></span>  <a href="glossary2glossaries.html#dx1-6001" ><span class="underline">19</span></a>, <a href="glossary2glossaries.html#dx1-6006" ><span class="underline">20</span></a>, <a href="glossary2glossaries.html#dx1-7005" ><span class="underline">21</span></a>, <a @@ -1715,16 +1747,16 @@ href="glossary2glossaries.html#dx1-6003" ><span class="underline">25</span></a>, href="glossary2glossaries.html#dx1-11003" ><span class="underline">26</span></a>, <a href="glossary2glossaries.html#dx1-11011" ><span class="underline">27</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glossaryname</span></span></span>  <a +class="ec-lmtt-10">\glossaryname</span></span></span>  <a href="glossary2glossaries.html#dx1-4007" ><span class="underline">28</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glossarystyle</span></span></span>  <a +class="ec-lmtt-10">\glossarystyle</span></span></span>  <a href="glossary2glossaries.html#dx1-4003" ><span class="underline">29</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\Gls</span></span></span>  <a +class="ec-lmtt-10">\Gls</span></span></span>  <a href="glossary2glossaries.html#dx1-12016" ><span class="underline">30</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\gls</span></span></span>  <a +class="ec-lmtt-10">\gls</span></span></span>  <a href="glossary2glossaries.html#dx1-7004" ><span class="underline">31</span></a>, <a href="glossary2glossaries.html#dx1-10001" ><span class="underline">32</span></a>, <a href="glossary2glossaries.html#dx1-10004" ><span class="underline">33</span></a>, <a @@ -1734,83 +1766,84 @@ href="glossary2glossaries.html#dx1-12011" ><span class="underline">36</span></a> href="glossary2glossaries.html#dx1-12014" ><span class="underline">37</span></a>, <a href="glossary2glossaries.html#dx1-12020" ><span class="underline">38</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\gls </span>options<br /></span> +class="ec-lmtt-10">\gls </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">counter</span>  <a +class="ec-lmss-10">counter</span>  <a href="glossary2glossaries.html#dx1-10003" >39</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">number</span>  <a +class="ec-lmss-10">number</span>  <a href="glossary2glossaries.html#dx1-10002" >40</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glsadd</span></span></span>  <a +class="ec-lmtt-10">\glsadd</span></span></span>  <a href="glossary2glossaries.html#dx1-8002" ><span class="underline">41</span></a>, <a href="glossary2glossaries.html#dx1-11015" ><span class="underline">42</span></a>, <a href="glossary2glossaries.html#dx1-12010" ><span class="underline">43</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\glsadd </span>options<br /></span> +class="ec-lmtt-10">\glsadd </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">counter</span>  <a +class="ec-lmss-10">counter</span>  <a href="glossary2glossaries.html#dx1-8005" >44</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glslink</span></span></span>  <a +class="ec-lmtt-10">\glslink</span></span></span>  <a href="glossary2glossaries.html#dx1-9002" ><span class="underline">45</span></a>, <a href="glossary2glossaries.html#dx1-11016" ><span class="underline">46</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glslocalreset</span></span></span>  <a +class="ec-lmtt-10">\glslocalreset</span></span></span>  <a href="glossary2glossaries.html#dx1-15003" ><span class="underline">47</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glslocalresetall</span></span></span>  <a +class="ec-lmtt-10">\glslocalresetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15010" ><span class="underline">48</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glslocalunset</span></span></span>  <a +class="ec-lmtt-10">\glslocalunset</span></span></span>  <a href="glossary2glossaries.html#dx1-15006" ><span class="underline">49</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glslocalunsetall</span></span></span>  <a +class="ec-lmtt-10">\glslocalunsetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15015" ><span class="underline">50</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glsreset</span></span></span>  <a +class="ec-lmtt-10">\glsreset</span></span></span>  <a href="glossary2glossaries.html#dx1-15002" ><span class="underline">51</span></a> <br /></span> - - <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glsresetall</span></span></span>  <a +class="ec-lmtt-10">\glsresetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15008" ><span class="underline">52</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glsunset</span></span></span>  <a +class="ec-lmtt-10">\glsunset</span></span></span>  <a href="glossary2glossaries.html#dx1-15005" ><span class="underline">53</span></a> <br /></span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\glsunsetall</span></span></span>  <a +class="ec-lmtt-10">\glsunsetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15013" ><span class="underline">54</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">I</span> +class="futb8t-">I</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\ifacronymfirstuse</span></span></span>  <a +class="ec-lmtt-10">\ifacronymfirstuse</span></span></span>  <a href="glossary2glossaries.html#dx1-14001" ><span class="underline">55</span></a>, <a href="glossary2glossaries.html#dx1-14004" ><span class="underline">56</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\ifglsused</span></span></span>  <a +class="ec-lmtt-10">\ifglsused</span></span></span>  <a href="glossary2glossaries.html#dx1-14002" ><span class="underline">57</span></a>, <a href="glossary2glossaries.html#dx1-14003" ><span class="underline">58</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">M</span> +class="futb8t-">M</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\makeacronym</span></span></span>  <a +class="ec-lmtt-10">\makeacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-5002" ><span class="underline">59</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">makeglos</span>  <a +class="ec-lmtt-10">makeglos</span>  <a href="glossary2glossaries.html#dx1-17002" >60</a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">makeglossaries</span>  <a +class="ec-lmtt-10">makeglossaries</span>  <a href="glossary2glossaries.html#dx1-17003" >61</a>, <a href="glossary2glossaries.html#dx1-17007" >62</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\makeglossaries</span></span></span>  <a +class="ec-lmtt-10">\makeglossaries</span></span></span>  <a href="glossary2glossaries.html#dx1-5003" ><span class="underline">63</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\makeglossary</span></span></span>  <a +class="ec-lmtt-10">\makeglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-5001" ><span class="underline">64</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">makeindex</span>  <a +class="ec-lmtt-10">makeindex</span>  <a href="glossary2glossaries.html#dx1-2003" >65</a>, <a href="glossary2glossaries.html#dx1-2006" >66</a>, <a href="glossary2glossaries.html#dx1-6012" >67</a>, <a @@ -1821,20 +1854,20 @@ href="glossary2glossaries.html#dx1-11004" >71</a>, <a href="glossary2glossaries.html#dx1-11006" >72</a>, <a href="glossary2glossaries.html#dx1-11012" >73</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">N</span> +class="futb8t-">N</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\newacronym</span></span></span>  <a +class="ec-lmtt-10">\newacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12001" ><span class="underline">74</span></a>, <a href="glossary2glossaries.html#dx1-12007" ><span class="underline">75</span></a>, <a href="glossary2glossaries.html#dx1-12018" ><span class="underline">76</span></a>, <a href="glossary2glossaries.html#dx1-13003" ><span class="underline">77</span></a>, <a href="glossary2glossaries.html#dx1-13005" ><span class="underline">78</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\newglossary</span></span></span>  <a +class="ec-lmtt-10">\newglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-4002" ><span class="underline">79</span></a>, <a href="glossary2glossaries.html#dx1-4009" ><span class="underline">80</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\newglossaryentry</span></span></span>  <a +class="ec-lmtt-10">\newglossaryentry</span></span></span>  <a href="glossary2glossaries.html#dx1-6005" ><span class="underline">81</span></a>, <a href="glossary2glossaries.html#dx1-6008" ><span class="underline">82</span></a>, <a href="glossary2glossaries.html#dx1-6011" ><span class="underline">83</span></a>, <a @@ -1843,36 +1876,36 @@ href="glossary2glossaries.html#dx1-11014" ><span class="underline">85</span></a> href="glossary2glossaries.html#dx1-11018" ><span class="underline">86</span></a>, <a href="glossary2glossaries.html#dx1-12002" ><span class="underline">87</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\newglossaryentry </span>options<br /></span> +class="ec-lmtt-10">\newglossaryentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">description</span>  <a +class="ec-lmss-10">description</span>  <a href="glossary2glossaries.html#dx1-12004" >88</a>, <a href="glossary2glossaries.html#dx1-12006" >89</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">name</span>  <a +class="ec-lmss-10">name</span>  <a href="glossary2glossaries.html#dx1-12003" >90</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\newglossarytype</span></span></span>  <a +class="ec-lmtt-10">\newglossarytype</span></span></span>  <a href="glossary2glossaries.html#dx1-4001" ><span class="underline">91</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">O</span> +class="futb8t-">O</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\oldacronym</span></span></span>  <a +class="ec-lmtt-10">\oldacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12017" ><span class="underline">92</span></a>, <a href="glossary2glossaries.html#dx1-12019" ><span class="underline">93</span></a>, <a href="glossary2glossaries.html#dx1-13004" ><span class="underline">94</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">P</span> +class="futb8t-">P</span> <span class="index-item">package options:<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">description</span>  <a +class="ec-lmss-10">description</span>  <a href="glossary2glossaries.html#dx1-12005" ><span class="underline">95</span></a>, <a href="glossary2glossaries.html#dx1-12008" ><span class="underline">96</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\printglossaries</span></span></span>  <a +class="ec-lmtt-10">\printglossaries</span></span></span>  <a href="glossary2glossaries.html#dx1-16002" ><span class="underline">97</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\printglossary</span></span></span>  <a +class="ec-lmtt-10">\printglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-4004" ><span class="underline">98</span></a>, <a href="glossary2glossaries.html#dx1-4006" ><span class="underline">99</span></a>, <a href="glossary2glossaries.html#dx1-4011" ><span class="underline">100</span></a>, <a @@ -1881,32 +1914,33 @@ href="glossary2glossaries.html#dx1-16003" ><span class="underline">102</span></a href="glossary2glossaries.html#dx1-16004" ><span class="underline">103</span></a>, <a href="glossary2glossaries.html#dx1-16006" ><span class="underline">104</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\printglossary </span>options<br /></span> +class="ec-lmtt-10">\printglossary </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">style</span>  <a +class="ec-lmss-10">style</span>  <a href="glossary2glossaries.html#dx1-4005" >105</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">toctitle</span>  <a +class="ec-lmss-10">toctitle</span>  <a href="glossary2glossaries.html#dx1-4010" >106</a>, <a href="glossary2glossaries.html#dx1-16005" >107</a>, <a href="glossary2glossaries.html#dx1-16007" >108</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">R</span> +class="futb8t-">R</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\resetacronym</span></span></span>  <a +class="ec-lmtt-10">\resetacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-15001" ><span class="underline">109</span></a> <br /></span> - - <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\resetallacronyms</span></span></span>  <a +class="ec-lmtt-10">\resetallacronyms</span></span></span>  <a href="glossary2glossaries.html#dx1-15007" ><span class="underline">110</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">S</span> +class="futb8t-">S</span> + + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\shortnotationname</span></span></span>  <a +class="ec-lmtt-10">\shortnotationname</span></span></span>  <a href="glossary2glossaries.html#dx1-16008" ><span class="underline">111</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\storeglosentry</span></span></span>  <a +class="ec-lmtt-10">\storeglosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-6004" ><span class="underline">112</span></a>, <a href="glossary2glossaries.html#dx1-6007" ><span class="underline">113</span></a>, <a href="glossary2glossaries.html#dx1-6009" ><span class="underline">114</span></a>, <a @@ -1915,46 +1949,46 @@ href="glossary2glossaries.html#dx1-6015" ><span class="underline">116</span></a> href="glossary2glossaries.html#dx1-7001" ><span class="underline">117</span></a>, <a href="glossary2glossaries.html#dx1-11009" ><span class="underline">118</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\storeglosentry </span>options<br /></span> +class="ec-lmtt-10">\storeglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">format</span>  <a +class="ec-lmss-10">format</span>  <a href="glossary2glossaries.html#dx1-6013" >119</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">number</span>  <a +class="ec-lmss-10">number</span>  <a href="glossary2glossaries.html#dx1-6014" >120</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-x-x-109">U</span> +class="futb8t-">U</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\unsetacronym</span></span></span>  <a +class="ec-lmtt-10">\unsetacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-15004" ><span class="underline">121</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\unsetallacronyms</span></span></span>  <a +class="ec-lmtt-10">\unsetallacronyms</span></span></span>  <a href="glossary2glossaries.html#dx1-15012" ><span class="underline">122</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\useacronym</span></span></span>  <a +class="ec-lmtt-10">\useacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12012" ><span class="underline">123</span></a>, <a href="glossary2glossaries.html#dx1-12013" ><span class="underline">124</span></a>, <a href="glossary2glossaries.html#dx1-12015" ><span class="underline">125</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\useGlosentry</span></span></span>  <a +class="ec-lmtt-10">\useGlosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-7003" ><span class="underline">126</span></a>, <a href="glossary2glossaries.html#dx1-9001" ><span class="underline">127</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10x-x-109">\useglosentry</span></span></span>  <a +class="ec-lmtt-10">\useglosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-7002" ><span class="underline">128</span></a>, <a href="glossary2glossaries.html#dx1-8001" ><span class="underline">129</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">\useglosentry </span>options<br /></span> +class="ec-lmtt-10">\useglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">format</span>  <a +class="ec-lmss-10">format</span>  <a href="glossary2glossaries.html#dx1-8003" >130</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10x-x-109">number</span>  <a +class="ec-lmss-10">number</span>  <a href="glossary2glossaries.html#dx1-8004" >131</a> <br /></span> -</p><p class="theindex"> <span -class="futb8t-x-x-109">X</span> +</p><p class="theindex"> <span +class="futb8t-">X</span> <span class="index-item"><span -class="ec-lmtt-10x-x-109">xindy</span>  <a +class="ec-lmtt-10">xindy</span>  <a href="glossary2glossaries.html#dx1-2004" >132</a>, <a href="glossary2glossaries.html#dx1-2005" >133</a>, <a href="glossary2glossaries.html#dx1-17005" >134</a>, <a @@ -1963,67 +1997,64 @@ href="glossary2glossaries.html#dx1-17009" >136</a>, <a href="glossary2glossaries.html#dx1-11005" >137</a>, <a href="glossary2glossaries.html#dx1-11007" >138</a> <br /></span> </p></div> - <div class="footnotes"><!--l. 84--><p class="noindent" ><span class="footnote-mark"><a -href="#fn1x0-bk" id="fn1x0"> -<sup class="textsuperscript">1</sup></a></span><span -class="futr8t-x-x-90">as from v1.17. Previous versions were designed to be used with </span><span -class="ec-lmtt-9">makeindex</span><a + <div class="footnotes"><!--l. 84--><p class="noindent" ><span class="footnote-mark"><a +href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span +class="futr8t-x-x-80">as from v1.17. Previous versions were designed to be used with </span><span +class="ec-lmtt-8">makeindex</span><a id="dx1-2002"></a> <span -class="futr8t-x-x-90">only</span></p><!--l. 99--><p class="noindent" ><span class="footnote-mark"><a -href="#fn2x0-bk" id="fn2x0"> -<sup class="textsuperscript">2</sup></a></span><span -class="futr8t-x-x-90">as from v1.17</span></p><!--l. 236--><p class="indent" > <span class="footnote-mark"><a -href="#fn3x0-bk" id="fn3x0"> -<sup class="textsuperscript">3</sup></a></span><span -class="futr8t-x-x-90">mainly because having a key value list in </span><span -class="ec-lmtt-9">\glossary</span><a +class="futr8t-x-x-80">only</span></p> +<!--l. 99--><p class="noindent" ><span class="footnote-mark"><a +href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span +class="futr8t-x-x-80">as from v1.17</span></p><!--l. 236--><p class="indent" > <span class="footnote-mark"><a +href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span +class="futr8t-x-x-80">mainly because having a key value list in </span><span +class="ec-lmtt-8">\glossary</span><a id="dx1-6003"></a> <span -class="futr8t-x-x-90">caused problems, but it also helps</span> - <span -class="futr8t-x-x-90">consistency.</span></p><!--l. 350--><p class="indent" > <span class="footnote-mark"><a -href="#fn4x0-bk" id="fn4x0"> -<sup class="textsuperscript">4</sup></a></span><span -class="futr8t-x-x-90">This is because </span><span -class="ec-lmtt-9">\glossary</span><a +class="futr8t-x-x-80">caused problems, but it also helps consistency.</span></p> +<!--l. 350--><p class="indent" > <span class="footnote-mark"><a +href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span +class="futr8t-x-x-80">This is because </span><span +class="ec-lmtt-8">\glossary</span><a id="dx1-11003"></a> <span -class="futr8t-x-x-90">requires the argument to be in a speci�c format and doesn't use the</span> - <span -class="futri8t-x-x-90"><key></span><span -class="futr8t-x-x-90">=</span><span -class="futri8t-x-x-90"><value> </span><span -class="futr8t-x-x-90">format that the old glossary package used. The new package's internal commands set</span> - <span -class="futr8t-x-x-90">this format, as well as escaping any of </span><span -class="ec-lmtt-9">makeindex</span><a +class="futr8t-x-x-80">requires the argument to be in a speci�c format and doesn't use</span> +<span +class="futr8t-x-x-80">the </span><span +class="futri8t-x-x-80"><key></span><span +class="futr8t-x-x-80">=</span><span +class="futri8t-x-x-80"><value> </span><span +class="futr8t-x-x-80">format that the old glossary package used. The new package's internal commands</span> +<span +class="futr8t-x-x-80">set this format, as well as escaping any of </span><span +class="ec-lmtt-8">makeindex</span><a id="dx1-11004"></a><span -class="futr8t-x-x-90">'s or </span><span -class="ec-lmtt-9">xindy</span><a +class="futr8t-x-x-80">'s or </span><span +class="ec-lmtt-8">xindy</span><a id="dx1-11005"></a><span -class="futr8t-x-x-90">'s special characters. What's more, the</span> - <span -class="futr8t-x-x-90">format has changed as from v1.17 to allow the new package to be used with either </span><span -class="ec-lmtt-9">makeindex</span><a +class="futr8t-x-x-80">'s special characters. What's more,</span> +<span +class="futr8t-x-x-80">the format has changed as from v1.17 to allow the new package to be used with either </span><span +class="ec-lmtt-8">makeindex</span><a id="dx1-11006"></a> <span -class="futr8t-x-x-90">or</span> - <span -class="ec-lmtt-9">xindy</span><a +class="futr8t-x-x-80">or</span> +<span +class="ec-lmtt-8">xindy</span><a id="dx1-11007"></a><span -class="futr8t-x-x-90">.</span></p><!--l. 359--><p class="indent" > <span class="footnote-mark"><a -href="#fn5x0-bk" id="fn5x0"> -<sup class="textsuperscript">5</sup></a></span><span -class="futr8t-x-x-90">From the user's point of view, using </span><span -class="ec-lmtt-9">\glossary</span><a +class="futr8t-x-x-80">.</span></p> +<!--l. 359--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span +class="futr8t-x-x-80">From the user's point of view, using </span><span +class="ec-lmtt-8">\glossary</span><a id="dx1-11011"></a> <span -class="futr8t-x-x-90">throughout the document is time consuming, and</span> - <span -class="futr8t-x-x-90">if you use it more than once for the same term, there's a chance extra spaces may creep in which will</span> - <span -class="futr8t-x-x-90">cause </span><span -class="ec-lmtt-9">makeindex</span><a +class="futr8t-x-x-80">throughout the document is time consuming, and if</span> +<span +class="futr8t-x-x-80">you use it more than once for the same term, there's a chance extra spaces may creep in which will</span> +<span +class="futr8t-x-x-80">cause </span><span +class="ec-lmtt-8">makeindex</span><a id="dx1-11012"></a> <span -class="futr8t-x-x-90">to treat the two entries as di�erent terms, even though they look the same in the</span> - <span -class="futr8t-x-x-90">document.</span></p> </div> +class="futr8t-x-x-80">to treat the two entries as di�erent terms, even though they look the same in the</span> +<span +class="futr8t-x-x-80">document.</span></p> </div> </body></html> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 2094026b3f9..379a251cc37 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 4e56c70fa02..e10e28d3006 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -31,7 +31,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2013-12-05} +\date{2014-01-20} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html index df0f837d87a..3082292be54 100644 --- a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html @@ -1,4 +1,5 @@ -<?xml version="1.0" encoding="utf-8" ?> +<a + id="top"></a><?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> @@ -6,263 +7,444 @@ > <head><title>mfirstuc.sty v1.08: uppercasing first letter - - + + - + + + -

+
+ + -
-
-

mfirstuc.sty v1.08: uppercasing -first letter

-
Nicola L.C. Talbot -
Dickimaw Books +

mfirstuc.sty v1.08: uppercasing first letter

+
Nicola L.C. Talbot +
Dickimaw Books
http://www.dickimaw-books.com/

+class="ectt-1200">http://www.dickimaw-_books.com/

2013-11-04
-
-

The glossaries bundle is supplied with the package mfirstuc2013-11-04

+
+

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

\makefirstuc 

\makefirstuc  \makefirstuc{<stuff>}
+class="ectt-1000">\makefirstuc{<stuff>}

This makes the first object of <stuff> uppercase unless <stuff> starts with a -control sequence followed by a non-empty group, in which case the first object in -the group is converted to uppercase. Examples:

+class="ecti-1000"><stuff> uppercase unless <stuff> starts with a control +sequence followed by a non-empty group, in which case the first object in the group is +converted to uppercase. Examples:

  • \makefirstuc{abc} produces Abc. +class="ectt-1000">\makefirstuc{abc} produces Abc.
  • \makefirstuc{\emph{abc}} produces Abc (\MakeUppercase has - been applied to the letter “a” rather than \emph). Note however - that +class="ectt-1000">\makefirstuc{\emph{abc}} produces Abc (\MakeUppercase has been applied to + the letter “a” rather than \emph). Note however that +
    \makefirstuc{{\em abc}}

    produces ABC (first object is {\em abc} so equivalent to - \MakeUppercase{\em abc}), and +class="ecti-1000">ABC (first object is {\em abc} so equivalent to \MakeUppercase{\em abc}), + and +

    {\makefirstuc{\em abc}}

    produces abc (\em doesn’t have an argument therefore first object is \em - so equivalent to {\MakeUppercase{\em}abc}). +class="ectt-1000">\em doesn’t have an argument therefore first object is \em so + equivalent to {\MakeUppercase{\em}abc}).

  • \makefirstuc{{\’a}bc} produces Ábc. +class="ectt-1000">\makefirstuc{{\’a}bc} produces Ábc.
  • \makefirstuc{\ae bc} produces Æbc. +class="ectt-1000">\makefirstuc{\ae bc} produces Æbc.
  • \makefirstuc{{\ae}bc} produces Æbc. +class="ectt-1000">\makefirstuc{{\ae}bc} produces Æbc.
  • \makefirstuc{{ä}bc} produces Äbc. +class="ectt-1000">\makefirstuc{{ä}bc} produces Äbc.
-

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. -

In version 1.02 of mfirstuc, a bug fix resulted in a change in output if the first +

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. +

In version 1.02 of mfirstuc, a bug fix resulted in a change in output if the first object is a control sequence followed by an empty group. Prior to version 1.02, \makefirstuc{\ae{}bc} produced æBc. However as from version 1.02, it now -produces Æbc.
+class="ectt-1000">\makefirstuc{\ae{}bc} produced æBc. However as from version 1.02, it now produces +Æbc.

-

Note also that +

Note also that +

-
+
\newcommand{\abc}{abc}  
\makefirstuc{\abc}
-

produces: ABC. This is because the first object in the argument of +

produces: ABC. This is because the first object in the argument of \makefirstuc is \makefirstuc is \abc, so it does \MakeUppercase{\abc}. Whereas: +class="ectt-1000">\abc, so it does \MakeUppercase{\abc}. Whereas: +

-
+
\newcommand{\abc}{abc}  
\expandafter\makefirstuc\expandafter{\abc}

produces: Abc. There is a short cut command which will do this: -

\xmakefirstuc 

\xmakefirstuc  \xmakefirstuc{<stuff>}
+class="ectt-1000">\xmakefirstuc{<stuff>}

This is equivalent to \expandafter\makefirstuc\expandafter{<stuff>}. +class="ectt-1000">\expandafter\makefirstuc\expandafter{<stuff>}. So +

-
+
\newcommand{\abc}{abc}  
\xmakefirstuc{\abc}

produces: Abc. -

\xmakefirstuc only performs one level expansion on the first object in its +

\xmakefirstuc only performs one level expansion on the first object in its argument. It does not fully expand the entire argument.

-

If you use mfirstuc without the glossaries

If you use mfirstuc without the glossaries package, the standard \MakeUppercase +class="ectt-1000">\MakeUppercase command is used. If used with glossariesglossaries, \MakeTextUppercase (defined by -textcase the package) is used instead. If you are using mfirstuc without the -glossaries package and want to use \MakeTextUppercase instead, you can -redefine -

\glsmakefirstuc \MakeTextUppercase (defined by textcase the +package) is used instead. If you are using mfirstuc without the glossaries package and +want to use \MakeTextUppercase instead, you can redefine +

\glsmakefirstuc  \glsmakefirstuc{<text>}
+class="ectt-1000">\glsmakefirstuc{<text>}

For example: +

-
+
\renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase #1}

Remember to also load textcasetextcase (glossaries loads this automatically). -

New to mfirstuc v1.06: -

\capitalisewords glossaries loads this automatically). +

New to mfirstuc v1.06: +

\capitalisewords  \capitalisewords{<text>}
+class="ectt-1000">\capitalisewords{<text>}

This command apply \makefirstuc\makefirstuc to each word in <text> where the space -character is used as the word separator. Note that it has to be a plain space -character, not another form of space, such as ~ or \space. Note that no -expansion is performed on <text>. -

This is a short cut for \expandafter\capitalisewords\expandafter{<text>}. -

If you are using hyperref\expandafter\capitalisewords\expandafter{<text>}. +

If you are using hyperref and want to use \capitalisewords or \makefirstuc -(or \xcapitalisewords/\xmakefirstuc) in a section heading, the PDF -bookmarks won’t be able to use the command as it’s not expandable, so you will -get a warning that looks like: +class="ectt-1000">\capitalisewords or \makefirstuc (or +\xcapitalisewords/\xmakefirstuc) in a section heading, the PDF bookmarks won’t +be able to use the command as it’s not expandable, so you will get a warning that looks +like: +

-
+
Package hyperref Warning: Token not allowed in a PDF string (PDFDocEncoding):  
(hyperref)                removing ‘\capitalisewords’

If you want to provide an alternative for the PDF bookmark, you can use hyperrefhyperref’s \texorpdfstring\texorpdfstring command. See the hyperref manual for further -details.

+class="ecss-1000">hyperref manual for further details. +

-

Examples: +

Examples:

  1. +
    \capitalisewords{a book of rhyme.} @@ -272,6 +454,7 @@ details.
  2. +
    \capitalisewords{a book\space of rhyme.} @@ -281,20 +464,21 @@ details.
  3. +
    \newcommand{\mytitle}{a book\space of rhyme.}  
    \capitalisewords{\mytitle}
    -

    produces: A BOOK OF RHYME. (No expansion is performed on +

    produces: A BOOK OF RHYME. (No expansion is performed on \mytitle, so \mytitle, so <text> consists of just one “word”.) Compare with next - example: +class="ecti-1000"><text> consists of just one “word”.) Compare with next example:

  4. +
    \newcommand{\mytitle}{a book\space of rhyme.} @@ -303,7 +487,7 @@ class="ecti-1095"><text> consists of just one “word&#

    produces: A Book of Rhyme.

- + diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf index 712428346a0..e36200e47ca 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf and b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index 1b9da222b7b..f9c277d2be0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index 144f1436977..8af4fbe2c2b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -38,22 +38,6 @@ \makeglossaries - % Setup acronym fonts (e.g. \emph for short form on first use and - % \textbf for short form on subsequent use): -\renewcommand{\firstacronymfont}[1]{\emph{#1}} -\renewcommand{\acronymfont}[1]{\textbf{#1}} - % Apply the generic acronym style to just the "acronym" glossary: -\defglsentryfmt[acronym]{\glsgenacfmt} - - % Change acronym first use so that its displayed as - % short (long) -\renewcommand{\genacrfullformat}[2]{% - \glsentryshort{#1}#2 (\glsentrylong{#1})% -} -\renewcommand{\genplacrfullformat}[2]{% - \glsentryshortpl{#1}#2 (\glsentrylongpl{#1})% -} - \longnewglossaryentry{par}{name={par}}% {% A long description with a paragraph break. @@ -68,6 +52,7 @@ description={a sample entry}} acronyms]{aca}{aca}{a contrived acronym} \begin{document} + A \gls{sample} entry and \gls{aca}. Second use: \gls{aca}. Plurals: \glspl{sample}. Reset acronym\glsreset{aca}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf index bfdc31fdf86..16583eb7780 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf index ab02047da75..4860ff0fdb9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf index d2dd194e17a..02bad518a40 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf index 0a6c0c06b85..998fc26de9e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf index 6772c33b807..c46d6e61396 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf index 07321a8550b..f823a59c6da 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf index eceeb393492..2e3a4de2b83 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf index fe4315f4a30..73d32ba5ae0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf index 627bad52ec8..e9b277ea335 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf index f95ce1c9348..13139f5a672 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf index d4437387658..4efb159ff35 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf index b5e671cbfb7..67f2ff80b19 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf index 65cfc9b388b..1c8ff7e08a6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf index 73cf459c27b..e60dfc356c0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf index 78a0343ca21..29e751949f6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf index 9ad908fe2fd..3bbbc1c8b36 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf index 115a4b1a287..43e5e28a3e0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf index ffcb40dd5a8..6988d5eb08d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf index 0a09b3966fb..62857b47426 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf index fed07670c44..751f890eea0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf index 61f0500e65f..e28564ef030 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf index b69d69a0714..7c7ae156f7c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf index fda7938e55a..a61e559b22f 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf index 824cb7296b2..0853be56835 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf index c653c4482e0..3a6ec86b528 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf index 37501dcc7cc..5a5bcaeff51 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf index f50aa8e5943..de299908d5e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf index 08da7b546ef..c6f4ab12b6e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf index 8c45c5a4b76..1cb92a7afc7 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf index 3228aa16a58..c1a5862b401 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf index 876061f671d..da0425f3988 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf index ce8221f72be..89443539238 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf index 810f36d2474..fa0ea98702f 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf index 5e90bb2ad24..3707e9ec010 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf differ diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries b/Master/texmf-dist/scripts/glossaries/makeglossaries index b1c6782ac70..40088ddb71c 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 2.10 (2013/12/01) +# Version : 2.12 (2014/01/20) # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -27,9 +27,19 @@ # glossary-super.sty, glossaries.perl. # Also makeglossaries and makeglossaries. -my $version="2.09 (2013-11-12)"; +my $version="2.12 (2014-01-20)"; # History: +# v2.12 (2014/01/20) +# * Added check for '*' in istfilename +# * Fixed bug report +# http://www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=33 +# * Added error text hashes +# v2.11 (2014/01/17): +# * Added check for backslashes in -x, -m and -d paths +# * Added double-quotes around $appname in &run_app +# v2.10 (2013/12/01): +# * initialise $language to suppress warnings # v2.09 (2013-11-12): # * added check for -q switch when issuing warnings. # v2.08 (2013-10-14): @@ -138,6 +148,9 @@ my %languagemap = if ($opt_d) { + # v2.11 check for backslash character if on Windows + $opt_d=~s/\\/\//g if $^O=~/Win/; + if (chdir $opt_d) { print "Changed to '$opt_d'\n" unless ($opt_q); @@ -150,7 +163,44 @@ if ($opt_d) # v2.02: added: my $xdynotist = 1; -my $needcompatibilitymode=2; +# v2.13: removed +#my $needcompatibilitymode=2; + +# v2.13: added $istnotfound +my $istnotfound = 3; + +# v2.13: added error text: +my %makeindex_error_text = + ( + $xdynotist => "Style name indicates makeindex, but may be in xindy format.\n" + . "Remember to use \\setStyleFile to specify the name\n" + . "of the style file rather than redefining \\istfilename\n" + . "explicitly.", + $istnotfound => "Style file not found." + ); + +my %xindy_error_text = + ( + 'nosort' => "Sort key required for entries only containing command names", + 'istnotxdy' => + "Style name has xdy extension, but may be in makeindex format.\n" + . "Remember to use \\setStyleFile to specify the name\n" + . "of the style file rather than redefining \\istfilename\n" + . "explicitly.", + 'missingendquote' => + "You may have missed a \" character in a command such as \\GlsAddXdyLocation", + 'nolanguage' => + "No language detected.\nHave you remembered to use \\printglossary\n". + "or \\printglossaries in your document?", + 'nomain' => + "\nRemember to use package option 'nomain' if you don't\n". + "want to use the main glossary.", + 'badlocation' => + "You may have forgotten to add a location \n" + . "class with \\GlsAddLocation or you may have \n" + . "the format incorrect.\n", + 'comp207' => "You may need to add 'compatible-2.07' package option.\n", + ); # define known extensions @@ -218,6 +268,13 @@ unless ($istfile) my $xindyapp = ($opt_x ? $opt_x :'xindy'); my $makeindexapp = ($opt_m ? $opt_m :'makeindex'); +# v2.11 check for backslash character if on Windows +if ($^O=~/Win/) +{ + $xindyapp=~s/\\/\//g; + $makeindexapp=~s/\\/\//g; +} + # v1.5 save the general xindy switches my $xdyopts = ''; @@ -539,7 +596,17 @@ sub scan_aux{ $istfile = $1; # check if double quotes were added to \jobname - $istfile=~s/^"(.*)"\.ist$/$1.ist/; + # v2.12 added check for xdy (bug ID 33) + $istfile=~s/^"(.*)"\.(ist|xdy)$/$1.$2/; + + # v2.12 if on Windows, substitute any '*' with ' ' + # to compensate for MiKTeX bug + # http://sourceforge.net/p/miktex/bugs/2301/ + + if ($^O=~/Win/) + { + $istfile=~tr/\*/ /; + } } # v1.5 added @@ -604,7 +671,8 @@ sub run_app{ return if ($dontexec); - if (open (STATUS, "$appname $appargs 2>&1 |")) + # v2.11 added double-quotes around $appname + if (open (STATUS, "\"$appname\" $appargs 2>&1 |")) { while () { @@ -621,11 +689,11 @@ sub run_app{ } else { - $warnings = "WARNING: Unable to fork $appname: $!\n"; + $warnings = "WARNING: Unable to fork \"$appname\": $!\n"; print STDERR $warnings, "Retrying without redirection.\n"; - $status = `$appname $appargs`; + $status = `\"$appname\" $appargs`; $log = $status; @@ -638,7 +706,7 @@ sub run_app{ if (open LOGFILE, ">>$trans") { - print LOGFILE "\n\n*** Unable to execute: '$appname $appargs' ***\n\n"; + print LOGFILE "\n\n*** Unable to execute: '\"$appname\" $appargs' ***\n\n"; print LOGFILE "Status report:\n\n"; print LOGFILE "$log"; close LOGFILE; @@ -657,6 +725,12 @@ sub run_app{ { while () { + if (/Index style file .* not found/) + { + $errno = $istnotfound; + last; + } + if (/Unknown specifier ;/) { $errno = $xdynotist; @@ -690,13 +764,13 @@ sub makeindex{ { my $diagnostic = ''; - if ($errno = $xdynotist) + if ($makeindex_error_text{$errno}) { - $diagnostic = - "Style name indicates makeindex, but may be in xindy format.\n" - . "Remember to use \\setStyleFile to specify the name\n" - . "of the style file rather than redefining \\istfilename\n" - . "explicitly."; + $diagnostic = $makeindex_error_text{$errno}; + } + else + { + $diagnostic = "Can't find diagnostic message for error number $errno"; } die "\n***Call to makeindex failed***\n", @@ -851,21 +925,15 @@ sub xindy{ if ($status=~/index 0 should be less than the length of the string/m) { - $diagnostic = - "Sort key required for entries only containing command names"; + $diagnostic = $xindy_error_text{nosort}; } elsif ($status=~/variable % has no value/m) { - $diagnostic = - "Style name has xdy extension, but may be in makeindex format.\n" - . "Remember to use \\setStyleFile to specify the name\n" - . "of the style file rather than redefining \\istfilename\n" - . "explicitly."; + $diagnostic = $xindy_error_text{istnotxindy}; } elsif ($status=~/Possible read-error due to ill-formed string " :sep/m) { - $diagnostic = - "You may have missed a \" character in a command such as \\GlsAddXdyLocation"; + $diagnostic = $xindy_error_text{missingendquote}; } elsif (not $language) { @@ -875,10 +943,7 @@ sub xindy{ # because the user has a customized style file that # contains the language settings. - $diagnostic = - "No language detected.". - "\nHave you remembered to use \\printglossary\n". - "or \\printglossaries in your document?"; + $diagnostic = $xindy_error_text{nolanguage}; if ($in eq 'glo') { @@ -886,9 +951,7 @@ sub xindy{ # glossary and has forgotten to suppress it with the # "nomain" package option - $diagnostic .= - "\nRemember to use package option 'nomain' if you don't\n". - "want to use the main glossary."; + $diagnostic .= $xindy_error_text{nomain}; } } @@ -907,16 +970,12 @@ sub xindy{ if ($status=~/did not match any location-class/m) { - $diagwarn = "You may have forgotten to add a location \n" - . "class with \\GlsAddLocation or you may have \n" - . "the format incorrect.\n"; - + $diagwarn = $xindy_error_text{badlocation}; } if ($status=~/unknown attribute `pageglsnumberformat'/m) { - $diagwarn .= "You may need to add 'compatible-2.07' package " - . "option.\n"; + $diagwarn .= $xindy_error_text{comp207}; } if ($diagwarn) @@ -957,9 +1016,12 @@ sub HELP_MESSAGE{ print "\t\textension.\n"; print "\nGeneral Options:\n\n"; print "-o \tUse as the output file.\n"; + print "\t\t(Don't use -o if you have more than one glossary.)\n"; print "-q\t\tQuiet mode.\n"; print "-s \tEmploy as the style file.\n"; print "-t \tEmploy as the transcript file.\n"; + print "\t\t(Don't use -t if you have more than one glossary\n"; + print "\t\tor the transcripts will be overwritten.)\n"; print "-d \tDirectory in which the .aux, .glo etc files are located.\n", "\t\t(Default is the directory in which resides.)\n"; print "-n\t\tPrint the command that would normally be executed,\n", diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries.bat b/Master/texmf-dist/scripts/glossaries/makeglossaries.bat index d91f67bd3e9..64a6a20750c 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries.bat +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries.bat @@ -1,3 +1,3 @@ -@rem = '-*- Perl -*- -@echo off -perl -S "%~dp0makeglossaries" %* +@rem = '-*- Perl -*- +@echo off +perl -S "%~dp0makeglossaries" %* diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 7ced9a3d178..ea52d610f09 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -28,7 +28,7 @@ % -author "Nicola Talbot" % -codetitle "Main Package Code" % glossaries -% Created on 2013/12/5 15:12 +% Created on 2014/1/20 17:22 %\fi %\iffalse %<*package> @@ -51,7 +51,7 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2013 Nicola Talbot, all rights reserved. +% Copyright (C) 2014 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> @@ -138,7 +138,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{17171} +\CheckSum{17824} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -166,12 +166,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{Documented Code For glossaries v4.02} +% \title{Documented Code For glossaries v4.03} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2013-12-05} +% \date{2014-01-20} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -187,7 +187,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %glossaries package}. % %\item[\url{glossaries-user.pdf}] -%For the main user guide, read \qt{glossaries.sty v4.02: +%For the main user guide, read \qt{glossaries.sty v4.03: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -231,7 +231,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2013/12/05 v4.02 (NLCT)] +\ProvidesPackage{glossaries}[2014/01/20 v4.03 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -1329,8 +1329,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} % \begin{macrocode} \define@boolkey[gls]{sanitize}{name}[true]{% - \GlossariesWarning{sanitize={name} package option -deprecated}% + \GlossariesWarning{sanitize={name} package option deprecated}% \ifgls@sanitize@name \glssetnoexpandfield{name}% \else @@ -1340,8 +1339,7 @@ deprecated}% % \end{macrocode} % \begin{macrocode} \define@boolkey[gls]{sanitize}{symbol}[true]{% - \GlossariesWarning{sanitize={symbol} package option -deprecated}% + \GlossariesWarning{sanitize={symbol} package option deprecated}% \ifgls@sanitize@symbol \glssetnoexpandfield{symbol}% \glssetnoexpandfield{symbolplural}% @@ -1675,15 +1673,17 @@ name=true]{% \ifglssavewrites \renewcommand*{\glswritefiles}{\@glswritefiles}% \else - \let\glswritefiles\relax + \let\glswritefiles\@empty \fi } % \end{macrocode} %\end{option} % Set default: +%\changes{4.03}{2014-01-17}{changed default to \cs{@empty} instead +%of \cs{relax}} % \begin{macrocode} \glssavewritesfalse -\let\glswritefiles\relax +\let\glswritefiles\@empty % \end{macrocode} % %\begin{option}{compatible-3.07} @@ -1974,7 +1974,7 @@ name=true]{% %\changes{1.15}{2008 August 15}{new} % \begin{macrocode} \newcommand*{\glssettoctitle}[1]{% -\def\glossarytoctitle{\csname @glotype@#1@title\endcsname}} + \def\glossarytoctitle{\csname @glotype@#1@title\endcsname}} % \end{macrocode} %\end{macro} % @@ -2165,7 +2165,7 @@ name=true]{% %\end{macro} % %\begin{macro}{\setStyleFile} -% Sets the style file. The relevent extension is appended. +% Sets the style file. The relevant extension is appended. % \begin{macrocode} \ifglsxindy \newcommand{\setStyleFile}[1]{% @@ -3115,8 +3115,9 @@ name=true]{% % This used to determine the root language, using a~bit of trickery % since \sty{babel} doesn't supply the information, but now that % \sty{babel} is once again actively maintained, we can't do this -% any more, so \cs{findrootlanguage} no longer available. Now -% provide a command that does nothing (in case it's been patched). +% any more, so \cs{findrootlanguage} is no longer available. Now +% provide a command that does nothing (in case it's been patched), +% but this may be removed completely in the future. % \begin{macrocode} \newcommand*{\findrootlanguage}{} % \end{macrocode} @@ -3283,6 +3284,30 @@ name=true]{% % \end{macrocode} %\end{macro} % +% Since the label is used to form the name of control sequences, by +% default UTF8 etc characters can't be used in the label. A possible +% workaround is to use \ics{scantokens}, but commands such as +% \ics{glsentrytext} will no longer be usable in sectioning, caption +% etc commands. If the user really wants to be able to construct a +% label with UTF8 characters, allow them the means to do so (but on +% their own head be it, if they then use entries in \ics{section} +% etc). This can be done via: +%\begin{verbatim} +%\renewcommand*{\glsdetoklabel}[1]{\scantokens{#1\noexpand}} +%\end{verbatim} +% (Note, don't use \ics{detokenize} or it will cause commands like +% \ics{glsaddall} to fail.) +% Since redefining \cs{glsdetoklabel} can cause things to go +% badly wrong, I'm not going to mention it in the main user guide. +% Only advanced users who know what they're doing ought to attempt +% it. +%\begin{macro}{\glsdetoklabel} +%\changes{4.03}{2014-01-20}{new} +% \begin{macrocode} +\newcommand*{\glsdetoklabel}[1]{#1} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\ifglsentryexists} % To check to see if a glossary entry has been defined use: %\begin{definition} @@ -3291,9 +3316,10 @@ name=true]{% %where \meta{label} is the entry's label. %\changes{3.0}{2011/04/02}{replaced \cs{@ifundefined} with %\cs{ifcsundef}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand{\ifglsentryexists}[3]{% - \ifcsundef{glo@#1@name}{#3}{#2}% + \ifcsundef{glo@\glsdetoklabel{#1}@name}{#3}{#2}% } % \end{macrocode} %\end{macro} @@ -3309,22 +3335,27 @@ name=true]{% % otherwise it will do \meta{false text}. %\changes{3.11a}{2013-10-15}{replaced \cs{ifthenelse} with %\cs{ifbool}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} -\newcommand*{\ifglsused}[3]{\ifbool{glo@#1@flag}{#2}{#3}} +\newcommand*{\ifglsused}[3]{% + \ifbool{glo@\glsdetoklabel{#1}@flag}{#2}{#3}% +} % \end{macrocode} %\end{macro} %The following two commands will cause an error if the given % condition fails: % %\begin{macro}{\glsdoifexists} -%\cs{glsdoifexists}\marg{label}\marg{code}\par +%\begin{definition} +%\cs{glsdoifexists}\marg{label}\marg{code} +%\end{definition} % Generate an error if entry specified by \meta{label} doesn't % exists, otherwise do \meta{code}. % \begin{macrocode} \newcommand{\glsdoifexists}[2]{% \ifglsentryexists{#1}{#2}{% - \PackageError{glossaries}{Glossary entry `#1' has not been - defined}{You need to define a glossary entry before you + \PackageError{glossaries}{Glossary entry `\glsdetoklabel{#1}' + has not been defined}{You need to define a glossary entry before you can use it.}}% } % \end{macrocode} @@ -3337,25 +3368,45 @@ name=true]{% % \begin{macrocode} \newcommand{\glsdoifnoexists}[2]{% \ifglsentryexists{#1}{% - \PackageError{glossaries}{Glossary entry `#1' has already + \PackageError{glossaries}{Glossary entry `\glsdetoklabel{#1}' has already been defined}{}}{#2}% } % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsdoifexistsorwarn} +%\begin{definition} +%\cs{glsdoifexistsorwarn}\marg{label}\marg{code} +%\end{definition} +% Generate a warning if entry specified by \meta{label} doesn't +% exists, otherwise do \meta{code}. +%\changes{4.03}{2014-01-20}{new} +% \begin{macrocode} +\newcommand{\glsdoifexistsorwarn}[2]{% + \ifglsentryexists{#1}{#2}{% + \GlossariesWarning{Glossary entry `\glsdetoklabel{#1}' + has not been defined}% + }% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\ifglshaschildren} % \cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} %\changes{3.02}{2012/05/21}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand{\ifglshaschildren}[3]{% \glsdoifexists{#1}% {% \def\do@glshaschildren{#3}% - \expandafter\forglsentries\expandafter[\csname glo@#1@type\endcsname] + \edef\@gls@thislabel{\glsdetoklabel{#1}}% + \expandafter\forglsentries\expandafter + [\csname glo@\@gls@thislabel @type\endcsname] {\glo@label}% {% \letcs\glo@parent{glo@\glo@label @parent}% - \ifthenelse{\equal{#1}{\glo@parent}}% + \ifdefequal\@gls@thislabel\glo@parent {% \def\do@glshaschildren{#2}% \@endfortrue @@ -3371,11 +3422,12 @@ name=true]{% %\begin{macro}{\ifglshasparent} % \cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} %\changes{3.02}{2012/05/21}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand{\ifglshasparent}[3]{% \glsdoifexists{#1}% {% - \ifcsempty{glo@#1@parent}{#3}{#2}% + \ifcsempty{glo@\glsdetoklabel{#1}@parent}{#3}{#2}% }% } % \end{macrocode} @@ -3386,9 +3438,10 @@ name=true]{% %\changes{3.08a}{2013-09-28}{new} %\changes{3.11a}{2013-10-15}{replaced \cs{ifdefempty} with %\cs{ifcsempty}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasdesc}[3]{% - \ifcsempty{glo@#1@desc}% + \ifcsempty{glo@\glsdetoklabel{#1}@desc}% {#3}% {#2}% } @@ -3400,9 +3453,11 @@ name=true]{% %\changes{3.08a}{2013-09-28}{new} % Does \meta{true part} if the description is just \cs{nopostdesc} % otherwise does \meta{false part}. +%\changes{4.03}{2014-01-20}{fixed typo} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglsdescsuppressed}[3]{% - \ifcsequal{glos@#1@desc}{@no@post@desc}% + \ifcsequal{glo@\glsdetoklabel{#1}@desc}{@no@post@desc}% {#2}% {#3}% } @@ -3416,16 +3471,18 @@ name=true]{% %\cs{@gls@default@symbol}} %\changes{3.11a}{2013-10-15}{replaced \cs{ifdefempty} with %\cs{ifcsempty}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +%\changes{4.03}{2014-01-20}{replaced \cs{ifcsempty} with +%\cs{ifdefempty} and replaced \cs{ifx} with \cs{ifdefequal}} % \begin{macrocode} \newcommand*{\ifglshassymbol}[3]{% - \ifcsempty{glo@#1@symbol}% + \letcs{\@glo@symbol}{glo@\glsdetoklabel{#1}@symbol}% + \ifdefempty\@glo@symbol {#3}% {% - \expandafter\ifx\csname glo@#1@symbol\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@symbol\@gls@default@value + {#3}% + {#2}% }% } % \end{macrocode} @@ -3434,16 +3491,16 @@ name=true]{% %\begin{macro}{\ifglshaslong} %\cs{ifglshaslong}\marg{label}\marg{true part}\marg{false part} %\changes{3.11a}{2013-10-15}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshaslong}[3]{% - \ifcsempty{glo@#1@long}% + \letcs{\@glo@long}{glo@\glsdetoklabel{#1}@long}% + \ifdefempty\@glo@long {#3}% {% - \expandafter\ifx\csname glo@#1@long\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@long\@gls@default@value + {#3}% + {#2}% }% } % \end{macrocode} @@ -3452,16 +3509,91 @@ name=true]{% %\begin{macro}{\ifglshasshort} %\cs{ifglshasshort}\marg{label}\marg{true part}\marg{false part} %\changes{3.11a}{2013-10-15}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasshort}[3]{% - \ifcsempty{glo@#1@short}% + \letcs{\@glo@short}{glo@\glsdetoklabel{#1}@short}% + \ifdefempty\@glo@short {#3}% {% - \expandafter\ifx\csname glo@#1@short\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@short\@gls@default@value + {#3}% + {#2}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\ifglshasfield} +%\changes{4.03}{2014-01-20}{new} +%\begin{definition} +%\cs{ifglshasfield}\marg{field}\marg{label}\marg{true part}\marg{false +%part} +%\end{definition} +% \begin{macrocode} +\newcommand*{\ifglshasfield}[4]{% + \glsdoifexists{#2}% + {% + \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@#1}% +% \end{macrocode} +% First check supplied field label is defined. +% \begin{macrocode} + \ifdef\@glo@thisvalue + {% +% \end{macrocode} +% Is defined, so now check if empty. +% \begin{macrocode} + \ifdefempty\@glo@thisvalue + {% +% \end{macrocode} +% Is empty, so doesn't have field set. +% \begin{macrocode} + #4% + }% + {% +% \end{macrocode} +% Not empty, so check if set to \cs{@gls@default@value} +% \begin{macrocode} + \ifdefequal\@glo@thisvalue\@gls@default@value{#4}{#3}% + }% + }% + {% +% \end{macrocode} +% Field given isn't defined, so check if mapping exists. +% \begin{macrocode} + \@gls@fetchfield{\@gls@thisfield}{#1}% +% \end{macrocode} +% If \cs{@gls@thisfield} is defined, we've found a map. If not, the +% field supplied doesn't exist. +% \begin{macrocode} + \ifdef\@gls@thisfield + {% +% \end{macrocode} +% Is defined, so now check if empty. +% \begin{macrocode} + \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@\@gls@thisfield}% + \ifdefempty\@glo@thisvalue + {% +% \end{macrocode} +% Is empty so field hasn't been set. +% \begin{macrocode} + #4% + }% + {% +% \end{macrocode} +% Isn't empty so check if it's been set to \cs{@gls@default@value}. +% \begin{macrocode} + \ifdefequal\@glo@thisvalue\@gls@default@value{#4}{#3}% + }% + }% + {% +% \end{macrocode} +% Not defined. +% \begin{macrocode} + \GlossariesWarning{Unknown entry field `#1'}% + #4% + }% + }% }% } % \end{macrocode} @@ -4251,13 +4383,15 @@ name=true]{% %\begin{macro}{\@gls@writedef} %\changes{3.10a}{2013-10-13}{new} % Writes glossary entry definition to \cs{@gls@deffile}. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\@gls@writedef}[1]{% \immediate\write\@gls@deffile {% \string\ifglsentryexists{#1}{}\expandafter\@gobble\string\%^^J% \expandafter\@gobble\string\{\expandafter\@gobble\string\%^^J% - \string\gls@defglossaryentry{#1}\expandafter\@gobble\string\%^^J% + \string\gls@defglossaryentry{\glsdetoklabel{#1}}\expandafter + \@gobble\string\%^^J% \expandafter\@gobble\string\{\expandafter\@gobble\string\%% }% % \end{macrocode} @@ -4266,7 +4400,8 @@ name=true]{% \@for\@gls@map:=\@gls@keymap\do {% \edef\glo@value{\expandafter\expandonce - \csname glo@#1@\expandafter\@secondoftwo\@gls@map\endcsname}% + \csname glo@\glsdetoklabel{#1}@\expandafter + \@secondoftwo\@gls@map\endcsname}% \@onelevel@sanitize\glo@value \immediate\write\@gls@deffile {% @@ -4322,6 +4457,42 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@fetchfield} +%\changes{4.03}{2014-01-20}{new} +%\begin{definition} +%\cs{@gls@fetchfield}\marg{cs}\marg{field} +%\end{definition} +% Fetches the internal field label from the given user \meta{field} and +% stores in \meta{cs}. +% \begin{macrocode} +\newcommand*{\@gls@fetchfield}[2]{% +% \end{macrocode} +% Ensure user field name is fully expanded +% \begin{macrocode} + \edef\@gls@thisval{#2}% +% \end{macrocode} +% Iterate through known mappings until we find the one for this +% field. +% \begin{macrocode} + \@for\@gls@map:=\@gls@keymap\do{% + \edef\@this@key{\expandafter\@firstoftwo\@gls@map}% + \ifdefequal{\@this@key}{\@gls@thisval}% + {% +% \end{macrocode} +% Found it. +% \begin{macrocode} + \edef#1{\expandafter\@secondoftwo\@gls@map}% +% \end{macrocode} +% Break out of loop. +% \begin{macrocode} + \@endfortrue + }% + {}% + }% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glsaddkey} %\begin{definition} %\cs{glsaddkey}\marg{key}\marg{default value}\marg{no link cs}\marg{no link ucfirst @@ -4373,14 +4544,12 @@ name=true]{% % \end{macrocode} % Define the no-link commands. % \begin{macrocode} - \newcommand*{#3}[1]{\csuse{glo@##1@#1}}% - \newcommand*{#4}[1]{% - \letcs{\@glo@text}{glo@##1@#1}% - \xmakefirstuc\@glo@text - }% + \newcommand*{#3}[1]{\@gls@entry@field{##1}{#1}}% + \newcommand*{#4}[1]{\@Gls@entry@field{##1}{#1}}% % \end{macrocode} % Now for the commands with links. First the version with no case % change: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@field@link}} % \begin{macrocode} \ifcsdef{@gls@user@#1@}% {% @@ -4401,11 +4570,7 @@ name=true]{% {\csuse{@gls@user@#1@}{##1}{##2}}% {\csuse{@gls@user@#1@}{##1}{##2}[]}}% \csdef{@gls@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{#3{##2}##3}% - }% + \@gls@field@link{##1}{##2}{#3{##2}##3}% }% }% % \end{macrocode} @@ -4430,11 +4595,7 @@ name=true]{% {\csuse{@Gls@user@#1@}{##1}{##2}}% {\csuse{@Gls@user@#1@}{##1}{##2}[]}}% \csdef{@Gls@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{#4{##2}##3}% - }% + \@gls@field@link{##1}{##2}{#4{##2}##3}% }% }% % \end{macrocode} @@ -4459,11 +4620,7 @@ name=true]{% {\csuse{@GLS@user@#1@}{##1}{##2}}% {\csuse{@GLS@user@#1@}{##1}{##2}[]}}% \csdef{@GLS@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{\mfirstucMakeUppercase{#3{##2}##3}}% - }% + \@gls@field@link{##1}{##2}{\mfirstucMakeUppercase{#3{##2}##3}}% }% }% }% @@ -4502,8 +4659,8 @@ name=true]{% \@org@newglossaryentryprehook }% \renewcommand*{\gls@assign@desc}[1]{% - \global\cslet{glo@#1@desc}{\@glo@desc}% - \global\cslet{glo@#1@descplural}{\@glo@desc}% + \global\cslet{glo@\glsdetoklabel{#1}@desc}{\@glo@desc}% + \global\cslet{glo@\glsdetoklabel{#1}@descplural}{\@glo@desc}% } \gls@defglossaryentry{#1}{#2}% \egroup @@ -4537,15 +4694,16 @@ name=true]{% %\end{definition} % Defines a new entry without checking if it already exists. %\changes{3.10a}{2013-10-13}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand{\gls@defglossaryentry}[2]{% % \end{macrocode} % Store label % \begin{macrocode} - \def\@glo@label{#1}% + \edef\@glo@label{\glsdetoklabel{#1}}% % \end{macrocode} % \changes{3.12a}{2013-10-16}{added \cs{glslabel}} -% Provide a means for user define keys to reference the label: +% Provide a means for user defined keys to reference the label: % \begin{macrocode} \let\glslabel\@glo@label % \end{macrocode} @@ -4650,9 +4808,10 @@ name=true]{% {}% % \end{macrocode} % Assign type. This must be fully expandable +%\changes{4.03}{2014-01-20}{replaced \#1 with \cs{@glo@label}} % \begin{macrocode} - \gls@assign@field{\glsdefaulttype}{#1}{type}{\@glo@type}% - \edef\@glo@type{\glsentrytype{#1}}% + \gls@assign@field{\glsdefaulttype}{\@glo@label}{type}{\@glo@type}% + \edef\@glo@type{\glsentrytype{\@glo@label}}% % \end{macrocode} % Check to see if this glossary type has been defined, if it has, % add this label to the relevant list, otherwise generate an error. @@ -4668,7 +4827,8 @@ name=true]{% }% {% \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% - \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% + \expandafter\xdef\csname glolist@\@glo@type\endcsname{% + \@glolist@{\@glo@label},}% }% % \end{macrocode} % Initialise level to 0. @@ -4682,16 +4842,18 @@ name=true]{% % Doesn't have a parent. Set \cs{glo@}\meta{label}"@parent" to % empty. % \begin{macrocode} - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% \else % \end{macrocode} % Has a parent. Check to ensure this entry isn't its own parent. +%\changes{4.03}{2014-01-20}{replaced \cs{ifthenelse} with +%\cs{ifdefequal}} % \begin{macrocode} - \ifthenelse{\equal{#1}{\@glo@parent}}% + \ifdefequal\@glo@label\@glo@parent% {% - \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \PackageError{glossaries}{Entry `\@glo@label' can't be its own parent}{}% \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% }% {% % \end{macrocode} @@ -4702,7 +4864,8 @@ name=true]{% % \end{macrocode} % Parent exists. Set \cs{glo@}\meta{label}"@parent". % \begin{macrocode} - \expandafter\xdef\csname glo@#1@parent\endcsname{\@glo@parent}% + \expandafter\xdef\csname glo@\@glo@label @parent\endcsname{% + \@glo@parent}% % \end{macrocode} % Determine level. % \begin{macrocode} @@ -4731,32 +4894,32 @@ name=true]{% \PackageError{glossaries}% {% Invalid parent `\@glo@parent' - for entry `#1' - parent doesn't exist% + for entry `\@glo@label' - parent doesn't exist% }% {% Parent entries must be defined before their children% }% \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% }% }% \fi % \end{macrocode} % Set the level for this entry % \begin{macrocode} - \expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% + \expandafter\xdef\csname glo@\@glo@label @level\endcsname{\number\gls@level}% % \end{macrocode} % Define commands associated with this entry: % \begin{macrocode} - \gls@assign@field{\@glo@name}{#1}{sortvalue}{\@glo@sort}% - \letcs\@glo@sort{glo@#1@sortvalue}% - \gls@assign@field{\@glo@name}{#1}{text}{\@glo@text}% + \gls@assign@field{\@glo@name}{\@glo@label}{sortvalue}{\@glo@sort}% + \letcs\@glo@sort{glo@\@glo@label @sortvalue}% + \gls@assign@field{\@glo@name}{\@glo@label}{text}{\@glo@text}% \expandafter\gls@assign@field\expandafter - {\csname glo@#1@text\endcsname\glspluralsuffix}% - {#1}{plural}{\@glo@plural}% + {\csname glo@\@glo@label @text\endcsname\glspluralsuffix}% + {\@glo@label}{plural}{\@glo@plural}% \expandafter\gls@assign@field\expandafter - {\csname glo@#1@text\endcsname}% - {#1}{first}{\@glo@first}% + {\csname glo@\@glo@label @text\endcsname}% + {\@glo@label}{first}{\@glo@first}% % \end{macrocode} %\changes{3.14a}{2013-11-12}{set the default for firstplural to be the value %of plural} @@ -4767,12 +4930,12 @@ name=true]{% % \begin{macrocode} \ifx\@glo@first\@gls@default@value \expandafter\gls@assign@field\expandafter - {\csname glo@#1@plural\endcsname}% - {#1}{firstpl}{\@glo@firstplural}% + {\csname glo@\@glo@label @plural\endcsname}% + {\@glo@label}{firstpl}{\@glo@firstplural}% \else \expandafter\gls@assign@field\expandafter - {\csname glo@#1@first\endcsname\glspluralsuffix}% - {#1}{firstpl}{\@glo@firstplural}% + {\csname glo@\@glo@label @first\endcsname\glspluralsuffix}% + {\@glo@label}{firstpl}{\@glo@firstplural}% \fi % \end{macrocode} %\changes{3.11a}{2013-10-15}{Fixed default counter if none supplied} @@ -4784,29 +4947,30 @@ name=true]{% {% \letcs\@glo@defaultcounter{@glotype@\@glo@type @counter}% }% - \gls@assign@field{\@glo@defaultcounter}{#1}{counter}{\@glo@counter}% - \gls@assign@field{}{#1}{useri}{\@glo@useri}% - \gls@assign@field{}{#1}{userii}{\@glo@userii}% - \gls@assign@field{}{#1}{useriii}{\@glo@useriii}% - \gls@assign@field{}{#1}{useriv}{\@glo@useriv}% - \gls@assign@field{}{#1}{userv}{\@glo@userv}% - \gls@assign@field{}{#1}{uservi}{\@glo@uservi}% - \gls@assign@field{}{#1}{short}{\@glo@short}% - \gls@assign@field{}{#1}{shortpl}{\@glo@shortpl}% - \gls@assign@field{}{#1}{long}{\@glo@long}% - \gls@assign@field{}{#1}{longpl}{\@glo@longpl}% + \gls@assign@field{\@glo@defaultcounter}{\@glo@label}{counter}{\@glo@counter}% + \gls@assign@field{}{\@glo@label}{useri}{\@glo@useri}% + \gls@assign@field{}{\@glo@label}{userii}{\@glo@userii}% + \gls@assign@field{}{\@glo@label}{useriii}{\@glo@useriii}% + \gls@assign@field{}{\@glo@label}{useriv}{\@glo@useriv}% + \gls@assign@field{}{\@glo@label}{userv}{\@glo@userv}% + \gls@assign@field{}{\@glo@label}{uservi}{\@glo@uservi}% + \gls@assign@field{}{\@glo@label}{short}{\@glo@short}% + \gls@assign@field{}{\@glo@label}{shortpl}{\@glo@shortpl}% + \gls@assign@field{}{\@glo@label}{long}{\@glo@long}% + \gls@assign@field{}{\@glo@label}{longpl}{\@glo@longpl}% \ifx\@glo@name\@glsnoname \@glsnoname \let\@gloname\@gls@default@value \fi - \gls@assign@field{}{#1}{name}{\@glo@name}% + \gls@assign@field{}{\@glo@label}{name}{\@glo@name}% % \end{macrocode} %\changes{3.02}{2012/05/21}{added numberlist element} % Set default numberlist if not defined: % \begin{macrocode} - \ifcsundef{glo@#1@numberlist}% + \ifcsundef{glo@\@glo@label @numberlist}% {% - \csxdef{glo@#1@numberlist}{\noexpand\@gls@missingnumberlist{\@glo@label}}% + \csxdef{glo@\@glo@label @numberlist}{% + \noexpand\@gls@missingnumberlist{\@glo@label}}% }% {}% % \end{macrocode} @@ -4823,14 +4987,14 @@ name=true]{% \@glsnodesc \let\@glodesc\@gls@default@value \fi - \gls@assign@desc{#1}% + \gls@assign@desc{\@glo@label}% % \end{macrocode} %\changes{1.18}{2009 January 14}{moved sort sanitization to % \cs{newglossaryentry}} %\changes{3.0}{2011/04/02}{added \cs{@gls@defsort}} % Set the sort key for this entry: % \begin{macrocode} - \@gls@defsort{\@glo@type}{#1}% + \@gls@defsort{\@glo@type}{\@glo@label}% % \end{macrocode} %\changes{1.15}{2008 August 15}{check for \cs{@glo@text} in symbol}% % \begin{macrocode} @@ -4838,24 +5002,26 @@ name=true]{% \ifx\@glo@symbol\@glo@@symbol \let\@glo@symbol\@glo@text \fi - \gls@assign@field{\relax}{#1}{symbol}{\@glo@symbol}% + \gls@assign@field{\relax}{\@glo@label}{symbol}{\@glo@symbol}% \expandafter \gls@assign@field\expandafter - {\csname glo@#1@symbol\endcsname} - {#1}{symbolplural}{\@glo@symbolplural}% + {\csname glo@\@glo@label @symbol\endcsname} + {\@glo@label}{symbolplural}{\@glo@symbolplural}% % \end{macrocode} % Define an associated boolean variable to determine whether this % entry has been used yet (needs to be defined globally): % \begin{macrocode} - \expandafter\gdef\csname glo@#1@flagfalse\endcsname{% - \expandafter\global\expandafter - \let\csname ifglo@#1@flag\endcsname\iffalse + \expandafter\xdef\csname glo@\@glo@label @flagfalse\endcsname{% + \noexpand\global + \noexpand\let\expandafter\noexpand + \csname ifglo@\@glo@label @flag\endcsname\noexpand\iffalse }% - \expandafter\gdef\csname glo@#1@flagtrue\endcsname{% - \expandafter\global\expandafter - \let\csname ifglo@#1@flag\endcsname\iftrue + \expandafter\xdef\csname glo@\@glo@label @flagtrue\endcsname{% + \noexpand\global + \noexpand\let\expandafter\noexpand + \csname ifglo@\@glo@label @flag\endcsname\noexpand\iftrue }% - \csname glo@#1@flagfalse\endcsname + \csname glo@\@glo@label @flagfalse\endcsname % \end{macrocode} % Sort out any cross-referencing if required. % \begin{macrocode} @@ -4864,7 +5030,7 @@ name=true]{% \protected@edef\@do@glssee{% \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see \noexpand\@nil - \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% + \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{\@glo@label}}% \@do@glssee \fi % \end{macrocode} @@ -4873,7 +5039,7 @@ name=true]{% % format when entry % is defined}% % \begin{macrocode} - \do@glo@storeentry{#1}% + \do@glo@storeentry{\@glo@label}% % \end{macrocode} % Add end hook in case another package wants to add extra keys. % \begin{macrocode} @@ -4902,16 +5068,23 @@ name=true]{% %\changes{3.02}{2012/05/21}{new} % Moves entry whose label is given by first argument to the glossary % named in the second argument. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glsmoveentry}[2]{% - \edef\glo@type{\csname glo@#1@type\endcsname}% + \edef\@glo@thislabel{\glsdetoklabel{#1}}% + \edef\glo@type{\csname glo@\@glo@thislabel @type\endcsname}% \def\glo@list{,}% \forglsentries[\glo@type]{\glo@label}% {% - \ifthenelse{\equal{\glo@label}{#1}}{}{\eappto\glo@list{\glo@label,}}% +% \end{macrocode} +%\changes{4.03}{2014-01-20}{replaced \cs{ifthenelse} with +%\cs{ifdefequal}} +% \begin{macrocode} + \ifdefequal\@glo@thislabel\glo@label + {}{\eappto\glo@list{\glo@label,}}% }% \cslet{glolist@\glo@type}{\glo@list}% - \csdef{glo@#1@type}{#2}% + \csdef{glo@\@glo@thislabel @type}{#2}% } % \end{macrocode} %\end{macro} @@ -4955,17 +5128,18 @@ name=true]{% %\changes{1.17}{2008 December 26}{new} % Determine the format to write the entry in the glossary % output (\filetype{.glo}) file. -% The argument is the entry's label. +% The argument is the entry's label (should already have been +% de-tok'ed if required). % The result is stored in \cs{glo@}\meta{label}"@entry", where % \meta{label} is the entry's label. (This doesn't include % any formatting or location information.) % \begin{macrocode} \newcommand{\@glo@storeentry}[1]{% % \end{macrocode} -% Escape special characters in the label: +% Escape makeindex/xindy special characters in the label: % \begin{macrocode} - \def\@glo@label{#1}% - \@gls@checkmkidxchars\@glo@label + \edef\@glo@esclabel{#1}% + \@gls@checkmkidxchars\@glo@esclabel % \end{macrocode} % Get the sort string and escape any special characters % \begin{macrocode} @@ -4996,7 +5170,7 @@ name=true]{% % \begin{macrocode} \expandafter\protected@xdef\csname glo@#1@index\endcsname{% (\string"\@glo@sort\string" % - \string"\@glo@prefix\@glossaryentryfield{\@glo@label}\string") % + \string"\@glo@prefix\@glossaryentryfield{\@glo@esclabel}\string") % }% \else % \end{macrocode} @@ -5006,7 +5180,7 @@ name=true]{% \csname glo@\@glo@parent @index\endcsname (\string"\@glo@sort\string" % \string"\@glo@prefix\@glossarysubentryfield - {\csname glo@#1@level\endcsname}{\@glo@label}\string") % + {\csname glo@#1@level\endcsname}{\@glo@esclabel}\string") % }% \fi \else @@ -5023,7 +5197,7 @@ name=true]{% % \begin{macrocode} \expandafter\protected@xdef\csname glo@#1@index\endcsname{% \@glo@sort\@gls@actualchar\@glo@prefix - \@glossaryentryfield{\@glo@label}% + \@glossaryentryfield{\@glo@esclabel}% }% \else % \end{macrocode} @@ -5033,7 +5207,7 @@ name=true]{% \csname glo@\@glo@parent @index\endcsname\@gls@levelchar \@glo@sort\@gls@actualchar\@glo@prefix \@glossarysubentryfield - {\csname glo@#1@level\endcsname}{\@glo@label}% + {\csname glo@#1@level\endcsname}{\@glo@esclabel}% }% \fi \fi @@ -5072,13 +5246,14 @@ name=true]{% % The command \cs{glsreset}\marg{label} can be used % to set the entry flag to indicate that it hasn't been used yet. The % required argument is the entry label. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glsreset}[1]{% \gls@ifnotmeasuring {% \glsdoifexists{#1}% {% - \expandafter\global\csname glo@#1@flagfalse\endcsname + \expandafter\global\csname glo@\glsdetoklabel{#1}@flagfalse\endcsname }% }% } @@ -5087,13 +5262,14 @@ name=true]{% % %\begin{macro}{\glslocalreset} % As above, but with only a local effect: +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glslocalreset}[1]{% \gls@ifnotmeasuring {% \glsdoifexists{#1}% {% - \expandafter\let\csname ifglo@#1@flag\endcsname\iffalse + \expandafter\let\csname ifglo@\glsdetoklabel{#1}@flag\endcsname\iffalse }% }% } @@ -5103,13 +5279,14 @@ name=true]{% % The command \cs{glsunset}\marg{label} can be used to % set the entry flag to indicate that it has been used. The required % argument is the entry label. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glsunset}[1]{% \gls@ifnotmeasuring {% \glsdoifexists{#1}% {% - \expandafter\global\csname glo@#1@flagtrue\endcsname + \expandafter\global\csname glo@\glsdetoklabel{#1}@flagtrue\endcsname }% }% } @@ -5118,13 +5295,14 @@ name=true]{% % %\begin{macro}{\glslocalunset} % As above, but with only a local effect: +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glslocalunset}[1]{% \gls@ifnotmeasuring {% \glsdoifexists{#1}% {% - \expandafter\let\csname ifglo@#1@flag\endcsname\iftrue + \expandafter\let\csname ifglo@\glsdetoklabel{#1}@flag\endcsname\iftrue }% }% } @@ -5906,7 +6084,7 @@ name=true]{% % number. % \begin{macrocode} \define@key{glslink}{format}{% -\def\@glsnumberformat{#1}} + \def\@glsnumberformat{#1}} % \end{macrocode} % The \gloskey[glslink]{hyper} key is a boolean key, it can either have the % value true or false, and indicates whether or not to make a @@ -5988,18 +6166,28 @@ name=true]{% % Inserting \cs{leavevmode} suggested by Donald~Arseneau (avoids % problem with tabularx). %\changes{2.03}{2009 Sep 23}{added \cs{leavevmode}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \leavevmode - \def\glslabel{#2}% + \edef\glslabel{\glsdetoklabel{#2}}% +% \end{macrocode} +% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} +%\changes{4.03}{2014-01-20}{moved \cs{@gls@link@opts} and +%\cs{@gls@link@label} to \cs{@gls@link}} +% \begin{macrocode} + \def\@gls@link@opts{#1}% + \let\@gls@link@label\glslabel +% \end{macrocode} +% \begin{macrocode} \def\@glsnumberformat{glsnumberformat}% - \edef\@gls@counter{\csname glo@#2@counter\endcsname}% + \edef\@gls@counter{\csname glo@\glslabel @counter\endcsname}% % \end{macrocode} %\changes{3.05}{2013-04-21}{added check for ``nohypertypes''}% %\changes{3.07}{2013-07-05}{fixed bug that failed to find entry in list}% % If this is in one of the ``nohypertypes'' glossaries, suppress the % hyperlink by default % \begin{macrocode} - \edef\gls@type{\csname glo@#2@type\endcsname}% + \edef\gls@type{\csname glo@\glslabel @type\endcsname}% \expandafter\DTLifinlist\expandafter {\gls@type}{\@gls@nohyperlist}% {% @@ -6018,14 +6206,15 @@ name=true]{% %\changes{3.0}{2011/04/02}{added \cs{@gls@setsort}} % Define sort key if necessary: % \begin{macrocode} - \@gls@setsort{#2}% + \@gls@setsort{\glslabel}% % \end{macrocode} %\changes{2.01}{2009 May 30}{moved \cs{@do@wrglossary} before term is displayed % to prevent unwanted whatsit} +% (De-tok'ing done by \cs{@@do@wrglossary}) % \begin{macrocode} \@do@wrglossary{#2}% \ifKV@glslink@hyper - \@glslink{\glolinkprefix#2}{\glstextformat{#3}}% + \@glslink{\glolinkprefix\glslabel}{\glstextformat{#3}}% \else % \end{macrocode} %\changes{3.13a}{2013-11-05}{removed \cs{relax}} @@ -6208,7 +6397,7 @@ name=true]{% } % \end{macrocode} %\end{macro} -% Catch special characters\mkidxspch (argument must be a +% Catch special characters\mkidxspch\ (argument must be a % control sequence): %\begin{macro}{\@gls@checkmkidxchars} % \begin{macrocode} @@ -6677,15 +6866,11 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% -% \end{macrocode} %\changes{3.11a}{2013-10-15}{add \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glscustomtext\@empty @@ -6770,12 +6955,8 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} @@ -6863,15 +7044,11 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@thirdofthree \let\glscustomtext\@empty @@ -6954,15 +7131,11 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@firstoftwo \let\glscapscase\@firstofthree \let\glscustomtext\@empty @@ -7049,12 +7222,8 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} @@ -7146,15 +7315,11 @@ name=true]{% {% \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@firstoftwo \let\glscapscase\@thirdofthree \let\glscustomtext\@empty @@ -7244,15 +7409,11 @@ name=true]{% % \begin{macrocode} \edef\@glo@type{\glsentrytype{#2}}% % \end{macrocode} -% Save options in \cs{@gls@link@opts} and label in \cs{@gls@link@label} -% \begin{macrocode} - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% -% \end{macrocode} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} %\changes{3.11a}{2013-10-15}{add \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glscustomtext} and \cs{glsinsert}} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \def\glscustomtext{#3}% @@ -7306,6 +7467,19 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@field@link} +%\changes{4.03}{2014-01-20}{new} +% \begin{macrocode} +\newcommand{\@gls@field@link}[3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% + \@gls@link[#1]{#2}{#3}% + }% +} +% \end{macrocode} +%\end{macro} +% % \cs{glstext} behaves like \ics{gls} except it always uses the value % given by the \gloskey{text} key and it doesn't mark the entry as % used. @@ -7326,18 +7500,11 @@ name=true]{% \new@ifnextchar[{\@glstext@{#1}{#2}}{\@glstext@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glstext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentrytext}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentrytext{#2}#3}% - }% +\def\@glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentrytext{#2}#3}% } % \end{macrocode} % @@ -7359,17 +7526,10 @@ name=true]{% \new@ifnextchar[{\@GLStext@{#1}{#2}}{\@GLStext@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLStext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrytext{#2}#3}}% - }% +\def\@GLStext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrytext{#2}#3}}% } % \end{macrocode} % @@ -7392,18 +7552,11 @@ name=true]{% \new@ifnextchar[{\@Glstext@{#1}{#2}}{\@Glstext@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glstext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{Changed to just use \cs{Glsentrytext}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentrytext{#2}#3}% - }% +\def\@Glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentrytext{#2}#3}% } % \end{macrocode} % @@ -7427,18 +7580,11 @@ name=true]{% \new@ifnextchar[{\@glsfirst@{#1}{#2}}{\@glsfirst@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryfirst}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryfirst{#2}#3}% - }% +\def\@glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryfirst{#2}#3}% } % \end{macrocode} % @@ -7460,17 +7606,11 @@ name=true]{% \new@ifnextchar[{\@Glsfirst@{#1}{#2}}{\@Glsfirst@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryfirst}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryfirst{#2}#3}}% +\def\@Glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryfirst{#2}#3}% } % \end{macrocode} % @@ -7492,19 +7632,11 @@ name=true]{% \new@ifnextchar[{\@GLSfirst@{#1}{#2}}{\@GLSfirst@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Determine what the link text should be (this is stored in -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryfirst}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryfirst{#2}#3}}% - }% +\def\@GLSfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryfirst{#2}#3}}% } % \end{macrocode} % @@ -7527,18 +7659,11 @@ name=true]{% \new@ifnextchar[{\@glsplural@{#1}{#2}}{\@glsplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryplural{#2}#3}% - }% +\def\@glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryplural{#2}#3}% } % \end{macrocode} % @@ -7560,18 +7685,11 @@ name=true]{% \new@ifnextchar[{\@Glsplural@{#1}{#2}}{\@Glsplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryplural{#2}#3}% - }% +\def\@Glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryplural{#2}#3}% } % \end{macrocode} % @@ -7594,18 +7712,11 @@ name=true]{% \new@ifnextchar[{\@GLSplural@{#1}{#2}}{\@GLSplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryplural{#2}#3}}% - }% +\def\@GLSplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryplural{#2}#3}}% } % \end{macrocode} % @@ -7629,19 +7740,12 @@ name=true]{% \new@ifnextchar[{\@glsfirstplural@{#1}{#2}}{\@glsfirstplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentryfirstplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryfirstplural{#2}#3}% - }% +\def\@glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryfirstplural{#2}#3}% } % \end{macrocode} % @@ -7664,19 +7768,12 @@ name=true]{% \new@ifnextchar[{\@Glsfirstplural@{#1}{#2}}{\@Glsfirstplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{Glsentryfirstplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryfirstplural{#2}#3}% - }% +\def\@Glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryfirstplural{#2}#3}% } % \end{macrocode} % @@ -7699,19 +7796,12 @@ name=true]{% \new@ifnextchar[{\@GLSfirstplural@{#1}{#2}}{\@GLSfirstplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentryfirstplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryfirstplural{#2}#3}}% - }% +\def\@GLSfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryfirstplural{#2}#3}}% } % \end{macrocode} % @@ -7735,18 +7825,11 @@ name=true]{% \new@ifnextchar[{\@glsname@{#1}{#2}}{\@glsname@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryname}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryname{#2}#3}% - }% +\def\@glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryname{#2}#3}% } % \end{macrocode} % @@ -7769,18 +7852,11 @@ name=true]{% \new@ifnextchar[{\@Glsname@{#1}{#2}}{\@Glsname@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryname}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryname{#2}#3}% - }% +\def\@Glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryname{#2}#3}% } % \end{macrocode} % @@ -7803,18 +7879,11 @@ name=true]{% \new@ifnextchar[{\@GLSname@{#1}{#2}}{\@GLSname@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryname}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryname{#2}#3}}% - }% +\def\@GLSname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryname{#2}#3}}% } % \end{macrocode} % @@ -7838,18 +7907,11 @@ name=true]{% \new@ifnextchar[{\@glsdesc@{#1}{#2}}{\@glsdesc@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentrydesc}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentrydesc{#2}#3}% - }% +\def\@glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentrydesc{#2}#3}% } % \end{macrocode} % @@ -7872,18 +7934,11 @@ name=true]{% \new@ifnextchar[{\@Glsdesc@{#1}{#2}}{\@Glsdesc@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentrydesc}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentrydesc{#2}#3}% - }% +\def\@Glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentrydesc{#2}#3}% } % \end{macrocode} % @@ -7906,18 +7961,11 @@ name=true]{% \new@ifnextchar[{\@GLSdesc@{#1}{#2}}{\@GLSdesc@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentrydesc}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrydesc{#2}#3}}% - }% +\def\@GLSdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrydesc{#2}#3}}% } % \end{macrocode} % @@ -7941,19 +7989,12 @@ name=true]{% \new@ifnextchar[{\@glsdescplural@{#1}{#2}}{\@glsdescplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentrydescplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentrydescplural{#2}#3}% - }% +\def\@glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentrydescplural{#2}#3}% } % \end{macrocode} % @@ -7976,19 +8017,12 @@ name=true]{% \new@ifnextchar[{\@Glsdescplural@{#1}{#2}}{\@Glsdescplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{Glsentrydescplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentrydescplural{#2}#3}% - }% +\def\@Glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentrydescplural{#2}#3}% } % \end{macrocode} % @@ -8011,19 +8045,12 @@ name=true]{% \new@ifnextchar[{\@GLSdescplural@{#1}{#2}}{\@GLSdescplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} % \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentrydescplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrydescplural{#2}#3}}% - }% +\def\@GLSdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrydescplural{#2}#3}}% } % \end{macrocode} % @@ -8047,18 +8074,11 @@ name=true]{% \new@ifnextchar[{\@glssymbol@{#1}{#2}}{\@glssymbol@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glssymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentrysymbol}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentrysymbol{#2}#3}% - }% +\def\@glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentrysymbol{#2}#3}% } % \end{macrocode} % @@ -8081,18 +8101,11 @@ name=true]{% \new@ifnextchar[{\@Glssymbol@{#1}{#2}}{\@Glssymbol@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glssymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentrysymbol}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentrysymbol{#2}#3}% - }% +\def\@Glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentrysymbol{#2}#3}% } % \end{macrocode} % @@ -8115,18 +8128,11 @@ name=true]{% \new@ifnextchar[{\@GLSsymbol@{#1}{#2}}{\@GLSsymbol@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSsymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentrysymbol}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrysymbol{#2}#3}}% - }% +\def\@GLSsymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrysymbol{#2}#3}}% } % \end{macrocode} % @@ -8150,19 +8156,12 @@ name=true]{% \new@ifnextchar[{\@glssymbolplural@{#1}{#2}}{\@glssymbolplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glssymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentrysymbolplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentrysymbolplural{#2}#3}% - }% +\def\@glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentrysymbolplural{#2}#3}% } % \end{macrocode} % @@ -8185,19 +8184,12 @@ name=true]{% \new@ifnextchar[{\@Glssymbolplural@{#1}{#2}}{\@Glssymbolplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glssymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{Glsentrysymbolplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentrysymbolplural{#2}#3}% - }% +\def\@Glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentrysymbolplural{#2}#3}% } % \end{macrocode} % @@ -8220,18 +8212,12 @@ name=true]{% \new@ifnextchar[{\@GLSsymbolplural@{#1}{#2}}{\@GLSsymbolplural@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSsymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% \changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} +%\changes{1.13}{2008 May 10}{fixed bug that ignored 3rd parameter} %\changes{3.11a}{2013-10-15}{changed to just use %\cs{glsentrysymbolplural}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}#3}}% - }% +\def\@GLSsymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}#3}}% } % \end{macrocode} % @@ -8255,17 +8241,10 @@ name=true]{% \new@ifnextchar[{\@glsuseri@{#1}{#2}}{\@glsuseri@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseri}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuseri{#2}#3}% - }% +\def\@glsuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuseri{#2}#3}% } % \end{macrocode} % @@ -8288,17 +8267,10 @@ name=true]{% \new@ifnextchar[{\@Glsuseri@{#1}{#2}}{\@Glsuseri@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuseri}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuseri{#2}#3}% - }% +\def\@Glsuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuseri{#2}#3}% } % \end{macrocode} % @@ -8321,17 +8293,10 @@ name=true]{% \new@ifnextchar[{\@GLSuseri@{#1}{#2}}{\@GLSuseri@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseri}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseri{#2}#3}}% - }% +\def\@GLSuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseri{#2}#3}}% } % \end{macrocode} % @@ -8355,17 +8320,10 @@ name=true]{% \new@ifnextchar[{\@glsuserii@{#1}{#2}}{\@glsuserii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuserii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuserii{#2}#3}% - }% +\def\@glsuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuserii{#2}#3}% } % \end{macrocode} % @@ -8388,17 +8346,10 @@ name=true]{% \new@ifnextchar[{\@Glsuserii@{#1}{#2}}{\@Glsuserii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuserii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuserii{#2}#3}% - }% +\def\@Glsuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuserii{#2}#3}% } % \end{macrocode} % @@ -8421,17 +8372,10 @@ name=true]{% \new@ifnextchar[{\@GLSuserii@{#1}{#2}}{\@GLSuserii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuserii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuserii{#2}#3}}% - }% +\def\@GLSuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuserii{#2}#3}}% } % \end{macrocode} % @@ -8455,17 +8399,10 @@ name=true]{% \new@ifnextchar[{\@glsuseriii@{#1}{#2}}{\@glsuseriii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseriii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuseriii{#2}#3}% - }% +\def\@glsuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuseriii{#2}#3}% } % \end{macrocode} % @@ -8488,17 +8425,10 @@ name=true]{% \new@ifnextchar[{\@Glsuseriii@{#1}{#2}}{\@Glsuseriii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuseriii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuseriii{#2}#3}% - }% +\def\@Glsuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuseriii{#2}#3}% } % \end{macrocode} % @@ -8521,17 +8451,10 @@ name=true]{% \new@ifnextchar[{\@GLSuseriii@{#1}{#2}}{\@GLSuseriii@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseriii}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseriii{#2}#3}}% - }% +\def\@GLSuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseriii{#2}#3}}% } % \end{macrocode} % @@ -8555,16 +8478,10 @@ name=true]{% \new@ifnextchar[{\@glsuseriv@{#1}{#2}}{\@glsuseriv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseriv}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuseriv{#2}#3}% - }% +\def\@glsuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuseriv{#2}#3}% } % \end{macrocode} % @@ -8587,17 +8504,10 @@ name=true]{% \new@ifnextchar[{\@Glsuseriv@{#1}{#2}}{\@Glsuseriv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuseriv}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuseriv{#2}#3}% - }% +\def\@Glsuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuseriv{#2}#3}% } % \end{macrocode} % @@ -8620,18 +8530,11 @@ name=true]{% \new@ifnextchar[{\@GLSuseriv@{#1}{#2}}{\@GLSuseriv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: +%\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseriv}} % \begin{macrocode} \def\@GLSuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} -%\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuseriv}} -% \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseriv{#2}#3}}% - }% -} + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseriv{#2}#3}}% +} % \end{macrocode} % % \cs{glsuserv} behaves like \ics{gls} except it always uses the value @@ -8654,17 +8557,10 @@ name=true]{% \new@ifnextchar[{\@glsuserv@{#1}{#2}}{\@glsuserv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuserv}} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuserv{#2}#3}% - }% +\def\@glsuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuserv{#2}#3}% } % \end{macrocode} % @@ -8687,17 +8583,10 @@ name=true]{% \new@ifnextchar[{\@Glsuserv@{#1}{#2}}{\@Glsuserv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuserv}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuserv{#2}#3}% - }% +\def\@Glsuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuserv{#2}#3}% } % \end{macrocode} % @@ -8720,17 +8609,10 @@ name=true]{% \new@ifnextchar[{\@GLSuserv@{#1}{#2}}{\@GLSuserv@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuserv}} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuserv{#2}#3}}% - }% +\def\@GLSuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuserv{#2}#3}}% } % \end{macrocode} % @@ -8754,17 +8636,10 @@ name=true]{% \new@ifnextchar[{\@glsuservi@{#1}{#2}}{\@glsuservi@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@glsuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuservi}} -% Call \cs{@gls@link} % \begin{macrocode} - \@gls@link[#1]{#2}{\glsentryuservi{#2}#3}% - }% +\def\@glsuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsentryuservi{#2}#3}% } % \end{macrocode} % @@ -8787,17 +8662,10 @@ name=true]{% \new@ifnextchar[{\@Glsuservi@{#1}{#2}}{\@Glsuservi@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@Glsuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} -% Call \cs{@gls@link} %\changes{3.11a}{2013-10-15}{changed to just use \cs{Glsentryuservi}} % \begin{macrocode} - \@gls@link[#1]{#2}{\Glsentryuservi{#2}#3}% - }% +\def\@Glsuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\Glsentryuservi{#2}#3}% } % \end{macrocode} % @@ -8820,17 +8688,10 @@ name=true]{% \new@ifnextchar[{\@GLSuservi@{#1}{#2}}{\@GLSuservi@{#1}{#2}[]}} % \end{macrocode} % Read in the final optional argument: -% \begin{macrocode} -\def\@GLSuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% -% \end{macrocode} %\changes{3.11a}{2013-10-15}{changed to just use \cs{glsentryuservi}} -% Call \cs{@gls@link} % \begin{macrocode} - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuservi{#2}#3}}% - }% +\def\@GLSuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuservi{#2}#3}}% } % \end{macrocode} % @@ -8864,8 +8725,9 @@ name=true]{% % \end{macrocode} %\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, % \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} % \begin{macrocode} - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -9414,6 +9276,33 @@ name=true]{% % These commands merely display entry information without adding % entries in the associated file or having hyperlinks. % +%\begin{macro}{\@gls@entry@field} +% Generic version. +%\changes{4.03}{2014-01-20}{new} +%\begin{definition} +%\cs{@gls@entry@field}\marg{label}\marg{field} +%\end{definition} +% \begin{macrocode} +\newcommand*{\@gls@entry@field}[2]{% + \csname glo@\glsdetoklabel{#1}@#2\endcsname +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Gls@entry@field} +% Generic first letter uppercase version. +%\changes{4.03}{2014-01-20}{new} +%\begin{definition} +%\cs{@Gls@entry@field}\marg{label}\marg{field} +%\end{definition} +% \begin{macrocode} +\newcommand*{\@Gls@entry@field}[2]{% + \letcs\@glo@text{glo@\glsdetoklabel{#1}@#2}% + \xmakefirstuc{\@glo@text}% +} +% \end{macrocode} +%\end{macro} +% % Get the entry name (as specified by the \gloskey{name} key % when the entry was defined). The argument % is the label associated with the entry. Note that unless you @@ -9422,15 +9311,14 @@ name=true]{% % any commands. %\begin{macro}{\glsentryname} % \begin{macrocode} -\newcommand*{\glsentryname}[1]{\csname glo@#1@name\endcsname} +\newcommand*{\glsentryname}[1]{\@gls@entry@field{#1}{name}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryname} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryname}[1]{% - \protected@edef\@glo@text{\csname glo@#1@name\endcsname}% - \expandafter\makefirstuc\expandafter{\@glo@text}% + \@Gls@entry@field{#1}{name}% } % \end{macrocode} %\end{macro} @@ -9443,15 +9331,14 @@ name=true]{% % key contained any commands. %\begin{macro}{\glsentrydesc} % \begin{macrocode} -\newcommand*{\glsentrydesc}[1]{\csname glo@#1@desc\endcsname} +\newcommand*{\glsentrydesc}[1]{\@gls@entry@field{#1}{desc}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrydesc} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrydesc}[1]{% - \protected@edef\@glo@text{\csname glo@#1@desc\endcsname}% - \expandafter\makefirstuc\expandafter{\@glo@text}% + \@Gls@entry@field{#1}{desc}% } % \end{macrocode} %\end{macro} @@ -9460,7 +9347,8 @@ name=true]{% %\changes{1.12}{2008 Mar 8}{New} % \begin{macrocode} \newcommand*{\glsentrydescplural}[1]{% - \csname glo@#1@descplural\endcsname} + \@gls@entry@field{#1}{descplural}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrydescplural} @@ -9468,8 +9356,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrydescplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@descplural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{descplural}% +} % \end{macrocode} %\end{macro} % @@ -9478,49 +9366,50 @@ name=true]{% % is the label associated with the entry: %\begin{macro}{\glsentrytext} % \begin{macrocode} -\newcommand*{\glsentrytext}[1]{\csname glo@#1@text\endcsname} +\newcommand*{\glsentrytext}[1]{\@gls@entry@field{#1}{text}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrytext} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrytext}[1]{% - \protected@edef\@glo@text{\csname glo@#1@text\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{text}% +} % \end{macrocode} %\end{macro} % % Get the plural form: %\begin{macro}{\glsentryplural} % \begin{macrocode} -\newcommand*{\glsentryplural}[1]{\csname glo@#1@plural\endcsname} +\newcommand*{\glsentryplural}[1]{% + \@gls@entry@field{#1}{plural}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryplural} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@plural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{plural}% +} % \end{macrocode} %\end{macro} % % Get the symbol associated with this entry. The argument -% is the label associated with the entry. Note that unless you -% used \texttt{symbol=false} in the \pkgopt{sanitize} package -% option you may get unexpected results if the \gloskey{symbol} -% key contained any commands. +% is the label associated with the entry. %\begin{macro}{\glsentrysymbol} % \begin{macrocode} -\newcommand*{\glsentrysymbol}[1]{\csname glo@#1@symbol\endcsname} +\newcommand*{\glsentrysymbol}[1]{% + \@gls@entry@field{#1}{symbol}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrysymbol} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrysymbol}[1]{% -\protected@edef\@glo@text{\csname glo@#1@symbol\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{symbol}% +} % \end{macrocode} %\end{macro} % Plural form: @@ -9528,7 +9417,8 @@ name=true]{% %\changes{1.12}{2008 Mar 8}{New} % \begin{macrocode} \newcommand*{\glsentrysymbolplural}[1]{% - \csname glo@#1@symbolplural\endcsname} + \@gls@entry@field{#1}{symbolplural}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrysymbolplural} @@ -9536,8 +9426,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrysymbolplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@symbolplural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{symbolplural}% +} % \end{macrocode} %\end{macro} % @@ -9546,32 +9436,36 @@ name=true]{% % the entry was defined). %\begin{macro}{\glsentryfirst} % \begin{macrocode} -\newcommand*{\glsentryfirst}[1]{\csname glo@#1@first\endcsname} +\newcommand*{\glsentryfirst}[1]{% + \@gls@entry@field{#1}{first}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryfirst} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryfirst}[1]{% -\protected@edef\@glo@text{\csname glo@#1@first\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{first}% +} % \end{macrocode} %\end{macro} % % Get the plural form (as specified by the \gloskey{firstplural} % key when the entry was defined). %\begin{macro}{\glsentryfirstplural} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glsentryfirstplural}[1]{% - \csname glo@#1@firstpl\endcsname} + \@gls@entry@field{#1}{firstpl}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryfirstplural} %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryfirstplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@firstpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{firstpl}% +} % \end{macrocode} %\end{macro} % @@ -9580,7 +9474,7 @@ name=true]{% % defined) %\begin{macro}{\glsentrytype} % \begin{macrocode} -\newcommand*{\glsentrytype}[1]{\csname glo@#1@type\endcsname} +\newcommand*{\glsentrytype}[1]{\@gls@entry@field{#1}{type}} % \end{macrocode} %\end{macro} % @@ -9589,7 +9483,9 @@ name=true]{% % occur if the \gloskey{sort} key contained commands. %\begin{macro}{\glsentrysort} % \begin{macrocode} -\newcommand*{\glsentrysort}[1]{\csname glo@#1@sort\endcsname} +\newcommand*{\glsentrysort}[1]{% + \@gls@entry@field{#1}{sort}% +} % \end{macrocode} %\end{macro} % @@ -9599,7 +9495,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuseri}[1]{\csname glo@#1@useri\endcsname} +\newcommand*{\glsentryuseri}[1]{% + \@gls@entry@field{#1}{useri}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuseri} @@ -9607,8 +9505,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuseri}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useri\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{useri}% +} % \end{macrocode} %\end{macro} % @@ -9618,7 +9516,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuserii}[1]{\csname glo@#1@userii\endcsname} +\newcommand*{\glsentryuserii}[1]{% + \@gls@entry@field{#1}{userii}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuserii} @@ -9626,8 +9526,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuserii}[1]{% -\protected@edef\@glo@text{\csname glo@#1@userii\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{userii}% +} % \end{macrocode} %\end{macro} % @@ -9637,7 +9537,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuseriii}[1]{\csname glo@#1@useriii\endcsname} +\newcommand*{\glsentryuseriii}[1]{% + \@gls@entry@field{#1}{useriii}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuseriii} @@ -9645,8 +9547,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuseriii}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useriii\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{useriii}% +} % \end{macrocode} %\end{macro} % @@ -9656,7 +9558,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuseriv}[1]{\csname glo@#1@useriv\endcsname} +\newcommand*{\glsentryuseriv}[1]{% + \@gls@entry@field{#1}{useriv}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuseriv} @@ -9664,8 +9568,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuseriv}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useriv\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{useriv}% +} % \end{macrocode} %\end{macro} % @@ -9675,7 +9579,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuserv}[1]{\csname glo@#1@userv\endcsname} +\newcommand*{\glsentryuserv}[1]{% + \@gls@entry@field{#1}{userv}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuserv} @@ -9683,8 +9589,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuserv}[1]{% -\protected@edef\@glo@text{\csname glo@#1@userv\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{userv}% +} % \end{macrocode} %\end{macro} % @@ -9694,7 +9600,9 @@ name=true]{% % is the label associated with the entry. %\changes{2.04}{2009 November 10}{new} % \begin{macrocode} -\newcommand*{\glsentryuservi}[1]{\csname glo@#1@uservi\endcsname} +\newcommand*{\glsentryuservi}[1]{% + \@gls@entry@field{#1}{uservi}% +} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryuservi} @@ -9702,8 +9610,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryuservi}[1]{% -\protected@edef\@glo@text{\csname glo@#1@uservi\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{uservi}% +} % \end{macrocode} %\end{macro} % @@ -9713,7 +9621,7 @@ name=true]{% % is the label associated with the entry. %\changes{3.0}{2011/04/02}{new} % \begin{macrocode} -\newcommand*{\glsentryshort}[1]{\csname glo@#1@short\endcsname} +\newcommand*{\glsentryshort}[1]{\@gls@entry@field{#1}{short}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryshort} @@ -9721,8 +9629,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryshort}[1]{% -\protected@edef\@glo@text{\csname glo@#1@short\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{short}% +} % \end{macrocode} %\end{macro} % @@ -9732,7 +9640,7 @@ name=true]{% % is the label associated with the entry. %\changes{3.0}{2011/04/02}{new} % \begin{macrocode} -\newcommand*{\glsentryshortpl}[1]{\csname glo@#1@shortpl\endcsname} +\newcommand*{\glsentryshortpl}[1]{\@gls@entry@field{#1}{shortpl}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryshortpl} @@ -9740,8 +9648,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentryshortpl}[1]{% -\protected@edef\@glo@text{\csname glo@#1@shortpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{shortpl}% +} % \end{macrocode} %\end{macro} % @@ -9751,7 +9659,7 @@ name=true]{% % is the label associated with the entry. %\changes{3.0}{2011/04/02}{new} % \begin{macrocode} -\newcommand*{\glsentrylong}[1]{\csname glo@#1@long\endcsname} +\newcommand*{\glsentrylong}[1]{\@gls@entry@field{#1}{long}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrylong} @@ -9759,8 +9667,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrylong}[1]{% - \protected@edef\@glo@text{\csname glo@#1@long\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{long}% +} % \end{macrocode} %\end{macro} % @@ -9770,7 +9678,7 @@ name=true]{% % is the label associated with the entry. %\changes{3.0}{2011/04/02}{new} % \begin{macrocode} -\newcommand*{\glsentrylongpl}[1]{\csname glo@#1@longpl\endcsname} +\newcommand*{\glsentrylongpl}[1]{\@gls@entry@field{#1}{longpl}} % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentrylongpl} @@ -9778,8 +9686,8 @@ name=true]{% %\changes{3.09a}{2013-10-09}{made robust} % \begin{macrocode} \newrobustcmd*{\Glsentrylongpl}[1]{% -\protected@edef\@glo@text{\csname glo@#1@longpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{longpl}% +} % \end{macrocode} %\end{macro} % @@ -9834,7 +9742,7 @@ name=true]{% \newcommand*{\glsentrynumberlist}[1]{% \glsdoifexists{#1}% {% - \csname glo@#1@numberlist\endcsname + \@gls@entry@field{#1}{numberlist}% }% } % \end{macrocode} @@ -9861,10 +9769,14 @@ name=true]{% \glsdoifexists{#1}% {% \bgroup - \def\@glo@label{#1}% +% \end{macrocode} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +% \begin{macrocode} + \edef\@glo@label{\glsdetoklabel{#1}}% \let\@org@glsnumberformat\glsnumberformat \def\glsnumberformat##1{##1}% - \protected@edef\the@numberlist{\csname glo@\@glo@label @numberlist\endcsname}% + \protected@edef\the@numberlist{% + \csname glo@\@glo@label @numberlist\endcsname}% \def\@gls@numlist@sep{}% \def\@gls@numlist@nextsep{}% \def\@gls@numlist@lastsep{}% @@ -9916,10 +9828,11 @@ name=true]{% %\changes{1.17}{2008 December 26}{new} %\changes{3.0}{2011/04/02}{changed default from \cs{glsentryname} %to \cs{glsentrytext}} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glshyperlink}[2][\glsentrytext{\@glo@label}]{% -\def\@glo@label{#2}% -\@glslink{\glolinkprefix#2}{#1}} + \def\@glo@label{#2}% + \@glslink{\glolinkprefix\glsdetoklabel{#2}}{#1}} % \end{macrocode} %\end{macro} % @@ -9952,12 +9865,13 @@ name=true]{% %\changes{1.07}{2007 Sep 13}{fixed bug caused by \cs{theglsentrycounter} setting the page number too soon} %\changes{2.04}{2009 November 10}{fixed bug that ignored counter} %\changes{3.01}{2011/04/12}{made robust} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newrobustcmd*{\glsadd}[2][]{% \glsdoifexists{#2}% {% \def\@glsnumberformat{glsnumberformat}% - \edef\@gls@counter{\csname glo@#2@counter\endcsname}% + \edef\@gls@counter{\csname glo@\glsdetoklabel{#2}@counter\endcsname}% \setkeys{glossadd}{#1}% % \end{macrocode} % Store the entry's counter in \cs{theglsentrycounter} @@ -10884,6 +10798,11 @@ you \@do@gls@getcounterprefix \fi % \end{macrocode} +% De-tok label if required +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +% \begin{macrocode} + \edef\@gls@label{\glsdetoklabel{#1}}% +% \end{macrocode} % Determine whether to use \app{xindy} or \app{makeindex} % syntax % \begin{macrocode} @@ -10904,8 +10823,8 @@ you % \end{macrocode} % Write to the glossary file using \app{xindy} syntax. % \begin{macrocode} - \glossary[\csname glo@#1@type\endcsname]{% - (indexentry :tkey (\csname glo@#1@index\endcsname) + \glossary[\csname glo@\@gls@label @type\endcsname]{% + (indexentry :tkey (\csname glo@\@gls@label @index\endcsname) % \end{macrocode} %\changes{3.02}{2012/05/21}{changed \cs{@glslocref} to \cs{theglsentrycounter}} %\changes{3.04}{2012-11-18}{changed \cs{theglsentrycounter} back to \cs{@glslocref}} @@ -10925,8 +10844,8 @@ you % \end{macrocode} % Write to the glossary file using \app{makeindex} syntax. % \begin{macrocode} - \glossary[\csname glo@#1@type\endcsname]{% - \string\glossaryentry{\csname glo@#1@index\endcsname + \glossary[\csname glo@\@gls@label @type\endcsname]{% + \string\glossaryentry{\csname glo@\@gls@label @index\endcsname \@gls@encapchar\@glo@numfmt}{\@glslocref}}% \fi } @@ -11055,9 +10974,12 @@ you \@gls@donext \fi % \end{macrocode} -% display the entry for this label +% Display the entry for this label. +% (Expanding label as it's a temporary control sequence that's used +% elsewhere.) +%\changes{4.03}{2014-01-20}{added \cs{expandafter} commands} % \begin{macrocode} - \glsseeitem{\@gls@thislabel}% + \expandafter\glsseeitem\expandafter{\@gls@thislabel}% % \end{macrocode} % Update separators % \begin{macrocode} @@ -11232,22 +11154,25 @@ you \@glossarystyle % \end{macrocode} %\changes{3.02}{2012/05/21}{add a way to fetch current entry label} -% added a way to fetch the current entry label (v3.08 updated for -% new \cs{glossentry} and \cs{subglossentry}): +% Added a way to fetch the current entry label (v3.08 updated for +% new \cs{glossentry} and \cs{subglossentry}, but this is now only +% needed for backward compatibility): +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \let\gls@org@glossaryentryfield\glossentry \let\gls@org@glossarysubentryfield\subglossentry \renewcommand{\glossentry}[1]{% - \gdef\glscurrententrylabel{##1}% + \xdef\glscurrententrylabel{\glsdetoklabel{##1}}% \gls@org@glossaryentryfield{##1}% }% \renewcommand{\subglossentry}[2]{% - \gdef\glscurrententrylabel{##2}% + \xdef\glscurrententrylabel{\glsdetoklabel{##2}}% \gls@org@glossarysubentryfield{##1}{##2}% }% % \end{macrocode} % Some macros may end up being expanded into internals in the -% glossary, so need to make @ a letter. +% glossary, so need to make @ a letter. (Unlikely to be a problem +% since v3.08a but kept for backward compatibility.) % \begin{macrocode} \makeatletter % \end{macrocode} @@ -11555,11 +11480,12 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.0}{2011/04/02}{new} % Advance the \ctr{glossaryentry} counter if in use. The argument is % the label associated with the entry. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \ifglsentrycounter \newcommand*{\glsstepentry}[1]{% \refstepcounter{glossaryentry}% - \label{glsentry-#1}% + \label{glsentry-\glsdetoklabel{#1}}% } \else \newcommand*{\glsstepentry}[1]{} @@ -11571,12 +11497,13 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.0}{2011/04/02}{new} % Advance the \ctr{glossarysubentry} counter if in use. The argument is % the label associated with the subentry. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \ifglssubentrycounter \newcommand*{\glsstepsubentry}[1]{% - \def\currentglssubentry{#1}% + \edef\currentglssubentry{\glsdetoklabel{#1}}% \refstepcounter{glossarysubentry}% - \label{glsentry-#1}% + \label{glsentry-\currentglssubentry}% } \else \newcommand*{\glsstepsubentry}[1]{} @@ -11588,12 +11515,13 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.0}{2011/04/02}{new} % Reference the entry or sub-entry counter if in use, otherwise just do % \ics{gls}. +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \ifglsentrycounter - \newcommand*{\glsrefentry}[1]{\ref{glsentry-#1}} + \newcommand*{\glsrefentry}[1]{\ref{glsentry-\glsdetoklabel{#1}}} \else \ifglssubentrycounter - \newcommand*{\glsrefentry}[1]{\ref{glsentry-#1}} + \newcommand*{\glsrefentry}[1]{\ref{glsentry-\glsdetoklabel{#1}}} \else \newcommand*{\glsrefentry}[1]{\gls{#1}} \fi @@ -11721,11 +11649,12 @@ false,nolabel,autolabel,nameref}[nolabel]{% % %\begin{macro}{\glossentryname} %\changes{3.08a}{2013-09-28}{new} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\glossentryname}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% - \letcs{\glo@name}{glo@#1@name}% + \letcs{\glo@name}{glo@\glsdetoklabel{#1}@name}% \expandafter\glsnamefont\expandafter{\glo@name}% }% } @@ -11736,7 +11665,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.08a}{2013-09-28}{new} % \begin{macrocode} \newcommand*{\Glossentryname}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsnamefont{\Glsentryname{#1}}% }% @@ -11748,7 +11677,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.08a}{2013-09-28}{new} % \begin{macrocode} \newcommand*{\glossentrydesc}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsentrydesc{#1}% }% @@ -11760,7 +11689,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.08a}{2013-09-28}{new} % \begin{macrocode} \newcommand*{\Glossentrydesc}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \Glsentrydesc{#1}% }% @@ -11772,7 +11701,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.08a}{2013-09-28}{new} % \begin{macrocode} \newcommand*{\glossentrysymbol}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsentrysymbol{#1}% }% @@ -11784,7 +11713,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{3.08a}{2013-09-28}{new} % \begin{macrocode} \newcommand*{\Glossentrysymbol}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \Glsentrysymbol{#1}% }% @@ -11827,7 +11756,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% % % %\begin{macro}{\glossaryentryfield} -% \cs{glossaryentryfield}\marg{label}\marg{name}\marg{description}\marg{symbol}\marg{page-list}\\[10pt] +%\begin{definition} +% \cs{glossaryentryfield}\marg{label}\marg{name}\marg{description}\marg{symbol}\marg{page-list} +%\end{definition} % This command formerly governed how each entry row should be formatted % in the glossary. Now deprecated. %\changes{3.08a}{2013-09-28}{deprecated} @@ -11842,7 +11773,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} %\begin{macro}{\glossarysubentryfield} -% \cs{glossarysubentryfield}\marg{level}\marg{label}\marg{name}\marg{description}\marg{symbol}\marg{page-list}\\[10pt] +%\begin{definition} +% \cs{glossarysubentryfield}\marg{level}\marg{label}\marg{name}\marg{description}\marg{symbol}\marg{page-list} +%\end{definition} % This command governs how each subentry should be formatted % in the glossary. Glossary styles need to redefine this command. % Most of the predefined styles ignore \meta{symbol}. The first @@ -12271,7 +12204,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% % %\subsection{Acronyms}\label{sec:acronym} %\begin{macro}{\oldacronym} -%\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list}\\[10pt] +%\begin{definition} +%\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list} +%\end{definition} % 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 @@ -12316,10 +12251,12 @@ false,nolabel,autolabel,nameref}[nolabel]{% } % \end{macrocode} %\end{macro} -%\vskip5pt +% +%\begin{definition} % \cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrev}\marg{long}\\[10pt] -% This is a quick way of defining acronyms, all it does -% is call \ics{newglossaryentry} with the appropriate +%\end{definition} +% This is a quick way of defining acronyms, +% using \ics{newglossaryentry} with the appropriate % values. It sets the % glossary type to \ics{acronymtype} which will be % "acronym" if the package option \pkgopt{acronym} has @@ -12849,6 +12786,24 @@ false,nolabel,autolabel,nameref}[nolabel]{% } % \end{macrocode} %\end{macro} +% +%\begin{macro}{\renewacronymstyle} +% Redefines the given acronym style. +%\changes{4.03}{2014-01-20}{new} +% \begin{macrocode} +\newcommand*{\renewacronymstyle}[3]{% + \ifcsdef{@glsacr@dispstyle@#1}% + {% + \csdef{@glsacr@dispstyle@#1}{#2}% + \csdef{@glsacr@styledefs@#1}{#3}% + }% + {% + \PackageError{glossaries}{Acronym style `#1' doesn't exist}{}% + }% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\GlsUseAcrEntryDispStyle} %\changes{4.02}{2013-12-05}{new} % \begin{macrocode} @@ -12930,7 +12885,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% \protect\firstacronymfont{\Glsentryshortpl{##1}}##2\space (\glsentrylongpl{##1})% }% - \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}} +% \end{macrocode} +%\changes{4.03}{2014-01-20}{commented spurious EOL} +% \begin{macrocode} + \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}}% \renewcommand*{\acronymsort}[2]{##1}% \renewcommand*{\acronymfont}[1]{##1}% \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% @@ -13193,8 +13151,11 @@ false,nolabel,autolabel,nameref}[nolabel]{% }% {% \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% +% \end{macrocode} +%\changes{4.03}{2014-01-20}{fixed bug in \cs{acrfullfmt}} +% \begin{macrocode} \renewcommand*{\acrfullfmt}[3]{% - \glslink[##1]{##2}{\glsentryshort{##2}##3\space + \glslink[##1]{##2}{\glsentrylong{##2}##3\space (\acronymfont{\glsentryshort{##2}})}}% \renewcommand*{\Acrfullfmt}[3]{% \glslink[##1]{##2}{\Glsentrylong{##2}##3\space @@ -13203,11 +13164,17 @@ false,nolabel,autolabel,nameref}[nolabel]{% \glslink[##1]{##2}{% \mfirstucMakeUppercase{\glsentrylong{##2}##3\space (\acronymfont{\glsentryshort{##2}})}}}% +% \end{macrocode} +%\changes{4.03}{2014-01-20}{fixed bug in \cs{acrfullplfmt}} +% \begin{macrocode} \renewcommand*{\acrfullplfmt}[3]{% - \glslink[##1]{##2}{\glsentryshortpl{##2}##3\space + \glslink[##1]{##2}{\glsentrylongpl{##2}##3\space (\acronymfont{\glsentryshortpl{##2}})}}% +% \end{macrocode} +%\changes{4.03}{2014-01-20}{fixed bug in \cs{Acrfullplfmt}} +% \begin{macrocode} \renewcommand*{\Acrfullplfmt}[3]{% - \glslink[##1]{##2}{\Glsentryshortpl{##2}##3\space + \glslink[##1]{##2}{\Glsentrylongpl{##2}##3\space (\acronymfont{\glsentryshortpl{##2}})}}% \renewcommand*{\ACRfullplfmt}[3]{% \glslink[##1]{##2}{% @@ -13244,7 +13211,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% {% \GlsUseAcrStyleDefs{dua}% \renewcommand*{\GenericAcronymFields}{}% - \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentrylong{##1}}} +% \end{macrocode} +%\changes{4.03}{2014-01-20}{commented spurious EOL} +% \begin{macrocode} + \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentrylong{##1}}}% \renewcommand*{\acronymsort}[2]{##2}% }% % \end{macrocode} @@ -14614,9 +14584,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloparent}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloparent}[1]{% - \expandafter\show\csname glo@#1@parent\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@parent\endcsname } % \end{macrocode} %\end{macro} @@ -14626,9 +14597,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglolevel}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglolevel}[1]{% - \expandafter\show\csname glo@#1@level\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@level\endcsname } % \end{macrocode} %\end{macro} @@ -14638,9 +14610,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglotext}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglotext}[1]{% - \expandafter\show\csname glo@#1@text\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@text\endcsname } % \end{macrocode} %\end{macro} @@ -14650,9 +14623,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloplural}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloplural}[1]{% - \expandafter\show\csname glo@#1@plural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@plural\endcsname } % \end{macrocode} %\end{macro} @@ -14662,9 +14636,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglofirst}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglofirst}[1]{% - \expandafter\show\csname glo@#1@first\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@first\endcsname } % \end{macrocode} %\end{macro} @@ -14674,9 +14649,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglofirstpl}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglofirstpl}[1]{% - \expandafter\show\csname glo@#1@firstpl\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstpl\endcsname } % \end{macrocode} %\end{macro} @@ -14686,9 +14662,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglotype}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglotype}[1]{% - \expandafter\show\csname glo@#1@type\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@type\endcsname } % \end{macrocode} %\end{macro} @@ -14698,9 +14675,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglocounter}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglocounter}[1]{% - \expandafter\show\csname glo@#1@counter\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@counter\endcsname } % \end{macrocode} %\end{macro} @@ -14710,9 +14688,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouseri}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouseri}[1]{% - \expandafter\show\csname glo@#1@useri\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useri\endcsname } % \end{macrocode} %\end{macro} @@ -14722,9 +14701,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouserii}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouserii}[1]{% - \expandafter\show\csname glo@#1@userii\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@userii\endcsname } % \end{macrocode} %\end{macro} @@ -14734,9 +14714,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouseriii}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouseriii}[1]{% - \expandafter\show\csname glo@#1@useriii\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useriii\endcsname } % \end{macrocode} %\end{macro} @@ -14746,9 +14727,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouseriv}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouseriv}[1]{% - \expandafter\show\csname glo@#1@useriv\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useriv\endcsname } % \end{macrocode} %\end{macro} @@ -14758,9 +14740,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouserv}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouserv}[1]{% - \expandafter\show\csname glo@#1@userv\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@userv\endcsname } % \end{macrocode} %\end{macro} @@ -14770,9 +14753,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglouservi}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglouservi}[1]{% - \expandafter\show\csname glo@#1@uservi\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@uservi\endcsname } % \end{macrocode} %\end{macro} @@ -14782,9 +14766,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloname}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloname}[1]{% - \expandafter\show\csname glo@#1@name\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@name\endcsname } % \end{macrocode} %\end{macro} @@ -14794,9 +14779,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglodesc}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglodesc}[1]{% - \expandafter\show\csname glo@#1@desc\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@desc\endcsname } % \end{macrocode} %\end{macro} @@ -14806,9 +14792,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglodescplural}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglodescplural}[1]{% - \expandafter\show\csname glo@#1@descplural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descplural\endcsname } % \end{macrocode} %\end{macro} @@ -14818,9 +14805,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglosort}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglosort}[1]{% - \expandafter\show\csname glo@#1@sort\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@sort\endcsname } % \end{macrocode} %\end{macro} @@ -14830,9 +14818,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglosymbol}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglosymbol}[1]{% - \expandafter\show\csname glo@#1@symbol\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbol\endcsname } % \end{macrocode} %\end{macro} @@ -14842,9 +14831,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglosymbolplural}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglosymbolplural}[1]{% - \expandafter\show\csname glo@#1@symbolplural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolplural\endcsname } % \end{macrocode} %\end{macro} @@ -14854,9 +14844,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloshort}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloshort}[1]{% - \expandafter\show\csname glo@#1@short\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@short\endcsname } % \end{macrocode} %\end{macro} @@ -14866,9 +14857,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showglolong}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglolong}[1]{% - \expandafter\show\csname glo@#1@long\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@long\endcsname } % \end{macrocode} %\end{macro} @@ -14878,9 +14870,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloindex}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloindex}[1]{% - \expandafter\show\csname glo@#1@index\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@index\endcsname } % \end{macrocode} %\end{macro} @@ -14890,9 +14883,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{definition} %\cs{showgloflag}\marg{label} %\end{definition} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloflag}[1]{% - \expandafter\show\csname ifglo@#1@flag\endcsname + \expandafter\show\csname ifglo@\glsdetoklabel{#1}@flag\endcsname } % \end{macrocode} %\end{macro} @@ -20101,7 +20095,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % but will only be updated when \texttt{glossaries-accsupp.sty} is % modified. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2013/11/14 v4.0 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2014/01/20 v4.03 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -20112,22 +20106,27 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \begin{macrocode} \ProcessOptions % \end{macrocode} +%\begin{macro}{\compatibleglossentry} % Override style compatibility macros: +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\compatibleglossentry}[2]{% \toks@{#2}% \protected@edef\@do@glossentry{% \noexpand\accsuppglossaryentryfield{#1}% {\noexpand\glsnamefont - {\expandafter\expandonce\csname glo@#1@name\endcsname}}% - {\expandafter\expandonce\csname glo@#1@desc\endcsname}% - {\expandafter\expandonce\csname glo@#1@symbol\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@name\endcsname}}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@desc\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@symbol\endcsname}% {\the\toks@}% }% \@do@glossentry } % \end{macrocode} +%\end{macro} % +%\begin{macro}{\compatiblesubglossentry} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\compatiblesubglossentry}[3]{% \toks@{#3}% @@ -20135,14 +20134,15 @@ false,nolabel,autolabel,nameref}[nolabel]{% \noexpand\accsuppglossarysubentryfield{\number#1}% {#2}% {\noexpand\glsnamefont - {\expandafter\expandonce\csname glo@#2@name\endcsname}}% - {\expandafter\expandonce\csname glo@#2@desc\endcsname}% - {\expandafter\expandonce\csname glo@#2@symbol\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@name\endcsname}}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@desc\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@symbol\endcsname}% {\the\toks@}% }% \@do@subglossentry } % \end{macrocode} +%\end{macro} % Required packages: % \begin{macrocode} \RequirePackage{glossaries} @@ -20370,36 +20370,40 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{macro}{\glsentryaccess} % Get the value of the \gloskey{access} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentryaccess}[1]{% - \csname glo@#1@access\endcsname + \@gls@entry@field{#1}{access}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrytextaccess} % Get the value of the \gloskey{textaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrytextaccess}[1]{% - \csname glo@#1@textaccess\endcsname + \@gls@entry@field{#1}{textaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryfirstaccess} % Get the value of the \gloskey{firstaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentryfirstaccess}[1]{% - \csname glo@#1@firstaccess\endcsname + \@gls@entry@field{#1}{firstaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrypluralaccess} % Get the value of the \gloskey{pluralaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrypluralaccess}[1]{% - \csname glo@#1@pluralaccess\endcsname + \@gls@entry@field{#1}{pluralaccess}% } % \end{macrocode} %\end{macro} @@ -20415,36 +20419,40 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{macro}{\glsentrysymbolaccess} % Get the value of the \gloskey{symbolaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrysymbolaccess}[1]{% - \csname glo@#1@symbolaccess\endcsname + \@gls@entry@field{#1}{symbolaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrysymbolpluralaccess} % Get the value of the \gloskey{symbolpluralaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrysymbolpluralaccess}[1]{% - \csname glo@#1@symbolpluralaccess\endcsname + \@gls@entry@field{#1}{symbolpluralaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrydescaccess} % Get the value of the \gloskey{descriptionaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrydescaccess}[1]{% - \csname glo@#1@descaccess\endcsname + \@gls@entry@field{#1}{descaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrydescpluralaccess} % Get the value of the \gloskey{descriptionpluralaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrydescpluralaccess}[1]{% - \csname glo@#1@descaccess\endcsname + \@gls@entry@field{#1}{descaccess}% } % \end{macrocode} %\end{macro} @@ -20452,36 +20460,40 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{macro}{\glsentryshortaccess} % Get the value of the \gloskey{shortaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentryshortaccess}[1]{% - \csname glo@#1@shortaccess\endcsname + \@gls@entry@field{#1}{shortaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryshortpluralaccess} % Get the value of the \gloskey{shortpluralaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentryshortpluralaccess}[1]{% - \csname glo@#1@shortpluralaccess\endcsname + \@gls@entry@field{#1}{shortpluralaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrylongaccess} % Get the value of the \gloskey{longaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrylongaccess}[1]{% - \csname glo@#1@longaccess\endcsname + \@gls@entry@field{#1}{longaccess}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentrylongpluralaccess} % Get the value of the \gloskey{longpluralaccess} key for the entry with % the given label: +%\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} % \begin{macrocode} \newcommand*{\glsentrylongpluralaccess}[1]{% - \csname glo@#1@longpluralaccess\endcsname + \@gls@entry@field{#1}{longpluralaccess}% } % \end{macrocode} %\end{macro} @@ -20507,12 +20519,11 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % -%\begin{macro}{\glsnameaccessdisplay} -% Displays the first argument with the accessibility text for -% the entry with the label given by the second argument (if set). +%\begin{macro}{\@gls@access@display} +%\changes{4.03}{2014-01-20}{new} % \begin{macrocode} -\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryaccess{#2}}% +\newcommand*{\@gls@access@display}[2]{% + \protected@edef\@glo@access{#2}% \ifx\@glo@access\@gls@noaccess #1% \else @@ -20521,16 +20532,21 @@ false,nolabel,autolabel,nameref}[nolabel]{% } % \end{macrocode} %\end{macro} +% +%\begin{macro}{\glsnameaccessdisplay} +% Displays the first argument with the accessibility text for +% the entry with the label given by the second argument (if set). +% \begin{macrocode} +\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% + \@gls@access@display{#1}{\glsentryaccess{#2}}% +} +% \end{macrocode} +%\end{macro} %\begin{macro}{\glstextaccessdisplay} % As above but for the \gloskey{textaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glstextaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrytextaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrytextaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20538,12 +20554,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{pluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glspluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrypluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrypluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20551,12 +20562,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{firstaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsfirstaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryfirstaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryfirstaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20564,12 +20570,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{firstpluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsfirstpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryfirstpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryfirstpluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20577,12 +20578,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{symbolaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glssymbolaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrysymbolaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrysymbolaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20590,12 +20586,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{symbolpluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glssymbolpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrysymbolpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrysymbolpluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20603,12 +20594,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{descriptionaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsdescriptionaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrydescaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrydescaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20616,12 +20602,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{descriptionpluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsdescriptionpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrydescpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrydescpluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20629,12 +20610,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{shortaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsshortaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryshortaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryshortaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20643,12 +20619,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{shortpluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glsshortpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryshortpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryshortpluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20656,12 +20627,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{longaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glslongaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrylongaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrylongaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20670,12 +20636,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % As above but for the \gloskey{longpluralaccess} replacement text. % \begin{macrocode} \DeclareRobustCommand*{\glslongpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrylongpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrylongpluralaccess{#2}}% } % \end{macrocode} %\end{macro} @@ -20934,254 +20895,1194 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % -%\begin{macro}{\@acrshort} +%\begin{macro}{\glsgenentryfmt} +% Redefine to use accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\def\@acrshort#1#2[#3]{% - \glsdoifexists{#2}% +\renewcommand*{\glsgenentryfmt}{% + \ifdefempty\glscustomtext {% - \edef\@glo@type{\glsentrytype{#2}}% + \glsifplural + {% % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +% Plural form % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@firstofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glsshortaccessdisplay{\glsentryshort{#2}}{#2}}#3% - }% -% \end{macrocode} + \glscapscase + {% +% \end{macrocode} +% Don't adjust case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use +% \begin{macrocode} + \glspluralaccessdisplay + {\glsentryplural{\glslabel}}{\glslabel}% + \glsinsert + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstpluralaccessdisplay + {\glsentryfirstplural{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% +% \end{macrocode} +% Make first letter upper case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use. +% \begin{macrocode} + \glspluralaccessdisplay + {\Glsentryplural{\glslabel}}{\glslabel}% + \glsinsert + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstpluralaccessdisplay + {\Glsentryfirstplural{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% +% \end{macrocode} +% Make all upper case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use +% \begin{macrocode} + \glspluralaccessdisplay + {\mfirstucMakeUppercase{\glsentryplural{\glslabel}}}% + {\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstpluralacessdisplay + {\mfirstucMakeUppercase{\glsentryfirstplural{\glslabel}}}% + {\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + }% + {% +% \end{macrocode} +% Singular form +% \begin{macrocode} + \glscapscase + {% +% \end{macrocode} +% Don't adjust case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use +% \begin{macrocode} + \glstextaccessdisplay{\glsentrytext{\glslabel}}{\glslabel}% + \glsinsert + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstaccessdisplay{\glsentryfirst{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% +% \end{macrocode} +% Make first letter upper case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use +% \begin{macrocode} + \glstextaccessdisplay{\Glsentrytext{\glslabel}}{\glslabel}% + \glsinsert + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstaccessdisplay{\Glsentryfirst{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% +% \end{macrocode} +% Make all upper case +% \begin{macrocode} + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use +% \begin{macrocode} + \glstextaccessdisplay + {\mfirstucMakeUppercase{\glsentrytext{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + {% +% \end{macrocode} +% First use +% \begin{macrocode} + \glsfirstaccessdisplay + {\mfirstucMakeUppercase{\glsentryfirst{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + }% + }% + {% +% \end{macrocode} +% Custom text provided in \cs{glsdisp}. (The insert should +% be empty at this point.) The accessibility information, if +% required, will have to be explicitly included in the custom text. +% \begin{macrocode} + \glscustomtext\glsinsert + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsgenacfmt} +% Redefine to include accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewcommand*{\glsgenacfmt}{% + \ifdefempty\glscustomtext + {% + \ifglsused\glslabel + {% +% \end{macrocode} +% Subsequent use: +% \begin{macrocode} + \glsifplural + {% +% \end{macrocode} +% Subsequent plural form: +% \begin{macrocode} + \glscapscase + {% +% \end{macrocode} +% Subsequent plural form, don't adjust case: +% \begin{macrocode} + \acronymfont + {\glsshortpluralaccessdisplay + {\glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% +% \end{macrocode} +% Subsequent plural form, make first letter upper case: +% \begin{macrocode} + \acronymfont + {\glsshortpluralaccessdisplay + {\Glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% +% \end{macrocode} +% Subsequent plural form, all caps: +% \begin{macrocode} + \mfirstucMakeUppercase + {\acronymfont + {\glsshortpluralaccessdisplay + {\glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert}% + }% + }% + {% +% \end{macrocode} +% Subsequent singular form +% \begin{macrocode} + \glscapscase + {% +% \end{macrocode} +% Subsequent singular form, don't adjust case: +% \begin{macrocode} + \acronymfont + {\glsshortaccessdisplay{\glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% +% \end{macrocode} +% Subsequent singular form, make first letter upper case: +% \begin{macrocode} + \acronymfont + {\glsshortaccessdisplay{\Glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% +% \end{macrocode} +% Subsequent singular form, all caps: +% \begin{macrocode} + \mfirstucMakeUppercase + {\acronymfont{% + \glsshortaccessdisplay{\glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert}% + }% + }% + }% + {% +% \end{macrocode} +% First use: +% \begin{macrocode} + \glsifplural + {% +% \end{macrocode} +% First use plural form: +% \begin{macrocode} + \glscapscase + {% +% \end{macrocode} +% First use plural form, don't adjust case: +% \begin{macrocode} + \genplacrfullformat{\glslabel}{\glsinsert}% + }% + {% +% \end{macrocode} +% First use plural form, make first letter upper case: +% \begin{macrocode} + \Genplacrfullformat{\glslabel}{\glsinsert}% + }% + {% +% \end{macrocode} +% First use plural form, all caps: +% \begin{macrocode} + \mfirstucMakeUppercase + {\genplacrfullformat{\glslabel}{\glsinsert}}% + }% + }% + {% +% \end{macrocode} +% First use singular form +% \begin{macrocode} + \glscapscase + {% +% \end{macrocode} +% First use singular form, don't adjust case: +% \begin{macrocode} + \genacrfullformat{\glslabel}{\glsinsert}% + }% + {% +% \end{macrocode} +% First use singular form, make first letter upper case: +% \begin{macrocode} + \Genacrfullformat{\glslabel}{\glsinsert}% + }% + {% +% \end{macrocode} +% First use singular form, all caps: +% \begin{macrocode} + \mfirstucMakeUppercase + {\genacrfullformat{\glslabel}{\glsinsert}}% + }% + }% + }% + }% + {% +% \end{macrocode} +% User supplied text. (The insert should be empty at this point.) +% The accessibility information, if +% required, will have to be explicitly included in the custom text. +% \begin{macrocode} + \glscustomtext + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\genacrfullformat} +% Redefine to include accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewcommand*{\genacrfullformat}[2]{% + \glslongaccessdisplay{\glsentrylong{#1}}{#1}#2\space + (\glsshortaccessdisplay{\protect\firstacronymfont{\glsentryshort{#1}}}{#1})% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\Genacrfullformat} +% Redefine to include accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewcommand*{\Genacrfullformat}[2]{% + \glslongaccessdisplay{\Glsentrylong{#1}}{#1}#2\space + (\glsshortaccessdisplay{\protect\firstacronymfont{\Glsentryshort{#1}}}{#1})% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\genplacrfullformat} +% Redefine to include accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewcommand*{\genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\glsentrylongpl{#1}}{#1}#2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{#1}}}{#1})% +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\Genplacrfullformat} +% Redefine to include accessibility information. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewcommand*{\Genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{#1}}{#1}#2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{#1}}}{#1})% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@acrshort} +% \begin{macrocode} +\def\@acrshort#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@firstofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glsshortaccessdisplay{\glsentryshort{#2}}{#2}}#3% + }% +% \end{macrocode} +% Call \cs{@gls@link} +% \begin{macrocode} + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Acrshort} +% \begin{macrocode} +\def\@Acrshort#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@secondofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glsshortaccessdisplay{\Glsentryshort{#2}}{#2}}#3% + }% +% \end{macrocode} +% Call \cs{@gls@link} +% \begin{macrocode} + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@ACRshort} +% \begin{macrocode} +\def\@ACRshort#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@thirdofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glsshortaccessdisplay + {\MakeUppercase{\glsentryshort{#2}}}{#2}}#3% + }% +% \end{macrocode} +% Call \cs{@gls@link} +% \begin{macrocode} + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@acrlong} +% \begin{macrocode} +\def\@acrlong#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@firstofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glslongaccessdisplay{\glsentrylong{#2}}{#2}}#3% + }% +% \end{macrocode} +% Call \cs{@gls@link} +% \begin{macrocode} + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Acrlong} +% \begin{macrocode} +\def\@Acrlong#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@firstofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glslongaccessdisplay{\Glsentrylong{#2}}{#2}}#3% + }% +% \end{macrocode} +% Call \cs{@gls@link} +% \begin{macrocode} + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@ACRlong} +% \begin{macrocode} +\def\@ACRlong#1#2[#3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% +% \end{macrocode} +%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, +% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\changes{4.03}{2014-01-20}{removed \cs{glslabel} (defined in +%\cs{@gls@link})} +% \begin{macrocode} + \let\glsifplural\@secondoftwo + \let\glscapscase\@firstofthree + \let\glsinsert\@empty + \def\glscustomtext{% + \acronymfont{\glslongaccessdisplay{% + \MakeUppercase{\glsentrylong{#2}}}{#2}#3}% + }% +% \end{macrocode} % Call \cs{@gls@link} % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% - }% + \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\subsection{Displaying the Glossary} +%\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossaryentryfield}} +%\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossarysubentryfield}} +% +% We need to redefine the way the glossary entries are formatted to +% include the accessibility support. The predefined glossary styles +% use \ics{glossentryname}, \ics{glossentrydesc} and +% \ics{glossentrysymbol}, but we need to provide compatibility with +% earlier versions in case users have defined their own styles using +% \cs{accsuppglossaryentryfield} and +% \cs{accsuppglossarysubentryfield}. +% +% Now redefine \cs{glossentryname}, \cs{glossentrydesc} and +% \cs{glossentrysymbol} etc so they use the accessibility stuff. +% \begin{macrocode} +\renewcommand*{\glossentryname}[1]{% + \glsdoifexists{#1}% + {% + \glsnamefont{\glsnameaccessdisplay{\glsentryname{#1}}{#1}}% + }% +} +% \end{macrocode} +% +% \begin{macrocode} +\renewcommand*{\glossentryname}[1]{% + \glsdoifexists{#1}% + {% + \glsnamefont{\glsnameaccessdisplay{\Glsentryname{#1}}{#1}}% + }% +} +% \end{macrocode} +% +% \begin{macrocode} +\renewcommand*{\glossentrydesc}[1]{% + \glsdoifexists{#1}% + {% + \glsdescriptionaccessdisplay{\glsentrydesc{#1}}{#1}% + }% +} +% \end{macrocode} +% +% \begin{macrocode} +\renewcommand*{\Glossentrydesc}[1]{% + \glsdoifexists{#1}% + {% + \glsdescriptionaccessdisplay{\Glsentrydesc{#1}}{#1}% + }% +} +% \end{macrocode} +% +% \begin{macrocode} +\renewcommand*{\glossentrysymbol}[1]{% + \glsdoifexists{#1}% + {% + \glssymbolaccessdisplay{\glsentrysymbol{#1}}{#1}% + }% +} +% \end{macrocode} +% +% \begin{macrocode} +\renewcommand*{\Glossentrysymbol}[1]{% + \glsdoifexists{#1}% + {% + \glssymbolaccessdisplay{\Glsentrysymbol{#1}}{#1}% + }% +} +% \end{macrocode} +% +%\begin{macro}{\accsuppglossaryentryfield} +% \begin{macrocode} +\newcommand*{\accsuppglossaryentryfield}[5]{% + \glossaryentryfield{#1}% + {\glsnameaccessdisplay{#2}{#1}}% + {\glsdescriptionaccessdisplay{#3}{#1}}% + {\glssymbolaccessdisplay{#4}{#1}}{#5}% +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\accsuppglossarysubentryfield} +% \begin{macrocode} +\newcommand*{\accsuppglossarysubentryfield}[6]{% + \glossarysubentryfield{#1}{#2}% + {\glsnameaccessdisplay{#3}{#2}}% + {\glsdescriptionaccessdisplay{#4}{#2}}% + {\glssymbolaccessdisplay{#5}{#2}}{#6}% +} +% \end{macrocode} +%\end{macro} +% +%\subsection{Acronyms} +% Redefine acronym styles provided by \styfmt{glossaries}: +% +%\begin{acrstyle}{long-short} +% \meta{long} (\meta{short}) acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewacronymstyle{long-short}% +{% +% \end{macrocode} +% Check for long form in case this is a mixed glossary. +% \begin{macrocode} + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\genacrfullformat}[2]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}##2\space + (\glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\Genacrfullformat}[2]{% + \glslongaccessdisplay{\Glsentrylong{##1}}{##1}##2\space + (\glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}##2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{##1}}{##1}##2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +} +% \end{macrocode} +%\end{acrstyle} +% +%\begin{acrstyle}{short-long} +% \meta{short} (\meta{long}) acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewacronymstyle{short-long}% +{% +% \end{macrocode} +% Check for long form in case this is a mixed glossary. +% \begin{macrocode} + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1}##2\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})% + }% + \renewcommand*{\Genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\Glsentryshort{##1}}}{##1}##2\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1}##2\space + (\glslongpluralaccessdisplay + {\glsentrylongpl{##1}}{##1})% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\Glsentryshortpl{##1}}}{##1}##2\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +} +% \end{macrocode} +%\end{acrstyle} +% +%\begin{acrstyle}{long-short-desc} +% \meta{long} (\marg{short}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewacronymstyle{long-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-short}% +}% +{% + \GlsUseAcrStyleDefs{long-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +% \end{macrocode} +%\end{acrstyle} +% +%\begin{acrstyle}{long-sc-short-desc} +% \meta{long} (\cs{textsc}\marg{short}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewacronymstyle{long-sc-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-sc-short}% +}% +{% + \GlsUseAcrStyleDefs{long-sc-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } % \end{macrocode} -%\end{macro} +%\end{acrstyle} % -%\begin{macro}{\@Acrshort} +%\begin{acrstyle}{long-sm-short-desc} +% \meta{long} (\cs{textsmaller}\marg{short}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\def\@Acrshort#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% +\renewacronymstyle{long-sm-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-sm-short}% +}% +{% + \GlsUseAcrStyleDefs{long-sm-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\end{acrstyle} +% +%\begin{acrstyle}{short-long-desc} +% \meta{short} (\marg{long}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@secondofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glsshortaccessdisplay{\Glsentryshort{#2}}{#2}}#3% - }% +\renewacronymstyle{short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{short-long}% +}% +{% + \GlsUseAcrStyleDefs{short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} % \end{macrocode} -% Call \cs{@gls@link} +%\end{acrstyle} +% +%\begin{acrstyle}{sc-short-long-desc} +% \meta{long} (\cs{textsc}\marg{short}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% - }% +\renewacronymstyle{sc-short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{sc-short-long}% +}% +{% + \GlsUseAcrStyleDefs{sc-short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } % \end{macrocode} -%\end{macro} +%\end{acrstyle} % -%\begin{macro}{\@ACRshort} +%\begin{acrstyle}{sm-short-long-desc} +% \meta{long} (\cs{textsmaller}\marg{short}) acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\def\@ACRshort#1#2[#3]{% - \glsdoifexists{#2}% +\renewacronymstyle{sm-short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{sm-short-long}% +}% +{% + \GlsUseAcrStyleDefs{sm-short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +% \end{macrocode} +%\end{acrstyle} +% +%\begin{acrstyle}{dua} +% \meta{long} only acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} +% \begin{macrocode} +\renewacronymstyle{dua}% +{% +% \end{macrocode} +% Check for long form in case this is a mixed glossary. +% \begin{macrocode} + \ifdefempty\glscustomtext {% - \edef\@glo@type{\glsentrytype{#2}}% + \ifglshaslong{\glslabel}% + {% + \glsifplural + {% % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +% Plural form: % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@thirdofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glsshortaccessdisplay - {\MakeUppercase{\glsentryshort{#2}}}{#2}}#3% - }% + \glscapscase + {% % \end{macrocode} -% Call \cs{@gls@link} +% Plural form, don't adjust case: % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% - }% -} + \glslongpluralaccessdisplay{\glsentrylongpl{\glslabel}}{\glslabel}% + \glsinsert + }% + {% % \end{macrocode} -%\end{macro} -% -%\begin{macro}{\@acrlong} +% Plural form, make first letter upper case: % \begin{macrocode} -\def\@acrlong#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% + \glslongpluralaccessdisplay{\Glsentrylongpl{\glslabel}}{\glslabel}% + \glsinsert + }% + {% % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +% Plural form, all caps: % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@firstofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glslongaccessdisplay{\glsentrylong{#2}}{#2}}#3% - }% + \glslongpluralaccessdisplay + {\mfirstucMakeUppercase{\glsentrylongpl{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + {% % \end{macrocode} -% Call \cs{@gls@link} +% Singular form % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% - }% -} + \glscapscase + {% % \end{macrocode} -%\end{macro} -% -%\begin{macro}{\@Acrlong} +% Singular form, don't adjust case: % \begin{macrocode} -\def\@Acrlong#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% + \glslongaccessdisplay{\glsentrylong{\glslabel}}{\glslabel}\glsinsert + }% + {% % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +% Subsequent singular form, make first letter upper case: % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@firstofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glslongaccessdisplay{\Glsentrylong{#2}}{#2}}#3% + \glslongaccessdisplay{\Glsentrylong{\glslabel}}{\glslabel}\glsinsert + }% + {% +% \end{macrocode} +% Subsequent singular form, all caps: +% \begin{macrocode} + \glslongaccessdisplay + {\mfirstucMakeUppercase + {\glsentrylong{\glslabel}\glsinsert}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% }% + {% % \end{macrocode} -% Call \cs{@gls@link} +% Not an acronym: % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% + \glsgenentryfmt + }% + }% + {\glscustomtext\glsinsert}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay{\glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}% + \renewcommand*{\Acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay{\Glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}% + \renewcommand*{\ACRfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay + {\mfirstucMakeUppercase{\glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}}% + \renewcommand*{\acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}% + \renewcommand*{\Acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\Glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}% + \renewcommand*{\ACRfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\mfirstucMakeUppercase{\glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}}% + \renewcommand*{\glsentryfull}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\Glsentryfull}[1]{% + \glslongaccessdisplay{\Glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\glsentryfullpl}[1]{% + \glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}\space + (\glsshortpluralaccessdisplay{\acronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\Glsentryfullpl}[1]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{##1}}{##1}\space + (\glsshortpluralaccessdisplay{\acronymfont{\glsentryshortpl{##1}}}{##1})% }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% } % \end{macrocode} -%\end{macro} +%\end{acrstyle} % -%\begin{macro}{\@ACRlong} +%\begin{acrstyle}{dua-desc} +% \meta{long} only acronym style with user-supplied description. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\def\@ACRlong#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% +\renewacronymstyle{dua-desc}% +{% + \GlsUseAcrEntryDispStyle{dua}% +}% +{% + \GlsUseAcrStyleDefs{dua}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\acronymfont{\glsentrylong{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##2}% +}% % \end{macrocode} -%\changes{3.11a}{2013-10-15}{added \cs{glslabel}, \cs{glsifplural}, -% \cs{glscapscase}, \cs{glsinsert} and \cs{glscustomtext}} +%\end{acrstyle} +% +%\begin{acrstyle}{footnote} +% \meta{short}\cs{footnote}\marg{long} acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} - \def\glslabel{#2}% - \let\glsifplural\@secondoftwo - \let\glscapscase\@firstofthree - \let\glsinsert\@empty - \def\glscustomtext{% - \acronymfont{\glslongaccessdisplay{% - \MakeUppercase{\glsentrylong{#2}}}{#2}#3}% - }% +\renewacronymstyle{footnote}% +{% % \end{macrocode} -% Call \cs{@gls@link} +% Check for long form in case this is a mixed glossary. % \begin{macrocode} - \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% - }% -} + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% % \end{macrocode} -%\end{macro} -% -%\subsection{Displaying the Glossary} -%\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossaryentryfield}} -%\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossarysubentryfield}} -% -% We need to redefine the way the glossary entries are formatted to -% include the accessibility support. The predefined glossary styles -% use \ics{glossentryname}, \ics{glossentrydesc} and -% \ics{glossentrysymbol}, but we need to provide compatibility with -% earlier versions in case users have defined their own styles using -% \cs{accsuppglossaryentryfield} and -% \cs{accsuppglossarysubentryfield}. -% -% Now redefine \cs{glossentryname}, \cs{glossentrydesc} and -% \cs{glossentrysymbol} etc so they use the accessibility stuff. +% Need to ensure hyperlinks are switched off on first use: % \begin{macrocode} -\renewcommand*{\glossentryname}[1]{% - \glsdoifexists{#1}% - {% - \glsnamefont{\glsnameaccessdisplay{\glsentryname{#1}}{#1}}% + \glshyperfirstfalse + \renewcommand*{\genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1}##2% + \protect\footnote{\glslongaccessdisplay{\glsentrylong{##1}}{##1}}% }% -} + \renewcommand*{\Genacrfullformat}[2]{% + \glsshortaccessdisplay + {\firstacronymfont{\Glsentryshort{##1}}}{##1}##2% + \protect\footnote{\glslongaccessdisplay{\glsentrylong{##1}}{##1}}% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1}##2% + \protect\footnote{\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}}% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\Glsentryshortpl{##1}}}{##1}##2% + \protect\footnote{\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}}% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% % \end{macrocode} -% +% Don't use footnotes for \ics{acrfull}: % \begin{macrocode} -\renewcommand*{\glossentryname}[1]{% - \glsdoifexists{#1}% - {% - \glsnamefont{\glsnameaccessdisplay{\Glsentryname{#1}}{#1}}% - }% -} + \renewcommand*{\acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}% + \renewcommand*{\Acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay{\acronymfont{\Glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}% + \renewcommand*{\ACRfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay + {\mfirstucMakeUppercase + {\acronymfont{\glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}}% + \renewcommand*{\acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}}{##2})}}% + \renewcommand*{\Acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\acronymfont{\Glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}})}}% + \renewcommand*{\ACRfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\mfirstucMakeUppercase + {\acronymfont{\glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}}{##2})}}}% % \end{macrocode} -% +% Similarly for \ics{glsentryfull} etc: % \begin{macrocode} -\renewcommand*{\glossentrydesc}[1]{% - \glsdoifexists{#1}% - {% - \glsdescriptionaccessdisplay{\glsentrydesc{#1}}{#1}% - }% + \renewcommand*{\glsentryfull}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})}% + \renewcommand*{\Glsentryfull}[1]{% + \glsshortaccessdisplay{\acronymfont{\Glsentryshort{##1}}}{##1}\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})}% + \renewcommand*{\glsentryfullpl}[1]{% + \glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##1}}}{##1}\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})}% + \renewcommand*{\Glsentryfullpl}[1]{% + \glsshortpluralaccessdisplay + {\acronymfont{\Glsentryshortpl{##1}}}{##1}\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})}% } % \end{macrocode} +%\end{acrstyle} % +%\begin{acrstyle}{footnote-sc} +% \cs{textsc}\marg{short}\cs{footnote}\marg{long} acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\renewcommand*{\Glossentrydesc}[1]{% - \glsdoifexists{#1}% - {% - \glsdescriptionaccessdisplay{\Glsentrydesc{#1}}{#1}% - }% -} +\renewacronymstyle{footnote-sc}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand{\acronymfont}[1]{\textsc{##1}}% + \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}% +}% % \end{macrocode} +%\end{acrstyle} % +%\begin{acrstyle}{footnote-sm} +% \cs{textsmaller}\marg{short}\cs{footnote}\marg{long} acronym style. +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\renewcommand*{\glossentrysymbol}[1]{% - \glsdoifexists{#1}% - {% - \glssymbolaccessdisplay{\glsentrysymbol{#1}}{#1}% - }% -} +\renewacronymstyle{footnote-sm}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand{\acronymfont}[1]{\textsmaller{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +}% % \end{macrocode} +%\end{acrstyle} % +%\begin{acrstyle}{footnote-desc} +% \meta{short}\cs{footnote}\marg{long} acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\renewcommand*{\Glossentrysymbol}[1]{% - \glsdoifexists{#1}% - {% - \glssymbolaccessdisplay{\Glsentrysymbol{#1}}{#1}% - }% +\renewacronymstyle{footnote-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } % \end{macrocode} +%\end{acrstyle} % -%\begin{macro}{\accsuppglossaryentryfield} +%\begin{acrstyle}{footnote-sc-desc} +% \cs{textsc}\marg{short}\cs{footnote}\marg{long} acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\newcommand*{\accsuppglossaryentryfield}[5]{% - \glossaryentryfield{#1}% - {\glsnameaccessdisplay{#2}{#1}}% - {\glsdescriptionaccessdisplay{#3}{#1}}% - {\glssymbolaccessdisplay{#4}{#1}}{#5}% +\renewacronymstyle{footnote-sc-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote-sc}% +}% +{% + \GlsUseAcrStyleDefs{footnote-sc}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } % \end{macrocode} -%\end{macro} -%\begin{macro}{\accsuppglossarysubentryfield} +%\end{acrstyle} +% +%\begin{acrstyle}{footnote-sm-desc} +% \cs{textsmaller}\marg{short}\cs{footnote}\marg{long} acronym style that has an +% accompanying description (which the user needs to supply). +%\changes{4.03}{2014-01-20}{redefined to use accessibility +%information} % \begin{macrocode} -\newcommand*{\accsuppglossarysubentryfield}[6]{% - \glossarysubentryfield{#1}{#2}% - {\glsnameaccessdisplay{#3}{#2}}% - {\glsdescriptionaccessdisplay{#4}{#2}}% - {\glssymbolaccessdisplay{#5}{#2}}{#6}% +\renewacronymstyle{footnote-sm-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote-sm}% +}% +{% + \GlsUseAcrStyleDefs{footnote-sm}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } % \end{macrocode} -%\end{macro} +%\end{acrstyle} % -%\subsection{Acronyms} % Use \cs{newacronymhook} to modify the key list to set % the access text to the long version by default. % \begin{macrocode} @@ -21226,7 +22127,22 @@ false,nolabel,autolabel,nameref}[nolabel]{% \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@descplural\gls@assign@descplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } % \end{macrocode} %\end{macro} @@ -21254,7 +22170,22 @@ false,nolabel,autolabel,nameref}[nolabel]{% \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } % \end{macrocode} %\end{macro} @@ -21287,7 +22218,22 @@ false,nolabel,autolabel,nameref}[nolabel]{% textaccess={\noexpand\@glo@shortaccess},% \the\glskeylisttok}% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } % \end{macrocode} %\end{macro} @@ -21313,7 +22259,22 @@ false,nolabel,autolabel,nameref}[nolabel]{% \the\glskeylisttok }% }% + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@descplural\gls@assign@descplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@descplural\@org@gls@assign@descplural } % \end{macrocode} %\end{macro} @@ -21346,7 +22307,27 @@ false,nolabel,autolabel,nameref}[nolabel]{% \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@descplural\gls@assign@descplural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@descplural\@org@gls@assign@descplural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } % \end{macrocode} %\end{macro} @@ -21376,93 +22357,106 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\subsection{Debugging Commands} % %\begin{macro}{\showglonameaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglonameaccess}[1]{% - \expandafter\show\csname glo@#1@textaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@textaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglotextaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglotextaccess}[1]{% - \expandafter\show\csname glo@#1@textaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@textaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglopluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglopluralaccess}[1]{% - \expandafter\show\csname glo@#1@pluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@pluralaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglofirstaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglofirstaccess}[1]{% - \expandafter\show\csname glo@#1@firstaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglofirstpluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglofirstpluralaccess}[1]{% - \expandafter\show\csname glo@#1@firstpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstpluralaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglosymbolaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglosymbolaccess}[1]{% - \expandafter\show\csname glo@#1@symbolaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglosymbolpluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglosymbolpluralaccess}[1]{% - \expandafter\show\csname glo@#1@symbolpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolpluralaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglodescaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglodescaccess}[1]{% - \expandafter\show\csname glo@#1@descaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglodescpluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglodescpluralaccess}[1]{% - \expandafter\show\csname glo@#1@descpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descpluralaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showgloshortaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloshortaccess}[1]{% - \expandafter\show\csname glo@#1@shortaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@shortaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showgloshortpluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showgloshortpluralaccess}[1]{% - \expandafter\show\csname glo@#1@shortpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@shortpluralaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglolongaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglolongaccess}[1]{% - \expandafter\show\csname glo@#1@longaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@longaccess\endcsname } % \end{macrocode} %\end{macro} %\begin{macro}{\showglolongpluralaccess} +%\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\showglolongpluralaccess}[1]{% - \expandafter\show\csname glo@#1@longpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@longpluralaccess\endcsname } % \end{macrocode} %\end{macro} @@ -22353,22 +23347,6 @@ false,nolabel,autolabel,nameref}[nolabel]{% \makeglossaries - % Setup acronym fonts (e.g. \emph for short form on first use and - % \textbf for short form on subsequent use): -\renewcommand{\firstacronymfont}[1]{\emph{#1}} -\renewcommand{\acronymfont}[1]{\textbf{#1}} - % Apply the generic acronym style to just the "acronym" glossary: -\defglsentryfmt[acronym]{\glsgenacfmt} - - % Change acronym first use so that its displayed as - % short (long) -\renewcommand{\genacrfullformat}[2]{% - \glsentryshort{#1}#2 (\glsentrylong{#1})% -} -\renewcommand{\genplacrfullformat}[2]{% - \glsentryshortpl{#1}#2 (\glsentrylongpl{#1})% -} - \longnewglossaryentry{par}{name={par}}% {% A long description with a paragraph break. @@ -22385,6 +23363,7 @@ description={a sample entry}} acronyms]{aca}{aca}{a contrived acronym} \begin{document} + A \gls{sample} entry and \gls{aca}. Second use: \gls{aca}. Plurals: \glspl{sample}. Reset acronym\glsreset{aca}. diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index b18e0255c08..778b4622d47 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 1.1 2013/12/5 15:12 +% glossaries.ins generated using makedtx version 1.1 2014/1/20 17:22 \input docstrip \preamble glossaries.dtx - Copyright 2013 Nicola Talbot + Copyright 2014 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 e7736fce866..b66cb8d3d1f 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 2013 Nicola Talbot +%% Copyright 2014 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-compatible-207.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty index b42fa4a33ec..b8d76376f58 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-compatible-207.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-compatible-307.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty index 7a520508b48..be55f61824a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-compatible-307.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-polyglossia.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty index e1e6d41a174..8ca3f214f7e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-polyglossia.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 629cc72c41e..4761b75eb3c 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 2013 Nicola Talbot +%% Copyright 2014 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}[2013/12/05 v4.02 (NLCT)] +\ProvidesPackage{glossaries}[2014/01/20 v4.03 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -398,8 +398,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \fi } \define@boolkey[gls]{sanitize}{name}[true]{% - \GlossariesWarning{sanitize={name} package option -deprecated}% + \GlossariesWarning{sanitize={name} package option deprecated}% \ifgls@sanitize@name \glssetnoexpandfield{name}% \else @@ -407,8 +406,7 @@ deprecated}% \fi } \define@boolkey[gls]{sanitize}{symbol}[true]{% - \GlossariesWarning{sanitize={symbol} package option -deprecated}% + \GlossariesWarning{sanitize={symbol} package option deprecated}% \ifgls@sanitize@symbol \glssetnoexpandfield{symbol}% \glssetnoexpandfield{symbolplural}% @@ -536,11 +534,11 @@ name=true]{% \ifglssavewrites \renewcommand*{\glswritefiles}{\@glswritefiles}% \else - \let\glswritefiles\relax + \let\glswritefiles\@empty \fi } \glssavewritesfalse -\let\glswritefiles\relax +\let\glswritefiles\@empty \define@boolkey{glossaries.sty}[gls]{compatible-3.07}[true]{} \boolfalse{glscompatible-3.07} \define@boolkey{glossaries.sty}[gls]{compatible-2.07}[true]{% @@ -665,7 +663,7 @@ name=true]{% \providecommand*{\glossaryname}{Glossary} \providecommand*{\acronymname}{Acronyms} \newcommand*{\glssettoctitle}[1]{% -\def\glossarytoctitle{\csname @glotype@#1@title\endcsname}} + \def\glossarytoctitle{\csname @glotype@#1@title\endcsname}} \providecommand*{\entryname}{Notation} \providecommand*{\descriptionname}{Description} \providecommand*{\symbolname}{Symbol} @@ -1232,30 +1230,41 @@ name=true]{% \newcommand{\ifglossaryexists}[3]{% \ifcsundef{@glotype@#1@out}{#3}{#2}% } +\newcommand*{\glsdetoklabel}[1]{#1} \newcommand{\ifglsentryexists}[3]{% - \ifcsundef{glo@#1@name}{#3}{#2}% + \ifcsundef{glo@\glsdetoklabel{#1}@name}{#3}{#2}% +} +\newcommand*{\ifglsused}[3]{% + \ifbool{glo@\glsdetoklabel{#1}@flag}{#2}{#3}% } -\newcommand*{\ifglsused}[3]{\ifbool{glo@#1@flag}{#2}{#3}} \newcommand{\glsdoifexists}[2]{% \ifglsentryexists{#1}{#2}{% - \PackageError{glossaries}{Glossary entry `#1' has not been - defined}{You need to define a glossary entry before you + \PackageError{glossaries}{Glossary entry `\glsdetoklabel{#1}' + has not been defined}{You need to define a glossary entry before you can use it.}}% } \newcommand{\glsdoifnoexists}[2]{% \ifglsentryexists{#1}{% - \PackageError{glossaries}{Glossary entry `#1' has already + \PackageError{glossaries}{Glossary entry `\glsdetoklabel{#1}' has already been defined}{}}{#2}% } +\newcommand{\glsdoifexistsorwarn}[2]{% + \ifglsentryexists{#1}{#2}{% + \GlossariesWarning{Glossary entry `\glsdetoklabel{#1}' + has not been defined}% + }% +} \newcommand{\ifglshaschildren}[3]{% \glsdoifexists{#1}% {% \def\do@glshaschildren{#3}% - \expandafter\forglsentries\expandafter[\csname glo@#1@type\endcsname] + \edef\@gls@thislabel{\glsdetoklabel{#1}}% + \expandafter\forglsentries\expandafter + [\csname glo@\@gls@thislabel @type\endcsname] {\glo@label}% {% \letcs\glo@parent{glo@\glo@label @parent}% - \ifthenelse{\equal{#1}{\glo@parent}}% + \ifdefequal\@gls@thislabel\glo@parent {% \def\do@glshaschildren{#2}% \@endfortrue @@ -1268,50 +1277,81 @@ name=true]{% \newcommand{\ifglshasparent}[3]{% \glsdoifexists{#1}% {% - \ifcsempty{glo@#1@parent}{#3}{#2}% + \ifcsempty{glo@\glsdetoklabel{#1}@parent}{#3}{#2}% }% } \newcommand*{\ifglshasdesc}[3]{% - \ifcsempty{glo@#1@desc}% + \ifcsempty{glo@\glsdetoklabel{#1}@desc}% {#3}% {#2}% } \newcommand*{\ifglsdescsuppressed}[3]{% - \ifcsequal{glos@#1@desc}{@no@post@desc}% + \ifcsequal{glo@\glsdetoklabel{#1}@desc}{@no@post@desc}% {#2}% {#3}% } \newcommand*{\ifglshassymbol}[3]{% - \ifcsempty{glo@#1@symbol}% + \letcs{\@glo@symbol}{glo@\glsdetoklabel{#1}@symbol}% + \ifdefempty\@glo@symbol {#3}% {% - \expandafter\ifx\csname glo@#1@symbol\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@symbol\@gls@default@value + {#3}% + {#2}% }% } \newcommand*{\ifglshaslong}[3]{% - \ifcsempty{glo@#1@long}% + \letcs{\@glo@long}{glo@\glsdetoklabel{#1}@long}% + \ifdefempty\@glo@long {#3}% {% - \expandafter\ifx\csname glo@#1@long\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@long\@gls@default@value + {#3}% + {#2}% }% } \newcommand*{\ifglshasshort}[3]{% - \ifcsempty{glo@#1@short}% + \letcs{\@glo@short}{glo@\glsdetoklabel{#1}@short}% + \ifdefempty\@glo@short {#3}% {% - \expandafter\ifx\csname glo@#1@short\endcsname\@gls@default@value - #3% - \else - #2% - \fi + \ifdefequal\@glo@short\@gls@default@value + {#3}% + {#2}% + }% +} +\newcommand*{\ifglshasfield}[4]{% + \glsdoifexists{#2}% + {% + \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@#1}% + \ifdef\@glo@thisvalue + {% + \ifdefempty\@glo@thisvalue + {% + #4% + }% + {% + \ifdefequal\@glo@thisvalue\@gls@default@value{#4}{#3}% + }% + }% + {% + \@gls@fetchfield{\@gls@thisfield}{#1}% + \ifdef\@gls@thisfield + {% + \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@\@gls@thisfield}% + \ifdefempty\@glo@thisvalue + {% + #4% + }% + {% + \ifdefequal\@glo@thisvalue\@gls@default@value{#4}{#3}% + }% + }% + {% + \GlossariesWarning{Unknown entry field `#1'}% + #4% + }% + }% }% } \newcommand*{\@glo@types}{,} @@ -1609,13 +1649,15 @@ name=true]{% {% \string\ifglsentryexists{#1}{}\expandafter\@gobble\string\%^^J% \expandafter\@gobble\string\{\expandafter\@gobble\string\%^^J% - \string\gls@defglossaryentry{#1}\expandafter\@gobble\string\%^^J% + \string\gls@defglossaryentry{\glsdetoklabel{#1}}\expandafter + \@gobble\string\%^^J% \expandafter\@gobble\string\{\expandafter\@gobble\string\%% }% \@for\@gls@map:=\@gls@keymap\do {% \edef\glo@value{\expandafter\expandonce - \csname glo@#1@\expandafter\@secondoftwo\@gls@map\endcsname}% + \csname glo@\glsdetoklabel{#1}@\expandafter + \@secondoftwo\@gls@map\endcsname}% \@onelevel@sanitize\glo@value \immediate\write\@gls@deffile {% @@ -1657,6 +1699,18 @@ name=true]{% {counter}{counter},% {parent}{parent}% } +\newcommand*{\@gls@fetchfield}[2]{% + \edef\@gls@thisval{#2}% + \@for\@gls@map:=\@gls@keymap\do{% + \edef\@this@key{\expandafter\@firstoftwo\@gls@map}% + \ifdefequal{\@this@key}{\@gls@thisval}% + {% + \edef#1{\expandafter\@secondoftwo\@gls@map}% + \@endfortrue + }% + {}% + }% +} \newcommand*{\glsaddkey}{\@ifstar\@sglsaddkey\@glsaddkey} \newcommand*{\@sglsaddkey}[1]{% \key@ifundefined{glossentry}{#1}% @@ -1679,11 +1733,8 @@ name=true]{% \letcs{\@glo@tmp}{@glo@#1}% \gls@assign@field{#2}{\@glo@label}{#1}{\@glo@tmp}% }% - \newcommand*{#3}[1]{\csuse{glo@##1@#1}}% - \newcommand*{#4}[1]{% - \letcs{\@glo@text}{glo@##1@#1}% - \xmakefirstuc\@glo@text - }% + \newcommand*{#3}[1]{\@gls@entry@field{##1}{#1}}% + \newcommand*{#4}[1]{\@Gls@entry@field{##1}{#1}}% \ifcsdef{@gls@user@#1@}% {% \PackageError{glossaries}% @@ -1703,11 +1754,7 @@ name=true]{% {\csuse{@gls@user@#1@}{##1}{##2}}% {\csuse{@gls@user@#1@}{##1}{##2}[]}}% \csdef{@gls@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{#3{##2}##3}% - }% + \@gls@field@link{##1}{##2}{#3{##2}##3}% }% }% \ifcsdef{@Gls@user@#1@}% @@ -1729,11 +1776,7 @@ name=true]{% {\csuse{@Gls@user@#1@}{##1}{##2}}% {\csuse{@Gls@user@#1@}{##1}{##2}[]}}% \csdef{@Gls@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{#4{##2}##3}% - }% + \@gls@field@link{##1}{##2}{#4{##2}##3}% }% }% \ifcsdef{@GLS@user@#1@}% @@ -1755,11 +1798,7 @@ name=true]{% {\csuse{@GLS@user@#1@}{##1}{##2}}% {\csuse{@GLS@user@#1@}{##1}{##2}[]}}% \csdef{@GLS@user@#1@}##1##2[##3]{% - \glsdoifexists{##2}% - {% - \edef\@glo@type{\glsentrytype{##2}}% - \@gls@link[##1]{##2}{\mfirstucMakeUppercase{#3{##2}##3}}% - }% + \@gls@field@link{##1}{##2}{\mfirstucMakeUppercase{#3{##2}##3}}% }% }% }% @@ -1782,8 +1821,8 @@ name=true]{% \@org@newglossaryentryprehook }% \renewcommand*{\gls@assign@desc}[1]{% - \global\cslet{glo@#1@desc}{\@glo@desc}% - \global\cslet{glo@#1@descplural}{\@glo@desc}% + \global\cslet{glo@\glsdetoklabel{#1}@desc}{\@glo@desc}% + \global\cslet{glo@\glsdetoklabel{#1}@descplural}{\@glo@desc}% } \gls@defglossaryentry{#1}{#2}% \egroup @@ -1796,7 +1835,7 @@ name=true]{% } \@onlypreamble{\longprovideglossaryentry} \newcommand{\gls@defglossaryentry}[2]{% - \def\@glo@label{#1}% + \edef\@glo@label{\glsdetoklabel{#1}}% \let\glslabel\@glo@label \let\@glo@name\@glsnoname \let\@glo@desc\@glsnodesc @@ -1833,8 +1872,8 @@ name=true]{% a new glossary before you can define entries}% }% {}% - \gls@assign@field{\glsdefaulttype}{#1}{type}{\@glo@type}% - \edef\@glo@type{\glsentrytype{#1}}% + \gls@assign@field{\glsdefaulttype}{\@glo@label}{type}{\@glo@type}% + \edef\@glo@type{\glsentrytype{\@glo@label}}% \ifcsundef{glolist@\@glo@type}% {% \PackageError{glossaries}% @@ -1844,22 +1883,24 @@ name=true]{% }% {% \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% - \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% + \expandafter\xdef\csname glolist@\@glo@type\endcsname{% + \@glolist@{\@glo@label},}% }% \gls@level=0\relax \ifx\@glo@parent\@empty - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% \else - \ifthenelse{\equal{#1}{\@glo@parent}}% + \ifdefequal\@glo@label\@glo@parent% {% - \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \PackageError{glossaries}{Entry `\@glo@label' can't be its own parent}{}% \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% }% {% \ifglsentryexists{\@glo@parent}% {% - \expandafter\xdef\csname glo@#1@parent\endcsname{\@glo@parent}% + \expandafter\xdef\csname glo@\@glo@label @parent\endcsname{% + \@glo@parent}% \gls@level=\csname glo@\@glo@parent @level\endcsname\relax \advance\gls@level by 1\relax \ifx\@glo@name\@glsnoname @@ -1875,34 +1916,34 @@ name=true]{% \PackageError{glossaries}% {% Invalid parent `\@glo@parent' - for entry `#1' - parent doesn't exist% + for entry `\@glo@label' - parent doesn't exist% }% {% Parent entries must be defined before their children% }% \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \expandafter\gdef\csname glo@\@glo@label @parent\endcsname{}% }% }% \fi - \expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% - \gls@assign@field{\@glo@name}{#1}{sortvalue}{\@glo@sort}% - \letcs\@glo@sort{glo@#1@sortvalue}% - \gls@assign@field{\@glo@name}{#1}{text}{\@glo@text}% + \expandafter\xdef\csname glo@\@glo@label @level\endcsname{\number\gls@level}% + \gls@assign@field{\@glo@name}{\@glo@label}{sortvalue}{\@glo@sort}% + \letcs\@glo@sort{glo@\@glo@label @sortvalue}% + \gls@assign@field{\@glo@name}{\@glo@label}{text}{\@glo@text}% \expandafter\gls@assign@field\expandafter - {\csname glo@#1@text\endcsname\glspluralsuffix}% - {#1}{plural}{\@glo@plural}% + {\csname glo@\@glo@label @text\endcsname\glspluralsuffix}% + {\@glo@label}{plural}{\@glo@plural}% \expandafter\gls@assign@field\expandafter - {\csname glo@#1@text\endcsname}% - {#1}{first}{\@glo@first}% + {\csname glo@\@glo@label @text\endcsname}% + {\@glo@label}{first}{\@glo@first}% \ifx\@glo@first\@gls@default@value \expandafter\gls@assign@field\expandafter - {\csname glo@#1@plural\endcsname}% - {#1}{firstpl}{\@glo@firstplural}% + {\csname glo@\@glo@label @plural\endcsname}% + {\@glo@label}{firstpl}{\@glo@firstplural}% \else \expandafter\gls@assign@field\expandafter - {\csname glo@#1@first\endcsname\glspluralsuffix}% - {#1}{firstpl}{\@glo@firstplural}% + {\csname glo@\@glo@label @first\endcsname\glspluralsuffix}% + {\@glo@label}{firstpl}{\@glo@firstplural}% \fi \ifcsundef{@glotype@\@glo@type @counter}% {% @@ -1911,25 +1952,26 @@ name=true]{% {% \letcs\@glo@defaultcounter{@glotype@\@glo@type @counter}% }% - \gls@assign@field{\@glo@defaultcounter}{#1}{counter}{\@glo@counter}% - \gls@assign@field{}{#1}{useri}{\@glo@useri}% - \gls@assign@field{}{#1}{userii}{\@glo@userii}% - \gls@assign@field{}{#1}{useriii}{\@glo@useriii}% - \gls@assign@field{}{#1}{useriv}{\@glo@useriv}% - \gls@assign@field{}{#1}{userv}{\@glo@userv}% - \gls@assign@field{}{#1}{uservi}{\@glo@uservi}% - \gls@assign@field{}{#1}{short}{\@glo@short}% - \gls@assign@field{}{#1}{shortpl}{\@glo@shortpl}% - \gls@assign@field{}{#1}{long}{\@glo@long}% - \gls@assign@field{}{#1}{longpl}{\@glo@longpl}% + \gls@assign@field{\@glo@defaultcounter}{\@glo@label}{counter}{\@glo@counter}% + \gls@assign@field{}{\@glo@label}{useri}{\@glo@useri}% + \gls@assign@field{}{\@glo@label}{userii}{\@glo@userii}% + \gls@assign@field{}{\@glo@label}{useriii}{\@glo@useriii}% + \gls@assign@field{}{\@glo@label}{useriv}{\@glo@useriv}% + \gls@assign@field{}{\@glo@label}{userv}{\@glo@userv}% + \gls@assign@field{}{\@glo@label}{uservi}{\@glo@uservi}% + \gls@assign@field{}{\@glo@label}{short}{\@glo@short}% + \gls@assign@field{}{\@glo@label}{shortpl}{\@glo@shortpl}% + \gls@assign@field{}{\@glo@label}{long}{\@glo@long}% + \gls@assign@field{}{\@glo@label}{longpl}{\@glo@longpl}% \ifx\@glo@name\@glsnoname \@glsnoname \let\@gloname\@gls@default@value \fi - \gls@assign@field{}{#1}{name}{\@glo@name}% - \ifcsundef{glo@#1@numberlist}% + \gls@assign@field{}{\@glo@label}{name}{\@glo@name}% + \ifcsundef{glo@\@glo@label @numberlist}% {% - \csxdef{glo@#1@numberlist}{\noexpand\@gls@missingnumberlist{\@glo@label}}% + \csxdef{glo@\@glo@label @numberlist}{% + \noexpand\@gls@missingnumberlist{\@glo@label}}% }% {}% \def\@glo@@desc{\@glo@first}% @@ -1940,48 +1982,52 @@ name=true]{% \@glsnodesc \let\@glodesc\@gls@default@value \fi - \gls@assign@desc{#1}% - \@gls@defsort{\@glo@type}{#1}% + \gls@assign@desc{\@glo@label}% + \@gls@defsort{\@glo@type}{\@glo@label}% \def\@glo@@symbol{\@glo@text}% \ifx\@glo@symbol\@glo@@symbol \let\@glo@symbol\@glo@text \fi - \gls@assign@field{\relax}{#1}{symbol}{\@glo@symbol}% + \gls@assign@field{\relax}{\@glo@label}{symbol}{\@glo@symbol}% \expandafter \gls@assign@field\expandafter - {\csname glo@#1@symbol\endcsname} - {#1}{symbolplural}{\@glo@symbolplural}% - \expandafter\gdef\csname glo@#1@flagfalse\endcsname{% - \expandafter\global\expandafter - \let\csname ifglo@#1@flag\endcsname\iffalse + {\csname glo@\@glo@label @symbol\endcsname} + {\@glo@label}{symbolplural}{\@glo@symbolplural}% + \expandafter\xdef\csname glo@\@glo@label @flagfalse\endcsname{% + \noexpand\global + \noexpand\let\expandafter\noexpand + \csname ifglo@\@glo@label @flag\endcsname\noexpand\iffalse }% - \expandafter\gdef\csname glo@#1@flagtrue\endcsname{% - \expandafter\global\expandafter - \let\csname ifglo@#1@flag\endcsname\iftrue + \expandafter\xdef\csname glo@\@glo@label @flagtrue\endcsname{% + \noexpand\global + \noexpand\let\expandafter\noexpand + \csname ifglo@\@glo@label @flag\endcsname\noexpand\iftrue }% - \csname glo@#1@flagfalse\endcsname + \csname glo@\@glo@label @flagfalse\endcsname \ifx\@glo@see\@empty \else \protected@edef\@do@glssee{% \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see \noexpand\@nil - \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% + \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{\@glo@label}}% \@do@glssee \fi - \do@glo@storeentry{#1}% + \do@glo@storeentry{\@glo@label}% \@newglossaryentryposthook } \newcommand*{\@newglossaryentryprehook}{} \newcommand*{\@newglossaryentryposthook}{} \newcommand*{\glsmoveentry}[2]{% - \edef\glo@type{\csname glo@#1@type\endcsname}% + \edef\@glo@thislabel{\glsdetoklabel{#1}}% + \edef\glo@type{\csname glo@\@glo@thislabel @type\endcsname}% \def\glo@list{,}% \forglsentries[\glo@type]{\glo@label}% {% - \ifthenelse{\equal{\glo@label}{#1}}{}{\eappto\glo@list{\glo@label,}}% + \ifdefequal\@glo@thislabel\glo@label + {}{\eappto\glo@list{\glo@label,}}% }% \cslet{glolist@\glo@type}{\glo@list}% - \csdef{glo@#1@type}{#2}% + \csdef{glo@\@glo@thislabel @type}{#2}% } \ifglsxindy \newcommand*{\@glossaryentryfield}{\string\\glossentry} @@ -1996,8 +2042,8 @@ name=true]{% \string\subglossentry} \fi \newcommand{\@glo@storeentry}[1]{% - \def\@glo@label{#1}% - \@gls@checkmkidxchars\@glo@label + \edef\@glo@esclabel{#1}% + \@gls@checkmkidxchars\@glo@esclabel \protected@edef\@glo@sort{\csname glo@#1@sort\endcsname}% \@gls@checkmkidxchars\@glo@sort \@gls@checkmkidxchars\@glo@prefix @@ -2006,14 +2052,14 @@ name=true]{% \ifx\@glo@parent\@empty \expandafter\protected@xdef\csname glo@#1@index\endcsname{% (\string"\@glo@sort\string" % - \string"\@glo@prefix\@glossaryentryfield{\@glo@label}\string") % + \string"\@glo@prefix\@glossaryentryfield{\@glo@esclabel}\string") % }% \else \expandafter\protected@xdef\csname glo@#1@index\endcsname{% \csname glo@\@glo@parent @index\endcsname (\string"\@glo@sort\string" % \string"\@glo@prefix\@glossarysubentryfield - {\csname glo@#1@level\endcsname}{\@glo@label}\string") % + {\csname glo@#1@level\endcsname}{\@glo@esclabel}\string") % }% \fi \else @@ -2021,14 +2067,14 @@ name=true]{% \@onelevel@sanitize\@glo@prefix \expandafter\protected@xdef\csname glo@#1@index\endcsname{% \@glo@sort\@gls@actualchar\@glo@prefix - \@glossaryentryfield{\@glo@label}% + \@glossaryentryfield{\@glo@esclabel}% }% \else \expandafter\protected@xdef\csname glo@#1@index\endcsname{% \csname glo@\@glo@parent @index\endcsname\@gls@levelchar \@glo@sort\@gls@actualchar\@glo@prefix \@glossarysubentryfield - {\csname glo@#1@level\endcsname}{\@glo@label}% + {\csname glo@#1@level\endcsname}{\@glo@esclabel}% }% \fi \fi @@ -2050,7 +2096,7 @@ name=true]{% {% \glsdoifexists{#1}% {% - \expandafter\global\csname glo@#1@flagfalse\endcsname + \expandafter\global\csname glo@\glsdetoklabel{#1}@flagfalse\endcsname }% }% } @@ -2059,7 +2105,7 @@ name=true]{% {% \glsdoifexists{#1}% {% - \expandafter\let\csname ifglo@#1@flag\endcsname\iffalse + \expandafter\let\csname ifglo@\glsdetoklabel{#1}@flag\endcsname\iffalse }% }% } @@ -2068,7 +2114,7 @@ name=true]{% {% \glsdoifexists{#1}% {% - \expandafter\global\csname glo@#1@flagtrue\endcsname + \expandafter\global\csname glo@\glsdetoklabel{#1}@flagtrue\endcsname }% }% } @@ -2077,7 +2123,7 @@ name=true]{% {% \glsdoifexists{#1}% {% - \expandafter\let\csname ifglo@#1@flag\endcsname\iftrue + \expandafter\let\csname ifglo@\glsdetoklabel{#1}@flag\endcsname\iftrue }% }% } @@ -2471,7 +2517,7 @@ name=true]{% }% } \define@key{glslink}{format}{% -\def\@glsnumberformat{#1}} + \def\@glsnumberformat{#1}} \define@boolkey{glslink}{hyper}[true]{} \define@boolkey{glslink}{local}[true]{} \newrobustcmd*{\glslink}{% @@ -2491,10 +2537,12 @@ name=true]{% } \def\@gls@link[#1]#2#3{% \leavevmode - \def\glslabel{#2}% + \edef\glslabel{\glsdetoklabel{#2}}% + \def\@gls@link@opts{#1}% + \let\@gls@link@label\glslabel \def\@glsnumberformat{glsnumberformat}% - \edef\@gls@counter{\csname glo@#2@counter\endcsname}% - \edef\gls@type{\csname glo@#2@type\endcsname}% + \edef\@gls@counter{\csname glo@\glslabel @counter\endcsname}% + \edef\gls@type{\csname glo@\glslabel @type\endcsname}% \expandafter\DTLifinlist\expandafter {\gls@type}{\@gls@nohyperlist}% {% @@ -2505,10 +2553,10 @@ name=true]{% }% \setkeys{glslink}{#1}% \@gls@saveentrycounter - \@gls@setsort{#2}% + \@gls@setsort{\glslabel}% \@do@wrglossary{#2}% \ifKV@glslink@hyper - \@glslink{\glolinkprefix#2}{\glstextformat{#3}}% + \@glslink{\glolinkprefix\glslabel}{\glstextformat{#3}}% \else \glstextformat{#3}% \fi @@ -2925,9 +2973,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glscustomtext\@empty @@ -2966,9 +3011,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@secondofthree \let\glscustomtext\@empty @@ -3008,9 +3050,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@thirdofthree \let\glscustomtext\@empty @@ -3048,9 +3087,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@firstoftwo \let\glscapscase\@firstofthree \let\glscustomtext\@empty @@ -3090,9 +3126,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@firstoftwo \let\glscapscase\@secondofthree \let\glscustomtext\@empty @@ -3132,9 +3165,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@firstoftwo \let\glscapscase\@thirdofthree \let\glscustomtext\@empty @@ -3170,9 +3200,6 @@ name=true]{% \newcommand*{\@glsdisp}[3][]{% \glsdoifexists{#2}{% \edef\@glo@type{\glsentrytype{#2}}% - \def\@gls@link@opts{#1}% - \def\@gls@link@label{#2}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \def\glscustomtext{#3}% @@ -3200,499 +3227,327 @@ name=true]{% \fi }% } +\newcommand{\@gls@field@link}[3]{% + \glsdoifexists{#2}% + {% + \edef\@glo@type{\glsentrytype{#2}}% + \@gls@link[#1]{#2}{#3}% + }% +} \newrobustcmd*{\glstext}{\@ifstar\@sglstext\@glstext} \newcommand*{\@sglstext}[1][]{\@glstext[hyper=false,#1]} \newcommand*{\@glstext}[2][]{% \new@ifnextchar[{\@glstext@{#1}{#2}}{\@glstext@{#1}{#2}[]}} \def\@glstext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentrytext{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentrytext{#2}#3}% } \newrobustcmd*{\GLStext}{\@ifstar\@sGLStext\@GLStext} \newcommand*{\@sGLStext}[1][]{\@GLStext[hyper=false,#1]} \newcommand*{\@GLStext}[2][]{% \new@ifnextchar[{\@GLStext@{#1}{#2}}{\@GLStext@{#1}{#2}[]}} \def\@GLStext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrytext{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrytext{#2}#3}}% } \newrobustcmd*{\Glstext}{\@ifstar\@sGlstext\@Glstext} \newcommand*{\@sGlstext}[1][]{\@Glstext[hyper=false,#1]} \newcommand*{\@Glstext}[2][]{% \new@ifnextchar[{\@Glstext@{#1}{#2}}{\@Glstext@{#1}{#2}[]}} \def\@Glstext@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentrytext{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentrytext{#2}#3}% } \newrobustcmd*{\glsfirst}{\@ifstar\@sglsfirst\@glsfirst} \newcommand*{\@sglsfirst}[1][]{\@glsfirst[hyper=false,#1]} \newcommand*{\@glsfirst}[2][]{% \new@ifnextchar[{\@glsfirst@{#1}{#2}}{\@glsfirst@{#1}{#2}[]}} \def\@glsfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryfirst{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryfirst{#2}#3}% } \newrobustcmd*{\Glsfirst}{\@ifstar\@sGlsfirst\@Glsfirst} \newcommand*{\@sGlsfirst}[1][]{\@Glsfirst[hyper=false,#1]} \newcommand*{\@Glsfirst}[2][]{% \new@ifnextchar[{\@Glsfirst@{#1}{#2}}{\@Glsfirst@{#1}{#2}[]}} \def\@Glsfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryfirst{#2}#3}}% + \@gls@field@link{#1}{#2}{\Glsentryfirst{#2}#3}% } \newrobustcmd*{\GLSfirst}{\@ifstar\@sGLSfirst\@GLSfirst} \newcommand*{\@sGLSfirst}[1][]{\@GLSfirst[hyper=false,#1]} \newcommand*{\@GLSfirst}[2][]{% \new@ifnextchar[{\@GLSfirst@{#1}{#2}}{\@GLSfirst@{#1}{#2}[]}} \def\@GLSfirst@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryfirst{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryfirst{#2}#3}}% } \newrobustcmd*{\glsplural}{\@ifstar\@sglsplural\@glsplural} \newcommand*{\@sglsplural}[1][]{\@glsplural[hyper=false,#1]} \newcommand*{\@glsplural}[2][]{% \new@ifnextchar[{\@glsplural@{#1}{#2}}{\@glsplural@{#1}{#2}[]}} \def\@glsplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryplural{#2}#3}% } \newrobustcmd*{\Glsplural}{\@ifstar\@sGlsplural\@Glsplural} \newcommand*{\@sGlsplural}[1][]{\@Glsplural[hyper=false,#1]} \newcommand*{\@Glsplural}[2][]{% \new@ifnextchar[{\@Glsplural@{#1}{#2}}{\@Glsplural@{#1}{#2}[]}} \def\@Glsplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryplural{#2}#3}% } \newrobustcmd*{\GLSplural}{\@ifstar\@sGLSplural\@GLSplural} \newcommand*{\@sGLSplural}[1][]{\@GLSplural[hyper=false,#1]} \newcommand*{\@GLSplural}[2][]{% \new@ifnextchar[{\@GLSplural@{#1}{#2}}{\@GLSplural@{#1}{#2}[]}} \def\@GLSplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryplural{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryplural{#2}#3}}% } \newrobustcmd*{\glsfirstplural}{\@ifstar\@sglsfirstplural\@glsfirstplural} \newcommand*{\@sglsfirstplural}[1][]{\@glsfirstplural[hyper=false,#1]} \newcommand*{\@glsfirstplural}[2][]{% \new@ifnextchar[{\@glsfirstplural@{#1}{#2}}{\@glsfirstplural@{#1}{#2}[]}} \def\@glsfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryfirstplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryfirstplural{#2}#3}% } \newrobustcmd*{\Glsfirstplural}{\@ifstar\@sGlsfirstplural\@Glsfirstplural} \newcommand*{\@sGlsfirstplural}[1][]{\@Glsfirstplural[hyper=false,#1]} \newcommand*{\@Glsfirstplural}[2][]{% \new@ifnextchar[{\@Glsfirstplural@{#1}{#2}}{\@Glsfirstplural@{#1}{#2}[]}} \def\@Glsfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryfirstplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryfirstplural{#2}#3}% } \newrobustcmd*{\GLSfirstplural}{\@ifstar\@sGLSfirstplural\@GLSfirstplural} \newcommand*{\@sGLSfirstplural}[1][]{\@GLSfirstplural[hyper=false,#1]} \newcommand*{\@GLSfirstplural}[2][]{% \new@ifnextchar[{\@GLSfirstplural@{#1}{#2}}{\@GLSfirstplural@{#1}{#2}[]}} \def\@GLSfirstplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryfirstplural{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryfirstplural{#2}#3}}% } \newrobustcmd*{\glsname}{\@ifstar\@sglsname\@glsname} \newcommand*{\@sglsname}[1][]{\@glsname[hyper=false,#1]} \newcommand*{\@glsname}[2][]{% \new@ifnextchar[{\@glsname@{#1}{#2}}{\@glsname@{#1}{#2}[]}} \def\@glsname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryname{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryname{#2}#3}% } \newrobustcmd*{\Glsname}{\@ifstar\@sGlsname\@Glsname} \newcommand*{\@sGlsname}[1][]{\@Glsname[hyper=false,#1]} \newcommand*{\@Glsname}[2][]{% \new@ifnextchar[{\@Glsname@{#1}{#2}}{\@Glsname@{#1}{#2}[]}} \def\@Glsname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryname{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryname{#2}#3}% } \newrobustcmd*{\GLSname}{\@ifstar\@sGLSname\@GLSname} \newcommand*{\@sGLSname}[1][]{\@GLSname[hyper=false,#1]} \newcommand*{\@GLSname}[2][]{% \new@ifnextchar[{\@GLSname@{#1}{#2}}{\@GLSname@{#1}{#2}[]}} \def\@GLSname@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryname{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryname{#2}#3}}% } \newrobustcmd*{\glsdesc}{\@ifstar\@sglsdesc\@glsdesc} \newcommand*{\@sglsdesc}[1][]{\@glsdesc[hyper=false,#1]} \newcommand*{\@glsdesc}[2][]{% \new@ifnextchar[{\@glsdesc@{#1}{#2}}{\@glsdesc@{#1}{#2}[]}} \def\@glsdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentrydesc{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentrydesc{#2}#3}% } \newrobustcmd*{\Glsdesc}{\@ifstar\@sGlsdesc\@Glsdesc} \newcommand*{\@sGlsdesc}[1][]{\@Glsdesc[hyper=false,#1]} \newcommand*{\@Glsdesc}[2][]{% \new@ifnextchar[{\@Glsdesc@{#1}{#2}}{\@Glsdesc@{#1}{#2}[]}} \def\@Glsdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentrydesc{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentrydesc{#2}#3}% } \newrobustcmd*{\GLSdesc}{\@ifstar\@sGLSdesc\@GLSdesc} \newcommand*{\@sGLSdesc}[1][]{\@GLSdesc[hyper=false,#1]} \newcommand*{\@GLSdesc}[2][]{% \new@ifnextchar[{\@GLSdesc@{#1}{#2}}{\@GLSdesc@{#1}{#2}[]}} \def\@GLSdesc@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrydesc{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrydesc{#2}#3}}% } \newrobustcmd*{\glsdescplural}{\@ifstar\@sglsdescplural\@glsdescplural} \newcommand*{\@sglsdescplural}[1][]{\@glsdescplural[hyper=false,#1]} \newcommand*{\@glsdescplural}[2][]{% \new@ifnextchar[{\@glsdescplural@{#1}{#2}}{\@glsdescplural@{#1}{#2}[]}} \def\@glsdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentrydescplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentrydescplural{#2}#3}% } \newrobustcmd*{\Glsdescplural}{\@ifstar\@sGlsdescplural\@Glsdescplural} \newcommand*{\@sGlsdescplural}[1][]{\@Glsdescplural[hyper=false,#1]} \newcommand*{\@Glsdescplural}[2][]{% \new@ifnextchar[{\@Glsdescplural@{#1}{#2}}{\@Glsdescplural@{#1}{#2}[]}} \def\@Glsdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentrydescplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentrydescplural{#2}#3}% } \newrobustcmd*{\GLSdescplural}{\@ifstar\@sGLSdescplural\@GLSdescplural} \newcommand*{\@sGLSdescplural}[1][]{\@GLSdescplural[hyper=false,#1]} \newcommand*{\@GLSdescplural}[2][]{% \new@ifnextchar[{\@GLSdescplural@{#1}{#2}}{\@GLSdescplural@{#1}{#2}[]}} \def\@GLSdescplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrydescplural{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrydescplural{#2}#3}}% } \newrobustcmd*{\glssymbol}{\@ifstar\@sglssymbol\@glssymbol} \newcommand*{\@sglssymbol}[1][]{\@glssymbol[hyper=false,#1]} \newcommand*{\@glssymbol}[2][]{% \new@ifnextchar[{\@glssymbol@{#1}{#2}}{\@glssymbol@{#1}{#2}[]}} \def\@glssymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentrysymbol{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentrysymbol{#2}#3}% } \newrobustcmd*{\Glssymbol}{\@ifstar\@sGlssymbol\@Glssymbol} \newcommand*{\@sGlssymbol}[1][]{\@Glssymbol[hyper=false,#1]} \newcommand*{\@Glssymbol}[2][]{% \new@ifnextchar[{\@Glssymbol@{#1}{#2}}{\@Glssymbol@{#1}{#2}[]}} \def\@Glssymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentrysymbol{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentrysymbol{#2}#3}% } \newrobustcmd*{\GLSsymbol}{\@ifstar\@sGLSsymbol\@GLSsymbol} \newcommand*{\@sGLSsymbol}[1][]{\@GLSsymbol[hyper=false,#1]} \newcommand*{\@GLSsymbol}[2][]{% \new@ifnextchar[{\@GLSsymbol@{#1}{#2}}{\@GLSsymbol@{#1}{#2}[]}} \def\@GLSsymbol@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrysymbol{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrysymbol{#2}#3}}% } \newrobustcmd*{\glssymbolplural}{\@ifstar\@sglssymbolplural\@glssymbolplural} \newcommand*{\@sglssymbolplural}[1][]{\@glssymbolplural[hyper=false,#1]} \newcommand*{\@glssymbolplural}[2][]{% \new@ifnextchar[{\@glssymbolplural@{#1}{#2}}{\@glssymbolplural@{#1}{#2}[]}} \def\@glssymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentrysymbolplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentrysymbolplural{#2}#3}% } \newrobustcmd*{\Glssymbolplural}{\@ifstar\@sGlssymbolplural\@Glssymbolplural} \newcommand*{\@sGlssymbolplural}[1][]{\@Glssymbolplural[hyper=false,#1]} \newcommand*{\@Glssymbolplural}[2][]{% \new@ifnextchar[{\@Glssymbolplural@{#1}{#2}}{\@Glssymbolplural@{#1}{#2}[]}} \def\@Glssymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentrysymbolplural{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentrysymbolplural{#2}#3}% } \newrobustcmd*{\GLSsymbolplural}{\@ifstar\@sGLSsymbolplural\@GLSsymbolplural} \newcommand*{\@sGLSsymbolplural}[1][]{\@GLSsymbolplural[hyper=false,#1]} \newcommand*{\@GLSsymbolplural}[2][]{% \new@ifnextchar[{\@GLSsymbolplural@{#1}{#2}}{\@GLSsymbolplural@{#1}{#2}[]}} \def\@GLSsymbolplural@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}#3}}% } \newrobustcmd*{\glsuseri}{\@ifstar\@sglsuseri\@glsuseri} \newcommand*{\@sglsuseri}[1][]{\@glsuseri[hyper=false,#1]} \newcommand*{\@glsuseri}[2][]{% \new@ifnextchar[{\@glsuseri@{#1}{#2}}{\@glsuseri@{#1}{#2}[]}} \def\@glsuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuseri{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuseri{#2}#3}% } \newrobustcmd*{\Glsuseri}{\@ifstar\@sGlsuseri\@Glsuseri} \newcommand*{\@sGlsuseri}[1][]{\@Glsuseri[hyper=false,#1]} \newcommand*{\@Glsuseri}[2][]{% \new@ifnextchar[{\@Glsuseri@{#1}{#2}}{\@Glsuseri@{#1}{#2}[]}} \def\@Glsuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuseri{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuseri{#2}#3}% } \newrobustcmd*{\GLSuseri}{\@ifstar\@sGLSuseri\@GLSuseri} \newcommand*{\@sGLSuseri}[1][]{\@GLSuseri[hyper=false,#1]} \newcommand*{\@GLSuseri}[2][]{% \new@ifnextchar[{\@GLSuseri@{#1}{#2}}{\@GLSuseri@{#1}{#2}[]}} \def\@GLSuseri@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseri{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseri{#2}#3}}% } \newrobustcmd*{\glsuserii}{\@ifstar\@sglsuserii\@glsuserii} \newcommand*{\@sglsuserii}[1][]{\@glsuserii[hyper=false,#1]} \newcommand*{\@glsuserii}[2][]{% \new@ifnextchar[{\@glsuserii@{#1}{#2}}{\@glsuserii@{#1}{#2}[]}} \def\@glsuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuserii{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuserii{#2}#3}% } \newrobustcmd*{\Glsuserii}{\@ifstar\@sGlsuserii\@Glsuserii} \newcommand*{\@sGlsuserii}[1][]{\@Glsuserii[hyper=false,#1]} \newcommand*{\@Glsuserii}[2][]{% \new@ifnextchar[{\@Glsuserii@{#1}{#2}}{\@Glsuserii@{#1}{#2}[]}} \def\@Glsuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuserii{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuserii{#2}#3}% } \newrobustcmd*{\GLSuserii}{\@ifstar\@sGLSuserii\@GLSuserii} \newcommand*{\@sGLSuserii}[1][]{\@GLSuserii[hyper=false,#1]} \newcommand*{\@GLSuserii}[2][]{% \new@ifnextchar[{\@GLSuserii@{#1}{#2}}{\@GLSuserii@{#1}{#2}[]}} \def\@GLSuserii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuserii{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuserii{#2}#3}}% } \newrobustcmd*{\glsuseriii}{\@ifstar\@sglsuseriii\@glsuseriii} \newcommand*{\@sglsuseriii}[1][]{\@glsuseriii[hyper=false,#1]} \newcommand*{\@glsuseriii}[2][]{% \new@ifnextchar[{\@glsuseriii@{#1}{#2}}{\@glsuseriii@{#1}{#2}[]}} \def\@glsuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuseriii{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuseriii{#2}#3}% } \newrobustcmd*{\Glsuseriii}{\@ifstar\@sGlsuseriii\@Glsuseriii} \newcommand*{\@sGlsuseriii}[1][]{\@Glsuseriii[hyper=false,#1]} \newcommand*{\@Glsuseriii}[2][]{% \new@ifnextchar[{\@Glsuseriii@{#1}{#2}}{\@Glsuseriii@{#1}{#2}[]}} \def\@Glsuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuseriii{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuseriii{#2}#3}% } \newrobustcmd*{\GLSuseriii}{\@ifstar\@sGLSuseriii\@GLSuseriii} \newcommand*{\@sGLSuseriii}[1][]{\@GLSuseriii[hyper=false,#1]} \newcommand*{\@GLSuseriii}[2][]{% \new@ifnextchar[{\@GLSuseriii@{#1}{#2}}{\@GLSuseriii@{#1}{#2}[]}} \def\@GLSuseriii@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseriii{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseriii{#2}#3}}% } \newrobustcmd*{\glsuseriv}{\@ifstar\@sglsuseriv\@glsuseriv} \newcommand*{\@sglsuseriv}[1][]{\@glsuseriv[hyper=false,#1]} \newcommand*{\@glsuseriv}[2][]{% \new@ifnextchar[{\@glsuseriv@{#1}{#2}}{\@glsuseriv@{#1}{#2}[]}} \def\@glsuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuseriv{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuseriv{#2}#3}% } \newrobustcmd*{\Glsuseriv}{\@ifstar\@sGlsuseriv\@Glsuseriv} \newcommand*{\@sGlsuseriv}[1][]{\@Glsuseriv[hyper=false,#1]} \newcommand*{\@Glsuseriv}[2][]{% \new@ifnextchar[{\@Glsuseriv@{#1}{#2}}{\@Glsuseriv@{#1}{#2}[]}} \def\@Glsuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuseriv{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuseriv{#2}#3}% } \newrobustcmd*{\GLSuseriv}{\@ifstar\@sGLSuseriv\@GLSuseriv} \newcommand*{\@sGLSuseriv}[1][]{\@GLSuseriv[hyper=false,#1]} \newcommand*{\@GLSuseriv}[2][]{% \new@ifnextchar[{\@GLSuseriv@{#1}{#2}}{\@GLSuseriv@{#1}{#2}[]}} \def\@GLSuseriv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuseriv{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuseriv{#2}#3}}% } \newrobustcmd*{\glsuserv}{\@ifstar\@sglsuserv\@glsuserv} \newcommand*{\@sglsuserv}[1][]{\@glsuserv[hyper=false,#1]} \newcommand*{\@glsuserv}[2][]{% \new@ifnextchar[{\@glsuserv@{#1}{#2}}{\@glsuserv@{#1}{#2}[]}} \def\@glsuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuserv{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuserv{#2}#3}% } \newrobustcmd*{\Glsuserv}{\@ifstar\@sGlsuserv\@Glsuserv} \newcommand*{\@sGlsuserv}[1][]{\@Glsuserv[hyper=false,#1]} \newcommand*{\@Glsuserv}[2][]{% \new@ifnextchar[{\@Glsuserv@{#1}{#2}}{\@Glsuserv@{#1}{#2}[]}} \def\@Glsuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuserv{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuserv{#2}#3}% } \newrobustcmd*{\GLSuserv}{\@ifstar\@sGLSuserv\@GLSuserv} \newcommand*{\@sGLSuserv}[1][]{\@GLSuserv[hyper=false,#1]} \newcommand*{\@GLSuserv}[2][]{% \new@ifnextchar[{\@GLSuserv@{#1}{#2}}{\@GLSuserv@{#1}{#2}[]}} \def\@GLSuserv@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuserv{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuserv{#2}#3}}% } \newrobustcmd*{\glsuservi}{\@ifstar\@sglsuservi\@glsuservi} \newcommand*{\@sglsuservi}[1][]{\@glsuservi[hyper=false,#1]} \newcommand*{\@glsuservi}[2][]{% \new@ifnextchar[{\@glsuservi@{#1}{#2}}{\@glsuservi@{#1}{#2}[]}} \def\@glsuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\glsentryuservi{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\glsentryuservi{#2}#3}% } \newrobustcmd*{\Glsuservi}{\@ifstar\@sGlsuservi\@Glsuservi} \newcommand*{\@sGlsuservi}[1][]{\@Glsuservi[hyper=false,#1]} \newcommand*{\@Glsuservi}[2][]{% \new@ifnextchar[{\@Glsuservi@{#1}{#2}}{\@Glsuservi@{#1}{#2}[]}} \def\@Glsuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\Glsentryuservi{#2}#3}% - }% + \@gls@field@link{#1}{#2}{\Glsentryuservi{#2}#3}% } \newrobustcmd*{\GLSuservi}{\@ifstar\@sGLSuservi\@GLSuservi} \newcommand*{\@sGLSuservi}[1][]{\@GLSuservi[hyper=false,#1]} \newcommand*{\@GLSuservi}[2][]{% \new@ifnextchar[{\@GLSuservi@{#1}{#2}}{\@GLSuservi@{#1}{#2}[]}} \def\@GLSuservi@#1#2[#3]{% - \glsdoifexists{#2}% - {% - \edef\@glo@type{\glsentrytype{#2}}% - \@gls@link[#1]{#2}{\mfirstucMakeUppercase{\glsentryuservi{#2}#3}}% - }% + \@gls@field@link{#1}{#2}{\mfirstucMakeUppercase{\glsentryuservi{#2}#3}}% } \newrobustcmd*{\acrshort}{\@ifstar\s@acrshort\ns@acrshort} \newcommand*{\s@acrshort}[2][]{% @@ -3706,7 +3561,6 @@ name=true]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -3958,89 +3812,117 @@ name=true]{% \@gls@link[#1]{#2}{\csname gls@\@glo@type @entryfmt\endcsname}% }% } -\newcommand*{\glsentryname}[1]{\csname glo@#1@name\endcsname} +\newcommand*{\@gls@entry@field}[2]{% + \csname glo@\glsdetoklabel{#1}@#2\endcsname +} +\newcommand*{\@Gls@entry@field}[2]{% + \letcs\@glo@text{glo@\glsdetoklabel{#1}@#2}% + \xmakefirstuc{\@glo@text}% +} +\newcommand*{\glsentryname}[1]{\@gls@entry@field{#1}{name}} \newrobustcmd*{\Glsentryname}[1]{% - \protected@edef\@glo@text{\csname glo@#1@name\endcsname}% - \expandafter\makefirstuc\expandafter{\@glo@text}% + \@Gls@entry@field{#1}{name}% } -\newcommand*{\glsentrydesc}[1]{\csname glo@#1@desc\endcsname} +\newcommand*{\glsentrydesc}[1]{\@gls@entry@field{#1}{desc}} \newrobustcmd*{\Glsentrydesc}[1]{% - \protected@edef\@glo@text{\csname glo@#1@desc\endcsname}% - \expandafter\makefirstuc\expandafter{\@glo@text}% + \@Gls@entry@field{#1}{desc}% } \newcommand*{\glsentrydescplural}[1]{% - \csname glo@#1@descplural\endcsname} + \@gls@entry@field{#1}{descplural}% +} \newrobustcmd*{\Glsentrydescplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@descplural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentrytext}[1]{\csname glo@#1@text\endcsname} + \@Gls@entry@field{#1}{descplural}% +} +\newcommand*{\glsentrytext}[1]{\@gls@entry@field{#1}{text}} \newrobustcmd*{\Glsentrytext}[1]{% - \protected@edef\@glo@text{\csname glo@#1@text\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryplural}[1]{\csname glo@#1@plural\endcsname} + \@Gls@entry@field{#1}{text}% +} +\newcommand*{\glsentryplural}[1]{% + \@gls@entry@field{#1}{plural}% +} \newrobustcmd*{\Glsentryplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@plural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentrysymbol}[1]{\csname glo@#1@symbol\endcsname} + \@Gls@entry@field{#1}{plural}% +} +\newcommand*{\glsentrysymbol}[1]{% + \@gls@entry@field{#1}{symbol}% +} \newrobustcmd*{\Glsentrysymbol}[1]{% -\protected@edef\@glo@text{\csname glo@#1@symbol\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{symbol}% +} \newcommand*{\glsentrysymbolplural}[1]{% - \csname glo@#1@symbolplural\endcsname} + \@gls@entry@field{#1}{symbolplural}% +} \newrobustcmd*{\Glsentrysymbolplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@symbolplural\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryfirst}[1]{\csname glo@#1@first\endcsname} + \@Gls@entry@field{#1}{symbolplural}% +} +\newcommand*{\glsentryfirst}[1]{% + \@gls@entry@field{#1}{first}% +} \newrobustcmd*{\Glsentryfirst}[1]{% -\protected@edef\@glo@text{\csname glo@#1@first\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{first}% +} \newcommand*{\glsentryfirstplural}[1]{% - \csname glo@#1@firstpl\endcsname} + \@gls@entry@field{#1}{firstpl}% +} \newrobustcmd*{\Glsentryfirstplural}[1]{% -\protected@edef\@glo@text{\csname glo@#1@firstpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentrytype}[1]{\csname glo@#1@type\endcsname} -\newcommand*{\glsentrysort}[1]{\csname glo@#1@sort\endcsname} -\newcommand*{\glsentryuseri}[1]{\csname glo@#1@useri\endcsname} + \@Gls@entry@field{#1}{firstpl}% +} +\newcommand*{\glsentrytype}[1]{\@gls@entry@field{#1}{type}} +\newcommand*{\glsentrysort}[1]{% + \@gls@entry@field{#1}{sort}% +} +\newcommand*{\glsentryuseri}[1]{% + \@gls@entry@field{#1}{useri}% +} \newrobustcmd*{\Glsentryuseri}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useri\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryuserii}[1]{\csname glo@#1@userii\endcsname} + \@Gls@entry@field{#1}{useri}% +} +\newcommand*{\glsentryuserii}[1]{% + \@gls@entry@field{#1}{userii}% +} \newrobustcmd*{\Glsentryuserii}[1]{% -\protected@edef\@glo@text{\csname glo@#1@userii\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryuseriii}[1]{\csname glo@#1@useriii\endcsname} + \@Gls@entry@field{#1}{userii}% +} +\newcommand*{\glsentryuseriii}[1]{% + \@gls@entry@field{#1}{useriii}% +} \newrobustcmd*{\Glsentryuseriii}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useriii\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryuseriv}[1]{\csname glo@#1@useriv\endcsname} + \@Gls@entry@field{#1}{useriii}% +} +\newcommand*{\glsentryuseriv}[1]{% + \@gls@entry@field{#1}{useriv}% +} \newrobustcmd*{\Glsentryuseriv}[1]{% -\protected@edef\@glo@text{\csname glo@#1@useriv\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryuserv}[1]{\csname glo@#1@userv\endcsname} + \@Gls@entry@field{#1}{useriv}% +} +\newcommand*{\glsentryuserv}[1]{% + \@gls@entry@field{#1}{userv}% +} \newrobustcmd*{\Glsentryuserv}[1]{% -\protected@edef\@glo@text{\csname glo@#1@userv\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryuservi}[1]{\csname glo@#1@uservi\endcsname} + \@Gls@entry@field{#1}{userv}% +} +\newcommand*{\glsentryuservi}[1]{% + \@gls@entry@field{#1}{uservi}% +} \newrobustcmd*{\Glsentryuservi}[1]{% -\protected@edef\@glo@text{\csname glo@#1@uservi\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryshort}[1]{\csname glo@#1@short\endcsname} + \@Gls@entry@field{#1}{uservi}% +} +\newcommand*{\glsentryshort}[1]{\@gls@entry@field{#1}{short}} \newrobustcmd*{\Glsentryshort}[1]{% -\protected@edef\@glo@text{\csname glo@#1@short\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentryshortpl}[1]{\csname glo@#1@shortpl\endcsname} + \@Gls@entry@field{#1}{short}% +} +\newcommand*{\glsentryshortpl}[1]{\@gls@entry@field{#1}{shortpl}} \newrobustcmd*{\Glsentryshortpl}[1]{% -\protected@edef\@glo@text{\csname glo@#1@shortpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentrylong}[1]{\csname glo@#1@long\endcsname} + \@Gls@entry@field{#1}{shortpl}% +} +\newcommand*{\glsentrylong}[1]{\@gls@entry@field{#1}{long}} \newrobustcmd*{\Glsentrylong}[1]{% - \protected@edef\@glo@text{\csname glo@#1@long\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} -\newcommand*{\glsentrylongpl}[1]{\csname glo@#1@longpl\endcsname} + \@Gls@entry@field{#1}{long}% +} +\newcommand*{\glsentrylongpl}[1]{\@gls@entry@field{#1}{longpl}} \newrobustcmd*{\Glsentrylongpl}[1]{% -\protected@edef\@glo@text{\csname glo@#1@longpl\endcsname}% -\expandafter\makefirstuc\expandafter{\@glo@text}} + \@Gls@entry@field{#1}{longpl}% +} \newcommand*{\glsentryfull}[1]{% \acrfullformat{\glsentrylong{#1}}{\acronymfont{\glsentryshort{#1}}}% } @@ -4056,7 +3938,7 @@ name=true]{% \newcommand*{\glsentrynumberlist}[1]{% \glsdoifexists{#1}% {% - \csname glo@#1@numberlist\endcsname + \@gls@entry@field{#1}{numberlist}% }% } \@ifpackageloaded{hyperref} {% @@ -4075,10 +3957,11 @@ name=true]{% \glsdoifexists{#1}% {% \bgroup - \def\@glo@label{#1}% + \edef\@glo@label{\glsdetoklabel{#1}}% \let\@org@glsnumberformat\glsnumberformat \def\glsnumberformat##1{##1}% - \protected@edef\the@numberlist{\csname glo@\@glo@label @numberlist\endcsname}% + \protected@edef\the@numberlist{% + \csname glo@\@glo@label @numberlist\endcsname}% \def\@gls@numlist@sep{}% \def\@gls@numlist@nextsep{}% \def\@gls@numlist@lastsep{}% @@ -4107,8 +3990,8 @@ name=true]{% \newcommand*{\glsnumlistsep}{, } \newcommand*{\glsnumlistlastsep}{ \& } \newcommand*{\glshyperlink}[2][\glsentrytext{\@glo@label}]{% -\def\@glo@label{#2}% -\@glslink{\glolinkprefix#2}{#1}} + \def\@glo@label{#2}% + \@glslink{\glolinkprefix\glsdetoklabel{#2}}{#1}} \define@key{glossadd}{counter}{\def\@gls@counter{#1}} \define@key{glossadd}{format}{\def\@glsnumberformat{#1}} \define@key{glossadd}{types}{\def\@glo@type{#1}} @@ -4116,7 +3999,7 @@ name=true]{% \glsdoifexists{#2}% {% \def\@glsnumberformat{glsnumberformat}% - \edef\@gls@counter{\csname glo@#2@counter\endcsname}% + \edef\@gls@counter{\csname glo@\glsdetoklabel{#2}@counter\endcsname}% \setkeys{glossadd}{#1}% \@gls@saveentrycounter \@do@wrglossary{#2}% @@ -4540,6 +4423,7 @@ you }% \@do@gls@getcounterprefix \fi + \edef\@gls@label{\glsdetoklabel{#1}}% \ifglsxindy \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil \def\@glo@range{}% @@ -4550,8 +4434,8 @@ you \def\@glo@range{:close-range}% \fi \fi - \glossary[\csname glo@#1@type\endcsname]{% - (indexentry :tkey (\csname glo@#1@index\endcsname) + \glossary[\csname glo@\@gls@label @type\endcsname]{% + (indexentry :tkey (\csname glo@\@gls@label @index\endcsname) :locref \string"{\@glo@counterprefix}{\@glslocref}\string" % :attr \string"\@gls@counter\@glo@suffix\string" \@glo@range @@ -4560,8 +4444,8 @@ you \else \@set@glo@numformat{\@glo@numfmt}{\@gls@counter}{\@glsnumberformat}% {\@glo@counterprefix}% - \glossary[\csname glo@#1@type\endcsname]{% - \string\glossaryentry{\csname glo@#1@index\endcsname + \glossary[\csname glo@\@gls@label @type\endcsname]{% + \string\glossaryentry{\csname glo@\@gls@label @index\endcsname \@gls@encapchar\@glo@numfmt}{\@glslocref}}% \fi } @@ -4621,7 +4505,7 @@ you \else \@gls@donext \fi - \glsseeitem{\@gls@thislabel}% + \expandafter\glsseeitem\expandafter{\@gls@thislabel}% \let\@gls@dolast\glsseelastsep \let\@gls@donext\glsseesep }% @@ -4675,11 +4559,11 @@ you \let\gls@org@glossaryentryfield\glossentry \let\gls@org@glossarysubentryfield\subglossentry \renewcommand{\glossentry}[1]{% - \gdef\glscurrententrylabel{##1}% + \xdef\glscurrententrylabel{\glsdetoklabel{##1}}% \gls@org@glossaryentryfield{##1}% }% \renewcommand{\subglossentry}[2]{% - \gdef\glscurrententrylabel{##2}% + \xdef\glscurrententrylabel{\glsdetoklabel{##2}}% \gls@org@glossarysubentryfield{##1}{##2}% }% \makeatletter @@ -4820,25 +4704,25 @@ false,nolabel,autolabel,nameref}[nolabel]{% \ifglsentrycounter \newcommand*{\glsstepentry}[1]{% \refstepcounter{glossaryentry}% - \label{glsentry-#1}% + \label{glsentry-\glsdetoklabel{#1}}% } \else \newcommand*{\glsstepentry}[1]{} \fi \ifglssubentrycounter \newcommand*{\glsstepsubentry}[1]{% - \def\currentglssubentry{#1}% + \edef\currentglssubentry{\glsdetoklabel{#1}}% \refstepcounter{glossarysubentry}% - \label{glsentry-#1}% + \label{glsentry-\currentglssubentry}% } \else \newcommand*{\glsstepsubentry}[1]{} \fi \ifglsentrycounter - \newcommand*{\glsrefentry}[1]{\ref{glsentry-#1}} + \newcommand*{\glsrefentry}[1]{\ref{glsentry-\glsdetoklabel{#1}}} \else \ifglssubentrycounter - \newcommand*{\glsrefentry}[1]{\ref{glsentry-#1}} + \newcommand*{\glsrefentry}[1]{\ref{glsentry-\glsdetoklabel{#1}}} \else \newcommand*{\glsrefentry}[1]{\gls{#1}} \fi @@ -4889,38 +4773,38 @@ false,nolabel,autolabel,nameref}[nolabel]{% \@do@glossentry } \newcommand*{\glossentryname}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% - \letcs{\glo@name}{glo@#1@name}% + \letcs{\glo@name}{glo@\glsdetoklabel{#1}@name}% \expandafter\glsnamefont\expandafter{\glo@name}% }% } \newcommand*{\Glossentryname}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsnamefont{\Glsentryname{#1}}% }% } \newcommand*{\glossentrydesc}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsentrydesc{#1}% }% } \newcommand*{\Glossentrydesc}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \Glsentrydesc{#1}% }% } \newcommand*{\glossentrysymbol}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \glsentrysymbol{#1}% }% } \newcommand*{\Glossentrysymbol}[1]{% - \glsdoifexists{#1}% + \glsdoifexistsorwarn{#1}% {% \Glsentrysymbol{#1}% }% @@ -5319,6 +5203,16 @@ false,nolabel,autolabel,nameref}[nolabel]{% \csdef{@glsacr@styledefs@#1}{#3}% }% } +\newcommand*{\renewacronymstyle}[3]{% + \ifcsdef{@glsacr@dispstyle@#1}% + {% + \csdef{@glsacr@dispstyle@#1}{#2}% + \csdef{@glsacr@styledefs@#1}{#3}% + }% + {% + \PackageError{glossaries}{Acronym style `#1' doesn't exist}{}% + }% +} \newcommand*{\GlsUseAcrEntryDispStyle}[1]{\csuse{@glsacr@dispstyle@#1}} \newcommand*{\GlsUseAcrStyleDefs}[1]{\csuse{@glsacr@styledefs@#1}} \newacronymstyle{long-short}% @@ -5371,7 +5265,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \protect\firstacronymfont{\Glsentryshortpl{##1}}##2\space (\glsentrylongpl{##1})% }% - \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}} + \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}}% \renewcommand*{\acronymsort}[2]{##1}% \renewcommand*{\acronymfont}[1]{##1}% \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% @@ -5522,7 +5416,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {% \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% \renewcommand*{\acrfullfmt}[3]{% - \glslink[##1]{##2}{\glsentryshort{##2}##3\space + \glslink[##1]{##2}{\glsentrylong{##2}##3\space (\acronymfont{\glsentryshort{##2}})}}% \renewcommand*{\Acrfullfmt}[3]{% \glslink[##1]{##2}{\Glsentrylong{##2}##3\space @@ -5532,10 +5426,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% \mfirstucMakeUppercase{\glsentrylong{##2}##3\space (\acronymfont{\glsentryshort{##2}})}}}% \renewcommand*{\acrfullplfmt}[3]{% - \glslink[##1]{##2}{\glsentryshortpl{##2}##3\space + \glslink[##1]{##2}{\glsentrylongpl{##2}##3\space (\acronymfont{\glsentryshortpl{##2}})}}% \renewcommand*{\Acrfullplfmt}[3]{% - \glslink[##1]{##2}{\Glsentryshortpl{##2}##3\space + \glslink[##1]{##2}{\Glsentrylongpl{##2}##3\space (\acronymfont{\glsentryshortpl{##2}})}}% \renewcommand*{\ACRfullplfmt}[3]{% \glslink[##1]{##2}{% @@ -5565,7 +5459,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {% \GlsUseAcrStyleDefs{dua}% \renewcommand*{\GenericAcronymFields}{}% - \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentrylong{##1}}} + \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentrylong{##1}}}% \renewcommand*{\acronymsort}[2]{##2}% }% \newacronymstyle{footnote}% @@ -6402,76 +6296,76 @@ false,nolabel,autolabel,nameref}[nolabel]{% \setglossarystyle{\@glossary@default@style} \fi \newcommand*{\showgloparent}[1]{% - \expandafter\show\csname glo@#1@parent\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@parent\endcsname } \newcommand*{\showglolevel}[1]{% - \expandafter\show\csname glo@#1@level\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@level\endcsname } \newcommand*{\showglotext}[1]{% - \expandafter\show\csname glo@#1@text\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@text\endcsname } \newcommand*{\showgloplural}[1]{% - \expandafter\show\csname glo@#1@plural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@plural\endcsname } \newcommand*{\showglofirst}[1]{% - \expandafter\show\csname glo@#1@first\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@first\endcsname } \newcommand*{\showglofirstpl}[1]{% - \expandafter\show\csname glo@#1@firstpl\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstpl\endcsname } \newcommand*{\showglotype}[1]{% - \expandafter\show\csname glo@#1@type\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@type\endcsname } \newcommand*{\showglocounter}[1]{% - \expandafter\show\csname glo@#1@counter\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@counter\endcsname } \newcommand*{\showglouseri}[1]{% - \expandafter\show\csname glo@#1@useri\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useri\endcsname } \newcommand*{\showglouserii}[1]{% - \expandafter\show\csname glo@#1@userii\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@userii\endcsname } \newcommand*{\showglouseriii}[1]{% - \expandafter\show\csname glo@#1@useriii\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useriii\endcsname } \newcommand*{\showglouseriv}[1]{% - \expandafter\show\csname glo@#1@useriv\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@useriv\endcsname } \newcommand*{\showglouserv}[1]{% - \expandafter\show\csname glo@#1@userv\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@userv\endcsname } \newcommand*{\showglouservi}[1]{% - \expandafter\show\csname glo@#1@uservi\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@uservi\endcsname } \newcommand*{\showgloname}[1]{% - \expandafter\show\csname glo@#1@name\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@name\endcsname } \newcommand*{\showglodesc}[1]{% - \expandafter\show\csname glo@#1@desc\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@desc\endcsname } \newcommand*{\showglodescplural}[1]{% - \expandafter\show\csname glo@#1@descplural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descplural\endcsname } \newcommand*{\showglosort}[1]{% - \expandafter\show\csname glo@#1@sort\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@sort\endcsname } \newcommand*{\showglosymbol}[1]{% - \expandafter\show\csname glo@#1@symbol\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbol\endcsname } \newcommand*{\showglosymbolplural}[1]{% - \expandafter\show\csname glo@#1@symbolplural\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolplural\endcsname } \newcommand*{\showgloshort}[1]{% - \expandafter\show\csname glo@#1@short\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@short\endcsname } \newcommand*{\showglolong}[1]{% - \expandafter\show\csname glo@#1@long\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@long\endcsname } \newcommand*{\showgloindex}[1]{% - \expandafter\show\csname glo@#1@index\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@index\endcsname } \newcommand*{\showgloflag}[1]{% - \expandafter\show\csname ifglo@#1@flag\endcsname + \expandafter\show\csname ifglo@\glsdetoklabel{#1}@flag\endcsname } \newcommand*{\showacronymlists}{% \show\@glsacronymlists diff --git a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty index f6791eb582a..15fc320613b 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 2013 Nicola Talbot +%% Copyright 2014 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-Brazilian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict index 7880c550996..cea3034b3ee 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Brazilian.dict @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Brazilian.dict,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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 3ba19bed470..10a32ffac18 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 2013 Nicola Talbot +%% Copyright 2014 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 dc293734ecb..562d104443f 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 2013 Nicola Talbot +%% Copyright 2014 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 49085eb0c0e..f42a60ea6d2 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 2013 Nicola Talbot +%% Copyright 2014 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 02de0418dcc..3f222bb9446 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 2013 Nicola Talbot +%% Copyright 2014 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 ea95ee503d1..ea0cfcb77f8 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 2013 Nicola Talbot +%% Copyright 2014 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 650644e8eef..c6cf04fc177 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 2013 Nicola Talbot +%% Copyright 2014 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 0ba4beba2e1..1156d2e1d9e 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 2013 Nicola Talbot +%% Copyright 2014 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 5bef7ed92bb..a44427a9f4c 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 2013 Nicola Talbot +%% Copyright 2014 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 c136b0d60d7..5908c8bdec9 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 2013 Nicola Talbot +%% Copyright 2014 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-Serbian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict index 2bbd7fa32d1..5755245f731 100644 --- a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict +++ b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-dictionary-Serbian.dict,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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 6db707a1608..ea04ece6a04 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 2013 Nicola Talbot +%% Copyright 2014 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/expl/glossaries-accsupp.sty b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty index 545b8c4072e..4e6e4a2a6ec 100644 --- a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty +++ b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-accsupp.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-accsupp}[2013/11/14 v4.0 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2014/01/20 v4.03 (NLCT) Experimental glossaries accessibility] \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}} \ProcessOptions @@ -48,9 +48,9 @@ \protected@edef\@do@glossentry{% \noexpand\accsuppglossaryentryfield{#1}% {\noexpand\glsnamefont - {\expandafter\expandonce\csname glo@#1@name\endcsname}}% - {\expandafter\expandonce\csname glo@#1@desc\endcsname}% - {\expandafter\expandonce\csname glo@#1@symbol\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@name\endcsname}}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@desc\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#1}@symbol\endcsname}% {\the\toks@}% }% \@do@glossentry @@ -61,9 +61,9 @@ \noexpand\accsuppglossarysubentryfield{\number#1}% {#2}% {\noexpand\glsnamefont - {\expandafter\expandonce\csname glo@#2@name\endcsname}}% - {\expandafter\expandonce\csname glo@#2@desc\endcsname}% - {\expandafter\expandonce\csname glo@#2@symbol\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@name\endcsname}}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@desc\endcsname}% + {\expandafter\expandonce\csname glo@\glsdetoklabel{#2}@symbol\endcsname}% {\the\toks@}% }% \@do@subglossentry @@ -186,43 +186,43 @@ \@glo@longpluralaccess}% } \newcommand*{\glsentryaccess}[1]{% - \csname glo@#1@access\endcsname + \@gls@entry@field{#1}{access}% } \newcommand*{\glsentrytextaccess}[1]{% - \csname glo@#1@textaccess\endcsname + \@gls@entry@field{#1}{textaccess}% } \newcommand*{\glsentryfirstaccess}[1]{% - \csname glo@#1@firstaccess\endcsname + \@gls@entry@field{#1}{firstaccess}% } \newcommand*{\glsentrypluralaccess}[1]{% - \csname glo@#1@pluralaccess\endcsname + \@gls@entry@field{#1}{pluralaccess}% } \newcommand*{\glsentryfirstpluralaccess}[1]{% \csname glo@#1@firstpluralaccess\endcsname } \newcommand*{\glsentrysymbolaccess}[1]{% - \csname glo@#1@symbolaccess\endcsname + \@gls@entry@field{#1}{symbolaccess}% } \newcommand*{\glsentrysymbolpluralaccess}[1]{% - \csname glo@#1@symbolpluralaccess\endcsname + \@gls@entry@field{#1}{symbolpluralaccess}% } \newcommand*{\glsentrydescaccess}[1]{% - \csname glo@#1@descaccess\endcsname + \@gls@entry@field{#1}{descaccess}% } \newcommand*{\glsentrydescpluralaccess}[1]{% - \csname glo@#1@descaccess\endcsname + \@gls@entry@field{#1}{descaccess}% } \newcommand*{\glsentryshortaccess}[1]{% - \csname glo@#1@shortaccess\endcsname + \@gls@entry@field{#1}{shortaccess}% } \newcommand*{\glsentryshortpluralaccess}[1]{% - \csname glo@#1@shortpluralaccess\endcsname + \@gls@entry@field{#1}{shortpluralaccess}% } \newcommand*{\glsentrylongaccess}[1]{% - \csname glo@#1@longaccess\endcsname + \@gls@entry@field{#1}{longaccess}% } \newcommand*{\glsentrylongpluralaccess}[1]{% - \csname glo@#1@longpluralaccess\endcsname + \@gls@entry@field{#1}{longpluralaccess}% } \newcommand*{\glsaccsupp}[2]{% \BeginAccSupp{ActualText=#1}#2\EndAccSupp{}% @@ -231,109 +231,52 @@ \protected@edef\@gls@replacementtext{#1}% \expandafter\glsaccsupp\expandafter{\@gls@replacementtext}{#2}% } -\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryaccess{#2}}% +\newcommand*{\@gls@access@display}[2]{% + \protected@edef\@glo@access{#2}% \ifx\@glo@access\@gls@noaccess #1% \else \xglsaccsupp{\@glo@access}{#1}% \fi } +\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% + \@gls@access@display{#1}{\glsentryaccess{#2}}% +} \DeclareRobustCommand*{\glstextaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrytextaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrytextaccess{#2}}% } \DeclareRobustCommand*{\glspluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrypluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrypluralaccess{#2}}% } \DeclareRobustCommand*{\glsfirstaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryfirstaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryfirstaccess{#2}}% } \DeclareRobustCommand*{\glsfirstpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryfirstpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryfirstpluralaccess{#2}}% } \DeclareRobustCommand*{\glssymbolaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrysymbolaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrysymbolaccess{#2}}% } \DeclareRobustCommand*{\glssymbolpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrysymbolpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrysymbolpluralaccess{#2}}% } \DeclareRobustCommand*{\glsdescriptionaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrydescaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrydescaccess{#2}}% } \DeclareRobustCommand*{\glsdescriptionpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrydescpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrydescpluralaccess{#2}}% } \DeclareRobustCommand*{\glsshortaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryshortaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryshortaccess{#2}}% } \DeclareRobustCommand*{\glsshortpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentryshortpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentryshortpluralaccess{#2}}% } \DeclareRobustCommand*{\glslongaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrylongaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrylongaccess{#2}}% } \DeclareRobustCommand*{\glslongpluralaccessdisplay}[2]{% - \protected@edef\@glo@access{\glsentrylongpluralaccess{#2}}% - \ifx\@glo@access\@gls@noaccess - #1% - \else - \xglsaccsupp{\@glo@access}{#1}% - \fi + \@gls@access@display{#1}{\glsentrylongpluralaccess{#2}}% } \DeclareRobustCommand*{\glsaccessdisplay}[3]{% \@ifundefined{gls#1accessdisplay}% @@ -506,11 +449,201 @@ }% }% } +\renewcommand*{\glsgenentryfmt}{% + \ifdefempty\glscustomtext + {% + \glsifplural + {% + \glscapscase + {% + \ifglsused\glslabel + {% + \glspluralaccessdisplay + {\glsentryplural{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glsfirstpluralaccessdisplay + {\glsentryfirstplural{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% + \ifglsused\glslabel + {% + \glspluralaccessdisplay + {\Glsentryplural{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glsfirstpluralaccessdisplay + {\Glsentryfirstplural{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% + \ifglsused\glslabel + {% + \glspluralaccessdisplay + {\mfirstucMakeUppercase{\glsentryplural{\glslabel}}}% + {\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + {% + \glsfirstpluralacessdisplay + {\mfirstucMakeUppercase{\glsentryfirstplural{\glslabel}}}% + {\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + }% + {% + \glscapscase + {% + \ifglsused\glslabel + {% + \glstextaccessdisplay{\glsentrytext{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glsfirstaccessdisplay{\glsentryfirst{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% + \ifglsused\glslabel + {% + \glstextaccessdisplay{\Glsentrytext{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glsfirstaccessdisplay{\Glsentryfirst{\glslabel}}{\glslabel}% + \glsinsert + }% + }% + {% + \ifglsused\glslabel + {% + \glstextaccessdisplay + {\mfirstucMakeUppercase{\glsentrytext{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + {% + \glsfirstaccessdisplay + {\mfirstucMakeUppercase{\glsentryfirst{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + }% + }% + {% + \glscustomtext\glsinsert + }% +} +\renewcommand*{\glsgenacfmt}{% + \ifdefempty\glscustomtext + {% + \ifglsused\glslabel + {% + \glsifplural + {% + \glscapscase + {% + \acronymfont + {\glsshortpluralaccessdisplay + {\glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% + \acronymfont + {\glsshortpluralaccessdisplay + {\Glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% + \mfirstucMakeUppercase + {\acronymfont + {\glsshortpluralaccessdisplay + {\glsentryshortpl{\glslabel}}{\glslabel}}% + \glsinsert}% + }% + }% + {% + \glscapscase + {% + \acronymfont + {\glsshortaccessdisplay{\glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% + \acronymfont + {\glsshortaccessdisplay{\Glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert + }% + {% + \mfirstucMakeUppercase + {\acronymfont{% + \glsshortaccessdisplay{\glsentryshort{\glslabel}}{\glslabel}}% + \glsinsert}% + }% + }% + }% + {% + \glsifplural + {% + \glscapscase + {% + \genplacrfullformat{\glslabel}{\glsinsert}% + }% + {% + \Genplacrfullformat{\glslabel}{\glsinsert}% + }% + {% + \mfirstucMakeUppercase + {\genplacrfullformat{\glslabel}{\glsinsert}}% + }% + }% + {% + \glscapscase + {% + \genacrfullformat{\glslabel}{\glsinsert}% + }% + {% + \Genacrfullformat{\glslabel}{\glsinsert}% + }% + {% + \mfirstucMakeUppercase + {\genacrfullformat{\glslabel}{\glsinsert}}% + }% + }% + }% + }% + {% + \glscustomtext + }% +} +\renewcommand*{\genacrfullformat}[2]{% + \glslongaccessdisplay{\glsentrylong{#1}}{#1}#2\space + (\glsshortaccessdisplay{\protect\firstacronymfont{\glsentryshort{#1}}}{#1})% +} +\renewcommand*{\Genacrfullformat}[2]{% + \glslongaccessdisplay{\Glsentrylong{#1}}{#1}#2\space + (\glsshortaccessdisplay{\protect\firstacronymfont{\Glsentryshort{#1}}}{#1})% +} +\renewcommand*{\genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\glsentrylongpl{#1}}{#1}#2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{#1}}}{#1})% +} +\renewcommand*{\Genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{#1}}{#1}#2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{#1}}}{#1})% +} \def\@acrshort#1#2[#3]{% \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -524,7 +657,6 @@ \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@secondofthree \let\glsinsert\@empty @@ -538,7 +670,6 @@ \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@thirdofthree \let\glsinsert\@empty @@ -553,7 +684,6 @@ \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -567,7 +697,6 @@ \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -581,7 +710,6 @@ \glsdoifexists{#2}% {% \edef\@glo@type{\glsentrytype{#2}}% - \def\glslabel{#2}% \let\glsifplural\@secondoftwo \let\glscapscase\@firstofthree \let\glsinsert\@empty @@ -640,6 +768,391 @@ {\glsdescriptionaccessdisplay{#4}{#2}}% {\glssymbolaccessdisplay{#5}{#2}}{#6}% } +\renewacronymstyle{long-short}% +{% + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\genacrfullformat}[2]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}##2\space + (\glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\Genacrfullformat}[2]{% + \glslongaccessdisplay{\Glsentrylong{##1}}{##1}##2\space + (\glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}##2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{##1}}{##1}##2\space + (\glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +} +\renewacronymstyle{short-long}% +{% + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1}##2\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})% + }% + \renewcommand*{\Genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\Glsentryshort{##1}}}{##1}##2\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1}##2\space + (\glslongpluralaccessdisplay + {\glsentrylongpl{##1}}{##1})% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\Glsentryshortpl{##1}}}{##1}##2\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +} +\renewacronymstyle{long-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-short}% +}% +{% + \GlsUseAcrStyleDefs{long-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{long-sc-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-sc-short}% +}% +{% + \GlsUseAcrStyleDefs{long-sc-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{long-sm-short-desc}% +{% + \GlsUseAcrEntryDispStyle{long-sm-short}% +}% +{% + \GlsUseAcrStyleDefs{long-sm-short}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{short-long}% +}% +{% + \GlsUseAcrStyleDefs{short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{sc-short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{sc-short-long}% +}% +{% + \GlsUseAcrStyleDefs{sc-short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{sm-short-long-desc}% +{% + \GlsUseAcrEntryDispStyle{sm-short-long}% +}% +{% + \GlsUseAcrStyleDefs{sm-short-long}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{dua}% +{% + \ifdefempty\glscustomtext + {% + \ifglshaslong{\glslabel}% + {% + \glsifplural + {% + \glscapscase + {% + \glslongpluralaccessdisplay{\glsentrylongpl{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glslongpluralaccessdisplay{\Glsentrylongpl{\glslabel}}{\glslabel}% + \glsinsert + }% + {% + \glslongpluralaccessdisplay + {\mfirstucMakeUppercase{\glsentrylongpl{\glslabel}}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + {% + \glscapscase + {% + \glslongaccessdisplay{\glsentrylong{\glslabel}}{\glslabel}\glsinsert + }% + {% + \glslongaccessdisplay{\Glsentrylong{\glslabel}}{\glslabel}\glsinsert + }% + {% + \glslongaccessdisplay + {\mfirstucMakeUppercase + {\glsentrylong{\glslabel}\glsinsert}}{\glslabel}% + \mfirstucMakeUppercase{\glsinsert}% + }% + }% + }% + {% + \glsgenentryfmt + }% + }% + {\glscustomtext\glsinsert}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay{\glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}% + \renewcommand*{\Acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay{\Glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}% + \renewcommand*{\ACRfullfmt}[3]{% + \glslink[##1]{##2}{% + \glslongaccessdisplay + {\mfirstucMakeUppercase{\glsentrylong{##2}}{##2}##3\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2})}}}% + \renewcommand*{\acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}% + \renewcommand*{\Acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\Glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}% + \renewcommand*{\ACRfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glslongpluralaccessdisplay + {\mfirstucMakeUppercase{\glsentrylongpl{##2}}{##2}##3\space + (\glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2})}}}% + \renewcommand*{\glsentryfull}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\Glsentryfull}[1]{% + \glslongaccessdisplay{\Glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})% + }% + \renewcommand*{\glsentryfullpl}[1]{% + \glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}\space + (\glsshortpluralaccessdisplay{\acronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\Glsentryfullpl}[1]{% + \glslongpluralaccessdisplay{\Glsentrylongpl{##1}}{##1}\space + (\glsshortpluralaccessdisplay{\acronymfont{\glsentryshortpl{##1}}}{##1})% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +} +\renewacronymstyle{dua-desc}% +{% + \GlsUseAcrEntryDispStyle{dua}% +}% +{% + \GlsUseAcrStyleDefs{dua}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\acronymfont{\glsentrylong{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##2}% +}% +\renewacronymstyle{footnote}% +{% + \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% +}% +{% + \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \glshyperfirstfalse + \renewcommand*{\genacrfullformat}[2]{% + \glsshortaccessdisplay + {\protect\firstacronymfont{\glsentryshort{##1}}}{##1}##2% + \protect\footnote{\glslongaccessdisplay{\glsentrylong{##1}}{##1}}% + }% + \renewcommand*{\Genacrfullformat}[2]{% + \glsshortaccessdisplay + {\firstacronymfont{\Glsentryshort{##1}}}{##1}##2% + \protect\footnote{\glslongaccessdisplay{\glsentrylong{##1}}{##1}}% + }% + \renewcommand*{\genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\glsentryshortpl{##1}}}{##1}##2% + \protect\footnote{\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}}% + }% + \renewcommand*{\Genplacrfullformat}[2]{% + \glsshortpluralaccessdisplay + {\protect\firstacronymfont{\Glsentryshortpl{##1}}}{##1}##2% + \protect\footnote{\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1}}% + }% + \renewcommand*{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}}% + \renewcommand*{\acronymsort}[2]{##1}% + \renewcommand*{\acronymfont}[1]{##1}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% + \renewcommand*{\acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}% + \renewcommand*{\Acrfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay{\acronymfont{\Glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}% + \renewcommand*{\ACRfullfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortaccessdisplay + {\mfirstucMakeUppercase + {\acronymfont{\glsentryshort{##2}}}{##2}##3\space + (\glslongaccessdisplay{\glsentrylong{##2}}{##2})}}}% + \renewcommand*{\acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}}{##2})}}% + \renewcommand*{\Acrfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\acronymfont{\Glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}})}}% + \renewcommand*{\ACRfullplfmt}[3]{% + \glslink[##1]{##2}{% + \glsshortpluralaccessdisplay + {\mfirstucMakeUppercase + {\acronymfont{\glsentryshortpl{##2}}}{##2}##3\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##2}}{##2})}}}% + \renewcommand*{\glsentryfull}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})}% + \renewcommand*{\Glsentryfull}[1]{% + \glsshortaccessdisplay{\acronymfont{\Glsentryshort{##1}}}{##1}\space + (\glslongaccessdisplay{\glsentrylong{##1}}{##1})}% + \renewcommand*{\glsentryfullpl}[1]{% + \glsshortpluralaccessdisplay + {\acronymfont{\glsentryshortpl{##1}}}{##1}\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})}% + \renewcommand*{\Glsentryfullpl}[1]{% + \glsshortpluralaccessdisplay + {\acronymfont{\Glsentryshortpl{##1}}}{##1}\space + (\glslongpluralaccessdisplay{\glsentrylongpl{##1}}{##1})}% +} +\renewacronymstyle{footnote-sc}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand{\acronymfont}[1]{\textsc{##1}}% + \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}% +}% +\renewacronymstyle{footnote-sm}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand{\acronymentry}[1]{% + \glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1}} + \renewcommand{\acronymfont}[1]{\textsmaller{##1}}% + \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}% +}% +\renewacronymstyle{footnote-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote}% +}% +{% + \GlsUseAcrStyleDefs{footnote}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{footnote-sc-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote-sc}% +}% +{% + \GlsUseAcrStyleDefs{footnote-sc}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} +\renewacronymstyle{footnote-sm-desc}% +{% + \GlsUseAcrEntryDispStyle{footnote-sm}% +}% +{% + \GlsUseAcrStyleDefs{footnote-sm}% + \renewcommand*{\GenericAcronymFields}{}% + \renewcommand*{\acronymsort}[2]{##2}% + \renewcommand*{\acronymentry}[1]{% + \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space + (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% +} \renewcommand*{\newacronymhook}{% \edef\@gls@keylist{shortaccess=\the\glslongtok,% \the\glskeylisttok}% @@ -677,7 +1190,22 @@ \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@descplural\gls@assign@descplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } \renewcommand*{\DescriptionFootnoteNewAcronymDef}{% \edef\@do@newglossaryentry{% @@ -701,7 +1229,22 @@ \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } \renewcommand*{\DescriptionNewAcronymDef}{% \edef\@do@newglossaryentry{% @@ -730,7 +1273,22 @@ textaccess={\noexpand\@glo@shortaccess},% \the\glskeylisttok}% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } \renewcommand*{\FootnoteNewAcronymDef}{% \edef\@do@newglossaryentry{% @@ -752,7 +1310,22 @@ \the\glskeylisttok }% }% + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@descplural\gls@assign@descplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@descplural\@org@gls@assign@descplural } \renewcommand*{\SmallNewAcronymDef}{% \edef\@do@newglossaryentry{% @@ -781,50 +1354,70 @@ \the\glskeylisttok }% }% + \let\@org@gls@assign@firstpl\gls@assign@firstpl + \let\@org@gls@assign@plural\gls@assign@plural + \let\@org@gls@assign@descplural\gls@assign@descplural + \let\@org@gls@assign@symbolplural\gls@assign@symbolplural + \def\gls@assign@firstpl##1##2{% + \@@gls@expand@field{##1}{firstpl}{##2}% + }% + \def\gls@assign@plural##1##2{% + \@@gls@expand@field{##1}{plural}{##2}% + }% + \def\gls@assign@descplural##1##2{% + \@@gls@expand@field{##1}{descplural}{##2}% + }% + \def\gls@assign@symbolplural##1##2{% + \@@gls@expand@field{##1}{symbolplural}{##2}% + }% \@do@newglossaryentry + \let\gls@assign@firstpl\@org@gls@assign@firstpl + \let\gls@assign@plural\@org@gls@assign@plural + \let\gls@assign@descplural\@org@gls@assign@descplural + \let\gls@assign@symbolplural\@org@gls@assign@symbolplural } \newcommand*{\glsshortaccesskey}{\glsshortkey access}% \newcommand*{\glsshortpluralaccesskey}{\glsshortpluralkey access}% \newcommand*{\glslongaccesskey}{\glslongkey access}% \newcommand*{\glslongpluralaccesskey}{\glslongpluralkey access}% \newcommand*{\showglonameaccess}[1]{% - \expandafter\show\csname glo@#1@textaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@textaccess\endcsname } \newcommand*{\showglotextaccess}[1]{% - \expandafter\show\csname glo@#1@textaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@textaccess\endcsname } \newcommand*{\showglopluralaccess}[1]{% - \expandafter\show\csname glo@#1@pluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@pluralaccess\endcsname } \newcommand*{\showglofirstaccess}[1]{% - \expandafter\show\csname glo@#1@firstaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstaccess\endcsname } \newcommand*{\showglofirstpluralaccess}[1]{% - \expandafter\show\csname glo@#1@firstpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@firstpluralaccess\endcsname } \newcommand*{\showglosymbolaccess}[1]{% - \expandafter\show\csname glo@#1@symbolaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolaccess\endcsname } \newcommand*{\showglosymbolpluralaccess}[1]{% - \expandafter\show\csname glo@#1@symbolpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@symbolpluralaccess\endcsname } \newcommand*{\showglodescaccess}[1]{% - \expandafter\show\csname glo@#1@descaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descaccess\endcsname } \newcommand*{\showglodescpluralaccess}[1]{% - \expandafter\show\csname glo@#1@descpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@descpluralaccess\endcsname } \newcommand*{\showgloshortaccess}[1]{% - \expandafter\show\csname glo@#1@shortaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@shortaccess\endcsname } \newcommand*{\showgloshortpluralaccess}[1]{% - \expandafter\show\csname glo@#1@shortpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@shortpluralaccess\endcsname } \newcommand*{\showglolongaccess}[1]{% - \expandafter\show\csname glo@#1@longaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@longaccess\endcsname } \newcommand*{\showglolongpluralaccess}[1]{% - \expandafter\show\csname glo@#1@longpluralaccess\endcsname + \expandafter\show\csname glo@\glsdetoklabel{#1}@longpluralaccess\endcsname } \endinput %% 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 f6f9ca6f80d..b511719400d 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 2013 Nicola Talbot +%% Copyright 2014 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-inline.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty index 49329c6bbec..11a6e98494f 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-inline.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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 3f9e207dc89..6476799549c 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 2013 Nicola Talbot +%% Copyright 2014 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-long.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty index 82adcae3aab..19689903576 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 2013 Nicola Talbot +%% Copyright 2014 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-longragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty index 3374df02639..5d40e29467a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-longragged.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-mcols.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty index bf8a64521c8..8e519073513 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-mcols.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-super.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty index 39748f84638..63dfc412197 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 2013 Nicola Talbot +%% Copyright 2014 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-superragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty index 58631275dd1..a4ac46d5631 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-superragged.sty,package') %% %% glossaries.dtx -%% Copyright 2013 Nicola Talbot +%% Copyright 2014 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-tree.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty index b84359acecd..74c4f0c18f3 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 2013 Nicola Talbot +%% Copyright 2014 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 -- cgit v1.2.3