From 9144cd7fe8a83679a67b2739e85be044b997c4a7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 26 Jan 2016 22:53:06 +0000 Subject: glossaries (24jan15) git-svn-id: svn://tug.org/texlive/trunk@39488 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 21 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 964266 -> 1129829 bytes .../doc/latex/glossaries/glossaries-user.html | 23052 +++++++++---------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 730262 -> 735442 bytes .../doc/latex/glossaries/glossaries-user.tex | 666 +- .../doc/latex/glossaries/glossariesbegin.html | 1206 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 148913 -> 155718 bytes .../doc/latex/glossaries/glossariesbegin.tex | 13 +- .../doc/latex/glossaries/glossary2glossaries.html | 697 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 140892 -> 142433 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 252917 -> 252917 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49381 -> 49381 bytes .../doc/latex/glossaries/samples/minimalgls.tex | 6 +- .../doc/latex/glossaries/samples/mwe-acr-desc.pdf | Bin 37957 -> 37957 bytes .../doc/latex/glossaries/samples/mwe-acr.pdf | Bin 33649 -> 33649 bytes .../doc/latex/glossaries/samples/mwe-gls.pdf | Bin 29939 -> 29939 bytes .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58817 -> 58817 bytes .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 54822 -> 54822 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53456 -> 53456 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82189 -> 82189 bytes .../latex/glossaries/samples/sample-dot-abbr.pdf | Bin 52712 -> 52712 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36455 -> 36455 bytes .../latex/glossaries/samples/sample-entrycount.pdf | Bin 36839 -> 36839 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 34904 -> 34904 bytes .../latex/glossaries/samples/sample-font-abbr.pdf | Bin 50703 -> 50703 bytes .../latex/glossaries/samples/sample-ignored.pdf | Bin 31810 -> 31810 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 43379 -> 43379 bytes .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 147337 -> 147350 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 38855 -> 38855 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 39198 -> 39198 bytes .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 96000 -> 96000 bytes .../latex/glossaries/samples/sample-noidxapp.pdf | Bin 67077 -> 67077 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 41745 -> 41745 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 41979 -> 41979 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 43259 -> 43259 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 21710 -> 21710 bytes .../samples/sample-storage-abbr-desc.pdf | Bin 39892 -> 39892 bytes .../glossaries/samples/sample-storage-abbr.pdf | Bin 37659 -> 37659 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 102997 -> 103020 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43320 -> 43320 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 65664 -> 65506 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 65643 -> 65613 bytes .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 93638 -> 93612 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47043 -> 47043 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48435 -> 48396 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155612 -> 155761 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169067 -> 169225 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91370 -> 91341 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98964 -> 98977 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 47459 -> 47459 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65942 -> 65669 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 95346 -> 95361 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41131 -> 41155 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 37201 -> 37201 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 66912 -> 66912 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44939 -> 44939 bytes .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 178864 -> 178927 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 68399 -> 68399 bytes 60 files changed, 12958 insertions(+), 12709 deletions(-) (limited to 'Master/texmf-dist/doc/latex/glossaries') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 19382cc830b..2318a3e602d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,26 @@ glossaries change log: +v4.21: + + * glossaries.sty: + + - Added warning if there's no default style. + + * glossary-longbooktabs.sty - new package + + * makeglossaries (2.18): + + - Added extra diagnostic if xindy's empty index key + warning/error occurs. + + - Added check for makeindex's multiple encap warning + and attempt to fix. + + * glossaries-user.tex: + + - Fixed typo: \DefineAcronymShortcuts should be + \DefineAcronymSynonyms + v4.20: * makeglossaries (2.17) bug fix diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 2c60264d3cd..da0f72ae9cb 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v4.20 +LaTeX Package : glossaries v4.21 -Last Modified : 2015-11-30 +Last Modified : 2016-01-24 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf index 25141661589..7c25436df2c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index 97251bb9507..81a0b3d824c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -4,13 +4,13 @@ -User Manual for glossaries.sty v4.20 + - + -

- - - -

User Manual for glossaries.sty v4.20

-
Nicola L.C. Talbot -

+ + +

+ + +

+
+

+

User Manual for glossaries.sty v4.21 +

+
+
Nicola L.C. Talbot
http://www.dickimaw-books.com/
-
2015-11-30
- - - +class="cmtt-12">http://www.dickimaw-books.com/
+
+

2016-01-24

-

- - +

+ +

-

-

+

Abstract

-

The glossaries package provides a means to define terms or abbreviations or symbols that -can be referenced within your document. Sorted lists with collated locations can be -generated either using T

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

- - +

Additional features not provided here may be available through the supplemental package +glossaries-extra which, if required, needs to be installed separately. New features will be added +to glossaries-extra. Any new versions of the glossaries package after v4.21 will be just bug +fixes. +

+ +

-

If you require multilingual support you must also separately install the relevant -language module. Each language module is called

If you require multilingual support you must also separately install the relevant language +module. Each language module is called glossaries-language⟩, where -⟨language⟩ is the root language name. For example, glossaries-french or -glossaries-german. If a language module is required, the glossaries package will -automatically try to load it and will give a warning if the module isn’t found. See language⟩, where ⟨language⟩ is the root +language name. For example, glossaries-french or glossaries-german. If a language +module is required, the glossaries package will automatically try to load it and will give +a warning if the module isn’t found. See §1.3 -Multi-Lingual Support for further details. -

Documents have wide-ranging styles when it comes to presenting glossaries or lists -of terms or notation. People have their own preferences and to a large extent this is -determined by the kind of information that needs to go in the glossary. They may just -have symbols with terse descriptions or they may have long technical words -with complicated descriptions. The §1.3 Multi-Lingual Support for further +details. +

The glossaries package requires a number of other packages including, but not limited to, +tracklang, mfirstuc, etoolbox, xkeyval (at least version dated 2006/11/18), textcase, xfor, +datatool-base (part of the datatool bundle) and amsgen. These packages are all available +in the latest TEX Live and MikTEX distributions. If any of them are missing, +please update your TEX distribution using your update manager. (For help on this +see, for example, How do I update my TEX distribution? or Updating TEX on +Linux.) +

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

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

-

-

The

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

+

+

The glossaries bundle comes with the following documentation:

glossariesbegin.pdf
If you are a complete beginner, start with “The glossaries +class="description">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”. + id="dx1-11"> 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="cmss-10">glossaries package.
mfirstuc-manual.pdf
The commands provided by the The commands provided by the mfirstuc package are - briefly described in package are briefly + described in “mfirstuc.sty: uppercasing first letter”.
glossaries-code.pdf
Advanced users wishing to know more about the inner - workings of all the packages provided in the glossaries bundle should read - “Documented Code for glossaries v4.20”. This includes the documented - code for the Advanced users wishing to know more about the inner workings + + + of all the packages provided in the glossaries bundle should read “Documented + Code for glossaries v4.21”. This includes the documented code for the mfirstuc package. + id="dx1-13"> + package.
INSTALL
Installation instructions. - -
CHANGES
Change log. class="cmbx-10">README
Package summary.
-

If you use

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

If you are using

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

-

-

Other documents that describe using the (DVI format) as +pdflatex deals with hyperlinks much better. If you use the DVI format, you will encounter +problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is +an issue with the DVI format not with glossaries.

+

+

Other documents that describe using the glossaries package include: Using LaTeX -to Write a PhD Thesis and Glossaries, Nomenclature, Lists of Symbols and -Acronyms. - - - - +href="http://www.dickimaw-books.com/latex/thesis/" >Using LaTeX to Write +a PhD Thesis and Glossaries, Nomenclature, Lists of Symbols and Acronyms. + + + +

Contents

@@ -477,8 +528,8 @@ href="#sec:homographs" id="QQ2-1-42">Homographs href="#sec:loadglsentries" id="QQ2-1-43">Loading Entries From a File
 4.9 Moving Entries to Another Glossary - - + +
 4.10 Drawbacks With Defining Entries in the Document Environment
  4.10.1 Defining New Glossaries
13 Acronyms and Other Abbreviations
 13.1 Changing the Acronym Style +href="#sec:setacronymstyle" id="QQ2-1-67">Changing the Abbreviation Style
  13.1.1 Predefined Acronym Styles
  13.1.2 Longtable Styles
  15.1.3 Longtable Styles (Ragged Right)
  15.1.4 Supertabular Styles +href="#x1-7200015.1.4" id="QQ2-1-81">Longtable Styles (booktabs)
  15.1.5 Supertabular Styles (Ragged Right) +href="#sec:superstyles" id="QQ2-1-82">Supertabular Styles
  15.1.6 Tree-Like Styles +href="#sec:superraggedstyles" id="QQ2-1-83">Supertabular Styles (Ragged Right)
  15.1.7 Multicols Style +href="#sec:treestyles" id="QQ2-1-84">Tree-Like Styles
  15.1.8 In-Line Style +href="#sec:mcolstyles" id="QQ2-1-85">Multicols Style +
  15.1.9 In-Line Style
 15.2 Defining your own glossary style +href="#sec:newglossarystyle" id="QQ2-1-88">Defining your own glossary style
16 Utilities +href="#sec:utilities" id="QQ2-1-89">Utilities
 16.1 Loops +href="#sec:loops" id="QQ2-1-90">Loops
 16.2 Conditionals +href="#sec:conditionals" id="QQ2-1-91">Conditionals
 16.3 Fetching and Updating the Value of a Field +href="#sec:fetchset" id="QQ2-1-92">Fetching and Updating the Value of a Field
17 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-93">Prefixes or Determiners
18 Accessibility Support +href="#sec:accsupp" id="QQ2-1-94">Accessibility Support
19 Troubleshooting -
Index - - +href="#sec:trouble" id="QQ2-1-95">Troubleshooting + +
- - - - - - + + + + + +

List of Tables

- - - - + + + +

- - + +

Glossary

\usepackage[xindy, -

nonumberlist,
-

toc,
-

nopostdot,
-

style=altlist,
-

}
id="glo:cli">Command Line Interface (CLI)

An application that doesn’t have a graphical user interface. That is, an - application that doesn’t have any windows, buttons or menus and can be - run in a command prompt or terminal.
An application that doesn’t have a graphical user interface. That is, an application + that doesn’t have any windows, buttons or menus and can be run in a command + prompt or terminal.
class="cmbx-10">Entry 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.
An alphabet consisting of Latin characters and extended Latin characters. -
s.
Extended Latin Character
A character that’s created by combining
Latin characters to form ligatures - (e.g. æ) or by applying diacritical marks to a Latin character or characters - (e.g. á or ø). See also s to form ligatures (e.g. æ) + or by applying diacritical marks to a Latin character or characters (e.g. á or ø). + See also non-Latin character.
@@ -713,26 +764,27 @@ class="newline" /> class="cmbx-10">First use

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

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

The text that is displayed on first use, which is governed by the The text that is displayed on first use, which is governed by the first and + id="dx1-3019"> and firstplural keys of keys of \newglossaryentry. (May be overridden by \glsdisp - or by or by + \defglsentry.)
+
+glossaries-extra

A separate package that extends the glossaries package, providing new features + or improving existing features. If you want to use glossaries-extra, you must have + both the glossaries package and the glossaries-extra package installed.
Indexing application

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

The alphabet consisting of Latin characters. See also extended Latin - alphabet.
The alphabet consisting of Latin characters. See also extended Latin alphabet.
Link text
The text produced by commands such as \gls
. It may or may not be a - hyperlink to the glossary.
. It may or may not be a hyperlink + to the glossary.
+ +
xindy and makeindex provided - with the provided with + the glossaries package.
@@ -853,8 +918,8 @@ class="description">
A Java GUI alternative to makeglossaries that also provides diagnostic - tools. Available separately on CTAN.
that also provides diagnostic tools. + Available separately on CTAN.
xindy and makeindex provided - with the glossaries package. This is a cut-down alternative to the Perl - makeglossaries script. If you have Perl installed, use the Perl script - instead.
provided with + the glossaries package. This is a cut-down alternative to the Perl makeglossaries + script. If you have Perl installed, use the Perl script instead.
Number list

A list of entry locations (also called a location list). The number list can - be suppressed using the entry locations (also called a location list). The number list can be + suppressed using the nonumberlist package option.
@@ -924,25 +988,25 @@ class="newline" /> class="cmbx-10">Sanitize

Converts command names into character sequences. That is, a command - called, say, 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 o. Depending on + the font, the backslash character may appear as a dash when used in the main + document text, so \foo will appear as: —foo. -

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

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

X Extended Latin Character

An extended Latin character that can be created by a core - LATEX command, such as An extended Latin character that can be created by a core LATEX command, + such as \o (ø) or \’e (é). That is, the character can - be produced without the need to load a particular package.
\’e
(é). That is, the character can be produced without the + need to load a particular package.

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

1.

1. Introduction

-

The

The glossaries package is provided to assist generating lists of terms, symbols or -abbreviations (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 -glossary styles that include symbols (in addition to a name and description) for glossary +abbreviations (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 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 used1.11.1 in the document will be added to 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 covers all the various settings. If you are +class="cmbx-10">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 covers all the various settings. If you are daunted by the size of the manual, try starting off with the much shorter guide for beginners. -

There’s a common misconception that you have to have Perl installed in order to -use the

There’s a common misconception that you have to have Perl installed in order to use +the glossaries package. Perl is not a requirement but it does increase the available options, particularly if you use an extended Latin alphabet or a non-Latin alphabet.
-

-

The basic idea behind the glossaries package is that you first define your entries -(terms, symbols or abbreviations). Then you can reference these within your -document (like \cite or \ref). You can also, optionally, display a list of the entries -you have referenced in your document (the glossary). This last part, displaying -the glossary, is the part that most new users find difficult. There are three -options: +

+

The basic idea behind the glossaries package is that you first define your entries (terms, +symbols or abbreviations). Then you can reference these within your document (like \cite or +\ref). You can also, optionally, display a list of the entries you have referenced in your +document (the glossary). This last part, displaying the glossary, is the part that most new +users find difficult. There are three options:

Option 1: -

This is the simplest option but it’s slow and if you want a sorted list, it - doesn’t work well for

This is the simplest option but it’s slow and if you want a sorted list, it doesn’t + work well for extended Latin alphabets or non-Latin alphabets. - However, if you use the non-Latin alphabets. However, if you + use the sanitizesort=false package option (the default for - Option 1) then the package option (the default for Option 1) then the + standard LATEX accent commands will be ignored, - so if an entry’s name is set to EX accent commands will be ignored, so if an entry’s name is set + to {\’e}lite then the sort will default to elite - if elite if sanitizesort=false is used and will default to is used and + will default to \’elite if sanitizesort=true - is used. -

This option works best with the is used. +

This option works best with the sort=def setting. For any other setting, - be prepared for a long document build time, especially if you have a lot of - entries defined. + id="dx1-4009"> setting. For any other setting, be + prepared for a long document build time, especially if you have a lot of entries + defined.

  1. Add \makenoidxglossaries to your preamble (before you start - defining your entries, as described in Add \makenoidxglossaries to your preamble (before you start defining + your entries, as described in §4 Defining Glossary Entries).
  2. Put -



    \printnoidxglossary

    - - -

    +

    where you want your list of entries to appear (described in §10 Displaying a + + glossary).

  3. Run LATEX twice on your document. (As you would do to make a table - of contents appear.) For example, click twice on the “typeset” or “build” or +class="E">EX twice on your document. (As you would do to make a table of + contents appear.) For example, click twice on the “typeset” or “build” or “PDFLATEX” button in your editor.
@@ -1084,47 +1146,46 @@ class="description">Option 2: -

This option uses a 

This option uses a command line interface (CLI) application called makeindex - to sort the entries. This application comes with all modern TEX distributions, - but it’s hard-coded for the non-extended to sort + the entries. This application comes with all modern TEX distributions, but it’s + hard-coded for the non-extended Latin alphabet, so it doesn’t work well - for extended Latin alphabets or non-Latin alphabets. This process involves - making LATEX write the glossary information to a temporary file which - , so it doesn’t work well for extended + Latin alphabets or non-Latin alphabets. This process involves making LATEX write + the glossary information to a temporary file which makeindex reads. Then makeindex writes a new file containing the code - to typeset the glossary. LATEX then reads this file in on the next - run. -

This option works best if you want to sort entries according to the English - alphabet and you don’t want to install Perl. + id="dx1-4019"> + writes a new file containing the code to typeset the glossary. LATEX then reads this + file in on the next run. +

This option works best if you want to sort entries according to the English alphabet and + you don’t want to install Perl.

  1. Add \makeglossaries to your preamble (before you start defining - your entries, as described in Add \makeglossaries to your preamble (before you start defining your + entries, as described in §4 Defining Glossary Entries).
  2. Put -



    \printglossary

    -

    +

    where you want your list of entries to appear (described in §10 Displaying a

  3. Run LATEX on your document. This creates files with the extensions .glo - and .glo and + .ist (for example, if your LATEX document is called myDoc.tex, - then you’ll have two extra files called myDoc.tex, then you’ll have + two extra files called myDoc.glo and myDoc.ist). If you - look at your document at this point, you won’t see the glossary as it hasn’t - been created yet. +class="cmtt-10">myDoc.ist). If you look at your + document at this point, you won’t see the glossary as it hasn’t been created + yet.
  4. Run makeindex with the .glo file as the input file and the .ist file - as the style so that it creates an output file with the extension - .gls. If you have access to a terminal or a command prompt (for - example, the MSDOS command prompt for Windows users or - the bash console for Unix-like users) then you need to run the +class="cmtt-10">.ist file as the style so + that it creates an output file with the extension .gls. If you have access to a + terminal or a command prompt (for example, the MSDOS command prompt for + Windows users or the bash console for Unix-like users) then you need to run the command: - - + +
    makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
    -

    (Replace

    (Replace myDoc with the base name of your LATEX document file. Avoid - spaces in the file name.) If you don’t know how to use the command - prompt, then you can probably access EX document file. Avoid spaces + in the file name.) If you don’t know how to use the command prompt, then you can + probably access makeindex via your text editor, - but each editor has a different method of doing this, so I can’t - give a general description. You will have to check your editor’s - manual. -

    The default sort is word order (“sea lion” comes before “seal”). If you want - letter ordering you need to add the via your text editor, but each editor has a different + method of doing this, so I can’t give a general description. You will have to check + your editor’s manual. +

    The default sort is word order (“sea lion” comes before “seal”). If you want letter + ordering you need to add the -l switch: - - + +

    makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
    -

    (See

    (See §1.4.4 Using makeindex explicitly (Option 2) for further details on - using explicitly (Option 2) for further details on using + makeindex explicitly.)

  5. @@ -1198,72 +1257,71 @@ class="cmtt-10">makeindexOnce you have successfully completed the previous step, you can now run LATEX on your document again.
-

This is the default option (although you still need to use \makeglossaries to - ensure the glossary files are created). +

This is the default option (although you still need to use \makeglossaries to ensure + the glossary files are created).

Option 3: -

This option uses a 

This option uses a CLI application called xindy to sort the entries. This - application is more flexible than to sort the entries. This application is + more flexible than makeindex and is able to sort extended Latin - alphabets or extended Latin alphabets or + non-Latin alphabets. The xindy application comes with - TEX Live but not with MiKT application comes with TEX Live but not with + MiKTEX. Since xindy is a Perl script, if you are - using MiKTEX you will not only need to install is a Perl script, if you are using MiKTEX you will not only + need to install xindy, you will also - need to install Perl. In a similar way to Option 2, this option involves - making LATEX write the glossary information to a temporary file - which , you will also need to install Perl. In a similar way to + Option 2, this option involves making LATEX write the glossary information to + a temporary file which xindy reads. Then xindy writes a new file containing the code - to typeset the glossary. LAT writes a new file containing + the code to typeset the glossary. LATEX then reads this file in on the next run. -

This is the best option if you want to sort according to a language other than - English or if you want non-standard location lists. +

This is the best option if you want to sort according to a language other than English or + if you want non-standard location lists.

  1. Add the xindy option to the glossaries package option list: - - + +
    \usepackage[xindy]{glossaries}
    -

    +

  2. Add \makeglossaries to your preamble (before you start defining your - entries, as described in \makeglossaries to your preamble (before you start defining your entries, as + described in §4 Defining Glossary Entries). @@ -1271,16 +1329,16 @@ href="#sec:newglosentry">Defining Glossary Entries

    (Replace

    (Replace myDoc with the base name of your LATEX document file. Avoid - spaces in the file name. If necessary, also replace english with the name of - your language and EX document file. Avoid spaces + in the file name. If necessary, also replace english with the name of your language + and utf8 with your input encoding, for example, -L german - -C din5007-utf8.) If you don’t know how to use the command - prompt, then you can probably access -L german -C din5007-utf8.) If + you don’t know how to use the command prompt, then you can probably access + xindy via your text editor, - but each editor has a different method of doing this, so I can’t - give a general description. You will have to check your editor’s + id="dx1-4050"> via your text editor, but each editor has a different method of doing this, so + I can’t give a general description. You will have to check your editor’s manual. -

    The default sort is word order (“sea lion” comes before “seal”). If you - want letter ordering you need to add the

    The default sort is word order (“sea lion” comes before “seal”). If you want letter + ordering you need to add the order=letter package - option: - - + id="dx1-4051"> package option: + +

    \usepackage[xindy,order=letter]{glossaries}
    -

    (and return to the previous step.) See

    (and return to the previous step.) See §1.4.3 Using xindy explicitly - (Option 3) for further details on using explicitly (Option 3) for + further details on using xindy explicitly.

  3. @@ -1347,92 +1401,91 @@ class="cmtt-10">xindyEX on your document again.
-

For Options 

For Options 2 and 3, it can be difficult to remember all the parameters -required for 3, it can be difficult to remember all the parameters required for +makeindex or xindy, so the glossaries package provides a Perl -script called glossaries package provides a Perl script called makeglossaries that reads the .aux file to determine what -settings you have used and will then run +that reads the .aux file to determine what settings you have used and will then run +makeindex or xindy. Again, this -is a command line application and can be run in a terminal or command -prompt. For example, if your LAT. Again, this is a command line application and can be run in a terminal +or command prompt. For example, if your LATEX document is in the file myDoc.tex, then run: - - + +

makeglossaries myDoc
-

(Replace

(Replace myDoc with the base name of your LATEX document file. Avoid spaces in -the file name.) This is described in more detail in EX document file. Avoid spaces in the file +name.) This is described in more detail in §1.4 Generating the Associated -Glossary Files. -

If you don’t have Perl installed you can use the Lua script instead: - - +href="#sec:makeglossaries">Generating the Associated Glossary +Files. +

If you don’t have Perl installed you can use the Lua script instead: + +

makeglossaries-lite.lua myDoc
-

This script doesn’t have the full functionality of the Perl script, but since modern +

This script doesn’t have the full functionality of the Perl script, but since modern TEX distributions come with Lua, you shouldn’t need to install anything extra to -make it run. Remember that since EX distributions come with Lua, you shouldn’t need to install anything extra to make it +run. Remember that since xindy is also a Perl script, if you want to use - is also a Perl script, if you want to use xindy you’ll need Perl installed anyway, so there’s no point using this Lua script if -you’re using you’ll +need Perl installed anyway, so there’s no point using this Lua script if you’re using +xindy. -

The

The .gls and .glo are temporary files created to help build your document. You -should not edit or explicitly input them. However, you may need to delete them if -something goes wrong and you need to do a fresh build.
-

-

An overview of these three options is given in .glo are temporary files created to help build your document. You should +not edit or explicitly input them. However, you may need to delete them if something goes +wrong and you need to do a fresh build.

+

+

An overview of these three options is given in table 1.1.

- - -


- - + +
Table 1.1: Glossary Options: Pros and Cons
- - + +
-

OptionOption 3

Requires +class="td11">

Requires an external - application?

Requires - Perl?

Requires + Perl?

Can +class="td11">

Can sort extended @@ -1487,7 +1540,7 @@ href="#glo:exlatinalph">extended or non-Latin - alphabets?

?

Efficient +class="td11">

Efficient sort - algorithm?

Can +class="td11">

Can use a different @@ -1516,7 +1569,7 @@ class="td11">

Can method for each - glossary?

Can +class="td11">

Can form ranges in the location - lists?

Can +class="td11">

Can have non-standard locations in the location - lists?

Maximum +class="td11">

Maximum hierarchical - depth

Unlimited 3 Unlimited

\glsdisplaynumberlist - reliable?

\newglossaryentry restricted to - preamble?

Requires +class="td11">

Requires additional write - registers?

Default +class="td11">

Default value of sanitizesort package - option

false true true
- + +
-

Strips standard LATEX accents (that is, accents generated by core -LATEX commands) so, for example, EX accents (that is, accents generated by core LATEX commands) so, +for example, \AA is treated the same as A. - - + +


-

This document uses the glossaries package. For example, when viewing the -PDF version of this document in a hyperlinked-enabled PDF viewer (such as -Adobe Reader or Okular) if you click on the word “

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

The remainder of this introductory section covers the following:

+

The remainder of this introductory section covers the following:

-

Top

1.1 Sample Documents

-

The

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 -samples subdirectory (folder) +of the glossaries documentation directory. This location varies according to your operating system and TEX distribution. You can use terminal
texdoc -l glossaries
-

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

If you can’t find the sample files on your computer, they are also available from your nearest +

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

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

The sample documents are as -follows1.2

The sample documents are as follows1.2:

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: - - + installation using this file. To create the complete document you will need to do the + following steps:
  1. Run minimalgls.tex through LEX either by typing
    latex minimalgls
    -

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

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

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

    These warnings may be ignored on the first run. -

    If you get a

    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 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. @@ -1743,40 +1791,38 @@ class="cmtt-10">makeglossaries on the document (§1.4 Generating the Associated - Glossary Files). This can be done on a terminal either by typing - +href="#sec:makeglossaries">Generating the Associated Glossary + Files). This can be done on a terminal either by typing
    makeglossaries minimalgls
    -

    +

    or by typing
    perl makeglossaries minimalgls
    -

    +

    If your system doesn’t recognise the command perl then it’s likely you - don’t have Perl installed. In which case you will need to use 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): - + id="dx1-5009"> 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.4.4 Using makeindex explicitly (Option 2) for further details on - using explicitly (Option 2) for further details on using + makeindex explicitly.) -

    Note that if you need to specify the full path and the path contains +

    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.

    @@ -1784,10 +1830,10 @@ class="cmtt-10">makeindex
    Run minimalgls.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. -

There are three other files that can be used as a

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

There are three other files that can be used as a minimal working example: mwe-gls.tex, mwe-acr-desc.tex. class="cmtt-10">sample-noidx.tex

This document illustrates how to use the glossaries package - - - without an external glossaries package without an + external indexing application (Option 1). To create the complete - document, you need to do: +href="#option1">Option 1). To create the complete document, you need + to do: + +
latex sample-noidx
latex sample-noidx
-

+

sample-noidx-utf8.tex
As the previous example, except that it uses the - As the previous example, except that it uses the inputenc package. To create the complete document, you need to do: - + id="dx1-5016"> package. + To create the complete document, you need to do:
latex sample-noidx-utf8
latex sample-noidx-utf8
-

+

sample4col.tex
This document illustrates a four column glossary where the entries - have a symbol in addition to the name and description. To create the complete - document, you need to do: + id="x1-5017r4"> 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
makeglossaries sample4col
latex sample4col
-

+

As before, if you don’t have Perl installed, you will need to use makeindex - directly instead of using directly + instead of using makeglossaries. The vertical gap between entries is - the gap created at the start of each group. This can be suppressed using the - . The vertical gap between entries is the gap created at + the start of each group. This can be suppressed using the nogroupskip package option. + id="dx1-5020"> package + option.

sampleAcr.tex
This document has some sample acronyms. It also adds the glossary - to the table of contents, so an extra run through LATEX is required to ensure - the document is up to date: + id="x1-5021r5"> 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
makeglossaries sampleAcr class="cmtt-10">latex sampleAcr

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: + id="x1-5022r6"> 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 + +
makeglossaries sampleAcrDesc
latex sampleAcrDesc
latex sampleAcrDesc
-

+

sampleDesc.tex
This is similar to the previous example, except that it defines the - acronyms using This is similar to the previous example, except that it defines the acronyms + using \newglossaryentry instead of \newacronym. As with the - previous example, the glossary is added to the table of contents, so an extra run - through LATEX is required: + id="dx1-5025">. As with the previous example, the + glossary is added to the table of contents, so an extra run through LATEX is required: +
latex sampleDesc
makeglossaries sampleDesc class="cmtt-10">latex sampleDesc

latex sampleDesc
-

+

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

latex sampleCustomAcr
-

+

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

latex sampleFnAcrDesc
- - -

+

+ +

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

+

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

+

sample-crossref.tex
latex sample-crossref class="cmtt-10">makeglossaries sample-crossref
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 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-5034"> to add all the entries to the + glossaries without referencing each one explicitly. To create the document do: +
latex sampleDB
makeglossaries sampleDB
latex sampleDB
-

+

The glossary definitions are stored in the accompanying files database1.tex and makeindexmakeglossaries: - - + +

  1. Create the main glossary (all on one line): @@ -2030,7 +2073,7 @@ class="cmtt-10">makeglossariesmakeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -

    +

  2. Create the secondary glossary (all on one line): @@ -2038,36 +2081,36 @@ class="cmtt-10">sampleDB.glo class="cmtt-10">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 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-5043"> environment. To create the document do: +
latex sampleEq
makeglossaries sampleEq
latex sampleEq
-

+

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 LATs + 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:
makeglossaries sampleEqPg class="cmtt-10">latex sampleEqPg

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: + id="x1-5046r16"> 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
makeglossaries sampleSec - - + +
latex sampleSec
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: + id="x1-5047r17"> 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
makeglossaries sampleNtn class="cmtt-10">latex sampleNtn

latex sampleNtn
-

+

Note that if you don’t have Perl installed, you will need to use makeindex twice - instead of a single call to twice instead + of a single call to makeglossaries: @@ -2132,7 +2175,7 @@ class="cmtt-10">makeglossariesmakeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -

+

  • Create the secondary glossary (all on one line): @@ -2140,19 +2183,19 @@ class="cmtt-10">sampleNtn.glo class="cmtt-10">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 This document illustrates some of the basics, including how to create child + entries that use the same name as the parent entry. This example adds the glossary to + the table of contents and it also uses \glsrefentry, so an extra - LATEX run is required: + id="dx1-5055">, so an extra LATEX run is + required:
    latex sample
    makeglossaries sample class="cmtt-10">latex sample

    latex sample
    -

    +

    You can see the difference between word and letter ordering if you substitute order=wordmakeglossariesmakeindex explicitly, you will need to use the -l - switch to indicate letter ordering.) - - +class="cmtt-10">-l switch to + indicate letter ordering.) + +

    sample-inline.tex
    This document is like sample.tex, above, but uses the inline - glossary style to put the glossary in a footnote. + id="dx1-5061"> 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: + id="x1-5062r20"> 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
    makeglossaries sampletree
    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: + id="x1-5063r21"> 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.tex
    This document illustrates how to use the glossaries package - to create English to French and French to English dictionaries. To create the - document do: + id="x1-5064r22"> This document illustrates how to use the glossaries package to create + English to French and French to English dictionaries. To create the document do: +
    latex sample-langdict
    makeglossaries sample-langdict
    latex sample-langdict
    -

    +

    samplexdy.tex
    This document illustrates how to use the glossaries package with - glossaries package with xindy instead of + instead of makeindex. The document uses UTF8 encoding (with the - . The document uses UTF8 encoding (with the inputenc package). The encoding is picked up by package). + The encoding is picked up by makeglossaries. By default, - this document will create a . By default, this document will + create a xindy style file called samplexdy.xdy, but if you - uncomment the lines - - +class="cmtt-10">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 , 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 + id="dx1-5072">, 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="cmss-10">glossaries + package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter + group. +

    To create the document do:
    latex samplexdy
    makeglossaries samplexdy
    latex samplexdy
    -

    +

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

    +

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

    +

    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: @@ -2328,19 +2370,18 @@ class="cmtt-10">pdflatex samplexdy2 class="cmtt-10">makeglossaries samplexdy2
    pdflatex samplexdy2 -

    +

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

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

    See §11.2 makeindex, xindy - can cope with can + cope with non-Latin characters. This document uses UTF8 encoding. To - create the document do: + id="dx1-5083">s. This document uses UTF8 encoding. To create the + document do:
    latex sampleutf8
    makeglossaries sampleutf8
    latex sampleutf8
    -

    +

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

    -

    If you remove the sampleutf8.gls sampleutf8.glo +

    +

    If you remove the xindy option from sampleutf8.tex and do: @@ -2393,35 +2434,35 @@ class="cmtt-10">latex sampleutf8 class="cmtt-10">makeglossaries sampleutf8
    latex sampleutf8 -

    +

    you will see that the entries that start with an extended 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 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 - , the call to makeindex is as follows (no line breaks): + id="dx1-5089"> is as follows (no line + breaks):
    makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo
    -

    +

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

    makeglossaries sample-index - -
    latex sample-index
    -

    +

    + +

    sample-newkeys.tex
    This document illustrates how add custom keys (using - This document illustrates how add custom keys (using \glsaddkey).
    sample-storage-abbr.tex
    This document illustrates how add custom storage keys - (using This document illustrates how add custom storage keys (using + \glsaddstoragekey).
    sample-storage-abbr-desc.tex
    An extension of the previous example where the - user needs to provide a description. + id="x1-5094r29"> An extension of the previous example where the user + needs to provide a description.
    sample-chap-hyperfirst.tex
    This document illustrates how to add a custom - key using This document illustrates how to add a custom key using + \glsaddstoragekey and hook into the \gls-like and - \gls-like and \glstext-like mechanism used to determine whether or not to hyperlink an - entry. +class="cmtt-10">\glstext-like mechanism used to + determine whether or not to hyperlink an entry.
    sample-font-abbr.tex
    This document illustrates how to different fonts for - abbreviations within the style. + id="x1-5096r31"> This document illustrates how to different fonts for abbreviations + within the style.
    sample-numberlist.tex
    This document illustrates how to reference the number - list in the document text. This requires an additional LATEX run: - +href="#glo:numberlist">number list in the + document text. This requires an additional LATEX run:
    latex sample-numberlist
    makeglossaries sample-numberlist class="cmtt-10">latex sample-numberlist

    latex sample-numberlist
    -

    +

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

    latex samplePeople
    - - -

    +

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

    latex sampleSort
    -

    +

    sample-nomathhyper.tex
    This document illustrates how to selectively enable and - disable entry hyperlinks in This document illustrates how to selectively enable and disable + entry hyperlinks in \glsentryfmt.
    @@ -2559,18 +2596,18 @@ class="cmtt-10">makeglossaries sample-prefix class="cmtt-10">latex sample-prefix
    latex sample-prefix -

    +

    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 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. @@ -2578,10 +2615,8 @@ href="#sec:accsupp">Accessibility Support. sample-ignored.tex
    This document defines an ignored glossary for common terms - that don’t need a definition. - - + id="x1-5108r39"> This document defines an ignored glossary for common terms that + don’t need a definition.
    sample-entrycount.tex
    \glsenableentrycount and \cgls - (described in (described + in §14.1 Counting the Number of Times an Entry has been Used - (First Use Flag Unset)) so that acronyms only used once don’t appear in the list - of acronyms.
    -

    -

    -

    Counting the Number of Times an Entry has been Used (First Use + Flag Unset)) so that acronyms only used once don’t appear in the list of + acronyms. + + +

    +

    +

    Top

    1.2 Dummy Entries for Testing

    -

    In addition to the sample files described above,

    In addition to the sample files described above, glossaries also provides some -files containing lorum ipsum dummy entries. These are provided for testing -purposes and are on TEX’s path (in tex/latex/glossaries/test-entries) -so they can be included via also provides some files containing +lorum ipsum dummy entries. These are provided for testing purposes and are on TEX’s path +(in tex/latex/glossaries/test-entries) so they can be included via \input or or +\loadglsentries. The files are as -follows: + id="dx1-6003">. The files are as follows:

    example-glossaries-brief.tex
    These entries all have long descriptions.
    example-glossaries-multipar.tex
    These entries all have multi-paragraph +class="description">These entries all have multi-paragraph descriptions.
    symbolexample-glossaries-images.tex
    These entries use the user1 key to store the - name of an image file. (The images are provided by the key to store the name + of an image file. (The images are provided by the mwe package and - should be on TEX’s path.) One entry doesn’t have an associated image to - help test for a missing key. + id="dx1-6006"> package and should be + on TEX’s path.) One entry doesn’t have an associated image to help test for + a missing key.
    example-glossaries-acronym.tex
    These entries are all acronyms.
    example-glossaries-acronym-desc.tex
    These entries are all acronyms that - use the These entries are all acronyms that use the + description key.
    example-glossaries-acronyms-lang.tex
    These entries are all acronyms, - where some of them have a translation supplied in the These entries are all acronyms, where some + of them have a translation supplied in the user1 key.
    example-glossaries-parent.tex
    These are hierarchical entries where the child - entries use the These are hierarchical entries where the child entries + use the name key. - -
    example-glossaries-childnoname.tex
    These are hierarchical entries where - the child entries don’t use the These are hierarchical entries where the child + entries don’t use the name key.
    @@ -2685,32 +2719,33 @@ class="cmss-10">nameexample-glossaries-cite.tex
    These entries use the user1 key to store a citation - key (or comma-separated list of citation keys). The citations are defined in - xampl.bib, which should be available on all modern TEX distributions. - One entry doesn’t have an associated citation to help test for a missing - key. + id="dx1-6011"> key to store a citation key + (or comma-separated list of citation keys). The citations are defined in xampl.bib, + which should be available on all modern TEX distributions. One entry doesn’t + have an associated citation to help test for a missing key. + +
    example-glossaries-url.tex
    These entries use the These entries use the user1 key to store an URL + id="dx1-6012"> key to store an URL associated with the entry.
    -

    The sample file

    The sample file glossary-lipsum-examples.tex in the doc/latex/glossaries/samples directory uses all these files. See also http://www.dickimaw-books.com/gallery/#glossaries. -

    +

    -

    Top

    1.3 Multi-Lingual Support

    -

    As from version 1.17, the

    As from version 1.17, the glossaries package can now be used with xindynon-Latin alphabet it is recommended that you use < class="cmtt-10">xindy as makeindex is hard-coded -for the non-extended is hard-coded for the +non-extended Latin alphabet. This means that you are not restricted to the A, -…, Z letter groups. If you want to use . This means that you are not restricted to the A, …, Z letter +groups. If you want to use xindy, remember to use the xindy package -option. For example: - - + id="dx1-7007"> package option. For +example: + +

    \documentclass[frenchb]{article} @@ -2745,23 +2780,22 @@ option. For example:  
    \usepackage{babel}  
    \usepackage[xindy]{glossaries}
    -

    -

    Note that although a 

    +

    Note that although a non-Latin character, such as é, looks like a plain character -in your tex file, with standard LATEX it’s actually a macro and can therefore cause -expansion problems. You may need to switch off the field expansions with -\glsnoexpandfields. This issue doesn’t occur with XeLaTeX. -

    If you use a , such as é, looks like a plain character in your +tex file, with standard LATEX it’s actually a macro and can therefore cause expansion +problems. You may need to switch off the field expansions with \glsnoexpandfields. This +issue doesn’t occur with XeLaTeX. +

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

    + id="dx1-7010">). For example:

    \newglossaryentry}{elite}{name={{ or class}}
    -

    +

    (For further details, see the section “UTF-8” in the mfirstuc user manual.) -

    If you use the

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

    +

    -

    Top

    1.3.1 Changing the Fixed Names

    -

    The fixed names are produced using the commands listed in table 1.2. If you aren’t -using a language package such as

    The fixed names are produced using the commands listed in table 1.2. If you aren’t using a +language package such as babel or polyglossia that uses caption hooks, you can -just redefine these commands as appropriate. If you are using that uses caption hooks, you can just redefine +these commands as appropriate. If you are using babel or polyglossia, you -need to use their caption hooks to change the defaults. See changing the words -babel uses or read the , you need to use their +caption hooks to change the defaults. See changing the words babel uses or read the babel or polyglossia documentation. If you have loaded + id="dx1-8005"> or polyglossia documentation. If you have loaded babel, then glossaries will attempt to load translator, unless you have used the + id="dx1-8008"> will attempt to load translator, unless you have used the notranslate, translate=false or translate=babel package options. If the package +options. If the translator -package is loaded, the translations are provided by dictionary files (for example, - package is loaded, the translations are provided by dictionary files +(for example, glossaries-dictionary-English.dict). See the translator package for advice on - - -changing translations provided by package for advice +on changing translations provided by translator dictionaries. If you can’t work out how to -modify these dictionary definitions, try switching to dictionaries. If you can’t work out +how to modify these dictionary definitions, try switching to babel’s interface using translate=babel: - - + +

    \documentclass[english,french]{article}  
    \usepackage{babel}  
    \usepackage[translate=babel]{glossaries}
    -

    and then use

    and then use babel’s caption hook mechanism. Note that if you pass the language -options directly to ’s caption hook mechanism. Note that if you pass the language options +directly to babel rather that using the document class options or otherwise -passing the same options to rather that using the document class options or otherwise passing the same +options to translator, then translator won’t pick up the language -and no dictionaries will be loaded and won’t pick up the language and no dictionaries will be +loaded and babel’s caption hooks will be used -instead. + id="dx1-8022">’s caption hooks will be used instead.

    - - -


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

    + glossary.

    + id="dx1-8026">).

    + headers).

    + headers).

    + option.

    + option.

    + option.

    -
    Command Name

    Translator Key Word

    Purpose

    Purpose

    \glossaryname

    Glossary

    Title +class="td11">

    Glossary

    Title of the main - glossary.

    \acronymname

    Acronyms

    Title +class="td11">

    Acronyms

    Title of the list @@ -2939,17 +2969,17 @@ class="td10">

    Title option acronym).

    \entryname

    Notation (glossaries)

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

    Header for first column @@ -2965,17 +2995,17 @@ class="td10">

    Header glossaries that support - headers).

    \descriptionname

    Description (glossaries)

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

    Header for second column @@ -2991,17 +3021,17 @@ class="td10">

    Header glossaries that support - headers).

    \symbolname

    Symbol (glossaries)

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

    Header for symbol column @@ -3014,19 +3044,19 @@ class="td10">

    Header that support this - option.

    \pagelistname

    Page List (glossaries)

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

    Header for page list @@ -3039,17 +3069,17 @@ class="td10">

    Header that support this - option.

    \glssymbolsgroupname

    Symbols (glossaries)

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

    Header for symbols section @@ -3062,17 +3092,17 @@ class="td10">

    Header that support this - option.

    \glsnumbersgroupname

    Numbers (glossaries)

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

    Header for numbers section @@ -3085,158 +3115,157 @@ class="td10">

    Header that support this - option.

    - + option.

    + +
    - - + +

    -

    As from version 4.12, multilingual support is provided by separate language -modules that need to be installed in addition to installing the glossaries package. You -only need to install the modules for the languages that you require. If the language -module has an unmaintained status, you can volunteer to take over the maintenance -by contacting me at

    As from version 4.12, multilingual support is provided by separate language modules that +need to be installed in addition to installing the glossaries package. You only need to install +the modules for the languages that you require. If the language module has an +unmaintained status, you can volunteer to take over the maintenance by contacting me at +http://www.dickimaw-books.com/contact.html. The translator -dictionary files for glossaries are now provided by the appropriate language module. -For further details about information specific to a given language, please see the -documentation for that language module. -

    Examples of use:

    + id="dx1-8033"> dictionary files for glossaries +are now provided by the appropriate language module. For further details about +information specific to a given language, please see the documentation for that language +module. +

    Examples of use:

    • Using babel and translator: - - + +
      \documentclass[english,french]{article}  
      \usepackage{babel}  
      \usepackage{glossaries}
      -

      (

      (translator is automatically loaded).

    • Using babel: - - + +
      \documentclass[english,french]{article}  
      \usepackage{babel}  
      \usepackage[translate=babel]{glossaries}
      -

      (

      (translator isn’t loaded).

    • Using polyglossia: - - + +
      \documentclass{article}  
      \usepackage{polyglossia}  
      \setmainlanguage{english}  
      \usepackage{glossaries}
      -

      +

    • Using ngerman: - - + +
      \documentclass{article}  
      \usepackage{ngerman}  
      \usepackage{glossaries}
      -

      +

    -

    Due to the varied nature of glossaries, it’s likely that the predefined translations -may not be appropriate. If you are using the

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not +be appropriate. If you are using the babel package and the glossaries package -option glossaries package option +translate=babel, you need to be familiar with the advice given in changing the -words babel uses. If you are using the changing the words +babel uses. If you are using the translator package, then you can provide your -own dictionary with the necessary modifications (using \deftranslation) and load it -using package, then you can provide your own +dictionary with the necessary modifications (using \deftranslation) and load it using +\usedictionary. -

    Note that the

    Note that the translator 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 - 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 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, - - + id="dx1-8046"> 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 T

    (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

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

    \documentclass[british]{article} @@ -3247,8 +3276,8 @@ class="cmss-10">translate=babel    \renewcommand*{\acronymname}{List of Acronyms}%  
    }
    -

    -

    Note that

    +

    Note that xindy provides much better multi-lingual support than Xindy (Option 3) for further

    Creating a New Language Module
    -

    The

    The glossaries package now uses the tracklang package to determine which language -modules need to be loaded. If you want to create a new language module, you should -first read the package to determine which language modules +need to be loaded. If you want to create a new language module, you should first read the +tracklang documentation. -

    To create a new language module, you need to at least create two files: -

    To create a new language module, you need to at least create two files: glossaries-lang.ldf and .ldf +and glossaries-dictionary-Lang.dict where ⟨lang⟩ is the -root language name (for example, lang⟩ is the root language name (for +example, english) and ⟨Lang⟩ is the language name used by -Lang⟩ is the language name used by translator (for example, (for example, +English). -

    Here’s an example of

    Here’s an example of glossaries-dictionary-English.dict: - - + +

    \ProvidesDictionary{glossaries-dictionary}{English} @@ -3307,21 +3336,21 @@ class="cmtt-10">glossaries-dictionary-English.dict:  
    \providetranslation{Symbols (glossaries)}{Symbols}  
    \providetranslation{Numbers (glossaries)}{Numbers}
    -

    You can use this as a template for your dictionary file. Change English -to the

    You can use this as a template for your dictionary file. Change English to the translator name for your language (so that it matches the file name - name +for your language (so that it matches the file name glossaries-dictionary-Lang.dict) and, for each \providetranslation, change -the second argument to the appropriate translation. -

    Here’s an example of .dict) +and, for each \providetranslation, change the second argument to the appropriate +translation. +

    Here’s an example of glossaries-english.ldf: - - + +

    \ProvidesGlossariesLang{english} @@ -3369,8 +3398,8 @@ class="cmtt-10">glossaries-english.ldf:  
          \csappto{captions\CurrentTrackedLanguage}%  
          {%  
            \glossariescaptionsenglish - - + +  
          }%  
        }%  
        {% @@ -3382,48 +3411,46 @@ class="cmtt-10">glossaries-english.ldf:  
    \renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}  
    \renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
    -

    This is a somewhat longer file, but again you can use it as a template. Replace -English with the

    This is a somewhat longer file, but again you can use it as a template. Replace English with +the translator language label ⟨Lang⟩ used for the dictionary file and -replace english with the root language name ⟨lang⟩. Within the definition of -Lang⟩ used for the dictionary file and replace english with the +root language name ⟨lang⟩. Within the definition of \glossariescaptionslang⟩, replace the English text (such as “Glossaries”) with the -appropriate translation. -

    Note: the suffixes used to generate the plural forms when the plural hasn’t -been specified are given by \glspluralsuffix (for general entries) and -\glsupacrpluralsuffix for acronyms where the suffix needs to be set using +class="cmti-10">lang⟩, replace the +English text (such as “Glossaries”) with the appropriate translation. +

    Note: the suffixes used to generate the plural forms when the plural hasn’t been specified +are given by \glspluralsuffix (for general entries) and \glsupacrpluralsuffix for +acronyms where the suffix needs to be set using \glstextup to counteract the effects of \glstextup to counteract the effects of \textsc and \glsacrpluralsuffix for other -acronym styles. These commands need to be set before the entry is defined and so the -definitions aren’t included in the caption mechanism as that’s not switched on until -the start of the document. This means that the suffix in effect will be for the last -loaded language. -

    If you want to add a regional variation, create a file called \glsacrpluralsuffix for other acronym styles. These commands need to be +set before the entry is defined and so the definitions aren’t included in the caption mechanism +as that’s not switched on until the start of the document. This means that the suffix in effect +will be for the last loaded language. +

    If you want to add a regional variation, create a file called glossaries-iso lang-iso lang-iso countrycountry.ldf, where ⟨iso lang⟩ is the ISO language code and ⟨iso country⟩ is the -ISO country code. For example, glossaries-en-GB.ldf. This file can load the root -language file and make the appropriate changes, for example: - - +class="cmti-10">iso country⟩ is the ISO country +code. For example, glossaries-en-GB.ldf. This file can load the root language file and +make the appropriate changes, for example: + +

     \ProvidesGlossariesLang{en-GB} @@ -3445,18 +3472,18 @@ language file and make the appropriate changes, for example:  
       }%  
     }
    -

    -

    If the translations includes

    +

    If the translations includes non-Latin characters, it’s necessary to provide code -that’s independent of the input encoding. Remember that while some users may use -UTF-8, others may use Latin-1 or any other supported encoding, but while users -won’t appreciate you enforcing your preference on them, it’s useful to provide a -UTF-8 version for XeLaTeX users. -

    The s, it’s necessary to provide code that’s +independent of the input encoding. Remember that while some users may use UTF-8, others +may use Latin-1 or any other supported encoding, but while users won’t appreciate +you enforcing your preference on them, it’s useful to provide a UTF-8 version for +XeLaTeX users. +

    The glossaries-irish.ldf file provides this as follows: - - + +

    \ProvidesGlossariesLang{irish} @@ -3494,23 +3521,22 @@ class="cmtt-10">glossaries-irish.ldf file provides this as follows:  
      \glossariescaptionsirish  
    }
    -

    (Again you can use this as a template. Replace irish with your root language label -and

    (Again you can use this as a template. Replace irish with your root language label and +Irish with the translator dictionary label.) -

    There are now two extra files: glossaries-irish-noenc.ldf and -

    There are now two extra files: glossaries-irish-noenc.ldf and glossaries-irish-utf8.ldf. -

    These both define

    These both define \glossariescaptionsirish but the *-noenc.ldf uses -LATEX accent commands: - - +class="cmtt-10">*-noenc.ldf uses LATEX accent +commands: + +

    \@ifpackageloaded{polyglossia}% @@ -3539,249 +3565,268 @@ class="E">EX accent commands:  
      }%  
    }
    -

    whereas the

    whereas the *-utf8.ldf replaces the accent commands with the appropriate UTF-8 characters. -

    +

    -

    Top

    1.4 Generating the Associated Glossary Files

    -

    This section is only applicable if you have chosen Options 

    This section is only applicable if you have chosen Options 2 or 3. You can ignore this section if you have chosen Option 1.
    -

    -

    If this section seriously confuses you, and you can’t work out how to run -Option 1. If you want to alphabetically sort your entries +always remember to use the sort key if the name contains any LATEX commands. +

    +

    +

    If this section seriously confuses you, and you can’t work out how to run makeglossaries or or +makeindex, you can try using the , you can try using the automake package -option, described in package option, described in §2.4 Sorting Options, but you will need TEX’s shell escape -enabled. -

    In order to generate a sorted glossary with compact Sorting Options, +but you will need TEX’s shell escape enabled. +

    In order to generate a sorted glossary with compact number lists, it is necessary to -use an external indexing application as an intermediate step (unless you have chosen - - -Option 1, which uses TEX to do the sorting). 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 LATs, it is necessary to use an + + +external indexing application as an intermediate step (unless you have chosen Option 1, +which uses TEX to do the sorting). 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 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 . 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 only. Note that xindy has much better multi-lingual support than has much better multi-lingual support than +makeindex, -so , so xindy is recommended if you’re not writing in English. Commands that -only have an effect when is recommended if you’re not writing in English. Commands +that only have an effect when xindy is used are described in is used are described in §11 Xindy (Option 3). -

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

    This is a multi-stage process, but there are methods of automating document compilation using applications such as latexmk and and arara. See + id="dx1-10015">. See http://www.dickimaw-books.com/latex/thesis/html/build.html for more -information.
    -

    -

    The http://www.dickimaw-books.com/latex/thesis/html/build.html for more information. +

    +

    +

    The glossaries package comes with the Perl script makeglossaries which will run + id="dx1-10016"> which will run makeindex or or xindy on all the glossary files using a customized style file (which is -created by on all the glossary files using a customized style file (which is created +by \makeglossaries). See ). See §1.4.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. Most Unix-like operating systems come with -a Perl interpreter. TUsing 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. Most Unix-like operating systems come with a Perl +interpreter. TEX Live also comes with a Perl interpreter. MiKTEX doesn’t -come with a Perl interpreter so if you are a Windows MiKTEX doesn’t come +with a Perl interpreter so if you are a Windows MiKTEX user you will need to install Perl if you want to use makeglossaries. Further information is available at + id="dx1-10020">. Further information is available at http://www.perl.org/about.html and MiKTeX and Perl scripts (and one Python script). -

    The advantages of using

    The advantages of using makeglossaries:

    + id="dx1-10021">:

    • It automatically detects whether to use makeindex or or xindy and sets the - relevant application switches. + id="dx1-10023"> and sets the relevant + application switches.
    • One call of makeglossaries will run will run makeindex//xindy for each glossary - type. + id="dx1-10026"> for each glossary type.
    • If things go wrong, makeglossaries will scan the messages from will scan the messages from makeindex - or 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 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. +
    • +
    • If makeindex or warns about multiple encap values, makeglossaries will detect this + and attempt to correct the problem.1.3 + Since xindy messages. + id="dx1-10036"> doesn’t warn about this, this correction is only provided by + makeglossaries when makeindex is used.
    -

    As from version 4.16, the glossaries package also comes with a Lua script -called

    As from version 4.16, the glossaries package also comes with a Lua script called +makeglossaries-lite.lua. This is a trimmed-down alternative to -the . This is a trimmed-down alternative to the makeglossaries Perl script. It doesn’t have some of the options that - - -the Perl version has and it doesn’t attempt to diagnose any problems, but -since modern T Perl +script. It doesn’t have some of the options that the Perl version has and it doesn’t attempt to +diagnose any problems, but since modern TEX distributions come with LuaTEX (and therefore have -a Lua interpreter) you don’t need to install anything else in order to use +class="E">EX (and +therefore have a Lua interpreter) you don’t need to install anything else in order to use makeglossaries-lite.lua so it’s an alternative to so it’s an alternative to makeglossaries if you want to -use if you want to use +Option 2 (makeindex). -

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

    Whilst it is strongly recommended that you use the ). +

    Whilst I strongly recommended that you use the makeglossaries Perl -script or the Perl script or the +makeglossaries-lite.lua script or the makeglossariesgui -Java application, it is possible to use the glossaries package without using -those applications. However, note that some commands and package options -have no effect if you explicitly run Lua script, it is possible to use the glossaries package +without using those applications. However, note that some commands and package +options have no effect if you explicitly run makeindex//xindy. These are listed in + id="dx1-10047">. These are listed in table 1.3. -

    If you are choosing not to use

    If you are choosing not to use makeglossaries because you don’t want to install -Perl, you will only be able to use because you don’t want to install Perl, +you will only be able to use makeindex as 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 also requires Perl. (Other useful Perl +scripts include epstopdf and latexmk, so it’s well-worth the effort to install 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, , makeindex or or +xindy -run, as appropriate. For example, suppose you have defined the following + id="dx1-10053"> run, as appropriate. For example, suppose you have defined the following entries:1.3 - - +href="#fn4x1" id="fn4x1-bk">1.4 + +

    \newglossaryentry{citrusfruit}{name={citrus fruit}, @@ -3790,22 +3835,22 @@ href="#fn3x2" id="fn3x2-bk">1.3\newglossaryentry{orange}{name={orange},  
    description={an orange coloured fruit.}}
    -

    and suppose you have \gls{citrusfruit} in your document but don’t reference the -

    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 orange entry won’t appear in your glossary until you +first create the glossary and then do another run of makeglossaries, , makeindex or - +or xindy. For example, if the document is called . For example, if the document is called myDoc.tex, then you must do:
    latex myDoc class="cmtt-10">makeglossaries myDoc

    latex myDoc
    -

    -

    Likewise, an additional

    +(Note that if you use glossaries-extra, this will be done automatically for you if +the indexcrossrefs feature is enabled. See the glossaries-extra user guide for further +details.) +

    Likewise, an additional makeglossaries and LAT 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 -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, -, xindy or or +makeindex via a terminal. Windows users can use the MSDOS Prompt -which is usually accessed via the via a terminal. Windows users can use the MSDOS Prompt which is usually +accessed via the Start->All Programs menu or Start->All -Programs-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 Accessories +menu. +

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

    If any problems occur, remember to check the transcript files (e.g. EX to Write a PhD Thesis” describes how +to do it for TeXWorks. For other editors see the editor’s user manual for further +details. +

    If any problems occur, remember to check the transcript files (e.g. .glg or or .alg) -for messages. + id="dx1-10065">) for +messages.

    - - -


    - - + +
    Table 1.3: Commands and package options that have no effect when using xindy -or or +makeindex explicitly
    + id="dx1-10068"> explicitly
    Command or Package Option + id="dx1-10070"> style="vertical-align:baseline;" id="TBL-4-3-"> style="vertical-align:baseline;" id="TBL-4-5-"> style="vertical-align:baseline;" id="TBL-4-6-">
    makeindex xindy
    order=letter use -l use -M ord/letorderorder=word default default
    xindy=={language=langcode\GlsSetXdyLanguage{lang} lang⟩ \GlsSetXdyCodePage{code} use -C code
    - - + +

    -

    Top

    1.4.1 Using the makeglossaries Perl Script

    -

    The

    The makeglossaries script picks up the relevant information from the auxiliary -( script picks up the relevant information from the auxiliary (.aux) file and will either call ) file +and will either call xindy or makeindex, depending on the supplied -information. Therefore, you only need to pass the document’s name without the -extension to , 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: + id="dx1-11005">. 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 makeglossaries into Perl:
    perl makeglossaries myDoc
    -

    -

    Windows users: TeX Live on Windows has its own internal Perl interpreter and -provides

    +

    Windows users: TeX Live on Windows has its own internal Perl interpreter and provides +makeglossaries.exe as a convenient wrapper for the makeglossaries Perl -script. MiKTeX also provides a wrapper makeglossaries.exe but doesn’t -provide a Perl interpreter, which is still required even if you run MiKTeX’s -makeglossaries.exe, so with MiKTeX you’ll need to install Perl. There’s more -information about this at Perl script. +MiKTeX also provides a wrapper makeglossaries.exe but doesn’t provide a Perl +interpreter, which is still required even if you run MiKTeX’s makeglossaries.exe, so +with MiKTeX you’ll need to install Perl. There’s more information about this at +http://tex.stackexchange.com/q/158796/19862 on the -TeX.SX site. Alternatively, there is a batch file called makeglossaries.bat that -should be located in the same folder as the http://tex.stackexchange.com/q/158796/19862 on the TeX.SX site. Alternatively, there +is a batch file called makeglossaries.bat that should be located in the same folder as the +makeglossaries Perl script. This just -explicitly loads the script into Perl. If you’ve installed Perl but for some reason your -operating system can’t find perl.exe, you can edit the makeglossaries.bat file to -include the full path to perl.exe (but take care as this file will be overwritten next -time you update the Perl script. This just explicitly loads the script into Perl. If you’ve installed +Perl but for some reason your operating system can’t find perl.exe, you can edit the +makeglossaries.bat file to include the full path to perl.exe (but take care as this file will +be overwritten next time you update the glossaries package). If you move the .bat file to a new location, -you will also need to supply the full path to the .bat file to a +new location, you will also need to supply the full path to the makeglossaries Perl script. -(Don’t also move the Perl script as well or you may miss out on updates to + id="dx1-11009"> Perl +script. (Don’t also move the Perl script as well or you may miss out on updates to makeglossaries.) -

    The

    The makeglossaries script attempts to fork the makeindex/xindy process using - process +using open() on the piped redirection 2>&1 | and parses the processor output to help -diagnose problems. If this method fails  | and parses the processor output to +help diagnose problems. If this method fails makeglossaries will print an “Unable to fork” -warning and will retry without redirection. If you run will print an “Unable +to fork” warning and will retry without redirection. If you run makeglossaries on an -operating system that doesn’t support this form of redirection, then you can use the - +on an operating system that doesn’t support this form of redirection, then you +can use the -Q switch to suppress this warning or you can use the -k switch to make --k switch to +make makeglossaries automatically use the fallback method without attempting the -redirection. Without this redirection, the automatically use the fallback method without attempting +the redirection. Without this redirection, the -q (quiet) switch doesn’t work as well. -

    You can specify in which directory the

    You can specify in which directory the .aux, .glo etc files are located using the -d -switch. For example: +class="cmtt-10">-d switch. +For example:
    pdflatex -output-directory myTmpDir myDoc
    makeglossaries -d myTmpDir myDoc
    - - -

    + + +

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

    The

    As from makeglossaries v2.18, if you are using makeindex, there’s a check for +makeindex’s multiple encap warning. This is where different encap values (location formats) +are used on the same location for the same entry. For example: + + +

    +
    +\documentclass{article} + 
    \usepackage{glossaries} + 
    \makeglossaries + 
    \newglossaryentry{sample}{name={sample},description={an example}} + 
    \begin{document} + 
    \gls{sample}, \gls[format=textbf]{sample}. + 
    \printglossaries + 
    \end{document} +
    +

    If you explicitly use makeindex, this will cause a warning and the location list +will be “1, 1”. That is, the page number will be repeated with each format. As +from v2.18, makeglossaries will check for this warning and, if found, will attempt +to correct the problem by removing duplicate locations and retrying. There’s no +similar check for xindy as xindy won’t produce any warning and will simply discard +duplicates. +

    The makeglossaries script contains POD (Plain Old Documentation). If you -want, you can create a man page for script contains POD (Plain Old Documentation). If you want, you +can create a man page for makeglossaries using using pod2man and -move the resulting file onto the man path. Alternatively do makeglossaries + id="dx1-11033"> and move the resulting file onto +the man path. Alternatively do makeglossaries --help for a list of all options or --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 --version for the version number. +

    -

    -

    + id="dx1-11034">. The current version is 2.18.

    +

    +

    -

    Top

    1.4.2 Using the makeglossaries-lite.lua Lua Script

    -

    The Lua alternative to the

    The Lua alternative to the makeglossaries Perl script requires a Lua interpreter, -which should already be available if you have a modern TEX distribution that -includes LuaTEX. Lua is a light-weight, cross-platform scripting language, but -because it’s light-weight it doesn’t have the full-functionality of heavy-weight scripting -languages, such as Perl. The Perl script requires a Lua interpreter, which +should already be available if you have a modern TEX distribution that includes LuaTEX. +Lua is a light-weight, cross-platform scripting language, but because it’s light-weight it +doesn’t have the full-functionality of heavy-weight scripting languages, such as Perl. The +makeglossaries-lite.lua script is therefore limited by -this and some of the options available to the script is therefore limited by this and some of the options +available to the makeglossaries Perl script aren’t -available here. (In particular the -d option.) -

    The Perl script aren’t available here. (In particular the -d +option.) +

    The makeglossaries-lite.lua script can be invoked in the same way as - script can be invoked in the same way as makeglossaries but you need to remember the .lua extension. For example, if your -document is called +but you need to remember the .lua extension. For example, if your document is called +myDoc.tex, then do
    makeglossaries-lite.lua myDoc
    -

    -

    +

    Some of the options available with makeglossaries are also available -with are also available with +makeglossaries-lite.lua. For a complete list of available options, do - + id="dx1-12007">. For a complete list of available options, do
    makeglossaries-lite.lua --help
    -

    -

    +

    +

    -

    Top

    1.4.3 Using xindy explicitly (Option 3)

    -

    Xindy comes with TEX Live, but not with MiKTEX. However MikTEX users can -install it. See EX users can install it. +See How to use Xindy with MikTeX on TEX on StackExchange. - - -

    If you want to use

    If you want to use xindy to process the glossary files, you must make sure you -have used the 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 @@ -4228,16 +4316,16 @@ class="cmtt-10">makeglossaries or makeglossariesgui. This -causes the glossary entries to be written in raw . This causes the +glossary entries to be written in raw xindy format, so you need to use -I xindy not -I xindy not -I tex. -

    To run tex. +

    To run xindy type the following in your terminal (all on one line): @@ -4250,48 +4338,47 @@ class="cmtt-10">-I xindy -M style-t base.glg -o -⟨.glg -o base.gls .gls +⟨base.glo -

    +

    where ⟨language⟩ is the required language name, ⟨encoding⟩ is the encoding, ⟨base⟩ is the -name of the document without the base⟩ is the name of +the document without the .tex extension and ⟨style⟩ is the name of -the style⟩ is the name of the xindy style file without the style file +without the .xdy extension. The default name for this -style file is ⟨ extension. The default name for this style file is ⟨base.xdy but can be changed via 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: +class="cmtt-10">}. 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 +

    +

    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 @@ -4310,52 +4397,51 @@ class="cmss-10">acronymxindy -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

    +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 - instead, you can replace all those calls to xindy with just one call to +with just one call to makeglossaries:
    makeglossaries myDoc
    -

    -Note also that some commands and package options have no effect if you -use

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

    +

    -

    Top

    1.4.4 Using makeindex explicitly (Option 2)

    -

    If you want to use

    If you want to use makeindex explicitly, you must make sure that you haven’t used -the 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 +package option or the glossary entries will be written in the wrong format. To run makeindex, type the following in your terminal: + id="dx1-14003">, +type the following in your terminal:
    makeindex -s stylebase.gls base.glo
    -

    +

    where ⟨base⟩ is the name of your document without the .tex extension and -⟨ extension and ⟨style.ist is the name of the is the +name of the makeindex style file. By default, this is ⟨base.ist, -but may be changed via , but may be changed via +\setStyleFile{style}. Note that there are other -options, such as -l (letter ordering). See the }. 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 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

    +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 for each glossary, +substituting .glg, .gls and .glo with the relevant extensions. For -example, if you have used the with the relevant extensions. For example, if you have used +the acronym package option, then you need to type the -following in your terminal: + id="dx1-14015"> 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

    +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 - instead, you can replace all those calls to makeindex with just one call to +with just one call to makeglossaries:
    makeglossaries myDoc
    -

    -Note also that some commands and package options have no effect if you use -

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

    +

    -

    Top

    1.4.5 Note to Front-End and Script Developers

    -

    The information needed to determine whether to use

    The information needed to determine whether to use xindy 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 -


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


    \@newglossary  out-ext}{in-ext}

    - - -

    +

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

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

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

    -

    The

    +

    The indexing application’s style file is specified by -



    \@istfilename  \@istfilename{filename}

    -

    +

    The file extension indicates whether to use makeindexxindy (.xdy). Note -that the glossary information is formatted differently depending on which + id="dx1-15008">). +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: -


    Word or letter ordering is specified by: +


    \@glsorder  \@glsorder{order}

    -

    +

    where ⟨order⟩ can be either word or letter. -

    If

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



    \@xdylanguage label}{code}

    -

    +

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

    If

    If Option 1 has been used, the .aux file will contain -



    \@gls@reference{type}{label}{location}

    -

    +

    for every time an entry has been referenced. - - + +

    -

    -

    +

    Top

    2. Package Options

    -

    This section describes the available glossaries package options. You may -omit the =true for boolean options. (For example,

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

    Note that ⟨

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

    + id="dx1-16004">) may be passed via the document class options. +

    +

    -

    Top

    2.1 General Options

    @@ -4627,11 +4709,10 @@ href="#top">Top

    nowarn

    This suppresses all warnings generated by the glossaries package. Don’t - use this option if you’re new to using glossaries as the warnings are - designed to help detect common mistakes (such as forgetting to use - glossaries package. Don’t use this + option if you’re new to using glossaries as the warnings are designed to help detect + common mistakes (such as forgetting to use \makeglossaries).
    @@ -4639,14 +4720,14 @@ class="cmtt-10">\makeglossariesnoredefwarn
    If you load glossaries with a class or another package that already - defines glossary related commands, by default glossaries will warn you that - it’s redefining those commands. If you are aware of the consequences of - using glossaries with that class or package and you don’t want to be warned - about it, use this option to suppress those warnings. Other warnings will - still be issued unless you use the glossaries with a class or another package that already defines + glossary related commands, by default glossaries will warn you that it’s redefining + those commands. If you are aware of the consequences of using glossaries with that + class or package and you don’t want to be warned about it, use this option to + suppress those warnings. Other warnings will still be issued unless you use the + nowarn option described above.
    @@ -4654,38 +4735,38 @@ class="cmss-10">nowarnnomain
    This suppresses the creation of the main glossary and associated .glo - file, if unrequired. Note that if you use this option, you must create - another glossary in which to put all your entries (either via the .glo file, if + unrequired. Note that if you use this option, you must create another glossary in + which to put all your entries (either via the acronym - (or (or acronyms) package option described in ) package option + described in §2.5 Acronym Options or via the - Acronym Options or via the symbols, numbers or index options described in options + described in §2.6 Other Options or via - Other Options or via \newglossary described in §12 Defining New Glossaries). -

    If you don’t use the main glossary and you don’t use this option, Defining + New Glossaries). +

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

    + id="dx1-17012"> will + produce the following warning:

    Warning:filename.glo’ is empty. - -
    Have you in glossary
    ’main’? + +
    Remember to the main glossary.
    -
    If you did actually want to use the main glossary and you see this warning, - check that you have referenced the entries in that glossary via commands such as - If you did actually want to use the main glossary and you see this warning, check that + you have referenced the entries in that glossary via commands such as \gls.
    -

    + id="dx1-17013">. +

    +

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

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

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

    -
    +
    \newcommand{\mysortvalue}{AAA}  
    \newglossaryentry{sample}{%  
      name={sample},  
      sort={\mysortvalue},  
      description={an example}}
    -

    and you actually want \mysortvalue expanded, so that the entry is sorted - according to

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

    The default for Options 

    The default for Options 2 and 3 is sanitizesort=true, and the default for - Option 1 is , and the default for Option 1 is + sanitizesort=false.

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

    This option can significantly slow document compilation. As an alternative, you - can use the

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

    -

    You can also reduce the number of write registers by using Option 1 or by - ensuring you define all your glossary entries in the preamble. -

    If you want to use T package (part of the KOMA-Script bundle) and not use this option. +
    +

    +

    You can also reduce the number of write registers by using Option 1 or by ensuring you + define all your glossary entries in the preamble. +

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

    -

    +

    +

    translateThis can take the following values: translate=true
    If If babel has been loaded and the has been loaded and the translator package is - installed, package is installed, + translator will be loaded and the translations will be provided - by the 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 + package interface. You can modify the translations by providing your own + dictionary. If the translator package isn’t installed - and package isn’t installed and babel is loaded, the is loaded, the + glossaries-babel package will be loaded and the - translations will be provided using package will be loaded and the translations will be provided + using babel’s \addto\captionlanguage⟩ - mechanism. If language⟩ mechanism. If polyglossia has been loaded, has been + loaded, glossaries-polyglossia will - be loaded. + id="dx1-17040"> will be loaded.
    translate=falseDon’t provide translations, even if babel or polyglossia has - been loaded. (Note that has been + loaded. (Note that babel provides the command \glossaryname - so that will still be translated if you have loaded so that will + still be translated if you have loaded babel.)
    translate=babel
    Don’t load the Don’t load the translator package. Instead load - package. Instead load glossaries-babel. -

    I recommend you use

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

    + id="dx1-17052">.

    +

    -

    If

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

    See

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

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

    The values must be fully expanded, so

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


    . You + may also use +


    \GlsDeclareNoHyperList{list}

    -

    +

    instead or additionally. See §6 Links to Glossary Entries for further - details. +href="#sec:glslink">Links to Glossary Entries for further details.

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

    The

    The hyperfirst setting applies to all glossary types (unless identified by - setting applies to all glossary types (unless identified by nohypertypes or defined with or + defined with \newignoredglossary). It can be overridden on an - individual basis by explicitly setting the ). It can be overridden on an individual basis by + explicitly setting the hyper key when referencing - an entry (or by using the plus or starred version of the referencing - command). -

    It may be that you only want to apply this to just the acronyms (where the first - use explains the meaning of the acronym) but not for ordinary glossary entries - (where the first use is identical to subsequent uses). In this case, you can use - key when referencing an entry (or by using the plus or + starred version of the referencing command). +

    It may be that you only want to apply this to just the acronyms (where the first use + explains the meaning of the acronym) but not for ordinary glossary entries (where the + first use is identical to subsequent uses). In this case, you can use hyperfirst=false and apply \glsunsetall to all the regular (non-acronym) - glossaries. For example: - - + id="dx1-17081"> + and apply \glsunsetall to all the regular (non-acronym) glossaries. For + example: + +

    -
    +
     \usepackage[acronym,hyperfirst=false]{glossaries}  
     % acronym and glossary entry definitions  
     % at the end of the preamble  
     \glsunsetall[main]
    -

    -

    Alternatively you can redefine the hook -


    +

    Alternatively you can redefine the hook +


    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +

    which is used by the commands that check the first use flag, such as \gls. - Within the definition of this command, you can use . Within the + definition of this command, you can use \glslabel to reference the - entry label and \glstype to reference the glossary type. You can also use + id="dx1-17084"> to reference the entry label and \glstype to reference the glossary type. You can also use \ifglsused to determine if the entry has been used. You can test if - an entry is an acronym by checking if it has the long key set using + id="dx1-17086"> to determine if + the entry has been used. You can test if an entry is an acronym by checking if it has the long key set using \ifglshaslong. For example, to switch off the hyperlink on first use just for - acronyms: - - + id="dx1-17088">. For example, to switch off the hyperlink on first use + just for acronyms: + +

    -
    +
    \renewcommand*{\glslinkcheckfirsthyperhook}{%  
     \ifglsused{\glslabel}{}%  
     {% @@ -5093,15 +5167,15 @@ class="cmtt-10">\ifglshaslong }%  
    }
    -

    -

    Note that this hook isn’t used by the commands that don’t check the first use - flag, such as

    +

    Note that this hook isn’t used by the commands that don’t check the first use flag, such + as \glstext. (You can, instead, redefine \glslinkpostsetkeys, - which is used by both the , which is used by both + the \gls-like and \glstext-like commands.) indexonlyfirst

    This is a boolean option that specifies whether to only add information to - the external glossary file on This is a boolean option that specifies whether to only add information to the + external glossary file on first use. The default is indexonlyfirst=false, which will - add a line to the file every time one of the , which will add a + line to the file every time one of the \gls-like or \glstext-like commands - are used. Note that \glstext-like commands are + used. Note that \glsadd will always add information to the external glossary file2.12.1 (since that’s the purpose of that command). -

    You can customise this by redefining -


    You can customise this by redefining +


    \glswriteentry  label}{wr-code}

    -

    +

    where ⟨label⟩ is the entry’s label and ⟨wr-code⟩ is the code that writes the entry’s information to the external file. The default definition of \glswriteentry is: - - + +

    -
    +
    \newcommand*{\glswriteentry}[2]{%  
      \ifglsindexonlyfirst  
        \ifglsused{#1}{}{#2}% @@ -5156,33 +5230,33 @@ class="cmtt-10">\glswriteentry  
      \fi  
    }
    -

    This checks the

    This checks the indexonlyfirst package option (using \ifglsindexonlyfirst) - and does ⟨\ifglsindexonlyfirst) and does + ⟨wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry - hasn’t been used. -

    For example, suppose you only want to index the first use for entries in the - acronym glossary and not in the wr-code⟩ of the entry hasn’t been + used. +

    For example, suppose you only want to index the first use for entries in the acronym + glossary and not in the main (or any other) glossary: - - + +

    -
    +
    \renewcommand*{\glswriteentry}[2]{%  
     \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}  
     {\ifglsused{#1}{}{#2}}%  
     {#2}%  
    }
    -

    Here I’ve used

    Here I’ve used \ifthenelse to ensure the arguments of \equal are fully - expanded before the comparison is made. +class="cmtt-10">\equal are fully expanded + before the comparison is made.

    savenumberlist\glsdisplaynumberlist in §9 Using Glossary - Terms Without Links.) This is always true if you use Using Glossary Terms + Without Links.) This is always true if you use Option 1. -

    +

    -

    Top

    2.2 Sectioning, Headings and TOC Options

    @@ -5217,19 +5291,19 @@ class="description">Add the glossaries to the table of contents. Note that an ex class="E">EX run is required with this option. Alternatively, you can switch this function on and off using -



    \glstoctrue  \glstoctrue

    -

    +

    and -



    \glstocfalse  \glstocfalse

    -

    +

    numberlinetoc, this will add \numberline{} in the final - argument of {} in the final argument of + \addcontentsline. This will align the table of contents - entry with the numbered section titles. Note that this option has no - effect if the . This will align the table of contents entry with the numbered + section titles. Note that this option has no effect if the toc option is omitted. If toc is used without is + used without numberline, the - title will be aligned with the section numbers rather than the section - titles. - - + id="dx1-18010">, the title will be aligned with the section numbers rather than + the section titles. + +
    sectionsectionThis is a ⟨key⟩=⟨value⟩ option. Its value should be the name of a sectional unit - (e.g. chapter). This will make the glossaries appear in the named sectional - unit, otherwise each glossary will appear in a chapter, if chapters exist, - otherwise in a section. Unnumbered sectional units will be used by default. - Example: - - -
    + (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 -


    You can change this value later in the document using +


    \setglossarysection  \setglossarysection{name}

    -

    +

    where ⟨name⟩ is the sectional unit. -

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


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


    \glsglossarymark  \glsglossarymark{glossary title}

    -

    +

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

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

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

    or to prevent it from changing the headers: + +

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

    If you want

    If you want \glsglossarymark to use \MakeUppercase in the header, use the - \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 - + option described below. +

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

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

    +

    ucmarkThis is a boolean option (default: ucmark=false, unless memoir has been - loaded, in which case it defaults to has been loaded, + in which case it defaults to ucmark=true). If set, \glsglossarymark\glsglossarymark\MakeTextUppercase2.32.3. You can test whether this option has been set or not using -



    \ifglsucmark  true part\else false part\fi

    -

    +

    For example: - - + +

    -
    +
    \renewcommand{\glsglossarymark}[1]{%  
      \ifglsucmark  
        \markright{\MakeTextUppercase{#1}}% @@ -5388,7 +5458,7 @@ class="cmtt-10">\fi

     
        \markright{#1}%  
      \fi}
    -

    If

    If memoir has been loaded and ucfirst\memUCheadnumberedsection

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


      ). The label is formed from +


      \glsautoprefix  \glsautoprefix type

      -

      +

      where ⟨type⟩ is the label identifying that glossary. The default value - of type⟩ is the label identifying that glossary. The default value of + \glsautoprefix is empty. For example, if you load glossaries - using: - - +class="cmss-10">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 +

      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 main if the + acronym option is not used and is set to acronym if the acronym option - is used. For example: - - + id="dx1-18044"> option is used. For + example: + +

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

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

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

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

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

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

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

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

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

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

      +

    • nameref\chapter*\section*). It’s designed for use with the nameref - package. For example: - - -
      + id="dx1-18049"> package. + For example: + + +
      \usepackage{nameref}  
      \usepackage[numberedsection=nameref]{glossaries}
      -

      Now \nameref{main} will display the (TOC) section title associated with - the

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

    +class="cmtt-10">\glsautoprefix
    to provide a prefix for + the label.

    -

    +

    -

    Top

    2.3 Glossary Appearance Options

    entrycounter
    This is a boolean option. (Default is 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 - .) 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 +

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



    \glsrefentry  \glsrefentry{label}

    -

    +

    where ⟨label⟩ is the label associated with that glossary entry. -

    If you use

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

    + id="dx1-19008"> to ensure the cross-references are + up-to-date.

    +

    counterwithincounterwithinThis is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ is the name of a counter. If - used, this option will automatically set value⟩ is the name of a counter. If used, this + option will automatically set entrycounter=true and the glossaryentry - counter will be reset every time ⟨ counter will be + reset every time ⟨value⟩ is incremented. -

    The

    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 - 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 + id="dx1-19013"> is the + same as the counter used in the glossary’s sectioning command.

    +

    +

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



    \glsresetentrycounter  \glsresetentrycounter

    -

    +

    which sets glossaryentry to zero: - - + +

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

    or if you are using

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

    -
    +
    \setglossarypreamble[acronym]{%  
      \glsresetentrycounter  
      The preamble text here for the list of acronyms. @@ -5644,26 +5711,26 @@ class="cmtt-10">\setglossarypreamble  The preamble text here for the main glossary.  
    }
    -

    +

    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 + id="dx1-19019">.) 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 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 . You can reference the number within the + document using \glsrefentry{This is a ⟨key⟩=⟨value⟩ option. (Default is style=list.) Its value should be the name - of the glossary style to use. This key may only be used for styles defined in - .) Its value should be the name of the + glossary style to use. This key may only be used for styles defined in glossary-list, , + glossary-long, glossary-super or glossary-tree. Alternatively, you can - set the style using -


    . Alternatively, you can set the style + using +


    \setglossarystyle{style name}

    -

    +

    (See §15 nolongThis prevents the glossaries package from automatically loading glossary-long - (which means that the (which + means that the longtable package also won’t be loaded). This reduces - overhead by not defining unwanted styles and commands. Note that - if you use this option, you won’t be able to use any of the glossary - styles defined in the glossary-long package (unless you explicitly load - package also won’t be loaded). This reduces overhead by not + defining unwanted styles and commands. Note that if you use this option, you won’t be + able to use any of the glossary styles defined in the glossary-long package (unless you + explicitly load glossary-long).

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

    +

    nonumberlist
    This option will suppress the associated number lists in the glossaries - (see also s in the glossaries (see also + §5 Number lists). @@ -5822,8 +5887,8 @@ href="#glo:numberlist">number lists with nonumberlist, described - above, this will also suppress any cross-referencing information supplied by the - see key in \newglossaryentry\newglossaryentry\glssee. If you use seeautonumberlist, the , + the see - key will automatically implement key will automatically implement nonumberlist=false for that entry. (Note this - doesn’t affect for that entry. + (Note this doesn’t affect \glssee.) For further details see §8 Number class="cmssbx-10">nopostdot
    This is a boolean option. If no value is specified, true is assumed. When - set to true, this option suppresses the default post description dot used by some - of the predefined styles. The default setting is true is assumed. When set to + true, this option suppresses the default post description dot used by some of the + predefined styles. The default setting is nopostdot=false.
    @@ -5875,113 +5940,109 @@ class="cmss-10">nopostdot=falsenogroupskip
    This is a boolean option. If no value is specified, true is assumed. When - set to true, this option suppresses the default vertical gap between - groups used by some of the predefined styles. The default setting is +class="cmtt-10">true is assumed. When set to true, this option suppresses the default vertical gap between groups used by some of + the predefined styles. The default setting is nogroupskip=false.
    -

    +

    -

    Top

    2.4 Sorting Options

    - - + +
    sort
    If you use Options 2 or 3, this package option is the only way of specifying - how to sort the glossaries. Only Option 1 allows you to specify sort methods - for individual glossaries via the 3, this package option is the only way of specifying how to + sort the glossaries. Only Option 1 allows you to specify sort methods for individual + glossaries via the sort key in the optional argument of - key in the optional argument of \printnoidxglossary. If you have multiple glossaries in your document - and you are using Option 1, only use the package options . If + you have multiple glossaries in your document and you are using Option 1, only + use the package options sort=def or - or sort=use if you want to set this sort method for if you want to set this sort method + for all your glossaries. -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ may be one of the following: -

    +class="cmti-10">value
    ⟩ may be one of the following:

    • standard : entries are sorted according to the value of the sort key - used in key used in + \newglossaryentry (if present) or the name key (if sort key - is missing); + id="dx1-20010"> key is missing);
    • def : entries are sorted in the order in which they were defined (the - : entries are sorted in the order in which they were defined (the sort key in key + in \newglossaryentry is ignored);
    • use : entries are sorted according to the order in which they are used - in the document (the : entries are sorted according to the order in which they are used in the + document (the sort key in \newglossaryentry is ignored). -

      Both

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


      set the sort key to a six digit number via +


      \glssortnumberfmt  \glssortnumberfmt{number}

      -

      - (padded with leading zeros, where necessary). This can be redefined, if - required, before the entries are defined (in the case of

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

    -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) are incompatible with the sort=use - and and + sort=def options. -

    The default is

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


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


    \glsprestandardsort  }{type}{label} -

    -

    +class="cmtt-10">}


    +

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



    \glsdosanitizesort  \glsdosanitizesort

    -

    +

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

    The other arguments, ⟨

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

    Redefining \glsprestandardsort won’t affect any entries that have already - been defined and will have no effect at all if you are using

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

    +

    -

    Example 1 (Mixing Alphabetical and Order of Definition Sorting) -

    Suppose I have three glossaries:

    Suppose I have three glossaries: main, acronym and notation, and let’s suppose - I want the notation, and let’s suppose I want + the main and acronym glossaries to be sorted alphabetically, but the - notation type should be sorted in order of definition. -

    For acronym glossaries to be sorted alphabetically, but the notation type + should be sorted in order of definition. +

    For Option 1, I just need to set the sort key in the optional argument of \printnoidxglossary: - - + +

    -
    +
    \printnoidxglossary[sort=word]  
    \printnoidxglossary[type=acronym,sort=word]  
    \printnoidxglossary[type=notation,sort=def]
    -

    -

    For Options 

    +

    For Options 2 or 3, I can set the sort to standard (which is the default, but can - be explicitly set via the package option standard (which is the default, but can be + explicitly set via the package option sort=standard), and I can either define all - my main and ), and I can either define all my main + and acronym entries, then redefine \glsprestandardsort to set ⟨sort - cs⟩ to an incremented integer, and then define all my notation entries. - Alternatively, I can redefine \glsprestandardsort to check for the glossary - type and only modify ⟨sort cs⟩ if ⟨sort cs⟩ to an + incremented integer, and then define all my notation entries. Alternatively, I can + redefine \glsprestandardsort to check for the glossary type and only modify ⟨sort cs⟩ if + ⟨type⟩ is notation. -

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

    The first option can be achieved as follows: + +

    -
    +
    \newcounter{sortcount}  
    \renewcommand{\glsprestandardsort}[3]{%  
      \stepcounter{sortcount}%  
      \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%  
    }
    -

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

    The second option can be achieved as follows: + +

    -
    +
    \newcounter{sortcount}  
    \renewcommand{\glsprestandardsort}[3]{%  
      \ifdefstring{#2}{notation}% @@ -6128,74 +6186,74 @@ class="cmtt-10">notation.  
      }%  
    }
    -

    (

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 2 (Customizing Standard Sort (Options 2 or 3)) -

    Suppose you want a glossary of people and you want the names listed as - ⟨first-name⟩ ⟨surname⟩ in the glossary, but you want the names sorted by +

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

    First, define two commands to set the person’s name: - - + id="dx1-20044"> key when you define the entry, but hook into the standard + sort mechanism to temporarily redefine \name while the sort value is being + set. +

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

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

    and

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

    -
    +
    \let\name\textname
    -

    Now redefine

    Now redefine \glsprestandardsort so that it temporarily sets \name to - \sortname and expands the sort value, then sets \name to \textname so that - the person’s name appears as ⟨\sortname + and expands the sort value, then sets \name to \textname so that the person’s name + appears as ⟨first-name⟩ ⟨surname⟩ in the text: - - + +

    -
    +
    \renewcommand{\glsprestandardsort}[3]{%  
     \let\name\sortname  
     \edef#1{\expandafter\expandonce\expandafter{#1}}% @@ -6203,26 +6261,26 @@ class="cmti-10">surname⟩ in the text:  
     \glsdosanitizesort  
    }
    -

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

    Now the entries can be defined: - - +

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

    Now the entries can be defined: + +

    -
    +
    \newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},  
      description={some information about Joe Bloggs}}  
    \newglossaryentry{johnsmith}{name={\name{John}{Smith}},  
      description={some information about John Smith}}
    -

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    orderword or letter. The default is word ordering. -

    Note that the

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

    -

    If you use

    +

    If you use Option 1, this setting will be used if you use sort=standard in the - optional argument of =standard in the optional + argument of \printnoidxglossary: - - + +

    -
    +
    \printnoidxglossary[sort=standard]
    -

    Alternatively, you can specify the order for individual glossaries: - - +

    Alternatively, you can specify the order for individual glossaries: + +

    -
    +
    \printnoidxglossary[sort=word]  
    \printnoidxglossary[type=acronym,sort=letter]
    -

    +

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

    You may omit this package option if you are using Option 2 as this is the - default. It’s available in case you need to override the effect of an earlier - occurrence of + extension. +

    You may omit this package option if you are using Option 2 as this is the default. It’s + available in case you need to override the effect of an earlier occurrence of xindy in the package option list. + id="dx1-20060"> in the + package option list.

    xindymakeglossariesxindy. If you don’t use makeglossaries, you need to remember to - use , you need to remember + to use xindy not makeindex.xdy extension. -

    This package option may additionally have a value that is a ⟨

    This package option may additionally have a value that is a ⟨key⟩=⟨value⟩ - comma-separated list to override the language and codepage. For example: - - +class="cmti-10">value⟩ comma-separated + list to override the language and codepage. For example: + +

    -
    +
    \usepackage[xindy={language=english,codepage=utf8}]  
      {glossaries}
    -

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

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

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

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

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

    xindygloss(Option 3) This is equivalent to xindy={} (that is, the xindy option - without any value supplied) and may be used as a document class option. - The language and code page can be set via option without any + value supplied) and may be used as a document class option. The language and code + page can be set via \GlsSetXdyLanguage and - and \GlsSetXdyCodePage (see §11.1 §11.1 + Language and Encodings.)
    xindynoglsnumbers
    (Option 3) This is equivalent to xindy={glsnumbers=false} - and may be used as a document class option. +class="cmtt-10">xindy={glsnumbers=false} and may + be used as a document class option.
    automake
    This is a boolean option (new to version 4.08) that will attempt to run - This is a boolean option (new to version 4.08) that will attempt to run makeindex or + or xindy using TEX’s \write18 mechanism at the end of the - document. Since this mechanism can be a security risk, some TEX distributions - disable it completely, in which case this option won’t have an effect. (If this - option doesn’t appear to work, search the log file for “runsystem” and see if it is - followed by “enabled” or “disabled”.) -

    Some distributions allow \write18 in a restricted mode. This mode - has a limited number of trusted applications, which usually includes - mechanism at the end of the document. Since this + mechanism can be a security risk, some TEX distributions disable it completely, in + which case this option won’t have an effect. (If this option doesn’t appear to work, + search the log file for “runsystem” and see if it is followed by “enabled” or + “disabled”.) +

    Some distributions allow \write18 in a restricted mode. This mode has a limited + number of trusted applications, which usually includes makeindex but may not include but may not include + xindy. So if you have the restricted mode - on, . So if you have the restricted mode on, automake should work with makeindex but may not work with - + but may not work with xindy. -

    However even in unrestricted mode this option may not work with

    However even in unrestricted mode this option may not work with xindy as - as xindy uses language names that don’t always correspond with uses + language names that don’t always correspond with \babel’s - language names. (The ’s language names. (The + makeglossaries script applies mappings to assist you.) - Note that you still need at least two LATEX runs to ensure the document is - up-to-date with this setting. -

    Since this package option attempts to run the script applies mappings to assist you.) Note that you still need + at least two LATEX runs to ensure the document is up-to-date with this + setting. +

    Since this package option attempts to run the indexing application on every LATEX run, its use should be considered a last resort for those who can’t work - out how to incorporate the indexing application into their document build. The - default value for this option is EX run, its use should be considered a last resort for those who can’t work out + how to incorporate the indexing application into their document build. The default + value for this option is automake=false.

    - - -

    + + +

    -

    Top

    2.5 Acronym Options

    @@ -6460,20 +6517,20 @@ class="cmssbx-10">acronymThis creates a new glossary with the label acronym. This is equivalent to: - - -
    + + +
    \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
    -

    It will also define -


    It will also define +


    \printacronyms  \printacronyms[options]

    -

    +

    that’s equivalent to

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

    If you are using

    If you are using Option 1, you need to use

    options]
    to display the list of acronyms. -

    If the

    If the acronym package option is used, \acronymtype\acronymtypeacronym otherwise it is set to main.2.42.4 Entries that are defined using \newacronym are placed in the glossary whose - label is given by are placed in the glossary whose label is + given by \acronymtype, unless another glossary is explicitly - specified. -

    Remember to use the , unless another glossary is explicitly specified. +

    Remember to use the nomain package option if you’re only interested in using this acronym glossary. (That is, you don’t intend to use the main glossary.)
    -

    +

    acronyms
    This is equivalent to acronym=true and may be used in the document class - option list. + id="dx1-21018"> and may be used in the document class option + list.
    acronymlists\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 - . 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: - - -
    + id="dx1-21021"> + 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 +

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

    You can use -


    You can use +


    \DeclareAcronymList  \DeclareAcronymList{list}

    -

    +

    instead of or in addition to the acronymlists option. This will add the - glossaries given in ⟨list⟩ to the list of glossaries that are identified as - lists of acronyms. To replace the list of acronym lists with a new list - use: -


    option. This will add the glossaries given in + ⟨list⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of + acronym lists with a new list use: +


    \SetAcronymLists  \SetAcronymLists{list}

    -

    -

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

    +

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



    \glsIfListOfAcronyms  label}{true part}{false - part}

    -

    +class="cmitt-10">false part⟩} +


    +

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


    \DefineAcronymShortcuts§13 Acronyms and + Other Abbreviations for further details. Alternatively you can use: +


    \DefineAcronymSynonyms  \DefineAcronymShortcuts

    -

    +class="cmtt-10">\DefineAcronymSynonyms


    +

    -

    +

    -

    Top

    2.5.1 Deprecated Acronym Style Options

    -

    The package options listed in this section are now deprecated but are kept for +

    The package options listed in this section are now deprecated but are kept for backward-compatibility. Use \setacronymstyle instead. See §13 Acronyms and Other Abbreviations for further details. - -

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

    or (with

    or (with smallcaps) - - + +

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

    or (with

    or (with smaller) - - + +

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

    or (with

    or (with footnote) - - + +

    -
    +
    \setacronymstyle{footnote-desc}
    -

    or (with

    or (with footnote and smallcaps) - - + +

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    or (with

    or (with footnote and smaller) - - + +

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    or (with

    or (with dua) - - + +

    -
    +
    \setacronymstyle{dua-desc}
    -

    +

    smallcaps
    This option changes the definition of \newacronym and the way that - acronyms are displayed. This option may be replaced by: - - -
    + id="dx1-22013"> and the way that acronyms are + displayed. This option may be replaced by: + + +
    \setacronymstyle{long-sc-short}
    -

    or (with

    or (with description) - - + +

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

    or (with

    or (with description and footnote) - - + +

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    +

    smaller
    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 and the way that acronyms are + displayed. +

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

    +

    This option may be replaced by: - - + +

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

    or (with

    or (with description) - - + +

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

    or (with

    or (with description and footnote) - - + +

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    +

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

    or (with

    or (with smallcaps) - - + +

    -
    +
    \setacronymstyle{footnote-sc}
    -

    or (with

    or (with smaller) - - + +

    -
    +
    \setacronymstyle{footnote-sm}
    -

    or (with

    or (with description) - - + +

    -
    +
    \setacronymstyle{footnote-desc}
    -

    or (with

    or (with smallcaps and description) - - + +

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    or (with

    or (with smaller and description) - - + +

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    +

    duaThis option changes the definition of \newacronym so that acronyms are always expanded. This option may be replaced by: - - -
    + + +
    \setacronymstyle{dua}
    -

    or (with

    or (with description) - - + +

    -
    +
    \setacronymstyle{dua-desc}
    -

    +

    -

    +

    -

    Top

    2.6 Other Options

    -

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

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

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

    It also defines -


    It also defines +


    \printsymbols  \printsymbols[options]

    -

    +

    which is a synonym for

    options]
    -

    If you use

    If you use Option 1, you need to use:

    options]
    to display the list of symbols. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in - using this package option if you’re only interested in using this + symbols glossary and don’t intend to use the main glossary. -
    -

    +class="cmtt-10">main glossary.

    +

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

    It also defines -


    It also defines +


    \printnumbers  \printnumbers[options]

    -

    +

    which is a synonym for

    options]
    -

    If you use

    If you use Option 1, you need to use:

    options]
    to display the list of numbers. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in - using this package option if you’re only interested in using this + numbers glossary and don’t intend to use the main glossary. -
    -

    +class="cmtt-10">main glossary.

    +

    index
    This option defines a new glossary type with the label index via - - -
    + + +
    \newglossary[ilg]{index}{ind}{idx}{\indexname}%
    -

    It also defines -


    It also defines +


    \newterm  options]{term}

    -

    +

    which is a synonym for

    options]
    and -



    \printindex  \printindex[options]

    -

    +

    which is a synonym for

    options]
    -

    If you use

    If you use Option 1, you need to use:

    options]
    to display this glossary. -

    Remember to use the

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

    - - -

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

    +

    + + +

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

    The example file

    The example file sample-index.tex illustrates the use of the indexcompatible-3.07Compatibility mode for old documents created using version 3.07 or below.

    -

    +

    -

    Top

    2.7 Setting Options After the Package is Loaded

    -

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


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


    \setupglossaries  \setupglossaries{key-val list}

    -

    +

    The following package options can’t be used in \setupglossaries: notreenostyles, nomain, -, compatible-2.07, , +translate, notranslate, acronym. These options have to be set while the -package is loading, except for the . These options have to be set while the package is loading, +except for the xindy sub-options which can be set using -commands like sub-options which can be set using commands like \GlsSetXdyLanguage (see +(see §11 Xindy (Option 3) for further -details). -

    If you need to use this command, use it as soon as possible after loading Xindy (Option 3) for further details). +

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

    - - -

    -

    -

    ) after you have started defining your +acronyms, you are likely to get unexpected results. If you try changing the sort +option after you have started to define entries, you may get unexpected results. +

    +

    + + +

    +

    +

    Top

    3. Setting Up

    -

    In the preamble you need to indicate whether you want to use

    In the preamble you need to indicate whether you want to use Option 1, Option 2 -or Option 2 or +Option 3. It’s not possible to mix these options within a document.

    -

    Top

    3.1 Option 1

    -

    The command -


    The command +


    \makenoidxglossaries  \makenoidxglossaries

    -

    +

    must be placed in the preamble. This sets up the internal commands required to make Option 1 work. If you omit \makenoidxglossaries none of the glossaries will +class="cmbx-10">none of the glossaries will be be displayed. -

    +class="cmbx-10">displayed. +

    -

    Top

    3.2 Options 2 and 3

    -

    The command -


    The command +


    \makeglossaries  \makeglossaries

    -

    +

    must be placed in the preamble in order to create the customised makeindex (.ist) or -) or xindy ( +(.xdy) style file (for Options 2 or 3, respectively) and to ensure that glossary -entries are written to the appropriate output files. 3, respectively) and to ensure that glossary entries are +written to the appropriate output files. If you omit \makeglossaries -none of the glossary files will be created. -

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

    Similarly, there are some commands that must not be used before \makeglossaries none of the +glossary files will be created. +

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

    Similarly, there are some commands that must not be used before \makeglossaries.

    -

    -

    You can suppress the creation of the customised

    +

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



    \noist  \noist

    -

    +

    That this command must not be used after \makeglossaries. -

    Note that if you have a custom

    Note that if you have a custom .xdy file created when using glossaries version 2.07 -or below, you will need to use the 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 package option with it.

    +

    +

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



    \setStyleFile  \setStyleFile{name}

    -

    +

    where ⟨name⟩ is the name of the style file without the extension. Note that this -command must not be used after name⟩ is the name of the style file without the extension. Note that this command must +not be used after \makeglossaries. -

    Each glossary entry is assigned a

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


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

    -

    +

    For example: - - + +

    -
    +
    \glsSetCompositor{-}
    -

    This command must not be used after

    This command must not be used after \makeglossaries. -

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


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


    \glsSetAlphaCompositor  \glsSetAlphaCompositor{symbol}

    -

    +

    This command has no effect if you use Option 2. For example, if you want number -lists containing a mixture of A-1 and 2.3 style formats, then do: - - +href="#glo:numberlist">number lists +containing a mixture of A-1 and 2.3 style formats, then do: + +

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

    See

    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. In fact, some commands such -as \longnewglossaryentry may only be used in the preamble. See

    All glossary entries must be defined before they are used, so it is better to define them in +the preamble to ensure this. In fact, some commands such as \longnewglossaryentry may +only be used in the preamble. See §4.10 -Drawbacks With Defining Entries in the Document Environment for a discussion of -the problems with defining entries within the document instead of in the -preamble. -

    §4.10 Drawbacks With Defining Entries in the Document +Environment for a discussion of the problems with defining entries within the document +instead of in the preamble. +

    Option 1 enforces the preamble-only restriction on \newglossaryentry. -
    -

    -

    Only those entries that are referenced in the document (using any of the -commands described in .

    +

    +

    Only those entries that are referenced 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 Adding an Entry to the Glossary Without +Generating Text or §8 Cross-Referencing Entries) will appear in -the glossary. See Cross-Referencing Entries) will appear in the glossary. See §10 Displaying a glossary to find out how to display the -glossary. -

    New glossary entries are defined using the command: -


    §10 +Displaying a glossary to find out how to display the glossary. +

    New glossary entries are defined using the command: +


    \newglossaryentry  label}{key=value list}

    -

    +

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


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


    \longnewglossaryentry  \longnewglossaryentry{label}{key=value -listkey=value list}{long descriptionlong +description}

    -

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

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

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

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



    \provideglossaryentry  }{key=value list}

    -

    +

    and -

    \longprovideglossaryentry  -



    \longprovideglossaryentry{label}{}{long description}

    -

    +

    (These are both preamble-only commands.) -

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

    Note that although an

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

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

    -

    The second argument, ⟨-) +to active characters.

    + + +

    +

    The second argument, ⟨key=value list⟩, is a ⟨key⟩=⟨value⟩ list that supplies the relevant @@ -7486,185 +7526,193 @@ information about this entry. There are two required fields: description and either name -or or +parent. The description is set in the third argument of \longnewglossaryentry -and \longprovideglossaryentry. With the other commands it’s set via the +class="cmtt-10">\longnewglossaryentry and \longprovideglossaryentry. With the other commands it’s set via the description key. Available fields are listed below: + id="dx1-28012"> key. As is +typical with ⟨key⟩=⟨value⟩ lists, values that contain a comma or equal sign must be enclosed in +braces. Available fields are listed below:

    name
    The name of the entry (as it will appear in the glossary). If this key is - omitted and the 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. -
    + id="dx1-28014"> key is supplied, this value will be the same as the parent’s name. +

    If the name key contains any commands, you must also use the sort key (described + below) if you intend sorting the entries alphabetically, otherwise the entries can’t be + sorted correctly.
    +

    +

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


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


    \nopostdesc  \nopostdesc

    -

    +

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



    \glspar  \glspar

    -

    +

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

    parent
    The label of the parent entry. Note that the parent entry must be defined - before its sub-entries. See
    The label of the parent entry. Note that the parent entry must be defined before its + sub-entries. See §4.7 Sub-Entries for further details.
    descriptionplural
    The plural form of the description, if required. If omitted, the value - is set to the same as the
    The plural form of the description, if required. If omitted, the value is set to + the same as the description key. + id="dx1-28023"> key.
    text
    How this entry will appear in the document text when using \gls (or one of its + id="dx1-28025"> (or one of its upper case variants). If this field is omitted, the value of the name key is + id="dx1-28026"> key is used. - - + +
    first
    How the entry will appear in the document text on first use with \gls (or - one of its upper case variants). If this field is omitted, the value of - the (or one of its + upper case variants). If this field is omitted, the value of the text key is used. Note that if you use key is used. Note that + if you use \glspl, , \Glspl, , \GLSpl, - , \glsdisp before using before using \gls, the , the firstplural value won’t be used with - value + won’t be used with \gls. + id="dx1-28036">.
    plural
    How the entry will appear in the document text when using \glspl (or one of - its upper case variants). If this field is omitted, the value is obtained by + id="dx1-28038"> (or one + of its upper case variants). If this field is omitted, the value is obtained by appending \glspluralsuffix to the value of the to the value of the text field. The default value of + id="dx1-28040"> field. The default value of \glspluralsuffix is the letter “s”. + id="dx1-28041"> is the letter “s”.
    firstplural
    How the entry will appear in the document text on first use with \glspl - (or one of its upper case variants). If this field is omitted, the value is - obtained from the (or one + of its upper case variants). If this field is omitted, the value is obtained from the plural key, if the + key, if the first key is omitted, or by appending - key is omitted, or by appending \glspluralsuffix to the value of the to the value of + the first field, if the field, if the first field is present. Note - that if you use field is present. Note that if you use \gls, , \Gls, , + \GLS, , \glsdisp before using \glspl, the , the firstplural - value won’t be used with 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 was always taken by + appending “s” to the first key, which meant that you had - to specify both key, which meant that you had to specify both plural and and + firstplural, even if you hadn’t used the , even if you hadn’t used the first - key. + id="dx1-28059"> key.

    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 @@ -7672,101 +7720,100 @@ class="cmtt-10">\relax. Note that not all glossary styles display the
    symbolplural
    This is the plural form of the symbol (as passed to \glsdisplay and + id="dx1-28062"> and \glsdisplayfirst by by \glspl, , \Glspl and and \GLSpl). If omitted, the value is set - to the same as the ). If omitted, the value is set to the + same as the symbol key. + id="dx1-28067"> key.
    sort
    This value indicates how this entry should be sorted. If omitted, the value is - given by the
    This value indicates how this entry should be sorted. If omitted, the value is given by the + name field unless one of the package options field unless one of the package options sort=def and - and sort=use have been used. In general, it’s best to use the have been + used. In general, it’s best to use the sort key if the - key if the name contains commands (e.g. \ensuremath{\alpha}). You can also - override the contains commands + (e.g. \ensuremath{\alpha}). You can also override the sort key by redefining key by redefining + \glsprestandardsort (see (see §2.4 Sorting - Options). -

    Sorting Options). +

    Option 1 by default strips the standard LATEX accents (that is, accents - generated by core LATEX accents (that is, accents generated by + core LATEX commands) from the name key when it sets the key when it sets the sort - key. So with key. So with + Option 1: - - + +

    -
    +
    \newglossaryentry{elite}{%  
      name={{\’e}lite},  
      description={select group of people}  
    }
    -

    This is equivalent to: - - +

    This is equivalent to: + +

    -
    +
    \newglossaryentry{elite}{%  
      name={{\’e}lite},  
      description={select group of people},  
      sort={elite}  
    }
    -

    Unless you use the package option

    Unless you use the package option sanitizesort=true, in which case it’s equivalent + id="dx1-28078">, in which case it’s equivalent to: - - + +

    -
    +
    \newglossaryentry{elite}{%  
      name={{\’e}lite},  
      description={select group of people},  
      sort={\’elite}  
    }
    -

    This will place the entry before the “A” letter group since the sort value starts - with a symbol. -

    Similarly if you use the

    This will place the entry before the “A” letter group since the sort value starts with a + symbol. +

    Similarly if you use the inputenc package:

    + id="dx1-28079"> package:

    \newglossaryentry{elite}{% @@ -7818,8 +7865,8 @@ class="cmtt-10">}
    Unless you use the package option sanitizesort=true, in which case it’s equivalent - to:
    + id="dx1-28080">, in which case it’s equivalent to: +
    \newglossaryentry{elite}{% @@ -7849,211 +7896,274 @@ class="cmtt-10">lite class="cmtt-10">}
    Again, this will place the entry before the “A” group. - - -

    With Options 

    With Options 2 and 3, the default value of sort will either be set to the will either be set to the name + id="dx1-28082"> key (if sanitizesort=true) or it will set it to the expansion of the ) or it will set it to the expansion of the name key (if + id="dx1-28084"> key (if sanitizesort=false). -

    Take care with ). +

    Take care with xindy ( (Option 3): if you have entries with the same sort value - they will be treated as the same entry. -

    Take care if you use value they will + be treated as the same entry. If you use xindy and aren’t using the def or use sort + methods, always use the sort key for entries where the name just consists of a control + sequence (for example name={\alpha}). +

    Take care if you use Option 1 and the name contains fragile commands. You will - either need to explicitly set the contains fragile commands. You will either + need to explicitly set the sort key or use the key or use the sanitizesort=true package - option (unless you use the package option (unless you + use the def or use sort methods).

    -

    +

    type
    This specifies the label of the glossary in which this entry belongs. If omitted, - the default glossary is assumed unless
    This specifies the label of the glossary in which this entry belongs. If omitted, the + default glossary is assumed unless \newacronym is used (see is used (see §13 Acronyms - and Other Abbreviations). +href="#sec:acronyms">Acronyms and Other + Abbreviations).
    user1, …, user6
    Six keys provided for any additional information the user may want - to specify. (For example, an associated dimension or an alternative plural or - some other grammatical construct.) Alternatively, you can add new keys using -
    Six keys provided for any additional information the user may want to + specify. (For example, an associated dimension or an alternative plural or some other + grammatical construct.) Alternatively, you can add new keys using \glsaddkey or or + \glsaddstoragekey (see (see §4.3 Additional Keys). Other keys are - also provided by the Additional Keys). Other keys are also provided by the + glossaries-prefix ( (§17 Prefixes or Determiners) and - Prefixes or Determiners) and glossaries-accsupp ( (§18 Accessibility Support) packages. +href="#sec:accsupp">Accessibility + Support) packages.
    nonumberlist
    A boolean key. If the value is missing or is true, this will suppress the - number list just for this entry. Conversely, if you have used the package option - true, this will suppress the number + list just for this entry. Conversely, if you have used the package option nonumberlist, you can activate the number list just for this entry with - , you + can activate the number list just for this entry with nonumberlist=false. (See . (See §5 Number lists.) +href="#sec:numberlists">Number + lists.)
    see
    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 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 Note that if you have suppressed the number list, the cross-referencing +class="cmbx-10">number information won’t appear in the glossary, as it forms part of +class="cmbx-10">list, the cross-referencing information won’t appear in the glossary, as it the number list. You can override this for individual glossary entries - using forms part of the number list. You can override this for individual glossary + entries using nonumberlist=false (see above). Alternatively, you can use the + id="dx1-28114"> (see above). Alternatively, you can use the seeautonumberlist package option. For further details, see package option. For further details, see §8 Cross-Referencing Entries. -

    For Options 

    This key essentially provides a convenient shortcut that performs

    + + +
    + \glssee[tag]{label}{xr-label list} +
    +
    after the entry has been defined. +

    For Options 2 and 3, \makeglossaries must be used before any occurrence of + id="dx1-28116"> must be used before any occurrence of \newglossaryentry that contains the that contains the see key.
    -

    - - + id="dx1-28118"> key. This key has no effect for entries defined + in the document environment.

    +

    +

    If you use the see key, you may want to consider using the supplementary glossaries-extra + package.

    -

    The following keys are reserved for

    The following keys are reserved for \newacronym (see (see §13 Acronyms and Other Abbreviations): long, , longplural, , short and and shortplural. Additional keys are provided by -the . Additional keys are provided by the +glossaries-prefix ( (§17 Prefixes or Determiners) and the glossaries-accsupp ( (§18 -Accessibility Support) packages. You can also define your own custom keys (see §18 Accessibility +Support) packages. You can also define your own custom keys (see §4.3 -Additional Keys). -

    Note that if the name starts with §4.3 Additional +Keys). +

    Avoid using any of the \gls-like or \glstext-like commands within the text, first, short +or long keys (or their plural equivalent) or any other key that you plan to access through +those commands. (For example, the symbol key if you intend to use \glssymbol.) Otherwise +you end up with nested links, which can cause complications and they won’t work with the +case-changing commands. You can use them within the value of keys that won’t be accessed +through those commands. For example, the description key if you don’t use \glsdesc. +Additionally, they’ll confuse the entry formatting commands, such as \glslabel. +
    +

    +

    Note that if the name starts with non-Latin character, you must group the + id="dx1-28135">, you must group the character, otherwise it will cause a problem for commands like \Gls and and \Glspl. For + id="dx1-28137">. For example: - - + +

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

    Note that the same applies if you are using the

    Note that the same applies if you are using the inputenc package:

    + id="dx1-28138"> package:

    \newglossaryentry{elite}{name={{ class}}
    (This doesn’t apply for XeLaTeX documents using the fontspec package. For further -details, see the section package. For further details, +see the section “UTF-8” in the mfirstuc user manual.) -

    Note that in both of the above examples, you will also need to supply the user manual.) +

    Note that in both of the above examples, you will also need to supply the sort key -if you are using key if you +are using Option 2 whereas xindy ( (Option 3) is usually able to sort non-Latin -characters correctly. non-Latin characters +correctly. Option 1 discards accents from standard LATEX extended Latin -characters unless you use the EX extended Latin characters unless +you use the sanitizesort=true. + id="dx1-28145">.

    -

    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 -


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

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

    +

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

    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: - - +class="cmtt-10">\glsuseri{cow} to produce “kine”. +You can, of course, define an easy to remember synonym. For example: + +

    -
    +
    \let\glsaltpl\glsuseri
    -

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

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

    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 §4.3 Additional +Keys. +

    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 key (and the +firstplural key where -necessary). -

    + id="dx1-29005"> key where necessary). +

    -

    Top

    4.2 Other Grammatical Constructs

    -

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

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

    -
    +
    \let\glsing\glsuseri  
    \let\glsd\glsuserii  
    \newcommand*{\ingkey}{user1} @@ -8193,70 +8300,70 @@ example:  
      }%  
    }
    -

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

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

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

    and use them in the text: - - +

    and use them in the text: + +

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

    -

    Alternatively, you can define your own keys using

    +

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

    +

    -

    Top

    4.3 Additional Keys

    -

    You can now also define your own custom keys using the commands described in this -section. There are two types of keys: those for use within the document and those to -store information used behind the scenes by other commands. -

    For example, if you want to add a key that indicates the associated unit for -a term, you might want to reference this unit in your document. In this case use -\glsaddkey described in

    You can now also define your own custom keys using the commands described in this section. +There are two types of keys: those for use within the document and those to store information +used behind the scenes by other commands. +

    For example, if you want to add a key that indicates the associated unit for a term, you +might want to reference this unit in your document. In this case use \glsaddkey described in +§4.4 Document Keys. If, on the other hand, you want to add -a key to indicate to a glossary style or acronym style that this entry should be -formatted differently to other entries, then you can use \glsaddstoragekey described -in Document Keys. If, on the other hand, you want to add a key to indicate to +a glossary style or acronym style that this entry should be formatted differently +to other entries, then you can use \glsaddstoragekey described in §4.5 Storage Keys. -

    In both cases, a new command ⟨no link cs⟩ will be defined that can be used to access -the value of this key (analogous to commands such as \glsentrytext). This can be -used in an expandable context (provided any fragile commands stored in the key -have been protected). The new keys must be added using \glsaddkey or -\glsaddstoragekey before glossary entries are defined. -

    -

    -

    Storage +Keys. +

    In both cases, a new command ⟨no link cs⟩ will be defined that can be used to access the +value of this key (analogous to commands such as \glsentrytext). This can be used in an +expandable context (provided any fragile commands stored in the key have been protected). +The new keys must be added using \glsaddkey or \glsaddstoragekey before glossary +entries are defined. +

    +

    +

    Top

    4.4 Document Keys

    -

    A custom key that can be used in the document is defined using: -


    A custom key that can be used in the document is defined using: +


    \glsaddkey  default value}{no link cs}{no link +class="cmitt-10">no link ucfirst ucfirst cscs}{link cs}{link ucfirst cs}{link allcaps cs}

    -

    +

    where:

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

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

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

    Example 3 (Defining Custom Keys) -

    Suppose I want to define two new keys,

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

    -
    +
     % Define "ed" key:  
     \glsaddkey*  
      {ed}% key @@ -8370,11 +8474,11 @@ both cases, so I need to use the starred form:  
      {\Glsing}% command analogous to \Glstext  
      {\GLSing}% command analogous to \GLStext
    -

    Now I can define some entries: - - +

    Now I can define some entries: + +

    -
    +
     % No need to override defaults for this entry:  
     \newglossaryentry{jump}{name={jump},description={}}  
     % Need to override defaults on these entries: @@ -8387,31 +8491,30 @@ both cases, so I need to use the starred form:  
       ing={waddling},%  
       description={}}
    -

    -

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

    +

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

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

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.5 Storage Keys

    -

    A custom key that can be used for simply storing information is defined -using: -


    A custom key that can be used for simply storing information is defined using: +


    \glsaddstoragekey  }{no link cs}

    -

    +

    where the arguments are as the first three arguments of \glsaddkey, described above -in \glsaddkey, described above in §4.4 §4.4 +Document Keys. -

    This is essentially the same as \glsaddkey except that it doesn’t define the -additional commands. You can access or update the value of your new field -using the commands described in

    This is essentially the same as \glsaddkey except that it doesn’t define the additional +commands. You can access or update the value of your new field using the commands +described in §16.3 Fetching and Updating the Value of a -Field. +href="#sec:fetchset">Fetching and Updating the Value of a Field. -

    Example 4 (Defining Custom Storage Key (Acronyms and Initialisms)) -

    Suppose I want to define acronyms and other forms of abbreviations, such as -initialisms, but I want them all in the same glossary and I want the acronyms on first -use to be displayed with the short form followed by the long form in parentheses, but -the opposite way round for other forms of abbreviations. -

    Here I can define a new key that determines whether the term is actually an -acronym rather than some other form of abbreviation. I’m going to call this key -

    Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I +want them all in the same glossary and I want the acronyms on first use to be displayed with the +short form followed by the long form in parentheses, but the opposite way round for other forms of +abbreviations.4.1 +

    Here I can define a new key that determines whether the term is actually an acronym +rather than some other form of abbreviation. I’m going to call this key abbrtype (since type already exists): - - +class="cmtt-10">type +already exists): + +

    -
    +
    \glsaddstoragekey  
     {abbrtype}% key/field name  
     {word}% default value if not explicitly set  
     {\abbrtype}% custom command to access the value if required
    -

    -

    Now I can define a style that looks up the value of this new key to determine how -to display the full form: - - +

    +

    Now I can define a style that looks up the value of this new key to determine how to +display the full form: + +

    -
    +
    \newacronymstyle  
     {mystyle}% style name  
     {% Use the generic display @@ -8517,8 +8621,8 @@ to display the full form:  
        }%  
      }%  
      % plural and first letter upper case - - + +  
      \renewcommand*{\Genplacrfullformat}[2]{%  
        \ifglsfieldeq{##1}{abbrtype}{word}  
        {% is a proper acronym @@ -8542,31 +8646,31 @@ to display the full form:  
      \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%  
     }
    -

    Remember that the new style needs to be set before defining any terms: - - +

    Remember that the new style needs to be set before defining any terms: + +

    -
    +
    \setacronymstyle{mystyle}
    -

    -

    Since it’s a bit confusing to use

    +

    Since it’s a bit confusing to use \newacronym for something that’s not technically -an acronym, let’s define a new command for initialisms: - - + id="dx1-33005"> for something that’s not technically an +acronym, let’s define a new command for initialisms: + +

    -
    +
    \newcommand*{\newinitialism}[4][]{%  
      \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%  
    }
    -

    Now the entries can all be defined: - - +

    Now the entries can all be defined: + +

    -
    +
    \newacronym{radar}{radar}{radio detecting and ranging}  
    \newacronym{laser}{laser}{light amplification by stimulated  
    emission of radiation} @@ -8575,153 +8679,151 @@ an acronym, let’s define a new command for initialisms:  
    \newinitialism{dsp}{DSP}{digital signal processing}  
    \newinitialism{atm}{ATM}{automated teller machine}
    -

    On

    On first use, \gls{radar} will produce “radar (radio detecting and ranging)” but -\gls{dsp} will produce “DSP (digital signal processing)”. -

    For a complete document, see the sample file \gls{radar} will produce “radar (radio detecting and ranging)” but \gls{dsp} +will produce “DSP (digital signal processing)”. +

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

    +class="cmtt-10">sample-storage-abbr.tex.

    -

    -

    ____________________________

    -

    In the above example, if \newglossaryentry is explicitly used (instead of -through

    +

    ____________________________

    +

    In the above example, if \newglossaryentry is explicitly used (instead of through +\newacronym) the abbrtype key will be set to its default value of -“word” but the \ifglshaslong test in the custom acronym style will be false -(since the abbrtype key will be set to its default value of “word” but the +\ifglshaslong test in the custom acronym style will be false (since the long key hasn’t been set) so the display style will switch to that -given by \glsgenentryfmt and they’ll be no test performed on the abbrtype -field. + id="dx1-33006"> key hasn’t been +set) so the display style will switch to that given by \glsgenentryfmt and they’ll be no test +performed on the abbrtype field. -

    +

    Example 5 (Defining Custom Storage Key (Acronyms and Non-Acronyms with Descriptions)) -

    The previous example can be modified if the +

    The previous example can be modified if the description also needs to be provided. -Here I’ve changed “word” to “acronym”: - - + id="dx1-33009"> also needs to be provided. Here +I’ve changed “word” to “acronym”: + +

    -
    +
    \glsaddstoragekey  
     {abbrtype}% key/field name  
     {acronym}% default value if not explicitly set  
     {\abbrtype}% custom command to access the value if required
    -

    This may seem a little odd for non-abbreviated entries defined using

    This may seem a little odd for non-abbreviated entries defined using \newglossaryentry directly, but \ifglshaslong can be used to determine whether or not to reference the -value of this new can be used to determine whether or not to reference the value +of this new abbrtype field. -

    The new acronym style has a minor modification that forces the user to specify a +

    The new acronym style has a minor modification that forces the user to specify a description. In the previous example, the line: - - + +

    -
    +
       \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}%
    -

    needs to be changed to: - - +

    needs to be changed to: + +

    -
    +
       \renewcommand*{\GenericAcronymFields}{}%
    -

    Additionally, to accommodate the change in the default value of the

    Additionally, to accommodate the change in the default value of the abbrtype key, all instances of - - + +

    -
    +
        \ifglsfieldeq{##1}{abbrtype}{word}
    -

    need to be changed to: - - +

    need to be changed to: + +

    -
    +
        \ifglsfieldeq{##1}{abbrtype}{acronym}
    -

    -

    Once this new style has been set, the new acronyms can be defined using the -optional argument to set the description: - - +

    +

    Once this new style has been set, the new acronyms can be defined using the optional +argument to set the description: + +

    -
    +
    \newacronym[description={system for detecting the position and  
    speed of aircraft, ships, etc}]{radar}{radar}{radio detecting  
    and ranging}
    -

    -

    No change is required for the definition of

    +

    No change is required for the definition of \newinitialism but again the optional argument is required to set the description: - - + +

    -
    +
    \newinitialism[description={mathematical manipulation of an  
    information signal}]{dsp}{DSP}{digital signal processing}
    -

    -

    We can also accommodate contractions in a similar manner to the initialisms: - - +

    +

    We can also accommodate contractions in a similar manner to the initialisms: + +

    -
    +
    \newcommand*{\newcontraction}[4][]{%  
      \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%  
    }
    -

    The contractions can similarly been defined using this new command: - - +

    The contractions can similarly been defined using this new command: + +

    -
    +
    \newcontraction[description={front part of a ship below the  
    deck}]{focsle}{fo’c’s’le}{forecastle}
    -

    -

    Since the custom acronym style just checks if

    +

    Since the custom acronym style just checks if abbrtype is acronym, the -contractions will be treated the same as the initialisms, but the style could be -modified by a further test of the acronym, the contractions will +be treated the same as the initialisms, but the style could be modified by a further test of the +abbrtype value if required. -

    To test regular non-abbreviated entries, I’ve also defined a simple word: - - +

    To test regular non-abbreviated entries, I’ve also defined a simple word: + +

    -
    +
    \newglossaryentry{apple}{name={apple},description={a fruit}}
    -

    -

    Now for a new glossary style that provides information about the abbreviation (in +

    +

    Now for a new glossary style that provides information about the abbreviation (in addition to the description): - - + +

    -
    +
    \newglossarystyle  
     {mystyle}% style name  
     {% base it on the "list" style @@ -8734,57 +8836,56 @@ addition to the description):  
           \glossentrydesc{##1}\glspostdescription\space ##2}%  
     }
    -

    This uses

    This uses \ifglshaslong to determine whether or not the term is an abbreviation. If -it has an abbreviation, the full form is supplied in parentheses and \abbrtype (defined -by to determine whether or not the term is an abbreviation. If it has +an abbreviation, the full form is supplied in parentheses and \abbrtype (defined by +\glsaddstoragekey earlier) is used to indicate the type of abbreviation. -

    With this style set, the apple entry is simply displayed in the glossary -as +

    With this style set, the apple entry is simply displayed in the glossary as

    apple
    a fruit.
    -

    but the abbreviations are displayed in the form +

    but the abbreviations are displayed in the form

    laser
    (acronym: light amplification by stimulated emission of radiation) device - that creates a narrow beam of intense light.
    -

    (for acronyms) or +class="description">(acronym: light amplification by stimulated emission of radiation) device that + creates a narrow beam of intense light. +

    (for acronyms) or

    DSP
    (initialism: digital signal processing) mathematical manipulation of an +class="description">(initialism: digital signal processing) mathematical manipulation of an information signal.
    -

    (for initalisms) or +

    (for initalisms) or

    fo’c’s’le
    (contraction: forecastle) front part of a ship below the deck.
    -

    (for contractions). -

    For a complete document, see the sample file

    (for contractions). +

    For a complete document, see the sample file sample-storage-abbr-desc.tex.

    -

    -

    ____________________________

    - - -

    +

    +

    ____________________________

    + + +

    -

    Top

    4.6 Expansion

    -

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

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

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


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


    \glssetexpandfield  \glssetexpandfield{field}

    -

    +

    or -



    \glssetnoexpandfield  \glssetnoexpandfield{field}

    -

    +

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

    - - -


    - - + +
    Table 4.1: Key to Field Mappings
    @@ -8925,48 +9026,46 @@ class="cmss-10">shortplural shortpl
    - - + +

    -

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

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



    \glsexpandfields  \glsexpandfields

    -

    +

    and -



    \glsnoexpandfields  \glsnoexpandfields

    -

    -

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

    +

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

    -

    Top

    4.7 Sub-Entries

    -

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

    As from version 1.17, it is possible to specify sub-entries. These may be used to order the +glossary into categories, in which case the sub-entry will have a different name to its parent +entry, or it may be used to distinguish different definitions for the same word, in which +case the sub-entries will have the same name as the parent entry. Note that not all +glossary styles support hierarchical entries and may display all the entries in a +flat format. Of the styles that support sub-entries, some display the sub-entry’s +name whilst others don’t. Therefore you need to ensure that you use a suitable +style. (See §15 -Glossary Styles for a list of predefined styles.) As from version 3.0, level 1 -sub-entries are automatically numbered in the predefined styles if you use the +class="cmsy-10">§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 makeindex has a restriction -on the maximum sub-entry depth. -

    + id="dx1-35003"> has a restriction on the maximum +sub-entry depth. +

    -

    Top

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

    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. + id="dx1-36001"> +key. -

    Example 6 (Hierarchical Categories—Greek and Roman - - +class="cmbx-12"> (Hierarchical Categories—Greek and Roman Mathematical Mathematical Symbols)Symbols) -

    Suppose I want a glossary of mathematical symbols that are divided into Greek -letters and Roman letters. Then I can define the categories as follows: - - +

    Suppose I want a glossary of mathematical symbols that are divided into Greek letters + + +and Roman letters. Then I can define the categories as follows: + +

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

    -

    Note that in this example, the category entries don’t need a description so I have -set the descriptions to

    +

    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: - - + id="dx1-36004">. 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}, @@ -9033,41 +9132,41 @@ description terminator.  
    description={Euler’s constant},  
    parent=romanletter}
    -

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.7.2 Homographs

    -

    Sub-entries that have the same name as the parent entry, don’t need to have the

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

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

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

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

    -
    +
    \newglossaryentry{glossarylist}{  
    description={list of technical words},  
    sort={1}, @@ -9077,39 +9176,38 @@ class="cmtt-10">\nopostdescsort={2},  
    parent={glossary}}
    -

    Note that if I reference the parent entry, the location will be added to the parent’s -number list, whereas if I reference 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

    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 key is +required unless you are using the sort=use or sort=def package -options (see package options (see §2.4 §2.4 +Sorting Options). You can use the subentrycounter package option to -automatically number the first-level child entries. See 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 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: - - + id="dx1-37008"> 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 @@ -9123,14 +9221,14 @@ example:  
    plural={bravoes},  
    parent=bravo}
    -

    -

    +

    +

    -

    Top

    4.8 Loading Entries From a File

    -

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


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


    \loadglsentries  type]{filename}

    -

    +

    where ⟨filename⟩ is the name of the file containing all the \newglossaryentry\newglossaryentry\longnewglossaryentry commands. The optional argument ⟨type⟩ is the name of the -glossary to which those entries should belong, for those entries where the type⟩ is the name of the glossary +to which those entries should belong, for those entries where the type key has -been omitted (or, more specifically, for those entries whose type has been -specified by key has been omitted +(or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what , +which is what \newglossaryentry uses by -default). -

    This is a preamble-only command. You may also use uses by default). +

    This is a preamble-only command. You may also use \input to load the file but -don’t use to load the file but don’t use +\include. -

    If you want to use

    If you want to use \AtBeginDocument to \input all your entries automatically at -the start of the document, add the \input all your entries automatically at the +start of the document, add the \AtBeginDocument command before you load the -before you load the glossaries package (and +package (and babel, if you are also loading that) to avoid the creation of the -.glsdefs file and any associated problems that are caused by defining commands in -the , if you are also loading that) to avoid the creation of the .glsdefs file and +any associated problems that are caused by defining commands in the document environment. (See +environment. (See §4.10 Drawbacks With Defining Entries in the -Document Environment.)
    -

    +href="#sec:docdefs">Drawbacks With Defining Entries in the Document Environment.) +

    +

    - - -

    Example 7 (Loading Entries from Another File) -

    Suppose I have a file called

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

    -
    +
    \newglossaryentry{perl}{type=main,  
    name={Perl},  
    description={A scripting language}} @@ -9210,51 +9307,51 @@ class="cmtt-10">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

    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 perl will be added to the main glossary, since it explicitly sets the +type to main.

    -

    -

    ____________________________

    -

    +

    ____________________________

    +

    Note: if you use \newacronym (see §13 Acronyms and Other Abbreviations) the -type is set as type=\acronymtype unless you explicitly override it. For example, if my -file Acronyms and Other Abbreviations) the type is +set as 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

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

    -
    +
    \loadglsentries[altacronym]{myacronyms}
    -

    will add

    will add aca to the glossary type acronym, if the package option acronymaltacronym, if the package option acronym is not specified.4.1 -

    If you have used the 4.2 +

    If you have used the acronym package option, there are two possible solutions to -this problem: + id="dx1-38023"> package option, there are two possible solutions to this +problem:

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

      and do: - - +

      and do: + +

      -
      +
      \loadglsentries[altacronym]{myacronyms}
      -

      +

    2. Temporarily change \acronymtype to the target glossary: - - -
      + + +
      \let\orgacronymtype\acronymtype  
      \renewcommand{\acronymtype}{altacronym}  
      \loadglsentries{myacronyms}  
      \let\acronymtype\orgacronymtype
      -

    -

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

    Remember that you can use

    +

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

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

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

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

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

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

    Now the

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

    +

    -

    Top

    4.9 Moving Entries to Another Glossary

    -

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


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


    \glsmoveentry  label}{target glossary label}

    -

    +

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

    Note that no check is performed to determine the existence of the target glossary. -If you want to move an entry to a glossary that’s skipped by 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. If +you want to move an entry to a glossary that’s skipped by \printglossaries, then -define an ignored glossary with , +then define an ignored glossary with \newignoredglossary. (See §12 Defining New Glossaries.) -

    Unpredictable results may occur if you move an entry to a different glossary from -its parent or children.
    -

    -

    +

    Unpredictable results may occur if you move an entry to a different glossary from its +parent or children.
    +

    +

    -

    Top

    4.10 Drawbacks With Defining Entries in the Document Environment

    -

    Originally,

    Originally, \newglossaryentry (and \newacronym) could only be used in the -preamble. I reluctantly removed this restriction in version 1.13, but there are issues -with defining commands in the ) could only be used in the preamble. I +reluctantly removed this restriction in version 1.13, but there are issues with defining +commands in the document environment instead of the preamble, which -is why the restriction is maintained for newer commands. This restriction is also -reimposed for environment instead of the preamble, which is why the +restriction is maintained for newer commands. This restriction is also reimposed for +\newglossaryentry by the new Option 1. - - -

    +href="#option1">Option 1. (The glossaries-extra automatically reimposes this +restriction for Options 2 and 3 but provides a package option to allow document +definitions.) + + +

    -

    Top

    4.10.1 Technical Issues

    -

    +

    1. If you define an entry mid-way through your document, but subsequently - shuffle sections around, you could end up using an entry before it has been - defined. + class="enumerate" id="x1-41002x1">If you define an entry mid-way through your document, but subsequently shuffle + sections around, you could end up using an entry before it has been defined.
    2. Entry information is required when displaying the glossary. If this occurs - at the start of the document, but the entries aren’t defined until later, then - the entry details are being looked up before the entry has been defined. + class="enumerate" id="x1-41004x2">Entry information is required when displaying the glossary. If this occurs at the + start of the document, but the entries aren’t defined until later, then the entry + details are being looked up before the entry has been defined.
    3. If you use a package, such as babel, that makes certain characters active - at the start of the , that makes certain characters active at the start + of the document environment, there will be a problem if those - characters have a special significance when defining glossary entries. These - characters include the double-quote environment, there will be a problem if those characters have + a special significance when defining glossary entries. These characters include the + double-quote " character, the exclamation mark ! - character, the question mark ! character, the question mark + ? character, and the pipe | character. They - must not be active when defining a glossary entry where they occur in the - | character. They must not be active when defining + a glossary entry where they occur in the sort key (and they should be avoided in the label if they may be active at - any point in the document). Additionally, the comma , character and the - equals = character should not be active when using commands that have - ⟨ key (and they should be avoided in + the label if they may be active at any point in the document). Additionally, the + comma , character and the equals = character should not be active when using + commands that have ⟨key⟩=⟨value⟩ arguments.
    -

    To overcome the first two problems, as from version 4.0 the glossaries package modifies -the definition of

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

    There are drawbacks to this mechanism: if you modify an entry definition, you -need a second run to see the effect of your modification; this method requires an extra -\newwrite, which may exceed TEX’s maximum allocation; unexpected expansion -issues could occur; if you have very long entries, you could find unexpected line -breaks have been written to the temporary file causing spurious spaces (or, -even worse, a command name could get split across a line causing an error -message). -

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

    - - -

    -

    environment if it doesn’t already exist. This means that the entry can now +be looked up in the glossary, even if the glossary occurs at the beginning of the +document. +

    There are drawbacks to this mechanism: if you modify an entry definition, you need a +second run to see the effect of your modification; this method requires an extra \newwrite, +which may exceed TEX’s maximum allocation; unexpected expansion issues could occur; the +see key isn’t stored, which means it can’t be added to the .glsdefs file when it’s +created at the end of the document (and therefore won’t be present on subsequent +runs). +

    +

    +

    Top

    4.10.2 Good Practice Issues

    -

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

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

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

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

    -

    -

    +

    Top

    5. Number lists

    -

    Each entry in the glossary has an associated

    Each entry in the glossary has an associated number list. By default, these -numbers refer to the pages on which that entry has been used (using any of the -commands described in . By default, these numbers refer +to the pages on which that entry has been used (using any of the commands described in §6 §6 +Links to Glossary Entries and §7 Adding an Entry to the -Glossary Without Generating Text). The number list can be suppressed using the -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 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 package option. The number list is also +referred to as the location list. -

    Due to the asynchronous nature of TEX’s output routine (see, for example, -Finding if you’re on an odd or an even page) the page counter (represented internally -as \c@page) can be unreliable. This can cause problems when glossary entries are -referenced in a paragraph that spans a page break. To compensate, the glossaries -package has to make some adjustments to ensure the location number is correct for -this situation. By default, the adjustments only affect the counter styles: roman, +

    Each location in the number list is encapsulated with a command. (The encap value.) By +default this is the \glsnumberformat command, but may be overridden using the format key +in the optional argument to commands like \gls. (See §6 Links to Glossary Entries.) For +example, you may want the location to appear in bold to indicate the principle use of a term +or symbol. Complications can arise if you use different encap values for the same location. +For example, suppose on page 10 you have both the default \glsnumberformat +and \textbf encaps. While it may seem apparent that \textbf should override \glsnumberformat in this situation, neither makeindex nor xindy know this. In +the case of xindy, it only accepts one encap and discards the other for identical +locations. The encap it chooses to keep may not necessarily be the one you want. In the +case of makeindex, it accepts different encaps for the same location, but warns +about it. This leads to a number list with the same location repeated in different +fonts. +

    This is something you need to be careful about, but if you use the +makeglossaries Perl script it will detect makeindex’s warning and attempt to fix the +problem.5.1 +Since xindy doesn’t generate a warning, makeglossaries won’t do anything about it if you +are using xindy. With makeindex, makeglossaries will let the encaps override each other, +similar to xindy, except that the \glsnumberformat encap will always have the least +precedence. Other conflicting encaps will have the last one override earlier ones for the same +location. +

    Due to the asynchronous nature of TEX’s output routine (see, for example, Finding if +you’re on an odd or an even page) the page counter (represented internally as \c@page) can +be unreliable. This can cause problems when glossary entries are referenced in a paragraph +that spans a page break. To compensate, the glossaries package has to make some adjustments +to ensure the location number is correct for this situation. By default, the adjustments only +affect the counter styles: roman, Roman, alph, Alph and arabic. If you have a different numbering system -where arabic. If you have a different +numbering system where \cs name{page} expands to \internal cs name\c@page you need to use: -



    \glsaddprotectedpagefmt  \glsaddprotectedpagefmt{internal cs name}

    -

    -

    For example, suppose you have a style samplenum that is implemented as -follows: - - +

    +

    For example, suppose you have a style samplenum that is implemented as follows: + +

    -
    +
     \newcommand*{\samplenum}[1]{%  
       \expandafter\@samplenum\csname c@#1\endcsname}  
     \newcommand*{\@samplenum}[1]{\two@digits{#1}}
    -

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure -the location is correct for entries in page-spanning paragraphs, you need to -do: - - +

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure the +location is correct for entries in page-spanning paragraphs, you need to do: + +

    -
    +
    \glsaddprotectedpagefmt{@samplenum}
    -

    (If you are using a different counter for the location, such as

    (If you are using a different counter for the location, such as section or equation, -you don’t need to worry about this.) -

    If the inner macro (as given by equation, you don’t +need to worry about this.) +

    If the inner macro (as given by \internal cs name⟩) contains non-expandable commands then you may need to redefine page after using \glsaddprotectedpagefmt{internal cs name}. This command doesn’t take any -arguments as the location is assumed to be given by \c@page. For example, suppose -now my page counter format uses small caps Roman numerals: - - +class="cmtt-10">}. This command doesn’t take any arguments as +the location is assumed to be given by \c@page. For example, suppose now my page counter +format uses small caps Roman numerals: + +

    -
    +
     \newcommand*{\samplenum}[1]{%  
      \expandafter\@samplenum\csname c@#1\endcsname}  
     \newcommand*{\@samplenum}[1]{\textsc{\romannumeral#1}}
    -

    Again, the inner macro needs to be identified using: - - +

    Again, the inner macro needs to be identified using: + +

    -
    +
    \glsaddprotectedpagefmt{@samplenum}
    -

    However, since

    However, since \textsc isn’t fully expandable, the location is written to the file as \textsc  {i} (for page 1), \textsc  {ii} (for page 2), etc. This format may cause -a problem for the  {ii} (for page 2), etc. This format may cause a +problem for the indexing application (particularly for makeindex). To compensate -for this, the ). To compensate for this, +the \glsinternal cs namepage command may be redefined so that -it expands to a format that’s acceptable to the indexing application. For -example: - - +class="cmtt-10">page command may be redefined so that it expands to a format +that’s acceptable to the indexing application. For example: + +

    -
    +
    \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page}
    -

    While this modification means that the location list in the glossary won’t -exactly match the format of the page numbers (displaying lower case Roman -numbers instead of small cap Roman numerals) this method will at least work -correctly for both

    While this modification means that the location list in the glossary won’t exactly match the +format of the page numbers (displaying lower case Roman numbers instead of small cap +Roman numerals) this method will at least work correctly for both makeindex and and xindy. If you are using . If +you are using xindy, the following -definition: - - + id="dx1-43028">, the following definition: + +

    -
    +
     \renewcommand*{\gls@samplenumpage}{%  
       \glsbackslash\string\textsc{\romannumeral\c@page}}
    -

    combined with - - +

    combined with + +

    -
    +
    \GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace"  
     "roman-numbers-lowercase" :sep "\glsclosebrace"}
    -

    will now have lowercase Roman numerals in the location list. (This option may cause +

    will now have lowercase Roman numerals in the location list. (This option may cause problems if your locations should be hyperlinks.) -

    Another possibility that will work with both

    Another possibility that will work with both makeindex and and xindy is to redefine + id="dx1-43030"> is to redefine \glsinternal cs namepage (\gls@samplenumpage in this example) to just expand to the decimal page number and redefine \glsnumberformat to change the displayed + id="dx1-43031"> to change the displayed format: - - + +

    -
    +
      \renewcommand*{\gls@samplenumpage}{\number\c@page}  
      \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}}
    -

    -

    If you redefine

    +

    If you redefine \glsinternal cs namepage, you must make sure that \c@page is -expanded when it’s written to the file. (So don’t, for example, hide \c@page inside a -robust command.)
    -

    -

    Both \c@page is expanded +when it’s written to the file. (So don’t, for example, hide \c@page inside a robust command.) +

    +

    +

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

    Note that n⟩ is either an integer or the keyword +none which indicates that there should be no range formation. +

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

    -

    With both is used.

    +

    +

    With both makeindex and and xindy (Options  (Options 2 and 3), you can replace the -separator and the closing number in the range using: -


    3), 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: - - +

    +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 (Option 3), you will also need to set the minimum range -length to 1 if you want to change these suffixes: - - + id="dx1-43042"> (Option 3), 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

    Note that if you use the hyperref package, you will need to use package, you will need to use \nohyperpage in the -suffix to ensure that the hyperlinks work correctly. For example: - - + id="dx1-43044"> in the suffix to +ensure that the hyperlinks work correctly. For example: + +

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

    -

    Note that

    +

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

    -

    Option 1 doesn’t form ranges. However, with this option you can iterate over an -entry’s is used.

    +

    +

    Option 1 doesn’t form ranges. However, with this option you can iterate over an entry’s +number list using: -


    using: +


    \glsnumberlistloop  \glsnumberlistloop{label}{handler cs}{xr handler -cs}

    -

    +class="cmitt-10">xr handler cs⟩} +


    +

    where ⟨label⟩ is the entry’s label and ⟨handler cs⟩ is a handler control sequence of the form: -



    handler cs{prefixformat}{location}

    -

    +

    where ⟨prefix⟩ is the hyperref prefix, ⟨counter⟩ is the name of the counter used for the -location, ⟨ prefix, ⟨counter⟩ is the name of the counter used for the location, +⟨format⟩ is the format used to display the location (e.g. textbf) and ⟨location⟩ -is the location. The third argument is the control sequence to use for any -cross-references in the list. This handler should have the syntax: -


    location⟩ is the location. +The third argument is the control sequence to use for any cross-references in the list. This +handler should have the syntax: +


    xr handler cs[tag]{xr list}

    -

    +

    where ⟨tag⟩ is the cross-referenced text (e.g. “see”) and ⟨xr list⟩ is a comma-separated -list of labels. (This actually has a third argument but it’s always empty when used -with xr list⟩ is a comma-separated list of +labels. (This actually has a third argument but it’s always empty when used with +Option 1.) -

    For example, if on page 12 I have used - - +

    For example, if on page 12 I have used + +

    -
    +
    \gls[format=textbf]{apple}
    -

    and on page 18 I have used - - +

    and on page 18 I have used + +

    -
    +
    \gls[format=emph]{apple}
    -

    then - - +

    then + +

    -
    +
    \glsnumberlistloop{apple}{\myhandler}
    -

    will be equivalent to: - - +

    will be equivalent to: + +

    -
    +
    \myhandler{}{page}{textbf}{12}%  
    \myhandler{}{page}{emph}{18}%
    -

    There is a predefined handler that’s used to display the

    There is a predefined handler that’s used to display the number list in the -glossary: -


    in the glossary: +


    \glsnoidxdisplayloc  \glsnoidxdisplayloc{prefix}{}{location}

    -

    +

    The predefined handler used for the cross-references in the glossary is: -



    \glsseeformat[tag]{xr list}{location}

    -

    +

    which is described in §8.1 Customising Cross-reference Text. -

    \glsnumberlistloop is not available for Options 2 and 3.
    -

    - - +

    + +

    -

    -

    +

    Top

    6. Links to Glossary Entries

    -

    Once you have defined a glossary entry using

    Once you have defined a glossary entry using \newglossaryentry or - or \newacronym (see (see +§13 Acronyms and Other Abbreviations), you can refer to -that entry in the document using one of the commands listed in Acronyms and Other Abbreviations), you can refer to that entry in the document using +one of the commands listed in §6.1 The -\gls-Like Commands (First Use Flag Queried) or The \gls-Like Commands (First Use Flag Queried) or +§6.2 The \glstext-Like -Commands (First Use Flag Not Queried). 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). These commands also add a line to -an external file that is used to generate the relevant entry in the glossary. -This information includes an associated location that is added to the number -list for that entry. By default, the location refers to the page number. For -further information on number lists, see \glstext-Like Commands (First Use Flag Not Queried). 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). These commands also add a line to an external file that is +used to generate the relevant entry in the glossary. This information includes an associated +location that is added to the number list for that entry. By default, the location refers to the +page number. For further information on number lists, see §5 Number lists. These external files -need to be post-processed by Number lists. These +external files need to be post-processed by makeindex or xindy unless you have chosen - unless you have +chosen Option 1. If you don’t use \makeglossaries these external files won’t be created. -

    I strongly recommend that you don’t use the commands defined in this chapter in -the arguments of sectioning or caption commands or any other command that has a -moving argument. -

    Aside from problems with expansion issues, PDF bookmarks and possible nested +

    Note that repeated use of these commands for the same entry can cause the number list to +become quite long, which may not be particular helpful to the reader. In this case, +you can use the non-indexing commands described in §9 Using Glossary Terms +Without Links or you can use the supplemental glossaries-extra package, which +provides a means to suppress the automated indexing of the commands listed in this +chapter. +

    I strongly recommend that you don’t use the commands defined in this chapter in the +arguments of sectioning or caption commands or any other command that has a moving +argument. +

    Aside from problems with expansion issues, PDF bookmarks and possible nested hyperlinks in the table of contents (or list of whatever) any use of the commands described in \gls-Like Commands (First Use Flag Queried)

    -

    The above warning is particularly important if you are using the glossaries -package in conjunction with the

    +

    The above warning is particularly important if you are using the glossaries package in +conjunction with the hyperref package. Instead, use one of the -expandable commands listed in package. Instead, use one of the expandable commands listed in +§9 Using Glossary Terms Without Links (such -as Using Glossary Terms Without Links (such as \glsentrytext but not the non-expandable case changing versions like - but not the non-expandable +case changing versions like \Glsentrytext). Alternatively, provide an alternative via the optional argument to -the sectioning/caption command or use ). Alternatively, provide an alternative via the +optional argument to the sectioning/caption command or use hyperref’s ’s \texorpdfstring. Examples: - - + id="dx1-44013">. +Examples: + +

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

    -

    If you want the

    If you want to retain the formatting that’s available through commands like \acrshort (for +example, if you are using one of the small caps styles), then you might want to consider the +glossaries-extra package which provides commands for this purpose. +

    If you want the link text to produce a hyperlink to the corresponding entry details -in the glossary, you should load the to produce a hyperlink to the corresponding entry details in the +glossary, you should load the hyperref package package before the glossaries package. -That’s what I’ve done in this document, so if you see a hyperlinked term, such as link -text, you can click on the word or phrase and it will take you to a brief description in -this document’s glossary. -

    If you use the glossaries package. That’s what I’ve +done in this document, so if you see a hyperlinked term, such as link text, you can click on +the word or phrase and it will take you to a brief description in this document’s +glossary. +

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

    These are limitations of the DVI format not of the

    These are limitations of the DVI format not of the glossaries package. -

    -

    -

    It may be that you only want terms in certain glossaries to have hyperlinks, but -not for other glossaries. In this case, you can use the package option package.

    +

    +

    It may be that you only want terms in certain glossaries to have hyperlinks, but not for +other glossaries. In this case, you can use the package option nohypertypes to -identify the glossary lists that shouldn’t have hyperlinked to identify the +glossary lists that shouldn’t have hyperlinked link text. See . See §2.1 General -Options for further details. -

    The way the General Options for further +details. +

    The way the link text is displayed depends on -


    is displayed depends on +


    \glstextformat  \glstextformat{text}

    -

    +

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

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

    Further customisation can be done via

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

    Each entry has an associated conditional referred to as the first use flag. Some of -the commands described in this chapter automatically unset this flag and can also use -it to determine what text should be displayed. These types of commands are the +href="#sec:glsdisplay">Changing the format of the link text for further details. +

    Each entry has an associated conditional referred to as the first use flag. Some of the +commands described in this chapter automatically unset this flag and can also use it +to determine what text should be displayed. These types of commands are the \gls-like commands and are described in \glstext-like commands and are described in §6.2 The \glstext-Like Commands -(First Use Flag Not Queried). See \glstext-Like Commands (First Use +Flag Not Queried). See §14 Unsetting and Resetting Entry Flags -for commands that unset or reset the first use flag without referencing the -entries. -

    The Unsetting and Resetting Entry Flags for commands that unset +(mark the entry as having been used) or reset (mark the entry as not used) the first use +flag without referencing the entries. +

    The \gls-like and \glstext-like commands all take a first optional argument -that is a comma-separated list of ⟨\glstext-like commands all take a first optional argument that is a +comma-separated list of ⟨key⟩=⟨value⟩ options, described below. They also have -a star-variant, which inserts hyper=false at the start of the list of options and a -plus-variant, which inserts hyper=true at the start of the list of options. For example -\gls*{sample} is the same as value⟩ options, described below. They also have a star-variant, +which inserts hyper=false at the start of the list of options and a plus-variant, which +inserts hyper=true at the start of the list of options. For example \gls*{sample} +is the same as \gls[hyper=false]{sample} and \gls+{sample} is -the same as \gls+{sample} is the same as +\gls[hyper=true]{sample}, whereas just \gls{sample} will use the -default hyperlink setting which depends on a number of factors (such as -whether the entry is in a glossary that has been identified in the \gls{sample} will use the default hyperlink +setting which depends on a number of factors (such as whether the entry is in a glossary that +has been identified in the nohypertypes -list). You can override the list). You can override the hyper key in the variant’s optional argument, for -example, \gls*[hyper=true]{sample} but this creates redundancy and is best -avoided. -

    The following keys are available for the optional argument: + id="dx1-44029"> key in the variant’s +optional argument, for example, \gls*[hyper=true]{sample} but this creates redundancy +and is best avoided. The glossaries-extra package provides the option to add a third custom +variant. +

    Avoid nesting these commands. For example don’t do \glslink{label}{\gls{label2}} +as this is likely to cause problems. By implication, these means that you should avoid using +any of these commands within the text, first, short or long keys (or their plural equivalent) or +any other key that you plan to access through these commands. (For example, the symbol key +if you intend to use \glssymbol.)
    +

    +

    The following keys are available for the optional argument:

    hyper
    This is a boolean key which can be used to enable/disable the hyperlink - to the relevant entry in the glossary. If this key is omitted, the value is - determined by current settings, as indicated above. For example, when used - with a
    This is a boolean key which can be used to enable/disable the hyperlink + to the relevant entry in the glossary. If this key is omitted, the value is + determined by current settings, as indicated above. For example, when used with + a \gls-like command, if this is the first use and the \gls-like command, if this is the first use and the hyperfirst=false - package option has been used, then the default value is hyper=false. The - hyperlink can be forced on using hyper=true unless the hyperlinks have - been suppressed using package + option has been used, then the default value is hyper=false. The hyperlink + can be forced on using hyper=true unless the hyperlinks have been suppressed + using \glsdisablehyper. You must load the . You must load the hyperref - package before the package before the glossaries package to ensure the hyperlinks work. + id="dx1-44039"> + package to ensure the hyperlinks work.
    + + format
    This specifies how to format the associated location number for this entry in - the glossary. This value is equivalent to the
    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 - encap value, and (as with \index) the value needs to be the name of a command without the initial - backslash. As with ) + the value needs to be the name of a command without the initial backslash. As with + \index, the characters , the characters ( and ) can also be used to - specify the beginning and ending of a number range. Again as with - ) 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 - , 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

    and use that command. +

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

    If you use

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

    -
    +
    \GlsAddXdyAttribute{textbfem}
    -

    See

    See §11 Xindy (Option 3) 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

    +

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

    -


    Table 6.1: Predefined Hyperlinked Location Formats
    +class="content">Predefined Hyperlinked Location Formats
    hyperrm serif hyperlink
    hypersf sans-serif hyperlink
    hypertt monospaced hyperlink
    hyperbf bold hyperlink
    hypermd medium weight hyperlink
    hyperit italic hyperlink
    hypersl slanted hyperlink
    hyperup upright hyperlink
    hypersc small caps hyperlink
    hyperemph emphasized hyperlink

    -

    Note that if the

    Note that if the \hyperlink command hasn’t been defined, the command hasn’t been defined, the hyperxx⟩ formats - are equivalent to the analogous xx⟩ formats are + equivalent to the analogous textxx⟩ font commands (and hyperemph is - equivalent to emph). If you want to make a new format, you will need to define a - command which takes one argument and use that. For example, if you want the - location number to be in a bold sans-serif font, you can define a command - called, say, 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: - - + id="dx1-44066">: + +

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

    and then use

    and then use hyperbsf as the value for the format key. (See also “Displaying - the glossary” in the documented code, glossaries-code.pdf.) Remember - that if you use key. (See also “Displaying the + glossary” in the documented code, glossaries-code.pdf.) Remember that if you use + xindy, you will need to add this to the list of location - attributes: - - + id="dx1-44068">, 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
    This specifies which counter to use for this location. This overrides the default + counter used by this entry. (See also §5 Number lists.)
    local
    This is a boolean key that only makes a difference when used with -
    This is a boolean key that only makes a difference when used with \gls-like commands that change the entry’s \gls-like commands + that change the entry’s first use flag. If local=true, the - change to the first use flag will be localised to the current scope. The default is - local=true, the change to the first use flag will + be localised to the current scope. The default is local=false.
    -

    The glossaries-extra package provides an additional key. Please see the glossaries-extra user manual +for further details. +

    The link text isn’t scoped by default. Any unscoped declarations in the link text may +affect subsequent text.
    +

    +

    +

    Top

    6.1 The \gls-Like Commands (First Use Flag Queried)

    -

    This section describes the commands that unset the first use flag on completion, and -in most cases they use the current state of the flag to determine the text to be -displayed. As described above, these commands all have a star-variant (hyper=false) -and a plus-variant (hyper=true) and have an optional first argument that is a -⟨

    This section describes the commands that unset (mark as used) the first use flag on +completion, and in most cases they use the current state of the flag to determine the text to +be displayed. As described above, these commands all have a star-variant (hyper=false) and +a plus-variant (hyper=true) and have an optional first argument that is a ⟨key⟩=⟨value⟩ list. -

    These commands use value⟩ +list. +

    These commands use \glsentryfmt or the equivalent definition provided by \defglsentryfmt to determine the automatically generated text and its format (see - to determine the automatically generated text and its format (see §6.3 §6.3 +Changing the format of the link text). -

    Apart from

    Apart from \glsdisp, the commands described in this section also have a final -optional argument ⟨insert⟩ which may be used to insert material into the automatically -generated text. -

    Since the commands have a final optional argument, take care if you actually want -to display an open square bracket after the command when the final optional -argument is absent. Insert an empty set of braces {} immediately before the opening -square bracket to prevent it from being interpreted as the final argument. For -example: - - +class="cmti-10">final optional +argument ⟨insert⟩ which may be used to insert material into the automatically generated +text. +

    Since the commands have a final optional argument, take care if you actually want to +display an open square bracket after the command when the final optional argument is +absent. Insert an empty set of braces {} immediately before the opening square bracket to +prevent it from being interpreted as the final argument. For example: + +

    -
    +
    \gls{sample} {}[Editor’s comment]
    -

    -

    Don’t use any of the

    +

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨insert⟩ -argument.

    -

    -


    insert⟩ argument. +
    +

    +


    \gls  label}[insert]

    -

    +

    This command typically determines the link text from the values of the text or - or first keys supplied when the entry was defined using keys +supplied when the entry was defined using \newglossaryentry. -However, if the entry was defined using . However, if the entry was +defined using \newacronym and \setacronymstyle was -used, then the link text will usually be determined from the was used, then the link text will usually +be determined from the long or short -keys. -

    There are two upper case variants: -


    keys. +

    There are two upper case variants: +


    \Gls  label}[insert]

    -

    +

    and -



    \GLS  label}[insert]

    -

    -which make the first letter of the link text or all the link text upper case, -respectively. For the former, the uppercasing of the first letter is performed by -

    +which make the first letter of the link text or all the link text upper case, respectively. For the +former, the uppercasing of the first letter is performed by \makefirstuc. For further details, including its limitations, see the . +

    The first letter uppercasing command \makefirstuc has limitations which must be taken +into account if you use \Gls or any of the other commands that convert the first letter to +uppercase.
    +

    +The upper casing is performed as follows:

    +
      +
    • If the first thing in the link text is a command follow by a group, the upper casing is + performed on the first object of the group. For example, if an entry has been defined + as + + +
      + \newglossaryentry{sample}{ +  
       name={\emph{sample} phrase}, +  
       sort={sample phrase}, +  
       description={an example}} +
      +

      Then \Gls{sample} will set the link text + to6.1 + + +

      +
      + \emph{\MakeUppercase sample} phrase +
      +

      which will appear as Sample phrase. +

    • +
    • If the first thing in the link text isn’t a command or is a command but isn’t followed by + a group, then the upper casing will be performed on that first thing. For example, if an + entry has been defined as: + + +
      + \newglossaryentry{sample}{ +  
        name={\oe-ligature}, +  
        sort={oe-ligature}, +  
        description={an example} +  
      } +
      +

      Then \Gls{sample} will set the link text to + + +

      +
      + \MakeUppercase \oe-ligature +
      +

      which will appear as Œ-ligature. +

    • +
    • If you have mfirstuc user -manual. -

      There are also analogous plural forms: -


      v2.01 or above, an extra case is added. If the first thing is \protect + it will be discarded and the above rules will then be tried. +
    +

    (Note the use of the sort key in the above examples.) +

    There are hundreds of LATEX packages that altogether define thousands of commands +with various syntax and it’s impossible for mfirstuc to take them all into account. The above +rules are quite simplistic and are designed for link text that starts with a text-block +command (such as \emph) or a command that produces a character (such as \oe). This means +that if your link text starts with something that doesn’t adhere to mfirstuc’s assumptions then +things are likely to go wrong. +

    For example, starting with a math-shift symbol: + + +

    +
    +\newglossaryentry{sample}{ + 
      name={$a$}, + 
      sort={a}, + 
      description={an example} + 
    } +
    +

    This falls into case 2 above, so the link text will be set to + + +

    +
    +\MakeUppercase $a$ +
    +

    This attempts to uppercase the math-shift $, which will go wrong. In this case it’s not +appropriate to perform any case-changing, but it may be that you want to use \Gls +programmatically without checking if the text contains any maths. In this case, the simplest +solution is to insert an empty brace at the start: + + +

    +
    +\newglossaryentry{sample}{ + 
      name={{}$a$}, + 
      sort={a}, + 
      description={an example} + 
    } +
    +

    Now the link text will be set to + + +

    +
    +\MakeUppercase{}$a$ +
    +

    and the \uppercase becomes harmless. +

    Another issue occurs when the link text starts with a command followed by an argument +(case 1) but the argument is a label, identifier or something else that shouldn’t have a +case-change. A common example is when the link text starts with one of the commands +described in this chapter. (But you haven’t done that, have you? What with the warning not +to do it at the beginning of the chapter.) Or when the link text starts with one of the +non-linking commands described in §9 Using Glossary Terms Without Links. For +example: + + +

    +
    +\newglossaryentry{sample}{name={sample},description={an example}} + 
    \newglossaryentry{sample2}{ + 
       name={\glsentrytext{sample} two}, + 
       sort={sample two}, + 
       description={another example} + 
     } +
    +

    Now the link text will be set to: + + +

    +
    +\glsentrytext{\MakeUppercase sample} two +
    +

    This will generate an error because there’s no entry with the label given by +\MakeUppercase sample. The best solution here is to write the term out in the text field and +use the command in the name field. If you don’t use \glsname anywhere in your document, +you can use \gls in the name field: + + +

    +
    +\newglossaryentry{sample}{name={sample},description={an example}} + 
    \newglossaryentry{sample2}{ + 
       name={\gls{sample} two}, + 
       sort={sample two}, + 
       text={sample two}, + 
       description={another example} + 
     } +
    +

    +

    If the link text starts with a command that has an optional argument or with multiple +arguments where the actual text isn’t in the first argument, then \makefirstuc will also fail. +For example: + + +

    +
    +\newglossaryentry{sample}{ + 
     name={\textcolor{blue}{sample} phrase}, + 
     sort={sample phrase}, + 
     description={an example}} +
    +

    Now the link text will be set to: + + +

    +
    +\textcolor{\MakeUppercase blue}{sample} phrase +
    +

    This won’t work because \MakeUppercase blue isn’t a recognised colour name. In this case +you will have to define a helper command where the first argument is the text. For +example: + + +

    +
    +\newglossaryentry{sample}{ + 
    \newcommand*{\blue}[1]{\textcolor{blue}{#1}} + 
     name={\blue{sample} phrase}, + 
     sort={sample phrase}, + 
     description={an example}} +
    +

    In fact, since the whole design ethos of LATEX is the separation of content and style, it’s +better to use a semantic command. For example: + + +

    +
    +\newglossaryentry{sample}{ + 
    \newcommand*{\keyword}[1]{\textcolor{blue}{#1}} + 
     name={\keyword{sample} phrase}, + 
     sort={sample phrase}, + 
     description={an example}} +
    +

    For further details see the mfirstuc user manual. +

    There are plural forms that are analogous to \gls: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    These typically determine the link text from the plural or or firstplural keys supplied -when the entry was defined using keys supplied when the +entry was defined using \newglossaryentry or, if the entry is an -acronym and or, if the entry is an abbreviation and +\setacronymstyle was used, from the longplural or or shortplural -keys. -

    Be careful when you use glossary entries in math mode especially if you are using - keys. +

    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: - - + id="dx1-45048"> +as it can affect the spacing of subscripts and superscripts. For example, suppose you have +defined the following entry: + +

    -
    +
    \newglossaryentry{Falpha}{name={F_\alpha},  
    description=sample}
    -

    and later you use it in math mode: - - +

    and later you use it in math mode: + +

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

    This will result in

    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 ⟨2. In this situation it’s best to bring the superscript into +the hyperlink using the final ⟨insert⟩ optional argument: - - + +

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

    -

    -


    +

    +


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

    -

    +

    This behaves in the same way as the above commands, except that the ⟨link text⟩ is -explicitly set. There’s no final optional argument as any inserted material can be -added to the ⟨link text⟩ argument. -

    Don’t use any of the link text⟩ is explicitly +set. There’s no final optional argument as any inserted material can be added to the ⟨link text⟩ +argument. +

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨link text⟩ -argument of link text⟩ argument of +\glsdisp.
    -

    -

    +

    +

    -

    Top

    6.2 The \glstext-Like Commands (First Use Flag Not Queried)

    -

    This section describes the commands that don’t change or reference the first use flag. -As described above, these commands all have a star-variant (hyper=false) and a -plus-variant (hyper=true) and have an optional first argument that is a ⟨

    This section describes the commands that don’t change or reference the first use +flag. As described above, these commands all have a star-variant (hyper=false) +and a plus-variant (hyper=true) and have an optional first argument that is a +⟨key⟩=⟨value⟩ -list. These commands also don’t use value⟩ list. These commands also don’t use \glsentryfmt or the equivalent definition -provided by or the equivalent +definition provided by \defglsentryfmt (see §6.3 Changing the format of the link text). -

    Apart from

    Apart from \glslink, the commands described in this section also have a final @@ -10696,7 +11148,7 @@ class="cmsy-10">§6.1 The \gls-Like Commands (First Use Flag Queried). -



    \glslink  label}{link text}

    -

    +

    This command explicitly sets the link text as given in the final argument. -

    Don’t use any of the

    Don’t use any of the \gls-like or \glstext-like commands in the argument of \glslink.
    -

    -


    \glslink. By extension, this means that you can’t use them in the value of fields that are +used to form link text.
    +

    +


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

    -

    +

    This command always uses the value of the text key as the key as the link text. -

    There are also analogous commands: -


    . +

    There are also analogous commands: + + +


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

    - - -

    -


    +


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

    -

    -These convert the first character or all the characters to uppercase, respectively. -


    +These convert the first character or all the characters to uppercase, respectively. See the note +on \Gls above for details on the limitations of converting the first letter to upper +case. +


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

    -

    +

    This command always uses the value of the first key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +

    The value of the first key (and firstplural key) doesn’t necessarily match the text produced +by \gls (or \glspl) on first use as the link text used by \gls may be modified +through commands like \defglsentry. (Similarly, the value of the text and plural keys +don’t necessarily match the link text used by \gls or \glspl on subsequent use.) +
    +

    +


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

    -

    +

    This command always uses the value of the plural key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the firstplural key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    + + +

    This command always uses the value of the name key as the key as the link text. Note that this -may be different from the values of the . Note that this may be +different from the values of the text or or first keys. In general it’s better to use + id="dx1-46041"> keys. In general it’s better to use \glstext or \glstext or \glsfirst instead of \glsname. -

    There are also analogous uppercasing commands: -


    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    - - -

    -

    In general it’s best to avoid \Glsname with acronyms. Instead, consider using +

    +

    In general it’s best to avoid \Glsname with acronyms. Instead, consider using \Acrlong, \Acrlong, \Acrshort or \Acrfull.
    -

    -


    +


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

    -

    +

    This command always uses the value of the symbol key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the description key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the user1 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    + + +

    This command always uses the value of the user2 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    - - -


    +


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

    -

    +

    This command always uses the value of the user3 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the user4 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the user5 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    This command always uses the value of the user6 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


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

    -

    -


    + + +


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

    -

    -

    +

    +

    -

    Top

    6.3 Changing the format of the link text

    - - -

    The default format of the

    The default format of the link text for the \gls-like commands is governed by6.1: -


    6.2: +


    \glsentryfmt  \glsentryfmt

    -

    -This may be redefined but if you only want the change the display style for a given -glossary, then you need to use -


    +This may be redefined but if you only want the change the display style for a given glossary, +then you need to use +


    \defglsentryfmt  type]{definition}

    -

    +

    instead of redefining \glsentryfmt. The optional first argument ⟨type⟩ is the glossary -type. This defaults to type⟩ is the glossary type. +This defaults to \glsdefaulttype if omitted. The second argument is the entry -format definition. -

    Note that \glsentryfmt is the default display format for entries. Once the display -format has been changed for an individual glossary using if omitted. The second argument is the entry format +definition. +

    Note that \glsentryfmt is the default display format for entries. Once the display format +has been changed for an individual glossary using \defglsentryfmt, -redefining \glsentryfmt won’t have an effect on that glossary, you must instead -use \defglsentryfmt again. Note that glossaries that have been identified -as lists of acronyms (via the package option acronymlists or the command + id="dx1-47009">, redefining \glsentryfmt won’t have an effect on that glossary, you must instead use \defglsentryfmt +again. Note that glossaries that have been identified as lists of acronyms (via the package +option acronymlists or the command \DeclareAcronymList, see §2.5 Acronym Options) use \defglsentryfmt to set their -display style.
    -

    -

    Within the ⟨Acronym Options) use +\defglsentryfmt to set their display style.

    +

    +

    Within the ⟨definition⟩ argument of \defglsentryfmt, or if you want to redefine \glsentryfmt, you may use the following commands: -



    \glslabel  \glslabel

    -

    -This is the label of the entry being referenced. As from version 4.08, you can also -access the glossary entry type using: -


    +This is the label of the entry being referenced. As from version 4.08, you can also access the +glossary entry type using: +


    \glstype  \glstype

    -

    +

    This is defined using \edef so the replacement text is the actual glossary type rather -than so the replacement text is the actual glossary type rather than +\glsentrytype{\glslabel}. -



    \glscustomtext  \glscustomtext

    -

    +

    This is the custom text supplied in \glsdisp. It’s always empty for \gls, \glspl and -their upper case variants. (You can use and their +upper case variants. (You can use etoolbox’s \ifdefempty to determine if -\glscustomtext is empty.) -


    \ifdefempty to determine if \glscustomtext is +empty.) +


    \glsinsert  \glsinsert

    -

    +

    The custom text supplied in the final optional argument to \gls, \glspl and their -upper case variants. -


    \glspl and their upper case + + +variants. +


    \glsifplural  true text}{false text}

    -

    +

    If \glspl, \Glspl or \GLSpl was used, this command does ⟨true text⟩ otherwise it does -⟨false text⟩. -


    true text⟩ otherwise it does ⟨false +text⟩. +


    \glscapscase  first uc}{all caps}

    -

    +

    If \gls, \glspl or \glsdisp were used, this does ⟨no case⟩. If \Gls or \Glspl were - - -used, this does ⟨\Glspl were used, this +does ⟨first uc⟩. If \GLS or \GLSpl were used, this does ⟨all caps⟩. -



    \glsifhyperon  hyper true}{hyper false}

    -

    +

    This will do ⟨hyper true⟩ if the hyperlinks are on for the current reference, otherwise it -will do ⟨hyper true⟩ if the hyperlinks are on for the current reference, otherwise it will +do ⟨hyper false⟩. The hyperlink may be off even if it wasn’t explicitly switched off with the hypernohypertypes) or because it’s the first use and the hyperlinks have been suppressed on -first use. -

    Note that first use and the hyperlinks have been suppressed on first +use. +

    Note that \glsifhyper is now deprecated. If you want to know if the command -used to reference this entry was used with the star or plus variant, you can -use: -


    is now deprecated. If you want to know if the command used to +reference this entry was used with the star or plus variant, you can use: +


    \glslinkvar  star}{plus}

    -

    +

    This will do ⟨unmodified⟩ if the unmodified version was used, or will do ⟨star⟩ if the -starred version was used, or will do ⟨plus⟩ if the plus version was used. Note that this -doesn’t take into account if the star⟩ if the starred +version was used, or will do ⟨plus⟩ if the plus version was used. Note that this doesn’t +take into account if the hyper key was used to override the default setting, so -this command shouldn’t be used to guess whether or not the hyperlink is on for this + id="dx1-47029"> key was used to override the default setting, so this +command shouldn’t be used to guess whether or not the hyperlink is on for this reference. -

    Note that you can also use commands such as

    Note that you can also use commands such as \ifglsused within the definition of \glsentryfmt (see §14 Unsetting and Resetting Entry Flags). -

    The commands

    The commands \glslabel, \glstype\glstype\glsifplural, \glscapscase, + id="dx1-47034">, \glscustomtext and \glscustomtex and \glsinsert are typically updated at the start of the - are typically updated at the start of the \gls-like and \glstext-like commands so they can usually be accessed in the hook -user commands, such as \glstext-like commands +so they can usually be accessed in the hook user commands, such as \glspostlinkhook and and +\glslinkpostsetkeys. -

    If you only want to make minor modifications to \glsentryfmt, you can -use -


    \glsgenentryfmt  \glsgenentryfmt

    -

    -This uses the above commands to display just the first, text, plural

    This means that using commands like \gls within the fields that are accessed using the +\gls-like or \glstext-like commands (such as the first, text, long or short keys) will cause a +problem. The entry formatting performed by \glsentryfmt and related commands isn’t +scoped (otherwise if would cause problems for \glspostlinkhook which may need to look +ahead as well as look behind). This means that any nested commands will, at the very least, +change the label stored in \glslabel.
    +

    +

    If you only want to make minor modifications to \glsentryfmt, you can use +


    \glsgenentryfmt  \glsgenentryfmt

    +

    +This uses the above commands to display just the first, text, plural or firstplural keys -(or the custom text) with the insert text appended. -

    Alternatively, if want to change the entry format for acronyms (defined via + id="dx1-47048"> keys (or the +custom text) with the insert text appended. + + +

    Alternatively, if want to change the entry format for abbreviations (defined via \newacronym) you can use: -


    ) you can use: +


    \glsgenacfmt  \glsgenacfmt

    -

    +

    This uses the values from the long, , short, , longplural and and shortplural keys, rather than + id="dx1-47054"> keys, rather than using the text, , plural, , first and and firstplural keys. The first use singular text is obtained + id="dx1-47058"> keys. The first use singular text is obtained via: -



    \genacrfullformat  \genacrfullformat{label}{insert}

    -

    +

    instead of from the first key, and the first use plural text is obtained via: -


    key, and the first use plural text is obtained via: +


    \genplacrfullformat  \genplacrfullformat{label}{insert}

    -

    +

    instead of from the firstplural key. In both cases, ⟨ key. In both cases, ⟨label⟩ is the entry’s label and ⟨insert⟩ is -the insert text provided in the final optional argument of commands like insert⟩ is the +insert text provided in the final optional argument of commands like \gls. The - - -default behaviour is to do the long form (or plural long form) followed by ⟨insert⟩ and -a space and the short form (or plural short form) in parentheses, where the short form + id="dx1-47063">. The default +behaviour is to do the long form (or plural long form) followed by ⟨insert⟩ and a space +and the short form (or plural short form) in parentheses, where the short form is in the argument of \firstacronymfont. There are also first letter upper case + id="dx1-47064">. There are also first letter upper case versions: -



    \Genacrfullformat  \Genacrfullformat{label}{insert}

    -

    +

    and -



    \Genplacrfullformat  \Genplacrfullformat{label}{insert}

    -

    -By default these perform a protected expansion on their no-case-change equivalents -and then use

    +By default these perform a protected expansion on their no-case-change equivalents and then +use \makefirstuc to convert the first character to upper case. If there are -issues caused by this expansion, you will need to redefine those commands to explicitly + id="dx1-47067"> to convert the first character to upper case. If there are issues +caused by this expansion, you will need to redefine those commands to explicitly use commands like \Glsentrylong (which is what the predefined acronym styles, such -as (which is what the predefined acronym styles, +such as long-short, do). Otherwise, you only need to redefine , do). Otherwise, you only need to redefine \genacrfullformat and - +and \genplacrfullformat to change the behaviour of to change the behaviour of \glsgenacfmt. See . See §13 Acronyms and Other Abbreviations for further details on changing the style of acronyms. -

    Note that \glsentryfmt is not used by the

    -

    -

    As from version 4.16, both the \glstext-like commands.

    +

    +

    As from version 4.16, both the \gls-like and \glstext-like commands -use -


    \glstext-like commands use +


    \glslinkpostsetkeys  \glslinkpostsetkeys

    -

    +

    after the ⟨options⟩ are set. This macro does nothing by default but can be redefined. -(For example, to switch off the hyperlink under certain conditions.) This version also +class="cmti-10">options⟩ are set. This macro does nothing by default but can be redefined. (For +example, to switch off the hyperlink under certain conditions.) This version also introduces -



    \glspostlinkhook  \glspostlinkhook

    -

    +

    which is done after the link text has been displayed and also after the first use -flag has been unset (see example first use flag has been +unset (see example 24). -

    + + +

    Example 8 (Custom Entry Display in Text) -

    Suppose you want a glossary of measurements and units, you can use the +

    Suppose you want a glossary of measurements and units, you can use the symbol -key to store the unit: - - + id="dx1-47077"> key to +store the unit: + +

    -
    +
    \newglossaryentry{distance}{name=distance,  
    description={The length between two points},  
    symbol={km}}
    -

    and now suppose you want

    and now suppose you want \gls{distance} to produce “distance (km)” on first use, -then you can redefine first use, then +you can redefine \glsentryfmt as follows: - - + id="dx1-47078"> as follows: + +

    -
    +
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%  
    }
    -

    -

    (Note that I’ve used

    +

    (Note that I’ve used \glsentrysymbol rather than rather than \glssymbol to avoid nested + id="dx1-47080"> to avoid nested hyperlinks.) -

    Note also that all of the

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

    -
    +
    \renewcommand{\glstextformat}[1]{\textbf{#1}}  
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \ifglsused{\glslabel}{}{\space(\glsentrysymbol{\glslabel})}%  
    }
    -

    then

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

    For a complete document, see the sample file

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

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 9 (Custom Format for Particular Glossary) -

    Suppose you have created a new glossary called +

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

    -
    +
    \defglsentryfmt[notation]{\glsgenentryfmt  
     \ifglsused{\glslabel}{}{\space  
       (denoted \glsentrysymbol{\glslabel})}}
    -

    Now suppose you have defined an entry as follows: - - +

    Now suppose you have defined an entry as follows: + +

    -
    +
    \newglossaryentry{set}{type=notation,  
      name=set,  
      description={A collection of objects},  
      symbol={$S$}  
    }
    -

    The

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

    Alternatively, if you expect all the symbols to be set in math mode, you can + id="dx1-47085"> was used). +

    Alternatively, if you expect all the symbols to be set in math mode, you can do: - - + +

    -
    +
    \defglsentryfmt[notation]{\glsgenentryfmt  
     \ifglsused{\glslabel}{}{\space  
       (denoted $\glsentrysymbol{\glslabel}$)}}
    -

    and define entries like this: - - +

    and define entries like this: + +

    -
    +
    \newglossaryentry{set}{type=notation,  
      name=set,  
      description={A collection of objects},  
      symbol={S}  
    }
    -

    +

    -

    -

    ____________________________

    -

    Remember that if you use the

    +

    ____________________________

    +

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

    + id="dx1-47086"> key, you need to use a glossary style that displays +the symbol, as many of the styles ignore it. +

    -

    Top

    6.4 Enabling and disabling hyperlinks to glossary entries

    -

    If you load the

    If you load the hyperref or htmlglossaries package, the href="#x1-450006.1">\gls-like and \glstext-like commands will automatically have hyperlinks to the -relevant glossary entry, unless the \glstext-like commands will automatically have hyperlinks to the relevant +glossary entry, unless the hyper option has been switched off (either -explicitly or through implicit means, such as via the option has been switched off (either explicitly or through +implicit means, such as via the nohypertypes package -option). -

    You can disable or enable links using: -


    package option). +

    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 -

    +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 have +been defined (for example, by the hyperref -package). -

    You can disable just the package). +

    You can disable just the first use links using the package option hyperfirst=false. -Note that this option only affects the . Note +that this option only affects the \gls-like commands that recognise the first use flag. -

    Example 10 (First Use With Hyperlinked Footnote - - -Description) (First Use With Hyperlinked Footnote Description) -

    Suppose I want the first use to have a hyperlink to the description in a footnote -instead of hyperlinking to the relevant place in the glossary. First I need to disable the -hyperlinks on first use via the package option

    Suppose I want the first use to have a hyperlink to the description in a footnote instead of +hyperlinking to the relevant place in the glossary. First I need to disable the hyperlinks on +first use via the package option hyperfirst=false: - - + +

    -
    +
    \usepackage[hyperfirst=false]{glossaries}
    -

    Now I need to redefine

    Now I need to redefine \glsentryfmt (see §6.3 Changing the format of the link text): - - + +

    -
    +
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%  
    }
    -

    -

    Now the first use won’t have hyperlinked text, but will be followed by a -footnote. See the sample file

    +

    Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the +sample file sample-FnDesc.tex for a complete document. -

    +class="cmtt-10">sample-FnDesc.tex for a complete document.

    -

    -

    ____________________________

    -

    Note that the

    +

    ____________________________

    +

    Note that the hyperfirst option applies to all defined glossaries. It may be that you -only want to disable the hyperlinks on first use for glossaries that have a different form -on first use. This can be achieved by noting that since the entries that require -hyperlinking for all instances have identical first and subsequent text, they can be -unset via option applies to all defined glossaries. It may be that you only +want to disable the hyperlinks on first use for glossaries that have a different form on first use. +This can be achieved by noting that since the entries that require hyperlinking for all +instances have identical first and subsequent text, they can be unset via \glsunsetall (see (see +§14 Unsetting and Resetting Entry Flags) so that the -Unsetting and Resetting Entry Flags) so that the hyperfirst option doesn’t get applied. + id="dx1-48017"> option doesn’t get +applied. -

    Example 11 (Suppressing Hyperlinks on First Use Just For Acronyms) -

    Suppose I want to suppress the hyperlink on first use for acronyms but not for -entries in the main glossary. I can load the

    Suppose I want to suppress the hyperlink on first use for acronyms but not for entries in +the main glossary. I can load the glossaries package using: - - + +

    -
    +
    \usepackage[hyperfirst=false,acronym]{glossaries}
    -

    Once all glossary entries have been defined I then do: - - +

    Once all glossary entries have been defined I then do: + +

    -
    +
    \glsunsetall[main]
    -

    +

    -

    -

    ____________________________

    -

    For more complex requirements, you might find it easier to switch off all hyperlinks -via

    +

    ____________________________

    +

    For more complex requirements, you might find it easier to switch off all hyperlinks via +\glsdisablehyper and put the hyperlinks (where required) within the definition -of and put the hyperlinks (where required) within the definition of +\glsentryfmt (see §6.3 Changing the format of the link text) via \glshyperlink -(see (see §9 §9 +Using Glossary Terms Without Links). -

    Example 12 (Only Hyperlink in Text Mode Not Math -Mode) (Only Hyperlink in Text Mode Not Math Mode) -

    This is a bit of a contrived example, but suppose, for some reason, I only want the +

    This is a bit of a contrived example, but suppose, for some reason, I only want the \gls-like commands to have hyperlinks when used in text mode, but not in math -mode. I can do this by adding the glossary to the list of nohypertypes and redefining +class="cmtt-10">\gls-like commands to have hyperlinks when used in text mode, but not in math mode. +I can do this by adding the glossary to the list of nohypertypes and redefining \glsentryfmt: - - + +

    -
    +
    \GlsDeclareNoHyperList{main}  
    \renewcommand*{\glsentryfmt}{%  
      \ifmmode @@ -12027,66 +12527,62 @@ class="cmtt-10">\glsentryfmt  \fi  
    }
    -

    Note that this doesn’t affect the

    Note that this doesn’t affect the \glstext-like commands, which will have the -hyperlinks off unless they’re forced on using the plus variant. -

    See the sample file \glstext-like commands, which will have the hyperlinks off +unless they’re forced on using the plus variant. +

    See the sample file sample-nomathhyper.tex for a complete document. -

    +class="cmtt-10">sample-nomathhyper.tex for a complete document.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 13 (One Hyper Link Per Entry Per Chapter) -

    Here’s a more complicated example that will only have the hyperlink on the first -time an entry is used per chapter. This doesn’t involve resetting the first use -flag. Instead it adds a new key using

    Here’s a more complicated example that will only have the hyperlink on the first time an +entry is used per chapter. This doesn’t involve resetting the first use flag. Instead it adds +a new key using \glsaddstoragekey (see §4.5 Storage -Keys) that keeps track of the chapter number that the entry was last used -in: - - +href="#sec:glsaddstoragekey">Storage Keys) that keeps track of the chapter +number that the entry was last used in: + +

    -
    +
    \glsaddstoragekey{chapter}{0}{\glschapnum}
    -

    This creates a new user command called \glschapnum that’s analogous to -\glsentrytext. The default value for this key is 0. I then define my glossary entries -as usual. -

    Next I redefine the hook

    This creates a new user command called \glschapnum that’s analogous to \glsentrytext. +The default value for this key is 0. I then define my glossary entries as usual. +

    Next I redefine the hook \glslinkpostsetkeys (see §6.3 Changing the format of -the link text) so that it determines the current chapter number (which is stored in -\currentchap using \edef). This value is then compared with the value of the -entry’s chapter key that I defined earlier. If they’re the same, this entry -has already been used in this chapter so the hyperlink is switched off using -Changing the format of the link +text) so that it determines the current chapter number (which is stored in \currentchap +using \edef). This value is then compared with the value of the entry’s chapter key that I +defined earlier. If they’re the same, this entry has already been used in this chapter so the +hyperlink is switched off using xkeyval’s \setkeys command. If the chapter number isn’t the same, then this -entry hasn’t been used in the current chapter. The chapter field is updated -using \setkeys command. If the chapter number isn’t the +same, then this entry hasn’t been used in the current chapter. The chapter field is +updated using \glsfieldxdef (Fetching and Updating the Value of a Field

    Note that this will be confused if you use \gls etc when the chapter counter is 0. -(That is, before the first

    Note that this will be confused if you use \gls etc when the chapter counter is 0. (That is, +before the first \chapter.) -

    See the sample file

    See the sample file sample-chap-hyperfirst.tex for a complete document.

    -

    -

    ____________________________

    - - -

    -

    +

    ____________________________

    + + +

    +

    Top

    7. Adding an Entry to the Glossary Without Generating Text

    -

    It is possible to add a line to the glossary file without generating any text at that -point in the document using: -


    It is possible to add a line to the glossary file without generating any text at that point in +the document using: +


    \glsadd  options]{label}

    -

    +

    This is similar to the \glstext-like commands, only it doesn’t produce any text (so therefore, there is no hyper key available in ⟨options⟩ but all the other options that can -be used with options⟩ but all the other options that can be +used with \glstext-like commands 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: -


    +

    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 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: - - + id="dx1-49005">) and a list of notation (specified by the glossary type +notation) then you can do: + +

    -
    +
    \glsaddall[types={\acronymtype,notation}]
    -

    -

    Note that

    +

    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 . 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  +package option. (See sections 2.3 and 5.) -
    -

    -

    There is now a variation of \glsaddall that skips any entries that have already -been used: -


    5.)
    +

    +

    There is now a variation of \glsaddall that skips any entries that have already been +used: +


    \glsaddallunused  \glsaddallunused[list]

    -

    +

    This command uses \glsadd[format=@gobble] which will ignore this location in the -number list. The optional argument ⟨list⟩ is a comma-separated list of glossary types. If -omitted, it defaults to the list of all defined glossaries. -

    If you want to use \glsaddallunused, it’s best to place the command at the end -of the document to ensure that all the commands you intend to use have already been +class="cmtt-10">\glsadd[format=@gobble] which will ignore this location in the number +list. The optional argument ⟨list⟩ is a comma-separated list of glossary types. If omitted, it +defaults to the list of all defined glossaries. +

    If you want to use \glsaddallunused, it’s best to place the command at the end of the +document to ensure that all the commands you intend to use have already been used. Otherwise you could end up with a spurious comma or dash in the location list. -

    Example 14 (Dual Entries) -

    The example file

    The example file sample-dual.tex makes use of \glsadd to allow for -an entry that should appear both in the main glossary and in the list of -acronyms. This example sets up the list of acronyms using the \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: - - + id="dx1-49011"> 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: + +

    - +

    Top

    8. Cross-Referencing Entries

    -

    You must use

    You must use \makeglossaries (Options 2 or \makenoidxglossaries (Option 1) before defining any terms that cross-reference entries. If any of the terms -that you have cross-referenced don’t appear in the glossary, check that you have -put before defining any terms that cross-reference entries. If any of the terms that +you have cross-referenced don’t appear in the glossary, check that you have put +\makeglossaries/\makenoidxglossaries before all entry definitions. -
    -

    -

    There are several ways of cross-referencing entries in the glossary: +class="cmtt-10">\makenoidxglossaries before all entry definitions.

    +

    +

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

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

      +

    2. As described in §4 Defining Glossary Entries, you can use the see key when you - define the entry. For example: - - -
      + id="dx1-50009"> 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

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

      The “see” tag is produce using

      The “see” tag is produce using \seename, but can be overridden in - specific instances using square brackets at the start of the , but can be overridden in specific instances + using square brackets at the start of the see value. For - example: - - + id="dx1-50012"> value. For example: + +

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

      Take care if you want to use the optional argument of commands such as -

      Take care if you want to use the optional argument of commands such as \newacronym or + or \newterm as the value will need to be grouped. For - example: - - + id="dx1-50014"> as the value will need to be grouped. For example: + +

      -
      +
      \newterm{seal}  
      \newterm[see={[see also]seal}]{sea lion}
      -

      Similarly if the value contains a list. For example: - - +

      Similarly if the value contains a list. For example: + +

      -
      +
      \glossaryentry{lemon}{  
        name={lemon},  
        description={Yellow citrus fruit} @@ -12427,11 +12916,11 @@ class="cmtt-10">\newterm  see={lemon,lime}  
      }
      -

      +

    3. After you have defined the entry, use -



      \glssee  label}{xr label list}

      -

      +

      where ⟨xr label list⟩ is a comma-separated list of entry labels to be - cross-referenced, ⟨label⟩ is the label of the entry doing the cross-referencing - and ⟨tag⟩ is the “see” tag. (The default value of ⟨xr label list⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨label⟩ + is the label of the entry doing the cross-referencing and ⟨tag⟩ is the “see” tag. (The + default value of ⟨tag⟩ is \seename.) For - example: - - + id="dx1-50018">.) For example: + +

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

      Note that this automatically adds the entry given by ⟨label⟩ to the glossary but - doesn’t add the cross-referenced entries (specified by ⟨

      Note that this automatically adds the entry given by ⟨label⟩ to the glossary + but doesn’t add the cross-referenced entries (specified by ⟨xr label list⟩) to the glossary.

    -

    In both cases 2 and 3 above, the cross-referenced information appears in the -

    In both cases 2 and 3 above, the cross-referenced information appears in the number list, whereas in case 1, the cross-referenced information appears -in the description. (See the , +whereas in case 1, the cross-referenced information appears in the description. (See the +sample-crossref.tex example file that comes -with this package.) This means that in cases 2 and 3, the cross-referencing -information won’t appear if you have suppressed the number list. In this -case, you will need to activate the number listsample-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=falseseeautonumberlist package option.

    -

    Top

    8.1 Customising Cross-reference Text

    -

    When you use either the

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


    \glssee, the cross-referencing information +will be typeset in the glossary according to: +


    \glsseeformat  label-list}{location}

    -

    +

    The default definition of \glsseeformat is:
    } \glsseelist{label-list}
    -Note that the location is always -ignored.8.18.1 For example, if you want the tag to appear in bold, you can do:8.28.2 - - + +

    -
    +
    \renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1}  
     \glsseelist{#2}}
    -

    -

    The list of labels is dealt with by

    +

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


    \space” respectively. The list entry text is +displayed using: +


    \glsseeitemformat  \glsseeitemformat{label}

    -

    -This defaults to -

    +This defaults to \glsentrytext{label}.8.38.3 For example, to make the cross-referenced list use small caps: - - + +

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

    -

    You can use

    +

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

    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 -, they don’t have any optional +arguments, they don’t affect the first use flag and, apart from \glshyperlink, they don’t produce hyperlinks. -

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will -need to provide an alternative via , they don’t +produce hyperlinks. +

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need +to provide an alternative via hyperref’s \texorpdfstring if you want to use -them in sectioning commands. (This isn’t specific to the glossaries package.) See the -\texorpdfstring if you want to use them in +sectioning commands. (This isn’t specific to the glossaries package.) See the hyperref documentation for further details. All the commands that convert the -first letter to upper case aren’t expandable. The other commands depend -on whether their corresponding keys were assigned non-expandable values. -
    -

    -

    If you want each word in a given entry field capitalised, you can use - +documentation for further details. All the commands that convert the first letter to upper +case aren’t expandable. The other commands depend on whether their corresponding keys +were assigned non-expandable values.

    +

    +

    If you want each word in a given entry field capitalised, you can use \ecapitalisewordstext⟩ defined by the text⟩ +defined by the mfirstuc package, but make sure you use one of -the expandable commands within ⟨ package, but make sure you use one of the expandable commands +within ⟨text⟩. For example: - - + +

    -
    +
    \ecaptialisewords{\glsentrytext{somelabel}}
    -

    Note that \ecapitalisewords is not expandable. -


    Note that \ecapitalisewords is not expandable. Note that this command has the same +limitations as \makefirstuc which is used by commands like \Gls and \Glsentryname to +upper-case the first letter (see the notes about \Gls in §6.1 The \gls-Like Commands (First +Use Flag Queried)). +


    \glsentryname  \glsentryname{label}

    -

    -


    +


    \Glsentryname  \Glsentryname{label}

    -

    +

    These commands display the name of the glossary entry given by ⟨label⟩, as specified by -the label⟩, as specified by the +name key. \Glsentryname makes the first letter upper case. Neither of these -commands check for the existence of ⟨\Glsentryname makes the first letter upper case. Neither of these commands check +for the existence of ⟨label⟩. The first form \glsentryname is -expandable (unless the name contains unexpandable commands). Note that this may -be different from the values of the \glsentryname is expandable (unless the name +contains unexpandable commands). Note that this may be different from the values of the +text or first keys. In general it’s better to use - keys. In general it’s better to use \glsentrytext or \glsentryfirst instead of \glsentryfirst instead of +\glsentryname. -

    In general it’s best to avoid \Glsentryname with acronyms. Instead, consider -using

    In general it’s best to avoid \Glsentryname with acronyms. Instead, consider using +\Glsentrylong, \Glsentryshort or \Glsentryfull.
    -

    -


    +


    \glossentryname  \glossentryname{label}

    -

    +

    This is like \glsnamefont{\glsentryname{label}} but also checks for the -existence of ⟨label⟩. This command is not expandable. It’s used in the predefined -glossary styles, so if you want to change the way the name is formatted in -the glossary, you can redefine \glsnamefont to use the required fonts. For -example: - - +class="cmsy-10">} but also checks for the existence of ⟨label⟩. +This command is not expandable. It’s used in the predefined glossary styles, so if you want to +change the way the name is formatted in the glossary, you can redefine \glsnamefont to use +the required fonts. For example: + +

    -
    +
    \renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}}
    -

    -


    +


    \Glossentryname  \Glossentryname{label}

    -

    +

    This is like \glossentryname but makes the first letter of the name upper -case. -


    \glossentryname but makes the first letter of the name upper case. +


    \glsentrytext  \glsentrytext{label}

    -

    -


    +


    \Glsentrytext  \Glsentrytext{label}

    -

    -These commands display the subsequent use text for the glossary entry given by -⟨label⟩, as specified by the

    +These commands display the subsequent use text for the glossary entry given by ⟨label⟩, as +specified by the text key. \Glsentrytext makes the first letter upper -case. The first form is expandable (unless the text contains unexpandable -commands). The second form is not expandable. Neither checks for the existence of -⟨\Glsentrytext makes the first letter upper case. The first form is +expandable (unless the text contains unexpandable commands). The second form is not +expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryplural  \glsentryplural{label}

    -

    -


    +


    \Glsentryplural  \Glsentryplural{label}

    -

    -These commands display the subsequent use plural text for the glossary entry given by -⟨label⟩, as specified by the

    +These commands display the subsequent use plural text for the glossary entry given by ⟨label⟩, +as specified by the plural key. \Glsentryplural makes the first letter upper -case. The first form is expandable (unless the value of that key contains unexpandable +class="cmtt-10">\Glsentryplural makes the first letter upper case. +The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryfirst  \glsentryfirst{label}

    -

    -


    +


    \Glsentryfirst  \Glsentryfirst{label}

    -

    +

    These commands display the first use text for the glossary entry given by ⟨label⟩, as -specified by the label⟩, +as specified by the first key. \Glsentryfirst makes the first letter upper case. The -first form is expandable (unless the value of that key contains unexpandable +class="cmtt-10">\Glsentryfirst makes the first letter upper case. +The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryfirstplural  \glsentryfirstplural{label}

    -

    -


    +


    \Glsentryfirstplural  \Glsentryfirstplural{label}

    -

    +

    These commands display the plural form of the first use text for the glossary entry - - -given by ⟨first use text for the glossary entry given by +⟨label⟩, as specified by the firstplural key. \Glsentryfirstplural makes the -first letter upper case. The first form is expandable (unless the value of that key -contains unexpandable commands). The second form is not expandable. Neither -checks for the existence of ⟨\Glsentryfirstplural makes the first letter upper +case. The first form is expandable (unless the value of that key contains unexpandable + + +commands). The second form is not expandable. Neither checks for the existence of +⟨label⟩. -



    \glsentrydesc  \glsentrydesc{label}

    -

    -


    +


    \Glsentrydesc  \Glsentrydesc{label}

    -

    +

    These commands display the description for the glossary entry given by ⟨label⟩. \Glsentrydesc +makes the first letter upper case. The first form is expandable (unless the value of that key +contains unexpandable commands). The second form is not expandable. Neither checks for +the existence of ⟨label⟩. -\Glsentrydesc makes the first letter upper case. The first form is expandable (unless -the value of that key contains unexpandable commands). The second form is not -expandable. Neither checks for the existence of ⟨label⟩. -



    \glossentrydesc  \glossentrydesc{label}

    -

    +

    This is like \glsentrydesc{label} but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in the predefined glossary styles to display the description. -



    \Glossentrydesc  \Glossentrydesc{label}

    -

    +

    This is like \glossentrydesc but converts the first letter to upper case. This -command is not expandable. -


    \glossentrydesc but converts the first letter to upper case. This command is not +expandable. +


    \glsentrydescplural  \glsentrydescplural{label}

    -

    -


    +


    \Glsentrydescplural  \Glsentrydescplural{label}

    -

    +

    These commands display the plural description for the glossary entry given by ⟨label⟩. \Glsentrydescplural makes the first letter upper case. The first form is expandable -(unless the value of that key contains unexpandable commands). The second form is -not expandable. Neither checks for the existence of ⟨\Glsentrydescplural makes the first letter upper case. The first form is expandable (unless +the value of that key contains unexpandable commands). The second form is not expandable. +Neither checks for the existence of ⟨label⟩. -



    \glsentrysymbol  \glsentrysymbol{label}

    -

    -


    +


    \Glsentrysymbol  \Glsentrysymbol{label}

    -

    +

    These commands display the symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbol +makes the first letter upper case. The first form is expandable (unless the value of that key +contains unexpandable commands). The second form is not expandable. Neither checks for +the existence of ⟨label⟩. -\Glsentrysymbol makes the first letter upper case. The first form is expandable -(unless the value of that key contains unexpandable commands). The second form is -not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsletentryfield  label}{field}

    -

    -This command doesn’t display anything. It merely fetches the value associated with -the given field (where the available field names are listed in table 4.1) and stores the -result in the control sequence ⟨cs⟩. For example, to store the description for the entry -whose label is “apple” in the control sequence

    +This command doesn’t display anything. It merely fetches the value associated with the given +field (where the available field names are listed in table 4.1) and stores the result in the +control sequence ⟨cs⟩. For example, to store the description for the entry whose label is “apple” +in the control sequence \tmp: - - + +

    -
    +
    \glsletentryfield{\tmp}{apple}{desc}
    -

    -


    +


    \glossentrysymbol  \glossentrysymbol{label}

    -

    +

    This is like \glsentrysymbol{label} but also checks for the existence of ⟨label⟩. This -command is not expandable. It’s used in some of the predefined glossary styles to -display the symbol. -


    label⟩. This command +is not expandable. It’s used in some of the predefined glossary styles to display the +symbol. +


    \Glossentrysymbol  \Glossentrysymbol{label}

    -

    +

    This is like \glossentrysymbol but converts the first letter to upper case. This -command is not expandable. -


    \glossentrysymbol but converts the first letter to upper case. This command is +not expandable. +


    \glsentrysymbolplural  \glsentrysymbolplural{label}

    -

    -


    +


    \Glsentrysymbolplural  \Glsentrysymbolplural{label}

    -

    +

    These commands display the plural symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbolplural makes the first letter upper case. The first form is -expandable (unless the value of that key contains unexpandable commands). The -second form is not expandable. Neither checks for the existence of ⟨\Glsentrysymbolplural makes the first letter upper case. The first form is expandable +(unless the value of that key contains unexpandable commands). The second form is not +expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryuseri  \glsentryuseri{label}

    -

    -


    +


    \Glsentryuseri  \Glsentryuseri{label}

    -

    -


    +


    \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⟩. The lower case forms are expandable (unless the value of the -key contains unexpandable commands). The commands beginning with an -upper case letter convert the first letter of the required value to upper case -and are not expandable. None of these commands check for the existence of -⟨

    +These commands display the value of the user keys for the glossary entry given by ⟨label⟩. The +lower case forms are expandable (unless the value of the key contains unexpandable +commands). The commands beginning with an upper case letter convert the first letter of the +required value to upper case and are not expandable. None of these commands check for the +existence of ⟨label⟩. -



    \glshyperlink  link text]{label}

    -

    +

    This command provides a hyperlink to the glossary entry given by ⟨labelbut does not add @@ -13132,7 +13623,7 @@ class="cmtt-10">{⟨label} by default9.19.1, but can be overridden using the optional argument. Note that the hyperlink will be suppressed if you have used \glsdisablehyperhyperref package. -

    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

    -

    -

    The next two commands are only available with Option 1 or with the -§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 Option 1 or with the savenumberlist package option: -


    +package option: +


    \glsentrynumberlist  \glsentrynumberlist{label}

    -

    -


    +


    \glsdisplaynumberlist  \glsdisplaynumberlist{label}

    -

    +

    Both display the number list for the entry given by ⟨label⟩. When used with Option 1 -a rerun is required to ensure this list is up-to-date, when used with Options Option 1 a rerun +is required to ensure this list is up-to-date, when used with Options 2 or 3 a -run of 3 a run of +makeglossaries (or makeindex/xindy) followed by one or two runs of -LATEX is required. -

    The first command, \glsentrynumberlist, simply displays the number list as is. The second command, -) followed by one or two runs of LATEX is +required. +

    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 works with Option 1, but for Options 2 or 3 it only works when the default counter format is used (that is, when -the 3 it only works when the default counter format is used (that is, when the +format key is set to glsnumberformat). This command will only work -with glsnumberformat). This command will only work with hyperref if you choose Option 1. If you try using this command with -Options  if you +choose Option 1. If you try using this command with Options 2 or 3 and hyperref, \glsentrynumberlist will be used instead. -
    -

    -

    For further information see “Displaying entry details without adding information -to the glossary” in the documented code (, +\glsentrynumberlist will be used instead.

    +

    +

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

    -

    -

    +

    Top

    10. Displaying a glossary

    @@ -13255,12 +13745,12 @@ class="cmbx-10">Option 1:
    -



    \printnoidxglossaries  \printnoidxglossaries

    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) @@ -13276,47 +13766,55 @@ href="#option3">3:

    -



    \printglossaries  \printglossaries

    -

    +

    (Must be used with \makeglossaries in the preamble.)

    -

    These commands will display all the glossaries in the order in which they were -defined. Note that, in the case of Options 

    These commands will display all the glossaries in the order in which they were defined. +Note that, in the case of Options 2 and 3, no glossaries will appear until you -have either used the Perl script 3, no glossaries will appear until you have either used +the Perl script makeglossaries or have directly used or Lua script makeglossaries-lite.lua or have directly +used makeindex or - or xindy (as described in (as described in §1.4 Generating the Associated Glossary Files). If the -glossary still does not appear after you re-LATGenerating the Associated Glossary Files). +(While the external files are missing, these commands will just do \null for each missing +glossary to assist dictionary style documents that just use \glsaddall without inserting any +text.) +

    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. With Option 1, you just need -two LATEX runs to make the glossaries appear, but you may need further runs to -make the log files to see if there is a problem. With Option 1, you just need two +LATEX runs to make the glossaries appear, but you may need further runs to make the +number lists up-to-date. -

    An individual glossary can be displayed using: + id="dx1-53011">s up-to-date. +

    An individual glossary can be displayed using:

    Option 1:
    -



    \printnoidxglossary  \printnoidxglossary[options]

    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) + id="dx1-53013"> in the preamble.)

    Options3:
    -



    \printglossary  \printglossary[options]

    -

    +

    (Must be used with \makeglossaries in the preamble.)

    -

    where ⟨ in the preamble.)

    +

    where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. The following keys are available: +class="cmti-10">value⟩ list of options. (Again, when the associated external file is missing, +\null is inserted into the document.) +

    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: - - -
    + id="dx1-53016">
    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]
    -

    Note that you can’t display an ignored glossary, so don’t try setting

    Note that you can’t display an ignored glossary, so don’t try setting type to the - name of a glossary that was defined using to the name of + a glossary that was defined using \newignoredglossary. (See . (See §12 - Defining New Glossaries.) +class="cmsy-10">§12 Defining New + Glossaries.)

    title
    This is the glossary’s title (overriding the title specified when the glossary was defined).
    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 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. + id="dx1-53022"> is used.
    style
    This specifies which glossary style to use for this glossary, overriding the effect of - the
    This specifies which glossary style to use for this glossary, overriding the effect of the + style package option or package option or \glossarystyle. + id="dx1-53025">.
    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 package option. This key has the same + syntax as the numberedsection package option, described in package option, described in §2.2 Sectioning, - Headings and TOC Options. +href="#sectioningheadingsandtocoptions">Sectioning, Headings + and TOC Options.
    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. +class="cmtt-10">nonumberlist=true) the numberlist is + suppressed for this glossary. If false (nonumberlist=false) the numberlist is displayed + for this glossary.
    nogroupskip
    This is a boolean key. If true the vertical gap between groups is - suppressed for this glossary. + id="dx1-53030">
    This is a boolean key. If true the vertical gap between groups is suppressed for + this glossary.
    nopostdot
    This is a boolean key. If true the full stop after the description is - suppressed for this glossary. + id="dx1-53031">
    This is a boolean key. If true the full stop after the description is suppressed for + this glossary.
    entrycounter
    This is a boolean key. Behaves similar to the package option of the same - name. The corresponding package option must be used to make
    This is a boolean key. Behaves similar to the package option of the same name. + The corresponding package option must be used to make \glsrefentry - work correctly. + id="dx1-53033"> work + correctly.
    subentrycounter
    This is a boolean key. Behaves similar to the package option of the - same name. If you want to set both
    This is a boolean key. Behaves similar to the package option of the same + name. If you want to set both entrycounter and and subentrycounter, make sure - - - you specify , make sure you specify + + + entrycounter first. The corresponding package option must be used to - make first. The corresponding package option must be used to make + \glsrefentry work correctly. + id="dx1-53038"> work correctly.
    sort
    This key is only available for Option 1. Possible values are: word (word order), - letter (letter order), word (word order), letter + (letter order), standard (word or letter ordering taken from the order - package option), package option), + use (order of use), def (order of definition) nocase - (case-insensitive) or case (case-sensitive). -

    The +class="cmtt-10">nocase (case-insensitive) or case + (case-sensitive). +

    The word and letter @@ -13501,14 +14002,14 @@ class="cmtt-10">case (case-sensitive). use datatool’s + id="dx1-53041">’s \dtlwordindexcompare + id="dx1-53042"> and \dtlletterindexcompare + id="dx1-53043"> handlers. The case-insensitive @@ -13517,10 +14018,10 @@ class="cmtt-10">\dtlletterindexcomparedatatool’s + id="dx1-53044">’s \dtlicompare + id="dx1-53045"> handler. The case-sensitive @@ -13529,136 +14030,135 @@ class="cmtt-10">\dtlicomparedatatool’s + id="dx1-53046">’s \dtlcompare + id="dx1-53047"> handler. See the datatool + id="dx1-53048"> documentation for further details. -

    If you don’t get an error with

    If you don’t get an error with sort=use and sort=def but you do get an error - with one of the other sort options, then you probably need to use the - - - sort=def but you do get an error with one + of the other sort options, then you probably need to use the sanitizesort=true package option or make sure none of the entries have fragile - commands in their package + + + option or make sure none of the entries have fragile commands in their sort field.

    -

    By default, the glossary is started either by + field.

    +

    By default, the glossary is started either by \chapter* or by or by \section*, depending on + id="dx1-53052">, depending on whether or not \chapter is defined. This can be overridden by the is defined. This can be overridden by the section package option or the - package option or +the \setglossarysection command. Numbered sectional units can be obtained using the - command. Numbered sectional units can be obtained using +the numberedsection package option. Each glossary sets the page header via the + id="dx1-53056"> package option. Each glossary sets the page header via the command -



    \glsglossarymark  \glsglossarymark{title}

    -

    -If this mechanism is unsuitable for your chosen class file or page style package, you -will need to redefine

    +If this mechanism is unsuitable for your chosen class file or page style package, you will need +to redefine \glsglossarymark. Further information about these options and -commands is given in . 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 -


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

    This needs to be done before the glossary is displayed. -

    If you want a different preamble per glossary you can use -


    This needs to be done before the glossary is displayed. +

    If you want a different preamble per glossary you can use +


    \setglossarypreamble  \setglossarypreamble[type]{preamble text} -

    -

    +class="cmtt-10">}


    +

    If ⟨type⟩ is omitted, \glsdefaulttype is used. -

    For example: - - +

    For example: + +

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

    This will print the given preamble text for the main glossary, but not have any -preamble text for any other glossaries. -

    There is an analogous command to

    This will print the given preamble text for the main glossary, but not have any preamble text +for any other glossaries. +

    There is an analogous command to \glossarypreamble called -



    \glossarypostamble  \glossarypostamble

    -

    +

    which is placed at the end of each glossary. -

    +

    Example 15 (Switch to Two Column Mode for Glossary) -

    Suppose you are using the +

    Suppose you are using the superheaderborder + id="dx1-53065"> style10.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: - - -

    -
    +href="#fn1x10" id="fn1x10-bk">10.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[{\chapter*{#2}}]%  
      \setlength\glsdescwidth{0.6\linewidth}% @@ -13666,167 +14166,167 @@ switch back to one column mode, you could do:  
    }  
    \renewcommand*{\glossarypostamble}{\onecolumn}
    -

    +

    -

    -

    ____________________________

    -

    Within each glossary, each entry name is formatted according to -


    +

    ____________________________

    +

    Within each glossary, each entry name is formatted according to +


    \glsnamefont  \glsnamefont{name}

    -

    -which takes one argument: the entry name. This command is always used regardless of -the glossary style. By default, \glsnamefont simply displays its argument in whatever -the surrounding font happens to be. This means that in the list-like glossary styles -(defined in the

    +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 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 and glossary-super style files) the name will appear in the normal font. -The hierarchical glossary styles (defined in the 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. + id="dx1-53074"> style file) also set the name in +bold. -

    +

    Example 16 (Changing the Font Used to Display Entry Names +class="cmbx-12"> (Changing the Font Used to Display Entry Names in the in the Glossary) -

    Suppose you want all the entry names to appear in medium weight small caps in -your glossaries, then you can do: - - +class="cmbx-12">Glossary) +

    Suppose you want all the entry names to appear in medium weight small caps in your +glossaries, then you can do: + +

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

    +

    -

    -

    ____________________________

    - - -

    -

    +

    ____________________________

    + + +

    +

    Top

    11. Xindy (Option 3)

    -

    If you want to use

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

    -
    +
    \usepackage[xindy]{glossaries}
    -

    This ensures that the glossary information is written in

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

    §1.4 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 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

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


    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.) Similarly, you can write a -percent character using: -


    \} don’t expand to +a simple brace character when written to a file.) Similarly, you can write a percent character +using: +


    \glspercentchar  \glspercentchar

    -

    +

    and a tilde character using: -



    \glstildechar  \glstildechar

    -

    +

    For example, a newline character is specified in a xindy style file using ~n so you can -use ~n so you can use +\glstildechar n to write this correctly (or you can do \string~n). A backslash -can be written to a file using -


    \string~n). A backslash can be +written to a file using +


    \glsbackslash  \glsbackslash

    -

    -

    In addition, if you are using a package that makes the double quote character -active (e.g.

    +

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

    If you want greater control over the xindy style file than is available through the @@ -13844,29 +14344,29 @@ class="cmtt-10">xindy, read the xindy documentation. I’m sorry I can’t provide any assistance with writing documentation. I’m sorry I can’t provide any assistance with writing +xindy -style files. If you need help, I recommend you ask on the style files. If you need help, I recommend you ask on the xindy mailing list (http://xindy.sourceforge.net/mailing-list.html). - - + +

    -

    Top

    11.1 Language and Encodings

    -

    When you use

    When you use xindy, you need to specify the language and encoding used (unless you have written your own custom xindy style file that defines the relevant alphabet and -sort rules). If you use style file that defines the relevant alphabet +and sort rules). If you use makeglossaries, this information is obtained from the @@ -13881,7 +14381,7 @@ language given your document settings, but in the event that it gets it wrong or class="cmtt-10">xindy doesn’t support that language, then you can specify the required language using: -



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

    -

    +class="cmtt-10">}


    +

    where ⟨language⟩ is the name of the language. The optional argument can be used if you -have multiple glossaries in different languages. If ⟨glossary type⟩ is omitted, it will be -applied to all glossaries, otherwise the language setting will only be applied to the -glossary given by ⟨language⟩ is the name of the language. The optional argument can be used if you have +multiple glossaries in different languages. If ⟨glossary type⟩ is omitted, it will be applied to all +glossaries, otherwise the language setting will only be applied to the glossary given by +⟨glossary type⟩. -

    If the

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


    . Alternatively, you can specify the encoding using: +


    \GlsSetXdyCodePage  \GlsSetXdyCodePage{code}

    -

    +

    where ⟨code⟩ is the name of the encoding. For example: - - + +

    -
    +
    \GlsSetXdyCodePage{utf8}
    -

    -

    Note that you can also specify the language and encoding using the package option +

    +

    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: - - + id="dx1-55011"> style file that includes the language settings, you need +to set the language to nothing: + +

    -
    +
    \GlsSetXdyLanguage{}
    -

    (and remember to use

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

    The commands

    The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have no effect if you don’t use xindy without makeglossaries you need -to remember to set the language and encoding using the 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

    If you use xindy, the glossaries package needs to know which counters you will be using -in the glossaries package needs to know which counters you will be using in the +number list in order to correctly format the xindy style file. Counters specified -using the 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 are automatically taken +care of, but if you plan to use a different counter in the counter -key for commands like key for commands +like \glslink, then you need to identify these counters before -before \makeglossaries using: -


    +using: +


    \GlsAddXdyCounters  \GlsAddXdyCounters{counter list}

    -

    +

    where ⟨counter list⟩ is a comma-separated list of counter names. -

    The most likely attributes used in the

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


    style file, but if you want to use another attribute, you need to add it +using: +


    \GlsAddXdyAttribute  \GlsAddXdyAttribute{name}

    -

    +

    where ⟨name⟩ is the name of the attribute, as used in the format key. -

    Example 17 (Custom Font for Displaying a Location) -

    Suppose I want a bold, italic, hyperlinked location. I first need to define a -command that will do this: - - +

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that +will do this: + +

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

    but with

    but with xindy, I also need to add this as an allowed attribute: - - + +

    -
    +
    \GlsAddXdyAttribute{hyperbfit}
    -

    Now I can use it in the optional argument of commands like

    Now I can use it in the optional argument of commands like \gls: - - + +

    -
    +
    Here is a \gls[format=hyperbfit]{sample} entry.
    -

    (where

    (where sample is the label of the required entry).

    -

    -

    ____________________________

    -

    Note that

    +

    ____________________________

    +

    Note that \GlsAddXdyAttribute has no effect if \noist is used or if - is used or if \makeglossaries is omitted. \GlsAddXdyAttribute must be used before - is +omitted. \GlsAddXdyAttribute must be used before \makeglossaries. Additionally, \GlsAddXdyCounters must come before + id="dx1-56022">. Additionally, \GlsAddXdyCounters must come before \GlsAddXdyAttribute.
    -

    -

    If the location numbers include formatting commands, then you need to add a -location style in the appropriate format using -


    +

    If the location numbers include formatting commands, then you need to add a location +style in the appropriate format using +


    \GlsAddXdyLocation  }{definition}

    -

    +

    where ⟨name⟩ is the name of the format and ⟨definition⟩ is the xindy -definition. The optional argument ⟨prefix-location⟩ is needed if - definition. The optional +argument ⟨prefix-location⟩ is needed if \theHcounter⟩ either isn’t defined or is different from counter⟩ either isn’t defined or is different +from \thecounter⟩. (See also -counter⟩. (See also \glsaddprotectedpagefmt described in §5 Number lists.) -

    Note that Number +lists.) +

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

    +

    -

    Example 18 (Custom Numbering System for Locations) -

    Suppose I decide to use a somewhat eccentric numbering system for sections where -I redefine

    Suppose I decide to use a somewhat eccentric numbering system for sections where I +redefine \thesection as follows: - - + +

    -
    +
    \renewcommand*{\thesection}{[\thechapter]\arabic{section}}
    -

    If I haven’t done counter=section in the package option, I need to specify that the -counter will be used as a location number: - - +

    If I haven’t done counter=section in the package option, I need to specify that the counter +will be used as a location number: + +

    -
    +
    \GlsAddXdyCounters{section}
    -

    Next I need to add the location style (

    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

    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

    then I need to modify the \GlsAddXdyLocation code above to: - - + +

    -
    +
    \GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["  
      "arabic-numbers" :sep "]" "arabic-numbers"  
    }
    -

    Since

    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: - - + id="dx1-56032"> will result in an empty string if the counter is zero, it’s a good idea to add an +extra location to catch this: + +

    -
    +
    \GlsAddXdyLocation{zero.section}{:sep "["  
      "arabic-numbers" :sep "]" "arabic-numbers"  
    }
    -

    This example is illustrated in the sample file

    This example is illustrated in the sample file samplexdy2.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 19 (Locations as Words not Digits) -

    Suppose I want the page numbers written as words rather than digits and I use -the

    Suppose I want the page numbers written as words rather than digits and I use the +fmtcount package to do this. I can redefine \thepage as follows: - - + +

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

    This gets expanded to

    This gets expanded to \protect \Numberstringnum {n} where ⟨n⟩ is the Arabic -page number. This means that I need to define a new location that has that -form: - - +class="cmti-10">n⟩ is the Arabic page +number. This means that I need to define a new location that has that form: + +

    -
    +
    \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space  
      \string\Numberstringnum\space\glsopenbrace"  
      "arabic-numbers" :sep "\glsclosebrace"}
    -

    Note that it’s necessary to use \space to indicate that spaces also appear -in the format, since, unlike T

    Note that it’s necessary to use \space to indicate that spaces also appear in the format, +since, unlike TEX, xindy doesn’t ignore spaces after control -sequences. -

    Note that doesn’t ignore spaces after control sequences. +

    Note that \GlsAddXdyLocation{name}{definition} will define commands in the form: -



    \glsXcounterXHprefix}{location}

    -

    +

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

    The first argument ⟨

    The first argument ⟨Hprefix⟩ is only relevant when used with the hyperref package -and indicates that package and +indicates that \theHcounter⟩ is given by \Hprefixsamplexdy.tex, which comes with the glossaries package, uses the default page -counter for locations, and it uses the default counter for +locations, and it uses the default \glsnumberformat and a custom -\hyperbfit format. A new 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 -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: - - +class="cmti-10">format⟩ +commands: + +

    -
    +
    \renewcommand{\glsXpageXglsnumberformat}[2]{%  
     \linkpagenumber#2%  
    } @@ -14326,53 +14820,52 @@ class="cmti-10">format⟩ 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: -, the locations are sorted according to type. The default +ordering is: roman-page-numbers (e.g. i), arabic-page-numbers (e.g. 1), arabic-section-numbers -(e.g. 1.1 if the compositor is a full stop or 1-1 if the compositor is a +class="cmtt-10">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 hyphen11.111.1), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), +class="cmtt-10">Roman-page-numbers (e.g. I), Alpha-page-numbers (e.g. A), 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 -hyphen11.2Appendix-page-numbers (e.g. A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor +is a hyphen11.2), user defined location names (as specified by \GlsAddXdyLocation in the order in -which they were defined), 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: - - +

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

    -
    +
    \GlsSetXdyLocationClassOrder{  
      "arabic-page-numbers"  
      "arabic-section-numbers" @@ -14384,8 +14877,8 @@ space. For example:  
      "see"  
    }
    -

    -

    Note that

    +

    Note that \GlsSetXdyLocationClassOrder has no effect if \noist is used or if @@ -14396,38 +14889,37 @@ class="cmtt-10">\GlsSetXdyLocationClassOrder must be used before \makeglossaries.
    -

    -

    If a

    +

    If a number list consists of a sequence of consecutive numbers, the range will be -concatenated. The number of consecutive locations that causes a range formation -defaults to 2, but can be changed using: - - -

    \GlsSetXdyMinRangeLength  -



    \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 manual for further details on range formations. +

    Note that \GlsSetXdyMinRangeLength has no effect if \noist is used or if @@ -14438,63 +14930,62 @@ class="cmtt-10">\GlsSetXdyMinRangeLength must be used before \makeglossaries.
    -

    -

    See

    +

    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 -

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

    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

    +

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

    - - +

    + +

    -

    -

    +

    Top

    12. Defining New Glossaries

    -

    A new glossary can be defined using: -


    A new glossary can be defined using: +


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

    -

    +

    where ⟨name⟩ is the label to assign to this glossary. The arguments ⟨in-ext⟩ and ⟨out-ext⟩ -specify the extensions to give to the input and output files for that glossary, ⟨title⟩ is the -default title for this new glossary and the final optional argument ⟨counter⟩ -specifies which counter to use for the associated out-ext⟩ specify +the extensions to give to the input and output files for that glossary, ⟨title⟩ is the default title +for this new glossary and the final optional argument ⟨counter⟩ specifies which counter to use +for the associated number lists (see also §5 -Number lists). The first optional argument specifies the extension for the -§5 Number lists). The first optional argument +specifies the extension for the makeindex (Option 2) or xindy (Option 3) transcript file (this information -is only used by Option 3) transcript file (this +information is only used by makeglossaries which picks up the information from the @@ -14548,16 +15038,16 @@ class="cmti-10">log-ext⟩, ⟨in-ext⟩ and ⟨out-ext⟩ arguments are ignored. -

    The glossary label ⟨name⟩ must not contain any active characters. It’s generally -best to stick with just characters that have category code 11 (typically the -non-extended Latin character

    -

    -

    There is also a starred version (new to v4.08): -


    +

    There is also a starred version (new to v4.08): +


    \newglossary*  title}[counter]

    -

    +

    which is equivalent to

    counter]
    or you can also use: -



    \altnewglossary  }{title}[counter] -

    -

    +class="cmtt-10">]


    +

    which is equivalent to

    counter]
    -

    It may be that you have some terms or acronyms that are so common -that they don’t need to be listed. In this case, you can define a special type -of glossary that doesn’t create any associated files. This is referred to as -an “ignored glossary” and it’s ignored by commands that iterate over all -the glossaries, such as

    It may be that you have some terms that are so common that they don’t need to be listed. +In this case, you can define a special type of glossary that doesn’t create any associated files. +This is referred to as an “ignored glossary” and it’s ignored by commands that iterate +over all the glossaries, such as \printglossaries. To define an ignored glossary, use - - -



    \newignoredglossary  \newignoredglossary{name}

    -

    +

    where ⟨name⟩ is the name of the glossary (as above). This glossary type will -automatically be added to the name⟩ is the name of the glossary (as above). This glossary type will automatically be + + +added to the nohypertypes list, since there are no hypertargets for the -entries in an ignored glossary. (The sample file list, since there are no hypertargets for the entries in +an ignored glossary. (The sample file sample-entryfmt.tex defines an -ignored glossary.) -

    You can test if a glossary is an ignored one using: -


    sample-entryfmt.tex defines an ignored +glossary.) +

    You can test if a glossary is an ignored one using: +


    \ifignoredglossary  true}{false}

    -

    +

    This does ⟨true⟩ if ⟨name⟩ was defined as an ignored glossary, otherwise it does -⟨name⟩ was defined as an ignored glossary, otherwise it does ⟨false⟩. -

    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

    so it can be identified by the label main (unless the nomain package option is used). -Using the 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

    so it can be identified by the label acronym. If you are not sure whether the acronym @@ -14705,53 +15192,51 @@ class="cmtt-9"> \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 + id="dx1-58017"> option has been used, +otherwise it is set to main. Note that if you are using the main glossary as your list of +acronyms, you need to declare it as a list of acronyms using the package option acronymlists. -

    The

    The symbols package option creates a new glossary with the label symbols -using: - - +class="cmtt-10">symbols using: + +

    -
    +
    \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
    -

    The

    The numbers package option creates a new glossary with the label numbers -using: - - +class="cmtt-10">numbers using: + +

    -
    +
    \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
    -

    The

    The index package option creates a new glossary with the label index using: - - + +

    -
    +
    \newglossary[ilg]{index}{ind}{idx}{\indexname}
    -

    -

    Options 

    +

    Options 2 and 3: all glossaries must be defined before \makeglossaries to -ensure that the relevant output files are opened. -

    See to ensure that +the relevant output files are opened. +

    See §1.3.1 Changing the Fixed Names if you want to redefine babel or translator. (Similarly for \glssymbolsgroupname -and \glssymbolsgroupname and +\glsnumbersgroupname.) If you want to redefine \indexname, just follow the -advice in How to change LaTeX’s “fixed names”.

    -

    - - -

    -

    -

    , just follow the advice in How +to change LaTeX’s “fixed names”.

    +

    + + +

    +

    +

    Top

    13. Acronyms and Other Abbreviations

    -

    Note that although this chapter uses the term “acronym”, you can also use the -commands described here for abbreviations or contractions (as in the case of some of -the examples given below). If the glossary title is no longer applicable (for example, it +

    Note that although this chapter uses the term “acronym”, you can also use the +commands described here for initialisms or contractions (as in the case of some of the +examples given below). If the glossary title is no longer applicable (for example, it should be “Abbreviations” rather than “Acronyms”) then you can change the title either by redefining \acronymname (see §1.3 Multi-Lingual Support) or by using -the Multi-Lingual Support) or by using the +title in the optional argument of \printglossary (or \printacronym). -
    -

    -

    You may have noticed in ). You may +prefer to use the glossaries-extra package which defines \newabbreviation and treats +acronyms (e.g. “laser”) differently from other forms of abbreviations (e.g. “html”). +

    +

    +

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


    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 abbreviations. For convenience, the glossaries package +defines the command: +


    \newacronym  }{abbrv}{long} -

    -

    -

    This uses }


    +

    +

    This uses \newglossaryentry to create an entry with the given label in the -glossary given by to create an entry with the given label in the glossary given +by \acronymtype. You can specify a different glossary using the type -key within the optional argument. The key within the optional +argument. The \newacronym command also uses the long, -, longplural, short and shortplural keys in \newglossaryentry to store the long and -abbreviated forms and their plurals. -

    If you haven’t identified the specified glossary type as a list of acronyms (via the -package option +keys in \newglossaryentry to store the long and abbreviated forms and their +plurals. +

    If you haven’t identified the specified glossary type as a list of acronyms (via +the package option acronymlists or the command \DeclareAcronymList, see §2.5 Acronym -Options) §2.5 +Acronym Options) \newacronym will add it to the list and reset the display style for that -glossary via reset the display style +for that glossary via \defglsentryfmt. If you have a mixture of acronyms and regular entries -within the same glossary, care is needed if you want to change the display -style: you must first identify that glossary as a list of acronyms and then use -. If you have a mixture of acronyms and +regular entries within the same glossary, care is needed if you want to change the +display style: you must first identify that glossary as a list of acronyms and then +use \defglsentryfmt (not redefine \glsentryfmt) before defining your entries.
    -

    -

    The optional argument

    +

    The optional argument {key-val list} allows you to specify keys such as description -(when used with one of the styles that require a description, described in (when +used with one of the styles that require a description, described in §13.1 -Changing the Acronym Style) or you can override plural forms of ⟨§13.1 Changing the +Abbreviation Style) or you can override plural forms of ⟨abbrv⟩ or ⟨long⟩ using -the long⟩ using the shortplural or 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). If you want to use the shortplural keys, I recommend you use \setacronymstyle to set the display style rather than using one of the pre-version -4.02 acronym styles. -

    Since to set the display style rather than using one of the pre-version 4.02 +acronym styles. +

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

    Since

    Since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using [type]{filename}, the optional -argument ⟨type⟩ will not have an effect unless you explicitly set the type as -type=\glsdefaulttype in the optional argument to }, the optional argument ⟨type⟩ +will not have an effect unless you explicitly set the type as type=\glsdefaulttype +in the optional argument to \newacronym. See §4.8 Loading -Entries From a File.
    -

    +href="#sec:loadglsentries">Loading Entries From a File. +

    +

    -

    Example 20 (Defining an Abbreviation) -

    The following defines the abbreviation IDN: - - +

    The following defines the abbreviation IDN: + +

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

    \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on -subsequent uses. If you want to use one of the smallcaps acronym styles, described in -§13.1 Changing the Acronym Style, you need to use lower case characters for the -shortened form: - - +class="cmsy-10">§13.1 +Changing the Abbreviation Style, you need to use lower case characters for the shortened +form: + +

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

    Now

    Now \gls{idn} will produce “identification number (in” on subsequent uses.

    -

    -

    ____________________________

    -

    The commands described below are similar to the

    +

    ____________________________

    +

    Recall from the warning in §4 Defining Glossary Entries that you should avoid using the +\gls-like and \glstext-like commands in -that they don’t modify the first use flag. However, their display is governed by +class="cmtt-10">\glstext-like commands within the value of keys like text and first due to +complications arising from nested links. The same applies to abbreviations defined using \newacronym. +

    For example, suppose you have defined: + + +

    +
    +\newacronym{ssi}{SSI}{server side includes} + 
    \newacronym{html}{HTML}{hypertext markup language} +
    +

    you may be tempted to do: + + +

    +
    +\newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}} +
    +

    Don’t! This will break the case-changing commands, such as \Gls, it will cause +inconsistencies on first use, and, if hyperlinks are enabled, will cause nested hyperlinks. It will +also confuse the commands used by the entry formatting (such as \glslabel). +

    Instead, consider doing: + + +

    +
    +\newacronym + 
     [description={\gls{ssi} enabled \gls{html}}] + 
     {shtml}{SHTML}{SSI enabled HTML} +
    +

    or + + +

    +
    +\newacronym + 
     [description={\gls{ssi} enabled \gls{html}}] + 
     {shtml}{SHTML} + 
     {server side includes enabled hypertext markup language} +
    +

    Similarly for the \glstext-like commands. +

    The commands described below are similar to the \glstext-like commands in that they +don’t modify the first use flag. However, their display is governed by \defentryfmt with with +\glscustomtext set as appropriate. All caveats that -apply to the set as appropriate. All caveats that apply to the \glstext-like commands also apply to the following commands. +class="cmtt-10">\glstext-like commands +also apply to the following commands. (Including the warning immediately above this box.)
    -

    -

    The optional arguments are the same as those for the

    +

    The optional arguments are the same as those for the \glstext-like commands, -and there are similar star and plus variants that switch off or on the hyperlinks. As -with the \glstext-like commands, the link text is placed in the argument of + id="dx1-59038"> is placed in the argument of \glstextformat. -


    . +


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

    -

    +

    This sets the link text to the short form (within the argument of to the short form (within the argument of \acronymfont) for -the entry given by ⟨) for the entry +given by ⟨label⟩. The short form is as supplied by the short key, which - key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -


    implicitly +sets. +

    There are also analogous upper case variants: +


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

    -

    -


    +


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

    -

    +

    There are also plural versions: -



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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    The short plural form is as supplied by the shortplural key, which key, which \newacronym -implicitly sets. -


    implicitly +sets. +


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

    - - -

    +

    This sets the link text to the long form for the entry given by ⟨label⟩. The long form is -as supplied by the to the long form for the entry given by ⟨label⟩. The long form is as +supplied by the long key, which key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -


    implicitly sets. + + +

    There are also analogous upper case variants: +


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

    -

    -


    +


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

    -

    +

    Again there are also plural versions: -



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

    -

    -


    +


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

    -

    -


    +


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

    -

    +

    The long plural form is as supplied by the longplural key, which key, which \newacronym -implicitly sets. -

    The commands below display the full form of the acronym, but note that -this isn’t necessarily the same as the form used on first use. These full-form -commands are shortcuts that use the above commands, rather than creating -the implicitly +sets. +

    The commands below display the full form of the acronym, but note that this isn’t +necessarily the same as the form used on first use. These full-form commands are shortcuts +that use the above commands, rather than creating the link text from the complete full form. These full-form commands have -star and plus variants and optional arguments that are passed to the above -commands. -


    from the complete full form. +These full-form commands have star and plus variants and optional arguments that are +passed to the above commands. +


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

    -

    +

    This is a shortcut for -



    \acrfullfmt  \acrfullfmt{options}{label}{insert}

    -

    +

    which by default does

    }}
    where -



    \acrfullformat  \acrfullformat{long}{short}

    -

    +

    by default does ⟨long⟩ (⟨short⟩). (For further details of these format commands see the documented code, glossaries-code.pdf.) -

    There are also analogous upper case variants: -


    There are also analogous upper case variants: +


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

    - - -

    -


    +


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

    -

    +

    and plural versions: -



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

    -

    -


    +


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

    -

    -


    +


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

    -

    -

    If you find the above commands too cumbersome to write, you can use the -

    +

    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 - +package option to activate the shorter command names listed in table 13.1.

    - - -


    - - + +
    Table 13.1: Synonyms provided by the package option shortcuts
    +class="cmss-10">shortcuts
    Equivalent Command style="vertical-align:baseline;" id="TBL-7-2-"> + id="dx1-59075"> + id="dx1-59077"> + id="dx1-59079"> + id="dx1-59081"> + id="dx1-59083"> + id="dx1-59085"> + id="dx1-59087"> + id="dx1-59089"> + id="dx1-59091"> + id="dx1-59093"> + id="dx1-59095"> + id="dx1-59097"> + id="dx1-59099"> + id="dx1-59101"> + id="dx1-59103">
    \acs \acrshort
    \Acs \Acrshort
    \acsp \acrshortpl
    \Acsp \Acrshortpl
    \acl \acrlong
    \Acl \Acrlong
    \aclp \acrlongpl
    \Aclp \Acrlongpl
    \acf \acrfull
    \Acf \Acrfull
    \acfp \acrfullpl
    \Acfp \Acrfullpl
    \ac \gls
    \Ac \Gls
    \acp \glspl
    \Acp \Glspl
    + id="dx1-59105">
    - - + +

    -

    It is also possible to access the long and short forms without adding information to -the glossary using commands analogous to

    It is also possible to access the long and short forms without adding information to the +glossary using commands analogous to \glsentrytext (described in (described in §9 Using -Glossary Terms Without Links). -

    The commands that convert the first letter to upper case come with the same -caveats as those for analogous commands like Using Glossary Terms +Without Links). +

    The commands that convert the first letter to upper case come with the same caveats as +those for analogous commands like \Glsentrytext (non-expandable, -can’t be used in PDF bookmarks, care needs to be taken if the first letter is -an accented character etc). See (non-expandable, can’t be used in PDF +bookmarks, care needs to be taken if the first letter is an accented character etc). See §9 Using Glossary Terms Without Links. -
    -

    -

    The long form can be accessed using: -


    +

    +

    The long form can be accessed using: +


    \glsentrylong  \glsentrylong{label}

    -

    +

    or, with the first letter converted to upper case: -



    \Glsentrylong  \Glsentrylong{label}

    -

    +

    Plural forms: -



    \glsentrylongpl  \glsentrylongpl{label}

    -

    -


    +


    \Glsentrylongpl  \Glsentrylongpl{label}

    -

    -

    Similarly, to access the short form: -


    +

    Similarly, to access the short form: +


    \glsentryshort  \glsentryshort{label}

    -

    +

    or, with the first letter converted to upper case: -



    \Glsentryshort  \Glsentryshort{label}

    -

    +

    Plural forms: -



    \glsentryshortpl  \glsentryshortpl{label}

    -

    -


    +


    \Glsentryshortpl  \Glsentryshortpl{label}

    -

    -

    And the full form can be obtained using: -


    +

    And the full form can be obtained using: +


    \glsentryfull  \glsentryfull{label}

    -

    -


    +


    \Glsentryfull  \Glsentryfull{label}

    -

    -


    +


    \glsentryfullpl  \glsentryfullpl{label}

    - - -

    -


    +


    \Glsentryfullpl  \Glsentryfullpl{label}

    -

    +

    These again use \acrfullformat by default, but the format may be redefined by the + id="dx1-59120"> by default, but the format may be redefined by the acronym style.

    -

    Top

    13.1 Changing the Acronym Style

    -

    It may be that the default style doesn’t suit your requirements in which case you can -switch to another styles using -


    Changing the Abbreviation Style +

    It may be that the default style doesn’t suit your requirements in which case you can switch +to another styles using +


    \setacronymstyle  \setacronymstyle{style name}

    -

    +

    where ⟨style name⟩ is the name of the required style. -

    You must use

    You must use \setacronymstyle before you define the acronyms with +class="cmti-10">before you define the acronyms with \newacronym. If +you have multiple glossaries representing lists of acronyms, you must use \setacronymstyle \newacronym. If you have multiple glossaries representing lists of acronyms, you must -use \setacronymstyle after using \DeclareAcronymList.
    -

    -

    Note that unlike the default behaviour of \newacronym, the styles used -via

    +

    The glossaries package has the restriction that only one style may be in use that +applies to all entries defined with \newacronym. If you need multiple abbreviation +styles, then try using the glossaries-extra package, which has better abbreviation +management. +

    Note that unlike the default behaviour of \newacronym, the styles used via +\setacronymstyle don’t use the first or text keys, but instead they use - keys, but instead they use \defglsentryfmt to set a custom format that uses the to +set a custom format that uses the long and short keys (or their -plural equivalents). This means that these styles cope better with plurals that aren’t -formed by simply appending the singular form with the letter “s”. In fact, most of the -predefined styles use keys (or their plural equivalents). This +means that these styles cope better with plurals that aren’t formed by simply appending the +singular form with the letter “s”. In fact, most of the predefined styles use \glsgenacfmt and modify the definitions of commands like - and +modify the definitions of commands like \genacrfullformat. -

    Note that when you use

    Note that when you use \setacronymstyle the name key is set to -



    \acronymentry  \acronymentry{label}

    -

    +

    and the sort key is set to -



    \acronymsort  short}{long}

    -

    -These commands are redefined by the acronym styles. However, you can redefine them -again after the style has been set but before you use \newacronym. Protected -expansion is performed on

    +These commands are redefined by the acronym styles. However, you can redefine them again +after the style has been set but before you use \newacronym. Protected expansion is +performed on \acronymsort when the entry is defined. -

    +

    -

    Top

    13.1.1 Predefined Acronym Styles

    -

    The glossaries package provides a number of predefined styles. These styles -apply -


    The glossaries package provides a number of predefined styles. These styles apply + + +


    \firstacronymfont  \firstacronymfont{text}

    - - -

    +

    to the short form on first use and -



    \acronymfont  \acronymfont{text}

    -

    +

    on subsequent use. The styles modify the definition of \acronymfont as required, but \acronymfont{text}. If you want the short -form displayed differently on first use, you can redefine }. If you want the short form +displayed differently on first use, you can redefine \firstacronymfont -independently of the acronym style. -

    The predefined styles that contain independently of the +acronym style. +

    The predefined styles that contain sc in their name (for example long-sc-short) -redefine ) redefine +\acronymfont to use \textsc, which means that the short form needs to be -specified in lower case. -

    , which means that the short form needs to be specified in lower +case. +

    -

    Some fonts don’t support bold smallcaps, so you may need to redefine -

    Some fonts don’t support bold smallcaps, so you may need to redefine \glsnamefont (see (see +§10 Displaying a glossary) to switch to medium weight if you are -using a glossary style that displays entry names in bold and you have chosen an -acronym style that uses Displaying a glossary) to switch to medium weight if you are using a glossary style that +displays entry names in bold and you have chosen an acronym style that uses \textsc.
    -

    -

    The predefined styles that contain . +

    +

    +

    The predefined styles that contain sm in their name (for example long-sm-short) -redefine ) redefine +\acronymfont to use \textsmaller. -

    -

    Note that the

    Note that the glossaries package doesn’t define or load any package that defines \textsmaller. If you use one of the acronym styles that set \acronymfont to -\textsmaller you must explicitly load the to \textsmaller +you must explicitly load the relsize package or otherwise define - package or otherwise define \textsmaller.
    -

    -

    The remaining predefined styles redefine

    +

    The remaining predefined styles redefine \acronymfont{text} to simply do its -argument ⟨} to simply do its argument +⟨text⟩. -

    In most cases, the predefined styles adjust

    In most cases, the predefined styles adjust \acrfull and \glsentryfull (and -their plural and upper case variants) to reflect the style. The only exceptions to this -are the (and their +plural and upper case variants) to reflect the style. The only exceptions to this are the dua and +and footnote styles (and their variants).
    -

    -

    The following styles are supplied by the

    +

    The following styles are supplied by the glossaries package:

    • long-sm-short, long-sp-short: -

      With these three styles, acronyms are displayed in the form -


      With these three styles, acronyms are displayed in the form +


      long(\firstacronymfont{short})

      -

      +

      on first use and -



      \acronymfont{short}

      - - -

      + + +

      on subsequent use. They also set \acronymsort{short}{long} to just - ⟨short⟩. This means that the acronyms are sorted according to their short - form. In addition, } to just ⟨short⟩. This + means that the acronyms are sorted according to their short form. In addition, + \acronymentry{label} is set to just the short form - (enclosed in \acronymfont) and the } is set to just the short form (enclosed in \acronymfont) and the + description key is set to the long - form. -

      The key is set to the long form. +

      The long-sp-short style was introduced in version 4.16 and uses -



      \glsacspace  \glsacspace{label}

      -

      - for the space between the long and short forms. This defaults to a non-breakable - space (

      + for the space between the long and short forms. This defaults to a non-breakable space + (~) if (\acronymfont{short}) is less than 3em, otherwise it uses a normal - space. This may be redefined as required. For example, to always use - a non-breakable space: - - +class="cmtt-10">}) is less than 3em, otherwise it uses a normal space. This + may be redefined as required. For example, to always use a non-breakable + space: + +

      -
      +
      \renewcommand*{\glsacspace}[1]{~}
      -

      +

    • short-longsc-short-long, sm-short-long: -

      These three styles are analogous to the above three styles, except the display - order is swapped to -


      These three styles are analogous to the above three styles, except the display order is + swapped to +


      \firstacronymfont{short} (long)

      -

      +

      on first use. -

      Note, however, that

      Note, however, that \acronymsort and \acronymentry are the same as for the - ⟨long⟩ (⟨ are the same as for the ⟨long⟩ + (⟨short⟩) styles above, so the acronyms are still sorted according to the short form.

    • @@ -15920,7 +16472,7 @@ class="cmss-10">long-sm-short-desc, long-sp-short-desc: -

      These are like the

      These are like the long-short, long-sc-shortlong-sc-shortlong-sm-short and long-sp-short styles - described above, except that the + styles described above, except that the description key must be supplied in the optional - argument of key must be supplied in the + optional argument of \newacronym. They also redefine \acronymentryshort}{long} to just ⟨long⟩. - This means that the acronyms are sorted according to the long form, and - in the list of acronyms the name field has the long form followed by - the short form in parentheses. I recommend you use a glossary style - such as long⟩. This + means that the acronyms are sorted according to the long form, and in the list of + acronyms the name field has the long form followed by the short form in parentheses. + I recommend you use a glossary style such as altlist with these acronym styles to allow for the long name - field. + id="dx1-61047"> with these acronym styles to allow + for the long name field.

    • short-long-descsc-short-long-desc, sm-short-long-desc: -

      These styles are analogous to the above three styles, but the first use display - style is: -


      These styles are analogous to the above three styles, but the first use display style + is: +


      \firstacronymfont{short} (long)

      -

      +

      The definitions of \acronymsort and \acronymentry are the same as those for @@ -15988,37 +16539,36 @@ class="cmss-10">dua, dua-desc: - - -

      With these styles, the

      With these styles, the \gls-like commands always display the long form - regardless of whether the entry has been used or not. However, \gls-like commands always display the long form regardless of + whether the entry has been used or not. However, \acrfull and - and \glsentryfull will display ⟨ will + display ⟨long⟩ (\acronymfont{short}). In the case of dua, the - , the name and sort keys are set to the short form and the description is set to the - long form. In the case of keys are set + to the short form and the description is set to the long form. In the case of dua-desc, the , the + name and sort keys are set to the - long form and the description is supplied in the optional argument of - keys are set to the long form and the description is supplied in the + optional argument of \newacronym.

    • @@ -16029,10 +16579,10 @@ class="cmss-10">footnote-sc, footnote-sm: -

      With these three styles, on first use the

      With these three styles, on first use the \gls-like commands display: -



      \firstacronymfont{short}\footnote}\footnote{⟨long}

      -

      +

      However, \acrfull and \glsentryfull\acronymfont{⟨short} (⟨long⟩). - On subsequent use the display is: -


      long⟩). On + subsequent use the display is: +


      \acronymfont{short}

      -

      +

      The sort and name keys are set to the short form, and the description is set to the - long form. -

      In order to avoid nested hyperlinks on first use the footnote styles - automatically implement is set to the long + form. +

      In order to avoid nested hyperlinks on first use the footnote styles automatically + implement hyperfirst=false for the acronym lists.
      -

      +

    • footnote-descfootnote-sc-desc, footnote-sm-desc: -

      These three styles are similar to the previous three styles, but the description +

      These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The name key is - set to the long form followed by the short form in parentheses and the key + is set to the long form followed by the short form in parentheses and the + sort key is - set to the long form. This means that the acronyms will be sorted according to - the long form. In addition, since the key is set to the long form. This means that the acronyms will be sorted + according to the long form. In addition, since the name will typically be quite wide it’s - best to choose a glossary style that can accommodate this, such as + id="dx1-61079"> will typically be quite + wide it’s best to choose a glossary style that can accommodate this, such as altlist. @@ -16099,73 +16649,71 @@ class="cmss-10">altlist

    -

    Example 21 (Adapting a Predefined Acronym Style) -

    Suppose I want to use the

    Suppose I want to use the footnote-sc-desc style, but I want the name -key set to the short form followed by the long form in parentheses and the - key set to the short +form followed by the long form in parentheses and the sort key set to the short form. Then I need to specify the key set to the short form. Then I +need to specify the footnote-sc-desc -style: - - + id="dx1-61086"> style: + +

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    and then redefine

    and then redefine \acronymsort and \acronymentry: - - + +

    -
    +
    \renewcommand*{\acronymsort}[2]{#1}% sort by short form  
    \renewcommand*{\acronymentry}[1]{%  
      \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%
    -

    (I’ve used \space for extra clarity, but you can just use an actual space -instead.) -

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also -going to redefine

    (I’ve used \space for extra clarity, but you can just use an actual space instead.) +

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to +redefine \acronymfont so that it always switches to medium weight to ensure -the smallcaps setting is used: - - + id="dx1-61089"> so that it always switches to medium weight to ensure the smallcaps +setting is used: + +

    -
    +
    \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}}
    -

    This isn’t necessary if you use a font that supports bold smallcaps. -

    The sample file

    This isn’t necessary if you use a font that supports bold smallcaps. +

    The sample file sampleFnAcrDesc.tex illustrates this example.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.1.2 Defining A Custom Acronym Style

    -

    You may find that the predefined acronyms styles that come with the

    You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style using: -



    \newacronymstyle  }{definitions}

    -

    +

    where ⟨style name⟩ is the name of the new style (avoid active characters). The second argument, ⟨display⟩, is equivalent to the mandatory argument of \defglsentryfmt. -You can simply use . You can +simply use \glsgenacfmt or you can customize the display using commands -like or you can customize the display using commands like +\ifglsused, \glsifplural\glscapscase. (See §6.3 Changing the format of -the link text for further details.) If the style is likely to be used with a mixed +href="#sec:glsdisplay">Changing the format +of the link text for further details.) If the style is likely to be used with a mixed glossary (that is entries in that glossary are defined both with \newacronym and \newglossaryentry) then you can test if the entry is an acronym and use -) then you can test if the entry is an acronym and use \glsgenacfmt if it is or if it +is or \glsgenentryfmt if it isn’t. For example, the long-short style -sets ⟨display⟩ as - - + id="dx1-62011"> style sets ⟨display⟩ +as + +

    -
    +
    \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
    -

    (You can use

    (You can use \ifglshasshort instead of \ifglshaslong to test if the entry is an -acronym if you prefer.) -

    The third argument, ⟨definitions⟩, can be used to redefine the commands that affect -the display style, such as to test if the entry is an acronym if +you prefer.) +

    The third argument, ⟨definitions⟩, can be used to redefine the commands that affect the +display style, such as \acronymfont or, if ⟨display⟩ uses \glsgenacfmt, -\glsgenacfmt, \genacrfullformat and its variants. -

    Note that +and its variants. +

    Note that \setacronymstyle redefines \glsentryfull\acrfullfmt to use \genacrfullformat (and similarly for the plural and upper case variants). If this -isn’t appropriate for the style (as in the case of styles like (and similarly for the plural and upper case variants). If this isn’t +appropriate for the style (as in the case of styles like footnote and dua) -\newacronymstyle should redefine these commands within ⟨) \newacronymstyle +should redefine these commands within ⟨definitions⟩. -

    Within

    Within \newacronymstyle’s ⟨definitions⟩ argument you can also redefine -



    \GenericAcronymFields  \GenericAcronymFields

    -

    +

    This is a list of additional fields to be set in \newacronym. You can use the -following token registers to access the entry label, long form and short form: -. You can use the following token +registers to access the entry label, long form and short form: \glslabeltok \glslabeltok, \glslabeltok, +\glslongtok \glslongtok and \glsshorttok \glsshorttok. -As with all TEX registers, you can access their values by preceding the register with -\glsshorttok. As with all TEX registers, you +can access their values by preceding the register with \the. For example, the long-short style does: - - + id="dx1-62028"> style +does: + +

    -
    +
    \renewcommand*{\GenericAcronymFields}{%  
       description={\the\glslongtok}}%
    -

    which sets the

    which sets the description field to the long form of the acronym whereas the - field to the long form of the acronym whereas the long-short-desc style does: - - + id="dx1-62030"> +style does: + +

    -
    +
    \renewcommand*{\GenericAcronymFields}{}%
    -

    since the description needs to be specified by the user. -

    It may be that you want to define a new acronym style that’s based on an existing -style. Within ⟨

    since the description needs to be specified by the user. +

    It may be that you want to define a new acronym style that’s based on an existing style. +Within ⟨display⟩ you can use -

    \GlsUseAcrEntryDispStyle  -



    \GlsUseAcrEntryDispStyle{style name}

    -

    +

    to use the ⟨display⟩ definition from the style given by ⟨style name⟩. Within ⟨definitions⟩ -you can use -


    definitions⟩ you can +use +


    \GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs{style name}

    -

    +

    to use the ⟨definitions⟩ from the style given by ⟨style name⟩. For example, the -style name⟩. For example, the long-sc-short acronym style is based on the +acronym style is based on the long-short style with minor modifications -(remember to use ## instead of style with minor modifications (remember to use ## +instead of # within ⟨definitions⟩): - - + +

    -
    +
    \newacronymstyle{long-sc-short}%  
    {% use the same display as "long-short"  
      \GlsUseAcrEntryDispStyle{long-short}% @@ -16358,27 +16906,27 @@ class="cmti-10">definitions⟩):  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
    }
    -

    (

    (\glstextup \glstextup is used to cancel the effect of \textsc. This defaults to -. This defaults to \textulc, if defined, otherwise , +if defined, otherwise \textup. For example, the plural of svm should be -rendered as m should be rendered as svms rather than ms +rather than svms.) -

    Example 22 (Defining a Custom Acronym Style) -

    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

    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: @@ -16426,17 +16973,17 @@ class="cmti-10">long⟩ (⟨short⟩) ⟨description
    -

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the -second argument of

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second +argument of \newacronymstyle using: - - + +

    -
    +
    \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
    -

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use \glsgenacfmt. The third argument (⟨definitions⟩) of \newacronymstyle needs to -redefine needs to redefine +\genacrfullformat etc so that the first use displays the short form in the -text with the long form in a footnote followed by the description. This is done as -follows (remember to use ## instead of first use displays the short form in the text with the long +form in a footnote followed by the description. This is done as follows (remember to use ## +instead of #): - - + +

    -
    +
     % No case change, singular first use:  
      \renewcommand*{\genacrfullformat}[2]{%  
       \firstacronymfont{\glsentryshort{##1}}##2% @@ -16478,12 +17025,12 @@ class="cmtt-10">#):  
       \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%  
      }%
    -

    If you think it inappropriate for the short form to be capitalised at the start of a -sentence you can change the above to: - - +

    If you think it inappropriate for the short form to be capitalised at the start of a sentence +you can change the above to: + +

    -
    +
     % No case change, singular first use:  
      \renewcommand*{\genacrfullformat}[2]{%  
       \firstacronymfont{\glsentryshort{##1}}##2% @@ -16497,22 +17044,22 @@ sentence you can change the above to:  
     \let\Genacrfullformat\genacrfullformat  
     \let\Genplacrfullformat\genplacrfullformat
    -

    Another variation is to use

    Another variation is to use \Glsentrylong and \Glsentrylongpl in the footnote -instead of in the footnote instead of +\glsentrylong and \glsentrylongpl. -

    Now let’s suppose that commands such as

    Now let’s suppose that commands such as \glsentryfull and \acrfull shouldn’t -use a footnote, but instead use the format: ⟨ shouldn’t use +a footnote, but instead use the format: ⟨long⟩ (⟨short⟩). This means that the style needs to redefine \glsentryfull, \acrfullfmt and their plural and upper case variants. -

    First, the non-linking commands: - - +

    First, the non-linking commands: + +

    -
    +
      \renewcommand*{\glsentryfull}[1]{%  
        \glsentrylong{##1}\space  
          (\acronymfont{\glsentryshort{##1}})% @@ -16542,11 +17089,11 @@ variants.  
          (\acronymfont{\glsentryshortpl{##1}})%  
      }%
    -

    Now for the linking commands: - - +

    Now for the linking commands: + +

    -
    +
      \renewcommand*{\acrfullfmt}[3]{%  
        \glslink[##1]{##2}{%  
         \glsentrylong{##2}##3\space @@ -16588,105 +17135,103 @@ variants.  
        }%  
      }%
    -

    (This may cause problems with long hyperlinks, in which case adjust the -definitions so that, for example, only the short form is inside the argument of -

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, +for example, only the short form is inside the argument of \glslink.) -

    The style also needs to redefine

    The style also needs to redefine \acronymsort so that the acronyms are sorted -according to the long form: - - + id="dx1-62057"> so that the acronyms are sorted according +to the long form: + +

    -
    +
      \renewcommand*{\acronymsort}[2]{##2}%
    -

    If you prefer them to be sorted according to the short form you can change the above +

    If you prefer them to be sorted according to the short form you can change the above to: - - + +

    -
    +
      \renewcommand*{\acronymsort}[2]{##1}%
    -

    The acronym font needs to be set to

    The acronym font needs to be set to \textsc and the plural suffix adjusted so that -the “s” suffix in the plural short form doesn’t get converted to smallcaps: - - + id="dx1-62058"> and the plural suffix adjusted so that the “s” +suffix in the plural short form doesn’t get converted to smallcaps: + +

    -
    +
      \renewcommand*{\acronymfont}[1]{\textsc{##1}}%  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%
    -

    There are a number of ways of dealing with the format in the list of acronyms. The -simplest way is to redefine

    There are a number of ways of dealing with the format in the list of acronyms. The simplest +way is to redefine \acronymentry to the long form followed by the upper case -short form in parentheses: - - + id="dx1-62059"> to the long form followed by the upper case short form in +parentheses: + +

    -
    +
     \renewcommand*{\acronymentry}[1]{%  
       \Glsentrylong{##1}\space  
         (\MakeTextUppercase{\glsentryshort{##1}})}%
    -

    (I’ve used

    (I’ve used \Glsentrylong instead of \glsentrylong to capitalise the name in the glossary.) -

    An alternative approach is to set

    An alternative approach is to set \acronymentry to just the long form and -redefine to just the long form and redefine +\GenericAcronymFields to set the symbol key to the short form and use a -glossary style that displays the symbol in parentheses after the key to the short form and use a glossary style +that displays the symbol in parentheses after the name (such as the tree -style) like this: - - + id="dx1-62066"> style) like +this: + +

    -
    +
     \renewcommand*{\acronymentry}[1]{\Glsentrylong{##1}}%  
     \renewcommand*{\GenericAcronymFields}{%  
        symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}%
    -

    I’m going to use the first approach and set

    I’m going to use the first approach and set \GenericAcronymFields to do -nothing: - - + id="dx1-62067"> to do nothing: + +

    -
    +
     \renewcommand*{\GenericAcronymFields}{}%
    -

    -

    Finally, this style needs to switch off hyperlinks on first use to avoid nested +

    +

    Finally, this style needs to switch off hyperlinks on first use to avoid nested links: - - + +

    -
    +
     \glshyperfirstfalse
    -

    Putting this all together: - - +

    Putting this all together: + +

    -
    +
    \newacronymstyle{custom-fn}% new style name  
    {%  
      \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% @@ -16733,8 +17278,8 @@ links:  
        }%  
      }%  
      \renewcommand*{\Acrfullfmt}[3]{% - - + +  
        \glslink[##1]{##2}{%  
         \Glsentrylong{##2}##3\space  
          (\acronymfont{\glsentryshort{##2}})% @@ -16776,30 +17321,29 @@ links:  
         (\MakeTextUppercase{\glsentryshort{##1}})}%  
    }
    -

    -

    Now I need to specify that I want to use this new style: - - +

    +

    Now I need to specify that I want to use this new style: + +

    -
    +
    \setacronymstyle{custom-fn}
    -

    I also need to use a glossary style that suits this acronym style, for example -

    I also need to use a glossary style that suits this acronym style, for example altlist: - - + +

    -
    +
    \setglossarystyle{altlist}
    -

    -

    Once the acronym style has been set, I can define my acronyms: - - +

    +

    Once the acronym style has been set, I can define my acronyms: + +

    -
    +
    \newacronym[description={set of tags for use in  
    developing hypertext documents}]{html}{html}{Hyper  
    Text Markup Language} @@ -16807,100 +17351,97 @@ class="cmss-10">altlistlayout of a document written in a markup language}]{css}  
    {css}{Cascading Style Sheet}
    -

    -

    The sample file

    +

    The sample file sample-custom-acronym.tex illustrates this example. -

    +class="cmtt-10">sample-custom-acronym.tex illustrates this example.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 23 (Italic and Upright Abbreviations) -

    Suppose I want to have some abbreviations in italic and some that just use the +

    Suppose I want to have some abbreviations in italic and some that just use the surrounding font. Hard-coding this into the ⟨short⟩ argument of \newacronym can cause complications. -

    This example uses

    This example uses \glsaddstoragekey to add an extra field that can be used to -store the formatting declaration (such as to add an extra field that can be used to store the +formatting declaration (such as \em). - - + +

    -
    +
    \glsaddstoragekey{font}{}{\entryfont}
    -

    This defines a new field/key called font, which defaults to nothing if it’s not -explicitly set. This also defines a command called \entryfont that’s analogous to -\glsentrytext. A new style is then created to format abbreviations that access this -field. -

    There are two ways to do this. The first is to create a style that doesn’t -use

    This defines a new field/key called font, which defaults to nothing if it’s not explicitly set. +This also defines a command called \entryfont that’s analogous to \glsentrytext. A new +style is then created to format abbreviations that access this field. +

    There are two ways to do this. The first is to create a style that doesn’t use \glsgenacfmt but instead provides a modified version that doesn’t use - +but instead provides a modified version that doesn’t use \acronymfont{short} but instead uses } but instead +uses {\entryfont{\glslabel}short}. The full -format given by commands such as \genacrfullformat need to be similarly adjusted. -For example: - - +class="cmtt-10">}. The full format given by commands such as +\genacrfullformat need to be similarly adjusted. For example: + +

    -
    +
      \renewcommand*{\genacrfullformat}[2]{%  
       \glsentrylong{##1}##2\space  
       ({\entryfont{##1}\glsentryshort{##1}})%  
      }%
    -

    This will deal with commands like

    This will deal with commands like \gls but not commands like \acrshort which still -use which still use +\acronymfont. Another approach is to redefine \acronymfont to look up the -required font declaration. Since \acronymfont doesn’t take the entry label as an -argument, the following will only work if \acronymfont is used in a context where -the label is provided by \acronymfont to look up the required font +declaration. Since \acronymfont doesn’t take the entry label as an argument, the following +will only work if \acronymfont is used in a context where the label is provided by +\glslabel. This is true in \gls, \acrshort and \acrfull. -The redefinition is now: - - +class="cmtt-10">\acrfull. The redefinition is +now: + +

    -
    +
    \renewcommand*{\acronymfont}[1]{{\entryfont{\glslabel}#1}}%
    -

    So the new style can be defined as: - - +

    So the new style can be defined as: + +

    -
    +
    \newacronymstyle{long-font-short}  
    {%  
      \GlsUseAcrEntryDispStyle{long-short}% @@ -16927,24 +17468,24 @@ The redefinition is now:  
      \renewcommand*{\acronymentry}[1]{{\entryfont{##1}\glsentryshort{##1}}}%  
    }
    -

    Remember the style needs to be set before defining the entries: - - +

    Remember the style needs to be set before defining the entries: + +

    -
    +
    \setacronymstyle{long-font-short}
    -

    -

    The complete document is contained in the sample file

    +

    The complete document is contained in the sample file sample-font-abbr.tex.

    -

    -

    ____________________________

    -

    Some writers and publishing houses have started to drop full stops (periods) from -upper case initials but may still retain them for lower case abbreviations, while others +

    +

    ____________________________

    +

    Some writers and publishing houses have started to drop full stops (periods) from upper +case initials but may still retain them for lower case abbreviations, while others may still use them for both upper and lower case. This can cause complications. Chapter 12 of The TEXbook discusses the spacing between words but, briefly, the -default behaviour of TEX is to assume that an upper case character followed by a full -stop and space is an abbreviation, so the space is the default inter-word space whereas -a lower case character followed by a full stop and space is a word occurring at the end -of a sentence. In the event that this isn’t true, you need to make a manual +class="cmti-10">book discusses the spacing between words but, briefly, the default +behaviour of TEX is to assume that an upper case character followed by a full stop +and space is an abbreviation, so the space is the default inter-word space whereas +a lower case character followed by a full stop and space is a word occurring at the +end of a sentence. In the event that this isn’t true, you need to make a manual adjustment using (back slash space) in place of just a space character for an inter-word mid-sentence space and use \@ before the full stop to indicate the end of -the sentence. -

    For example: - - +class="cmtt-10">\@ before the full stop to indicate the end of the +sentence. +

    For example: + +

    -
    +
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    The spacing is more noticeable with the typewriter font: - - + +

    -
    +
    \ttfamily  
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    The lower case letter at the end of “B.Sc.” is confusing TEX into thinking that the -full stop after it marks the end of the sentence. Whereas the upper case letter at the -end of “Ph.D.” has confused TEX into thinking that the following full stop is just -part of the abbreviation. These can be corrected: - - +class="E">EX into thinking that the full stop +after it marks the end of the sentence. Whereas the upper case letter at the end of “Ph.D.” +has confused TEX into thinking that the following full stop is just part of the abbreviation. +These can be corrected: + +

    -
    +
    I was awarded a B.Sc.\ and a Ph.D\@. (From the same place.)
    -

    -

    This situation is a bit problematic for glossaries. The full stops can form part of the -⟨

    +

    This situation is a bit problematic for glossaries. The full stops can form part of +the ⟨short⟩ argument of \newacronym and the B.Sc.\␣ part can be dealt with by remembering to add \␣ (for example, \gls{bsc}\␣) but the end of sentence case is -more troublesome as you need to omit the sentence terminating full stop (to avoid two -dots) which can make the source code look a little strange but you also need to -adjust the space factor, which is usually done by inserting \@ before the full stop. -

    The next example shows one way of achieving this. +

    The next example shows one way of achieving this. (Note that the supplemental +glossaries-extra package provides a much simpler way of doing this, which you may prefer to +use.) -

    Example 24 (Abbreviations with Full Stops (Periods)) -

    As from version 4.16, there’s now a hook (

    As from version 4.16, there’s now a hook (\glspostlinkhook) that’s called at the -very end of the ) that’s called at the very +end of the \gls-like and \glstext-like commands. This can be redefined to -check if the following character is a full stop. The \glstext-like commands. This can be redefined to check if the +following character is a full stop. The amsgen package (which -is automatically loaded by glossaries) provides an internal command called + id="dx1-62080"> package (which is automatically loaded by \new@ifnextchar that can be used to determine if the given character appears next. -(For more information see the glossaries) provides an internal command called \new@ifnextchar that can be used to +determine if the given character appears next. (For more information see the amsgen documentation.) -

    It’s possible that I may also want acronyms or contractions in my document, so -I need some way to differentiate between them. Here I’m going to use the same -method as in example 4 where a new field is defined to indicate the type of -abbreviation: - - + id="dx1-62081"> +documentation.) +

    It’s possible that I may also want acronyms or contractions in my document, so I need +some way to differentiate between them. Here I’m going to use the same method as in +example 4 where a new field is defined to indicate the type of abbreviation: + +

    -
    +
    \glsaddstoragekey{abbrtype}{word}{\abbrtype}  
    \newcommand*{\newabbr}[1][]{\newacronym[abbrtype=initials,#1]}
    -

    Now I just use

    Now I just use \newacronym for the acronyms, for example, - - + +

    -
    +
    \newacronym{laser}{laser}{light amplification by stimulated  
    emission of radiation}
    -

    and my new command

    and my new command \newabbr for initials, for example, - - + +

    -
    +
    \newabbr{eg}{e.g.}{exempli gratia}  
    \newabbr{ie}{i.e.}{id est}  
    \newabbr{bsc}{B.Sc.}{Bachelor of Science}  
    \newabbr{ba}{B.A.}{Bachelor of Arts}  
    \newabbr{agm}{A.G.M.}{annual general meeting}
    -

    Within

    Within \glspostlinkhook the entry’s label can be accessed using \glslabel and \ifglsfieldeq can be used to determine if the current entry has the new abbrtype -field set to “initials”. If it doesn’t, then nothing needs to happen, but if it does, -a check is performed to see if the next character is a full stop. If it is, this signals the -end of a sentence otherwise it’s mid-sentence. -

    Remember that internal commands within the document file (rather than in -a class or package) need to be placed between abbrtype field set +to “initials”. If it doesn’t, then nothing needs to happen, but if it does, a check is performed +to see if the next character is a full stop. If it is, this signals the end of a sentence otherwise +it’s mid-sentence. +

    Remember that internal commands within the document file (rather than in a class or +package) need to be placed between \makeatletter and \makeatother: - - + +

    -
    +
    \makeatletter  
    \renewcommand{\glspostlinkhook}{%  
     \ifglsfieldeq{\glslabel}{abbrtype}{initials}% @@ -17100,20 +17644,20 @@ class="cmtt-10">\makeatother}  
    \makeatother
    -

    In the event that a full stop is found \doendsentence is performed but it will be -followed by the full stop, which needs to be discarded. Otherwise \doendword will be -done but it won’t be followed by a full stop so there’s nothing to discard. The -definitions for these commands are: - - +

    In the event that a full stop is found \doendsentence is performed but it will be followed by +the full stop, which needs to be discarded. Otherwise \doendword will be done but it won’t be +followed by a full stop so there’s nothing to discard. The definitions for these commands +are: + +

    -
    +
    \newcommand{\doendsentence}[1]{\spacefactor=10000{}}  
    \newcommand{\doendword}{\spacefactor=1000{}}
    -

    Now, I can just do

    Now, I can just do \gls{bsc} mid-sentence and \gls{phd}. at the end of the sentence. The terminating full stop will be discarded in the latter case, but it won’t be @@ -17121,46 +17665,45 @@ discarded in, say, \gls{laser}. as that doesn’t have the abbrtype field set to “initials”. -

    This also works on first use when the style is set to one of the ⟨

    This also works on first use when the style is set to one of the ⟨long⟩ (⟨short⟩) styles -but it will fail with the ⟨short⟩) styles but it +will fail with the ⟨short⟩ (⟨long⟩) styles as in this case the terminating full stop -shouldn’t be discarded. Since long⟩) styles as in this case the terminating full stop shouldn’t be +discarded. Since \glspostlinkhook is used after the first use -flag has been unset for the entry, this can’t be fixed by simply checking with -first use flag has been unset for the +entry, this can’t be fixed by simply checking with \ifglsused. One possible solution to this is to redefine . One possible solution to this is +to redefine \glslinkpostsetkeys -to check for the first use flag and define a macro that can then be used in - to check for the first use flag and define a macro that can +then be used in \glspostlinkhook. -

    The other thing to consider is what to do with plurals. One possibility is to check -for plural use within

    The other thing to consider is what to do with plurals. One possibility is to check for +plural use within \doendsentence (using \glsifplural) and put the full stop -back if the plural has been used. -

    The complete document is contained in the sample file ) and put the full stop back if the +plural has been used. +

    The complete document is contained in the sample file ??.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.2 Displaying the List of Acronyms

    -

    The list of acronyms is just like any other type of glossary and can be displayed on its -own using: +

    The list of acronyms is just like any other type of glossary and can be displayed on its own +using:

    [type=\acronymtype]
    - - + +
    Options[type=\acronymtype]
    -

    (If you use the

    (If you use the acronym package option you can also use

    @@ -17229,8 +17772,7 @@ href="#acronymoptions">§2.5 Acronym Options.) -

    Alternatively the list of acronyms can be displayed with all the other glossaries -using: +

    Alternatively the list of acronyms can be displayed with all the other glossaries using:

    :
    \printglossaries
    -

    However, care must be taken to choose a glossary style that’s appropriate to your -acronym style. Alternatively, you can define your own custom style (see

    However, care must be taken to choose a glossary style that’s appropriate to your acronym +style. Alternatively, you can define your own custom style (see §15.2 Defining -your own glossary style for further details). - - -

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

    -

    Top

    13.3 Upgrading From the glossary Package

    -

    Users of the obsolete

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

    In order to facilitate migrating from the old package to the new one, the glossaries package13.113.1 provides the command: -



    \oldacronym  }{long}{key-val list} -

    -

    +class="cmtt-10">}


    +

    This uses the same syntax as the glossary package’s method of defining acronyms. It is @@ -17337,91 +17878,89 @@ class="cmtt-10">{⟨label}. If ⟨label⟩ is omitted, ⟨abbrv⟩ -is used. Since commands names must consist only of alphabetical characters, ⟨label⟩ -must also only consist of alphabetical characters. Note that abbrv⟩ is used. +Since commands names must consist only of alphabetical characters, ⟨label⟩ must also only +consist of alphabetical characters. Note that \label⟩ doesn’t allow you to -use the first optional argument of label⟩ doesn’t allow you to use the first optional +argument of \gls or \Gls — you will need to explicitly use \gls -or 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 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 label⟩ unless you additionally load the xspace package, but be aware that there are some issues with -using +package, but be aware that there are some issues with using xspace.13.2
    -

    +href="#fn2x13" id="fn2x13-bk">13.2

    +

    -

    The

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

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

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

    This will create the command

    This will create the command \abc and its starred version \abc*. Table 13.2 -illustrates the effect of \abc (on subsequent use) according to whether or not -the Table 13.2 illustrates the +effect of \abc (on subsequent use) according to whether or not the xspace package has been loaded. As can be seen from the final row in -the table, the 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. + id="dx1-64024"> package prevents the +optional argument from being recognised.

    - - -


    - - + +
    Table 13.2: The effect of using  xyz abc [’s] xyz abc’s xyz
    - - + +

    - - -

    -

    +

    Top

    14. Unsetting and Resetting Entry Flags

    -

    When using the

    When using the \gls-like commands it is possible that 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}

    -

    +

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


    +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 list⟩ is a comma-separated list of glossary labels. If omitted, all defined -glossaries are assumed (except for the ignored ones). For example, to reset all entries -in the main glossary and the list of acronyms: - - +glossaries are assumed (except for the ignored ones). 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  true part}{false part}

    -

    +

    where ⟨label⟩ is the label of the required entry. If the entry has been used, ⟨true part⟩ will -be done, otherwise ⟨true part⟩ will be +done, otherwise ⟨false part⟩ will be done. -

    Be careful when using

    Be careful when using \gls-like commands within an environment or -command argument that gets processed multiple times as it can cause unwanted -side-effects when the first use displayed text is different from subsequent use. -
    -

    -

    For example, the \gls-like commands within an environment or command +argument that gets processed multiple times as it can cause unwanted side-effects when the +first use displayed text is different from subsequent use.

    +

    +

    For example, the frame environment in beamer processes its argument for each -overlay. This means that the first use flag will be unset on the first overlay and -subsequent overlays will use the non-first use form. -

    Consider the following example: - - + id="dx1-65014"> processes its argument for each overlay. +This means that the first use flag will be unset on the first overlay and subsequent overlays +will use the non-first use form. +

    Consider the following example: + +

    -
    +
    \documentclass{beamer}  
    \usepackage{glossaries}  
    \newacronym{svm}{SVM}{support vector machine} @@ -17630,22 +18167,22 @@ subsequent overlays will use the non-first use form.  
    \end{frame}  
    \end{document}
    -

    -

    On the first overlay, \gls{svm} produces “support vector machine (SVM)” and -then unsets the

    +

    On the first overlay, \gls{svm} produces “support vector machine (SVM)” and then +unsets the first use flag. When the second overlay is processed, \gls{svm} now -produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway -around this and I can only offer two suggestions. -

    Firstly, unset all acronyms at the start of the document and explicitly use -\gls{svm} now produces +“SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and I can +only offer two suggestions. +

    Firstly, unset all acronyms at the start of the document and explicitly use \acrfull when you want the full version to be displayed: - - + id="dx1-65015"> when +you want the full version to be displayed: + +

    -
    +
    \documentclass{beamer}  
    \usepackage{glossaries}  
    \newacronym{svm}{SVM}{support vector machine} @@ -17660,12 +18197,12 @@ class="cmtt-10">\acrfull\end{frame}  
    \end{document}
    -

    -

    Secondly, explicitly reset each acronym on first use: - - +

    +

    Secondly, explicitly reset each acronym on first use: + +

    -
    + -

    These are non-optimal, but the

    These are non-optimal, but the beamer class is too complex for me to provide a -programmatic solution. Other potentially problematic environments are some + id="dx1-65016"> class is too complex for me to provide +a programmatic solution. Other potentially problematic environments are some tabular-like environments (but not tabular itself) that process the contents in order to -work out the column widths and then reprocess the contents to do the actual + id="dx1-65020"> itself) that process the contents in order +to work out the column widths and then reprocess the contents to do the actual typesetting. -

    The

    The amsmath environments, such as align, also process their contents multiple -times, but the , also process their contents multiple times, but +the glossaries package now checks for this.

    -

    Top

    14.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)

    -

    As from version 4.14, it’s now possible to keep track of how many times an entry is -used. That is, how many times the first use flag is unset. -

    This function is disabled by default as it adds extra overhead to the document -build time and also switches

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. +That is, how many times the first use flag is unset. Note that the supplemental +glossaries-extra package improves this function and also provides per-unit counting, which isn’t +available with the glossaries package. +

    This function is disabled by default as it adds extra overhead to the document build time +and also switches \newglossaryentry (and therefore \newacronym) into -a preamble-only command.
    -

    -

    To enable this function, use -


    ) into a preamble-only +command.
    +

    +

    To enable this function, use +


    \glsenableentrycount  \glsenableentrycount

    -

    +

    before defining your entries. This adds two extra (internal) fields to entries: currcount -and currcount and +prevcount. -

    The

    The currcount field keeps track of how many times \glsunset is used within the document. A local unset (using \glslocalunset) performs a local rather than global increment to currcount. Remember that not all commands use \glsunset. -Only the \glsunset. Only the +\gls-like commands do this. The reset commands \glsreset and -\glslocalreset reset this field back to zero (where \glslocalreset performs a local -change). -

    The \glsreset and \glslocalreset reset this +field back to zero (where \glslocalreset performs a local change). +

    The prevcount field stores the final value of the currcount field from the previous -run. This value is read from the from the previous run. +This value is read from the .aux file at the beginning of the document -environment. -

    You can access these fields using -


    environment. +

    You can access these fields using +


    \glsentrycurrcount  \glsentrycurrcount{label}

    - - -

    + + +

    for the currcount field, and -



    \glsentryprevcount  \glsentryprevcount{label}

    -

    +

    for the prevcount field. These commands are only defined if you have used \glsenableentrycount. -

    For example: - - +

    For example: + +

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \makeglossaries @@ -17793,35 +18332,34 @@ class="cmbx-10">.  
    Number of times apple has been used: \glsentrycurrcount{apple}.  
    \end{document}
    -

    On the first LAT

    On the first LATEX run, \glsentryprevcount{apple} produces 0. At the end of -the document, \glsentrycurrcount{apple} produces 4. This is because the -only commands that have incremented the entry count are those that use -\glsentryprevcount{apple} produces 0. At the end of the +document, \glsentrycurrcount{apple} produces 4. This is because the only commands +that have incremented the entry count are those that use \glsunset. That is: \gls, \glsdisp and \Gls. The other commands used -in the above example, \glsdisp +and \Gls. The other commands used in the above example, \glsadd, \glsentrytext and \glslink, don’t use +class="cmtt-10">\glsentrytext and \glslink, don’t use \glsunset so they don’t increment the entry count. On the next LATEX run, -next +LATEX run, \glsentryprevcount{apple} now produces 4 as that was the value of the currcount field for the apple entry at the end of the document on the previous run. -

    When you enable the entry count using \glsenableentrycount, you also enable -the following commands: -


    When you enable the entry count using \glsenableentrycount, you also enable the +following commands: +


    \cgls  label}[insert]

    -

    +

    (no case-change, singular) -



    \cglspl  label}[insert]

    -

    +

    (no case-change, plural) -



    \cGls  label}[insert]

    -

    +

    (first letter uppercase, singular), and -



    \cGlspl  label}[insert]

    -

    -(first letter uppercase, plural). These all have plus and starred variants like the -analogous

    +(first letter uppercase, plural). These all have plus and starred variants like the analogous +\gls, \glspl, \Gls and \Glspl commands. -

    If you don’t use

    If you don’t use \glsenableentrycount, these commands behave like \gls, -\gls, \glspl, \Gls and \Glspl, respectively, only there will be a warning that you - - -haven’t enabled entry counting. If you have enabled entry counting with -\glsenableentrycount then these commands test if \Gls +and \Glspl, respectively, only there will be a warning that you haven’t enabled entry +counting. If you have enabled entry counting with \glsenableentrycount then these + + +commands test if \glsentryprevcount{label} -equals 1. If it doesn’t then the analogous \gls etc will be used. If it does, then the -first optional argument will be ignored and

    +class="cmtt-10">} equals 1. If it doesn’t then the analogous \gls +etc will be used. If it does, then the first optional argument will be ignored and +

    cslabel}
    will be performed, where ⟨cs format⟩ is a command that takes two arguments. The -command used depends whether you have used cs format⟩ is a command that takes two arguments. The command +used depends whether you have used \cgls, \cglspl, \cGls or -\cGls or \cGlspl. -



    \cglsformat  label}{insert}

    -

    +

    This command is used by \cgls and defaults to

    @@ -17945,7 +18482,7 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cglsplformat  label}{insert}

    -

    +

    This command is used by \cglspl and defaults to

    @@ -17974,7 +18511,7 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cGlsformat  label}{insert}

    -

    +

    This command is used by \cGls and defaults to

    - - + +
    \Glsentrylong{}insert
    otherwise. -



    \cGlsplformat  label}{insert}

    -

    +

    This command is used by \cGlspl and defaults to

    @@ -18034,38 +18571,37 @@ class="cmtt-10">}⟨insert
    otherwise. -

    This means that if the previous count for the given entry was 1, the entry won’t -be hyperlinked with the \cgls-like commands and they won’t add a line to the -external glossary file. If you haven’t used any of the other commands that add -information to glossary file (such as

    This means that if the previous count for the given entry was 1, the entry won’t be +hyperlinked with the \cgls-like commands and they won’t add a line to the external glossary +file. If you haven’t used any of the other commands that add information to glossary file (such +as \glsadd or the \glstext-like commands) then -the entry won’t appear in the glossary. -

    Remember that since these commands use \glsentryprevcount you -need to run LATEX twice to ensure they work correctly. The document -build order is now (at least): \glstext-like commands) then the entry won’t appear in the +glossary. +

    Remember that since these commands use \glsentryprevcount you need to run +LATEX twice to ensure they work correctly. The document build order is now (at least): +(pdf)latex, (pdf)latex, makeglossaries, -makeglossaries, (pdf)latex. -

    Example 25 (Don’t index entries that are only used once) -

    In this example, the abbreviations that have only been used once (on the previous -run) only have their long form shown with

    In this example, the abbreviations that have only been used once (on the previous run) +only have their long form shown with \cgls. - - + +

    -
    +
    \documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage[acronym]{glossaries} @@ -18086,7 +18622,7 @@ class="cmtt-10">\cgls.  
    \printglossaries  
    \end{document}
    -

    After a complete document build (

    After a complete document build (latex, latex, makeglossaries,

    -

    -

    ____________________________

    -

    Remember that if you don’t like typing

    +

    ____________________________

    +

    Remember that if you don’t like typing \cgls you can create a synonym. For example - - + +

    -
    +
    \let\ac\cgls
    -

    - - +

    + +

    -

    -

    +

    Top

    15. Glossary Styles

    -

    Glossaries vary from lists that simply contain a symbol with a terse description to -lists of terms or phrases with lengthy descriptions. Some glossaries may have terms +

    Glossaries vary from lists that simply contain a symbol with a terse description to lists +of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The glossaries package comes with a @@ -18130,7 +18666,7 @@ href="#sec:newglossarystyle">§15.2 Defining your own glossary style). -

    The glossary style can be set using the

    The glossary style can be set using the style key in the optional argument to Option 1) or \printglossary (Options 2 and 3) or using -the command: -


    3) or using the +command: +


    \setglossarystyle  \setglossarystyle{style-name}

    -

    +

    (before the glossary is displayed). -

    Some of the predefined glossary styles may also be set using the

    Some of the predefined glossary styles may also be set using the style package -option, it depends if the package in which they are defined is automatically loaded by -the glossaries package. -

    You can use the lorum ipsum dummy entries provided in the -example-glossaries-*.tex files (described in package option, it +depends if the package in which they are defined is automatically loaded by the glossaries +package. +

    You can use the lorum ipsum dummy entries provided in the example-glossaries-*.tex +files (described in §1.2 Dummy Entries for Testing) to -test the different styles. +href="#sec:lipsum">Dummy Entries for Testing) to test the different styles.

    -

    Top

    15.1 Predefined Styles

    -

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. +

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options entrycounter, counterwithin and subentrycounter described in - described +in §2.3 Glossary Appearance Options. There is a summary of available styles in table 15.1. -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) will have unexpected results if used -with the ) will have unexpected results if used with the +sort=def or sort=use options.
    -

    +

    - - -


    - - + +
    Table 15.1: Glossary Styles. An asterisk in the style name indicates anything -that matches that doesn’t match any previously listed style (e.g. long3col* -matches Glossary Styles. An asterisk in the style name indicates anything that +matches that doesn’t match any previously listed style (e.g. long3col* matches +long3col, , long3colheader, , long3colborder and and long3colheaderborder). A -maximum level of 0 indicates a flat glossary (sub-entries are displayed in the -same way as main entries). Where the maximum level is given as — there is no -limit, but note that ). A maximum level of +0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). +Where the maximum level is given as — there is no limit, but note that makeindex (Option 2) imposes a limit of 2 sub-levels. If the -homograph column is checked, then the name is not displayed for sub-entries. If -the symbol column is checked, then the symbol will be displayed.
    + id="dx1-68012"> +(Option 2) imposes a limit of 2 sub-levels. If the homograph column is checked, then +the name is not displayed for sub-entries. If the symbol column is checked, then the +symbol will be displayed.
    1
    - - + +

    -

    The tabular-like styles that allow multi-line descriptions and page lists use the -length

    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 \glsdescwidth to set the width of the description column and the +length \glspagelistwidth \glspagelistwidth to set the width of the page list column.15.115.1 These will need to be changed using \setlength if the glossary is too wide. Note that -the \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 styles (and their header and border variations) don’t use these lengths +as they are designed for single line entries. Instead you should use the analogous +altlong4col and altsuper4col styles. If you want to explicitly create a -line-break within a multi-line description in a tabular-like style it’s better to use - styles. If you want to explicitly create a line-break within a +multi-line description in a tabular-like style it’s better to use \newline instead of instead of +\\. -

    Note that if you use the

    Note that if you use the style key in the optional argument to \printnoidxglossaryOption 1) or \printglossary (Options 2 and 3), it will override any previous style -settings for the given glossary, so if, for example, you do - - +href="#option3">3), 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

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

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

    will reset

    will reset \glsgroupskip back to its default definition for the named glossary style (long\newglossarystyle\setglossarystyle, e.g.: - - + +

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

    As from version 3.03, you can now use the package option

    As from version 3.03, you can now use the package option nogroupskip to -suppress the gap between groups for the default styles instead of redefining - to suppress the gap +between groups for the default styles instead of redefining \glsgroupskip. -

    All the styles except for the three- and four-column styles and the

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


    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

    +after the description. This simply displays a full stop by default. To eliminate this full +stop (or replace it with something else, say, a comma) you will need to redefine +\glspostdescription before the glossary is displayed. Alternatively, you can suppress it for +a given entry by placing \nopostdesc in the entry’s -description. -

    As from version 3.03 you can now use the package option in the entry’s description. +

    As from version 3.03 you can now use the package option nopostdot to suppress -this full stop. + id="dx1-68036"> to suppress this full +stop.

    -

    Top

    15.1.1 List Styles

    -

    The styles described in this section are all defined in the package

    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 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 nostyleslist style uses the description environment. The entry name is placed in - the optional argument of the environment. The entry name is placed in the + optional argument of the \item command (so it will usually appear in - bold by default). The description follows, and then the associated number - list for that entry. The symbol is ignored. If the entry has child entries, the - description and number list follows (but not the name) for each child entry. - Groups are separated using command (so it will usually appear in bold by + default). The description follows, and then the associated number list for that + entry. The symbol is ignored. If the entry has child entries, the description and + number list follows (but not the name) for each child entry. Groups are separated + using \indexspace.

    @@ -18547,39 +19080,38 @@ class="description">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 LAT 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: - - +

    + 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

    +

    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 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. + id="dx1-69018">, but note that this needs to be done after + the glossary style has been set.

    altlist
    The altlist style is like list but the description starts on the line following the - name. (As with the 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 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. @@ -18602,8 +19134,7 @@ class="description">The altlistgroup style is like altlist but the glossary groups have - headings. + id="dx1-69024"> but the glossary groups have headings.
    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 but has a set of links to the + glossary groups. The navigation line is the same as that for listhypergroup, - described above. + id="dx1-69027">, described + above.
    listdotted
    This style uses the This style uses the description environment.15.215.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 number list - and the symbol. The length -


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

    + governs where the description should start. This is a flat style, so child entries are + formatted in the same way as the parent entries.

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

    + + +

    -

    Top

    15.1.2 Longtable Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-long. Since -they all use the . 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 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 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.1.3 Longtable Styles (Ragged -Right). +href="#sec:longraggedstyles">Longtable Styles (Ragged Right). If you want to incorporate rules +from the booktabs package, try the styles described in §15.1.4 Longtable Styles +(booktabs).

    long
    The long style uses the style uses the longtable environment (defined by the 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 - 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-70012">. Child entries have a similar format to + the parent entries except that their name is suppressed.
    longborder
    The longborder style is like style is like long but has horizontal and vertical lines - around it. + id="dx1-70014"> but has horizontal and vertical lines around + it.
    longheader
    The longheader style is like style is like long but has a header row. + id="dx1-70016"> but has a header row.
    longheaderborder
    The The longheaderborder style is like style is like longheader but has - horizontal and vertical lines around it. + id="dx1-70018"> but has horizontal + and vertical lines around it.
    long3col
    The long3col style is like 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 - 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 , and the width of the third + column is governed by the length \glspagelistwidth. + id="dx1-70023">.
    long3colborder
    The The long3colborder style is like the style is like the long3col style but has - horizontal and vertical lines around it. + id="dx1-70025"> style but has horizontal + and vertical lines around it.
    long3colheader
    The long3colheader style is like style is like long3col but has a header row. - - + id="dx1-70027"> but has a header row. + +
    long3colheaderborder
    The The long3colheaderborder style is like style is like long3colheader - but has horizontal and vertical lines around it. + id="dx1-70029"> but has + horizontal and vertical lines around it.
    long4col
    The long4col style is like 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 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. + id="dx1-70032"> for multi-line descriptions.
    long4colborder
    The The long4colborder style is like the style is like the long4col style but has - horizontal and vertical lines around it. + id="dx1-70034"> style but has horizontal + and vertical lines around it.
    long4colheader
    The long4colheader style is like style is like long4col but has a header row. + id="dx1-70036"> but has a header row.
    long4colheaderborder
    The The long4colheaderborder style is like style is like long4colheader - but has horizontal and vertical lines around it. + id="dx1-70038"> but has + horizontal and vertical lines around it.
    altlong4col
    The The altlong4col - style is like style is like long4col but allows multi-line descriptions and page lists. The - width of the description column is governed by the length 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 + id="dx1-70041"> 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. + id="dx1-70042">. The widths of the name and symbol columns are governed + by the widest entry in the given column.
    altlong4colborder
    The The altlong4colborder style is like the style is like the long4colborder but - allows multi-line descriptions and page lists. + id="dx1-70044"> but allows + multi-line descriptions and page lists.
    altlong4colheader
    The The altlong4colheader style is like style is like long4colheader but allows + id="dx1-70046"> but allows multi-line descriptions and page lists.
    altlong4colheaderborder
    The The altlong4colheaderborder style is like + id="dx1-70047"> style is like long4colheaderborder but allows multi-line descriptions and page lists.
    -

    + id="dx1-70048"> but allows multi-line descriptions and page lists. +

    -

    Top

    15.1.3 Longtable Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longragged. -These styles are analogous to those defined in . 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 - - - 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 environment, they are +governed by the same parameters as that environment. The glossary-longragged package additionally requires the package + + +additionally requires the array -package. Note that these styles will only be available if you explicitly load - 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

    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. + id="dx1-71008"> package option since the styles aren’t +defined until after the glossaries package has been loaded. If you want to incorporate rules +from the booktabs package, try the styles described in §15.1.4 Longtable Styles +(booktabs).

    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 style has two columns: the first column contains the entry’s + name and the second column contains the (left-justified) description followed by + the number list. The entry’s symbol is ignored. Sub groups - are separated with a blank row. The width of the first column is governed - by the widest entry in that column. The width of the second column is - governed by the length . 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-71012">. + Child entries have a similar format to the parent entries except that their name + is suppressed.
    longraggedborder
    The The longraggedborder style is like style is like longragged but has - horizontal and vertical lines around it. + id="dx1-71014"> but has horizontal + and vertical lines around it.
    longraggedheader
    The The longraggedheader style is like style is like longragged but has a - header row. + id="dx1-71016"> but has a header row.
    longraggedheaderborder
    The The longraggedheaderborder style is like - style is like longraggedheader but has horizontal and vertical lines around it. + id="dx1-71018"> + but has horizontal and vertical lines around it.
    longragged3col
    The The longragged3col style is like 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 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 , and the width of the third column is governed by the + length \glspagelistwidth. + id="dx1-71023">.
    longragged3colborder
    The The longragged3colborder style is like the - style is like the longragged3col style but has horizontal and vertical lines around it. + id="dx1-71025"> style + but has horizontal and vertical lines around it.
    longragged3colheader
    The longragged3colheader style is like style is like longragged3col - but has a header row. - - + id="dx1-71027"> but has + a header row. + +
    longragged3colheaderborder
    The The longragged3colheaderborder style is like + id="dx1-71028"> style is like longragged3colheader but has horizontal and vertical lines around it. + id="dx1-71029"> but has horizontal and vertical lines around it.
    altlongragged4col
    The The altlongragged4col style is like 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 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 - 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. + id="dx1-71033">. The widths + of the name and symbol columns are governed by the widest entry in the given + column.
    altlongragged4colborder
    The The altlongragged4colborder style is like the + id="dx1-71034"> style is like the altlongragged4col but has horizontal and vertical lines around it. + id="dx1-71035"> but has horizontal and vertical lines around it.
    altlongragged4colheader
    The The altlongragged4colheader style is like - style is like altlongragged4col but has a header row. + id="dx1-71037"> + but has a header row.
    altlongragged4colheaderborder
    The altlongragged4colheaderborder style is - like style is like + altlongragged4colheader but has horizontal and vertical lines around it. + id="dx1-71039"> but has horizontal and vertical lines around it.
    -

    +

    -

    Top

    15.1.4 Longtable Styles (booktabs)

    +

    The styles described in this section are all defined in the package glossary-longbooktabs. +

    Since these styles all use the longtable environment, they are governed by the same +parameters as that environment. The glossary-longbooktabs package automatically loads the +glossary-long (§15.1.2 Longtable Styles) and glossary-longragged (§15.1.3 Longtable Styles +(Ragged Right)) packages. Note that these styles will only be available if you explicitly load +glossary-longbooktabs: + + +

    +
    +\usepackage{glossaries} + 
    \usepackage{glossary-longbooktabs} +
    +

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

    These styles are similar to the “header” styles in the glossary-long and glossary-ragged +packages, but they add the rules provided by the booktabs package, \toprule, \midrule and +\bottomrule. Additionally these styles patch the longtable environment to check for instances +of the group skip occurring at a page break. If you don’t want this patch to affect any other +use of longtable in your document, you can scope the effect by only setting the style through +the style key in the optional argument of \printglossary. (The nogroupskip package option +is checked by these styles.) +

    Alternatively, you can restore the original longtable behaviour with: +


    \glsrestoreLToutput  \glsrestoreLToutput

    +

    +For more information about the patch, see the documented code (glossaries-code.pdf). +

    +long-booktabs
    This style is similar to the longheader style but adds rules above and + below the header (\toprule and \midrule) and inserts a rule at the bottom of + the table (\bottomrule). +
    +long3col-booktabs
    This style is similar to the long3colheader style but adds rules as + per long-booktabs. +
    +long4col-booktabs
    This style is similar to the long4colheader style but adds rules as + above. +
    +altlong4col-booktabs
    This style is similar to the altlong4colheader style but adds rules + as above. +
    +longragged-booktabs
    This style is similar to the longraggedheader style but adds rules + as above. +
    +longragged3col-booktabs
    This style is similar to the longragged3colheader style but + adds rules as above. + + +
    +altlongragged4col-booktabs
    This style is similar to the altlongragged4colheader style + but adds rules as above. +
    +

    +

    +

    Top

    15.1.5 Supertabular Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-super. Since -they all use the . +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 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 or nostyles package options. In general, the package options. In general, the longtable + id="dx1-73006"> environment is better, but there are some circumstances where it is better to use supertabular.15.3 -These styles fully justify the description and page list columns. If you want ragged -right formatting instead, use the analogous styles described in .15.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.1.5 Supertabular -Styles (Ragged Right). +class="cmsy-10">§15.1.6 Supertabular Styles (Ragged +Right).

    super
    The The super style uses the style uses the supertabular environment (defined by the - 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 + 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 . 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-73017">. Child entries have a + similar format to the parent entries except that their name is suppressed.
    superborder
    The superborder style is like style is like super but has horizontal and vertical - lines around it. + id="dx1-73019"> but has horizontal and vertical lines + around it.
    superheader
    The superheader style is like style is like super but has a header row. + id="dx1-73021"> but has a header row.
    superheaderborder
    The superheaderborder style is like style is like superheader but has - horizontal and vertical lines around it. + id="dx1-73023"> but has horizontal + and vertical lines around it.
    super3col
    The The super3col style is like 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 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 . 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 . The width of the + third column is governed by the length \glspagelistwidth. + id="dx1-73028">. + +
    super3colborder
    The The super3colborder style is like the style is like the super3col style but has + id="dx1-73030"> style but has horizontal and vertical lines around it.
    super3colheader
    The super3colheader style is like style is like super3col but has a header - row. + id="dx1-73032"> but has a header row.
    super3colheaderborder
    The The super3colheaderborder style is like the - style is like the super3colheader style but has horizontal and vertical lines around it. + id="dx1-73034"> + style but has horizontal and vertical lines around it.
    super4col
    The super4col style is like 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 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. + id="dx1-73037"> for multi-line descriptions.
    super4colborder
    The The super4colborder style is like the style is like the super4col style but has + id="dx1-73039"> style but has horizontal and vertical lines around it.
    super4colheader
    The super4colheader style is like style is like super4col but has a header - row. - - + id="dx1-73041"> but has a header row.
    super4colheaderborder
    The The super4colheaderborder style is like the - style is like the super4colheader style but has horizontal and vertical lines around it. + id="dx1-73043"> + style but has horizontal and vertical lines around it.
    altsuper4col
    The The altsuper4col style is like style is like super4col but allows multi-line - descriptions and page lists. The width of the description column is governed - by the length 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 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. + id="dx1-73047">. The width of the name and symbol columns is governed by + the widest entry in the given column.
    altsuper4colborder
    The The altsuper4colborder style is like the style is like the super4colborder - style but allows multi-line descriptions and page lists. + id="dx1-73049"> style but + allows multi-line descriptions and page lists.
    altsuper4colheader
    The The altsuper4colheader style is like style is like super4colheader but - allows multi-line descriptions and page lists. + id="dx1-73051"> but allows + multi-line descriptions and page lists.
    altsuper4colheaderborder
    The The altsuper4colheaderborder style is like + id="dx1-73052"> style is like super4colheaderborder but allows multi-line descriptions and page lists.
    -

    + id="dx1-73053"> but allows multi-line descriptions and page lists. + + +

    -

    Top

    15.1.5

    Top

    15.1.6 Supertabular Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-superragged. -These styles are analogous to those defined in . 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 - 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 environment, they +are governed by the same parameters as that environment. The glossary-superragged package additionally requires the package +additionally requires the array -package. Note that these styles will only be available if you explicitly load - package. Note that these styles will only be available if you +explicitly load glossary-superragged: - - + id="dx1-74007">: + +

    -
    +
    \usepackage{glossaries}  
    \usepackage{glossary-superragged}
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles -aren’t defined until after the package option since the styles aren’t +defined until after the glossaries package has been loaded.

    superragged
    The superragged style uses the style uses the supertabular environment (defined - by the 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 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 . 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-74014">. + Child entries have a similar format to the parent entries except that their name + is suppressed.
    superraggedborder
    The superraggedborder style is like style is like superragged but has - horizontal and vertical lines around it. + id="dx1-74016"> but has horizontal + and vertical lines around it.
    superraggedheader
    The superraggedheader style is like style is like superragged but has a - header row. + id="dx1-74018"> but has a header + row.
    superraggedheaderborder
    The The superraggedheaderborder - style is like style is like + superraggedheader but has horizontal and vertical lines around - it. + id="dx1-74020"> but has horizontal and vertical lines around it.
    superragged3col
    The superragged3col style is like 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) 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 . + 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 . The width of the third column is governed by the length + \glspagelistwidth. + id="dx1-74025">.
    superragged3colborder
    The The superragged3colborder style is like the - style is like the superragged3col style but has horizontal and vertical lines around it. + id="dx1-74027"> + style but has horizontal and vertical lines around it.
    superragged3colheader
    The The superragged3colheader style is like - style is like superragged3col but has a header row. - - + id="dx1-74029"> but + has a header row. + +
    superragged3colheaderborder
    The superragged3colheaderborder style is like +class="description">The superragged3colheaderborder style is like superragged3colheader but has horizontal and vertical lines around it. + id="dx1-74031"> but has horizontal + and vertical lines around it.
    altsuperragged4col
    The altsuperragged4col style is like 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. + id="dx1-74033"> but has an + additional column in which the entry’s associated symbol appears. The column + widths for the name and symbol column are governed by the widest entry in the + given column.
    altsuperragged4colborder
    The The altsuperragged4colborder style is like the + id="dx1-74034"> style is like the altsuperragged4col style but has horizontal and vertical lines around it. + id="dx1-74035"> style but has horizontal and vertical lines around it.
    altsuperragged4colheader
    The The altsuperragged4colheader style is like + id="dx1-74036"> style is like altsuperragged4col but has a header row. + id="dx1-74037"> but has a header row.
    altsuperragged4colheaderborder
    The altsuperragged4colheaderborder style - is like style is like + altsuperragged4colheader but has horizontal and vertical lines around - it. + id="dx1-74039"> but has horizontal and vertical lines around it.
    -

    +

    -

    Top

    15.1.6

    Top

    15.1.7 Tree-Like Styles

    -

    The styles described in this section are all defined in the package

    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 -. 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 or nostyles package options. These styles all format the entry name -using: -


    package options. These styles +all format the entry name using: +


    \glstreenamefmt  \glstreenamefmt{name}

    -

    +

    This defaults to \textbf{name}, but note that ⟨name⟩ includes \glsnamefont so the -bold setting in \glstreenamefont may be counteracted by another font change in -\glsnamefont (or in \acronymfont). The tree-like styles that also display the header -use \glstreenamefmt to format the heading. + id="dx1-75005"> so the bold +setting in \glstreenamefont may be counteracted by another font change in \glsnamefont +(or in \acronymfont). The tree-like styles that also display the header use \glstreenamefmt +to format the heading.

    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 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. + id="dx1-75007">. + +
    indexgroup
    The indexgroup style is similar to the style is similar to the index style except that each - group has a heading. + id="dx1-75009"> style except that each group + has a heading.
    indexhypergroup
    The indexhypergroup style is like style is like indexgroup but has a set of - links to the glossary groups. The navigation line is the same as that for - but has a set of links + to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-75012">, + described above.
    tree
    The The tree style is similar to the style is similar to the index style except that it can have arbitrary - levels. (Note that style except that it can have arbitrary + levels. (Note that makeindex is limited to three levels, so you will need to + id="dx1-75015"> 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 + id="dx1-75016"> 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 \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.) + id="dx1-75018"> style instead. (See below.)
    treegroup
    The treegroup style is similar to the style is similar to the tree style except that each group - has a heading. + id="dx1-75020"> style except that each group has a + heading.
    treehypergroup
    The The treehypergroup style is like style is like treegroup but has a set of - links to the glossary groups. The navigation line is the same as that for - but has a set of links to + the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-75023">, + described above.
    treenoname
    The treenoname style is like the style is like the tree style except that the name - for each sub-entry is ignored. + id="dx1-75025"> style except that the name for each + sub-entry is ignored.
    treenonamegroup
    The treenonamegroup style is similar to the style is similar to the treenoname style - except that each group has a heading. + id="dx1-75027"> style except + that each group has a heading.
    treenonamehypergroup
    The The treenonamehypergroup style - is like style is like treenonamegroup but has a set of links to the glossary groups. The - navigation line is the same as that for but + has a set of links to the glossary groups. The navigation line is the same as that + for listhypergroup, described above. + id="dx1-75030">, described above.
    alttree
    The alttree style is similar to the style is similar to the tree style except that the indentation for - each level is determined by the width of the text specified by -


    style except that the indentation for each level + is determined by the width of the text specified by +


    \glssetwidest  \glssetwidest[level]{text}

    - - -

    +

    The optional argument ⟨level⟩ indicates the level, where 0 indicates the top-most - level, 1 indicates the first level sub-entries, etc. If \glssetwidest hasn’t been - used for a given sub-level, the level 0 widest text is used instead. If ⟨level⟩ is - omitted, 0 is assumed. -

    For each level, the name is placed to the left of the paragraph block containing - the symbol (optional) and the description. If the symbol is present, it is placed - in parentheses before the description. +class="cmti-10">level⟩ indicates the level, where 0 indicates the top-most level, 1 + indicates the first level sub-entries, etc. If \glssetwidest hasn’t been used for a + given sub-level, the level 0 widest text is used instead. If ⟨level⟩ is omitted, 0 is + assumed. + + +

    For each level, the name is placed to the left of the paragraph block containing the + symbol (optional) and the description. If the symbol is present, it is placed in + parentheses before the description.

    alttreegroup
    The alttreegroup is like the is like the alttree style except that each group has a + id="dx1-75035"> style except that each group has a heading.
    alttreehypergroup
    The alttreehypergroup style is like style is like alttreegroup but has a set of - links to the glossary groups. The navigation line is the same as that for - but has a set of links to + the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-75038">, described + above.
    -

    +

    -

    Top

    15.1.7

    Top

    15.1.8 Multicols Style

    -

    The

    The glossary-mcols package provides tree-like styles that are in the package provides tree-like styles that are in the multicols -environment (defined by the environment +(defined by the multicol package). The style names are as their analogous -tree styles (as defined in package). The style names are as their analogous tree styles (as +defined in §15.1.6 Tree-Like Styles) but are prefixed with “mcol”. For -example, the §15.1.7 Tree-Like Styles) but are prefixed with “mcol”. For example, the mcolindex style is essentially the +style is essentially the index style but put in a style but put in a multicols -environment. For the complete list, see environment. For the complete list, see +table 15.2. -

    Note that

    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 is not loaded by glossaries. If you want to use any of the multicol +styles in that package you need to load it explicitly with \usepackage and set the required +glossary style using \setglossarystyle. -
    -

    -

    The default number of columns is 2, but can be changed by redefining -


    .
    +

    +

    The default number of columns is 2, but can be changed by redefining +


    \glsmcols  \glsmcols

    -

    +

    to the required number. For example, for a three column glossary: - - + +

    -
    +
    \usepackage{glossary-mcols}  
    \renewcommand*{\glsmcols}{3}  
    \setglossarystyle{mcolindex}
    -

    +

    - - -


    - - + +
    Table 15.2: Multicolumn Styles
    +class="content">Multicolumn Styles
    @@ -19713,498 +20394,493 @@ class="cmbx-10">Analogous Tree Style style="vertical-align:baseline;" id="TBL-10-2-"> + id="dx1-76017"> + id="dx1-76019"> + id="dx1-76023"> + id="dx1-76025"> + id="dx1-76027"> + id="dx1-76029"> + id="dx1-76031"> + id="dx1-76033"> + id="dx1-76035">
    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
    - - + id="dx1-76037">
    + +

    -

    Top

    15.1.8

    Top

    15.1.9 In-Line Style

    -

    This section covers the

    This section covers the glossary-inline package that supplies the 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 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 . +

    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: - - + id="dx1-77004"> with this style. For example, +suppose you are required to have your glossaries and list of acronyms in a footnote, you can +do: + +

    -
    +
     \usepackage{glossary-inline}  
     \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }  
     \setglossarystyle{inline}
    -

    -

    Note that you need to include

    +

    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 - with \usepackage as it’s not automatically +included by the glossaries package and then set the style using \setglossarystyle.
    -

    -

    Where you need to include your glossaries as a footnote you can do: - - + id="dx1-77006">. +

    +

    +

    Where you need to include your glossaries as a footnote you can do: + +

    -
    +
    \footnote{\printglossaries}
    -

    -

    The

    +

    The inline style is governed by the following: -


    style is governed by the following: +


    \glsinlineseparator  \glsinlineseparator

    -

    + id="dx1-77009">


    +

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



    \glsinlinesubseparator  \glsinlinesubseparator

    -

    + id="dx1-77011">


    +

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



    \glsinlineparentchildseparator  \glsinlineparentchildseparator -

    -

    + id="dx1-77013">


    +

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


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


    \glspostinline  \glspostinline

    -

    + id="dx1-77015">


    +

    This defaults to “; ” and is used at the end of the glossary. -

    +

    -

    Top

    15.2 Defining your own glossary style

    -

    If the predefined styles don’t fit your requirements, you can define your own style +

    If the predefined styles don’t fit your requirements, you can define your own style using: -



    \newglossarystyle  \newglossarystyle{name}{definitions}

    -

    +

    where ⟨name⟩ is the name of the new glossary style (to be used in \setglossarystyle). -The second argument ⟨\setglossarystyle). The +second argument ⟨definitions⟩ needs to redefine all of the following: -



    theglossary  theglossary

    -

    -This environment defines how the main body of the glossary should be typeset. Note -that this does not include the section heading, the glossary preamble (defined by -


    +

    +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 ) +or the glossary postamble (defined by \glossarypostamble). -For example, the ). For example, the list style uses the style uses +the description environment, so the environment, so the theglossary -environment is simply redefined to begin and end the environment is simply redefined to begin and +end the description environment. -


    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

    +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 , which should not be affected by changes in the +glossary style. The list glossary style redefines glossary style redefines \glossaryheader to do - - -nothing, whereas the to do nothing, +whereas the longheader glossary style redefines \glossaryheader to do a -header row. -


    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

    +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 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 key (or +name key if the key if the sort key is omitted). The sub-divisions are in the -following order: symbols, numbers, A, …, Z. If you use 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 , 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 -


    not the group title. The group +title can be obtained via +


    \glsgetgrouptitle  \glsgetgrouptitle{label}

    -

    +

    This obtains the title as follows: if ⟨label⟩ consists of a single non-active character or -⟨label⟩ is equal to label⟩ consists of a single non-active character or ⟨label⟩ is +equal to glssymbols or glsnumbers and \labelgroupname exists, -this is taken to be the title, otherwise the title is just ⟨label⟩. (The “symbols” -group has the label glssymbols, so the command groupname exists, this is taken to be the title, +otherwise the title is just ⟨label⟩. (The “symbols” group has the label glssymbols, so the +command \glssymbolsgroupname is -used, and the “numbers” group has the label glsnumbers, so the command + id="dx1-78027"> is used, and the “numbers” group has the label glsnumbers, so the command \glsnumbersgrouptitle is used.) If you are using is used.) If you are using xindy, ⟨label⟩ may be an -active character (for example ø), in which case the title will be set to just + id="dx1-78029">, ⟨label⟩ may be an active character (for example ø), in which case the title will be set +to just ⟨label⟩. You can redefine \glsgetgrouptitle if this is unsuitable for your document. -

    A navigation hypertarget can be created using -


    A navigation hypertarget can be created using +


    \glsnavhypertarget  \glsnavhypertarget{label}{text}

    -

    +

    For further details about \glsnavhypertarget, see the documented code (glossaries-code.pdf). -

    Most of the predefined glossary styles redefine \glsgroupheading to simply -ignore its argument. The

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

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

    See also \glsgroupskip below. (Note that command definitions within -

    See also \glsgroupskip below. (Note that command definitions within \newglossarystyle must use +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

    +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 glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine \glsgroupskip to produce a -blank row. -

    As from version 3.03, the package option , whereas the tabular-like styles redefine \glsgroupskip to produce a blank +row. +

    As from version 3.03, the package option nogroupskip can be used to suppress this -default gap for the predefined styles. -


    can be used to suppress this default +gap for the predefined styles. +


    \glossentry  \glossentry{label}{number list}

    -

    -This macro indicates what to do for each level 0 glossary entry. The entry label is -given by ⟨

    +This macro indicates what to do for each level 0 glossary entry. The entry label is given +by ⟨label⟩ and the associated number list is given by ⟨number list⟩. You -can redefine is given by ⟨number list⟩. You can redefine +\glossentry to use commands like to use commands like \glossentryname{label}, -}, \glossentrydesc{label} and } and +\glossentrysymbol{label} to display the name, -description and symbol fields, or to access other fields, use commands like -} to display the name, description and symbol fields, or +to access other fields, use commands like \glsentryuseri{label}. (See §9 Using Glossary Terms Without Links for further -details.) You can also use the following commands: -


    Using +Glossary Terms Without Links for further details.) You can also use the following +commands: +


    \glsentryitem  \glsentryitem{label}

    -

    -This macro will increment and display the associated counter for the main (level 0) -entries if the

    +This macro will increment and display the associated counter for the main (level 0) entries if +the entrycounter or or counterwithin package options have been used. This macro -is typically called by package options have been used. This macro is typically +called by \glossentry before \glstarget. The format of the counter is -controlled by the macro -


    \glstarget. The format of the counter is controlled by the +macro +


    \glsentrycounterlabel  \glsentrycounterlabel

    -

    -

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are -enabled) to the relevant line in the glossary. Your new glossary style must -therefore redefine \glossentry to set the appropriate target. This is done -using -


    +

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the +relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to +set the appropriate target. This is done using +


    \glstarget  \glstarget{label}{text}

    -

    +

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

    For example, the +package has been loaded, as \glstarget won’t create a target if \hypertarget hasn’t been +defined. +

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

    -
    +
      \renewcommand*{\glossentry}[2]{%  
        \item[\glsentryitem{##1}%  
              \glstarget{##1}{\glossentryname{##1}}]  
           \glossentrydesc{##1}\glspostdescription\space ##2}
    -

    -

    Note also that ⟨

    +

    Note also that ⟨number list⟩ will always be of the form -



    \glossaryentrynumbers{\relax
    \setentrycounter[Hprefix]{format cmd{number(s)}} -

    -

    +class="cmsy-10">}


    +

    where ⟨number(s)⟩ may contain \delimN (to delimit individual numbers) and/or + id="dx1-78053"> (to delimit individual numbers) and/or \delimR (to indicate a range of numbers). There may be multiple occurrences -of (to indicate a range of numbers). There may be multiple occurrences of +\setentrycounter[Hprefix]{}format cmd{number(s)}, -but note that the entire number list is enclosed within the argument of -}, 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 . 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 is to provide a means of +suppressing the number list altogether. (In fact, the nonumberlist option redefines 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 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 + id="dx1-78060"> package option. -



    \subglossentry  \subglossentry{level}{label}{number list}

    -

    +

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


    described above. +


    \glssubentryitem  \glssubentryitem{label}

    -

    -This macro will increment and display the associated counter for the level 1 entries if -the

    +This macro will increment and display the associated counter for the level 1 entries if the +subentrycounter package option has been used. This macro is typically called by + id="dx1-78064"> package option has been used. This macro is typically called by \subglossentry before \glstarget. The format of the counter is controlled by the + id="dx1-78065">. The format of the counter is controlled by the macro -



    \glssubentrycounterlabel  \glssubentrycounterlabel

    -

    -

    Note that

    +

    Note that \printglossary (which (which \printglossaries calls) sets -


    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 (

    +to the current glossary label, so it’s possible to create a glossary style that varies according to +the glossary type. +

    For further details of these commands, see “Displaying the glossary” in the documented +code (glossaries-code.pdf). -

    + + +

    Example 26 (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 +

    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 environment, so theglossary should -start and end that environment. Let’s also suppose that you don’t want anything -between the glossary groups (so +should start and end that environment. Let’s also suppose that you don’t want +anything between the glossary groups (so \glsgroupheading and and \glsgroupskip should do -nothing) and suppose you don’t want anything to appear immediately after - +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 + id="dx1-78078"> 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, 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}% @@ -20374,40 +21047,40 @@ follows:  
       \glossentry{##2}{##3}}%  
     }
    -

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly -the same way as the top level entries. It also hasn’t used

    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 - or \glssubentryitem so it won’t be affected by the so +it won’t be affected by the entrycounter, , counterwithin or - or subentrycounter package options. -

    Variations:

    + id="dx1-78084"> package +options. +

    Variations:

    • You might want the entry name to be capitalised, in which case use \Glossentryname instead of instead of \glossentryname. + id="dx1-78086">.
    • -
    • You might want to check if the symbol hasn’t been set and omit the parentheses - if the symbol is absent. In this case you can use You might want to check if the symbol hasn’t been set and omit the parentheses if + the symbol is absent. In this case you can use \ifglshassymbol (see (see §16 Utilities): - - -
      + + +
       \renewcommand*{\glossentry}[2]{%  
       \item % bullet point  
       \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -20420,82 +21093,82 @@ href="#sec:utilities">Utilities):  
       \space [##2]% the number list in square brackets  
       }%
      -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 27 (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 +

    If you want to define a new style that is a slightly modified version of an existing style, +you can use \setglossarystyle within the second argument of - within the second argument of \newglossarystyle followed by whatever alterations you require. For example, -suppose you want a style like the 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 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: - - + id="dx1-78093"> +between groups, then you can create a new glossary style called, say, mylist as +follows: + +

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

    (In this case, you can actually achieve the same effect using the

    (In this case, you can actually achieve the same effect using the list style in -combination with the package option style in combination with +the package option nogroupskip.)

    + id="dx1-78095">.)

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 28 (Example: creating a glossary style that uses the - (Example: creating a glossary style that uses the user1, , +…, user6 keys) -

    Suppose each entry not only has an associated symbol, but also units (stored in - +

    Suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension (stored in ) and +dimension (stored in user2). Then you can define a glossary style that -displays each entry in a ). Then you can define a glossary style that displays each entry in a +longtable as follows: - - + id="dx1-78102"> as follows: + +

    -
    +
    \newglossarystyle{long6col}{%  
     % put the glossary in a longtable environment:  
     \renewenvironment{theglossary}% @@ -20534,33 +21207,37 @@ class="cmss-10">longtable \renewcommand*{\glsgroupskip}{}%  
    }
    -

    +

    -

    -

    ____________________________

    - - -

    -

    +

    ____________________________

    + + +

    +

    Top

    16. Utilities

    -

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

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

    -

    Top

    16.1 Loops

    -

    Some of the commands described here take a comma-separated list as an argument. -As with LAT

    Some of the commands described here take a comma-separated list as an argument. As with +LATEX’s \@for command, make sure your list doesn’t have any unwanted -spaces in it as they don’t get stripped.
    -

    -


    \@for command, make sure your list doesn’t have any unwanted spaces in it as +they don’t get stripped. (Discussed in more detail in §2.7.2 of “LATEX for Administrative +Work”.)
    +

    +


    \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 ⟨body⟩ is performed. If ⟨glossary list⟩ is omitted, the default is to iterate over all glossaries (except the ignored ones). -



    \forallacronyms  \forallacronyms{cs}{body}

    -

    +

    This is like \forallglossaries but only iterates over the lists of acronyms (that have previously been declared using \DeclareAcronymList or the or the acronymlists package -option). This command doesn’t have an optional argument. If you want to -explicitly say which lists to iterate over, just use the optional argument of - package option). +This command doesn’t have an optional argument. If you want to explicitly say which lists to +iterate over, just use the optional argument of \forallglossaries. -



    \forglsentries  \forglsentries[glossary label]{cs}{body}

    -

    +

    This iterates through all entries in the glossary given by ⟨glossary label⟩. At each -iteration ⟨cs⟩ (which must be a control sequence) is set to the entry label for the current -iteration and ⟨body⟩ is performed. If ⟨glossary label⟩. At each iteration ⟨cs⟩ +(which must be a control sequence) is set to the entry label for the current iteration and ⟨body⟩ +is performed. If ⟨glossary label⟩ is omitted, \glsdefaulttype -(usually the main glossary) is used. -


    (usually the main glossary) is +used. +


    \forallglsentries  \forallglsentries[glossary list]{cs}{body}

    -

    +

    This is like \forglsentries but for each glossary in ⟨glossary list⟩ (a comma-separated -list of glossary labels). If ⟨glossary list⟩ is omitted, the default is the list of all defined -glossaries (except the ignored ones). At each iteration ⟨cs⟩ is set to the entry label -and ⟨body⟩ is performed. (The current glossary label can be obtained using -glossary list⟩ (a comma-separated list of +glossary labels). If ⟨glossary list⟩ is omitted, the default is the list of all defined glossaries +(except the ignored ones). At each iteration ⟨cs⟩ is set to the entry label and ⟨body⟩ is +performed. (The current glossary label can be obtained using \glsentrytype{cs} within ⟨} within +⟨body⟩.) -

    +

    -

    Top

    16.2 Conditionals

    -



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

    - - -

    + + +

    This checks if the glossary given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, -otherwise ⟨true part⟩ is performed, otherwise +⟨false part⟩. -



    \ifglsentryexists  \ifglsentryexistslabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. (Note that \ifglsentryexists will always be true after the -containing glossary has been displayed via \ifglsentryexists will always be true after the containing +glossary has been displayed via \printglossary or or \printglossaries -even if the entry is explicitly defined later in the document. This is because the entry -has to be defined before it can be displayed in the glossary, see even if the entry is +explicitly defined later in the document. This is because the entry has to be defined +before it can be displayed in the glossary, see §4.10.1 Technical -Issues for further details.) -


    Technical Issues for further +details.) +


    \glsdoifexists  \glsdoifexists{label}{code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists. If it doesn’t exist, an error is generated. -(This command uses label⟩ exists. If it doesn’t exist, an error is generated. (This +command uses \ifglsentryexists.) -



    \glsdoifnoexists  \glsdoifnoexists{label}{code}

    -

    +

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -



    \glsdoifexistsorwarn  \glsdoifexistsorwarn{label}{code}

    -

    +

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -



    \glsdoifexistsordo  \glsdoifexistsordo{label}{code}{else code} -

    -

    +class="cmtt-10">}


    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists otherwise generate an error and do ⟨else code⟩. -



    \glsdoifnoexistsordo  \glsdoifnoexistsordo{label}{code}{else code} -

    -

    +class="cmtt-10">}


    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ doesn’t exist otherwise generate an error and do -⟨else code⟩. -


    label⟩ doesn’t exist otherwise generate an error and do ⟨else +code⟩. +


    \ifglsused  \ifglsusedlabel⟩⟨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 ⟨label⟩ has any sub-entries. If it does, ⟨true -part⟩ is performed, otherwise ⟨true part⟩ is +performed, otherwise ⟨false part⟩. -



    \ifglshasparent  \ifglshasparentlabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has a parent entry. If it does, ⟨true part⟩ -is performed, otherwise ⟨true part⟩ is +performed, otherwise ⟨false part⟩. -



    \ifglshassymbol  \ifglshassymbol{label}{true part}{false part} -

    -

    - - +class="cmtt-10">}


    +

    This checks if the glossary entry given by ⟨label⟩ has had the symbol field set. If it has, -⟨true part⟩ is performed, otherwise ⟨ field set. If it has, ⟨true part⟩ +is performed, otherwise ⟨false part⟩. -



    \ifglshaslong  \ifglshaslong{label}{true part}{false part}

    -

    + + +

    This checks if the glossary entry given by ⟨label⟩ has had the long field set. If it has, ⟨true + id="dx1-81016"> field set. If it has, ⟨true part⟩ is +performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that -has been defined via \newacronym. There is no check for the existence of -⟨. There is no check for the existence of ⟨label⟩. -



    \ifglshasshort  \ifglshasshort{label}{true part}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the short field set. If it has, -⟨true part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that -has been defined via field set. If it has, ⟨true part⟩ +is performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via +\newacronym. There is no check for the existence of -⟨. There is no check for the existence of ⟨label⟩. -



    \ifglshasdesc  \ifglshasdesc{label}{true part}{false part}

    -

    +

    This checks if the description field is non-empty for the entry given by ⟨label⟩. If it has, -⟨true part⟩ is performed, otherwise ⟨ field is non-empty for the entry given by ⟨label⟩. If it has, ⟨true part⟩ +is performed, otherwise ⟨false part⟩. Compare with: -



    \ifglsdescsuppressed  \ifglsdescsuppressed{label}{}{false part}

    -

    +

    This checks if the description field has been set to just field has been set to just \nopostdesc for the entry given -by ⟨ for the entry given by +⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. There is no check for -the existence of ⟨false part⟩. There is no check for the existence +of ⟨label⟩. -

    For all other fields you can use: -


    For all other fields you can use: +


    \ifglshasfield{field}{true part}{false part}

    -

    +

    This checks if the field given by ⟨field⟩ for the entry identified by ⟨label⟩ is empty. If it is, -⟨true part⟩ is performed, otherwise ⟨false part⟩. If the field supplied is unrecognised ⟨false -part⟩ is performed and a warning is issued. Unlike the above commands, such as +class="cmti-10">label⟩ is empty. If it is, ⟨true \ifglshasshort, an error occurs if the entry is undefined. -

    You can test if the value of the field is equal to a given string using: -


    part⟩ is performed, otherwise ⟨false part⟩. If the field supplied is unrecognised ⟨false part⟩ is +performed and a warning is issued. Unlike the above commands, such as \ifglshasshort, an +error occurs if the entry is undefined. +

    You can test if the value of the field is equal to a given string using: +


    \ifglsfieldeq  \ifglsfieldeq{label}{}{false}

    -

    +

    In this case the ⟨field⟩ must be the field name not the key (see table 4.1). If the field -isn’t recognised, an error will occur. This command internally uses table 4.1). If the +field isn’t recognised, an error will occur. This command internally uses etoolbox’s + id="dx1-81027">’s \ifcsstring to perform the comparison. The string is not expanded during the test. -

    The result may vary depending on whether or not expansion is on for the given -field (when the entry was defined). For example: - - +

    The result may vary depending on whether or not expansion is on for the given field +(when the entry was defined). For example: + +

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -20998,26 +21668,25 @@ field (when the entry was defined). For example:  
    \ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  
    \end{document}
    -

    This will produce “TRUE” in both cases since expansion is on, so \foo was -expanded to “FOO” when sample2 was defined. If the tests are changed -to: - - +

    This will produce “TRUE” in both cases since expansion is on, so \foo was expanded to +“FOO” when sample2 was defined. If the tests are changed to: + +

    -
    +
    \ifglsfieldeq{sample1}{useri}{\foo}{TRUE}{FALSE}.  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.
    -

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off -for the

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the +user1 key: - - + id="dx1-81028"> key: + +

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -21031,14 +21700,14 @@ class="cmss-10">user1\ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  
    \end{document}
    -

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and +

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and “FALSE” for the second case (comparing “\foo” with “FOO”). -

    The reverse happens in the following: - - +

    The reverse happens in the following: + +

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -21052,17 +21721,17 @@ class="cmtt-10">\foo” with “FOO”).  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    This now produces “FALSE” for the first case (comparing “FOO” with “

    This now produces “FALSE” for the first case (comparing “FOO” with “\foo”) and “TRUE” for the second case (comparing “\foo” with “\foo”). -

    You can test if the value of a field is equal to the replacement text of a command +

    You can test if the value of a field is equal to the replacement text of a command using: -



    \ifglsfielddefeq  \ifglsfielddefeq{label}{}{false}

    -

    +

    This internally uses etoolbox’s \ifdefstrequal command to perform the comparison. -The argument ⟨’s \ifdefstrequal command to perform the comparison. The +argument ⟨command⟩ must be a macro. -

    For example: - - +

    For example: + +

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -21100,32 +21769,32 @@ class="cmti-10">command⟩ must be a macro.  
    \ifglsfielddefeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    Here, the first case produces “TRUE” since the value of the useri field (“FOO”) is -the same as the replacement text (definition) of \foo (“FOO”). We have the result +

    Here, the first case produces “TRUE” since the value of the useri field (“FOO”) is the same +as the replacement text (definition) of \foo (“FOO”). We have the result “FOO” is equal to “FOO” is equal to “FOO”. -

    The second case produces “FALSE” since the value of the

    The second case produces “FALSE” since the value of the useri field (“\foo”) is -not the same as the replacement text (definition) of \foo (“FOO”). No expansion has -been performed on the value of the \foo”) is not the +same as the replacement text (definition) of \foo (“FOO”). No expansion has been +performed on the value of the useri field. We have the result “\foo” is not equal -to “\foo” is not equal to +“FOO”. -

    If we add: - - +

    If we add: + +

    -
    +
    \newcommand{\FOO}{\foo}  
    \ifglsfielddefeq{sample2}{useri}{\FOO}{TRUE}{FALSE}.
    -

    we now get “TRUE” since the value of the

    we now get “TRUE” since the value of the useri field (“\foo”) is the same as the replacement text (definition) of \foo”). We have the result “\foo” is equal to “\foo”. -

    There is a similar command that requires the control sequence name (without the -leading backslash) instead of the actual control sequence: -


    There is a similar command that requires the control sequence name (without the leading +backslash) instead of the actual control sequence: +


    \ifglsfieldcseq  \ifglsfieldcseq{label}{}{false}

    -

    +

    This internally uses etoolbox’s ’s \ifcsstrequal command instead of \ifdefstrequal. -

    +

    -

    Top

    16.3 Fetching and Updating the Value of a Field

    -

    You can fetch the value of a given field and store it in a control sequence -using: -


    You can fetch the value of a given field and store it in a control sequence using: +


    \glsfieldfetch  \glsfieldfetch{label}{field}{cs}

    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see @@ -21184,33 +21852,32 @@ class="cmti-10">field⟩ is the field label (see href="#tab:fieldmap">table 4.1) and ⟨cs⟩ is the control sequence in which to store the value. Remember that ⟨field⟩ is the internal label and is not necessarily the same as the key used to set that -field in the argument of field⟩ is the internal label and is not necessarily the same as the key used to set +that field in the argument of \newglossaryentry (or the optional argument of \newacronym). -

    You can change the value of a given field using one of the following commands. -Note that these commands only change the value of the given field. They have no -affect on any related field. For example, if you change the value of the

    You can change the value of a given field using one of the following commands. Note that +these commands only change the value of the given field. They have no affect on any related +field. For example, if you change the value of the text field, it -won’t modify the value given by the field, it won’t modify the value given by +the name, , plural, , first or any other related -key. -

    In all the four related commands below, ⟨ or any other related key. +

    In all the four related commands below, ⟨label⟩ and ⟨field⟩ are as above and ⟨definition⟩ -is the new value of the field. -


    definition⟩ is the +new value of the field. +


    \glsfielddef  \glsfielddef{label}{field}{definition}

    -

    +

    This uses \def to change the value of the field (so it will be localised by any -grouping). -


    \def to change the value of the field (so it will be localised by any grouping). +


    \glsfieldedef  \glsfieldedef{label}{field}{definition}

    -

    +

    This uses \edef to change the value of the field (so it will be localised by -any grouping). Any fragile commands contained in the ⟨definition⟩ must be -protected. - - -


    \edef to change the value of the field (so it will be localised by any grouping). Any +fragile commands contained in the ⟨definition⟩ must be protected. +


    \glsfieldgdef  \glsfieldgdef{label}{field}{definition}

    -

    +

    This uses \gdef to change the value of the field. -



    \glsfieldxdef  \glsfieldxdef{label}{field}{definition}

    -

    +

    This uses \xdef to change the value of the field. Any fragile commands contained in -the ⟨\xdef to change the value of the field. Any fragile commands contained in the +⟨definition⟩ must be protected. - - + +

    -

    -

    +

    Top

    17. Prefixes or Determiners

    -

    The

    The glossaries-prefix package provides additional keys that can be used as prefixes. -For example, if you want to specify determiners (such as “a”, “an” or “the”). The - package that comes with the glossaries package provides additional +keys that can be used as prefixes. For example, if you want to specify determiners (such as +“a”, “an” or “the”). The glossaries-prefix package automatically loads the glossaries package and has the same -package options. -

    The extra keys for glossaries package +and has the same package options. +

    The extra keys for \newglossaryentry are as follows: + id="dx1-83002"> are as follows:

    prefix
    The prefix associated with the text key. This defaults to nothing. + id="dx1-83004"> key. This defaults to nothing.
    prefixplural
    The prefix associated with the plural key. This defaults to nothing. + id="dx1-83006"> key. This defaults to nothing.
    prefixfirst
    The prefix associated with the first key. If omitted, this defaults to - the value of the key. If omitted, this defaults to the value + of the prefix key. + id="dx1-83009"> key.
    prefixfirstplural
    The prefix associated with the firstplural key. If omitted, this - defaults to the value of the key. If omitted, this defaults + to the value of the prefixplural key.
    + id="dx1-83012"> key. -

    +

    Example 29 (Defining Determiners) -

    Here’s the start of my example document: - - + id="x1-83014"> +

    Here’s the start of my example document: + +

    -
    +
    documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage[toc,acronym]{glossaries-prefix}
    -

    Note that I’ve simply replaced glossaries from previous -sample documents with glossaries-prefix. Now for a sample -definition17.1: - - +

    Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a +sample definition17.1: + +

    -
    +
    \newglossaryentry{sample}{name={sample},%  
      description={an example},%  
      prefix={a~},%  
      prefixplural={the\space}%  
    }
    -

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the -possibility of prefixes that shouldn’t have a space, such as: - - +

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility +of prefixes that shouldn’t have a space, such as: + +

    -
    +
    \newglossaryentry{oeil}{name={oeil},  
      plural={yeux},  
      description={eye},  
      prefix={l’},  
      prefixplural={les\space}}
    -

    Where a space is required at the end of the prefix, you must use a spacing command, -such as

    Where a space is required at the end of the prefix, you must use a spacing command, such as +\space, \␣ (backslash space) or ~ due to the automatic spacing trimming -performed in ⟨~ due to the automatic spacing trimming performed in +⟨key⟩=⟨value⟩ options. -

    The prefixes can also be used with acronyms. For example: - - +

    The prefixes can also be used with acronyms. For example: + +

    -
    +
    \newacronym  
     [%  
       prefix={an\space},prefixfirst={a~}%  
     ]{svm}{SVM}{support vector machine}
    -

    +

    -

    -

    ____________________________

    -

    The

    +

    ____________________________

    +

    The glossaries-prefix package provides convenient commands to use these prefixes -with commands such as package provides convenient commands to use these prefixes with +commands such as \gls. Note that the prefix is not considered part of the link -text, so it’s not included in the hyperlink (where hyperlinks are enabled). The options -and any star or plus modifier are passed on to the . Note that the prefix is not considered part of the link text, so it’s +not included in the hyperlink (where hyperlinks are enabled). The options and any star or +plus modifier are passed on to the \gls-like command. (See §6 Links -to Glossary Entries for further details.) -


    Links to Glossary Entries for +further details.) +


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

    -

    +

    This is inserts the value of the prefix key (or key (or prefixfirst key, on key, on first use) in front of \gls[label}[insert]. -



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

    -

    +

    If the prefix key (or key (or prefixfirst, on first use) has been set, this displays the -value of that key with the first letter converted to upper case followed by -, on first use) has been set, this displays the value of that key +with the first letter converted to upper case followed by \gls[options]{label}[insert]. If that key hasn’t been set, this is equivalent to -]. If that +key hasn’t been set, this is equivalent to \Gls[options]{label}[insert]. -



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

    -

    +

    As \pgls but converts the prefix to upper case and uses \GLS instead of - instead of \gls. -



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

    -

    +

    This is inserts the value of the prefixplural key (or key (or prefixfirstplural key, on first use) in -front of key, on first use) in front of +\glspl[options]{label}[insert]. -



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

    -

    +

    If the prefixplural key (or key (or prefixfirstplural, on first use) has been set, this displays the -value of that key with the first letter converted to upper case followed by + id="dx1-83034">, on first use) has been set, this displays +the value of that key with the first letter converted to upper case followed by \glspl[optionsinsert]. If that key hasn’t been set, this is equivalent to \Glspl[options]{label}[insert]. -



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

    -

    +

    As \pglspl but converts the prefix to upper case and uses \GLSpl instead of - instead of \glspl. - - + + -

    +

    Example 30 (Using Prefixes) -

    Continuing from Example 29, now that I’ve defined my entries, I can use them in -the text via the above commands: - - -

    -
    + id="x1-83039"> +

    Continuing from Example 29, now that I’ve defined my entries, I can use them in the text +via the above commands: + + +

    +
    First use: \pgls{svm}. Next use: \pgls{svm}.  
    Singular: \pgls{sample}, \pgls{oeil}.  
    Plural: \pglspl{sample}, \pglspl{oeil}.
    -

    which produces: +

    which produces:

    -

    First use: a support vector machine (SVM). Next use: an SVM. - Singular: a sample, l’oeil. Plural: the samples, les yeux.

    -

    For a complete document, see

    First use: a support vector machine (SVM). Next use: an SVM. Singular: + a sample, l’oeil. Plural: the samples, les yeux.

    +

    For a complete document, see sample-prefix.tex.

    -

    -

    ____________________________

    -

    This package also provides the commands described below, none of which perform -any check to determine the entry’s existence. -


    +

    ____________________________

    +

    This package also provides the commands described below, none of which perform any +check to determine the entry’s existence. +


    \ifglshasprefix  \ifglshasprefix{label}{true part}{false part} -

    -

    +class="cmtt-10">}


    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefix + id="dx1-83041"> key. -

    This package also provides the following commands: -


    This package also provides the following commands: +


    \ifglshasprefixplural  \ifglshasprefixplural{label}{true part}{false -part}

    -

    +class="cmitt-10">false part⟩} +


    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixplural + id="dx1-83043"> key. -



    \ifglshasprefixfirst  \ifglshasprefixfirst{label}{true part}{false -part}

    -

    +class="cmitt-10">false part⟩} +


    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirst + id="dx1-83045"> key. -

    \ifglshasprefixfirstplural  -


    +


    \ifglshasprefixfirstplural{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the -label⟩ has a non-empty value for the prefixfirstplural key. -


    +key. +


    \glsentryprefix  \glsentryprefix{label}

    -

    +

    Displays the value of the prefix key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixfirst  \glsentryprefixfirst{label}

    - - -

    +

    Displays the value of the prefixfirst key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixplural  \glsentryprefixplural{label}

    -

    +

    Displays the value of the prefixplural key for the entry given by ⟨label⟩. (No check is -performed to determine if the entry exists.) -

    key for the entry given by ⟨label⟩. (No check is performed +to determine if the entry exists.) +

    \glsentryprefixfirstplural  -


    +


    \glsentryprefixfirstplural{label}

    -

    +

    Displays the value of the prefixfirstplural key for the entry given by ⟨ key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    There are also variants that convert the first letter to upper +

    There are also variants that convert the first letter to upper case17.2: -


    17.2: +


    \Glsentryprefix  \Glsentryprefix{label}

    -

    -


    +


    \Glsentryprefixfirst  \Glsentryprefixfirst{label}

    -

    -


    +


    \Glsentryprefixplural  \Glsentryprefixplural{label}

    -

    -

    +

    \Glsentryprefixfirstplural  -


    +


    \Glsentryprefixfirstplural{label}

    -

    -

    As with analogous commands such as

    +

    As with analogous commands such as \Glsentrytext, these commands aren’t + id="dx1-83061">, these commands aren’t expandable so can’t be used in PDF bookmarks.
    -

    +

    -

    +

    Example 31 (Adding Determiner to Glossary Style) -

    You can use the above commands to define a new glossary style that uses the -determiner. For example, the following style is a slight modification of the +

    You can use the above commands to define a new glossary style that uses the determiner. +For example, the following style is a slight modification of the list style -that inserts the prefix before the name: - - + id="dx1-83064"> style that inserts the prefix +before the name: + +

    -
    +
    \newglossarystyle{plist}{%  
      \setglossarystyle{list}%  
      \renewcommand*{\glossentry}[2]{% @@ -21796,164 +22455,163 @@ that inserts the prefix before the name:  
           \glossentrydesc{##1}\glspostdescription\space ##2}%  
    }
    -

    +

    -

    -

    ____________________________

    - - -

    -

    +

    ____________________________

    + + +

    +

    Top

    18. Accessibility Support

    -

    Limited accessibility support is provided by the accompanying

    Limited accessibility support is provided by the accompanying glossaries-accsupp -package, but note that this package is experimental and it requires the 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: + id="dx1-84002"> 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
    The replacement text corresponding to the name key. + id="dx1-84004"> key.
    textaccess
    The replacement text corresponding to the text key. + id="dx1-84006"> key.
    firstaccess
    The replacement text corresponding to the first key. + id="dx1-84008"> key.
    pluralaccess
    The replacement text corresponding to the plural key. + id="dx1-84010"> key.
    firstpluralaccess
    The replacement text corresponding to the firstplural key. + id="dx1-84012"> key.
    symbolaccess
    The replacement text corresponding to the symbol key. + id="dx1-84014"> key.
    symbolpluralaccess
    The replacement text corresponding to the symbolplural key. + id="dx1-84016"> key.
    descriptionaccess
    The replacement text corresponding to the description key. + id="dx1-84018"> key.
    descriptionpluralaccess
    The replacement text corresponding to the -
    The replacement text corresponding to the descriptionplural key. + id="dx1-84020"> + key.
    longaccess
    The replacement text corresponding to the
    The replacement text corresponding to the long key (used by - key (used by \newacronym). + id="dx1-84023">).
    shortaccess
    The replacement text corresponding to the
    The replacement text corresponding to the short key (used by + id="dx1-84025"> key (used by \newacronym). + id="dx1-84026">).
    longpluralaccess
    The replacement text corresponding to the longplural key (used - by key (used by + \newacronym). + id="dx1-84029">).
    shortpluralaccess
    The replacement text corresponding to the
    The replacement text corresponding to the shortplural key - (used by key (used by + \newacronym). + id="dx1-84032">).
    -

    For example: - - +

    For example: + +

    -
    +
    \newglossaryentry{tex}{name={\TeX},description={Document  
    preparation language},access={TeX}}
    -

    Now

    Now \gls{tex} will be equivalent to - - + +

    -
    +
    \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{}
    -

    The sample file

    The sample file sampleaccsupp.tex illustrates the glossaries-accsupp package. -

    See the documented code (glossaries-code.pdf) for further details. It is -recommended that you also read the package. +

    See the documented code (glossaries-code.pdf) for further details. I recommend that +you also read the accsupp documentation. - - + id="dx1-84034"> documentation. + +

    -

    -

    +

    Top

    19. Troubleshooting

    -

    The

    The glossaries package comes with some minimal example files, minimalgls.tex, mwe-acr-desc.tex, which can be used for testing. These 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/2014/texmf-dist/doc/latex/glossaries/. -Further information on debugging LATEX code is available at -TEX installation. For example, on my Linux partition it can be found in +/usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/. Further information on +debugging LATEX code is available at http://www.dickimaw-books.com/latex/minexample/. -

    If you have any problems, please first consult the

    If you have any problems, please first consult the glossaries FAQ. If that doesn’t help, try posting your query to somewhere like the comp.text.tex newsgroup, the href="http://www.latex-community.org/" >LATEX Community Forum or TEX on StackExchange. Bug reports can be -submitted via EX on StackExchange. Bug reports can be submitted via +my package bug report form. - - -

    - - + +

    Top

    Index

    Index Symbols
    \@gls@codepage  4
    class="cmtt-10">\@xdylanguage  5
    -

    A -\AA  6
    -\Ac  7
    -\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
    +href="glossaries-user.html#dx1-84002" >6, 7
    \ACRfull  21
    +href="glossaries-user.html#dx1-59068" >8
    \Acrfull  22, 23
    +href="glossaries-user.html#dx1-59067" >9
    \acrfull  24, 25, 26, 27, 28, 29, 30
    +href="glossaries-user.html#dx1-59064" >10
    \acrfullfmt  31, 32, 33
    +href="glossaries-user.html#dx1-59065" >11
    \acrfullformat  34, 35
    +href="glossaries-user.html#dx1-59066" >12
    \ACRfullpl  36
    +href="glossaries-user.html#dx1-59071" >13
    \Acrfullpl  37, 38
    +href="glossaries-user.html#dx1-59070" >14
    \acrfullpl  39, 40
    +href="glossaries-user.html#dx1-59069" >15
    \ACRlong  41
    +href="glossaries-user.html#dx1-59057" >16
    \Acrlong  42, 43
    +href="glossaries-user.html#dx1-59056" >17
    \acrlong  44, 45
    +href="glossaries-user.html#dx1-59052" >18
    \ACRlongpl  46
    - - +href="glossaries-user.html#dx1-59060" >19
    \Acrlongpl  47, 48
    +href="glossaries-user.html#dx1-59059" >20
    \acrlongpl  49, 50
    +href="glossaries-user.html#dx1-59058" >21
    acronym styles:
        dua  51, 52, 53, 54
    +href="glossaries-user.html#dx1-61018" >22, 23, 24, 25
        dua-desc  55, 56
    +href="glossaries-user.html#dx1-61053" >26, 27
        footnote  57, 58, 59
    +href="glossaries-user.html#dx1-61019" >28, 29, 30
        footnote-desc  60
    +href="glossaries-user.html#dx1-61073" >31
        footnote-sc  61
    +href="glossaries-user.html#dx1-61064" >32
        footnote-sc-desc  62, 63, 64, 65
    +href="glossaries-user.html#dx1-5028" >33, 34, 35, 36
        footnote-sm  66
    +href="glossaries-user.html#dx1-61065" >37
        footnote-sm-desc  67
    +href="glossaries-user.html#dx1-61075" >38
        long-sc-short  68, 69, 70, 71
    +href="glossaries-user.html#dx1-61007" >39, 40, 41, 42
        long-sc-short-desc  72
    +href="glossaries-user.html#dx1-61036" >43
    + +     long-short  73, 74, 75, 76, 77, 78
    +href="glossaries-user.html#dx1-47069" >44, 45, 46, 47, 48, 49
        long-short-desc  79, 80, 81
    +href="glossaries-user.html#dx1-61035" >50, 51, 52
        long-sm-short  82, 83, 84
    +href="glossaries-user.html#dx1-61011" >53, 54, 55
        long-sm-short-desc  85
    +href="glossaries-user.html#dx1-61037" >56
        long-sp-short  86, 87, 88
    +href="glossaries-user.html#dx1-61023" >57, 58, 59
        long-sp-short-desc  89
    +href="glossaries-user.html#dx1-61038" >60
        sc-short-long  90
    +href="glossaries-user.html#dx1-61030" >61
        sc-short-long-desc  91
    +href="glossaries-user.html#dx1-61049" >62
        short-long  92
    +href="glossaries-user.html#dx1-61029" >63
        short-long-desc  93
    +href="glossaries-user.html#dx1-61048" >64
        sm-short-long  94
    +href="glossaries-user.html#dx1-61031" >65
        sm-short-long-desc  95
    +href="glossaries-user.html#dx1-61050" >66
    \acronymentry  96, 97, 98, 99, 100, 101
    +class="cmti-10">67
    \acronymfont  102, 103, 104, 105, 106, 107, 108, 109, 110
    -\acronymname  111, 112
    +class="cmti-10">68
    \acronymsort  113, 114, 115, 116, 117
    +class="cmti-10">69
    \acronymtype  118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129
    +class="cmti-10">70
    \ACRshort  130
    +href="glossaries-user.html#dx1-59046" >71
    \Acrshort  131, 132
    +href="glossaries-user.html#dx1-59045" >72
    \acrshort  133, 134, 135, 136
    +href="glossaries-user.html#dx1-59040" >73
    \ACRshortpl  137
    +href="glossaries-user.html#dx1-59049" >74
    \Acrshortpl  138, 139
    +href="glossaries-user.html#dx1-59048" >75
    \acrshortpl  140, 141
    -\Acs  142
    -\acs  143
    -\Acsp  144
    -\acsp  145
    -\addcontentsline  146
    -align (environment)  147
    +href="glossaries-user.html#dx1-59047" >76
    \altnewglossary  148
    +class="cmti-10">77
    amsgen package  149, 150
    +href="glossaries-user.html#dx1-10" >78, 79, 80
    amsmath package  151
    -\andname  152
    - - +href="glossaries-user.html#dx1-65021" >81
    arara  153
    +href="glossaries-user.html#dx1-10015" >82
    array package  154, 155
    -\AtBeginDocument  156
    -

    83, 84
    +

    B -\babel  157
    babel package  158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180
    +href="glossaries-user.html#dx1-8001" >85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107
    beamer class  181, 182
    +href="glossaries-user.html#dx1-65014" >108, 109
    beamer package  183
    -

    110
    +booktabs package  111, 112, 113
    +

    C \cGls  184
    +class="cmti-10">114
    \cgls  185, 186
    +class="cmti-10">115
    \cGlsformat  187
    +class="cmti-10">116
    \cglsformat  188
    +class="cmti-10">117
    \cGlspl  189
    +class="cmti-10">118
    \cglspl  190
    +class="cmti-10">119
    \cGlsplformat  191
    +class="cmti-10">120
    \cglsplformat  192
    -\chapter  193
    -\chapter*  194, 195
    +class="cmti-10">121
    \currentglossary  196
    -

    122
    + + +

    D datatool package  197, 198, 199, 200
    +href="glossaries-user.html#dx1-9" >123, 124, 125, 126, 127
    +datatool-base package  128
    \DeclareAcronymList  201, 202, 203, 204
    -\defentryfmt  205
    -\defglsentry  206
    +class="cmti-10">129
    \defglsentryfmt  207, 208, 209, 210, 211, 212, 213, 214, 215
    -\DefineAcronymShortcuts  216
    -\delimN  217
    +class="cmti-10">130
    \delimR  218
    -description (environment)  219, 220, 221, 222, 223
    -\descriptionname  224
    +class="cmtt-10">\DefineAcronymSynonyms  131
    doc package  225, 226, 227
    -document (environment)  228, 229, 230, 231, 232, 233, 234
    -\dtlcompare  235
    -\dtlicompare  236
    -\dtlletterindexcompare  237
    -\dtlwordindexcompare  238
    -

    132, 133, 134
    +

    E - - -\ecapitalisewords  239
    -\edef  240
    -\emph  241
    +encap  135
    entry location  242
    -\entryname  243
    +class="cmbx-10">136
    environments:
        align  244
    -    description  245, 246, 247, 248, 249
    -    document  250, 251, 252, 253, 254, 255, 256
    -    equation  257
    -    frame  258
    -    itemize  259
    -    longtable  260, 261, 262, 263, 264, 265
    -    multicols  266, 267
    -    supertabular  268, 269, 270, 271, 272
    -    tabular  273, 274
    -    theglossary  275, 276, 277, 278
    -equation (environment)  279
    +href="glossaries-user.html#dx1-78003" >137
    etex package  280
    +href="glossaries-user.html#dx1-17022" >138
    etoolbox package  281, 282, 283, 284, 285
    +href="glossaries-user.html#dx1-4" >139, 140, 141, 142, 143, 144
    Extended Latin Alphabet  286
    +class="cmbx-10">145
    extended Latin character  287, 146, 288, 289, 290, 291, 292, 293
    -

    147, 148, 149, 150, 151, 152
    +

    F file types
        .alg  294
    +href="glossaries-user.html#dx1-10065" >153
        .aux  295, 296, 297
    +href="glossaries-user.html#dx1-11002" >154, 155, 156
        .glg  298, 299, 300
    +href="glossaries-user.html#dx1-10064" >157, 158, 159
        .glg2  301
    +href="glossaries-user.html#dx1-20" >160
        .glo  302, 303, 304
    +href="glossaries-user.html#dx1-11018" >161, 162, 163
        .gls  305, 306
    +href="glossaries-user.html#dx1-13016" >164, 165
        .glsdefs  307
    +href="glossaries-user.html#dx1-41013" >166, 167
        .ist  308, 309, 310, 311, 312, 313
    +href="glossaries-user.html#dx1-14005" >168, 169, 170, 171, 172, 173
        .tex  314, 315
    +href="glossaries-user.html#dx1-13009" >174, 175
        .xdy  316, 317, 318, 319, 320, 321, 322, 323
    +href="glossaries-user.html#dx1-13011" >176, 177, 178, 179, 180, 181, 182, 183
        glo2  324
    +href="glossaries-user.html#dx1-19" >184
        gls2  325
    +href="glossaries-user.html#dx1-18" >185
    first use  326
    +href="glossaries-user.html#dx1-3009" >186
        flag  327
    +href="glossaries-user.html#dx1-3017" >187
        text  328
    +href="glossaries-user.html#dx1-3018" >188
    \firstacronymfont  329, 330, 331, 332, 333, 334, 335
    +class="cmti-10">189
    flowfram package  336
    +href="glossaries-user.html#dx1-73011" >190
    fmtcount package  337
    - - +href="glossaries-user.html#dx1-56035" >191
    fontspec package  338
    -\footnote  339
    +href="glossaries-user.html#dx1-28139" >192
    \forallacronyms  340
    +href="glossaries-user.html#dx1-80002" >193
    \forallglossaries  341
    +href="glossaries-user.html#dx1-80001" >194
    \forallglsentries  342
    +href="glossaries-user.html#dx1-80007" >195
    + + \forglsentries  343
    -frame (environment)  344
    -

    196
    +

    G \Genacrfullformat  345
    +href="glossaries-user.html#dx1-47065" >197
    \genacrfullformat  346, 347, 348, 349, 350, 351
    +href="glossaries-user.html#dx1-47059" >198
    \GenericAcronymFields  352, 353, 354
    +class="cmti-10">199
    \Genplacrfullformat  355
    +href="glossaries-user.html#dx1-47066" >200
    \genplacrfullformat  356, 357
    +href="glossaries-user.html#dx1-47061" >201
    glossaries package  358, 359, 360, 361, 362
    +href="glossaries-user.html#dx1-6001" >202, 203, 204, 205, 206
    glossaries-accsupp package  363, 364, 365, 366, 367
    +href="glossaries-user.html#dx1-5107" >207, 208, 209, 210, 211
    glossaries-babel package  368, 369
    +href="glossaries-user.html#dx1-17038" >212, 213
    glossaries-polyglossia package  370
    +href="glossaries-user.html#dx1-17040" >214
    glossaries-prefix package  371, 372, 373, 374, 375
    +href="glossaries-user.html#dx1-5105" >215, 216, 217, 218, 219
    glossary counters:
        glossaryentry  376
    +class="cmti-10">220
        glossarysubentry  377
    +class="cmti-10">221
    glossary package  378, 379, 380, 381, 382
    +href="glossaries-user.html#dx1-11" >222, 223, 224, 225, 226
    glossary styles:
        altlist  383, 384, 385, 386, 387
    +href="glossaries-user.html#dx1-61047" >227, 228, 229, 230, 231
        altlistgroup  388, 389
    +href="glossaries-user.html#dx1-69023" >232, 233
        altlisthypergroup  390
    +href="glossaries-user.html#dx1-69025" >234
        altlong4col  391, 392, 393
    +href="glossaries-user.html#dx1-68021" >235, 236, 237
    +    altlong4col-booktabs  238
        altlong4colborder  394
    +href="glossaries-user.html#dx1-70043" >239
        altlong4colheader  395
    +href="glossaries-user.html#dx1-70045" >240, 241
        altlong4colheaderborder  396
    +href="glossaries-user.html#dx1-70047" >242
        altlongragged4col  397, 398, 399
    +href="glossaries-user.html#dx1-71030" >243, 244, 245
    +    altlongragged4col-booktabs  246
        altlongragged4colborder  400
    +href="glossaries-user.html#dx1-71034" >247
        altlongragged4colheader  401, 402
    +href="glossaries-user.html#dx1-71036" >248, 249, 250
        altlongragged4colheaderborder  403
    +href="glossaries-user.html#dx1-71038" >251
        altsuper4col  404, 405, 406
    +href="glossaries-user.html#dx1-68022" >252, 253, 254
        altsuper4colborder  407
    +href="glossaries-user.html#dx1-73048" >255
        altsuper4colheader  408
    +href="glossaries-user.html#dx1-73050" >256
        altsuper4colheaderborder  409
    +href="glossaries-user.html#dx1-73052" >257
        altsuperragged4col  410, 411, 412
    +href="glossaries-user.html#dx1-74032" >258, 259, 260
        altsuperragged4colborder  413
    +href="glossaries-user.html#dx1-74034" >261
        altsuperragged4colheader  414, 415
    +href="glossaries-user.html#dx1-74036" >262, 263
        altsuperragged4colheaderborder  416
    +href="glossaries-user.html#dx1-74038" >264
        alttree  417, 418, 419, 420
    +href="glossaries-user.html#dx1-75018" >265, 266, 267, 268
        alttreegroup  421, 422, 423
    - - +href="glossaries-user.html#dx1-75034" >269, 270, 271
        alttreehypergroup  424, 425
    +href="glossaries-user.html#dx1-75036" >272, 273
        index  426, 427, 428, 429, 430
    +href="glossaries-user.html#dx1-75006" >274, 275, 276, 277, 278
        indexgroup  431, 432, 433
    +href="glossaries-user.html#dx1-75008" >279, 280, 281
        indexhypergroup  434, 435
    +href="glossaries-user.html#dx1-75010" >282, 283
    + +     inline  436, 437, 438
    +href="glossaries-user.html#dx1-5061" >284, 285, 286
        list  439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451
    +href="glossaries-user.html#dx1-19041" >287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299
        listdotted  452, 453, 454
    +href="glossaries-user.html#dx1-68033" >300, 301, 302
        listgroup  455, 456, 457, 458
    +href="glossaries-user.html#dx1-20020" >303, 304, 305, 306
        listhypergroup  459, 460, 461, 462, 463, 464, 465
    +href="glossaries-user.html#dx1-69014" >307, 308, 309, 310, 311, 312, 313
        long  466, 467, 468, 469, 470
    +href="glossaries-user.html#dx1-68029" >314, 315, 316, 317, 318
    +    long-booktabs  319, 320
        long3col  471, 472, 473, 474, 475
    +href="glossaries-user.html#dx1-68008" >321, 322, 323, 324, 325
    +    long3col-booktabs  326
        long3colborder  476, 477
    +href="glossaries-user.html#dx1-68010" >327, 328
        long3colheader  478, 479, 480
    +href="glossaries-user.html#dx1-68009" >329, 330, 331, 332
        long3colheaderborder  481, 482
    +href="glossaries-user.html#dx1-68011" >333, 334
        long4col  483, 484, 485, 486, 487
    +href="glossaries-user.html#dx1-68019" >335, 336, 337, 338, 339
    +    long4col-booktabs  340
        long4colborder  488, 489
    +href="glossaries-user.html#dx1-70033" >341, 342
        long4colheader  490, 491, 492
    +href="glossaries-user.html#dx1-70035" >343, 344, 345, 346
        long4colheaderborder  493, 494
    +href="glossaries-user.html#dx1-70037" >347, 348
        longborder  495
    +href="glossaries-user.html#dx1-70013" >349
        longheader  496, 497, 498
    +href="glossaries-user.html#dx1-70015" >350, 351, 352, 353
        longheaderborder  499, 500
    +href="glossaries-user.html#dx1-70017" >354, 355
        longragged  501, 502, 503, 504
    +href="glossaries-user.html#dx1-71010" >356, 357, 358, 359
    +    longragged-booktabs  360
        longragged3col  505, 506, 507, 508
    +href="glossaries-user.html#dx1-71019" >361, 362, 363, 364
    +    longragged3col-booktabs  365
        longragged3colborder  509
    +href="glossaries-user.html#dx1-71024" >366
        longragged3colheader  510, 511
    +href="glossaries-user.html#dx1-71026" >367, 368, 369
        longragged3colheaderborder  512
    +href="glossaries-user.html#dx1-71028" >370
        longraggedborder  513
    +href="glossaries-user.html#dx1-71013" >371
        longraggedheader  514, 515
    +href="glossaries-user.html#dx1-71015" >372, 373, 374
        longraggedheaderborder  516
    +href="glossaries-user.html#dx1-71017" >375
        mcolalttree  517
    +href="glossaries-user.html#dx1-76032" >376
        mcolalttreegroup  518
    +href="glossaries-user.html#dx1-76034" >377
        mcolalttreehypergroup  519
    +href="glossaries-user.html#dx1-76036" >378
        mcolindex  520, 521
    +href="glossaries-user.html#dx1-76005" >379, 380
        mcolindexgroup  522
    +href="glossaries-user.html#dx1-76016" >381
        mcolindexhypergroup  523
    +href="glossaries-user.html#dx1-76018" >382
        mcoltree  524
    +href="glossaries-user.html#dx1-76020" >383
        mcoltreegroup  525
    +href="glossaries-user.html#dx1-76022" >384
        mcoltreehypergroup  526
    +href="glossaries-user.html#dx1-76024" >385
        mcoltreenoname  527
    +href="glossaries-user.html#dx1-76026" >386
        mcoltreenonamegroup  528
    +href="glossaries-user.html#dx1-76028" >387
        mcoltreenonamehypergroup  529
    +href="glossaries-user.html#dx1-76030" >388
        super  530, 531, 532, 533
    +href="glossaries-user.html#dx1-73012" >389, 390, 391, 392
        super3col  534, 535, 536, 537
    +href="glossaries-user.html#dx1-73024" >393, 394, 395, 396
        super3colborder  538
    +href="glossaries-user.html#dx1-73029" >397
        super3colheader  539, 540
    +href="glossaries-user.html#dx1-73031" >398, 399
    + +     super3colheaderborder  541
    - - +href="glossaries-user.html#dx1-73033" >400
        super4col  542, 543, 544, 545, 546
    +href="glossaries-user.html#dx1-68020" >401, 402, 403, 404, 405
        super4colborder  547, 548
    +href="glossaries-user.html#dx1-73038" >406, 407
        super4colheader  549, 550, 551
    +href="glossaries-user.html#dx1-73040" >408, 409, 410
        super4colheaderborder  552, 553
    +href="glossaries-user.html#dx1-73042" >411, 412
        superborder  554
    +href="glossaries-user.html#dx1-73018" >413
        superheader  555, 556
    +href="glossaries-user.html#dx1-73020" >414, 415
        superheaderborder  557, 558
    +href="glossaries-user.html#dx1-53065" >416, 417
        superragged  559, 560, 561, 562
    +href="glossaries-user.html#dx1-74009" >418, 419, 420, 421
        superragged3col  563, 564, 565, 566
    +href="glossaries-user.html#dx1-74021" >422, 423, 424, 425
        superragged3colborder  567
    +href="glossaries-user.html#dx1-74026" >426
        superragged3colheader  568, 569
    +href="glossaries-user.html#dx1-74028" >427, 428
        superragged3colheaderborder  570
    +href="glossaries-user.html#dx1-74030" >429
        superraggedborder  571
    +href="glossaries-user.html#dx1-74015" >430
        superraggedheader  572, 573
    +href="glossaries-user.html#dx1-74017" >431, 432
        superraggedheaderborder  574
    +href="glossaries-user.html#dx1-74019" >433
        tree  575, 576, 577, 578, 579, 580
    +href="glossaries-user.html#dx1-62066" >434, 435, 436, 437, 438, 439
        treegroup  581, 582, 583
    +href="glossaries-user.html#dx1-75019" >440, 441, 442
        treehypergroup  584, 585
    +href="glossaries-user.html#dx1-75021" >443, 444
        treenoname  586, 587, 588
    +href="glossaries-user.html#dx1-75024" >445, 446, 447
        treenonamegroup  589, 590, 591
    +href="glossaries-user.html#dx1-75026" >448, 449, 450
        treenonamehypergroup  592, 593
    +href="glossaries-user.html#dx1-75028" >451, 452
    glossary-inline package  594, 595
    +href="glossaries-user.html#dx1-77001" >453, 454
    glossary-list package  596, 597, 598, 599, 600
    +href="glossaries-user.html#dx1-19026" >455, 456, 457, 458, 459
    glossary-long package  601, 602, 603, 604, 605, 606
    +href="glossaries-user.html#dx1-19027" >460, 461, 462, 463, 464, 465, 466, 467
    +glossary-longbooktabs package  468, 469, 470
    glossary-longragged package  607, 608, 609
    +href="glossaries-user.html#dx1-71001" >471, 472, 473, 474
    glossary-mcols package  610, 611, 612, 613
    +href="glossaries-user.html#dx1-19047" >475, 476, 477, 478
    +glossary-ragged package  479
    glossary-super package  614, 615, 616, 617, 618, 619
    +href="glossaries-user.html#dx1-19028" >480, 481, 482, 483, 484, 485
    glossary-superragged package  620, 621, 622
    +href="glossaries-user.html#dx1-74001" >486, 487, 488
    glossary-tree package  623, 624, 625, 626, 627
    +href="glossaries-user.html#dx1-19029" >489, 490, 491, 492, 493
    glossaryentry (counter)  628, 629, 630, 631
    -\glossaryentrynumbers  632, 633, 634, 635
    +class="cmti-10">494, 495, 496, 497
    \glossaryheader  636, 637, 638, 639
    -\glossaryname  640, 641
    +href="glossaries-user.html#dx1-78015" >498
    \glossarypostamble  642, 643
    +href="glossaries-user.html#dx1-53062" >499
    \glossarypreamble  644, 645, 646, 647
    -\glossarysection  648
    -\glossarystyle  649
    +href="glossaries-user.html#dx1-53060" >500
    glossarysubentry (counter)  650
    +class="cmti-10">501
    \glossentry  651, 652, 653
    +href="glossaries-user.html#dx1-78037" >502
    \Glossentrydesc  654
    +class="cmti-10">503
    \glossentrydesc  655, 656
    +class="cmti-10">504
    \Glossentryname  657, 658
    +class="cmti-10">505
    \glossentryname  659, 660, 661
    +class="cmti-10">506
    \Glossentrysymbol  662
    +class="cmti-10">507
    \glossentrysymbol  663, 664
    +class="cmti-10">508
    \GLS  665, 666, 667, 668
    - - +class="cmti-10">509
    \Gls  669, 670, 671, 672, 673, 674, 675, 676, 677, 678
    +class="cmti-10">510
    + + \gls  679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703, 704, 705, 706
    -\gls*  707
    +class="cmti-10">511
    \glsacspace  708
    +class="cmti-10">512
    \glsadd  709, 710
    +class="cmti-10">513
    \glsaddall  711, 712
    +class="cmti-10">514
    \glsaddall options
        types  713
    +href="glossaries-user.html#dx1-49004" >515
    \glsaddallunused  714
    +class="cmti-10">516
    \glsaddkey  715, 716, 717, 718
    +class="cmti-10">517
    \glsaddprotectedpagefmt  719, 720
    +href="glossaries-user.html#dx1-43024" >518
    \glsaddstoragekey  721, 722, 723, 724
    +class="cmti-10">519
    \GlsAddXdyAttribute  725, 726
    +class="cmti-10">520
    \GlsAddXdyCounters  727, 728
    +class="cmti-10">521
    \GlsAddXdyLocation  729, 730
    +class="cmti-10">522
    \glsautoprefix  731
    +class="cmti-10">523
    \glsbackslash  732
    +class="cmti-10">524
    \glscapscase  733, 734, 735
    +class="cmti-10">525
    \glsclearpage  736
    +class="cmti-10">526
    \glsclosebrace  737
    -\glscustomtex  738
    +class="cmti-10">527
    \glscustomtext  739, 740
    -\GlsDeclareNoHyperList  741, 742
    -\glsdefaulttype  743, 744, 745, 746, 747, 748
    +class="cmti-10">528
    \GLSdesc  749
    +href="glossaries-user.html#dx1-46053" >529
    \Glsdesc  750
    +href="glossaries-user.html#dx1-46052" >530
    \glsdesc  751
    +href="glossaries-user.html#dx1-46049" >531
    \glsdescwidth  752, 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763
    +class="cmti-10">532
    \glsdisablehyper  764, 765, 766, 767, 768
    +class="cmti-10">533
    \glsdisp  769, 770, 771, 772, 773, 774
    -\glsdisplay  775, 776
    -\glsdisplayfirst  777, 778
    +href="glossaries-user.html#dx1-45049" >534
    \glsdisplaynumberlist  779, 780, 781
    +class="cmti-10">535
    \glsdoifexists  782
    +href="glossaries-user.html#dx1-81005" >536
    \glsdoifexistsordo  783
    +href="glossaries-user.html#dx1-81008" >537
    \glsdoifexistsorwarn  784
    +href="glossaries-user.html#dx1-81007" >538
    \glsdoifnoexists  785
    +href="glossaries-user.html#dx1-81006" >539
    \glsdoifnoexistsordo  786
    +href="glossaries-user.html#dx1-81009" >540
    \glsdosanitizesort  787
    +class="cmti-10">541
    \glsenableentrycount  788, 789
    +class="cmti-10">542
    \glsenablehyper  790
    +class="cmti-10">543
    \glsentrycounterlabel  791
    +href="glossaries-user.html#dx1-78047" >544
    \glsentrycurrcount  792
    +class="cmti-10">545
    \Glsentrydesc  793
    +class="cmti-10">546
    \glsentrydesc  794
    - - +class="cmti-10">547
    \Glsentrydescplural  795
    +class="cmti-10">548
    \glsentrydescplural  796
    +class="cmti-10">549
    \Glsentryfirst  797
    +class="cmti-10">550
    \glsentryfirst  798
    +class="cmti-10">551
    \Glsentryfirstplural  799
    +class="cmti-10">552
    \glsentryfirstplural  800
    +class="cmti-10">553
    \glsentryfmt  801, 802, 803, 804, 805, 806, 807, 808, 809, 810
    +class="cmti-10">554
    \Glsentryfull  811
    +href="glossaries-user.html#dx1-59117" >555
    + + \glsentryfull  812, 813, 814, 815, 816, 817
    +href="glossaries-user.html#dx1-59116" >556
    \Glsentryfullpl  818
    +href="glossaries-user.html#dx1-59119" >557
    \glsentryfullpl  819
    +href="glossaries-user.html#dx1-59118" >558
    \glsentryitem  820, 821
    +href="glossaries-user.html#dx1-78044" >559
    \Glsentrylong  822, 823, 824, 825
    +href="glossaries-user.html#dx1-59109" >560
    \glsentrylong  826, 827, 828
    +href="glossaries-user.html#dx1-59108" >561
    \Glsentrylongpl  829, 830
    +href="glossaries-user.html#dx1-59111" >562
    \glsentrylongpl  831, 832
    +href="glossaries-user.html#dx1-59110" >563
    \Glsentryname  833
    +class="cmti-10">564
    \glsentryname  834, 835
    +class="cmti-10">565
    \glsentrynumberlist  836, 837
    +class="cmti-10">566
    \Glsentryplural  838
    +class="cmti-10">567
    \glsentryplural  839
    +class="cmti-10">568
    \Glsentryprefix  840
    +href="glossaries-user.html#dx1-83057" >569
    \glsentryprefix  841
    +href="glossaries-user.html#dx1-83048" >570
    \Glsentryprefixfirst  842
    +href="glossaries-user.html#dx1-83058" >571
    \glsentryprefixfirst  843
    +href="glossaries-user.html#dx1-83050" >572
    \Glsentryprefixfirstplural  844
    +href="glossaries-user.html#dx1-83060" >573
    \glsentryprefixfirstplural  845
    +href="glossaries-user.html#dx1-83054" >574
    \Glsentryprefixplural  846
    +href="glossaries-user.html#dx1-83059" >575
    \glsentryprefixplural  847
    +href="glossaries-user.html#dx1-83052" >576
    \glsentryprevcount  848
    +class="cmti-10">577
    \Glsentryshort  849
    +href="glossaries-user.html#dx1-59113" >578
    \glsentryshort  850
    +href="glossaries-user.html#dx1-59112" >579
    \Glsentryshortpl  851
    +href="glossaries-user.html#dx1-59115" >580
    \glsentryshortpl  852
    +href="glossaries-user.html#dx1-59114" >581
    \Glsentrysymbol  853
    +class="cmti-10">582
    \glsentrysymbol  854, 855
    +class="cmti-10">583
    \Glsentrysymbolplural  856
    +class="cmti-10">584
    \glsentrysymbolplural  857
    +class="cmti-10">585
    \Glsentrytext  858, 859, 860, 861, 862
    +class="cmti-10">586
    \glsentrytext  863, 864, 865, 866, 867, 868
    +class="cmti-10">587
    \Glsentryuseri  869
    +class="cmti-10">588
    \glsentryuseri  870, 871
    +class="cmti-10">589
    \Glsentryuserii  872
    +class="cmti-10">590
    \glsentryuserii  873
    +class="cmti-10">591
    \Glsentryuseriii  874
    +class="cmti-10">592
    \glsentryuseriii  875
    - - +class="cmti-10">593
    \Glsentryuseriv  876
    +class="cmti-10">594
    \glsentryuseriv  877
    +class="cmti-10">595
    \Glsentryuserv  878
    +class="cmti-10">596
    \glsentryuserv  879
    +class="cmti-10">597
    \Glsentryuservi  880
    +class="cmti-10">598
    \glsentryuservi  881
    +class="cmti-10">599
    \glsexpandfields  882
    +class="cmti-10">600
    \glsfielddef  883
    +href="glossaries-user.html#dx1-82006" >601
    + + \glsfieldedef  884
    +href="glossaries-user.html#dx1-82007" >602
    \glsfieldfetch  885
    +href="glossaries-user.html#dx1-82001" >603
    \glsfieldgdef  886
    +href="glossaries-user.html#dx1-82008" >604
    \glsfieldxdef  887, 888
    +href="glossaries-user.html#dx1-82009" >605
    \GLSfirst  889
    +href="glossaries-user.html#dx1-46016" >606
    \Glsfirst  890
    +href="glossaries-user.html#dx1-46015" >607
    \glsfirst  891
    +href="glossaries-user.html#dx1-46012" >608
    \GLSfirstplural  892
    +href="glossaries-user.html#dx1-46036" >609
    \Glsfirstplural  893
    +href="glossaries-user.html#dx1-46035" >610
    \glsfirstplural  894
    +href="glossaries-user.html#dx1-46032" >611
    \glsgenacfmt  895, 896, 897, 898, 899, 900, 901
    +href="glossaries-user.html#dx1-47050" >612
    \glsgenentryfmt  902, 903, 904
    +href="glossaries-user.html#dx1-47044" >613
    \glsgetgrouptitle  905
    +href="glossaries-user.html#dx1-78026" >614
    \glsglossarymark  906, 907, 908, 909, 910
    +class="cmti-10">615, 616
    \glsgroupheading  911, 912
    +href="glossaries-user.html#dx1-78020" >617
    \glsgroupskip  913, 914, 915
    +href="glossaries-user.html#dx1-78033" >618
    \glshyperlink  916, 917, 918
    +class="cmti-10">619
    \glshypernavsep  919
    -\glsifhyper  920
    +class="cmti-10">620
    \glsifhyperon  921
    +class="cmti-10">621
    \glsIfListOfAcronyms  922
    +class="cmti-10">622
    \glsifplural  923, 924, 925, 926
    +class="cmti-10">623
    \glsinlineparentchildseparator  927, 928
    +href="glossaries-user.html#dx1-77012" >624
    \glsinlineseparator  929, 930
    +href="glossaries-user.html#dx1-77008" >625
    \glsinlinesubseparator  931, 932
    +href="glossaries-user.html#dx1-77010" >626
    \glsinsert  933, 934
    +class="cmti-10">627
    \glslabel  935, 936, 937, 938, 939
    +class="cmti-10">628
    \glslabeltok  940
    +class="cmti-10">629
    \glsletentryfield  941
    +class="cmti-10">630
    \glslink  942, 943, 944, 945, 946
    +class="cmti-10">631
    \glslink options
        counter  947, 948
    +href="glossaries-user.html#dx1-44069" >632, 633
        format  949, 950, 951, 952, 953
    +href="glossaries-user.html#dx1-43008" >634, 635, 636, 637, 638, 639
        hyper  954, 955, 956, 957, 958, 959, 960
    +href="glossaries-user.html#dx1-17080" >640, 641, 642, 643, 644, 645, 646
        local  961
    +href="glossaries-user.html#dx1-44070" >647
    \glslinkcheckfirsthyperhook  962
    +class="cmti-10">648
    \glslinkpostsetkeys  963, 964, 965, 966, 967
    +href="glossaries-user.html#dx1-47073" >649
    \glslinkvar  968
    - - +class="cmti-10">650
    \glslistdottedwidth  969
    +class="cmti-10">651
    \glslocalreset  970
    +class="cmti-10">652
    \glslocalresetall  971
    +class="cmti-10">653
    \glslocalunset  972
    +class="cmti-10">654
    \glslocalunsetall  973
    +class="cmti-10">655
    \glslongtok  974
    +class="cmti-10">656
    \glsmcols  975
    +href="glossaries-user.html#dx1-76011" >657
    \glsmoveentry  976
    +class="cmti-10">658
    \GLSname  977
    +href="glossaries-user.html#dx1-46043" >659
    + + \Glsname  978
    +href="glossaries-user.html#dx1-46042" >660
    \glsname  979
    +href="glossaries-user.html#dx1-46037" >661
    \glsnamefont  980, 981, 982
    +href="glossaries-user.html#dx1-53070" >662
    \glsnavhypertarget  983
    +href="glossaries-user.html#dx1-78030" >663
    \glsnoexpandfields  984
    +class="cmti-10">664
    \glsnoidxdisplayloc  985
    -\glsnumberformat  986, 987
    +href="glossaries-user.html#dx1-43051" >665
    \glsnumberlistloop  988
    -\glsnumbersgroupname  989
    -\glsnumbersgrouptitle  990
    +href="glossaries-user.html#dx1-43048" >666
    \glsnumlistlastsep  991
    +class="cmti-10">667
    \glsnumlistsep  992
    +class="cmti-10">668
    \glsopenbrace  993
    +class="cmti-10">669
    \glspagelistwidth  994, 995, 996, 997, 998, 999, 1000, 1001
    +class="cmti-10">670
    \glspar  1002
    +href="glossaries-user.html#dx1-28019" >671
    \glspercentchar  1003
    +class="cmti-10">672
    \GLSpl  1004, 1005, 1006, 1007, 1008
    +href="glossaries-user.html#dx1-45042" >673
    \Glspl  1009, 1010, 1011, 1012, 1013, 1014, 1015
    +href="glossaries-user.html#dx1-45041" >674
    \glspl  1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025
    +href="glossaries-user.html#dx1-45040" >675
    \GLSplural  1026
    +href="glossaries-user.html#dx1-46031" >676
    \Glsplural  1027
    +href="glossaries-user.html#dx1-46030" >677
    \glsplural  1028
    +href="glossaries-user.html#dx1-46027" >678
    \glspluralsuffix  1029, 1030, 1031, 1032
    +class="cmti-10">679
    \glspostdescription  1033
    +class="cmti-10">680
    \glspostinline  1034, 1035
    +href="glossaries-user.html#dx1-77014" >681
    \glspostlinkhook  1036, 1037, 1038, 1039, 1040
    +href="glossaries-user.html#dx1-47074" >682
    \glsprestandardsort  1041, 1042
    +class="cmti-10">683
    \glsquote  1043
    +class="cmti-10">684
    \glsrefentry  1044, 1045, 1046, 1047, 1048
    +class="cmti-10">685
    \glsreset  1049, 1050
    +class="cmti-10">686
    \glsresetall  1051
    +class="cmti-10">687
    \glsresetentrycounter  1052
    +class="cmti-10">688
    +\glsrestoreLToutput  689
    \glssee  1053, 1054, 1055, 1056, 1057
    +class="cmti-10">690
    \glsseeformat  1058, 1059
    +class="cmti-10">691
    \glsseeitemformat  1060
    +class="cmti-10">692
    \glsseelastsep  1061
    -\glsseelist  1062
    - - +class="cmti-10">693
    \glsseesep  1063
    +class="cmti-10">694
    \glsSetAlphaCompositor  1064
    +class="cmti-10">695
    \glsSetCompositor  1065
    +class="cmti-10">696
    \glssetexpandfield  1066
    +class="cmti-10">697
    \glssetnoexpandfield  1067
    +class="cmti-10">698
    \glsSetSuffixF  1068
    +href="glossaries-user.html#dx1-43040" >699
    \glsSetSuffixFF  1069
    +href="glossaries-user.html#dx1-43041" >700
    \glssetwidest  1070
    +href="glossaries-user.html#dx1-75033" >701
    \GlsSetXdyCodePage  1071, 1072, 1073
    +class="cmti-10">702
    \GlsSetXdyFirstLetterAfterDigits  1074
    +class="cmti-10">703
    \GlsSetXdyLanguage  1075, 1076, 1077, 1078
    +class="cmti-10">704
    \GlsSetXdyLocationClassOrder  1079
    +class="cmti-10">705
    + + \GlsSetXdyMinRangeLength  1080, 1081
    +class="cmti-10">706
    \glsshorttok  1082
    +class="cmti-10">707
    \glssortnumberfmt  1083
    +class="cmti-10">708
    \glssubentrycounterlabel  1084
    +href="glossaries-user.html#dx1-78066" >709
    \glssubentryitem  1085, 1086
    +href="glossaries-user.html#dx1-78063" >710
    \GLSsymbol  1087
    +href="glossaries-user.html#dx1-46048" >711
    \Glssymbol  1088
    +href="glossaries-user.html#dx1-46047" >712
    \glssymbol  1089, 1090
    -\glssymbolsgroupname  1091, 1092
    +href="glossaries-user.html#dx1-46044" >713
    \glstarget  1093, 1094
    +href="glossaries-user.html#dx1-78048" >714
    \GLStext  1095, 1096
    +href="glossaries-user.html#dx1-46011" >715
    \Glstext  1097, 1098
    +href="glossaries-user.html#dx1-46010" >716
    \glstext  1099, 1100, 1101, 1102
    +href="glossaries-user.html#dx1-46007" >717
    \glstextformat  1103, 1104, 1105, 1106
    +href="glossaries-user.html#dx1-44024" >718
    \glstextup  1107
    +class="cmti-10">719
    \glstildechar  1108
    +class="cmti-10">720
    \glstocfalse  1109
    +class="cmti-10">721
    \glstoctrue  1110
    +class="cmti-10">722
    \glstreeindent  1111
    +href="glossaries-user.html#dx1-75017" >723
    \glstreenamefmt  1112
    +href="glossaries-user.html#dx1-75004" >724
    \glstype  1113, 1114, 1115
    +class="cmti-10">725
    \glsunset  1116
    +class="cmti-10">726
    \glsunsetall  1117, 1118
    +class="cmti-10">727
    \GlsUseAcrEntryDispStyle  1119
    +class="cmti-10">728
    \GlsUseAcrStyleDefs  1120
    +class="cmti-10">729
    \GLSuseri  1121
    +href="glossaries-user.html#dx1-46058" >730
    \Glsuseri  1122
    +href="glossaries-user.html#dx1-46057" >731
    \glsuseri  1123
    +href="glossaries-user.html#dx1-46054" >732
    \GLSuserii  1124
    +href="glossaries-user.html#dx1-46063" >733
    \Glsuserii  1125
    +href="glossaries-user.html#dx1-46062" >734
    \glsuserii  1126
    +href="glossaries-user.html#dx1-46059" >735
    \GLSuseriii  1127
    +href="glossaries-user.html#dx1-46068" >736
    \Glsuseriii  1128
    +href="glossaries-user.html#dx1-46067" >737
    \glsuseriii  1129
    - - +href="glossaries-user.html#dx1-46064" >738
    \GLSuseriv  1130
    +href="glossaries-user.html#dx1-46073" >739
    \Glsuseriv  1131
    +href="glossaries-user.html#dx1-46072" >740
    \glsuseriv  1132
    +href="glossaries-user.html#dx1-46069" >741
    \GLSuserv  1133
    +href="glossaries-user.html#dx1-46078" >742
    \Glsuserv  1134
    +href="glossaries-user.html#dx1-46077" >743
    \glsuserv  1135
    +href="glossaries-user.html#dx1-46074" >744
    \GLSuservi  1136
    +href="glossaries-user.html#dx1-46083" >745
    \Glsuservi  1137
    +href="glossaries-user.html#dx1-46082" >746
    \glsuservi  1138
    +href="glossaries-user.html#dx1-46079" >747
    \glswriteentry  1139
    -

    748
    +

    H html package  1140
    -\hyperbf  1141
    -\hyperbsf  1142
    -\hyperemph  1143
    -\hyperit  1144
    -\hyperlink  1145, 1146
    -\hypermd  1147
    -\hyperpage  1148
    +href="glossaries-user.html#dx1-48002" >749
    + + hyperref package  1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171
    -\hyperrm  1172, 1173
    -\hypersc  1174
    -\hypersf  1175
    -\hypersl  1176
    -\hypertarget  1177
    -\hypertt  1178
    -\hyperup  1179
    -

    750, 751, 752, 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763, 764, 765, 766, 767, 768, 769, 770, 771, 772
    +

    I \ifglossaryexists  1180
    +href="glossaries-user.html#dx1-81001" >773
    \ifglsdescsuppressed  1181
    +href="glossaries-user.html#dx1-81023" >774
    \ifglsentryexists  1182
    +href="glossaries-user.html#dx1-81002" >775
    \ifglsfieldcseq  1183
    +href="glossaries-user.html#dx1-81031" >776
    \ifglsfielddefeq  1184
    +href="glossaries-user.html#dx1-81029" >777
    \ifglsfieldeq  1185, 1186
    +href="glossaries-user.html#dx1-81026" >778
    \ifglshaschildren  1187
    +href="glossaries-user.html#dx1-81011" >779
    \ifglshasdesc  1188
    +href="glossaries-user.html#dx1-81021" >780
    \ifglshaslong  1189, 1190, 1191, 1192, 1193
    +href="glossaries-user.html#dx1-81015" >781
    \ifglshasparent  1194
    +href="glossaries-user.html#dx1-81012" >782
    \ifglshasprefix  1195
    +href="glossaries-user.html#dx1-83040" >783
    \ifglshasprefixfirst  1196
    +href="glossaries-user.html#dx1-83044" >784
    \ifglshasprefixfirstplural  1197
    - - +href="glossaries-user.html#dx1-83046" >785
    \ifglshasprefixplural  1198
    +href="glossaries-user.html#dx1-83042" >786
    \ifglshasshort  1199, 1200
    +href="glossaries-user.html#dx1-81018" >787
    \ifglshassymbol  1201, 1202
    +href="glossaries-user.html#dx1-81013" >788
    \ifglsucmark  1203
    +class="cmti-10">789
    \ifglsused  1204, 1205, 1206, 1207, 1208, 1209
    +class="cmti-10">790, 791
    \ifignoredglossary  1210
    +class="cmti-10">792
    imakeidx package  1211
    -\include  1212
    -\index  1213, 1214, 1215, 1216, 1217
    +href="glossaries-user.html#dx1-23022" >793
    index package  1218
    -\indexname  1219
    -\indexspace  1220, 1221, 1222, 1223
    -\input  1224, 1225
    +href="glossaries-user.html#dx1-23021" >794
    inputenc package  1226, 1227, 1228, 1229, 1230, 1231
    -\inputencodingname  1232
    -\item  1233, 1234
    -itemize (environment)  1235
    -

    J -\jobname  1236, 1237
    -

    795, 796, 797, 798, 799, 800
    +

    L -\label  1238
    latex  1239, 1240
    +href="glossaries-user.html#dx1-24" >801, 802
    latexmk  1241
    +href="glossaries-user.html#dx1-10014" >803
    Latin alphabet  1242, 1243, 1244
    +class="cmbx-10">804, 805, 806
    Latin character  1245, 1246, 1247, 1248, 807, 808, 809, 810, 1249, 1250, 1251
    +class="cmbx-10">811, 812, 813
    link text  1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281
    +class="cmbx-10">814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848, 849, 850, 851, 852, 853, 854, 855, 856, 857, 858, 859, 860, 861, 862
    \loadglsentries  1282, 1283, 1284
    +class="cmti-10">863
    location list  see number list
    \longnewglossaryentry  1286, 1287, 1288, 1289
    +class="cmti-10">865
    \longprovideglossaryentry  1290
    -longtable (environment)  1291, 1292, 1293, 1294, 1295, 1296
    +class="cmti-10">866
    longtable package  1297, 1298
    -

    867, 868
    +

    M -\makeatletter  1299
    -\makeatother  1300
    -\makefirstuc  1301, 1302, 1303
    makeglossaries  1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377
    +class="cmbx-10">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, 909, 910, 911, 912, 913, 914, 915, 916, 917, 918, 919, 920, 921, 922, 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
    \makeglossaries  1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399
    - - +class="cmti-10">952
    + + makeglossaries-lite.lua  1400, 1401, 1402, 1403, 1404, 1405, 1406
    +class="cmbx-10">953, 954, 955, 956, 957, 958, 959, 960
    makeglossariesgui  1407, 1408, 1409, 1410
    +class="cmbx-10">961, 962
    makeidx package  1411
    +href="glossaries-user.html#dx1-23020" >963
    makeindex  1412, 1413, 1414, 964, 965, 966, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499
    +class="cmbx-10">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, 995, 996, 997, 998, 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, 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
    \makenoidxglossaries  1500, 1501, 1502, 1503
    -\MakeTextUppercase  1504
    -\markboth  1505
    +class="cmti-10">1061
    memoir class  1506, 1507, 1508, 1509
    -\memUChead  1510
    +href="glossaries-user.html#dx1-18021" >1062, 1063, 1064, 1065
    mfirstuc package  1511, 1512, 1513, 1514, 1515, 1516
    -\mfirstucMakeUppercase  1517
    +href="glossaries-user.html#dx1-3" >1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075
    multicol package  1518
    -multicols (environment)  1519, 1520
    +href="glossaries-user.html#dx1-76004" >1076
    mwe package  1521
    -

    1077
    +

    N nameref package  1522
    +href="glossaries-user.html#dx1-18049" >1078
    \newacronym  1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559
    +class="cmti-10">1079
    \newacronymstyle  1560, 1561, 1562
    -\newdualentry  1563
    +class="cmti-10">1080
    \newglossary  1564, 1565, 1566, 1567, 1568, 1569
    +class="cmti-10">1081
    \newglossary*  1570
    +class="cmti-10">1082
    \newglossaryentry  1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593
    +class="cmti-10">1083
    \newglossaryentry options
        access  1594
    +href="glossaries-user.html#dx1-84003" >1084
        description  1595, 1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611
    +href="glossaries-user.html#dx1-6007" >1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102
        descriptionaccess  1612
    +href="glossaries-user.html#dx1-84017" >1103
        descriptionplural  1613, 1614, 1615, 1616
    +href="glossaries-user.html#dx1-28022" >1104, 1105, 1106, 1107
        descriptionpluralaccess  1617
    +href="glossaries-user.html#dx1-84019" >1108
        entrycounter  1618, 1619
    +href="glossaries-user.html#dx1-53035" >1109, 1110
        first  1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635, 1636, 1637, 1638, 1639
    +href="glossaries-user.html#dx1-3019" >1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129, 1130, 1131, 1132, 1133, 1134, 1135
        firstaccess  1640
    +href="glossaries-user.html#dx1-84007" >1136
        firstplural  1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656
    +href="glossaries-user.html#dx1-3020" >1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153
        firstpluralaccess  1657
    +href="glossaries-user.html#dx1-84011" >1154
        format  1658
    +href="glossaries-user.html#dx1-44067" >1155
        long  1659, 1660, 1661, 1662, 1663, 1664, 1665, 1666, 1667, 1668
    +href="glossaries-user.html#dx1-17087" >1156, 1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168
        longaccess  1669
    +href="glossaries-user.html#dx1-84021" >1169
        longplural  1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678
    +href="glossaries-user.html#dx1-28124" >1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178
        longpluralaccess  1679
    +href="glossaries-user.html#dx1-84027" >1179
        name  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
    - - +href="glossaries-user.html#dx1-6009" >1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214
        nonumberlist  1711
    +href="glossaries-user.html#dx1-28105" >1215
        parent  1712, 1713, 1714, 1715
    +href="glossaries-user.html#dx1-28011" >1216, 1217, 1218, 1219
        plural  1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729
    +href="glossaries-user.html#dx1-28037" >1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234
        pluralaccess  1730
    +href="glossaries-user.html#dx1-84009" >1235
        prefix  1731, 1732, 1733, 1734, 1735, 1736, 1737
    +href="glossaries-user.html#dx1-83003" >1236, 1237, 1238, 1239, 1240, 1241, 1242
        prefixfirst  1738, 1739, 1740, 1741, 1742
    +href="glossaries-user.html#dx1-83007" >1243, 1244, 1245, 1246, 1247
        prefixfirstplural  1743, 1744, 1745, 1746, 1747
    +href="glossaries-user.html#dx1-83010" >1248, 1249, 1250, 1251, 1252
        prefixplural  1748, 1749, 1750, 1751, 1752, 1753
    +href="glossaries-user.html#dx1-83005" >1253, 1254, 1255, 1256, 1257, 1258
    + +     see  1754, 1755, 1756, 1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766
    +href="glossaries-user.html#dx1-19057" >1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272
        short  1767, 1768, 1769, 1770, 1771, 1772, 1773, 1774
    +href="glossaries-user.html#dx1-28125" >1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283
        shortaccess  1775
    +href="glossaries-user.html#dx1-84024" >1284
        shortplural  1776, 1777, 1778, 1779, 1780, 1781, 1782, 1783, 1784
    +href="glossaries-user.html#dx1-28126" >1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293
        shortpluralaccess  1785
    +href="glossaries-user.html#dx1-84030" >1294
        sort  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
    +href="glossaries-user.html#dx1-3049" >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
        subentrycounter  1813
    +href="glossaries-user.html#dx1-53036" >1326
        symbol  1814, 1815, 1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823
    +href="glossaries-user.html#dx1-6004" >1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338
        symbolaccess  1824
    +href="glossaries-user.html#dx1-84013" >1339
        symbolplural  1825, 1826, 1827
    +href="glossaries-user.html#dx1-28061" >1340, 1341, 1342
        symbolpluralaccess  1828
    +href="glossaries-user.html#dx1-84015" >1343
        text  1829, 1830, 1831, 1832, 1833, 1834, 1835, 1836, 1837, 1838, 1839, 1840, 1841, 1842, 1843
    +href="glossaries-user.html#dx1-28024" >1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364
        textaccess  1844
    +href="glossaries-user.html#dx1-84005" >1365
        type  1845, 1846, 1847
    +href="glossaries-user.html#dx1-28093" >1366, 1367, 1368
        user1  1848, 1849, 1850, 1851, 1852, 1853, 1854, 1855, 1856, 1857
    +href="glossaries-user.html#dx1-6005" >1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378
        user2  1858, 1859, 1860, 1861
    +href="glossaries-user.html#dx1-28097" >1379, 1380, 1381, 1382
        user3  1862, 1863, 1864
    +href="glossaries-user.html#dx1-28098" >1383, 1384, 1385
        user4  1865, 1866, 1867
    +href="glossaries-user.html#dx1-28099" >1386, 1387, 1388
        user5  1868, 1869, 1870
    +href="glossaries-user.html#dx1-28100" >1389, 1390, 1391
        user6  1871, 1872, 1873, 1874
    +href="glossaries-user.html#dx1-28096" >1392, 1393, 1394, 1395
    \newglossarystyle  1875, 1876, 1877, 1878
    +href="glossaries-user.html#dx1-78001" >1396
    \newignoredglossary  1879, 1880, 1881, 1882
    -\newline  1883, 1884
    +class="cmti-10">1397
    \newterm  1885, 1886
    +class="cmti-10">1398
    ngerman package  1887, 1888
    -\nohyperpage  1889
    +href="glossaries-user.html#dx1-8040" >1399, 1400
    \noist  1890, 1891, 1892, 1893, 1894, 1895, 1896, 1897, 1898, 1899, 1900
    +class="cmti-10">1401
    Non-Latin Alphabet  1901
    +class="cmbx-10">1402
    non-Latin character  1902, 1903, 1403, 1404, 1904, 1905, 1906, 1907, 1908, 1909, 1910, 1911, 1912
    +class="cmbx-10">1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413
    \nopostdesc  1913, 1914, 1915, 1916, 1917, 1918
    +href="glossaries-user.html#dx1-28018" >1414
    number list  1919, 1920, 1921, 1922, 1923, 1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931, 1932, 1933, 1934, 1935, 1936, 1937, 1938, 1939, 1940, 1941, 1942, 1943, 1944, 1945, 1946, 1947, 1948, 1949, 1950, 1951, 1952, 1953, 1954, 1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965
    -\numberline  1966
    -

    1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464
    +

    O \oldacronym  1967, 1968
    - - -

    1465
    +

    P package options:
        acronym  1969, 1970, 1971, 1972, 1973, 1974, 1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992
    +href="glossaries-user.html#dx1-8026" >1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489
            true  1993, 1994
    +href="glossaries-user.html#dx1-16002" >1490, 1491
        acronymlists  1995, 1996, 1997, 1998, 1999, 2000, 2001
    +href="glossaries-user.html#dx1-21019" >1492, 1493, 1494, 1495, 1496, 1497, 1498
        acronyms  2002, 2003
    +href="glossaries-user.html#dx1-17007" >1499, 1500
        automake  2004, 2005, 2006
    +href="glossaries-user.html#dx1-10005" >1501, 1502, 1503
    + +         false  2007
    +href="glossaries-user.html#dx1-20088" >1504
        compatible-2.07  2008, 2009, 2010
    +href="glossaries-user.html#dx1-23027" >1505, 1506, 1507
        compatible-3.07  2011, 2012, 2013
    +href="glossaries-user.html#dx1-21004" >1508, 1509, 1510
        counter  2014, 2015, 2016, 2017, 2018
    +href="glossaries-user.html#dx1-19063" >1511, 1512, 1513, 1514, 1515
            page  2019
    +href="glossaries-user.html#dx1-19064" >1516
        counterwithin  2020, 2021, 2022, 2023, 2024
    +href="glossaries-user.html#dx1-19009" >1517, 1518, 1519, 1520, 1521
        description  2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033
    +href="glossaries-user.html#dx1-22002" >1522, 1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530
        dua  2034, 2035
    +href="glossaries-user.html#dx1-22011" >1531, 1532
        entrycounter  2036, 2037, 2038, 2039, 2040
    +href="glossaries-user.html#dx1-19001" >1533, 1534, 1535, 1536, 1537
            false  2041
    +href="glossaries-user.html#dx1-19002" >1538
            true  2042
    +href="glossaries-user.html#dx1-19010" >1539
        footnote  2043, 2044, 2045, 2046, 2047, 2048
    +href="glossaries-user.html#dx1-22006" >1540, 1541, 1542, 1543, 1544, 1545
        hyperfirst  2049, 2050, 2051, 2052
    +href="glossaries-user.html#dx1-17067" >1546, 1547, 1548, 1549
            false  2053, 2054, 2055, 2056, 2057
    +href="glossaries-user.html#dx1-17081" >1550, 1551, 1552, 1553, 1554
            true  2058, 2059
    +href="glossaries-user.html#dx1-17068" >1555, 1556
        index  2060, 2061, 2062, 2063, 2064
    +href="glossaries-user.html#dx1-17010" >1557, 1558, 1559, 1560, 1561
        indexonlyfirst  2065, 2066
    +href="glossaries-user.html#dx1-17091" >1562, 1563
            false  2067
    +href="glossaries-user.html#dx1-17092" >1564
        makeindex  2068, 2069, 2070
    +href="glossaries-user.html#dx1-16004" >1565, 1566, 1567
        nogroupskip  2071, 2072, 2073, 2074, 2075
    +href="glossaries-user.html#dx1-5020" >1568, 1569, 1570, 1571, 1572, 1573
            false  2076
    +href="glossaries-user.html#dx1-19069" >1574
        nohypertypes  2077, 2078, 2079, 2080, 2081, 2082, 2083, 2084, 2085
    +href="glossaries-user.html#dx1-17063" >1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583
            index  2086
    +href="glossaries-user.html#dx1-23024" >1584
        nolist  2087, 2088, 2089
    +href="glossaries-user.html#dx1-19038" >1585, 1586, 1587
        nolong  2090, 2091, 2092, 2093
    +href="glossaries-user.html#dx1-19030" >1588, 1589, 1590, 1591
        nomain  2094, 2095, 2096, 2097, 2098, 2099, 2100, 2101
    +href="glossaries-user.html#dx1-17005" >1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599
        nonumberlist  2102, 2103, 2104, 2105, 2106, 2107, 2108, 2109
    +href="glossaries-user.html#dx1-3047" >1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607
        nopostdot  2110, 2111
    +href="glossaries-user.html#dx1-19066" >1608, 1609
            false  2112
    +href="glossaries-user.html#dx1-19067" >1610
        noredefwarn  2113
    +href="glossaries-user.html#dx1-17003" >1611
        nostyles  2114, 2115, 2116, 2117, 2118, 2119, 2120
    +href="glossaries-user.html#dx1-19046" >1612, 1613, 1614, 1615, 1616, 1617, 1618
        nosuper  2121, 2122, 2123, 2124
    +href="glossaries-user.html#dx1-19034" >1619, 1620, 1621, 1622
        notranslate  2125, 2126, 2127
    +href="glossaries-user.html#dx1-8010" >1623, 1624, 1625
        notree  2128, 2129, 2130
    +href="glossaries-user.html#dx1-19043" >1626, 1627, 1628
        nowarn  2131, 2132
    - - +href="glossaries-user.html#dx1-17001" >1629, 1630
        numberedsection  2133, 2134, 2135, 2136, 2137
    +href="glossaries-user.html#dx1-18035" >1631, 1632, 1633, 1634, 1635
            autolabel  2138, 2139
    +href="glossaries-user.html#dx1-18039" >1636, 1637
            false  2140
    +href="glossaries-user.html#dx1-18037" >1638
            nameref  2141
    +href="glossaries-user.html#dx1-18045" >1639
            nolabel  2142
    +href="glossaries-user.html#dx1-18038" >1640
        numberline  2143, 2144
    +href="glossaries-user.html#dx1-18004" >1641, 1642
        numbers  2145, 2146, 2147
    +href="glossaries-user.html#dx1-17009" >1643, 1644, 1645
        order  2148, 2149, 2150
    +href="glossaries-user.html#dx1-20045" >1646, 1647, 1648
            letter  2151, 2152, 2153, 2154
    +href="glossaries-user.html#dx1-4051" >1649, 1650, 1651, 1652
            word  2155, 2156, 2157
    +href="glossaries-user.html#dx1-5056" >1653, 1654, 1655
        sanitizesort  2158, 2159, 2160
    +href="glossaries-user.html#dx1-4067" >1656, 1657, 1658
    + +         false  2161, 2162, 2163, 2164, 2165, 2166
    +href="glossaries-user.html#dx1-4006" >1659, 1660, 1661, 1662, 1663, 1664
            true  2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174
    +href="glossaries-user.html#dx1-4008" >1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672
        savenumberlist  2175, 2176
    +href="glossaries-user.html#dx1-17097" >1673, 1674
            false  2177
    +href="glossaries-user.html#dx1-17099" >1675
        savewrites  2178, 2179, 2180
    +href="glossaries-user.html#dx1-17019" >1676, 1677, 1678
            false  2181
    +href="glossaries-user.html#dx1-17020" >1679
        section  2182, 2183
    +href="glossaries-user.html#dx1-18011" >1680, 1681
        seeautonumberlist  2184, 2185, 2186, 2187
    +href="glossaries-user.html#dx1-19054" >1682, 1683, 1684, 1685
        shortcuts  2188, 2189
    +href="glossaries-user.html#dx1-21026" >1686, 1687
        smallcaps  2190, 2191, 2192, 2193, 2194, 2195
    +href="glossaries-user.html#dx1-22004" >1688, 1689, 1690, 1691, 1692, 1693
        smaller  2196, 2197, 2198, 2199, 2200
    +href="glossaries-user.html#dx1-22005" >1694, 1695, 1696, 1697, 1698
        sort  2201
    +href="glossaries-user.html#dx1-20001" >1699
            def  2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211
    +href="glossaries-user.html#dx1-4009" >1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709
            standard  2212, 2213, 2214
    +href="glossaries-user.html#dx1-20006" >1710, 1711, 1712
            use  2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223
    +href="glossaries-user.html#dx1-20005" >1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721
        style  2224, 2225, 2226, 2227, 2228, 2229, 2230
    +href="glossaries-user.html#dx1-19024" >1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729
            list  2231
    +href="glossaries-user.html#dx1-19025" >1730
        subentrycounter  2232, 2233, 2234, 2235, 2236, 2237
    +href="glossaries-user.html#dx1-19018" >1731, 1732, 1733, 1734, 1735, 1736
            false  2238
    +href="glossaries-user.html#dx1-19019" >1737
        symbols  2239, 2240, 2241
    +href="glossaries-user.html#dx1-17008" >1738, 1739, 1740
        toc  2242, 2243, 2244, 2245, 2246
    +href="glossaries-user.html#dx1-18001" >1741, 1742, 1743, 1744, 1745
        translate  2247, 2248, 2249, 2250
    +href="glossaries-user.html#dx1-17030" >1746, 1747, 1748, 1749
            babel  2251, 2252, 2253, 2254, 2255, 2256
    +href="glossaries-user.html#dx1-8012" >1750, 1751, 1752, 1753, 1754, 1755
            false  2257, 2258, 2259, 2260
    +href="glossaries-user.html#dx1-8011" >1756, 1757, 1758, 1759
            true  2261, 2262, 2263, 2264
    +href="glossaries-user.html#dx1-17031" >1760, 1761, 1762, 1763
        ucfirst  2265
    +href="glossaries-user.html#dx1-18032" >1764
        ucmark  2266, 2267
    +href="glossaries-user.html#dx1-18017" >1765, 1766
            false  2268
    +href="glossaries-user.html#dx1-18020" >1767
            true  2269
    +href="glossaries-user.html#dx1-18022" >1768
        xindy  2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277, 2278, 2279, 2280, 2281, 2282, 2283
    +href="glossaries-user.html#dx1-4042" >1769, 1770, 1771, 1772, 1773, 1774, 1775, 1776, 1777, 1778, 1779, 1780, 1781, 1782
        xindygloss  2284, 2285
    +href="glossaries-user.html#dx1-20070" >1783, 1784
        xindynoglsnumbers  2286, 2287
    +href="glossaries-user.html#dx1-20074" >1785, 1786
    page (counter)  2288
    -\pagelistname  2289
    +href="glossaries-user.html#dx1-56042" >1787
    pdflatex  2290, 2291
    - - +href="glossaries-user.html#dx1-23" >1788, 1789
    \PGLS  2292
    +href="glossaries-user.html#dx1-83027" >1790
    \Pgls  2293
    +href="glossaries-user.html#dx1-83023" >1791
    \pgls  2294
    +href="glossaries-user.html#dx1-83020" >1792
    \PGLSpl  2295
    +href="glossaries-user.html#dx1-83036" >1793
    \Pglspl  2296
    +href="glossaries-user.html#dx1-83032" >1794
    \pglspl  2297
    +href="glossaries-user.html#dx1-83029" >1795
    pod2man  2298
    +href="glossaries-user.html#dx1-11033" >1796
    polyglossia package  2299, 2300, 2301, 2302, 2303, 2304, 2305
    -\printacronym  2306
    +href="glossaries-user.html#dx1-8002" >1797, 1798, 1799, 1800, 1801, 1802, 1803
    \printacronyms  2307, 2308
    +class="cmti-10">1804
    \printglossaries  2309, 2310, 2311, 2312, 2313, 2314
    +class="cmti-10">1805
    \printglossary  2315, 2316, 2317, 2318, 2319, 2320, 2321, 2322, 2323, 2324, 2325, 2326, 2327
    +href="glossaries-user.html#dx1-53014" >1806
    \printglossary options
    + +     entrycounter  2328
    +href="glossaries-user.html#dx1-53032" >1807
        nogroupskip  2329
    +href="glossaries-user.html#dx1-53030" >1808
        nonumberlist  2330
    +href="glossaries-user.html#dx1-53029" >1809
        nopostdot  2331
    +href="glossaries-user.html#dx1-53031" >1810
        numberedsection  2332
    +href="glossaries-user.html#dx1-53026" >1811
        style  2333, 2334, 2335, 2336
    +href="glossaries-user.html#dx1-19050" >1812, 1813, 1814, 1815, 1816
        subentrycounter  2337
    +href="glossaries-user.html#dx1-53034" >1817
        title  2338, 2339, 2340
    +href="glossaries-user.html#dx1-53019" >1818, 1819, 1820
        toctitle  2341
    +href="glossaries-user.html#dx1-53020" >1821
        type  2342, 2343
    +href="glossaries-user.html#dx1-53016" >1822, 1823
    \printindex  2344
    +class="cmti-10">1824
    \printnoidxglossaries  2345, 2346
    +class="cmti-10">1825
    \printnoidxglossary  2347, 2348, 2349, 2350, 2351, 2352, 2353, 2354, 2355, 2356, 2357
    +href="glossaries-user.html#dx1-53012" >1826
    \printnoidxglossary options
        sort  2358, 2359, 2360, 2361
    +href="glossaries-user.html#dx1-20002" >1827, 1828, 1829, 1830
    \printnumbers  2362
    +class="cmti-10">1831
    \printsymbols  2363
    +class="cmti-10">1832
    \provideglossaryentry  2364, 2365
    -

    1833
    +

    R relsize package  2366, 2367
    -\Roman  2368
    -

    1834, 1835
    +

    S sanitize  2369, 2370, 2371, 2372, 2373
    +class="cmbx-10">1836, 1837, 1838, 1839, 1840
    scrwfile package  2374
    -\section*  2375, 2376
    -\seename  2377, 2378, 2379
    +href="glossaries-user.html#dx1-17023" >1841
    \SetAcronymLists  2380
    +class="cmti-10">1842
    \setacronymstyle  2381, 2382, 2383, 2384, 2385
    -\setAlphaCompositor  2386
    - - -\setCompositor  2387
    -\setentrycounter  2388, 2389
    +class="cmti-10">1843
    \setglossarypreamble  2390, 2391
    +href="glossaries-user.html#dx1-53061" >1844
    \setglossarysection  2392, 2393
    +class="cmti-10">1845
    \setglossarystyle  2394, 2395, 2396, 2397, 2398, 2399, 2400
    +class="cmti-10">1846
    \setStyleFile  2401, 2402, 2403
    +class="cmti-10">1847
    \setupglossaries  2404
    +class="cmti-10">1848
    \subglossentry  2405
    -supertabular (environment)  2406, 2407, 2408, 2409, 2410
    +href="glossaries-user.html#dx1-78061" >1849
    supertabular package  2411, 2412, 2413
    -\symbolname  2414
    -

    1850, 1851, 1852
    +

    T tabular (environment)  2415, 2416
    -\texorpdfstring  2417
    -\textbf  2418
    -textcase package  2419, 2420
    -\textrm  2421
    -\textsc  2422, 2423, 2424, 2425, 2426, 2427
    -\textsmaller  2428, 2429, 2430
    -\textulc  2431
    -\textup  2432
    -\the  2433
    +href="glossaries-user.html#dx1-6" >1853, 1854, 1855
    theglossary (environment)  2434, 2435, 2436, 2437
    -\thepage  2438
    +href="glossaries-user.html#dx1-78002" >1856
    tracklang package  2439, 2440
    +href="glossaries-user.html#dx1-2" >1857, 1858, 1859
    translator package  2441, 2442, 2443, 2444, 2445, 2446, 2447, 2448, 2449, 2450, 2451, 2452, 2453, 2454, 2455, 2456, 2457, 2458, 2459, 2460, 2461, 2462, 2463, 2464, 2465
    -

    W -\write18  2466, 2467
    -

    1860, 1861, 1862, 1863, 1864, 1865, 1866, 1867, 1868, 1869, 1870, 1871, 1872, 1873, 1874, 1875, 1876, 1877, 1878, 1879, 1880, 1881, 1882, 1883, 1884
    +

    X + + +xfor package  1885
    xindy  2468, 2469, 2470, 1886, 1887, 1888, 2471, 2472, 2473, 2474, 2475, 2476, 2477, 2478, 2479, 2480, 2481, 2482, 2483, 2484, 2485, 2486, 2487, 2488, 2489, 2490, 2491, 2492, 2493, 2494, 2495, 2496, 2497, 2498, 2499, 2500, 2501, 2502, 2503, 2504, 2505, 2506, 2507, 2508, 2509, 2510, 2511, 2512, 2513, 2514, 2515, 2516, 2517, 2518, 2519, 2520, 2521, 2522, 2523, 2524, 2525, 2526, 2527, 2528, 2529, 2530, 2531, 2532, 2533, 2534, 2535, 2536, 2537, 2538, 2539, 2540, 2541, 2542, 2543, 2544, 2545, 2546, 2547, 2548, 2549, 2550, 2551, 2552, 2553, 2554, 2555, 2556, 2557, 2558, 2559, 2560, 2561, 2562, 2563, 2564, 2565, 2566, 2567, 2568, 2569, 2570, 2571, 2572, 2573, 2574, 2575, 2576, 2577, 2578, 2579, 2580, 2581, 2582, 2583, 2584, 2585, 2586, 2587, 2588, 2589, 2590, 2591, 2592, 2593
    +class="cmbx-10">1889, 1890, 1891, 1892, 1893, 1894, 1895, 1896, 1897, 1898, 1899, 1900, 1901, 1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909, 1910, 1911, 1912, 1913, 1914, 1915, 1916, 1917, 1918, 1919, 1920, 1921, 1922, 1923, 1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931, 1932, 1933, 1934, 1935, 1936, 1937, 1938, 1939, 1940, 1941, 1942, 1943, 1944, 1945, 1946, 1947, 1948, 1949, 1950, 1951, 1952, 1953, 1954, 1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965, 1966, 1967, 1968, 1969, 1970, 1971, 1972, 1973, 1974, 1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020
    xkeyval package  2594, 2595
    -\xspace  2596
    +href="glossaries-user.html#dx1-5" >2021, 2022, 2023
    xspace package  2597, 2598, 2599, 2600, 2601, 2602, 2603
    +href="glossaries-user.html#dx1-64014" >2024, 2025, 2026, 2027, 2028, 2029, 2030

    - - -

    1.1

    1.1That is, if the term has been referenced using any of the commands described in §6 Links to +class="cmr-8">Links to Glossary Glossary Entries Entries and §Adding an Entry to the Glossary Without Generating Text or via \glssee - (or the see key) or commands such as key) or +commands such as \acrshort.

    -

    1.2

    1.2Note that although I’ve written latex in this section, it’s better to use pdflatex, where +class="cmr-8">, where possible, for possible, for the reasons given the reasons given earlier.

    -

    1.3

    1.3Added to version makeglossaries 2.18.

    +

    1.4As from v3.01 \gls is no longer fragile and doesn’t need protecting.

    -

    2.1

    2.1bug fix in v4.16 has corrected the code to ensure this.

    -

    2.2

    2.2unless memoir is loaded, which case it uses \markboth

    -

    2.3

    2.3Actually it uses \mfirstucMakeUppercase textcase’s \MakeTextUppercase by the +class="cmr-8">by the glossaries glossaries package. This makes it consistent with \makefirstuc. (The textcase package is +class="cmr-8">package is automatically loaded by automatically loaded by glossaries.)

    -

    2.4

    2.4Actually it sets \acronymtype \glsdefaulttypeif the acronym package option is not +class="cmr-8">package option is not used, but used, but \glsdefaulttype usually has the value main unless the nomain option has been -used.

    4.1option has been used.

    +

    4.1The glossaries-extra package provides a simpler way of achieving this.

    +

    4.2This is because \acronymtype acronym package option is not used.

    6.1used.

    5.1This feature was introduced in makeglossaries version 2.18.

    +

    6.1I’ve used \MakeUppercase in all the examples for clarity, but it will actually use \mfirstucMakeUppercase.

    +

    6.2\glsdisplayfirst and \glsdisplay are now deprecated. Backwards compatibility should be +class="cmr-8">are now deprecated. Backwards compatibility should be preserved preserved but you may need to use the but you may need to use the compatible-3.07 option

    -

    8.1

    8.1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.

    8.2Ifyou redefine discarded.

    8.2If you redefine \glsseeformat, keep the default value of the optional argument as \seename + id="dx1-51006"> as as both both see and [\seename] in the output file if no optional argument is given.

    -

    8.3

    8.3In versions before 3.0, \glsentryname was used, but this could cause problems when the name -key was key was +sanitized.

    -

    9.1.

    9.1versions before 3.0 used \glsentryname as the default, but this could cause problems when -as the default, but this could cause problems when name had been had +been sanitized.

    10.1.

    10.1you can’t use the longheaderborder style for this example as you can’t use the longtable + id="dx1-53068"> environment in environment in two column mode.

    11.1two column mode.

    11.1see \setCompositor §3 Setting Up

    -

    11.2

    11.2see \setAlphaCompositor §3 Setting Up

    -

    13.1as from version 1.18

    13.2

    13.1as from version 1.18

    13.2See David Carlisle’sexplanation in http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace

    -

    15.1

    15.1These lengths will not be available if you use both the nolong and nosuper package +class="cmr-8">package options or if you options or if you use the use the nostyles package option unless you explicitly load the relevant -package.

    -

    15.2package option unless you explicitly load the relevant package.

    +

    15.2This style was supplied by Axel Menzel.

    -

    15.3

    15.3e.g. with the flowfram package.

    -

    17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, +

    17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the hence the non-breakable space after “a” in the non-breakable space after “a” in the prefix field.

    -

    17.2The earlier caveats about initial non-Latin characters apply.

    +

    17.2The earlier caveats about initial non-Latin characters apply.

    - + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index 7cf448a4217..189514e236a 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 37419b2fae6..18d96dbad06 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -1,4 +1,4 @@ -\documentclass[report,inlinetitle]{nlctdoc} +\documentclass[report,inlinetitle,widecs]{nlctdoc} \usepackage[inner=0.5in,includemp]{geometry} @@ -308,6 +308,16 @@ user2={sanitization\protect\iterm{sanitize}}% description={An alphabet consisting of \glspl{nonlatinchar}.} } +\newglossaryentry{glossaries-extra}{% + name={\styfmt{glossaries-extra}}, + sort={glossaries-extra}, + description={A separate package that extends the + \styfmt{glossaries} package, providing new features or improving + existing features. If you want to use \styfmt{glossaries-extra}, + you must have both the \styfmt{glossaries} package and the + \styfmt{glossaries-extra} package installed.} +} + \ifpdf \externaldocument{glossaries-code} \fi @@ -378,11 +388,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.20} + \title{User Manual for glossaries.sty v4.21} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2015-11-30} + \date{2016-01-24} \maketitle \begin{abstract} @@ -390,6 +400,12 @@ The \styfmt{glossaries} package provides a means to define terms or abbreviations or symbols that can be referenced within your document. Sorted lists with collated \glslink{entrylocation}{locations} can be generated either using \TeX\ or using a supplementary \gls{indexingapp}. + +Additional features not provided here may be available through +the supplemental package \gls{glossaries-extra} which, if required, +needs to be installed separately. New features will be added to +\gls*{glossaries-extra}. Any new versions of the \styfmt{glossaries} +package after v4.21 will be just bug fixes. \end{abstract} If you require multilingual support you must also separately install @@ -401,6 +417,21 @@ the \styfmt{glossaries} package will automatically try to load it and will give a warning if the module isn't found. See \sectionref{sec:languages} for further details. +The \styfmt{glossaries} package requires a number of other packages +including, but not limited to, \sty{tracklang}, \sty{mfirstuc}, +\sty{etoolbox}, +\sty{xkeyval} (at least version dated 2006/11/18), \sty{textcase}, +\sty{xfor}, \sty{datatool-base} (part of the \sty{datatool} bundle) and \sty{amsgen}. These +packages are all available in the latest \TeX\ Live and Mik\TeX\ +distributions. If any of them are missing, please update your +\TeX\ distribution using your update manager. +(For help on this see, for example, +\href{http://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How +do I update my \TeX\ distribution?} +or +\href{http://tex.stackexchange.com/questions/14925/updating-tex-on-linux}{Updating +\TeX\ on Linux}.) + \begin{important} Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and @@ -444,7 +475,7 @@ letter}{mfirstuc-manual}. \item[\url{glossaries-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v4.20}. +\qt{Documented Code for glossaries v4.21}. This includes the documented code for the \sty{mfirstuc} package. \item[INSTALL] Installation instructions. @@ -1830,7 +1861,9 @@ the appropriate UTF-8 characters. \begin{important} This section is only applicable if you have chosen \optsor23. You can -ignore this section if you have chosen \opt1. +ignore this section if you have chosen \opt1. If you want to +alphabetically sort your entries always remember to use the +\gloskey{sort} key if the \gloskey{name} contains any \LaTeX\ commands. \end{important} If this section seriously confuses you, and you can't work out how @@ -1894,6 +1927,12 @@ can't diagnose the problem, you will have to read the relevant transcript file and see if you can work it out from the \gls*{makeindex} or \gls*{xindy} messages. +\item If \gls{makeindex} warns about multiple encap values, +\gls{makeglossaries} will detect this and attempt to correct the +problem.\footnote{Added to version \gls{makeglossaries} 2.18.} Since +\gls{xindy} doesn't warn about this, this correction is only +provided by \gls{makeglossaries} when \gls{makeindex} is used. + \end{itemize} As from version 4.16, the \styfmt{glossaries} package also comes @@ -1906,21 +1945,19 @@ a~Lua interpreter) you don't need to install anything else in order to use \gls{makeglossaries-lite.lua} so it's an alternative to \gls{makeglossaries} if you want to use \opt2 (\gls{makeindex}). -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} Perl script or the \gls{makeglossaries-lite.lua} -script or the \gls{makeglossariesgui} Java application, it is +Whilst I strongly recommended that you use the \gls{makeglossaries} +Perl script or the \gls{makeglossaries-lite.lua} Lua script, it is possible to use the \styfmt{glossaries} package without using those applications. However, note that some commands and package options -have no effect if you explicitly run \gls{makeindex}\slash\gls{xindy}. +have no effect if you explicitly run \gls{makeindex}\slash\gls{xindy}. 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. +\gls*{makeindex} as \gls*{xindy} also requires Perl. (Other useful +Perl scripts include \appfmt{epstopdf} and \appfmt{latexmk}, so it's +well-worth the effort to install Perl.) \end{important} Note that if any of your entries use an entry @@ -1951,6 +1988,10 @@ latex myDoc makeglossaries myDoc latex myDoc \end{prompt} +(Note that if you use \gls{glossaries-extra}, this will be done +automatically for you if the \pkgoptfmt{indexcrossrefs} feature is +enabled. See the \gls*{glossaries-extra} user guide for further +details.) Likewise, an additional \gls{makeglossaries} and \LaTeX\ run may be required if the document pages shift with re-runs. For @@ -2074,6 +2115,31 @@ path. If this isn't the case, you can specify the full pathname using \texttt{-m} \meta{path/to/makeindex} for \gls*{makeindex} or \texttt{-x} \meta{path/to/xindy} for \gls*{xindy}. +As from \gls{makeglossaries} v2.18, if you are using +\gls{makeindex}, there's a check for \gls*{makeindex}['s] multiple +encap warning. This is where different encap values (location formats) are +used on the same location for the same entry. For example: +\begin{verbatim} +\documentclass{article} + +\usepackage{glossaries} +\makeglossaries + +\newglossaryentry{sample}{name={sample},description={an example}} + +\begin{document} +\gls{sample}, \gls[format=textbf]{sample}. +\printglossaries +\end{document} +\end{verbatim} +If you explicitly use \gls{makeindex}, this will cause a warning and +the location list will be \qt{1, \textbf{1}}. That is, the page +number will be repeated with each format. As from v2.18, +\gls{makeglossaries} will check for this warning and, if found, will +attempt to correct the problem by removing duplicate locations and +retrying. There's no similar check for \gls{xindy} as \gls*{xindy} +won't produce any warning and will simply discard duplicates. + The \gls{makeglossaries} script contains POD (Plain Old Documentation). If you want, you can create a man page for \gls*{makeglossaries} using \app{pod2man} and move the @@ -2084,7 +2150,7 @@ resulting file onto the man path. Alternatively do \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -??. +2.18. \end{important} \subsection{Using the makeglossaries-lite.lua Lua Script} @@ -2658,7 +2724,7 @@ If you want \cs{glsglossarymark} to use \cs{MakeUppercase} in the header, use th \pkgopt{ucmark} option described below. Occasionally you may find that another package defines -\linebreak\cs{cleardoublepage} when it is not required. This may cause an +\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 \DescribeMacro\glsclearpage\cs{glsclearpage}: \begin{verbatim} @@ -3281,8 +3347,8 @@ of acronyms using: \item[\pkgopt{shortcuts}] This option provides shortcut commands for acronyms. See \sectionref{sec:acronyms} for further details. Alternatively you can use: -\begin{definition}[\DescribeMacro\DefineAcronymShortcuts] -\cs{DefineAcronymShortcuts} +\begin{definition}[\DescribeMacro\DefineAcronymSynonyms] +\cs{DefineAcronymSynonyms} \end{definition} \end{description} @@ -3716,13 +3782,21 @@ information about this entry. There are two required fields: The description is set in the third argument of \cs{longnewglossaryentry} and \cs{longprovideglossaryentry}. With the other commands it's set via the \gloskey{description} key. -Available fields are listed below: +As is typical with \meta{key}=\meta{value} lists, values that contain +a comma or equal sign must be enclosed in +braces. Available fields are listed below: \begin{description} \item[{\gloskey{name}}] The name of the entry (as it will appear in the glossary). If this key is omitted and the \gloskey{parent} key is supplied, this value will be the same as the parent's name. +\begin{important} +If the \gloskey{name} key contains any commands, you must also +use the \gloskey{sort} key (described below) if you intend sorting the entries +alphabetically, otherwise the entries can't be sorted correctly. +\end{important} + \item[{\gloskey{description}}] A brief description of this term (to appear in the glossary). Within this value, you can use \begin{definition}[\DescribeMacro{\nopostdesc}] @@ -3865,7 +3939,10 @@ will set it to the expansion of the \gloskey{name} key (if \begin{important} Take care with \gls{xindy} (\opt3): if you have entries with the same \gloskey{sort} value they will be treated as the -same entry. +same entry. If you use \gls{xindy} and aren't using the \texttt{def} +or \texttt{use} sort methods, \textbf{always} use the \gloskey{sort} +key for entries where the name just consists of a control sequence +(for example \texttt{name=\{\cs{alpha}\}}). Take care if you use \opt1 and the \gloskey{name} contains fragile commands. You will either need to explicitly set the \gloskey{sort} @@ -3909,11 +3986,21 @@ glossary entries using \gloskey{nonumberlist=false} (see above). Alternatively, you can use the \pkgopt{seeautonumberlist} package option. For further details, see \sectionref{sec:crossref}. +This key essentially provides a convenient shortcut that performs +\begin{alltt} +\cs{glssee}\oarg{tag}\marg{label}\marg{xr-label list} +\end{alltt} +after the entry has been defined. + \begin{important} For \optsand23, \ics{makeglossaries} must be used before any occurrence of -\ics{newglossaryentry} that contains the \gloskey{see} key. +\ics{newglossaryentry} that contains the \gloskey{see} key. This key +has no effect for entries defined in the \env{document} environment. \end{important} +If you use the \gloskey{see} key, you may want to consider using the +supplementary \gls{glossaries-extra} package. + \end{description} The following keys are reserved for \ics{newacronym} (see @@ -3924,6 +4011,21 @@ and the \sty{glossaries-accsupp} (\sectionref{sec:accsupp}) packages. You can also define your own custom keys (see \sectionref{sec:addkey}). +\begin{important} +Avoid using any of the \glslike\ or \glstextlike\ commands within +the \gloskey{text}, \gloskey{first}, \gloskey{short} or +\gloskey{long} keys (or their plural equivalent) or any +other key that you plan to access through those commands. +(For example, the \gloskey{symbol} key if you intend to use +\cs{glssymbol}.) Otherwise you end up with nested links, which +can cause complications and they won't work with the case-changing +commands. You can use them within the value of keys +that won't be accessed through those commands. For example, +the \gloskey{description} key if you don't use \cs{glsdesc}. +Additionally, they'll confuse the entry formatting commands, such as +\cs{glslabel}. +\end{important} + Note that if the name starts with \gls{nonlatinchar}, you must group the character, otherwise it will cause a problem for commands like \ics{Gls} and \ics{Glspl}. @@ -4180,7 +4282,8 @@ Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all in the same glossary and I want the acronyms on first use to be displayed with the short form followed by the long form in parentheses, but the opposite way round for other -forms of abbreviations. +forms of abbreviations.\footnote{The \gls{glossaries-extra} package +provides a simpler way of achieving this.} Here I can define a new key that determines whether the term is actually an acronym rather than some other form of abbreviation. I'm @@ -4769,7 +4872,10 @@ used in the preamble. I reluctantly removed this restriction in version 1.13, but there are issues with defining commands in the \env{document} environment instead of the preamble, which is why the restriction is maintained for newer commands. This restriction is also reimposed -for \cs{newglossaryentry} by the new \opt1. +for \cs{newglossaryentry} by the new \opt1. (The +\gls{glossaries-extra} automatically reimposes this restriction for +\optsand23 but provides a package option to allow document +definitions.) \subsection{Technical Issues} \label{sec:techissues} @@ -4814,13 +4920,9 @@ There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the effect of your modification; this method requires an extra \cs{newwrite}, which may exceed \TeX's maximum allocation; unexpected expansion issues could -occur; if you have very long entries, you could find unexpected line -breaks have been written to the temporary file causing spurious -spaces (or, even worse, a~command name could get split across a line -causing an error message). - -The last reason is why \ics{longnewglossaryentry} has the -preamble-only restriction, which I don't intend to lift. +occur; the \gloskey{see} key isn't stored, which means it can't be +added to the \filetype{.glsdefs} file when it's created at the end of the +document (and therefore won't be present on subsequent runs). \subsection{Good Practice Issues} \label{sec:goodpractice} @@ -4859,6 +4961,35 @@ option, or an alternative counter can be set as the default using the \pkgopt{counter} package option. The number list is also referred to as the location list\index{location list|see{number list}}. +Each location in the \gls{numberlist} is encapsulated with a +command. (The \termdef{encap} value.) By default this is the +\ics{glsnumberformat} command, but may be overridden using the +\gloskey[glslink]{format} key in the optional argument to commands +like \cs{gls}. (See \sectionref{sec:glslink}.) For example, you may +want the location to appear in bold to indicate the principle use of +a term or symbol. Complications can arise if you use different encap +values for the same location. For example, suppose on page~10 you +have both the default \cs{glsnumberformat} and \cs{textbf} encaps. +While it may seem apparent that \cs{textbf} should override +\cs{glsnumberformat} in this situation, neither \gls{makeindex} nor +\gls{xindy} know this. In the case of \gls{xindy}, it only accepts +one encap and discards the other for identical locations. The encap +it chooses to keep may not necessarily be the one you want. In the +case of \gls{makeindex}, it accepts different encaps for the same +location, but warns about it. This leads to a \gls{numberlist} with +the same location repeated in different fonts. + +This is something you need to be careful about, but if you use the +\gls{makeglossaries} Perl script it will detect \gls{makeindex}'s +warning and attempt to fix the problem.\footnote{This feature was +introduced in \gls{makeglossaries} version 2.18.} Since \gls{xindy} +doesn't generate a warning, \gls{makeglossaries} won't do anything +about it if you are using \gls{xindy}. With \gls{makeindex}, +\gls{makeglossaries} will let the encaps override each other, +similar to \gls{xindy}, except that the \cs{glsnumberformat} encap +will always have the least precedence. Other conflicting encaps will +have the last one override earlier ones for the same location. + Due to the asynchronous nature of \TeX's output routine (see, for example, \href{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage}{Finding @@ -4959,7 +5090,6 @@ command.) Both \gls{makeindex} and \gls{xindy} (\optsand23) concatenate a sequence of~3 or more consecutive pages into~a range. With \gls*{xindy} (\opt3) you can vary the minimum sequence length using -\linebreak \ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either an integer or the keyword \texttt{none} which indicates that there should be no range formation. @@ -5081,6 +5211,14 @@ post-processed by \gls{makeindex} or \gls{xindy} unless you have chosen \opt1. If you don't use \ics{makeglossaries} these external files won't be created. +Note that repeated use of these commands for the same entry can +cause the \gls{numberlist} to become quite long, which may not be +particular helpful to the reader. In this case, you can use the +non-indexing commands described in \sectionref{sec:glsnolink} or +you can use the supplemental \gls{glossaries-extra} package, which +provides a means to suppress the automated indexing of the commands listed +in this chapter. + \begin{important} I strongly recommend that you don't use the commands defined in this chapter in the arguments of sectioning or caption @@ -5106,6 +5244,11 @@ command or use \sty{hyperref}'s \ics{texorpdfstring}. Examples: \chapter[An overview of Perl]{An overview of \gls{perl}} \chapter{An overview of \texorpdfstring{\gls{perl}}{Perl}} \end{verbatim} +If you want to retain the formatting that's available through +commands like \cs{acrshort} (for example, if you are using one of +the small caps styles), then you might want to consider the +\gls{glossaries-extra} package which provides commands +for this purpose. If you want the \gls{linktext} to produce a hyperlink to the corresponding entry details in the glossary, you should load the @@ -5160,29 +5303,43 @@ are the \glslike\ commands and are described in \sectionref{sec:gls-like}. The commands that don't reference or change the \firstuseflag\ are \glstextlike\ commands and are described in \sectionref{sec:glstext-like}. See \sectionref{sec:glsunset} for -commands that unset or reset the \firstuseflag\ without referencing +commands that unset (mark the entry as having been used) or reset +(mark the entry as not used) the \firstuseflag\ without referencing the entries. The \glslike\ and \glstextlike\ commands all take a first optional argument that is a comma-separated list of -\meta{key}=\meta{value} -options, described below. They also have a star-variant, which -inserts \texttt{hyper=false} at the start of the list of options -and a plus-variant, which inserts \texttt{hyper=true} at the start -of the list of options. For example \verb|\gls*{sample}| is the same -as \verb|\gls[hyper=false]{sample}| and \verb|\gls+{sample}| is the -same as \verb|\gls[hyper=true]{sample}|, whereas just -\verb|\gls{sample}| will use the default hyperlink setting which -depends on a number of factors (such as whether the entry is in a -glossary that has been identified in the \pkgopt{nohypertypes} list). -You can override the \gloskey[glslink]{hyper} key in the variant's -optional argument, for example, \verb|\gls*[hyper=true]{sample}| but -this creates redundancy and is best avoided. +\meta{key}=\meta{value} options, described below. They also have a +star-variant, which inserts \texttt{hyper=false} at the start of the +list of options and a plus-variant, which inserts +\texttt{hyper=true} at the start of the list of options. For example +\verb|\gls*{sample}| is the same as \verb|\gls[hyper=false]{sample}| +and \verb|\gls+{sample}| is the same as +\verb|\gls[hyper=true]{sample}|, whereas just \verb|\gls{sample}| +will use the default hyperlink setting which depends on a number of +factors (such as whether the entry is in a glossary that has been +identified in the \pkgopt{nohypertypes} list). You can override the +\gloskey[glslink]{hyper} key in the variant's optional argument, for +example, \verb|\gls*[hyper=true]{sample}| but this creates +redundancy and is best avoided. The \gls{glossaries-extra} package +provides the option to add a third custom variant. + +\begin{important} +Avoid nesting these commands. For example don't do +\cs{glslink}\marg{label}\texttt{\{\cs{gls}\marg{label2}\}} +as this is likely to cause problems. By implication, these +means that you should avoid using any of these commands within +the \gloskey{text}, \gloskey{first}, \gloskey{short} or +\gloskey{long} keys (or their plural equivalent) or any +other key that you plan to access through these commands. +(For example, the \gloskey{symbol} key if you intend to use +\cs{glssymbol}.) +\end{important} The following keys are available for the optional argument: \begin{description} \item[{\gloskey[glslink]{hyper}}] This is a boolean key which can -be used to enable/disable the hyperlink to the relevant entry +be used to enable\slash disable the hyperlink to the relevant entry in the glossary. If this key is omitted, the value is determined by current settings, as indicated above. For example, when used with a \glslike\ command, if this is the first use and the \pkgopt[false]{hyperfirst} package option has been used, @@ -5227,13 +5384,6 @@ with the \gloskey[glslink]{format} key using See \sectionref{sec:xindy} for further details. \end{important} -Note that unlike \ics{index}, you can't have anything following the -command name, such as an asterisk or arguments. If you want to -cross-reference another entry, either use the \gloskey{see} key when -you define the entry or use \ics{glssee} (described in -\sectionref{sec:crossref}). - - If you are using hyperlinks and you want to change the font of the hyperlinked location, don't use \ics{hyperpage} (provided by the \sty{hyperref} package) as the locations may not refer to a page @@ -5291,11 +5441,19 @@ the \gls*{firstuseflag} will be localised to the current scope. The default is \texttt{local=false}. \end{description} +The \gls{glossaries-extra} package provides an additional key. +Please see the \gls{glossaries-extra} user manual for further +details. + +\begin{important} +The \gls{linktext} isn't scoped by default. Any unscoped +declarations in the \gls{linktext} may affect subsequent text. +\end{important} \section{The \cs{gls}-Like Commands (First Use Flag Queried)} \label{sec:gls-like} -This section describes the commands that unset the \firstuseflag\ on +This section describes the commands that unset (mark as used) the \firstuseflag\ on completion, and in most cases they use the current state of the flag to determine the text to be displayed. As described above, these commands all have a star-variant (\texttt{hyper=false}) and @@ -5345,10 +5503,169 @@ and \end{definition} which make the first letter of the link text or all the link text upper case, respectively. For the former, the uppercasing of the -first letter is performed by \ics{makefirstuc}. For further -details, including its limitations, see the \sty{mfirstuc} user manual. +first letter is performed by \ics{makefirstuc}. + +\begin{important} +The first letter uppercasing command \cs{makefirstuc} has +limitations which must be taken into account if you use \cs{Gls} or +any of the other commands that convert the first letter to +uppercase. +\end{important} +The upper casing is performed as follows: +\begin{itemize} +\item If the first thing in the \gls{linktext} is a command follow +by a group, the upper casing is performed on the first object of the +group. For example, if an entry has been defined as +\begin{verbatim} +\newglossaryentry{sample}{ + name={\emph{sample} phrase}, + sort={sample phrase}, + description={an example}} +\end{verbatim} +Then \cs{Gls}\verb|{sample}| will set the \gls{linktext} +to\footnote{I've used \cs{MakeUppercase} in all the examples for clarity, but it +will actually use \cs{mfirstucMakeUppercase}.} +\begin{verbatim} +\emph{\MakeUppercase sample} phrase +\end{verbatim} +which will appear as \emph{\MakeUppercase sample} phrase. + +\item If the first thing in the \gls{linktext} isn't a command or is +a command but isn't followed by a group, then the upper casing will +be performed on that first thing. For example, if an entry has been +defined as: +\begin{verbatim} +\newglossaryentry{sample}{ + name={\oe-ligature}, + sort={oe-ligature}, + description={an example} +} +\end{verbatim} +Then \cs{Gls}\verb|{sample}| will set the \gls{linktext} to +\begin{verbatim} +\MakeUppercase \oe-ligature +\end{verbatim} +which will appear as \MakeUppercase \oe-ligature. + +\item If you have \sty{mfirstuc} v2.01 or above, an extra case is +added. If the first thing is \cs{protect} it will be discarded and +the above rules will then be tried. -There are also analogous plural forms: +\end{itemize} +(Note the use of the \gloskey{sort} key in the above examples.) + +There are hundreds of \LaTeX\ packages that altogether define +thousands of commands with various syntax and it's impossible for +\sty{mfirstuc} to take them all into account. The above rules are quite +simplistic and are designed for \gls{linktext} that starts with +a~text-block command (such as \cs{emph}) or a command that produces +a character (such as \cs{oe}). This means that if your \gls{linktext} +starts with something that doesn't adhere to \sty{mfirstuc}'s assumptions +then things are likely to go wrong. + +For example, starting with a math-shift symbol: +\begin{verbatim} +\newglossaryentry{sample}{ + name={$a$}, + sort={a}, + description={an example} +} +\end{verbatim} +This falls into case~2 above, so the \gls{linktext} will be set to +\begin{verbatim} +\MakeUppercase $a$ +\end{verbatim} +This attempts to uppercase the math-shift \verb|$|, which will go +wrong. In this case it's not appropriate to perform any +case-changing, but it may be that you want to use \cs{Gls} +programmatically without checking if the text contains any maths. +In this case, the simplest solution is to insert an empty brace at +the start: +\begin{verbatim} +\newglossaryentry{sample}{ + name={{}$a$}, + sort={a}, + description={an example} +} +\end{verbatim} +Now the \gls{linktext} will be set to +\begin{verbatim} +\MakeUppercase{}$a$ +\end{verbatim} +and the \cs{uppercase} becomes harmless. + +Another issue occurs when the \gls{linktext} starts with a command +followed by an argument (case~1) but the argument is a label, +identifier or something else that shouldn't have a case-change. +A common example is when the \gls{linktext} starts with one of the +commands described in this chapter. (But you haven't done that, have +you? What with the warning not to do it at the beginning of the chapter.) +Or when the \gls{linktext} starts with one of the non-linking +commands described in \sectionref{sec:glsnolink}. For example: +\begin{verbatim} +\newglossaryentry{sample}{name={sample},description={an example}} +\newglossaryentry{sample2}{ + name={\glsentrytext{sample} two}, + sort={sample two}, + description={another example} + } +\end{verbatim} +Now the \gls{linktext} will be set to: +\begin{verbatim} +\glsentrytext{\MakeUppercase sample} two +\end{verbatim} +This will generate an error because there's no entry with the label +given by \verb|\MakeUppercase sample|. The best solution here is to +write the term out in the \gloskey{text} field and use the command +in the \gloskey{name} field. If you don't use \cs{glsname} anywhere +in your document, you can use \cs{gls} in the \gloskey{name} field: +\begin{verbatim} +\newglossaryentry{sample}{name={sample},description={an example}} +\newglossaryentry{sample2}{ + name={\gls{sample} two}, + sort={sample two}, + text={sample two}, + description={another example} + } +\end{verbatim} + +If the \gls{linktext} starts with a command that has an optional +argument or with multiple arguments where the actual text isn't in +the first argument, then \cs{makefirstuc} will also fail. For +example: +\begin{verbatim} +\newglossaryentry{sample}{ + name={\textcolor{blue}{sample} phrase}, + sort={sample phrase}, + description={an example}} +\end{verbatim} +Now the \gls{linktext} will be set to: +\begin{verbatim} +\textcolor{\MakeUppercase blue}{sample} phrase +\end{verbatim} +This won't work because \verb|\MakeUppercase blue| isn't a recognised +colour name. In this case you will have to define a helper command where +the first argument is the text. For example: +\begin{verbatim} +\newglossaryentry{sample}{ +\newcommand*{\blue}[1]{\textcolor{blue}{#1}} + name={\blue{sample} phrase}, + sort={sample phrase}, + description={an example}} +\end{verbatim} +In fact, since the whole design ethos of \LaTeX\ is the separation +of content and style, it's better to use a semantic command. For +example: +\begin{verbatim} +\newglossaryentry{sample}{ +\newcommand*{\keyword}[1]{\textcolor{blue}{#1}} + name={\keyword{sample} phrase}, + sort={sample phrase}, + description={an example}} +\end{verbatim} +For further details see the \sty{mfirstuc} user manual. + +There are plural forms that are analogous to \cs{gls}: \begin{definition}[\DescribeMacro{\glspl}] \cs{glspl}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -5360,8 +5677,8 @@ There are also analogous plural forms: \end{definition} These typically determine the link text from the \gloskey{plural} or \gloskey{firstplural} keys supplied when the entry was -defined using \ics{newglossaryentry} or, if the entry is an acronym -and \cs{setacronymstyle} was used, from the \gloskey{longplural} or +defined using \ics{newglossaryentry} or, if the entry is an +abbreviation and \cs{setacronymstyle} was used, from the \gloskey{longplural} or \gloskey{shortplural} keys. \begin{important} @@ -5422,7 +5739,9 @@ final argument. \begin{important} Don't use any of the \glslike\ or \glstextlike\ commands in the -argument of \cs{glslink}. +argument of \cs{glslink}. By extension, this means that you can't +use them in the value of fields that are used to form +\gls{linktext}. \end{important} \begin{definition}[\DescribeMacro{\glstext}] @@ -5439,7 +5758,8 @@ There are also analogous commands: \cs{GLStext}\oarg{options}\marg{text}\oarg{insert} \end{definition} These convert the first character or all the characters to -uppercase, respectively. +uppercase, respectively. See the note on \cs{Gls} above for details +on the limitations of converting the first letter to upper case. \begin{definition}[\DescribeMacro{\glsfirst}] \cs{glsfirst}\oarg{options}\marg{label}\oarg{insert} @@ -5455,6 +5775,16 @@ There are also analogous uppercasing commands: \cs{GLSfirst}\oarg{options}\marg{text}\oarg{insert} \end{definition} +\begin{important} +The value of the \gloskey{first} key (and \gloskey{firstplural} key) +doesn't necessarily match the text produced by \ics{gls} (or \ics{glspl}) on +\firstuse\ as the \gls{linktext} used by \ics{gls} may be modified +through commands like \ics{defglsentry}. (Similarly, the value of the +\gloskey{text} and \gloskey{plural} keys don't necessarily match +the \gls*{linktext} used by \cs{gls} or \cs{glspl} on subsequent +use.) +\end{important} + \begin{definition}[\DescribeMacro{\glsplural}] \cs{glsplural}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -5721,11 +6051,23 @@ Note that you can also use commands such as \ics{ifglsused} within the definition of \cs{glsentryfmt} (see \sectionref{sec:glsunset}). The commands \ics{glslabel}, \ics{glstype}, \ics{glsifplural}, -\ics{glscapscase}, \ics{glscustomtex} and \ics{glsinsert} are +\ics{glscapscase}, \ics{glscustomtext} and \ics{glsinsert} are typically updated at the start of the \glslike\ and \glstextlike\ commands so they can usually be accessed in the hook user commands, such as \ics{glspostlinkhook} and \ics{glslinkpostsetkeys}. +\begin{important} +This means that using commands like \ics{gls} within the fields +that are accessed using the \glslike\ or \glstextlike\ commands +(such as the \gloskey{first}, \gloskey{text}, \gloskey{long} +or \gloskey{short} keys) will cause a problem. The entry formatting +performed by \cs{glsentryfmt} and related commands isn't scoped +(otherwise if would cause problems for \cs{glspostlinkhook} which +may need to look ahead as well as look behind). +This means that any nested commands will, at the very least, change +the label stored in \cs{glslabel}. +\end{important} + If you only want to make minor modifications to \cs{glsentryfmt}, you can use \begin{definition}[\DescribeMacro{\glsgenentryfmt}] @@ -5735,7 +6077,7 @@ This uses the above commands to display just the \gloskey{first}, \gloskey{text}, \gloskey{plural} or \gloskey{firstplural} keys (or the custom text) with the insert text appended. -Alternatively, if want to change the entry format for acronyms +Alternatively, if want to change the entry format for abbreviations (defined via \ics{newacronym}) you can use: \begin{definition}[\DescribeMacro{\glsgenacfmt}] \cs{glsgenacfmt} @@ -5779,7 +6121,8 @@ only need to redefine \ics{genacrfullformat} and on changing the style of acronyms. \begin{important} -Note that \cs{glsentryfmt} is not used by the \glstextlike\ commands. +Note that \cs{glsentryfmt} (or the formatting given by \cs{defglsentryfmt}) +is not used by the \glstextlike\ commands. \end{important} As from version 4.16, both the \glslike\ and \glstextlike\ commands @@ -6319,7 +6662,10 @@ package, but make sure you use one of the expandable commands within \begin{verbatim} \ecaptialisewords{\glsentrytext{somelabel}} \end{verbatim} -Note that \cs{ecapitalisewords} is not expandable. +Note that \cs{ecapitalisewords} is not expandable. Note that +this command has the same limitations as \cs{makefirstuc} which is +used by commands like \cs{Gls} and \cs{Glsentryname} to upper-case +the first letter (see the notes about \cs{Gls} in \sectionref{sec:gls-like}). \begin{definition}[\DescribeMacro{\glsentryname}] \cs{glsentryname}\marg{label} @@ -6585,7 +6931,7 @@ followed by one or two runs of \LaTeX\ is required. The first command, \cs{glsentrynumberlist}, simply displays the number list as is. The second command, -\linebreak\cs{glsdisplaynumberlist}, formats the list using: +\cs{glsdisplaynumberlist}, formats the list using: \begin{definition}[\DescribeMacro{\glsnumlistsep}] \cs{glsnumlistsep} \end{definition} @@ -6627,15 +6973,21 @@ glossary} in the documented code (\texttt{glossaries-code.pdf}). (Must be used with \ics{makeglossaries} in the preamble.) \end{description} -These commands will display all the glossaries in the order in which they were -defined. Note that, in the case of \optsand23, no glossaries will appear until you have either -used the Perl script \gls{makeglossaries} or have directly used -\gls{makeindex} or \gls{xindy} (as described in -\sectionref{sec:makeglossaries}). If the glossary -still does not appear after you re-\LaTeX\ your document, check the -\gls*{makeindex}\slash\gls*{xindy} log files to see if there is a problem. -With \opt1, you just need two \LaTeX\ runs to make the glossaries appear, -but you may need further runs to make the \glspl{numberlist} up-to-date. +These commands will display all the glossaries in the order in which +they were defined. Note that, in the case of \optsand23, no +glossaries will appear until you have either used the Perl script +\gls{makeglossaries} or Lua script \gls{makeglossaries-lite.lua} or +have directly used \gls{makeindex} or \gls{xindy} (as described in +\sectionref{sec:makeglossaries}). (While the external files are +missing, these commands will just do \cs{null} for each missing +glossary to assist dictionary style documents that just use +\cs{glsaddall} without inserting any text.) + +If the glossary still does not appear after you re-\LaTeX\ your +document, check the \gls*{makeindex}\slash\gls*{xindy} log files to +see if there is a problem. With \opt1, you just need two \LaTeX\ +runs to make the glossaries appear, but you may need further runs to +make the \glspl{numberlist} up-to-date. An individual glossary can be displayed using: \begin{description} @@ -6652,6 +7004,9 @@ An individual glossary can be displayed using: (Must be used with \ics{makeglossaries} in the preamble.) \end{description} where \meta{options} is a \meta{key}=\meta{value} list of options. +(Again, when the associated external file is missing, \cs{null} is +inserted into the document.) + The following keys are available: \begin{description} \item[{\gloskey[printglossary]{type}}] The value of this key @@ -6687,7 +7042,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 \linebreak(\verb|nonumberlist=false|) the +for this glossary. If false (\verb|nonumberlist=false|) the numberlist is displayed for this glossary. \item[{\gloskey[printglossary]{nogroupskip}}] This is a boolean @@ -6737,7 +7092,7 @@ entries have fragile commands in their \gloskey{sort} field. 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 -\linebreak\ics{setglossarysection} command. Numbered sectional units can be +\ics{setglossarysection} command. Numbered sectional units can be obtained using the \pkgopt{numberedsection} package option. Each glossary sets the page header via the command \begin{definition}[\DescribeMacro\glsglossarymark] @@ -7007,7 +7362,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 \linebreak\cs{theH}\meta{counter} either isn't defined or is +is needed if \cs{theH}\meta{counter} either isn't defined or is different from \cs{the}\meta{counter}. (See also \ics{glsaddprotectedpagefmt} described in \sectionref{sec:numberlists}.) @@ -7214,7 +7569,7 @@ Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if 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}\linebreak\oarg{counter} +\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\linebreak\marg{title}\oarg{counter} \end{definition} where \meta{name} is the label to assign to this glossary. The arguments \meta{in-ext} and \meta{out-ext} specify the extensions to @@ -7253,7 +7608,7 @@ which is equivalent to \cs{newglossary}[\meta{tag}-glg]\marg{name}\{\meta{tag}-gls\}\{\meta{tag}-glo\}\marg{title}\oarg{counter} \end{alltt} -It may be that you have some terms or acronyms that are so common +It may be that you have some terms that are so common that they don't need to be listed. In this case, you can define a~special type of glossary that doesn't create any associated files. This is referred to as an \qt{ignored glossary} and it's ignored by @@ -7329,20 +7684,23 @@ change LaTeX’s \qt{fixed names}}. \begin{important} Note that although this chapter uses the term \qt{acronym}, you can also -use the commands described here for abbreviations or contractions +use the commands described here for initialisms or contractions (as in the case of some of the examples given below). If the glossary title is no longer applicable (for example, it should be \qt{Abbreviations} rather than \qt{Acronyms}) then you can change the title either by redefining \ics{acronymname} (see \sectionref{sec:languages}) or by using the \gloskey[printglossary]{title} in the optional argument of \ics{printglossary} (or -\ics{printacronym}). +\ics{printacronym}). You may prefer to use the +\gls{glossaries-extra} package which defines \cs{newabbreviation} +and treats acronyms (e.g.\ \qt{laser}) differently from other forms +of abbreviations (e.g.\ \qt{html}). \end{important} You may have noticed in \sectionref{sec:newglosentry} that when you specify a new entry, you can specify alternate text to use when the term is \glsd{firstuse} in the document. This provides a -useful means to define acronyms. For convenience, the +useful means to define abbreviations. For convenience, the \styfmt{glossaries} package defines the command: \begin{definition}[\DescribeMacro{\newacronym}] \cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long} @@ -7417,12 +7775,50 @@ Now \verb|\gls{idn}| will produce \qt{identification number uses. \end{example} +Recall from the warning in +\sectionref{sec:newglosentry} that you should avoid using +the \glslike\ and \glstextlike\ commands within the value of +keys like \gloskey{text} and \gloskey{first} due to complications +arising from nested links. The same applies to abbreviations +defined using \cs{newacronym}. + +For example, suppose you have defined: +\begin{verbatim} +\newacronym{ssi}{SSI}{server side includes} +\newacronym{html}{HTML}{hypertext markup language} +\end{verbatim} +you may be tempted to do: +\begin{verbatim} +\newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}} +\end{verbatim} +\textbf{Don't!} This will break the case-changing commands, such +as \ics{Gls}, it will cause inconsistencies on \firstuse, and, +if hyperlinks are enabled, will cause nested hyperlinks. It will +also confuse the commands used by the entry formatting (such as +\ics{glslabel}). + +Instead, consider doing: +\begin{verbatim} +\newacronym + [description={\gls{ssi} enabled \gls{html}}] + {shtml}{SHTML}{SSI enabled HTML} +\end{verbatim} +or +\begin{verbatim} +\newacronym + [description={\gls{ssi} enabled \gls{html}}] + {shtml}{SHTML} + {server side includes enabled hypertext markup language} +\end{verbatim} +Similarly for the \glstextlike\ commands. + \begin{important} The commands described below are similar to the \glstextlike\ commands in that they don't modify the \firstuseflag. However, their display is governed by \ics{defentryfmt} with \ics{glscustomtext} set as appropriate. All caveats that apply to the \glstextlike\ commands also apply to the following commands. +(Including the warning immediately above this box.) \end{important} The optional arguments are the same as those for the \glstextlike\ @@ -7622,7 +8018,7 @@ And the full form can be obtained using: These again use \ics{acrfullformat} by default, but the format may be redefined by the acronym style. -\section{Changing the Acronym Style} +\section{Changing the Abbreviation Style} \label{sec:setacronymstyle} It may be that the default style doesn't suit your requirements in @@ -7639,6 +8035,12 @@ representing lists of acronyms, you must use \cs{setacronymstyle} \emph{after} using \cs{DeclareAcronymList}. \end{important} +The \styfmt{glossaries} package has the restriction that only one +style may be in use that applies to all entries defined with +\cs{newacronym}. If you need multiple abbreviation styles, then try +using the \gls{glossaries-extra} package, which has better +abbreviation management. + Note that unlike the default behaviour of \cs{newacronym}, the styles used via \cs{setacronymstyle} don't use the \gloskey{first} or \gloskey{text} keys, but instead they use \ics{defglsentryfmt} to @@ -8412,6 +8814,8 @@ adjust the space factor, which is usually done by inserting \cs{@} before the full stop. The next example shows one way of achieving this. +(Note that the supplemental \gls{glossaries-extra} package provides a much +simpler way of doing this, which you may prefer to use.) \begin{example}{Abbreviations with Full Stops (Periods)}{ex:dotabbr} As from version 4.16, there's now a hook (\ics{glspostlinkhook}) @@ -8768,7 +9172,9 @@ Flag Unset)} As from version 4.14, it's now possible to keep track of how many times an entry is used. That is, how many times the \firstuseflag\ -is unset. +is unset. Note that the supplemental \gls{glossaries-extra} package improves +this function and also provides per-unit counting, which isn't +available with the \styfmt{glossaries} package. \begin{important} This function is disabled by default as it adds extra @@ -9218,7 +9624,8 @@ unless you use the \pkgopt{nolong} or \pkgopt{nostyles} package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in \sectionref{sec:longraggedstyles}. - +If you want to incorporate rules from the \sty{booktabs} package, +try the styles described in \sectionref{sec:longbooktabsstyles}. \begin{description} \item[long] The \glostyle{long} style uses the \env{longtable} @@ -9285,7 +9692,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 \linebreak\ics{glspagelistwidth}. The widths of the +governed by the length \ics{glspagelistwidth}. The widths of the name and symbol columns are governed by the widest entry in the given column. @@ -9298,7 +9705,7 @@ page lists. page lists. \item[altlong4colheaderborder] The \glostyle{altlong4colheaderborder} -style is like \linebreak\glostyle{long4colheaderborder} but allows multi-line +style is like \glostyle{long4colheaderborder} but allows multi-line descriptions and page lists. \end{description} @@ -9322,6 +9729,8 @@ these styles will only be available if you explicitly load Note that you can't set these styles using the \pkgopt{style} package option since the styles aren't defined until after the \styfmt{glossaries} package has been loaded. +If you want to incorporate rules from the \sty{booktabs} package, +try the styles described in \sectionref{sec:longbooktabsstyles}. \begin{description} \item[longragged] The \glostyle{longragged} style has two @@ -9389,6 +9798,75 @@ lines around it. \end{description} +\subsection{Longtable Styles (\styfmt{booktabs})} +\label{sec:longbooktabsstyles} + +The styles described in this section are all defined in the package +\sty{glossary-longbooktabs}. + +Since these styles all use the +\env{longtable} environment, they are governed by the same +parameters as that environment. The \sty{glossary-longbooktabs} +package automatically loads the \sty{glossary-long} +(\sectionref{sec:longstyles}) +and \sty{glossary-longragged} (\sectionref{sec:longraggedstyles}) packages. Note that +these styles will only be available if you explicitly load +\sty{glossary-longbooktabs}: +\begin{verbatim} +\usepackage{glossaries} +\usepackage{glossary-longbooktabs} +\end{verbatim} +Note that you can't set these styles using the \pkgopt{style} +package option since the styles aren't defined until after +the \styfmt{glossaries} package has been loaded. + +These styles are similar to the +\qt{header} styles in the \sty{glossary-long} and +\sty{glossary-ragged} packages, but they add the rules +provided by the \sty{booktabs} package, \ics{toprule}, \ics{midrule} and +\ics{bottomrule}. Additionally these styles patch the +\env{longtable} environment to check for instances of the group +skip occurring at a page break. If you don't want this patch to +affect any other use of \env{longtable} in your document, you can +scope the effect by only setting the style through the +\gloskey[printglossary]{style} key in the optional argument of +\cs{printglossary}. (The \pkgopt{nogroupskip} package option +is checked by these styles.) + +Alternatively, you can restore the original \env{longtable} +behaviour with: +\begin{definition}[\DescribeMacro\glsrestoreLToutput] +\cs{glsrestoreLToutput} +\end{definition} +For more information about the patch, see the documented code +(\texttt{glossaries-code.pdf}). + +\begin{description} +\item[\glostyle{long-booktabs}] This style is similar to +the \glostyle{longheader} style but adds rules above and below the +header (\cs{toprule} and \cs{midrule}) and inserts a rule at the +bottom of the table (\cs{bottomrule}). + +\item[\glostyle{long3col-booktabs}] This style is similar to +the \glostyle{long3colheader} style but adds rules as per +\glostyle{long-booktabs}. + +\item[\glostyle{long4col-booktabs}] This style is similar to +the \glostyle{long4colheader} style but adds rules as above. + +\item[\glostyle{altlong4col-booktabs}] This style is similar to +the \glostyle{altlong4colheader} style but adds rules as above. + +\item[\glostyle{longragged-booktabs}] This style is similar to +the \glostyle{longraggedheader} style but adds rules as above. + +\item[\glostyle{longragged3col-booktabs}] This style is similar to +the \glostyle{longragged3colheader} style but adds rules as above. + +\item[\glostyle{altlongragged4col-booktabs}] This style is similar to +the \glostyle{altlongragged4colheader} style but adds rules as above. + +\end{description} \subsection{Supertabular Styles} \label{sec:superstyles} @@ -9445,7 +9923,7 @@ lines around it. \glostyle{super3col} but has a header row. \item[super3colheaderborder] The \glostyle{super3colheaderborder} style -is like the \linebreak\glostyle{super3colheader} style but has horizontal and vertical +is like the \glostyle{super3colheader} style but has horizontal and vertical lines around it. \item[super4col] The \glostyle{super4col} style is like @@ -9463,7 +9941,7 @@ lines around it. \glostyle{super4col} but has a header row. \item[super4colheaderborder] The \glostyle{super4colheaderborder} style -is like the \linebreak\glostyle{super4colheader} style but has horizontal and vertical +is like the \glostyle{super4colheader} style but has horizontal and vertical lines around it. \item[altsuper4col] The \glostyle{altsuper4col} style is like @@ -9930,7 +10408,7 @@ may contain \ics{delimN} (to delimit individual numbers) and/or multiple occurrences of \ics{setentrycounter}\oarg{Hprefix}\marg{counter name}\meta{format cmd}\marg{number(s)}, but note that the entire number list is enclosed within the argument -of \linebreak\ics{glossaryentrynumbers}. The user can redefine this to change +of \ics{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 \ics{glossaryentrynumbers} is to provide a means of suppressing the @@ -10128,6 +10606,9 @@ can be found in the documented code (glossaries-code.pdf). Some of the commands described here take a comma-separated list as an argument. As with \LaTeX's \cs{@for} command, make sure your list doesn't have any unwanted spaces in it as they don't get stripped. +(Discussed in more detail in +\href{http://www.dickimaw-books.com/latex/admin/html/docsvlist.shtml#spacesinlists}{\S2.7.2 of \qt{\LaTeX\ for Administrative +Work}}.) \end{important} \begin{definition}[\DescribeMacro{\forallglossaries}] @@ -10499,7 +10980,8 @@ commands contained in the \meta{definition} must be protected. \chapter{Prefixes or Determiners}\label{sec:prefix} -The \sty{glossaries-prefix} package provides +The \sty{glossaries-prefix} package that comes with the +\styfmt{glossaries} package provides additional keys that can be used as prefixes. For example, if you want to specify determiners (such as \qt{a}, \qt{an} or \qt{the}). The \styfmt{glossaries-prefix} @@ -10795,7 +11277,7 @@ The sample file \samplefile{accsupp} illustrates the \sty{glossaries-accsupp} package. See \ifpdf section~\ref*{sec:code:accsupp} in \fi the documented code -(\texttt{glossaries-code.pdf}) for further details. It is recommended +(\texttt{glossaries-code.pdf}) for further details. I~recommend that you also read the \sty{accsupp} documentation. \chapter{Troubleshooting} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 4df38cac1c2..647cd7542a2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -4,13 +4,13 @@ -The glossaries package v4.20: a guide for beginners + - + -

    - +

    + - - + +

    + - - -

    The glossaries package v4.20: a guide for beginners

    -
    Nicola L.C. Talbot

    -
    2015-11-30
    -
    + +

    +
    +

    +

    The glossaries package v4.21: a guide for +beginners +

    +
    Nicola L.C. Talbot
    +
    +

    2016-01-24

    @@ -223,24 +243,24 @@ class="cmr-9">the high-level user commands, the main user manual is quite big. T be rather daunting for beginners, so this document is a brief introduction just to help get you started. If you find yourself saying, “Yeah, but how can +class="cmr-9">just to help get you started. If you find yourself saying, “Yeah, but how I docan I do…?” then it’s time to move on to the main user manual.

    I’ve made some statements in this document that don’t actually tell you +class="cmr-9">I’ve made some statements in this document that don’t actually tell the full truth, but it would clutter the document and cause confusion if I +class="cmr-9">you the full truth, but it would clutter the document and cause confusion keep writing “except when …” or “but you can also do this, that or the other” +class="cmr-9">if I keep writing “except when …” or “but you can also do this, that or or “you can do it this way but you can also do it that way, but that way +class="cmr-9">the other” or “you can do it this way but you can also do it that way, but may cause complications under certain circumstances”. +class="cmr-9">that way may cause complications under certain circumstances”.

    may cause complications under certain circumstances”.
    1 Getting Started + + +
    2 Defining Terms
    3 Using Entries href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries
    5 Customising the Glossary - - -
    6 Multiple Glossaries
    7 Top

    Getting Started

    As with all packages, you need to load glossaries with \usepackage, but there are -certain packages that must be loaded before \usepackage, but +there are certain packages that must be loaded before glossaries, if they are required: if they are +required: hyperref, -, babel, polyglossiapolyglossiainputenc and fontenc. (You don’t have to load these packages, but if -you want them, you must load them before . (You don’t have +to load these packages, but if you want them, you must load them before +glossaries.) -

    If you require multilingual support you must also install the relevant language -module. Each language module is called

    If you require multilingual support you must also install the relevant +language module. Each language module is called glossaries-language⟩, where ⟨language⟩ is the -root language name. For example, glossaries-french or glossaries-german. If a -language module is required, the glossaries package will automatically try to load it and -will give a warning if the module isn’t found.
    +class="cmti-10">language
    ⟩, where +⟨language⟩ is the root language name. For example, glossaries-french or +glossaries-german. If a language module is required, the glossaries package will +automatically try to load it and will give a warning if the module isn’t found. +

    Once you have loaded glossaries, you need to define your terms in the preamble and -then you can use them throughout the document. Here’s a simple example: - +class="cmss-10">glossaries, you need to define your terms in the +preamble and then you can use them throughout the document. Here’s a simple +example: + - +

    \documentclass{article} @@ -323,9 +346,9 @@ then you can use them throughout the document. Here’s a simple example:
    Here’s my sample term.
    Here’s another example: - + - +

    \documentclass{article} @@ -353,29 +376,30 @@ class="cmtt-10">.log file and search for the line that starts with Package: glossaries followed by a date and version.) -

    If you like, you can put all your definitions in another file (for example, defns.tex) -and load that file in the preamble using \loadglsentries with the filename as the -argument. For example: - - - +

    If you like, you can put all your definitions in another file (for example, +defns.tex) and load that file in the preamble using \loadglsentries with the +filename as the argument. For example: + + +

    \loadglsentries{defns}

    -

    Don’t try inserting formatting commands into the definitions as they can interfere -with the underlying mechanism. Instead, the formatting should be done by the style. -For example, suppose I want to replace SVM in the above to \textsc{svm}, then I need -to select a style that uses \textsc, like this: - - - +

    Don’t try inserting formatting commands into the definitions as they can +interfere with the underlying mechanism. Instead, the formatting should +be done by the style. For example, suppose I want to replace SVM in the +above to \textsc{svm}, then I need to select a style that uses \textsc, like +this: + + +

    \documentclass{article} @@ -394,48 +418,51 @@ class="cmtt-10">ex and in the second case the label was svm. The label is just a way of identifying the term (like the standard \label/\ref mechanism). It’s best to -just use the following alphanumerics in the labels: \ref mechanism). It’s best to just use +the following alphanumerics in the labels: a, …, z, A, …, Z, 0, …, 9. -Sometimes you can also use punctuation characters but not if another package (such -as 9. Sometimes you can +also use punctuation characters but not if another package (such as babel) meddles with them. Don’t try using any characters outside of the -basic Latin set (for example, é or ß) or things will go horribly wrong. This -warning only applies to the label. It doesn’t apply to the text that appears in the + id="dx1-2006">) +meddles with them. Don’t try using any characters outside of the basic Latin +set (for example, é or ß) or things will go horribly wrong. This warning +only applies to the label. It doesn’t apply to the text that appears in the document.

    Don’t use \gls in chapter or section headings as it can have some unpleasant -side-effects. Instead use \glsentrytext for regular entries and one of \glsentryshort, -\gls in chapter or section headings as it can have some +unpleasant side-effects. Instead use \glsentrytext for regular entries and +one of \glsentryshort, \glsentrylong or \glsentryfull for acronyms.
    +class="cmtt-10">\glsentryfull for acronyms. +

    -

    The above examples are reasonably straightforward. The difficulty comes if you -want to display a sorted list of all the entries you have used in the document. The -

    The above examples are reasonably straightforward. The difficulty comes +if you want to display a sorted list of all the entries you have used in the +document. The glossaries package provides three options: use TEX to perform the sorting; use -EX to perform the +sorting; use makeindex to perform the sorting; use xindy to perform the sorting. +class="cmtt-10">xindy to perform the +sorting.

    The first option (using TEX) is the simplest and easiest method, but it’s inefficient -and the sorting is done according to the English alphabet. To use this method, add +class="E">EX) is the simplest and easiest method, but +it’s inefficient and the sorting is done according to the English alphabet. +To use this method, add \makenoidxglossaries to the preamble and put \makenoidxglossaries to the preamble and put \printnoidxglossaries at the place -where you want your glossary. For example: - +class="cmtt-10">\printnoidxglossaries at the place where you want your glossary. For +example: + - +

    \documentclass{article} @@ -455,28 +482,30 @@ where you want your glossary. For example:

    Try this out and run LATEX (or pdfLATEX) twice. The first run won’t show the -glossary. It will only appear on the second run. The glossary has a vertical gap between -the “carrot” term and the “potato” term. This is because the entries in the glossaries -are grouped according to their first letter. If you don’t want this gap, just add -nogroupskip to the package options: - - - +class="cmti-10">twice. The first run won’t +show the glossary. It will only appear on the second run. The glossary has +a vertical gap between the “carrot” term and the “potato” term. This is +because the entries in the glossaries are grouped according to their first +letter. If you don’t want this gap, just add nogroupskip to the package +options: + + +

    \usepackage[nogroupskip]{glossaries}
    -

    If you try out this example you may also notice that the description is followed by a -full stop (period) and a number. The number is the location in the document where the -entry was used, so you can lookup the term in the glossary and be directed to the -relevant pages. It may be that you don’t want this back-reference, in which case you can -suppress it using the nonumberlist package option: - +

    If you try out this example you may also notice that the description is followed +by a full stop (period) and a number. The number is the location in the +document where the entry was used, so you can lookup the term in the glossary +and be directed to the relevant pages. It may be that you don’t want this +back-reference, in which case you can suppress it using the nonumberlist package +option: + - +

    \usepackage[nonumberlist]{glossaries} @@ -484,9 +513,9 @@ class="cmtt-10">nonumberlist package option:

    If you don’t like the terminating full stop, you can suppress that with the nopostdot package option: - + - +

    \usepackage[nopostdot]{glossaries} @@ -494,9 +523,9 @@ package option:

    You may have noticed that I’ve used another command in the above example: \glspl. This displays the plural form. By default, this is just the singular form with the -letter “s” appended, but in the case of “potato” I had to specify the correct plural using -the \glspl. This displays the plural form. By default, this is just the singular form with +the letter “s” appended, but in the case of “potato” I had to specify the correct +plural using the plural key.

    As I mentioned earlier, using TEX to sort the entries is the simplest but least @@ -506,8 +535,8 @@ extended Latin characters, then you will have a much faster build time if you us class="cmtt-10">makeindex or xindy. If you are using extended Latin or non-Latin characters, then xindy is the recommended method. These two methods are described in more detail in -xindy is the recommended method. These two methods are described in more detail +in §4 Displaying a List of Entries. @@ -524,8 +553,8 @@ class="cmss-10">glossaries package, you need to define glossary entries in the document preamble. These entries could be a word, phrase, acronym or symbol. They’re usually accompanied by a description, which could be a short sentence or an -in-depth explanation that spans multiple paragraphs. The simplest method of defining -an entry is to use: +in-depth explanation that spans multiple paragraphs. The simplest method of +defining an entry is to use:


    }

    where ⟨label⟩ is a unique label that identifies this entry. (Don’t include the angle brackets ⟨ -⟩. They just indicate the parts of the code you need to change when you use +class="cmti-10">label⟩ is a unique label that identifies this entry. (Don’t include the angle +brackets ⟨ ⟩. They just indicate the parts of the code you need to change when you use this command in your document.) The ⟨name⟩ is the word, phrase or symbol - + - + you are defining, and ⟨description⟩ is the description to be displayed in the glossary. @@ -601,9 +630,9 @@ class="cmtt-10">}

  • Define the term “set” with the label set: - + - +
    \newglossaryentry{set}  
    { @@ -617,9 +646,9 @@ class="cmtt-10">set: class="enumerate" id="x1-3005x2">Define the symbol with the label emptyset: - + - +
    \newglossaryentry{emptyset}  
    { @@ -632,9 +661,9 @@ class="cmtt-10">emptyset:
  • Define the phrase “Fish Age” with the label fishage: - + - +
    \longnewglossaryentry{fishage}  
    {name={Fish Age}} @@ -657,9 +686,9 @@ class="cmss-10">inputenc package such as é). This first letter must be placed in a group: - + - +
    \newglossaryentry{elite}  
    { @@ -713,26 +742,26 @@ commands), ⟨short⟩ is the short form and ⟨long⟩ is the long form. For example, the following defines an abbreviation: - + - +

    \newacronym{svm}{svm}{support vector machine}

    This defines a glossary entry with the label svm. By default, the ⟨name⟩ is -set to ⟨name⟩ is set +to ⟨short⟩ (“svm” in the above example) and the ⟨description⟩ is set to ⟨long⟩ (“support vector machine” in the above example). If, instead, you want to be able to specify your own description you can do this using the optional argument: - + - +

    \newacronym @@ -765,14 +794,14 @@ acronym or that use a footnote on first use. See the main user guide for further details.

    There are other keys you can use when you define an entry. For example, the name -key used above indicates how the term should appear in the list of entries (glossary). If -the term should appear differently when you reference it in the document, you need to -use the text key as well.

    For example: - + - +

    \newglossaryentry{latinalph} @@ -788,12 +817,12 @@ class="cmtt-10">text key as well.

    Another commonly used key is plural for specifying the plural of the term. This defaults to the value of the text key with an “s” appended, but if this is incorrect, just -use the text key with an “s” appended, but if this is incorrect, +just use the plural key to override it: - + - +

    \newglossaryentry{oesophagus} @@ -809,9 +838,9 @@ class="cmtt-10">\oe needs to be grouped.) class="cmtt-10">longplural and shortplural keys. For example: - + - +

    \newacronym @@ -820,13 +849,14 @@ class="cmtt-10">shortplural keys. For example:

    If omitted, the defaults are again obtained by appending an “s” to the singular versions. -

    It’s also possible to have both a name and a corresponding symbol. Just use the -

    It’s also possible to have both a name and a corresponding symbol. +Just use the name key for the name and the symbol key for the symbol. For example: - +class="cmtt-10">symbol key for the symbol. For +example: + - +

    \newglossaryentry{emptyset} @@ -842,9 +872,9 @@ class="cmtt-10">symbol key for the symbol. For example:

    Top

    3 Using Entries

    -

    Once you have defined your entries, as described above, you can reference them in your -document. There are a number of commands to do this, but the most common one -is: +

    Once you have defined your entries, as described above, you can reference them in +your document. There are a number of commands to do this, but the most common +one is:


    \gls{label\gls*{fishage}. The other commands described in this section all have a similar starred form.

    If the entry was defined as an acronym (using \newacronym described above), then +class="cmtt-10">\newacronym described above), +then \gls will display the full form the first time it’s used and just the +short form on subsequent use. For example, if the acronym style is set to \gls will display the full form the first time it’s used and just the short form on -subsequent use. For example, if the acronym style is set to long-short, then -\gls{svm} will display “support vector machine (svm)” the first time it’s used, but the -next occurrence of \gls{svm} will just display “svm”. +class="cmtt-10">long-short, then \gls{svm} will display “support vector machine (svm)” the +first time it’s used, but the next occurrence of \gls{svm} will just display +“svm”.

    If you want the plural form, you can use:


    \glspl{label}

    for the singular form or + + +


    \Glspl{label}

    - - -

    for the plural form. For example: - + - +

    \Glspl{set} are collections.

    produces “Sets are collections”.

    If you’ve specified a symbol using the symbol key, you can display it using: +class="cmtt-10">symbol key, you can display it +using:


    \glssymbol{labelTop

    In §1 Getting Started I mentioned that there are three options you can choose from to -create your glossary. Here they are again in a little more detail: +href="#sec:start">Getting Started I mentioned that there are three options you can choose from +to create your glossary. Here they are again in a little more detail:

    other options⟩]


    where you want your list of entries to appear. The sort ⟨order⟩ may be one of: - order⟩ may be one + of: word (word ordering), letter (letter ordering), case (case-sensitive letter - ordering), case (case-sensitive + letter ordering), def (in order of definition) or use (in order of use). Alternatively, - use +class="cmtt-10">use (in order of use). + Alternatively, use


    \printnoidxglossaries

    to display all your glossaries (if you have more than one). This command doesn’t have any arguments. + + +

  • Run LATEX twice on your document. (As you would do to make a table of - contents appear.) For example, click twice on the “typeset” or “build” or - “PDFLATEX twice on your document. (As you would do to make a table + of contents appear.) For example, click twice on the “typeset” or “build” + or “PDFLATEX” button in your editor.
  • - - -
    Option 2:

    This option uses an application called makeindex to sort the entries. This - application comes with all modern TEX distributions, but it’s hard-coded for the - non-extended Latin alphabet. This process involves making LATEX write the - glossary information to a temporary file which makeindex to sort the entries. + This application comes with all modern TEX distributions, but it’s + hard-coded for the non-extended Latin alphabet. This process involves + making LATEX write the glossary information to a temporary file which + makeindex reads. Then makeindex - writes a new file containing the code to typeset the glossary. LATEX then reads - this file on the next run. +class="cmtt-10">makeindex writes a new file containing the + code to typeset the glossary. LATEX then reads this file on the next + run.

    1. Add \makeglossaries to your preamble (before you start defining your - entries). +class="cmtt-10">\makeglossaries to your preamble (before you start defining + your entries).
    2. Put @@ -1015,42 +1048,43 @@ class="cmitt-10">options⟩]

    where you want your list of entries (glossary) to appear. (The sort key isn’t - available in ⟨sort key + isn’t available in ⟨options⟩.) Alternatively, use


    \printglossaries

    - which will display all glossaries (if you have more than one). This command - doesn’t have any arguments. + which will display all glossaries (if you have more than one). This + command doesn’t have any arguments.

  • Run LATEX on your document. This creates files with the extensions .glo - and EX on your document. This creates files with the extensions + .glo and .ist (for example, if your LATEX document is called myDoc.tex, then - you’ll have two extra files called myDoc.glo and myDoc.ist). If you look at - your document at this point, you won’t see the glossary as it hasn’t been - created yet. +class="E">EX document is called + myDoc.tex, then you’ll have two extra files called myDoc.glo and + myDoc.ist). If you look at your document at this point, you won’t see the + glossary as it hasn’t been created yet.
  • Run makeindex with the .glo file as the input file and the .ist file as the - style so that it creates an output file with the extension .gls. If you have - access to a terminal or a command prompt (for example, the MSDOS - command prompt for Windows users or the bash console for Unix-like users) - then you need to run the command: - - - +class="cmtt-10">.ist file + as the style so that it creates an output file with the extension + .gls. If you have access to a terminal or a command prompt (for + example, the MSDOS command prompt for Windows users or + the bash console for Unix-like users) then you need to run the + command: + + +
    makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
    @@ -1063,12 +1097,12 @@ class="cmtt-10">makeindex via your text editor, but each editor has a different method of doing this, so I can’t give a general description. You will have to check your editor’s manual. -

    The default sort is word order (“sea lion” comes before “seal”). If you want - letter ordering you need to add the

    The default sort is word order (“sea lion” comes before “seal”). If you + want letter ordering you need to add the -l switch: - + - +

    makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo @@ -1086,24 +1120,24 @@ class="description">Option 3:

    This option uses an application called xindy to sort the entries. This application - is more flexible than makeindex and is able to sort extended Latin or non-Latin - alphabets. It comes with Txindy to sort the entries. This + application is more flexible than makeindex and is able to sort extended Latin + or non-Latin alphabets. It comes with TEX Live but not with MiKTEX. Since xindy is a Perl - script, if you are using MiKTEX you will not only need to install xindy, you - will also need to install Perl. In a similar way to Option 2, this option - involves making LATEX write the glossary information to a temporary - file which EX. Since + xindy is a Perl script, if you are using MiKTEX you will not only need to + install xindy, you will also need to install Perl. In a similar way to Option 2, + this option involves making LATEX write the glossary information to + a temporary file which xindy reads. Then xindy writes a new file containing the - code to typeset the glossary. LATxindy writes a new file containing + the code to typeset the glossary. LATEX then reads this file on the next run.

    @@ -1113,9 +1147,9 @@ class="E">EX then reads this file on the next class="cmtt-10">xindy option to the glossaries package option list: - + - +

    \usepackage[xindy]{glossaries}
    @@ -1134,8 +1168,8 @@ class="cmitt-10">options⟩]

    where you want your list of entries (glossary) to appear. (The sort key isn’t - available in ⟨sort key + isn’t available in ⟨options⟩.) Alternatively, use


    \printglossaries

    @@ -1143,17 +1177,17 @@ class="cmtt-10">\printglossaries

  • Run LATEX on your document. This creates files with the extensions .glo - and EX on your document. This creates files with the extensions + .glo and .xdy (for example, if your LATEX document is called myDoc.tex, then - you’ll have two extra files called myDoc.glo and myDoc.xdy). If you look at - your document at this point, you won’t see the glossary as it hasn’t been - created yet. +class="E">EX document is called + myDoc.tex, then you’ll have two extra files called myDoc.glo and + myDoc.xdy). If you look at your document at this point, you won’t see the + glossary as it hasn’t been created yet.
  • Run xindy with the .glo file as the input file and the .xdy file as a module so that it creates an output file with the extension .gls. - You also need to set the language name and input encoding. If you - have access to a terminal or a command prompt (for example, the +class="cmtt-10">.gls. You + also need to set the language name and input encoding. If you have + access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command (all on one line): - + - +
    xindy  -L english -C utf8 -I xindy -M myDoc  
    -t myDoc.glg -o myDoc.gls myDoc.glo @@ -1178,21 +1212,21 @@ class="cmtt-10">.gls. class="cmtt-10">myDoc with the base name of your LATEX document file. Avoid spaces in the file name. If necessary, also replace english with the name of - your language and utf8 with your input encoding.) If you don’t know how to - use the command prompt, then you can probably access xindy via your text - editor, but each editor has a different method of doing this, so I can’t - give a general description. You will have to check your editor’s +class="cmtt-10">english with the name + of your language and utf8 with your input encoding.) If you don’t know + how to use the command prompt, then you can probably access xindy via + your text editor, but each editor has a different method of doing this, so + I can’t give a general description. You will have to check your editor’s manual.

    The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the order=letter package option: - + - +

    \usepackage[xindy,order=letter]{glossaries} @@ -1207,25 +1241,25 @@ class="E">EX on your document again.

    For Options 2 and 3, it can be difficult to remember all the parameters required for -3, it can be difficult to remember all the parameters required +for makeindex or xindy, so the glossaries package provides a script called makeglossaries -that reads the .aux file to determine what settings you have used and will then run + id="dx1-5030"> package provides a script called makeglossaries that reads the .aux file to determine what settings you have used +and will then run makeindex or xindy. Again, this is a command line application and can be run in -a terminal or command prompt. For example, if your LATEX document is in the file -xindy. Again, this is a command line application +and can be run in a terminal or command prompt. For example, if your +LATEX document is in the file myDoc.tex, then run: - + - +

    makeglossaries myDoc @@ -1239,9 +1273,9 @@ class="cmtt-10">makeglossaries via your text editor. Check your editor’s manual for advice. If you are using arara then you can just use the directives: - + - +

     arara: pdflatex @@ -1253,25 +1287,25 @@ directives: class="cmtt-10">makeglossaries script is written in Perl, so you need a Perl interpreter installed. If you are using a Unix-like operating system then you most likely have one installed. If you are using Windows with the TEX Live distribution, then you can use -the Perl interpreter that comes with TEX Live distribution, then you can +use the Perl interpreter that comes with TEX Live. If you are using Windows and MiKTEX then you need to install a Perl distribution for Windows. If you are -using EX then you need to install a Perl distribution for Windows. If you are using +Option 3, then you need to do this anyway as xindy is also written in -Perl. If you are using Option 2 and can’t work out how to install Perl (or -for some reason don’t want to install it) then just use xindy is also written in Perl. +If you are using Option 2 and can’t work out how to install Perl (or for +some reason don’t want to install it) then just use makeindex directly, as described above, or you can use a Lua alternative to makeglossaries called makeglossaries-lite.lua: - + - +

    makeglossaries-lite.lua myDoc @@ -1279,9 +1313,9 @@ makeglossaries-lite.lua myDoc

    As a last resort you can try the package option automake: - + - +

    \usepackage[automake]{glossaries} @@ -1295,20 +1329,20 @@ probably won’t work for xindy and won’t work at all if the shell escape has been disabled in your TEX distribution. Most TEX distributions will allow a restricted shell -escape, which will only allow trusted applications to be run. If the automake option is -successful, you will still need to run LATEX distributions will allow a restricted +shell escape, which will only allow trusted applications to be run. If the automake +option is successful, you will still need to run LATEX twice for the glossaries to be displayed. -

    When sorting the entries, the string comparisons are made according to each entry’s -

    When sorting the entries, the string comparisons are made according to each +entry’s sort key. If this is omitted, the name key is used. For example, recall the earlier -definition: - +class="cmtt-10">name key is used. For example, recall the +earlier definition: + - +

    \newglossaryentry{elite} @@ -1320,25 +1354,25 @@ definition:

    No sort key was used, so it’s set to the same as the name key: {\’e}lite. How this is -interpreted depends on which option you have used: +class="cmtt-10">{\’e}lite. How this +is interpreted depends on which option you have used:

    Option 1:
    By default, the accent command will be stripped so the sort value will - be elite. This will put the entry in the “E” letter group. However if you - use the By default, the accent command will be stripped so the sort value + will be elite. This will put the entry in the “E” letter group. However + if you use the sanitizesort=true package option, the sort value will be interpreted - as the sequence of characters: package option, the sort value will be + interpreted as the sequence of characters: \ ’ e l i t and e. This will place this entry - before the “A” letter group since it starts with a symbol. +class="cmtt-10">e. This will place + this entry before the “A” letter group since it starts with a symbol.
    The sort key will be interpreted the sequence of characters: class="cmtt-10">{ \ e } - l i t and e + }lit and e. The first character is an opening curly brace { so makeindex @@ -1366,8 +1400,8 @@ class="cmbx-10">:
    xindy disregards LATEX commands so it sorts on elite, which puts - this entry in the “E” group.
    +class="cmtt-10">elite, which + puts this entry in the “E” group.

    If the inputenc package is used and the entry is defined as:

    @@ -1400,18 +1434,18 @@ class="cmbx-10">Option 1:
    By default the sort value will be interpreted as elite so the entry will - be put in the “E” letter group. If you use the elite so the entry + will be put in the “E” letter group. If you use the sanitizesort=true package option, - the sort value will be interpreted as package + option, the sort value will be interpreted as élite where é has been sanitized (so - it’s no longer an active character) which will put this entry before the “A” - letter group. - +class="cmtt-10">lite where é has been + sanitized (so it’s no longer an active character) which will put this entry + before the “A” letter group. + - +
    :
    xindy will correctly recognise the sort value élite and will place it - in whatever letter group is appropriate for the given language setting. (In - English, this would just be the “E” letter group.)
    -

    Therefore if you have extended Latin or non-Latin characters, your best option is to -use lite and will place + it in whatever letter group is appropriate for the given language setting. + (In English, this would just be the “E” letter group.) +

    Therefore if you have extended Latin or non-Latin characters, your best option is +to use xindy (Option 3) with the inputenc package. If you use makeindex (Option 2) you -need to specify the Option 2) +you need to specify the sort key like this: - + - +

    \newglossaryentry{elite} @@ -1458,25 +1492,42 @@ class="cmtt-10">sort key like this:

    If you use Option 1, you may or may not need to use the sort key, but you will need -to be careful about fragile commands in the sort key, but you will +need to be careful about fragile commands in the name key if you don’t set the sort key. -

    If you use Option 3 and the name only contains a command (such as \P) you +must add the sort key. This is also advisable for the other options, but is essential +for Option 3. For example: + + + +

    +
    +\newglossaryentry{P}{name={\P},sort={P}, + 
     description={paragraph symbol}} +
    +

    +

    Table 1 summarises the main pros and cons of three options described above.

    - + - -


    - + - +
    Table 1: Glossary Options: Pros and Cons
    @@ -1488,7 +1539,7 @@ id="TBL-2-2" />

    OptionOption 3

    Requires +class="td11">

    Requires an external - application?

    Requires - Perl?

    Requires + Perl?

    Can +class="td11">

    Can sort extended Latin or non-Latin - alphabets?

    Efficient +class="td11">

    Efficient sort - algorithm?

    Can +class="td11">

    Can form ranges in the location - lists?

    Can +class="td11">

    Can have non-standard - locations?

    -

    Strips standard LATEX accents so, for example, \AA is treated the same as A. - + - +


    -

    Top

    5 Customising the Glossary

    -

    The default glossary style uses the

    The default glossary style uses the description environment to display the entry list. @@ -1601,162 +1652,163 @@ class="cmtt-10">\item which means that it will typically be displayed in bold. You can switch to medium weight by redefining \glsnamefont: - + - +

    -
    +
    \renewcommand*{\glsnamefont}[1]{\textmd{#1}}
    -

    -

    By default, a full stop is appended to the description. To prevent this from +

    +

    By default, a full stop is appended to the description. To prevent this from happening use the nopostdot package option: - + - +

    -
    +
    \usepackage[nopostdot]{glossaries}
    -

    -

    By default, a location list is displayed for each entry. This refers to the document -locations (for example, the page number) where the entry has been referenced. If you -use Options 

    +

    By default, a location list is displayed for each entry. This refers to the +document locations (for example, the page number) where the entry has been +referenced. If you use Options 2 or 3 described in §4 Displaying a List of Entries location ranges will be -compressed. For example, if an entry was used on pages 1, 2 and 3, with Options 2 -or 3 the location list will appear as 1–3, but with Option 1 it will appear as 1, 2, 3. If -you don’t want the locations displayed you can hide them using the nonumberlist -package option: - +href="#sec:printglossaries">Displaying a List of +Entries location ranges will be compressed. For example, if an entry was +used on pages 1, 2 and 3, with Options 2 or 3 the location list will appear +as 1–3, but with Option 1 it will appear as 1, 2, 3. If you don’t want the +locations displayed you can hide them using the nonumberlist package +option: + - +

    -
    +
    \usepackage[nonumberlist]{glossaries}
    -

    -

    Entries are grouped according to the first letter of each entry’s sort key. By default -a vertical gap is placed between letter groups. You can suppress this with the +

    +

    Entries are grouped according to the first letter of each entry’s sort key. By +default a vertical gap is placed between letter groups. You can suppress this with the nogroupskip package option: - + - +

    -
    +
    \usepackage[nogroupskip]{glossaries}
    -

    -

    If the default style doesn’t suit your document, you can change the style +

    +

    If the default style doesn’t suit your document, you can change the style using: -



    \setglossarystyle{style name}

    -

    +

    There are a number of predefined styles. Glossaries can vary from a list of symbols with a terse description to a list of words or phrases with descriptions that span multiple paragraphs, so there’s no “one style fits all” solution. You need to choose a style that suits your document. -

    Examples: +

    Examples:

    1. You have entries where the name is a symbol and the description is a brief phrase - or short sentence. Try one of the “mcol” styles defined in the You have entries where the name is a symbol and the description is a brief + phrase or short sentence. Try one of the “mcol” styles defined in the + glossary-mcols - package. For example: - + id="dx1-6005"> package. For example: + - -
      + +
      \usepackage[nogroupskip,nopostdot]{glossaries}  
      \usepackage{glossary-mcols}  
      \setglossarystyle{mcolindex}
      -

      +

    2. You have entries where the name is a word or phrase and the description spans multiple paragraphs. Try one of the “altlist” styles. For example: - + - -
      + +
      \usepackage[nopostdot]{glossaries}  
      \setglossarystyle{altlist}
      -

      +

    3. You have entries where the name is a single word, the description is brief, and an associated symbol has been set. Use one of the styles that display the symbol (not all of them do). For example, one of the tabular styles: - + - -
      + +
      \usepackage[nopostdot,nonumberlist]{glossaries}  
      \setglossarystyle{long4col}
      -

      or one of the “tree” styles: - +

      or one of the “tree” styles: + - +

      -
      +
      \usepackage[nopostdot,nonumberlist]{glossaries}  
      \setglossarystyle{tree}
      -

    -

    If your glossary consists of a list of acronyms and you also want to specify +

  • +

    If your glossary consists of a list of acronyms and you also want to specify a description as well as the long form, then you need to use an acronym style that will suit the glossary style. For example, use the long-short-desc acronym style: - + - +

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

    Define the acronyms with a description: - +

    Define the acronyms with a description: + - +

    -
    +
    \newacronym  
     [description={statistical pattern recognition technique}]  
     {svm}{svm}{support vector machine}
    -

    Choose a glossary style that suits wide entry names: - +

    Choose a glossary style that suits wide entry names: + - +

    -
    +
    \setglossarystyle{altlist}
    -

    -

    +

    +

    -

    Top

    6 Multiple Glossaries

    -

    The

    The glossaries package predefines a default main glossary. When you define an entry @@ -1768,7 +1820,7 @@ automatically assigned to the default glossary, unless you indicate otherwise us type key. However you first need to make sure the desired glossary has been defined. This is done using: -



    \newglossary[glg]{glo}{title}

    -

    +

    The ⟨label⟩ is a label that uniquely identifies this new glossary. As with other types of identifying labels, be careful not to use active characters in ⟨gls⟩ and ⟨glo⟩ arguments are ignored, in which case you may prefer to use the starred version where you don’t specify the extensions: -



    \newglossary*{label}{title}

    -

    -

    In the case of Options 

    +

    In the case of Options 2 or 3, all glossary definitions must come before \makeglossaries. -

    Since it’s quite common for documents to have both a list of terms and a list of +

    Since it’s quite common for documents to have both a list of terms and a list of acronyms, the glossaries package provides the package option acronym (or acronyms), which is a convenient shortcut for - + - +

    -
    +
    \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
    -

    The option also changes the behaviour of

    The option also changes the behaviour of \newacronym so that acronyms are automatically put in the list of acronyms instead of the main glossary. -

    For example, suppose you want a main glossary for terms, a list of acronyms and +

    For example, suppose you want a main glossary for terms, a list of acronyms and a list of notation: - + - +

    -
    +
    \usepackage[acronyms]{glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}
    -

    After

    After \makeglossaries (or \makenoidxglossaries) you can define the entries in the -preamble. For example: - +class="cmtt-10">\makenoidxglossaries) you can define the entries in +the preamble. For example: + - +

    -
    +
    \newglossaryentry{gls:set}  
    {% This entry goes in the ‘main’ glossary  
      name=set, @@ -1865,13 +1917,13 @@ preamble. For example:  
      description={A set},  
      sort={S}}
    -

    or if you don’t like using

    or if you don’t like using \ensuremath: - + - +

    -
    +
    \newglossaryentry{not:set}  
    {% This entry goes in the ‘notation’ glossary:  
      type=notation, @@ -1880,109 +1932,109 @@ class="cmtt-10">\ensuremath:  
      description={A set},  
      sort={S}}
    -

    -

    Each glossary is displayed using: -


    +

    Each glossary is displayed using: +


    \printnoidxglossary[type=type]

    -

    +

    (Option 1) or -



    \printglossary[type=type]

    -

    +

    (Options 2 and 3). Where ⟨type⟩ is the glossary label. If the type is omitted the default -type⟩ is the glossary label. If the type is omitted the +default main glossary is assumed. -

    There’s a convenient shortcut that will display all the defined glossaries: -


    There’s a convenient shortcut that will display all the defined glossaries: +


    \printnoidxglossaries

    -

    +

    (Option 1) or -



    \printglossaries

    -

    +

    (Options 2 and 3). -

    If you use

    If you use Option 1, you don’t need to do anything else. If you use Options 2 or 3 -with the makeglossaries Perl script, you similarly don’t need to do anything else. If -you use Options 2 +or 3 with the makeglossaries Perl script, you similarly don’t need to do anything +else. If you use Options 2 or 3 without the makeglossaries Perl script then you need to make -sure you run makeglossaries Perl script then you +need to make sure you run makeindex/xindy for each defined glossary. The ⟨gls⟩ and ⟨glo⟩ arguments of -gls⟩ and +⟨glo⟩ arguments of \newglossary specify the file extensions to use instead of .gls and .glo. The optional -argument ⟨glg⟩ is the file extension for the transcript file. This should be different for each -glossary in case you need to check for .gls and +.glo. The optional argument ⟨glg⟩ is the file extension for the transcript file. This +should be different for each glossary in case you need to check for makeindex/xindy errors or warnings if things go -wrong. -

    For example, suppose you have three glossaries in your document (xindy +errors or warnings if things go wrong. +

    For example, suppose you have three glossaries in your document (main, acronym and notation), specified using: - + - +

    -
    +
    \usepackage[acronyms]{glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}
    -

    Then (assuming your LAT

    Then (assuming your LATEX document is in a file called myDoc.tex): -

    +

    Option 2: -

    You need to run

    You need to run makeindex three times: - + - +

    -
    +
    makeindex -t myDoc.glg -s myDoc.ist -o myDoc.gls myDoc.glo  
    makeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn  
    makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn
    -

    +

    Option 3: -

    You need to run xindy three times (be careful not to insert line breaks where the - line has wrapped.) - +

    You need to run xindy three times (be careful not to insert line breaks where + the line has wrapped.) + - +

    -
    +
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.glg  
    -o myDoc.gls myDoc.glo  
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.alg @@ -1990,15 +2042,15 @@ class="cmtt-10">xindy three times (be careful not to insert line breaks w  
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg  
    -o myDoc.not myDoc.ntn
    -

    -

    +

    +

    -

    Top

    7 glossaries and hyperref

    -

    Take care if you use the

    Take care if you use the glossaries package with hyperrefafter hyperref: - + - +

    -
    +
    \usepackage[colorlinks]{hyperref}  
    \usepackage{glossaries}
    -

    If you use

    If you use hyperref make sure you use PDFLATEX rather than the LATEX to DVI -engine. The DVI format can’t break hyperlinks across a line so long glossary -entries (such as the full form of acronyms) won’t line wrap with the DVI engine. +engine. The DVI format can’t break hyperlinks across a line so long glossary entries +(such as the full form of acronyms) won’t line wrap with the DVI engine. Also, hyperlinks in sub- or superscripts aren’t correctly sized with the DVI format. -

    By default, if the

    By default, if the hyperref package has been loaded, commands like \gls will form a hyperlink to the relevant entry in the glossary. If you to disable this for all your glossaries, then use -



    \glsdisablehyper

    -

    +

    If you want hyperlinks suppressed for entries in specific glossaries, then use the nohypertypes package option. For example, if you don’t want hyperlinks for entries in -the nohypertypes package option. For example, if you don’t want hyperlinks for entries +in the acronym and notation glossaries but you do want them for entries in the main glossary, then do: - + - +

    -
    +
    \usepackage[colorlinks]{hyperref}  
    \usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}
    -

    -

    If you want the hyperlinks suppressed the first time an entry is used, but you want -hyperlinks for subsequence references then use the

    +

    If you want the hyperlinks suppressed the first time an entry is used, but you +want hyperlinks for subsequence references then use the hyperfirst=false package option: - + - +

    -
    +
    \usepackage[colorlinks]{hyperref}  
    \usepackage[hyperfirst=false]{glossaries}
    -

    -

    Take care not to use non-expandable commands in PDF bookmarks. This -isn’t specific to the

    +

    Take care not to use non-expandable commands in PDF bookmarks. This isn’t +specific to the glossaries package but is a limitation of PDF bookmarks. Non-expandable commands include commands like hyperref package provides a way of specifying alternative text for the PDF bookmarks via \texorpdfstring. For example: - + - +

    -
    +
    \section{The \texorpdfstring{\gls{fishage}}{Fish Age}}
    -

    However, it’s not a good idea to use commands like

    However, it’s not a good idea to use commands like \gls in a section heading as you’ll end up with the table of contents in your location list. Instead you can use -



    \glsentrytext{label}

    -

    +

    This is expandable provided that the text key doesn’t contain non-expandable code. For example, the following works: - + - +

    -
    +
    \section{The \glsentrytext{fishage}}
    -

    and it doesn’t put the table of contents in the location list. -

    +

    and it doesn’t put the table of contents in the location list. +

    -

    Top

    8 Cross-References

    -

    You can add a reference to another entry in a location list using the

    You can add a reference to another entry in a location list using the see={label} key when you define an entry. The referenced entry must also be defined. -

    For example: - +

    For example: + - +

    -
    +
    \longnewglossaryentry{devonian}{name={Devonian}}%  
    {%  
      The geologic period spanning from the end of the @@ -2141,18 +2193,18 @@ when you define an entry. The referenced entry must also be defined.  
      see={devonian}  
    }
    -

    The cross-reference will appear as “see Devonian”. You can change the “see” tag using -the format

    The cross-reference will appear as “see Devonian”. You can change the “see” tag +using the format see=[tag]label⟩. For example: - + - +

    -
    +
    \newglossaryentry{latinalph}  
    {  
      name={Latin alphabet}, @@ -2167,47 +2219,47 @@ class="cmti-10">label⟩. For example:  
       other letters such as ligatures or diacritics.}  
    }
    -

    If you use the

    If you use the see key in the optional argument of \newacronym, make sure you enclose the value in braces. For example: - + - +

    -
    +
    \newacronym{ksvm}{ksvm}{kernel support vector machine}  
    \newacronym  
     [see={[see also]{ksvm}}]  
     {svm}{svm}{support vector machine}
    -

    -

    Since the cross-reference appears in the location list, if you suppress the location list -using the

    +

    Since the cross-reference appears in the location list, if you suppress the location +list using the nonumberlist package option, then the cross-reference will also be suppressed. -

    +

    -

    Top

    9 Further Information

    -

    Further information can be found in the main

    Further information can be found in the main glossaries user manual or in the glossaries -FAQ. There is also an article on the glossaries package on the user manual or in the +glossaries FAQ. There is also an article on the glossaries package on the +LATEX Community’s -Know How section and a chapter on the EX Community’s Know How section and a chapter on the glossaries package in package in +Using LATEX to Write a -PhD Thesis.

    +class="E">EX to Write a PhD Thesis.

    - + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 0e96cdfd20a..9d50b0b2f7a 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 f9b646cb507..3be8291d82d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -20,10 +20,10 @@ \newcommand*{\yes}{\ding{52}} \newcommand*{\no}{\ding{56}} -\title{The glossaries package v4.20: +\title{The glossaries package v4.21: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2015-11-30} +\date{2016-01-24} \ifpdf \externaldocument{glossaries-user} @@ -815,6 +815,15 @@ If you use \opt1, you may or may not need to use the \texttt{sort} key, but you will need to be careful about fragile commands in the \texttt{name} key if you don't set the \texttt{sort} key. +If you use \opt3 and the \texttt{name} only contains a command +(such as \cs{P}) you must add the \texttt{sort} key. This +is also advisable for the other options, but is essential for +\opt3. For example: +\begin{verbatim} +\newglossaryentry{P}{name={\P},sort={P}, + description={paragraph symbol}} +\end{verbatim} + \Tableref{tab:optionsp+c} summarises the main pros and cons of three options described above. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 411bff47ee2..d2de8c4f63f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -4,13 +4,13 @@ -Upgrading from the glossary package to the glossaries package + - + -

    - +

    + - - + +

    + - - -

    Upgrading from the glossary package to the -glossaries package

    -
    Nicola L.C. Talbot

    -
    2015-11-30
    -
    + +

    +
    +

    +

    Upgrading from the glossary package to the +glossaries package +

    +
    Nicola L.C. Talbot
    +
    +

    2016-01-24

    @@ -190,7 +211,7 @@ class="abstract"

    Abstract

    The purpose of this document is to provide advice if you want to +class="cmr-9">The purpose of this document is to provide advice if you want to convert a LEX document from using the obsolete glossary package to the +class="cmr-9">package to replacement the replacement glossaries package.

    @@ -231,15 +252,15 @@ class="cmtt-10">\useglosentry
     6.2 \useGlosentry + + +
     6.3 \gls
     6.4 \glossary - - -
    7 Acronyms
     7.1 Displaying the glossary href="#processingyourdocument" id="QQ2-1-18">Processing Your Document
    10 Troubleshooting -
    Index

    @@ -268,13 +287,13 @@ href="#index">Index href="#top">Top

    1 Why the Need for a New Package?

    The glossary package started out as an example in a tutorial, but I decided that I may -as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and -unable to adapt well to the wide variation in glossary styles. Users began making +class="cmss-10">glossary package started out as an example in a tutorial, but I decided that I +may as well package it up and upload it to CTAN. Unfortunately it was fairly rigid +and unable to adapt well to the wide variation in glossary styles. Users began making requests for enhancements, but with each enhancement the code became more -complicated and bugs crept in. Each fix in one place seemed to cause another problem -elsewhere. In the end, it was taking up too much of my time to maintain, so I decided -to replace it with a much better designed package. With the new glossaries package:

    @@ -286,8 +305,8 @@ package:
  • 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 fixed names used + in headings and by some of the glossary styles;
  • you can choose1xindyxindy means that: - + - +
      -
    • there is much better support for terms containing accented or non-Latin - characters; +
    • there is much better support for terms containing accented or + non-Latin characters;
    • there is support for non-standard location numbers;
  • @@ -333,27 +352,27 @@ href="#top">Top

    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 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 \usepackage{glossaries}, +however some of the package options are different, so you may need to change those +as well. Table 1 shows the mappings from the glossary to the glossaries package options.

    - + - +


    - + - +
    Table 1: Mappings from global no corresponding option
    - + - +

    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 different style to the main +(default) glossary, you will also need to put


    glossaries new style⟩ using the same mapping given in Table 1.

    For example, if your document contains the following: - + - +

    \newglossarytype[nlg]{notation}{not}{ntn}[style=long,header]  
    \newcommand{\notationname}{Index of Notation}

    You will need to replace the above two lines with: - + - +

    \newglossary[nlg]{notation}{not}{ntn}{Index of Notation}

    in the preamble and - + - +

    \glossarystyle{longheader} @@ -601,9 +620,9 @@ class="cmss-10">style\printglossary. For example: - + - +

    \printglossary[type=notation,style=longheader] @@ -618,8 +637,8 @@ class="cmtt-10">\glossaryname and \acronymname) but is instead specified in the ⟨title⟩ argument of -title⟩ argument +of \newglossary. The short title which is specified in the glossary package by the @@ -645,23 +664,23 @@ class="cmti-10">glossary name⟩ (e.g. \makeglossary and \makeacronym) should -be replaced by the single command ) +should be replaced by the single command \makeglossaries. For example, if your document -contained the following: - + id="dx1-5003">. For example, if your +document contained the following: + - +

    \makeglossary  
    \makeacronym

    then you should replace both lines with the single line: - + - +

    \makeglossaries @@ -721,12 +740,12 @@ class="cmitt-10">gls-entry⟩}


    -This should be fairly easy to do using the search and replace facility in your editor (but -see notes below). +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 + id="dx1-6009"> (i.e. you have +multiple glossaries) then you will need to substitute


    glossary ,type=gls-type}

    - + - +

    The glossary entry information ⟨gls-entry⟩ may also need changing. If ⟨" 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: - + - +

    \newglossaryentry{card}{name={$|\mathcal{S}|$}, @@ -810,19 +829,19 @@ href="#top">Top

    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 and the entries for that term +were added using \useglosentry, \useGlosentry and \gls. Secondly, the term was added -to the glossary using . Secondly, the term was +added to the glossary using \glossary. This second approach is unavailable with the glossaries -package. + id="dx1-7005">. This second approach is unavailable with the +glossaries package.

    old options⟩ should be replaced with counter=counter name⟩ -in ⟨counter +name⟩ in ⟨new options⟩. - + - +

    \gls\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 - +store all these commands, and then input that file in your document’s preamble. + - -text editors and front-ends allow you to have multiple files open, and you can tab back -and forth between them. + +Most text editors and front-ends allow you to have multiple files open, and you can +tab back and forth between them.

    glossary package which set the name key to ⟨long⟩ (⟨abbrv⟩) and -allowed you to set a description using the abbrv⟩) +and allowed you to set a description using the description key. If you still want to do this, -you can use the key. If you still want to do +this, you can use the description package option, and use the description key in the optional -argument of key in the +optional argument of \newacronym.

    For example, if your document originally had the following: - + - +

    \newacronym{SVM}{Support Vector Machine}{description=Statistical @@ -1104,24 +1124,24 @@ class="cmss-10">glossaries package using the description package option, for example: - + - +

    \usepackage[description]{glossaries}

    and change the acronym definition 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

    You can then reference the acronym using any of the new referencing commands, +such as \gls or \glsaddacr-name⟩ which could be used to display the acron So the above SVM example would create the command \SVM with the old package. In the new glossaries package, the acronyms are just another type -of glossary entry, so they are displayed using glossaries package, the acronyms are just another type of +glossary entry, so they are displayed using \gls{\gls{svm}. class="cmtt-10">\useacronym instead of \acr-name⟩, then you will need to replace -all occurrences of +class="cmti-10">acr-name⟩, then you will need to +replace all occurrences of


    glossary \oldacronymglossary package’s \newacronym and also defines - and +also defines \acr-name⟩. For example, if your document originally had the following: +class="cmti-10">acr-name⟩. For example, if your document originally had the +following:


    glossary - + - +

    \newacronym{SVM}{Support Vector Machine}{description=Statistical

    pattern recognition technique} @@ -1214,9 +1235,9 @@ class="cmss-10">glossary then you can change this to:


    glossaries - + - +

    \oldacronym{SVM}{Support Vector Machine}{description=Statistical

    pattern recognition technique} @@ -1227,16 +1248,16 @@ class="cmss-10">glossaries

    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 EX 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 xspace +package. (See Acronyms of the glossaries documentation for further details.) Note that -glossaries documentation for further details.) Note +that \oldacronym uses its first argument to define the acronym’s label (as used by commands like \acrln and \acrsh. With -the . With the +glossaries package (provided you defined the acronym using \newacronym -or or +\oldacronym and provided you haven’t redefined \newacronym{acr-name}

    - + - +
    with


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

    See \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: +class="cmss-10">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 {acr-name}

    - + - +
    with either




    - + - + or


    glossaries @@ -1539,51 +1560,51 @@ class="cmss-10">glossary package provides the command \printglossary (or \printtype⟩ for other -glossary types) which can be used to print individual glossaries. The glossaries package -provides the command type⟩ for +other glossary types) which can be used to print individual glossaries. The glossaries +package provides the command \printglossaries which will print all the glossaries which have -been defined, or which will print all the glossaries +which have been defined, or \printglossary[options] to print individual glossaries. So if you -just have ] 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 - + - +

    \printglossary  
    \printacronym

    then you will need to replace this with either - + - +

    \printglossaries

    or - + - +

    \printglossary @@ -1591,8 +1612,8 @@ say:

    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 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 @@ -1602,12 +1623,12 @@ class="cmss-10">toctitle key which can be used in the optional argument to \printglossary. For example, if you have created a -new glossary type called . For example, if you have created +a new glossary type called notation, and you had defined - + - +

    \newcommand{\shortnotationname}{Notation} @@ -1615,9 +1636,9 @@ class="cmtt-10">notation, and you had defined

    then you would need to use the toctitle key: - + - +

    \printglossary[type=notation,toctitle=Notation] @@ -1634,11 +1655,11 @@ href="#top">Top

    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 glossaries +package, you will need to delete any of the additional files, such as the .glo file, that were -created by the file, that +were created by the glossary package, as the glossaries package uses a different format. Remember also, that if you used the makeglosmakeglossaries Perl script instead. As from v1.17, the glossaries package -can be used with either glossaries package can +be used with either makeindex or xindyTop

    Please check the FAQ for the glossaries package if you have any problems. - - - -

    +

    Index

    -

    A -

    -
    \acl  1
    -\acrln  2, 3
    -\acrlong  4, 5
    -\acrlongpl  6
    -\acronymname  7
    -\acronymtype  8, 9, 10, 11
    -\acrsh  12, 13
    -\acrshort  14, 15
    -\acrshortpl  16
    -\acs  17
    -

    F -file types
    +

    +
    file types
        .glo  18
    -

    1
    +

    G -\glossary  19, 20, 21, 22, 23, 24, 25, 26, 27
    -\glossaryname  28
    -\glossarystyle  29
    -\Gls  30
    -\gls  31, 32, 33, 34, 35, 36, 37, 38
    \gls options
    + + +     counter  39
    +href="glossary2glossaries.html#dx1-10003" >2
        number  40
    -\glsadd  41, 42, 43
    +href="glossary2glossaries.html#dx1-10002" >3
    \glsadd options
        counter  44
    -\glslink  45, 46
    -\glslocalreset  47
    -\glslocalresetall  48
    -\glslocalunset  49
    -\glslocalunsetall  50
    -\glsreset  51
    -\glsresetall  52
    -\glsunset  53
    - - - -\glsunsetall  54
    -

    I -\ifacronymfirstuse  55, 56
    -\ifglsused  57, 58
    -

    4
    +

    M -\makeacronym  59
    makeglos  60
    +href="glossary2glossaries.html#dx1-17002" >5
    makeglossaries  61, 62
    -\makeglossaries  63
    -\makeglossary  64
    +href="glossary2glossaries.html#dx1-17003" >6, 7
    makeindex  65, 66, 67, 68, 69, 70, 71, 72, 73
    -

    8, 9, 10, 11, 12, 13, 14, 15, 16
    +

    N -\newacronym  74, 75, 76, 77, 78
    -\newglossary  79, 80
    -\newglossaryentry  81, 82, 83, 84, 85, 86, 87
    \newglossaryentry options
        description  88, 89
    +href="glossary2glossaries.html#dx1-12004" >17, 18
        name  90
    -\newglossarytype  91
    -

    O -\oldacronym  92, 93, 94
    -

    19
    +

    P package options:
        description  95, 96
    -\printglossaries  97
    -\printglossary  98, 99, 100, 101, 102, 103, 104
    +href="glossary2glossaries.html#dx1-12005" >20, 21
    \printglossary options
        style  105
    +href="glossary2glossaries.html#dx1-4005" >22
        toctitle  106, 107, 108
    -

    R -\resetacronym  109
    -\resetallacronyms  110
    -

    23, 24, 25
    +

    S - - - -\shortnotationname  111
    -\storeglosentry  112, 113, 114, 115, 116, 117, 118
    \storeglosentry options
        format  119
    +href="glossary2glossaries.html#dx1-6013" >26
        number  120
    -

    27
    +

    U -\unsetacronym  121
    -\unsetallacronyms  122
    -\useacronym  123, 124, 125
    -\useGlosentry  126, 127
    -\useglosentry  128, 129
    \useglosentry options
        format  130
    +href="glossary2glossaries.html#dx1-8003" >28
        number  131
    -

    29
    +

    X xindy  132, 133, 134, 135, 136, 137, 138
    +href="glossary2glossaries.html#dx1-2004" >30, 31, 32, 33, 34, 35, 36

    + + +

    1as from v1.17. Previous versions were designed to be used with 4This is because \glossary requires the argument to be in a specific format and doesn’t use the -⟨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 +class="cmr-8">format that the old glossary package used. The new package’s internal commands set format, as well as escaping any of this format, as well as escaping any of makeindex’s or xindy’s special characters. What’s more, the format +class="cmr-8">’s special characters. What’s more, the has changed as from v1.17 to allow the new package to be used with either format has changed as from v1.17 to allow the new package to be used with either makeindex or @@ -2052,12 +1867,12 @@ class="cmr-8">and if you use it more than once for the same term, there’s class="cmr-8">will cause makeindex to treat the two entries as different terms, even though they look the same in the +class="cmr-8">to treat the two entries as different terms, even though they look the same in document.

    +class="cmr-8">the document.

    - + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 15890359932..e12dcd93bbf 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 e7947360fc5..d4c563c4e9a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -33,7 +33,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2015-11-30} +\date{2016-01-24} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf index c45c178c47b..7f1ad584a79 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index 29257e69f8e..791f7ff3356 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index ed4b47edb27..31cb82781b6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -37,7 +37,7 @@ \listfiles \usepackage[colorlinks]{hyperref} - %\usepackage{glossaries} % acronym will go in main glossary + %\usepackage{glossaries} % abbreviation will go in main glossary \usepackage[acronym]{glossaries} % make a separate list of acronyms \makeglossaries @@ -57,9 +57,13 @@ description={a sample entry}} % This contrived acronym has non-standard plural forms. % These are specified in the optional argument. + % Remove the optional argument to revert to the default + % plurals. \newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived acronyms]{aca}{aca}{a contrived acronym} + % Keep all definitions in the preamble! + \begin{document} A \gls{sample} entry and \gls{aca}. Second use: \gls{aca}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf index 7eb117e7d27..6efa729c41d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf index fea5d8a5a8d..c4c54c68393 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf index 0c83db56027..6de9cc825bf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf index 589893246d7..b335374a545 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf index 49351f64a70..d4b42200c56 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.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 d51de5243e0..c42cdf033a2 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 6ece67a0d60..d5d8d33ce7a 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-dot-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf index 2cf1c2a2cd6..bb8db927774 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.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 92e3616d817..62a8df4aac8 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-entrycount.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf index ebc251b4f30..44fc65b3a94 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf index 7467f184f57..f06526bd9b7 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf index 1cb8a1004fe..449cf1d7a04 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf index be66009a29f..12de6377391 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf index fa56ebb803f..d77e43ba7ca 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf index 398569da8d0..1b9726203a0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf index 6e6f4d8bbab..c018b8b611b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf index c9d1dcf5155..538fa68cbd9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf index eb19f82070a..3f145c1f7e0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf index 374f3a40fa5..37f138a6049 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf index 74fae88f9da..bc498cdbe0b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf index 9152f76ba94..a62e300a4bb 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf index 4cfca18b13d..23545ba1d3d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf index 4c096b20509..63ab4d65b51 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf index 1864b9232e0..02b4f999a92 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf index 2e7dde0d635..4c9aa145397 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf index 772e1ef6354..00c8a23dbc2 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 f6a15b26797..41b011791ae 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 020e14e650e..ab1d9443955 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 8941693ec54..b8cec0fa741 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf index 3fc207b4a71..924b8cc8585 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf index 34bf42c7d62..835cb5d5bff 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 ef1c1974a88..94695c1f6b5 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 a7b6041fc69..1e55b290585 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf index eba6215e3e3..6ed3311a87d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf index 023c192edf4..cd667581143 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf index fe0e5912639..171241d6aa8 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf index 34f57214d4d..c7876abb85c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf index 28bc855bc03..6386571c4a6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf index 884c4fb2eb2..1b041af79c5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf index d4a55d40fac..9255d32f1a7 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 26759c78663..063ad22f1b5 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 a56ae83ef98..43ac436bb15 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 15389c6bfc1..1549b5d6e70 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf index 28e1fddf71f..0913ab620ec 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 d874be08475..e63701ba4f3 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 -- cgit v1.2.3