From 18d3ed873290d987fea4820b83615c3f35c44770 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 21 May 2012 23:39:22 +0000 Subject: glossaries 3.02 (21may12) git-svn-id: svn://tug.org/texlive/trunk@26547 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 50 + Master/texmf-dist/doc/latex/glossaries/README | 7 +- .../doc/latex/glossaries/glossaries-user.html | 30365 ++++++++++--------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 752347 -> 480211 bytes .../doc/latex/glossaries/glossaries-user.tex | 703 +- .../texmf-dist/doc/latex/glossaries/glossaries.pdf | Bin 1177041 -> 745377 bytes .../doc/latex/glossaries/glossariesbegin.html | 710 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 112598 -> 92340 bytes .../doc/latex/glossaries/glossariesbegin.tex | 6 +- .../doc/latex/glossaries/glossary2glossaries.html | 2751 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 338575 -> 322249 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 7 +- .../doc/latex/glossaries/mfirstuc-manual.html | Bin 18633 -> 21582 bytes .../doc/latex/glossaries/mfirstuc-manual.pdf | Bin 224462 -> 154593 bytes .../doc/latex/glossaries/mfirstuc-manual.tex | 55 +- .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 37801 -> 34466 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 58986 -> 53490 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 83061 -> 77296 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 38192 -> 36486 bytes .../doc/latex/glossaries/samples/sample-inline.tex | 141 + .../latex/glossaries/samples/sample-langdict.tex | 34 + .../latex/glossaries/samples/sample-mfirstuc.tex | 29 + .../latex/glossaries/samples/sample-numberlist.tex | 34 + .../doc/latex/glossaries/samples/sample.pdf | Bin 119174 -> 102323 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 45565 -> 43346 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 79982 -> 66097 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 74774 -> 65568 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 51086 -> 47070 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 56059 -> 48474 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 172108 -> 155597 bytes .../doc/latex/glossaries/samples/sampleEq.tex | 4 +- .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 202692 -> 169151 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 110592 -> 97352 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 76423 -> 65976 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 48285 -> 45763 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 67704 -> 64428 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 75391 -> 59849 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 47388 -> 44950 bytes .../glossaries/samples/samplexdy-compatible207.pdf | Bin 175030 -> 165014 bytes .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 191489 -> 92375 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 75756 -> 67647 bytes .../texmf-dist/scripts/glossaries/makeglossaries | 10 +- .../source/latex/glossaries/glossaries.dtx | 1588 +- .../source/latex/glossaries/glossaries.ins | 14 +- .../tex/latex/glossaries/base/glossaries-babel.sty | 4 +- .../glossaries/base/glossaries-compatible-207.sty | 4 +- .../glossaries/base/glossaries-polyglossia.sty | 4 +- .../tex/latex/glossaries/base/glossaries.sty | 664 +- .../tex/latex/glossaries/base/mfirstuc.sty | 29 +- .../dict/glossaries-dictionary-Brazilian.dict | 4 +- .../dict/glossaries-dictionary-Danish.dict | 4 +- .../dict/glossaries-dictionary-Dutch.dict | 4 +- .../dict/glossaries-dictionary-English.dict | 4 +- .../dict/glossaries-dictionary-French.dict | 4 +- .../dict/glossaries-dictionary-German.dict | 4 +- .../dict/glossaries-dictionary-Irish.dict | 4 +- .../dict/glossaries-dictionary-Italian.dict | 4 +- .../dict/glossaries-dictionary-Magyar.dict | 4 +- .../dict/glossaries-dictionary-Polish.dict | 4 +- .../dict/glossaries-dictionary-Serbian.dict | 4 +- .../dict/glossaries-dictionary-Spanish.dict | 4 +- .../latex/glossaries/expl/glossaries-accsupp.sty | 4 +- .../latex/glossaries/styles/glossary-hypernav.sty | 4 +- .../latex/glossaries/styles/glossary-inline.sty | 83 + .../tex/latex/glossaries/styles/glossary-list.sty | 4 +- .../tex/latex/glossaries/styles/glossary-long.sty | 4 +- .../glossaries/styles/glossary-longragged.sty | 4 +- .../tex/latex/glossaries/styles/glossary-mcols.sty | 152 + .../tex/latex/glossaries/styles/glossary-super.sty | 4 +- .../glossaries/styles/glossary-superragged.sty | 4 +- .../tex/latex/glossaries/styles/glossary-tree.sty | 4 +- 71 files changed, 20743 insertions(+), 16785 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex create mode 100644 Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty create mode 100644 Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 14187b28fae..6e91aa9e806 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,55 @@ glossaries change log: +v3.02: + + * new package options: + + - 'ucmark' + - 'indexonlyfirst' + - 'savenumberlist' + + * new glossary styles: + + - glossary-mcol.sty + - glossary-inline.sty + + * new commands: + + - \glolinkprefix + - \glsmoveentry + - \renewglossarystyle + - \ifglshaschildren + - \ifglshasparent + - \glsresetentrycounter + - \glsentrynumberlist + - \glsdisplaynumberlist + + * added check to \glswritefiles to see if glossary tokens have + been defined in case savewrites option used and \makeglossaries + omitted. + + * fixed bug in \showglossaryentries + + * fixed bug in \SmallNewAcronymDef + + * fixed unwanted space in + \SetDescriptionFootnoteAcronymDisplayStyle + + * fixed [xindy] wrong page number bug for entries occurring in + paragraph spanning page break + + * fixed bug in \Glsentryfull and \glsentryfullpl + + * swapped order of checks for babel and polyglossia + + mfirstuc v1.06: + + * added \capitalisewords, \xcapitalisewords + + makeglossaries v2.04: + + * fixed bug in &scan_aux + v3.01: * made commands like \glslink, \gls and \acrshort robust diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 9bd5d16869e..52a04280724 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v3.01 +LaTeX Package : glossaries v3.02 -Last Modified : 2011-04-12 +Last Modified : 2012-05-21 Author : Nicola Talbot @@ -51,7 +51,8 @@ supertabular package isn't installed, you can still use the glossaries package, but you won't be able to use any of the styles defined in glossaries-super.sty. If you want to use glossary-longragged.sty or glossary-superragged.sty you will also -need the array package. +need the array package. If you want to use glossary-mcols you will +also need the multicol package. Note that the current version of the glossaries package doesn't load xspace. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index e7d70cec6eb..d2bfbd760d1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -1,156 +1,207 @@ - + -User Manual for glossaries.sty v3.01 - +User Manual for glossaries.sty v3.02 + - + - + -
- +
+ - - + + - + + -

User Manual for glossaries.sty v3.01

-
Nicola L.C. Talbot -
School of Computing Sciences + +
+
+ +

User Manual for glossaries.sty +v3.02

+
+class="ec-lmtt-12x-x-120">http://theoval.cmp.uea.ac.uk/~nlct/

2011-04-12
-
-

The glossaries bundle comes with the following documentation: +class="ec-lmr-12x-x-120">2012-05-21

+ + + +
+

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="ec-lmtk-10x-x-109">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="ec-lmtk-10x-x-109">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="ec-lmssbx-10x-x-109">glossaries-user.pdf
This document is the main user guide for the + glossaries package.
mfirstuc-manual.pdf
mfirstuc-manual.pdf
The commands provided by the mfirstuc package are - briefly described in “mfirstuc.sty: uppercasing first letter”. +class="ec-lmss-10x-x-109">mfirstuc + package are briefly described in “mfirstuc.sty: uppercasing first + letter”.
glossaries.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 v3.01”. This includes how to iterate over all entry labels - defined in a given glossary or how to iterate over all glossary types, as well - as the documented code for the mfirstucglossaries.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 v3.02”. 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

If you use hyperref and glossaries, you must load hyperrefglossaries, you must load hyperref first.
-

- +class="ec-lmri-10x-x-109">first. +

+

+ + + + - +

-

Contents

-
- Contents +
+   Glossary -
1 Introduction -
 1.1 Sample Documents -
 1.2 Multi-Lingual Support -
  1.2.1 Changing the Fixed Names -
 1.3 Generating the Associated Glossary Files -
  1.3.1 Using the makeglossaries Perl Script -
  1.3.2 Using xindy explicitly -
  1.3.3 Using makeindex explicitly -
  1.3.4 Note to Front-End and Script Developers -
2 Package Options -
 2.1 General Options -
 2.2 Sectioning and TOC Options -
 2.3 Glossary Appearance Options -
 2.4 Sorting Options -
 2.5 Acronym Options -
3 Setting Up -
4 Defining Glossary Entries -
 4.1 Plurals -
 4.2 Sub-Entries -
  4.2.1 Hierarchical Categories -
  4.2.2 Homographs -
 4.3 Loading Entries From a File -
5 Number lists -
6 Links to Glossary Entries -
 6.1 Changing the format of the link text -
 6.2 Enabling and disabling hyperlinks to glossary entries -
7 Adding an Entry to the Glossary Without Generating Text -
8 Cross-Referencing Entries -
 8.1 Customising Cross-reference Text -
9 Using Glossary Terms Without Links -
10 Displaying a glossary -
11 Xindy -
 11.1 Language and Encodings -
 11.2 Locations and Number lists -
 11.3 Glossary Groups -
12 Defining New Glossaries -
13 Acronyms -
 13.1 Predefined Acronym Styles -
 13.2 Displaying the List of Acronyms -
 13.3 Defining A Custom Acronym Style -
 13.4 Upgrading From the glossary Package - - - -
14 Unsetting and Resetting Entry Flags -
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 -
16 Defining your own glossary style -
 16.1 Example: creating a completely new style -
 16.2 Example: creating a new glossary style based on an existing style -
 16.3 Example: creating a glossary style that uses the user1, …, user6 keys -
17 Accessibility Support -
18 Troubleshooting -
Index -
- - - -

1  Introduction +
 1.1  Sample Documents +
 1.2  Multi-Lingual Support +
  1.2.1  Changing the Fixed Names +
 1.3  Generating the Associated Glossary Files +
  1.3.1  Using the makeglossaries Perl Script +
  1.3.2  Using xindy explicitly +
  1.3.3  Using makeindex explicitly +
  1.3.4  Note to Front-End and Script Developers +
2  Package Options +
 2.1  General Options +
 2.2  Sectioning, Headings and TOC Options +
 2.3  Glossary Appearance Options +
 2.4  Sorting Options +
 2.5  Acronym Options +
3  Setting Up +
4  Defining Glossary Entries +
 4.1  Plurals +
 4.2  Other Grammatical Constructs +
 4.3  Sub-Entries +
  4.3.1  Hierarchical Categories +
  4.3.2  Homographs +
 4.4  Loading Entries From a File +
 4.5  Moving Entries to Another Glossary +
5  Number lists +
6  Links to Glossary Entries +
 6.1  Changing the format of the link text +
 6.2  Enabling and disabling hyperlinks to glossary entries +
7  Adding an Entry to the Glossary Without Generating Text +
8  Cross-Referencing Entries +
 8.1  Customising Cross-reference Text +
9  Using Glossary Terms Without Links +
10  Displaying a glossary +
11  Xindy + + + +
 11.1  Language and Encodings +
 11.2  Locations and Number lists +
 11.3  Glossary Groups +
12  Defining New Glossaries +
13  Acronyms +
 13.1  Predefined Acronym Styles +
 13.2  Displaying the List of Acronyms +
 13.3  Defining A Custom Acronym Style +
 13.4  Upgrading From the glossary Package +
14  Unsetting and Resetting Entry Flags +
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 +
 16.1  Example: creating a completely new style +
 16.2  Example: creating a new glossary style based on an existing style +
 16.3  Example: creating a glossary style that uses the user1, …, user6 keys +
17  Utilities +
18  Accessibility Support +
19  Troubleshooting +
  Index +

+ + + + + + + + + +

+ + +

-

Glossary

+

Glossary

This glossary style was setup using:

+class="ec-lmri-10x-x-109">This glossary style was setup using:

\usepackage[\usepackage[xindy, +class="ec-lmtt-10x-x-109">xindy,
-

nonumberlist,
-

nonumberlist,
+

seeautonumberlist,
-

seeautonumberlist,
+

toc,
-

toc,
+

style=altlist]{glossaries}
+class="ec-lmtt-10x-x-109">style=altlist]{glossaries}

\renewcommand*{\glsgroupskip\renewcommand*{\glsgroupskip}{}
}{}
\renewcommand*{\glsseeformat\renewcommand*{\glsseeformat}[3][\seename}[3][\seename]{(\xmakefirstuc{#1}
]{%
\glsseelist(\xmakefirstuc{#1} \glsseelist{#2}.)} +class="ec-lmtt-10x-x-109">{#2}.)}

Entry locationEntry location

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.
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.
First useFirst 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: \glsThe 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, \GLS\GLS, \glspl, - \Glspl\glspl, \Glspl, \GLSpl\GLSpl or \glsdisp. (See \glsdisp. (See + first use flag & first use text.)
First use flagFirst use flag

A conditional that determines whether or not the entry has been used - according to the rules of 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.
first use. Commands to unset + or reset this conditional are described in §14 Unsetting and + Resetting Entry Flags.
+ + + First use textFirst 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 \glsdispfirst use, which is governed by + the first and firstplural keys of \newglossaryentry. (May be + overridden by \glsdisp.)
- - -
Link textLink 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 entry locations. 21, (See number list.)
makeglossariesmakeglossaries

A glossaries custom designed Perl script interface to glossaries custom designed Perl script interface to xindy and xindy and + makeindex. -
makeindex.
+
+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.
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. -

When TEX writes information to a file, fragile commands must be - protected. The name, description and symbol keys all have their values written - to a file, which means that care must be taken if those values contain fragile - commands. There are two approaches: 1) the fragile commands must be - protected using \protect; 2) the values are sanitized. Sanitizing the values - gets rid of the inconvenience of having to protect fragile commands, but at - the expense of no longer being able to use those values in the document. - Sanitization is governed by the package option sanitize described in §2.1 - General Options.
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. +

When TEX writes information to a file, fragile commands must + be protected. The name, description and symbol keys all have + their values written to a file, which means that care must be + taken if those values contain fragile commands. There are two + approaches: 1) the fragile commands must be protected using + \protect; 2) the values are sanitized. Sanitizing the values gets + rid of the inconvenience of having to protect fragile commands, + but at the expense of no longer being able to use those values + in the document. Sanitization is governed by the package option + sanitize described in §2.1 General Options.

xindy
xindy

An flexible indexing application with multilingual support written in Perl.
An flexible indexing application with multilingual support + written in Perl.
-

-

-

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

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 used11 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 makeglossaries. +This provides a convenient interface to 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 called makeindex or -makeindex or xindy explicitly. See §1.3 Generating the Associated Glossary Files for further details. +class="ec-lmtt-10x-x-109">xindy explicitly. See +§1.3 Generating the Associated Glossary Files for further details.
-

-

The remainder of this introductory section covers the following:

+

+

The remainder of this introductory section covers the following: +

- +

1.1  Sample Documents

+ - -

-

-

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 package is provided with some sample documents +that illustrate the various functions. These should be located in the glossaries documentation directory. This location varies according to your -operating system and Tsamples 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 terminal or command prompt, type: +class="ec-lmtt-10x-x-109">texdoc to locate the main glossaries +documentation. For example, in a terminal or command prompt, type: -
texdoc -l glossaries
-

+
texdoc -l glossaries +

This should display the full pathname of the file glossaries.pdf. View the contents of -that directory and see if it contains the samples subdirectory. -

If you can’t find the sample files, they are available in the subdirectory -doc/latex/glossaries/samples/ in the glossaries.tds.zip archive which can be -downloaded from glossaries.pdf. View +the contents of that directory and see if it contains the samples +subdirectory. +

If you can’t find the sample files, they are available in the subdirectory +doc/latex/glossaries/samples/ in the glossaries.tds.zip archive +which can be downloaded from CTAN. -

The sample documents are as follows: +

The sample documents are as follows:

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

    4. +
    5. Run makeglossaries on the document. 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 makeglossaries on the document. 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 §1.3.3 Using makeindex explicitly for further details on using 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 makeindex - explicitly.) -

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

    6. -
    7. makeindex explicitly.) +

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

    8. +
    9. 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
    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: +class="ec-lmssbx-10x-x-109">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: +
    latex sample4col +class="ec-lmtt-10x-x-109">latex sample4col

    makeglossaries sample4col +class="ec-lmtt-10x-x-109">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 by redefining - \glsgroupskip after the glossary style has been set: - +class="ec-lmtt-10x-x-109">makeglossaries. The vertical + gap between entries is the gap created at the start of each group. + This can be suppressed by redefining \glsgroupskip after the + glossary style has been set: + - +

    \renewcommand*{\glsgroupskip}{}
    -

    +

    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: +class="ec-lmssbx-10x-x-109">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: +
    latex sampleAcr +class="ec-lmtt-10x-x-109">latex sampleAcr

    makeglossaries sampleAcr +class="ec-lmtt-10x-x-109">makeglossaries sampleAcr
    latex sampleAcr +class="ec-lmtt-10x-x-109">latex sampleAcr
    latex sampleAcr -

    +class="ec-lmtt-10x-x-109">latex sampleAcr +

    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: +class="ec-lmssbx-10x-x-109">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:
    latex sampleAcrDesc +class="ec-lmtt-10x-x-109">latex sampleAcrDesc

    makeglossaries sampleAcrDesc +class="ec-lmtt-10x-x-109">makeglossaries sampleAcrDesc
    latex sampleAcrDesc +class="ec-lmtt-10x-x-109">latex sampleAcrDesc
    latex sampleAcrDesc -

    +class="ec-lmtt-10x-x-109">latex sampleAcrDesc +

    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: +class="ec-lmssbx-10x-x-109">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: +
    latex sampleDesc +class="ec-lmtt-10x-x-109">latex sampleDesc
    + + +
    makeglossaries sampleDesc +class="ec-lmtt-10x-x-109">makeglossaries sampleDesc
    latex sampleDesc +class="ec-lmtt-10x-x-109">latex sampleDesc
    latex sampleDesc -

    - - - +class="ec-lmtt-10x-x-109">latex sampleDesc +

    sample-custom-acronym.tex
    This document illustrates how to define your - own acronym style if the predefined styles don’t suit your requirements. - +class="ec-lmssbx-10x-x-109">sample-custom-acronym.tex
    This document illustrates how to define + your own acronym style if the predefined styles don’t suit your + requirements.
    latex sample-custom-acronym +class="ec-lmtt-10x-x-109">latex sample-custom-acronym

    makeglossaries sample-custom-acronym +class="ec-lmtt-10x-x-109">makeglossaries sample-custom-acronym
    latex sample-custom-acronym -

    +class="ec-lmtt-10x-x-109">latex sample-custom-acronym +

    sample-crossref.tex
    This document illustrates how to cross-reference entries in the - glossary. +class="ec-lmssbx-10x-x-109">sample-crossref.tex
    This document illustrates how to cross-reference + entries in the glossary.
    latex sample-crossref +class="ec-lmtt-10x-x-109">latex sample-crossref

    makeglossaries sample-crossref +class="ec-lmtt-10x-x-109">makeglossaries sample-crossref
    latex sample-crossref -

    +class="ec-lmtt-10x-x-109">latex sample-crossref +

    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 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 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-4022"> 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="ec-lmtt-10x-x-109">latex sampleDB

    makeglossaries sampleDB +class="ec-lmtt-10x-x-109">makeglossaries sampleDB

    latex sampleDB -

    - The glossary definitions are stored in the accompanying files database1.tex and +class="ec-lmtt-10x-x-109">latex sampleDB +

    + The glossary definitions are stored in the accompanying files database2.tex. Note that if you don’t have Perl installed, you will need to use - database1.tex and 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. +
      2. Create the main glossary: -
        makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls - sampleDB.glo
        -

        -

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

        +

      5. +
      6. Create the secondary glossary: - - - -
        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
    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 equationsampleEq.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 environment. To create the document - do: + id="dx1-4033"> environment. To create the document do: +
    latex sampleEq +class="ec-lmtt-10x-x-109">latex sampleEq

    makeglossaries sampleEq +class="ec-lmtt-10x-x-109">makeglossaries sampleEq

    latex sampleEq -

    +class="ec-lmtt-10x-x-109">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="ec-lmtt-10x-x-109">latex sampleEqPg

    makeglossaries sampleEqPg +class="ec-lmtt-10x-x-109">makeglossaries sampleEqPg

    latex sampleEqPg +class="ec-lmtt-10x-x-109">latex sampleEqPg
    latex sampleEqPg -

    +class="ec-lmtt-10x-x-109">latex sampleEqPg +

    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: +class="ec-lmssbx-10x-x-109">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: +
    latex sampleSec +class="ec-lmtt-10x-x-109">latex sampleSec

    makeglossaries sampleSec +class="ec-lmtt-10x-x-109">makeglossaries sampleSec
    latex sampleSec +class="ec-lmtt-10x-x-109">latex sampleSec
    latex sampleSec -

    - - - +class="ec-lmtt-10x-x-109">latex sampleSec +

    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 LATEX run - is required: +class="ec-lmssbx-10x-x-109">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 LATEX run is required:
    latex sampleNtn +class="ec-lmtt-10x-x-109">latex sampleNtn

    makeglossaries sampleNtn +class="ec-lmtt-10x-x-109">makeglossaries sampleNtn
    latex sampleNtn +class="ec-lmtt-10x-x-109">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. +
      2. Create the main glossary: -
        makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls - sampleNtn.glo
        -

        -

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

        +

      5. +
      6. Create the secondary glossary: -
        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
    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: +class="ec-lmssbx-10x-x-109">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: + + + +
    latex sample +class="ec-lmtt-10x-x-109">latex sample

    makeglossaries sample +class="ec-lmtt-10x-x-109">makeglossaries sample
    latex sample +class="ec-lmtt-10x-x-109">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="ec-lmtt-10x-x-109">makeindex + explicitly, you will need to use the -l switch to indicate letter + ordering.)

    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: - - - +class="ec-lmssbx-10x-x-109">sample-inline.tex
    This document is like sample.tex, above, but uses the + inline glossary style to put the glossary in a footnote. +
    +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:
    latex sampletree +class="ec-lmtt-10x-x-109">latex sampletree

    makeglossaries sampletree +class="ec-lmtt-10x-x-109">makeglossaries sampletree
    latex sampletree -

    +class="ec-lmtt-10x-x-109">latex sampletree +

    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: - +class="ec-lmssbx-10x-x-109">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: +
    latex sample-dual +
    makeglossaries sample-dual +
    latex sample-dual
    +

    +

    +sample-langdict
    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-dual +class="ec-lmtt-10x-x-109">latex sample-langdict
    + + +
    makeglossaries sample-dual +class="ec-lmtt-10x-x-109">makeglossaries sample-langdict
    latex sample-dual -

    +class="ec-lmtt-10x-x-109">latex sample-langdict +

    samplexdy.tex
    samplexdy.tex
    This document illustrates how to use the glossaries package with - glossaries package + with xindy instead of xindy 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="ec-lmtt-10x-x-109">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 will need to specify the required information. Note that if - you set the style file to samplexdy-mc.xdy you must also specify \noist, - otherwise the glossaries package will overwrite samplexdy-mc.xdy and you will - lose the “Mc” letter group. -

    To create the document do: +class="ec-lmtt-10x-x-109">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 + 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:
    latex samplexdy +class="ec-lmtt-10x-x-109">latex samplexdy

    makeglossaries samplexdy +class="ec-lmtt-10x-x-109">makeglossaries samplexdy
    latex samplexdy -

    +class="ec-lmtt-10x-x-109">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="ec-lmtt-10x-x-109">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 samplexdy.glg -o +class="ec-lmtt-10x-x-109">xindy -L english -C utf8 -I xindy -M samplexdy -t
    samplexdy.gls samplexdy.glo -

    +class="ec-lmtt-10x-x-109">samplexdy.glg -o samplexdy.gls samplexdy.glo +

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

    +class="ec-lmtt-10x-x-109">samplexdy.gls 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="ec-lmtt-10x-x-109">xindy. To create the document do: +
    pdflatex samplexdy2 +class="ec-lmtt-10x-x-109">pdflatex samplexdy2
    + + +
    makeglossaries samplexdy2 +class="ec-lmtt-10x-x-109">makeglossaries samplexdy2
    pdflatex samplexdy2 -

    +class="ec-lmtt-10x-x-109">pdflatex samplexdy2 +

    If you can’t use makeglossaries then you need to do: - - - +class="ec-lmtt-10x-x-109">makeglossaries then you need to do:
    xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o +class="ec-lmtt-10x-x-109">xindy -L english -C utf8 -I xindy -M samplexdy2 -t
    samplexdy2.gls samplexdy2.glo -

    +class="ec-lmtt-10x-x-109">samplexdy2.glg -o samplexdy2.gls samplexdy2.glo +

    See §11.2 Locations and Number lists for further details. +href="#sec:xindyloc">§11.2 Locations and Number lists for further details.

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

    makeglossaries sampleutf8 +class="ec-lmtt-10x-x-109">makeglossaries sampleutf8
    latex sampleutf8 -

    +class="ec-lmtt-10x-x-109">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="ec-lmtt-10x-x-109">makeglossaries (no line breaks): +
    xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o +class="ec-lmtt-10x-x-109">xindy -L english -C utf8 -I xindy -M sampleutf8 -t
    sampleutf8.gls sampleutf8.glo -

    -

    If you remove the xindy option from sampleutf8.tex and do: +class="ec-lmtt-10x-x-109">sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +

    +

    If you remove the xindy option from sampleutf8.tex and do: +
    latex sampleutf8 +class="ec-lmtt-10x-x-109">latex sampleutf8

    makeglossaries sampleutf8 +class="ec-lmtt-10x-x-109">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 + makeglossaries, the call to makeglossaries, the call to makeindex is as - follows (no line breaks): +class="ec-lmtt-10x-x-109">makeindex is as follows (no line breaks): +
    makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls +class="ec-lmtt-10x-x-109">makeindex -s sampleutf8.ist -t sampleutf8.glg -o
    sampleutf8.glo -

    +class="ec-lmtt-10x-x-109">sampleutf8.gls sampleutf8.glo + + + +

    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 §17 Accessibility Support. +class="ec-lmss-10x-x-109">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 §18 Accessibility + Support.
- - - -

+

-

Top

1.2 Multi-Lingual Support

-

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

Top

1.2  Multi-Lingual Support

+

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

+

+

Note that although an accented character, such as é, looks like a plain +character in your tex file, it’s actually a macro and can therefore cause +problems. +

  1. If you use an accented (or other expandable) character at the start of an entry - name, you must place it in a group, or it will cause a problem for commands that - convert the first letter to uppercase (e.g. \GlsIf you use an accented (or other expandable) character at + the start of an entry name, you must place it in a group, or + it will cause a problem for commands that convert the first + letter to uppercase (e.g. \Gls) due to expansion issues. For example: - + - +
    - \newglossaryentry{elite}{name={{é}lite}, + \newglossaryentry{elite}{name={{é}lite},  
    description={select group or class}}
    -

    +

  2. If you use an accented (or other expandable) character in an entry name - and you haven’t switched off the nameIf you use an accented (or other expandable) character in an entry + name and you haven’t switched off the name key sanitization, you must use - commands like \glsentrytext, you + must use commands like \glsentrytext or \glstext instead of \glsentryname or +class="ec-lmtt-10x-x-109">\glstext instead of \glsname or you will end up with strange looking characters in your - document. +class="ec-lmtt-10x-x-109">\glsentryname or \glsname or you will end up with strange looking + characters in your document.
-

-

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="ec-lmtt-10x-x-109">xindy manual for further details. +

-

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

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 or polyglossiapolyglossia before glossaries to -enable this. Note that if babel is loaded and the translatorbefore glossaries to enable this. Note that if babel is +loaded and the translator package is detected on TEX’s -path, then the translatorEX’s path, then the +translator package will be loaded automatically. However, it may not pick -up on the required languages so, if the predefined text is not translated, you may -need to explicitly load the translator package with the required languages. For -example: - +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="ec-lmss-10x-x-109">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. 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: Supported Languages
+ +
Table 1.1: Supported Languages
-

+

+class="td11"> Language +class="td11"> Brazilian Portuguese Danish +class="td11"> English +class="td11"> French +class="td11"> German +class="td11"> Irish +class="td11"> Italian +class="td11"> Hungarian +class="td11"> Polish +class="td11"> Serbian
Language As from version As from version
Brazilian Portuguese 1.17 1.17
Danish 1.08
1.08
Dutch Dutch 1.08
English 1.08 1.08
French 1.08 1.08
German 1.08 1.08
Irish 1.08 1.08
Italian 1.08 1.08
Hungarian 1.08 1.08
Polish 1.13 1.13
Serbian 2.06 2.06
Spanish 1.08
-
- - - -

-
-

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

-
- +class="td11"> Spanish 1.08
+ + + +

+

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


- + - -
Table 2: Customised Text
-
-

-

+ +
Table 1.2: Customised Text
+ + +
+class="ec-lmbx-10x-x-109">Command Name +class="ec-lmtt-10x-x-109">\glossaryname +class="ec-lmtt-10x-x-109">\acronymname +class="ec-lmtt-10x-x-109">\entryname +class="ec-lmtt-10x-x-109">\descriptionname +class="ec-lmtt-10x-x-109">\symbolname +class="ec-lmtt-10x-x-109">\pagelistname +class="ec-lmtt-10x-x-109">\glssymbolsgroupname -
Command Name Translator Key Word

Purpose

Translator + Key + Word

Purpose

\glossaryname Glossary

Title of the main glossary.

Glossary

Title + of + the + main + glossary.

\acronymname Acronyms

Title of the list of acronyms -(when used with package option -acronym).

Acronyms

Title + of + the + list + of + acronyms + (when + used + with + package + option + acronym).

\entryname Notation (glossaries)

Header for first column in the -glossary (for 2, 3 or 4 column -glossaries that support headers).

Notation + (glossaries)

Header + for + first + column + in + the + glossary + (for + 2, + 3 + or + 4 + column + glossaries + that + support + headers).

\descriptionname Description (glossaries)

Header for second column in the -glossary (for 2, 3 or 4 column -glossaries that support headers).

Description + (glossaries)

Header + for + second + column + in + the + glossary + (for + 2, + 3 + or + 4 + column + glossaries + that + support + headers).

\symbolname Symbol (glossaries)

Header for symbol column in the -glossary for glossary styles that -support this option.

Symbol + (glossaries)

Header + for + symbol + column + in + the + glossary + for + glossary + styles + that + support + this + option.

\pagelistname Page List (glossaries)

Header for page list column in -the glossary for glossaries that -support this option.

Page + List + (glossaries)

Header + for + page + list + column + in + the + glossary + for + glossaries + that + support + this + option.

\glssymbolsgroupnameSymbols (glossaries)

Header for symbols section of the -glossary for glossary styles that -support this option.

Symbols + (glossaries)

Header + for + symbols + section + of + the + glossary + for + glossary + styles + that + support + this + option.

\glsnumbersgroupnameNumbers (glossaries)

Header for numbers section of -the glossary for glossary styles -that support this 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 do not have the -translator package installed, you need to be familiar with the advice given in changing -the words babel uses. If you have the translator package installed, 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.) +class="ec-lmtt-10x-x-109">\glsnumbersgroupname

Numbers + (glossaries)

Header + for + numbers + section + of + the + glossary + for + glossary + styles + that + support + this + option.

+ + +
-

-

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 do not have the translator package installed, you need to be familiar +with the advice given in changing the words babel uses. If you have the +translator package installed, 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 -suppress it using the package option translate=false, and either load glossaries-babel -after glossaries or specify you’re own translations. For example: - +class="ec-lmss-10x-x-109">translator interface, you +can suppress it using the package option translate=false, and either load +glossaries-babel after glossaries or specify you’re own translations. For +example: + - +

-
+
\documentclass[british]{article}  
\usepackage{babel}  
\usepackage[translate=false]{glossaries}  
\usepackage{glossaries-babel}
-

or: - +

or: + - +

-
+
\documentclass[british]{article}  
\usepackage{babel}  
\usepackage[translate=false]{glossaries} @@ -1963,304 +2246,334 @@ class="ecss-1000">glossaries or specify you’re own translations. Fo  
    \renewcommand*{\glsnumbersgroupname}{Numbers}%  
}
-

-

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 §11 Xindy for further details. +class="ec-lmtt-10x-x-109">xindy if you have glossary +entries that contain diacritics or non-Roman letters. See §11 Xindy for +further details.

-

Top

1.3 Generating the Associated Glossary Files

-

In order to generate a sorted glossary with compact location lists, it is necessary to use -an external indexing application as an intermediate step. It is this application that -creates the file containing the code that typesets the glossary. If this step is omitted, the -glossaries will not appear in your document. The two indexing applications that are -most commonly used with LATEX are

Top

1.3  Generating the Associated Glossary Files

+

In order to generate a sorted glossary with compact location lists, it is +necessary to use an external indexing application as an intermediate step. +It is this application that creates the file containing the code that typesets +the glossary. If this step is omitted, the glossaries will not appear in your +document. The two indexing applications that are most commonly used +with LATEX are 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 xindy has much better -multi-lingual support than makeindex, so xindy is recommended if you’re not writing -in English. Commands that only have an effect when xindy is used are described in §11 +class="ec-lmtt-10x-x-109">xindy. As from version 1.17, the +glossaries package can be used with either of these applications. Previous +versions were designed to be used with makeindex only. Note that +xindy has much better multi-lingual support than makeindex, so +xindy is recommended if you’re not writing in English. Commands +that only have an effect when xindy is used are described in §11 Xindy. -

The glossaries package comes with the Perl script Xindy. + + + +

The glossaries package comes with the Perl script makeglossaries which will run -makeglossaries +which will run makeindex or makeindex or 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 +class="ec-lmtt-10x-x-109">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 makeglossaries: -

- - - +class="ec-lmtt-10x-x-109">http://www.perl.org/about.html. The advantages of using +makeglossaries:

  • It automatically detects whether to use makeindex or xindy and sets the - relevant application switches. + id="dx1-7025">makeindex or xindy and + sets the relevant application switches.
  • One call of makeglossaries will run makeindex/xindy for each glossary - type. + id="dx1-7029">makeglossaries will run makeindex/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 makeindex or xindy messages. +class="ec-lmtt-10x-x-109">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 makeindex or xindy messages.
-

Whilst it is strongly recommended that you use the

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

Whilst it is strongly recommended that you use the makeglossaries script, it is -possible to use the glossaries package without having Perl installed. However, you will -only be able to use makeindex as xindy also requires Perl. Note that some commands -and package options have no effect if you don’t use makeglossaries. These are listed in +class="ec-lmtt-10x-x-109">makeglossaries +script or makeglossariesgui, 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 makeglossaries or table 3. -

Note that if any of your entries use an entry that is not referenced outside the -glossary, you will need to do an additional makeglossariesgui. These are listed in table 1.3. +

If you are choosing not to use makeglossaries because you don’t want +to install Perl, you will only be able to use makeindex 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 makeglossaries, makeglossaries, makeindex or +class="ec-lmtt-10x-x-109">makeindex or xindy run, as appropriate. For example, suppose you have defined the following +class="ec-lmtt-10x-x-109">xindy run, as appropriate. For example, suppose you have defined the following entries:2 - +href="#fn2x3" id="fn2x3-bk">2 + - +

-
+
\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 +makeglossaries, makeglossaries, 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 makeglossaries and LATEX run may be required if the -document pages shift with re-runs. For example, if the page numbering is not reset after -the table of contents, the insertion of the table of contents on the second LATEX run -may push glossary entries across page boundaries, which means that the makeglossaries and LATEX run may be +required if the document pages shift with re-runs. For example, if the page +numbering is not reset after the table of contents, the insertion of the table +of contents on the second LATEX run may push glossary entries across +page boundaries, which means that the number lists in -the glossary may 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, xindy -or xindy 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 +class="ec-lmtt-10x-x-109">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

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. For other editors see the editor’s user manual for further +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. 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. -

-
- +

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



- + - -
Table 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="ec-lmtt-10x-x-109">xindy +class="ec-lmss-10x-x-109">order=letter +class="ec-lmss-10x-x-109">order=word +class="ec-lmss-10x-x-109">xindy={language=lang,codename=code} +class="ec-lmtt-10x-x-109">\GlsSetXdyLanguage{lang}
Command or Package Option Command or Package Option makeindexmakeindex xindy
order=letter use -l use -M ord/letorder use -l use -M ord/letorder
order=word default default default default
xindy={language=lang,codename=code}N/A use -L lang-C code N/A use -L lang-C code
\GlsSetXdyLanguage{lang} N/A use -L lang N/A use -L lang
\GlsSetXdyCodePage{code} N/A use -C code
+class="ec-lmtt-10x-x-109">\GlsSetXdyCodePage{code} N/A use -C code
- - - -

-
-

Top

1.3.1 Using the makeglossaries Perl Script
-

The


+

Top

1.3.1  Using the makeglossaries Perl Script

+

The makeglossaries script picks up the relevant information from the auxiliary (.aux) -file and will either call makeglossaries 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="ec-lmtt-10x-x-109">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 Windows users, -but you must have Perl installed to be able to use it. -

The makeglossaries.bat which does this for +Windows users, but you must have Perl installed to be able to use +it. +

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

-

+class="ec-lmtt-10x-x-109">makeglossaries. The current version is 2.04.

+

+

-

Top

1.3.2 Using xindy explicitly
-

Top

1.3.2  Using xindy explicitly

+

Xindy comes with TeXLive, but not with MiKTeX. However MikTeX users can install -it. There is a thread in the Makeindex section of the Xindy comes with TeXLive, but not with MiKTeX. However MikTeX users +can install it. There is a thread in the Makeindex section of the +LATEX Community that -describes how to do this. -

If you want to use EX Community that describes how to do this. +

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 xindy explicitly or whether +it’s called implicitly via makeglossaries. This causes the glossary entries to be written in raw -xindy format, so you need to use -I xindy not -I tex. -

To run makeglossaries or makeglossariesgui. This +causes the glossary entries to be written in raw xindy format, so you need +to use -I xindy not -I tex. +

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

+class="ec-lmtt-10x-x-109">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 languageis the required language name, encodingis the encoding, baseis -the name of the document without the .tex extension and styleis the name of -the languageis the required language name, encodingis the +encoding, baseis the name of the document without the .tex extension +and styleis the name of the xindy style file without the .xdy extension. The default name for this -style file is base.xdy but can be changed via \setStyleFile{style}. You -may need to specify the full path name depending on the current working -directory. If any of the file names contain spaces, you must delimit them using +class="ec-lmtt-10x-x-109">xindy style file without the .xdy +extension. The default name for this style file is base.xdy but can +be changed via \setStyleFile{style}. You may need to specify +the full path name depending on the current working directory. If +any of the file names contain spaces, you must delimit them using double-quotes. -

For example, if your document is called myDoc.tex and 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 package option, then you would need to do: +

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.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 makeglossaries instead, you can replace all those calls to -xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o +myDoc.gls myDoc.glo +

+

Note that this just creates the main glossary. You need to do the same +for each of the other glossaries (including the list of acronyms if +you have used the acronym package option), substituting .glg, +.gls and .glo with the relevant extensions. For example, if you +have used the acronym package option, then you would need to do: + +
xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o +myDoc.acr myDoc.acn
+

+For additional glossaries, the extensions are those supplied when you +created the glossary with \newglossary. +

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

-Note also that some commands and package options have no effect if you use xindy with just one call to makeglossaries: + + + +
makeglossaries myDoc
+

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

- - - +class="ec-lmtt-10x-x-109">xindy explicitly instead of using makeglossaries. These are listed in +table 1.3. +

-

Top

1.3.3 Using makeindex explicitly
-

If you want to use

Top

1.3.3  Using makeindex explicitly

+

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="ec-lmtt-10x-x-109">makeindex, type the following in your +terminal: +
makeindex -s style.ist -t base.glg -o base.gls base.glo
+

where baseis the name of your document without the .texbaseis the name of your document without the .tex extension and style.iststyle.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 -table 3. -

+class="ec-lmtt-10x-x-109">makeglossaries. These are + + + +listed in table 1.3. +

-

Top

1.3.4 Note to Front-End and Script Developers
-

The information needed to determine whether to use

Top

1.3.4  Note to Front-End and Script Developers

+

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="ec-lmtt-10x-x-109">\@newglossary{label}{log}{out-ext}{in-ext} +


+

where in-extis the extension of the indexing application’s input file (the output file -from the glossaries package’s point of view), out-extis the extension of the indexing -application’s output file (the input file from the glossaries package’s point of view) and -logis 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 +class="lmsy-10x-x-109">⟨in-extis the extension of the indexing application’s input file (the +output file from the glossaries package’s point of view), out-extis the +extension of the indexing application’s output file (the input file from the +glossaries package’s point of view) and logis the extension of the indexing +application’s transcript file. The label for the glossary is also given +for information purposes only, but is not required by the indexing applications. For example, the information for the main glossary is written as: - + - +

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

-

The indexing application’s style file is specified by -


\@istfilename 

+

The indexing application’s style file is specified by +


\@istfilename  \@istfilename{filename}

-

+class="ec-lmtt-10x-x-109">\@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="ec-lmtt-10x-x-109">\@glsorder{order}


+

where ordercan be either word or letter. -

If ordercan 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="ec-lmtt-10x-x-109">\@gls@codepage{label}{code}


+

where labelidentifies the glossary, languageis the root language (e.g. english) and -codeis the encoding (e.g. utf8). These commands are omitted if labelidentifies the glossary, languageis the root language +(e.g. english) and codeis the encoding (e.g. utf8). These commands +are omitted if makeindex should -be used. -

-

-

Top

2 Package Options

-

This section describes the available glossaries package options. -

+class="ec-lmtt-10x-x-109">makeindex should be used. + + +

-

Top

2.1 General Options

-

-

-nowarn

Top

2  Package Options

+ This section describes the available glossaries package options. +

2.1  General Options

+
+nowarn
This suppresses all warnings generated by the glossaries package. +class="description">This suppresses all warnings generated by the glossaries + package.
nomainnomain
This suppresses the creation of the main glossary. Note that if you use - this option, you must create another glossary in which to put all your entries - - - - (either via the acronym package option described in §2.5 Acronym Options - or via \newglossary described in §12 Defining New Glossaries). +class="description">This suppresses the creation of the main glossary. Note that + if you use this option, you must create another glossary in + which to put all your entries (either via the acronym package + option described in §2.5 Acronym Options or via \newglossary + described in §12 Defining New Glossaries).
sanitizesanitize
This is a key=valueoption whose value is also a key=valuelist. By - default, the glossaries package key=valueoption whose value is also a key=value + list. By default, the glossaries package sanitizes the values of the name, description and + id="dx1-13007">s the values of the symbol keys used when defining a new glossary entry. This means that you can use - fragile commands in those keys, but it may lead to unexpected results if you try - to display these values within the document text. This sanitization can be - switched off using the sanitizename, description and symbol keys used when defining a new glossary + entry. This means that you can use fragile commands in those keys, + but it may lead to unexpected results if you try to display these + values within the document text. This sanitization can be switched + off using the sanitize package option. For example, to switch off the sanitization for the descriptiondescription and namename keys, but not for the symbol key, - do: - +class="ec-lmss-10x-x-109">symbol + key, do: + - +
\usepackage[sanitize={name=false,description=false,%  
symbol=true}]{glossaries}
-

You can use sanitize=none

You can use sanitize=none as a shortcut for
sanitize={name=false,description=false,symbol=false}. -

Note: this sanitization only applies to the namesanitize={name=false,description=false,symbol=false}. +

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

+

savewritessavewrites
This is a boolean option to minimises 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 savewritesThis is a boolean option to minimises 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 etexetex. -

If you want to use T

If you want to use TEX’s \write18\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 xindy from your document and use savewrites, you must + create the external files with \glswritefiles before you call + makeindexmakeindex/xindyxindy. Also set \glswritefiles to - nothing or \relax before the end of the document to avoid rewriting the files. For +class="ec-lmtt-10x-x-109">\glswritefiles to nothing or \relax + before the end of the document to avoid rewriting the files. For example: - + - +

\glswritefiles -  
\write18{makeindex -s \istfilename\space -t \jobname.glg -  
-o \jobname.gls \jobname} +  
\write18{makeindex -s \istfilename\space +  
-t \jobname.glg -o \jobname.gls \jobname}  
\let\glswritefiles\relax
-

-

+

+

translatetranslate
This is a boolean option. The default is truetrue if babelbabel, polyglossia or translator - have been loaded, otherwise the default value is falsepolyglossia + or translator have been loaded, otherwise the default value is + false. -

-

+
translate=truetranslate=true
If babelbabel 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 translatortranslator + 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\captionlanguage - mechanism. If polyglossia has been loaded, glossaries-polyglossia will be - loaded. -
+ and babel is loaded, the glossaries-babel package will be + loaded and the translations will be provided using babel’s + \addto\captionlanguagemechanism. If polyglossia has + been loaded, glossaries-polyglossia will be loaded. +
translate=falsetranslate=false
Don’t provide translations, even if babel or polyglossia has - been loaded. You can then provide you’re own translations or explicitly - load glossaries-babel or glossaries-polyglossiaDon’t provide translations, even if babel or + polyglossia has been loaded. You can then provide you’re + own translations or explicitly load glossaries-babel or + glossaries-polyglossia.
-

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

See §1.2.1 Changing the Fixed Names for further details.

hyperfirsthyperfirst
This is a boolean option that specifies whether each term has a hyperlink on - This is a boolean option that specifies whether each term has a + hyperlink on first use. The default is hyperfirst=truehyperfirst=true (terms on first use have a hyperlink, - unless explicitly suppressed using starred versions of commands such as - \gls*first + use have a hyperlink, unless explicitly suppressed using starred + versions of commands such as \gls*). -
- + - -

+ +

+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 + \glsdisplaynumberlist in §9 Using Glossary Terms Without + Links.) +
+

-

Top

2.2 Sectioning and TOC Options

-

-

+

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="ec-lmtt-10x-x-109">\glstocfalse


+

numberlinenumberline
When used with toctoc, this will add \numberline\numberline{} in the final +class="ec-lmtt-10x-x-109">{} 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="ec-lmss-10x-x-109">numberline, + the title will be aligned with the section numbers rather than the + section titles.
sectionsection
This is a key=valueoption. 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="lmsy-10x-x-109">⟨key=valueoption. 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="ec-lmtt-10x-x-109">\setglossarysection{name}


+

where nameis the sectional unit. -

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


\glossarymark nameis the sectional unit. +

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


\glossarymark  \glossarymark{glossary title}

-

+class="ec-lmtt-10x-x-109">\glossarymark{glossary title}


+

This defaults to \@mkboth unless memoir is loaded, but you may need to redefine - it. For example, to only change the right header: - +class="ec-lmtt-10x-x-109">\@mkboth unless memoir is loaded, but you may + need to redefine it. For example, to only change the right + header: + - +

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

or to prevent it from changing the headers: - +

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

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

-

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

If you want \glossarymark to use \MakeUppercase in the header, + use the 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: + + +

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

+

numberedsection
The glossaries are placed in unnumbered sectional units by - default, but this can be changed using numberedsection. This option - can take three possible values: false (no number, i.e. use starred form), +class="ec-lmssbx-10x-x-109">ucmark
This is a boolean option (default: ucmark=false). If set, + \glossarymark is defined to use \MakeUppercase. +
+numberedsection
The glossaries are placed in unnumbered sectional units + by default, but this can be changed using numberedsection. + This option can take three possible values: false (no number, + i.e. use starred form), nolabel (numbered, i.e. unstarred form, + but not labelled) and autolabel (numbered with automatic + labelling). If numberedsection=autolabel is used, each glossary is + given a label that matches the glossary type, so the main + (default) glossary is labelled main, the list of acronyms is labelled nolabel (numbered, i.e. unstarred form, but not labelled) and autolabel - (numbered with automatic labelling). If numberedsection=autolabel is used, - each glossary is given a label that matches the glossary type, so the - main (default) glossary is labelled main, the list of acronyms is labelled +class="ec-lmtt-10x-x-109">acronym1 + and additional glossaries are labelled using the value specified in the + first mandatory argument to \newglossary. For example, if you load acronym3 - and additional glossaries are labelled using the value specified in the first - mandatory argument to \newglossary. For example, if you load glossaries - using: - - - +class="ec-lmss-10x-x-109">glossaries using: + + +
\usepackage[section,numberedsection=autolabel]{glossaries}
-

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

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 +

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 option is not used and is set to acronym if the acronym option is used. - For example: - +class="ec-lmtt-10x-x-109">acronym if the acronym option is used. For example: + - +

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

-

As from version 1.14, you can add a prefix to the label by redefining -


\glsautoprefix  \glsautoprefix

-

+

+

As from version 1.14, you can add a prefix to the label by + redefining +


\glsautoprefix  \glsautoprefix

+

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

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}. + The list of acronyms is in +  
section~\ref{glo:\acronymtype}.
-

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

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

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

+

-

+

-

Top

2.3 Glossary Appearance Options

-

-

+

Top

2.3  Glossary Appearance Options

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

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


\glsrefentry glossaryentry. +

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


\glsrefentry  \glsrefentry{label}

-

+class="ec-lmtt-10x-x-109">\glsrefentry{label}


+

where labelis the label associated with that glossary entry. -

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

-

+class="ec-lmtt-10x-x-109">xindy to + ensure the cross-references are up-to-date.

+

counterwithincounterwithin
This is a key=valueoption where valueis the name of a counter. If - used, this option will automatically set entrycounter=truekey=valueoption where valueis the + name of a counter. If used, this option will automatically set + entrycounter=true and the glossaryentry - counter will be reset every time valueis 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 so that it sets glossaryentry to +class="ec-lmss-10x-x-109">glossaryentry counter will be reset every + time valueis incremented. + + + +

\glsresetentrycounter  +

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, which sets glossaryentry to zero: - + - +

\renewcommand{\glossarypreamble}{% -  
  \setcounter{glossaryentry}{0}% +  
  \glsresetentrycounter  
}
-

-

+

+

subentrycounter
subentrycounter
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 glossarysubentry. 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 +class="ec-lmss-10x-x-109">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 + entrycounter. You can reference the number within the document using \glsrefentry{label} where labelis the label associated with the - sub-entry. (See above.) +class="ec-lmtt-10x-x-109">\glsrefentry{label} where labelis the label associated + with the sub-entry.
style
style
This is a key=valueoption. (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-longkey=valueoption. (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-super or glossary-tree. (See §15 Glossary - Styles.) +class="ec-lmss-10x-x-109">glossary-long, glossary-super or + glossary-tree. (See §15 Glossary Styles.)
nolong
nolong
This prevents the glossaries package from automatically loading glossary-long - (which means that the longtable package also won’t be loaded). This reduces - overhead by not defining unwanted styles and commands. Note that if you use - this option, you won’t be able to use any of the glossary styles defined in the +class="ec-lmss-10x-x-109">glossaries package from automatically loading glossary-long package. +class="ec-lmss-10x-x-109">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.
nosuper
nosuper
This prevents the glossaries package from automatically loading glossary-super - (which means that the supertabular package also won’t be loaded). This reduces - overhead by not defining unwanted styles and commands. Note that if you use - this option, you won’t be able to use any of the glossary styles defined in the +class="ec-lmss-10x-x-109">glossaries package from automatically loading glossary-super package. +class="ec-lmss-10x-x-109">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. + + +
nolist
nolist
This prevents the 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 package. Note that since the default style is list, - - - - you will also need to use the style option to set the style to something - else. +class="ec-lmss-10x-x-109">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 package. Note that since the + default style is list, you will also need to use the style option to set + the style to something else.
notree
notree
This prevents the 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 +class="ec-lmss-10x-x-109">glossaries package from automatically loading glossary-tree package. +class="ec-lmss-10x-x-109">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.
nostyles
This prevents all the predefined styles from being loaded. This option is - provided in the event that the user has custom styles that are not dependent on - the styles provided by the glossaries package. Note that if you use this - option, you can’t use the style package option. Instead you must either use +class="ec-lmssbx-10x-x-109">nostyles
This prevents all the predefined styles from being loaded. If you + use this option, you need to load a glossary style package (such as \glossarystyle{style} or the style key in the optional argument to - \printglossary. -
+class="ec-lmss-10x-x-109">glossary-mcols). Also if you use this option, you can’t use the style + package option. Instead you must either use \glossarystyle{style} + or the style key in the optional argument to \printglossary. + Example: + + + +
+ \usepackage[nostyles]{glossaries} +  
\usepackage{glossary-mcols} +  
\glossarystyle{mcoltree} +
+

+

nonumberlist
nonumberlist
This option will suppress the associated number lists in the glossaries - (see also §5 Number lists). + id="dx1-15052">s in the + glossaries (see also §5 Number lists).
seeautonumberlist
seeautonumberlist
If you suppress the number lists with nonumberlist, described above, - this will also suppress any cross-referencing information supplied by the see key in + id="dx1-15055">s with nonumberlist, + described above, this will also suppress any cross-referencing + information supplied by the see key in \newglossaryentry or \newglossaryentry or \glssee. If you use seeautonumberlist, the see key will - automatically implement nonumberlist=false for that entry. (Note this - doesn’t affect \glssee.) For further details see §8 Cross-Referencing +class="ec-lmtt-10x-x-109">\glssee. If you use seeautonumberlist, the see key will automatically + implement nonumberlist=false for that entry. (Note this doesn’t + affect \glssee.) For further details see §8 Cross-Referencing Entries.
counter
counter
This is a key=valueoption. (Default is counter=page.) The value should be - the name of the default counter to use in the number lists (see §5 Number - lists). +class="lmsy-10x-x-109">⟨key=valueoption. (Default is counter=page.) The + value should be the name of the default counter to use in the number + lists (see §5 Number lists).
-

+

-

Top

2.4 Sorting Options

-

-

+

Top

2.4  Sorting Options

+
sortsort
This is a key=valueoption where the option can only have one of the - following values: - - - -
    -
  • standardkey=valueoption 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 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).
    -

    The default is sort=standard +

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

The default is sort=standard.

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="ec-lmtt-10x-x-109">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 xindyxindy. The indexing style file will been given a .ist.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. -

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

The xindy package option may additionally have a value that is a + key=valuecomma-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}
-

See §11 Xindy for further details on using

See §11 Xindy for further details on using xindyxindy with the glossaries +class="ec-lmss-10x-x-109">glossaries package.

-

+

-

Top

2.5 Acronym Options

-

-

+

Top

2.5  Acronym Options

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

If the acronym

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

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="ec-lmtt-10x-x-109">\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}]{glossaries}  
\newglossary[alg2]{acronym2}{acr2}{acn2}{Statistical Acronyms}
-

+

descriptiondescription
This option changes the definition of \newacronym to allow a description. - This option has no effect if you defined your own custom acronym style. See §13 - Acronyms for further details. +class="ec-lmtt-10x-x-109">\newacronym to + allow a description. This option has no effect if you defined + your own custom acronym style. See §13 Acronyms for further + details.
footnotefootnote
This option changes the definition of \newacronym and the way that - acronyms are displayed. This option has no effect if you defined your own custom - acronym style. See §13 Acronyms for further details. +class="ec-lmtt-10x-x-109">\newacronym and the way + that acronyms are displayed. This option has no effect if you defined + your own custom acronym style. See §13 Acronyms for further + details.
smallcapssmallcaps
This option changes the definition of \newacronym and the way that - acronyms are displayed. This option may have no effect if you defined your own - custom acronym style. See §13 Acronyms for further details. +class="ec-lmtt-10x-x-109">\newacronym and the way + that acronyms are displayed. This option may have no effect if you + defined your own custom acronym style. See §13 Acronyms for + further details.
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 or redefine \acronymfont. This option may have - no effect if you defined your own custom acronym style. See §13 Acronyms for - further details. +class="ec-lmtt-10x-x-109">\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. This option may have no effect if you defined + your own custom acronym style. See §13 Acronyms for further + details.
duadua
This option changes the definition of \newacronym so that acronyms are always - expanded. This option has no effect if you defined your own custom acronym - style. See §13 Acronyms for further details. +class="ec-lmtt-10x-x-109">\newacronym so that acronyms + are always expanded. This option has no effect if you defined + your own custom acronym style. See §13 Acronyms for further + details.
shortcutsshortcuts
This option provides shortcut commands for acronyms. See §13 Acronyms for - further details. +href="#sec:acronyms">§13 + Acronyms for further details.
- + - -

-

-

Top

3 Setting Up

-

The command -


\makeglossaries 

Top

3  Setting Up

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

-

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

+

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


\noist makeindex +style file using +


\noist  \noist

-

+class="ec-lmtt-10x-x-109">\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="ec-lmtt-10x-x-109">\setStyleFile{name}


+

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

Each glossary entry is assigned a nameis 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-18025"> 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="ec-lmtt-10x-x-109">\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 uppercase alphabetical character using: -


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


\glsSetAlphaCompositor  \glsSetAlphaCompositor{symbol}

-

+class="ec-lmtt-10x-x-109">\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-18033">s containing a mixture of A-1 +and 2.3 style formats, then do: + - +

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

See §5 Number lists for further information about

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

+ + +

-

Top

4 Defining Glossary Entries

-

All glossary entries must be defined before they are used, so it is better to define them in the preamble -to ensure this.5 -However only those entries that occur in the document (using any of the commands -described in §6 Links to Glossary Entries, §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 .gls4  Defining Glossary Entries +

All glossary entries must be defined before they are used, +so it is better to define them in the preamble to ensure +this.1 +However only those entries that occur in the document (using any of the +commands described in §6 Links to Glossary Entries, §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\printglossary or \printglossaries. The Perl script -\printglossaries. The +Perl script makeglossariesmakeglossaries 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 +class="ec-lmtt-10x-x-109">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 should be no need for you to explicitly edit or input any of these external +class="ec-lmbx-10x-x-109">for you to explicitly edit or input any of these external files.6 +class="ec-lmbx-10x-x-109">files.2 See §1.3 Generating the Associated Glossary Files for further details. -

New glossary entries are defined using the command: -


\newglossaryentry §1.3 Generating the Associated Glossary Files for further details. +

New glossary entries are defined using the command: +


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

-

+class="ec-lmtt-10x-x-109">\newglossaryentry{label}{key-val list} +


+

The first argument, label, must be a unique label with which to identify this entry. -The second argument, key-val list, is a key=valuelist that supplies the relevant -information about this entry. There are two required fields: descriptionlabel, must be a unique label with which to identify +this entry. The second argument, key-val list, is a key=valuelist 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="ec-lmss-10x-x-109">name or 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 \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

-

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


+ + + +

+ 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="ec-lmtt-10x-x-109">\\ 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 §4.2 Sub-Entries for further details. +class="description">The label of the parent entry. Note that the parent entry must be + defined before its sub-entries. See §4.3 Sub-Entries for further + details.
descriptionpluraldescriptionplural
The plural form of the description (as passed to \glsdisplay and +class="description">The plural form of the description (as passed to \glsdisplayfirst\glsdisplay and \glsdisplayfirst by \glspl\glspl, \Glspl and \GLSpl). If omitted, the value is set to - the same as the description key. (Note that if you want the description to appear - in the main body of the document, you must switch off the description +class="ec-lmtt-10x-x-109">\Glspl and + \GLSpl). If omitted, the value is set to the same as the description + key. (Note that if you want the description to appear in the main + body of the document, you must switch off the description sanitization using the sanitizesanitize package option described in §2.1 General - Options.) +href="#sec:pkgopts-general">§2.1 + General Options.)
texttext
How this entry will appear in the document text when using \gls (or one of its - uppercase variants). If this field is omitted, the value of the name key is - used. +class="ec-lmtt-10x-x-109">\gls (or + one of its uppercase 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 uppercase variants). If this field is omitted, the value of the text key is used. - Note that if you use \glsplfirst use with + \gls (or one of its uppercase variants). If this field is omitted, the + value of the text key is used. Note that if you use \glspl, \Glspl, \GLSpl\Glspl, + \GLSpl, \glsdisp\glsdisp before using \gls, the - firstplural value won’t be used with \gls\gls, the firstplural value won’t be + used with \gls.
pluralplural
How the entry will appear in the document text when using \glspl (or one of its - uppercase variants). If this field is omitted, the value is obtained by appending - \glspluralsuffix\glspl + (or one of its uppercase variants). If this field is omitted, the value is + obtained by appending \glspluralsuffix to the value of the text field. The default value of - \glspluralsuffix is the letter “s”. +class="ec-lmss-10x-x-109">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 uppercase variants). If this field is omitted, the value is obtained from - the pluralfirst + use with \glspl (or one of its uppercase variants). If this field is + omitted, the value is obtained from the plural key, if the first key is omitted, or by appending \glspluralsuffix to - the value of the first field, if the firstfirst 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 \gls, +class="ec-lmtt-10x-x-109">\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 was always taken by - appending “s” to the first key, which meant that you had to specify both plural and - 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 plural and firstplural, even if you hadn’t used the first key. - - - +class="ec-lmss-10x-x-109">first + 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. (If you want the symbol to appear in the main body of the document, you - must switch off the symbol This field is provided to allow the user to specify an associated + symbol. If omitted, the value is set to \relax. Note that not all + glossary styles display the symbol. (If you want the symbol to appear + in the main body of the document, you must switch off the symbol + sanitization using the sanitize package option described - in §2.1 General Options.) +class="ec-lmss-10x-x-109">sanitize package option described in §2.1 + General Options.)
symbolpluralsymbolplural
This is the plural form of the symbol (as passed to \glsdisplay and +class="description">This is the plural form of the symbol (as passed to \glsdisplayfirst\glsdisplay and \glsdisplayfirst by \glspl\glspl, \Glspl and \GLSpl). If omitted, the value is set to - the same as the symbol key. +class="ec-lmtt-10x-x-109">\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. In general, it’s best to use the sort key if the +class="ec-lmtt-10x-x-109">xindy should sort this entry. + If omitted, the value is given by the name field. In general, + it’s best to use the sort key if the name contains commands + (e.g. \ensuremath{\alpha}). Note that the package options name contains commands (e.g. \ensuremath{\alpha}). Note that the package - options sort=defsort=def and sort=usesort=use override the sortsort key in \newglossaryentry (see - §2.4 Sorting Options). +class="ec-lmtt-10x-x-109">\newglossaryentry + (see §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 §13 - Acronyms). +class="description">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 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.) +class="description">Six keys provided for any additional information + the user may want to specify. (For example an associated + dimension or an alternative plural or some other grammatical + construct.)
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.) +href="#sec:numberlists">§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 +class="ec-lmss-10x-x-109">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 have suppressed the number list, the cross-referencing information - won’t appear in the glossary. 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 + id="dx1-19117">, the cross-referencing + information won’t appear in the glossary. 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.
- - - -

The following keys are reserved for \newacronym

The following keys are reserved for \newacronym (see §13 Acronyms): long, +href="#sec:acronyms">§13 Acronyms): longplurallong, longplural, shortshort and shortpluralshortplural. -

Note that if the name starts with an accented letter or non-Roman character, you -must group the character, otherwise it will cause a problem for commands like \Gls and -\Glspl

Note that if the name starts with an accented letter or non-Roman +character, you must group the character, otherwise it will cause a problem +for commands like \Gls and \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}, +
+\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="ec-lmtt-10x-x-109">xindy is usually able to sort +accented letters correctly.

-

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

-

-to the singular form. This command defaults to the letter “s”. For example: - +class="ec-lmtt-10x-x-109">\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 alternative -plural. -

If you are using a language that usually forms plurals by appending a different -letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, -this must be done before the entries are defined. For languages that don’t form plurals -by simply appending a suffix, all the plural forms must be specified using the plural key -(and the firstplural key where necessary). -

+

Then you don’t have to remember which key you used to store the +alternative plural. +

If you are using a language that usually forms plurals by appending a +different letter, or sequence of letters, you can redefine \glspluralsuffix +as required. However, this must be done before the entries are defined. For +languages that don’t form plurals by simply appending a suffix, all the +plural forms must be specified using the plural key (and the firstplural key +where necessary). +

-

Top

4.2 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 §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 Glossary Appearance Options for further +

Top

4.2  Other Grammatical Constructs

+

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

+
+\let\glsing\glsuseri + 
\let\glsd\glsuserii + 
\newcommand*{\ingkey}{user1} + 
\newcommand*{\edkey}{user2} + 
\newcommand*{\newterm}[3][]{% + 
  \newglossaryentry{#2}{% + 
   name={#2},% + 
   description={#3},% + 
   \edkey={#2ed},% + 
   \ingkey={#2ing},#1% + 
  }% + 
} +
+

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

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

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

+

+

+

Top

4.3  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 §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 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="ec-lmtt-10x-x-109">makeindex has a restriction on the maximum sub-entry +depth. +

-

Top

4.2.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 key. For example, suppose I want a glossary of mathematical symbols that are -divided into Greek letters and Roman letters. Then I can define the categories as +

Top

4.3.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 key. For example, suppose +I want a glossary of mathematical symbols that are divided into +Greek letters and Roman letters. Then I can define the categories as follows: - + - +

-
+
\newglossaryentry{greekletter}{name={Greek letters},  
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}, + 
description={ratio of the circumference of a circle to + 
the diameter},  
parent=greekletter}  
\newglossaryentry{C}{name={\ensuremath{C}},sort={C},  
description={Euler’s constant},  
parent=romanletter}
-

-

+

+

-

Top

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

Top

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

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

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

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

-
+
\newglossaryentry{glossarylist}{  
description={list of technical words},  
sort={1}, @@ -4880,96 +5369,100 @@ class="ectt-1000">\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 or sort=def package -options. You can use the subentrycounter package option to automatically number -the first-level child entries. See §2.3 Glossary Appearance Options for further + id="dx1-24004">, 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. 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: - +

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 (pl.\ bravos)}, + 
\newglossaryentry{bravocry}{description={cry of approval + 
(pl.\ bravos)},  
sort={1},  
plural={bravos},  
parent=bravo} - 
\newglossaryentry{bravoruffian}{description={hired ruffian or - 
killer (pl.\ bravoes)}, + 
\newglossaryentry{bravoruffian}{description={hired + 
ruffian or killer (pl.\ bravoes)},  
sort={2},  
plural={bravoes},  
parent=bravo}
-

-

+

+

-

Top

4.3 Loading Entries From a File

-

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


\loadglsentries  \loadglsentries[type]{filename}

-

+

Top

4.4  Loading Entries From a File

+

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


\loadglsentries  \loadglsentries[type]{filename}

+

where filenameis the name of the file containing all the \newglossaryentry +class="lmsy-10x-x-109">⟨filenameis the name of the file containing all the \newglossaryentry commands. The optional argument typeis 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 uses by default). For example, suppose I have a file called -myentries.tex which contains: - - - +class="lmsy-10x-x-109">⟨typeis 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 uses by +default). For example, suppose I have a file called myentries.tex which +contains: + + +

-
+
\newglossaryentry{perl}{type=main,  
name={Perl},  
description={A scripting language}} @@ -4979,2271 +5472,2367 @@ class="ectt-1000">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. -

Note: if you use \newacronym (see §13 Acronyms) the type is set as +

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 (see §13 Acronyms) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file -myacronyms.tex contains: - +class="ec-lmtt-10x-x-109">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 is not +

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

If you have used the acronym package option, there are two possible solutions to this -problem: +href="#fn3x6" id="fn3x6-bk">3 +

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="enumerate" id="x1-25015x1">Change myacronyms.tex so that entries are defined in the + form: + - -
    - \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} + +
    + \newacronym[type=\glsdefaulttype]{aca}{aca}{a +  
    contrived acronym}
    -

    and do: - +

    and do: + - +

    -
    +
    \loadglsentries[altacronym]{myacronyms}
    -

    +

  2. Temporarily change \acronymtype to the target glossary: - + class="enumerate" id="x1-25017x2">Temporarily change \acronymtype to the target glossary: + - -
    + +
    \let\orgacronymtype\acronymtype  
    \def\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. +

+

+

Top

4.5  Moving Entries to Another Glossary

+

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


\glsmoveentry  \glsmoveentry{label}{target glossary label} +

+

+where labelis the unique label identifying the required entry and target +glossary labelis 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 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. 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

5 Number lists

-

Each entry in the glossary has an associated

Top

5  Number lists

+ 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 §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 + id="dx1-27002">. By default, +these numbers refer to the pages on which that entry has been used (using +any of the commands described in §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 list. -

Both . +

Both makeindex and makeindex and xindy concatenate a sequence of 3 or more consecutive pages -into a range. With xindy you can vary the minimum sequence length using -\GlsSetXdyMinRangeLength{n} where nis 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 xindy concatenate a sequence of 3 or more +consecutive pages into a range. With xindy you can vary the minimum +sequence length using \GlsSetXdyMinRangeLength{n} where nis +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 makeindex and makeindex and xindy, you can replace the separator and the closing -number in the range using: -


\glsSetSuffixF  \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="ec-lmtt-10x-x-109">xindy, you can replace the separator and the +closing number in the range using: +


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

-
+
\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="ec-lmtt-10x-x-109">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 -\makeglossaries and have no effect if \noist is used.
-

-

+

+

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

+ + +

-

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 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 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 makeindex or makeindex or xindy to generate the relevant +class="ec-lmtt-10x-x-109">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 + id="dx1-28009"> for that entry. By default, the location refers to the page number. For further information on number lists, see §5 Number +href="#sec:numberlists">§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 §9 -Using Glossary Terms Without Links (such as \glsentrytext) or provide an -alternative via the optional argument to the sectioning/caption command. -Examples: - - - +

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 §9 Using Glossary Terms Without Links +(such as \glsentrytext) or provide an alternative via the optional +argument to the sectioning/caption command. Examples: + + +

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

-

The way the

+

The way the link text is displayed depends on -


\glstextformat  \glstextformat{text}

-

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


\glstextformat  \glstextformat{text}

+

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

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

-

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

The command: -


\glslink  \glslink[options]{label}{text}

-

+

+

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

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, textwill 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, textwill 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 optionsmust be a key=valuelist which can take any of the following +class="ec-lmtt-10x-x-109">\glsdisp instead.) The optional argument options +must be a key=valuelist 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 +class="ec-lmtt-10x-x-109">makeindex + encap value, and (as with \index) the value needs to be the + name of a command without the initial backslash. As with 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 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 +class="ec-lmtt-10x-x-109">\index, the characters ( and ) can also be used to specify + the beginning and ending of a number range. Again as with italic) you will need to create a command that applies both formats, +class="ec-lmtt-10x-x-109">\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, 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 4. -

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 xindy with the above example, you would need to add: - - - +class="ec-lmtt-10x-x-109">makeindex, you must specify any + non-standard formats that you want to use with the format key using + \GlsAddXdyAttribute{name}. So if you use xindy with the above + example, you would need to add: + + +

-
+
\GlsAddXdyAttribute{textbfem}
-

See §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 §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 4. -

-
-


See §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 §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 4: Predefined Hyperlinked Location Formats
+
Table 6.1: Predefined Hyperlinked Location Formats
+class="td11"> hyperrm +class="td11"> hypersf +class="td11"> hypertt +class="td11"> hyperbf +class="td11"> hypermd +class="td11"> hyperit +class="td11"> hypersl +class="td11"> hyperup +class="td11"> hypersc
hyperrm serif hyperlink serif hyperlink
hypersf sans-serif hyperlink sans-serif hyperlink
hypertt monospaced hyperlink monospaced hyperlink
hyperbf bold hyperlink bold hyperlink
hypermd medium weight hyperlink medium weight hyperlink
hyperit italic hyperlink italic hyperlink
hypersl slanted hyperlink slanted hyperlink
hyperup upright hyperlink upright hyperlink
hypersc small caps hyperlink small caps hyperlink
hyperemphemphasized hyperlink
+class="td11"> hyperemph emphasized hyperlink

-
-

Note that if the \hyperlink command hasn’t been defined, the hyperxx - formats are equivalent to the analogous textxxfont 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: - - - +

Note that if the \hyperlink command hasn’t been defined, the + hyperxxformats are equivalent to the analogous textxxfont + 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: + + +

-
+
\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.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.pdf.) + Remember that if you use xindy, you will need to add this to the list of location - attributes: - +class="ec-lmtt-10x-x-109">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 §5 Number lists.) +class="ec-lmssbx-10x-x-109">counter
This specifies which counter to use for this location. This + overrides the default counter used by this entry. (See also §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 hyper=true will - have no effect if \hyperlink has not been defined.) The default value is +class="ec-lmssbx-10x-x-109">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. +class="ec-lmtt-10x-x-109">hyper=true will have no effect if \hyperlink has not been defined.) + The default value is hyper=true.
-

There is also a starred version: -


\glslink*  \glslink*[options]{label}{text}

-

+

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 textargument of \glslink. -
-

-

The command: -


\gls  \gls[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\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 textargument 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 uppercase variants: -


\Gls  \Gls[options]{label}[insert]

-

+ id="dx1-28069"> 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 uppercase variants: +


\Gls  \Gls[options]{label}[insert]

+

and -


\GLS  \GLS[options]{label}[insert]

-

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

The final optional argument insert, allows you to insert some additional -text into the link text. By default, this will append insertat 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 optionsis 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 insertargument of \gls and -its variants.
-

-

There are also analogous plural forms: -


\glspl  \glspl[options]{label}[insert]

-

-


\Glspl  \Glspl[options]{label}[insert]

-

-


\GLSpl  \GLSpl[options]{label}[insert]

-

+ + + +


\GLS  \GLS[options]{label}[insert]

+

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

The final optional argument insert, allows you to insert some +additional text into the link text. By default, this will append insertat +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 optionsis 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 insertargument of +\gls and its variants.
+

+

There are also analogous plural forms: +


\glspl  \glspl[options]{label}[insert]

+

+


\Glspl  \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="ec-lmss-10x-x-109">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} +
+\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 insertoptional 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 insertoptional +argument: + + +

-
+
$\gls{Falpha}[^2]$
-

-

-

Note that \glslink doesn’t use or affect the first use flag, nor does it use -\glsdisplay or \glsdisplayfirst (see §6.1 Changing the format of the link text). -Instead, you can use: -


\glsdisp  \glsdisp[options]{label}{link text}

-

+

+

+

Note that \glslink doesn’t use or affect the first use flag, nor does it +use \glsdisplay or \glsdisplayfirst (see §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 textinstead of the -value of the first or text key. (Note that this command always sets insertto -nothing.) This command affects the first use flag, and uses \glsdisplay or -\glsdisplayfirst. -

The command: -


\glstext  \glstext[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\gls, except that it uses link text +instead of the value of the first or text key. (Note that this command always +sets insertto nothing.) This command affects the first use flag, and uses +\glsdisplay or \glsdisplayfirst. +

The command: +


\glstext  \glstext[options]{label}[insert]

+

is similar to \gls except that it always uses the value of the text key and +class="ec-lmtt-10x-x-109">\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 insertis +class="ec-lmtt-10x-x-109">\gls, the inserted text insertis always appended to the link text since \glstext doesn’t use \glsdisplay or -\glsdisplayfirst. (The same is true for all the following commands described in this -section.) -

There are also analogous commands: -


\Glstext  \Glstext[options]{text}[insert]

-

-


\GLStext  \GLStext[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. -

The command: -


\glsfirst  \glsfirst[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\glstext doesn’t use \glsdisplay +or \glsdisplayfirst. (The same is true for all the following commands +described in this section.) +

There are also analogous commands: +


\Glstext  \Glstext[options]{text}[insert]

+

+


\GLStext  \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, -insertis 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  \GLSfirst[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. - - - -

The command: -


\glsplural  \glsplural[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\glstext except that it always uses the value of the first key. +Again, insertis 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  \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, -insertis 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  \GLSplural[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. -

The command: -


\glsfirstplural  \glsfirstplural[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\glstext except that it always uses the value of the plural key. +Again, insertis 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  \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, -insertis 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  \glsname[options]{label}[insert]

-

+class="ec-lmtt-10x-x-109">\glstext except that it always uses the value of the firstplural +key. Again, insertis 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  \glsname[options]{label}[insert]

+

is similar to \glstext except that it always uses the value of the name key. Again, -insertis always appended to the end of the link text and does not mark the entry as -having been used. Note: if you want to use this command and the name key contains -commands, you will have to disable the \glstext except that it always uses the value of the name key. +Again, insertis always appended to the end of the link text and +does not mark the entry as having been used. Note: if you want to +use this command and the name key contains commands, you will +have to disable the sanitization of the name key and protect fragile + id="dx1-28126"> of the name key and protect fragile + + + commands. -

There are also analogous commands: -


\Glsname  \Glsname[options]{text}[insert]

-

-


\GLSname  \GLSname[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. -

The command: -


\glssymbol  \glssymbol[options]{label}[insert]

-

+

There are also analogous commands: +


\Glsname  \Glsname[options]{text}[insert]

+

+


\GLSname  \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, -insertis always appended to the end of the link text and does not mark the entry as - - - -having been used. Note: if you want to use this command and the symbol key contains -commands, you will have to disable the \glstext except that it always uses the value of the symbol +key. Again, insertis always appended to the end of the link text and does +not mark the entry as having been used. Note: if you want to use this +command and the symbol key contains commands, you will have +to disable the sanitization of the symbol key and protect -fragile commands. -

There are also analogous commands: -


\Glssymbol  \Glssymbol[options]{text}[insert]

-

-


\GLSsymbol  \GLSsymbol[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. -

The command: -


\glsdesc  \glsdesc[options]{label}[insert]

-

+ id="dx1-28135"> of the symbol key and protect fragile +commands. +

There are also analogous commands: +


\Glssymbol  \Glssymbol[options]{text}[insert]

+

+


\GLSsymbol  \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, -insertis always appended to the end of the link text and does not mark the entry as -having been used. Note: if you want to use this command and the description key -contains commands, you will have to disable the \glstext except that it always uses the value of the +description key. Again, insertis always appended to the end of the link +text and does not mark the entry as having been used. Note: if you want to +use this command and the description key contains commands, you will +have to disable the sanitization of the description key and -protect fragile commands. -

There are also analogous commands: -


\Glsdesc  \Glsdesc[options]{text}[insert]

-

-


\GLSdesc  \GLSdesc[options]{text}[insert]

-

-As before, these commands also have a starred version that disable the hyperlink. -

The command: -


\glsuseri  \glsuseri[options]{label}[insert]

-

+ id="dx1-28144"> of the description key and protect fragile +commands. +

There are also analogous commands: +


\Glsdesc  \Glsdesc[options]{text}[insert]

+

+


\GLSdesc  \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, -insertis 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  \GLSuseri[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  \GLSuserii[options]{text}[insert]

- - - -

-


\glsuseriii  \glsuseriii[options]{text}[insert]

-

-


\Glsuseriii  \Glsuseriii[options]{text}[insert]

-

-


\GLSuseriii  \GLSuseriii[options]{text}[insert]

-

-


\glsuseriv  \glsuseriv[options]{text}[insert]

-

-


\Glsuseriv  \Glsuseriv[options]{text}[insert]

-

-


\GLSuseriv  \GLSuseriv[options]{text}[insert]

-

-


\glsuserv  \glsuserv[options]{text}[insert]

-

-


\Glsuserv  \Glsuserv[options]{text}[insert]

-

-


\GLSuserv  \GLSuserv[options]{text}[insert]

-

-


\glsuservi  \glsuservi[options]{text}[insert]

-

-


\Glsuservi  \Glsuservi[options]{text}[insert]

-

-


\GLSuservi  \GLSuservi[options]{text}[insert]

-

-

+class="ec-lmtt-10x-x-109">\glstext except that it always uses the value of the user1 key. +Again, insertis 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  \GLSuseri[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  \GLSuserii[options]{text}[insert]

+

+


\glsuseriii  \glsuseriii[options]{text}[insert]

+

+


\Glsuseriii  \Glsuseriii[options]{text}[insert]

+

+


\GLSuseriii  \GLSuseriii[options]{text}[insert]

+

+


\glsuseriv  \glsuseriv[options]{text}[insert]

+

+


\Glsuseriv  \Glsuseriv[options]{text}[insert]

+

+


\GLSuseriv  \GLSuseriv[options]{text}[insert]

+

+


\glsuserv  \glsuserv[options]{text}[insert]

+

+ + + +


\Glsuserv  \Glsuserv[options]{text}[insert]

+

+


\GLSuserv  \GLSuserv[options]{text}[insert]

+

+


\glsuservi  \glsuservi[options]{text}[insert]

+

+


\Glsuservi  \Glsuservi[options]{text}[insert]

+

+


\GLSuservi  \GLSuservi[options]{text}[insert]

+

-

Top

6.1 Changing the format of the link text

-

The format of the 6.1  Changing the format of the link text +

The format of the link text for \gls, \glspl and their uppercase variants is governed -by two commands: - - - -


\glsdisplayfirst  \glsdisplayfirst{first/first plural}{description}{symbol}{insert} -

-

+ id="dx1-29002"> for \gls, \glspl and their uppercase variants +is governed by two commands: +


\glsdisplayfirst  \glsdisplayfirst{first/first +plural}{description}{symbol}{insert}

+

which is used the first time a glossary entry is used in the text and -


\glsdisplay  \glsdisplay{text/plural}{description}{symbol}{insert} +


\glsdisplay  \glsdisplay{text/plural}{description}{symbol}{insert}

-

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

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

Care needs to be taken when redefining \glsdisplay and \glsdisplayfirst as -commands like \Gls will expand the displayed text before applying \makefirstuc. If -you want to use formatting commands, it’s best to define a robust version that deals -with all the formatting. For example, suppose you want the text to appear in bold -italic, it’s best to do something like: - - - +

Care needs to be taken when redefining \glsdisplay and +\glsdisplayfirst as commands like \Gls will expand the displayed text +before applying \makefirstuc. If you want to use formatting commands, + + + +it’s best to define a robust version that deals with all the formatting. For +example, suppose you want the text to appear in bold italic, it’s best to do +something like: + + +

-
-\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries #1}} +
+\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries + 
#1}}  
\renewcommand{\glsdisplay}[4]{\textbfit{#1#4}}
-

See the mfirstuc documentation for further details on the limitations of \makefirstuc. -

-

-

If required, you can access the label for the given entry via -


\glslabel  \glslabel

-

+

See the mfirstuc documentation for further details on the limitations of +\makefirstuc.

+

+

If required, you can access the label for the given entry via +


\glslabel  \glslabel

+

so it is possible to use this label in the definition of \glsdisplay or \glsdisplayfirst -to supply additional information using any of the commands described in §9 Using -Glossary Terms Without Links, if required. -

Note that \glsdisplay and \glsdisplayfirst are not used by \glslink. If you -want to supply your own link text, you need to use \glsdisp instead. -

For example, suppose you want a glossary of measurements and units, you can use -the symbol key to store the unit: - +class="ec-lmtt-10x-x-109">\glsdisplay or +\glsdisplayfirst to supply additional information using any of the +commands described in §9 Using Glossary Terms Without Links, if +required. +

Note that \glsdisplay and \glsdisplayfirst are not used by +\glslink. If you want to supply your own link text, you need to use +\glsdisp instead. +

For example, 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 \glsdisplayfirst as follows: - - - +

and now suppose you want \gls{distance} to produce “distance +(km)” on first use, then you can redefine \glsdisplayfirst as +follows: + + +

-
+
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
-

Note that the additional text is placed after #1, so \gls{distance}[’s] will -produce “distance’s (km)” rather than “distance (km)’s” which looks a bit -odd (even though it may be in the context of “the distance (km) is measured -between the two points” — but in this instance it would be better not to use a -contraction). -

Note also that all of the

Note that the additional text is placed after #1, so \gls{distance}[’s] +will produce “distance’s (km)” rather than “distance (km)’s” which looks a +bit odd (even though it may be in the context of “the distance (km) is +measured between the two points” — but in this instance it would be +better not to use a contraction). +

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

-
+
\renewcommand{\glstextformat}[1]{\textbf{#1}}  
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
-

then \gls{distance} will produce “distance (km)”. -

If you have multiple glossaries, changing \glsdisplayfirst and \glsdisplay will -change the way entries for all of the glossaries appear when using the commands \gls, -\glspl, their uppercase variants and \glsdisp. If you only want the change to affect -entries for a given glossary, then you need to use -


\defglsdisplay  \defglsdisplay[type]{definition}

-

+

then \gls{distance} will produce “distance (km)”. +

If you have multiple glossaries, changing \glsdisplayfirst and +\glsdisplay will change the way entries for all of the glossaries appear +when using the commands \gls, \glspl, their uppercase variants and +\glsdisp. If you only want the change to affect entries for a given glossary, +then you need to use +


\defglsdisplay  \defglsdisplay[type]{definition}

+

and -


\defglsdisplayfirst  \defglsdisplayfirst[type]{definition}

-

+


\defglsdisplayfirst  \defglsdisplayfirst[type]{definition} +

+

instead of redefining \glsdisplay and \glsdisplayfirst. -

Both \defglsdisplay and \defglsdisplayfirst take +class="ec-lmtt-10x-x-109">\glsdisplay and \glsdisplayfirst. +

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

For example, suppose you have created a new glossary called notation and you -want to change the way the entry is displayed on first use so that it includes the -symbol, you can do: - - - +href="#fn1x8" id="fn1x8-bk">1 +and the second is how the term should be displayed when it is invoked +using commands \gls, \glspl, their uppercase variants and \glsdisp. +This is similar to the way \glsdisplayfirst was redefined above. +

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

-
+
\defglsdisplayfirst[notation]{#1#4 (denoted #3)}
-

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 first time you reference this entry it will be displayed as: “set (denoted S)” -(assuming \gls was used). -

Remember that if you use the symbol key, you need to use a glossary style that -displays the symbol, as many of the styles ignore it. In addition, if you want either the -description or symbol to appear in the

The first time you reference this entry it will be displayed as: “set +(denoted S)” (assuming \gls was used). +

Remember that if you use the symbol key, you need to use a glossary +style that displays the symbol, as many of the styles ignore it. In addition, +if you want either the description or symbol to appear in the link text, you will have to disable the -, you +will have to disable the sanitization of these keys and protect fragile commands. -

+ id="dx1-29043"> of these keys and protect fragile +commands. +

-

Top

6.2 Enabling and disabling hyperlinks to glossary entries

-

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


\glsdisablehyper  \glsdisablehyper

-

+

Top

6.2  Enabling and disabling hyperlinks to glossary entries

+

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


\glsdisablehyper  \glsdisablehyper

+

and -


\glsenablehyper  \glsenablehyper

-

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

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 flag, for -example \gls, \glspl and \glsdisp but not \glslink. -

+


\glsenablehyper  \glsenablehyper

+

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

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 flag, for example \gls, \glspl and \glsdisp but not +\glslink. + + +

-

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


\glsadd  \glsadd[options]{label}

- - - -

+

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


\glsadd  \glsadd[options]{label}

+

This is similar to \glslink, only it doesn’t produce any text (so therefore, +class="ec-lmtt-10x-x-109">\glslink, only it doesn’t produce any text (so therefore, there is no hyper key available in optionsbut 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="ec-lmss-10x-x-109">hyper key available in optionsbut 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: + + +

-
+
\glsadd[format=(]{set}  
Lots of text about sets spanning many pages.  
\glsadd[format=)]{set}
-

-

To add all entries that have been defined, use: -


\glsaddall  \glsaddall[options]

-

+

+

To add all entries that have been defined, use: +


\glsaddall  \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="ec-lmtt-10x-x-109">\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 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 2.3 and 5.) -
-

-

The sample 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 acronyms. This example sets -up the list of acronyms using the acronym package option: - - - +

+

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 2.3 and 5.)
+

+

The sample 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 +acronyms. This example sets up the list of acronyms using the 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\protect\glsadd{#2}},% @@ -7253,1702 +7842,1833 @@ class="ecss-1000">acronym  \newacronym{#2}{#3\protect\glsadd{main-#2}}{#4}  
}
-

This has the following syntax: -


\newdualentry[options]{label}{abbrv}{long}{description}

-

+

This has the following syntax: +


\newdualentry[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}. + + +

-

Top

8 Cross-Referencing Entries

-

There are several ways of cross-referencing entries in the glossary: -

+

8  Cross-Referencing Entries

+

There are several ways of cross-referencing entries in the glossary:

  1. You can use commands such as \gls in the entries description. For example: - + class="enumerate" id="x1-32002x1">You can use commands such as \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 + makeglossaries: - +class="ec-lmtt-10x-x-109">makeglossaries: + - +

    -
    +
    latex filename  
    makeglossaries filename  
    latex filename  
    makeglossaries filename  
    latex filename
    -

    -

    If you switch off the description

    +

    If you switch off the description sanitization, you must protect fragile + id="dx1-32007">, you must protect fragile commands:9 - +href="#fn1x10" id="fn1x10-bk">1 + - +

    -
    +
    \newglossaryentry{apple}{name=apple,  
    description={firm, round fruit. See also  
    \protect\gls{pear}}}
    -

    -

    +

    +

  2. As described in §4 Defining Glossary Entries, you can use the see key when you - define the entry. For example: - - - -
    - \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, + class="enumerate" id="x1-32011x2">As described in §4 Defining Glossary Entries, you can use the see key + when you define the entry. For example: + + + +
    + \newglossaryentry{MaclaurinSeries}{name={Maclaurin +  
    series},  
    description={Series expansion},  
    see={TaylorsTheorem}}
    -

    Note that in this case, the entry with the see key will 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 §7 Adding an Entry to the Glossary Without Generating +

    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 §7 Adding an Entry to the Glossary Without Generating Text. -

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

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

    -
    - \newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, +
    + \newglossaryentry{MaclaurinSeries}{name={Maclaurin +  
    series},  
    description={Series expansion},  
    see=[see also]{TaylorsTheorem}}
    -

    +

  3. After you have defined the entry, use -


    \glssee  \glssee[tag]{label}{xr label list}

    -

    + class="enumerate" id="x1-32017x3">After you have defined the entry, use +


    \glssee  \glssee[tag]{label}{xr label list}

    +

    where xr label listis a comma-separated list of entry labels to be +class="lmsy-10x-x-109">⟨xr label listis a comma-separated list of entry labels to be cross-referenced, labelis the label of the entry doing the cross-referencing - and tagis the “see” tag. (The default value of tagis \seename.) For - example: - +class="lmsy-10x-x-109">⟨labelis the label of the entry doing the + cross-referencing and tagis the “see” tag. (The default value of + tagis \seename.) For example: + - +

    -
    +
    \glssee[see also]{series}{FourierSeries,TaylorsTheorem}
    -

    Note that this automatically adds the entry given by labelto 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 labelto 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 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 number list -for the given entries using nonumberlist=false. Alternatively, if you just use the see key -instead of \glssee, you can automatically activate the number list using the -seeautonumberlist package option. -

+ id="dx1-32021">, 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 number list. 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 key instead of \glssee, you can +automatically activate the number list using the seeautonumberlist package +option.

-

Top

8.1 Customising Cross-reference Text

-

When you use either the see key or the command \glssee, the cross-referencing -information will be typeset in the glossary according to: -


\glsseeformat  \glsseeformat[tag]{label-list}{location}

-

+

8.1  Customising Cross-reference Text

+

When you use either the see key or the command \glssee, the +cross-referencing information will be typeset in the glossary according +to: +


\glsseeformat  \glsseeformat[tag]{label-list}{location} +

+

The default definition of \glsseeformat is: -
\emph{tag} \glsseelist{label-list} -
+class="ec-lmtt-10x-x-109">\glsseeformat is: +
\emph{tag} \glsseelist{label-list} +
Note that the location is always ignored.10 +href="#fn2x10" id="fn2x10-bk">2 For example, if you want the tag to appear in bold, you can do:11 - +href="#fn3x10" id="fn3x10-bk">3 + - +

-
-\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1} \glsseelist{#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 -


\glsseesep  \glsseesep

-

+

+

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 +


\glsseesep  \glsseesep

+

or (for the last pair) -


\glsseelastsep  \glsseelastsep

-

-These default to ,\space and \space\andname\space respectively. The list entry text -is displayed using: -


\glsseeitemformat  \glsseeitemformat{label}

-

+


\glsseelastsep  \glsseelastsep

+

+These default to “,\space” and “\space\andname\space” respectively. +The list entry text is displayed using: +


\glsseeitemformat  \glsseeitemformat{label}

+

This defaults to \glsentrytext{label}.12 +class="ec-lmtt-10x-x-109">\glsentrytext{label}.4 For example, to make the cross-referenced list use small caps: - + - +

-
-\renewcommand{\glsseeitemformat}[1]{\textsc{\glsentrytext{#1}}} +
+\renewcommand{\glsseeitemformat}[1]{% + 
  \textsc{\glsentrytext{#1}}}
-

-

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

+

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

-
+
Some information (see also  
\glsseelist{FourierSeries,TaylorsTheorem}%  
\glsadd{FourierSeries}\glsadd{TaylorsTheorem}).
-

-

-

+

+

+ + +

-

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

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 first use flag and, apart from \glshyperlink, -they don’t produce hyperlinks. -


\glsentryname  \glsentryname{label}

-

-


\Glsentryname  \Glsentryname{label}

-

+class="ec-lmtt-10x-x-109">\glshyperlink, they don’t +produce hyperlinks. +


\glsentryname  \glsentryname{label}

+

+


\Glsentryname  \Glsentryname{label}

+

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


\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 key. \Glsentrytext makes the first letter -uppercase. -


\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 key. \Glsentryplural makes the first letter +class="lmsy-10x-x-109">⟨label, as +specified by the name key. \Glsentryname makes the first letter uppercase. -


\glsentryfirst  \glsentryfirst{label}

- - - -

-


\Glsentryfirst  \Glsentryfirst{label}

-

+


\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 key. \Glsentrytext makes the +first letter uppercase. +


\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 key. \Glsentryplural +makes the first letter uppercase. +


\glsentryfirst  \glsentryfirst{label}

+

+


\Glsentryfirst  \Glsentryfirst{label}

+

These commands display the first use text for the glossary entry given by label, as specified by the first key. \Glsentryfirst makes the first letter +class="lmsy-10x-x-109">⟨label, as specified by the first key. \Glsentryfirst makes the first letter uppercase. -


\glsentryfirstplural  \glsentryfirstplural{label}

-

-


\Glsentryfirstplural  \Glsentryfirstplural{label}

-

+


\glsentryfirstplural  \glsentryfirstplural{label}

+

+


\Glsentryfirstplural  \Glsentryfirstplural{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 uppercase. -


\glsentrydesc  \glsentrydesc{label}

-

-


\Glsentrydesc  \Glsentrydesc{label}

-

-These commands display the description for the glossary entry given by label. -\Glsentrydesc makes the first letter uppercase. -


\glsentrydescplural  \glsentrydescplural{label}

-

-


\Glsentrydescplural  \Glsentrydescplural{label}

-

-These commands display the plural description for the glossary entry given by label. -\Glsentrydescplural makes the first letter uppercase. -


\glsentrysymbol  \glsentrysymbol{label}

-

-


\Glsentrysymbol  \Glsentrysymbol{label}

-

+ id="dx1-34019">first use text for the +glossary entry given by label, as specified by the firstplural key. +\Glsentryfirstplural makes the first letter uppercase. +


\glsentrydesc  \glsentrydesc{label}

+

+


\Glsentrydesc  \Glsentrydesc{label}

+

+These commands display the description for the glossary entry given by +label. \Glsentrydesc makes the first letter uppercase. +


\glsentrydescplural  \glsentrydescplural{label}

+

+


\Glsentrydescplural  \Glsentrydescplural{label}

+

+These commands display the plural description for the glossary +entry given by label. \Glsentrydescplural makes the first letter +uppercase. +


\glsentrysymbol  \glsentrysymbol{label}

+

+


\Glsentrysymbol  \Glsentrysymbol{label}

+

These commands display the symbol for the glossary entry given by label. -\Glsentrysymbol makes the first letter uppercase. -


\glsentrysymbolplural  \glsentrysymbolplural{label}

-

-


\Glsentrysymbolplural  \Glsentrysymbolplural{label}

-

-These commands display the plural symbol for the glossary entry given by label. -\Glsentrysymbolplural makes the first letter uppercase. -


\glsentryuseri  \glsentryuseri{label}

-

- - - -


\Glsentryuseri  \Glsentryuseri{label}

-

-


\glsentryuserii  \glsentryuserii{label}

-

-


\Glsentryuserii  \Glsentryuserii{label}

-

-


\glsentryuseriii  \glsentryuseriii{label}

-

-


\Glsentryuseriii  \Glsentryuseriii{label}

-

-


\glsentryuseriv  \glsentryuseriv{label}

-

-


\Glsentryuseriv  \Glsentryuseriv{label}

-

-


\glsentryuserv  \glsentryuserv{label}

-

-


\Glsentryuserv  \Glsentryuserv{label}

-

-


\glsentryuservi  \glsentryuservi{label}

-

-


\Glsentryuservi  \Glsentryuservi{label}

-

-These commands display the value of the user keys for the glossary entry given by -label. -


\glshyperlink  \glshyperlink[link text]{label}

-

-This command provides a hyperlink to the glossary entry given by labelbut does not add -any information to the glossary file. The link text is given by \glsentrytext{label} by +class="lmsy-10x-x-109">⟨label. +\Glsentrysymbol makes the first letter uppercase. +


\glsentrysymbolplural  \glsentrysymbolplural{label}

+

+


\Glsentrysymbolplural  \Glsentrysymbolplural{label}

+

+These commands display the plural symbol for the glossary entry +given by label. \Glsentrysymbolplural makes the first letter +uppercase. +


\glsentryuseri  \glsentryuseri{label}

+

+


\Glsentryuseri  \Glsentryuseri{label}

+

+


\glsentryuserii  \glsentryuserii{label}

+

+ + + +


\Glsentryuserii  \Glsentryuserii{label}

+

+


\glsentryuseriii  \glsentryuseriii{label}

+

+


\Glsentryuseriii  \Glsentryuseriii{label}

+

+


\glsentryuseriv  \glsentryuseriv{label}

+

+


\Glsentryuseriv  \Glsentryuseriv{label}

+

+


\glsentryuserv  \glsentryuserv{label}

+

+


\Glsentryuserv  \Glsentryuserv{label}

+

+


\glsentryuservi  \glsentryuservi{label}

+

+


\Glsentryuservi  \Glsentryuservi{label}

+

+These commands display the value of the user keys for the glossary entry +given by label. +


\glshyperlink  \glshyperlink[link text]{label}

+

+This command provides a hyperlink to the glossary entry given by +labelbut does not add any information to the glossary +file. The link text is given by \glsentrytext{label} by default13, +href="#fn1x11" id="fn1x11-bk">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 §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.
-

- - - -

For further information see “Displaying entry details without adding information to -the glossary” in the documented code (glossaries.pdf). -

+

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 §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  \glsdisplaynumberlist{label}

+

+Both display the number list for the entry given by labeland require a +run of makeglossaries (or xindy 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  \glsnumlistsep

+

+as the separator between all but the last two elements and +


\glsnumlistlastsep  \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.pdf). + + +

-

Top

10 Displaying a glossary

-

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 10  Displaying a glossary +

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 +makeglossaries or have -directly used makeglossaries or have directly used makeindex or makeindex or 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 makeindex/xindy log files to see if there is a problem. Remember -that you also need to use the command \makeglossaries in the preamble to enable the -glossaries. -

An individual glossary can be displayed using: -


\printglossary  \printglossary[options]

-

+class="ec-lmtt-10x-x-109">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 +makeindex/xindy log files to see if there is a problem. Remember that you +also need to use the command \makeglossaries in the preamble to enable +the glossaries. +

An individual glossary can be displayed using: +


\printglossary  \printglossary[options]

+

where optionsis a key=valuelist of options. The following keys are available: +class="lmsy-10x-x-109">⟨optionsis a key=valuelist of options. The following keys are +available:

type
The value of this key specifies which glossary to print. If omitted, the default - glossary is assumed. For example, to print the list of acronyms: - +class="ec-lmssbx-10x-x-109">type
The value of this key specifies which glossary to print. If omitted, the + default glossary is assumed. For example, to print the list of + acronyms: + - -
+ +
\printglossary[type=\acronymtype]
-

+

title
This is the glossary’s title (overriding the title specified when the glossary was - defined). +class="ec-lmssbx-10x-x-109">title
This is the glossary’s title (overriding the title specified when the + glossary was defined).
toctitle
toctitle
This is the title to use for the table of contents (if the toc package 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="ec-lmss-10x-x-109">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.
style
This specifies which glossary style to use for this glossary, overriding the effect of - the style package option or \glossarystyle. +class="ec-lmssbx-10x-x-109">style
This specifies which glossary style to use for this glossary, overriding + the effect of the style package option or \glossarystyle.
numberedsection
This specifies whether to use a numbered section for this glossary, - overriding the effect of the numberedsection package option. This key has the same - syntax as the numberedsection package option, described in §2.2 Sectioning and - TOC Options. +class="ec-lmssbx-10x-x-109">numberedsection
This specifies whether to use a numbered section for this + glossary, overriding the effect of the numberedsection package + option. This key has the same syntax as the numberedsection + package option, described in §2.2 Sectioning, Headings and TOC + Options.
nonumberlist
nonumberlist
This is a boolean key. If true (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="ec-lmtt-10x-x-109">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.
-

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 +

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 \glossarymark. If this mechanism is unsuitable for your chosen class -file or page style package, you will need to redefine \glossarymark. Further -information about these options and commands is given in §2.2 Sectioning and TOC +class="ec-lmss-10x-x-109">numberedsection package option. Each glossary sets the +page header via the command \glossarymark. If this mechanism is +unsuitable for your chosen class file or page style package, you will +need to redefine \glossarymark. 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  \glossarypreamble

-

+ + + +

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

+

For example: - + - +

-
-\renewcommand{\glossarypreamble}{Numbers in italic indicate - 
primary definitions.} +
+\renewcommand{\glossarypreamble}{Numbers in italic + 
indicate primary definitions.}
-

This needs to be done before the glossary is displayed using \printglossaries or -\printglossary. Note that if you want a different preamble for each glossary, you will -need to use a separate \printglossary for each glossary and change the definition of -\glossarypreamble between each glossary. For example: - +

This needs to be done before the glossary is displayed using +\printglossaries or \printglossary. Note that if you want a different +preamble for each glossary, you will need to use a separate \printglossary +for each glossary and change the definition of \glossarypreamble between +each glossary. For example: + - +

-
-\renewcommand{\glossarypreamble}{Numbers in italic indicate - 
primary definitions.} +
+\renewcommand{\glossarypreamble}{Numbers in italic + 
indicate primary definitions.}  
\printglossary  
\renewcommand{\glossarypreamble}{}  
\printglossary[type=acronym]
-

Alternatively, you can do something like: - +

Alternatively, you can do something like: + - +

-
-\renewcommand{\glossarypreamble}{Numbers in italic indicate - 
primary definitions.\gdef\glossarypreamble{}} +
+\renewcommand{\glossarypreamble}{Numbers in italic + 
indicate primary definitions.\gdef\glossarypreamble{}}  
\printglossaries
-

which will print the preamble text for the first glossary and change the preamble to do -nothing for subsequent glossaries. (Note that \gdef is required as the glossary is placed -within a group.) -

There is an analogous command called -


\glossarypostamble  \glossarypostamble

-

+

which will print the preamble text for the first glossary and change the +preamble to do nothing for subsequent glossaries. (Note that \gdef is +required as the glossary is placed within a group.) +

There is an analogous command called +


\glossarypostamble  \glossarypostamble

+

which is placed at the end of each glossary. -

For example: suppose you are using the superheaderborder +

For example: suppose you are using the superheaderborder style14, -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: - +href="#fn1x12" id="fn1x12-bk">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: + - +

-
+
\renewcommand*{\glossarysection}[2][]{% - 
  \twocolumn[{\section*{#2}}]% + 
  \twocolumn[{\chapter*{#2}}]%  
  \setlength\glsdescwidth{0.6\linewidth}%  
  \glossarymark{\glossarytoctitle}%  
}  
\renewcommand*{\glossarypostamble}{\onecolumn}
-

-

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 style file) the name will appear in bold, since the name is +

+

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 style file) the name will appear in bold, since the name is placed in the optional argument of \item, whereas in the tabular styles (defined in the -glossary-long and glossary-super style files) the name will appear in the normal font. The -hierarchical glossary styles (defined in the glossary-tree style file) also set the name in +class="ec-lmtt-10x-x-109">\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. -

For example, suppose you want all the entry names to appear in medium weight -small caps, then you can do: - +

For example, suppose you want all the entry names to appear in medium +weight small caps, then you can do: + - +

-
+
\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
-

-

+

+ + +

-

Top

11 Xindy

-

If you want to use 11  Xindy +

If you want to use xindy to sort the glossary, you must use the package option -xindy: - +class="ec-lmtt-10x-x-109">xindy to sort the glossary, you must use the package +option xindy: + - +

-
+
\usepackage[xindy]{glossaries}
-

This ensures that the glossary information is written in xindy syntax. -

§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

This ensures that the glossary information is written in xindy +syntax. +

§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 xindy style file (.xdy) and parameters. -

To assist writing information to the xindy style file +(.xdy) and parameters. +

To assist writing information to the xindy style file, the glossaries package provides -the following commands: -


\glsopenbrace  \glsopenbrace

-

-


\glsclosebrace  \glsclosebrace

-

+class="ec-lmtt-10x-x-109">xindy style file, the glossaries +package provides the following commands: +


\glsopenbrace  \glsopenbrace

+

+


\glsclosebrace  \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) you can use: -


\glsquote  \glsquote{text}

-

+class="ec-lmtt-10x-x-109">\{ 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{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 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 documentation. -

+class="ec-lmss-10x-x-109">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, read the xindy +documentation.

-

Top

11.1 Language and Encodings

-

When you use 11.1  Language and Encodings +

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


\GlsSetXdyLanguage  \GlsSetXdyLanguage[glossary type]{language} -

- +class="ec-lmtt-10x-x-109">makeglossaries, this +information is obtained from the document’s auxiliary (.aux) file. The +glossaries package attempts to find the root language, but in the event that + - -

+ +it gets it wrong or if xindy doesn’t support that language, then you can +specify the language using: +


\GlsSetXdyLanguage  \GlsSetXdyLanguage[glossary type]{language} +

+

where languageis the name of the language. The optional argument can be used if -you have multiple glossaries in different languages. If glossary typeis 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 +class="lmsy-10x-x-109">⟨languageis the name of the language. The optional argument can +be used if you have multiple glossaries in different languages. If glossary +typeis 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. Alternatively, you can specify the encoding +class="ec-lmtt-10x-x-109">\inputencodingname. Alternatively, you can specify the encoding using: -


\GlsSetXdyCodePage  \GlsSetXdyCodePage{code}

-

+


\GlsSetXdyCodePage  \GlsSetXdyCodePage{code}

+

where codeis the name of the encoding. For example: - +class="lmsy-10x-x-109">⟨codeis 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="ec-lmtt-10x-x-109">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 makeglossaries. If you call makeglossaries. If you call xindy without makeglossaries you need to -remember to set the language and encoding using the -L and -C switches. -
-

-

+class="ec-lmtt-10x-x-109">xindy without +makeglossaries you need to remember to set the language and encoding +using the -L and -C switches.

+

+

-

Top

11.2 Locations and Number lists

-

If you use xindy, the glossaries package needs to know which counters you will be using -in the

Top

11.2  Locations and Number lists

+

If you use xindy, the glossaries package needs to know which counters you +will be using in the number list in order to correctly format the in order to correctly format the xindy style file. Counters specified -using the counter package option or the counteroption 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="ec-lmtt-10x-x-109">xindy 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  \GlsAddXdyCounters{counter list}

+

where counter listis a comma-separated list of counter names. -

The most likely attributes used in the format key (textrm, hyperrm etc) are -automatically added to the counter listis a comma-separated list of counter names. +

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


\GlsAddXdyAttribute  \GlsAddXdyAttribute{name}

-

+class="ec-lmtt-10x-x-109">xindy style file, but if you want to use +another attribute, you need to add it using: +


\GlsAddXdyAttribute  \GlsAddXdyAttribute{name}

+

where nameis the name of the attribute, as used in the format key. For example, -suppose I want a bold, italic, hyperlinked location. I first need to define a command -that will do this: - - - +class="lmsy-10x-x-109">⟨nameis the name of the attribute, as used in the format key. For +example, suppose I want a bold, italic, hyperlinked location. I first need to +define a command that will do this: + + +

-
+
\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
-

but with

but with xindy, I also need to add this as an allowed attribute: - +class="ec-lmtt-10x-x-109">xindy, I also need to add this as an allowed attribute: + - +

-
+
\GlsAddXdyAttribute{hyperbfit}
-

-

Note that \GlsAddXdyAttribute has no effect if \noist is used or if -\makeglossaries is omitted. \GlsAddXdyAttribute must be used before -\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 -


\GlsAddXdyLocation  \GlsAddXdyLocation[prefix-location]{name}{definition} +

+

Note that \GlsAddXdyAttribute has no effect if \noist is used or if +\makeglossaries is omitted. \GlsAddXdyAttribute must be used before +\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 +


\GlsAddXdyLocation  \GlsAddXdyLocation[prefix-location]{name}{definition}

-

+

where nameis the name of the format and definitionis the nameis the name of the format and definitionis the +xindy definition. The -optional argument prefix-locationis needed if \theHcountereither isn’t defined or is -different from \thecounter. -

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

-

For example, suppose I decide to use a somewhat eccentric numbering system for -sections that redefines \thesection as follows: - - - +class="ec-lmtt-10x-x-109">xindy definition. The optional argument prefix-locationis needed if +\theHcountereither isn’t defined or is different from \thecounter. +

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

+

For example, suppose I decide to use a somewhat eccentric numbering +system for sections that redefines \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"  
}
-

The above example is illustrated in the accompanying sample file samplexdy2.tex. -

Another example: suppose you want the page numbers written as words rather than -digits and you use the fmtcount package to do this. You can redefine \thepage as -follows: - +

The above example is illustrated in the accompanying sample file +samplexdy2.tex. +

Another example: suppose you want the page numbers written as words +rather than digits and you use the fmtcount package to do this. You can +redefine \thepage as follows: + - +

-
+
\renewcommand*{\thepage}{\Numberstring{page}}
-

This gets expanded to \protect \Numberstringnum {n} where nis the Arabic -page number. This means that you need to define a new location that has that -form: - +

This gets expanded to \protect \Numberstringnum {n} where nis +the Arabic page number. This means that you 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, xindy doesn’t ignore spaces after control +class="ec-lmtt-10x-x-109">xindy doesn’t ignore spaces after control sequences. -

\GlsAddXdyLocation{name}{definition} will define commands -


\glsXcounterXname{Hprefix}{location}

-

+

\GlsAddXdyLocation{name}{definition} will define commands +


\glsXcounterXname{Hprefix}{location}

+

for each counter that has been identified either by the counter package option, the -counteroption for \newglossary or in the argument of \GlsAddXdyCounters. -

The first argument Hprefixis only relevant when used with the hyperref package -and indicates that \theHcounteris given by \Hprefix.\thecounter. 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 counter package +option, the counteroption for \newglossary or in the argument of +\GlsAddXdyCounters. +

The first argument Hprefixis only relevant when used with the +hyperref package and indicates that \theHcounteris given by +\Hprefix.\thecounter. 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 xindy 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 -\glsXcounterXformatcommands: - - - +class="ec-lmtt-10x-x-109">xindy 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 \glsXcounterXformat +commands: + + +

-
+
\renewcommand{\glsXpageXglsnumberformat}[2]{%  
 \linkpagenumber#2%  
} @@ -8957,53 +9677,54 @@ class="cmsy-10">⟩ 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: + id="dx1-38045">, the locations are sorted according to +type. The default ordering is: roman-page-numbers (e.g. i), 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 +class="ec-lmtt-10x-x-109">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 hyphen15), +href="#fn1x13" id="fn1x13-bk">1), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), +class="ec-lmtt-10x-x-109">alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), Alpha-page-numbers (e.g. A), Appendix-page-numbers (e.g. A.1 if -the Alpha compositor is a full stop or A-1 if the Alpha compositor is a +class="ec-lmtt-10x-x-109">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 hyphen16), +href="#fn2x13" id="fn2x13-bk">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  -


\GlsSetXdyLocationClassOrder{location names}

-

-where each location name is delimited by double quote marks and separated by white -space. For example: - - - +class="ec-lmtt-10x-x-109">\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{  
  "arabic-page-numbers"  
  "arabic-section-numbers" @@ -9015,508 +9736,525 @@ space. For example:  
  "see"  
}
-

-

+

+

Note that \GlsSetXdyLocationClassOrder +class="ec-lmtt-10x-x-109">\GlsSetXdyLocationClassOrder has no effect if \noist +class="ec-lmtt-10x-x-109">\noist is used or if \makeglossaries +class="ec-lmtt-10x-x-109">\makeglossaries is omitted. \GlsSetXdyLocationClassOrder +class="ec-lmtt-10x-x-109">\GlsSetXdyLocationClassOrder must be used before \makeglossaries. +class="ec-lmtt-10x-x-109">\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  \GlsSetXdyMinRangeLength{n}

- - - -

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

+

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 -\makeglossaries is omitted. \GlsSetXdyMinRangeLength must be used before -\makeglossaries.
-

-

See §5 Number lists for further details. -

+class="ec-lmtt-10x-x-109">xindy 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.
+

+

See §5 Number lists for further details. +

-

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

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

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


\GlsSetXdyFirstLetterAfterDigits{letter}

-

-

+

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 +class="ec-lmtt-10x-x-109">\GlsSetXdyFirstLetterAfterDigits has no effect if \noist +class="ec-lmtt-10x-x-109">\noist is used or if \makeglossaries +class="ec-lmtt-10x-x-109">\makeglossaries is omitted. \GlsSetXdyFirstLetterAfterDigits +class="ec-lmtt-10x-x-109">\GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries. +class="ec-lmtt-10x-x-109">\makeglossaries.
-

-

+

+ + +

- - - -

Top

12 Defining New Glossaries

-

A new glossary can be defined using: -


\newglossary  \newglossary[log-ext]{name}{in-ext}{out-ext}{title}[counter] -

-

+

Top

12  Defining New Glossaries

+ A new glossary can be defined using: +


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

+

where nameis the label to assign to this glossary. The arguments in-ext -and out-extspecify the extensions to give to the input and output files for -that glossary, titleis the default title for this new glossary and the final -optional argument counterspecifies which counter to use for the associated -nameis the label to assign to this glossary. The arguments +in-extand out-extspecify the extensions to give to the input and +output files for that glossary, titleis the default title for this new +glossary and the final optional argument counterspecifies which +counter to use for the associated number lists (see also §5 Number lists). The first optional argument specifies the -extension for the s (see also §5 Number +lists). The first optional argument specifies the extension for the +makeindex or makeindex or xindy transcript file (this information is only -used by xindy transcript file (this information is only used by +makeglossaries which picks up the information from the auxiliary +class="ec-lmtt-10x-x-109">makeglossaries which picks up the information from the auxiliary file). -

Note that the main (default) glossary is automatically created as: - +

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

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

-

+

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

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

+ + +

-

Top

13 Acronyms

-

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

-

-

This uses \newglossaryentry to create an entry with the given label in the glossary -given by \acronymtype. Amongst other things, it sets up the first and text keys and, -depending on the acronym style, may also use \defdisplayfirst and \defdisplay -(see §6.1 Changing the format of the link text). -

The optional argument {key-val list} allows you to specify keys such as description -(when used with the description package option, described below) or you can override -plural forms of abbrvor longusing the shortplural or longplural keys. For -example: - +

13  Acronyms

+

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

+

+

This uses \newglossaryentry to create an entry with the given label in +the glossary given by \acronymtype. Amongst other things, it sets up the +first and text keys and, depending on the acronym style, may also use +\defdisplayfirst and \defdisplay (see §6.1 Changing the format of the +link text). +

The optional argument {key-val list} allows you to specify keys such as +description (when used with the description package option, described +below) or you can override plural forms of abbrvor longusing 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). -

The following package options are available to change the acronym style: -

+class="ec-lmtt-10x-x-109">\glspl{dm} will display: diagonal +matrices (DMs). +

The following package options are available to change the acronym +style:

description
description
With this package option, the description key needs to be set in the - optional argument key-val listof \newacronym. (If this package option isn’t - used, the long form longis put in the description key.) +class="ec-lmss-10x-x-109">description key needs to be + set in the optional argument key-val listof \newacronym. (If + this package option isn’t used, the long form longis put in the + description key.)
footnote
footnote
With this package option, on first use the long form longis placed in a - footnote. By default the long form in the footnote will link to the relevant - entry in the glossary or list of acronyms. You can prevent this link by - doing: - - - -
+class="lmsy-10x-x-109">⟨longis + placed in a footnote. By default the long form in the footnote will + link to the relevant entry in the glossary or list of acronyms. You can + prevent this link by doing: + + + +
\let\acrfootnote\acrnolinkfootnote
-

+

smallcaps
smallcaps
With this package option, the short form abbrvis typeset using - \textsc. (Recall that \textsc converts lower case characters into small - capitals and leaves upper case characters as they are. Therefore, you - need to have lower case characters in abbrvfor this option to have an - effect.) +class="lmsy-10x-x-109">⟨abbrvis typeset + using \textsc. (Recall that \textsc converts lower case characters + into small capitals and leaves upper case characters as they are. + Therefore, you need to have lower case characters in abbrvfor this + option to have an effect.)
smaller
smaller
This is similar to smallcaps, except that \textsmaller is used instead of - \textsc. Note that the glossaries package doesn’t define \textsmaller nor does it - load any package that does so. If you use this option, you must make sure +class="ec-lmss-10x-x-109">smallcaps, except that \textsmaller is used + instead of \textsc. Note that the glossaries package doesn’t define \textsmaller is defined (for example by loading relsize). +class="ec-lmtt-10x-x-109">\textsmaller nor does it load any package that does so. If you use + this option, you must make sure \textsmaller is defined (for + example by loading relsize).
dua
dua
This option will set both the first and text keys to the long form long.
-

If you want to define your own custom acronym style, see §13.3 Defining A Custom -Acronym Style. -

If you try using \newglossaryentry for entries in a designated list of acronyms in -combination with any of the above named package options you are likely to get -unexpected results such as empty brackets or empty footnotes. -

If you don’t intend to use \newacronym you should skip this section] and not use the -above package options.

-

-

As mentioned in §2.2 Sectioning and TOC Options, the command \acronymtype is -the name of the glossary in which the acronyms should appear. If the acronym package -option has been used, this will be acronym, otherwise it will be main. The acronyms can -then be used in exactly the same way as any other glossary entry. If you want more -than one list of acronyms, you must identify the others using the package options -acronymlists. This ensures that options such as footnote and smallcaps work for the -additional lists of acronyms. -

+class="ec-lmss-10x-x-109">first and text keys to the long form + long. +

If you want to define your own custom acronym style, see §13.3 Defining +A Custom Acronym Style. +

If you try using \newglossaryentry for entries in a designated list of +acronyms in combination with any of the above named package options +you are likely to get unexpected results such as empty brackets or empty +footnotes. +

If you don’t intend to use \newacronym you should skip this section] and +not use the above package options.

+

+

As mentioned in §2.2 Sectioning, Headings and TOC Options, the +command \acronymtype is the name of the glossary in which the acronyms +should appear. If the acronym package option has been used, this +will be acronym, otherwise it will be main. The acronyms can then +be used in exactly the same way as any other glossary entry. If +you want more than one list of acronyms, you must identify the +others using the package options acronymlists. This ensures that +options such as footnote and smallcaps work for the additional lists of +acronyms. + + + +

Since \newacronym +class="ec-lmtt-10x-x-109">\newacronym sets type=\acronymtype, +class="ec-lmtt-10x-x-109">type=\acronymtype, if - - - you want to @@ -9528,24 +10266,24 @@ acronym definitions using \loadglsentries[type]{filename}, +class="ec-lmtt-10x-x-109">\loadglsentries[type]{filename}, the optional argument type +class="lmsy-10x-x-109">⟨type will not have @@ -9559,1094 +10297,1096 @@ the type as type=\glsdefaulttype +class="ec-lmtt-10x-x-109">type=\glsdefaulttype in the optional argument to \newacronym. +class="ec-lmtt-10x-x-109">\newacronym. See §4.3 +href="#sec:loadglsentries">§4.4 + + + Loading +href="#sec:loadglsentries">Loading Entries From a File.
-

-

Since \newacronym uses \newglossaryentry, you can use commands like \gls and -\glsreset as with any other glossary entry. - - - -

For example, the following defines the acronym IDN: - - - +

+

Since \newacronym uses \newglossaryentry, you can use commands +like \gls and \glsreset as with any other glossary entry. +

For example, 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 the smallcaps package option, you need to use lower -case characters for the shortened form: - - - +

\gls{idn} will produce “identification number (IDN)” on first use and +“IDN” on subsequent uses. If you want to use the smallcaps package +option, you need to use lower case characters for the shortened +form: + + +

-
+
\newacronym{idn}{idn}{identification number}
-

Now \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on -subsequent uses. -

If you use any of the package options smallcaps, smaller, description or footnote, the -short form abbrvwill be displayed in the document using: -


\acronymfont  \acronymfont{text}

-

+

Now \gls{idn} will produce “identification number (idn)” on first +use and “IDN” on subsequent uses. +

If you use any of the package options smallcaps, smaller, description or +footnote, the short form abbrvwill be displayed in the document +using: +


\acronymfont  \acronymfont{text}

+

and -


\firstacronymfont  \firstacronymfont{text}

-

+


\firstacronymfont  \firstacronymfont{text}

+

where \firstacronymfont is applied on \firstacronymfont is applied on first use and \acronymfont is applied on -subsequent use. Note that if you don’t use any of the above package options, changing -the definition of \acronymfont or \firstacronymfont will have no effect. In this case, -the recommended route is to use either the smaller or the smallcaps package option and +class="ec-lmtt-10x-x-109">\acronymfont is +applied on subsequent use. Note that if you don’t use any of the +above package options, changing the definition of \acronymfont or +\firstacronymfont will have no effect. In this case, the recommended +route is to use either the smaller or the smallcaps package option and redefine \acronymfont and \firstacronymfont as required. (The smallcaps option sets -the default plural suffix in an upright font to cancel the effect of \textsc, -whereas smaller sets the suffix in the surrounding font.) For example, if you want -acronyms in a normal font on first use and emphasized on subsequent use, -do: - +class="ec-lmtt-10x-x-109">\acronymfont and \firstacronymfont as required. (The +smallcaps option sets the default plural suffix in an upright font to cancel +the effect of \textsc, whereas smaller sets the suffix in the surrounding +font.) For example, if you want acronyms in a normal font on first use and +emphasized on subsequent use, do: + - +

-
+
\usepackage[smaller]{glossaries}  
\renewcommand*{\firstacronymfont}[1]{#1}  
\renewcommand*{\acronymfont}[1]{\emph{#1}}
-

(Note that it is for this reason that the relsize package is not automatically loaded -when selecting the smaller package option.) -

There are commands analogous 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]

-

+

(Note that it is for this reason that the relsize package is not automatically +loaded when selecting the smaller package option.) +

There are commands analogous 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]

-

-


\acrlong  \acrlong[options]{label}[insert]

-

+class="lmsy-10x-x-109">⟨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]

+

+


\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 variants: -


\Acrlong  \Acrlong[options]{label}[insert]

-

-


\ACRshort  \ACRlong[options]{label}[insert]

-

-


\acrfull  \acrfull[options]{label}[insert]

-

+class="lmsy-10x-x-109">⟨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  \Acrlong[options]{label}[insert]

+

+


\ACRlong  \ACRlong[options]{label}[insert]

+

+


\acrfull  \acrfull[options]{label}[insert]

+

This is equivalent to: \acrfullformat \acrfullformat{\acrlong}{\acrshort}. This -defaults to long(\acronymfont{short}) regardless of the package options. There are -also analogous upper case variants: -


\Acrfull  \Acrfull[options]{label}[insert]

-

-


\ACRfull  \ACRfull[options]{label}[insert]

- - - -

-

If you find the above commands too cumbersome to write, you can use +class="ec-lmtt-10">\acrfullformat \acrfullformat{\acrlong}{\acrshort}. +This defaults to long(\acronymfont{short}) regardless of the package +options. There are also analogous upper case variants: +


\Acrfull  \Acrfull[options]{label}[insert]

+ + + +

+


\ACRfull  \ACRfull[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 5. -

-
- +class="ec-lmss-10x-x-109">shortcuts package option to activate the shorter command names listed +in table 13.1. + - -



- + - -
Table 5:
Table 13.1: Synonyms provided by the package option shortcuts +class="ec-lmss-10x-x-109">shortcuts
+class="td11"> Shortcut Command +class="td11"> \acs +class="td11"> \Acs +class="td11"> \acsp +class="td11"> \Acsp +class="td11"> \acl +class="td11"> \Acl +class="td11"> \aclp +class="td11"> \Aclp +class="td11"> \acf +class="td11"> \Acf +class="td11"> \acfp +class="td11"> \Acfp +class="td11"> \ac +class="td11"> \Ac +class="td11"> \acp
Shortcut CommandEquivalent Command Equivalent Command
\acs \acrshort \acrshort
\Acs \Acrshort \Acrshort
\acsp \acrshortpl \acrshortpl
\Acsp \Acrshortpl \Acrshortpl
\acl \acrlong \acrlong
\Acl \Acrlong \Acrlong
\aclp \acrlongpl \acrlongpl
\Aclp \Acrlongpl \Acrlongpl
\acf \acrfull \acrfull
\Acf \Acrfull \Acrfull
\acfp \acrfullpl \acrfullpl
\Acfp \Acrfullpl \Acrfullpl
\ac \gls \gls
\Ac \Gls \Gls
\acp \glspl \glspl
\Acp \Glspl
+class="td11"> \Acp \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 §9 Using -Glossary Terms Without Links). -

The long form can be accessed using: -


\glsentrylong  \glsentrylong{label}

-

+ + + +


+

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

+

+ + +

-

Top

13.1 Predefined Acronym Styles

-

Some of the acronym-related package options may be combined. Listed below are the -effects of different combinations. If you use an invalid combination, you’ll get an error -message. -

+

13.1  Predefined Acronym Styles

+

Some of the acronym-related package options may be combined. Listed +below are the effects of different combinations. If you use an invalid +combination, you’ll get an error message.

description,footnote
When these two package options are used together, the first - use displays the entry as: +class="ec-lmssbx-10x-x-109">description,footnote
When these two package options are used together, + the first use displays the entry as:
\firstacronymfont{abbrv}insert\footnote{long} +class="ec-lmtt-10x-x-109">\firstacronymfont{
abbrv}insert\footnote{long}
while subsequent use displays the entry as:
\acronymfont{abbrv}insert +class="ec-lmtt-10x-x-109">\acronymfont{
abbrv}insert
where insertindicates the text supplied in the final optional argument to \gls, - \glspl or their uppercase variants. +class="lmsy-10x-x-109">⟨insertindicates the text supplied in the final optional + argument to \gls, \glspl or their uppercase variants.
dua
dua
The dua package option always makes \gls display the expanded form and so may - not be used with footnote, smaller or smallcaps. Both first use and subsequent use - displays the entry in the form: +class="ec-lmss-10x-x-109">dua package option always makes \gls display the expanded form + and so may not be used with footnote, smaller or smallcaps. Both + first use and subsequent use displays the entry in the form: +
long⟩⟨insert +class="lmsy-10x-x-109">⟨
long⟩⟨insert
You can, however, access the short form using \acrshort and its variants. +class="ec-lmtt-10x-x-109">\acrshort and its + variants.
description
description
This package option displays the entry on first use as: + id="dx1-42015">first use as: +
long⟩⟨insert(\firstacronymfont{abbrv}) +class="lmsy-10x-x-109">⟨
long⟩⟨insert(\firstacronymfont{abbrv})
while subsequent use displays the entry as:
\acronymfont{abbrv}insert +class="ec-lmtt-10x-x-109">\acronymfont{
abbrv}insert
-

Note that with this option, you need to specify the description using the - description key in the optional argument of \newacronym. + + + +

Note that with this option, you need to specify the description using + the description key in the optional argument of \newacronym.

footnote
footnote
This package option displays the entry on first use as: + id="dx1-42020">first use as: +
\firstacronymfont{abbrv}insert\footnote{long} +class="ec-lmtt-10x-x-109">\firstacronymfont{
abbrv}insert\footnote{long}
while subsequent use displays the entry as: - - -
\acronymfont{abbrv}insert +class="ec-lmtt-10x-x-109">\acronymfont{
abbrv}insert
Acronyms will be sorted according to the short form. -

Note that on first use, it is the long form in the footnote that links to the relevant - glossary entry (where hyperlinks are enabled), whereas on subsequent use, the - acronym links to the relevant glossary entry. You can suppress the long form link - by setting: - - - +

Note that on first use, it is the long form in the footnote that links to + the relevant glossary entry (where hyperlinks are enabled), whereas + on subsequent use, the acronym links to the relevant glossary entry. + You can suppress the long form link by setting: + + +

-
+
\let\acrfootnote\acrnolinkfootnote
-

+

smallcaps
smallcaps
If neither the footnote nor description options have been set, this option - displays the entry on footnote nor description options have been set, this + option displays the entry on first use as:
long⟩⟨insert(\firstacronymfont{abbrv}) +class="lmsy-10x-x-109">⟨
long⟩⟨insert(\firstacronymfont{abbrv})
while subsequent use displays the entry as:
\acronymfont{abbrv}insert +class="ec-lmtt-10x-x-109">\acronymfont{
abbrv}insert
where \acronymfont is set to \textsc{#1}. -

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

+class="ec-lmtt-10x-x-109">\acronymfont is set to \textsc{#1}. +

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

smaller
smaller
If neither the footnote nor description options have been set, this option - displays the entry on footnote nor description options have been set, this + option displays the entry on first use as:
long⟩⟨insert(\firstacronymfont{abbrv}) +class="lmsy-10x-x-109">⟨
long⟩⟨insert(\firstacronymfont{abbrv})
while subsequent use displays the entry as:
\acronymfont{abbrv}insert +class="ec-lmtt-10x-x-109">\acronymfont
{abbrv}insert
- where \acronymfont is set to + where \acronymfont is set to \textsmaller{#1}.17 +class="ec-lmtt-10x-x-109">\textsmaller{#1}.1 The entries will be sorted according to the short form. -

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

- - - +

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

+ + +

None of the above
None of the above
If none of the package options smallcaps, smaller, footnote, +class="ec-lmss-10x-x-109">smallcaps, smaller, dua or description are used, then on first use the entry is displayed as: - +class="ec-lmss-10x-x-109">footnote, dua or description are used, then on first use the entry is + displayed as:
long(abbrv)insert +class="lmsy-10x-x-109">⟨
long(abbrv)insert
while subsequent use displays the entry as:
abbrv⟩⟨insert +class="lmsy-10x-x-109">⟨
abbrv⟩⟨insert
Entries will be sorted according to the short form.
-

+

-

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 \printglossary[type=\acronymtype] or with all the other glossaries -using \printglossaries. However, care must be taken to choose a glossary -style that’s appropriate to your acronym style. The different acronym-related -package options store different information in the name, description and symbol -keys. -

Table 6 lists the package options that govern the acronym styles and how the -information is stored in the keys used when displaying the glossary. Note that the -description package option uses the following command in the name: -


\acrnameformat  \acrnameformat{abbrv}{long}

-

+

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 \printglossary[type=\acronymtype] or with +all the other glossaries using \printglossaries. However, care must be +taken to choose a glossary style that’s appropriate to your acronym style. +The different acronym-related package options store different information +in the name, description and symbol keys. +

Table 13.2 lists the package options that govern the acronym styles and +how the information is stored in the keys used when displaying the +glossary. Note that the description package option uses the following +command in the name: +


\acrnameformat  \acrnameformat{abbrv}{long}

+

This defaults to just \acronymfont{abbrv}. -

For example, if I use the package options description and footnote, then the name -field will contain the abbreviation and the symbol field will contain the long form. If I -then use the long4col style, each entry in the list of acronyms will appear in the form: - -
\acronymfont{abbrv} description⟩⟨long -
location list -
+class="ec-lmtt-10x-x-109">\acronymfont{abbrv}. +

For example, if I use the package options description and footnote, then +the name field will contain the abbreviation and the symbol field will +contain the long form. If I then use the long4col style, each entry in the list +of acronyms will appear in the form: +
\acronymfont{abbrv} description⟩ ⟨long +
location list +
Alternatively, you can define your own custom style (see §16 Defining your own glossary -style for further details). -

-
- +href="#sec:newglossarystyle">§16 Defining your +own glossary style for further details). + - -



- - - -
Table 6: Package options governing \newacronym and how the information is -stored
+ + + +
Table 13.2: Package options governing \newacronym and how the +information is stored
-

+

+class="td11"> Package Option +class="td11"> description,footnote +class="td11"> description,dua +class="td11"> description +class="td11"> footnote +class="td11"> smallcaps +class="td11"> smaller +class="td11"> dua
Package Optionname description symbol name description symbol
description,footnote\acronymfont{abbrv} user suppliedlong \acronymfont{abbrv} user supplied long
description,dua longuser suppliedabbrv long user supplied abbrv
description \acrnameformat{abbrv}{long}user suppliedabbrv \acrnameformat{abbrv}{long} user supplied abbrv
footnote \acronymfont{abbrv} long \acronymfont{abbrv} long
smallcaps \acronymfont{abbrv} longabbrv \acronymfont{abbrv} long abbrv
smaller \acronymfont{abbrv} longabbrv \acronymfont{abbrv} long abbrv
dua abbrvlongabbrv abbrv long abbrv
None of the above abbrvlong
+class="td11"> None of the above abbrv long
- - - -

-
-

Top

13.3 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. This is done by -redefining the following commands: -


\CustomAcronymFields  \CustomAcronymFields

-

+ + + +


+

Top

13.3  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. This is done by redefining the following +commands: +


\CustomAcronymFields  \CustomAcronymFields

+

This command sets up the keys for \newglossaryentry when you define an acronym -using \newacronym. Within the definition of \CustomAcronymFields, you may use -\the\glslongtok to access the long form, \the\glsshorttok to access the short form -and \the\glslabeltok to access the label. This command is typically used to set the -name, first, firstplural, text and plural keys. It may also be used to set the symbol or -description keys depending on your requirements. -


\SetCustomDisplayStyle  \SetCustomDisplayStyle{type}

-

-This is used to set up the display style for the glossary given by type. This should -typically just use \defglsdisplayfirst and \defglsdisplay. -

Once you have redefined \CustomAcronymFields and \SetCustomDisplayStyle, -you must then switch to this style using -


\SetCustomStyle  \SetCustomStyle

-

+class="ec-lmtt-10x-x-109">\newglossaryentry when you +define an acronym using \newacronym. Within the definition of +\CustomAcronymFields, you may use \the\glslongtok to access +the long form, \the\glsshorttok to access the short form and +\the\glslabeltok to access the label. This command is typically used +to set the name, first, firstplural, text and plural keys. It may also +be used to set the symbol or description keys depending on your +requirements. +


\SetCustomDisplayStyle  \SetCustomDisplayStyle{type}

+

+This is used to set up the display style for the glossary given by +type. This should typically just use \defglsdisplayfirst and +\defglsdisplay. +

Once you have redefined \CustomAcronymFields and +\SetCustomDisplayStyle, you must then switch to this style using +


\SetCustomStyle  \SetCustomStyle

+

Note that you may still use the shortcuts package option with your custom +class="ec-lmss-10x-x-109">shortcuts package option with your custom style. -

If you omit \SetCustomStyle, or use it before you redefine \CustomAcronymFields -and \SetCustomDisplayStyle, your new style won’t be correctly implemented. You -must set up the custom style before defining new acronyms. The acronyms must be -defined using \newacronym not \newglossaryentry.
-

-

As an example, suppose I want my acronym on first use to have the short form in -the text and the long form with the description in a footnote. Suppose also that I want -the short form to be put in small caps in the main body of the document, but I -want it in normal capitals in the list of acronyms. In my list of acronyms, -I want the long form as the name with the short form in brackets followed -by the description. That is, in the text I want \gls on

+

+

As an example, suppose I want my acronym on first use to have the +short form in the text and the long form with the description in a footnote. +Suppose also that I want the short form to be put in small caps in +the main body of the document, but I want it in normal capitals +in the list of acronyms. In my list of acronyms, I want the long +form as the name with the short form in brackets followed by the +description. That is, in the text I want \gls on first use to display: + + + -
\textsc{abbrv}\footnote{long: description} -
+
\textsc{abbrv}\footnote{long: description} +
on subsequent use: -
\textsc{abbrv} -
-and in the list of acronyms, each entry will be displayed in the form: - - - -
long(short) description -
-

First, I need to redefine \CustomAcronymFields so that \newacronym will correctly -set the name, text and plural keys. I want the long form to be stored in the -name and the short form to be stored in text. In addition, I’m going to set the -symbol to the short form in upper case so that it will appear in the list of -acronyms. - +
\textsc{abbrv} +
+and in the list of acronyms, each entry will be displayed in the form: + +
long(short) description +
+

First, I need to redefine \CustomAcronymFields so that \newacronym +will correctly set the name, text and plural keys. I want the long form to be +stored in the name and the short form to be stored in text. In addition, I’m +going to set the symbol to the short form in upper case so that it will +appear in the list of acronyms. + - +

-
+
\renewcommand*{\CustomAcronymFields}{%  
  name={\the\glslongtok},%  
  symbol={\MakeUppercase{\the\glsshorttok}},% @@ -10998,63 +11744,64 @@ acronyms.  
  plural={\textsc{\the\glsshorttok}\noexpand\acrpluralsuffix}%  
}
-

-

When using \newacronym, the short and long forms are stored in the short and long -keys, and the plural forms are stored in shortplural and longplural. So when I use -\defglsdisplayfirst and \defglsdisplay, I can use \glsentrylong to access the -long form. Recall from §6.1 Changing the format of the link text, that the optional -argument to \defglsdisplayfirst and \defglsdisplay indicates the glossary -type. This is passed to \SetCustomDisplayStyle. The mandatory argument -sets up the definition of \glsdisplayfirst and \glsdisplay for the given +

+

When using \newacronym, the short and long forms are stored in the +short and long keys, and the plural forms are stored in shortplural and +longplural. So when I use \defglsdisplayfirst and \defglsdisplay, I +can use \glsentrylong to access the long form. Recall from §6.1 +Changing the format of the link text, that the optional argument to +\defglsdisplayfirst and \defglsdisplay indicates the glossary type. +This is passed to \SetCustomDisplayStyle. The mandatory argument sets +up the definition of \glsdisplayfirst and \glsdisplay for the given glossary, where the first argument corresponds to the first, firstplural, text or -plural, as appropriate, the second argument corresponds to the description, -the third corresponds to the symbol and the fourth argument is the inserted -text. - - - +class="ec-lmss-10x-x-109">first, firstplural, text +or plural, as appropriate, the second argument corresponds to the +description, the third corresponds to the symbol and the fourth argument is +the inserted text. + + +

-
+
\renewcommand*{\SetCustomDisplayStyle}[1]{%  
  \defglsdisplayfirst[#1]{##1##4\protect\footnote{%  
    \glsentrylong{\glslabel}: ##2% @@ -11062,281 +11809,286 @@ text.  
  \defglsdisplay[#1]{##1##4}%  
}
-

-

Since we have a definition inside a definition, #1 refers to the argument of -\SetCustomDisplayStyle, and ##1, …, ##4, refer to the arguments of \glsdisplayfirst -and \glsdisplay. -

Now that I’ve redefined \CustomAcronymFields and \SetCustomDisplayStyle, I -can set this style using - - - +

+

Since we have a definition inside a definition, #1 refers to the argument +of \SetCustomDisplayStyle, and ##1, …, ##4, refer to the arguments of +\glsdisplayfirst and \glsdisplay. +

Now that I’ve redefined \CustomAcronymFields and +\SetCustomDisplayStyle, I can set this style using + + +

-
+
\SetCustomStyle
-

and now I can define my acronyms: - +

and now I can define my acronyms: + - +

-
-\newacronym[description={set of tags for use in developing hypertext - 
documents}]{html}{html}{Hyper Text Markup Language} - 
\newacronym[description={language used to describe the layout of a - 
document written in a markup language}]{css}{css}{Cascading Style - 
Sheet} +
+\newacronym[description={set of tags for use in + 
developing hypertext documents}]{html}{html}{Hyper + 
Text Markup Language} + 
\newacronym[description={language used to describe the + 
layout of a document written in a markup language}]{css} + 
{css}{Cascading Style Sheet}
-

-

Note that since I’ve used the description in the main body of the text, I need to -switch off the sanitization otherwise any commands within the description won’t get -interpreted. Also I want to use the hyperref package, but this will cause a problem on -first use as I’ll get nested hyperlinks, so I need to switch off the hyperlinks on first use. -In addition, I want to use a glossary style that displays the symbol. Therefore, in my -preamble I have: - - - +

+

Note that since I’ve used the description in the main body of the text, I +need to switch off the sanitization otherwise any commands within the +description won’t get interpreted. Also I want to use the hyperref package, +but this will cause a problem on first use as I’ll get nested hyperlinks, so I +need to switch off the hyperlinks on first use. In addition, I want to use a +glossary style that displays the symbol. Therefore, in my preamble I +have: + + +

-
+
\usepackage[colorlinks]{hyperref} - 
\usepackage[acronym,         % create list of acronyms - 
            nomain,          % don’t need main glossary for this example - 
            style=tree,      % need a style that displays the symbol - 
            hyperfirst=false,% don’t hyperlink first use - 
            sanitize=none    % switch off sanitization as description - 
                             % will be used in the main text - 
            ]{glossaries} + 
\usepackage + 
 [acronym,         % create list of acronyms + 
  nomain,          % don’t need main glossary for this example + 
  style=tree,      % need a style that displays the symbol + 
  hyperfirst=false,% don’t hyperlink first use + 
  sanitize=none    % switch off sanitization as description + 
                   % will be used in the main text + 
 ]{glossaries}
-

-

Note that I haven’t used the description or footnote package options. -

+

+

Note that I haven’t used the description or footnote package options. +

-

Top

13.4 Upgrading From the glossary Package

-

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

In order to facilitate migrating from the old package to the new one, the glossaries +

Top

13.4  Upgrading From the glossary Package

+

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

In order to facilitate migrating from the old package to the new one, the glossaries package18 +href="#fn2x15" id="fn2x15-bk">2 provides the command: -


\oldacronym  \oldacronym[label]{abbrv}{long}{key-val list}

-

+


\oldacronym  \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:
glossary package’s method of defining +acronyms. It is equivalent to:
\newacronym[key-val list]{label}{abbrv}{long}
\newacronym[key-val list]{label}{abbrv}{long}
In addition, \oldacronym also defines the commands \label, which is equivalent to -\gls{label}, and \label*, which is equivalent to \Gls{label}. If labelis omitted, -abbrvis used. Since commands names must consist only of alphabetical characters, -labelmust also only consist of alphabetical characters. Note that \labeldoesn’t -allow you to use the first optional argument of \gls or \Gls — you will need to -explicitly use \gls or \Gls to change the settings. -

Recall that, in general, LATEX ignores spaces following command names -consisting of alphabetical characters. This is also true for \labelunless you -additionally load the xspace package.
-

- - - -

The glossaries package doesn’t load the xspace package since there are both -advantages and disadvantages to using \xspace in \label. If you don’t use the xspace -package you need to explicitly force a space using \␣ (backslash space) however you can -follow \labelwith additional text in square brackets (the final optional argument to -\gls). If you use the xspace package you don’t need to escape the spaces but you -can’t use the optional argument to insert text (you will have to explicitly use -\gls). -

To illustrate this, suppose I define the acronym “abc” as follows: - - - +class="ec-lmtt-10x-x-109">\oldacronym also defines the commands \label, which is +equivalent to \gls{label}, and \label*, which is equivalent to +\Gls{label}. If labelis omitted, abbrvis used. Since commands names +must consist only of alphabetical characters, labelmust also only consist +of alphabetical characters. Note that \labeldoesn’t allow you to use the + + + +first optional argument of \gls or \Gls — you will need to explicitly use +\gls or \Gls to change the settings. +

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

+

The glossaries package doesn’t load the xspace package since there are +both advantages and disadvantages to using \xspace in \label. If you +don’t use the xspace package you need to explicitly force a space using \␣ +(backslash space) however you can follow \labelwith additional text in +square brackets (the final optional argument to \gls). If you use the xspace +package you don’t need to escape the spaces but you can’t use the +optional argument to insert text (you will have to explicitly use +\gls). +

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

-
+
\oldacronym{abc}{example acronym}{}
-

This will create the command \abc and its starred version \abc*. Table 7 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.3 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 7:
Table 13.3: The effect of using xspace with \oldacronym +class="ec-lmss-10x-x-109">xspace with \oldacronym
+class="td11"> Code +class="td11"> \abc. +class="td11"> \abc xyz +class="td11"> \abc\ xyz +class="td11"> \abc* xyz
Code With xspaceWithout xspace With xspace Without xspace
\abc. abc. abc. abc. abc.
\abc xyz abc xyz abcxyz abc xyz abcxyz
\abc\ xyz abc xyz abc xyz abc xyz abc xyz
\abc* xyz Abc xyz Abc xyz Abc xyz Abc xyz
\abc[’s] xyzabc [’s] xyz abc’s xyz
+class="td11"> \abc[’s] xyz abc [’s] xyz abc’s xyz
- - - -

-
-

Top

14 Unsetting and Resetting Entry Flags

-

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


+ + + +

Top

14  Unsetting and Resetting Entry Flags

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


\glsreset  \glsreset{label}

-

-


\glslocalreset  \glslocalreset{label}

-

+


\glsreset  \glsreset{label}

+

+


\glslocalreset  \glslocalreset{label}

+

while the latter can be achieved by one of the following commands: -


\glsunset  \glsunset{label}

-

-


\glslocalunset  \glslocalunset{label}

-

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

-

+


\glsunset  \glsunset{label}

+

+


\glslocalunset  \glslocalunset{label}

+

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

+

where glossary listis 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="lmsy-10x-x-109">⟨glossary listis 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{label}{true part}{false part}

-

+


\ifglsused  \ifglsused{label}{true part}{false part}

+

where labelis the label of the required entry. If the entry has been used, true part -will be done, otherwise false partwill be done. -

+class="lmsy-10x-x-109">⟨labelis the label of the required entry. If the entry has +been used, true partwill be done, otherwise false partwill be +done. + + +

-

Top

15 Glossary Styles

-

The glossaries package comes with some pre-defined glossary styles. Note that the styles -are suited to different types of glossaries: some styles ignore the associated symbol; -some styles are not designed for hierarchical entries, so they display sub-entries in the -same way as they display top level entries; some styles are designed for homographs, so -they ignore the name for sub-entries. You should therefore pick a style that suits your -type of glossary. See table 8 for a summary of the available 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 +

15  Glossary Styles

+

The glossaries package comes with some pre-defined glossary styles. Note +that the styles are suited to different types of glossaries: some styles ignore +the associated symbol; some styles are not designed for hierarchical entries, +so they display sub-entries in the same way as they display top level +entries; some styles are designed for homographs, so they ignore the +name for sub-entries. You should therefore pick a style that suits +your type of glossary. See table 15.1 for a summary of the available +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. -

-
- + - -



- - - -
+class="td11"> Style listdotted list* ✓ +class="pzdr-x-x-109">✓ +class="td11"> long4col* +class="td11"> altlong*4col* +class="td11"> long* +class="td11"> super*3col* +class="td11"> super4col* +class="td11"> altsuper*4col* +class="td11"> super* +class="td11"> *index* +class="td11"> treenoname* +class="td11"> *tree*
Style Maximum LevelHomographSymbol Maximum Level Homograph Symbol
listdotted 0
0
sublistdotted sublistdotted 1
list* 1
1
altlist* altlist* 1
long*3col* long*3col* 1
long4col* 1 1
altlong*4col* 1 1
long* 1 1
super*3col* 1 1
super4col* 1 1
altsuper*4col* 1 1
super* 1 1
index* 2 2
treenoname*
tree*
alttree*
- - - -

-
-

The glossary style can be set using the style key in the optional argument to -\printglossary or using the command: -


\glossarystyle  \glossarystyle{style-name}

-

+class="td11"> *alttree* + inline 1

+ + + +

+

The glossary style can be set using the style key in the optional argument +to \printglossary or using the command: +


\glossarystyle  \glossarystyle{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 +class="ec-lmss-10x-x-109">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 column.19 +href="#fn1x17" id="fn1x17-bk">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 you should use \newline instead -of \\. -

Note that if you use the style key in the optional argument to \printglossary, it -will override any previous style settings for the given glossary, so if, for example, you -do - - - +class="ec-lmtt-10x-x-109">\setlength if the glossary is too +wide. Note that the long4col and super4col styles (and their header and +border variations) don’t use these lengths as they are designed for single +line entries. Instead you should use the analogous altlong4col and +altsuper4col styles. If you want to explicitly create a line-break within a +multi-line description in a tabular-like style you should use \newline +instead of \\. +

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

-
+
\renewcommand*{\glsgroupskip}{}  
\printglossary[style=long]
-

then the new definition of \glsgroupskip will not have an affect for this glossary, as -\glsgroupskip is redefined by style=long. Likewise, \glossarystyle will also -override any previous style definitions, so, again - - - +

then the new definition of \glsgroupskip will not have an affect for this +glossary, as \glsgroupskip is redefined by style=long. Likewise, +\glossarystyle will also override any previous style definitions, so, +again + + +

-
+
\renewcommand*{\glsgroupskip}{}  
\glossarystyle{long}
-

will reset \glsgroupskip back to its default definition for the named glossary style -(long in this case). If you want to modify the styles, either use \newglossarystyle -(described in the next section) or make the modifications after \glossarystyle, -e.g.: - - - +

will reset \glsgroupskip back to its default definition for the named +glossary style (long in this case). If you want to modify the styles, either +use \newglossarystyle (described in the next section) or make the +modifications after \glossarystyle, e.g.: + + +

-
+
\glossarystyle{long}  
\renewcommand*{\glsgroupskip}{}
-

-

All the styles except for the three- and four-column styles and the listdotted style use -the command -


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

+

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.

-

Top

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

+

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.

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 appear in bold by - default). The description follows, and then the associated list style uses the description environment. The entry name + is placed in the optional argument of the \item command (so + it will appear in bold by default). The description follows, and + then the associated number list for 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 + id="dx1-48011"> 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="ec-lmtt-10x-x-109">\indexspace.
listgroup
listgroup
The listgroup style is like list but the glossary groups have headings. +class="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">description environment.20 +href="#fn2x17" id="fn2x17-bk">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-48033"> 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.
- - - -

+class="ec-lmss-10x-x-109">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 §15.3 Longtable Styles (Ragged +

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 §15.3 Longtable Styles (Ragged Right). -

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 \glsdescwidth. - Child entries have a similar format to the parent entries except that their - name is suppressed. +class="ec-lmssbx-10x-x-109">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 + \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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmssbx-10x-x-109">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 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 \glspagelistwidth. + id="dx1-49022">. + 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.
long3colborder
The long3colborder style is like the long3col style but has - horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">long3colborder
The long3colborder style is like the long3col style but + has horizontal and vertical lines around it.
long3colheader
The long3colheader style is like long3col but has a header row. - - - +class="ec-lmssbx-10x-x-109">long3colheader
The long3colheader style is like long3col but has a + header row.
long3colheaderborder
The long3colheaderborder style is like long3colheader but - has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">long3colheaderborder
The long3colheaderborder style is like + long3colheader but has horizontal and vertical lines around it.
long4col
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. +
+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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">long4colheader style is like long4col but has a + header row.
long4colheader
The long4colheader style is like long4col but has a header row. +class="ec-lmssbx-10x-x-109">long4colheaderborder
The long4colheaderborder style is like + long4colheader but has horizontal and vertical lines around it.
long4colheaderborder
altlong4col
The long4colheaderborder style is like long4colheader but - has horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">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.
altlong4col
altlong4colborder
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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">altlong4colheader style is like long4colheader + but allows multi-line descriptions and page lists.
altlong4colheaderborder
The altlong4colheaderborder - style is like long4colheaderborder but allows multi-line descriptions and page +class="ec-lmssbx-10x-x-109">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: - - - +

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

-
+
\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 + id="dx1-50011">. 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="ec-lmtt-10x-x-109">\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. +class="ec-lmssbx-10x-x-109">longraggedborder
The longraggedborder style is like longragged but + has horizontal and vertical lines around it.
longraggedheader
longraggedheader
The longraggedheader style is like longragged but has a header - row. +class="ec-lmss-10x-x-109">longraggedheader style is like longragged but + has a header row.
longraggedheaderborder
The +class="ec-lmssbx-10x-x-109">longraggedheaderborder
The longraggedheaderborder style is like longraggedheaderborder style is like longraggedheader but has horizontal and - vertical lines around it. +class="ec-lmss-10x-x-109">longraggedheader but has horizontal and vertical lines around it.
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) 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. + id="dx1-50022">. 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. + + +
longragged3colborder
The longragged3colborder style is like the longragged3col - style but has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">longragged3colborder
The longragged3colborder style is like the + longragged3col style but has horizontal and vertical lines around + it.
longragged3colheader
The longragged3colheader style is like longragged3col but - has a header row. - - - +class="ec-lmssbx-10x-x-109">longragged3colheader
The longragged3colheader style is like + longragged3col but has a header row.
longragged3colheaderborder
The longragged3colheaderborder style is like - longragged3colheader but has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">longragged3colheaderborder
The longragged3colheaderborder style is + like longragged3colheader but has horizontal and vertical lines + around it.
altlongragged4col
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="ec-lmss-10x-x-109">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.
altlongragged4colborder
The +class="ec-lmssbx-10x-x-109">altlongragged4colborder
The altlongragged4colborder style is like the altlongragged4colborder style is like the altlongragged4col but has horizontal - and vertical lines around it. +class="ec-lmss-10x-x-109">altlongragged4col but has horizontal and vertical lines around it.
altlongragged4colheader
The altlongragged4colheader style is like +class="ec-lmssbx-10x-x-109">altlongragged4colheader
The altlongragged4colheader style is like altlongragged4col but has a header row. +class="ec-lmss-10x-x-109">altlongragged4col but has a header row.
altlongragged4colheaderborder
The altlongragged4colheaderborder style is like +class="ec-lmssbx-10x-x-109">altlongragged4colheaderborder
The altlongragged4colheader but has horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">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.21 -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). -

+

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 §15.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 length - \glsdescwidth. Child entries have a similar format to the parent entries - except that their name is suppressed. + id="dx1-51017">. 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.
superborder
superborder
The superborder style is like super but has horizontal and vertical - lines around it. +class="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">superheader style is like super but has a header row.
superheaderborder
The superheaderborder style is like superheader but has - horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">superheaderborder
The 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 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. +class="ec-lmss-10x-x-109">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.
super3colborder
super3colborder
The super3colborder style is like the super3col style but has - horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">super3colheader style is like super3col but has a + header row.
super3colheaderborder
The super3colheaderborder style is like super3colheader - but has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">super3colheaderborder
The super3colheaderborder style is like the + 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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">super4colheader style is like super4col but has a + header row.
super4colheaderborder
The super4colheaderborder style is like super4colheader - but has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">super4colheaderborder
The super4colheaderborder style is like the + 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="ec-lmss-10x-x-109">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="ec-lmssbx-10x-x-109">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="ec-lmssbx-10x-x-109">altsuper4colheader
The altsuper4colheader style is + like super4colheader but allows multi-line descriptions and page + lists. + + +
altsuper4colheaderborder
The altsuper4colheaderborder style is like +class="ec-lmssbx-10x-x-109">altsuper4colheaderborder
The altsuper4colheaderborder style is like super4colheaderborder but allows multi-line descriptions and page lists.
-

+class="ec-lmss-10x-x-109">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: - +

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

-
+
\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. -
-superraggedborder
The superraggedborder style is like superragged but has - horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">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.
superraggedheader
superraggedborder
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 it. +class="ec-lmss-10x-x-109">superraggedborder style is like superragged but + has horizontal and vertical lines around it.
superragged3col
superraggedheader
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) 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. +class="ec-lmss-10x-x-109">superraggedheader style is like superragged + but has a header row.
superragged3colborder
The superragged3colborder style - is like the superragged3col style but has horizontal and vertical lines around +class="ec-lmssbx-10x-x-109">superraggedheaderborder
The superraggedheaderborder style is like + superraggedheader but has horizontal and vertical lines around it. - - -
superragged3colheader
superragged3col
The superragged3colheader style is like superragged3col - but has a header row. +class="ec-lmss-10x-x-109">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. + + +
superragged3colheaderborder
superragged3colborder
The superragged3colheaderborder style is like +class="ec-lmss-10x-x-109">superragged3colborder style is like the superragged3colheader but has horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">superragged3col style but has horizontal and vertical lines around + it. +
+superragged3colheader
The superragged3colheader style is like + superragged3col but has a header row.
altsuperragged4col
superragged3colheaderborder
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="ec-lmss-10x-x-109">superragged3colheaderborder style + is like superragged3colheader but has horizontal and vertical lines + around it.
altsuperragged4colborder
The altsuperragged4colborder style is like the - altsuperragged4col style but has horizontal and vertical lines around it. +class="ec-lmssbx-10x-x-109">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.
altsuperragged4colheader
The altsuperragged4colheader style is like +class="ec-lmssbx-10x-x-109">altsuperragged4colborder
The altsuperragged4colborder style is like + the altsuperragged4col style but has horizontal and vertical lines + around it. +
+altsuperragged4colheader
The altsuperragged4colheader style is like altsuperragged4col but has a header row. +class="ec-lmss-10x-x-109">altsuperragged4col but has a header row.
altsuperragged4colheaderborder
altsuperragged4colheaderborder
The altsuperragged4colheaderborder style is - like altsuperragged4colheader but has horizontal and vertical lines around it. +class="ec-lmss-10x-x-109">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 +

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

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 +class="ec-lmssbx-10x-x-109">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="ec-lmtt-10x-x-109">\indexspace.
indexgroup
indexgroup
The indexgroup style is similar to the index style except that each - group has a heading. +class="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmtt-10x-x-109">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="ec-lmss-10x-x-109">treegroup style is similar to the tree style except that + each group has a heading.
treehypergroup
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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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="ec-lmssbx-10x-x-109">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 navigation line is the same as that for listhypergroup, described above. +class="ec-lmssbx-10x-x-109">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.
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="ec-lmss-10x-x-109">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 levelindicates 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 levelis - 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="lmsy-10x-x-109">⟨levelindicates 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 levelis 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="ec-lmss-10x-x-109">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="ec-lmss-10x-x-109">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

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}

-

+

Top

15.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 §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 +\glossarystyle.
+

+

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} + 
\glossarystyle{mcolindex} +
+

+ + + +


+ + + +
Table 15.2: Multicolumn Styles
+
+ + + + + + + + + +
glossary-mcols Style Analogous Tree Style
mcolindex index
mcolindexgroup indexgroup
mcolindexhypergroup indexhypergroup
mcoltree tree
mcoltreegroup treegroup
mcoltreehypergroup treehypergroup
mcoltreenoname treenoname
mcoltreenonamegroup treenonamegroup
mcoltreenonamehypergroup treenonamehypergroup
mcolalttree alttree
mcolalttreegroup alttreegroup
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: + + + +

+
+ \usepackage{glossary-inline} + 
 \renewcommand*{\glossarysection}[2][]{\textbf{#1}: } + 
 \glossarystyle{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 \glossarystyle.
+

+

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

+

+This defaults to “; ” and is used between main (i.e. level 0) entries. +


\glsinlinesubseparator  \glsinlinesubseparator

+

+This defaults to “, ” and is used between sub-entries. +


\glsinlineparentchildseparator  \glsinlineparentchildseparator +

+

+This defaults to “: ” and is used between a parent main entry and its first +sub-entry. +


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

+

where nameis the name of the new glossary style (to be used in \glossarystyle). -The second argument definitionsneeds 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 nameis the name of the new glossary style (to be used in +\glossarystyle). The second argument definitionsneeds 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="ec-lmtt-10x-x-109">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 \labelgroupname exists, this is taken to be the title, -otherwise the title is just label. -

A navigation hypertarget can be created using -


\glsnavhypertarget  \glsnavhypertarget{label}{text}

-

+class="ec-lmtt-10x-x-109">\labelgroupname exists, this is taken +to be the title, otherwise the title is just label. +

A navigation hypertarget can be created using +


\glsnavhypertarget  \glsnavhypertarget{label}{text}

+ + + +

For further details about \glsnavhypertarget, see the documented code +class="ec-lmtt-10x-x-109">\glsnavhypertarget, see the documented code (glossaries.pdf). -

Most of the predefined glossary styles redefine \glsgroupheading to simply -ignore its argument. The listhypergroup style redefines \glsgroupheading as -follows: - +class="ec-lmtt-10x-x-109">glossaries.pdf). +

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

-
+
\renewcommand*{\glsgroupheading}[1]{%  
\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
-

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


\glossaryentryfield  \glossaryentryfield{label}{formatted name}{description} -{symbol}{number list}

-

-This macro indicates what to do for a given glossary entry. Note that formatted name -will always be in the form \glsnamefont{name}. This allows the user to set a given -font for the entry name, regardless of the glossary style used. Note that labelis the -label used when the glossary entry was defined via either \newglossaryentry or -\newacronym. -


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


\glstarget  \glstarget{label}{text}

-

+

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


\glossaryentryfield  \glossaryentryfield{label}{formatted +name}{description} {symbol}{number list}

+

+This macro indicates what to do for a given glossary entry. Note that +formatted namewill always be in the form \glsnamefont{name}. This +allows the user to set a given font for the entry name, regardless of +the glossary style used. Note that labelis the label used when +the glossary entry was defined via either \newglossaryentry or +\newacronym. +


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


\glstarget  \glstarget{label}{text}

+

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

For example, the list style defines \glossaryentryfield as follows: - - - +class="lmsy-10x-x-109">⟨labelis the entry’s label. Note that you don’t need to worry about +whether the hyperref package has been loaded, as \glstarget won’t create +a target if \hypertarget hasn’t been defined. +

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

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

-

Note also that number listwill always be of the form

+

Note also that number listwill always be of the form
-


\glossaryentrynumbers{\relax


\glossaryentrynumbers{\relax
\setentrycounter[Hprefix]{counter name}format cmd{number(s)}} +class="ec-lmtt-10x-x-109">\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)}, +class="lmsy-10x-x-109">⟨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="ec-lmtt-10x-x-109">\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. -


\glossarysubentryfield  \glossarysubentryfield{level}{label}{formatted -name} {description}{symbol}{number list}

-

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


\glssubentryitem  \glssubentryitem{label}

-

-This macro will increment and display the associated counter for the level 1 entries if -the subentrycounter package options have been used. This macro is typically called by -\glossarysubentryfield 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.pdf). -

+


\glossarysubentryfield  \glossarysubentryfield{level}{label}{formatted +name} {description}{symbol}{number list}

+

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


\glssubentryitem  \glssubentryitem{label}

+

+This macro will increment and display the associated counter for the +level 1 entries if the subentrycounter package options have been +used. This macro is typically called by \glossarysubentryfield +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.pdf).

-

Top

16.1 Example: creating a completely new style

-

If you want a completely new style, you will need to redefine all of the commands and -the environment listed above. -

For example, suppose you want each entry to start with a bullet point. This means -that the glossary should be placed in the 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 +

16.1  Example: creating a completely new style

+

If you want a completely new style, you will need to redefine all of the +commands and the environment listed above. +

For example, suppose you want each entry to start with a bullet point. +This means that the glossary should be placed in the 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-57009"> 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}{\begin{itemize}}{\end{itemize}}% + 
 \renewenvironment{theglossary}% + 
   {\begin{itemize}}{\end{itemize}}%  
 % have nothing after \begin{theglossary}:  
 \renewcommand*{\glossaryheader}{}%  
 % have nothing between glossary groups: @@ -13555,82 +14650,87 @@ follows:  
   \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}%  
 }
-

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

+

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

-

Top

16.2 Example: creating a new glossary style based on an existing style

-

If you want to define a new style that is a slightly modified version of an existing style, -you can use \glossarystyle within the second argument of \newglossarystyle -followed by whatever alterations you require. For example, suppose you want a style like -the list style but you don’t want the extra vertical space created by \indexspace -between groups, then you can create a new glossary style called, say, mylist as +

Top

16.2  Example: creating a new glossary style based on an existing +style

+

If you want to define a new style that is a slightly modified version of an +existing style, you can use \glossarystyle within the second argument of +\newglossarystyle followed by whatever alterations you require. +For example, suppose you want a style like the list style but you +don’t want the extra vertical space created by \indexspace between +groups, then you can create a new glossary style called, say, mylist as follows: - + - +

-
+
\newglossarystyle{mylist}{%  
\glossarystyle{list}% base this style on the list style - 
\renewcommand{\glsgroupskip}{}% make nothing happen between groups + 
\renewcommand{\glsgroupskip}{}% make nothing happen + 
                              % between groups  
}
-

-

+

+

-

Top

16.3 Example: creating a glossary style that uses the user1, …, user6 -keys

-

Since \glossaryentryfield and \glossarysubentryfield provide the label for the -entry, it’s also possible to access the values of the generic user keys, such as user1. For -example, 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: - - - +

Top

16.3  Example: creating a glossary style that uses the user1, …, user6 +keys

+

Since \glossaryentryfield and \glossarysubentryfield provide the +label for the entry, it’s also possible to access the values of the generic user +keys, such as user1. For example, 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}% @@ -13669,790 +14769,1108 @@ class="ecss-1000">longtable \renewcommand*{\glsgroupskip}{}%  
}
-

-

+

+ + + +

+

Top

17  Utilities

+ This section describes some utility commands. Additional commands can +be found in the documented code (glossaries.pdf). +


\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 bodyis performed. If glossary listis 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 bodyis performed. If glossary +labelis 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 listis omitted, +the default is the list of all defined glossaries. At each iteration +csis set to the entry label and bodyis performed. (The current +glossary label can be obtained using \glsentrytype{cs} within +body.) +


\ifglossaryexists  \ifglossaryexistslabel⟩⟨true part⟩⟨false part +

+

+This checks if the glossary given by labelexists. If it does true partis +performed, otherwise false part. +


\ifglsentryexists  \ifglsentryexistslabel⟩⟨true part⟩⟨false part +

+

+This checks if the glossary entry given by labelexists. If it does true +partis performed, otherwise false part. +


\ifglsused  \ifglsentryexistslabel⟩⟨true part⟩⟨false part +

+

+See §14 Unsetting and Resetting Entry Flags. + + + +


\ifglshaschildren  \ifglshaschildrenlabel⟩⟨true part⟩⟨false part +

+

+This checks if the glossary entry given by labelhas any sub-entries. If it +does, true partis performed, otherwise false part. +


\ifglshasparent  \ifglshasparentlabel⟩⟨true part⟩⟨false part +

+

+This checks if the glossary entry given by labelhas a parent entry. If it +does, true partis performed, otherwise false part. + + +

-

Top

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

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:

access
access
The replacement text corresponding to the name key. +class="ec-lmss-10x-x-109">name key.
textaccess
textaccess
The replacement text corresponding to the text key. +class="ec-lmss-10x-x-109">text key.
firstaccess
firstaccess
The replacement text corresponding to the first key. +class="ec-lmss-10x-x-109">first key.
pluralaccess
pluralaccess
The replacement text corresponding to the plural key. +class="ec-lmss-10x-x-109">plural key.
firstpluralaccess
firstpluralaccess
The replacement text corresponding to the firstplural key. +class="ec-lmss-10x-x-109">firstplural + key.
symbolaccess
symbolaccess
The replacement text corresponding to the symbol key. +class="ec-lmss-10x-x-109">symbol key.
symbolpluralaccess
The replacement text corresponding to the symbolplural key. -
-descriptionaccess
The replacement text corresponding to the description key. -
-descriptionpluralaccess
The replacement text corresponding to the +class="ec-lmssbx-10x-x-109">symbolpluralaccess
The replacement text corresponding to the descriptionplural key. +class="ec-lmss-10x-x-109">symbolplural key.
longaccess
The replacement text corresponding to the long key (used by +class="ec-lmssbx-10x-x-109">descriptionaccess
The replacement text corresponding to the \newacronym). +class="ec-lmss-10x-x-109">description key.
shortaccess
The replacement text corresponding to the short key (used by +class="ec-lmssbx-10x-x-109">descriptionpluralaccess
The replacement text corresponding to the \newacronym). +class="ec-lmss-10x-x-109">descriptionplural key.
longpluralaccess
longaccess
The replacement text corresponding to the longplural key (used +class="ec-lmss-10x-x-109">long key (used by \newacronym). +class="ec-lmtt-10x-x-109">\newacronym).
shortpluralaccess
shortaccess
The replacement text corresponding to the shortplural key (used +class="ec-lmss-10x-x-109">short key (used by \newacronym). +class="ec-lmtt-10x-x-109">\newacronym). + + + +
+longpluralaccess
The replacement text corresponding to the longplural + key (used by \newacronym). +
+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}} +
+\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 sampleaccsupp.tex illustrates the glossaries-accsupp package. -

See the documented code (glossaries.pdf) for further details. It is recommended -that you also read the accsupp documentation. -

+

The sample file sampleaccsupp.tex illustrates the glossaries-accsupp +package. +

See the documented code (glossaries.pdf) for further details. It is +recommended that you also read the accsupp documentation. + + +

-

Top

18 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/2008/texmf-dist/doc/latex/glossaries/. -Further information on debugging LATEX code is available at -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/2008/texmf-dist +/doc/latex/glossaries/. Further information on debugging LATEX code +is available at http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/. -

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

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

+class="ec-lmtt-10x-x-109">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html.

  1. Q. I get the error message: - + class="enumerate" id="x1-62002x1">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.

  2. Q. When I use Q. When I use xindy, I get the following error message: - +class="ec-lmtt-10x-x-109">xindy, I get the following error message: + - -
    - ERROR: CHAR: index 0 should be less than the length of the string + +
    + 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="ec-lmtt-10x-x-109">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 §2.4 Sorting Options for further details of the sort - option. +

    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.

  3. 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-62020x3">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.

  4. 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-62026">first use links using + the package option hyperfirst=false.

  5. 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-62029x5">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}}
    -

    +

  6. 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 + class="enumerate" id="x1-62033x6">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 \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 +class="ec-lmtt-10x-x-109">\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}
    -

    +

  7. Q. I don’t have Perl installed, do I have to use makeglossaries? -

    A. Although it is strongly recommended that you use Q. I don’t have Perl installed, do I have to use makeglossaries, you don’t - have to use it. For further details, read §1.3.2 Using xindy explicitly or §1.3.3 - Using makeindex explicitly, depending on whether you want to use xindy or +class="ec-lmtt-10x-x-109">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 makeglossariesgui instead. Otherwise you + can just call makeindex. +class="ec-lmtt-10x-x-109">makeindex explicitly (see §1.3.3 Using makeindex + explicitly). Note that you can’t use xindy if you don’t have Perl + installed.

  8. 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-62053x8">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.

  9. 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 adding the translator package with the required languages explicitly (before - you load the glossaries package). For example: - - - + class="enumerate" id="x1-62056x9">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 adding the translator package with the required + languages explicitly (before you load the glossaries package). For + example: + + +

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

    Alternatively, you can add the language as a global option to the class file. Check - the translator package documentation for further details. +

    Alternatively, you can add the language as a global option to the + class file. Check the translator package documentation for further + details.

  10. Q. My acronyms contain strange characters when I use commands like - \acrlong. -

    A. Switch off the sanitization: - + class="enumerate" id="x1-62060x10">Q. My acronyms contain strange characters when I use commands + like \acrlong. +

    A. Switch off the sanitization: + - +

    -
    +
    \usepackage[sanitize=none]{glossaries}
    -

    and protect fragile commands. +

    and protect fragile commands.

  11. Q. Weird characters appear when I use \glsentryname or \glsname. -

    A. Either use \glsentrytext or \glstext, respectively, or switch off the - sanitization for the name key: - + class="enumerate" id="x1-62063x11">Q. Weird characters appear when I use \glsentryname or + \glsname. +

    A. Either use \glsentrytext or \glstext, respectively, or switch off + the sanitization for the name key: + - +

    -
    +
    \usepackage[sanitize={name=false}]{glossaries}
    -

    and protect fragile commands. +

    and protect fragile commands.

  12. Q. Weird characters appear when I try to display an entry’s description. -

    A. Switch off the sanitization for the description key: - - - + class="enumerate" id="x1-62070x12">Q. Weird characters appear when I try to display an entry’s + description. +

    A. Switch off the sanitization for the description key: + + +

    -
    +
    \usepackage[sanitize={description=false}]{glossaries}
    -

    and protect fragile commands. +

    and protect fragile commands.

  13. 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 §6 Links to Glossary Entries, §7 Adding an - Entry to the Glossary Without Generating Text or §8 Cross-Referencing - Entries for each entry that you want to appear in the glossary. -
    • -
    • Run LATEX on your document, then run 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. 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="ec-lmtt-10x-x-109">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 §2.4 Sorting Options. +

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

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

      -
- +
+ \renewcommand*{\glsgroupskip}{} +
+

or + - - + +

+
+ \renewcommand*{\glsgroupskip}{\item[]} +
+

+

+ + - -

+ id="Q1-1-73"> + + +

-

Top

Index

-

Symbols +

Index

+

Symbols

-
\@gls@codepage  \@gls@codepage  1
+class="ec-lmri-10x-x-109">1
\@glsorder  \@glsorder  2
+class="ec-lmri-10x-x-109">2
\@istfilename  \@istfilename  3
+class="ec-lmri-10x-x-109">3
\@newglossary  \@newglossary  4
+class="ec-lmri-10x-x-109">4
\@xdylanguage  \@xdylanguage  5
+class="ec-lmri-10x-x-109">5
Xindy  Xindy  6
-

A +

A \Ac  7
+class="ec-lmtt-10x-x-109">\Ac  7
\ac  8
+class="ec-lmtt-10x-x-109">\ac  8
accsupp package  9, 10
-\Acf  11
-\acf  12
-\Acfp  13
-\acfp  14
-\Acl  15
-\acl  16
-\Aclp  17
-\aclp  18
-\Acp  19
-\acp  20
-\ACRfull  21
-\Acrfull  22, 23
-\acrfull  24, 25
-\acrfullformat  26
-\Acrfullpl  27
-\acrfullpl  28
-\Acrlong  29, 30
-\acrlong  31, 32, 33, 34
-\Acrlongpl  35
-\acrlongpl  36
-\acrnameformat  37, 38
-\acronymfont  39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52
-\acronymname  53
-\acronymtype  54, 55, 56, 57, 58, 59, 60, 61, 62
-\ACRshort  63, 64
- - - -\Acrshort  65, 66
-\acrshort  67, 68, 69, 70, accsupp package  9, 10
+\Acf  11
+\acf  12
+\Acfp  13
+\acfp  14
+\Acl  15
+\acl  16
+\Aclp  17
+\aclp  18
+\Acp  19
+\acp  20
+\ACRfull  21
+\Acrfull  22, 23
+\acrfull  24, 25
+\acrfullformat  26
+\Acrfullpl  27
+\acrfullpl  28
+\ACRlong  29
+\Acrlong  30, 31
+\acrlong  32, 33, 34, 35
+\Acrlongpl  36
+\acrlongpl  37
+ + + +\acrnameformat  38, 39
+\acronymfont  40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53
+\acronymname  54
+\acronymtype  55, 56, 57, 58, 59, 60, 61, 62, 63
+\ACRshort  64
+\Acrshort  65, 66
+\acrshort  67, 68, 69, 70, 71
\Acrshortpl  72
+class="ec-lmtt-10x-x-109">\Acrshortpl  72
\acrshortpl  73
+class="ec-lmtt-10x-x-109">\acrshortpl  73
\Acs  74
+class="ec-lmtt-10x-x-109">\Acs  74
\acs  75
+class="ec-lmtt-10x-x-109">\acs  75
\Acsp  76
+class="ec-lmtt-10x-x-109">\Acsp  76
\acsp  77
+class="ec-lmtt-10x-x-109">\acsp  77
\addcontentsline  \addcontentsline  78
\andname  79
+class="ec-lmtt-10x-x-109">\andname  79
array package  80, 81
-

B +class="ec-lmss-10x-x-109">array package  80, 81
+

B babel package  babel package  82, 83, 84, 88, 89, 90, 91, 92
+href="glossaries-user.html#dx1-62057" >92
beamer package  beamer package  93
-

C -\chapter  94
-\chapter*  95
-\currentglossary  96
-\CustomAcronymFields  97, 98, 99
-

D -\defdisplay  100
-\defdisplayfirst  101
-\defglsdisplay  102, 103, 104, 105
-\defglsdisplayfirst  106, 107, 108, 109
-\delimN  110
-\delimR  111
+

C +\chapter  94
+\chapter*  95
+\currentglossary  96
+\CustomAcronymFields  97, 98, 99
+

D +\defdisplay  100
+\defdisplayfirst  101
+\defglsdisplay  102, 103, 104, 105
+\defglsdisplayfirst  106, 107, 108, 109
+\delimN  110
+\delimR  111
description (environment)  112, 113, 114, 115, 116
-\descriptionname  description (environment)  112, 113, 114, 115, 116
+\descriptionname  117
-

E +

E \emph  118
+class="ec-lmtt-10x-x-109">\emph  118
+ + + entry location  119
+class="ec-lmbx-10x-x-109">119
\entryname  \entryname  120
environments:
    description  121, 122, 123, 124, 125
+class="ec-lmtt-10x-x-109">description  121, 122, 123, 124, 125
    equation  equation  126
    itemize  127
+class="ec-lmtt-10x-x-109">itemize  127
    longtable  128, 129, 130, 131, 132, 133
+class="ec-lmtt-10x-x-109">longtable  128, 129, 130, 131, 132, 133
    supertabular  134, 135, 136, 137, 138
- - - +class="ec-lmtt-10x-x-109">multicols  134, 135
    theglossary  139, 140, 141, 142
+class="ec-lmtt-10x-x-109">supertabular  136, 137, 138, 139, 140
+    theglossary  141, 142, 143, 144
equation (environment)  143
+class="ec-lmtt-10x-x-109">equation (environment)  145
etex package  144
-

F +class="ec-lmss-10x-x-109">etex package  146
+

F file types
    .alg  145
+class="ec-lmtt-10x-x-109">.alg  147
    .aux  146, 147
+class="ec-lmtt-10x-x-109">.aux  148, 149
    .glg  148, 149, 150, 151
+class="ec-lmtt-10x-x-109">.glg  150, 151, 152, 153
    .glo  152, 153, 154
+class="ec-lmtt-10x-x-109">.glo  154, 155, 156
    .gls  155, 156, 157
+class="ec-lmtt-10x-x-109">.gls  157, 158, 159
    .ist  158, 159, 160, 161, 162, 163
+class="ec-lmtt-10x-x-109">.ist  160, 161, 162, 163, 164, 165
    .log  164
+class="ec-lmtt-10x-x-109">.log  166
    .tex  165, 166
+class="ec-lmtt-10x-x-109">.tex  167, 168
    .xdy  167, 168, 169, 170, 171, 172, 173, 174
+class="ec-lmtt-10x-x-109">.xdy  169, 170, 171, 172, 173, 174, 175, 176
first use  175
+href="glossaries-user.html#dx1-2007" >177
    flag  176, 177
+href="glossaries-user.html#dx1-2015" >178, 179
    text  178
-\firstacronymfont  179, 180, 181, 182, 183
-flowfram package  184
+href="glossaries-user.html#dx1-2017" >180
+\firstacronymfont  181, 182, 183, 184, 185
fmtcount package  185
-

G +class="ec-lmss-10x-x-109">flowfram package  186
german package  186
+class="ec-lmss-10x-x-109">fmtcount package  187
+\forallglossaries  188
+\forallglsentries  189
+\forglsentries  190
+

G glossaries package  187
+class="ec-lmss-10x-x-109">german package  191
glossaries-accsupp package  188, 189, 190
+class="ec-lmss-10x-x-109">glossaries-accsupp package  192, 193, 194
glossaries-babel package  191, 192, 193
+class="ec-lmss-10x-x-109">glossaries-babel package  195, 196, 197
glossaries-polyglossia package  194, 195, 196
+class="ec-lmss-10x-x-109">glossaries-polyglossia package  198, 199, 200
glossary counters:
    glossaryentry  glossaryentry  197
+class="ec-lmri-10x-x-109">201
+ + +     glossarysubentry  198
+class="ec-lmtt-10x-x-109">glossarysubentry  202
glossary package  199, 200, 201, 202, 203, 204
+class="ec-lmss-10x-x-109">glossary package  203, 204, 205, 206, 207, 208
glossary styles:
    altlist  205, 206
+class="ec-lmtt-10x-x-109">altlist  209, 210
    altlistgroup  207, 208
+class="ec-lmtt-10x-x-109">altlistgroup  211, 212
    altlisthypergroup  209
+class="ec-lmtt-10x-x-109">altlisthypergroup  213
    altlong4col  210, 211, 212
+class="ec-lmtt-10x-x-109">altlong4col  214, 215, 216
    altlong4colborder  213
+class="ec-lmtt-10x-x-109">altlong4colborder  217
    altlong4colheader  214
+class="ec-lmtt-10x-x-109">altlong4colheader  218
    altlong4colheaderborder  215
+class="ec-lmtt-10x-x-109">altlong4colheaderborder  219
    altlongragged4col  216, 217, 218
+class="ec-lmtt-10x-x-109">altlongragged4col  220, 221, 222
    altlongragged4colborder  219
+class="ec-lmtt-10x-x-109">altlongragged4colborder  223
    altlongragged4colheader  220, 221
+class="ec-lmtt-10x-x-109">altlongragged4colheader  224, 225
    altlongragged4colheaderborder  222
- - - +class="ec-lmtt-10x-x-109">altlongragged4colheaderborder  226
    altsuper4col  223, 224, 225
+class="ec-lmtt-10x-x-109">altsuper4col  227, 228, 229
    altsuper4colborder  226
+class="ec-lmtt-10x-x-109">altsuper4colborder  230
    altsuper4colheader  227
+class="ec-lmtt-10x-x-109">altsuper4colheader  231
    altsuper4colheaderborder  228
+class="ec-lmtt-10x-x-109">altsuper4colheaderborder  232
    altsuperragged4col  229, 230, 231
+class="ec-lmtt-10x-x-109">altsuperragged4col  233, 234, 235
    altsuperragged4colborder  232
+class="ec-lmtt-10x-x-109">altsuperragged4colborder  236
    altsuperragged4colheader  233, 234
+class="ec-lmtt-10x-x-109">altsuperragged4colheader  237, 238
    altsuperragged4colheaderborder  235
+class="ec-lmtt-10x-x-109">altsuperragged4colheaderborder  239
    alttree  236, 237, 238
+class="ec-lmtt-10x-x-109">alttree  240, 241, 242, 243
    alttreegroup  239, 240
+class="ec-lmtt-10x-x-109">alttreegroup  244, 245, 246
    alttreehypergroup  241
+class="ec-lmtt-10x-x-109">alttreehypergroup  247, 248
    index  242, 243, 244
+class="ec-lmtt-10x-x-109">index  249, 250, 251, 252, 253
    indexgroup  245, 246
+class="ec-lmtt-10x-x-109">indexgroup  254, 255, 256
    indexhypergroup  247
+class="ec-lmtt-10x-x-109">indexhypergroup  257, 258
    list  248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258
+class="ec-lmtt-10x-x-109">inline  259, 260, 261
    listdotted  259, 260, 261
+class="ec-lmtt-10x-x-109">list  262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273
    listgroup  262, 263
+class="ec-lmtt-10x-x-109">listdotted  274, 275, 276
    listhypergroup  264, 265, 266, 267, 268, 269, 270
+class="ec-lmtt-10x-x-109">listgroup  277, 278
    long  271, 272, 273, 274, 275
+class="ec-lmtt-10x-x-109">listhypergroup  279, 280, 281, 282, 283, 284, 285
    long3col  276, 277, 278, 279, 280
+class="ec-lmtt-10x-x-109">long  286, 287, 288, 289, 290
    long3colborder  281, 282
+class="ec-lmtt-10x-x-109">long3col  291, 292, 293, 294, 295
    long3colheader  283, 284, 285
+class="ec-lmtt-10x-x-109">long3colborder  296, 297
    long3colheaderborder  286, 287
+class="ec-lmtt-10x-x-109">long3colheader  298, 299, 300
    long4col  288, 289, 290, 291, 292, 293
+class="ec-lmtt-10x-x-109">long3colheaderborder  301, 302
    long4colborder  294, 295
+class="ec-lmtt-10x-x-109">long4col  303, 304, 305, 306, 307, 308
    long4colheader  296, 297, 298
+class="ec-lmtt-10x-x-109">long4colborder  309, 310
    long4colheaderborder  299, 300
+class="ec-lmtt-10x-x-109">long4colheader  311, 312, 313
    longborder  301
+class="ec-lmtt-10x-x-109">long4colheaderborder  314, 315
    longheader  302, 303, 304
+class="ec-lmtt-10x-x-109">longborder  316
+ + +     longheaderborder  305, 306
+class="ec-lmtt-10x-x-109">longheader  317, 318, 319
    longragged  307, 308, 309, 310
+class="ec-lmtt-10x-x-109">longheaderborder  320, 321
    longragged3col  311, 312, 313, 314
+class="ec-lmtt-10x-x-109">longragged  322, 323, 324, 325
    longragged3colborder  315
+class="ec-lmtt-10x-x-109">longragged3col  326, 327, 328, 329
    longragged3colheader  316, 317
+class="ec-lmtt-10x-x-109">longragged3colborder  330
    longragged3colheaderborder  318
+class="ec-lmtt-10x-x-109">longragged3colheader  331, 332
    longraggedborder  319
+class="ec-lmtt-10x-x-109">longragged3colheaderborder  333
    longraggedheader  320, 321
+class="ec-lmtt-10x-x-109">longraggedborder  334
    longraggedheaderborder  322
+class="ec-lmtt-10x-x-109">longraggedheader  335, 336
    super  323, 324, 325, 326
+class="ec-lmtt-10x-x-109">longraggedheaderborder  337
    super3col  327, 328, 329, 330
+class="ec-lmtt-10x-x-109">mcolalttree  338
    super3colborder  331
+class="ec-lmtt-10x-x-109">mcolalttreegroup  339
    super3colheader  332, 333
+class="ec-lmtt-10x-x-109">mcolalttreehypergroup  340
    super3colheaderborder  334
+class="ec-lmtt-10x-x-109">mcolindex  341, 342
    super4col  335, 336, 337, 338, 339
+class="ec-lmtt-10x-x-109">mcolindexgroup  343
    super4colborder  340, 341
+class="ec-lmtt-10x-x-109">mcolindexhypergroup  344
    super4colheader  342, 343, 344
- - - +class="ec-lmtt-10x-x-109">mcoltree  345
+    mcoltreegroup  346
+    mcoltreehypergroup  347
+    mcoltreenoname  348
+    mcoltreenonamegroup  349
+    mcoltreenonamehypergroup  350
+    super  351, 352, 353, 354
+    super3col  355, 356, 357, 358
+    super3colborder  359
+    super3colheader  360, 361
    super4colheaderborder  345, 346
+class="ec-lmtt-10x-x-109">super3colheaderborder  362
    superborder  347
+class="ec-lmtt-10x-x-109">super4col  363, 364, 365, 366, 367
    superheader  348, 349
+class="ec-lmtt-10x-x-109">super4colborder  368, 369
    superheaderborder  350, 351
+class="ec-lmtt-10x-x-109">super4colheader  370, 371, 372
    superragged  352, 353, 354, 355
+class="ec-lmtt-10x-x-109">super4colheaderborder  373, 374
    superragged3col  356, 357, 358, 359
+class="ec-lmtt-10x-x-109">superborder  375
    superragged3colborder  360
+class="ec-lmtt-10x-x-109">superheader  376, 377
    superragged3colheader  361, 362
+class="ec-lmtt-10x-x-109">superheaderborder  378, 379
    superragged3colheaderborder  363
+class="ec-lmtt-10x-x-109">superragged  380, 381, 382, 383
    superraggedborder  364
+class="ec-lmtt-10x-x-109">superragged3col  384, 385, 386, 387
    superraggedheader  365, 366
+class="ec-lmtt-10x-x-109">superragged3colborder  388
    superraggedheaderborder  367
+class="ec-lmtt-10x-x-109">superragged3colheader  389, 390
    tree  368, 369, 370, 371
+class="ec-lmtt-10x-x-109">superragged3colheaderborder  391
    treegroup  372, 373
+class="ec-lmtt-10x-x-109">superraggedborder  392
    treehypergroup  374
+class="ec-lmtt-10x-x-109">superraggedheader  393, 394
    treenoname  375, 376
+class="ec-lmtt-10x-x-109">superraggedheaderborder  395
    treenonamegroup  377, 378
+class="ec-lmtt-10x-x-109">tree  396, 397, 398, 399, 400
+ + + +    treegroup  401, 402, 403
+    treehypergroup  404, 405
+    treenoname  406, 407, 408
    treenonamehypergroup  379
+class="ec-lmtt-10x-x-109">treenonamegroup  409, 410, 411
+    treenonamehypergroup  412, 413
+glossary-inline package  414, 415
+glossary-list package  416, 417, 418, 419
glossary-list package  380, 381, 382, 383
+class="ec-lmss-10x-x-109">glossary-long package  420, 421, 422, 423, 424
glossary-long package  384, 385, 386, 387, 388
+class="ec-lmss-10x-x-109">glossary-longragged package  425, 426, 427
glossary-longragged package  389, 390, 391
+class="ec-lmss-10x-x-109">glossary-mcols package  428, 429, 430, 431
glossary-super package  392, 393, 394, 395, 396
+class="ec-lmss-10x-x-109">glossary-super package  432, 433, 434, 435, 436
glossary-superragged package  397, 398, 399
+class="ec-lmss-10x-x-109">glossary-superragged package  437, 438, 439
glossary-tree package  400, 401, 402, 403
+class="ec-lmss-10x-x-109">glossary-tree package  440, 441, 442, 443
glossaryentry (counter)  glossaryentry (counter)  404
+class="ec-lmri-10x-x-109">444
glossaryentry counter  405, 406, 407
-\glossaryentryfield  408, 409, 410
-\glossaryentrynumbers  411, 412, 413, 414
-\glossaryheader  415, 416, 417, 418
-\glossarymark  glossaryentry counter  445, 446, 447
+\glossaryentryfield  448, 449, 450
+\glossaryentrynumbers  451, 452, 453, 454
+\glossaryheader  455, 456, 457, 458
+\glossarymark  419, 420, 421
-\glossaryname  422
-\glossarypostamble  423, 424
-\glossarypreamble  425, 426, 427, 428
-\glossarystyle  429, 430, 431, 432, 433, 434
+class="ec-lmri-10x-x-109">459, 460, 461, 462
+\glossaryname  463
+\glossarypostamble  464, 465
+\glossarypreamble  466, 467, 468, 469
+\glossarysection  470
+\glossarystyle  471, 472, 473, 474, 475, 476, 477, 478
glossarysubentry (counter)  435
-\glossarysubentryfield  436, 437
-\GLS  438, 439, 440
-\Gls  441, 442, 443, 444, 445, 446, 447, 448, 449, 450
-\gls  451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481
-\gls*  482
-\glsadd  483
-\glsaddall  484, 485
+class="ec-lmtt-10x-x-109">glossarysubentry (counter)  479
+\glossarysubentryfield  480, 481
+\GLS  482, 483, 484
+\Gls  485, 486, 487, 488, 489, 490, 491, 492, 493, 494
+\gls  495, 496, 497, 498, 499, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525
+\gls*  526
+\glsadd  527
+\glsaddall  528, 529
\glsaddall options
+class="ec-lmtt-10x-x-109">\glsaddall options
    types  486
-\GlsAddXdyAttribute  487, 488
- +class="ec-lmss-10x-x-109">types  530
+\GlsAddXdyAttribute  531, 532
+\GlsAddXdyCounters  533, 534
+\GlsAddXdyLocation  535, 536
+\glsautoprefix  537
+\glsclearpage  538
+\glsclosebrace  539
+\glsdefaulttype  540, 541, 542, 543, 544
+\GLSdesc  545
+ - + +\Glsdesc  546
+\glsdesc  547
+\glsdescwidth  548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559
+\glsdisablehyper  560
+\glsdisp  561, 562, 563, 564, 565, 566, 567, 568
+\glsdisplay  569, 570, 571, 572, 573, 574, 575, 576
+\glsdisplayfirst  577, 578, 579, 580, 581, 582, 583, 584
\GlsAddXdyCounters  489, 490
-\GlsAddXdyLocation  491, 492
-\glsautoprefix  493
-\glsclearpage  494
-\glsclosebrace  495
-\glsdefaulttype  496, 497, 498, 499
-\GLSdesc  500
-\Glsdesc  501
-\glsdesc  502
-\glsdescwidth  503, 504, 505, 506, 507, 508, 509, 510, 511, 512, 513, 514
-\glsdisablehyper  515
-\glsdisp  516, 517, 518, 519, 520, 521, 522, 523
-\glsdisplay  524, 525, 526, 527, 528, 529, 530, 531
-\glsdisplayfirst  532, 533, 534, 535, 536, 537, 538, 539
-\glsenablehyper  540
-\glsentrycounterlabel  541
-\Glsentrydesc  542
-\glsentrydesc  543
-\Glsentrydescplural  544
-\glsentrydescplural  545
-\Glsentryfirst  546
-\glsentryfirst  547
-\Glsentryfirstplural  548
+class="ec-lmtt-10x-x-109">\glsdisplaynumberlist  585, 586
\glsentryfirstplural  549
-\Glsentryfull  550
-\glsentryfull  551
-\Glsentryfullpl  552
-\glsentryfullpl  553
-\glsentryitem  554, 555
-\Glsentrylong  556
-\glsentrylong  557, 558
-\Glsentrylongpl  559
-\glsentrylongpl  560
-\Glsentryname  561
-\glsentryname  562, 563, 564, 565
-\Glsentryplural  566
-\glsentryplural  567
-\Glsentryshort  568
-\glsentryshort  569
-\Glsentryshortpl  570
-\glsentryshortpl  571
-\Glsentrysymbol  572
-\glsentrysymbol  573
-\Glsentrysymbolplural  574
-\glsentrysymbolplural  575
-\Glsentrytext  576
- - - -\glsentrytext  577, 578, 579, 580, 581, 582, 583
-\Glsentryuseri  584
-\glsentryuseri  585
-\Glsentryuserii  586
-\glsentryuserii  587
-\Glsentryuseriii  588
-\glsentryuseriii  589
-\Glsentryuseriv  590
-\glsentryuseriv  591
-\Glsentryuserv  592
-\glsentryuserv  593
-\Glsentryuservi  594
-\glsentryuservi  595
-\GLSfirst  596
-\Glsfirst  597
-\glsfirst  598
-\GLSfirstplural  599
-\Glsfirstplural  600
-\glsfirstplural  601
-\glsgetgrouptitle  602
-\glsgroupheading  603, 604
-\glsgroupskip  605, 606, 607, 608, 609
-\glshyperlink  610, 611
-\glshypernavsep  612
-\glslabel  613
-\glslabeltok  614
-\glslink  615, 616, 617, 618, 619, 620, 621, 622, 623, 624
+class="ec-lmtt-10x-x-109">\glsenablehyper  587
+\glsentrycounterlabel  588
+\Glsentrydesc  589
+\glsentrydesc  590
+\Glsentrydescplural  591
+\glsentrydescplural  592
+\Glsentryfirst  593
+\glsentryfirst  594
+\Glsentryfirstplural  595
+\glsentryfirstplural  596
+\Glsentryfull  597
+\glsentryfull  598
+\Glsentryfullpl  599
+\glsentryfullpl  600
+\glsentryitem  601, 602
+\Glsentrylong  603
+\glsentrylong  604, 605
+\Glsentrylongpl  606
+\glsentrylongpl  607
+\Glsentryname  608
+\glsentryname  609, 610, 611, 612
+\glsentrynumberlist  613, 614
+\Glsentryplural  615
+\glsentryplural  616
+\Glsentryshort  617
+\glsentryshort  618
+\Glsentryshortpl  619
+\glsentryshortpl  620
+\Glsentrysymbol  621
+\glsentrysymbol  622
+\Glsentrysymbolplural  623
+\glsentrysymbolplural  624
+\Glsentrytext  625
+\glsentrytext  626, 627, 628, 629, 630, 631, 632
+\Glsentryuseri  633
+ + + +\glsentryuseri  634
+\Glsentryuserii  635
+\glsentryuserii  636
+\Glsentryuseriii  637
+\glsentryuseriii  638
+\Glsentryuseriv  639
+\glsentryuseriv  640
+\Glsentryuserv  641
+\glsentryuserv  642
+\Glsentryuservi  643
+\glsentryuservi  644
+\GLSfirst  645
+\Glsfirst  646
+\glsfirst  647
+\GLSfirstplural  648
+\Glsfirstplural  649
+\glsfirstplural  650
+\glsgetgrouptitle  651
+\glsgroupheading  652, 653
+\glsgroupskip  654, 655, 656, 657, 658
+\glshyperlink  659, 660
+\glshypernavsep  661
+\glsinlineparentchildseparator  662, 663
+\glsinlineseparator  664, 665
+\glsinlinesubseparator  666, 667
+\glslabel  668
+\glslabeltok  669
+\glslink  670, 671, 672, 673, 674, 675, 676, 677, 678, 679
\glslink options
+class="ec-lmtt-10x-x-109">\glslink options
    counter  625, 626
+class="ec-lmss-10x-x-109">counter  680, 681
    format  627, 628, 629, 630
+class="ec-lmss-10x-x-109">format  682, 683, 684, 685, 686
    hyper  631, 632, 633
+class="ec-lmss-10x-x-109">hyper  687, 688, 689
+\glslink*  690
+\glslistdottedwidth  691
+\glslocalreset  692
+\glslocalresetall  693
+\glslocalunset  694
+\glslocalunsetall  695
+\glslongtok  696
+\glsmcols  697
+\glsmoveentry  698
+\GLSname  699
+\Glsname  700
+ + + \glslink*  634
+class="ec-lmtt-10x-x-109">\glsname  701, 702, 703
\glslistdottedwidth  635
+class="ec-lmtt-10x-x-109">\glsnamefont  704, 705
\glslocalreset  636
+class="ec-lmtt-10x-x-109">\glsnavhypertarget  706
\glslocalresetall  637
+class="ec-lmtt-10x-x-109">\glsnumberformat  707
\glslocalunset  638
+class="ec-lmtt-10x-x-109">\glsnumbersgroupname  708
\glslocalunsetall  639
+class="ec-lmtt-10x-x-109">\glsnumlistlastsep  709
\glslongtok  640
+class="ec-lmtt-10x-x-109">\glsnumlistsep  710
\GLSname  641
+class="ec-lmtt-10x-x-109">\glsopenbrace  711
+\glspagelistwidth  712, 713, 714, 715, 716, 717, 718, 719
+\glspar  720
+\GLSpl  721, 722, 723, 724, 725
+\Glspl  726, 727, 728, 729, 730, 731, 732
+\glspl  733, 734, 735, 736, 737, 738, 739, 740, 741, 742, 743, 744, 745, 746, 747, 748, 749
+\GLSplural  750
+\Glsplural  751
+\glsplural  752
+\glspluralsuffix  753, 754, 755, 756
\Glsname  642
+class="ec-lmtt-10x-x-109">\glspostdescription  757
\glsname  643, 644, 645
+class="ec-lmtt-10x-x-109">\glspostinline  758, 759
\glsnamefont  646, 647
+class="ec-lmtt-10x-x-109">\glsquote  760
\glsnavhypertarget  648
+class="ec-lmtt-10x-x-109">\glsrefentry  761, 762, 763
\glsnumberformat  649
+class="ec-lmtt-10x-x-109">\glsreset  764, 765
\glsnumbersgroupname  650
+class="ec-lmtt-10x-x-109">\glsresetall  766
\glsopenbrace  651
- - - -\glspagelistwidth  652, 653, 654, 655, 656, 657, 658, 659
-\glspar  660
-\GLSpl  661, 662, 663, 664, 665
-\Glspl  666, 667, 668, 669, 670, 671, 672
-\glspl  673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689
-\GLSplural  690
-\Glsplural  691
-\glsplural  692
-\glspluralsuffix  693, 694, 695, 696
+class="ec-lmtt-10x-x-109">\glsresetentrycounter  767
\glspostdescription  697
+class="ec-lmtt-10x-x-109">\glssee  768, 769, 770, 771, 772
\glsquote  698
+class="ec-lmtt-10x-x-109">\glsseeformat  773, 774, 775
\glsrefentry  699, 700, 701
-\glsreset  702, 703
-\glsresetall  704
-\glssee  705, 706, 707, 708, 709
-\glsseeformat  710, 711, 712
-\glsseeitemformat  713
-\glsseelastsep  714
-\glsseelist  715, 716
-\glsseesep  717
-\glsSetAlphaCompositor  \glsseeitemformat  776
+\glsseelastsep  777
+\glsseelist  778, 779
+\glsseesep  780
+\glsSetAlphaCompositor  718
+class="ec-lmri-10x-x-109">781
\glsSetCompositor  \glsSetCompositor  719
+class="ec-lmri-10x-x-109">782
\glsSetSuffixF  720
+class="ec-lmtt-10x-x-109">\glsSetSuffixF  783
\glsSetSuffixFF  721
+class="ec-lmtt-10x-x-109">\glsSetSuffixFF  784
\glssetwidest  722
+class="ec-lmtt-10x-x-109">\glssetwidest  785
\GlsSetXdyCodePage  723, 724
-\GlsSetXdyFirstLetterAfterDigits  725
-\GlsSetXdyLanguage  726, 727
-\GlsSetXdyLocationClassOrder  728
-\GlsSetXdyMinRangeLength  729, 730
-\glsshorttok  731
-\glssubentrycounterlabel  732
-\glssubentryitem  733, 734
-\GLSsymbol  735
-\Glssymbol  736
-\glssymbol  737
-\glssymbolsgroupname  738
-\glstarget  739, 740
-\GLStext  741
-\Glstext  742
-\glstext  743, 744, 745, 746, 747, 748, 749, 750, 751, 752, 753
-\glstextformat  754, 755, 756
-\glstocfalse  \GlsSetXdyCodePage  786, 787
+\GlsSetXdyFirstLetterAfterDigits  788
+\GlsSetXdyLanguage  789, 790
+\GlsSetXdyLocationClassOrder  791
+\GlsSetXdyMinRangeLength  792, 793
+\glsshorttok  794
+\glssubentrycounterlabel  795
+\glssubentryitem  796, 797
+ + + +\GLSsymbol  798
+\Glssymbol  799
+\glssymbol  800
+\glssymbolsgroupname  801
+\glstarget  802, 803
+\GLStext  804
+\Glstext  805
+\glstext  806, 807, 808, 809, 810, 811, 812, 813, 814, 815, 816
+\glstextformat  817, 818, 819
+\glstocfalse  757
+class="ec-lmri-10x-x-109">820
\glstoctrue  \glstoctrue  758
+class="ec-lmri-10x-x-109">821
\glstreeindent  759
+class="ec-lmtt-10x-x-109">\glstreeindent  822
\glsunset  760
- - - +class="ec-lmtt-10x-x-109">\glsunset  823
\glsunsetall  761
+class="ec-lmtt-10x-x-109">\glsunsetall  824
\GLSuseri  762
+class="ec-lmtt-10x-x-109">\GLSuseri  825
\Glsuseri  763
+class="ec-lmtt-10x-x-109">\Glsuseri  826
\glsuseri  764
+class="ec-lmtt-10x-x-109">\glsuseri  827
\GLSuserii  765
+class="ec-lmtt-10x-x-109">\GLSuserii  828
\Glsuserii  766
+class="ec-lmtt-10x-x-109">\Glsuserii  829
\glsuserii  767
+class="ec-lmtt-10x-x-109">\glsuserii  830
\GLSuseriii  768
+class="ec-lmtt-10x-x-109">\GLSuseriii  831
\Glsuseriii  769
+class="ec-lmtt-10x-x-109">\Glsuseriii  832
\glsuseriii  770
+class="ec-lmtt-10x-x-109">\glsuseriii  833
\GLSuseriv  771
+class="ec-lmtt-10x-x-109">\GLSuseriv  834
\Glsuseriv  772
+class="ec-lmtt-10x-x-109">\Glsuseriv  835
\glsuseriv  773
+class="ec-lmtt-10x-x-109">\glsuseriv  836
\GLSuserv  774
+class="ec-lmtt-10x-x-109">\GLSuserv  837
\Glsuserv  775
+class="ec-lmtt-10x-x-109">\Glsuserv  838
\glsuserv  776
+class="ec-lmtt-10x-x-109">\glsuserv  839
\GLSuservi  777
+class="ec-lmtt-10x-x-109">\GLSuservi  840
\Glsuservi  778
+class="ec-lmtt-10x-x-109">\Glsuservi  841
\glsuservi  779
-

H +class="ec-lmtt-10x-x-109">\glsuservi  842
+

H html package  780
+class="ec-lmss-10x-x-109">html package  843
\hyperbf  781
+class="ec-lmtt-10x-x-109">\hyperbf  844
\hyperbsf  782
+class="ec-lmtt-10x-x-109">\hyperbsf  845
\hyperemph  783
+class="ec-lmtt-10x-x-109">\hyperemph  846
\hyperit  784
+class="ec-lmtt-10x-x-109">\hyperit  847
\hyperlink  785, 786, 787
+class="ec-lmtt-10x-x-109">\hyperlink  848, 849, 850
\hypermd  788
+class="ec-lmtt-10x-x-109">\hypermd  851
\hyperpage  789
+class="ec-lmtt-10x-x-109">\hyperpage  852
+ + + hyperref package  790, 791, 792, 793, 794, 795, 796, 797, 798, 799, 800, 801
-\hyperrm  802, 803
-\hypersc  804
-\hypersf  805
-\hypersl  806
-\hypertarget  807
-\hypertt  808
-\hyperup  809
-

I -\ifglsused  810
-\index  811, 812, 813, 814
-\indexspace  815, 816, 817, 818
+class="ec-lmss-10x-x-109">hyperref package  853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865
+\hyperrm  866, 867
+\hypersc  868
+\hypersf  869
+\hypersl  870
+\hypertarget  871
+\hypertt  872
+\hyperup  873
+

I +\ifglossaryexists  874
+\ifglsentryexists  875
+\ifglshaschildren  876
+\ifglshasparent  877
+\ifglsused  878, 879
+\index  880, 881, 882, 883
+\indexspace  884, 885, 886, 887, 888
inputenc package  819, 820, 821, 822
-\inputencodingname  823
- - - -\item  824, 825
+class="ec-lmss-10x-x-109">inputenc package  889, 890, 891, 892
+\inputencodingname  893
+\item  894, 895
itemize (environment)  826
-

J -\jobname  827, 828
-

L +class="ec-lmtt-10x-x-109">itemize (environment)  896
+

J +\jobname  897, 898
+

L link text  829, 830, 831, 832, 833, 834, 835, 836
-\loadglsentries  837, 838, 839
+class="ec-lmbx-10x-x-109">899, 900, 901, 902, 903, 904, 905, 906
+\loadglsentries  907, 908, 909
location list  see number list
+class="ec-lmri-10x-x-109">see number list
longtable (environment)  841, 842, 843, 844, 845, 846
+class="ec-lmtt-10x-x-109">longtable (environment)  911, 912, 913, 914, 915, 916
longtable package  847, 848
-

M -\makefirstuc  849, 850, 851
+class="ec-lmss-10x-x-109">longtable package  917, 918
+

M +\makefirstuc  919, 920, 921
makeglossaries  852
+class="ec-lmbx-10x-x-109">922
makeglossaries  853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865, 866, 867, 868, 869, 870, 871, 872, 873, 874, 875, 876, 877, 878, 879, 880, 881, 882, 883, 884, 885, 886, 887, 888, 889, 890, 891, 892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907, 908
-\makeglossaries  909, makeglossaries  923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940, 941, 942, 943, 944, 945, 946, 947, 948, 949, 950, 951, 952, 953, 954, 955, 956, 957, 958, 959, 960, 961, 962, 963, 964, 965, 966, 967, 968, 969, 970, 971, 972, 973, 974, 975, 976, 977, 978, 979, 980, 981
+\makeglossaries  982, 910, 911, 912, 913, 914, 915, 916, 917, 918, 919, 920, 921, 922, 923, 924, 925, 926
+class="ec-lmri-10x-x-109">983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999
+ + + +makeglossariesgui  1000
+makeglossariesgui  1001, 1002, 1003, 1004, 1005
makeindex  927
+href="glossaries-user.html#dx1-2035" >1006
makeindex  928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940, 941, 942, 943, 944, 945, 946, 947, 948, 949, 950, 951, 952, 953, 954, 955, 956, 957, 958, 959, 960, 961, 962, 963, 964, 965, 966, 967, 968, 969, 970, 971, 972, 973, 974, 975, 976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994
+class="ec-lmtt-10x-x-109">makeindex  1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074
+\MakeUppercase  1075
memoir class  995
+class="ec-lmss-10x-x-109">memoir class  1076
mfirstuc package  996, 997, 998
-

N -\newacronym  999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024
-\newdualentry  1025
-\newglossary  1026, 1027, 1028, 1029, 1030, 1031
-\newglossaryentry  1032, 1033, 1034, 1035, mfirstuc package  1077, 1078, 1079
+multicol package  1080
+multicols (environment)  1081, 1082
+

N +\newacronym  1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108
+\newdualentry  1109
+\newglossary  1110, 1111, 1112, 1113, 1114, 1115
+\newglossaryentry  1116, 1117, 1118, 1119, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048
+class="ec-lmri-10x-x-109">1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129, 1130, 1131, 1132
\newglossaryentry options
+class="ec-lmtt-10x-x-109">\newglossaryentry options
    access  1049
+class="ec-lmss-10x-x-109">access  1133
    description  1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070
+class="ec-lmss-10x-x-109">description  1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153, 1154
    descriptionaccess  1071
+class="ec-lmss-10x-x-109">descriptionaccess  1155
    descriptionplural  1072, 1073, 1074
+class="ec-lmss-10x-x-109">descriptionplural  1156, 1157, 1158
    descriptionpluralaccess  1075
+class="ec-lmss-10x-x-109">descriptionpluralaccess  1159
    first  1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095
+class="ec-lmss-10x-x-109">first  1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179
    firstaccess  1096
+class="ec-lmss-10x-x-109">firstaccess  1180
    firstplural  1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110
- - - +class="ec-lmss-10x-x-109">firstplural  1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194
    firstpluralaccess  1111
+class="ec-lmss-10x-x-109">firstpluralaccess  1195
    format  1112
+class="ec-lmss-10x-x-109">format  1196
    long  1113, 1114, 1115
+class="ec-lmss-10x-x-109">long  1197, 1198, 1199
    longaccess  1116
+class="ec-lmss-10x-x-109">longaccess  1200
    longplural  1117, 1118, 1119, 1120
+class="ec-lmss-10x-x-109">longplural  1201, 1202, 1203, 1204
    longpluralaccess  1121
+class="ec-lmss-10x-x-109">longpluralaccess  1205
    name  1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151
+class="ec-lmss-10x-x-109">name  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, 1234, 1235
    nonumberlist  1152
+class="ec-lmss-10x-x-109">nonumberlist  1236
    parent  1153, 1154, 1155, 1156
+class="ec-lmss-10x-x-109">parent  1237, 1238, 1239, 1240
    plural  1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170
+class="ec-lmss-10x-x-109">plural  1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
    pluralaccess  1171
+class="ec-lmss-10x-x-109">pluralaccess  1255
    see  1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183
+class="ec-lmss-10x-x-109">see  1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267
    short  1184, 1185, 1186
+class="ec-lmss-10x-x-109">short  1268, 1269, 1270
+ + +     shortaccess  1187
+class="ec-lmss-10x-x-109">shortaccess  1271
    shortplural  1188, 1189, 1190, 1191
+class="ec-lmss-10x-x-109">shortplural  1272, 1273, 1274, 1275
    shortpluralaccess  1192
+class="ec-lmss-10x-x-109">shortpluralaccess  1276
    sort  1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206
+class="ec-lmss-10x-x-109">sort  1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290
    symbol  1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224
+class="ec-lmss-10x-x-109">symbol  1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308
    symbolaccess  1225
+class="ec-lmss-10x-x-109">symbolaccess  1309
    symbolplural  1226, 1227, 1228
+class="ec-lmss-10x-x-109">symbolplural  1310, 1311, 1312
    symbolpluralaccess  1229
+class="ec-lmss-10x-x-109">symbolpluralaccess  1313
    text  1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249
+class="ec-lmss-10x-x-109">text  1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333
    textaccess  1250
+class="ec-lmss-10x-x-109">textaccess  1334
    type  1251, 1252
+class="ec-lmss-10x-x-109">type  1335, 1336
    user1  1253, 1254, 1255, 1256, 1257, 1258
+class="ec-lmss-10x-x-109">user1  1337, 1338, 1339, 1340, 1341, 1342
    user2  1259, 1260
+class="ec-lmss-10x-x-109">user2  1343, 1344
    user3  1261
+class="ec-lmss-10x-x-109">user3  1345
    user4  1262
+class="ec-lmss-10x-x-109">user4  1346
    user5  1263
+class="ec-lmss-10x-x-109">user5  1347
    user6  1264, 1265, 1266
-\newglossarystyle  1267, 1268, 1269, 1270
-\newline  1271, 1272
+class="ec-lmss-10x-x-109">user6  1348, 1349, 1350
+\newglossarystyle  1351, 1352, 1353, 1354
+\newline  1355, 1356
ngerman package  1273, 1274
+class="ec-lmss-10x-x-109">ngerman package  1357, 1358
\nohyperpage  1275
+class="ec-lmtt-10x-x-109">\nohyperpage  1359
\noist  1276, \noist  1360, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287
-\nopostdesc  1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371
+\nopostdesc  1288, 1289, 1290, 1291
+class="ec-lmri-10x-x-109">1372, 1373, 1374, 1375
number list  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
-\numberline  1329
-

O -\oldacronym  1330, 1331
-

P - - - +href="glossaries-user.html#dx1-2026" >1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415
+\numberline  1416
+

O +\oldacronym  1417, 1418
+

P package options:
    acronym  1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353
+class="ec-lmss-10x-x-109">acronym  1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440
    acronymlists  1354, 1355, 1356, 1357
+class="ec-lmss-10x-x-109">acronymlists  1441, 1442, 1443, 1444
    compatible-2.07  1358
+class="ec-lmss-10x-x-109">compatible-2.07  1445
    counter  1359, 1360, 1361, 1362, 1363
+class="ec-lmss-10x-x-109">counter  1446, 1447, 1448, 1449, 1450
        page  1364
+class="ec-lmss-10x-x-109">page  1451
    counterwithin  1365, 1366, 1367, 1368, 1369
+class="ec-lmss-10x-x-109">counterwithin  1452, 1453, 1454, 1455, 1456
+ + +     description  1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384
+class="ec-lmss-10x-x-109">description  1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469, 1470, 1471
    dua  1385, 1386, 1387, 1388, 1389, 1390, 1391
+class="ec-lmss-10x-x-109">dua  1472, 1473, 1474, 1475, 1476, 1477, 1478
    entrycounter  1392, 1393, 1394, 1395, 1396
+class="ec-lmss-10x-x-109">entrycounter  1479, 1480, 1481, 1482, 1483
        false  1397
+class="ec-lmss-10x-x-109">false  1484
        true  1398
+class="ec-lmss-10x-x-109">true  1485
    footnote  1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412
+class="ec-lmss-10x-x-109">footnote  1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499
    hyperfirst  1413
+class="ec-lmss-10x-x-109">hyperfirst  1500
        false  1414, 1415
+class="ec-lmss-10x-x-109">false  1501, 1502
        true  1416
+class="ec-lmss-10x-x-109">true  1503
    makeindex  1417
+class="ec-lmss-10x-x-109">makeindex  1504
    nolist  1418, 1419
+class="ec-lmss-10x-x-109">nolist  1505, 1506
    nolong  1420, 1421, 1422
+class="ec-lmss-10x-x-109">nolong  1507, 1508, 1509
    nomain  1423, 1424
+class="ec-lmss-10x-x-109">nomain  1510, 1511
    nonumberlist  1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432
+class="ec-lmss-10x-x-109">nonumberlist  1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519
    nostyles  1433, 1434, 1435, 1436, 1437, 1438
+class="ec-lmss-10x-x-109">nostyles  1520, 1521, 1522, 1523, 1524, 1525
    nosuper  1439, 1440, 1441
+class="ec-lmss-10x-x-109">nosuper  1526, 1527, 1528
    notree  1442, 1443
+class="ec-lmss-10x-x-109">notree  1529, 1530
    nowarn  1444
+class="ec-lmss-10x-x-109">nowarn  1531, 1532
    numberedsection  1445, 1446, 1447, 1448, 1449
+class="ec-lmss-10x-x-109">numberedsection  1533, 1534, 1535, 1536, 1537
        autolabel  1450, 1451
+class="ec-lmss-10x-x-109">autolabel  1538, 1539
        false  1452
+class="ec-lmss-10x-x-109">false  1540
        nolabel  1453
+class="ec-lmss-10x-x-109">nolabel  1541
    numberline  1454, 1455
+class="ec-lmss-10x-x-109">numberline  1542, 1543
    order  1456, 1457
+class="ec-lmss-10x-x-109">order  1544, 1545
        letter  1458, 1459, 1460
+class="ec-lmss-10x-x-109">letter  1546, 1547, 1548
        word  1461, 1462, 1463
+class="ec-lmss-10x-x-109">word  1549, 1550, 1551
    sanitize  1464, 1465, 1466, 1467, 1468
+class="ec-lmss-10x-x-109">sanitize  1552, 1553, 1554, 1555, 1556
        none  1469
+class="ec-lmss-10x-x-109">none  1557
    savewrites  1470, 1471, 1472
+class="ec-lmss-10x-x-109">savenumberlist  1558, 1559
        false  1473
+class="ec-lmss-10x-x-109">false  1560
    section  1474, 1475
+class="ec-lmss-10x-x-109">savewrites  1561, 1562, 1563
+        false  1564
    seeautonumberlist  1476, 1477, 1478, 1479
+class="ec-lmss-10x-x-109">section  1565, 1566
    shortcuts  1480, 1481, 1482, 1483
+class="ec-lmss-10x-x-109">seeautonumberlist  1567, 1568, 1569, 1570
    smallcaps  1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497
+class="ec-lmss-10x-x-109">shortcuts  1571, 1572, 1573, 1574
    smaller  1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509
+class="ec-lmss-10x-x-109">smallcaps  1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588
    sort  1510, 1511, 1512
- - - +class="ec-lmss-10x-x-109">smaller  1589, 1590, 1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599, 1600
+    sort  1601, 1602, 1603
        def  1513, 1514, 1515, 1516
+class="ec-lmss-10x-x-109">def  1604, 1605, 1606, 1607
        standard  1517, 1518, 1519
+class="ec-lmss-10x-x-109">standard  1608, 1609, 1610
        use  1520, 1521, 1522, 1523
+class="ec-lmss-10x-x-109">use  1611, 1612, 1613, 1614
    style  1524, 1525, 1526, 1527, 1528, 1529, 1530
+class="ec-lmss-10x-x-109">style  1615, 1616, 1617, 1618, 1619, 1620, 1621
+ + +         list  1531
+class="ec-lmss-10x-x-109">list  1622
    subentrycounter  1532, 1533, 1534, 1535, 1536, 1537
+class="ec-lmss-10x-x-109">subentrycounter  1623, 1624, 1625, 1626, 1627, 1628
        false  1538
+class="ec-lmss-10x-x-109">false  1629
    toc  1539, 1540, 1541, 1542, 1543
+class="ec-lmss-10x-x-109">toc  1630, 1631, 1632, 1633, 1634
    translate  1544
+class="ec-lmss-10x-x-109">translate  1635
        false  1545, 1546, 1547, 1548
+class="ec-lmss-10x-x-109">false  1636, 1637, 1638, 1639
        true  1549, 1550
+class="ec-lmss-10x-x-109">true  1640, 1641
    xindy  1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561
+class="ec-lmss-10x-x-109">ucmark  1642, 1643
+        false  1644
+    xindy  1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655
page counter  1562
+class="ec-lmss-10x-x-109">page counter  1656
\pagelistname  1563
+class="ec-lmtt-10x-x-109">\pagelistname  1657
pod2man  1564
+class="ec-lmtt-10x-x-109">pod2man  1658
polyglossia package  1565, 1566, 1567, 1568, 1569
-\printglossaries  1570, 1571, 1572, 1573, 1574
-\printglossary  1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582
+class="ec-lmss-10x-x-109">polyglossia package  1659, 1660, 1661, 1662, 1663
+\printglossaries  1664, 1665, 1666, 1667, 1668
+\printglossary  1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676
\printglossary options
+class="ec-lmtt-10x-x-109">\printglossary options
    nonumberlist  1583
+class="ec-lmss-10x-x-109">nonumberlist  1677
    numberedsection  1584
+class="ec-lmss-10x-x-109">numberedsection  1678
    style  1585, 1586, 1587, 1588
+class="ec-lmss-10x-x-109">style  1679, 1680, 1681, 1682
    title  1589, 1590
+class="ec-lmss-10x-x-109">title  1683, 1684
    toctitle  1591
+class="ec-lmss-10x-x-109">toctitle  1685
    type  1592
+class="ec-lmss-10x-x-109">type  1686
\protect  1593
-

R +class="ec-lmtt-10x-x-109">\protect  1687
+

R relsize package  1594, 1595, 1596, 1597
-\Roman  1598
-

S +class="ec-lmss-10x-x-109">relsize package  1688, 1689, 1690, 1691
+\Roman  1692
+

S sanitize  1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611
-\section*  1612
-\seename  1613, 1614, 1615, 1616
-\setAlphaCompositor  1617
-\setCompositor  1618
-\SetCustomDisplayStyle  1619, 1620, 1621, 1622
-\SetCustomStyle  1623
-\setentrycounter  1624, 1625
-\setglossarysection  1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705
+\section*  1706
+\seename  1707, 1708, 1709, 1710
+\setAlphaCompositor  1711
+\setCompositor  1712
+\SetCustomDisplayStyle  1713, 1714, 1715, 1716
+\SetCustomStyle  1717
+\setentrycounter  1718, 1719
+\setglossarysection  1626, 1627
+class="ec-lmri-10x-x-109">1720, 1721
\setStyleFile  1628, 1629, \setStyleFile  1722, 1723, 1630
+class="ec-lmri-10x-x-109">1724
\smaller  1631
+class="ec-lmtt-10x-x-109">\smaller  1725
+ + + supertabular (environment)  1632, 1633, 1634, 1635, 1636
- - - +class="ec-lmtt-10x-x-109">supertabular (environment)  1726, 1727, 1728, 1729, 1730
supertabular package  1637, 1638, 1639
-\symbolname  1640
-

T -\textbf  1641
-\textrm  1642
-\textsc  1643, 1644, 1645, 1646, 1647, 1648, 1649
-\textsmaller  1650, 1651, 1652, 1653, 1654, 1655, 1656
+class="ec-lmss-10x-x-109">supertabular package  1731, 1732, 1733
+\symbolname  1734
+

T +TeX4HT  1735
+\textbf  1736
+\textrm  1737
+\textsc  1738, 1739, 1740, 1741, 1742, 1743, 1744
+\textsmaller  1745, 1746, 1747, 1748, 1749, 1750, 1751
theglossary (environment)  1657, 1658, 1659, 1660
-\thepage  1661
+class="ec-lmtt-10x-x-109">theglossary (environment)  1752, 1753, 1754, 1755
+\thepage  1756
translator package  1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676
-

W -\write18  1677
-

X +class="ec-lmss-10x-x-109">translator package  1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767, 1768, 1769, 1770, 1771
+

W +\write18  1772
+

X xindy  1678
+href="glossaries-user.html#dx1-2045" >1773
xindy  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, 1707, 1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729, 1730, 1731, 1732, 1733, 1734, 1735, 1736, 1737, 1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752, 1753, 1754, 1755, 1756, 1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767, 1768, 1769, 1770, 1771, 1772, 1773, 1774, 1775, 1776, 1777, 1778
+class="ec-lmtt-10x-x-109">xindy  1774, 1775, 1776, 1777, 1778, 1779, 1780, 1781, 1782, 1783, 1784, 1785, 1786, 1787, 1788, 1789, 1790, 1791, 1792, 1793, 1794, 1795, 1796, 1797, 1798, 1799, 1800, 1801, 1802, 1803, 1804, 1805, 1806, 1807, 1808, 1809, 1810, 1811, 1812, 1813, 1814, 1815, 1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827, 1828, 1829, 1830, 1831, 1832, 1833, 1834, 1835, 1836, 1837, 1838, 1839, 1840, 1841, 1842, 1843, 1844, 1845, 1846, 1847, 1848, 1849, 1850, 1851, 1852, 1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862, 1863, 1864, 1865, 1866, 1867, 1868, 1869, 1870, 1871, 1872, 1873, 1874
xkeyval package  1779, 1780
+class="ec-lmss-10x-x-109">xkeyval package  1875, 1876
\xmakefirstuc  1781
+class="ec-lmtt-10x-x-109">\xmakefirstuc  1877
\xspace  1782
+class="ec-lmtt-10x-x-109">\xspace  1878
xspace package  1783, 1784, 1785, 1786, 1787, 1788
+class="ec-lmss-10x-x-109">xspace package  1879, 1880, 1881, 1882, 1883, 1884

- - - -

1That is, if the term has been referenced using any of the commands described in §6 Links to -Glossary Entries and §7 Adding an Entry to the Glossary Without Generating Text or via \glssee

+1That is, if the term has been referenced using any of the commands described + in §6 Links to Glossary Entries and §7 Adding an Entry to the Glossary + Without Generating Text or via \glssee (or -the see(or the see key) or commands such as \acrshortkey) or commands such as + \acrshort.

-

2As from v3.01 \gls is no longer fragile and doesn’t need protecting.

-

3if the acronym option is used, otherwise the list of acronyms is the main glossary

-

4Actually it sets \acronymtype.

+2As from v3.01 \gls is no longer fragile and doesn’t need protecting.

+1if the acronym option is used, otherwise the list of acronyms is the main + glossary

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

-

5The only preamble restriction on \newglossaryentryusually has the value main.

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

-

6Except possibly the style file but then you’ll need to use \noist.

+2Except possibly the style file but then you’ll need to use \noist to prevent your changes from -being overwritten.

-

7This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not -used.

-

8main for the main (default) glossary, \acronymtype for the list of acronyms, or the name -supplied in the first mandatory argument to \newglossary for additional glossaries.

-

9As from v3.01, \gls is no longer fragile.

-

10to prevent your + changes from being overwritten.

+3This is because \acronymtype is set to \glsdefaulttype if the acronym package + option is not used.

+1main for the main (default) glossary, \acronymtype for the list of acronyms, or the + name supplied in the first mandatory argument to \newglossary for additional + glossaries.

+1As from v3.01, \gls is no longer fragile.

+2makeindex will always assign a location number, even if it’s not needed, so it needs to be -discarded.

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

-

12In versions before 3.0, \glsentryname was used, but this can cause problems when the name -key is makeindex will always assign a location number, even if it’s not needed, so it needs + to be discarded.

+3If you 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.

+4In versions before 3.0, \glsentryname was used, but this can cause problems when + the name key is sanitized.

-

13versions before 3.0 used \glsentryname as the default, but this can cause problems when name -has been sanitized.

+1versions before 3.0 used \glsentryname as the default, but this can cause problems + when name has been sanitized.

14you can’t use the longheaderborder style for this example as you can’t use the longtable -environment in two column mode.

15see \setCompositor described in §3 Setting Up

-

16see \setAlphaCompositor described in §3 Setting Up

-

17not that this was change from using \smaller to \textsmaller as declarations cause a problem for -\makefirstuc.

-

18as from version 1.18

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

-

20This style was supplied by Axel Menzel.

-

21e.g. with the flowfram package.

+class="ec-lmr-9">sanitized.

+1you can’t use the longheaderborder style for this example as you can’t use the + longtable environment in two column mode.

+1see \setCompositor described in §3 Setting Up

+2see \setAlphaCompositor described in §3 Setting Up

+1not that this was change from using \smaller to \textsmaller as declarations + cause a problem for \makefirstuc.

+2as from version 1.18

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

- + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index 1bab8a84747..87983d9c124 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 4a4039b46f2..ca79ac9bd84 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -1,9 +1,13 @@ -\documentclass{nlctdoc} +\documentclass[report]{nlctdoc} +\usepackage[inner=0.5in,includemp]{geometry} + +\usepackage{array} \usepackage{alltt} \usepackage{pifont} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} +\usepackage{lmodern} \ifpdf \usepackage{mathpazo} \usepackage[scaled=.88]{helvet} @@ -17,6 +21,9 @@ pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} \usepackage{xr-hyper} \usepackage[xindy,nonumberlist,seeautonumberlist,toc,style=altlist]{glossaries} +\usepackage{glossary-inline} + +\pagestyle{headings} \renewcommand*{\glsgroupskip}{} @@ -35,8 +42,8 @@ style=altlist]\{glossaries\} \end{tabbing} \cs{renewcommand*}\{\ics{glsgroupskip}\}\{\}\newline -\cs{renewcommand*}\{\ics{glsseeformat}\}[3][\ics{seename}]\{(\ics{xmakefirstuc}\{\#1\} \newline -\ics{glsseelist}\{\#2\}.)\} +\cs{renewcommand*}\{\ics{glsseeformat}\}[3][\ics{seename}]\{\% \newline +(\ics{xmakefirstuc}\{\#1\} \ics{glsseelist}\{\#2\}.)\} \end{ttfamily} } @@ -55,7 +62,8 @@ \newcommand*{\htextbf}[1]{\textbf{\hyperpage{#1}}} \newcommand*{\itermdef}[1]{\index{#1|htextbf}} -\IndexPrologue{} +\IndexPrologue{\chapter*{\indexname} + \markboth{\indexname}{\indexname}} \newglossaryentry{xindy}{ name={\appfmt{xindy}\index{xindy|htextbf}}, @@ -76,10 +84,20 @@ description={An indexing application}, name={\appfmt{makeglossaries}\index{makeglossaries|htextbf}},% sort={makeglossaries},% text={\protect\app{makeglossaries}},% -description={A \sty{glossaries} custom designed Perl script interface +description={A \styfmt{glossaries} custom designed Perl script interface to \gls{xindy} and \gls{makeindex}} } +\newglossaryentry{makeglossariesgui}{% +name={\appfmt{makeglossariesgui}\index{makeglossariesgui|htextbf}},% +sort={makeglossariesgui},% +text={\protect\app{makeglossariesgui}},% +description={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} +} + \newglossaryentry{numberlist}{% name={Number list\itermdef{number list}},% sort={number list},% @@ -100,6 +118,7 @@ have multiple locations} \newglossaryentry{locationlist}{% name={Location list},% +text={location list}, sort={location list},% description={A list of \glslink{entrylocation}{entry locations}},% see={numberlist} @@ -214,7 +233,7 @@ package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v3.01} + \title{User Manual for glossaries.sty v3.02} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -222,7 +241,7 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{2011-04-12} + \date{2012-05-21} \maketitle \noindent @@ -250,10 +269,8 @@ letter}{mfirstuc-manual}. \item[\url{glossaries.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v3.01}. -This includes how to iterate over all entry labels defined in a -given glossary or how to iterate over all glossary types, as well as -the documented code for the \sty{mfirstuc} package. +\qt{Documented Code for glossaries v3.02}. +This includes the documented code for the \sty{mfirstuc} package. \item[INSTALL] Installation instructions. @@ -274,7 +291,8 @@ If you use \sty{hyperref} and \styfmt{glossaries}, you must load \clearpage \printglossaries - \section{Introduction} + \chapter{Introduction} +\label{sec:intro} The \styfmt{glossaries} package is provided to assist generating glossaries. It has a certain amount of flexibility, allowing the @@ -325,7 +343,7 @@ post-processor to create the sorted glossaries for your document. \end{itemize} -\subsection{Sample Documents} +\section{Sample Documents} \label{sec:samples} The \styfmt{glossaries} package is provided with some sample @@ -574,6 +592,10 @@ that this will only have an effect if you use you will need to use the \texttt{-l} switch to indicate letter ordering.) +\item[sample-inline.tex]\label{ex:sample-inline} This document is +like \texttt{sample.tex}, above, but uses the \glostyle{inline} +glossary style to put the glossary in a footnote. + \item[sampletree.tex]\label{ex:sampletree} This document illustrates a hierarchical glossary structure where child entries have different names to their corresponding parent entry. To create the document @@ -593,6 +615,16 @@ makeglossaries sample-dual latex sample-dual \end{prompt} +\item[sample-langdict]\label{ex:sample-langdict} This document +illustrates how to use the glossaries package to create English +to French and French to English dictionaries. To create the document +do: +\begin{prompt} +latex sample-langdict +makeglossaries sample-langdict +latex sample-langdict +\end{prompt} + \item[samplexdy.tex]\label{ex:samplexdy} This document illustrates how to use the \styfmt{glossaries} package with \gls{xindy} instead of \gls{makeindex}. The document uses UTF8 encoding (with the @@ -692,7 +724,7 @@ about the \styfmt{glossaries-accsupp} package can be found in \end{description} -\subsection{Multi-Lingual Support} +\section{Multi-Lingual Support} \label{sec:languages} As from version 1.17, the \styfmt{glossaries} package can now be @@ -743,7 +775,7 @@ will pick up the encoding from the auxiliary file. If you use you may need to specify the encoding using the \texttt{-C} option. Read the \gls*{xindy} manual for further details. -\subsubsection{Changing the Fixed Names} +\subsection{Changing the Fixed Names} \label{sec:fixednames} As from version 1.08, the \styfmt{glossaries} package now has @@ -815,32 +847,32 @@ glossaries package are listed in \tableref{tab:predefinednames}. \begin{table}[htbp] \caption{Customised Text} \label{tab:predefinednames} -\begin{center} -\begin{tabular}{@{}llp{0.4\linewidth}@{}} +\centering +\setlength{\tabcolsep}{3pt} +\begin{tabular}{@{}l>{\raggedright}p{0.3\linewidth}>{\raggedright}p{0.4\linewidth}@{}} \bfseries Command Name & \bfseries Translator Key Word & -\bfseries Purpose\\ -\ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\\ +\bfseries Purpose\cr +\ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\cr \ics{acronymname} & \texttt{Acronyms} & Title of the list of acronyms -(when used with package option \pkgopt{acronym}).\\ +(when used with package option \pkgopt{acronym}).\cr \ics{entryname} & \texttt{Notation (glossaries)} & Header for first column in the glossary (for 2, 3 or 4 column glossaries -that support headers).\\ +that support headers).\cr \ics{descriptionname} & \texttt{Description (glossaries)} & Header for second column in the glossary (for 2, 3 or 4 column glossaries -that support headers).\\ +that support headers).\cr \ics{symbolname} & \texttt{Symbol (glossaries)} & Header for symbol -column in the glossary for glossary styles that support this option.\\ +column in the glossary for glossary styles that support this option.\cr \ics{pagelistname} & \texttt{Page List (glossaries)} & Header for page list column in the glossary for glossaries that support -this option.\\ +this option.\cr \ics{glssymbolsgroupname} & \texttt{Symbols (glossaries)} & Header for symbols section of the glossary for glossary styles that -support this option.\\ +support this option.\cr \ics{glsnumbersgroupname} & \texttt{Numbers (glossaries)} & Header for numbers section of the glossary for glossary styles that support this option. \end{tabular} -\end{center} \end{table} Due to the varied nature of glossaries, it's likely that the @@ -926,10 +958,10 @@ if you have glossary entries that contain diacritics or non-Roman letters. See \sectionref{sec:xindy} for further details. -\subsection{Generating the Associated Glossary Files} +\section{Generating the Associated Glossary Files} \label{sec:makeglossaries} -In order to generate a sorted glossary with compact location lists, +In order to generate a sorted glossary with compact \glspl{locationlist}, 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 @@ -970,14 +1002,23 @@ file and see if you can work it out from the \gls*{makeindex} or \end{itemize} +There is also a Java GUI alternative called \gls{makeglossariesgui}, +distributed separately, that has diagnostic tools. + Whilst it is strongly recommended that you use the -\gls{makeglossaries} script, it is possible to use the -\styfmt{glossaries} package without having Perl installed. However, -you will only be able to use \gls{makeindex} as \gls{xindy} also -requires Perl. Note that some commands and package options have no -effect if you don't use \gls*{makeglossaries}. These are listed in +\gls{makeglossaries} script or \gls{makeglossariesgui}, it is +possible to use the \styfmt{glossaries} package without using either +application. However, note that some commands and package options +have no effect if you don't use \gls*{makeglossaries} or +\gls*{makeglossariesgui}. These are listed in \tableref{tab:makeglossariesCmds}. +\begin{important} +If you are choosing not to use \gls*{makeglossaries} because you +don't want to install Perl, you will only be able to use +\gls*{makeindex} as \gls*{xindy} also requires Perl. +\end{important} + Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an additional \gls{makeglossaries}, \gls{makeindex} @@ -1058,7 +1099,7 @@ use \texttt{-C} \meta{code} \end{table} -\subsubsection{Using the makeglossaries Perl Script} +\subsection{Using the makeglossaries Perl Script} \label{sec:makeglossariesapp} The \gls{makeglossaries} script picks up the relevant information @@ -1091,10 +1132,10 @@ 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.03. +2.04. \end{important} -\subsubsection{Using xindy explicitly} +\subsection{Using xindy explicitly} \label{sec:xindyapp} \Gls{xindy} comes with TeXLive, but not with MiKTeX. However MikTeX @@ -1112,7 +1153,7 @@ files, you must make sure you have used the \end{verbatim} This is required regardless of whether you use \gls{xindy} explicitly or whether it's called implicitly via -\gls{makeglossaries}. This causes the glossary +\gls{makeglossaries} or \gls{makeglossariesgui}. This causes the glossary entries to be written in raw \gls*{xindy} format, so you need to use \texttt{-I xindy} \emph{not} \texttt{-I tex}. @@ -1163,7 +1204,7 @@ you use \gls{xindy} explicitly instead of using \tableref{tab:makeglossariesCmds}. -\subsubsection{Using makeindex explicitly} +\subsection{Using makeindex explicitly} \label{sec:makeindexapp} If you want to use \gls{makeindex} explicitly, you must @@ -1213,7 +1254,8 @@ you use \gls*{makeindex} explicitly instead of using \tableref{tab:makeglossariesCmds}. -\subsubsection{Note to Front-End and Script Developers} +\subsection{Note to Front-End and Script Developers} +\label{sec:notedev} The information needed to determine whether to use \gls{xindy} or \gls{makeindex} and the information needed to call those @@ -1267,12 +1309,12 @@ is the encoding (e.g.\ \texttt{utf8}). These commands are omitted if \gls{makeindex} should be used. -\section{Package Options} +\chapter{Package Options} \label{sec:pkgopts} This section describes the available \styfmt{glossaries} package options. -\subsection{General Options} +\section{General Options} \label{sec:pkgopts-general} \begin{description} @@ -1336,8 +1378,8 @@ If you want to use \TeX's \ics{write18} mechanism to call document to avoid rewriting the files. For example: \begin{verbatim} \glswritefiles -\write18{makeindex -s \istfilename\space -t \jobname.glg --o \jobname.gls \jobname} +\write18{makeindex -s \istfilename\space +-t \jobname.glg -o \jobname.gls \jobname} \let\glswritefiles\relax \end{verbatim} \end{important} @@ -1374,9 +1416,15 @@ whether each term has a hyperlink on \firstuse. The default is unless explicitly suppressed using starred versions of commands such as \ics{gls*}). +\item[\pkgopt{savenumberlist}] This is a boolean option that +specifies whether or not to gather and store the \gls{numberlist} +for each entry. The default is \pkgopt[false]{savenumberlist}. (See +\ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} in +\sectionref{sec:glsnolink}.) + \end{description} -\subsection{Sectioning and TOC Options} +\section{Sectioning, Headings and TOC Options} \label{sec:pkgopts-sec} \begin{description} @@ -1436,15 +1484,20 @@ or to prevent it from changing the headers: \begin{verbatim} \renewcommand{\glossarymark}[1]{} \end{verbatim} +If you want \cs{glossarymark} to use \cs{MakeUppercase} in the header, use the +\pkgopt{ucmark} option described below. Occasionally you may find that another package defines -\cs{cleardoublepage} when it is not required. This may cause an +\linebreak\cs{cleardoublepage} when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining \ics{glsclearpage}: \begin{verbatim} \renewcommand*{\glsclearpage}{\clearpage} \end{verbatim} +\item[\pkgopt{ucmark}] This is a boolean option (default: \pkgopt[false]{ucmark}). If +set, \ics{glossarymark} is defined to use \ics{MakeUppercase}. + \item[\pkgopt{numberedsection}] The glossaries are placed in unnumbered sectional units by default, but this can be changed using \pkgopt{numberedsection}. This option can take @@ -1491,16 +1544,18 @@ For example: will add \texttt{glo:} to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows: \begin{verbatim} -The list of acronyms is in section~\ref{glo:\acronymtype}. +The list of acronyms is in +section~\ref{glo:\acronymtype}. \end{verbatim} Or, if you are undecided on a prefix: \begin{verbatim} -The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. +The list of acronyms is in +section~\ref{\glsautoprefix\acronymtype}. \end{verbatim} \end{description} -\subsection{Glossary Appearance Options} +\section{Glossary Appearance Options} \label{sec:pkgopts-printglos} \begin{description} @@ -1530,16 +1585,18 @@ option will automatically set \pkgopt[true]{entrycounter} and the \ctr{glossaryentry} counter will be reset every time \meta{value} is incremented. +\DescribeMacro{\glsresetentrycounter} \begin{important} The \ctr{glossaryentry} counter isn't automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by \pkgopt{counterwithin} is the same as the -counter used in the glossary's sectioning command. If you want -the counter reset at the start of each glossary, you can redefine -\ics{glossarypreamble} so that it sets \ctr{glossaryentry} to zero: +counter used in the glossary's sectioning command. If you want the +counter reset at the start of each glossary, you can redefine +\ics{glossarypreamble} to use \cs{glsresetentrycounter}, which sets +\ctr{glossaryentry} to zero: \begin{verbatim} \renewcommand{\glossarypreamble}{% - \setcounter{glossaryentry}{0}% + \glsresetentrycounter } \end{verbatim} \end{important} @@ -1553,7 +1610,7 @@ The counter is reset with each main (level~0) entry. Note that this package option is independent of \pkgopt{entrycounter}. You can reference the number within the document using \ics{glsrefentry}\marg{label} where \meta{label} is the label -associated with the sub-entry. (See above.) +associated with the sub-entry. \item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. (Default is \pkgopt[list]{style}.) Its value should be the name of @@ -1592,13 +1649,17 @@ you use this option, you won't be able to use any of the glossary styles defined in the \styfmt{glossary-tree} package. \item[\pkgopt{nostyles}] This prevents all the predefined styles -from being loaded. This option is provided in the event that the -user has custom styles that are not dependent on the styles -provided by the \styfmt{glossaries} package. Note that if you use -this option, you can't use the \pkgopt{style} package option. Instead -you must either use \ics{glossarystyle}\marg{style} or -the \gloskey[printglossary]{style} key in the -optional argument to \ics{printglossary}. +from being loaded. If you use this option, you need to load a +glossary style package (such as \sty{glossary-mcols}). Also if you +use this option, you can't use the \pkgopt{style} package option. +Instead you must either use \ics{glossarystyle}\marg{style} or the +\gloskey[printglossary]{style} key in the optional argument to +\ics{printglossary}. Example: +\begin{verbatim} +\usepackage[nostyles]{glossaries} +\usepackage{glossary-mcols} +\glossarystyle{mcoltree} +\end{verbatim} \item[\pkgopt{nonumberlist}] This option will suppress the associated \glspl{numberlist} in the glossaries (see also @@ -1620,7 +1681,7 @@ the default counter to use in the \glspl{numberlist} \end{description} -\subsection{Sorting Options} +\section{Sorting Options} \label{sec:pkgopts-sort} \begin{description} @@ -1684,7 +1745,7 @@ with the \styfmt{glossaries} package. \end{description} -\subsection{Acronym Options} +\section{Acronym Options} \label{sec:pkgopts-acronym} \begin{description} @@ -1751,7 +1812,7 @@ for acronyms. See \sectionref{sec:acronyms} for further details. \end{description} -\section{Setting Up} +\chapter{Setting Up} \label{sec:setup} The command @@ -1826,7 +1887,7 @@ formats, then do: See \sectionref{sec:numberlists} for further information about \glspl{numberlist}. -\section{Defining Glossary Entries} +\chapter{Defining Glossary Entries} \label{sec:newglosentry} All glossary entries must be defined before they are used, so it is @@ -2009,7 +2070,9 @@ supply the \gloskey{sort} key if you are using \gls{makeindex} whereas \gls{xindy} is usually able to sort accented letters correctly. -\subsection{Plurals} +\section{Plurals} +\label{sec: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 @@ -2057,7 +2120,43 @@ form plurals by simply appending a suffix, all the plural forms must be specified using the \gloskey{plural} key (and the \gloskey{firstplural} key where necessary). -\subsection{Sub-Entries} +\section{Other Grammatical Constructs} +\label{sec:grammar} + +You can use the six user keys to provide alternatives, such as +participles. For example: +\begin{verbatim} +\let\glsing\glsuseri +\let\glsd\glsuserii + +\newcommand*{\ingkey}{user1} +\newcommand*{\edkey}{user2} + +\newcommand*{\newterm}[3][]{% + \newglossaryentry{#2}{% + name={#2},% + description={#3},% + \edkey={#2ed},% + \ingkey={#2ing},#1% + }% +} +\end{verbatim} +With the above definitions, I can now define terms like this: +\begin{verbatim} +\newterm{play}{to take part in activities for enjoyment} +\newterm[\edkey={ran},\ingkey={running}]{run}{to move fast using +the legs} +\end{verbatim} +and use them in the text: +\begin{verbatim} +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. +\end{verbatim} + +\section{Sub-Entries} \label{sec:subentries} As from version 1.17, it is possible to specify sub-entries. These @@ -2081,7 +2180,8 @@ If the parent entry is not referenced in the document, it will not have a \gls{numberlist}. Note also that \gls{makeindex} has a restriction on the maximum sub-entry depth. -\subsubsection{Hierarchical Categories} +\subsection{Hierarchical Categories} +\label{sec:hierarchical} To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the @@ -2105,7 +2205,8 @@ description terminator. I can now define my sub-entries as follows: \begin{verbatim} \newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi}, -description={ratio of the circumference of a circle to the diameter}, +description={ratio of the circumference of a circle to +the diameter}, parent=greekletter} \newglossaryentry{C}{name={\ensuremath{C}},sort={C}, @@ -2114,7 +2215,8 @@ parent=romanletter} \end{verbatim} -\subsubsection{Homographs} +\subsection{Homographs} +\label{sec:homographs} Sub-entries that have the same name as the parent entry, don't need to have the \gloskey{name} key. For example, the word \qt{glossary} @@ -2159,20 +2261,21 @@ have different plurals, they will need to be specified. For example: \newglossaryentry{bravo}{name={bravo}, description={\nopostdesc}} -\newglossaryentry{bravocry}{description={cry of approval (pl.\ bravos)}, +\newglossaryentry{bravocry}{description={cry of approval +(pl.\ bravos)}, sort={1}, plural={bravos}, parent=bravo} -\newglossaryentry{bravoruffian}{description={hired ruffian or -killer (pl.\ bravoes)}, +\newglossaryentry{bravoruffian}{description={hired +ruffian or killer (pl.\ bravoes)}, sort={2}, plural={bravoes}, parent=bravo} \end{verbatim} -\subsection{Loading Entries From a File} +\section{Loading Entries From a File} \label{sec:loadglsentries} You can store all your glossary entry definitions in another @@ -2234,7 +2337,8 @@ there are two possible solutions to this problem: \item Change \texttt{myacronyms.tex} so that entries are defined in the form: \begin{verbatim} -\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym} +\newacronym[type=\glsdefaulttype]{aca}{aca}{a +contrived acronym} \end{verbatim} and do: \begin{verbatim} @@ -2255,7 +2359,34 @@ in the text will appear in the relevant glossaries. Note also that \cs{loadglsentries} may only be used in the preamble. -\section{Number lists} +\section{Moving Entries to Another Glossary} +\label{sec:moveentry} + +As from version~3.02, you can move an entry from one glossary to +another using: +\begin{definition}[\DescribeMacro{\glsmoveentry}] +\cs{glsmoveentry}\marg{label}\marg{target glossary label} +\end{definition} +where \meta{label} is the unique label identifying the required +entry and \meta{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 so common it doesn't need listing.) + +\begin{important} +If you move an entry to an undefined glossary and you have +hyperlinked entries, the link will point to an undefined target. +Also, you will get warnings about no file defined for that glossary +(unless you use the \pkgopt{nowarn} package option). Unpredictable +results may occur if you move an entry to a different glossary from +its parent or children. +\end{important} + +\chapter{Number lists} \label{sec:numberlists} Each entry in the glossary has an associated \gls{numberlist}. @@ -2316,7 +2447,7 @@ used. \end{important} -\section{Links to Glossary Entries} +\chapter{Links to Glossary Entries} \label{sec:glslink} Once you have defined a glossary entry using \ics{newglossaryentry}, @@ -2344,8 +2475,8 @@ package. Instead, use one of the commands listed in alternative via the optional argument to the sectioning/caption command. Examples: \begin{verbatim} -\section{An overview of \glsentrytext{perl}} -\section[An overview of Perl]{An overview of \gls{perl}} +\chapter{An overview of \glsentrytext{perl}} +\chapter[An overview of Perl]{An overview of \gls{perl}} \end{verbatim} The way the \gls{linktext} is displayed depends on @@ -2552,7 +2683,8 @@ are using \sty{hyperref} as it can affect the spacing of subscripts and superscripts. For example, suppose you have defined the following entry: \begin{verbatim} -\newglossaryentry{Falpha}{name={F_\alpha},description=sample} +\newglossaryentry{Falpha}{name={F_\alpha}, +description=sample} \end{verbatim} and later you use it in math mode: \begin{verbatim} @@ -2787,7 +2919,7 @@ the hyperlink. Similarly for the other user keys: \cs{GLSuservi}\oarg{options}\marg{text}\oarg{insert} \end{definition} -\subsection{Changing the format of the link text} +\section{Changing the format of the link text} \label{sec:glsdisplay} The format of the \gls{linktext} for \ics{gls}, \ics{glspl} @@ -2823,7 +2955,8 @@ formatting commands, it's best to define a robust version that deals with all the formatting. For example, suppose you want the text to appear in bold italic, it's best to do something like: \begin{verbatim} -\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries #1}} +\DeclareRobustCommand{\textbfit}[1]{\emph{\bfseries +#1}} \renewcommand{\glsdisplay}[4]{\textbfit{#1#4}} \end{verbatim} See the \sty{mfirstuc} documentation for further details on the @@ -2919,7 +3052,8 @@ to appear in the \gls{linktext}, you will have to disable the \glsation{sanitize} of these keys and protect fragile commands. -\subsection{Enabling and disabling hyperlinks to glossary entries} +\section{Enabling and disabling hyperlinks to glossary entries} +\label{sec:disablehyperlinks} If you load the \sty{hyperref} or \sty{html} packages prior to loading the \styfmt{glossaries} package, commands such as \ics{glslink} @@ -2944,7 +3078,7 @@ affects commands that recognise the \firstuseflag, for example \ics{gls}, \ics{glspl} and \ics{glsdisp} but not \ics{glslink}. -\section{Adding an Entry to the Glossary Without Generating Text} +\chapter{Adding an Entry to the Glossary Without Generating Text} \label{sec:glsadd} It is possible to add a line in the glossary file without @@ -3022,7 +3156,7 @@ You can then define a new dual entry: Now you can reference the acronym with \verb|\gls{svm}| or you can reference the entry in the main glossary with \verb|\gls{main-svm}|. -\section{Cross-Referencing Entries} +\chapter{Cross-Referencing Entries} \label{sec:crossref} There are several ways of cross-referencing entries in the @@ -3060,7 +3194,8 @@ description={firm, round fruit. See also \item As described in \sectionref{sec:newglosentry}, you can use the \gloskey{see} key when you define the entry. For example: \begin{verbatim} -\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, +\newglossaryentry{MaclaurinSeries}{name={Maclaurin +series}, description={Series expansion}, see={TaylorsTheorem}} \end{verbatim} @@ -3074,7 +3209,8 @@ The \qt{see} tag is produce using \ics{seename}, but can be overridden in specific instances using square brackets at the start of the \gloskey{see} value. For example: \begin{verbatim} -\newglossaryentry{MaclaurinSeries}{name={Maclaurin series}, +\newglossaryentry{MaclaurinSeries}{name={Maclaurin +series}, description={Series expansion}, see=[see also]{TaylorsTheorem}} \end{verbatim} @@ -3108,7 +3244,8 @@ just use the \gloskey{see} key instead of \ics{glssee}, you can automatically activate the \gls*{numberlist} using the \pkgopt{seeautonumberlist} package option. -\subsection{Customising Cross-reference Text} +\section{Customising Cross-reference Text} +\label{sec:customxr} When you use either the \gloskey{see} key or the command \cs{glssee}, the cross-referencing information will be typeset in the @@ -3129,7 +3266,8 @@ both \gloskey{see} and \cs{glssee} explicitly write \texttt[\cs{seename}\texttt] in the output file if no optional argument is given.} \begin{verbatim} -\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1} \glsseelist{#2}} +\renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1} + \glsseelist{#2}} \end{verbatim} @@ -3143,8 +3281,8 @@ or (for the last pair) \begin{definition}[\DescribeMacro{\glsseelastsep}] \cs{glsseelastsep} \end{definition} -These default to ",\space" and -\cs{space}\ics{andname}\cs{space} respectively. The list entry text +These default to ``",\space"'' and +``\cs{space}\ics{andname}\cs{space}'' respectively. The list entry text is displayed using: \begin{definition}[\DescribeMacro{\glsseeitemformat}] \cs{glsseeitemformat}\marg{label} @@ -3154,7 +3292,8 @@ versions before 3.0, \cs{glsentryname} was used, but this can cause problems when the \gloskey{name} key is \glsd{sanitize}.} For example, to make the cross-referenced list use small caps: \begin{verbatim} -\renewcommand{\glsseeitemformat}[1]{\textsc{\glsentrytext{#1}}} +\renewcommand{\glsseeitemformat}[1]{% + \textsc{\glsentrytext{#1}}} \end{verbatim} \begin{important} @@ -3169,7 +3308,7 @@ Some information (see also \end{verbatim} \end{important} -\section{Using Glossary Terms Without Links} +\chapter{Using Glossary Terms Without Links} \label{sec:glsnolink} The commands described in this section display entry details without @@ -3313,11 +3452,43 @@ described in \sectionref{sec:glslink} or \sectionref{sec:glsadd} otherwise you will end up with an undefined link. \end{important} +The next two commands are only available with the +\pkgopt{savenumberlist} package option: +\begin{definition}[\DescribeMacro{\glsentrynumberlist}] +\cs{glsentrynumberlist}\marg{label} +\end{definition} +\begin{definition}[\DescribeMacro{\glsdisplaynumberlist}] +\cs{glsdisplaynumberlist}\marg{label} +\end{definition} +Both display the \gls{numberlist} for the entry given by +\meta{label} and require a run of \gls{makeglossaries} (or +\gls{xindy} or \gls{makeindex}) followed by one or two runs of +\LaTeX. The first command, \cs{glsentrynumberlist}, simply displays +the number list as is. The second command, +\linebreak\cs{glsdisplaynumberlist}, formats the list using: +\begin{definition}[\DescribeMacro{\glsnumlistsep}] +\cs{glsnumlistsep} +\end{definition} +as the separator between all but the last two elements and +\begin{definition}[\DescribeMacro{\glsnumlistlastsep}] +\cs{glsnumlistlastsep} +\end{definition} +between the final two elements. The defaults are +\verb*|, | and \verb*| \& |, respectively. + +\begin{important} +\cs{glsdisplaynumberlist} is fairly experimental. It only works when +the default counter format is used (that is, when the +\gloskey[glslink]{format} key is set to \texttt{glsnumberformat}). +This command also doesn't work with \sty{hyperref}. If you try using +it with that package, \cs{glsentrynumberlist} will be used instead. +\end{important} + For further information see \ifpdf section~\ref*{sec:code:glsnolink} \fi \qt{Displaying entry details without adding information to the glossary} in the documented code (\texttt{glossaries.pdf}). -\section{Displaying a glossary} +\chapter{Displaying a glossary} \label{sec:printglossary} The command @@ -3370,7 +3541,7 @@ option, described in \sectionref{sec:pkgopts-sec}. \item[{\gloskey[printglossary]{nonumberlist}}] This is a boolean key. If true (\verb|nonumberlist=true|) the numberlist is suppressed -for this glossary. If false (\verb|nonumberlist=false|) the +for this glossary. If false \linebreak(\verb|nonumberlist=false|) the numberlist is displayed for this glossary. If no value is supplied, true is assumed. @@ -3379,7 +3550,7 @@ true is assumed. By default, the glossary is started either by \ics{chapter*} or by \ics{section*}, depending on whether or not \ics{chapter} is defined. This can be overridden by the \pkgopt{section} package option or the -\ics{setglossarysection} command. Numbered sectional units can be +\linebreak\ics{setglossarysection} command. Numbered sectional units can be obtained using the \pkgopt{numberedsection} package option. Each glossary sets the page header via the command \ics{glossarymark}. If this mechanism is unsuitable for your chosen class file or page @@ -3394,26 +3565,26 @@ title and before the main body of the glossary) by redefining \end{definition} For example: \begin{verbatim} -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.} +\renewcommand{\glossarypreamble}{Numbers in italic +indicate primary definitions.} \end{verbatim} This needs to be done before the glossary is displayed using -\cs{printglossaries} or \cs{printglossary}. Note that if you +\linebreak\cs{printglossaries} or \cs{printglossary}. Note that if you want a different preamble for each glossary, you will need to use a separate \cs{printglossary} for each glossary and change the definition of \cs{glossarypreamble} between each glossary. For example: \begin{verbatim} -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.} +\renewcommand{\glossarypreamble}{Numbers in italic +indicate primary definitions.} \printglossary \renewcommand{\glossarypreamble}{} \printglossary[type=acronym] \end{verbatim} Alternatively, you can do something like: \begin{verbatim} -\renewcommand{\glossarypreamble}{Numbers in italic indicate -primary definitions.\gdef\glossarypreamble{}} +\renewcommand{\glossarypreamble}{Numbers in italic +indicate primary definitions.\gdef\glossarypreamble{}} \printglossaries \end{verbatim} which will print the preamble text for the first glossary and @@ -3435,7 +3606,7 @@ but after the glossary you want to switch back to one column mode, you could do: \begin{verbatim} \renewcommand*{\glossarysection}[2][]{% - \twocolumn[{\section*{#2}}]% + \twocolumn[{\chapter*{#2}}]% \setlength\glsdescwidth{0.6\linewidth}% \glossarymark{\glossarytoctitle}% } @@ -3466,7 +3637,7 @@ medium weight small caps, then you can do: \end{verbatim} -\section{Xindy} +\chapter{Xindy} \label{sec:xindy} If you want to use \gls{xindy} to sort the glossary, you @@ -3513,7 +3684,9 @@ style file from being overwritten by the \styfmt{glossaries} package. For additional information about \gls*{xindy}, read the \gls*{xindy} documentation. -\subsection{Language and Encodings} +\section{Language and Encodings} +\label{sec:langenc} + When you use \gls{xindy}, you need to specify the language and encoding used (unless you have written your own custom \gls*{xindy} style file that defines the relevant alphabet @@ -3570,7 +3743,7 @@ need to remember to set the language and encoding using the \end{important} -\subsection{Locations and Number lists} +\section{Locations and Number lists} \label{sec:xindyloc} If you use \pkgopt{xindy}, the \styfmt{glossaries} package needs to @@ -3622,7 +3795,7 @@ you need to add a location style in the appropriate format using \end{definition} where \meta{name} is the name of the format and \meta{definition} is the \gls{xindy} definition. The optional argument \meta{prefix-location} -is needed if \cs{theH}\meta{counter} either isn't defined or is +is needed if \linebreak\cs{theH}\meta{counter} either isn't defined or is different from \cs{the}\meta{counter}. \begin{important} @@ -3787,7 +3960,8 @@ is used or if \ics{makeglossaries} is omitted. See \sectionref{sec:numberlists} for further details. -\subsection{Glossary Groups} +\section{Glossary Groups} +\label{sec:groups} The glossary is divided into groups according to the first letter of the sort key. The \styfmt{glossaries} package also adds @@ -3816,12 +3990,12 @@ Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if \end{important} -\section{Defining New Glossaries} +\chapter{Defining New Glossaries} \label{sec:newglossary} A new glossary can be defined using: \begin{definition}[\DescribeMacro{\newglossary}] -\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\oarg{counter} +\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\linebreak\oarg{counter} \end{definition} where \meta{name} is the label to assign to this glossary. The arguments \meta{in-ext} and \meta{out-ext} specify the extensions to @@ -3860,7 +4034,7 @@ ensure that the relevant output files are opened. \end{important} -\section{Acronyms} +\chapter{Acronyms} \label{sec:acronyms} You may have noticed in \sectionref{sec:newglosentry} that when you @@ -4043,7 +4217,7 @@ variants: \begin{definition}[\DescribeMacro{\Acrlong}] \cs{Acrlong}\oarg{options}\marg{label}\oarg{insert} \end{definition} -\begin{definition}[\DescribeMacro{\ACRshort}] +\begin{definition}[\DescribeMacro{\ACRlong}] \cs{ACRlong}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -4143,7 +4317,8 @@ using: \cs{Glsentryfullpl}\marg{label} \end{definition} -\subsection{Predefined Acronym Styles} +\section{Predefined Acronym Styles} +\label{sec:predefinedacrstyles} Some of the acronym-related package options may be combined. Listed below are the effects of different combinations. If you use an @@ -4263,7 +4438,8 @@ while subsequent use displays the entry as: Entries will be sorted according to the short form. \end{description} -\subsection{Displaying the List of Acronyms} +\section{Displaying the List of Acronyms} +\label{sec:disploa} The list of acronyms is just like any other type of glossary and can be displayed on its own using @@ -4340,7 +4516,7 @@ None of the above& \end{center} \end{table} -\subsection{Defining A Custom Acronym Style} +\section{Defining A Custom Acronym Style} \label{sec:customacronym} You may find that the predefined acronyms styles that come with the @@ -4368,7 +4544,7 @@ This is used to set up the display style for the glossary given by and \ics{defglsdisplay}. Once you have redefined \cs{CustomAcronymFields} and -\cs{SetCustomDisplayStyle}, you must then switch to this style using +\linebreak\cs{SetCustomDisplayStyle}, you must then switch to this style using \begin{definition}[\DescribeMacro{\SetCustomStyle}] \cs{SetCustomStyle} \end{definition} @@ -4452,18 +4628,19 @@ the argument of \ics{SetCustomDisplayStyle}, and \verb|##1|, \ldots, \ics{glsdisplay}. Now that I've redefined \ics{CustomAcronymFields} and -\ics{SetCustomDisplayStyle}, I can set this style using +\linebreak\ics{SetCustomDisplayStyle}, I can set this style using \begin{verbatim} \SetCustomStyle \end{verbatim} and now I can define my acronyms: \begin{verbatim} -\newacronym[description={set of tags for use in developing hypertext -documents}]{html}{html}{Hyper Text Markup Language} +\newacronym[description={set of tags for use in +developing hypertext documents}]{html}{html}{Hyper +Text Markup Language} -\newacronym[description={language used to describe the layout of a -document written in a markup language}]{css}{css}{Cascading Style -Sheet} +\newacronym[description={language used to describe the +layout of a document written in a markup language}]{css} +{css}{Cascading Style Sheet} \end{verbatim} Note that since I've used the description in the main body of the @@ -4476,20 +4653,22 @@ that displays the symbol. Therefore, in my preamble I have: \begin{verbatim} \usepackage[colorlinks]{hyperref} -\usepackage[acronym, % create list of acronyms - nomain, % don't need main glossary for this example - style=tree, % need a style that displays the symbol - hyperfirst=false,% don't hyperlink first use - sanitize=none % switch off sanitization as description - % will be used in the main text - ]{glossaries} +\usepackage + [acronym, % create list of acronyms + nomain, % don't need main glossary for this example + style=tree, % need a style that displays the symbol + hyperfirst=false,% don't hyperlink first use + sanitize=none % switch off sanitization as description + % will be used in the main text + ]{glossaries} \end{verbatim} Note that I haven't used the \pkgopt{description} or \pkgopt{footnote} package options. -\subsection{Upgrading From the glossary Package} +\section{Upgrading From the glossary Package} \label{sec:oldacronym} + Users of the obsolete \sty{glossary} package may recall that the syntax used to define new acronyms has changed with the replacement \styfmt{glossaries} package. In addition, the old @@ -4566,7 +4745,7 @@ optional argument from being recognised. -\section{Unsetting and Resetting Entry Flags} +\chapter{Unsetting and Resetting Entry Flags} \label{sec:glsunset} When using \ics{gls}, \ics{glspl} and their uppercase variants it is @@ -4619,7 +4798,7 @@ entry has been used, \meta{true part} will be done, otherwise \meta{false part} will be done. -\section{Glossary Styles} +\chapter{Glossary Styles} \label{sec:styles} The \styfmt{glossaries} package comes with some pre-defined glossary styles. Note that the styles are suited to different @@ -4666,10 +4845,11 @@ be displayed.} \ttfamily super4col* & 1 & \tick & \tick \\ \ttfamily altsuper*4col* & 1 & \tick & \tick \\ \ttfamily super* & 1 & \tick & \\ -\ttfamily index* & 2 & & \tick\\ +\ttfamily *index* & 2 & & \tick\\ \ttfamily treenoname* & --- & \tick & \tick\\ -\ttfamily tree* & --- & & \tick\\ -\ttfamily alttree* & --- & & \tick +\ttfamily *tree* & --- & & \tick\\ +\ttfamily *alttree* & --- & & \tick\\ +\ttfamily inline & 1 & \tick & \end{tabular} \par \end{table} @@ -4738,7 +4918,7 @@ a comma) you will need to redefine \cs{glspostdescription} before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \ics{nopostdesc} in the entry's description. -\subsection{List Styles} +\section{List Styles} \label{sec:liststyles} The styles described in this section are all defined in the package @@ -4813,7 +4993,7 @@ the same manner as \glostyle{listdotted}. \end{description} -\subsection{Longtable Styles} +\section{Longtable Styles} \label{sec:longstyles} The styles described in this section are all defined in the package @@ -4891,7 +5071,7 @@ around it. \glostyle{long4col} but allows multi-line descriptions and page lists. The width of the description column is governed by the length \ics{glsdescwidth} and the width of the page list column is -governed by the length \ics{glspagelistwidth}. The widths of the +governed by the length \linebreak\ics{glspagelistwidth}. The widths of the name and symbol columns are governed by the widest entry in the given column. @@ -4904,12 +5084,12 @@ page lists. page lists. \item[altlong4colheaderborder] The \glostyle{altlong4colheaderborder} -style is like \glostyle{long4colheaderborder} but allows multi-line +style is like \linebreak\glostyle{long4colheaderborder} but allows multi-line descriptions and page lists. \end{description} -\subsection{Longtable Styles (Ragged Right)} +\section{Longtable Styles (Ragged Right)} \label{sec:longraggedstyles} The styles described in this section are all defined in the package @@ -4996,7 +5176,7 @@ lines around it. \end{description} -\subsection{Supertabular Styles} +\section{Supertabular Styles} \label{sec:superstyles} The styles described in this section are all defined in the package @@ -5051,7 +5231,7 @@ lines around it. \glostyle{super3col} but has a header row. \item[super3colheaderborder] The \glostyle{super3colheaderborder} style -is like \glostyle{super3colheader} but has horizontal and vertical +is like the \linebreak\glostyle{super3colheader} style but has horizontal and vertical lines around it. \item[super4col] The \glostyle{super4col} style is like @@ -5069,7 +5249,7 @@ lines around it. \glostyle{super4col} but has a header row. \item[super4colheaderborder] The \glostyle{super4colheaderborder} style -is like \glostyle{super4colheader} but has horizontal and vertical +is like the \linebreak\glostyle{super4colheader} style but has horizontal and vertical lines around it. \item[altsuper4col] The \glostyle{altsuper4col} style is like @@ -5095,7 +5275,7 @@ descriptions and page lists. \end{description} -\subsection{Supertabular Styles (Ragged Right)} +\section{Supertabular Styles (Ragged Right)} \label{sec:superraggedstyles} The styles described in this section are all defined in the package @@ -5183,7 +5363,7 @@ lines around it. \end{description} -\subsection{Tree-Like Styles} +\section{Tree-Like Styles} \label{sec:treestyles} The styles described in this section are all defined in the package @@ -5270,7 +5450,112 @@ groups. The navigation line is the same as that for \end{description} -\section{Defining your own glossary style} +\section{Multicols Style} +\label{sec:mcolstyles} + +The \sty{glossary-mcols} package provides tree-like styles that are +in the \env{multicols} environment (defined by the \sty{multicol} +package). The style names are as their analogous tree styles (as +defined in \sectionref{sec:treestyles}) but are prefixed with ``mcol''. +For example, the \glostyle{mcolindex} style is essentially the +\glostyle{index} style but put in a \env{multicols} environment. +For the complete list, see \tableref{tab:mcols}. + +\begin{important} +Note that \sty{glossary-mcols} is not loaded by \styfmt{glossaries}. If +you want to use any of the multicol styles in that package you need +to load it explicitly with \cs{usepackage} and set the required glossary +style using \ics{glossarystyle}. +\end{important} + +The default number of columns is 2, but can be changed by redefining +\begin{definition}[\DescribeMacro{\glsmcols}] +\cs{glsmcols} +\end{definition} +to the required number. For example, for a three column glossary: +\begin{verbatim} +\usepackage{glossary-mcols} +\renewcommand*{\glsmcols}{3} +\glossarystyle{mcolindex} +\end{verbatim} + +\begin{table}[htbp] +\caption{Multicolumn Styles} +\label{tab:mcols} +\centering +\begin{tabular}{ll} +\bfseries +\sty{glossary-mcols} Style & +\bfseries +Analogous Tree Style\\ +\glostyle{mcolindex} & \glostyle{index}\\ +\glostyle{mcolindexgroup} & \glostyle{indexgroup}\\ +\glostyle{mcolindexhypergroup} & \glostyle{indexhypergroup}\\ +\glostyle{mcoltree} & \glostyle{tree}\\ +\glostyle{mcoltreegroup} & \glostyle{treegroup}\\ +\glostyle{mcoltreehypergroup} & \glostyle{treehypergroup}\\ +\glostyle{mcoltreenoname} & \glostyle{treenoname}\\ +\glostyle{mcoltreenonamegroup} & \glostyle{treenonamegroup}\\ +\glostyle{mcoltreenonamehypergroup} & \glostyle{treenonamehypergroup}\\ +\glostyle{mcolalttree} & \glostyle{alttree}\\ +\glostyle{mcolalttreegroup} & \glostyle{alttreegroup}\\ +\glostyle{mcolalttreehypergroup} & \glostyle{alttreehypergroup} +\end{tabular} +\end{table} + +\section{In-Line Style} +\label{sec:inline} + +This section covers the \sty{glossary-inline} package that supplies +the \glostyle{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 \gls{numberlist}. + +You will most likely need to redefine \ics{glossarysection} with +this style. For example, suppose you are required to have your +glossaries and list of acronyms in a footnote, you can do: +\begin{verbatim} + \usepackage{glossary-inline} + + \renewcommand*{\glossarysection}[2][]{\textbf{#1}: } + \glossarystyle{inline} +\end{verbatim} + +\begin{important} +Note that you need to include \sty{glossary-inline} with +\cs{usepackage} as it's not automatically included by the +\styfmt{glossaries} package and then set the style using +\ics{glossarystyle}. +\end{important} + +Where you need to include your glossaries as a footnote you can do: +\begin{verbatim} +\footnote{\printglossaries} +\end{verbatim} + +The \glostyle{inline} style is governed by the following: +\begin{definition}[\DescribeMacro{\glsinlineseparator}] +\ics{glsinlineseparator} +\end{definition} +This defaults to ``\texttt{\glsinlineseparator}'' and is used between +main (i.e.\ level~0) entries. +\begin{definition}[\DescribeMacro{\glsinlinesubseparator}] +\ics{glsinlinesubseparator} +\end{definition} +This defaults to ``\texttt{\glsinlinesubseparator}'' and is used between +sub-entries. +\begin{definition}[\DescribeMacro{\glsinlineparentchildseparator}] +\ics{glsinlineparentchildseparator} +\end{definition} +This defaults to ``\texttt{\glsinlineparentchildseparator}'' and is used between +a parent main entry and its first sub-entry. +\begin{definition}[\DescribeMacro{\glspostinline}] +\ics{glspostinline} +\end{definition} +This defaults to ``\texttt{\glsinlineseparator}'' and is used at the end +of the glossary. + +\chapter{Defining your own glossary style} \label{sec:newglossarystyle} If the predefined styles don't fit your requirements, you can @@ -5452,7 +5737,8 @@ For further details of these commands, see \ifpdf section~\ref*{sec:code:printglos} \fi \qt{Displaying the glossary} in the documented code (\texttt{glossaries.pdf}). -\subsection{Example: creating a completely new style} +\section{Example: creating a completely new style} +\label{sec:exnewstyle} If you want a completely new style, you will need to redefine all of the commands and the environment listed above. @@ -5472,7 +5758,8 @@ at the end. Then you can create this new glossary style, called, say, \begin{verbatim} \newglossarystyle{mylist}{% % put the glossary in the itemize environment: - \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}% + \renewenvironment{theglossary}% + {\begin{itemize}}{\end{itemize}}% % have nothing after \begin{theglossary}: \renewcommand*{\glossaryheader}{}% % have nothing between glossary groups: @@ -5497,8 +5784,9 @@ It also hasn't used \ics{glsentryitem} or \ics{glssubentryitem} so it won't be affected by the \pkgopt{entrycounter}, \pkgopt{counterwithin} or \pkgopt{subentrycounter} package options. -\subsection{Example: creating a new glossary style based on an +\section{Example: creating a new glossary style based on an existing style} +\label{sec:exadaptstyle} If you want to define a new style that is a slightly modified version of an existing style, you can use \ics{glossarystyle} @@ -5511,13 +5799,15 @@ follows: \begin{verbatim} \newglossarystyle{mylist}{% \glossarystyle{list}% base this style on the list style -\renewcommand{\glsgroupskip}{}% make nothing happen between groups +\renewcommand{\glsgroupskip}{}% make nothing happen + % between groups } \end{verbatim} -\subsection{Example: creating a glossary style that uses the +\section{Example: creating a glossary style that uses the \texorpdfstring{\gloskey{user1}}{user1}, \ldots, \texorpdfstring{\gloskey{user6}}{user6} keys} +\label{sec:exuserstyle} Since \ics{glossaryentryfield} and \ics{glossarysubentryfield} provide the label for the entry, it's also possible to access @@ -5566,8 +5856,78 @@ that displays each entry in a \env{longtable} as follows: } \end{verbatim} +\chapter{Utilities} +\label{sec:utilities} + +This section describes some utility commands. Additional commands +can be found in the documented code (glossaries.pdf). + +\begin{definition}[\DescribeMacro{\forallglossaries}] +\cs{forallglossaries}\oarg{glossary list}\marg{cs}\marg{body} +\end{definition} +This iterates through \meta{glossary list}, a comma-separated list +of glossary labels (as supplied when the glossary was defined). +At each iteration \meta{cs} (which must be a control sequence) is +set to the glossary label for the current iteration and \meta{body} +is performed. If \meta{glossary list} is omitted, the default is to +iterate over all glossaries. + +\begin{definition}[\DescribeMacro{\forglsentries}] +\cs{forglsentries}\oarg{glossary label}\marg{cs}\marg{body} +\end{definition} +This iterates through all entries in the glossary given by +\meta{glossary label}. At each iteration \meta{cs} (which must be a +control sequence) is set to the entry label for the current +iteration and \meta{body} is performed. If \meta{glossary label} is +omitted, \ics{glsdefaulttype} (usually the main glossary) is used. + +\begin{definition}[\DescribeMacro{\forallglsentries}] +\cs{forallglsentries}\oarg{glossary list}\marg{cs}\marg{body} +\end{definition} +This is like \cs{forglsentries} but for each glossary in +\meta{glossary list} (a comma-separated list of glossary labels). If +\meta{glossary list} is omitted, the default is the list of all +defined glossaries. At each iteration \meta{cs} is set to the entry +label and \meta{body} is performed. (The current glossary label can +be obtained using \cs{glsentrytype}\marg{cs} within \meta{body}.) + +\begin{definition}[\DescribeMacro{\ifglossaryexists}] +\cs{ifglossaryexists}{\meta{label}}{\meta{true part}}{\meta{false +part}} +\end{definition} +This checks if the glossary given by \meta{label} exists. If it +does \meta{true part} is performed, otherwise \meta{false part}. -\section{Accessibility Support}\label{sec:accsupp} +\begin{definition}[\DescribeMacro{\ifglsentryexists}] +\cs{ifglsentryexists}{\meta{label}}{\meta{true part}}{\meta{false +part}} +\end{definition} +This checks if the glossary entry given by \meta{label} exists. If it +does \meta{true part} is performed, otherwise \meta{false part}. + +\begin{definition}[\DescribeMacro{\ifglsused}] +\cs{ifglsentryexists}{\meta{label}}{\meta{true part}}{\meta{false +part}} +\end{definition} +See \sectionref{sec:glsunset}. + +\begin{definition}[\DescribeMacro{\ifglshaschildren}] +\cs{ifglshaschildren}{\meta{label}}{\meta{true part}}{\meta{false +part}} +\end{definition} +This checks if the glossary entry given by \meta{label} has any +sub-entries. If it does, \meta{true part} is performed, otherwise +\meta{false part}. + +\begin{definition}[\DescribeMacro{\ifglshasparent}] +\cs{ifglshasparent}{\meta{label}}{\meta{true part}}{\meta{false +part}} +\end{definition} +This checks if the glossary entry given by \meta{label} has a parent +entry. If it does, \meta{true part} is performed, otherwise +\meta{false part}. + +\chapter{Accessibility Support}\label{sec:accsupp} Limited accessibility support is provided by the accompanying \sty{glossaries-accsupp} package, but note that this package is experimental and it requires the \sty{accsupp} package @@ -5617,8 +5977,8 @@ the \gloskey{shortplural} key (used by \ics{newacronym}). \end{description} For example: \begin{verbatim} -\newglossaryentry{tex}{name={\TeX},description={Document preparation -language},access={TeX}} +\newglossaryentry{tex}{name={\TeX},description={Document +preparation language},access={TeX}} \end{verbatim} Now \verb|\gls{tex}| will be equivalent to \begin{verbatim} @@ -5631,7 +5991,7 @@ See \ifpdf section~\ref*{sec:code:accsupp} in \fi the documented code (\texttt{glossaries.pdf}) for further details. It is recommended that you also read the \sty{accsupp} documentation. -\section{Troubleshooting} +\chapter{Troubleshooting} \label{sec:trouble} The \styfmt{glossaries} package comes with a minimal file called @@ -5640,7 +6000,7 @@ should be located in the \texttt{samples} subdirectory (folder) of the \styfmt{glossaries} documentation directory. The location varies according to your operating system and \TeX\ installation. For example, on my Linux partition it can be found in -\texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. +\texttt{/usr/local/texlive/2008/texmf-dist\linebreak/doc/latex/glossaries/}. Further information on debugging \LaTeX\ code is available at \url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. @@ -5660,7 +6020,8 @@ package. \item \textbf{Q.} When I use \gls{xindy}, I get the following error message: \begin{verbatim} -ERROR: CHAR: index 0 should be less than the length of the string +ERROR: CHAR: index 0 should be less than the length of +the string \end{verbatim} \textbf{A.} \gls{xindy} discards all commands and braces from the @@ -5728,10 +6089,12 @@ as above. For example to make the acronym emphasized on \item \textbf{Q.} I don't have Perl installed, do I have to use \gls{makeglossaries}? -\textbf{A.} Although it is strongly recommended that you use -\gls{makeglossaries}, you don't have to use it. For further details, -read \sectionref{sec:xindyapp} or \sectionref{sec:makeindexapp}, -depending on whether you want to use \gls{xindy} or \gls{makeindex}. +\textbf{A.} No. Although it is strongly recommended, you don't have to +use \gls{makeglossaries}. If you prefer a GUI application and have +Java installed, you can use \gls{makeglossariesgui} instead. +Otherwise you can just call \gls{makeindex} explicitly (see +\sectionref{sec:makeindexapp}). Note that you can't use \gls{xindy} +if you don't have Perl installed. \item \textbf{Q.} I'm used to using the \styfmt{glossary} package: are there any instructions on migrating from the \sty{glossary} package to the @@ -5835,10 +6198,26 @@ If you want to sort according to order of definition or order of use, use the \pkgopt{sort} package option described in \sectionref{sec:pkgopts-sort}. +\item \textbf{Q.} I get an error when using TeX4HT\index{TeX4HT|hyperpage} with +\styfmt{glossaries}. + +\textbf{A.} TeX4HT seems to have a problem with the glossary styles +that use \ics{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 \cs{indexspace}. For example, if you are +using the \glostyle{list} style, try: +\begin{verbatim} +\renewcommand*{\glsgroupskip}{} +\end{verbatim} +or +\begin{verbatim} +\renewcommand*{\glsgroupskip}{\item[]} +\end{verbatim} + \end{enumerate} \clearpage\phantomsection -\addcontentsline{toc}{section}{Index}\PrintIndex +\addcontentsline{toc}{chapter}{Index}\PrintIndex \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf index b5e5a6ce1d8..88533acf85d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 0aad1ee76de..6902c2084ef 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -1,35 +1,41 @@ - + 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="futr8t-x-x-144">Nicola L.C. Talbot

2011-04-12
-
-
2012-05-21
+
+
-
-

-

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

This document is a brief guide to the glossaries package for + beginners who nd 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?

You need to have the glossaries package installed. You also need to have the following +class="ecss-1095">glossaries package installed. You also need to have the following packages installed: ifthenifthen, xkeyvalxkeyval (at least version 2.5f), xforxfor, amsgenamsgen and etoolbox. You -may also need longtableetoolbox. +You may also need longtable, supertabular and array, depending on what glossary style you -want to use. All these packages can be downloaded from CTAN if you don’t -have them installed. See “Installing things on a (La)TeX System” for further +class="ecss-1095">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 +

In addition, you need an indexing application. The glossaries package is congured +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 nd 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 -xindy, you need to have Perl installed. If you don’t have Perl installed, you can still use +class="ectt-1095">makeindex or xindy. If you want to use makeglossaries or glossaries but you can only use it with makeindex. +class="ectt-1095">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 makeindex.

Top

2 Top

2 Getting Started

The most obvious things to do is to remember to load the glossariesglossaries 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.
+class="ecss-1095">ngerman. +

-

If you want to use xindy

If you want to use xindy rather than makeindexmakeindex to sort the glossaries, you need to specify this in the package options: -

-
+
\usepackage[xindy]{glossaries}

Other package options are described in Package Options in the main glossariesglossaries user manual. -

Next, you need to enable the creation of the various external files that are required +

Next, you need to enable the creation of the various external les that are required by the indexing application. This is done using: -


\makeglossaries

+


\makeglossaries

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}

+href="#top">Top

3 Dening a Term or Symbol

+

You must dene terms or symbols before you can use them in the document. This is +best done in the preamble. Each term is dened using: +


\newglossaryentry{hlabeli}{hsettingsi}

where labelis a unique label used to identify the term. The second argument, +class="futsy-x-x-109">hlabeli 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="futsy-x-x-109">hsettingsi, 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 glossariesDening +Glossary Entries in the main glossaries user manual. The principle keys are namename and descriptiondescription. -

For example, to define the term “electrolyte”: +

For example, to dene 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: +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 -specified using the plural 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 LAToesophagus. Note that in this case, the plural has to be +specied using the plural key since it isn't formed by simply appending the letter +s. +

When you dene terms, it is important to remember that they will be sorted by an +external application that doesn't interpret LATEX commands. XindyXindy is a little more TEX-aware than makeindexmakeindex, 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 \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: +class="ectt-1095">\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 inputencinputenc package and xindyxindy, you can use the encoded character œ rather than \oe and xindyœ 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 rst character must be grouped: -

-
+
\newglossaryentry{elite}{name={\’e}lite,  
description={select group of people},  
sort=elite}

or -

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

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}}}} @@ -484,219 +475,215 @@ example:

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 dened 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{hlabeli}

This prints the term associated with label. Using the example in the previous section, -\gls{oesophagus} will display œsophagus. If the hyperrefhlabeli. 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 glossary. -


\glspl{label}

+


\glspl{hlabeli}

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 +class="futsy-x-x-109">hlabeli, so \glspl{oesophagus} +will display sophagi. Again, the text will be a hyperlink to the relevant entry in the +glossary, if hyperlinks are dened. +

There are also versions that convert the rst character to upper case if you need to start a sentence with a term: -


\Gls{label}

+


\Gls{hlabeli}

and -


\Glspl{label}

+


\Glspl{hlabeli}

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 +

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 glossariesglossaries user manual. -

Don’t use these commands in moving arguments, such as those used by \chapter, +

Don't use these commands in moving arguments, such as those used by \section and \caption.
+class="ectt-1095">\chapter, \section and \caption.

You can, instead, use commands such as -


\glsentrytext{label}

+


\glsentrytext{hlabeli}

See Using Glossary Terms Without Links in the main glossariesglossaries 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: +class="ecss-1095">glossaries package also allows you to dene 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}

There are other options that govern how acronyms appear. For further details, see Acronyms in the main glossariesglossaries user manual. -

Acronyms must be defined before use and are defined using: -


\newacronym{label}{abbrv}{full}

+

Acronyms must be dened before use and are dened using: +


\newacronym{hlabeli}{habbrvi}{hfulli}

where labelis the label identifying the acronym, abbrvis the abbreviated form and -fullis the fully expanded text. For example: +class="futsy-x-x-109">hlabeli is the label identifying the acronym, habbrvi is the abbreviated form +and hfulli 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 +

Once the acronym is dened, 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 +class="ectt-1095">\gls and \glspl. On rst use, the default will display full(abbrv). On subsequent use, only the abbreviation will appear. For +class="futsy-x-x-109">hfulli (habbrvi). 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 rst 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. -
+
A svm was implemented. +
You can reset an acronym so that the next use fully expands it again using: -


\glsreset{label}

+


\glsreset{hlabeli}

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

+

In order to display the sorted list of terms, you rst 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, +class="ectt-1095">\printglossaries won't produce any text the rst 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 +class="futri8t-x-x-109">at least a three step process. -

Suppose your document is called myDoc.tex, then you need to: +

Suppose your document is called myDoc.tex, then you need to:

  1. Build/LATEX your document, either by clicking on an your front-end/text editor or by typing the following at a terminal/command prompt: -
    latex myDoc @@ -712,41 +698,40 @@ class="E">EX your document, either by clicking on an

  2. Run the indexing application on the external file(s) created by the glossariesRun the indexing application on the external le(s) created by the glossaries package. If you have used the xindyxindy package option, you must use xindyxindy, otherwise you must use makeindexmakeindex. The glossariesglossaries 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 + 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 +

    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

    If you don't have Perl installed, you will need to call makeindex or xindyxindy explicitly. This is more complicated and is described in Generating the Associated - Glossary Files in the main glossariesGenerating the + Associated Glossary Files in the main glossaries user manual.

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

The appearance of the glossary depends on the glossary style in use. The default style uses the descriptiondescription 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 -nonumberlistglossaries 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 article on the glossaries package on the LATEX Community’s Know How +class="E">EX Community's Know How section.

Top

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 8c1405bf198..89554556337 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 3b958bed19b..05da3bd3001 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{2011-04-12} +\date{2012-05-21} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} @@ -39,8 +39,8 @@ You need to have the \styfmt{glossaries} package installed. You also need to have the following packages installed: \sty{ifthen}, \sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and \sty{etoolbox}. -You may also need \sty{longtable}, \sty{supertabular} and -\sty{array}, depending on what glossary style you want to use. All +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 \urlfootref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}{\qt{Installing diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index bd5a734528d..7bc46a441a1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -1,51 +1,66 @@ - + 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-144">Nicola L.C. Talbot

2011-04-12
-
-
2012-05-21
+
+
-
-

-

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

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?

-

The glossary package started out as an example in a tutorial, but I decided that I may +

The glossary package started out as an example in a tutorial, but I decided that I may as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and unable to adapt well to the wide variation in glossary styles. Users began making requests for enhancements, but with each enhancement the code became more -complicated and bugs crept in. Each fix in one place seemed to cause another problem -elsewhere. In the end, it was taking up too much of my time to maintain, so I decided -to replace it with a much better designed package. With the new glossaries +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 define irregular plurals; +
  • 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 fixed 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 makeindex or xindy to sort the glossary. Using xindy means - that: - - - -
      -
    • there is much better support for terms containing accented or non-Latin - characters; -
    • -
    • there is support for non-standard location numbers;
    + between using makeindex or xindy to sort the glossary. Using xindy + means that: + + +
      +
    • there is much better support for terms containing accented or + non-Latin characters; +
    • +
    • there is support for non-standard location numbers;
  • -
  • you don’t need to remember to escape makeindex’s special characters as this is +
  • you don't need to remember to escape makeindex's special characters as this is done internally;
  • hierarchical entries and homographs are @@ -319,45 +318,43 @@ href="#fn2x0" id="fn2x0-bk">2
  • acronyms are just another glossary term which helps to maintain consistency;
  • -
  • different acronym styles are supported. +
  • dierent acronym styles are supported.
-

+

-

Top

2

Top

2 Package Options

-

When converting a document that currently uses the obsolete glossary package to the +

When converting a document that currently uses the obsolete glossary package to the replacement glossaries package, it should be fairly obvious that the first thing you need -to do is replace \usepackage{glossary} with \usepackage{glossaries}, however -some of the package options are different, so you may need to change those as -well. Table glossaries package, it should be fairly obvious that the rst thing you +need to do is replace \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="ecss-1095">glossary to the glossaries package options.

-
+
- -


-
Table 1: Mappings from glossary to glossaries package options
+class="ecss-1095">glossary to glossaries package options
-

+

+class="ecsx-1095">glossaries option +class="td11">style=list +class="td11">style=altlist +class="td11">style=long +class="td11">style=longheader +class="td11">style=longborder +class="td11">style=longheaderborder +class="td11">style=long3col +class="td11">style=long3colheader +class="td11">style=long3colborder +class="td11">style=super,header=none,border=none,cols=2 +class="td11">style=superheader +class="td11">style=superborder +class="td11">style=superheaderborder +class="td11">style=super,header=none,border=none,cols=3 +class="td11">style=super3colheader +class="td11">style=super3colborder +class="td11">number=none +class="futsy-x-x-109">hcounter namei +class="td11">toc +class="td11">hypertoc +class="futri8t-x-x-109">no corresponding option +class="td11">section=true +class="futri8t-x-x-109">no corresponding option +class="td11">acronym
glossary option glossary option glossaries option
style=list style=list style=list
style=altlist style=altlist style=altlist
style=long,header=none,border=none,cols=2 style=long
style=long,header=plain,border=none,cols=2 style=longheader
style=long,header=none,border=plain,cols=2 style=longborder
style=long,header=plain,border=plain,cols=2 style=longheaderborder
style=long,header=none,border=none,cols=3 style=long3col
style=long,header=plain,border=none,cols=3 style=long3colheader
style=long,header=none,border=plain,cols=3 style=long3colborder
style=long,header=plain,border=plain,cols=3 style=long3colheaderborder
style=super,header=none,border=none,cols=2 style=super style=super
style=super,header=plain,border=none,cols=2style=superheader
style=super,header=none,border=plain,cols=2style=superborder
style=super,header=plain,border=plain,cols=2style=superheaderborder
style=super,header=none,border=none,cols=3 style=super3col style=super3col
style=super,header=plain,border=none,cols=3style=super3colheader
style=super,header=none,border=plain,cols=3style=super3colborder
style=super,header=plain,border=plain,cols=3style=super3colheaderborder
number=none nonumberlist nonumberlist
number=counter namehcounter namei counter=counter name
toc toc toc
hypertoc toc toc
hyper hyper no corresponding option
section=true section section
section=false section=false no corresponding option
acronym acronym acronym
global global no corresponding option
+class="futri8t-x-x-109">no corresponding option
- -

-
-

Top

3 Defining new glossary types

-

If you have created new glossary types, you will need to replace all instances +


+
+

Top

3 Dening new glossary types

+

If you have created new glossary types, you will need to replace all instances of -


glossary - \newglossarytype


glossary + \newglossarytype[log-ext]{type}{out-ext}{in-ext}[old style list]
[hlog-exti]{htypei}{hout-exti}{hin-exti}[hold style +listi]
-
\newcommand{\typename}{title} -

-
+
\newcommand{\htypeiname}{htitlei} +

+
with -


glossaries - \newglossary


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

-
-in the preamble, and, if the new glossary requires a different 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 +


glossaries + \glossarystyle{new style} -

-
+class="ectt-1095">{hnew stylei} +

+
immediately before the glossary is displayed, or you can specify the style when you display the glossary using \printglossary\printglossary (see below). -

The old style listoptional argument can be converted to new styleusing the +

The hold style listi optional argument can be converted to hnew stylei 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: +

You will need to replace the above two lines with: -

-
+
\newglossary[nlg]{notation}{not}{ntn}{Index of Notation}
-

in the preamble and +

in the preamble and -

-
+
\glossarystyle{longheader}
-

immediately prior to displaying this glossary. Alternatively, you can specify the +

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

-
+
\printglossary[type=notation,style=longheader]
-

-

Note that the glossary title is no longer specified using \glossary-typename (except -for \glossaryname

+

Note that the glossary title is no longer specied using \hglossary-typeiname +(except for \glossaryname and \acronymname) but is instead specified in the titleargument -of \newglossary. The short title which is specified in the glossary package by the -command \shortglossary-namename is now specified using the toctitle key in the -optional argument to \printglossary\acronymname) but is instead specied in the htitlei +argument of \newglossary. The short title which is specied in the glossary package +by the command \shorthglossary-nameiname is now specied using the toctitle key +in the optional argument to \printglossary. -

+

-

Top

4

Top

4 \makeglossary name

-

All instances of \makeglossary name(e.g. \makeglossary\makehglossary namei +

All instances of \makehglossary namei (e.g. \makeglossary and \makeacronym) should -be replaced by the single command \makeglossaries. For example, if your document -contained the following: +class="ectt-1095">\makeacronym) +should be replaced by the single command \makeglossaries. For example, if your +document contained the following: -

-
+
\makeglossary  
\makeacronym
-

then you should replace both lines with the single line: +

then you should replace both lines with the single line: -

-
+
\makeglossaries
-

-

+

+

-

Top

5

Top

5 Storing glossary information

-

With the old glossary package you could optionally store glossary information for later +

With the old glossary package you could optionally store glossary information for later use, or you could simply use \glossary\glossary whenever you wanted to add information to the glossary. With the new glossaries package, the latter option is no longer +class="ecss-1095">glossaries package, the latter option is no longer available.3 If you have stored all the glossary information using \storeglosentry\storeglosentry, then you will need to convert these commands into the equivalent \newglossaryentry. If you have -only used \glossary\newglossaryentry. If you +have only used \glossary, then see 6.4 §6.4 \glossary. -

Substitute all instances of -


glossary - \storeglosentry\glossary. +

Substitute all instances of +


glossary + \storeglosentry{label}{gls-entry} -

-
+class="ectt-1095">{hlabeli}{hgls-entryi} +

+
with -


glossaries - \newglossaryentry


glossaries + \newglossaryentry{label}{gls-entry} -

-
-This should be fairly easy to do using the search and replace facility in your editor (but -see notes below). -

If you have used the optional argument of \storeglosentry (i.e. you have multiple -glossaries) then you will need to substitute -


glossary - \storeglosentry{hlabeli}{hgls-entryi} +

+
+This should be fairly easy to do using the search and replace facility in your editor +(but see notes below). +

If you have used the optional argument of \storeglosentry (i.e. you have +multiple glossaries) then you will need to substitute +


glossary + \storeglosentry[gls-type]{label}{gls-entry} -

-
+class="ectt-1095">[hgls-typei]{hlabeli}{hgls-entryi} +

+
with -


glossaries - \newglossaryentry{label}{gls-entry,type=gls-type} -

+


glossaries - -
-

The glossary entry information gls-entrymay also need changing. If gls-entry + \newglossaryentry{hlabeli}{hgls-entryi,type=hgls-typei} +


+
+

The glossary entry information hgls-entryi may also need changing. If hgls-entryi contains any of makeindex’s special characters (i.e. @ ! " or |) then they should no -longer be escaped with " since the glossaries package deals with these characters -internally. For example, if your document contains the following: +class="ectt-1095">makeindex's special characters (i.e. @!" or |) then they +should no longer be escaped with " since the glossaries package deals with +these characters internally. For example, if your document contains the +following: -

-
+
\storeglosentry{card}{name={$"|\mathcal{S}"|$},  
description={The cardinality of the set $\mathcal{S}$}}
-

then you will need to replace it with: +

then you will need to replace it with: -

-
+
\newglossaryentry{card}{name={$|\mathcal{S}|$},  
description={The cardinality of the set $\mathcal{S}$}}
-

-

The format

+

The format and numbernumber keys available in \storeglosentry\storeglosentry are not available with \newglossaryentry\newglossaryentry. -

+

-

Top

6

Top

6 Adding an entry to the glossary

-

The glossary package provided two basic means to add information to the glossary: -firstly, the term was defined using \storeglosentry and the entries for that term were -added using \useglosentry

The glossary package provided two basic means to add information to the glossary: +rstly, the term was dened using \storeglosentry and the entries for that term +were added using \useglosentry, \useGlosentry\useGlosentry and \gls. Secondly, the term was added -to the glossary using \glossary. This second approach is unavailable with the glossaries -package. -

+class="ectt-1095">\gls. Secondly, the term +was added to the glossary using \glossary. This second approach is unavailable +with the glossaries package. +

-

Top

6.1

Top

6.1 \useglosentry

-

The glossary package allows you to add information to the glossary for a predefined +class="ectt-1095">\useglosentry +

The glossary package allows you to add information to the glossary for a predened term without producing any text in the document using -


glossary - \useglosentry


glossary + \useglosentry[old options]{label} -

-
+class="ectt-1095">[hold optionsi]{hlabeli} +

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


glossaries - \glsadd


glossaries + \glsadd[new options]{label} -

-
+class="ectt-1095">[hnew optionsi]{hlabeli} +

+
The formatformat key in old optionsremains the same in new options. However the -numberhold optionsi remains the same in hnew optionsi. However +the number=counter namekey in old optionsshould be replaced with counter=counter +class="ectt-1095">=hcounter namei key in hold optionsi should be replaced with namein new options. +class="ecss-1095">counter=hcounter namei in hnew optionsi. - -

+

-

Top

6.2

Top

6.2 \useGlosentry

-

The glossary package allows you to add information to the glossary for a predefined +class="ectt-1095">\useGlosentry +

The glossary package allows you to add information to the glossary for a predened term with the given text using -


glossary - \useGlosentry


glossary + \useGlosentry[old options]{label}{text} -

-
+class="ectt-1095">[hold optionsi]{hlabeli}{htexti} +

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


glossaries - \glslink


glossaries + \glslink[new options]{label}{text} -

-
+class="ectt-1095">[hnew optionsi]{hlabeli}{htexti} +

+
The mapping from old optionsto new optionsis the same as that given §6.1 +class="futsy-x-x-109">hold optionsi to hnew optionsi is the same as that given 6.1 \useglosentry. -

+class="ectt-1095">\useglosentry. +

-

Top

6.3

Top

6.3 \gls

-

Both the glossary and the glossaries packages define the command \gls\gls +

Both the glossary and the glossaries packages dene the command \gls. In this case, the only thing you need to change is the numbernumber key in the optional argument to countercounter. Note that the new form of \gls also takes a final optional +class="ectt-1095">\gls also takes a nal optional argument which can be used to insert text into the automatically generated text. -

+

-

Top

6.4

Top

6.4 \glossary

-

When using the glossaries package, you should not use \glossary\glossary +

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

If you don’t like the idea of continually scrolling back to the preamble to type all +

If you don't like the idea of continually scrolling back to the preamble to type all your \newglossaryentry commands, you may prefer to create a new file, in which to -store all these commands, and then input that file in your document’s preamble. Most - - - -text editors and front-ends allow you to have multiple files open, and you can tab back -and forth between them. -

+class="ectt-1095">\newglossaryentry 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. +

-

Top

7

Top

7 Acronyms

-

In the glossary package, acronyms were treated differently to glossary entries. This +

In the glossary package, acronyms were treated dierently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new glossaries +class="ecss-1095">glossaries package treats acronyms in exactly the same way as normal glossary terms. In fact, in the glossaries package, the default definition of: -


glossaries - \newacronymglossaries package, the default denition of: +


glossaries + \newacronym[options]{label}{abbrv}{long} -

-
+class="ectt-1095">[hoptionsi]{hlabeli}{habbrvi}{hlongi} +

+
is a shortcut for: -


glossaries - \newglossaryentry


glossaries + \newglossaryentry{label}{type=\acronymtype, -
name={abbrv}, -
description={long}, -
text={abbrv}, -
first={⟨long(abbrv)}, -
plural={⟨abbrvs}, -
firstplural={⟨longs (abbrvs)}, -
options⟩} -

-
-

This is different to the glossary package which set the name{hlabeli}{type=\acronymtype, +
name={habbrvi}, +
description={hlongi}, +
text={habbrvi}, +
first={hlongi (habbrvi)}, +
plural={habbrvis}, +
firstplural={hlongis (habbrvis)}, +
hoptionsi} +


+
+

This is dierent to the glossary package which set the name key to long(abbrv) +class="futsy-x-x-109">hlongi (habbrvi) and allowed you to set a description using the descriptiondescription key. If you still want to do this, you can use the descriptiondescription package option, and use the descriptiondescription key in the optional argument of \newacronym\newacronym. -

For example, if your document originally had the following: +

For example, if your document originally had the following: -

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

Then you would need to load the glossaries package using the description

Then you would need to load the glossaries package using the description package option, for example: -

-
+
\usepackage[description]{glossaries}
-

and change the acronym definition to: +

and change the acronym denition to: -

-
+
\newacronym[description=Statistical pattern recognition  
technique]{svm}{SVM}{Support Vector Machine}
-

You can then reference the acronym using any of the new referencing commands, such -as \gls

You can then reference the acronym using any of the new referencing commands, +such as \gls or \glsadd\glsadd. -

With the old glossary package, when you defined an acronym, it also defined a +

With the old glossary package, when you dened an acronym, it also dened a command \acr-namewhich could be used to display the acronym in the text. +class="ectt-1095">\hacr-namei which could be used to display the acronym in the text. So the above SVM example would create the command \SVM with the old +class="ectt-1095">\SVM with the old package. In the new glossaries package, the acronyms are just another type of +class="ecss-1095">glossaries package, the acronyms are just another type of glossary entry, so they are displayed using \gls\gls{label}. Therefore, in the +class="ectt-1095">{hlabeli}. Therefore, in the above example, you will also need to replace all occurrences of \SVM with +class="ectt-1095">\SVM with \gls{svm}. -

If you have used \useacronym\gls{svm}. +

If you have used \useacronym instead of \acr-name, then you will need to replace -all occurrences of -


glossary - \useacronym\hacr-namei, then you will need to +replace all occurrences of +


glossary + \useacronym[insert]{acr-name} -

-
+class="ectt-1095">[hinserti]{hacr-namei} +

+
with -


glossaries - \gls


glossaries + \gls{label}[insert] -

-
+class="ectt-1095">{hlabeli}[hinserti] +

+
Note that the starred versions of \useacronym\useacronym and \acr-name(which make the first -letter uppercase) should be replaced with \Gls\hacr-namei (which make the +rst letter uppercase) should be replaced with \Gls{label}. -

Alternatively (as from v1.18 of the glossaries package), you can use \oldacronym{hlabeli}. +

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


glossary +


glossary - -
-

\newacronym{SVM}{Support Vector Machine}{description=Statistical -

pattern recognition technique} +

+

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

pattern recognition technique}

-

-


-

+

+


+

then you can change this to: -


glossaries +


glossaries - -
-

\oldacronym{SVM}{Support Vector Machine}{description=Statistical -

pattern recognition technique} +

+

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

pattern recognition technique}

-

-


-

+

+


+

You can then continue to use \SVM. However, remember that LATEX generally ignores -spaces after command names that consist of alphabetical characters. You will therefore -need to force a space after \acr-name, unless you also load the xspace package. -(See \SVM. However, remember that LATEX generally +ignores spaces after command names that consist of alphabetical characters. You will +therefore need to force a space after \hacr-namei, unless you also load the xspace +package. (See Acronyms of the glossaries documentation for further details.) Note that -\oldacronym uses its first argument to define the acronym’s label (as used by +class="ecss-1095">glossaries documentation for further details.) Note +that \oldacronym uses its rst argument to dene the acronym's label (as used by commands like \gls\gls), so in the above example, with the new glossaries package, +class="ecss-1095">glossaries package, \SVM becomes a shortcut for \gls{SVM} and \SVM* becomes a shortcut for +class="ectt-1095">\SVM becomes a shortcut for \gls{SVM} and \SVM* becomes a shortcut for \Gls{SVM}. -

+class="ectt-1095">\Gls{SVM}. +

-

Top

7.1

Top

7.1 \acrln and \acrsh

-

In the glossary package, it is possible to produce the long and short forms of an +class="ectt-1095">\acrln and \acrsh +

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


glossary - \acrsh


glossary + \acrsh{acr-name} -

-
+class="ectt-1095">{hacr-namei} +

+
with -


glossaries - \acrshort


glossaries + \acrshort{label} -

-
+class="ectt-1095">{hlabeli} +

+
and you can replace -


glossary - \acrln{acr-name} -

+


glossary - -
+ \acrln{hacr-namei} +

+
with -


glossaries - \acrlong


glossaries + \acrlong{label} -

-
+class="ectt-1095">{hlabeli} +

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

See

See Acronyms of the glossaries manual for further details of how to use these +class="ecss-1095">glossaries manual for further details of how to use these commands. -

+

-

Top

7.2

Top

7.2 \ifacronymfirstuse

-

The glossary package command -


glossary - \ifacronymfirstuse\ifacronymfirstuse +

The glossary package command +


glossary + \ifacronymfirstuse{acr-name}{text1}{text2} -

-
+class="ectt-1095">{hacr-namei}{htext1i}{htext2i} +

+
can be replaced by the glossaries command: -


glossaries - \ifglsusedglossaries command: +


glossaries + \ifglsused{label}{text2}{text1} -

-
+class="ectt-1095">{hlabeli}{htext2i}{htext1i} +

+
Note that \ifglsused\ifglsused evaluates the opposite condition to that of \ifacronymfirstuse\ifacronymfirstuse which is why the last two arguments have been reversed. -

+

-

Top

7.3

Top

7.3 \resetacronym and \unsetacronym

-

The glossary package allows you to reset and unset the acronym flag which is used to -determine whether the acronym has been used in the document. The glossaries package -also provides a means to do this on either a local or a global level. To reset an acronym, -you will need to replace: -


glossary - \resetacronym{acr-name} -

+class="ectt-1095">\resetacronym and \unsetacronym - -
+

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


glossary + \resetacronym{hacr-namei} +

+
with either -


glossaries - \glsreset


glossaries + \glsreset{label} -

-
+class="ectt-1095">{hlabeli} +

+
or -


glossaries - \glslocalreset



-
-

To unset an acronym, you will need to replace: -


glossary - \unsetacronym{hlabeli} +

+
+

To unset an acronym, you will need to replace: +


glossary + \unsetacronym{acr-name} -

-
+class="ectt-1095">{hacr-namei} +

+
with either -


glossaries - \glsunset


glossaries + \glsunset{label} -

-
+class="ectt-1095">{hlabeli} +

+
or -


glossaries - \glslocalunset



-
-

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


glossary - \resetallacronyms{hlabeli} +

+
+

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



-
+ + +

+
with -


glossaries - \glsresetall



-
- - - +class="ectt-1095">] +

+
or -


glossaries - \glslocalresetall



-
+class="ectt-1095">] +

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


glossary - \unsetallacronyms



-
+

+
with -


glossaries - \glsunsetall



-
+class="ectt-1095">] +

+
or -


glossaries - \glslocalunsetall



-
-

+class="ectt-1095">] +


+
+

-

Top

8

Top

8 Displaying the glossary

-

The glossary package provides the command \printglossary

The glossary package provides the command \printglossary (or \printtypefor +class="ectt-1095">\printhtypei for other glossary types) which can be used to print individual glossaries. The glossaries +class="ecss-1095">glossaries package provides the command \printglossaries which will print all the glossaries -which have been defined, or \printglossary\printglossaries which will print all the + + +glossaries which have been dened, or \printglossary[options] to print individual glossaries. -So if you just have \printglossary, then you can leave it as it is, but if you have, -say: +class="ectt-1095">[hoptionsi] to print +individual glossaries. So if you just have \printglossary, then you can leave it as it +is, but if you have, say: -

-
+
\printglossary  
\printglossary[acronym]
-

or +

or -

-
+
\printglossary  
\printacronym
-

then you will need to replace this with either +

then you will need to replace this with either -

-
+
\printglossaries
-

or +

or -

-
+
\printglossary  
\printglossary[type=\acronymtype]
-

-

The glossary package allows you to specify a short title (for the table of contents and -page header) by defining a command of the form \shortglossary-typename. The -glossaries package doesn’t do this, but instead provides the toctitle key which can be -used in the optional argument to \printglossary. For example, if you have created a -new glossary type called notation, and you had defined +

+

The glossary package allows you to specify a short title (for the table of contents +and page header) by dening a command of the form \shorthglossary-typeiname. +The glossaries package doesn't do this, but instead provides the toctitle key which can +be used in the optional argument to \printglossary. For example, if you have +created a new glossary type called notation, and you had dened -

-
+
\newcommand{\shortnotationname}{Notation}
-

then you would need to use the toctitle

then you would need to use the toctitle key: -

-
+
\printglossary[type=notation,toctitle=Notation]
-

The glossaries package will ignore \shortnotationname

The glossaries package will ignore \shortnotationname, so unless you have used it -elsewhere in the document, you may as well remove the definition. -

+elsewhere in the document, you may as well remove the denition. +

-

Top

9

Top

9 Processing Your Document

-

If you convert your document from using the glossary package to the glossaries package, -you will need to delete any of the additional files, such as the .glo file, that were -created by the glossary package, as the glossaries package uses a different format. -Remember also, that if you used the makeglos Perl script, you will need to use the -makeglossaries

If you convert your document from using the glossary package to the glossaries +package, you will need to delete any of the additional les, such as the .glo le, that +were created by the glossary package, as the glossaries package uses a dierent +format. Remember also, that if you used the makeglos Perl script, you will need to +use the makeglossaries Perl script instead. As from v1.17, the glossaries package -can be used with either makeindexglossaries package can +be used with either makeindex or xindyxindy. Since xindyxindy was designed to be multilingual, the new glossaries package is a much better option for non-English +class="ecss-1095">glossaries package is a much better option for non-English documents. -

For further information on using makeglossaries

For further information on using makeglossaries, makeindexmakeindex or xindyxindy to create your glossaries, see Generating the Associated Glossary Files of the glossaries +class="ecss-1095">glossaries documentation. -

+

-

Top

10

Top

10 Troubleshooting

-

Please check the

Please check the FAQ for the glossaries package if you have any problems. +class="ecss-1095">glossaries package if you have any problems.

Top

Index

A +class="futb8t-x-x-109">A

-
\acl  \acl  1
\acrln  \acrln  2, 3
\acrlong  \acrlong  4, 5
\acrlongpl  \acrlongpl  6
\acronymname  \acronymname  7
- - - \acronymtype  \acronymtype  8, 9, 10, 11
\acrsh  \acrsh  12, 13
\acrshort  \acrshort  14, 15
\acrshortpl  \acrshortpl  16
\acs  \acs  17

F -file types
+class="futb8t-x-x-109">F +le types
    .glo  .glo  18

G +class="futb8t-x-x-109">G \glossary  \glossary  19, 20, 21, 25, href="glossary2glossaries.html#dx1-11003" >26, 27
\glossaryname  \glossaryname  28
\glossarystyle  \glossarystyle  29
\Gls  \Gls  30
\gls  \gls  31, 32, 33, 36 href="glossary2glossaries.html#dx1-12014" >37, 38
\gls options
+class="ectt-1095">\gls options
    counter  counter  39
    number  number  40
\glsadd  \glsadd  41, 42, 43
\glsadd options
+class="ectt-1095">\glsadd options
    counter  counter  44
\glslink  \glslink  45, 46
\glslocalreset  \glslocalreset  47
\glslocalresetall  \glslocalresetall  48
\glslocalunset  \glslocalunset  49
\glslocalunsetall  \glslocalunsetall  50
\glsreset  \glsreset  51
\glsresetall  \glsresetall  52
\glsunset  \glsunset  53
\glsunsetall  \glsunsetall  54

I +class="futb8t-x-x-109">I \ifacronymfirstuse  \ifacronymfirstuse  55, 56
\ifglsused  \ifglsused  57, 58

M +class="futb8t-x-x-109">M + + \makeacronym  \makeacronym  59
makeglos  makeglos  60
makeglossaries  makeglossaries  61, 62
\makeglossaries  \makeglossaries  63
\makeglossary  \makeglossary  64
- - - makeindex  makeindex  65, 66, 67, 71, 72, 73

N +class="futb8t-x-x-109">N \newacronym  \newacronym  74, 75, 76, 77, 78
\newglossary  \newglossary  79, 80
\newglossaryentry  \newglossaryentry  81, 82, 83, 85 href="glossary2glossaries.html#dx1-11018" >86, 87
\newglossaryentry options
+class="ectt-1095">\newglossaryentry options
    description  description  88, 89
    name  name  90
\newglossarytype  \newglossarytype  91

O +class="futb8t-x-x-109">O \oldacronym  \oldacronym  92, 93, 94

P +class="futb8t-x-x-109">P package options:
    description  description  95, 96
\printglossaries  \printglossaries  97
\printglossary  \printglossary  98, 99, 100, 102103, 104
\printglossary options
+class="ectt-1095">\printglossary options
    style  style  105
    toctitle  toctitle  106, 107, 108

R +class="futb8t-x-x-109">R \resetacronym  \resetacronym  109
\resetallacronyms  \resetallacronyms  110
-

S +

S \shortnotationname  \shortnotationname  111
\storeglosentry  \storeglosentry  112, 113, 114, 116 href="glossary2glossaries.html#dx1-7001" >117, 118
\storeglosentry options
+class="ectt-1095">\storeglosentry options
    format  format  119
+ +     number  number  120

U +class="futb8t-x-x-109">U \unsetacronym  \unsetacronym  121
\unsetallacronyms  \unsetallacronyms  122
\useacronym  \useacronym  123, 124, 125
\useGlosentry  \useGlosentry  126, 127
\useglosentry  \useglosentry  128, 129
- - - \useglosentry options
+class="ectt-1095">\useglosentry options
    format  format  130
    number  number  131

X +class="futb8t-x-x-109">X xindy  xindy  132, 133, 134, 136, 137, 138

-

1as from v1.17. Previous versions were designed to be used with makeindex

+1as from v1.17. Previous versions were designed to be used with makeindex only

-

2as from v1.17

3mainly because having a key value list in \glossaryonly

+2as from v1.17

+3mainly because having a key value list in \glossary caused problems, but it also helps -consistency.

-

4This is because \glossarycaused problems, but it also helps + consistency.

+4This is because \glossary requires the argument to be in a specific format and doesn’t use the -key=valueformat that the old glossary package used. The new package’s internal commands set -this format, as well as escaping any of makeindexrequires the argument to be in a specic format and doesn't use the + hkeyi=hvaluei format that the old glossary package used. The new package's internal commands set + this format, as well as escaping any of makeindex’s or xindy's or xindy’s special characters. What’s more, the -format has changed as from v1.17 to allow the new package to be used with either makeindex's special characters. What's more, the + format has changed as from v1.17 to allow the new package to be used with either makeindex or -xindyor + xindy.

-

5From the user’s point of view, using \glossary.

+5From the user's point of view, using \glossary throughout the document is time consuming, -and if you use it more than once for the same term, there’s a chance extra spaces may creep in which -will cause makeindexthroughout the document is time consuming, and + if you use it more than once for the same term, there's a chance extra spaces may creep in which will + cause makeindex to treat the two entries as different terms, even though they look the same in the -document.

+class="futr8t-x-x-90">to treat the two entries as dierent terms, even though they look the same in the + document.

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index adb51736221..1668a745f52 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 51d6b381b5a..60d18b38360 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -1,6 +1,6 @@ \documentclass{nlctdoc} -\usepackage{xr} +\usepackage{xr-hyper} \usepackage[colorlinks, bookmarks, hyperindex=false, @@ -8,6 +8,9 @@ pdftitle={Upgrading from the glossary package to the glossaries package}]{hyperref} +\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} +\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} + \ifpdf \externaldocument{glossaries-user} \fi @@ -18,7 +21,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2011-04-12} +\date{2012-05-21} \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 7b1aa41b5ce..d31003c0f56 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html and b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html differ diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf index 2b14c51a676..1939739a0f2 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/mfirstuc-manual.tex b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex index d01adf94f70..8cc27b29a4d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex @@ -21,7 +21,7 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{2011-04-02} + \date{2012-05-21} \maketitle The \styfmt{glossaries} bundle is supplied with the package @@ -111,4 +111,57 @@ For example: \renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase #1} \end{verbatim} +New to mfirstuc v1.06: +\begin{definition}[\DescribeMacro{\capitalisewords}] +\cs{capitalisewords}\marg{text} +\end{definition} +This command apply \ics{makefirstuc} to each word in \meta{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 \verb|~| or \cs{space}. Note that no expansion is performed +on \meta{text}. + +\begin{definition}[\DescribeMacro{\xcapitalisewords}] +\cs{xcapitalisewords}\marg{text} +\end{definition} +This is a short cut for +\cs{expandafter}\cs{capitalisewords}\cs{expandafter}\marg{text}. + +Examples: +\begin{enumerate} +\item +\begin{verbatim} +\capitalisewords{a book of rhyme.} +\end{verbatim} +produces: +\capitalisewords{a book of rhyme.} + +\item +\begin{verbatim} +\capitalisewords{a book\space of rhyme.} +\end{verbatim} +produces: +\capitalisewords{a book\space of rhyme.} + +\item +\begin{verbatim} +\newcommand{\mytitle}{a book\space of rhyme.} +\capitalisewords{\mytitle} +\end{verbatim} +produces: +\newcommand{\mytitle}{a book\space of rhyme.} +\capitalisewords{\mytitle} +(No expansion is performed on \cs{mytitle}, so \meta{text} +consists of just one ``word''.) Compare with next example: + +\item +\begin{verbatim} +\newcommand{\mytitle}{a book\space of rhyme.} +\xcapitalisewords{\mytitle} +\end{verbatim} +produces: +\xcapitalisewords{\mytitle} + +\end{enumerate} + \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index 45d37971c60..241b748e430 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/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf index 1e91f1c3b80..bf36438cc7b 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 ba6e0382fca..58c39506dd3 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 7db5987f813..b3571c0afb4 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-inline.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex new file mode 100644 index 00000000000..88ae07a23a1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex @@ -0,0 +1,141 @@ + % This file is public domain +\documentclass[a4paper]{report} + +\usepackage[plainpages=false,colorlinks]{hyperref} +\usepackage[toc,order=word,subentrycounter]{glossaries} + +\usepackage{glossary-inline} + +\renewcommand*{\glossarysection}[2][]{\textbf{#1}: } +\renewcommand{\glsnamefont}[1]{\textsc{#1}} +\glossarystyle{inline} + +\makeglossaries + +\newglossaryentry{Perl}{name=\texttt{Perl}, +sort=Perl, % need a sort key because name contains a command +description=A scripting language} + +\newglossaryentry{glossary}{name=glossary, +description={\nopostdesc}, +plural={glossaries}} + +\newglossaryentry{glossarycol}{ +description={collection of glosses}, +sort={2}, +parent={glossary}} + +\newglossaryentry{glossarylist}{ +description={list of technical words}, +sort={1}, +parent={glossary}} + +\newglossaryentry{pagelist}{name=page list, + % description value has to be enclosed in braces + % because it contains commas +description={a list of individual pages or page ranges +(e.g.\ 1,2,4,7-9)}} + +\newglossaryentry{mtrx}{name=matrix, +description={rectangular array of quantities}, + % plural is not simply obtained by appending an s, so specify +plural=matrices} + + % entry with a paragraph break in the description + +\newglossaryentry{par}{name=paragraph, +description={distinct section of piece of +writing. Beginning on new, usually indented, line}} + + % entry with two types of plural. Set the plural form to the + % form most likely to be used. If you want to use a different + % plural, you will need to explicity specify it in \glslink +\newglossaryentry{cow}{name=cow, + % this isn't necessary, as this form (appending an s) is + % the default +plural=cows, + % description: +description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult +female of any bovine animal}} + +\newglossaryentry{bravo}{name={bravo}, +description={\nopostdesc}} + +\newglossaryentry{bravo1}{description={cry of approval (pl.\ bravos)}, +sort={1}, +plural={bravos}, +parent=bravo} + +\newglossaryentry{bravo2}{description={hired ruffian or killer (pl.\ bravoes)}, +sort={2}, +plural={bravoes}, +parent=bravo} + +\newglossaryentry{seal}{name=seal,description={sea mammal with +flippers that eats fish}} + +\newglossaryentry{sealion}{name={sea lion}, +description={large seal}} + +\begin{document} + +\title{Sample Document Using glossary Package} +\author{Nicola Talbot} +\pagenumbering{alph}% prevent duplicate page link names if using PDF +\maketitle + +\pagenumbering{roman} +\tableofcontents + +\chapter{Introduction} +\pagenumbering{arabic} + +This document has a glossary in a footnote\footnote{\printglossaries}. + +A \gls{glossarylist} (definition~\glsrefentry{glossarylist}) is a +very useful addition to any technical document, although a +\gls{glossarycol} (definition~\glsrefentry{glossarycol}) can also +simply be a collection of glosses, which is another thing entirely. +Some documents have multiple \glspl{glossarylist}. + +Once you have run your document through \LaTeX, you +will then need to run the \texttt{.glo} file through +\texttt{makeindex}. You will need to set the output +file so that it creates a \texttt{.gls} file instead +of an \texttt{.ind} file, and change the name of +the log file so that it doesn't overwrite the index +log file (if you have an index for your document). +Rather than having to remember all the command line +switches, you can call the \gls{Perl} script +\texttt{makeglossaries} which provides a convenient +wrapper. + +If a comma appears within the name or description, grouping +must be used, e.g.\ in the description of \gls{pagelist}. + +\chapter{Plurals and Paragraphs} + +Plurals are assumed to have the letter s appended, but if this is +not the case, as in \glspl{mtrx}, then you need to specify the +plural when you define the entry. If a term may have multiple +plurals (for example \glspl{cow}/\glslink{cow}{kine}) then +define the entry with the plural form most likely to be used and +explicitly specify the alternative form using \verb|\glslink|. +\Glspl{seal} and \glspl{sealion} have regular plural forms. + +\Gls{bravo} is a homograph, but the plural forms are spelt +differently. The plural of \gls{bravo1}, a cry of approval +(definition~\glsrefentry{bravo1}), is \glspl{bravo1}, whereas the +plural of \gls{bravo2}, a hired ruffian or killer +(definition~\glsrefentry{bravo2}), is \glspl{bravo2}. + +\Glspl{par} can cause a problem in commands, so care is needed +when having a paragraph break in a \gls{glossarylist} entry. + +\chapter{Ordering} + +There are two types of ordering: word ordering (which places +``\gls{sealion}'' before ``\gls{seal}'') and letter ordering +(which places ``\gls{seal}'' before ``\gls{sealion}''). + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex new file mode 100644 index 00000000000..f7675f8b6c6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex @@ -0,0 +1,34 @@ +\documentclass[english,french]{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{babel} +\usepackage[nomain]{glossaries} + +\newglossary[glg]{english}{gls}{glo}{English to French} +\newglossary[flg]{french}{fls}{flo}{French to English} + +\makeglossaries + + % \newword{label}{english}{determiner}{french} +\newcommand*{\newword}[4]{% + \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}% + \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4},description={#2}}% +} + +\newword{cat}{cat}{le}{chat} +\newword{mat}{mat}{la}{natte} + +\begin{document} +\selectlanguage{english} +The \gls{en-cat} sat on the \gls{en-mat}. + +\selectlanguage{french} +Le \gls{fr-cat} s'est repos\'e sur la \gls{fr-mat}. + +\selectlanguage{english} +\printglossary[type=english] + +\selectlanguage{french} +\printglossary[type=french] +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex new file mode 100644 index 00000000000..71f35e1acbc --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex @@ -0,0 +1,29 @@ +\documentclass{article} + +\usepackage{mfirstuc} + +\begin{document} + +\makefirstuc{abc}. + +\makefirstuc{{\em abc}}. + +\makefirstuc{\emph{abc}}. + +\makefirstuc{\ae bc}. + +\makefirstuc{{\ae}bc}. + +\newcommand{\abc}{abc}% +\xmakefirstuc{\abc}. + +\capitalisewords{a book of rhyme.} + +\capitalisewords{a book\space of rhyme.} + +\newcommand{\mytitle}{a book\space of rhyme.} +\capitalisewords{\mytitle} + +\xcapitalisewords{\mytitle} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex new file mode 100644 index 00000000000..32a4bd86cd0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex @@ -0,0 +1,34 @@ +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[savenumberlist,counter=chapter]{glossaries} + +\makeglossaries + +\newglossaryentry{sample}{name=sample,description=an example} + +\begin{document} +\chapter{Introduction} + +This is a \glsentryname{sample} document. \Glsentryplural{sample} +are discussed in chapters~\glsdisplaynumberlist{sample}. + +\chapter{Sample Documents} + +\Gls{sample} documents are provided for testing and illustration +purposes. + +\chapter{More About Samples} + +Here's more information about \glspl{sample}. + +\chapter{Another chapter} + +A chapter about something else. + +\chapter{Another About Samples} + +Here's some more information about \glspl{sample}. + +\printglossaries +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf index 7e1d1836f7a..2b71c655fd0 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 63d7d3ec894..589475065e5 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 a0257944f1a..1c77fb0c167 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 45ca607ea46..b9f4d756584 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/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf index bb85b3129b3..65b8dd1857f 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 6b5e0a870b1..8d19afee2c7 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 0e06f20f27e..76c003b31d1 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/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index 53b84ddc551..9cee73eade9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -3,13 +3,15 @@ \usepackage{amsmath} \usepackage[colorlinks]{hyperref} -\usepackage[style=long3colheader,counter=equation]{glossaries} +\usepackage[toc,ucmark,style=long3colheader,counter=equation]{glossaries} \makeglossaries \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} +\pagestyle{headings} + % redefine the way hyperref creates the target for equations % so that the glossary links to equation numbers work diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf index 2a9d8729f0b..26ce7ad4228 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/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf index 7a2fafd4b10..dcffae44862 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/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf index cb73afc1324..35d002ea02a 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/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf index 54e56908ec4..964e0df5be8 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 c12f12ce23a..8c87013d84d 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 135bdb35347..5646b7fb7a5 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 8df50a9cd6e..2fbd57b9f99 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-compatible207.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf index 5cddf6b292c..e911938d771 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.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 904e3903344..442fac61dae 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 9b250265074..9d12f1b8344 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 df289eb8a39..19a61c9b5d0 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.03 (2011/12/02) +# Version : 2.04 (2011/06/21) # 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,11 @@ # glossary-super.sty, glossaries.perl. # Also makeglossaries and makeglossaries. -my $version="2.03 (2011-12-02)"; +my $version="2.04 (2012-05-19)"; # History: +# v2.04 (2012-04-19): +# * fixed bug in &scan_aux # v2.03 (2011-04-12): # * added warning about possibly needing 'nomain' package option # v2.02 (2011-04-2): @@ -456,6 +458,10 @@ sub scan_aux{ if (m/\\\@input{(.+)\.aux}/) { &scan_aux($1); + + # v2.04 added + # (Fix provided by Daniel Grund) + next; } if (m/\\\@newglossary\s*\{(.*)\}{(.*)}{(.*)}{(.*)}/) diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index caa101c7e40..3c3f4e9abeb 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -27,7 +27,7 @@ % -author "Nicola Talbot" % -codetitle "Main Package Code" % glossaries -% Created on 2011/4/13 19:39 +% Created on 2012/5/21 14:06 %\fi %\iffalse %<*package> @@ -50,7 +50,7 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2011 Nicola Talbot, all rights reserved. +% Copyright (C) 2012 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> @@ -79,7 +79,7 @@ glossaries.dtx \setcounter{IndexColumns}{2} -\CheckSum{13130} +\CheckSum{13653} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{first use\ifirstuse} @@ -107,7 +107,7 @@ glossaries.dtx %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{Documented Code For glossaries v3.01} +% \title{Documented Code For glossaries v3.02} % \author{Nicola L.C. Talbot\\[10pt] %School of Computing Sciences\\ %University of East Anglia\\ @@ -115,7 +115,7 @@ glossaries.dtx %NR4 7TJ. United Kingdom.\\ %\url{http://theoval.cmp.uea.ac.uk/~nlct/}} % -% \date{2011-04-12} +% \date{2012-05-21} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -131,7 +131,7 @@ glossaries.dtx %glossaries package}. % %\item[\url{glossaries-user.pdf}] -%For the main user guide, read \qt{glossaries.sty v3.01: +%For the main user guide, read \qt{glossaries.sty v3.02: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -172,7 +172,7 @@ glossaries.dtx % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2011/04/12 v3.01 (NLCT)] +\ProvidesPackage{glossaries}[2012/05/21 v3.02 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -313,7 +313,7 @@ false,nolabel,autolabel}[nolabel]{% % The default number list format displays the number list ``as is'': %\begin{macro}{\glossaryentrynumbers} % \begin{macrocode} -\newcommand*{\glossaryentrynumbers}[1]{#1} +\newcommand*{\glossaryentrynumbers}[1]{#1\gls@save@numberlist{#1}} % \end{macrocode} %\end{macro} %\begin{option}{nonumberlist} @@ -325,7 +325,17 @@ false,nolabel,autolabel}[nolabel]{% % \cs{glossaryentrynumbers} to ignores its argument). % \begin{macrocode} \DeclareOptionX{nonumberlist}{% -\renewcommand*{\glossaryentrynumbers}[1]{}} + \renewcommand*{\glossaryentrynumbers}[1]{\gls@save@numberlist{#1}}% +} +% \end{macrocode} +%\end{option} +% +%\begin{option}{savenumberlist} +%\changes{3.02}{2012/05/21}{new} +% Provide means to store the number list for entries. +% \begin{macrocode} +\define@boolkey{glossaries.sty}[gls]{savenumberlist}[true]{} +\glssavenumberlistfalse % \end{macrocode} %\end{option} % @@ -437,6 +447,16 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{option} % +%\begin{option}{ucmark} +% Boolean option to determine whether or not to use +% \ics{MakeUppercase} in definition of \ics{glossarymark} +%\changes{3.02}{2012/05/21}{new} +% \begin{macrocode} +\define@boolkey{glossaries.sty}[gls]{ucmark}[true]{} +\glsucmarkfalse +% \end{macrocode} +%\end{option} +% %\begin{option}{entrycounter} % Defines a counter that can be used in the standard glossary styles % to number each (main) entry. If true, this will define a counter called @@ -919,10 +939,25 @@ name=true]{% % Set the default value: % \begin{macrocode} \glstranslatefalse -\@ifpackageloaded{translator}{\glstranslatetrue}{% -\@ifpackageloaded{babel}{\glstranslatetrue}{% -\@ifpackageloaded{polyglossia}{\glstranslatetrue}{}}} + \@ifpackageloaded{translator}% + {\glstranslatetrue}% + {% + \@ifpackageloaded{polyglossia}% + {\glstranslatetrue}% + {% + \@ifpackageloaded{babel}{\glstranslatetrue}{}% + }% +} +% \end{macrocode} +% +%\begin{option}{indexonlyfirst} +%\changes{3.02}{2012/05/21}{new} +% Set whether to only index on first use. +% \begin{macrocode} +\define@boolkey{glossaries.sty}[gls]{indexonlyfirst}[true]{} +\glsindexonlyfirstfalse % \end{macrocode} +%\end{option} % %\begin{option}{hyperfirst} %\changes{2.03}{2009 Sep 23}{new} @@ -1135,8 +1170,25 @@ name=true]{% % automatic loading of translator package} % \begin{macrocode} \ifglstranslate - \@ifpackageloaded{babel}{\IfFileExists{translator.sty}{% - \RequirePackage{translator}}{}}{} + \@ifpackageloaded{polyglossia}% + {% +% \end{macrocode} +%\changes{3.02}{2012/05/21}{added check for polyglossia}% +% \sty{polyglossia} fakes \sty{babel} so need to check for +% \sty{polyglossia} first. +% \begin{macrocode} + }% + {% + \@ifpackageloaded{babel}% + {% + \IfFileExists{translator.sty}% + {% + \RequirePackage{translator}% + }% + {}% + }% + {} + } \fi % \end{macrocode} % @@ -1375,11 +1427,14 @@ name=true]{% \renewcommand*{\glsnumbersgroupname}{% \translate{Numbers (glossaries)}}% }{% - \@ifpackageloaded{babel}% - {\RequirePackage{glossaries-babel}}% +% \end{macrocode} +%\changes{3.02}{2012/05/21}{reversed order of package check} +% \begin{macrocode} + \@ifpackageloaded{polyglossia}% + {\RequirePackage{glossaries-polyglossia}}% {% - \@ifpackageloaded{polyglossia}{% - \RequirePackage{glossaries-polyglossia}}{}% + \@ifpackageloaded{babel}{% + \RequirePackage{glossaries-babel}}{}% }} \fi % \end{macrocode} @@ -1675,18 +1730,36 @@ name=true]{% % \begin{macrocode} \ifcsundef{glossarymark}% {% - \newcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \ifglsucmark + \newcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \newcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \fi }% {% \GlossariesWarning{overriding \string\glossarymark}% \@ifclassloaded{memoir}% { - \renewcommand{\glossarymark}[1]{% - \markboth{\memUChead{#1}}{\memUChead{#1}}% - } + \ifglsucmark + \renewcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \renewcommand{\glossarymark}[1]{% + \markboth{\memUChead{#1}}{\memUChead{#1}}% + } + \fi } { - \renewcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \ifglsucmark + \renewcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \renewcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \fi } } % \end{macrocode} @@ -2565,6 +2638,44 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\ifglshaschildren} +% \cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} +%\changes{3.02}{2012/05/21}{new} +% \begin{macrocode} +\newcommand{\ifglshaschildren}[3]{% + \glsdoifexists{#1}% + {% + \def\do@glshaschildren{#3}% + \expandafter\forglsentries\expandafter[\csname glo@#1@type\endcsname] + {\glo@label}% + {% + \letcs\glo@parent{glo@\glo@label @parent}% + \ifthenelse{\equal{#1}{\glo@parent}}% + {% + \def\do@glshaschildren{#2}% + \@endfortrue + }% + {}% + }% + \do@glshaschildren + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\ifglshasparent} +% \cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} +%\changes{3.02}{2012/05/21}{new} +% \begin{macrocode} +\newcommand{\ifglshasparent}[3]{% + \glsdoifexists{#1}% + {% + \ifcsempty{glo@#1@parent}{#3}{#2}% + }% +} +% \end{macrocode} +%\end{macro} +% %\subsection{Defining new glossaries}\label{sec:newglos} % A comma-separated list of glossary names is stored % in \cs{@glo@types}. When a new glossary type @@ -3043,6 +3154,27 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@missingnumberlist} +%\changes{3.02}{2012/05/21}{new} +% Define a command to generate warning when numberlist not set. +% \begin{macrocode} +\newcommand*{\@gls@missingnumberlist}[1]{% + ??% + \ifglssavenumberlist + \GlossariesWarning{Missing number list for entry `#1'. + Maybe makeglossaries + rerun required.}% + \else + \PackageError{glossaries}% + {Package option `savenumberlist=true' required.}% + {% + You must use the `savenumberlist' package option + to reference location lists.% + }% + \fi +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@glsdefaultsort} % Define command to set default sort. % \changes{1.17}{2008 December 26}{new} @@ -3071,40 +3203,49 @@ name=true]{% % \end{macrocode} % Check to see if this glossary entry has already been defined: % \begin{macrocode} -\glsdoifnoexists{#1}{% + \glsdoifnoexists{#1}% + {% % \end{macrocode} % Store label % \begin{macrocode} -\def\@glo@label{#1}% + \def\@glo@label{#1}% % \end{macrocode} % Set up defaults. If the \gloskey{name} or \gloskey{description} % keys are omitted, an error will be generated. % \begin{macrocode} -\let\@glo@name\@glsnoname + \let\@glo@name\@glsnoname % \end{macrocode} %\changes{1.08}{2007 Oct 13}{Fixed error message to say ``description %key'' rather than ``desc key''} % \begin{macrocode} -\def\@glo@desc{\PackageError{glossaries}{description key required in -\string\newglossaryentry\space for entry `\@glo@label'}{You haven't specified the entry description}}% + \def\@glo@desc{% + \PackageError{glossaries} + {% + description key required in \string\newglossaryentry\space + for entry `\@glo@label'% + }% + {% + You haven't specified the entry description% + }% + }% % \end{macrocode} % \changes{1.12}{2008 Mar 8}{descriptionplural support added} % \begin{macrocode} -\def\@glo@descplural{\@glo@desc}% + \def\@glo@descplural{\@glo@desc}% % \end{macrocode} % \begin{macrocode} -\def\@glo@type{\glsdefaulttype}% -\def\@glo@symbol{\relax}% + \def\@glo@type{\glsdefaulttype}% + \def\@glo@symbol{\relax}% % \end{macrocode} % \changes{1.12}{2008 Mar 8}{symbolplural support added} % \begin{macrocode} -\def\@glo@symbolplural{\@glo@symbol}% + \def\@glo@symbolplural{\@glo@symbol}% % \end{macrocode} % \begin{macrocode} -\def\@glo@text{\@glo@name}% + \def\@glo@text{\@glo@name}% % \end{macrocode} % \begin{macrocode} -\let\@glo@plural\@glsdefaultplural + \let\@glo@plural\@glsdefaultplural % \end{macrocode} % \changes{1.13}{2008 May 10}{Changed default first value} % Using \cs{let} instead of \cs{def} to make later comparison @@ -3112,13 +3253,13 @@ name=true]{% % this.) % \changes{1.16}{2008 August 27}{Changed def to let} % \begin{macrocode} -\let\@glo@first\relax + \let\@glo@first\relax % \end{macrocode} % \changes{1.12}{2008 Mar 8}{Changed default first plural to be first % key with s appended (was text key with s appended)} % \changes{1.13}{2008 May 10}{Changed default firstplural value} % \begin{macrocode} -\let\@glo@firstplural\relax + \let\@glo@firstplural\relax % \end{macrocode} % Set the default sort: %\changes{1.05}{2007 Aug 10}{Changed the default value of the sort @@ -3126,130 +3267,139 @@ name=true]{% %\changes{1.18}{2009 January 14}{Changed default value of sort % to '@glsdefaultsort} % \begin{macrocode} -\let\@glo@sort\@glsdefaultsort + \let\@glo@sort\@glsdefaultsort % \end{macrocode} % Set the default counter: % \begin{macrocode} -\def\@glo@counter{\@gls@getcounter{\@glo@type}}% + \def\@glo@counter{\@gls@getcounter{\@glo@type}}% % \end{macrocode} %\changes{1.17}{2008 December 26}{added see key} % \begin{macrocode} -\def\@glo@see{}% + \def\@glo@see{}% % \end{macrocode} %\changes{1.17}{2008 December 26}{added parent key} % \begin{macrocode} -\def\@glo@parent{}% + \def\@glo@parent{}% % \end{macrocode} %\changes{1.17}{2008 December 26}{added nonumberlist key} % \begin{macrocode} -\def\@glo@prefix{}% + \def\@glo@prefix{}% % \end{macrocode} %\changes{2.04}{2009 November 10}{added user1-6 keys} % \begin{macrocode} -\def\@glo@useri{}% -\def\@glo@userii{}% -\def\@glo@useriii{}% -\def\@glo@useriv{}% -\def\@glo@userv{}% -\def\@glo@uservi{}% + \def\@glo@useri{}% + \def\@glo@userii{}% + \def\@glo@useriii{}% + \def\@glo@useriv{}% + \def\@glo@userv{}% + \def\@glo@uservi{}% % \end{macrocode} %\changes{3.0}{2011/04/02}{added short and long keys} % \begin{macrocode} -\def\@glo@short{}% -\def\@glo@shortpl{}% -\def\@glo@long{}% -\def\@glo@longpl{}% + \def\@glo@short{}% + \def\@glo@shortpl{}% + \def\@glo@long{}% + \def\@glo@longpl{}% % \end{macrocode} % Add start hook in case another package wants to add extra keys. % \begin{macrocode} - \@newglossaryentryprehook + \@newglossaryentryprehook % \end{macrocode} % Extract key-val information from third parameter: % \begin{macrocode} -\setkeys{glossentry}{#2}% + \setkeys{glossentry}{#2}% % \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. %\changes{3.0}{2011/04/02}{replaced \cs{@ifundefined} with %\cs{ifcsundef}} % \begin{macrocode} -\ifcsundef{glolist@\@glo@type}% -{% - \PackageError{glossaries}% - {Glossary type '\@glo@type' has not been defined}% - {You need to define a new glossary type, before making entries - in it}% -}% -{% - \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% - \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% -}% + \ifcsundef{glolist@\@glo@type}% + {% + \PackageError{glossaries}% + {Glossary type '\@glo@type' has not been defined}% + {You need to define a new glossary type, before making entries + in it}% + }% + {% + \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% + \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% + }% % \end{macrocode} % Initialise level to 0. % \begin{macrocode} -\gls@level=0\relax + \gls@level=0\relax % \end{macrocode} % Has this entry been assigned a parent? % \begin{macrocode} -\ifx\@glo@parent\@empty + \ifx\@glo@parent\@empty % \end{macrocode} % Doesn't have a parent. Set \cs{glo@}\meta{label}"@parent" to % empty. % \begin{macrocode} - \expandafter\gdef\csname glo@#1@parent\endcsname{}% -\else + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + \else % \end{macrocode} % Has a parent. Check to ensure this entry isn't its own parent. % \begin{macrocode} - \ifthenelse{\equal{#1}{\@glo@parent}}{% - \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% - \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% - }{% + \ifthenelse{\equal{#1}{\@glo@parent}}% + {% + \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }% + {% % \end{macrocode} % Check the parent exists: % \begin{macrocode} - \ifglsentryexists{\@glo@parent}{% + \ifglsentryexists{\@glo@parent}% + {% % \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@#1@parent\endcsname{\@glo@parent}% % \end{macrocode} % Determine level. % \begin{macrocode} - \gls@level=\csname glo@\@glo@parent @level\endcsname\relax - \advance\gls@level by 1\relax + \gls@level=\csname glo@\@glo@parent @level\endcsname\relax + \advance\gls@level by 1\relax % \end{macrocode} % If name hasn't been specified, use same as the parent name % \begin{macrocode} - \ifx\@glo@name\@glsnoname - \expandafter\let\expandafter\@glo@name - \csname glo@\@glo@parent @name\endcsname + \ifx\@glo@name\@glsnoname + \expandafter\let\expandafter\@glo@name + \csname glo@\@glo@parent @name\endcsname % \end{macrocode} % If name and plural haven't been specified, use same as the parent % \begin{macrocode} - \ifx\@glo@plural\@glsdefaultplural - \expandafter\let\expandafter\@glo@plural - \csname glo@\@glo@parent @plural\endcsname - \fi - \fi - }{% + \ifx\@glo@plural\@glsdefaultplural + \expandafter\let\expandafter\@glo@plural + \csname glo@\@glo@parent @plural\endcsname + \fi + \fi + }% + {% % \end{macrocode} % Parent doesn't exist, so issue an error message and change this % entry to have no parent % \begin{macrocode} - \PackageError{glossaries}{Invalid parent `\@glo@parent' - for entry `#1' - parent doesn't exist}{Parent entries - must be defined before their children}% - \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% - }% - }% -\fi + \PackageError{glossaries}% + {% + Invalid parent `\@glo@parent' + for entry `#1' - parent doesn't exist% + }% + {% + Parent entries must be defined before their children% + }% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }% + }% + \fi % \end{macrocode} % Set the level for this entry % \begin{macrocode} -\expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% + \expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% % \end{macrocode} % Check if \gloskey{first} and \gloskey{firstplural} have been use. % If \gloskey{firstplural} hasn't been specified, but \gloskey{first} @@ -3260,108 +3410,119 @@ name=true]{% % This now uses \cs{ifx} instead of \cs{if} to avoid expansion % issues. (Thanks to Ulrich~Diez for suggesting this.) % \begin{macrocode} -\ifx\relax\@glo@firstplural - \ifx\relax\@glo@first - \def\@glo@firstplural{\@glo@plural}% - \def\@glo@first{\@glo@text}% - \else - \def\@glo@firstplural{\@glo@first\glspluralsuffix}% - \fi -\else - \ifx\relax\@glo@first - \def\@glo@first{\@glo@text}% - \fi -\fi + \ifx\relax\@glo@firstplural + \ifx\relax\@glo@first + \def\@glo@firstplural{\@glo@plural}% + \def\@glo@first{\@glo@text}% + \else + \def\@glo@firstplural{\@glo@first\glspluralsuffix}% + \fi + \else + \ifx\relax\@glo@first + \def\@glo@first{\@glo@text}% + \fi + \fi % \end{macrocode} % Define commands associated with this entry: % \begin{macrocode} -\expandafter - \protected@xdef\csname glo@#1@text\endcsname{\@glo@text}% -\expandafter - \protected@xdef\csname glo@#1@plural\endcsname{\@glo@plural}% -\expandafter - \protected@xdef\csname glo@#1@first\endcsname{\@glo@first}% -\expandafter - \protected@xdef\csname glo@#1@firstpl\endcsname{\@glo@firstplural}% -\expandafter - \protected@xdef\csname glo@#1@type\endcsname{\@glo@type}% -\expandafter - \protected@xdef\csname glo@#1@counter\endcsname{\@glo@counter}% -\expandafter - \protected@xdef\csname glo@#1@useri\endcsname{\@glo@useri}% -\expandafter - \protected@xdef\csname glo@#1@userii\endcsname{\@glo@userii}% -\expandafter - \protected@xdef\csname glo@#1@useriii\endcsname{\@glo@useriii}% -\expandafter - \protected@xdef\csname glo@#1@useriv\endcsname{\@glo@useriv}% -\expandafter - \protected@xdef\csname glo@#1@userv\endcsname{\@glo@userv}% -\expandafter - \protected@xdef\csname glo@#1@uservi\endcsname{\@glo@uservi}% -\expandafter - \protected@xdef\csname glo@#1@short\endcsname{\@glo@short}% -\expandafter - \protected@xdef\csname glo@#1@shortpl\endcsname{\@glo@shortpl}% -\expandafter - \protected@xdef\csname glo@#1@long\endcsname{\@glo@long}% -\expandafter - \protected@xdef\csname glo@#1@longpl\endcsname{\@glo@longpl}% -\@gls@sanitizename -\expandafter\protected@xdef\csname glo@#1@name\endcsname{\@glo@name}% + \expandafter + \protected@xdef\csname glo@#1@text\endcsname{\@glo@text}% + \expandafter + \protected@xdef\csname glo@#1@plural\endcsname{\@glo@plural}% + \expandafter + \protected@xdef\csname glo@#1@first\endcsname{\@glo@first}% + \expandafter + \protected@xdef\csname glo@#1@firstpl\endcsname{\@glo@firstplural}% + \expandafter + \protected@xdef\csname glo@#1@type\endcsname{\@glo@type}% + \expandafter + \protected@xdef\csname glo@#1@counter\endcsname{\@glo@counter}% + \expandafter + \protected@xdef\csname glo@#1@useri\endcsname{\@glo@useri}% + \expandafter + \protected@xdef\csname glo@#1@userii\endcsname{\@glo@userii}% + \expandafter + \protected@xdef\csname glo@#1@useriii\endcsname{\@glo@useriii}% + \expandafter + \protected@xdef\csname glo@#1@useriv\endcsname{\@glo@useriv}% + \expandafter + \protected@xdef\csname glo@#1@userv\endcsname{\@glo@userv}% + \expandafter + \protected@xdef\csname glo@#1@uservi\endcsname{\@glo@uservi}% + \expandafter + \protected@xdef\csname glo@#1@short\endcsname{\@glo@short}% + \expandafter + \protected@xdef\csname glo@#1@shortpl\endcsname{\@glo@shortpl}% + \expandafter + \protected@xdef\csname glo@#1@long\endcsname{\@glo@long}% + \expandafter + \protected@xdef\csname glo@#1@longpl\endcsname{\@glo@longpl}% + \@gls@sanitizename + \expandafter\protected@xdef\csname glo@#1@name\endcsname{\@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}% + {% + \csxdef{glo@#1@numberlist}{\noexpand\@gls@missingnumberlist{\@glo@label}}% + }% + {}% % \end{macrocode} % The smaller and smallcaps options set the description to % \cs{@glo@first}. Need to check for this, otherwise it won't get % expanded if the description gets sanitized. %\changes{1.15}{2008 August 15}{check for '@glo@first in description}% % \begin{macrocode} -\def\@glo@@desc{\@glo@first}% -\ifx\@glo@desc\@glo@@desc - \let\@glo@desc\@glo@first -\fi -\@gls@sanitizedesc -\expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% -\expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% + \def\@glo@@desc{\@glo@first}% + \ifx\@glo@desc\@glo@@desc + \let\@glo@desc\@glo@first + \fi + \@gls@sanitizedesc + \expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% + \expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% % \end{macrocode} %\changes{1.18}{2009 January 14}{moved sort sanitization to % '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}{#1}% % \end{macrocode} %\changes{1.15}{2008 August 15}{check for '@glo@text in symbol}% % \begin{macrocode} -\def\@glo@@symbol{\@glo@text}% -\ifx\@glo@symbol\@glo@@symbol - \let\@glo@symbol\@glo@text -\fi -\@gls@sanitizesymbol -\expandafter\protected@xdef\csname glo@#1@symbol\endcsname{\@glo@symbol}% -\expandafter\protected@xdef\csname glo@#1@symbolplural\endcsname{\@glo@symbolplural}% + \def\@glo@@symbol{\@glo@text}% + \ifx\@glo@symbol\@glo@@symbol + \let\@glo@symbol\@glo@text + \fi + \@gls@sanitizesymbol + \expandafter\protected@xdef\csname glo@#1@symbol\endcsname{\@glo@symbol}% + \expandafter\protected@xdef\csname glo@#1@symbolplural\endcsname{\@glo@symbolplural}% % \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\gdef\csname glo@#1@flagtrue\endcsname{% -\expandafter\global\expandafter -\let\csname ifglo@#1@flag\endcsname\iftrue}% -\csname glo@#1@flagfalse\endcsname + \expandafter\gdef\csname glo@#1@flagfalse\endcsname{% + \expandafter\global\expandafter + \let\csname ifglo@#1@flag\endcsname\iffalse + }% + \expandafter\gdef\csname glo@#1@flagtrue\endcsname{% + \expandafter\global\expandafter + \let\csname ifglo@#1@flag\endcsname\iftrue + }% + \csname glo@#1@flagfalse\endcsname % \end{macrocode} % Sort out any cross-referencing if required. % \begin{macrocode} -\ifx\@glo@see\@empty -\else - \protected@edef\@do@glssee{% - \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see - \noexpand\@nil - \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% - \@do@glssee -\fi -}% + \ifx\@glo@see\@empty + \else + \protected@edef\@do@glssee{% + \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see + \noexpand\@nil + \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% + \@do@glssee + \fi + }% % \end{macrocode} % Determine and store main part of the entry's index format. %\changes{1.17}{2008 December 26}{Stored main part of entry @@ -3392,6 +3553,25 @@ name=true]{% \newcommand*{\@newglossaryentryposthook}{} % \end{macrocode} %\end{macro} +% +%\begin{macro}{\glsmoveentry} +%\changes{3.02}{2012/05/21}{new} +% Moves entry whose label is given by first argument to the glossary +% named in the second argument. +% \begin{macrocode} +\newcommand*{\glsmoveentry}[2]{% + \edef\glo@type{\csname glo@#1@type\endcsname}% + \def\glo@list{,}% + \forglsentries[\glo@type]{\glo@label}% + {% + \ifthenelse{\equal{\glo@label}{#1}}{}{\eappto\glo@list{\glo@label,}}% + }% + \cslet{glolist@\glo@type}{\glo@list}% + \csdef{glo@#1@type}{#2}% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@glossaryentryfield} % Indicate what command should be used to display each entry in % the glossary. (This enables the \sty{glossaries-accsupp} package @@ -3864,7 +4044,7 @@ name=true]{% % \begin{macrocode} \@do@wrglossary{#2}% \ifKV@glslink@hyper - \@glslink{glo:#2}{\glstextformat{#3}}% + \@glslink{\glolinkprefix#2}{\glstextformat{#3}}% \else \glstextformat{#3}\relax \fi @@ -3872,6 +4052,20 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glolinkprefix} +% \begin{macrocode} +\newcommand*{\glolinkprefix}{glo:} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentrycounter} +% Set default value of entry counter +%\changes{3.02}{2012/05/21}{set default value} +% \begin{macrocode} +\def\glsentrycounter{\glscounter}% +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@gls@saveentrycounter} %\changes{3.0}{2011/04/02}{new} % Need to check if using \ctr{equation} counter in \env{align} @@ -7499,16 +7693,20 @@ name=true]{% % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryfull} +%\changes{3.02}{2012/05/21}{fixed bug (replaced \cs{glsentryshortpl} +%with \cs{glsentryshort})} % \begin{macrocode} \newcommand*{\Glsentryfull}[1]{% - \Glsentrylong{#1}\space(\glsentryshortpl{#1})% + \Glsentrylong{#1}\space(\glsentryshort{#1})% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryfullpl} +%\changes{3.02}{2012/05/21}{fixed bug (replaced \cs{glsentryshort} +%with \cs{glsentryshortpl})} % \begin{macrocode} \newcommand*{\glsentryfullpl}[1]{% - \glsentrylongpl{#1}\space(\glsentryshort{#1})% + \glsentrylongpl{#1}\space(\glsentryshortpl{#1})% } % \end{macrocode} %\end{macro} @@ -7520,6 +7718,86 @@ name=true]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsentrynumberlist} +%\changes{3.02}{2012/05/21}{new} +%Displays the number list as is. +% \begin{macrocode} +\newcommand*{\glsentrynumberlist}[1]{% + \glsdoifexists{#1}% + {% + \csname glo@#1@numberlist\endcsname + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsdisplaynumberlist} +%\changes{3.02}{2012/05/21}{new} +% Formats the number list for the given entry label. +% Doesn't work with hyperref. +% \begin{macrocode} +\@ifpackageloaded{hyperref} +{% + \newcommand*{\glsdisplaynumberlist}[1]{% + \GlossariesWarning + {% + \string\glsdisplaynumberlist\space + doesn't work with hyperref.^^JUsing + \string\glsentrynumberlist\space instead% + }% + \glsentrynumberlist{#1}% + }% +}% +{% + \newcommand*{\glsdisplaynumberlist}[1]{% + \glsdoifexists{#1}% + {% + \bgroup + \def\@glo@label{#1}% + \let\@org@glsnumberformat\glsnumberformat + \def\glsnumberformat##1{##1}% + \protected@edef\the@numberlist{\csname glo@\@glo@label @numberlist\endcsname}% + \def\@gls@numlist@sep{}% + \def\@gls@numlist@nextsep{}% + \def\@gls@numlist@lastsep{}% + \def\@gls@thislist{}% + \def\@gls@donext@def{}% + \renewcommand\do[1]{% + \protected@edef\@gls@thislist{% + \@gls@thislist + \noexpand\@gls@numlist@sep + ##1% + }% + \let\@gls@numlist@sep\@gls@numlist@nextsep + \def\@gls@numlist@nextsep{\glsnumlistsep}% + \@gls@donext@def + \def\@gls@donext@def{% + \def\@gls@numlist@lastsep{\glsnumlistlastsep}% + }% + }% + \expandafter \glsnumlistparser \expandafter{\the@numberlist}% + \let\@gls@numlist@sep\@gls@numlist@lastsep + \@gls@thislist + \egroup + }% + } +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsnumlistsep} +%\changes{3.02}{21012/05/19}{new} +% \begin{macrocode} +\newcommand*{\glsnumlistsep}{, } +% \end{macrocode} +%\end{macro} +%\begin{macro}{\glsnumlistlastsep} +%\changes{3.02}{21012/05/19}{new} +% \begin{macrocode} +\newcommand*{\glsnumlistlastsep}{ \& } +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glshyperlink} % Provide a hyperlink to a glossary entry without adding information % to the glossary file. The entry needs to be added using a @@ -7533,7 +7811,7 @@ name=true]{% % \begin{macrocode} \newcommand*{\glshyperlink}[2][\glsentrytext{\@glo@label}]{% \def\@glo@label{#2}% -\@glslink{glo:#2}{#1}} +\@glslink{\glolinkprefix#2}{#1}} % \end{macrocode} %\end{macro} % @@ -8150,6 +8428,15 @@ name=true]{% % Suppress warning about no \cs{makeglossaries} % \begin{macrocode} \let\warn@nomakeglossaries\relax +% \end{macrocode} +% Declare list parser for \cs{glsdisplaynumberlist} +%\changes{3.02}{2012/05/21}{added list parser} +% \begin{macrocode} + \ifglssavenumberlist + \edef\@gls@dodeflistparser{\noexpand\DeclareListParser + {\noexpand\glsnumlistparser}{\delimN}}% + \@gls@dodeflistparser + \fi } % \end{macrocode} %\end{macro} @@ -8208,10 +8495,21 @@ name=true]{% % \end{macrocode} % Iterate through all the glossaries %\changes{3.01}{2011/04/12}{added check for empty glossaries} +%\changes{3.02}{2012/05/21}{added check for existence of token +% in case \cs{makeglossaries has been omitted}} % \begin{macrocode} \forallglossaries{\@glo@type}{% - \edef\gls@tmp{\expandafter\the\csname glo@\@glo@type -@filetok\endcsname}% +% \end{macrocode} +% Check for empty glossaries (patch provided by Patrick H\"acker) +% \begin{macrocode} + \ifcsundef{glo@\@glo@type @filetok}% + {% + \def\gls@tmp{}% + }% + {% + \edef\gls@tmp{\expandafter\the + \csname glo@\@glo@type @filetok\endcsname}% + }% \ifx\gls@tmp\@empty \ifx\@glo@type\glsdefaulttype \GlossariesWarningNoLine{Glossary `\@glo@type' has no @@ -8225,8 +8523,8 @@ you \else \@glsopenfile{\glswrite}{\@glo@type}% \immediate\write\glswrite{% - \expandafter\the\csname glo@\@glo@type -@filetok\endcsname}% + \expandafter\the + \csname glo@\@glo@type @filetok\endcsname}% \immediate\closeout\glswrite \fi }% @@ -8247,7 +8545,8 @@ you %\begin{macro}{\glossary} % \begin{macrocode} \renewcommand*{\glossary}[1][\glsdefaulttype]{% -\@glossary[#1]} + \@glossary[#1]% +} % \end{macrocode} %\end{macro} % @@ -8288,7 +8587,16 @@ you \expandafter\global\expandafter\csname glo@#1@filetok\endcsname \expandafter{\@gls@tmp^^J}% \else - \expandafter\protected@write\csname glo@#1@file\endcsname{}{#2}% +% \end{macrocode} +%\changes{3.02}{2012/05/21}{added check for glossary file defined}% +% \begin{macrocode} + \ifcsdef{glo@#1@file}% + {% + \expandafter\protected@write\csname glo@#1@file\endcsname{}{#2}% + }% + {% + \GlossariesWarning{No file defined for glossary `#1'}% + }% \fi \endgroup\@esphack } @@ -8296,13 +8604,25 @@ you %\end{macro} % %\begin{macro}{\@do@wrglossary} +%\changes{3.02}{2012/05/21}{changed \cs{@do@wr@glossary} to test for +%\pkgopt{indexonlyfirst} option; put old \cs{@do@wr@glossary} code +%into \cs{@@do@wrglossary}} +% \begin{macrocode} +\newcommand*{\@do@wrglossary}[1]{% + \ifglsindexonlyfirst + \ifglsused{#1}{}{\@@do@wrglossary{#1}}% + \else + \@@do@wrglossary{#1}% + \fi +} +% \end{macrocode} %\changes{1.17}{2008 December 26}{new} % Write the glossary entry in the appropriate format. % (Need to set \cs{@glsnumberformat} and \cs{@gls@counter} prior to use.) % The argument is the entry's label. %\changes{3.0}{2011/04/02}{modified to use new format} % \begin{macrocode} -\newcommand{\@do@wrglossary}[1]{% +\newcommand*{\@@do@wrglossary}[1]{% % \end{macrocode} % Get the location and escape any special characters % \begin{macrocode} @@ -8327,44 +8647,47 @@ you % Determine whether to use \app{xindy} or \app{makeindex} % syntax % \begin{macrocode} -\ifglsxindy + \ifglsxindy % \end{macrocode} % Need to determine if the formatting information starts with % a ( or ) indicating a range. % \begin{macrocode} - \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil - \def\@glo@range{}% - \expandafter\if\@glo@prefix(\relax - \def\@glo@range{:open-range}% - \else - \expandafter\if\@glo@prefix)\relax - \def\@glo@range{:close-range}% + \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil + \def\@glo@range{}% + \expandafter\if\@glo@prefix(\relax + \def\@glo@range{:open-range}% + \else + \expandafter\if\@glo@prefix)\relax + \def\@glo@range{:close-range}% + \fi \fi - \fi % \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) - :locref \string"{\@glo@counterprefix}{\@glslocref}\string" % - :attr \string"\@gls@counter\@glo@suffix\string" - \@glo@range - ) - }% -\else + \glossary[\csname glo@#1@type\endcsname]{% + (indexentry :tkey (\csname glo@#1@index\endcsname) +% \end{macrocode} +%\changes{3.02}{2012/05/21}{changed \cs{@glslocref} to \cs{theglsentrycounter}} +% \begin{macrocode} + :locref \string"{\@glo@counterprefix}{\theglsentrycounter}\string" % + :attr \string"\@gls@counter\@glo@suffix\string" + \@glo@range + ) + }% + \else % \end{macrocode} % Convert the format information into the format required for % \app{makeindex} % \begin{macrocode} - \@set@glo@numformat{\@glo@numfmt}{\@gls@counter}{\@glsnumberformat}% - {\@glo@counterprefix}% + \@set@glo@numformat{\@glo@numfmt}{\@gls@counter}{\@glsnumberformat}% + {\@glo@counterprefix}% % \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 - \@gls@encapchar\@glo@numfmt}{\theglsentrycounter}}% -\fi + \glossary[\csname glo@#1@type\endcsname]{% + \string\glossaryentry{\csname glo@#1@index\endcsname + \@gls@encapchar\@glo@numfmt}{\theglsentrycounter}}% + \fi } % \end{macrocode} %\end{macro} @@ -8540,6 +8863,23 @@ you % glossary, and can also be used to set the style, title and % entry in the table of contents. Available keys are defined below. % +%\begin{macro}{\gls@save@numberlist} +%\changes{3.02}{2012/05/21}{new} +% Provide command to store number list. +% \begin{macrocode} +\newcommand*{\gls@save@numberlist}[1]{% + \ifglssavenumberlist + \toks@{#1}% + \edef\@do@writeaux@info{% + \noexpand\csgdef{glo@\glscurrententrylabel @numberlist}{\the\toks@}% + }% + \@onelevel@sanitize\@do@writeaux@info + \protected@write\@auxout{}{\@do@writeaux@info}% + \fi +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\warn@noprintglossary} % Warn the user if they have forgotten \ics{printglossaries} % or \ics{printglossary}. (Will be suppressed if there is at @@ -8547,9 +8887,11 @@ you % to ensure that there is a \ics{printglossary} for each defined % glossary.) % \begin{macrocode} -\def\warn@noprintglossary{\GlossariesWarningNoLine{No - \string\printglossary\space or \string\printglossaries\space - found.^^JThis document will not have a glossary}} +\def\warn@noprintglossary{% + \GlossariesWarningNoLine{No \string\printglossary\space + or \string\printglossaries\space + found.^^JThis document will not have a glossary}% +} % \end{macrocode} %\end{macro} % @@ -8643,6 +8985,20 @@ you % \begin{macrocode} \@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: +% \begin{macrocode} + \let\gls@org@glossaryentryfield\glossaryentryfield + \let\gls@org@glossarysubentryfield\glossarysubentryfield + \renewcommand{\glossaryentryfield}[1]{% + \gdef\glscurrententrylabel{##1}% + \gls@org@glossaryentryfield{##1}% + }% + \renewcommand{\glossarysubentryfield}[2]{% + \gdef\glscurrententrylabel{##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. % \begin{macrocode} @@ -8657,8 +9013,9 @@ you % This might produce an empty page, but at this point the document % isn't complete, so it shouldn't matter. % \begin{macrocode} -\IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}{}% -{\null}% + \IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}% + {}% + {\null}% % \end{macrocode} % If \app{xindy} is being used, need to write the language % dependent information to the \filetype{.aux} file for @@ -8708,7 +9065,8 @@ you %\begin{macro}{\printglossaries} % \begin{macrocode} \newcommand*{\printglossaries}{% -\forallglossaries{\@@glo@type}{\printglossary[type=\@@glo@type]}} + \forallglossaries{\@@glo@type}{\printglossary[type=\@@glo@type]}% +} % \end{macrocode} %\end{macro} % The keys that can be used in the optional argument to @@ -8786,8 +9144,10 @@ false,nolabel,autolabel}[nolabel]{% % \begin{macrocode} \newcommand*{\@glsnonextpages}{% \gdef\glossaryentrynumbers##1{% - \glsresetentrylist}} -% \end{macrocode} + \glsresetentrylist + }% +} +% \end{macrocode} %\end{macro} %\begin{macro}{\@glsnextpages} %\changes{3.0}{2011/04/02}{new}% @@ -8873,6 +9233,20 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsresetsubentrycounter} +%\changes{3.02}{2012/05/21}{new} +% Resets the \ctr{glossarentry} counter. +% \begin{macrocode} +\ifglsentrycounter + \newcommand*{\glsresetentrycounter}{% + \setcounter{glossaryentry}{0}% + } +\else + \newcommand*{\glsresetentrycounter}{} +\fi +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glsstepentry} %\changes{3.0}{2011/04/02}{new} % Advance the \ctr{glossaryentry} counter if in use. The argument is @@ -9012,7 +9386,7 @@ false,nolabel,autolabel}[nolabel]{% % Provide user interface to \cs{@glstarget} to make it easier to % modify the glossary style in the document. % \begin{macrocode} -\newcommand*{\glstarget}[2]{\@glstarget{glo:#1}{#2}} +\newcommand*{\glstarget}[2]{\@glstarget{\glolinkprefix#1}{#2}} % \end{macrocode} %\end{macro} % @@ -9183,6 +9557,22 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\renewglossarystyle} +%\changes{3.02}{2012/05/21}{new} +%Code for this macro supplied by Marco Daniel. +% \begin{macrocode} +\newcommand{\renewglossarystyle}[2]{% + \ifcsundef{@glsstyle@#1}% + {% + \PackageError{glossaries}{Glossary style `#1' isn't already defined}{}% + }% + {% + \csdef{@glsstyle@#1}{#2}% + }% +} +% \end{macrocode} +%\end{macro} +% % Glossary entries are encoded so that the second argument % to \ics{glossaryentryfield} is always specified as % \cs{glsnamefont}\marg{name}. This allows the @@ -9840,7 +10230,7 @@ false,nolabel,autolabel}[nolabel]{% \defglsdisplayfirst[#1]{% \firstacronymfont{##1}##4% \expandafter\protect\expandafter\acrfootnote\expandafter - {\@gls@link@opts}{\@gls@link@label}{##3} + {\@gls@link@opts}{\@gls@link@label}{##3}% }% \defglsdisplay[#1]{\acronymfont{##1}##4}% } @@ -10201,6 +10591,7 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} %\end{macro} %\begin{macro}{\SmallNewAcronymDef} +%\changes{3.02}{2012/05/21}{fixed broken short and long plural} % \begin{macrocode} \newcommand*{\SmallNewAcronymDef}{% \edef\@do@newglossaryentry{% @@ -10210,9 +10601,11 @@ false,nolabel,autolabel}[nolabel]{% name={\noexpand\acronymfont{\the\glsshorttok}},% sort={\the\glsshorttok},% text={\noexpand\@glo@symbol},% - plural={\noexpand\@glo@symbolplural},% + %plural={\noexpand\@glo@symbolplural},% + plural={\noexpand\@glo@shortpl},% first={\the\glslongtok},% - firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + %firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + firstplural={\noexpand\@glo@longpl},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% long={\the\glslongtok},% @@ -10220,7 +10613,8 @@ false,nolabel,autolabel}[nolabel]{% description={\noexpand\@glo@first},% descriptionplural={\noexpand\@glo@firstplural},% symbol={\the\glsshorttok},% - symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + %symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + symbolplural={\noexpand\@glo@shortpl},% \the\glskeylisttok }% }% @@ -10967,13 +11361,14 @@ false,nolabel,autolabel}[nolabel]{% % %\begin{macro}{\showglossaryentries} %\changes{3.0}{2011/04/02}{new} +%\changes{3.02}{2012/05/21}{fixed misspelt command} %\begin{definition} %\cs{showglossaryentries}\marg{glossary-label} %\end{definition} % Show the list of entry labels for the given glossary. % \begin{macrocode} \newcommand*{\showglossaryentries}[1]{% - \expandafter\show\csname @glolist@#1\endcsname + \expandafter\show\csname glolist@#1\endcsname } % \end{macrocode} %\end{macro} @@ -11015,7 +11410,12 @@ false,nolabel,autolabel}[nolabel]{% %\label{sec:code:mfirstuc} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{mfirstuc}[2011/04/02 v1.05 (NLCT)] +\ProvidesPackage{mfirstuc}[2012/05/21 v1.06 (NLCT)] +% \end{macrocode} +% Requires \sty{etoolbox}:\changes{1.06}{2012/05/21}{now requires +% etoolbox} +% \begin{macrocode} +\RequirePackage{etoolbox} % \end{macrocode} %\begin{macro}{\makefirstuc} % Syntax:\\ @@ -11115,6 +11515,47 @@ false,nolabel,autolabel}[nolabel]{% \expandafter\makefirstuc\expandafter{#1}} % \end{macrocode} %\end{macro} +% +%\begin{macro}{\capitalisewords} +%\changes{1.06}{2012/05/21}{new} +% Capitalise each word in the argument. Words are considered to be +% separated by plain spaces (i.e.\ non-breakable spaces won't be +% considered a word break). +% \begin{macrocode} +\newcommand*{\capitalisewords}[1]{% + \def\gls@add@space{}% + \mfu@capitalisewords#1 \@nil\mfu@endcap + %\gls@add@space\makefirstuc{##1}\def\gls@add@space{ }% +} +% \end{macrocode} +%\end{macro} +% +% \begin{macrocode} +\def\mfu@capitalisewords#1 #2\mfu@endcap{% + \def\mfu@cap@first{#1}% + \def\mfu@cap@second{#2}% + \gls@add@space + \makefirstuc{#1}% + \def\gls@add@space{ }% + \ifx\mfu@cap@second\@nnil + \let\next@mfu@cap\mfu@noop + \else + \let\next@mfu@cap\mfu@capitalisewords + \fi + \next@mfu@cap#2\mfu@endcap +} +\def\mfu@noop#1\mfu@endcap{} +% \end{macrocode} +% +%\begin{macro}{\xcapitalisewords} +%\changes{1.06}{2012/05/21}{new} +% Short-cut command: +% \begin{macrocode} +\newcommand*{\xcapitalisewords}[1]{% + \expandafter\capitalisewords\expandafter{#1}% +} +% \end{macrocode} +%\end{macro} %\section{Glossary Styles} %\iffalse % \begin{macrocode} @@ -11286,6 +11727,110 @@ false,nolabel,autolabel}[nolabel]{% %\fi %\iffalse % \begin{macrocode} +%<*glossary-inline.sty> +% \end{macrocode} +%\fi +% \subsection{In-line Style (glossary-inline.sty)} +% This defines an in-line style where the entries are +% comma-separated with just the name and description displayed. +% \begin{macrocode} +\ProvidesPackage{glossary-inline}[2012/05/21 v1.0 (NLCT)] +% \end{macrocode} +% +%\begin{style}{inline} +% Define the inline style. +% \begin{macrocode} +\newglossarystyle{inline}{% +% \end{macrocode} +% Start of glossary sets up first empty separator between entries. +% (This is then changed by \cs{glossaryentryfield}) +% \begin{macrocode} + \renewenvironment{theglossary}% + {% + \def\gls@inlinesep{}% + \def\gls@inlinesubsep{}% + }% + {\glspostinline}% +% \end{macrocode} +% No header: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{}% +% \end{macrocode} +% No group headings: +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{}% +% \end{macrocode} +% Just display separator followed by name and description: +% \begin{macrocode} + \renewcommand*{\glossaryentryfield}[5]{% + \gls@inlinesep + \glsentryitem{##1}\glstarget{##1}{##2}% + \def\glo@desc{##3}% + \def\@no@post@desc{\nopostdesc}% + \ifx\glo@desc\@no@post@desc + \else + \ifstrempty{##3}{}{\space##3}% + \fi + \ifglshaschildren{##1}% + {% + \glsresetsubentrycounter + \glsinlineparentchildseparator + \def\gls@inlinesubsep{}% + }% + {}% + \def\gls@inlinesep{\glsinlineseparator}% + }% +% \end{macrocode} +% Sub-entries display description but no name: +% \begin{macrocode} + \renewcommand*{\glossarysubentryfield}[6]{% + \gls@inlinesubsep% + \glstarget{##2}{}% + \glssubentryitem{##2}##4% + \def\gls@inlinesubsep{\glsinlinesubseparator}% + }% +% \end{macrocode} +% Nothing special between groups: +% \begin{macrocode} + \renewcommand*{\glsgroupskip}{}% +} +% \end{macrocode} +%\end{style} +% +%\begin{macro}{\glsinlineseparator} +% Separator to use between entries. +% \begin{macrocode} +\newcommand*{\glsinlineseparator}{;\space} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsinlinesubseparator} +% Separator to use between sub-entries. +% \begin{macrocode} +\newcommand*{\glsinlinesubseparator}{,\space} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsinlineparentchildseparator} +% Separator to use between parent and children. +% \begin{macrocode} +\newcommand*{\glsinlineparentchildseparator}{:\space} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glspostinline} +% Terminator for inline glossary. +% \begin{macrocode} +\newcommand*{\glspostinline}{.\space} +% \end{macrocode} +%\end{macro} +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*glossary-list.sty> % \end{macrocode} %\fi @@ -12325,17 +12870,303 @@ false,nolabel,autolabel}[nolabel]{% % \end{macrocode} % Add table header and horizontal line at the table's foot: % \begin{macrocode} - \renewcommand*{\glossaryheader}{% - \hline\bfseries\entryname&\bfseries\descriptionname& - \bfseries \symbolname& - \bfseries\pagelistname\tabularnewline\hline\endhead - \hline\endfoot}% -} + \renewcommand*{\glossaryheader}{% + \hline\bfseries\entryname&\bfseries\descriptionname& + \bfseries \symbolname& + \bfseries\pagelistname\tabularnewline\hline\endhead + \hline\endfoot}% +} +% \end{macrocode} +%\end{style} +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +%<*glossary-mcols.sty> +% \end{macrocode} +%\fi +%\subsection{Glossary Styles using \styfmt{multicol} +%(glossary-mcols.sty)} +%The \isty{glossary-mcols} style file defines glossary styles that +%use the \sty{multicol} package. These use the tree-like glossary +%styles in a multicol environment. +% \begin{macrocode} +\ProvidesPackage{glossary-mcols}[2012/05/21 v1.0 (NLCT)] +% \end{macrocode} +% Required packages: +% \begin{macrocode} +\RequirePackage{multicol} +\RequirePackage{glossary-tree} +% \end{macrocode} +% +%\begin{macro}{\glsmcols} +% Define macro in which to store the number of columns. (Defaults to +% 2.) +% \begin{macrocode} +\newcommand*{\glsmcols}{2} +% \end{macrocode} +%\end{macro} +% +%\begin{style}{mcolindex} +% Multi-column index style. Same as the \glostyle{index}, but puts the +% glossary in multiple columns. (Ideally the glossary title should go in the +% optional argument of \env{multicols}, but the title isn't part of +% the glossary style.) +% \begin{macrocode} +\newglossarystyle{mcolindex}{% + \glossarystyle{index}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + \let\item\@idxitem}% + {\end{multicols}}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcolindexgroup} +% As \glostyle{mcolindex} but has headings: +% \begin{macrocode} +\newglossarystyle{mcolindexgroup}{% + \glossarystyle{mcolindex}% + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsgetgrouptitle{##1}}\indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcolindexhypergroup} +% The \glostyle{mcolindexhypergroup} style is like the +% \glostyle{mcolindexgroup} style but has hyper navigation. +% \begin{macrocode} +\newglossarystyle{mcolindexhypergroup}{% +% \end{macrocode} +% Base it on the glostyle{mcolindex} style: +% \begin{macrocode} + \glossarystyle{mcolindex}% +% \end{macrocode} +% Put navigation links to the groups at the start of the glossary: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \item\textbf{\glsnavigation}\indexspace}% +% \end{macrocode} +% Add a heading for each group (with a target). The group's title is +% in bold followed by a vertical gap. +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% + \indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltree} +% Multi-column index style. Same as the \glostyle{tree}, but puts the +% glossary in multiple columns. +% \begin{macrocode} +\newglossarystyle{mcoltree}{% + \glossarystyle{tree}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + }% + {\end{multicols}}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltreegroup} +% Like the \glostyle{mcoltree} style but the glossary groups have +% headings. +% \begin{macrocode} +\newglossarystyle{mcoltreegroup}{% +% \end{macrocode} +% Base it on the glostyle{mcoltree} style: +% \begin{macrocode} + \glossarystyle{mcoltree}% +% \end{macrocode} +% Each group has a heading (in bold) followed by a vertical gap): +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltreehypergroup} +% The \glostyle{mcoltreehypergroup} style is like the +% \glostyle{treegroup} +% style, but has a set of links to the groups at the +% start of the glossary. +% \begin{macrocode} +\newglossarystyle{mcoltreehypergroup}{% +% \end{macrocode} +% Base it on the glostyle{mcoltree} style: +% \begin{macrocode} + \glossarystyle{mcoltree}% +% \end{macrocode} +% Put navigation links to the groups at the start of the +% \env{theglossary} environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% +% \end{macrocode} +% Each group has a heading (in bold with a target) followed by a +% vertical gap): +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltreenoname} +% Multi-column index style. Same as the \glostyle{treenoname}, but puts the +% glossary in multiple columns. +% \begin{macrocode} +\newglossarystyle{mcoltreenoname}{% + \glossarystyle{treenoname}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + }% + {\end{multicols}}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltreenonamegroup} +% Like the \glostyle{mcoltreenoname} style but the glossary groups have +% headings. +% \begin{macrocode} +\newglossarystyle{mcoltreenonamegroup}{% +% \end{macrocode} +% Base it on the glostyle{mcoltreenoname} style: +% \begin{macrocode} + \glossarystyle{mcoltreenoname}% +% \end{macrocode} +% Give each group a heading: +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcoltreenonamehypergroup} +% The \glostyle{mcoltreenonamehypergroup} style is like the +% \glostyle{mcoltreenonamegroup} +% style, but has a set of links to the groups at the +% start of the glossary. +% \begin{macrocode} +\newglossarystyle{mcoltreenonamehypergroup}{% +% \end{macrocode} +% Base it on the glostyle{mcoltreenoname} style: +% \begin{macrocode} + \glossarystyle{mcoltreenoname}% +% \end{macrocode} +% Put navigation links to the groups at the start of the +% \env{theglossary} environment: +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% +% \end{macrocode} +% Each group has a heading (in bold with a target) followed by a +% vertical gap): +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcolalttree} +% Multi-column index style. Same as the \glostyle{alttree}, but puts the +% glossary in multiple columns. +% \begin{macrocode} +\newglossarystyle{mcolalttree}{% + \glossarystyle{alttree}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2}% + \def\@gls@prevlevel{-1}% + \mbox{}\par + }% + {\par\end{multicols}}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcolalttreegroup} +% Like the \glostyle{mcolalttree} style but the glossary groups have +% headings. +% \begin{macrocode} +\newglossarystyle{mcolalttreegroup}{% +% \end{macrocode} +% Base it on the glostyle{mcolalttree} style: +% \begin{macrocode} + \glossarystyle{mcolalttree}% +% \end{macrocode} +% Give each group a heading. +% \begin{macrocode} + \renewcommand{\glsgroupheading}[1]{\par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +% \end{macrocode} +%\end{style} +% +%\begin{style}{mcolalttreehypergroup} +% The \glostyle{mcolalttreehypergroup} style is like the +% \glostyle{mcolalttreegroup} style, but has a set of links to the +% groups at the start of the glossary. +% \begin{macrocode} +\newglossarystyle{mcolalttreehypergroup}{% +% \end{macrocode} +% Base it on the glostyle{mcolalttree} style: +% \begin{macrocode} + \glossarystyle{mcolalttree}% +% \end{macrocode} +% Put the navigation links in the header +% \begin{macrocode} + \renewcommand*{\glossaryheader}{% + \par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsnavigation}\par\indexspace}% +% \end{macrocode} +% Put a hypertarget at the start of each group +% \begin{macrocode} + \renewcommand*{\glsgroupheading}[1]{% + \par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}} % \end{macrocode} %\end{style} + + %\iffalse % \begin{macrocode} -% +% % \end{macrocode} %\fi %\iffalse @@ -16625,6 +17456,303 @@ Sheet} %\fi %\iffalse % \begin{macrocode} +%<*sample-inline.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} + % This file is public domain +\documentclass[a4paper]{report} + +\usepackage[plainpages=false,colorlinks]{hyperref} +\usepackage[toc,order=word,subentrycounter]{glossaries} + +\usepackage{glossary-inline} + +\renewcommand*{\glossarysection}[2][]{\textbf{#1}: } +\renewcommand{\glsnamefont}[1]{\textsc{#1}} +\glossarystyle{inline} + +\makeglossaries + +\newglossaryentry{Perl}{name=\texttt{Perl}, +sort=Perl, % need a sort key because name contains a command +description=A scripting language} + +\newglossaryentry{glossary}{name=glossary, +description={\nopostdesc}, +plural={glossaries}} + +\newglossaryentry{glossarycol}{ +description={collection of glosses}, +sort={2}, +parent={glossary}} + +\newglossaryentry{glossarylist}{ +description={list of technical words}, +sort={1}, +parent={glossary}} + +\newglossaryentry{pagelist}{name=page list, + % description value has to be enclosed in braces + % because it contains commas +description={a list of individual pages or page ranges +(e.g.\ 1,2,4,7-9)}} + +\newglossaryentry{mtrx}{name=matrix, +description={rectangular array of quantities}, + % plural is not simply obtained by appending an s, so specify +plural=matrices} + + % entry with a paragraph break in the description + +\newglossaryentry{par}{name=paragraph, +description={distinct section of piece of +writing. Beginning on new, usually indented, line}} + + % entry with two types of plural. Set the plural form to the + % form most likely to be used. If you want to use a different + % plural, you will need to explicity specify it in \glslink +\newglossaryentry{cow}{name=cow, + % this isn't necessary, as this form (appending an s) is + % the default +plural=cows, + % description: +description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult +female of any bovine animal}} + +\newglossaryentry{bravo}{name={bravo}, +description={\nopostdesc}} + +\newglossaryentry{bravo1}{description={cry of approval (pl.\ bravos)}, +sort={1}, +plural={bravos}, +parent=bravo} + +\newglossaryentry{bravo2}{description={hired ruffian or killer (pl.\ bravoes)}, +sort={2}, +plural={bravoes}, +parent=bravo} + +\newglossaryentry{seal}{name=seal,description={sea mammal with +flippers that eats fish}} + +\newglossaryentry{sealion}{name={sea lion}, +description={large seal}} + +\begin{document} + +\title{Sample Document Using glossary Package} +\author{Nicola Talbot} +\pagenumbering{alph}% prevent duplicate page link names if using PDF +\maketitle + +\pagenumbering{roman} +\tableofcontents + +\chapter{Introduction} +\pagenumbering{arabic} + +This document has a glossary in a footnote\footnote{\printglossaries}. + +A \gls{glossarylist} (definition~\glsrefentry{glossarylist}) is a +very useful addition to any technical document, although a +\gls{glossarycol} (definition~\glsrefentry{glossarycol}) can also +simply be a collection of glosses, which is another thing entirely. +Some documents have multiple \glspl{glossarylist}. + +Once you have run your document through \LaTeX, you +will then need to run the \texttt{.glo} file through +\texttt{makeindex}. You will need to set the output +file so that it creates a \texttt{.gls} file instead +of an \texttt{.ind} file, and change the name of +the log file so that it doesn't overwrite the index +log file (if you have an index for your document). +Rather than having to remember all the command line +switches, you can call the \gls{Perl} script +\texttt{makeglossaries} which provides a convenient +wrapper. + +If a comma appears within the name or description, grouping +must be used, e.g.\ in the description of \gls{pagelist}. + +\chapter{Plurals and Paragraphs} + +Plurals are assumed to have the letter s appended, but if this is +not the case, as in \glspl{mtrx}, then you need to specify the +plural when you define the entry. If a term may have multiple +plurals (for example \glspl{cow}/\glslink{cow}{kine}) then +define the entry with the plural form most likely to be used and +explicitly specify the alternative form using \verb|\glslink|. +\Glspl{seal} and \glspl{sealion} have regular plural forms. + +\Gls{bravo} is a homograph, but the plural forms are spelt +differently. The plural of \gls{bravo1}, a cry of approval +(definition~\glsrefentry{bravo1}), is \glspl{bravo1}, whereas the +plural of \gls{bravo2}, a hired ruffian or killer +(definition~\glsrefentry{bravo2}), is \glspl{bravo2}. + +\Glspl{par} can cause a problem in commands, so care is needed +when having a paragraph break in a \gls{glossarylist} entry. + +\chapter{Ordering} + +There are two types of ordering: word ordering (which places +``\gls{sealion}'' before ``\gls{seal}'') and letter ordering +(which places ``\gls{seal}'' before ``\gls{sealion}''). + + + +\end{document} +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +%<*sample-langdict.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +\documentclass[english,french]{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{babel} +\usepackage[nomain]{glossaries} + +\newglossary[glg]{english}{gls}{glo}{English to French} +\newglossary[flg]{french}{fls}{flo}{French to English} + +\makeglossaries + + % \newword{label}{english}{determiner}{french} +\newcommand*{\newword}[4]{% + \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}% + \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4},description={#2}}% +} + +\newword{cat}{cat}{le}{chat} +\newword{mat}{mat}{la}{natte} + +\begin{document} +\selectlanguage{english} +The \gls{en-cat} sat on the \gls{en-mat}. + +\selectlanguage{french} +Le \gls{fr-cat} s'est repos\'e sur la \gls{fr-mat}. + +\selectlanguage{english} +\printglossary[type=english] + +\selectlanguage{french} +\printglossary[type=french] +\end{document} +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +%<*sample-mfirstuc.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +\documentclass{article} + +\usepackage{mfirstuc} + +\begin{document} + +\makefirstuc{abc}. + +\makefirstuc{{\em abc}}. + +\makefirstuc{\emph{abc}}. + +\makefirstuc{\ae bc}. + +\makefirstuc{{\ae}bc}. + +\newcommand{\abc}{abc}% +\xmakefirstuc{\abc}. + +\capitalisewords{a book of rhyme.} + +\capitalisewords{a book\space of rhyme.} + +\newcommand{\mytitle}{a book\space of rhyme.} +\capitalisewords{\mytitle} + +\xcapitalisewords{\mytitle} + + +\end{document} +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +%<*sample-numberlist.tex> +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[savenumberlist,counter=chapter]{glossaries} + +\makeglossaries + +\newglossaryentry{sample}{name=sample,description=an example} + +\begin{document} +\chapter{Introduction} + +This is a \glsentryname{sample} document. \Glsentryplural{sample} +are discussed in chapters~\glsdisplaynumberlist{sample}. + +\chapter{Sample Documents} + +\Gls{sample} documents are provided for testing and illustration +purposes. + +\chapter{More About Samples} + +Here's more information about \glspl{sample}. + +\chapter{Another chapter} + +A chapter about something else. + +\chapter{Another About Samples} + +Here's some more information about \glspl{sample}. + +\printglossaries +\end{document} +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*sample.tex> % \end{macrocode} %\fi @@ -17206,13 +18334,15 @@ one \gls[format=hyperbf]{svm}. \usepackage{amsmath} \usepackage[colorlinks]{hyperref} -\usepackage[style=long3colheader,counter=equation]{glossaries} +\usepackage[toc,ucmark,style=long3colheader,counter=equation]{glossaries} \makeglossaries \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} +\pagestyle{headings} + % redefine the way hyperref creates the target for equations % so that the glossary links to equation numbers work diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index 1fff61cf90b..91f62e20856 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins @@ -1,10 +1,10 @@ -% glossaries.ins generated using makedtx version 0.94b 2011/4/13 19:39 +% glossaries.ins generated using makedtx version 0.94b 2012/5/21 14:06 \input docstrip \preamble glossaries.dtx - Copyright 2011 Nicola Talbot + Copyright 2012 Nicola Talbot This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 @@ -18,7 +18,7 @@ The Current Maintainer of this work is Nicola Talbot. - This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. + This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. \endpreamble @@ -30,12 +30,16 @@ \usepostamble\defaultpostamble\from{glossaries.dtx}{mfirstuc.sty,package}} \file{glossary-hypernav.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-hypernav.sty,package}} +\file{glossary-inline.sty}{\usepreamble\defaultpreamble +\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-inline.sty,package}} \file{glossary-list.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-list.sty,package}} \file{glossary-long.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-long.sty,package}} \file{glossary-longragged.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-longragged.sty,package}} +\file{glossary-mcols.sty}{\usepreamble\defaultpreamble +\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-mcols.sty,package}} \file{glossary-super.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-super.sty,package}} \file{glossary-superragged.sty}{\usepreamble\defaultpreamble @@ -78,6 +82,10 @@ \file{sample-crossref.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-crossref.tex}} \file{sample-custom-acronym.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-custom-acronym.tex}} \file{sample-dual.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-dual.tex}} +\file{sample-inline.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-inline.tex}} +\file{sample-langdict.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-langdict.tex}} +\file{sample-mfirstuc.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-mfirstuc.tex}} +\file{sample-numberlist.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample-numberlist.tex}} \file{sample.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample.tex}} \file{sample4col.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample4col.tex}} \file{sampleaccsupp.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleaccsupp.tex}} 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 cb4c936813a..0137acf05a2 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty index 05bd60a57d5..86f59c1b1da 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty index a92f5411d54..da5a7b8b7a8 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 33ad66443ea..6656ebafc85 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2011/04/12 v3.01 (NLCT)] +\ProvidesPackage{glossaries}[2012/05/21 v3.02 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -74,9 +74,12 @@ false,nolabel,autolabel}[nolabel]{% \newcommand*{\@glossary@default@style}{list} \define@key{glossaries.sty}{style}{% \renewcommand*{\@glossary@default@style}{#1}} -\newcommand*{\glossaryentrynumbers}[1]{#1} +\newcommand*{\glossaryentrynumbers}[1]{#1\gls@save@numberlist{#1}} \DeclareOptionX{nonumberlist}{% -\renewcommand*{\glossaryentrynumbers}[1]{}} + \renewcommand*{\glossaryentrynumbers}[1]{\gls@save@numberlist{#1}}% +} +\define@boolkey{glossaries.sty}[gls]{savenumberlist}[true]{} +\glssavenumberlistfalse \newcommand*\@glo@seeautonumberlist{} \DeclareOptionX{seeautonumberlist}{% \renewcommand*{\@glo@seeautonumberlist}{% @@ -100,6 +103,8 @@ false,nolabel,autolabel}[nolabel]{% \renewcommand*{\@gls@loadtree}{}% \let\@glossary@default@style\relax } +\define@boolkey{glossaries.sty}[gls]{ucmark}[true]{} +\glsucmarkfalse \define@boolkey{glossaries.sty}[gls]{entrycounter}[true]{} \glsentrycounterfalse \define@key{glossaries.sty}{counterwithin}{% @@ -261,9 +266,17 @@ name=true]{% } \define@boolkey{glossaries.sty}[gls]{translate}[true]{} \glstranslatefalse -\@ifpackageloaded{translator}{\glstranslatetrue}{% -\@ifpackageloaded{babel}{\glstranslatetrue}{% -\@ifpackageloaded{polyglossia}{\glstranslatetrue}{}}} + \@ifpackageloaded{translator}% + {\glstranslatetrue}% + {% + \@ifpackageloaded{polyglossia}% + {\glstranslatetrue}% + {% + \@ifpackageloaded{babel}{\glstranslatetrue}{}% + }% +} +\define@boolkey{glossaries.sty}[gls]{indexonlyfirst}[true]{} +\glsindexonlyfirstfalse \define@boolkey{glossaries.sty}[gls]{hyperfirst}[true]{} \glshyperfirsttrue \define@boolkey{glossaries.sty}[glsacr]{footnote}[true]{% @@ -319,8 +332,20 @@ name=true]{% \csname glscompatible-2.07false\endcsname \ProcessOptionsX \ifglstranslate - \@ifpackageloaded{babel}{\IfFileExists{translator.sty}{% - \RequirePackage{translator}}{}}{} + \@ifpackageloaded{polyglossia}% + {% + }% + {% + \@ifpackageloaded{babel}% + {% + \IfFileExists{translator.sty}% + {% + \RequirePackage{translator}% + }% + {}% + }% + {} + } \fi \ifthenelse{\equal{\glscounter}{section}}% {% @@ -425,11 +450,11 @@ name=true]{% \renewcommand*{\glsnumbersgroupname}{% \translate{Numbers (glossaries)}}% }{% - \@ifpackageloaded{babel}% - {\RequirePackage{glossaries-babel}}% + \@ifpackageloaded{polyglossia}% + {\RequirePackage{glossaries-polyglossia}}% {% - \@ifpackageloaded{polyglossia}{% - \RequirePackage{glossaries-polyglossia}}{}% + \@ifpackageloaded{babel}{% + \RequirePackage{glossaries-babel}}{}% }} \fi \newcommand*{\glspostdescription}{.} @@ -499,18 +524,36 @@ name=true]{% } \ifcsundef{glossarymark}% {% - \newcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \ifglsucmark + \newcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \newcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \fi }% {% \GlossariesWarning{overriding \string\glossarymark}% \@ifclassloaded{memoir}% { - \renewcommand{\glossarymark}[1]{% - \markboth{\memUChead{#1}}{\memUChead{#1}}% - } + \ifglsucmark + \renewcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \renewcommand{\glossarymark}[1]{% + \markboth{\memUChead{#1}}{\memUChead{#1}}% + } + \fi } { - \renewcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \ifglsucmark + \renewcommand{\glossarymark}[1]{% + \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}% + } + \else + \renewcommand{\glossarymark}[1]{\@mkboth{#1}{#1}} + \fi } } \newcommand*{\setglossarysection}[1]{% @@ -900,6 +943,30 @@ name=true]{% \PackageError{glossaries}{Glossary entry `#1' has already been defined}{}}{#2}% } +\newcommand{\ifglshaschildren}[3]{% + \glsdoifexists{#1}% + {% + \def\do@glshaschildren{#3}% + \expandafter\forglsentries\expandafter[\csname glo@#1@type\endcsname] + {\glo@label}% + {% + \letcs\glo@parent{glo@\glo@label @parent}% + \ifthenelse{\equal{#1}{\glo@parent}}% + {% + \def\do@glshaschildren{#2}% + \@endfortrue + }% + {}% + }% + \do@glshaschildren + }% +} +\newcommand{\ifglshasparent}[3]{% + \glsdoifexists{#1}% + {% + \ifcsempty{glo@#1@parent}{#3}{#2}% + }% +} \newcommand*{\@glo@types}{,} \newcommand*{\newglossary}[5][glg]{% \ifglossaryexists{#2}{% @@ -1040,163 +1107,212 @@ name=true]{% \string\newglossaryentry\space for entry `\@glo@label'}{You haven't specified the entry name}} \newcommand*{\@glsdefaultplural}{\@glo@text\glspluralsuffix} +\newcommand*{\@gls@missingnumberlist}[1]{% + ??% + \ifglssavenumberlist + \GlossariesWarning{Missing number list for entry `#1'. + Maybe makeglossaries + rerun required.}% + \else + \PackageError{glossaries}% + {Package option `savenumberlist=true' required.}% + {% + You must use the `savenumberlist' package option + to reference location lists.% + }% + \fi +} \newcommand*{\@glsdefaultsort}{\@glo@name} \newcount\gls@level \newrobustcmd{\newglossaryentry}[2]{% -\glsdoifnoexists{#1}{% -\def\@glo@label{#1}% -\let\@glo@name\@glsnoname -\def\@glo@desc{\PackageError{glossaries}{description key required in -\string\newglossaryentry\space for entry `\@glo@label'}{You haven't specified the entry description}}% -\def\@glo@descplural{\@glo@desc}% -\def\@glo@type{\glsdefaulttype}% -\def\@glo@symbol{\relax}% -\def\@glo@symbolplural{\@glo@symbol}% -\def\@glo@text{\@glo@name}% -\let\@glo@plural\@glsdefaultplural -\let\@glo@first\relax -\let\@glo@firstplural\relax -\let\@glo@sort\@glsdefaultsort -\def\@glo@counter{\@gls@getcounter{\@glo@type}}% -\def\@glo@see{}% -\def\@glo@parent{}% -\def\@glo@prefix{}% -\def\@glo@useri{}% -\def\@glo@userii{}% -\def\@glo@useriii{}% -\def\@glo@useriv{}% -\def\@glo@userv{}% -\def\@glo@uservi{}% -\def\@glo@short{}% -\def\@glo@shortpl{}% -\def\@glo@long{}% -\def\@glo@longpl{}% - \@newglossaryentryprehook -\setkeys{glossentry}{#2}% -\ifcsundef{glolist@\@glo@type}% -{% - \PackageError{glossaries}% - {Glossary type '\@glo@type' has not been defined}% - {You need to define a new glossary type, before making entries - in it}% -}% -{% - \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% - \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% -}% -\gls@level=0\relax -\ifx\@glo@parent\@empty - \expandafter\gdef\csname glo@#1@parent\endcsname{}% -\else - \ifthenelse{\equal{#1}{\@glo@parent}}{% - \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \glsdoifnoexists{#1}% + {% + \def\@glo@label{#1}% + \let\@glo@name\@glsnoname + \def\@glo@desc{% + \PackageError{glossaries} + {% + description key required in \string\newglossaryentry\space + for entry `\@glo@label'% + }% + {% + You haven't specified the entry description% + }% + }% + \def\@glo@descplural{\@glo@desc}% + \def\@glo@type{\glsdefaulttype}% + \def\@glo@symbol{\relax}% + \def\@glo@symbolplural{\@glo@symbol}% + \def\@glo@text{\@glo@name}% + \let\@glo@plural\@glsdefaultplural + \let\@glo@first\relax + \let\@glo@firstplural\relax + \let\@glo@sort\@glsdefaultsort + \def\@glo@counter{\@gls@getcounter{\@glo@type}}% + \def\@glo@see{}% \def\@glo@parent{}% - \expandafter\gdef\csname glo@#1@parent\endcsname{}% - }{% - \ifglsentryexists{\@glo@parent}{% - \expandafter\xdef\csname glo@#1@parent\endcsname{\@glo@parent}% - \gls@level=\csname glo@\@glo@parent @level\endcsname\relax - \advance\gls@level by 1\relax - \ifx\@glo@name\@glsnoname - \expandafter\let\expandafter\@glo@name - \csname glo@\@glo@parent @name\endcsname - \ifx\@glo@plural\@glsdefaultplural - \expandafter\let\expandafter\@glo@plural - \csname glo@\@glo@parent @plural\endcsname - \fi - \fi - }{% - \PackageError{glossaries}{Invalid parent `\@glo@parent' - for entry `#1' - parent doesn't exist}{Parent entries - must be defined before their children}% - \def\@glo@parent{}% + \def\@glo@prefix{}% + \def\@glo@useri{}% + \def\@glo@userii{}% + \def\@glo@useriii{}% + \def\@glo@useriv{}% + \def\@glo@userv{}% + \def\@glo@uservi{}% + \def\@glo@short{}% + \def\@glo@shortpl{}% + \def\@glo@long{}% + \def\@glo@longpl{}% + \@newglossaryentryprehook + \setkeys{glossentry}{#2}% + \ifcsundef{glolist@\@glo@type}% + {% + \PackageError{glossaries}% + {Glossary type '\@glo@type' has not been defined}% + {You need to define a new glossary type, before making entries + in it}% + }% + {% + \protected@edef\@glolist@{\csname glolist@\@glo@type\endcsname}% + \expandafter\xdef\csname glolist@\@glo@type\endcsname{\@glolist@{#1},}% + }% + \gls@level=0\relax + \ifx\@glo@parent\@empty \expandafter\gdef\csname glo@#1@parent\endcsname{}% - }% + \else + \ifthenelse{\equal{#1}{\@glo@parent}}% + {% + \PackageError{glossaries}{Entry `#1' can't be its own parent}{}% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }% + {% + \ifglsentryexists{\@glo@parent}% + {% + \expandafter\xdef\csname glo@#1@parent\endcsname{\@glo@parent}% + \gls@level=\csname glo@\@glo@parent @level\endcsname\relax + \advance\gls@level by 1\relax + \ifx\@glo@name\@glsnoname + \expandafter\let\expandafter\@glo@name + \csname glo@\@glo@parent @name\endcsname + \ifx\@glo@plural\@glsdefaultplural + \expandafter\let\expandafter\@glo@plural + \csname glo@\@glo@parent @plural\endcsname + \fi + \fi + }% + {% + \PackageError{glossaries}% + {% + Invalid parent `\@glo@parent' + for entry `#1' - parent doesn't exist% + }% + {% + Parent entries must be defined before their children% + }% + \def\@glo@parent{}% + \expandafter\gdef\csname glo@#1@parent\endcsname{}% + }% + }% + \fi + \expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% + \ifx\relax\@glo@firstplural + \ifx\relax\@glo@first + \def\@glo@firstplural{\@glo@plural}% + \def\@glo@first{\@glo@text}% + \else + \def\@glo@firstplural{\@glo@first\glspluralsuffix}% + \fi + \else + \ifx\relax\@glo@first + \def\@glo@first{\@glo@text}% + \fi + \fi + \expandafter + \protected@xdef\csname glo@#1@text\endcsname{\@glo@text}% + \expandafter + \protected@xdef\csname glo@#1@plural\endcsname{\@glo@plural}% + \expandafter + \protected@xdef\csname glo@#1@first\endcsname{\@glo@first}% + \expandafter + \protected@xdef\csname glo@#1@firstpl\endcsname{\@glo@firstplural}% + \expandafter + \protected@xdef\csname glo@#1@type\endcsname{\@glo@type}% + \expandafter + \protected@xdef\csname glo@#1@counter\endcsname{\@glo@counter}% + \expandafter + \protected@xdef\csname glo@#1@useri\endcsname{\@glo@useri}% + \expandafter + \protected@xdef\csname glo@#1@userii\endcsname{\@glo@userii}% + \expandafter + \protected@xdef\csname glo@#1@useriii\endcsname{\@glo@useriii}% + \expandafter + \protected@xdef\csname glo@#1@useriv\endcsname{\@glo@useriv}% + \expandafter + \protected@xdef\csname glo@#1@userv\endcsname{\@glo@userv}% + \expandafter + \protected@xdef\csname glo@#1@uservi\endcsname{\@glo@uservi}% + \expandafter + \protected@xdef\csname glo@#1@short\endcsname{\@glo@short}% + \expandafter + \protected@xdef\csname glo@#1@shortpl\endcsname{\@glo@shortpl}% + \expandafter + \protected@xdef\csname glo@#1@long\endcsname{\@glo@long}% + \expandafter + \protected@xdef\csname glo@#1@longpl\endcsname{\@glo@longpl}% + \@gls@sanitizename + \expandafter\protected@xdef\csname glo@#1@name\endcsname{\@glo@name}% + \ifcsundef{glo@#1@numberlist}% + {% + \csxdef{glo@#1@numberlist}{\noexpand\@gls@missingnumberlist{\@glo@label}}% + }% + {}% + \def\@glo@@desc{\@glo@first}% + \ifx\@glo@desc\@glo@@desc + \let\@glo@desc\@glo@first + \fi + \@gls@sanitizedesc + \expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% + \expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% + \@gls@defsort{\@glo@type}{#1}% + \def\@glo@@symbol{\@glo@text}% + \ifx\@glo@symbol\@glo@@symbol + \let\@glo@symbol\@glo@text + \fi + \@gls@sanitizesymbol + \expandafter\protected@xdef\csname glo@#1@symbol\endcsname{\@glo@symbol}% + \expandafter\protected@xdef\csname glo@#1@symbolplural\endcsname{\@glo@symbolplural}% + \expandafter\gdef\csname glo@#1@flagfalse\endcsname{% + \expandafter\global\expandafter + \let\csname ifglo@#1@flag\endcsname\iffalse + }% + \expandafter\gdef\csname glo@#1@flagtrue\endcsname{% + \expandafter\global\expandafter + \let\csname ifglo@#1@flag\endcsname\iftrue + }% + \csname glo@#1@flagfalse\endcsname + \ifx\@glo@see\@empty + \else + \protected@edef\@do@glssee{% + \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see + \noexpand\@nil + \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% + \@do@glssee + \fi }% -\fi -\expandafter\xdef\csname glo@#1@level\endcsname{\number\gls@level}% -\ifx\relax\@glo@firstplural - \ifx\relax\@glo@first - \def\@glo@firstplural{\@glo@plural}% - \def\@glo@first{\@glo@text}% - \else - \def\@glo@firstplural{\@glo@first\glspluralsuffix}% - \fi -\else - \ifx\relax\@glo@first - \def\@glo@first{\@glo@text}% - \fi -\fi -\expandafter - \protected@xdef\csname glo@#1@text\endcsname{\@glo@text}% -\expandafter - \protected@xdef\csname glo@#1@plural\endcsname{\@glo@plural}% -\expandafter - \protected@xdef\csname glo@#1@first\endcsname{\@glo@first}% -\expandafter - \protected@xdef\csname glo@#1@firstpl\endcsname{\@glo@firstplural}% -\expandafter - \protected@xdef\csname glo@#1@type\endcsname{\@glo@type}% -\expandafter - \protected@xdef\csname glo@#1@counter\endcsname{\@glo@counter}% -\expandafter - \protected@xdef\csname glo@#1@useri\endcsname{\@glo@useri}% -\expandafter - \protected@xdef\csname glo@#1@userii\endcsname{\@glo@userii}% -\expandafter - \protected@xdef\csname glo@#1@useriii\endcsname{\@glo@useriii}% -\expandafter - \protected@xdef\csname glo@#1@useriv\endcsname{\@glo@useriv}% -\expandafter - \protected@xdef\csname glo@#1@userv\endcsname{\@glo@userv}% -\expandafter - \protected@xdef\csname glo@#1@uservi\endcsname{\@glo@uservi}% -\expandafter - \protected@xdef\csname glo@#1@short\endcsname{\@glo@short}% -\expandafter - \protected@xdef\csname glo@#1@shortpl\endcsname{\@glo@shortpl}% -\expandafter - \protected@xdef\csname glo@#1@long\endcsname{\@glo@long}% -\expandafter - \protected@xdef\csname glo@#1@longpl\endcsname{\@glo@longpl}% -\@gls@sanitizename -\expandafter\protected@xdef\csname glo@#1@name\endcsname{\@glo@name}% -\def\@glo@@desc{\@glo@first}% -\ifx\@glo@desc\@glo@@desc - \let\@glo@desc\@glo@first -\fi -\@gls@sanitizedesc -\expandafter\protected@xdef\csname glo@#1@desc\endcsname{\@glo@desc}% -\expandafter\protected@xdef\csname glo@#1@descplural\endcsname{\@glo@descplural}% -\@gls@defsort{\@glo@type}{#1}% -\def\@glo@@symbol{\@glo@text}% -\ifx\@glo@symbol\@glo@@symbol - \let\@glo@symbol\@glo@text -\fi -\@gls@sanitizesymbol -\expandafter\protected@xdef\csname glo@#1@symbol\endcsname{\@glo@symbol}% -\expandafter\protected@xdef\csname glo@#1@symbolplural\endcsname{\@glo@symbolplural}% -\expandafter\gdef\csname glo@#1@flagfalse\endcsname{% -\expandafter\global\expandafter -\let\csname ifglo@#1@flag\endcsname\iffalse}% -\expandafter\gdef\csname glo@#1@flagtrue\endcsname{% -\expandafter\global\expandafter -\let\csname ifglo@#1@flag\endcsname\iftrue}% -\csname glo@#1@flagfalse\endcsname -\ifx\@glo@see\@empty -\else - \protected@edef\@do@glssee{% - \noexpand\@gls@fixbraces\noexpand\@glo@list\@glo@see - \noexpand\@nil - \noexpand\expandafter\noexpand\@glssee\noexpand\@glo@list{#1}}% - \@do@glssee -\fi -}% \do@glo@storeentry{#1}% \@newglossaryentryposthook } \newcommand*{\@newglossaryentryprehook}{} \newcommand*{\@newglossaryentryposthook}{} +\newcommand*{\glsmoveentry}[2]{% + \edef\glo@type{\csname glo@#1@type\endcsname}% + \def\glo@list{,}% + \forglsentries[\glo@type]{\glo@label}% + {% + \ifthenelse{\equal{\glo@label}{#1}}{}{\eappto\glo@list{\glo@label,}}% + }% + \cslet{glolist@\glo@type}{\glo@list}% + \csdef{glo@#1@type}{#2}% +} \ifglsxindy \newcommand*{\@glossaryentryfield}{\string\\glossaryentryfield} \else @@ -1338,11 +1454,13 @@ name=true]{% \@gls@setsort{#2}% \@do@wrglossary{#2}% \ifKV@glslink@hyper - \@glslink{glo:#2}{\glstextformat{#3}}% + \@glslink{\glolinkprefix#2}{\glstextformat{#3}}% \else \glstextformat{#3}\relax \fi } +\newcommand*{\glolinkprefix}{glo:} +\def\glsentrycounter{\glscounter}% \newcommand*{\@gls@saveentrycounter}{% \def\@gls@Hcounter{}% \ifthenelse{\equal{\@gls@counter}{equation}}% @@ -2711,17 +2829,71 @@ name=true]{% \glsentrylong{#1}\space(\glsentryshort{#1})% } \newcommand*{\Glsentryfull}[1]{% - \Glsentrylong{#1}\space(\glsentryshortpl{#1})% + \Glsentrylong{#1}\space(\glsentryshort{#1})% } \newcommand*{\glsentryfullpl}[1]{% - \glsentrylongpl{#1}\space(\glsentryshort{#1})% + \glsentrylongpl{#1}\space(\glsentryshortpl{#1})% } \newcommand*{\Glsentryfullpl}[1]{% \Glsentrylongpl{#1}\space(\glsentryshortpl{#1})% } +\newcommand*{\glsentrynumberlist}[1]{% + \glsdoifexists{#1}% + {% + \csname glo@#1@numberlist\endcsname + }% +} +\@ifpackageloaded{hyperref} +{% + \newcommand*{\glsdisplaynumberlist}[1]{% + \GlossariesWarning + {% + \string\glsdisplaynumberlist\space + doesn't work with hyperref.^^JUsing + \string\glsentrynumberlist\space instead% + }% + \glsentrynumberlist{#1}% + }% +}% +{% + \newcommand*{\glsdisplaynumberlist}[1]{% + \glsdoifexists{#1}% + {% + \bgroup + \def\@glo@label{#1}% + \let\@org@glsnumberformat\glsnumberformat + \def\glsnumberformat##1{##1}% + \protected@edef\the@numberlist{\csname glo@\@glo@label @numberlist\endcsname}% + \def\@gls@numlist@sep{}% + \def\@gls@numlist@nextsep{}% + \def\@gls@numlist@lastsep{}% + \def\@gls@thislist{}% + \def\@gls@donext@def{}% + \renewcommand\do[1]{% + \protected@edef\@gls@thislist{% + \@gls@thislist + \noexpand\@gls@numlist@sep + ##1% + }% + \let\@gls@numlist@sep\@gls@numlist@nextsep + \def\@gls@numlist@nextsep{\glsnumlistsep}% + \@gls@donext@def + \def\@gls@donext@def{% + \def\@gls@numlist@lastsep{\glsnumlistlastsep}% + }% + }% + \expandafter \glsnumlistparser \expandafter{\the@numberlist}% + \let\@gls@numlist@sep\@gls@numlist@lastsep + \@gls@thislist + \egroup + }% + } +} +\newcommand*{\glsnumlistsep}{, } +\newcommand*{\glsnumlistlastsep}{ \& } \newcommand*{\glshyperlink}[2][\glsentrytext{\@glo@label}]{% \def\@glo@label{#2}% -\@glslink{glo:#2}{#1}} +\@glslink{\glolinkprefix#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}} @@ -3017,6 +3189,11 @@ name=true]{% \let\makeglossaries\relax \@disable@onlypremakeg \let\warn@nomakeglossaries\relax + \ifglssavenumberlist + \edef\@gls@dodeflistparser{\noexpand\DeclareListParser + {\noexpand\glsnumlistparser}{\delimN}}% + \@gls@dodeflistparser + \fi } \let\makeglossary\makeglossaries \AtEndDocument{% @@ -3031,8 +3208,14 @@ name=true]{% \ifglssavewrites \newcommand*{\glswritefiles}{% \forallglossaries{\@glo@type}{% - \edef\gls@tmp{\expandafter\the\csname glo@\@glo@type -@filetok\endcsname}% + \ifcsundef{glo@\@glo@type @filetok}% + {% + \def\gls@tmp{}% + }% + {% + \edef\gls@tmp{\expandafter\the + \csname glo@\@glo@type @filetok\endcsname}% + }% \ifx\gls@tmp\@empty \ifx\@glo@type\glsdefaulttype \GlossariesWarningNoLine{Glossary `\@glo@type' has no @@ -3046,8 +3229,8 @@ you \else \@glsopenfile{\glswrite}{\@glo@type}% \immediate\write\glswrite{% - \expandafter\the\csname glo@\@glo@type -@filetok\endcsname}% + \expandafter\the + \csname glo@\@glo@type @filetok\endcsname}% \immediate\closeout\glswrite \fi }% @@ -3056,7 +3239,8 @@ you \let\glswritefiles\relax \fi \renewcommand*{\glossary}[1][\glsdefaulttype]{% -\@glossary[#1]} + \@glossary[#1]% +} \def\@glossary[#1]{\index} \newcommand{\@gls@renewglossary}{% \gdef\@glossary[##1]{\@bsphack\begingroup\@wrglossary{##1}}% @@ -3068,11 +3252,24 @@ you \expandafter\global\expandafter\csname glo@#1@filetok\endcsname \expandafter{\@gls@tmp^^J}% \else - \expandafter\protected@write\csname glo@#1@file\endcsname{}{#2}% + \ifcsdef{glo@#1@file}% + {% + \expandafter\protected@write\csname glo@#1@file\endcsname{}{#2}% + }% + {% + \GlossariesWarning{No file defined for glossary `#1'}% + }% \fi \endgroup\@esphack } -\newcommand{\@do@wrglossary}[1]{% +\newcommand*{\@do@wrglossary}[1]{% + \ifglsindexonlyfirst + \ifglsused{#1}{}{\@@do@wrglossary{#1}}% + \else + \@@do@wrglossary{#1}% + \fi +} +\newcommand*{\@@do@wrglossary}[1]{% \protected@edef\@glslocref{\theglsentrycounter}% \@gls@checkmkidxchars\@glslocref \expandafter\ifx\theHglsentrycounter\theglsentrycounter @@ -3085,30 +3282,30 @@ you }% \@do@gls@getcounterprefix \fi -\ifglsxindy - \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil - \def\@glo@range{}% - \expandafter\if\@glo@prefix(\relax - \def\@glo@range{:open-range}% - \else - \expandafter\if\@glo@prefix)\relax - \def\@glo@range{:close-range}% + \ifglsxindy + \expandafter\@glo@check@mkidxrangechar\@glsnumberformat\@nil + \def\@glo@range{}% + \expandafter\if\@glo@prefix(\relax + \def\@glo@range{:open-range}% + \else + \expandafter\if\@glo@prefix)\relax + \def\@glo@range{:close-range}% + \fi \fi + \glossary[\csname glo@#1@type\endcsname]{% + (indexentry :tkey (\csname glo@#1@index\endcsname) + :locref \string"{\@glo@counterprefix}{\theglsentrycounter}\string" % + :attr \string"\@gls@counter\@glo@suffix\string" + \@glo@range + ) + }% + \else + \@set@glo@numformat{\@glo@numfmt}{\@gls@counter}{\@glsnumberformat}% + {\@glo@counterprefix}% + \glossary[\csname glo@#1@type\endcsname]{% + \string\glossaryentry{\csname glo@#1@index\endcsname + \@gls@encapchar\@glo@numfmt}{\theglsentrycounter}}% \fi - \glossary[\csname glo@#1@type\endcsname]{% - (indexentry :tkey (\csname glo@#1@index\endcsname) - :locref \string"{\@glo@counterprefix}{\@glslocref}\string" % - :attr \string"\@gls@counter\@glo@suffix\string" - \@glo@range - ) - }% -\else - \@set@glo@numformat{\@glo@numfmt}{\@gls@counter}{\@glsnumberformat}% - {\@glo@counterprefix}% - \glossary[\csname glo@#1@type\endcsname]{% - \string\glossaryentry{\csname glo@#1@index\endcsname - \@gls@encapchar\@glo@numfmt}{\theglsentrycounter}}% -\fi } \newcommand*\@gls@getcounterprefix[2]{% \edef\@gls@thisloc{#1}\edef\@gls@thisHloc{#2}% @@ -3174,9 +3371,21 @@ you \newcommand*{\glsseesep}{, } \newcommand*{\glsseeitem}[1]{\glshyperlink[\glsseeitemformat{#1}]{#1}} \newcommand*{\glsseeitemformat}[1]{\glsentrytext{#1}} -\def\warn@noprintglossary{\GlossariesWarningNoLine{No - \string\printglossary\space or \string\printglossaries\space - found.^^JThis document will not have a glossary}} +\newcommand*{\gls@save@numberlist}[1]{% + \ifglssavenumberlist + \toks@{#1}% + \edef\@do@writeaux@info{% + \noexpand\csgdef{glo@\glscurrententrylabel @numberlist}{\the\toks@}% + }% + \@onelevel@sanitize\@do@writeaux@info + \protected@write\@auxout{}{\@do@writeaux@info}% + \fi +} +\def\warn@noprintglossary{% + \GlossariesWarningNoLine{No \string\printglossary\space + or \string\printglossaries\space + found.^^JThis document will not have a glossary}% +} \ifcsundef{printglossary}{}% {% \GlossariesWarning{Overriding \string\printglossary}% @@ -3204,10 +3413,21 @@ you \let\nopostdesc\@nopostdesc \gls@dotoctitle \@glossarystyle + \let\gls@org@glossaryentryfield\glossaryentryfield + \let\gls@org@glossarysubentryfield\glossarysubentryfield + \renewcommand{\glossaryentryfield}[1]{% + \gdef\glscurrententrylabel{##1}% + \gls@org@glossaryentryfield{##1}% + }% + \renewcommand{\glossarysubentryfield}[2]{% + \gdef\glscurrententrylabel{##2}% + \gls@org@glossarysubentryfield{##1}{##2}% + }% \makeatletter \@input@{\jobname.\csname @glotype@\@glo@type @in\endcsname}% -\IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}{}% -{\null}% + \IfFileExists{\jobname.\csname @glotype@\@glo@type @in\endcsname}% + {}% + {\null}% \ifglsxindy \ifcsundef{@xdy@\@glo@type @language}% {% @@ -3227,7 +3447,8 @@ you \global\let\warn@noprintglossary\relax } \newcommand*{\printglossaries}{% -\forallglossaries{\@@glo@type}{\printglossary[type=\@@glo@type]}} + \forallglossaries{\@@glo@type}{\printglossary[type=\@@glo@type]}% +} \define@key{printgloss}{type}{\def\@glo@type{#1}} \define@key{printgloss}{title}{\def\glossarytitle{#1}} \define@key{printgloss}{toctitle}{\def\glossarytoctitle{#1}% @@ -3263,7 +3484,9 @@ false,nolabel,autolabel}[nolabel]{% \fi} \newcommand*{\@glsnonextpages}{% \gdef\glossaryentrynumbers##1{% - \glsresetentrylist}} + \glsresetentrylist + }% +} \newcommand*{\@glsnextpages}{% \gdef\glossaryentrynumbers##1{% ##1\glsresetentrylist}} @@ -3294,6 +3517,13 @@ false,nolabel,autolabel}[nolabel]{% \else \newcommand*{\glsresetsubentrycounter}{} \fi +\ifglsentrycounter + \newcommand*{\glsresetentrycounter}{% + \setcounter{glossaryentry}{0}% + } +\else + \newcommand*{\glsresetentrycounter}{} +\fi \ifglsentrycounter \newcommand*{\glsstepentry}[1]{% \refstepcounter{glossaryentry}% @@ -3353,7 +3583,7 @@ false,nolabel,autolabel}[nolabel]{% \renewenvironment{theglossary}{}{}% } \newcommand*{\glossaryheader}{} -\newcommand*{\glstarget}[2]{\@glstarget{glo:#1}{#2}} +\newcommand*{\glstarget}[2]{\@glstarget{\glolinkprefix#1}{#2}} \newcommand*{\glossaryentryfield}[5]{% \noindent\textbf{\glstarget{#1}{#2}} #4 #3. #5\par} \newcommand*{\glossarysubentryfield}[6]{% @@ -3393,6 +3623,15 @@ false,nolabel,autolabel}[nolabel]{% \PackageError{glossaries}{Glossary style `#1' is already defined}{}% }% } +\newcommand{\renewglossarystyle}[2]{% + \ifcsundef{@glsstyle@#1}% + {% + \PackageError{glossaries}{Glossary style `#1' isn't already defined}{}% + }% + {% + \csdef{@glsstyle@#1}{#2}% + }% +} \newcommand*{\glsnamefont}[1]{#1} \ifcsundef{hyperlink}% {% @@ -3640,7 +3879,7 @@ false,nolabel,autolabel}[nolabel]{% \defglsdisplayfirst[#1]{% \firstacronymfont{##1}##4% \expandafter\protect\expandafter\acrfootnote\expandafter - {\@gls@link@opts}{\@gls@link@label}{##3} + {\@gls@link@opts}{\@gls@link@label}{##3}% }% \defglsdisplay[#1]{\acronymfont{##1}##4}% } @@ -3875,9 +4114,11 @@ false,nolabel,autolabel}[nolabel]{% name={\noexpand\acronymfont{\the\glsshorttok}},% sort={\the\glsshorttok},% text={\noexpand\@glo@symbol},% - plural={\noexpand\@glo@symbolplural},% + %plural={\noexpand\@glo@symbolplural},% + plural={\noexpand\@glo@shortpl},% first={\the\glslongtok},% - firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + %firstplural={\the\glslongtok\noexpand\acrpluralsuffix},% + firstplural={\noexpand\@glo@longpl},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% long={\the\glslongtok},% @@ -3885,7 +4126,8 @@ false,nolabel,autolabel}[nolabel]{% description={\noexpand\@glo@first},% descriptionplural={\noexpand\@glo@firstplural},% symbol={\the\glsshorttok},% - symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + %symbolplural={\the\glsshorttok\noexpand\acrpluralsuffix},% + symbolplural={\noexpand\@glo@shortpl},% \the\glskeylisttok }% }% @@ -4165,7 +4407,7 @@ false,nolabel,autolabel}[nolabel]{% \expandafter\show\csname @glotype@#1@counter\endcsname } \newcommand*{\showglossaryentries}[1]{% - \expandafter\show\csname @glolist@#1\endcsname + \expandafter\show\csname glolist@#1\endcsname } \csname ifglscompatible-2.07\endcsname \RequirePackage{glossaries-compatible-207} diff --git a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty index 15f73330303..d188ca13208 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -39,7 +39,8 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{mfirstuc}[2011/04/02 v1.05 (NLCT)] +\ProvidesPackage{mfirstuc}[2012/05/21 v1.06 (NLCT)] +\RequirePackage{etoolbox} \newif\if@glscs \newtoks\@glsmfirst \newtoks\@glsmrest @@ -89,6 +90,28 @@ \def\@gls@gobbletonil#1\@nil{\def\@gls@rest{#1}} \newcommand*{\xmakefirstuc}[1]{% \expandafter\makefirstuc\expandafter{#1}} +\newcommand*{\capitalisewords}[1]{% + \def\gls@add@space{}% + \mfu@capitalisewords#1 \@nil\mfu@endcap + %\gls@add@space\makefirstuc{##1}\def\gls@add@space{ }% +} +\def\mfu@capitalisewords#1 #2\mfu@endcap{% + \def\mfu@cap@first{#1}% + \def\mfu@cap@second{#2}% + \gls@add@space + \makefirstuc{#1}% + \def\gls@add@space{ }% + \ifx\mfu@cap@second\@nnil + \let\next@mfu@cap\mfu@noop + \else + \let\next@mfu@cap\mfu@capitalisewords + \fi + \next@mfu@cap#2\mfu@endcap +} +\def\mfu@noop#1\mfu@endcap{} +\newcommand*{\xcapitalisewords}[1]{% + \expandafter\capitalisewords\expandafter{#1}% +} \endinput %% %% End of file `mfirstuc.sty'. 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 aef181f20d1..5e5f5b14bab 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Danish.dict index 4430d1cccde..ba780eb793f 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Dutch.dict index daa59ff0bfb..4feb8f0510f 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-English.dict index de7550d74b1..c64178d9b40 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-French.dict index 3fe71a617f9..c59fb6f8089 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-German.dict index 1edbfbf7b8c..3314d65154f 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Irish.dict index 4e8ae30e84c..d79575d1cb5 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Italian.dict index 3e8f8ee7a24..aba2556387c 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Magyar.dict index 00fba3094b3..9bcb6105c83 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Polish.dict index b92a84f2548..5038e2b22b6 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Serbian.dict index 5ec30b56554..ba1ea82f9ff 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict b/Master/texmf-dist/tex/latex/glossaries/dict/glossaries-dictionary-Spanish.dict index e0ef0253c84..9b1cf522607 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty index 574678f709a..97a31c19fe8 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty index 3483dd5d9ea..36e77c46625 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty new file mode 100644 index 00000000000..ace05107b11 --- /dev/null +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty @@ -0,0 +1,83 @@ +%% +%% This is file `glossary-inline.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% glossaries.dtx (with options: `glossary-inline.sty,package') +%% +%% glossaries.dtx +%% Copyright 2012 Nicola Talbot +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.3 +%% of this license of (at your option) any later version. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of LaTeX +%% version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Nicola Talbot. +%% +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\ProvidesPackage{glossary-inline}[2012/05/21 v1.0 (NLCT)] +\newglossarystyle{inline}{% + \renewenvironment{theglossary}% + {% + \def\gls@inlinesep{}% + \def\gls@inlinesubsep{}% + }% + {\glspostinline}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossaryentryfield}[5]{% + \gls@inlinesep + \glsentryitem{##1}\glstarget{##1}{##2}% + \def\glo@desc{##3}% + \def\@no@post@desc{\nopostdesc}% + \ifx\glo@desc\@no@post@desc + \else + \ifstrempty{##3}{}{\space##3}% + \fi + \ifglshaschildren{##1}% + {% + \glsresetsubentrycounter + \glsinlineparentchildseparator + \def\gls@inlinesubsep{}% + }% + {}% + \def\gls@inlinesep{\glsinlineseparator}% + }% + \renewcommand*{\glossarysubentryfield}[6]{% + \gls@inlinesubsep% + \glstarget{##2}{}% + \glssubentryitem{##2}##4% + \def\gls@inlinesubsep{\glsinlinesubseparator}% + }% + \renewcommand*{\glsgroupskip}{}% +} +\newcommand*{\glsinlineseparator}{;\space} +\newcommand*{\glsinlinesubseparator}{,\space} +\newcommand*{\glsinlineparentchildseparator}{:\space} +\newcommand*{\glspostinline}{.\space} +\endinput +%% +%% End of file `glossary-inline.sty'. 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 8b773da64ab..4cf93957abd 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty index 756eef5dcbf..59ab300bb11 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty index a05e4bd1a24..f62e597c976 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty new file mode 100644 index 00000000000..e46f7f83b1e --- /dev/null +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty @@ -0,0 +1,152 @@ +%% +%% This is file `glossary-mcols.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% glossaries.dtx (with options: `glossary-mcols.sty,package') +%% +%% glossaries.dtx +%% Copyright 2012 Nicola Talbot +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.3 +%% of this license of (at your option) any later version. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of LaTeX +%% version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Nicola Talbot. +%% +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\ProvidesPackage{glossary-mcols}[2012/05/21 v1.0 (NLCT)] +\RequirePackage{multicol} +\RequirePackage{glossary-tree} +\newcommand*{\glsmcols}{2} +\newglossarystyle{mcolindex}{% + \glossarystyle{index}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + \let\item\@idxitem}% + {\end{multicols}}% +} +\newglossarystyle{mcolindexgroup}{% + \glossarystyle{mcolindex}% + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsgetgrouptitle{##1}}\indexspace}% +} +\newglossarystyle{mcolindexhypergroup}{% + \glossarystyle{mcolindex}% + \renewcommand*{\glossaryheader}{% + \item\textbf{\glsnavigation}\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \item\textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}% + \indexspace}% +} +\newglossarystyle{mcoltree}{% + \glossarystyle{tree}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + }% + {\end{multicols}}% +} +\newglossarystyle{mcoltreegroup}{% + \glossarystyle{mcoltree}% + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +\newglossarystyle{mcoltreehypergroup}{% + \glossarystyle{mcoltree}% + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} +\newglossarystyle{mcoltreenoname}{% + \glossarystyle{treenoname}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2} + \setlength{\parindent}{0pt}% + \setlength{\parskip}{0pt plus 0.3pt}% + }% + {\end{multicols}}% +} +\newglossarystyle{mcoltreenonamegroup}{% + \glossarystyle{mcoltreenoname}% + \renewcommand{\glsgroupheading}[1]{\par + \noindent\textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +\newglossarystyle{mcoltreenonamehypergroup}{% + \glossarystyle{mcoltreenoname}% + \renewcommand*{\glossaryheader}{% + \par\noindent\textbf{\glsnavigation}\par\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \par\noindent + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}% +} +\newglossarystyle{mcolalttree}{% + \glossarystyle{alttree}% + \renewenvironment{theglossary}% + {% + \begin{multicols}{2}% + \def\@gls@prevlevel{-1}% + \mbox{}\par + }% + {\par\end{multicols}}% +} +\newglossarystyle{mcolalttreegroup}{% + \glossarystyle{mcolalttree}% + \renewcommand{\glsgroupheading}[1]{\par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsgetgrouptitle{##1}}\par\indexspace}% +} +\newglossarystyle{mcolalttreehypergroup}{% + \glossarystyle{mcolalttree}% + \renewcommand*{\glossaryheader}{% + \par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsnavigation}\par\indexspace}% + \renewcommand*{\glsgroupheading}[1]{% + \par + \def\@gls@prevlevel{-1}% + \hangindent0pt\relax + \parindent0pt\relax + \textbf{\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}\par + \indexspace}} + +\endinput +%% +%% End of file `glossary-mcols.sty'. 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 7831f9b0085..a1d66b9599a 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty index 2c02e10e420..92ec5eccdcf 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty index 490ad13ea68..cc3ddd86cb5 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 2011 Nicola Talbot +%% Copyright 2012 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -21,7 +21,7 @@ %% %% The Current Maintainer of this work is Nicola Talbot. %% -%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. +%% This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, mfirstuc.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, glossaries-dictionary-Brazilian.dict, glossaries-dictionary-Danish.dict, glossaries-dictionary-Dutch.dict, glossaries-dictionary-English.dict, glossaries-dictionary-French.dict, glossaries-dictionary-German.dict, glossaries-dictionary-Irish.dict, glossaries-dictionary-Italian.dict, glossaries-dictionary-Magyar.dict, glossaries-dictionary-Polish.dict, glossaries-dictionary-Serbian.dict, glossaries-dictionary-Spanish.dict, minimalgls.tex, sample-crossref.tex, sample-custom-acronym.tex, sample-dual.tex, sample-inline.tex, sample-langdict.tex, sample-mfirstuc.tex, sample-numberlist.tex, sample.tex, sample4col.tex, sampleaccsupp.tex, sampleAcr.tex, sampleAcrDesc.tex, sampleacronyms.tex, sampleDB.tex, sampleDesc.tex, sampleEq.tex, sampleEqPg.tex, sampleNtn.tex, sampleSec.tex, sampletree.tex, sampleutf8.tex, samplexdy-compatible207.tex, samplexdy.tex, samplexdy2.tex, samplexdy-mc.xdy, samplexdy-mc207.xdy, database1.tex, database2.tex, glossaries.perl. %% %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -- cgit v1.2.3